1.\" $NetBSD: gelf_getsyminfo.3,v 1.4 2021/03/08 20:55:06 jkoshy Exp $ 2.\" 3.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" This software is provided by Joseph Koshy ``as is'' and 15.\" any express or implied warranties, including, but not limited to, the 16.\" implied warranties of merchantability and fitness for a particular purpose 17.\" are disclaimed. in no event shall Joseph Koshy be liable 18.\" for any direct, indirect, incidental, special, exemplary, or consequential 19.\" damages (including, but not limited to, procurement of substitute goods 20.\" or services; loss of use, data, or profits; or business interruption) 21.\" however caused and on any theory of liability, whether in contract, strict 22.\" liability, or tort (including negligence or otherwise) arising in any way 23.\" out of the use of this software, even if advised of the possibility of 24.\" such damage. 25.\" 26.\" Id: gelf_getsyminfo.3 3928 2021-03-07 19:47:55Z jkoshy 27.\" 28.Dd April 22, 2019 29.Dt GELF_GETSYMINFO 3 30.Os 31.Sh NAME 32.Nm gelf_getsyminfo , 33.Nm gelf_update_syminfo 34.Nd read and update symbol information 35.Sh LIBRARY 36.Lb libelf 37.Sh SYNOPSIS 38.In gelf.h 39.Ft "GElf_Syminfo *" 40.Fn gelf_getsyminfo "Elf_Data *data" "int ndx" "GElf_Syminfo *syminfo" 41.Ft int 42.Fn gelf_update_syminfo "Elf_Data *data" "int ndx" "GElf_Syminfo *syminfo" 43.Sh DESCRIPTION 44These convenience functions are used to retrieve and update class-dependent 45.Vt Elf32_Syminfo 46and 47.Vt Elf64_Syminfo 48records in an ELF object. 49.Pp 50Argument 51.Ar data 52is an 53.Vt Elf_Data 54descriptor associated with a section of type 55.Dv SHT_SUNW_syminfo . 56Argument 57.Ar ndx 58is the index of the record being retrieved or updated. 59The class-independent 60.Vt GElf_Syminfo 61structure is described in 62.Xr gelf 3 . 63.Pp 64Function 65.Fn gelf_getsyminfo 66retrieves class-dependent record at index 67.Ar ndx 68in data buffer 69.Ar data 70and copies it to the destination pointed to by argument 71.Ar syminfo 72after translation to class-independent form. 73.Pp 74Function 75.Fn gelf_update_syminfo 76converts the class-independent record pointed to 77by argument 78.Ar syminfo 79to class-dependent form, and writes it to the record at index 80.Ar ndx 81in the data buffer described by argument 82.Ar data . 83.Sh RETURN VALUES 84Function 85.Fn gelf_getsyminfo 86returns the value of argument 87.Ar syminfo 88if successful, or 89.Dv NULL 90in case of an error. 91Function 92.Fn gelf_update_syminfo 93returns a non-zero value if successful, or zero in case of an error. 94.Sh ERRORS 95These functions may fail with the following errors: 96.Bl -tag -width "[ELF_E_RESOURCE]" 97.It Bq Er ELF_E_ARGUMENT 98Arguments 99.Ar data 100or 101.Ar syminfo 102were 103.Dv NULL . 104.It Bq Er ELF_E_ARGUMENT 105Argument 106.Ar ndx 107was less than zero or larger than the number of symbols in the data 108descriptor. 109.It Bq Er ELF_E_ARGUMENT 110Data descriptor 111.Ar data 112was not associated with a section containing symbol information. 113.It Bq Er ELF_E_VERSION 114The 115.Vt Elf_Data 116descriptor denoted by argument 117.Ar data 118is associated with an ELF object with an unsupported version. 119.El 120.Sh SEE ALSO 121.Xr elf 3 , 122.Xr elf_getdata 3 , 123.Xr elf_getscn 3 , 124.Xr gelf 3 , 125.Xr gelf_getsym 3 , 126.Xr gelf_update_sym 3 127