1*0a6a1f1dSLionel Sambuc.\" $NetBSD: elf_getphnum.3,v 1.2 2014/03/09 16:58:04 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved. 4*0a6a1f1dSLionel Sambuc.\" 5*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 6*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 7*0a6a1f1dSLionel Sambuc.\" are met: 8*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 9*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 10*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 11*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 12*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 13*0a6a1f1dSLionel Sambuc.\" 14*0a6a1f1dSLionel Sambuc.\" This software is provided by Joseph Koshy ``as is'' and 15*0a6a1f1dSLionel Sambuc.\" any express or implied warranties, including, but not limited to, the 16*0a6a1f1dSLionel Sambuc.\" implied warranties of merchantability and fitness for a particular purpose 17*0a6a1f1dSLionel Sambuc.\" are disclaimed. in no event shall Joseph Koshy be liable 18*0a6a1f1dSLionel Sambuc.\" for any direct, indirect, incidental, special, exemplary, or consequential 19*0a6a1f1dSLionel Sambuc.\" damages (including, but not limited to, procurement of substitute goods 20*0a6a1f1dSLionel Sambuc.\" or services; loss of use, data, or profits; or business interruption) 21*0a6a1f1dSLionel Sambuc.\" however caused and on any theory of liability, whether in contract, strict 22*0a6a1f1dSLionel Sambuc.\" liability, or tort (including negligence or otherwise) arising in any way 23*0a6a1f1dSLionel Sambuc.\" out of the use of this software, even if advised of the possibility of 24*0a6a1f1dSLionel Sambuc.\" such damage. 25*0a6a1f1dSLionel Sambuc.\" 26*0a6a1f1dSLionel Sambuc.\" Id: elf_getphnum.3 467 2009-08-05 18:18:49Z jkoshy 27*0a6a1f1dSLionel Sambuc.\" 28*0a6a1f1dSLionel Sambuc.Dd August 5, 2009 29*0a6a1f1dSLionel Sambuc.Os 30*0a6a1f1dSLionel Sambuc.Dt ELF_GETPHNUM 3 31*0a6a1f1dSLionel Sambuc.Sh NAME 32*0a6a1f1dSLionel Sambuc.Nm elf_getphnum 33*0a6a1f1dSLionel Sambuc.Nd return the number of program headers in an ELF file 34*0a6a1f1dSLionel Sambuc.Sh LIBRARY 35*0a6a1f1dSLionel Sambuc.Lb libelf 36*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 37*0a6a1f1dSLionel Sambuc.In libelf.h 38*0a6a1f1dSLionel Sambuc.Ft int 39*0a6a1f1dSLionel Sambuc.Fn elf_getphnum "Elf *elf" "size_t *phnum" 40*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 41*0a6a1f1dSLionel SambucThis function is deprecated. 42*0a6a1f1dSLionel SambucPlease use function 43*0a6a1f1dSLionel Sambuc.Xr elf_getphdrnum 3 44*0a6a1f1dSLionel Sambucinstead. 45*0a6a1f1dSLionel Sambuc.Pp 46*0a6a1f1dSLionel SambucFunction 47*0a6a1f1dSLionel Sambuc.Fn elf_getphnum 48*0a6a1f1dSLionel Sambucretrieves the number of ELF program headers associated with descriptor 49*0a6a1f1dSLionel Sambuc.Ar elf 50*0a6a1f1dSLionel Sambucand stores it into the location pointed to by argument 51*0a6a1f1dSLionel Sambuc.Ar phnum . 52*0a6a1f1dSLionel Sambuc.Pp 53*0a6a1f1dSLionel SambucThis routine allows applications to uniformly process both normal ELF 54*0a6a1f1dSLionel Sambucobjects and ELF objects that use extended numbering. 55*0a6a1f1dSLionel Sambuc.Pp 56*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 57*0a6a1f1dSLionel SambucFunction 58*0a6a1f1dSLionel Sambuc.Fn elf_getphnum 59*0a6a1f1dSLionel Sambucreturns a non-zero value if successful, or zero in case of an 60*0a6a1f1dSLionel Sambucerror. 61*0a6a1f1dSLionel Sambuc.Sh ERRORS 62*0a6a1f1dSLionel SambucFunction 63*0a6a1f1dSLionel Sambuc.Fn elf_getphnum 64*0a6a1f1dSLionel Sambuccan fail with the following errors: 65*0a6a1f1dSLionel Sambuc.Bl -tag -width "[ELF_E_RESOURCE]" 66*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_ARGUMENT 67*0a6a1f1dSLionel SambucA NULL value was passed in for argument 68*0a6a1f1dSLionel Sambuc.Ar elf . 69*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_ARGUMENT 70*0a6a1f1dSLionel SambucArgument 71*0a6a1f1dSLionel Sambuc.Ar elf 72*0a6a1f1dSLionel Sambucwas not for an ELF file. 73*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_ARGUMENT 74*0a6a1f1dSLionel SambucArgument 75*0a6a1f1dSLionel Sambuc.Ar elf 76*0a6a1f1dSLionel Sambuclacks an ELF Executable Header. 77*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_HEADER 78*0a6a1f1dSLionel SambucThe ELF Executable Header associated with argument 79*0a6a1f1dSLionel Sambuc.Ar elf 80*0a6a1f1dSLionel Sambucwas corrupt. 81*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_SECTION 82*0a6a1f1dSLionel SambucThe section header at index 83*0a6a1f1dSLionel Sambuc.Dv SHN_UNDEF 84*0a6a1f1dSLionel Sambucwas corrupt. 85*0a6a1f1dSLionel Sambuc.El 86*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 87*0a6a1f1dSLionel Sambuc.Xr elf 3 , 88*0a6a1f1dSLionel Sambuc.Xr elf32_getehdr 3 , 89*0a6a1f1dSLionel Sambuc.Xr elf64_getehdr 3 , 90*0a6a1f1dSLionel Sambuc.Xr elf_getident 3 , 91*0a6a1f1dSLionel Sambuc.Xr elf_getphdrnum 3 , 92*0a6a1f1dSLionel Sambuc.Xr elf_getshdrnum 3 , 93*0a6a1f1dSLionel Sambuc.Xr elf_getshdrstrndx 3 , 94*0a6a1f1dSLionel Sambuc.Xr gelf 3 , 95*0a6a1f1dSLionel Sambuc.Xr gelf_getehdr 3 96