summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/dwarf_formref.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
commit253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch)
treeadf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man3/dwarf_formref.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/dwarf_formref.3')
-rw-r--r--static/netbsd/man3/dwarf_formref.3140
1 files changed, 140 insertions, 0 deletions
diff --git a/static/netbsd/man3/dwarf_formref.3 b/static/netbsd/man3/dwarf_formref.3
new file mode 100644
index 00000000..3299e4a5
--- /dev/null
+++ b/static/netbsd/man3/dwarf_formref.3
@@ -0,0 +1,140 @@
+.\" $NetBSD: dwarf_formref.3,v 1.6 2024/03/03 17:37:31 christos Exp $
+.\"
+.\" Copyright (c) 2010 Joseph Koshy
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" Id: dwarf_formref.3 3962 2022-03-12 15:56:10Z jkoshy
+.\"
+.Dd June 21, 2010
+.Dt DWARF_FORMREF 3
+.Os
+.Sh NAME
+.Nm dwarf_formref ,
+.Nm dwarf_global_formref
+.Nd retrieve offsets for REFERENCE class attributes
+.Sh LIBRARY
+.Lb libdwarf
+.Sh SYNOPSIS
+.In libdwarf.h
+.Ft int
+.Fo dwarf_formref
+.Fa "Dwarf_Attribute attr"
+.Fa "Dwarf_Off *retoffset"
+.Fa "Dwarf_Error *err"
+.Fc
+.Ft int
+.Fo dwarf_global_formref
+.Fa "Dwarf_Attribute attr"
+.Fa "Dwarf_Off *retoffset"
+.Fa "Dwarf_Error *err"
+.Fc
+.Sh DESCRIPTION
+These functions return the offsets associated with a DWARF attribute
+descriptor.
+.Pp
+Function
+.Fn dwarf_formref
+returns the compilation unit relative offset of the descriptor
+referenced by argument
+.Fa attr
+in the location pointed to by argument
+.Fa retoffset .
+Argument
+.Fa attr
+must be a reference that is local to a compilation unit.
+Permitted forms for argument
+.Fa attr
+are
+.Dv DW_FORM_ref1 ,
+.Dv DW_FORM_ref2 ,
+.Dv DW_FORM_ref4 ,
+.Dv DW_FORM_ref8
+and
+.Dv DW_FORM_ref_udata .
+.Pp
+Function
+.Fn dwarf_global_formref
+returns the section-relative offset of the descriptor referenced by
+argument
+.Fa attr
+in the location pointed to by argument
+.Fa retoffset .
+Argument
+.Fa attr
+should be a legal
+.Sy REFERENCE
+class form.
+Permitted forms for argument
+.Fa attr
+are:
+.Dv DW_FORM_ref_addr ,
+.Dv DW_FORM_ref_udata ,
+.Dv DW_FORM_ref1 ,
+.Dv DW_FORM_ref2 ,
+.Dv DW_FORM_ref4 ,
+.Dv DW_FORM_ref8
+and
+.Dv DW_FORM_sec_offset .
+The returned offset is relative to the start of the
+.Dq .debug_info
+ELF section.
+.Pp
+If argument
+.Fa err
+is not
+.Dv NULL ,
+it will be used to return an error descriptor in case of an error.
+.Sh RETURN VALUES
+These functions return
+.Dv DW_DLV_OK
+on success.
+In case of an error, these functions return
+.Dv DW_DLV_ERROR
+and sets argument
+.Fa err .
+.Sh ERRORS
+These functions may fail with the following errors:
+.Bl -tag -width ".Bq Er DW_DLE_ATTR_FORM_BAD"
+.It Bq Er DW_DLE_ARGUMENT
+Either of arguments
+.Fa attr
+or
+.Fa retoffset
+was
+.Dv NULL .
+.It Bq Er DW_DLE_ATTR_FORM_BAD
+The attribute referenced by argument
+.Fa attr
+was not of a permitted kind.
+.El
+.Sh SEE ALSO
+.Xr dwarf 3 ,
+.Xr dwarf_attr 3 ,
+.Xr dwarf_formblock 3 ,
+.Xr dwarf_formflag 3 ,
+.Xr dwarf_formsdata 3 ,
+.Xr dwarf_formsig8 3 ,
+.Xr dwarf_formstring 3 ,
+.Xr dwarf_formudata 3 ,
+.Xr dwarf_hasattr 3