share/man/man3elf/elf32_getphdr.3elf

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2001, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ELF32_GETPHDR 3ELF "Jul 11, 2001"
   7 .SH NAME
   8 elf32_getphdr, elf32_newphdr, elf64_getphdr, elf64_newphdr \- retrieve
   9 class-dependent program header table
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR ... ] \fIfile\fR... \fB-lelf\fR [ \fIlibrary\fR ... ]
  14 #include <libelf.h>
  15
  16 \fBElf32_Phdr *\fR\fBelf32_getphdr\fR(\fBElf *\fR\fIelf\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBElf32_Phdr *\fR\fBelf32_newphdr\fR(\fBElf *\fR\fIelf\fR, \fBsize_t\fR \fIcount\fR);
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBElf64_Phdr *\fR\fBelf64_getphdr\fR(\fBElf *\fR\fIelf\fR);
  27 .fi
  28
  29 .LP
  30 .nf
  31 \fBElf64_Phdr *\fR\fBelf64_newphdr\fR(\fBElf *\fR\fIelf\fR, \fBsize_t\fR \fIcount\fR);
  32 .fi
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 For a 32-bit class file, \fBelf32_getphdr()\fR returns a pointer to the program
  38 execution header table, if one is available for the \fBELF\fR descriptor
  39 \fIelf\fR.
  40 .sp
  41 .LP
  42 \fBelf32_newphdr()\fR allocates a new table with \fIcount\fR entries,
  43 regardless of whether one existed previously, and sets the \fBELF_F_DIRTY\fR
  44 bit for the table. See \fBelf_flagdata\fR(3ELF). Specifying a zero \fIcount\fR
  45 deletes an existing table. Note this behavior differs from that of
  46 \fBelf32_newehdr()\fR allowing a program to replace or delete the program
  47 header table, changing its size if necessary.  See \fBelf32_getehdr\fR(3ELF).
  48 .sp
  49 .LP
  50 If no program header table exists, the file is not a 32-bit class file, an
  51 error occurs, or \fIelf\fR is \fINULL,\fR both functions return a null pointer.
  52 Additionally, \fBelf32_newphdr()\fR returns a null pointer if \fIcount\fR is
  53 \fB0\fR.
  54 .sp
  55 .LP
  56 The table is an array of \fBElf32_Phdr\fR structures, each of which includes
  57 the following members:
  58 .sp
  59 .in +2
  60 .nf
  61 \fBElf32_Word   p_type;
  62 Elf32_Off       p_offset;
  63 Elf32_Addr      p_vaddr;
  64 Elf32_Addr      p_paddr;
  65 Elf32_Word      p_filesz;
  66 Elf32_Word      p_memsz;
  67 Elf32_Word      p_flags;
  68 Elf32_Word      p_align;\fR
  69 .fi
  70 .in -2
  71
  72 .sp
  73 .LP
  74 The  \fBElf64_Phdr\fR structures include the following members:
  75 .sp
  76 .in +2
  77 .nf
  78 \fBElf64_Word   p_type;
  79 Elf64_Word      p_flags;
  80 Elf64_Off       p_offset;
  81 Elf64_Addr      p_vaddr;
  82 Elf64_Addr      p_paddr;
  83 Elf64_Xword     p_filesz;
  84 Elf64_Xword     p_memsz;
  85 Elf64_Xword     p_align;\fR
  86 .fi
  87 .in -2
  88
  89 .sp
  90 .LP
  91 For the 64\(mibit class, replace 32 with 64 as appropriate.
  92 .sp
  93 .LP
  94 The \fBELF\fR header's \fBe_phnum\fR member tells how many entries the program
  95 header table has. See \fBelf32_getehdr\fR(3ELF). A program may inspect this
  96 value to determine the size of an existing table; \fBelf32_newphdr()\fR
  97 automatically sets the member's value to \fIcount\fR. If the program is
  98 building a new file, it is responsible for creating the file's \fBELF\fR header
  99 before creating the program header table.
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for descriptions of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 Interface Stability     Stable
 114 _
 115 MT-Level        MT-Safe
 116 .TE
 117
 118 .SH SEE ALSO
 119 .sp
 120 .LP
 121 \fBelf\fR(3ELF), \fBelf32_getehdr\fR(3ELF), \fBelf_begin\fR(3ELF),
 122 \fBelf_flagdata\fR(3ELF), \fBlibelf\fR(3LIB), \fBattributes\fR(5)