summaryrefslogtreecommitdiffstats
path: root/dwarf-extract-struct.c
blob: 141bb83088153323f627a8d88e50e529b279b734 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
/*
 * Trivial dwarf parser to extract part of a struct from debug infos
 *
 * Author: Dominique Martinet <dominique.martinet@cea.fr>
 * License: WTFPLv2
 *
 * Canonical source: http://cgit.notk.org/asmadeus/dwarf-extract-struct.git
 */

#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <strings.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include "libdwarf/dwarf.h"
#include "libdwarf/libdwarf.h"


#define COUNT_ALL (-1)

static int debug = 0;

static void parse_dwarf(Dwarf_Debug dbg, const char *struct_name,
		const char *field_names[], int field_count);
static void find_struct(Dwarf_Debug dbg, Dwarf_Die die, const char *struct_name,
		const char *field_names[], int field_count, int level);
static void find_fields(Dwarf_Debug dbg, Dwarf_Die struct_die, Dwarf_Die die,
		const char *struct_name, const char *field_names[],
		int field_count, int level);
static void print_field(Dwarf_Debug dbg, Dwarf_Die die, const char *field_name,
		int pad_num);

void usage(const char *argv[]) {
	fprintf(stderr, "%s debug_file struct_name [field [field...]]\n",
		argv[0]);
}

int main(int argc, const char *argv[]) {
	Dwarf_Debug dbg = 0;
	int fd = -1;
	const char *filepath;
	const char *struct_name;
	int res = DW_DLV_ERROR;
	Dwarf_Error error;
	Dwarf_Handler errhand = 0;
	Dwarf_Ptr errarg = 0;

	if(argc < 3) {
		usage(argv);
		exit(1);
	}

	filepath = argv[1];
	struct_name = argv[2];

	fd = open(filepath,O_RDONLY);
	if(fd < 0) {
		fprintf(stderr, "Failure attempting to open %s\n",filepath);
	}
	res = dwarf_init(fd, DW_DLC_READ, errhand, errarg, &dbg, &error);
	if(res != DW_DLV_OK) {
		fprintf(stderr, "Giving up, cannot do DWARF processing\n");
		exit(1);
	}

	parse_dwarf(dbg, struct_name, argv + 3, argc - 3);

	res = dwarf_finish(dbg,&error);
	if(res != DW_DLV_OK) {
		fprintf(stderr, "dwarf_finish failed!\n");
	}
	close(fd);
	return 0;
}

static void parse_dwarf(Dwarf_Debug dbg, const char *struct_name,
		const char *field_names[], int field_count) {
	Dwarf_Bool is_info = 1;
	Dwarf_Unsigned cu_length;
	Dwarf_Half cu_version;
	Dwarf_Off cu_abbrev_offset;
	Dwarf_Half cu_pointer_size;
	Dwarf_Half cu_offset_size;
	Dwarf_Half cu_extension_size;
	Dwarf_Sig8 type_signature;
	Dwarf_Unsigned type_offset;
	Dwarf_Unsigned cu_next_offset;
	Dwarf_Error err;
	int rc;


	while (1) {
		Dwarf_Die die;

		rc = dwarf_next_cu_header_c(dbg, is_info, &cu_length,
			&cu_version, &cu_abbrev_offset, &cu_pointer_size,
			&cu_offset_size, &cu_extension_size, &type_signature,
			&type_offset, &cu_next_offset, &err);

		if (rc == DW_DLV_NO_ENTRY)
			break;
		if (rc != DW_DLV_OK) {
			fprintf(stderr, "error dwarf_next_cu_header_c: %d %s\n",
				rc, dwarf_errmsg(err));
			exit(1);
		}


		rc = dwarf_siblingof(dbg, NULL, &die, &err);
		if (rc != DW_DLV_OK) {
			fprintf(stderr, "first dwarf_siblingof failed: %d %s\n",
				rc, dwarf_errmsg(err));
			exit(1);
		}

		find_struct(dbg, die, struct_name, field_names, field_count, 0);
	}

	fprintf(stderr, "struct %s not found\n", struct_name);
	exit(2);
}

