Commit | Line | Data |
---|---|---|
4f45f9bb JD |
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> | |
ca9f27f3 | 8 | * Copyright (c) 2019 Francis Deslauriers <francis.deslauriers@efficios.com> |
4f45f9bb JD |
9 | * |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
91bc8451 | 29 | #define BT_COMP_LOG_SELF_COMP self_comp |
3a3d15f3 | 30 | #define BT_LOG_OUTPUT_LEVEL log_level |
350ad6c1 | 31 | #define BT_LOG_TAG "PLUGIN/FLT.LTTNG-UTILS.DEBUG-INFO" |
d9c39b0a | 32 | #include "logging/comp-logging.h" |
b4565e8b | 33 | |
4f45f9bb | 34 | #include <glib.h> |
ca9f27f3 | 35 | |
578e048b MJ |
36 | #include "common/assert.h" |
37 | #include "common/common.h" | |
38 | #include "fd-cache/fd-cache.h" | |
ca9f27f3 | 39 | |
4f45f9bb | 40 | #include "bin-info.h" |
ca9f27f3 FD |
41 | #include "debug-info.h" |
42 | #include "trace-ir-data-copy.h" | |
43 | #include "trace-ir-mapping.h" | |
44 | #include "trace-ir-metadata-copy.h" | |
4f45f9bb | 45 | #include "utils.h" |
cf7b259e | 46 | #include "plugins/common/param-validation/param-validation.h" |
ca9f27f3 FD |
47 | |
48 | #define DEFAULT_DEBUG_INFO_FIELD_NAME "debug_info" | |
49 | #define LTTNG_UST_STATEDUMP_PREFIX "lttng_ust" | |
50 | #define VPID_FIELD_NAME "vpid" | |
51 | #define IP_FIELD_NAME "ip" | |
52 | #define BADDR_FIELD_NAME "baddr" | |
53 | #define CRC32_FIELD_NAME "crc" | |
54 | #define BUILD_ID_FIELD_NAME "build_id" | |
55 | #define FILENAME_FIELD_NAME "filename" | |
56 | #define IS_PIC_FIELD_NAME "is_pic" | |
57 | #define MEMSZ_FIELD_NAME "memsz" | |
58 | #define PATH_FIELD_NAME "path" | |
59 | ||
60 | struct debug_info_component { | |
3a3d15f3 | 61 | bt_logging_level log_level; |
91bc8451 | 62 | bt_self_component *self_comp; |
06d1cf5d FD |
63 | gchar *arg_debug_dir; |
64 | gchar *arg_debug_info_field_name; | |
65 | gchar *arg_target_prefix; | |
66 | bt_bool arg_full_path; | |
ca9f27f3 FD |
67 | }; |
68 | ||
69 | struct debug_info_msg_iter { | |
3a3d15f3 | 70 | bt_logging_level log_level; |
ca9f27f3 FD |
71 | struct debug_info_component *debug_info_component; |
72 | bt_self_message_iterator *input_iterator; | |
73 | bt_self_component *self_comp; | |
74 | bt_self_component_port_input_message_iterator *msg_iter; | |
75 | ||
76 | struct trace_ir_maps *ir_maps; | |
77 | /* in_trace -> debug_info_mapping. */ | |
78 | GHashTable *debug_info_map; | |
1e638f98 FD |
79 | |
80 | struct bt_fd_cache fd_cache; | |
ca9f27f3 FD |
81 | }; |
82 | ||
83 | struct debug_info_source { | |
84 | /* Strings are owned by debug_info_source. */ | |
06d1cf5d | 85 | gchar *func; |
ca9f27f3 FD |
86 | /* |
87 | * Store the line number as a string so that the allocation and | |
88 | * conversion to string is only done once. | |
89 | */ | |
06d1cf5d FD |
90 | gchar *line_no; |
91 | gchar *src_path; | |
ca9f27f3 | 92 | /* short_src_path points inside src_path, no need to free. */ |
06d1cf5d FD |
93 | const gchar *short_src_path; |
94 | gchar *bin_path; | |
ca9f27f3 | 95 | /* short_bin_path points inside bin_path, no need to free. */ |
06d1cf5d | 96 | const gchar *short_bin_path; |
ca9f27f3 FD |
97 | /* |
98 | * Location within the binary. Either absolute (@0x1234) or | |
99 | * relative (+0x4321). | |
100 | */ | |
06d1cf5d | 101 | gchar *bin_loc; |
ca9f27f3 | 102 | }; |
4f45f9bb JD |
103 | |
104 | struct proc_debug_info_sources { | |
105 | /* | |
106 | * Hash table: base address (pointer to uint64_t) to bin info; owned by | |
107 | * proc_debug_info_sources. | |
108 | */ | |
109 | GHashTable *baddr_to_bin_info; | |
110 | ||
111 | /* | |
112 | * Hash table: IP (pointer to uint64_t) to (struct debug_info_source *); | |
113 | * owned by proc_debug_info_sources. | |
114 | */ | |
115 | GHashTable *ip_to_debug_info_src; | |
116 | }; | |
117 | ||
118 | struct debug_info { | |
3a3d15f3 | 119 | bt_logging_level log_level; |
91bc8451 | 120 | bt_self_component *self_comp; |
9d325e17 | 121 | struct debug_info_component *comp; |
ca9f27f3 | 122 | const bt_trace *input_trace; |
2054a0d1 | 123 | bt_listener_id destruction_listener_id; |
9d325e17 | 124 | |
4f45f9bb JD |
125 | /* |
126 | * Hash table of VPIDs (pointer to int64_t) to | |
f9597f41 | 127 | * (struct proc_debug_info_sources*); owned by debug_info. |
4f45f9bb JD |
128 | */ |
129 | GHashTable *vpid_to_proc_dbg_info_src; | |
130 | GQuark q_statedump_bin_info; | |
131 | GQuark q_statedump_debug_link; | |
132 | GQuark q_statedump_build_id; | |
133 | GQuark q_statedump_start; | |
134 | GQuark q_dl_open; | |
135 | GQuark q_lib_load; | |
136 | GQuark q_lib_unload; | |
1e638f98 | 137 | struct bt_fd_cache *fd_cache; /* Weak ref. Owned by the iterator. */ |
4f45f9bb JD |
138 | }; |
139 | ||
140 | static | |
141 | int debug_info_init(struct debug_info *info) | |
142 | { | |
143 | info->q_statedump_bin_info = g_quark_from_string( | |
144 | "lttng_ust_statedump:bin_info"); | |
145 | info->q_statedump_debug_link = g_quark_from_string( | |
ca9f27f3 | 146 | "lttng_ust_statedump:debug_link"); |
4f45f9bb JD |
147 | info->q_statedump_build_id = g_quark_from_string( |
148 | "lttng_ust_statedump:build_id"); | |
149 | info->q_statedump_start = g_quark_from_string( | |
150 | "lttng_ust_statedump:start"); | |
151 | info->q_dl_open = g_quark_from_string("lttng_ust_dl:dlopen"); | |
152 | info->q_lib_load = g_quark_from_string("lttng_ust_lib:load"); | |
153 | info->q_lib_unload = g_quark_from_string("lttng_ust_lib:unload"); | |
154 | ||
91bc8451 | 155 | return bin_info_init(info->log_level, info->self_comp); |
4f45f9bb JD |
156 | } |
157 | ||
158 | static | |
159 | void debug_info_source_destroy(struct debug_info_source *debug_info_src) | |
160 | { | |
161 | if (!debug_info_src) { | |
162 | return; | |
163 | } | |
164 | ||
06d1cf5d FD |
165 | g_free(debug_info_src->func); |
166 | g_free(debug_info_src->line_no); | |
167 | g_free(debug_info_src->src_path); | |
168 | g_free(debug_info_src->bin_path); | |
169 | g_free(debug_info_src->bin_loc); | |
4f45f9bb JD |
170 | g_free(debug_info_src); |
171 | } | |
172 | ||
173 | static | |
ca9f27f3 | 174 | struct debug_info_source *debug_info_source_create_from_bin( |
91bc8451 PP |
175 | struct bin_info *bin, uint64_t ip, |
176 | bt_self_component *self_comp) | |
4f45f9bb JD |
177 | { |
178 | int ret; | |
179 | struct debug_info_source *debug_info_src = NULL; | |
180 | struct source_location *src_loc = NULL; | |
03df65b7 SM |
181 | bt_logging_level log_level; |
182 | ||
183 | BT_ASSERT(bin); | |
184 | ||
185 | log_level = bin->log_level; | |
4f45f9bb JD |
186 | |
187 | debug_info_src = g_new0(struct debug_info_source, 1); | |
188 | ||
189 | if (!debug_info_src) { | |
190 | goto end; | |
191 | } | |
192 | ||
193 | /* Lookup function name */ | |
194 | ret = bin_info_lookup_function_name(bin, ip, &debug_info_src->func); | |
195 | if (ret) { | |
196 | goto error; | |
197 | } | |
198 | ||
199 | /* Can't retrieve src_loc from ELF, or could not find binary, skip. */ | |
200 | if (!bin->is_elf_only || !debug_info_src->func) { | |
201 | /* Lookup source location */ | |
202 | ret = bin_info_lookup_source_location(bin, ip, &src_loc); | |
ca9f27f3 | 203 | if (ret) { |
91bc8451 | 204 | BT_COMP_LOGI("Failed to lookup source location: ret=%d", ret); |
ca9f27f3 | 205 | } |
4f45f9bb JD |
206 | } |
207 | ||
208 | if (src_loc) { | |
06d1cf5d FD |
209 | debug_info_src->line_no = |
210 | g_strdup_printf("%"PRId64, src_loc->line_no); | |
211 | if (!debug_info_src->line_no) { | |
3b34b490 FD |
212 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
213 | "Error occured when setting `line_no` field."); | |
ca9f27f3 FD |
214 | goto error; |
215 | } | |
4f45f9bb JD |
216 | |
217 | if (src_loc->filename) { | |
06d1cf5d | 218 | debug_info_src->src_path = g_strdup(src_loc->filename); |
4f45f9bb JD |
219 | if (!debug_info_src->src_path) { |
220 | goto error; | |
221 | } | |
222 | ||
223 | debug_info_src->short_src_path = get_filename_from_path( | |
bc463d34 | 224 | debug_info_src->src_path); |
4f45f9bb | 225 | } |
4f45f9bb JD |
226 | source_location_destroy(src_loc); |
227 | } | |
228 | ||
229 | if (bin->elf_path) { | |
06d1cf5d | 230 | debug_info_src->bin_path = g_strdup(bin->elf_path); |
4f45f9bb JD |
231 | if (!debug_info_src->bin_path) { |
232 | goto error; | |
233 | } | |
234 | ||
235 | debug_info_src->short_bin_path = get_filename_from_path( | |
bc463d34 | 236 | debug_info_src->bin_path); |
4f45f9bb JD |
237 | |
238 | ret = bin_info_get_bin_loc(bin, ip, &(debug_info_src->bin_loc)); | |
239 | if (ret) { | |
240 | goto error; | |
241 | } | |
242 | } | |
243 | ||
244 | end: | |
245 | return debug_info_src; | |
246 | ||
247 | error: | |
248 | debug_info_source_destroy(debug_info_src); | |
249 | return NULL; | |
250 | } | |
251 | ||
252 | static | |
253 | void proc_debug_info_sources_destroy( | |
254 | struct proc_debug_info_sources *proc_dbg_info_src) | |
255 | { | |
256 | if (!proc_dbg_info_src) { | |
257 | return; | |
258 | } | |
259 | ||
260 | if (proc_dbg_info_src->baddr_to_bin_info) { | |
261 | g_hash_table_destroy(proc_dbg_info_src->baddr_to_bin_info); | |
262 | } | |
263 | ||
264 | if (proc_dbg_info_src->ip_to_debug_info_src) { | |
265 | g_hash_table_destroy(proc_dbg_info_src->ip_to_debug_info_src); | |
266 | } | |
267 | ||
268 | g_free(proc_dbg_info_src); | |
269 | } | |
270 | ||
271 | static | |
272 | struct proc_debug_info_sources *proc_debug_info_sources_create(void) | |
273 | { | |
274 | struct proc_debug_info_sources *proc_dbg_info_src = NULL; | |
275 | ||
276 | proc_dbg_info_src = g_new0(struct proc_debug_info_sources, 1); | |
277 | if (!proc_dbg_info_src) { | |
278 | goto end; | |
279 | } | |
280 | ||
281 | proc_dbg_info_src->baddr_to_bin_info = g_hash_table_new_full( | |
bc463d34 FD |
282 | g_int64_hash, g_int64_equal, (GDestroyNotify) g_free, |
283 | (GDestroyNotify) bin_info_destroy); | |
4f45f9bb JD |
284 | if (!proc_dbg_info_src->baddr_to_bin_info) { |
285 | goto error; | |
286 | } | |
287 | ||
288 | proc_dbg_info_src->ip_to_debug_info_src = g_hash_table_new_full( | |
bc463d34 FD |
289 | g_int64_hash, g_int64_equal, (GDestroyNotify) g_free, |
290 | (GDestroyNotify) debug_info_source_destroy); | |
4f45f9bb JD |
291 | if (!proc_dbg_info_src->ip_to_debug_info_src) { |
292 | goto error; | |
293 | } | |
294 | ||
295 | end: | |
296 | return proc_dbg_info_src; | |
297 | ||
298 | error: | |
299 | proc_debug_info_sources_destroy(proc_dbg_info_src); | |
300 | return NULL; | |
301 | } | |
302 | ||
303 | static | |
304 | struct proc_debug_info_sources *proc_debug_info_sources_ht_get_entry( | |
305 | GHashTable *ht, int64_t vpid) | |
306 | { | |
307 | gpointer key = g_new0(int64_t, 1); | |
308 | struct proc_debug_info_sources *proc_dbg_info_src = NULL; | |
309 | ||
310 | if (!key) { | |
311 | goto end; | |
312 | } | |
313 | ||
314 | *((int64_t *) key) = vpid; | |
315 | ||
316 | /* Exists? Return it */ | |
317 | proc_dbg_info_src = g_hash_table_lookup(ht, key); | |
318 | if (proc_dbg_info_src) { | |
319 | goto end; | |
320 | } | |
321 | ||
322 | /* Otherwise, create and return it */ | |
323 | proc_dbg_info_src = proc_debug_info_sources_create(); | |
324 | if (!proc_dbg_info_src) { | |
325 | goto end; | |
326 | } | |
327 | ||
328 | g_hash_table_insert(ht, key, proc_dbg_info_src); | |
329 | /* Ownership passed to ht */ | |
330 | key = NULL; | |
331 | end: | |
332 | g_free(key); | |
333 | return proc_dbg_info_src; | |
334 | } | |
335 | ||
ca9f27f3 FD |
336 | static inline |
337 | const bt_field *event_borrow_payload_field(const bt_event *event, | |
338 | const char *field_name) | |
339 | { | |
340 | const bt_field *event_payload, *field; | |
341 | ||
342 | event_payload = bt_event_borrow_payload_field_const(event); | |
98b15851 | 343 | BT_ASSERT_DBG(event_payload); |
ca9f27f3 FD |
344 | |
345 | field = bt_field_structure_borrow_member_field_by_name_const( | |
bc463d34 | 346 | event_payload, field_name); |
ca9f27f3 FD |
347 | return field; |
348 | } | |
349 | ||
350 | static inline | |
351 | const bt_field *event_borrow_common_context_field(const bt_event *event, | |
352 | const char *field_name) | |
353 | { | |
354 | const bt_field *event_common_ctx, *field = NULL; | |
355 | ||
356 | event_common_ctx = bt_event_borrow_common_context_field_const(event); | |
357 | if (!event_common_ctx) { | |
358 | goto end; | |
359 | } | |
360 | ||
361 | field = bt_field_structure_borrow_member_field_by_name_const( | |
bc463d34 | 362 | event_common_ctx, field_name); |
ca9f27f3 FD |
363 | |
364 | end: | |
365 | return field; | |
366 | } | |
367 | ||
368 | static inline | |
369 | void event_get_common_context_signed_integer_field_value( | |
370 | const bt_event *event, const char *field_name, int64_t *value) | |
371 | { | |
9c08c816 | 372 | *value = bt_field_integer_signed_get_value( |
bc463d34 | 373 | event_borrow_common_context_field(event, field_name)); |
ca9f27f3 FD |
374 | } |
375 | ||
376 | static inline | |
c079be4f | 377 | void event_get_payload_build_id_length(const bt_event *event, |
ca9f27f3 FD |
378 | const char *field_name, uint64_t *build_id_len) |
379 | { | |
380 | const bt_field *build_id_field; | |
381 | const bt_field_class *build_id_field_class; | |
382 | ||
383 | build_id_field = event_borrow_payload_field(event, field_name); | |
384 | build_id_field_class = bt_field_borrow_class_const(build_id_field); | |
385 | ||
386 | BT_ASSERT(bt_field_class_get_type(build_id_field_class) == | |
81b8fa44 PP |
387 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD || |
388 | bt_field_class_get_type(build_id_field_class) == | |
389 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD); | |
ca9f27f3 | 390 | BT_ASSERT(bt_field_class_get_type( |
bc463d34 FD |
391 | bt_field_class_array_borrow_element_field_class_const( |
392 | build_id_field_class)) == | |
393 | BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER); | |
ca9f27f3 FD |
394 | |
395 | *build_id_len = bt_field_array_get_length(build_id_field); | |
ca9f27f3 FD |
396 | } |
397 | ||
398 | static inline | |
c079be4f | 399 | void event_get_payload_build_id_value(const bt_event *event, |
ca9f27f3 FD |
400 | const char *field_name, uint8_t *build_id) |
401 | { | |
402 | const bt_field *curr_field, *build_id_field; | |
403 | const bt_field_class *build_id_field_class; | |
404 | uint64_t i, build_id_len; | |
ca9f27f3 FD |
405 | |
406 | build_id_field = event_borrow_payload_field(event, field_name); | |
407 | build_id_field_class = bt_field_borrow_class_const(build_id_field); | |
408 | ||
409 | BT_ASSERT(bt_field_class_get_type(build_id_field_class) == | |
81b8fa44 PP |
410 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD || |
411 | bt_field_class_get_type(build_id_field_class) == | |
412 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD); | |
ca9f27f3 | 413 | BT_ASSERT(bt_field_class_get_type( |
bc463d34 FD |
414 | bt_field_class_array_borrow_element_field_class_const( |
415 | build_id_field_class)) == | |
416 | BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER); | |
ca9f27f3 FD |
417 | |
418 | build_id_len = bt_field_array_get_length(build_id_field); | |
419 | ||
420 | for (i = 0; i < build_id_len; i++) { | |
bc463d34 | 421 | curr_field = bt_field_array_borrow_element_field_by_index_const( |
c079be4f | 422 | build_id_field, i); |
ca9f27f3 | 423 | |
9c08c816 | 424 | build_id[i] = bt_field_integer_unsigned_get_value(curr_field); |
ca9f27f3 | 425 | } |
ca9f27f3 FD |
426 | } |
427 | ||
428 | static | |
429 | void event_get_payload_unsigned_integer_field_value(const bt_event *event, | |
430 | const char *field_name, uint64_t *value) | |
431 | { | |
9c08c816 | 432 | *value = bt_field_integer_unsigned_get_value( |
bc463d34 | 433 | event_borrow_payload_field(event, field_name)); |
ca9f27f3 FD |
434 | } |
435 | ||
436 | static | |
437 | void event_get_payload_string_field_value(const bt_event *event, | |
438 | const char *field_name, const char **value) | |
439 | { | |
440 | *value = bt_field_string_get_value( | |
bc463d34 | 441 | event_borrow_payload_field(event, field_name)); |
ca9f27f3 FD |
442 | } |
443 | ||
444 | static inline | |
445 | bool event_has_payload_field(const bt_event *event, | |
446 | const char *field_name) | |
447 | { | |
5084732e | 448 | return event_borrow_payload_field(event, field_name); |
ca9f27f3 FD |
449 | } |
450 | ||
4f45f9bb JD |
451 | static |
452 | struct debug_info_source *proc_debug_info_sources_get_entry( | |
3a3d15f3 | 453 | struct debug_info *debug_info, |
4f45f9bb JD |
454 | struct proc_debug_info_sources *proc_dbg_info_src, uint64_t ip) |
455 | { | |
456 | struct debug_info_source *debug_info_src = NULL; | |
457 | gpointer key = g_new0(uint64_t, 1); | |
458 | GHashTableIter iter; | |
459 | gpointer baddr, value; | |
460 | ||
461 | if (!key) { | |
462 | goto end; | |
463 | } | |
464 | ||
465 | *((uint64_t *) key) = ip; | |
466 | ||
467 | /* Look in IP to debug infos hash table first. */ | |
468 | debug_info_src = g_hash_table_lookup( | |
bc463d34 | 469 | proc_dbg_info_src->ip_to_debug_info_src, key); |
4f45f9bb JD |
470 | if (debug_info_src) { |
471 | goto end; | |
472 | } | |
473 | ||
474 | /* Check in all bin_infos. */ | |
475 | g_hash_table_iter_init(&iter, proc_dbg_info_src->baddr_to_bin_info); | |
476 | ||
477 | while (g_hash_table_iter_next(&iter, &baddr, &value)) | |
478 | { | |
479 | struct bin_info *bin = value; | |
480 | ||
481 | if (!bin_info_has_address(value, ip)) { | |
482 | continue; | |
483 | } | |
484 | ||
485 | /* | |
486 | * Found; add it to cache. | |
487 | * | |
488 | * FIXME: this should be bounded in size (and implement | |
489 | * a caching policy), and entries should be prunned when | |
490 | * libraries are unmapped. | |
491 | */ | |
91bc8451 PP |
492 | debug_info_src = debug_info_source_create_from_bin(bin, ip, |
493 | debug_info->self_comp); | |
4f45f9bb JD |
494 | if (debug_info_src) { |
495 | g_hash_table_insert( | |
bc463d34 FD |
496 | proc_dbg_info_src->ip_to_debug_info_src, key, |
497 | debug_info_src); | |
4f45f9bb JD |
498 | /* Ownership passed to ht. */ |
499 | key = NULL; | |
500 | } | |
501 | break; | |
502 | } | |
503 | ||
504 | end: | |
505 | free(key); | |
506 | return debug_info_src; | |
507 | } | |
508 | ||
1e638f98 | 509 | static |
4f45f9bb JD |
510 | struct debug_info_source *debug_info_query(struct debug_info *debug_info, |
511 | int64_t vpid, uint64_t ip) | |
512 | { | |
513 | struct debug_info_source *dbg_info_src = NULL; | |
514 | struct proc_debug_info_sources *proc_dbg_info_src; | |
515 | ||
516 | proc_dbg_info_src = proc_debug_info_sources_ht_get_entry( | |
bc463d34 | 517 | debug_info->vpid_to_proc_dbg_info_src, vpid); |
4f45f9bb JD |
518 | if (!proc_dbg_info_src) { |
519 | goto end; | |
520 | } | |
521 | ||
3a3d15f3 PP |
522 | dbg_info_src = proc_debug_info_sources_get_entry(debug_info, |
523 | proc_dbg_info_src, ip); | |
4f45f9bb JD |
524 | |
525 | end: | |
526 | return dbg_info_src; | |
527 | } | |
528 | ||
1e638f98 | 529 | static |
ca9f27f3 | 530 | struct debug_info *debug_info_create(struct debug_info_component *comp, |
1e638f98 | 531 | const bt_trace *trace, struct bt_fd_cache *fdc) |
4f45f9bb JD |
532 | { |
533 | int ret; | |
534 | struct debug_info *debug_info; | |
535 | ||
1e638f98 FD |
536 | BT_ASSERT(comp); |
537 | BT_ASSERT(trace); | |
538 | BT_ASSERT(fdc); | |
539 | ||
4f45f9bb JD |
540 | debug_info = g_new0(struct debug_info, 1); |
541 | if (!debug_info) { | |
542 | goto end; | |
543 | } | |
544 | ||
3a3d15f3 | 545 | debug_info->log_level = comp->log_level; |
91bc8451 | 546 | debug_info->self_comp = comp->self_comp; |
4f45f9bb | 547 | debug_info->vpid_to_proc_dbg_info_src = g_hash_table_new_full( |
bc463d34 FD |
548 | g_int64_hash, g_int64_equal, (GDestroyNotify) g_free, |
549 | (GDestroyNotify) proc_debug_info_sources_destroy); | |
4f45f9bb JD |
550 | if (!debug_info->vpid_to_proc_dbg_info_src) { |
551 | goto error; | |
552 | } | |
553 | ||
9d325e17 | 554 | debug_info->comp = comp; |
4f45f9bb JD |
555 | ret = debug_info_init(debug_info); |
556 | if (ret) { | |
557 | goto error; | |
558 | } | |
559 | ||
ca9f27f3 | 560 | debug_info->input_trace = trace; |
1e638f98 | 561 | debug_info->fd_cache = fdc; |
ca9f27f3 | 562 | |
4f45f9bb JD |
563 | end: |
564 | return debug_info; | |
565 | error: | |
566 | g_free(debug_info); | |
567 | return NULL; | |
568 | } | |
569 | ||
1e638f98 | 570 | static |
4f45f9bb JD |
571 | void debug_info_destroy(struct debug_info *debug_info) |
572 | { | |
3a3d15f3 | 573 | bt_logging_level log_level; |
91bc8451 | 574 | bt_self_component *self_comp; |
d24d5663 | 575 | bt_trace_remove_listener_status remove_listener_status; |
4f45f9bb JD |
576 | if (!debug_info) { |
577 | goto end; | |
578 | } | |
579 | ||
3a3d15f3 | 580 | log_level = debug_info->log_level; |
91bc8451 | 581 | self_comp = debug_info->self_comp; |
3a3d15f3 | 582 | |
4f45f9bb JD |
583 | if (debug_info->vpid_to_proc_dbg_info_src) { |
584 | g_hash_table_destroy(debug_info->vpid_to_proc_dbg_info_src); | |
585 | } | |
586 | ||
d24d5663 | 587 | remove_listener_status = bt_trace_remove_destruction_listener( |
bc463d34 FD |
588 | debug_info->input_trace, |
589 | debug_info->destruction_listener_id); | |
d24d5663 | 590 | if (remove_listener_status != BT_TRACE_REMOVE_LISTENER_STATUS_OK) { |
91bc8451 | 591 | BT_COMP_LOGE("Trace destruction listener removal failed."); |
b80991f6 | 592 | bt_current_thread_clear_error(); |
3b40fbf9 | 593 | } |
ca9f27f3 | 594 | |
4f45f9bb JD |
595 | g_free(debug_info); |
596 | end: | |
597 | return; | |
598 | } | |
599 | ||
600 | static | |
ca9f27f3 | 601 | void handle_event_statedump_build_id(struct debug_info *debug_info, |
b19ff26f | 602 | const bt_event *event) |
4f45f9bb JD |
603 | { |
604 | struct proc_debug_info_sources *proc_dbg_info_src; | |
ca9f27f3 FD |
605 | uint64_t build_id_len, baddr; |
606 | uint8_t *build_id = NULL; | |
607 | struct bin_info *bin; | |
4f45f9bb | 608 | int64_t vpid; |
ca9f27f3 | 609 | int ret = 0; |
4f45f9bb | 610 | |
ca9f27f3 | 611 | event_get_common_context_signed_integer_field_value(event, |
bc463d34 | 612 | VPID_FIELD_NAME, &vpid); |
ca9f27f3 | 613 | event_get_payload_unsigned_integer_field_value(event, |
bc463d34 | 614 | BADDR_FIELD_NAME, &baddr); |
4f45f9bb JD |
615 | |
616 | proc_dbg_info_src = proc_debug_info_sources_ht_get_entry( | |
bc463d34 | 617 | debug_info->vpid_to_proc_dbg_info_src, vpid); |
4f45f9bb JD |
618 | if (!proc_dbg_info_src) { |
619 | goto end; | |
620 | } | |
621 | ||
622 | bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info, | |
bc463d34 | 623 | (gpointer) &baddr); |
4f45f9bb JD |
624 | if (!bin) { |
625 | /* | |
626 | * The build_id event comes after the bin has been | |
627 | * created. If it isn't found, just ignore this event. | |
628 | */ | |
629 | goto end; | |
630 | } | |
c079be4f FD |
631 | |
632 | event_get_payload_build_id_length(event, BUILD_ID_FIELD_NAME, | |
bc463d34 | 633 | &build_id_len); |
ca9f27f3 FD |
634 | |
635 | build_id = g_new0(uint8_t, build_id_len); | |
636 | if (!build_id) { | |
637 | goto end; | |
638 | } | |
4f45f9bb | 639 | |
c079be4f | 640 | event_get_payload_build_id_value(event, BUILD_ID_FIELD_NAME, build_id); |
ca9f27f3 FD |
641 | |
642 | ret = bin_info_set_build_id(bin, build_id, build_id_len); | |
643 | if (ret) { | |
644 | goto end; | |
445e79d6 | 645 | } |
4f45f9bb JD |
646 | |
647 | /* | |
648 | * Reset the is_elf_only flag in case it had been set | |
649 | * previously, because we might find separate debug info using | |
650 | * the new build id information. | |
651 | */ | |
652 | bin->is_elf_only = false; | |
653 | ||
4f45f9bb | 654 | end: |
ca9f27f3 | 655 | g_free(build_id); |
4f45f9bb JD |
656 | return; |
657 | } | |
658 | ||
659 | static | |
ca9f27f3 | 660 | void handle_event_statedump_debug_link(struct debug_info *debug_info, |
b19ff26f | 661 | const bt_event *event) |
4f45f9bb JD |
662 | { |
663 | struct proc_debug_info_sources *proc_dbg_info_src; | |
664 | struct bin_info *bin = NULL; | |
665 | int64_t vpid; | |
666 | uint64_t baddr; | |
667 | const char *filename = NULL; | |
668 | uint32_t crc32; | |
ca9f27f3 | 669 | uint64_t crc_field_value; |
4f45f9bb | 670 | |
ca9f27f3 | 671 | event_get_common_context_signed_integer_field_value(event, |
bc463d34 | 672 | VPID_FIELD_NAME, &vpid); |
4f45f9bb | 673 | |
ca9f27f3 | 674 | event_get_payload_unsigned_integer_field_value(event, |
bc463d34 | 675 | BADDR_FIELD_NAME, &baddr); |
4f45f9bb | 676 | |
ca9f27f3 | 677 | event_get_payload_unsigned_integer_field_value(event, |
bc463d34 | 678 | CRC32_FIELD_NAME, &crc_field_value); |
4f45f9bb | 679 | |
ca9f27f3 FD |
680 | crc32 = (uint32_t) crc_field_value; |
681 | ||
682 | event_get_payload_string_field_value(event, | |
bc463d34 | 683 | FILENAME_FIELD_NAME, &filename); |
4f45f9bb JD |
684 | |
685 | proc_dbg_info_src = proc_debug_info_sources_ht_get_entry( | |
bc463d34 | 686 | debug_info->vpid_to_proc_dbg_info_src, vpid); |
4f45f9bb JD |
687 | if (!proc_dbg_info_src) { |
688 | goto end; | |
689 | } | |
690 | ||
691 | bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info, | |
bc463d34 | 692 | (gpointer) &baddr); |
4f45f9bb JD |
693 | if (!bin) { |
694 | /* | |
695 | * The debug_link event comes after the bin has been | |
696 | * created. If it isn't found, just ignore this event. | |
697 | */ | |
698 | goto end; | |
699 | } | |
700 | ||
701 | bin_info_set_debug_link(bin, filename, crc32); | |
702 | ||
703 | end: | |
704 | return; | |
705 | } | |
706 | ||
707 | static | |
ca9f27f3 | 708 | void handle_bin_info_event(struct debug_info *debug_info, |
b19ff26f | 709 | const bt_event *event, bool has_pic_field) |
4f45f9bb JD |
710 | { |
711 | struct proc_debug_info_sources *proc_dbg_info_src; | |
712 | struct bin_info *bin; | |
713 | uint64_t baddr, memsz; | |
714 | int64_t vpid; | |
715 | const char *path; | |
716 | gpointer key = NULL; | |
717 | bool is_pic; | |
4f45f9bb | 718 | |
ca9f27f3 | 719 | event_get_payload_unsigned_integer_field_value(event, |
bc463d34 | 720 | MEMSZ_FIELD_NAME, &memsz); |
ca9f27f3 FD |
721 | if (memsz == 0) { |
722 | /* Ignore VDSO. */ | |
4f45f9bb JD |
723 | goto end; |
724 | } | |
725 | ||
ca9f27f3 | 726 | event_get_payload_unsigned_integer_field_value(event, |
bc463d34 | 727 | BADDR_FIELD_NAME, &baddr); |
4f45f9bb | 728 | |
65db8b88 JD |
729 | /* |
730 | * This field is not produced by the dlopen event emitted before | |
731 | * lttng-ust 2.9. | |
732 | */ | |
ca9f27f3 | 733 | if (!event_has_payload_field(event, PATH_FIELD_NAME)) { |
4f45f9bb JD |
734 | goto end; |
735 | } | |
ca9f27f3 | 736 | event_get_payload_string_field_value(event, PATH_FIELD_NAME, &path); |
4f45f9bb JD |
737 | |
738 | if (has_pic_field) { | |
ca9f27f3 | 739 | uint64_t is_pic_field_value; |
4f45f9bb | 740 | |
ca9f27f3 | 741 | event_get_payload_unsigned_integer_field_value(event, |
1e638f98 | 742 | IS_PIC_FIELD_NAME, &is_pic_field_value); |
ca9f27f3 | 743 | is_pic = is_pic_field_value == 1; |
4f45f9bb JD |
744 | } else { |
745 | /* | |
746 | * dlopen has no is_pic field, because the shared | |
747 | * object is always PIC. | |
748 | */ | |
749 | is_pic = true; | |
750 | } | |
751 | ||
ca9f27f3 | 752 | event_get_common_context_signed_integer_field_value(event, |
c4838cef | 753 | VPID_FIELD_NAME, &vpid); |
4f45f9bb JD |
754 | |
755 | proc_dbg_info_src = proc_debug_info_sources_ht_get_entry( | |
1e638f98 | 756 | debug_info->vpid_to_proc_dbg_info_src, vpid); |
4f45f9bb JD |
757 | if (!proc_dbg_info_src) { |
758 | goto end; | |
759 | } | |
760 | ||
761 | key = g_new0(uint64_t, 1); | |
762 | if (!key) { | |
763 | goto end; | |
764 | } | |
765 | ||
766 | *((uint64_t *) key) = baddr; | |
767 | ||
1e638f98 | 768 | bin = g_hash_table_lookup(proc_dbg_info_src->baddr_to_bin_info, key); |
4f45f9bb JD |
769 | if (bin) { |
770 | goto end; | |
771 | } | |
772 | ||
1e638f98 | 773 | bin = bin_info_create(debug_info->fd_cache, path, baddr, memsz, is_pic, |
9d325e17 | 774 | debug_info->comp->arg_debug_dir, |
3a3d15f3 | 775 | debug_info->comp->arg_target_prefix, |
91bc8451 | 776 | debug_info->log_level, debug_info->self_comp); |
4f45f9bb JD |
777 | if (!bin) { |
778 | goto end; | |
779 | } | |
780 | ||
1e638f98 | 781 | g_hash_table_insert(proc_dbg_info_src->baddr_to_bin_info, key, bin); |
4f45f9bb JD |
782 | /* Ownership passed to ht. */ |
783 | key = NULL; | |
784 | ||
785 | end: | |
786 | g_free(key); | |
787 | return; | |
788 | } | |
789 | ||
790 | static inline | |
ca9f27f3 | 791 | void handle_event_statedump_bin_info(struct debug_info *debug_info, |
b19ff26f | 792 | const bt_event *event) |
4f45f9bb | 793 | { |
ca9f27f3 | 794 | handle_bin_info_event(debug_info, event, true); |
4f45f9bb JD |
795 | } |
796 | ||
797 | static inline | |
ca9f27f3 | 798 | void handle_event_lib_load(struct debug_info *debug_info, |
b19ff26f | 799 | const bt_event *event) |
4f45f9bb | 800 | { |
ca9f27f3 | 801 | handle_bin_info_event(debug_info, event, false); |
4f45f9bb JD |
802 | } |
803 | ||
ca9f27f3 FD |
804 | static |
805 | void handle_event_lib_unload(struct debug_info *debug_info, | |
b19ff26f | 806 | const bt_event *event) |
4f45f9bb | 807 | { |
ca9f27f3 | 808 | gboolean ret; |
4f45f9bb JD |
809 | struct proc_debug_info_sources *proc_dbg_info_src; |
810 | uint64_t baddr; | |
811 | int64_t vpid; | |
4f45f9bb | 812 | |
ca9f27f3 | 813 | event_get_payload_unsigned_integer_field_value(event, BADDR_FIELD_NAME, |
bc463d34 | 814 | &baddr); |
4f45f9bb | 815 | |
ca9f27f3 | 816 | event_get_common_context_signed_integer_field_value(event, |
bc463d34 | 817 | VPID_FIELD_NAME, &vpid); |
4f45f9bb JD |
818 | |
819 | proc_dbg_info_src = proc_debug_info_sources_ht_get_entry( | |
bc463d34 | 820 | debug_info->vpid_to_proc_dbg_info_src, vpid); |
4f45f9bb | 821 | if (!proc_dbg_info_src) { |
ca9f27f3 FD |
822 | /* |
823 | * It's an unload event for a library for which no load event | |
824 | * was previously received. | |
825 | */ | |
4f45f9bb JD |
826 | goto end; |
827 | } | |
828 | ||
ca9f27f3 | 829 | ret = g_hash_table_remove(proc_dbg_info_src->baddr_to_bin_info, |
bc463d34 | 830 | (gpointer) &baddr); |
ca9f27f3 | 831 | BT_ASSERT(ret); |
4f45f9bb JD |
832 | end: |
833 | return; | |
834 | } | |
835 | ||
836 | static | |
ca9f27f3 | 837 | void handle_event_statedump_start(struct debug_info *debug_info, |
b19ff26f | 838 | const bt_event *event) |
4f45f9bb JD |
839 | { |
840 | struct proc_debug_info_sources *proc_dbg_info_src; | |
841 | int64_t vpid; | |
4f45f9bb | 842 | |
ca9f27f3 | 843 | event_get_common_context_signed_integer_field_value( |
bc463d34 | 844 | event, VPID_FIELD_NAME, &vpid); |
4f45f9bb JD |
845 | |
846 | proc_dbg_info_src = proc_debug_info_sources_ht_get_entry( | |
bc463d34 | 847 | debug_info->vpid_to_proc_dbg_info_src, vpid); |
4f45f9bb JD |
848 | if (!proc_dbg_info_src) { |
849 | goto end; | |
850 | } | |
851 | ||
852 | g_hash_table_remove_all(proc_dbg_info_src->baddr_to_bin_info); | |
853 | g_hash_table_remove_all(proc_dbg_info_src->ip_to_debug_info_src); | |
854 | ||
855 | end: | |
856 | return; | |
857 | } | |
858 | ||
7c7301d5 | 859 | static |
ca9f27f3 FD |
860 | void trace_debug_info_remove_func(const bt_trace *in_trace, void *data) |
861 | { | |
862 | struct debug_info_msg_iter *debug_it = data; | |
863 | if (debug_it->debug_info_map) { | |
864 | gboolean ret; | |
865 | ret = g_hash_table_remove(debug_it->debug_info_map, | |
bc463d34 | 866 | (gpointer) in_trace); |
ca9f27f3 FD |
867 | BT_ASSERT(ret); |
868 | } | |
869 | } | |
870 | ||
871 | static | |
872 | void handle_event_statedump(struct debug_info_msg_iter *debug_it, | |
873 | const bt_event *event) | |
4f45f9bb | 874 | { |
b19ff26f | 875 | const bt_event_class *event_class; |
4f45f9bb JD |
876 | const char *event_name; |
877 | GQuark q_event_name; | |
ca9f27f3 FD |
878 | const bt_trace *trace; |
879 | struct debug_info *debug_info; | |
880 | ||
881 | BT_ASSERT(debug_it); | |
882 | BT_ASSERT(event); | |
883 | ||
884 | event_class = bt_event_borrow_class_const(event); | |
4f45f9bb | 885 | |
50842bdc | 886 | event_name = bt_event_class_get_name(event_class); |
ca9f27f3 FD |
887 | |
888 | trace = bt_stream_borrow_trace_const( | |
bc463d34 | 889 | bt_event_borrow_stream_const(event)); |
ca9f27f3 FD |
890 | |
891 | debug_info = g_hash_table_lookup(debug_it->debug_info_map, trace); | |
892 | if (!debug_info) { | |
b80991f6 PP |
893 | bt_trace_add_listener_status add_listener_status; |
894 | ||
ca9f27f3 | 895 | debug_info = debug_info_create(debug_it->debug_info_component, |
bc463d34 | 896 | trace, &debug_it->fd_cache); |
ca9f27f3 | 897 | g_hash_table_insert(debug_it->debug_info_map, (gpointer) trace, |
bc463d34 | 898 | debug_info); |
b80991f6 | 899 | add_listener_status = bt_trace_add_destruction_listener( |
bc463d34 FD |
900 | trace, trace_debug_info_remove_func, debug_it, |
901 | &debug_info->destruction_listener_id); | |
b80991f6 | 902 | BT_ASSERT(add_listener_status == BT_TRACE_ADD_LISTENER_STATUS_OK); |
4f45f9bb | 903 | } |
ca9f27f3 | 904 | |
4f45f9bb JD |
905 | q_event_name = g_quark_try_string(event_name); |
906 | ||
907 | if (q_event_name == debug_info->q_statedump_bin_info) { | |
908 | /* State dump */ | |
ca9f27f3 | 909 | handle_event_statedump_bin_info(debug_info, event); |
4f45f9bb JD |
910 | } else if (q_event_name == debug_info->q_dl_open || |
911 | q_event_name == debug_info->q_lib_load) { | |
912 | /* | |
913 | * dl_open and lib_load events are both checked for since | |
914 | * only dl_open was produced as of lttng-ust 2.8. | |
915 | * | |
916 | * lib_load, which is produced from lttng-ust 2.9+, is a lot | |
917 | * more reliable since it will be emitted when other functions | |
918 | * of the dlopen family are called (e.g. dlmopen) and when | |
919 | * library are transitively loaded. | |
920 | */ | |
ca9f27f3 | 921 | handle_event_lib_load(debug_info, event); |
4f45f9bb JD |
922 | } else if (q_event_name == debug_info->q_statedump_start) { |
923 | /* Start state dump */ | |
ca9f27f3 | 924 | handle_event_statedump_start(debug_info, event); |
4f45f9bb JD |
925 | } else if (q_event_name == debug_info->q_statedump_debug_link) { |
926 | /* Debug link info */ | |
ca9f27f3 | 927 | handle_event_statedump_debug_link(debug_info, event); |
4f45f9bb JD |
928 | } else if (q_event_name == debug_info->q_statedump_build_id) { |
929 | /* Build ID info */ | |
ca9f27f3 | 930 | handle_event_statedump_build_id(debug_info, event); |
4f45f9bb | 931 | } else if (q_event_name == debug_info-> q_lib_unload) { |
ca9f27f3 FD |
932 | handle_event_lib_unload(debug_info, event); |
933 | } | |
934 | ||
935 | return; | |
936 | } | |
937 | ||
938 | static | |
939 | void destroy_debug_info_comp(struct debug_info_component *debug_info) | |
940 | { | |
06d1cf5d FD |
941 | if (!debug_info) { |
942 | return; | |
943 | } | |
944 | ||
945 | g_free(debug_info->arg_debug_dir); | |
946 | g_free(debug_info->arg_debug_info_field_name); | |
947 | g_free(debug_info->arg_target_prefix); | |
ca9f27f3 FD |
948 | g_free(debug_info); |
949 | } | |
950 | ||
951 | static | |
952 | void fill_debug_info_bin_field(struct debug_info_source *dbg_info_src, | |
3a3d15f3 | 953 | bool full_path, bt_field *curr_field, |
91bc8451 | 954 | bt_logging_level log_level, bt_self_component *self_comp) |
ca9f27f3 | 955 | { |
d24d5663 PP |
956 | bt_field_string_set_value_status set_status; |
957 | bt_field_string_append_status append_status; | |
ca9f27f3 | 958 | |
98b15851 | 959 | BT_ASSERT_DBG(bt_field_get_class_type(curr_field) == |
bc463d34 | 960 | BT_FIELD_CLASS_TYPE_STRING); |
ca9f27f3 FD |
961 | |
962 | if (dbg_info_src) { | |
963 | if (full_path) { | |
d24d5663 PP |
964 | set_status = bt_field_string_set_value(curr_field, |
965 | dbg_info_src->bin_path); | |
ca9f27f3 | 966 | } else { |
d24d5663 PP |
967 | set_status = bt_field_string_set_value(curr_field, |
968 | dbg_info_src->short_bin_path); | |
ca9f27f3 | 969 | } |
d24d5663 | 970 | if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { |
3b34b490 | 971 | BT_COMP_LOGE("Cannot set path component of `bin` " |
ca9f27f3 FD |
972 | "curr_field field's value: str-fc-addr=%p", |
973 | curr_field); | |
b80991f6 | 974 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
975 | } |
976 | ||
d24d5663 PP |
977 | append_status = bt_field_string_append(curr_field, |
978 | dbg_info_src->bin_loc); | |
979 | if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) { | |
3b34b490 | 980 | BT_COMP_LOGE("Cannot set bin location component of `bin` " |
ca9f27f3 FD |
981 | "curr_field field's value: str-fc-addr=%p", |
982 | curr_field); | |
b80991f6 | 983 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
984 | } |
985 | } else { | |
d24d5663 PP |
986 | set_status = bt_field_string_set_value(curr_field, ""); |
987 | if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { | |
3b34b490 | 988 | BT_COMP_LOGE("Cannot set `bin` curr_field field's value: " |
ca9f27f3 | 989 | "str-fc-addr=%p", curr_field); |
b80991f6 | 990 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
991 | } |
992 | } | |
993 | } | |
994 | ||
995 | static | |
996 | void fill_debug_info_func_field(struct debug_info_source *dbg_info_src, | |
91bc8451 PP |
997 | bt_field *curr_field, bt_logging_level log_level, |
998 | bt_self_component *self_comp) | |
ca9f27f3 | 999 | { |
d24d5663 | 1000 | bt_field_string_set_value_status status; |
ca9f27f3 | 1001 | |
98b15851 | 1002 | BT_ASSERT_DBG(bt_field_get_class_type(curr_field) == |
ca9f27f3 FD |
1003 | BT_FIELD_CLASS_TYPE_STRING); |
1004 | if (dbg_info_src && dbg_info_src->func) { | |
1005 | status = bt_field_string_set_value(curr_field, | |
d24d5663 | 1006 | dbg_info_src->func); |
ca9f27f3 FD |
1007 | } else { |
1008 | status = bt_field_string_set_value(curr_field, ""); | |
1009 | } | |
d24d5663 | 1010 | if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { |
3b34b490 | 1011 | BT_COMP_LOGE("Cannot set `func` curr_field field's value: " |
ca9f27f3 | 1012 | "str-fc-addr=%p", curr_field); |
b80991f6 | 1013 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
1014 | } |
1015 | } | |
1016 | ||
1017 | static | |
1018 | void fill_debug_info_src_field(struct debug_info_source *dbg_info_src, | |
3a3d15f3 | 1019 | bool full_path, bt_field *curr_field, |
91bc8451 PP |
1020 | bt_logging_level log_level, |
1021 | bt_self_component *self_comp) | |
ca9f27f3 | 1022 | { |
d24d5663 PP |
1023 | bt_field_string_set_value_status set_status; |
1024 | bt_field_string_append_status append_status; | |
ca9f27f3 | 1025 | |
98b15851 | 1026 | BT_ASSERT_DBG(bt_field_get_class_type(curr_field) == |
bc463d34 | 1027 | BT_FIELD_CLASS_TYPE_STRING); |
ca9f27f3 FD |
1028 | |
1029 | if (dbg_info_src && dbg_info_src->src_path) { | |
1030 | if (full_path) { | |
d24d5663 | 1031 | set_status = bt_field_string_set_value(curr_field, |
bc463d34 | 1032 | dbg_info_src->src_path); |
ca9f27f3 | 1033 | } else { |
d24d5663 | 1034 | set_status = bt_field_string_set_value(curr_field, |
bc463d34 | 1035 | dbg_info_src->short_src_path); |
ca9f27f3 | 1036 | } |
d24d5663 | 1037 | if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { |
3b34b490 | 1038 | BT_COMP_LOGE("Cannot set path component of `src` " |
ca9f27f3 FD |
1039 | "curr_field field's value: str-fc-addr=%p", |
1040 | curr_field); | |
b80991f6 | 1041 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
1042 | } |
1043 | ||
d24d5663 PP |
1044 | append_status = bt_field_string_append(curr_field, ":"); |
1045 | if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) { | |
3b34b490 | 1046 | BT_COMP_LOGE("Cannot set colon component of `src` " |
ca9f27f3 FD |
1047 | "curr_field field's value: str-fc-addr=%p", |
1048 | curr_field); | |
b80991f6 | 1049 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
1050 | } |
1051 | ||
d24d5663 PP |
1052 | append_status = bt_field_string_append(curr_field, |
1053 | dbg_info_src->line_no); | |
1054 | if (append_status != BT_FIELD_STRING_APPEND_STATUS_OK) { | |
3b34b490 | 1055 | BT_COMP_LOGE("Cannot set line number component of `src` " |
ca9f27f3 FD |
1056 | "curr_field field's value: str-fc-addr=%p", |
1057 | curr_field); | |
b80991f6 | 1058 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
1059 | } |
1060 | } else { | |
d24d5663 PP |
1061 | set_status = bt_field_string_set_value(curr_field, ""); |
1062 | if (set_status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { | |
3b34b490 | 1063 | BT_COMP_LOGE("Cannot set `src` curr_field field's value: " |
ca9f27f3 | 1064 | "str-fc-addr=%p", curr_field); |
b80991f6 | 1065 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
1066 | } |
1067 | } | |
1068 | } | |
1069 | ||
3a3d15f3 PP |
1070 | static |
1071 | void fill_debug_info_field_empty(bt_field *debug_info_field, | |
91bc8451 | 1072 | bt_logging_level log_level, bt_self_component *self_comp) |
ca9f27f3 | 1073 | { |
d24d5663 | 1074 | bt_field_string_set_value_status status; |
ca9f27f3 FD |
1075 | bt_field *bin_field, *func_field, *src_field; |
1076 | ||
98b15851 | 1077 | BT_ASSERT_DBG(bt_field_get_class_type(debug_info_field) == |
bc463d34 | 1078 | BT_FIELD_CLASS_TYPE_STRUCTURE); |
ca9f27f3 FD |
1079 | |
1080 | bin_field = bt_field_structure_borrow_member_field_by_name( | |
bc463d34 | 1081 | debug_info_field, "bin"); |
ca9f27f3 | 1082 | func_field = bt_field_structure_borrow_member_field_by_name( |
bc463d34 | 1083 | debug_info_field, "func"); |
ca9f27f3 | 1084 | src_field = bt_field_structure_borrow_member_field_by_name( |
bc463d34 | 1085 | debug_info_field, "src"); |
ca9f27f3 | 1086 | |
98b15851 | 1087 | BT_ASSERT_DBG(bt_field_get_class_type(bin_field) == |
bc463d34 | 1088 | BT_FIELD_CLASS_TYPE_STRING); |
98b15851 | 1089 | BT_ASSERT_DBG(bt_field_get_class_type(func_field) == |
bc463d34 | 1090 | BT_FIELD_CLASS_TYPE_STRING); |
98b15851 | 1091 | BT_ASSERT_DBG(bt_field_get_class_type(src_field) == |
bc463d34 | 1092 | BT_FIELD_CLASS_TYPE_STRING); |
ca9f27f3 FD |
1093 | |
1094 | status = bt_field_string_set_value(bin_field, ""); | |
d24d5663 | 1095 | if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { |
3b34b490 | 1096 | BT_COMP_LOGE("Cannot set `bin` field's value: " |
ca9f27f3 | 1097 | "str-fc-addr=%p", bin_field); |
b80991f6 | 1098 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
1099 | } |
1100 | ||
1101 | status = bt_field_string_set_value(func_field, ""); | |
d24d5663 | 1102 | if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { |
3b34b490 | 1103 | BT_COMP_LOGE("Cannot set `func` field's value: " |
ca9f27f3 | 1104 | "str-fc-addr=%p", func_field); |
b80991f6 | 1105 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
1106 | } |
1107 | ||
1108 | status = bt_field_string_set_value(src_field, ""); | |
d24d5663 | 1109 | if (status != BT_FIELD_STRING_SET_VALUE_STATUS_OK) { |
3b34b490 | 1110 | BT_COMP_LOGE("Cannot set `src` field's value: " |
ca9f27f3 | 1111 | "str-fc-addr=%p", src_field); |
b80991f6 | 1112 | bt_current_thread_clear_error(); |
ca9f27f3 FD |
1113 | } |
1114 | } | |
1115 | static | |
1116 | void fill_debug_info_field(struct debug_info *debug_info, int64_t vpid, | |
1117 | uint64_t ip, bt_field *debug_info_field) | |
1118 | { | |
1119 | struct debug_info_source *dbg_info_src; | |
1120 | const bt_field_class *debug_info_fc; | |
1121 | ||
98b15851 | 1122 | BT_ASSERT_DBG(bt_field_get_class_type(debug_info_field) == |
bc463d34 | 1123 | BT_FIELD_CLASS_TYPE_STRUCTURE); |
ca9f27f3 FD |
1124 | |
1125 | debug_info_fc = bt_field_borrow_class_const(debug_info_field); | |
1126 | ||
98b15851 PP |
1127 | BT_ASSERT_DBG(bt_field_class_structure_get_member_count( |
1128 | debug_info_fc) == 3); | |
ca9f27f3 FD |
1129 | |
1130 | dbg_info_src = debug_info_query(debug_info, vpid, ip); | |
1131 | ||
3a3d15f3 PP |
1132 | fill_debug_info_bin_field(dbg_info_src, |
1133 | debug_info->comp->arg_full_path, | |
1134 | bt_field_structure_borrow_member_field_by_name( | |
1135 | debug_info_field, "bin"), | |
91bc8451 | 1136 | debug_info->log_level, debug_info->self_comp); |
ca9f27f3 | 1137 | fill_debug_info_func_field(dbg_info_src, |
3a3d15f3 PP |
1138 | bt_field_structure_borrow_member_field_by_name( |
1139 | debug_info_field, "func"), | |
91bc8451 | 1140 | debug_info->log_level, debug_info->self_comp); |
3a3d15f3 PP |
1141 | fill_debug_info_src_field(dbg_info_src, |
1142 | debug_info->comp->arg_full_path, | |
1143 | bt_field_structure_borrow_member_field_by_name( | |
1144 | debug_info_field, "src"), | |
91bc8451 | 1145 | debug_info->log_level, debug_info->self_comp); |
ca9f27f3 FD |
1146 | } |
1147 | ||
1148 | static | |
1149 | void fill_debug_info_event_if_needed(struct debug_info_msg_iter *debug_it, | |
1150 | const bt_event *in_event, bt_event *out_event) | |
1151 | { | |
1152 | bt_field *out_common_ctx_field, *out_debug_info_field; | |
1153 | const bt_field *vpid_field, *ip_field, *in_common_ctx_field; | |
1154 | const bt_field_class *in_common_ctx_fc; | |
1155 | struct debug_info *debug_info; | |
1156 | uint64_t vpid; | |
1157 | int64_t ip; | |
06d1cf5d | 1158 | gchar *debug_info_field_name = |
ca9f27f3 | 1159 | debug_it->debug_info_component->arg_debug_info_field_name; |
3a3d15f3 | 1160 | bt_logging_level log_level = debug_it->log_level; |
91bc8451 | 1161 | bt_self_component *self_comp = debug_it->self_comp; |
ca9f27f3 FD |
1162 | |
1163 | in_common_ctx_field = bt_event_borrow_common_context_field_const( | |
bc463d34 | 1164 | in_event); |
ca9f27f3 FD |
1165 | if (!in_common_ctx_field) { |
1166 | /* | |
1167 | * There is no event common context so no need to add debug | |
1168 | * info field. | |
1169 | */ | |
1170 | goto end; | |
1171 | } | |
1172 | ||
1173 | in_common_ctx_fc = bt_field_borrow_class_const(in_common_ctx_field); | |
1174 | if (!is_event_common_ctx_dbg_info_compatible(in_common_ctx_fc, | |
bc463d34 | 1175 | debug_it->ir_maps->debug_info_field_class_name)) { |
ca9f27f3 FD |
1176 | /* |
1177 | * The input event common context does not have the necessary | |
1178 | * fields to resolve debug information. | |
1179 | */ | |
1180 | goto end; | |
1181 | } | |
1182 | ||
1183 | /* Borrow the debug-info field. */ | |
1184 | out_common_ctx_field = bt_event_borrow_common_context_field(out_event); | |
1185 | if (!out_common_ctx_field) { | |
1186 | goto end; | |
4f45f9bb JD |
1187 | } |
1188 | ||
ca9f27f3 | 1189 | out_debug_info_field = bt_field_structure_borrow_member_field_by_name( |
bc463d34 | 1190 | out_common_ctx_field, debug_info_field_name); |
ca9f27f3 FD |
1191 | |
1192 | vpid_field = bt_field_structure_borrow_member_field_by_name_const( | |
bc463d34 | 1193 | out_common_ctx_field, VPID_FIELD_NAME); |
ca9f27f3 | 1194 | ip_field = bt_field_structure_borrow_member_field_by_name_const( |
bc463d34 | 1195 | out_common_ctx_field, IP_FIELD_NAME); |
ca9f27f3 | 1196 | |
9c08c816 PP |
1197 | vpid = bt_field_integer_signed_get_value(vpid_field); |
1198 | ip = bt_field_integer_unsigned_get_value(ip_field); | |
ca9f27f3 FD |
1199 | |
1200 | /* | |
1201 | * Borrow the debug_info structure needed for the source | |
1202 | * resolving. | |
1203 | */ | |
1204 | debug_info = g_hash_table_lookup(debug_it->debug_info_map, | |
bc463d34 FD |
1205 | bt_stream_borrow_trace_const( |
1206 | bt_event_borrow_stream_const(in_event))); | |
ca9f27f3 FD |
1207 | |
1208 | if (debug_info) { | |
1209 | /* | |
1210 | * Perform the debug-info resolving and set the event fields | |
1211 | * accordingly. | |
1212 | */ | |
1213 | fill_debug_info_field(debug_info, vpid, ip, out_debug_info_field); | |
1214 | } else { | |
91bc8451 | 1215 | BT_COMP_LOGD("No debug information for this trace. Setting debug " |
ca9f27f3 | 1216 | "info fields to empty strings."); |
91bc8451 PP |
1217 | fill_debug_info_field_empty(out_debug_info_field, |
1218 | log_level, self_comp); | |
ca9f27f3 | 1219 | } |
4f45f9bb JD |
1220 | end: |
1221 | return; | |
1222 | } | |
ca9f27f3 FD |
1223 | |
1224 | static | |
1225 | void update_event_statedump_if_needed(struct debug_info_msg_iter *debug_it, | |
1226 | const bt_event *in_event) | |
1227 | { | |
1228 | const bt_field *event_common_ctx; | |
1229 | const bt_field_class *event_common_ctx_fc; | |
1230 | const bt_event_class *in_event_class = bt_event_borrow_class_const(in_event); | |
1231 | ||
1232 | /* | |
1233 | * If the event is an lttng_ust_statedump event AND has the right event | |
1234 | * common context fields update the debug-info view for this process. | |
1235 | */ | |
1236 | event_common_ctx = bt_event_borrow_common_context_field_const(in_event); | |
1237 | if (!event_common_ctx) { | |
1238 | goto end; | |
1239 | } | |
1240 | ||
1241 | event_common_ctx_fc = bt_field_borrow_class_const(event_common_ctx); | |
1242 | if (is_event_common_ctx_dbg_info_compatible(event_common_ctx_fc, | |
bc463d34 | 1243 | debug_it->ir_maps->debug_info_field_class_name)) { |
ca9f27f3 FD |
1244 | /* Checkout if it might be a one of lttng ust statedump events. */ |
1245 | const char *in_event_name = bt_event_class_get_name(in_event_class); | |
1246 | if (strncmp(in_event_name, LTTNG_UST_STATEDUMP_PREFIX, | |
1247 | strlen(LTTNG_UST_STATEDUMP_PREFIX)) == 0) { | |
1248 | /* Handle statedump events. */ | |
1249 | handle_event_statedump(debug_it, in_event); | |
1250 | } | |
1251 | } | |
1252 | end: | |
1253 | return; | |
1254 | } | |
1255 | ||
1256 | static | |
1257 | bt_message *handle_event_message(struct debug_info_msg_iter *debug_it, | |
1258 | const bt_message *in_message) | |
1259 | { | |
1260 | const bt_clock_snapshot *cs; | |
1261 | const bt_clock_class *default_cc; | |
1262 | const bt_packet *in_packet; | |
26fc5aed PP |
1263 | const bt_stream *in_stream; |
1264 | const bt_stream *out_stream; | |
ca9f27f3 | 1265 | bt_event_class *out_event_class; |
26fc5aed | 1266 | bt_packet *out_packet = NULL; |
ca9f27f3 | 1267 | bt_event *out_event; |
3a3d15f3 | 1268 | bt_logging_level log_level = debug_it->log_level; |
91bc8451 | 1269 | bt_self_component *self_comp = debug_it->self_comp; |
ca9f27f3 FD |
1270 | |
1271 | bt_message *out_message = NULL; | |
1272 | ||
1273 | /* Borrow the input event and its event class. */ | |
1274 | const bt_event *in_event = | |
1275 | bt_message_event_borrow_event_const(in_message); | |
1276 | const bt_event_class *in_event_class = | |
1277 | bt_event_borrow_class_const(in_event); | |
1278 | ||
1279 | update_event_statedump_if_needed(debug_it, in_event); | |
1280 | ||
1281 | out_event_class = trace_ir_mapping_borrow_mapped_event_class( | |
1282 | debug_it->ir_maps, in_event_class); | |
1283 | if (!out_event_class) { | |
1284 | out_event_class = trace_ir_mapping_create_new_mapped_event_class( | |
bc463d34 | 1285 | debug_it->ir_maps, in_event_class); |
ca9f27f3 | 1286 | } |
98b15851 | 1287 | BT_ASSERT_DBG(out_event_class); |
ca9f27f3 | 1288 | |
26fc5aed PP |
1289 | /* Borrow the input stream. */ |
1290 | in_stream = bt_event_borrow_stream_const(in_event); | |
98b15851 | 1291 | BT_ASSERT_DBG(in_stream); |
26fc5aed PP |
1292 | out_stream = trace_ir_mapping_borrow_mapped_stream(debug_it->ir_maps, |
1293 | in_stream); | |
98b15851 | 1294 | BT_ASSERT_DBG(in_stream); |
26fc5aed | 1295 | |
ca9f27f3 FD |
1296 | /* Borrow the input and output packets. */ |
1297 | in_packet = bt_event_borrow_packet_const(in_event); | |
26fc5aed PP |
1298 | if (in_packet) { |
1299 | out_packet = trace_ir_mapping_borrow_mapped_packet( | |
1300 | debug_it->ir_maps, in_packet); | |
1301 | } | |
ca9f27f3 FD |
1302 | |
1303 | default_cc = bt_stream_class_borrow_default_clock_class_const( | |
bc463d34 | 1304 | bt_event_class_borrow_stream_class_const(in_event_class)); |
ca9f27f3 FD |
1305 | if (default_cc) { |
1306 | /* Borrow event clock snapshot. */ | |
0cbc2c33 | 1307 | cs = bt_message_event_borrow_default_clock_snapshot_const( |
bc463d34 | 1308 | in_message); |
ca9f27f3 FD |
1309 | |
1310 | /* Create an output event message. */ | |
26fc5aed PP |
1311 | if (out_packet) { |
1312 | out_message = | |
1313 | bt_message_event_create_with_packet_and_default_clock_snapshot( | |
ca9f27f3 FD |
1314 | debug_it->input_iterator, |
1315 | out_event_class, out_packet, | |
1316 | bt_clock_snapshot_get_value(cs)); | |
26fc5aed PP |
1317 | } else { |
1318 | out_message = | |
1319 | bt_message_event_create_with_default_clock_snapshot( | |
1320 | debug_it->input_iterator, | |
1321 | out_event_class, out_stream, | |
1322 | bt_clock_snapshot_get_value(cs)); | |
1323 | } | |
ca9f27f3 | 1324 | } else { |
26fc5aed PP |
1325 | if (out_packet) { |
1326 | out_message = bt_message_event_create_with_packet( | |
1327 | debug_it->input_iterator, out_event_class, | |
1328 | out_packet); | |
1329 | } else { | |
1330 | out_message = bt_message_event_create( | |
1331 | debug_it->input_iterator, out_event_class, | |
1332 | out_stream); | |
1333 | } | |
ca9f27f3 FD |
1334 | } |
1335 | ||
1336 | if (!out_message) { | |
3b34b490 FD |
1337 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1338 | "Error creating output event message."); | |
ca9f27f3 FD |
1339 | goto error; |
1340 | } | |
1341 | ||
1342 | out_event = bt_message_event_borrow_event(out_message); | |
1343 | ||
1344 | /* Copy the original fields to the output event. */ | |
3b34b490 FD |
1345 | if (copy_event_content(in_event, out_event, log_level, self_comp) != |
1346 | DEBUG_INFO_TRACE_IR_MAPPING_STATUS_OK) { | |
1347 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, | |
1348 | "Error copying event message content output event message: " | |
1349 | "in-ev-addr=%p, out-ev-addr=%p", in_event, out_event); | |
1350 | goto error; | |
1351 | } | |
ca9f27f3 FD |
1352 | |
1353 | /* | |
1354 | * Try to set the debug-info fields based on debug information that is | |
1355 | * gathered so far. | |
1356 | */ | |
1357 | fill_debug_info_event_if_needed(debug_it, in_event, out_event); | |
1358 | ||
3b34b490 FD |
1359 | goto end; |
1360 | ||
ca9f27f3 | 1361 | error: |
3b34b490 FD |
1362 | BT_MESSAGE_PUT_REF_AND_RESET(out_message); |
1363 | end: | |
ca9f27f3 FD |
1364 | return out_message; |
1365 | } | |
1366 | ||
1367 | static | |
1368 | bt_message *handle_stream_begin_message(struct debug_info_msg_iter *debug_it, | |
1369 | const bt_message *in_message) | |
1370 | { | |
1371 | const bt_stream *in_stream; | |
1372 | bt_message *out_message; | |
1373 | bt_stream *out_stream; | |
3a3d15f3 | 1374 | bt_logging_level log_level = debug_it->log_level; |
91bc8451 | 1375 | bt_self_component *self_comp = debug_it->self_comp; |
ca9f27f3 FD |
1376 | |
1377 | in_stream = bt_message_stream_beginning_borrow_stream_const(in_message); | |
1378 | BT_ASSERT(in_stream); | |
1379 | ||
1380 | /* Create a duplicated output stream. */ | |
1381 | out_stream = trace_ir_mapping_create_new_mapped_stream( | |
bc463d34 | 1382 | debug_it->ir_maps, in_stream); |
ca9f27f3 FD |
1383 | if (!out_stream) { |
1384 | out_message = NULL; | |
1385 | goto error; | |
1386 | } | |
1387 | ||
1388 | /* Create an output stream beginning message. */ | |
1389 | out_message = bt_message_stream_beginning_create( | |
bc463d34 | 1390 | debug_it->input_iterator, out_stream); |
ca9f27f3 | 1391 | if (!out_message) { |
3b34b490 FD |
1392 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1393 | "Error creating output stream beginning message: " | |
ca9f27f3 FD |
1394 | "out-s-addr=%p", out_stream); |
1395 | } | |
1396 | error: | |
1397 | return out_message; | |
1398 | } | |
1399 | ||
1400 | static | |
1401 | bt_message *handle_stream_end_message(struct debug_info_msg_iter *debug_it, | |
1402 | const bt_message *in_message) | |
1403 | { | |
1404 | const bt_stream *in_stream; | |
1405 | bt_message *out_message = NULL; | |
1406 | bt_stream *out_stream; | |
3a3d15f3 | 1407 | bt_logging_level log_level = debug_it->log_level; |
91bc8451 | 1408 | bt_self_component *self_comp = debug_it->self_comp; |
ca9f27f3 FD |
1409 | |
1410 | in_stream = bt_message_stream_end_borrow_stream_const(in_message); | |
1411 | BT_ASSERT(in_stream); | |
1412 | ||
1413 | out_stream = trace_ir_mapping_borrow_mapped_stream( | |
bc463d34 | 1414 | debug_it->ir_maps, in_stream); |
ca9f27f3 FD |
1415 | BT_ASSERT(out_stream); |
1416 | ||
1417 | /* Create an output stream end message. */ | |
1418 | out_message = bt_message_stream_end_create(debug_it->input_iterator, | |
bc463d34 | 1419 | out_stream); |
ca9f27f3 | 1420 | if (!out_message) { |
3b34b490 FD |
1421 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1422 | "Error creating output stream end message: " | |
1423 | "out-s-addr=%p", out_stream); | |
b80991f6 | 1424 | goto end; |
ca9f27f3 FD |
1425 | } |
1426 | ||
1427 | /* Remove stream from trace mapping hashtable. */ | |
1428 | trace_ir_mapping_remove_mapped_stream(debug_it->ir_maps, in_stream); | |
1429 | ||
b80991f6 | 1430 | end: |
ca9f27f3 FD |
1431 | return out_message; |
1432 | } | |
1433 | ||
1434 | static | |
1435 | bt_message *handle_packet_begin_message(struct debug_info_msg_iter *debug_it, | |
1436 | const bt_message *in_message) | |
1437 | { | |
649934d2 | 1438 | bool has_default_clock_snapshot; |
ca9f27f3 FD |
1439 | const bt_clock_snapshot *cs; |
1440 | bt_message *out_message = NULL; | |
1441 | bt_packet *out_packet; | |
3a3d15f3 | 1442 | bt_logging_level log_level = debug_it->log_level; |
91bc8451 | 1443 | bt_self_component *self_comp = debug_it->self_comp; |
ca9f27f3 FD |
1444 | |
1445 | const bt_packet *in_packet = | |
1446 | bt_message_packet_beginning_borrow_packet_const(in_message); | |
1447 | BT_ASSERT(in_packet); | |
1448 | ||
1449 | /* This packet should not be already mapped. */ | |
1450 | BT_ASSERT(!trace_ir_mapping_borrow_mapped_packet( | |
1451 | debug_it->ir_maps, in_packet)); | |
1452 | ||
1453 | out_packet = trace_ir_mapping_create_new_mapped_packet(debug_it->ir_maps, | |
bc463d34 | 1454 | in_packet); |
ca9f27f3 FD |
1455 | |
1456 | BT_ASSERT(out_packet); | |
1457 | ||
649934d2 | 1458 | has_default_clock_snapshot = |
9b24b6aa | 1459 | bt_stream_class_packets_have_beginning_default_clock_snapshot( |
ca9f27f3 FD |
1460 | bt_stream_borrow_class_const( |
1461 | bt_packet_borrow_stream_const(in_packet))); | |
649934d2 | 1462 | if (has_default_clock_snapshot) { |
ca9f27f3 | 1463 | /* Borrow clock snapshot. */ |
0cbc2c33 | 1464 | cs = bt_message_packet_beginning_borrow_default_clock_snapshot_const( |
bc463d34 | 1465 | in_message); |
ca9f27f3 FD |
1466 | |
1467 | /* Create an output packet beginning message. */ | |
ca9f27f3 | 1468 | out_message = bt_message_packet_beginning_create_with_default_clock_snapshot( |
bc463d34 FD |
1469 | debug_it->input_iterator, out_packet, |
1470 | bt_clock_snapshot_get_value(cs)); | |
ca9f27f3 FD |
1471 | } else { |
1472 | out_message = bt_message_packet_beginning_create( | |
bc463d34 | 1473 | debug_it->input_iterator, out_packet); |
ca9f27f3 FD |
1474 | } |
1475 | if (!out_message) { | |
3b34b490 FD |
1476 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1477 | "Error creating output packet beginning message: " | |
ca9f27f3 FD |
1478 | "out-p-addr=%p", out_packet); |
1479 | } | |
1480 | ||
1481 | return out_message; | |
1482 | } | |
1483 | ||
1484 | static | |
1485 | bt_message *handle_packet_end_message(struct debug_info_msg_iter *debug_it, | |
1486 | const bt_message *in_message) | |
1487 | { | |
649934d2 | 1488 | bool has_default_clock_snapshot; |
ca9f27f3 FD |
1489 | const bt_clock_snapshot *cs; |
1490 | const bt_packet *in_packet; | |
ca9f27f3 FD |
1491 | bt_message *out_message = NULL; |
1492 | bt_packet *out_packet; | |
3a3d15f3 | 1493 | bt_logging_level log_level = debug_it->log_level; |
91bc8451 | 1494 | bt_self_component *self_comp = debug_it->self_comp; |
ca9f27f3 FD |
1495 | |
1496 | in_packet = bt_message_packet_end_borrow_packet_const(in_message); | |
1497 | BT_ASSERT(in_packet); | |
1498 | ||
1499 | out_packet = trace_ir_mapping_borrow_mapped_packet(debug_it->ir_maps, in_packet); | |
1500 | BT_ASSERT(out_packet); | |
1501 | ||
649934d2 | 1502 | has_default_clock_snapshot = |
9b24b6aa | 1503 | bt_stream_class_packets_have_end_default_clock_snapshot( |
ca9f27f3 FD |
1504 | bt_stream_borrow_class_const( |
1505 | bt_packet_borrow_stream_const(in_packet))); | |
649934d2 | 1506 | if (has_default_clock_snapshot) { |
ca9f27f3 | 1507 | /* Borrow clock snapshot. */ |
0cbc2c33 | 1508 | cs = bt_message_packet_end_borrow_default_clock_snapshot_const( |
bc463d34 | 1509 | in_message); |
ca9f27f3 FD |
1510 | |
1511 | /* Create an outpute packet end message. */ | |
ca9f27f3 | 1512 | out_message = bt_message_packet_end_create_with_default_clock_snapshot( |
bc463d34 FD |
1513 | debug_it->input_iterator, out_packet, |
1514 | bt_clock_snapshot_get_value(cs)); | |
ca9f27f3 FD |
1515 | } else { |
1516 | out_message = bt_message_packet_end_create( | |
bc463d34 | 1517 | debug_it->input_iterator, out_packet); |
ca9f27f3 FD |
1518 | } |
1519 | ||
1520 | if (!out_message) { | |
3b34b490 FD |
1521 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1522 | "Error creating output packet end message: " | |
ca9f27f3 | 1523 | "out-p-addr=%p", out_packet); |
b80991f6 | 1524 | goto end; |
ca9f27f3 FD |
1525 | } |
1526 | ||
1527 | /* Remove packet from data mapping hashtable. */ | |
1528 | trace_ir_mapping_remove_mapped_packet(debug_it->ir_maps, in_packet); | |
1529 | ||
b80991f6 | 1530 | end: |
ca9f27f3 FD |
1531 | return out_message; |
1532 | } | |
1533 | ||
1534 | static | |
1535 | bt_message *handle_msg_iterator_inactivity(struct debug_info_msg_iter *debug_it, | |
1536 | const bt_message *in_message) | |
1537 | { | |
1538 | /* | |
1539 | * This message type can be forwarded directly because it does | |
1540 | * not refer to any objects in the trace class. | |
1541 | */ | |
1542 | bt_message_get_ref(in_message); | |
1543 | return (bt_message*) in_message; | |
1544 | } | |
1545 | ||
ca9f27f3 FD |
1546 | static |
1547 | bt_message *handle_discarded_events_message(struct debug_info_msg_iter *debug_it, | |
1548 | const bt_message *in_message) | |
1549 | { | |
1550 | const bt_clock_snapshot *begin_cs, *end_cs; | |
1551 | const bt_stream *in_stream; | |
2e90378a | 1552 | bool has_default_clock_snapshots; |
ca9f27f3 | 1553 | uint64_t discarded_events, begin_cs_value, end_cs_value; |
ca9f27f3 FD |
1554 | bt_property_availability prop_avail; |
1555 | bt_message *out_message = NULL; | |
1556 | bt_stream *out_stream; | |
3a3d15f3 | 1557 | bt_logging_level log_level = debug_it->log_level; |
91bc8451 | 1558 | bt_self_component *self_comp = debug_it->self_comp; |
ca9f27f3 FD |
1559 | |
1560 | in_stream = bt_message_discarded_events_borrow_stream_const( | |
1561 | in_message); | |
1562 | BT_ASSERT(in_stream); | |
1563 | ||
bc463d34 FD |
1564 | out_stream = trace_ir_mapping_borrow_mapped_stream( debug_it->ir_maps, |
1565 | in_stream); | |
ca9f27f3 FD |
1566 | BT_ASSERT(out_stream); |
1567 | ||
2e90378a PP |
1568 | has_default_clock_snapshots = |
1569 | bt_stream_class_discarded_events_have_default_clock_snapshots( | |
ca9f27f3 | 1570 | bt_stream_borrow_class_const(in_stream)); |
2e90378a | 1571 | if (has_default_clock_snapshots) { |
bc463d34 FD |
1572 | begin_cs = bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const( |
1573 | in_message); | |
1574 | end_cs = bt_message_discarded_events_borrow_end_default_clock_snapshot_const( | |
1575 | in_message); | |
ca9f27f3 FD |
1576 | |
1577 | begin_cs_value = bt_clock_snapshot_get_value(begin_cs); | |
1578 | end_cs_value = bt_clock_snapshot_get_value(end_cs); | |
1579 | ||
bc463d34 FD |
1580 | out_message = bt_message_discarded_events_create_with_default_clock_snapshots( |
1581 | debug_it->input_iterator, out_stream, | |
1582 | begin_cs_value, end_cs_value); | |
ca9f27f3 FD |
1583 | } else { |
1584 | out_message = bt_message_discarded_events_create( | |
bc463d34 | 1585 | debug_it->input_iterator, out_stream); |
ca9f27f3 FD |
1586 | } |
1587 | if (!out_message) { | |
3b34b490 FD |
1588 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1589 | "Error creating output discarded events message: " | |
ca9f27f3 FD |
1590 | "out-s-addr=%p", out_stream); |
1591 | goto error; | |
1592 | } | |
1593 | ||
1594 | prop_avail = bt_message_discarded_events_get_count(in_message, | |
bc463d34 | 1595 | &discarded_events); |
ca9f27f3 FD |
1596 | |
1597 | if (prop_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) { | |
1598 | bt_message_discarded_events_set_count(out_message, | |
bc463d34 | 1599 | discarded_events); |
ca9f27f3 FD |
1600 | } |
1601 | ||
1602 | error: | |
1603 | return out_message; | |
1604 | } | |
1605 | ||
1606 | static | |
1607 | bt_message *handle_discarded_packets_message(struct debug_info_msg_iter *debug_it, | |
1608 | const bt_message *in_message) | |
1609 | { | |
1610 | const bt_clock_snapshot *begin_cs, *end_cs; | |
2e90378a | 1611 | bool has_default_clock_snapshots; |
ca9f27f3 FD |
1612 | const bt_stream *in_stream; |
1613 | uint64_t discarded_packets, begin_cs_value, end_cs_value; | |
ca9f27f3 FD |
1614 | bt_property_availability prop_avail; |
1615 | bt_message *out_message = NULL; | |
1616 | bt_stream *out_stream; | |
3a3d15f3 | 1617 | bt_logging_level log_level = debug_it->log_level; |
91bc8451 | 1618 | bt_self_component *self_comp = debug_it->self_comp; |
ca9f27f3 FD |
1619 | |
1620 | in_stream = bt_message_discarded_packets_borrow_stream_const( | |
bc463d34 | 1621 | in_message); |
ca9f27f3 FD |
1622 | BT_ASSERT(in_stream); |
1623 | ||
bc463d34 FD |
1624 | out_stream = trace_ir_mapping_borrow_mapped_stream( debug_it->ir_maps, |
1625 | in_stream); | |
ca9f27f3 FD |
1626 | BT_ASSERT(out_stream); |
1627 | ||
2e90378a PP |
1628 | has_default_clock_snapshots = |
1629 | bt_stream_class_discarded_packets_have_default_clock_snapshots( | |
ca9f27f3 | 1630 | bt_stream_borrow_class_const(in_stream)); |
2e90378a | 1631 | if (has_default_clock_snapshots) { |
bc463d34 FD |
1632 | begin_cs = bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const( |
1633 | in_message); | |
ca9f27f3 | 1634 | |
bc463d34 FD |
1635 | end_cs = bt_message_discarded_packets_borrow_end_default_clock_snapshot_const( |
1636 | in_message); | |
ca9f27f3 FD |
1637 | |
1638 | begin_cs_value = bt_clock_snapshot_get_value(begin_cs); | |
1639 | end_cs_value = bt_clock_snapshot_get_value(end_cs); | |
1640 | ||
1641 | out_message = bt_message_discarded_packets_create_with_default_clock_snapshots( | |
bc463d34 FD |
1642 | debug_it->input_iterator, out_stream, |
1643 | begin_cs_value, end_cs_value); | |
ca9f27f3 FD |
1644 | } else { |
1645 | out_message = bt_message_discarded_packets_create( | |
bc463d34 | 1646 | debug_it->input_iterator, out_stream); |
ca9f27f3 FD |
1647 | } |
1648 | if (!out_message) { | |
3b34b490 FD |
1649 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1650 | "Error creating output discarded packet message: " | |
ca9f27f3 FD |
1651 | "out-s-addr=%p", out_stream); |
1652 | goto error; | |
1653 | } | |
1654 | ||
1655 | prop_avail = bt_message_discarded_packets_get_count(in_message, | |
bc463d34 | 1656 | &discarded_packets); |
ca9f27f3 FD |
1657 | if (prop_avail == BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE) { |
1658 | bt_message_discarded_packets_set_count(out_message, | |
bc463d34 | 1659 | discarded_packets); |
ca9f27f3 FD |
1660 | } |
1661 | ||
1662 | error: | |
1663 | return out_message; | |
1664 | } | |
1665 | ||
1666 | static | |
1667 | const bt_message *handle_message(struct debug_info_msg_iter *debug_it, | |
1668 | const bt_message *in_message) | |
1669 | { | |
1670 | bt_message *out_message = NULL; | |
1671 | ||
1672 | switch (bt_message_get_type(in_message)) { | |
1673 | case BT_MESSAGE_TYPE_EVENT: | |
bc463d34 | 1674 | out_message = handle_event_message(debug_it, in_message); |
ca9f27f3 FD |
1675 | break; |
1676 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: | |
bc463d34 | 1677 | out_message = handle_packet_begin_message(debug_it, in_message); |
ca9f27f3 FD |
1678 | break; |
1679 | case BT_MESSAGE_TYPE_PACKET_END: | |
bc463d34 | 1680 | out_message = handle_packet_end_message(debug_it, in_message); |
ca9f27f3 FD |
1681 | break; |
1682 | case BT_MESSAGE_TYPE_STREAM_BEGINNING: | |
bc463d34 | 1683 | out_message = handle_stream_begin_message(debug_it, in_message); |
ca9f27f3 FD |
1684 | break; |
1685 | case BT_MESSAGE_TYPE_STREAM_END: | |
bc463d34 | 1686 | out_message = handle_stream_end_message(debug_it, in_message); |
ca9f27f3 FD |
1687 | break; |
1688 | case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: | |
bc463d34 | 1689 | out_message = handle_msg_iterator_inactivity(debug_it, in_message); |
ca9f27f3 | 1690 | break; |
ca9f27f3 | 1691 | case BT_MESSAGE_TYPE_DISCARDED_EVENTS: |
bc463d34 | 1692 | out_message = handle_discarded_events_message(debug_it, in_message); |
ca9f27f3 FD |
1693 | break; |
1694 | case BT_MESSAGE_TYPE_DISCARDED_PACKETS: | |
bc463d34 | 1695 | out_message = handle_discarded_packets_message(debug_it, in_message); |
ca9f27f3 FD |
1696 | break; |
1697 | default: | |
1698 | abort(); | |
1699 | break; | |
1700 | } | |
1701 | ||
1702 | return out_message; | |
1703 | } | |
1704 | ||
cf7b259e SM |
1705 | struct bt_param_validation_map_value_entry_descr debug_info_params[] = { |
1706 | { "debug-info-field-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, | |
1707 | { "debug-info-dir", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, | |
1708 | { "target-prefix", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, | |
1709 | { "full-path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
1710 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END | |
1711 | }; | |
1712 | ||
ca9f27f3 | 1713 | static |
f4f11e84 SM |
1714 | bt_component_class_initialize_method_status init_from_params( |
1715 | struct debug_info_component *debug_info_component, | |
ca9f27f3 FD |
1716 | const bt_value *params) |
1717 | { | |
f4f11e84 SM |
1718 | const bt_value *value; |
1719 | bt_component_class_initialize_method_status status; | |
cf7b259e SM |
1720 | bt_logging_level log_level = debug_info_component->log_level; |
1721 | enum bt_param_validation_status validation_status; | |
1722 | gchar *validate_error = NULL; | |
1723 | ||
1724 | validation_status = bt_param_validation_validate(params, | |
1725 | debug_info_params, &validate_error); | |
1726 | if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) { | |
1727 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; | |
1728 | goto end; | |
1729 | } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) { | |
1730 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
1731 | BT_COMP_LOGE_APPEND_CAUSE(debug_info_component->self_comp, | |
1732 | "%s", validate_error); | |
1733 | goto end; | |
1734 | } | |
ca9f27f3 FD |
1735 | |
1736 | BT_ASSERT(params); | |
1737 | ||
1738 | value = bt_value_map_borrow_entry_value_const(params, | |
1739 | "debug-info-field-name"); | |
1740 | if (value) { | |
ca9f27f3 | 1741 | debug_info_component->arg_debug_info_field_name = |
06d1cf5d | 1742 | g_strdup(bt_value_string_get(value)); |
ca9f27f3 FD |
1743 | } else { |
1744 | debug_info_component->arg_debug_info_field_name = | |
06d1cf5d | 1745 | g_strdup(DEFAULT_DEBUG_INFO_FIELD_NAME); |
ca9f27f3 FD |
1746 | } |
1747 | ||
1748 | value = bt_value_map_borrow_entry_value_const(params, "debug-info-dir"); | |
1749 | if (value) { | |
06d1cf5d FD |
1750 | debug_info_component->arg_debug_dir = |
1751 | g_strdup(bt_value_string_get(value)); | |
1752 | } else { | |
1753 | debug_info_component->arg_debug_dir = NULL; | |
ca9f27f3 FD |
1754 | } |
1755 | ||
06d1cf5d | 1756 | |
ca9f27f3 FD |
1757 | value = bt_value_map_borrow_entry_value_const(params, "target-prefix"); |
1758 | if (value) { | |
1759 | debug_info_component->arg_target_prefix = | |
06d1cf5d FD |
1760 | g_strdup(bt_value_string_get(value)); |
1761 | } else { | |
1762 | debug_info_component->arg_target_prefix = NULL; | |
ca9f27f3 FD |
1763 | } |
1764 | ||
1765 | value = bt_value_map_borrow_entry_value_const(params, "full-path"); | |
1766 | if (value) { | |
1767 | debug_info_component->arg_full_path = bt_value_bool_get(value); | |
06d1cf5d FD |
1768 | } else { |
1769 | debug_info_component->arg_full_path = BT_FALSE; | |
ca9f27f3 FD |
1770 | } |
1771 | ||
f4f11e84 SM |
1772 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; |
1773 | ||
cf7b259e SM |
1774 | end: |
1775 | g_free(validate_error); | |
1776 | ||
f4f11e84 | 1777 | return status; |
ca9f27f3 FD |
1778 | } |
1779 | ||
1780 | BT_HIDDEN | |
21a9f056 | 1781 | bt_component_class_initialize_method_status debug_info_comp_init( |
91bc8451 | 1782 | bt_self_component_filter *self_comp_flt, |
59225a3e | 1783 | bt_self_component_filter_configuration *config, |
c88dd1cb | 1784 | const bt_value *params, __attribute__((unused)) void *init_method_data) |
ca9f27f3 | 1785 | { |
ca9f27f3 | 1786 | struct debug_info_component *debug_info_comp; |
21a9f056 FD |
1787 | bt_component_class_initialize_method_status status = |
1788 | BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; | |
d24d5663 | 1789 | bt_self_component_add_port_status add_port_status; |
91bc8451 PP |
1790 | bt_self_component *self_comp = |
1791 | bt_self_component_filter_as_self_component(self_comp_flt); | |
3a3d15f3 | 1792 | bt_logging_level log_level = bt_component_get_logging_level( |
91bc8451 | 1793 | bt_self_component_as_component(self_comp)); |
ca9f27f3 | 1794 | |
91bc8451 | 1795 | BT_COMP_LOGI("Initializing debug_info component: " |
ca9f27f3 FD |
1796 | "comp-addr=%p, params-addr=%p", self_comp, params); |
1797 | ||
1798 | debug_info_comp = g_new0(struct debug_info_component, 1); | |
1799 | if (!debug_info_comp) { | |
3b34b490 FD |
1800 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1801 | "Failed to allocate one debug_info component."); | |
ca9f27f3 FD |
1802 | goto error; |
1803 | } | |
1804 | ||
3a3d15f3 | 1805 | debug_info_comp->log_level = log_level; |
91bc8451 PP |
1806 | debug_info_comp->self_comp = self_comp; |
1807 | bt_self_component_set_data(self_comp, debug_info_comp); | |
ca9f27f3 | 1808 | |
d24d5663 PP |
1809 | add_port_status = bt_self_component_filter_add_input_port( |
1810 | self_comp_flt, "in", NULL, NULL); | |
f4f11e84 SM |
1811 | if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) { |
1812 | status = (int) add_port_status; | |
ca9f27f3 FD |
1813 | goto error; |
1814 | } | |
1815 | ||
d24d5663 | 1816 | add_port_status = bt_self_component_filter_add_output_port( |
f4f11e84 SM |
1817 | self_comp_flt, "out", NULL, NULL); |
1818 | if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) { | |
1819 | status = (int) add_port_status; | |
ca9f27f3 FD |
1820 | goto error; |
1821 | } | |
1822 | ||
f4f11e84 SM |
1823 | status = init_from_params(debug_info_comp, params); |
1824 | if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) { | |
3b34b490 FD |
1825 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1826 | "Cannot configure debug_info component: " | |
ca9f27f3 FD |
1827 | "debug_info-comp-addr=%p, params-addr=%p", |
1828 | debug_info_comp, params); | |
1829 | goto error; | |
1830 | } | |
1831 | ||
1832 | goto end; | |
1833 | ||
1834 | error: | |
1835 | destroy_debug_info_comp(debug_info_comp); | |
91bc8451 | 1836 | bt_self_component_set_data(self_comp, NULL); |
ca9f27f3 | 1837 | |
21a9f056 FD |
1838 | if (status == BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) { |
1839 | status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; | |
ca9f27f3 FD |
1840 | } |
1841 | end: | |
1842 | return status; | |
1843 | } | |
1844 | ||
1845 | BT_HIDDEN | |
91bc8451 | 1846 | void debug_info_comp_finalize(bt_self_component_filter *self_comp_flt) |
ca9f27f3 FD |
1847 | { |
1848 | struct debug_info_component *debug_info = | |
1849 | bt_self_component_get_data( | |
bc463d34 FD |
1850 | bt_self_component_filter_as_self_component( |
1851 | self_comp_flt)); | |
3a3d15f3 | 1852 | bt_logging_level log_level = debug_info->log_level; |
91bc8451 | 1853 | bt_self_component *self_comp = debug_info->self_comp; |
3a3d15f3 | 1854 | |
91bc8451 | 1855 | BT_COMP_LOGI("Finalizing debug_info self_component: comp-addr=%p", |
ca9f27f3 FD |
1856 | self_comp); |
1857 | ||
1858 | destroy_debug_info_comp(debug_info); | |
1859 | } | |
1860 | ||
1861 | BT_HIDDEN | |
d24d5663 | 1862 | bt_component_class_message_iterator_next_method_status debug_info_msg_iter_next( |
ca9f27f3 FD |
1863 | bt_self_message_iterator *self_msg_iter, |
1864 | const bt_message_array_const msgs, uint64_t capacity, | |
1865 | uint64_t *count) | |
1866 | { | |
1867 | bt_self_component_port_input_message_iterator *upstream_iterator = NULL; | |
d24d5663 | 1868 | bt_message_iterator_next_status upstream_iterator_ret_status; |
ca9f27f3 FD |
1869 | struct debug_info_msg_iter *debug_info_msg_iter; |
1870 | struct debug_info_component *debug_info = NULL; | |
d24d5663 | 1871 | bt_component_class_message_iterator_next_method_status status; |
ca9f27f3 FD |
1872 | bt_self_component *self_comp = NULL; |
1873 | bt_message_array_const input_msgs; | |
1874 | const bt_message *out_message; | |
1875 | uint64_t curr_msg_idx, i; | |
1876 | ||
d24d5663 | 1877 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; |
ca9f27f3 FD |
1878 | |
1879 | self_comp = bt_self_message_iterator_borrow_component(self_msg_iter); | |
98b15851 | 1880 | BT_ASSERT_DBG(self_comp); |
ca9f27f3 FD |
1881 | |
1882 | debug_info = bt_self_component_get_data(self_comp); | |
98b15851 | 1883 | BT_ASSERT_DBG(debug_info); |
ca9f27f3 FD |
1884 | |
1885 | debug_info_msg_iter = bt_self_message_iterator_get_data(self_msg_iter); | |
98b15851 | 1886 | BT_ASSERT_DBG(debug_info_msg_iter); |
ca9f27f3 FD |
1887 | |
1888 | upstream_iterator = debug_info_msg_iter->msg_iter; | |
98b15851 | 1889 | BT_ASSERT_DBG(upstream_iterator); |
ca9f27f3 FD |
1890 | |
1891 | upstream_iterator_ret_status = | |
1892 | bt_self_component_port_input_message_iterator_next( | |
bc463d34 | 1893 | upstream_iterator, &input_msgs, count); |
d24d5663 PP |
1894 | if (upstream_iterator_ret_status != |
1895 | BT_MESSAGE_ITERATOR_NEXT_STATUS_OK) { | |
ca9f27f3 | 1896 | /* |
d24d5663 PP |
1897 | * No messages were returned. Not necessarily an error. |
1898 | * Convert the upstream message iterator status to a | |
1899 | * self status. | |
ca9f27f3 | 1900 | */ |
d24d5663 | 1901 | status = (int) upstream_iterator_ret_status; |
ca9f27f3 FD |
1902 | goto end; |
1903 | } | |
1904 | ||
1905 | /* | |
1906 | * There should never be more received messages than the capacity we | |
1907 | * provided. | |
1908 | */ | |
98b15851 | 1909 | BT_ASSERT_DBG(*count <= capacity); |
ca9f27f3 FD |
1910 | |
1911 | for (curr_msg_idx = 0; curr_msg_idx < *count; curr_msg_idx++) { | |
1912 | out_message = handle_message(debug_info_msg_iter, | |
d24d5663 | 1913 | input_msgs[curr_msg_idx]); |
ca9f27f3 FD |
1914 | if (!out_message) { |
1915 | goto handle_msg_error; | |
1916 | } | |
1917 | ||
1918 | msgs[curr_msg_idx] = out_message; | |
1919 | /* | |
1920 | * Drop our reference of the input message as we are done with | |
1921 | * it and created a output copy. | |
1922 | */ | |
1923 | bt_message_put_ref(input_msgs[curr_msg_idx]); | |
1924 | } | |
1925 | ||
1926 | goto end; | |
1927 | ||
1928 | handle_msg_error: | |
1929 | /* | |
1930 | * Drop references of all the output messages created before the | |
1931 | * failure. | |
1932 | */ | |
1933 | for (i = 0; i < curr_msg_idx; i++) { | |
1934 | bt_message_put_ref(msgs[i]); | |
1935 | } | |
1936 | ||
acc179dd FD |
1937 | /* |
1938 | * Drop references of all the input messages not dropped before the | |
1939 | * failure. | |
1940 | */ | |
1941 | for (i = curr_msg_idx; i < *count; i++) { | |
1942 | bt_message_put_ref(input_msgs[i]); | |
1943 | } | |
1944 | ||
d24d5663 PP |
1945 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR; |
1946 | ||
ca9f27f3 FD |
1947 | end: |
1948 | return status; | |
1949 | } | |
1950 | ||
cbba2996 FD |
1951 | static |
1952 | void debug_info_msg_iter_destroy(struct debug_info_msg_iter *debug_info_msg_iter) | |
1953 | { | |
1954 | if (!debug_info_msg_iter) { | |
1955 | goto end; | |
1956 | } | |
1957 | ||
1958 | if (debug_info_msg_iter->msg_iter) { | |
1959 | bt_self_component_port_input_message_iterator_put_ref( | |
bc463d34 | 1960 | debug_info_msg_iter->msg_iter); |
cbba2996 FD |
1961 | } |
1962 | ||
1963 | if (debug_info_msg_iter->ir_maps) { | |
1964 | trace_ir_maps_destroy(debug_info_msg_iter->ir_maps); | |
1965 | } | |
1966 | ||
1967 | if (debug_info_msg_iter->debug_info_map) { | |
1968 | g_hash_table_destroy(debug_info_msg_iter->debug_info_map); | |
1969 | } | |
1970 | ||
1971 | bt_fd_cache_fini(&debug_info_msg_iter->fd_cache); | |
1972 | g_free(debug_info_msg_iter); | |
1973 | ||
1974 | end: | |
1975 | return; | |
1976 | } | |
1977 | ||
ca9f27f3 | 1978 | BT_HIDDEN |
21a9f056 | 1979 | bt_component_class_message_iterator_initialize_method_status debug_info_msg_iter_init( |
ca9f27f3 | 1980 | bt_self_message_iterator *self_msg_iter, |
8d8b141d | 1981 | bt_self_message_iterator_configuration *config, |
91bc8451 | 1982 | bt_self_component_filter *self_comp_flt, |
ca9f27f3 FD |
1983 | bt_self_component_port_output *self_port) |
1984 | { | |
21a9f056 | 1985 | bt_component_class_message_iterator_initialize_method_status status; |
e803df70 SM |
1986 | bt_self_component_port_input_message_iterator_create_from_message_iterator_status |
1987 | msg_iter_status; | |
cbba2996 FD |
1988 | struct bt_self_component_port_input *input_port = NULL; |
1989 | bt_self_component_port_input_message_iterator *upstream_iterator = NULL; | |
1990 | struct debug_info_msg_iter *debug_info_msg_iter = NULL; | |
06d1cf5d | 1991 | gchar *debug_info_field_name; |
1e638f98 | 1992 | int ret; |
91bc8451 PP |
1993 | bt_self_component *self_comp = |
1994 | bt_self_component_filter_as_self_component(self_comp_flt); | |
3a3d15f3 | 1995 | bt_logging_level log_level = bt_component_get_logging_level( |
91bc8451 | 1996 | bt_self_component_as_component(self_comp)); |
ca9f27f3 FD |
1997 | |
1998 | /* Borrow the upstream input port. */ | |
1999 | input_port = bt_self_component_filter_borrow_input_port_by_name( | |
91bc8451 | 2000 | self_comp_flt, "in"); |
ca9f27f3 | 2001 | if (!input_port) { |
21a9f056 | 2002 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR; |
cbba2996 FD |
2003 | goto error; |
2004 | } | |
2005 | ||
2006 | debug_info_msg_iter = g_new0(struct debug_info_msg_iter, 1); | |
2007 | if (!debug_info_msg_iter) { | |
21a9f056 | 2008 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
cbba2996 | 2009 | goto error; |
ca9f27f3 FD |
2010 | } |
2011 | ||
3a3d15f3 | 2012 | debug_info_msg_iter->log_level = log_level; |
91bc8451 | 2013 | debug_info_msg_iter->self_comp = self_comp; |
3a3d15f3 | 2014 | |
ca9f27f3 | 2015 | /* Create an iterator on the upstream component. */ |
e803df70 SM |
2016 | msg_iter_status = bt_self_component_port_input_message_iterator_create_from_message_iterator( |
2017 | self_msg_iter, input_port, &upstream_iterator); | |
2018 | if (msg_iter_status != BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK) { | |
2019 | status = (int) msg_iter_status; | |
cbba2996 | 2020 | goto error; |
ca9f27f3 FD |
2021 | } |
2022 | ||
cbba2996 FD |
2023 | BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_MOVE_REF( |
2024 | debug_info_msg_iter->msg_iter, upstream_iterator); | |
ca9f27f3 | 2025 | |
cbba2996 | 2026 | /* Create hashtable that will contain debug info mapping. */ |
ca9f27f3 | 2027 | debug_info_msg_iter->debug_info_map = g_hash_table_new_full( |
cbba2996 FD |
2028 | g_direct_hash, g_direct_equal, (GDestroyNotify) NULL, |
2029 | (GDestroyNotify) debug_info_destroy); | |
ca9f27f3 | 2030 | if (!debug_info_msg_iter->debug_info_map) { |
21a9f056 | 2031 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
cbba2996 | 2032 | goto error; |
ca9f27f3 FD |
2033 | } |
2034 | ||
91bc8451 PP |
2035 | debug_info_msg_iter->debug_info_component = |
2036 | bt_self_component_get_data(self_comp); | |
ca9f27f3 | 2037 | |
06d1cf5d FD |
2038 | debug_info_field_name = |
2039 | debug_info_msg_iter->debug_info_component->arg_debug_info_field_name; | |
2040 | ||
91bc8451 | 2041 | debug_info_msg_iter->ir_maps = trace_ir_maps_create(self_comp, |
3a3d15f3 | 2042 | debug_info_field_name, log_level); |
ca9f27f3 | 2043 | if (!debug_info_msg_iter->ir_maps) { |
21a9f056 | 2044 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
cbba2996 | 2045 | goto error; |
ca9f27f3 FD |
2046 | } |
2047 | ||
3a3d15f3 | 2048 | ret = bt_fd_cache_init(&debug_info_msg_iter->fd_cache, log_level); |
1e638f98 | 2049 | if (ret) { |
21a9f056 | 2050 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
cbba2996 | 2051 | goto error; |
1e638f98 FD |
2052 | } |
2053 | ||
c0e46a7c SM |
2054 | bt_self_message_iterator_configuration_set_can_seek_forward(config, |
2055 | bt_self_component_port_input_message_iterator_can_seek_forward( | |
2056 | debug_info_msg_iter->msg_iter)); | |
2057 | ||
ca9f27f3 | 2058 | bt_self_message_iterator_set_data(self_msg_iter, debug_info_msg_iter); |
ca9f27f3 FD |
2059 | debug_info_msg_iter->input_iterator = self_msg_iter; |
2060 | ||
21a9f056 | 2061 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK; |
cbba2996 FD |
2062 | goto end; |
2063 | ||
2064 | error: | |
2065 | debug_info_msg_iter_destroy(debug_info_msg_iter); | |
d24d5663 | 2066 | |
ca9f27f3 FD |
2067 | end: |
2068 | return status; | |
2069 | } | |
2070 | ||
2071 | BT_HIDDEN | |
f2fb1b32 | 2072 | bt_component_class_message_iterator_can_seek_beginning_method_status |
bc463d34 FD |
2073 | debug_info_msg_iter_can_seek_beginning(bt_self_message_iterator *self_msg_iter, |
2074 | bt_bool *can_seek) | |
ca9f27f3 FD |
2075 | { |
2076 | struct debug_info_msg_iter *debug_info_msg_iter = | |
2077 | bt_self_message_iterator_get_data(self_msg_iter); | |
2078 | BT_ASSERT(debug_info_msg_iter); | |
2079 | ||
f2fb1b32 SM |
2080 | return (int) bt_self_component_port_input_message_iterator_can_seek_beginning( |
2081 | debug_info_msg_iter->msg_iter, can_seek); | |
ca9f27f3 FD |
2082 | } |
2083 | ||
2084 | BT_HIDDEN | |
bc463d34 FD |
2085 | bt_component_class_message_iterator_seek_beginning_method_status |
2086 | debug_info_msg_iter_seek_beginning(bt_self_message_iterator *self_msg_iter) | |
ca9f27f3 FD |
2087 | { |
2088 | struct debug_info_msg_iter *debug_info_msg_iter = | |
2089 | bt_self_message_iterator_get_data(self_msg_iter); | |
d24d5663 PP |
2090 | bt_component_class_message_iterator_seek_beginning_method_status status = |
2091 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK; | |
2092 | bt_message_iterator_seek_beginning_status seek_beg_status; | |
ca9f27f3 FD |
2093 | |
2094 | BT_ASSERT(debug_info_msg_iter); | |
2095 | ||
2096 | /* Ask the upstream component to seek to the beginning. */ | |
d24d5663 | 2097 | seek_beg_status = bt_self_component_port_input_message_iterator_seek_beginning( |
ca9f27f3 | 2098 | debug_info_msg_iter->msg_iter); |
d24d5663 PP |
2099 | if (seek_beg_status != BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK) { |
2100 | status = (int) seek_beg_status; | |
ca9f27f3 FD |
2101 | goto end; |
2102 | } | |
2103 | ||
2104 | /* Clear this iterator data. */ | |
2105 | trace_ir_maps_clear(debug_info_msg_iter->ir_maps); | |
2106 | g_hash_table_remove_all(debug_info_msg_iter->debug_info_map); | |
d24d5663 | 2107 | |
ca9f27f3 | 2108 | end: |
d24d5663 | 2109 | return status; |
ca9f27f3 FD |
2110 | } |
2111 | ||
2112 | BT_HIDDEN | |
2113 | void debug_info_msg_iter_finalize(bt_self_message_iterator *it) | |
2114 | { | |
2115 | struct debug_info_msg_iter *debug_info_msg_iter; | |
2116 | ||
2117 | debug_info_msg_iter = bt_self_message_iterator_get_data(it); | |
2118 | BT_ASSERT(debug_info_msg_iter); | |
2119 | ||
cbba2996 | 2120 | debug_info_msg_iter_destroy(debug_info_msg_iter); |
ca9f27f3 | 2121 | } |