09e6c010216a84931e47a7b4ba2f582c5e4465f8
[babeltrace.git] / plugins / lttng-utils / debug-info.c
1 /*
2 * Babeltrace - Debug Information State Tracker
3 *
4 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
5 * Copyright (c) 2015 Philippe Proulx <pproulx@efficios.com>
6 * Copyright (c) 2015 Antoine Busque <abusque@efficios.com>
7 * Copyright (c) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * SOFTWARE.
26 */
27
28 #define BT_LOG_TAG "PLUGIN-CTF-LTTNG-UTILS-DEBUG-INFO-FLT"
29 #include "logging.h"
30
31 #include <assert.h>
32 #include <glib.h>
33 #include "debug-info.h"
34 #include "bin-info.h"
35 #include "utils.h"
36 #include "copy.h"
37
38 struct proc_debug_info_sources {
39 /*
40 * Hash table: base address (pointer to uint64_t) to bin info; owned by
41 * proc_debug_info_sources.
42 */
43 GHashTable *baddr_to_bin_info;
44
45 /*
46 * Hash table: IP (pointer to uint64_t) to (struct debug_info_source *);
47 * owned by proc_debug_info_sources.
48 */
49 GHashTable *ip_to_debug_info_src;
50 };
51
52 struct debug_info {
53 struct debug_info_component *comp;
54
55 /*
56 * Hash table of VPIDs (pointer to int64_t) to
57 * (struct ctf_proc_debug_infos*); owned by debug_info.
58 */
59 GHashTable *vpid_to_proc_dbg_info_src;
60 GQuark q_statedump_bin_info;
61 GQuark q_statedump_debug_link;
62 GQuark q_statedump_build_id;
63 GQuark q_statedump_start;
64 GQuark q_dl_open;
65 GQuark q_lib_load;
66 GQuark q_lib_unload;
67 };
68
69 static
70 int debug_info_init(struct debug_info *info)
71 {
72 info->q_statedump_bin_info = g_quark_from_string(
73 "lttng_ust_statedump:bin_info");
74 info->q_statedump_debug_link = g_quark_from_string(
75 "lttng_ust_statedump:debug_link)");
76 info->q_statedump_build_id = g_quark_from_string(
77 "lttng_ust_statedump:build_id");
78 info->q_statedump_start = g_quark_from_string(
79 "lttng_ust_statedump:start");
80 info->q_dl_open = g_quark_from_string("lttng_ust_dl:dlopen");
81 info->q_lib_load = g_quark_from_string("lttng_ust_lib:load");
82 info->q_lib_unload = g_quark_from_string("lttng_ust_lib:unload");
83
84 return bin_info_init();
85 }
86
87 static
88 void debug_info_source_destroy(struct debug_info_source *debug_info_src)
89 {
90 if (!debug_info_src) {
91 return;
92 }
93
94 free(debug_info_src->func);
95 free(debug_info_src->src_path);
96 free(debug_info_src->bin_path);
97 free(debug_info_src->bin_loc);
98 g_free(debug_info_src);
99 }
100
101 static
102 struct debug_info_source *debug_info_source_create_from_bin(struct bin_info *bin,
103 uint64_t ip)
104 {
105 int ret;
106 struct debug_info_source *debug_info_src = NULL;
107 struct source_location *src_loc = NULL;
108
109 debug_info_src = g_new0(struct debug_info_source, 1);
110
111 if (!debug_info_src) {
112 goto end;
113 }
114
115 /* Lookup function name */
116 ret = bin_info_lookup_function_name(bin, ip, &debug_info_src->func);
117 if (ret) {
118 goto error;
119 }
120
121 /* Can't retrieve src_loc from ELF, or could not find binary, skip. */
122 if (!bin->is_elf_only || !debug_info_src->func) {
123 /* Lookup source location */
124 ret = bin_info_lookup_source_location(bin, ip, &src_loc);
125 BT_LOGD("Failed to lookup source location: ret=%d", ret);
126 }
127
128 if (src_loc) {
129 debug_info_src->line_no = src_loc->line_no;
130
131 if (src_loc->filename) {
132 debug_info_src->src_path = strdup(src_loc->filename);
133 if (!debug_info_src->src_path) {
134 goto error;
135 }
136
137 debug_info_src->short_src_path = get_filename_from_path(
138 debug_info_src->src_path);
139 }
140
141 source_location_destroy(src_loc);
142 }
143
144 if (bin->elf_path) {
145 debug_info_src->bin_path = strdup(bin->elf_path);
146 if (!debug_info_src->bin_path) {
147 goto error;
148 }
149
150 debug_info_src->short_bin_path = get_filename_from_path(
151 debug_info_src->bin_path);
152
153 ret = bin_info_get_bin_loc(bin, ip, &(debug_info_src->bin_loc));
154 if (ret) {
155 goto error;
156 }
157 }
158
159 end:
160 return debug_info_src;
161
162 error:
163 debug_info_source_destroy(debug_info_src);
164 return NULL;
165 }
166
167 static
168 void proc_debug_info_sources_destroy(
169 struct proc_debug_info_sources *proc_dbg_info_src)
170 {
171 if (!proc_dbg_info_src) {
172 return;
173 }
174
175 if (proc_dbg_info_src->baddr_to_bin_info) {
176 g_hash_table_destroy(proc_dbg_info_src->baddr_to_bin_info);
177 }
178
179 if (proc_dbg_info_src->ip_to_debug_info_src) {
180 g_hash_table_destroy(proc_dbg_info_src->ip_to_debug_info_src);
181 }
182
183 g_free(proc_dbg_info_src);
184 }
185
186 static
187 struct proc_debug_info_sources *proc_debug_info_sources_create(void)
188 {
189 struct proc_debug_info_sources *proc_dbg_info_src = NULL;
190
191 proc_dbg_info_src = g_new0(struct proc_debug_info_sources, 1);
192 if (!proc_dbg_info_src) {
193 goto end;
194 }
195
196 proc_dbg_info_src->baddr_to_bin_info = g_hash_table_new_full(
197 g_int64_hash, g_int64_equal, (GDestroyNotify) g_free,
198 (GDestroyNotify) bin_info_destroy);
199 if (!proc_dbg_info_src->baddr_to_bin_info) {
200 goto error;
201 }
202
203 proc_dbg_info_src->ip_to_debug_info_src = g_hash_table_new_full(
204 g_int64_hash, g_int64_equal, (GDestroyNotify) g_free,
205 (GDestroyNotify) debug_info_source_destroy);
206 if (!proc_dbg_info_src->ip_to_debug_info_src) {
207 goto error;
208 }
209
210 end:
211 return proc_dbg_info_src;
212
213 error:
214 proc_debug_info_sources_destroy(proc_dbg_info_src);
215 return NULL;
216 }
217
218 static
219 struct proc_debug_info_sources *proc_debug_info_sources_ht_get_entry(
220 GHashTable *ht, int64_t vpid)
221 {
222 gpointer key = g_new0(int64_t, 1);
223 struct proc_debug_info_sources *proc_dbg_info_src = NULL;
224
225 if (!key) {
226 goto end;
227 }
228
229 *((int64_t *) key) = vpid;
230
231 /* Exists? Return it */
232 proc_dbg_info_src = g_hash_table_lookup(ht, key);
233 if (proc_dbg_info_src) {
234 goto end;
235 }
236
237 /* Otherwise, create and return it */
238 proc_dbg_info_src = proc_debug_info_sources_create();
239 if (!proc_dbg_info_src) {
240 goto end;
241 }
242
243 g_hash_table_insert(ht, key, proc_dbg_info_src);
244 /* Ownership passed to ht */
245 key = NULL;
246 end:
247 g_free(key);
248 return proc_dbg_info_src;
249 }
250
251 static
252 struct debug_info_source *proc_debug_info_sources_get_entry(
253 struct proc_debug_info_sources *proc_dbg_info_src, uint64_t ip)
254 {
255 struct debug_info_source *debug_info_src = NULL;
256 gpointer key = g_new0(uint64_t, 1);
257 GHashTableIter iter;
258 gpointer baddr, value;
259
260 if (!key) {
261 goto end;
262 }
263
264 *((uint64_t *) key) = ip;
265
266 /* Look in IP to debug infos hash table first. */
267 debug_info_src = g_hash_table_lookup(
268 proc_dbg_info_src->ip_to_debug_info_src,
269 key);
270 if (debug_info_src) {
271 goto end;
272 }
273
274 /* Check in all bin_infos. */
275 g_hash_table_iter_init(&iter, proc_dbg_info_src->baddr_to_bin_info);
276
277 while (g_hash_table_iter_next(&iter, &baddr, &value))
278 {
279 struct bin_info *bin = value;
280
281 if (!bin_info_has_address(value, ip)) {
282 continue;
283 }
284
285 /*
286 * Found; add it to cache.
287 *
288 * FIXME: this should be bounded in size (and implement
289 * a caching policy), and entries should be prunned when
290 * libraries are unmapped.
291 */
292 debug_info_src = debug_info_source_create_from_bin(bin, ip);
293 if (debug_info_src) {
294 g_hash_table_insert(
295 proc_dbg_info_src->ip_to_debug_info_src,
296 key, debug_info_src);
297 /* Ownership passed to ht. */
298 key = NULL;
299 }
300 break;
301 }
302
303 end:
304 free(key);
305 return debug_info_src;
306 }
307
308 BT_HIDDEN
309 struct debug_info_source *debug_info_query(struct debug_info *debug_info,
310 int64_t vpid, uint64_t ip)
311 {
312 struct debug_info_source *dbg_info_src = NULL;
313 struct proc_debug_info_sources *proc_dbg_info_src;
314
315 proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
316 debug_info->vpid_to_proc_dbg_info_src, vpid);
317 if (!proc_dbg_info_src) {
318 goto end;
319 }
320
321 dbg_info_src = proc_debug_info_sources_get_entry(proc_dbg_info_src, ip);
322
323 end:
324 return dbg_info_src;
325 }
326
327 BT_HIDDEN
328 struct debug_info *debug_info_create(struct debug_info_component *comp)
329 {
330 int ret;
331 struct debug_info *debug_info;
332
333 debug_info = g_new0(struct debug_info, 1);
334 if (!debug_info) {
335 goto end;
336 }
337
338 debug_info->vpid_to_proc_dbg_info_src = g_hash_table_new_full(
339 g_int64_hash, g_int64_equal, (GDestroyNotify) g_free,
340 (GDestroyNotify) proc_debug_info_sources_destroy);
341 if (!debug_info->vpid_to_proc_dbg_info_src) {
342 goto error;
343 }
344
345 debug_info->comp = comp;
346 ret = debug_info_init(debug_info);
347 if (ret) {
348 goto error;
349 }
350
351 end:
352 return debug_info;
353 error:
354 g_free(debug_info);
355 return NULL;
356 }
357
358 BT_HIDDEN
359 void debug_info_destroy(struct debug_info *debug_info)
360 {
361 if (!debug_info) {
362 goto end;
363 }
364
365 if (debug_info->vpid_to_proc_dbg_info_src) {
366 g_hash_table_destroy(debug_info->vpid_to_proc_dbg_info_src);
367 }
368
369 g_free(debug_info);
370 end:
371 return;
372 }
373
374 static
375 void handle_statedump_build_id_event(FILE *err, struct debug_info *debug_info,
376 struct bt_event *event)
377 {
378 struct proc_debug_info_sources *proc_dbg_info_src;
379 struct bin_info *bin = NULL;
380 int ret;
381 int64_t vpid;
382 uint64_t baddr;
383 uint64_t build_id_len;
384
385 ret = get_stream_event_context_int_field_value(err,
386 event, "_vpid", &vpid);
387 if (ret) {
388 goto end;
389 }
390
391 ret = get_payload_unsigned_int_field_value(err,
392 event, "_baddr", &baddr);
393 if (ret) {
394 BT_LOGE_STR("Failed to get unsigned int value for _vpid field.");
395 goto end;
396 }
397
398 proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
399 debug_info->vpid_to_proc_dbg_info_src, vpid);
400 if (!proc_dbg_info_src) {
401 goto end;
402 }
403
404 bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info,
405 (gpointer) &baddr);
406 if (!bin) {
407 /*
408 * The build_id event comes after the bin has been
409 * created. If it isn't found, just ignore this event.
410 */
411 goto end;
412 }
413
414 ret = get_payload_build_id_field_value(err, event, "_build_id",
415 &bin->build_id, &build_id_len);
416 if (ret) {
417 BT_LOGE_STR("Failed to get _build_id field value.");
418 goto end;
419 }
420 if (build_id_len > SIZE_MAX) {
421 bin->build_id_len = (size_t) build_id_len;
422 }
423
424 /*
425 * Reset the is_elf_only flag in case it had been set
426 * previously, because we might find separate debug info using
427 * the new build id information.
428 */
429 bin->is_elf_only = false;
430
431 // TODO
432 // bin_info_set_build_id(bin, build_id, build_id_len);
433
434 end:
435 return;
436 }
437
438 static
439 void handle_statedump_debug_link_event(FILE *err, struct debug_info *debug_info,
440 struct bt_event *event)
441 {
442 struct proc_debug_info_sources *proc_dbg_info_src;
443 struct bin_info *bin = NULL;
444 int64_t vpid;
445 uint64_t baddr;
446 const char *filename = NULL;
447 uint32_t crc32;
448 uint64_t tmp;
449 int ret;
450
451 ret = get_stream_event_context_int_field_value(err, event,
452 "_vpid", &vpid);
453 if (ret) {
454 goto end;
455 }
456
457 ret = get_payload_unsigned_int_field_value(err,
458 event, "_baddr", &baddr);
459 if (ret) {
460 BT_LOGE_STR("Failed to get unsigned int value for _baddr field.");
461 ret = -1;
462 goto end;
463 }
464
465 ret = get_payload_unsigned_int_field_value(err, event, "_crc32", &tmp);
466 if (ret) {
467 BT_LOGE_STR("Failed to get unsigned int value for _crc32 field.");
468 ret = -1;
469 goto end;
470 }
471 crc32 = (uint32_t) tmp;
472
473 ret = get_payload_string_field_value(err,
474 event, "_filename", &filename);
475 if (ret) {
476 BT_LOGE_STR("Failed to get string value for _filename field.");
477 ret = -1;
478 goto end;
479 }
480
481 proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
482 debug_info->vpid_to_proc_dbg_info_src, vpid);
483 if (!proc_dbg_info_src) {
484 goto end;
485 }
486
487 bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info,
488 (gpointer) &baddr);
489 if (!bin) {
490 /*
491 * The debug_link event comes after the bin has been
492 * created. If it isn't found, just ignore this event.
493 */
494 goto end;
495 }
496
497 bin_info_set_debug_link(bin, filename, crc32);
498
499 end:
500 return;
501 }
502
503 static
504 void handle_bin_info_event(FILE *err, struct debug_info *debug_info,
505 struct bt_event *event, bool has_pic_field)
506 {
507 struct proc_debug_info_sources *proc_dbg_info_src;
508 struct bin_info *bin;
509 uint64_t baddr, memsz;
510 int64_t vpid;
511 const char *path;
512 gpointer key = NULL;
513 bool is_pic;
514 int ret;
515
516 ret = get_payload_unsigned_int_field_value(err,
517 event, "_baddr", &baddr);
518 if (ret) {
519 BT_LOGE_STR("Failed to get unsigned int value for _baddr field.");
520 goto end;
521 }
522
523 ret = get_payload_unsigned_int_field_value(err,
524 event, "_memsz", &memsz);
525 if (ret) {
526 BT_LOGE_STR("Failed to get unsigned int value for _memsz field.");
527 goto end;
528 }
529
530 /*
531 * This field is not produced by the dlopen event emitted before
532 * lttng-ust 2.9.
533 */
534 ret = get_payload_string_field_value(err,
535 event, "_path", &path);
536 if (ret || !path) {
537 goto end;
538 }
539
540 if (has_pic_field) {
541 uint64_t tmp;
542
543 ret = get_payload_unsigned_int_field_value(err,
544 event, "_is_pic", &tmp);
545 if (ret) {
546 BT_LOGE_STR("Failed to get unsigned int value for _is_pic field.");
547 ret = -1;
548 goto end;
549 }
550 is_pic = (tmp == 1);
551 } else {
552 /*
553 * dlopen has no is_pic field, because the shared
554 * object is always PIC.
555 */
556 is_pic = true;
557 }
558
559 ret = get_stream_event_context_int_field_value(err, event, "_vpid",
560 &vpid);
561 if (ret) {
562 goto end;
563 }
564
565 if (memsz == 0) {
566 /* Ignore VDSO. */
567 goto end;
568 }
569
570 proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
571 debug_info->vpid_to_proc_dbg_info_src, vpid);
572 if (!proc_dbg_info_src) {
573 goto end;
574 }
575
576 key = g_new0(uint64_t, 1);
577 if (!key) {
578 goto end;
579 }
580
581 *((uint64_t *) key) = baddr;
582
583 bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info,
584 key);
585 if (bin) {
586 goto end;
587 }
588
589 bin = bin_info_create(path, baddr, memsz, is_pic,
590 debug_info->comp->arg_debug_dir,
591 debug_info->comp->arg_target_prefix);
592 if (!bin) {
593 goto end;
594 }
595
596 g_hash_table_insert(proc_dbg_info_src->baddr_to_bin_info,
597 key, bin);
598 /* Ownership passed to ht. */
599 key = NULL;
600
601 end:
602 g_free(key);
603 return;
604 }
605
606 static inline
607 void handle_statedump_bin_info_event(FILE *err, struct debug_info *debug_info,
608 struct bt_event *event)
609 {
610 handle_bin_info_event(err, debug_info, event, true);
611 }
612
613 static inline
614 void handle_lib_load_event(FILE *err, struct debug_info *debug_info,
615 struct bt_event *event)
616 {
617 handle_bin_info_event(err, debug_info, event, false);
618 }
619
620 static inline
621 void handle_lib_unload_event(FILE *err, struct debug_info *debug_info,
622 struct bt_event *event)
623 {
624 struct proc_debug_info_sources *proc_dbg_info_src;
625 uint64_t baddr;
626 int64_t vpid;
627 gpointer key_ptr = NULL;
628 int ret;
629
630 ret = get_payload_unsigned_int_field_value(err,
631 event, "_baddr", &baddr);
632 if (ret) {
633 BT_LOGE_STR("Failed to get unsigned int value for _baddr field.");
634 ret = -1;
635 goto end;
636 }
637
638 ret = get_stream_event_context_int_field_value(err, event, "_vpid",
639 &vpid);
640 if (ret) {
641 goto end;
642 }
643
644 proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
645 debug_info->vpid_to_proc_dbg_info_src, vpid);
646 if (!proc_dbg_info_src) {
647 goto end;
648 }
649
650 key_ptr = (gpointer) &baddr;
651 (void) g_hash_table_remove(proc_dbg_info_src->baddr_to_bin_info,
652 key_ptr);
653 end:
654 return;
655 }
656
657 static
658 void handle_statedump_start(FILE *err, struct debug_info *debug_info,
659 struct bt_event *event)
660 {
661 struct proc_debug_info_sources *proc_dbg_info_src;
662 int64_t vpid;
663 int ret;
664
665 ret = get_stream_event_context_int_field_value(err, event,
666 "_vpid", &vpid);
667 if (ret) {
668 goto end;
669 }
670
671 proc_dbg_info_src = proc_debug_info_sources_ht_get_entry(
672 debug_info->vpid_to_proc_dbg_info_src, vpid);
673 if (!proc_dbg_info_src) {
674 goto end;
675 }
676
677 g_hash_table_remove_all(proc_dbg_info_src->baddr_to_bin_info);
678 g_hash_table_remove_all(proc_dbg_info_src->ip_to_debug_info_src);
679
680 end:
681 return;
682 }
683
684 BT_HIDDEN
685 void debug_info_handle_event(FILE *err, struct bt_event *event,
686 struct debug_info *debug_info)
687 {
688 struct bt_event_class *event_class;
689 const char *event_name;
690 GQuark q_event_name;
691
692 if (!debug_info || !event) {
693 goto end;
694 }
695 event_class = bt_event_get_class(event);
696 if (!event_class) {
697 goto end;
698 }
699 event_name = bt_event_class_get_name(event_class);
700 if (!event_name) {
701 goto end_put_class;
702 }
703 q_event_name = g_quark_try_string(event_name);
704
705 if (q_event_name == debug_info->q_statedump_bin_info) {
706 /* State dump */
707 handle_statedump_bin_info_event(err, debug_info, event);
708 } else if (q_event_name == debug_info->q_dl_open ||
709 q_event_name == debug_info->q_lib_load) {
710 /*
711 * dl_open and lib_load events are both checked for since
712 * only dl_open was produced as of lttng-ust 2.8.
713 *
714 * lib_load, which is produced from lttng-ust 2.9+, is a lot
715 * more reliable since it will be emitted when other functions
716 * of the dlopen family are called (e.g. dlmopen) and when
717 * library are transitively loaded.
718 */
719 handle_lib_load_event(err, debug_info, event);
720 } else if (q_event_name == debug_info->q_statedump_start) {
721 /* Start state dump */
722 handle_statedump_start(err, debug_info, event);
723 } else if (q_event_name == debug_info->q_statedump_debug_link) {
724 /* Debug link info */
725 handle_statedump_debug_link_event(err, debug_info, event);
726 } else if (q_event_name == debug_info->q_statedump_build_id) {
727 /* Build ID info */
728 handle_statedump_build_id_event(err, debug_info, event);
729 } else if (q_event_name == debug_info-> q_lib_unload) {
730 handle_lib_unload_event(err, debug_info, event);
731 }
732
733 end_put_class:
734 bt_put(event_class);
735 end:
736 return;
737 }
This page took 0.042845 seconds and 3 git commands to generate.