1.\" $NetBSD: dwarf_get_loclist_entry.3,v 1.6 2024/03/03 17:37:31 christos Exp $ 2.\" 3.\" Copyright (c) 2011 Kai Wang 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" Id: dwarf_get_loclist_entry.3 3963 2022-03-12 16:07:32Z jkoshy 28.\" 29.Dd July 6, 2011 30.Dt DWARF_GET_LOCLIST_ENTRY 3 31.Os 32.Sh NAME 33.Nm dwarf_get_loclist_entry 34.Nd retrieve DWARF location list entry 35.Sh LIBRARY 36.Lb libdwarf 37.Sh SYNOPSIS 38.In libdwarf.h 39.Ft int 40.Fo dwarf_get_loclist_entry 41.Fa "Dwarf_Debug dbg" 42.Fa "Dwarf_Unsigned offset" 43.Fa "Dwarf_Addr *hipc" 44.Fa "Dwarf_Addr *lopc" 45.Fa "Dwarf_Ptr *data" 46.Fa "Dwarf_Unsigned *entry_len" 47.Fa "Dwarf_Unsigned *next_entry" 48.Fa "Dwarf_Error *err" 49.Fc 50.Sh DESCRIPTION 51Function 52.Fn dwarf_get_loclist_entry 53retrieves a location list entry from the DWARF section 54.Dq ".debug_loc" . 55.Pp 56Argument 57.Fa dbg 58should reference a DWARF debug context allocated using 59.Xr dwarf_init 3 . 60.Pp 61Argument 62.Fa offset 63is an offset, relative to the 64.Dq ".debug_loc" 65section, to the start of the desired location list entry. 66.Pp 67Argument 68.Fa hipc 69should point to a location which will hold the offset, relative to the 70base address of the location list entry, of the highest program 71counter value for the entry. 72.Pp 73Argument 74.Fa lowpc 75should point to a location which will hold the offset, relative to the 76base address of the location list entry, of the lowest program counter 77value for the entry. 78.Pp 79Argument 80.Fa data 81should point to a location which will be set to a pointer to the location 82list data. 83.Pp 84Argument 85.Fa entry_len 86should point to a location which will hold the length in bytes of the 87location list data returned in argument 88.Fa data . 89.Pp 90Argument 91.Fa next_entry 92should point to a location which will hold the offset of the next 93location list entry. 94.Pp 95If argument 96.Fa err 97is not 98.Dv NULL , 99it will be used to store error information in case of an error. 100.Sh RETURN VALUES 101Function 102.Fn dwarf_get_loclist_entry 103returns 104.Dv DW_DLV_OK 105when it succeeds. 106It returns 107.Dv DW_DLV_NO_ENTRY 108if there is no location list at the specified offset 109.Fa offset . 110In case of an error, it returns 111.Dv DW_DLV_ERROR 112and sets the argument 113.Fa err . 114.Sh EXAMPLES 115To iterate through all the location list entries in the 116.Dq ".debug_loc" 117section, use: 118.Bd -literal -offset indent 119Dwarf_Debug dbg; 120Dwarf_Unsigned off, len, next; 121Dwarf_Addr hipc, lopc; 122Dwarf_Ptr data; 123Dwarf_Error de; 124int ret; 125 126off = 0; 127while ((ret = dwarf_get_loclist_entry(dbg, off, &hipc, &lopc, &data, 128 &len, &next, &de)) == DW_DLV_OK) { 129 /* ... use loclist entry ... */ 130 off = next; 131} 132if (ret == DW_DLV_ERROR) 133 warnx("dwarf_get_loclist_entry failed: %s", dwarf_errmsg(de)); 134.Ed 135.Sh ERRORS 136Function 137.Fn dwarf_get_loclist_entry 138can fail with: 139.Bl -tag -width ".Bq Er DW_DLE_NO_ENTRY" 140.It Bq Er DW_DLE_ARGUMENT 141One of the arguments 142.Fa dbg , 143.Fa hipc , 144.Fa lopc , 145.Fa data , 146.Fa entry_len 147or 148.Fa next_entry 149was 150.Dv NULL . 151.It Bq Er DW_DLE_NO_ENTRY 152There is no location list at the specified offset 153.Fa offset . 154.El 155.Sh SEE ALSO 156.Xr dwarf 3 , 157.Xr dwarf_loclist 3 , 158.Xr dwarf_loclist_from_expr 3 , 159.Xr dwarf_loclist_from_expr_a 3 , 160.Xr dwarf_loclist_n 3 161