xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf_get_cu_die_offset.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2011 Kai Wang
22de3b87aSKai Wang.\" All rights reserved.
32de3b87aSKai Wang.\"
42de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
52de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
62de3b87aSKai Wang.\" are met:
72de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
82de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
92de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
102de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
112de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
122de3b87aSKai Wang.\"
132de3b87aSKai Wang.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
142de3b87aSKai Wang.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
152de3b87aSKai Wang.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
162de3b87aSKai Wang.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
172de3b87aSKai Wang.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
182de3b87aSKai Wang.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
192de3b87aSKai Wang.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
202de3b87aSKai Wang.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
212de3b87aSKai Wang.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
222de3b87aSKai Wang.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232de3b87aSKai Wang.\" SUCH DAMAGE.
242de3b87aSKai Wang.\"
25*ae500c1fSEd Maste.\" $Id: dwarf_get_cu_die_offset.3 3640 2018-10-14 14:09:13Z jkoshy $
262de3b87aSKai Wang.\"
272de3b87aSKai Wang.Dd April 10, 2011
282de3b87aSKai Wang.Dt DWARF_GET_CU_DIE_OFFSET 3
29*ae500c1fSEd Maste.Os
302de3b87aSKai Wang.Sh NAME
312de3b87aSKai Wang.Nm dwarf_get_arange_cu_header_offset ,
322de3b87aSKai Wang.Nm dwarf_get_cu_die_offset
332de3b87aSKai Wang.Nd retrieve compilation unit offsets
342de3b87aSKai Wang.Sh LIBRARY
352de3b87aSKai Wang.Lb libdwarf
362de3b87aSKai Wang.Sh SYNOPSIS
372de3b87aSKai Wang.In libdwarf.h
382de3b87aSKai Wang.Ft int
392de3b87aSKai Wang.Fo dwarf_get_arange_cu_header_offset
402de3b87aSKai Wang.Fa "Dwarf_Arange ar"
412de3b87aSKai Wang.Fa "Dwarf_Off *ret"
422de3b87aSKai Wang.Fa "Dwarf_Error *err"
432de3b87aSKai Wang.Fc
442de3b87aSKai Wang.Ft int
452de3b87aSKai Wang.Fo dwarf_get_cu_die_offset
462de3b87aSKai Wang.Fa "Dwarf_Arange ar"
472de3b87aSKai Wang.Fa "Dwarf_Off *ret"
482de3b87aSKai Wang.Fa "Dwarf_Error *err"
492de3b87aSKai Wang.Fc
502de3b87aSKai Wang.Sh DESCRIPTION
512de3b87aSKai WangThese functions retrieve the offsets, relative to the
522de3b87aSKai Wang.Dq ".debug_info"
532de3b87aSKai WangDWARF section, of the debugging information entries describing the
542de3b87aSKai Wangcompilation unit associated with a
552de3b87aSKai Wang.Vt Dwarf_Arange
562de3b87aSKai Wangdescriptor.
572de3b87aSKai Wang.Pp
582de3b87aSKai WangFunction
592de3b87aSKai Wang.Fn dwarf_get_arange_cu_header_offset
602de3b87aSKai Wangretrieves the offset of the compilation unit header associated with
612de3b87aSKai Wangargument
622de3b87aSKai Wang.Ar ar ,
632de3b87aSKai Wangand stores it in the location pointed to by argument
642de3b87aSKai Wang.Ar ret .
652de3b87aSKai Wang.Pp
662de3b87aSKai WangFunction
672de3b87aSKai Wang.Fn dwarf_get_cu_die_offset
682de3b87aSKai Wangretrieves the offset of the debugging information entry for the
692de3b87aSKai Wangcompilation unit associated with argument
702de3b87aSKai Wang.Ar ar ,
712de3b87aSKai Wangand stores it in the location pointed to by argument
722de3b87aSKai Wang.Ar ret .
732de3b87aSKai Wang.Pp
742de3b87aSKai WangIf argument
752de3b87aSKai Wang.Ar err
762de3b87aSKai Wangis not NULL, these functions will use it to store error information,
772de3b87aSKai Wangin case of an error.
782de3b87aSKai Wang.Sh RETURN VALUES
792de3b87aSKai WangOn success, these functions returns
802de3b87aSKai Wang.Dv DW_DLV_OK .
812de3b87aSKai WangIn case of an error, they return
822de3b87aSKai Wang.Dv DW_DLV_ERROR
832de3b87aSKai Wangand set the argument
842de3b87aSKai Wang.Ar err .
852de3b87aSKai Wang.Sh ERRORS
862de3b87aSKai WangThese functions may fail with:
872de3b87aSKai Wang.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
882de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
892de3b87aSKai WangArgument
902de3b87aSKai Wang.Ar ar
912de3b87aSKai Wangwas not a valid
922de3b87aSKai Wang.Vt Dwarf_Arange
932de3b87aSKai Wangdescriptor.
942de3b87aSKai Wang.It Bq Er DW_DLE_ARGUMENT
952de3b87aSKai WangArgument
962de3b87aSKai Wang.Ar ret
972de3b87aSKai Wangwas NULL.
982de3b87aSKai Wang.El
992de3b87aSKai Wang.Sh SEE ALSO
1002de3b87aSKai Wang.Xr dwarf 3 ,
1012de3b87aSKai Wang.Xr dwarf_get_arange 3 ,
1022de3b87aSKai Wang.Xr dwarf_get_arange_info 3 ,
1032de3b87aSKai Wang.Xr dwarf_get_aranges 3
104