external/bsd/elftoolchain/dist/libelf/elf_memory.3

   1 .\"     $NetBSD: elf_memory.3,v 1.2 2014/03/09 16:58:04 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2006,2008 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_memory.3 2314 2011-12-11 06:19:51Z jkoshy
  27 .\"
  28 .Dd June 28, 2006
  29 .Os
  30 .Dt ELF_MEMORY 3
  31 .Sh NAME
  32 .Nm elf_memory
  33 .Nd process an ELF or ar(1) archive mapped into memory
  34 .Sh LIBRARY
  35 .Lb libelf
  36 .Sh SYNOPSIS
  37 .In libelf.h
  38 .Ft "Elf *"
  39 .Fn elf_memory "char *image" "size_t size"
  40 .Sh DESCRIPTION
  41 Function
  42 .Fn elf_memory
  43 is used to process an ELF file or
  44 .Xr ar 1
  45 archive whose image is present in memory.
  46 .Pp
  47 Argument
  48 .Ar image
  49 points to the start of the memory image of the file or archive.
  50 Argument
  51 .Ar size
  52 contains the size in bytes of the memory image.
  53 .Pp
  54 The ELF descriptor is created for reading (i.e., analogous to the
  55 use of
  56 .Xr elf_begin 3
  57 with a command argument value of
  58 .Dv ELF_C_READ Ns ).
  59 .Sh RETURN VALUES
  60 Function
  61 .Fn elf_memory
  62 returns a pointer to a new ELF descriptor if successful, or NULL if an
  63 error occurred.
  64 .Pp
  65 The return value may be queried for the file type using
  66 .Xr elf_kind 3 .
  67 .Sh EXAMPLES
  68 To read parse an elf file, use:
  69 .Bd -literal -offset indent
  70 int fd;
  71 void *p;
  72 struct stat sb;
  73 Elf *e;
  74 \&...
  75 if ((fd = open("./elf-file", O_RDONLY)) < 0 ||
  76     fstat(fd, &sb) < 0 ||
  77     (p = mmap(NULL, sb.st_size, PROT_READ, MAP_PRIVATE, fd, (off_t) 0)) ==
  78     MAP_FAILED) {
  79         ... handle system error ...
  80 }
  81
  82 if ((e = elf_memory(p, sb.st_size)) == NULL) {
  83         ... handle elf(3) error ...
  84 }
  85 \&... use ELF descriptor "e" here ...
  86 .Ed
  87 .Sh ERRORS
  88 Function
  89 .Fn elf_memory
  90 can fail with the following errors:
  91 .Bl -tag -width "[ELF_E_RESOURCE]"
  92 .It Bq Er ELF_E_ARGUMENT
  93 A NULL value was used for argument
  94 .Ar image
  95 or the value of argument
  96 .Ar sz
  97 was zero.
  98 .It Bq Er ELF_E_HEADER
  99 The header of the ELF object contained an unsupported value in its
 100 .Va e_ident[EI_CLASS]
 101 field.
 102 .It Bq Er ELF_E_HEADER
 103 The header of the ELF object contained an unsupported value in its
 104 .Va e_ident[EI_DATA]
 105 field.
 106 .It Bq Er ELF_E_RESOURCE
 107 An out of memory condition was detected.
 108 .It Bq Er ELF_E_SEQUENCE
 109 Function
 110 .Fn elf_memory
 111 was called before a working version was set using
 112 .Xr elf_version 3 .
 113 .It Bq Er ELF_E_VERSION
 114 The ELF object referenced by argument
 115 .Ar image
 116 was of an unsupported ELF version.
 117 .El
 118 .Sh SEE ALSO
 119 .Xr elf 3 ,
 120 .Xr elf_begin 3 ,
 121 .Xr elf_end 3 ,
 122 .Xr elf_errno 3 ,
 123 .Xr elf_kind 3 ,
 124 .Xr gelf 3