man3/dl_iterate_phdr.3

   1 .\" Copyright (c) 2003 by Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH DL_ITERATE_PHDR 3 2015-07-23 "GNU" "Linux Programmer's Manual"
  26 .SH NAME
  27 dl_iterate_phdr \- walk through list of shared objects
  28 .SH SYNOPSIS
  29 .nf
  30 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  31 .B #include <link.h>
  32
  33 .BI "int dl_iterate_phdr("
  34 .BI "          int (*" callback ") (struct dl_phdr_info *" info ,
  35 .BI "                           size_t " size ", void *" data "),"
  36 .BI "          void *" data ");"
  37 .fi
  38 .SH DESCRIPTION
  39 The
  40 .BR dl_iterate_phdr ()
  41 function allows an application to inquire at run time to find
  42 out which shared objects it has loaded.
  43
  44 The
  45 .BR dl_iterate_phdr ()
  46 function walks through the list of an
  47 application's shared objects and calls the function
  48 .I callback
  49 once for each object,
  50 until either all shared objects have been processed or
  51 .I callback
  52 returns a nonzero value.
  53
  54 Each call to
  55 .I callback
  56 receives three arguments:
  57 .IR info ,
  58 which is a pointer to a structure containing information
  59 about the shared object;
  60 .IR size ,
  61 which is the size of the structure pointed to by
  62 .IR info ;
  63 and
  64 .IR data ,
  65 which is a copy of whatever value was passed by the calling
  66 program as the second argument (also named
  67 .IR data )
  68 in the call to
  69 .BR dl_iterate_phdr ().
  70
  71 The
  72 .I info
  73 argument is a structure of the following type:
  74
  75 .in +4n
  76 .nf
  77 struct dl_phdr_info {
  78     ElfW(Addr)        dlpi_addr;  /* Base address of object */
  79     const char       *dlpi_name;  /* (Null-terminated) name of
  80                                      object */
  81     const ElfW(Phdr) *dlpi_phdr;  /* Pointer to array of
  82                                      ELF program headers
  83                                      for this object */
  84     ElfW(Half)        dlpi_phnum; /* # of items in \fIdlpi_phdr\fP */
  85 };
  86 .fi
  87 .in
  88
  89 (The
  90 .IR ElfW ()
  91 macro definition turns its argument into the name of an ELF data
  92 type suitable for the hardware architecture.
  93 For example, on a 32-bit platform,
  94 ElfW(Addr) yields the data type name Elf32_Addr.
  95 Further information on these types can be found in the
  96 .IR <elf.h> " and " <link.h>
  97 header files.)
  98
  99 The
 100 .I dlpi_addr
 101 field indicates the base address of the shared object
 102 (i.e., the difference between the virtual memory address of
 103 the shared object and the offset of that object in the file
 104 from which it was loaded).
 105 The
 106 .I dlpi_name
 107 field is a null-terminated string giving the pathname
 108 from which the shared object was loaded.
 109
 110 To understand the meaning of the
 111 .I dlpi_phdr
 112 and
 113 .I dlpi_phnum
 114 fields, we need to be aware that an ELF shared object consists
 115 of a number of segments, each of which has a corresponding
 116 program header describing the segment.
 117 The
 118 .I dlpi_phdr
 119 field is a pointer to an array of the program headers for this
 120 shared object.
 121 The
 122 .I dlpi_phnum
 123 field indicates the size of this array.
 124
 125 These program headers are structures of the following form:
 126 .in +4n
 127 .nf
 128
 129 typedef struct {
 130     Elf32_Word  p_type;    /* Segment type */
 131     Elf32_Off   p_offset;  /* Segment file offset */
 132     Elf32_Addr  p_vaddr;   /* Segment virtual address */
 133     Elf32_Addr  p_paddr;   /* Segment physical address */
 134     Elf32_Word  p_filesz;  /* Segment size in file */
 135     Elf32_Word  p_memsz;   /* Segment size in memory */
 136     Elf32_Word  p_flags;   /* Segment flags */
 137     Elf32_Word  p_align;   /* Segment alignment */
 138 } Elf32_Phdr;
 139 .fi
 140 .in
 141
 142 Note that we can calculate the location of a particular program header,
 143 .IR x ,
 144 in virtual memory using the formula:
 145
 146 .nf
 147   addr == info\->dlpi_addr + info\->dlpi_phdr[x].p_vaddr;
 148 .fi
 149 .SH RETURN VALUE
 150 The
 151 .BR dl_iterate_phdr ()
 152 function returns whatever value was returned by the last call to
 153 .IR callback .
 154 .SH VERSIONS
 155 .BR dl_iterate_phdr ()
 156 has been supported in glibc since version 2.2.4.
 157 .SH ATTRIBUTES
 158 For an explanation of the terms used in this section, see
 159 .BR attributes (7).
 160 .TS
 161 allbox;
 162 lb lb lb
 163 l l l.
 164 Interface       Attribute       Value
 165 T{
 166 .BR dl_iterate_phdr ()
 167 T}      Thread safety   MT-Safe
 168 .TE
 169
 170 .SH CONFORMING TO
 171 The
 172 .BR dl_iterate_phdr ()
 173 function is Linux-specific and should be avoided in portable applications.
 174 .SH NOTES
 175 Future versions of the C library may add further fields to the
 176 .IR dl_phdr_info
 177 structure; in that event, the
 178 .I size
 179 argument provides a mechanism for the callback function to discover
 180 whether it is running on a system with added fields.
 181 .SH EXAMPLE
 182 The following program displays a list of pathnames of the
 183 shared objects it has loaded.
 184 For each shared object, the program lists the virtual addresses
 185 at which the object's ELF segments are loaded.
 186
 187 .nf
 188 #define _GNU_SOURCE
 189 #include <link.h>
 190 #include <stdlib.h>
 191 #include <stdio.h>
 192
 193 static int
 194 callback(struct dl_phdr_info *info, size_t size, void *data)
 195 {
 196     int j;
 197
 198     printf("name=%s (%d segments)\\n", info\->dlpi_name,
 199         info\->dlpi_phnum);
 200
 201     for (j = 0; j < info\->dlpi_phnum; j++)
 202          printf("\\t\\t header %2d: address=%10p\\n", j,
 203              (void *) (info\->dlpi_addr + info\->dlpi_phdr[j].p_vaddr));
 204     return 0;
 205 }
 206
 207 int
 208 main(int argc, char *argv[])
 209 {
 210     dl_iterate_phdr(callback, NULL);
 211
 212     exit(EXIT_SUCCESS);
 213 }
 214 .fi
 215 .SH SEE ALSO
 216 .BR ldd (1),
 217 .BR objdump (1),
 218 .BR readelf (1),
 219 .BR dlopen (3),
 220 .BR elf (5),
 221 .BR ld.so (8)
 222
 223 .IR "Executable and Linking Format Specification" ,
 224 available at various locations online.