xref: /freebsd/contrib/elftoolchain/libdwarf/libdwarf_arange.c (revision 2de3b87a120614a3b053be7dd845b72f1e9ce804)
1*2de3b87aSKai Wang /*-
2*2de3b87aSKai Wang  * Copyright (c) 2009-2011 Kai Wang
3*2de3b87aSKai Wang  * All rights reserved.
4*2de3b87aSKai Wang  *
5*2de3b87aSKai Wang  * Redistribution and use in source and binary forms, with or without
6*2de3b87aSKai Wang  * modification, are permitted provided that the following conditions
7*2de3b87aSKai Wang  * are met:
8*2de3b87aSKai Wang  * 1. Redistributions of source code must retain the above copyright
9*2de3b87aSKai Wang  *    notice, this list of conditions and the following disclaimer.
10*2de3b87aSKai Wang  * 2. Redistributions in binary form must reproduce the above copyright
11*2de3b87aSKai Wang  *    notice, this list of conditions and the following disclaimer in the
12*2de3b87aSKai Wang  *    documentation and/or other materials provided with the distribution.
13*2de3b87aSKai Wang  *
14*2de3b87aSKai Wang  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*2de3b87aSKai Wang  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*2de3b87aSKai Wang  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*2de3b87aSKai Wang  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*2de3b87aSKai Wang  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*2de3b87aSKai Wang  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*2de3b87aSKai Wang  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*2de3b87aSKai Wang  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*2de3b87aSKai Wang  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*2de3b87aSKai Wang  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*2de3b87aSKai Wang  * SUCH DAMAGE.
25*2de3b87aSKai Wang  */
26*2de3b87aSKai Wang 
27*2de3b87aSKai Wang #include "_libdwarf.h"
28*2de3b87aSKai Wang 
29*2de3b87aSKai Wang ELFTC_VCSID("$Id: libdwarf_arange.c 2070 2011-10-27 03:05:32Z jkoshy $");
30*2de3b87aSKai Wang 
31*2de3b87aSKai Wang void
32*2de3b87aSKai Wang _dwarf_arange_cleanup(Dwarf_Debug dbg)
33*2de3b87aSKai Wang {
34*2de3b87aSKai Wang 	Dwarf_ArangeSet as, tas;
35*2de3b87aSKai Wang 	Dwarf_Arange ar, tar;
36*2de3b87aSKai Wang 
37*2de3b87aSKai Wang 	STAILQ_FOREACH_SAFE(as, &dbg->dbg_aslist, as_next, tas) {
38*2de3b87aSKai Wang 		STAILQ_FOREACH_SAFE(ar, &as->as_arlist, ar_next, tar) {
39*2de3b87aSKai Wang 			STAILQ_REMOVE(&as->as_arlist, ar, _Dwarf_Arange,
40*2de3b87aSKai Wang 			    ar_next);
41*2de3b87aSKai Wang 			free(ar);
42*2de3b87aSKai Wang 		}
43*2de3b87aSKai Wang 		STAILQ_REMOVE(&dbg->dbg_aslist, as, _Dwarf_ArangeSet, as_next);
44*2de3b87aSKai Wang 		free(as);
45*2de3b87aSKai Wang 	}
46*2de3b87aSKai Wang 
47*2de3b87aSKai Wang 	if (dbg->dbg_arange_array)
48*2de3b87aSKai Wang 		free(dbg->dbg_arange_array);
49*2de3b87aSKai Wang 
50*2de3b87aSKai Wang 	dbg->dbg_arange_array = NULL;
51*2de3b87aSKai Wang 	dbg->dbg_arange_cnt = 0;
52*2de3b87aSKai Wang }
53*2de3b87aSKai Wang 
54*2de3b87aSKai Wang int
55*2de3b87aSKai Wang _dwarf_arange_init(Dwarf_Debug dbg, Dwarf_Error *error)
56*2de3b87aSKai Wang {
57*2de3b87aSKai Wang 	Dwarf_CU cu;
58*2de3b87aSKai Wang 	Dwarf_ArangeSet as;
59*2de3b87aSKai Wang 	Dwarf_Arange ar;
60*2de3b87aSKai Wang 	Dwarf_Section *ds;
61*2de3b87aSKai Wang 	uint64_t offset, dwarf_size, length, addr, range;
62*2de3b87aSKai Wang 	int i, ret;
63*2de3b87aSKai Wang 
64*2de3b87aSKai Wang 	ret = DW_DLE_NONE;
65*2de3b87aSKai Wang 
66*2de3b87aSKai Wang 	if ((ds = _dwarf_find_section(dbg, ".debug_aranges")) == NULL)
67*2de3b87aSKai Wang 		return (DW_DLE_NONE);
68*2de3b87aSKai Wang 
69*2de3b87aSKai Wang 	if (!dbg->dbg_info_loaded) {
70*2de3b87aSKai Wang 		ret = _dwarf_info_load(dbg, 1, error);
71*2de3b87aSKai Wang 		if (ret != DW_DLE_NONE)
72*2de3b87aSKai Wang 			return (ret);
73*2de3b87aSKai Wang 	}
74*2de3b87aSKai Wang 
75*2de3b87aSKai Wang 	offset = 0;
76*2de3b87aSKai Wang 	while (offset < ds->ds_size) {
77*2de3b87aSKai Wang 
78*2de3b87aSKai Wang 		if ((as = malloc(sizeof(struct _Dwarf_ArangeSet))) == NULL) {
79*2de3b87aSKai Wang 			DWARF_SET_ERROR(dbg, error, DW_DLE_MEMORY);
80*2de3b87aSKai Wang 			return (DW_DLE_MEMORY);
81*2de3b87aSKai Wang 		}
82*2de3b87aSKai Wang 		STAILQ_INIT(&as->as_arlist);
83*2de3b87aSKai Wang 		STAILQ_INSERT_TAIL(&dbg->dbg_aslist, as, as_next);
84*2de3b87aSKai Wang 
85*2de3b87aSKai Wang 		/* Read in the table header. */
86*2de3b87aSKai Wang 		length = dbg->read(ds->ds_data, &offset, 4);
87*2de3b87aSKai Wang 		if (length == 0xffffffff) {
88*2de3b87aSKai Wang 			dwarf_size = 8;
89*2de3b87aSKai Wang 			length = dbg->read(ds->ds_data, &offset, 8);
90*2de3b87aSKai Wang 		} else
91*2de3b87aSKai Wang 			dwarf_size = 4;
92*2de3b87aSKai Wang 
93*2de3b87aSKai Wang 		as->as_length = length;
94*2de3b87aSKai Wang 		as->as_version = dbg->read(ds->ds_data, &offset, 2);
95*2de3b87aSKai Wang 		if (as->as_version != 2) {
96*2de3b87aSKai Wang 			DWARF_SET_ERROR(dbg, error, DW_DLE_VERSION_STAMP_ERROR);
97*2de3b87aSKai Wang 			ret = DW_DLE_VERSION_STAMP_ERROR;
98*2de3b87aSKai Wang 			goto fail_cleanup;
99*2de3b87aSKai Wang 		}
100*2de3b87aSKai Wang 
101*2de3b87aSKai Wang 		as->as_cu_offset = dbg->read(ds->ds_data, &offset, dwarf_size);
102*2de3b87aSKai Wang 		STAILQ_FOREACH(cu, &dbg->dbg_cu, cu_next) {
103*2de3b87aSKai Wang 			if (cu->cu_offset == as->as_cu_offset)
104*2de3b87aSKai Wang 				break;
105*2de3b87aSKai Wang 		}
106*2de3b87aSKai Wang 		if (cu == NULL) {
107*2de3b87aSKai Wang 			DWARF_SET_ERROR(dbg, error, DW_DLE_ARANGE_OFFSET_BAD);
108*2de3b87aSKai Wang 			ret = DW_DLE_ARANGE_OFFSET_BAD;
109*2de3b87aSKai Wang 			goto fail_cleanup;
110*2de3b87aSKai Wang 		}
111*2de3b87aSKai Wang 		as->as_cu = cu;
112*2de3b87aSKai Wang 
113*2de3b87aSKai Wang 		as->as_addrsz = dbg->read(ds->ds_data, &offset, 1);
114*2de3b87aSKai Wang 		as->as_segsz = dbg->read(ds->ds_data, &offset, 1);
115*2de3b87aSKai Wang 
116*2de3b87aSKai Wang 		/* Skip the padding bytes.  */
117*2de3b87aSKai Wang 		offset = roundup(offset, 2 * as->as_addrsz);
118*2de3b87aSKai Wang 
119*2de3b87aSKai Wang 		/* Read in address range descriptors. */
120*2de3b87aSKai Wang 		while (offset < ds->ds_size) {
121*2de3b87aSKai Wang 			addr = dbg->read(ds->ds_data, &offset, as->as_addrsz);
122*2de3b87aSKai Wang 			range = dbg->read(ds->ds_data, &offset, as->as_addrsz);
123*2de3b87aSKai Wang 			if (addr == 0 && range == 0)
124*2de3b87aSKai Wang 				break;
125*2de3b87aSKai Wang 			if ((ar = calloc(1, sizeof(struct _Dwarf_Arange))) ==
126*2de3b87aSKai Wang 			    NULL) {
127*2de3b87aSKai Wang 				DWARF_SET_ERROR(dbg, error, DW_DLE_MEMORY);
128*2de3b87aSKai Wang 				goto fail_cleanup;
129*2de3b87aSKai Wang 			}
130*2de3b87aSKai Wang 			ar->ar_as = as;
131*2de3b87aSKai Wang 			ar->ar_address = addr;
132*2de3b87aSKai Wang 			ar->ar_range = range;
133*2de3b87aSKai Wang 			STAILQ_INSERT_TAIL(&as->as_arlist, ar, ar_next);
134*2de3b87aSKai Wang 			dbg->dbg_arange_cnt++;
135*2de3b87aSKai Wang 		}
136*2de3b87aSKai Wang 	}
137*2de3b87aSKai Wang 
138*2de3b87aSKai Wang 	/* Build arange array. */
139*2de3b87aSKai Wang 	if (dbg->dbg_arange_cnt > 0) {
140*2de3b87aSKai Wang 		if  ((dbg->dbg_arange_array = malloc(dbg->dbg_arange_cnt *
141*2de3b87aSKai Wang 		    sizeof(struct _Dwarf_Arange))) == NULL) {
142*2de3b87aSKai Wang 			DWARF_SET_ERROR(dbg, error, DW_DLE_MEMORY);
143*2de3b87aSKai Wang 			ret = DW_DLE_MEMORY;
144*2de3b87aSKai Wang 			goto fail_cleanup;
145*2de3b87aSKai Wang 		}
146*2de3b87aSKai Wang 
147*2de3b87aSKai Wang 		i = 0;
148*2de3b87aSKai Wang 		STAILQ_FOREACH(as, &dbg->dbg_aslist, as_next) {
149*2de3b87aSKai Wang 			STAILQ_FOREACH(ar, &as->as_arlist, ar_next)
150*2de3b87aSKai Wang 				dbg->dbg_arange_array[i++] = ar;
151*2de3b87aSKai Wang 		}
152*2de3b87aSKai Wang 		assert((Dwarf_Unsigned)i == dbg->dbg_arange_cnt);
153*2de3b87aSKai Wang 	}
154*2de3b87aSKai Wang 
155*2de3b87aSKai Wang 	return (DW_DLE_NONE);
156*2de3b87aSKai Wang 
157*2de3b87aSKai Wang fail_cleanup:
158*2de3b87aSKai Wang 
159*2de3b87aSKai Wang 	_dwarf_arange_cleanup(dbg);
160*2de3b87aSKai Wang 
161*2de3b87aSKai Wang 	return (ret);
162*2de3b87aSKai Wang }
163*2de3b87aSKai Wang 
164*2de3b87aSKai Wang int
165*2de3b87aSKai Wang _dwarf_arange_gen(Dwarf_P_Debug dbg, Dwarf_Error *error)
166*2de3b87aSKai Wang {
167*2de3b87aSKai Wang 	Dwarf_P_Section ds;
168*2de3b87aSKai Wang 	Dwarf_Rel_Section drs;
169*2de3b87aSKai Wang 	Dwarf_ArangeSet as;
170*2de3b87aSKai Wang 	Dwarf_Arange ar;
171*2de3b87aSKai Wang 	uint64_t offset;
172*2de3b87aSKai Wang 	int ret;
173*2de3b87aSKai Wang 
174*2de3b87aSKai Wang 	as = dbg->dbgp_as;
175*2de3b87aSKai Wang 	assert(as != NULL);
176*2de3b87aSKai Wang 	if (STAILQ_EMPTY(&as->as_arlist))
177*2de3b87aSKai Wang 		return (DW_DLE_NONE);
178*2de3b87aSKai Wang 
179*2de3b87aSKai Wang 	as->as_length = 0;
180*2de3b87aSKai Wang 	as->as_version = 2;
181*2de3b87aSKai Wang 	as->as_cu_offset = 0;	/* We have only one CU. */
182*2de3b87aSKai Wang 	as->as_addrsz = dbg->dbg_pointer_size;
183*2de3b87aSKai Wang 	as->as_segsz = 0;	/* XXX */
184*2de3b87aSKai Wang 
185*2de3b87aSKai Wang 	/* Create .debug_arange section. */
186*2de3b87aSKai Wang 	if ((ret = _dwarf_section_init(dbg, &ds, ".debug_aranges", 0, error)) !=
187*2de3b87aSKai Wang 	    DW_DLE_NONE)
188*2de3b87aSKai Wang 		goto gen_fail0;
189*2de3b87aSKai Wang 
190*2de3b87aSKai Wang 	/* Create relocation section for .debug_aranges */
191*2de3b87aSKai Wang 	RCHECK(_dwarf_reloc_section_init(dbg, &drs, ds, error));
192*2de3b87aSKai Wang 
193*2de3b87aSKai Wang 	/* Write section header. */
194*2de3b87aSKai Wang 	RCHECK(WRITE_VALUE(as->as_length, 4));
195*2de3b87aSKai Wang 	RCHECK(WRITE_VALUE(as->as_version, 2));
196*2de3b87aSKai Wang 	RCHECK(_dwarf_reloc_entry_add(dbg, drs, ds, dwarf_drt_data_reloc, 4,
197*2de3b87aSKai Wang 	    ds->ds_size, 0, as->as_cu_offset, ".debug_info", error));
198*2de3b87aSKai Wang 	RCHECK(WRITE_VALUE(as->as_addrsz, 1));
199*2de3b87aSKai Wang 	RCHECK(WRITE_VALUE(as->as_segsz, 1));
200*2de3b87aSKai Wang 
201*2de3b87aSKai Wang 	/* Pad to (2 * address_size) */
202*2de3b87aSKai Wang 	offset = roundup(ds->ds_size, 2 * as->as_addrsz);
203*2de3b87aSKai Wang 	if (offset > ds->ds_size)
204*2de3b87aSKai Wang 		RCHECK(WRITE_PADDING(0, offset - ds->ds_size));
205*2de3b87aSKai Wang 
206*2de3b87aSKai Wang 	/* Write tuples. */
207*2de3b87aSKai Wang 	STAILQ_FOREACH(ar, &as->as_arlist, ar_next) {
208*2de3b87aSKai Wang 		RCHECK(_dwarf_reloc_entry_add(dbg, drs, ds,
209*2de3b87aSKai Wang 		    dwarf_drt_data_reloc, dbg->dbg_pointer_size, ds->ds_size,
210*2de3b87aSKai Wang 		    ar->ar_symndx, ar->ar_address, NULL, error));
211*2de3b87aSKai Wang 		if (ar->ar_esymndx > 0)
212*2de3b87aSKai Wang 			RCHECK(_dwarf_reloc_entry_add_pair(dbg, drs, ds,
213*2de3b87aSKai Wang 			    dbg->dbg_pointer_size, ds->ds_size, ar->ar_symndx,
214*2de3b87aSKai Wang 			    ar->ar_esymndx, ar->ar_address, ar->ar_eoff, error));
215*2de3b87aSKai Wang 		else
216*2de3b87aSKai Wang 			RCHECK(WRITE_VALUE(ar->ar_range, dbg->dbg_pointer_size));
217*2de3b87aSKai Wang 	}
218*2de3b87aSKai Wang 	RCHECK(WRITE_VALUE(0, dbg->dbg_pointer_size));
219*2de3b87aSKai Wang 	RCHECK(WRITE_VALUE(0, dbg->dbg_pointer_size));
220*2de3b87aSKai Wang 
221*2de3b87aSKai Wang 	/* Fill in the length field. */
222*2de3b87aSKai Wang 	as->as_length = ds->ds_size - 4;
223*2de3b87aSKai Wang 	offset = 0;
224*2de3b87aSKai Wang 	dbg->write(ds->ds_data, &offset, as->as_length, 4);
225*2de3b87aSKai Wang 
226*2de3b87aSKai Wang 	/* Inform application the creation of .debug_aranges ELF section. */
227*2de3b87aSKai Wang 	RCHECK(_dwarf_section_callback(dbg, ds, SHT_PROGBITS, 0, 0, 0, error));
228*2de3b87aSKai Wang 
229*2de3b87aSKai Wang 	/* Finalize relocation section for .debug_aranges */
230*2de3b87aSKai Wang 	RCHECK(_dwarf_reloc_section_finalize(dbg, drs, error));
231*2de3b87aSKai Wang 
232*2de3b87aSKai Wang 	return (DW_DLE_NONE);
233*2de3b87aSKai Wang 
234*2de3b87aSKai Wang gen_fail:
235*2de3b87aSKai Wang 	_dwarf_reloc_section_free(dbg, &drs);
236*2de3b87aSKai Wang 
237*2de3b87aSKai Wang gen_fail0:
238*2de3b87aSKai Wang 	_dwarf_section_free(dbg, &ds);
239*2de3b87aSKai Wang 
240*2de3b87aSKai Wang 	return (ret);
241*2de3b87aSKai Wang }
242*2de3b87aSKai Wang 
243*2de3b87aSKai Wang void
244*2de3b87aSKai Wang _dwarf_arange_pro_cleanup(Dwarf_P_Debug dbg)
245*2de3b87aSKai Wang {
246*2de3b87aSKai Wang 	Dwarf_ArangeSet as;
247*2de3b87aSKai Wang 	Dwarf_Arange ar, tar;
248*2de3b87aSKai Wang 
249*2de3b87aSKai Wang 	assert(dbg != NULL && dbg->dbg_mode == DW_DLC_WRITE);
250*2de3b87aSKai Wang 	if (dbg->dbgp_as == NULL)
251*2de3b87aSKai Wang 		return;
252*2de3b87aSKai Wang 
253*2de3b87aSKai Wang 	as = dbg->dbgp_as;
254*2de3b87aSKai Wang 	STAILQ_FOREACH_SAFE(ar, &as->as_arlist, ar_next, tar) {
255*2de3b87aSKai Wang 		STAILQ_REMOVE(&as->as_arlist, ar, _Dwarf_Arange, ar_next);
256*2de3b87aSKai Wang 		free(ar);
257*2de3b87aSKai Wang 	}
258*2de3b87aSKai Wang 	free(as);
259*2de3b87aSKai Wang 	dbg->dbgp_as = NULL;
260*2de3b87aSKai Wang }
261