summaryrefslogtreecommitdiff
path: root/libelf/elf_rawfile.3
diff options
context:
space:
mode:
authorWez Furlong <wez@netevil.org>2011-04-03 21:42:26 -0400
committerWez Furlong <wez@netevil.org>2011-04-03 21:42:26 -0400
commit84b8cb41945586d1c3d7ff9ebe4df2506c51d2c3 (patch)
tree738ca55f76e8240c6f1129399ec8362b7dccac6c /libelf/elf_rawfile.3
parent8e4e3efb4e7c3bdb86f247bd161d0809757609c8 (diff)
downloadctf-84b8cb41945586d1c3d7ff9ebe4df2506c51d2c3.tar.gz
pull in the freebsd 8.2 libelf; primarily so we can build on darwin.
Diffstat (limited to 'libelf/elf_rawfile.3')
-rw-r--r--libelf/elf_rawfile.376
1 files changed, 76 insertions, 0 deletions
diff --git a/libelf/elf_rawfile.3 b/libelf/elf_rawfile.3
new file mode 100644
index 0000000..2597e2f
--- /dev/null
+++ b/libelf/elf_rawfile.3
@@ -0,0 +1,76 @@
+.\" Copyright (c) 2006 Joseph Koshy. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" This software is provided by Joseph Koshy ``as is'' and
+.\" any express or implied warranties, including, but not limited to, the
+.\" implied warranties of merchantability and fitness for a particular purpose
+.\" are disclaimed. in no event shall Joseph Koshy be liable
+.\" for any direct, indirect, incidental, special, exemplary, or consequential
+.\" damages (including, but not limited to, procurement of substitute goods
+.\" or services; loss of use, data, or profits; or business interruption)
+.\" however caused and on any theory of liability, whether in contract, strict
+.\" liability, or tort (including negligence or otherwise) arising in any way
+.\" out of the use of this software, even if advised of the possibility of
+.\" such damage.
+.\"
+.\" $FreeBSD: src/lib/libelf/elf_rawfile.3,v 1.2.10.2.2.1 2010/12/21 17:09:25 kensmith Exp $
+.\"
+.Dd July 3, 2006
+.Dt ELF_RAWFILE 3
+.Os
+.Sh NAME
+.Nm elf_rawfile
+.Nd return uninterpreted contents of an ELF file
+.Sh LIBRARY
+.Lb libelf
+.Sh SYNOPSIS
+.In libelf.h
+.Ft char *
+.Fn elf_rawfile "Elf *elf" "size_t *sz"
+.Sh DESCRIPTION
+Function
+.Fn elf_rawfile
+returns the uninterpreted contents of the file referenced by ELF descriptor
+.Ar elf .
+.Pp
+If argument
+.Ar sz
+is non-null, the function stores the file's size in bytes
+in the location to which it points.
+A value of zero is written to this location if an error is
+encountered.
+.Sh RETURN VALUES
+Function
+.Fn elf_rawfile
+returns a valid pointer if successful or NULL if an error occurs.
+.Sh ERRORS
+Function
+.Fn elf_rawfile
+may fail with the following errors:
+.Bl -tag -width "[ELF_E_RESOURCE]"
+.It Bq Er ELF_E_ARGUMENT
+Argument
+.Ar elf
+was NULL.
+.It Bq Er ELF_E_SEQUENCE
+Argument
+.Ar elf
+was opened for writing and function
+.Fn elf_rawfile
+was invoked before
+.Xr elf_update 3 .
+.El
+.Sh SEE ALSO
+.Xr elf 3 ,
+.Xr elf_getdata 3 ,
+.Xr elf_getident 3 ,
+.Xr elf_kind 3 ,
+.Xr elf_update 3