1*5ac3bc71Schristos.\" $NetBSD: dwarf_get_elf.3,v 1.6 2024/03/03 17:37:31 christos Exp $ 2e81373b4Schristos.\" 39dd9d0cfSchristos.\" Copyright (c) 2009 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.\" 26cdbf1fe1Sjkoshy.\" Id: dwarf_get_elf.3 3962 2022-03-12 15:56:10Z jkoshy 279dd9d0cfSchristos.\" 289dd9d0cfSchristos.Dd November 9, 2011 299dd9d0cfSchristos.Dt DWARF_GET_ELF 3 30604b0842Sjkoshy.Os 319dd9d0cfSchristos.Sh NAME 329dd9d0cfSchristos.Nm dwarf_get_elf 339dd9d0cfSchristos.Nd retrieve the 349dd9d0cfSchristos.Vt Elf 359dd9d0cfSchristosdescriptor associated with a 369dd9d0cfSchristos.Vt Dwarf_Debug 379dd9d0cfSchristosinstance 389dd9d0cfSchristos.Sh LIBRARY 399dd9d0cfSchristos.Lb libdwarf 409dd9d0cfSchristos.Sh SYNOPSIS 419dd9d0cfSchristos.In libdwarf.h 429dd9d0cfSchristos.Ft int 439dd9d0cfSchristos.Fo dwarf_get_elf 449dd9d0cfSchristos.Fa "Dwarf_Debug dbg" 459dd9d0cfSchristos.Fa "Elf **elf" 469dd9d0cfSchristos.Fa "Dwarf_Error *err" 479dd9d0cfSchristos.Fc 489dd9d0cfSchristos.Sh DESCRIPTION 499dd9d0cfSchristosFunction 509dd9d0cfSchristos.Fn dwarf_get_elf 519dd9d0cfSchristosreturns the 529dd9d0cfSchristos.Vt Elf 539dd9d0cfSchristosdescriptor associated with a 549dd9d0cfSchristos.Vt Dwarf_Debug 559dd9d0cfSchristosinstance. 569dd9d0cfSchristos.Pp 579dd9d0cfSchristosArgument 58cdbf1fe1Sjkoshy.Fa dbg 599dd9d0cfSchristosshould be a handle to a valid 609dd9d0cfSchristos.Vt Dwarf_Debug 619dd9d0cfSchristosinstance returned by a prior call to 629dd9d0cfSchristos.Xr dwarf_init 3 639dd9d0cfSchristosor 649dd9d0cfSchristos.Xr dwarf_elf_init 3 . 659dd9d0cfSchristos.Pp 669dd9d0cfSchristosArgument 67cdbf1fe1Sjkoshy.Fa elf 689dd9d0cfSchristospoints a location into which a handle to an 699dd9d0cfSchristos.Vt Elf 709dd9d0cfSchristosdescriptor will be written. 719dd9d0cfSchristos.Pp 729dd9d0cfSchristosArgument 73cdbf1fe1Sjkoshy.Fa err 749dd9d0cfSchristosis used to record error information in case of failure. 759dd9d0cfSchristos.Sh RETURN VALUES 769dd9d0cfSchristosOn success, function 779dd9d0cfSchristos.Fn dwarf_get_elf 789dd9d0cfSchristosreturns 799dd9d0cfSchristos.Dv DW_DLV_OK . 809dd9d0cfSchristosIn case of an error, it returns 819dd9d0cfSchristos.Dv DW_DLV_ERROR 829dd9d0cfSchristosand sets argument 83cdbf1fe1Sjkoshy.Fa err . 849dd9d0cfSchristos.Sh EXAMPLES 859dd9d0cfSchristosTo retrieve the 869dd9d0cfSchristos.Vt Elf 879dd9d0cfSchristosinstance associated with a 889dd9d0cfSchristos.Vt Dwarf_Debug 899dd9d0cfSchristosinstance use: 909dd9d0cfSchristos.Bd -literal -offset indent 919dd9d0cfSchristosDwarf_Debug dbg; 929dd9d0cfSchristosDwarf_Error de; 939dd9d0cfSchristosElf *elf; 949dd9d0cfSchristos 959dd9d0cfSchristos\&... allocate dbg using dwarf_init() etc ... 969dd9d0cfSchristos 979dd9d0cfSchristosif (dwarf_get_elf(dbg, &elf, &de) != DW_DLV_OK) 989dd9d0cfSchristos errx(EXIT_FAILURE, "dwarf_get_elf: %s", dwarf_errmsg(de)); 999dd9d0cfSchristos.Ed 1009dd9d0cfSchristos.Sh SEE ALSO 1019dd9d0cfSchristos.Xr dwarf 3 , 1029dd9d0cfSchristos.Xr dwarf_errmsg 3 , 1039dd9d0cfSchristos.Xr dwarf_finish 3 , 104604b0842Sjkoshy.Xr dwarf_init 3 , 1059dd9d0cfSchristos.Xr elf 3 106