Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

dwarf_get_section_bytes(3) [freebsd man page]

DWARF_GET_SECTION_BYTES(3)				   BSD Library Functions Manual 				DWARF_GET_SECTION_BYTES(3)

NAME
dwarf_get_section_bytes -- retrieve ELF section byte streams LIBRARY
DWARF Access Library (libdwarf, -ldwarf) SYNOPSIS
#include <libdwarf.h> Dwarf_Ptr dwarf_get_section_bytes(Dwarf_P_Debug dbg, Dwarf_Signed dwarf_section, Dwarf_Signed *elf_section_index, Dwarf_Unsigned *length, Dwarf_Error *err); DESCRIPTION
Function dwarf_get_section_bytes() returns the ELF section byte streams generated by a prior call to function dwarf_transform_to_disk_form(3). Each call to function dwarf_get_section_bytes() will return the byte stream for one ELF section. The first call to this function will always return the first ELF section, and the subsequent calls will return the rest of sections in the order when they were generated, until the last one. The total number of sections generated is returned by the function dwarf_transform_to_disk_form(3). Argument dbg should reference a DWARF producer instance allocated using the functions dwarf_producer_init(3) or dwarf_producer_init_b(3). Argument dwarf_section is currently ignored. Argument elf_section_index should point to a location which will be set to the section index value of the returned ELF section. Argument length should point to a location which will hold the length in bytes of the returned ELF section. If argument err is not NULL, it will be used to store error information in case of an error. Memory Management The memory areas used for the returned ELF section byte streams should be freed using the function dwarf_producer_finish(). RETURN VALUES
On success, function dwarf_get_section_bytes() returns a pointer to a ELF section byte stream. In case of an error, function dwarf_get_section_bytes() will return NULL and set the argument err. ERRORS
Function dwarf_get_section_bytes() can fail with: [DW_DLE_ARGUMENT] One of the arguments dbg, elf_section_index, or length was NULL. [DW_DLE_NO_ENTRY] There were no more ELF sections to retrieve, or the function was called before a call to dwarf_transform_to_disk_form(3). EXAMPLES
To generate and retrieve ELF section byte streams, use: Dwarf_P_Debug dbg; Dwarf_Signed count, i, sec_index; Dwarf_Unsigned len; Dwarf_Ptr bytes; Dwarf_Error de; /* ... Assume that `dbg' refers to a DWARF producer instance, * and that application code has added DWARF debugging * information to the producer instance. ... */ if ((count = dwarf_transform_to_disk_form(dbg, &de)) == DW_DLV_NOCOUNT) { warnx("dwarf_transform_to_disk_form failed: %s", dwarf_errmsg(-1)); return; } /* Retrieve section data. */ for (i = 0; i < count; i++) { bytes = dwarf_get_section_bytes(dbg, i, &sec_index, &len, &de); if (bytes == NULL) { warnx("dwarf_get_section_bytes failed: %s", dwarf_errmsg(-1)); continue; } /* ... use the returned byte stream ... */ } /* Release resources. */ dwarf_producer_finish(dbg, &de); SEE ALSO
dwarf(3), dwarf_reset_section_bytes(3), dwarf_producer_finish(3), dwarf_producer_init(3), dwarf_producer_init_b(3), dwarf_transform_to_disk_form(3) BSD
August 26, 2011 BSD

Check Out this Related Man Page

DWARF_ADD_LINE_ENTRY(3) 				   BSD Library Functions Manual 				   DWARF_ADD_LINE_ENTRY(3)

NAME
dwarf_add_line_entry -- add a line number information entry to a producer instance LIBRARY
DWARF Access Library (libdwarf, -ldwarf) SYNOPSIS
#include <libdwarf.h> Dwarf_Unsigned dwarf_add_line_entry(Dwarf_P_Debug dbg, Dwarf_Unsigned filendx, Dwarf_Addr off, Dwarf_Unsigned lineno, Dwarf_Signed column, Dwarf_Bool is_stmt, Dwarf_Bool basic_block, Dwarf_Error *err); DESCRIPTION
Function dwarf_add_line_entry() adds a line number information entry to a DWARF producer instance. Argument dbg should reference a DWARF producer instance allocated using dwarf_producer_init(3) or dwarf_producer_init_b(3). Argument filendx specifies the index of the source file that contains the source line in question. Valid source file indices are those returned by the function dwarf_add_file_decl(3). Argument off specifies a relocatable program address. The ELF symbol to be used for relocation is set by a prior call to the function dwarf_lne_set_address(3). Argument lineno specifies the line number of the source line. Argument column specifies the column number within the source line. If the argument is_stmt is set to true, it indicates that the instruction at the address specified by argument off is a recommended break- point location, i.e., the first instruction in the instruction sequence generated by the source line. If the argument basic_block is set to true, it indicates that the instruction at the address specified by argument off is the first instruc- tion of a basic block. If argument err is not NULL, it will be used to store error information in case of an error. RETURN VALUES
On success, function dwarf_add_line_entry() returns DW_DLV_OK. In case of an error, function dwarf_add_line_entry() returns DW_DLV_NOCOUNT and sets the argument err. ERRORS
Function dwarf_add_line_entry() can fail with: [DW_DLE_ARGUMENT] Argument dbg was NULL. [DW_DLE_ARGUMENT] The function dwarf_lne_set_address(3) was not called before calling this function. [DW_DLE_MEMORY] An out of memory condition was encountered during the execution of the function. EXAMPLE
To add line number information to the producer instance, use: Dwarf_P_Debug dbg; Dwarf_Error de; Dwarf_Unsigned dir, filendx; /* ... assume dbg refers to a DWARF producer instance ... */ dir = dwarf_add_directory_decl(dbg, "/home/foo", &de); if (dir == DW_DLV_NOCOUNT) errx(EXIT_FAILURE, "dwarf_add_directory_decl failed: %s", dwarf_errmsg(-1)); filendx = dwarf_add_file_decl(dbg, "bar.c", dir, 0, 1234, &de); if (filendx == DW_DLV_NOCOUNT) errx(EXIT_FAILURE, "dwarf_add_file_decl failed: %s", dwarf_errmsg(-1)); if (dwarf_lne_set_address(dbg, 0x4012b0, 12, &de) != DW_DLV_OK) errx(EXIT_FAILURE, "dwarf_lne_set_address failed: %s", dwarf_errmsg(-1)); if (dwarf_add_line_entry(dbg, filendx, 10, 258, 0, 1, 1, &de) != DW_DLV_OK) errx(EXIT_FAILURE, "dwarf_add_line_entry failed: %s", dwarf_errmsg(-1)); SEE ALSO
dwarf(3), dwarf_add_directory_decl(3), dwarf_add_file_decl(3), dwarf_lne_end_sequence(3), dwarf_lne_set_address(3), dwarf_producer_init(3), dwarf_producer_init_b(3) BSD
June 30, 2013 BSD
Man Page