dwarf_attrlist(3) [freebsd man page]

DWARF_ATTRLIST(3)					   BSD Library Functions Manual 					 DWARF_ATTRLIST(3)

NAME

     dwarf_attrlist -- retrieve DWARF attribute descriptors

LIBRARY

     DWARF Access Library (libdwarf, -ldwarf)

SYNOPSIS

     #include <libdwarf.h>

     int
     dwarf_attrlist(Dwarf_Die die, Dwarf_Attribute **attrbuf, Dwarf_Signed *attrcount, Dwarf_Error *err);

DESCRIPTION

     Function dwarf_attrlist() retrieves the DWARF attribute descriptors associated with a debugging information entry descriptor in argument die.
     The descriptors are returned as an array of values of the opaque type Dwarf_Attribute.  The data associated with each returned attribute
     descriptor may be queried using the form query functions in the dwarf(3) API set.

     Argument attrbuf points to a location that will hold a pointer to the returned array of DWARF attribute descriptors.  Argument attrcount
     points to a location that will hold the number of descriptors in the returned array.

     If argument err is non-NULL, it is used to return an error descriptor in case of an error.

   Memory Management
     In the current implementation, the memory allocated for each DWARF attribute descriptor and for the returned array of descriptors is managed
     by the library and the application does not need to explicitly free the returned pointers.  However, for compatibility with other implementa-
     tions of the dwarf(3) API, the application is permitted to pass the pointers returned by to the dwarf_dealloc() function.

RETURN VALUES

     Function dwarf_attrlist() returns DW_DLV_OK on success.

     If the debugging information entry descriptor denoted by argument die does not contain any attribute, the function returns DW_DLV_NO_ENTRY
     and sets argument err.  For other errors, it returns DW_DLV_ERROR and sets argument err.

EXAMPLES

     To retrieve the attribute list for a DWARF debugging information entry use:

	   Dwarf_Die dw_die;
	   Dwarf_Error dw_e;
	   Dwarf_Unsigned dw_count;
	   Dwarf_Attribute *dw_attributes;
	   int error, i;

	   ... variable dw_die contains a reference to the DIE of interest ...

	   /* Retrieve the attribute list from the DIE. */
	   if ((error = dwarf_attrlist(dw_die, &dw_attributes, &dw_count,
		   &dw_e)) != DW_DLV_OK)
		   errx(EXIT_FAILURE, "dwarf_attrlist: %s", dwarf_errmsg(dw_e));

	   /* Process the attribute list. */
	   for (i = 0; i < dw_count; ++i) {
		   /* Use the returned pointers in dw_attributes[i] here. */
	   }

ERRORS

     Function dwarf_diename() can fail with the following errors:

     [DW_DLE_ARGUMENT]	Arguments die, attrbuf, or attrcount were NULL.

     [DW_DLE_NO_ENTRY]	Argument die had no attributes.

     [DW_DLE_MEMORY]	An out of memory condition was encountered during the execution of the function.

SEE ALSO

     dwarf(3), dwarf_attr(3), dwarf_dealloc(3), dwarf_hasattr(3), dwarf_hasform(3), dwarf_whatattr(3), dwarf_whatform(3)

BSD
								 November 9, 2011							       BSD

DWARF_SRCLINES(3)					   BSD Library Functions Manual 					 DWARF_SRCLINES(3)

NAME

     dwarf_srclines -- retrieve line number information for a debugging information entry

LIBRARY

     DWARF Access Library (libdwarf, -ldwarf)

SYNOPSIS

     #include <libdwarf.h>

     int
     dwarf_srclines(Dwarf_Die die, Dwarf_Line **lines, Dwarf_Signed *nlines, Dwarf_Error *err);

DESCRIPTION

     Function dwarf_srclines() returns line number information associated with a compilation unit.  Line number information is returned as an
     array of Dwarf_Line descriptors.

     Argument die should reference a DWARF debugging information entry descriptor with line number information, see dwarf(3).  Argument lines
     should point to a location that will hold a pointer to the returned array of Dwarf_Line descriptors.  Argument nlines should point to a loca-
     tion that will hold the number of descriptors returned.  If argument err is not NULL, it will be used to store error information in case of
     an error.

     The returned Dwarf_Line descriptors may be passed to the other line number functions in the API set to retrieve specific information about
     each source line.

   Memory Management
     The memory area used for the array of Dwarf_Line descriptors returned in argument lines is owned by the DWARF Access Library (libdwarf,
     -ldwarf).	The application should not attempt to free this pointer.  Portable code should instead use dwarf_srclines_dealloc() to indicate
     that the memory may be freed.

RETURN VALUES

     Function dwarf_srclines() returns DW_DLV_OK when it succeeds.  In case of an error, it returns DW_DLV_ERROR and sets the argument err.

ERRORS

     Function dwarf_srclines() can fail with:

     [DW_DLE_ARGUMENT]	One of the arguments die, lines or nlines was NULL.

     [DW_DLE_NO_ENTRY]	The compilation unit referenced by argument die does not have associated line number information.

     [DW_DLE_MEMORY]	An out of memory condition was encountered during the execution of this function.

EXAMPLE

     To obtain an array of Dwarf_Line descriptors and to retrieve the source file, line number, and virtual address associated with each descrip-
     tor:

	   int n;
	   Dwarf_Die die;
	   Dwarf_Error de;
	   char *filename;
	   Dwarf_Line *lines;
	   Dwarf_Signed nlines;
	   Dwarf_Addr lineaddr;
	   Dwarf_Unsigned lineno;

	   /* variable "die" should reference a DIE for a compilation unit */

	   if (dwarf_srclines(die, &lines, &nlines, &de) != DW_DLV_OK)
		   errx(EXIT_FAILURE, "dwarf_srclines: %s", dwarf_errmsg(de));

	   for (n = 0; n < nlines; n++) {
		   /* Retrieve the file name for this descriptor. */
		   if (dwarf_linesrc(lines[n], &filename, &de))
			   errx(EXIT_FAILURE, "dwarf_linesrc: %s",
			       dwarf_errmsg(de));

		   /* Retrieve the line number in the source file. */
		   if (dwarf_lineno(lines[n], &lineno, &de))
			   errx(EXIT_FAILURE, "dwarf_lineno: %s",
			       dwarf_errmsg(de));
		   /* Retrieve the virtual address for this line. */
		   if (dwarf_lineaddr(lines[n], &lineaddr, &de))
			   errx(EXIT_FAILURE, "dwarf_lineaddr: %s",
			       dwarf_errmsg(de));
		   }

SEE ALSO

     dwarf(3), dwarf_line_srcfileno(3), dwarf_lineaddr(3), dwarf_linebeginstatement(3), dwarf_lineblock(3), dwarf_lineendsequence(3),
     dwarf_lineno(3), dwarf_lineoff(3), dwarf_linesrc(3), dwarf_srcfiles(3), dwarf_srclines_dealloc(3)

BSD
								 November 9, 2011							       BSD