static void find_struct(Dwarf_Debug dbg, Dwarf_Die die, const char *struct_name,
		const char *field_names[], int field_count, int level) {
	Dwarf_Die next;
	Dwarf_Error err;
	int rc;

	if (level > 1)
		return;

	do {
		char *name;
		const char *tag_name;
		Dwarf_Half tag;

		rc = dwarf_diename(die, &name, &err);
		if (rc == DW_DLV_NO_ENTRY) {
			name = NULL;
		} else if (rc != DW_DLV_OK) {
			fprintf(stderr, "dwarf_diename error: %d %s\n",
				rc, dwarf_errmsg(err));
			exit(1);
		}

		rc = dwarf_tag(die, &tag, &err);
		if (rc != DW_DLV_OK) {
			fprintf(stderr, "dwarf_tag error: %d %s\n",
				rc, dwarf_errmsg(err));
			exit(1);
		}

		if (debug) {
			rc = dwarf_get_TAG_name(tag, &tag_name);
			if (rc != DW_DLV_OK) {
				fprintf(stderr,
					"dwarf_get_TAG_name error: %d\n", rc);
				exit(1);
			}

			printf("<%d> %p <%d> %s: %s\n", level, die, tag,
			       tag_name, name ? name : "<no name>");
		}

		rc = dwarf_child(die, &next, &err);
		if (rc == DW_DLV_ERROR) {
			fprintf(stderr, "dwarf_child error: %d %s\n",
				rc, dwarf_errmsg(err));
			exit(1);
		}
		if (rc == DW_DLV_OK) {
			if (tag == DW_TAG_structure_type
				&& name && strcasecmp(name, struct_name) == 0) {
				find_fields(dbg, die, next, struct_name,
					    field_names, field_count,
					    level + 1);
				fprintf(stderr,
					"Found struct %s but it did not have all members given!\nMissing:\n",
					struct_name);
				for (rc = 0; rc < field_count; rc++) {
					if (field_names[rc])
						fprintf(stderr, "%s\n",
							field_names[rc]);
				}
				exit(3);
			}
			find_struct(dbg, next, struct_name, field_names,
				    field_count, level + 1);
			dwarf_dealloc(dbg, next, DW_DLA_DIE);
		}


		rc = dwarf_siblingof(dbg, die, &next, &err);
		dwarf_dealloc(dbg, die, DW_DLA_DIE);
		if (name)
			dwarf_dealloc(dbg, name, DW_DLA_STRING);

		if (rc != DW_DLV_OK)
			break;

		die = next;
	} while (die);
}

static int dwarf_get_attribute_value(Dwarf_Debug dbg, Dwarf_Die die,
		int attr_index, int *pval, Dwarf_Error *perr) {
	Dwarf_Attribute attr;
	Dwarf_Unsigned val;
	int rc;

	rc = dwarf_attr(die, attr_index, &attr, perr);
	if (rc != DW_DLV_OK) {
		return rc;
	}
	Dwarf_Half form;
	rc = dwarf_whatform(attr, &form, perr);
	if (rc != DW_DLV_OK) {
		fprintf(stderr, "Error getting whatform: %s\n",
			dwarf_errmsg(*perr));
		exit(5);
	}
	if (form == DW_FORM_data1 || form == DW_FORM_data2
		|| form == DW_FORM_data2 || form == DW_FORM_data4
		|| form == DW_FORM_data8 || form == DW_FORM_udata) {
		dwarf_formudata(attr, &val, 0);
	} else if (form == DW_FORM_sdata) {
		Dwarf_Signed sval;
		dwarf_formsdata(attr, &sval, 0);
		if (sval < 0) {
			fprintf(stderr,
				"unsupported negative val\n");
			exit(5);
		}
		val = (Dwarf_Unsigned) sval;
	} else {
		Dwarf_Locdesc **locdescs;
		Dwarf_Signed len;
		if (dwarf_loclist_n(attr, &locdescs, &len,  perr)
				== DW_DLV_ERROR) {
			 fprintf(stderr, "unsupported member val\n");
			 exit(5);
		}
		if (len != 1
		    || locdescs[0]->ld_cents != 1
		    || (locdescs[0]->ld_s[0]).lr_atom
				!= DW_OP_plus_uconst) {
			 fprintf(stderr,
				"unsupported location expression\n");
			 exit(5);
		}
		val = (locdescs[0]->ld_s[0]).lr_number;
	}
	dwarf_dealloc(dbg, attr, DW_DLA_ATTR);

	*pval = (int) val;
	return DW_DLV_OK;
}

