usr/src/man/man3elf/elf_getarsym.3elf

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1996, 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 ELF_GETARSYM 3ELF "Jul 11, 2001"
   7 .SH NAME
   8 elf_getarsym \- retrieve archive symbol table
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lelf\fR [ \fIlibrary\fR ... ]
  13 #include <libelf.h>
  14
  15 \fBElf_Arsym *\fR\fBelf_getarsym\fR(\fBElf *\fR\fIelf\fR, \fBsize_t *\fR\fIptr\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBelf_getarsym()\fR function returns a pointer to the archive symbol
  22 table, if one is available for the \fBELF\fR descriptor \fIelf\fR. Otherwise,
  23 the archive doesn't have a symbol table, an error occurred, or \fIelf\fR was
  24 null; \fBelf_getarsym()\fR then returns a null value. The symbol table is an
  25 array of structures that include the following members.
  26 .sp
  27 .in +2
  28 .nf
  29 \fBchar *as_name;
  30 size_t  as_off;
  31 unsigned long   as_hash;\fR
  32 .fi
  33 .in -2
  34
  35 .sp
  36 .LP
  37 These members have the following semantics:
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBas_name\fR\fR
  42 .ad
  43 .RS 11n
  44 A pointer to a null-terminated symbol name resides here.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBas_off\fR\fR
  51 .ad
  52 .RS 11n
  53 This value is a byte offset from the beginning of the archive to the member's
  54 header. The archive member residing at the given offset defines the associated
  55 symbol. Values in \fBas_off\fR may be passed as arguments to \fBelf_rand()\fR.
  56 See \fBelf_begin\fR(3ELF) to access the desired archive member.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBas_hash\fR\fR
  63 .ad
  64 .RS 11n
  65 This is a hash value for the name, as computed by \fBelf_hash()\fR.
  66 .RE
  67
  68 .sp
  69 .LP
  70 If \fIptr\fR is non-null, the library stores the number of table entries in the
  71 location to which \fIptr\fR points. This value is set to \fB0\fR when the
  72 return value is \fINULL\fR. The table's last entry, which is included in the
  73 count, has a null \fBas_name\fR, a zero value for \fBas_off\fR, and \fB~0UL\fR
  74 for \fBas_hash\fR.
  75 .sp
  76 .LP
  77 The hash value returned is guaranteed not to be the bit pattern of all ones (
  78 \fB~0UL\fR).
  79 .SH ATTRIBUTES
  80 .sp
  81 .LP
  82 See \fBattributes\fR(5) for descriptions of the following attributes:
  83 .sp
  84
  85 .sp
  86 .TS
  87 box;
  88 c | c
  89 l | l .
  90 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  91 _
  92 Interface Stability     Stable
  93 _
  94 MT-Level        MT-Safe
  95 .TE
  96
  97 .SH SEE ALSO
  98 .sp
  99 .LP
 100 \fBar.h\fR(3HEAD), \fBelf\fR(3ELF), \fBelf_begin\fR(3ELF),
 101 \fBelf_getarhdr\fR(3ELF), \fBelf_hash\fR(3ELF), \fBlibelf\fR(3LIB),
 102 \fBattributes\fR(5)