| blob | 90e2ad710509927e231d5678768b4c8b7e6fcd2c |
1 .\" $NetBSD: elf_open.3,v 1.2 2014/03/09 16:58:04 christos Exp $
2 .\"
3 .\" Copyright (c) 2012 Joseph Koshy. All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
13 .\"
14 .\" This software is provided by Joseph Koshy ``as is'' and
15 .\" any express or implied warranties, including, but not limited to, the
16 .\" implied warranties of merchantability and fitness for a particular purpose
17 .\" are disclaimed. in no event shall Joseph Koshy be liable
18 .\" for any direct, indirect, incidental, special, exemplary, or consequential
19 .\" damages (including, but not limited to, procurement of substitute goods
20 .\" or services; loss of use, data, or profits; or business interruption)
21 .\" however caused and on any theory of liability, whether in contract, strict
22 .\" liability, or tort (including negligence or otherwise) arising in any way
23 .\" out of the use of this software, even if advised of the possibility of
24 .\" such damage.
25 .\"
26 .\" Id: elf_open.3 2512 2012-05-31 06:15:57Z jkoshy
27 .\"
28 .Dd May 31, 2012
29 .Os
30 .Dt ELF_OPEN 3
31 .Sh NAME
32 .Nm elf_open
33 .Nd open ELF objects and ar(1) archives
34 .Sh LIBRARY
35 .Lb libelf
36 .Sh SYNOPSIS
37 .In libelf.h
38 .Ft "Elf *"
39 .Fn elf_open "int fd"
40 .Ft "Elf *"
41 .Fn elf_openmemory "char *image" "size_t sz"
42 .Sh DESCRIPTION
43 .Em Important :
44 The functions
45 .Fn elf_open
46 and
47 .Fn elf_openmemory
48 are extensions to the ELF(3) API, for the internal use of the
49 Elftoolchain project.
50 Portable applications should not use these functions.
51 .Pp
52 The function
53 .Fn elf_open
54 returns an Elf descriptor opened with mode
55 .Dv ELF_C_READ
56 for the ELF object or
57 .Xr ar 1
58 archive referenced by the file descriptor in argument
59 .Ar fd .
60 .Pp
61 The function
62 .Fn elf_openmemory
63 returns an ELF descriptor opened with mode
64 .Dv ELF_C_READ
65 for the ELF object or
66 .Xr ar 1
67 archive contained in the memory area pointed to by the argument
68 .Ar image .
69 The argument
70 .Ar sz
71 specifies the size of the memory area in bytes.
72 .Sh COMPATIBILITY
73 These functions are non-standard extensions to the ELF(3) API set.
74 .Pp
75 The behavior of these functions differs from their counterparts
76 .Xr elf_begin 3
77 and
78 .Xr elf_memory 3
79 in that these functions will successfully open malformed ELF objects
80 and
81 .Xr ar 1
82 archives, returning an Elf descriptor of type
83 .Dv ELF_K_NONE .
84 .Sh RETURN VALUES
85 The function returns a pointer to a ELF descriptor if successful, or
86 NULL if an error occurred.
87 .Sh ERRORS
88 These functions can fail with the following errors:
89 .Bl -tag -width "[ELF_E_RESOURCE]"
90 .It Bq Er ELF_E_ARGUMENT
91 The argument
92 .Ar fd
93 was of an unsupported file type.
94 .It Bq Er ELF_E_ARGUMENT
95 The argument
96 .Ar sz
97 was zero, or the argument
98 .Ar image
99 was NULL.
100 .It Bq Er ELF_E_IO
101 The file descriptor in argument
102 .Ar fd
103 was invalid.
104 .It Bq Er ELF_E_IO
105 The file descriptor in argument
106 .Ar fd
107 could not be read.
108 .It Bq Er ELF_E_RESOURCE
109 An out of memory condition was encountered.
110 .It Bq Er ELF_E_SEQUENCE
111 Functions
112 .Fn elf_open
113 or
114 .Fn elf_openmemory
115 was called before a working version was established with
116 .Xr elf_version 3 .
117 .El
118 .Sh SEE ALSO
119 .Xr elf 3 ,
120 .Xr elf_begin 3 ,
121 .Xr elf_errno 3 ,
122 .Xr elf_memory 3 ,
123 .Xr gelf 3