1*5ac3bc71Schristos.\" $NetBSD: elf_getphdrnum.3,v 1.6 2024/03/03 17:37:33 christos Exp $ 2e81373b4Schristos.\" 39dd9d0cfSchristos.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved. 49dd9d0cfSchristos.\" 59dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without 69dd9d0cfSchristos.\" modification, are permitted provided that the following conditions 79dd9d0cfSchristos.\" are met: 89dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright 99dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer. 109dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright 119dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer in the 129dd9d0cfSchristos.\" documentation and/or other materials provided with the distribution. 139dd9d0cfSchristos.\" 149dd9d0cfSchristos.\" This software is provided by Joseph Koshy ``as is'' and 159dd9d0cfSchristos.\" any express or implied warranties, including, but not limited to, the 169dd9d0cfSchristos.\" implied warranties of merchantability and fitness for a particular purpose 179dd9d0cfSchristos.\" are disclaimed. in no event shall Joseph Koshy be liable 189dd9d0cfSchristos.\" for any direct, indirect, incidental, special, exemplary, or consequential 199dd9d0cfSchristos.\" damages (including, but not limited to, procurement of substitute goods 209dd9d0cfSchristos.\" or services; loss of use, data, or profits; or business interruption) 219dd9d0cfSchristos.\" however caused and on any theory of liability, whether in contract, strict 229dd9d0cfSchristos.\" liability, or tort (including negligence or otherwise) arising in any way 239dd9d0cfSchristos.\" out of the use of this software, even if advised of the possibility of 249dd9d0cfSchristos.\" such damage. 259dd9d0cfSchristos.\" 263f622274Sjkoshy.\" Id: elf_getphdrnum.3 3956 2022-03-12 12:39:30Z jkoshy 279dd9d0cfSchristos.\" 28c5261b83Sjkoshy.Dd July 25, 2018 299dd9d0cfSchristos.Dt ELF_GETPHDRNUM 3 30c5261b83Sjkoshy.Os 319dd9d0cfSchristos.Sh NAME 329dd9d0cfSchristos.Nm elf_getphdrnum 339dd9d0cfSchristos.Nd return the number of program headers in an ELF file 349dd9d0cfSchristos.Sh LIBRARY 359dd9d0cfSchristos.Lb libelf 369dd9d0cfSchristos.Sh SYNOPSIS 379dd9d0cfSchristos.In libelf.h 389dd9d0cfSchristos.Ft int 399dd9d0cfSchristos.Fn elf_getphdrnum "Elf *elf" "size_t *phnum" 409dd9d0cfSchristos.Sh DESCRIPTION 419dd9d0cfSchristosFunction 429dd9d0cfSchristos.Fn elf_getphdrnum 439dd9d0cfSchristosretrieves the number of ELF program headers associated with descriptor 443f622274Sjkoshy.Fa elf 459dd9d0cfSchristosand stores it into the location pointed to by argument 463f622274Sjkoshy.Fa phnum . 479dd9d0cfSchristos.Pp 489dd9d0cfSchristosThis routine allows applications to uniformly process both normal ELF 499dd9d0cfSchristosobjects and ELF objects that use extended numbering. 509dd9d0cfSchristos.Sh RETURN VALUES 519dd9d0cfSchristosFunction 529dd9d0cfSchristos.Fn elf_getphdrnum 539dd9d0cfSchristosreturns a zero value if successful, or -1 in case of an error. 549dd9d0cfSchristos.Sh ERRORS 559dd9d0cfSchristosFunction 56c5261b83Sjkoshy.Fn elf_getphdrnum 579dd9d0cfSchristoscan fail with the following errors: 589dd9d0cfSchristos.Bl -tag -width "[ELF_E_RESOURCE]" 599dd9d0cfSchristos.It Bq Er ELF_E_ARGUMENT 60c5261b83SjkoshyA 61c5261b83Sjkoshy.Dv NULL 62c5261b83Sjkoshyvalue was passed in for argument 633f622274Sjkoshy.Fa elf . 649dd9d0cfSchristos.It Bq Er ELF_E_ARGUMENT 659dd9d0cfSchristosArgument 663f622274Sjkoshy.Fa elf 679dd9d0cfSchristoswas not for an ELF file. 689dd9d0cfSchristos.It Bq Er ELF_E_ARGUMENT 699dd9d0cfSchristosArgument 703f622274Sjkoshy.Fa elf 719dd9d0cfSchristoslacks an ELF Executable Header. 729dd9d0cfSchristos.It Bq Er ELF_E_HEADER 739dd9d0cfSchristosThe ELF Executable Header associated with argument 743f622274Sjkoshy.Fa elf 759dd9d0cfSchristoswas corrupt. 769dd9d0cfSchristos.It Bq Er ELF_E_SECTION 779dd9d0cfSchristosThe section header at index 789dd9d0cfSchristos.Dv SHN_UNDEF 799dd9d0cfSchristoswas corrupt. 809dd9d0cfSchristos.El 819dd9d0cfSchristos.Sh SEE ALSO 829dd9d0cfSchristos.Xr elf 3 , 839dd9d0cfSchristos.Xr elf32_getehdr 3 , 849dd9d0cfSchristos.Xr elf64_getehdr 3 , 859dd9d0cfSchristos.Xr elf_getident 3 , 869dd9d0cfSchristos.Xr elf_getshdrnum 3 , 879dd9d0cfSchristos.Xr elf_getshdrstrndx 3 , 889dd9d0cfSchristos.Xr gelf 3 , 899dd9d0cfSchristos.Xr gelf_getehdr 3 90