static int dwarf_get_offset(Dwarf_Debug dbg, Dwarf_Die die,
		int *poffset, Dwarf_Error *perr) {
	return dwarf_get_attribute_value(dbg, die, DW_AT_data_member_location,
					 poffset, perr);
}

static int dwarf_get_size(Dwarf_Debug dbg, Dwarf_Die die,
		int *psize, Dwarf_Error *perr) {
	return dwarf_get_attribute_value(dbg, die, DW_AT_byte_size,
					 psize, perr);
}

static int deref_type(Dwarf_Debug dbg, Dwarf_Die type_die,
		Dwarf_Die *new_type_die, Dwarf_Half *ptype_tag,
		Dwarf_Error *perr) {
	Dwarf_Attribute pointer_attr;
	Dwarf_Off pointer_off;
	int rc;

	rc = dwarf_attr(type_die, DW_AT_type, &pointer_attr,
			perr);
	if (rc != DW_DLV_OK)
		return rc;

	rc = dwarf_global_formref(pointer_attr, &pointer_off,
				  perr);
	if (rc != DW_DLV_OK)
		return rc;

	rc = dwarf_offdie_b(dbg, pointer_off, 1, new_type_die,
			    perr);
	if (rc != DW_DLV_OK)
		return rc;

	dwarf_dealloc(dbg, pointer_attr, DW_DLA_ATTR);

	if (ptype_tag)
		rc = dwarf_tag(*new_type_die, ptype_tag, perr);

	return rc;
}

static void find_fields(Dwarf_Debug dbg, Dwarf_Die struct_die, Dwarf_Die die,
		const char *struct_name, const char *field_names[],
		int field_count, int level) {
	Dwarf_Die next;
	Dwarf_Error err;
	int rc, i, printed_count = 0;
	int size;

	if (field_count == 1 && strcmp(field_names[0], "*") == 0) {
		/* special value to print all fields */
		field_count = COUNT_ALL;
	}

	printf("struct %s {\n\tunion {\n",
		struct_name);

	rc =  dwarf_get_size(dbg, struct_die, &size, &err);
	if (rc != DW_DLV_OK) {
		fprintf(stderr, "could not get size for struct %s: %s\n",
			struct_name, dwarf_errmsg(err));
		exit(1);
	}
	printf("\t\tchar whole_struct[%d];\n", size);

	do {
		char *name;
		const char *tag_name;
		Dwarf_Half tag;

		rc = dwarf_diename(die, &name, &err);
		if (rc == DW_DLV_NO_ENTRY) {
			name = NULL;
		} else if (rc != DW_DLV_OK) {
			fprintf(stderr, "dwarf_diename error: %d %s\n",
				rc, dwarf_errmsg(err));
			exit(1);
		}

		rc = dwarf_tag(die, &tag, &err);
		if (rc != DW_DLV_OK) {
			fprintf(stderr, "dwarf_tag error: %d %s\n",
				rc, dwarf_errmsg(err));
			exit(1);
		}

		if (debug) {
			rc = dwarf_get_TAG_name(tag, &tag_name);
			if (rc != DW_DLV_OK) {
				fprintf(stderr,
					"dwarf_get_TAG_name error: %d\n", rc);
				exit(1);
			}

			printf("<%d> %p <%d> %s: %s\n", level, die, tag,
			       tag_name, name ? name : "<no name>");
		}

		if (tag == DW_TAG_member && name) {
			for (i = 0; i < field_count; i++) {
				if (!field_names[i])
					continue;
				if (strcasecmp(name, field_names[i]) == 0) {
					print_field(dbg, die, field_names[i],
						printed_count);
					field_names[i] = NULL;
					printed_count++;
					break;
				}
			}
			if (field_count == COUNT_ALL) {
				print_field(dbg, die, name, printed_count++);
			}
			if (printed_count == field_count) {
				printf("\t};\n};\n");
				exit(0);
			}
		}

		rc = dwarf_siblingof(dbg, die, &next, &err);
		dwarf_dealloc(dbg, die, DW_DLA_DIE);
		if (name)
			dwarf_dealloc(dbg, name, DW_DLA_STRING);

		if (rc != DW_DLV_OK)
			break;

		die = next;
	} while (die);

	if (field_count == COUNT_ALL) {
		printf("\t};\n};\n");
		exit(0);
	}
}

