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 | |
087cd0f5 | 17 | #include "metadata.hpp" |
490db841 | 18 | |
78bb6992 | 19 | extern bool ctf_fs_debug; |
56a1cced | 20 | |
4164020e SM |
21 | struct ctf_fs_file |
22 | { | |
23 | bt_logging_level log_level; | |
98903a3e | 24 | |
4164020e SM |
25 | /* Weak */ |
26 | bt_self_component *self_comp; | |
4c65a157 | 27 | |
4164020e SM |
28 | /* Owned by this */ |
29 | GString *path; | |
1a9f7075 | 30 | |
4164020e SM |
31 | /* Owned by this */ |
32 | FILE *fp; | |
1a9f7075 | 33 | |
4164020e | 34 | off_t size; |
56a1cced JG |
35 | }; |
36 | ||
4164020e SM |
37 | struct ctf_fs_metadata |
38 | { | |
39 | /* Owned by this */ | |
40 | struct ctf_metadata_decoder *decoder; | |
44c440bc | 41 | |
4164020e SM |
42 | /* Owned by this */ |
43 | bt_trace_class *trace_class; | |
1a9f7075 | 44 | |
4164020e SM |
45 | /* Weak (owned by `decoder` above) */ |
46 | struct ctf_trace_class *tc; | |
44c440bc | 47 | |
4164020e SM |
48 | /* Owned by this */ |
49 | char *text; | |
1a9f7075 | 50 | |
4164020e | 51 | int bo; |
56a1cced JG |
52 | }; |
53 | ||
4164020e SM |
54 | struct ctf_fs_component |
55 | { | |
56 | bt_logging_level log_level; | |
98903a3e | 57 | |
4164020e SM |
58 | /* Array of struct ctf_fs_port_data *, owned by this */ |
59 | GPtrArray *port_data; | |
1a9f7075 | 60 | |
4164020e SM |
61 | /* Owned by this */ |
62 | struct ctf_fs_trace *trace; | |
1a9f7075 | 63 | |
4164020e | 64 | struct ctf_fs_metadata_config metadata_config; |
1a9f7075 PP |
65 | }; |
66 | ||
4164020e SM |
67 | struct ctf_fs_trace |
68 | { | |
69 | bt_logging_level log_level; | |
98903a3e | 70 | |
4164020e SM |
71 | /* |
72 | * Weak. These are mostly used to generate log messages or to append | |
73 | * error causes. They are mutually exclusive, only one of them must be | |
74 | * set. | |
75 | */ | |
76 | bt_self_component *self_comp; | |
77 | bt_self_component_class *self_comp_class; | |
4c65a157 | 78 | |
4164020e SM |
79 | /* Owned by this */ |
80 | struct ctf_fs_metadata *metadata; | |
1a9f7075 | 81 | |
4164020e SM |
82 | /* Owned by this */ |
83 | bt_trace *trace; | |
862ca4ed | 84 | |
4164020e SM |
85 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
86 | GPtrArray *ds_file_groups; | |
94cf822e | 87 | |
4164020e SM |
88 | /* Owned by this */ |
89 | GString *path; | |
1a9f7075 | 90 | |
4164020e SM |
91 | /* Next automatic stream ID when not provided by packet header */ |
92 | uint64_t next_stream_id; | |
1a9f7075 PP |
93 | }; |
94 | ||
4164020e SM |
95 | struct ctf_fs_ds_index_entry |
96 | { | |
97 | /* Weak, belongs to ctf_fs_ds_file_info. */ | |
98 | const char *path; | |
99 | ||
100 | /* Position, in bytes, of the packet from the beginning of the file. */ | |
101 | uint64_t offset; | |
102 | ||
103 | /* Size of the packet, in bytes. */ | |
104 | uint64_t packet_size; | |
105 | ||
106 | /* | |
107 | * Extracted from the packet context, relative to the respective fields' | |
108 | * mapped clock classes (in cycles). | |
109 | */ | |
110 | uint64_t timestamp_begin, timestamp_end; | |
111 | ||
112 | /* | |
113 | * Converted from the packet context, relative to the trace's EPOCH | |
114 | * (in ns since EPOCH). | |
115 | */ | |
116 | int64_t timestamp_begin_ns, timestamp_end_ns; | |
117 | ||
118 | /* | |
119 | * Packet sequence number, or UINT64_MAX if not present in the index. | |
120 | */ | |
121 | uint64_t packet_seq_num; | |
7ed5243a FD |
122 | }; |
123 | ||
4164020e SM |
124 | struct ctf_fs_ds_index |
125 | { | |
126 | /* Array of pointer to struct ctf_fs_ds_index_entry. */ | |
127 | GPtrArray *entries; | |
7ed5243a FD |
128 | }; |
129 | ||
4164020e SM |
130 | struct ctf_fs_ds_file_group |
131 | { | |
132 | /* | |
133 | * Array of struct ctf_fs_ds_file_info, owned by this. | |
134 | * | |
135 | * This is an _ordered_ array of data stream file infos which | |
136 | * belong to this group (a single stream instance). | |
137 | * | |
138 | * You can call ctf_fs_ds_file_create() with one of those paths | |
139 | * and the trace IR stream below. | |
140 | */ | |
141 | GPtrArray *ds_file_infos; | |
142 | ||
143 | /* Owned by this */ | |
144 | struct ctf_stream_class *sc; | |
145 | ||
146 | /* Owned by this */ | |
147 | bt_stream *stream; | |
148 | ||
149 | /* Stream (instance) ID; -1ULL means none */ | |
150 | uint64_t stream_id; | |
151 | ||
152 | /* Weak, belongs to component */ | |
153 | struct ctf_fs_trace *ctf_fs_trace; | |
154 | ||
155 | /* | |
156 | * Owned by this. | |
157 | */ | |
158 | struct ctf_fs_ds_index *index; | |
ea0b4b9e JG |
159 | }; |
160 | ||
4164020e SM |
161 | struct ctf_fs_port_data |
162 | { | |
163 | /* Weak, belongs to ctf_fs_trace */ | |
164 | struct ctf_fs_ds_file_group *ds_file_group; | |
5c563278 | 165 | |
4164020e SM |
166 | /* Weak */ |
167 | struct ctf_fs_component *ctf_fs; | |
94cf822e PP |
168 | }; |
169 | ||
4164020e SM |
170 | struct ctf_fs_msg_iter_data |
171 | { | |
172 | bt_logging_level log_level; | |
98903a3e | 173 | |
4164020e SM |
174 | /* Weak */ |
175 | bt_self_component *self_comp; | |
4c65a157 | 176 | |
4164020e SM |
177 | /* Weak */ |
178 | bt_self_message_iterator *self_msg_iter; | |
5c563278 | 179 | |
4164020e SM |
180 | /* Weak, belongs to ctf_fs_trace */ |
181 | struct ctf_fs_ds_file_group *ds_file_group; | |
94cf822e | 182 | |
4164020e SM |
183 | /* Owned by this */ |
184 | struct ctf_msg_iter *msg_iter; | |
cbca1c06 | 185 | |
4164020e SM |
186 | /* |
187 | * Saved error. If we hit an error in the _next method, but have some | |
188 | * messages ready to return, we save the error here and return it on | |
189 | * the next _next call. | |
190 | */ | |
191 | bt_message_iterator_class_next_method_status next_saved_status; | |
192 | const struct bt_error *next_saved_error; | |
f6e68e70 | 193 | |
4164020e | 194 | struct ctf_fs_ds_group_medops_data *msg_iter_medops_data; |
94cf822e PP |
195 | }; |
196 | ||
4164020e SM |
197 | bt_component_class_initialize_method_status |
198 | ctf_fs_init(bt_self_component_source *source, bt_self_component_source_configuration *config, | |
199 | const bt_value *params, void *init_method_data); | |
490db841 | 200 | |
b19ff26f | 201 | void ctf_fs_finalize(bt_self_component_source *component); |
d3e4dcd8 | 202 | |
4164020e SM |
203 | bt_component_class_query_method_status ctf_fs_query(bt_self_component_class_source *comp_class, |
204 | bt_private_query_executor *priv_query_exec, | |
205 | const char *object, const bt_value *params, | |
206 | void *method_data, const bt_value **result); | |
55314f2a | 207 | |
4164020e SM |
208 | bt_message_iterator_class_initialize_method_status |
209 | ctf_fs_iterator_init(bt_self_message_iterator *self_msg_iter, | |
210 | bt_self_message_iterator_configuration *config, | |
211 | bt_self_component_port_output *self_port); | |
d94d92ac | 212 | |
d6e69534 | 213 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it); |
d3eb6e8f | 214 | |
4164020e SM |
215 | bt_message_iterator_class_next_method_status |
216 | ctf_fs_iterator_next(bt_self_message_iterator *iterator, bt_message_array_const msgs, | |
217 | uint64_t capacity, uint64_t *count); | |
d3eb6e8f | 218 | |
4164020e SM |
219 | bt_message_iterator_class_seek_beginning_method_status |
220 | ctf_fs_iterator_seek_beginning(bt_self_message_iterator *message_iterator); | |
6a9bb5e9 | 221 | |
f280892e SM |
222 | /* Create and initialize a new, empty ctf_fs_component. */ |
223 | ||
50b9f4b5 | 224 | struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level); |
f280892e SM |
225 | |
226 | /* | |
a0cd55ad SM |
227 | * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing |
228 | * the same UUID. | |
229 | * | |
230 | * `paths_value` must be an array of strings, | |
231 | * | |
232 | * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`. | |
d23b766e SM |
233 | * |
234 | * `self_comp` and `self_comp_class` are used for logging, only one of them | |
235 | * should be set. | |
f280892e SM |
236 | */ |
237 | ||
4164020e SM |
238 | int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component *ctf_fs, |
239 | const bt_value *paths_value, | |
240 | const bt_value *trace_name_value, | |
241 | bt_self_component *self_comp, | |
242 | bt_self_component_class *self_comp_class); | |
f280892e SM |
243 | |
244 | /* Free `ctf_fs` and everything it owns. */ | |
245 | ||
f280892e SM |
246 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs); |
247 | ||
d907165c SM |
248 | /* |
249 | * Read and validate parameters taken by the src.ctf.fs plugin. | |
250 | * | |
251 | * - The mandatory `paths` parameter is returned in `*paths`. | |
252 | * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if | |
253 | * present, are recorded in the `ctf_fs` structure. | |
005d49d6 SM |
254 | * - The optional `trace-name` parameter is returned in `*trace_name` if |
255 | * present, else `*trace_name` is set to NULL. | |
d907165c | 256 | * |
d23b766e SM |
257 | * `self_comp` and `self_comp_class` are used for logging, only one of them |
258 | * should be set. | |
259 | * | |
d907165c SM |
260 | * Return true on success, false if any parameter didn't pass validation. |
261 | */ | |
f280892e | 262 | |
4164020e SM |
263 | bool read_src_fs_parameters(const bt_value *params, const bt_value **paths, |
264 | const bt_value **trace_name, struct ctf_fs_component *ctf_fs, | |
265 | bt_self_component *self_comp, bt_self_component_class *self_comp_class); | |
f280892e | 266 | |
a38d7650 SM |
267 | /* |
268 | * Generate the port name to be used for a given data stream file group. | |
269 | * | |
270 | * The result must be freed using g_free by the caller. | |
271 | */ | |
272 | ||
a38d7650 SM |
273 | gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group); |
274 | ||
541b0a11 | 275 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |