1  .\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
 2  .\"
 3  .\" Redistribution and use in source and binary forms, with or without
 4  .\" modification, are permitted provided that the following conditions
 5  .\" are met:
 6  .\" 1. Redistributions of source code must retain the above copyright
 7  .\"    notice, this list of conditions and the following disclaimer.
 8  .\" 2. Redistributions in binary form must reproduce the above copyright
 9  .\"    notice, this list of conditions and the following disclaimer in the
10  .\"    documentation and/or other materials provided with the distribution.
11  .\"
12  .\" This software is provided by Joseph Koshy ``as is'' and
13  .\" any express or implied warranties, including, but not limited to, the
14  .\" implied warranties of merchantability and fitness for a particular purpose
15  .\" are disclaimed.  in no event shall Joseph Koshy be liable
16  .\" for any direct, indirect, incidental, special, exemplary, or consequential
17  .\" damages (including, but not limited to, procurement of substitute goods
18  .\" or services; loss of use, data, or profits; or business interruption)
19  .\" however caused and on any theory of liability, whether in contract, strict
20  .\" liability, or tort (including negligence or otherwise) arising in any way
21  .\" out of the use of this software, even if advised of the possibility of
22  .\" such damage.
23  .\"
24  .\" $Id$
25  .\"
26  .Dd February 5, 2008
27  .Os
28  .Dt GELF_FSIZE 3
29  .Sh NAME
30  .Nm gelf_fsize ,
31  .Nm elf32_fsize ,
32  .Nm elf64_fsize
33  .Nd return the size of a file type
34  .Sh LIBRARY
35  .Lb libelf
36  .Sh SYNOPSIS
37  .In libelf.h
38  .Ft size_t
39  .Fn elf32_fsize "Elf_Type type" "size_t count" "unsigned int version"
40  .Ft size_t
41  .Fn elf64_fsize "Elf_Type type" "size_t count" "unsigned int version"
42  .In gelf.h
43  .Ft size_t
44  .Fn gelf_fsize "Elf *elf" "Elf_Type type" "size_t count" "unsigned int version"
45  .Sh DESCRIPTION
46  These functions return the size in bytes of the file representation of
47  .Ar count
48  numbers of objects of ELF type
49  .Ar type .
50  For ELF types that are of variable length, these functions return a
51  size of one byte.
52  .Pp
53  Functions
54  .Fn elf32_fsize
55  and
56  .Fn elf64_fsize
57  return sizes for files of class
58  .Dv ELFCLASS32
59  and
60  .Dv ELFCLASS64
61  respectively.
62  Function
63  .Fn gelf_fsize
64  returns the size for the class of ELF descriptor
65  .Ar elf .
66  .Sh RETURN VALUES
67  These functions return a non-zero value in case of success, or zero in
68  case of an error.
69  .Sh ERRORS
70  These functions may fail with:
71  .Bl -tag -width "[ELF_E_RESOURCE]"
72  .It Bq Er ELF_E_ARGUMENT
73  Argument
74  .Ar elf
75  was NULL in a call to
76  .Fn gelf_fsize .
77  .It Bq Er ELF_E_ARGUMENT
78  ELF descriptor
79  .Ar elf
80  had an unknown ELF class.
81  .It Bq Er ELF_E_ARGUMENT
82  Argument
83  .Ar type
84  contained an illegal value.
85  .It Bq Er ELF_E_UNIMPL
86  Support for ELF type
87  .Ar type
88  has not been implemented.
89  .It Bq Er ELF_E_VERSION
90  Argument
91  .Ar version
92  is not a supported version.
93  .El
94  .Sh SEE ALSO
95  .Xr elf 3 ,
96  .Xr gelf 3