Commit | Line | Data |
---|---|---|
490db841 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
490db841 | 3 | * |
f3bc2010 | 4 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
56a1cced | 5 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> |
490db841 | 6 | * |
0235b0db | 7 | * BabelTrace - CTF on File System Component |
490db841 JG |
8 | */ |
9 | ||
0235b0db MJ |
10 | #ifndef BABELTRACE_PLUGIN_CTF_FS_H |
11 | #define BABELTRACE_PLUGIN_CTF_FS_H | |
12 | ||
c7e1be4b | 13 | #include <glib.h> |
c802cacb | 14 | |
c7e1be4b | 15 | #include <babeltrace2/babeltrace.h> |
c802cacb | 16 | |
49b956cc | 17 | #include "cpp-common/bt2c/glib-up.hpp" |
0f5c5d5c SM |
18 | #include "cpp-common/bt2c/logging.hpp" |
19 | ||
cdf7de78 | 20 | #include "data-stream-file.hpp" |
1fa280c9 | 21 | #include "plugins/ctf/common/src/metadata/tsdl/decoder.hpp" |
490db841 | 22 | |
78bb6992 | 23 | extern bool ctf_fs_debug; |
56a1cced | 24 | |
4164020e SM |
25 | struct ctf_fs_metadata |
26 | { | |
27 | /* Owned by this */ | |
1fa280c9 | 28 | ctf_metadata_decoder_up decoder; |
44c440bc | 29 | |
4164020e | 30 | /* Owned by this */ |
afb0f12b | 31 | bt_trace_class *trace_class = nullptr; |
1a9f7075 | 32 | |
4164020e | 33 | /* Weak (owned by `decoder` above) */ |
afb0f12b | 34 | struct ctf_trace_class *tc = nullptr; |
44c440bc | 35 | |
4164020e | 36 | /* Owned by this */ |
afb0f12b | 37 | char *text = nullptr; |
1a9f7075 | 38 | |
afb0f12b | 39 | int bo = 0; |
56a1cced JG |
40 | }; |
41 | ||
7df773f2 SM |
42 | struct ctf_fs_trace_deleter |
43 | { | |
44 | void operator()(ctf_fs_trace *) noexcept; | |
45 | }; | |
46 | ||
4164020e SM |
47 | struct ctf_fs_trace |
48 | { | |
7df773f2 SM |
49 | using UP = std::unique_ptr<ctf_fs_trace, ctf_fs_trace_deleter>; |
50 | ||
0f5c5d5c SM |
51 | explicit ctf_fs_trace(const bt2c::Logger& parentLogger) : |
52 | logger {parentLogger, "PLUGIN/SRC.CTF.FS/TRACE"} | |
53 | { | |
54 | } | |
98903a3e | 55 | |
0f5c5d5c | 56 | bt2c::Logger logger; |
4c65a157 | 57 | |
4164020e | 58 | /* Owned by this */ |
afb0f12b | 59 | struct ctf_fs_metadata *metadata = nullptr; |
1a9f7075 | 60 | |
e44859b1 | 61 | bt2::Trace::Shared trace; |
862ca4ed | 62 | |
cdf7de78 | 63 | std::vector<ctf_fs_ds_file_group::UP> ds_file_groups; |
94cf822e | 64 | |
cee8a466 | 65 | std::string path; |
1a9f7075 | 66 | |
4164020e | 67 | /* Next automatic stream ID when not provided by packet header */ |
afb0f12b | 68 | uint64_t next_stream_id = 0; |
1a9f7075 PP |
69 | }; |
70 | ||
09721481 SM |
71 | struct ctf_fs_port_data |
72 | { | |
945312a2 SM |
73 | using UP = std::unique_ptr<ctf_fs_port_data>; |
74 | ||
09721481 SM |
75 | /* Weak, belongs to ctf_fs_trace */ |
76 | struct ctf_fs_ds_file_group *ds_file_group = nullptr; | |
77 | ||
78 | /* Weak */ | |
79 | struct ctf_fs_component *ctf_fs = nullptr; | |
80 | }; | |
81 | ||
09721481 SM |
82 | struct ctf_fs_component |
83 | { | |
57ec0a35 | 84 | using UP = std::unique_ptr<ctf_fs_component>; |
09721481 SM |
85 | |
86 | explicit ctf_fs_component(const bt2c::Logger& parentLogger) noexcept : | |
87 | logger {parentLogger, "PLUGIN/SRC.CTF.FS/COMP"} | |
88 | { | |
89 | } | |
90 | ||
91 | bt2c::Logger logger; | |
92 | ||
945312a2 | 93 | std::vector<ctf_fs_port_data::UP> port_data; |
09721481 | 94 | |
7df773f2 | 95 | ctf_fs_trace::UP trace; |
09721481 SM |
96 | |
97 | ctf::src::ClkClsCfg clkClsCfg; | |
98 | }; | |
99 | ||
4164020e SM |
100 | struct ctf_fs_msg_iter_data |
101 | { | |
adf452d1 SM |
102 | using UP = std::unique_ptr<ctf_fs_msg_iter_data>; |
103 | ||
0f5c5d5c SM |
104 | explicit ctf_fs_msg_iter_data(bt_self_message_iterator *selfMsgIter) : |
105 | self_msg_iter {selfMsgIter}, logger {bt2::SelfMessageIterator {self_msg_iter}, | |
106 | "PLUGIN/SRC.CTF.FS/MSG-ITER"} | |
107 | { | |
108 | } | |
4c65a157 | 109 | |
4164020e | 110 | /* Weak */ |
afb0f12b | 111 | bt_self_message_iterator *self_msg_iter = nullptr; |
5c563278 | 112 | |
0f5c5d5c SM |
113 | bt2c::Logger logger; |
114 | ||
4164020e | 115 | /* Weak, belongs to ctf_fs_trace */ |
afb0f12b | 116 | struct ctf_fs_ds_file_group *ds_file_group = nullptr; |
94cf822e | 117 | |
537fddc0 | 118 | ctf_msg_iter_up msg_iter; |
cbca1c06 | 119 | |
4164020e SM |
120 | /* |
121 | * Saved error. If we hit an error in the _next method, but have some | |
122 | * messages ready to return, we save the error here and return it on | |
123 | * the next _next call. | |
124 | */ | |
afb0f12b SM |
125 | bt_message_iterator_class_next_method_status next_saved_status = |
126 | BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK; | |
127 | const struct bt_error *next_saved_error = nullptr; | |
f6e68e70 | 128 | |
3cf88182 | 129 | ctf_fs_ds_group_medops_data_up msg_iter_medops_data; |
94cf822e PP |
130 | }; |
131 | ||
4164020e SM |
132 | bt_component_class_initialize_method_status |
133 | ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config, | |
134 | const bt_value *params, void *init_method_data); | |
490db841 | 135 | |
b19ff26f | 136 | void ctf_fs_finalize(bt_self_component_source *component); |
d3e4dcd8 | 137 | |
4164020e SM |
138 | bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class, |
139 | bt_private_query_executor *priv_query_exec, | |
140 | const char *object, const bt_value *params, | |
141 | void *method_data, const bt_value **result); | |
55314f2a | 142 | |
4164020e SM |
143 | bt_message_iterator_class_initialize_method_status |
144 | ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter, | |
145 | bt_self_message_iterator_configuration *config, | |
146 | bt_self_component_port_output *self_port); | |
d94d92ac | 147 | |
d6e69534 | 148 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it); |
d3eb6e8f | 149 | |
4164020e SM |
150 | bt_message_iterator_class_next_method_status |
151 | ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs, | |
152 | uint64_t capacity, uint64_t *count); | |
d3eb6e8f | 153 | |
4164020e SM |
154 | bt_message_iterator_class_seek_beginning_method_status |
155 | ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator); | |
6a9bb5e9 | 156 | |
f280892e SM |
157 | /* Create and initialize a new, empty ctf_fs_component. */ |
158 | ||
f340a3e8 | 159 | ctf_fs_component::UP ctf_fs_component_create(const bt2c::Logger& parentLogger); |
f280892e SM |
160 | |
161 | /* | |
a0cd55ad SM |
162 | * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing |
163 | * the same UUID. | |
164 | * | |
165 | * `paths_value` must be an array of strings, | |
166 | * | |
167 | * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`. | |
d23b766e SM |
168 | * |
169 | * `self_comp` and `self_comp_class` are used for logging, only one of them | |
170 | * should be set. | |
f280892e SM |
171 | */ |
172 | ||
4164020e SM |
173 | int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs, |
174 | const bt_value *paths_value, | |
175 | const bt_value *trace_name_value, | |
0f5c5d5c | 176 | bt_self_component *selfComp); |
f280892e | 177 | |
d907165c SM |
178 | /* |
179 | * Read and validate parameters taken by the src.ctf.fs plugin. | |
180 | * | |
181 | * - The mandatory `paths` parameter is returned in `*paths`. | |
182 | * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if | |
183 | * present, are recorded in the `ctf_fs` structure. | |
005d49d6 SM |
184 | * - The optional `trace-name` parameter is returned in `*trace_name` if |
185 | * present, else `*trace_name` is set to NULL. | |
d907165c | 186 | * |
d23b766e SM |
187 | * `self_comp` and `self_comp_class` are used for logging, only one of them |
188 | * should be set. | |
189 | * | |
d907165c SM |
190 | * Return true on success, false if any parameter didn't pass validation. |
191 | */ | |
f280892e | 192 | |
4164020e | 193 | bool read_src_fs_parameters(const bt_value *params, const bt_value **paths, |
0f5c5d5c | 194 | const bt_value **trace_name, struct ctf_fs_component *ctf_fs); |
f280892e | 195 | |
a38d7650 SM |
196 | /* |
197 | * Generate the port name to be used for a given data stream file group. | |
a38d7650 SM |
198 | */ |
199 | ||
49b956cc | 200 | bt2c::GCharUP ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group); |
a38d7650 | 201 | |
541b0a11 | 202 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |