xref: /freebsd/contrib/elftoolchain/libelf/elf_cntl.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
22de3b87aSKai Wang.\"
32de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
42de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
52de3b87aSKai Wang.\" are met:
62de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
72de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
82de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
92de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
102de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
112de3b87aSKai Wang.\"
122de3b87aSKai Wang.\" This software is provided by Joseph Koshy ``as is'' and
132de3b87aSKai Wang.\" any express or implied warranties, including, but not limited to, the
142de3b87aSKai Wang.\" implied warranties of merchantability and fitness for a particular purpose
152de3b87aSKai Wang.\" are disclaimed.  in no event shall Joseph Koshy be liable
162de3b87aSKai Wang.\" for any direct, indirect, incidental, special, exemplary, or consequential
172de3b87aSKai Wang.\" damages (including, but not limited to, procurement of substitute goods
182de3b87aSKai Wang.\" or services; loss of use, data, or profits; or business interruption)
192de3b87aSKai Wang.\" however caused and on any theory of liability, whether in contract, strict
202de3b87aSKai Wang.\" liability, or tort (including negligence or otherwise) arising in any way
212de3b87aSKai Wang.\" out of the use of this software, even if advised of the possibility of
222de3b87aSKai Wang.\" such damage.
232de3b87aSKai Wang.\"
24*ae500c1fSEd Maste.\" $Id: elf_cntl.3 3639 2018-10-14 14:07:02Z jkoshy $
252de3b87aSKai Wang.\"
262de3b87aSKai Wang.Dd August 9, 2006
272de3b87aSKai Wang.Dt ELF_CNTL 3
28*ae500c1fSEd Maste.Os
292de3b87aSKai Wang.Sh NAME
302de3b87aSKai Wang.Nm elf_cntl
312de3b87aSKai Wang.Nd control an elf file descriptor
322de3b87aSKai Wang.Sh LIBRARY
332de3b87aSKai Wang.Lb libelf
342de3b87aSKai Wang.Sh SYNOPSIS
352de3b87aSKai Wang.In libelf.h
362de3b87aSKai Wang.Ft int
372de3b87aSKai Wang.Fn elf_cntl "Elf *elf" "Elf_Cmd cmd"
382de3b87aSKai Wang.Sh DESCRIPTION
392de3b87aSKai WangFunction
402de3b87aSKai Wang.Fn elf_cntl
412de3b87aSKai Wangcontrols the ELF library's subsequent use of the file descriptor
422de3b87aSKai Wangused to create ELF descriptor
432de3b87aSKai Wang.Ar elf .
442de3b87aSKai Wang.Pp
452de3b87aSKai WangArgument
462de3b87aSKai Wang.Ar cmd
472de3b87aSKai Wanginforms the library of the action to be taken:
482de3b87aSKai Wang.Bl -tag -width "ELF_C_FDDONE"
492de3b87aSKai Wang.It Dv ELF_C_FDDONE
502de3b87aSKai WangThis value instructs the ELF library not to perform any further
512de3b87aSKai WangI/O on the file descriptor associated with argument
522de3b87aSKai Wang.Ar elf .
532de3b87aSKai WangFor ELF descriptors opened with mode
542de3b87aSKai Wang.Ar ELF_C_WRITE
552de3b87aSKai Wangor
562de3b87aSKai Wang.Ar ELF_C_RDWR
572de3b87aSKai Wangsubsequent
582de3b87aSKai Wang.Fn elf_update
592de3b87aSKai Wangoperations on the descriptor will fail.
602de3b87aSKai Wang.It Dv ELF_C_FDREAD
612de3b87aSKai WangThis value instructs the ELF library to read in all necessary
622de3b87aSKai Wangdata associated with ELF descriptor
632de3b87aSKai Wang.Ar elf
642de3b87aSKai Wanginto memory so that the underlying file descriptor can be
652de3b87aSKai Wangsafely closed with command
662de3b87aSKai Wang.Dv ELF_C_FDDONE .
672de3b87aSKai Wang.El
682de3b87aSKai Wang.Pp
692de3b87aSKai WangArgument
702de3b87aSKai Wang.Ar elf
712de3b87aSKai Wangmust be an ELF descriptor associated with a file system object
722de3b87aSKai Wang(e.g., an
732de3b87aSKai Wang.Xr ar 1
742de3b87aSKai Wangarchive, an ELF file, or other data file).
752de3b87aSKai Wang.Sh IMPLEMENTATION NOTES
762de3b87aSKai WangDue to use of
772de3b87aSKai Wang.Xr mmap 2
782de3b87aSKai Wanginternally, this function is a no-op for ELF objects opened in
792de3b87aSKai Wang.Dv ELF_C_READ
802de3b87aSKai Wangmode.
812de3b87aSKai Wang.Sh RETURN VALUES
822de3b87aSKai WangFunction
832de3b87aSKai Wang.Fn elf_cntl
842de3b87aSKai Wangreturns 0 on success, or -1 if an error was detected.
852de3b87aSKai Wang.Sh ERRORS
862de3b87aSKai Wang.Bl -tag -width "[ELF_E_RESOURCE]"
872de3b87aSKai Wang.It Bq Er ELF_E_ARCHIVE
882de3b87aSKai WangArgument
892de3b87aSKai Wang.Ar elf
902de3b87aSKai Wangis a descriptor for an archive member.
912de3b87aSKai Wang.It Bq Er ELF_E_ARGUMENT
922de3b87aSKai WangArgument
932de3b87aSKai Wang.Ar elf
942de3b87aSKai Wangwas NULL.
952de3b87aSKai Wang.It Bq Er ELF_E_ARGUMENT
962de3b87aSKai WangArgument
972de3b87aSKai Wang.Ar cmd
982de3b87aSKai Wangwas not recognized.
992de3b87aSKai Wang.It Bq Er ELF_E_MODE
1002de3b87aSKai WangAn
1012de3b87aSKai Wang.Dv ELF_C_FDREAD
1022de3b87aSKai Wangoperation was requested on an ELF descriptor opened
1032de3b87aSKai Wangfor writing.
1042de3b87aSKai Wang.El
1052de3b87aSKai Wang.Sh SEE ALSO
1062de3b87aSKai Wang.Xr elf 3 ,
1072de3b87aSKai Wang.Xr elf_begin 3 ,
1082de3b87aSKai Wang.Xr elf_end 3 ,
1092de3b87aSKai Wang.Xr elf_next 3 ,
1102de3b87aSKai Wang.Xr elf_update 3 ,
1112de3b87aSKai Wang.Xr gelf 3
112