usr/src/man/man3elf/elf_cntl.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_CNTL 3ELF "Jul 11, 2001"
   7 .SH NAME
   8 elf_cntl \- control an elf file descriptor
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR ... ] \fIfile\fR ... \fB-lelf\fR [ \fIlibrary\fR ... ]
  13 #include <libelf.h>
  14
  15 \fBint\fR \fBelf_cntl\fR(\fBElf *\fR\fIelf\fR, \fBElf_Cmd\fR \fIcmd\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 \fBelf_cntl()\fR instructs the library to modify its behavior with respect to
  22 an \fBELF\fR descriptor, \fIelf\fR. As \fBelf_begin\fR(3ELF) describes, an
  23 \fBELF\fR descriptor can have multiple activations, and multiple \fBELF\fR
  24 descriptors may share a single file descriptor. Generally, \fBelf_cntl()\fR
  25 commands apply to all activations of \fIelf\fR. Moreover, if the \fBELF\fR
  26 descriptor is associated with an archive file, descriptors for members within
  27 the archive will also be affected as described below. Unless stated otherwise,
  28 operations on archive members do not affect the descriptor for the containing
  29 archive.
  30 .sp
  31 .LP
  32 The \fIcmd\fR argument tells what actions to take and may have the following
  33 values:
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBELF_C_FDDONE\fR\fR
  38 .ad
  39 .RS 16n
  40 This value tells the library not to use the file descriptor associated with
  41 \fIelf\fR. A program should use this command when it has requested all the
  42 information it cares to use and wishes to avoid the overhead of reading the
  43 rest of the file. The memory for all completed operations remains valid, but
  44 later file operations, such as the initial \fBelf_getdata()\fR for a section,
  45 will fail if the data are not in memory already.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBELF_C_FDREAD\fR\fR
  52 .ad
  53 .RS 16n
  54 This command is similar to \fBELF_C_FDDONE\fR, except it forces the library to
  55 read the rest of the file. A program should use this command when it must close
  56 the file descriptor but has not yet read everything it needs from the file.
  57 After \fBelf_cntl()\fR completes the \fBELF_C_FDREAD\fR command, future
  58 operations, such as \fBelf_getdata()\fR, will use the memory version of the
  59 file without needing to use the file descriptor.
  60 .RE
  61
  62 .sp
  63 .LP
  64 If \fBelf_cntl()\fR succeeds, it returns \fB0\fR. Otherwise \fIelf\fR was
  65 \fINULL\fR or an error occurred, and the function returns \fB\(mi1\fR\&.
  66 .SH ATTRIBUTES
  67 .sp
  68 .LP
  69 See \fBattributes\fR(5) for descriptions of the following attributes:
  70 .sp
  71
  72 .sp
  73 .TS
  74 box;
  75 c | c
  76 l | l .
  77 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  78 _
  79 Interface Stability     Stable
  80 _
  81 MT-Level        MT-Safe
  82 .TE
  83
  84 .SH SEE ALSO
  85 .sp
  86 .LP
  87 \fBelf\fR(3ELF), \fBelf_begin\fR(3ELF), \fBelf_getdata\fR(3ELF),
  88 \fBelf_rawfile\fR(3ELF), \fBlibelf\fR(3LIB), \fBattributes\fR(5)
  89 .SH NOTES
  90 .sp
  91 .LP
  92 If the program wishes to use the ``raw'' operations (see \fBelf_rawdata()\fR,
  93 which \fBelf_getdata\fR(3ELF) describes, and \fBelf_rawfile\fR(3ELF)) after
  94 disabling the file descriptor with \fBELF_C_FDDONE\fR or \fBELF_C_FDREAD\fR, it
  95 must execute the raw operations explicitly beforehand. Otherwise, the raw file
  96 operations will fail. Calling \fBelf_rawfile()\fR makes the entire image
  97 available, thus supporting subsequent \fBelf_rawdata()\fR calls.