1.\" Copyright (c) 2014 Kai Wang 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $Id: dwarf_next_types_section.3 3116 2014-12-20 18:26:55Z jkoshy $ 26.\" 27.Dd December 20, 2014 28.Os 29.Dt DWARF_NEXT_TYPES_SECTION 3 30.Sh NAME 31.Nm dwarf_next_types_section 32.Nd step through .debug_types sections in a debug context 33.Sh LIBRARY 34.Lb libdwarf 35.Sh SYNOPSIS 36.In libdwarf.h 37.Ft int 38.Fo dwarf_next_types_section 39.Fa "Dwarf_Debug dbg" 40.Fa "Dwarf_Error *err" 41.Fc 42.Sh DESCRIPTION 43Function 44.Fn dwarf_next_types_section 45steps through the 46.Dq \&.debug_types 47sections found in a debug context. 48.Pp 49Argument 50.Ar dbg 51should reference a DWARF debug context allocated using 52.Xr dwarf_init 3 . 53Argument 54.Ar err 55should point to a location that will hold an error descriptor in case 56of an error. 57.Pp 58When a DWARF debug context is allocated using 59.Xr dwarf_init 3 , 60an internal pointer associated with the context will point to the 61first 62.Dq \&.debug_types 63section present in the debug object. 64When the application calls function 65.Fn dwarf_next_types_section , 66this internal pointer will move to the next 67.Dq \&.debug_types 68section present. 69On stepping past the last 70.Dq \&.debug_types 71section left in the debug context, function 72.Fn dwarf_next_types_section 73returns 74.Dv DW_DLV_NO_ENTRY . 75The next call to the function will restart from the first 76.Dq \&.debug_types 77section in the debug context. 78.Pp 79Application code should call function 80.Xr dwarf_next_cu_header_c 3 81to iterate though the type units associated with the current 82.Dq \&.debug_types 83section. 84.Sh RETURN VALUES 85On success, function 86.Fn dwarf_next_types_section 87returns 88.Dv DW_DLV_OK . 89.Pp 90In case of an error, it returns 91.Dv DW_DLV_ERROR 92and sets argument 93.Ar err . 94When there are no more 95.Dq \&.debug_types 96sections left to traverse, it returns 97.Dv DW_DLV_NO_ENTRY . 98.Sh COMPATIBILITY 99This function is an extension to the 100.Xr DWARF 3 101API. 102.Sh ERRORS 103The 104.Fn dwarf_next_types_section 105function may fail with the following errors: 106.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 107.It Bq Er DW_DLE_ARGUMENT 108Argument 109.Va dbg 110was NULL. 111.El 112.Sh EXAMPLES 113To iterate though every type unit in all the 114.Dq \&.debug_types 115sections found in a debug context: 116.Bd -literal -offset indent 117Dwarf_Debug dbg; 118Dwarf_Sig8 sig8; 119Dwarf_Unsigned typeoff; 120Dwarf_Error de; 121 122\&... allocate dbg using dwarf_init() etc ... 123 124do { 125 while ((ret = dwarf_next_cu_header_c(dbg, 0, NULL, NULL, NULL, 126 NULL, NULL, NULL, &sig8, &typeoff, NULL, &de)) == DW_DLV_OK) { 127 /* Access DIEs etc ... */ 128 } 129} while (dwarf_next_types_section(dbg, &de) == DW_DLV_OK); 130.Ed 131.Sh SEE ALSO 132.Xr dwarf 3 , 133.Xr dwarf_init 3 , 134.Xr dwarf_next_cu_header_c 3 135