xref: /freebsd/contrib/elftoolchain/libdwarf/dwarf.3 (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
1.\" Copyright (c) 2011 Joseph Koshy.  All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" This software is provided by Joseph Koshy ``as is'' and
13.\" any express or implied warranties, including, but not limited to, the
14.\" implied warranties of merchantability and fitness for a particular purpose
15.\" are disclaimed.  in no event shall Joseph Koshy be liable
16.\" for any direct, indirect, incidental, special, exemplary, or consequential
17.\" damages (including, but not limited to, procurement of substitute goods
18.\" or services; loss of use, data, or profits; or business interruption)
19.\" however caused and on any theory of liability, whether in contract, strict
20.\" liability, or tort (including negligence or otherwise) arising in any way
21.\" out of the use of this software, even if advised of the possibility of
22.\" such damage.
23.\"
24.\" $Id: dwarf.3 3195 2015-05-12 17:22:19Z emaste $
25.\"
26.Dd December 21, 2014
27.Os
28.Dt DWARF 3
29.Sh NAME
30.Nm dwarf
31.Nd access debugging information in object files
32.Sh LIBRARY
33.Lb libdwarf
34.Sh SYNOPSIS
35.In libdwarf.h
36.Sh DESCRIPTION
37.Pp
38The
39.Lb libdwarf
40provides functions that allow an application to read and write debugging
41information in object files.
42The format of debugging information accessible through this API
43is defined by the DWARF standard, see
44.Xr dwarf 4 .
45.Pp
46The
47.Xr DWARF 3
48API has two parts:
49.Bl -bullet
50.It
51A consumer API set allows applications to read existing debug information
52in a program object.
53The functions that comprise the DWARF consumer API are described in
54the section
55.Sx "DWARF Consumer API"
56below.
57.It
58A producer API set that allows applications to add debug information
59to a program object.
60The functions that comprise the DWARF producer API are described in
61the section
62.Sx "DWARF Producer API"
63below.
64.El
65.Pp
66Each function referenced below is further described in its own manual page.
67.Ss Namespace use
68The DWARF library uses the following prefixes:
69.Pp
70.Bl -tag -width ".Li Dwarf_*" -compact
71.It Li DWARF_*
72Used for error numbers and constants.
73.It Li DW_*
74Used for constants.
75.It Li Dwarf_*
76Used for types.
77.It Li dwarf_*
78Used for functions and macros that make up the API.
79.El
80.Ss Data Types
81The DWARF(3) API uses the following data types:
82.Pp
83.Bl -tag -width ".Vt Dwarf_Unsigned" -compact
84.It Vt Dwarf_Abbrev
85Describes DWARF abbreviations.
86.It Vt Dwarf_Addr
87A program address in the target object.
88.It Vt Dwarf_Arange
89Describes address ranges.
90.It Vt Dwarf_Attribute , Vt Dwarf_P_Attribute
91Describes attributes of debugging information entries.
92.It Vt Dwarf_Bool
93Used for boolean states.
94.It Vt Dwarf_Cie , Vt Dwarf_P_Cie
95Describes call information that is common to several frames.
96.It Vt Dwarf_Debug , Vt Dwarf_P_Debug
97An opaque type describing a debug context.
98.It Vt Dwarf_Die , Vt Dwarf_P_Die
99A debugging information entry.
100.It Vt Dwarf_Fde , Vt Dwarf_P_Fde
101A frame descriptor.
102.It Vt Dwarf_Func
103A descriptor representing a function.
104.It Vt Dwarf_Global
105A descriptor representing a global name.
106.It Vt Dwarf_Half
107A 16-bit wide unsigned numeric type.
108.It Vt Dwarf_Handler
109A pointer to an error handling function.
110.It Vt Dwarf_Line
111A descriptor for a source line.
112.It Vt Dwarf_Off
113An unsigned file offset, corresponding to an
114.Vt off_t
115type supported by the underlying operating system.
116.It Vt Dwarf_P_Expr
117A descriptor for a location expression.
118.It Vt Dwarf_Ptr
119A virtual address used by an application.
120.It Vt Dwarf_Signed
121A 64-bit wide signed numeric type.
122.It Vt Dwarf_Small
123An 8-bit wide unsigned numeric type.
124.It Vt Dwarf_Type
125A descriptor representing a user-specified type.
126.It Vt Dwarf_Unsigned
127A 64-bit wide unsigned numeric type.
128.It Vt Dwarf_Var
129A descriptor representing a static variable.
130.It Vt Dwarf_Weak
131A descriptor representing a weak name.
132.El
133.Ss Error Handling
134.Pp
135Library functions that encounter an error will return with a value
136other than
137.Dv DW_DLV_OK .
138.Pp
139The
140.Lb libdwarf
141allows applications to specify three levels of error handling:
142.Bl -enum -compact
143.It
144Most library functions take a parameter of type
145.Vt Dwarf_Error
146that specifies a location to store an error descriptor in
147case of an error.
148If an error occurs during the execution on an API, and if this
149parameter is non-NULL, then an error descriptor is written to the
150location specified.
151.It
152Otherwise, if the error parameter was NULL, but if an error handler
153was defined for the debug context in use using
154.Xr dwarf_init 3
155or
156.Xr dwarf_seterrhand 3 ,
157then the library will invoke the specified error handler with an error
158descriptor as argument.
159.It
160Otherwise, if a library wide error handler was specified using
161.Xr dwarf_seterrhand 3 ,
162it is called.
163.El
164.Pp
165Error descriptors may be used with
166.Xr dwarf_errmsg 3
167or
168.Xr dwarf_errno 3 .
169.Sh The DWARF Consumer API
170The DWARF consumer API permits applications to read DWARF information in
171an object file.
172.Pp
173The major functional groups of functions in the consumer API are listed
174below.
175.Pp
176.Bl -tag -compact -width "CCCC"
177.It Abbreviations
178.Bl -tag -compact
179.It Fn dwarf_get_abbrev
180Retrieve abbreviation information at a given offset.
181.It Fn dwarf_get_abbrev_children_flag
182Check if an abbreviation has child elements.
183.It Fn dwarf_get_abbrev_code
184Retrieve the abbreviation code for an abbreviation entry descriptor.
185.It Fn dwarf_get_abbrev_entry
186Retrieve abbreviation information for an abbreviation entry
187descriptor.
188.It Fn dwarf_get_abbrev_tag
189Retrieve the tag for an abbreviation entry.
190.El
191.It Addresses
192.Bl -tag -compact
193.It Fn dwarf_get_address_size
194Return the number of bytes needed to represent an address.
195.It Fn dwarf_get_arange
196Search for an address range descriptor covering an address.
197.It Fn dwarf_get_arange_cu_header_offset
198Retrieve the offsets associated with an address range descriptor.
199.It Fn dwarf_get_arange_info
200Extract address range information from a descriptor.
201.It Fn dwarf_get_aranges
202Retrieve program address space mappings.
203.It Fn dwarf_get_cu_die_offset
204Retrieve the offset associated with a compilation unit for an address
205range descriptor.
206.It Fn dwarf_get_ranges , Fn dwarf_get_ranges_a
207Retrieve information about non-contiguous address ranges for
208a debugging information entry.
209.El
210.It Attributes
211.Bl -tag -compact
212.It Fn dwarf_arrayorder
213Retrieve the value of a
214.Dv DW_AT_ordering
215attribute.
216.It Fn dwarf_attr
217Retrieve an attribute descriptor.
218.It Fn dwarf_attrlist
219Retrieve attribute descriptors for a debugging information entry.
220.It Fn dwarf_attroffset
221Retrieve the section-relative offset of an attribute descriptor.
222.It Fn dwarf_attrval_flag
223Retrieve a
224.Dv DW_AT_FORM_flag
225value.
226.It Fn dwarf_attrval_signed
227Retrieve an attribute's value as a signed integral quantity.
228.It Fn dwarf_attrval_string
229Retrieve an attribute's value as a NUL-terminated string.
230.It Fn dwarf_attrval_unsigned
231Retrieve an attribute's value as an unsigned integral quantity.
232.It Fn dwarf_bitoffset ,
233Retrieve the value of a
234.Dv DW_AT_bit_offset
235attribute.
236.It Fn dwarf_bitsize ,
237Retrieve the value of a
238.Dv DW_AT_bit_size
239attribute.
240.It Fn dwarf_bytesize
241Retrieve the value of a
242.Dv DW_AT_byte_size
243attribute.
244.It Fn dwarf_formaddr
245Return the value of an
246.Dv ADDRESS Ns - Ns
247class attribute.
248.It Fn dwarf_formblock
249Return the value of a
250.Dv BLOCK Ns - Ns
251class attribute
252.It Fn dwarf_formexprloc
253Return information about a location expression.
254.It Fn dwarf_formflag
255Retrieve information about a
256.Dv BOOLEAN Ns - Ns
257class attribute.
258.It Fn dwarf_formref , Fn dwarf_global_formref
259Retrieve offsets for
260.Dv REFERENCE Ns - Ns
261class attributes.
262.It Fn dwarf_formsdata , Fn dwarf_formudata
263Retrieve the value of a
264.Dv CONSTANT Ns - Ns
265class attribute.
266.It Fn dwarf_formsig8
267Return the type signature for a DWARF type.
268.It Fn dwarf_formstring
269Retrieve information about a
270.Dv STRING Ns - Ns
271class attribute.
272.It Fn dwarf_get_form_class
273Retrieve the form class for an attribute.
274.It Fn dwarf_hasattr
275Check for the presence of an attribute.
276.It Fn dwarf_hasform
277Check if an attribute has the given form.
278.It Fn dwarf_whatattr
279Retrieve the attribute code for an attribute.
280.It Fn dwarf_whatform , Fn dwarf_whatform_direct
281Retrieve the form of an attribute.
282.El
283.It Call Information Entries and Frame Descriptor Entries
284.Bl -tag -compact
285.It Fn dwarf_get_cie_index
286Retrieve the index for a CIE descriptor.
287.It Fn dwarf_get_cie_info
288Retrieve information from a CIE descriptor.
289.It Fn dwarf_get_cie_of_fde
290Retrieve a CIE descriptor.
291.It Fn dwarf_get_fde_at_pc
292Retrieve an FDE descriptor for an address.
293.It Fn dwarf_get_fde_info_for_all_regs
294Retrieve register rule row.
295.It Fn dwarf_get_fde_info_for_all_regs3
296Retrieve register rule row (revised API).
297.It Fn dwarf_get_fde_info_for_cfa_reg3
298Retrieve a CFA register rule.
299.It Fn dwarf_get_fde_info_for_reg
300Retrieve a register rule.
301.It Fn dwarf_get_fde_info_for_reg3
302Retrieve a register rule (revised API).
303.It Fn dwarf_get_fde_instr_bytes
304Retrieve instructions from an FDE descriptor.
305.It Fn dwarf_get_fde_list , Fn dwarf_get_fde_list_eh
306Retrieve frame information.
307.It Fn dwarf_get_fde_n
308Retrieve an FDE descriptor.
309.It Fn dwarf_get_fde_range
310Retrieve range information from an FDE descriptor.
311.El
312.It Compilation Units
313.Bl -tag -compact
314.It Xo
315.Fn dwarf_get_cu_die_offset_given_cu_header_offset ,
316.Fn dwarf_get_cu_die_offset_given_cu_header_offset_b
317.Xc
318Retrieve the offset of the debugging information entry for a
319compilation or type unit.
320.It Xo
321.Fn dwarf_next_cu_header ,
322.Fn dwarf_next_cu_header_b ,
323.Fn dwarf_next_cu_header_c
324.Xc
325Step through compilation units in a debug context.
326.El
327.It Debugging Information Entries
328.Bl -tag -compact
329.It Fn dwarf_child
330Returns the child of a debugging information entry.
331.It Fn dwarf_die_abbrev_code
332Returns the abbreviation code for a debugging information entry.
333.It Fn dwarf_die_CU_offset , Fn dwarf_die_CU_offset_range
334Retrieve offsets and lengths for a compilation unit.
335.It Fn dwarf_diename
336Returns the
337.Dv DW_AT_name
338attribute for a debugging information entry.
339.It Fn dwarf_dieoffset
340Retrieves the offset for a debugging information entry.
341.It Fn dwarf_get_die_infotypes_flag
342Indicate the originating section for a debugging information entry.
343.It Fn dwarf_highpc , Fn dwarf_highpc_b
344Return the highest PC value for a debugging information entry.
345.It Fn dwarf_lowpc
346Return the lowest PC value for a debugging information entry.
347.It Fn dwarf_offdie , Fn dwarf_offdie_b
348Retrieve a debugging information entry given an offset.
349.It Fn dwarf_siblingof , Fn dwarf_siblingof_b
350Retrieve the sibling descriptor for a debugging information entry.
351.It Fn dwarf_srclang
352Retrieve the source language attribute for a debugging information
353entry.
354.It Fn dwarf_tag
355Retrieve the tag for a debugging information entry.
356.El
357.It Functions
358.Bl -tag -compact
359.It Fn dwarf_func_cu_offset
360Retrieves the offset for the compilation unit for a function.
361.It Fn dwarf_func_die_offset
362Retrieves the offset for the debugging information entry for a
363function.
364.It Fn dwarf_funcname
365Retrieves the name of a function.
366.It Fn dwarf_func_name_offsets
367Retrieve both the name and offsets for a function.
368.It Fn dwarf_get_funcs
369Retrieve information about static functions.
370.El
371.It Globals
372.Bl -tag -compact
373.It Fn dwarf_get_globals
374Retrieve a list of globals.
375.It Fn dwarf_global_cu_offset
376Return the offset for compilation unit for a global.
377.It Fn dwarf_global_die_offset
378Return the offset for the debugging information entry for a global.
379.It Fn dwarf_global_name_offsets
380Return the name and offsets for a global.
381.It Fn dwarf_globname
382Return the name for a global.
383.El
384.It Initialization and Finalization
385Functions
386.Fn dwarf_elf_init
387and
388.Fn dwarf_init
389may be used for initialization.
390The function
391.Fn dwarf_finish
392may be used to release resources.
393.Pp
394The functions
395.Fn dwarf_object_init
396and
397.Fn dwarf_object_finish
398allow an application to specify alternate low-level file access
399routines.
400.It Line Numbers
401.Bl -tag -compact
402.It Fn dwarf_lineaddr
403Retrieve the program address for a source line.
404.It Fn dwarf_linebeginstatement
405Check if a source line corresponds to the beginning of a statement.
406.It Fn dwarf_lineblock
407Check if a source line corresponds to the start of a basic block.
408.It Fn dwarf_lineendsequence
409Check if the source line corresponds to the end of a sequence of
410instructions.
411.It Fn dwarf_lineno
412Retrieve the line number for a line descriptor.
413.It Fn dwarf_lineoff
414Retrieve the column number for a line descriptor.
415.It Fn dwarf_linesrc
416Retrieve the source file for a line descriptor.
417.It Fn dwarf_line_srcfileno
418Retrieve the index of the source file for a line descriptor.
419.It Fn dwarf_srcfiles
420Retrieve source files for a compilation unit.
421.It Fn dwarf_srclines
422Return line number information for a compilation unit.
423.El
424.It Location Lists
425.Bl -tag -compact
426.It Fn dwarf_get_loclist_entry
427Retrieve a location list entry.
428.It Fn dwarf_loclist , Fn dwarf_loclist_n
429Retrieve location expressions.
430.It Xo
431.Fn dwarf_loclist_from_expr ,
432.Fn dwarf_loclist_from_expr_a ,
433.Fn dwarf_loclist_from_expr_b
434.Xc
435Translate a location expression into a location descriptor.
436.El
437.It Error Handling
438.Bl -tag -compact
439.It Fn dwarf_errmsg
440Retrieve a human-readable error message.
441.It Fn dwarf_errno
442Retrieve an error number from an error descriptor.
443.It Fn dwarf_seterrarg
444Set the argument passed to a callback error handler.
445.It Fn dwarf_seterrhand
446Set the callback handler to be called in case of an error.
447.El
448.It Frame Handling
449.Bl -tag -compact
450.It Fn dwarf_expand_frame_instructions
451Translate frame instruction bytes.
452.It Fn dwarf_set_frame_cfa_value
453Set the CFA parameter for the internal register rule table.
454.It Fn dwarf_set_frame_rule_initial_value
455Set the initial value of the register rules in the internal register
456rule table.
457.It Fn dwarf_set_frame_rule_table_size
458Set the maximum number of columns in the register rule table.
459.It Fn dwarf_set_frame_same_value
460Set the register number representing the
461.Dq "same value"
462rule.
463.It Fn dwarf_set_frame_undefined_value
464Set the register number representing the
465.Dq "undefined"
466rule.
467.El
468.It Macros
469.Bl -tag -compact
470.It Fn dwarf_find_macro_value_start
471Return the macro value part of a macro string.
472.It Fn dwarf_get_macro_details
473Retrieve macro information.
474.El
475.It Memory Management
476In the DWARF consumer API, the rules for memory management differ
477between functions.
478In some cases, the memory areas returned to the application by the
479library are freed by calling specific API functions.
480In others, the deallocation function
481.Fn dwarf_dealloc
482suffices.
483The individual manual pages for the API's functions document the
484specific memory management rules to be followed.
485.Pp
486The function
487.Fn dwarf_dealloc
488is used to mark memory arenas as unused.
489Additionally, the following functions release specific types of
490DWARF resources:
491.Fn dwarf_fde_cie_list_dealloc ,
492.Fn dwarf_funcs_dealloc ,
493.Fn dwarf_globals_dealloc ,
494.Fn dwarf_pubtypes_dealloc ,
495.Fn dwarf_ranges_dealloc ,
496.Fn dwarf_srclines_dealloc ,
497.Fn dwarf_types_dealloc ,
498.Fn dwarf_vars_dealloc ,
499and
500.Fn dwarf_weaks_dealloc .
501.It Symbol Constants
502The following functions may be used to return symbolic names
503for DWARF constants:
504.Fn dwarf_get_ACCESS_name ,
505.Fn dwarf_get_AT_name ,
506.Fn dwarf_get_ATE_name ,
507.Fn dwarf_get_CC_name ,
508.Fn dwarf_get_CFA_name ,
509.Fn dwarf_get_CHILDREN_name ,
510.Fn dwarf_get_DS_name ,
511.Fn dwarf_get_DSC_name ,
512.Fn dwarf_get_EH_name ,
513.Fn dwarf_get_END_name ,
514.Fn dwarf_get_FORM_name ,
515.Fn dwarf_get_ID_name ,
516.Fn dwarf_get_INL_name ,
517.Fn dwarf_get_LANG_name ,
518.Fn dwarf_get_LNE_name ,
519.Fn dwarf_get_LNS_name ,
520.Fn dwarf_get_MACINFO_name ,
521.Fn dwarf_get_OP_name ,
522.Fn dwarf_get_ORD_name ,
523.Fn dwarf_get_TAG_name ,
524.Fn dwarf_get_VIRTUALITY_name ,
525and
526.Fn dwarf_get_VIS_name .
527.It Types
528.Bl -tag -compact
529.It Fn dwarf_get_pubtypes , Fn dwarf_get_types
530Retrieve descriptors for user-defined types.
531.It Fn dwarf_next_types_section
532Step through
533.Dq \&.debug_types
534sections in a debug context.
535.It Fn dwarf_pubtype_cu_offset , Fn dwarf_type_cu_offset
536Return the offset for the compilation unit for a type.
537.It Fn dwarf_pubtype_die_offset , Fn dwarf_type_die_offset
538Return the offset for the debugging information entry for a type.
539.It Fn dwarf_pubtypename , Fn dwarf_typename
540Retrieve the name of a type.
541.It Fn dwarf_pubtype_name_offsets , Fn dwarf_type_name_offsets
542Retrieve the name and offsets for a type.
543.El
544.It Variables
545.Bl -tag -compact
546.It Fn dwarf_get_vars
547Retrieve descriptors for static variables.
548.It Fn dwarf_var_cu_offset
549Return the offset for the compilation unit for a variable.
550.It Fn dwarf_var_die_offset
551Return the offset for the debugging information entry for a variable.
552.It Fn dwarf_varname
553Retrieve the name of a variable.
554.It Fn dwarf_var_name_offsets
555Retrieve the name and offsets for a variable.
556.El
557.It Weak Symbols
558.Bl -tag -compact
559.It Fn dwarf_get_weaks
560Retrieve information about weak symbols.
561.It Fn dwarf_weak_cu_offset
562Return the offset for the compilation unit for a weak symbol.
563.It Fn dwarf_weak_die_offset
564Return the offset for the debugging information entry for a weak symbol.
565.It Fn dwarf_weakname
566Retrieve the name of a weak symbol.
567.It Fn dwarf_weak_name_offsets
568Retrieve the name and offsets for a weak symbol.
569.El
570.It Miscellaneous
571.Bl -tag -compact
572.It Fn dwarf_get_elf
573Retrieve the ELF descriptor for a debug context, see
574.Xr elf 3 .
575.It Fn dwarf_get_str
576Retrieve a NUL-terminated string from the DWARF string section.
577.It Fn dwarf_set_reloc_application
578Control whether relocations are to be handled by
579.Lb libdwarf .
580.El
581.El
582.Sh The DWARF Producer API
583The DWARF producer API permits applications to add DWARF information to
584an object file.
585.Pp
586The major functional groups of functions in the producer API are listed
587below.
588.Bl -tag -width "CCCC"
589.It Attribute Management
590The following functions are used to attach attributes to a debugging
591information entry:
592.Fn dwarf_add_AT_comp_dir ,
593.Fn dwarf_add_AT_const_value_signedint ,
594.Fn dwarf_add_AT_const_value_string ,
595.Fn dwarf_add_AT_const_value_unsignedint ,
596.Fn dwarf_add_AT_dataref ,
597.Fn dwarf_add_AT_flag ,
598.Fn dwarf_add_AT_location_expr ,
599.Fn dwarf_add_AT_name ,
600.Fn dwarf_add_AT_producer ,
601.Fn dwarf_add_AT_ref_address ,
602.Fn dwarf_add_AT_reference ,
603.Fn dwarf_add_AT_signed_const ,
604.Fn dwarf_add_AT_string ,
605.Fn dwarf_add_AT_targ_address ,
606.Fn dwarf_add_AT_targ_address_b
607and
608.Fn dwarf_add_AT_unsigned_const .
609.It Debugging Information Entry Management
610.Bl -tag -compact
611.It Fn dwarf_add_die_to_debug
612Set the root debugging information entry for a DWARF producer instance.
613.It Fn dwarf_die_link
614Links debugging information entries.
615.It Fn dwarf_new_die
616Allocate a new debugging information entry.
617.El
618.It Initialization and Finalization
619The functions
620.Fn dwarf_producer_init
621and
622.Fn dwarf_producer_init_b
623are used to initialize a producer instance.
624.Pp
625When done, applications release resources using the function
626.Fn dwarf_producer_finish .
627.It Relocations and Sections
628.Bl -tag -compact
629.It Fn dwarf_get_relocation_info
630Retrieve a relocation array from a producer instance.
631.It Fn dwarf_get_relocation_info_count
632Return the number of relocation arrays for a producer instance.
633.It Fn dwarf_get_section_bytes
634Retrieve the ELF byte stream for a section.
635.It Fn dwarf_reset_section_bytes
636Reset internal state for a producer instance.
637.It Fn dwarf_transform_to_disk_form
638Prepare byte streams for writing out.
639.El
640.It Macros
641.Bl -tag -compact
642.It Fn dwarf_def_macro
643Add a macro definition.
644.It Fn dwarf_end_macro_file , Fn dwarf_start_macro_file
645Record macro file related information.
646.It Fn dwarf_undef_macro
647Note the removal of a macro definition.
648.It Fn dwarf_vendor_ext
649Enables storing macro information as specified in the DWARF standard.
650.El
651.It Symbols, Expressions, Addresses and Offsets
652.Bl -tag -compact
653.It Fn dwarf_add_arange , Fn dwarf_add_arange_b
654Add address range information.
655.It Fn dwarf_add_directory_decl
656Add information about an include directory to a producer instance.
657.It Fn dwarf_add_fde_inst
658Add an operation to a frame descriptor entry.
659.It Fn dwarf_add_file_decl
660Add information about a source file to a producer instance.
661.It Fn dwarf_add_frame_cie
662Add call information to a frame descriptor.
663.It Fn dwarf_add_frame_fde , Fn dwarf_add_frame_fde_b
664Link a frame descriptor to a producer instance.
665.It Fn dwarf_add_funcname
666Add information about a function to a producer instance.
667.It Fn dwarf_add_line_entry
668Record mapping information between machine addresses and a source line.
669.It Fn dwarf_add_expr_addr , Fn dwarf_add_expr_addr_b
670Add a
671.Dv DW_OP_addr
672opcode to a location expression.
673.It Fn dwarf_add_expr_gen
674Add an operator to a location expression.
675.It Fn dwarf_add_pubname
676Add information about a global name to a producer instance.
677.It Fn dwarf_add_typename
678Add information about a type to a producer instance.
679.It Fn dwarf_add_varname
680Add information about a static variable to a producer instance.
681.It Fn dwarf_add_weakname
682Add information about a weak symbol to a producer instance.
683.It Fn dwarf_expr_current_offset
684Retrieve the current size of a location expression.
685.It Fn dwarf_expr_into_block
686Convert a location expression into a byte stream.
687.It Fn dwarf_fde_cfa_offset
688Append a
689.Dv DW_CFA_offset
690operation to a frame descriptor.
691.It Fn dwarf_lne_end_sequence , Fn dwarf_lne_set_address
692Note address ranges for source lines.
693.It Fn dwarf_new_expr
694Allocate a location expression descriptor.
695.It Fn dwarf_new_fde
696Allocate a frame descriptor.
697.El
698.It Miscellaneous
699The function
700.Fn dwarf_producer_set_isa
701sets the instruction set architecture for the producer instance.
702.El
703.Sh COMPATIBILITY
704This implementation is believed to be source compatible with the
705SGI/GNU DWARF(3) library, version 20110113.
706.Pp
707Known differences with the SGI/GNU library include:
708.Bl -bullet -compact
709.It
710The memory management scheme used differs, in a backward-compatible
711way.
712See
713.Sx Memory Management
714above, for coding guidelines for portable applications.
715.It
716There is provision for setting a library-wide error handler in
717addition to the per-debug context handlers supported by the SGI/GNU
718API, see the subsection
719.Sx Error Handling
720above.
721.El
722.Ss Extensions
723The following APIs are extensions specific to this implementation:
724.Bl -bullet -compact
725.It
726.Fn dwarf_attroffset
727.It
728.Fn dwarf_next_types_section
729.It
730.Fn dwarf_producer_set_isa
731.El
732.Sh SEE ALSO
733.Xr elf 3
734.Sh STANDARDS
735The DWARF standard is defined by
736.Rs
737.%T "The DWARF Debugging Information Format"
738.%V "Version 4"
739.%O "http://www.dwarfstd.org/"
740.Re
741.Sh HISTORY
742The DWARF(3) API originated at Silicon Graphics Inc.
743.Pp
744A BSD-licensed implementation of a subset of the API was written by
745.An John Birrell Aq Mt jb@FreeBSD.org
746for the FreeBSD project.
747The implementation was subsequently revised and completed by
748.An Kai Wang Aq Mt kaiwang27@users.sourceforge.net .
749.Pp
750Manual pages for this implementation were written by
751.An Joseph Koshy Aq Mt jkoshy@users.sourceforge.net
752and
753.An Kai Wang Aq Mt kaiwang27@users.sourceforge.net .
754