1 .\" Copyright (c) 2011 Kai Wang
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $Id: dwarf_add_line_entry.3 3644 2018-10-15 19:55:01Z jkoshy $
28 .Dt DWARF_ADD_LINE_ENTRY 3
31 .Nm dwarf_add_line_entry
32 .Nd add a line number information entry to a producer instance
38 .Fo dwarf_add_line_entry
39 .Fa "Dwarf_P_Debug dbg"
40 .Fa "Dwarf_Unsigned filendx"
42 .Fa "Dwarf_Unsigned lineno"
43 .Fa "Dwarf_Signed column"
44 .Fa "Dwarf_Bool is_stmt"
45 .Fa "Dwarf_Bool basic_block"
46 .Fa "Dwarf_Error *err"
50 .Fn dwarf_add_line_entry
51 adds a line number information entry to a DWARF producer instance.
55 should reference a DWARF producer instance allocated using
56 .Xr dwarf_producer_init 3
58 .Xr dwarf_producer_init_b 3 .
62 specifies the index of the source file that contains the source line
64 Valid source file indices are those returned by the function
65 .Xr dwarf_add_file_decl 3 .
69 specifies a relocatable program address.
70 The ELF symbol to be used
71 for relocation is set by a prior call to the function
72 .Xr dwarf_lne_set_address 3 .
76 specifies the line number of the source line.
80 specifies the column number within the source line.
84 is set to true, it indicates that the instruction at the address
87 is a recommended breakpoint location, i.e., the first instruction in
88 the instruction sequence generated by the source line.
92 is set to true, it indicates that the instruction at the address
95 is the first instruction of a basic block.
99 is not NULL, it will be used to store error information in case
103 .Fn dwarf_add_line_entry
106 In case of an error, function
107 .Fn dwarf_add_line_entry
110 and sets the argument
113 To add line number information to the producer instance, use:
114 .Bd -literal -offset indent
117 Dwarf_Unsigned dir, filendx;
119 /* ... assume dbg refers to a DWARF producer instance ... */
121 dir = dwarf_add_directory_decl(dbg, "/home/foo", &de);
122 if (dir == DW_DLV_NOCOUNT)
123 errx(EXIT_FAILURE, "dwarf_add_directory_decl failed: %s",
126 filendx = dwarf_add_file_decl(dbg, "bar.c", dir, 0, 1234, &de);
127 if (filendx == DW_DLV_NOCOUNT)
128 errx(EXIT_FAILURE, "dwarf_add_file_decl failed: %s",
131 if (dwarf_lne_set_address(dbg, 0x4012b0, 12, &de) != DW_DLV_OK)
132 errx(EXIT_FAILURE, "dwarf_lne_set_address failed: %s",
135 if (dwarf_add_line_entry(dbg, filendx, 10, 258, 0, 1, 1, &de) !=
137 errx(EXIT_FAILURE, "dwarf_add_line_entry failed: %s",
142 .Fn dwarf_add_line_entry
144 .Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
145 .It Bq Er DW_DLE_ARGUMENT
149 .It Bq Er DW_DLE_ARGUMENT
151 .Xr dwarf_lne_set_address 3
152 was not called before calling this function.
153 .It Bq Er DW_DLE_MEMORY
154 An out of memory condition was encountered during the execution of the
159 .Xr dwarf_add_directory_decl 3 ,
160 .Xr dwarf_add_file_decl 3 ,
161 .Xr dwarf_lne_end_sequence 3 ,
162 .Xr dwarf_lne_set_address 3 ,
163 .Xr dwarf_producer_init 3 ,
164 .Xr dwarf_producer_init_b 3