xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_get_elf.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2009 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: dwarf_get_elf.3 3644 2018-10-15 19:55:01Z jkoshy $
252de3b87aSKai Wang.\"
262de3b87aSKai Wang.Dd November 9, 2011
272de3b87aSKai Wang.Dt DWARF_GET_ELF 3
28*ae500c1fSEd Maste.Os
292de3b87aSKai Wang.Sh NAME
302de3b87aSKai Wang.Nm dwarf_get_elf
312de3b87aSKai Wang.Nd retrieve the
322de3b87aSKai Wang.Vt Elf
332de3b87aSKai Wangdescriptor associated with a
342de3b87aSKai Wang.Vt Dwarf_Debug
352de3b87aSKai Wanginstance
362de3b87aSKai Wang.Sh LIBRARY
372de3b87aSKai Wang.Lb libdwarf
382de3b87aSKai Wang.Sh SYNOPSIS
392de3b87aSKai Wang.In libdwarf.h
402de3b87aSKai Wang.Ft int
412de3b87aSKai Wang.Fo dwarf_get_elf
422de3b87aSKai Wang.Fa "Dwarf_Debug dbg"
432de3b87aSKai Wang.Fa "Elf **elf"
442de3b87aSKai Wang.Fa "Dwarf_Error *err"
452de3b87aSKai Wang.Fc
462de3b87aSKai Wang.Sh DESCRIPTION
472de3b87aSKai WangFunction
482de3b87aSKai Wang.Fn dwarf_get_elf
492de3b87aSKai Wangreturns the
502de3b87aSKai Wang.Vt Elf
512de3b87aSKai Wangdescriptor associated with a
522de3b87aSKai Wang.Vt Dwarf_Debug
532de3b87aSKai Wanginstance.
542de3b87aSKai Wang.Pp
552de3b87aSKai WangArgument
562de3b87aSKai Wang.Ar dbg
572de3b87aSKai Wangshould be a handle to a valid
582de3b87aSKai Wang.Vt Dwarf_Debug
592de3b87aSKai Wanginstance returned by a prior call to
602de3b87aSKai Wang.Xr dwarf_init 3
612de3b87aSKai Wangor
622de3b87aSKai Wang.Xr dwarf_elf_init 3 .
632de3b87aSKai Wang.Pp
642de3b87aSKai WangArgument
652de3b87aSKai Wang.Ar elf
662de3b87aSKai Wangpoints a location into which a handle to an
672de3b87aSKai Wang.Vt Elf
682de3b87aSKai Wangdescriptor will be written.
692de3b87aSKai Wang.Pp
702de3b87aSKai WangArgument
712de3b87aSKai Wang.Ar err
722de3b87aSKai Wangis used to record error information in case of failure.
732de3b87aSKai Wang.Sh RETURN VALUES
742de3b87aSKai WangOn success, function
752de3b87aSKai Wang.Fn dwarf_get_elf
762de3b87aSKai Wangreturns
772de3b87aSKai Wang.Dv DW_DLV_OK .
782de3b87aSKai WangIn case of an error, it returns
792de3b87aSKai Wang.Dv DW_DLV_ERROR
802de3b87aSKai Wangand sets argument
812de3b87aSKai Wang.Ar err .
822de3b87aSKai Wang.Sh EXAMPLES
832de3b87aSKai WangTo retrieve the
842de3b87aSKai Wang.Vt Elf
852de3b87aSKai Wanginstance associated with a
862de3b87aSKai Wang.Vt Dwarf_Debug
872de3b87aSKai Wanginstance use:
882de3b87aSKai Wang.Bd -literal -offset indent
892de3b87aSKai WangDwarf_Debug dbg;
902de3b87aSKai WangDwarf_Error de;
912de3b87aSKai WangElf *elf;
922de3b87aSKai Wang
932de3b87aSKai Wang\&... allocate dbg using dwarf_init() etc ...
942de3b87aSKai Wang
952de3b87aSKai Wangif (dwarf_get_elf(dbg, &elf, &de) != DW_DLV_OK)
962de3b87aSKai Wang	errx(EXIT_FAILURE, "dwarf_get_elf: %s", dwarf_errmsg(de));
972de3b87aSKai Wang.Ed
982de3b87aSKai Wang.Sh SEE ALSO
992de3b87aSKai Wang.Xr dwarf 3 ,
1002de3b87aSKai Wang.Xr dwarf_errmsg 3 ,
1012de3b87aSKai Wang.Xr dwarf_finish 3 ,
102*ae500c1fSEd Maste.Xr dwarf_init 3 ,
1032de3b87aSKai Wang.Xr elf 3
104