1 #ifndef BABELTRACE_PLUGIN_DEBUG_INFO_H
2 #define BABELTRACE_PLUGIN_DEBUG_INFO_H
5 * Babeltrace - Debug information Plug-in
7 * Copyright (c) 2015 EfficiOS Inc.
8 * Copyright (c) 2015 Antoine Busque <abusque@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
32 #include <babeltrace/babeltrace-internal.h>
33 #include <babeltrace/babeltrace.h>
35 enum debug_info_stream_state
{
37 * We know the stream exists but we have never received a
38 * stream_begin notification for it.
40 DEBUG_INFO_UNKNOWN_STREAM
,
41 /* We know this stream is active (between stream_begin and _end). */
42 DEBUG_INFO_ACTIVE_STREAM
,
43 /* We have received a stream_end for this stream. */
44 DEBUG_INFO_COMPLETED_STREAM
,
47 struct debug_info_component
{
49 char *arg_debug_info_field_name
;
50 const char *arg_debug_dir
;
52 const char *arg_target_prefix
;
55 struct debug_info_iterator
{
56 struct debug_info_component
*debug_info_component
;
57 /* Map between struct bt_ctf_trace and struct bt_ctf_writer. */
58 GHashTable
*trace_map
;
59 /* Input iterators associated with this output iterator. */
60 GPtrArray
*input_iterator_group
;
61 struct bt_notification
*current_notification
;
62 struct bt_notification_iterator
*input_iterator
;
66 struct debug_info_trace
{
67 struct bt_ctf_trace
*trace
;
68 struct bt_ctf_trace
*writer_trace
;
69 struct debug_info_component
*debug_info_component
;
70 struct debug_info_iterator
*debug_it
;
71 int static_listener_id
;
73 /* Map between reader and writer stream. */
74 GHashTable
*stream_map
;
75 /* Map between reader and writer stream class. */
76 GHashTable
*stream_class_map
;
77 /* Map between reader and writer stream class. */
78 GHashTable
*packet_map
;
79 /* Map between a trace_class and its corresponding debug_info. */
80 GHashTable
*trace_debug_map
;
81 /* Map between a stream and enum debug_info_stream_state. */
82 GHashTable
*stream_states
;
85 struct debug_info_source
{
86 /* Strings are owned by debug_info_source. */
90 /* short_src_path points inside src_path, no need to free. */
91 const char *short_src_path
;
93 /* short_bin_path points inside bin_path, no need to free. */
94 const char *short_bin_path
;
96 * Location within the binary. Either absolute (@0x1234) or
103 struct debug_info
*debug_info_create(struct debug_info_component
*comp
);
106 void debug_info_destroy(struct debug_info
*debug_info
);
109 struct debug_info_source
*debug_info_query(struct debug_info
*debug_info
,
110 int64_t vpid
, uint64_t ip
);
113 void debug_info_handle_event(FILE *err
, struct bt_ctf_event
*event
,
114 struct debug_info
*debug_info
);
117 void debug_info_close_trace(struct debug_info_iterator
*debug_it
,
118 struct debug_info_trace
*di_trace
);
120 #endif /* BABELTRACE_PLUGIN_DEBUG_INFO_H */