static void print_field(Dwarf_Debug dbg, Dwarf_Die die, const char *field_name,
		int padnum) {
	Dwarf_Attribute attr;
	Dwarf_Error err;
	int offset = 0;
	char type_buf[1024];
	char array_buf[128] = "";
	char pointer_buf[128] = "";
	int rc;

	rc = dwarf_get_offset(dbg, die, &offset, &err);
	if (rc == DW_DLV_NO_ENTRY) {
		fprintf(stderr, "Found %s but no offset, assuming 0\n",
			field_name);
	} else if (rc != DW_DLV_OK) {
		fprintf(stderr, "Error getting dwarf attr offset: %s\n",
			dwarf_errmsg(err));
		exit(4);
	}

	rc = dwarf_attr(die, DW_AT_type, &attr, &err);
	if (rc == DW_DLV_NO_ENTRY) {
		fprintf(stderr,
			"Found %s but no type, can't assume that one out..\n",
			field_name);
		exit(6);
	} else if (rc != DW_DLV_OK) {
		fprintf(stderr, "Error getting dwarf attrlist: %s\n",
			dwarf_errmsg(err));
		exit(6);
	} else {
		Dwarf_Die type_die, next;
		Dwarf_Off type_off;
		Dwarf_Half type_tag;
		char *type_name;
		int pointer = 0;

		rc = dwarf_global_formref(attr, &type_off, &err);
		if (rc != DW_DLV_OK) {
			fprintf(stderr,
				"Error getting ref offset for type: %s\n",
				dwarf_errmsg(err));
			exit(7);
		}

		rc = dwarf_offdie_b(dbg, type_off, 1, &type_die, &err);
		if (rc != DW_DLV_OK) {
			fprintf(stderr,
				"Error getting die from offset for type: %s\n",
				dwarf_errmsg(err));
			exit(7);
		}

		rc = dwarf_tag(type_die, &type_tag, &err);
		if (rc != DW_DLV_OK) {
			fprintf(stderr, "dwarf_tag error: %d %s\n",
				rc, dwarf_errmsg(err));
			exit(7);
		}

		while (type_tag == DW_TAG_pointer_type) {
			pointer_buf[pointer++] = '*';

			rc = deref_type(dbg, type_die, &next,
					&type_tag, &err);
			/* No entry here means void* */
			if (rc == DW_DLV_NO_ENTRY)
				break;

			if (rc != DW_DLV_OK) {
				fprintf(stderr,
					"Could not deref type for %s: %s\n",
					field_name, dwarf_errmsg(err));
				exit(7);
			}

			dwarf_dealloc(dbg, type_die, DW_DLA_DIE);
			type_die = next;
		}

		if (type_tag == DW_TAG_array_type) {
			int next_offset, size;

			rc = deref_type(dbg, type_die, &next,
					&type_tag, &err);
			if (rc == DW_DLV_NO_ENTRY) {
				fprintf(stderr,
					"Could not deref array type for %s: no entry\n",
					field_name);
				exit(7);
			}
			if (rc != DW_DLV_OK) {
				fprintf(stderr,
					"Could not deref type for %s: %s\n",
					field_name, dwarf_errmsg(err));
				exit(7);
			}

			dwarf_dealloc(dbg, type_die, DW_DLA_DIE);
			type_die = next;

			/* get next pos */
			rc = dwarf_siblingof(dbg, die, &next, &err);
			if (rc == DW_DLV_NO_ENTRY) {
				fprintf(stderr,
					"Need to get sibling for array size but none left, please implement through whole struct size instead. field %s\n",
					field_name);
				exit(7);
			}
			if (rc != DW_DLV_OK) {
				fprintf(stderr,
					"Could not get sibling of field %s: %s\n",
					field_name, dwarf_errmsg(err));
				exit(7);
			}
			rc = dwarf_get_offset(dbg, next, &next_offset, &err);
			if (rc != DW_DLV_OK) {
				fprintf(stderr,
					"Could not get neighbor's offset for field %s: %s\n",
					field_name, dwarf_errmsg(err));
				exit(7);
			}
			dwarf_dealloc(dbg, next, DW_DLA_DIE);

			/* get type size */
			next = type_die;
			if (type_tag == DW_TAG_typedef) {
				rc = deref_type(dbg, type_die, &next, NULL, &err);
				if (rc != DW_DLV_OK) {
					fprintf(stderr,
						"Could not deref array typedef type for %s: %s\n",
						field_name, dwarf_errmsg(err));
					exit(7);
				}
			}
			rc = dwarf_get_size(dbg, next, &size, &err);
			if (rc != DW_DLV_OK) {
				fprintf(stderr,
					"Could not get size for type for %s: %s\n",
					field_name, dwarf_errmsg(err));
				exit(7);
			}
			if (next != type_die)
				dwarf_dealloc(dbg, next, DW_DLA_DIE);

			snprintf(array_buf, 128, "[%d]", (next_offset - offset) / size);
		}

		/* If it's still pointer at this point, it's void * */
		if (type_tag != DW_TAG_pointer_type) {
			rc = dwarf_diename(type_die, &type_name, &err);
			if (rc != DW_DLV_OK) {
				fprintf(stderr, "dwarf_diename error: %s\n",
					rc == DW_DLV_NO_ENTRY ?
						"no name" : dwarf_errmsg(err));
				const char *tag_name;

				rc = dwarf_get_TAG_name(type_tag, &tag_name);
				if (rc != DW_DLV_OK) {
					fprintf(stderr,
						"dwarf_get_TAG_name error: %d\n",
						rc);
				}

				fprintf(stderr, "Bad tag %s (%d)?\n",
					tag_name, type_tag);
				exit(7);
			}
		}

		if (type_tag == DW_TAG_structure_type) {
			snprintf(type_buf, 1024, "struct %s %s",
				 type_name, pointer_buf);
		} else if (type_tag == DW_TAG_base_type
				|| type_tag == DW_TAG_typedef) {
			snprintf(type_buf, 1024, "%s %s", type_name,
				pointer_buf);
		} else if (type_tag == DW_TAG_pointer_type) {
			snprintf(type_buf, 1024, "void %s", pointer_buf);
		} else {
			const char *tag_name;

			rc = dwarf_get_TAG_name(type_tag, &tag_name);
			if (rc != DW_DLV_OK) {
				fprintf(stderr,
					"dwarf_get_TAG_name error: %d\n", rc);
			}

			fprintf(stderr,
				"Type tag %s (%d) is not implemented, please add it\n",
				tag_name, type_tag);
			exit(7);
		}

		dwarf_dealloc(dbg, type_name, DW_DLA_STRING);
		dwarf_dealloc(dbg, attr, DW_DLA_ATTR);
		dwarf_dealloc(dbg, type_die, DW_DLA_DIE);
	}

	printf("\t\tstruct {\n\t\t\tchar padding%i[%u];\n\t\t\t%s%s%s;\n\t\t};\n",
		padnum, (unsigned int) offset,
		type_buf, field_name, array_buf);
}