Commit | Line | Data |
---|---|---|
541b0a11 JG |
1 | #ifndef BABELTRACE_PLUGIN_CTF_FS_H |
2 | #define BABELTRACE_PLUGIN_CTF_FS_H | |
490db841 JG |
3 | |
4 | /* | |
6a29d9fd | 5 | * BabelTrace - CTF on File System Component |
490db841 | 6 | * |
f3bc2010 | 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
56a1cced | 8 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> |
490db841 JG |
9 | * |
10 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
11 | * | |
12 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
13 | * of this software and associated documentation files (the "Software"), to deal | |
14 | * in the Software without restriction, including without limitation the rights | |
15 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
16 | * copies of the Software, and to permit persons to whom the Software is | |
17 | * furnished to do so, subject to the following conditions: | |
18 | * | |
19 | * The above copyright notice and this permission notice shall be included in | |
20 | * all copies or substantial portions of the Software. | |
21 | * | |
22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
23 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
24 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
25 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
26 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
27 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
28 | * SOFTWARE. | |
29 | */ | |
30 | ||
c55a9f58 | 31 | #include <stdbool.h> |
85e7137b | 32 | #include "common/macros.h" |
71c5da58 | 33 | #include <babeltrace2/babeltrace.h> |
94cf822e | 34 | #include "data-stream-file.h" |
97ade20b | 35 | #include "metadata.h" |
7b33a0e0 | 36 | #include "../common/metadata/decoder.h" |
490db841 | 37 | |
78bb6992 MD |
38 | BT_HIDDEN |
39 | extern bool ctf_fs_debug; | |
56a1cced JG |
40 | |
41 | struct ctf_fs_file { | |
3d731ea9 PP |
42 | bt_logging_level log_level; |
43 | ||
f67894f9 PP |
44 | /* Weak */ |
45 | bt_self_component *self_comp; | |
46 | ||
1a9f7075 | 47 | /* Owned by this */ |
56a1cced | 48 | GString *path; |
1a9f7075 PP |
49 | |
50 | /* Owned by this */ | |
56a1cced | 51 | FILE *fp; |
1a9f7075 | 52 | |
56a1cced JG |
53 | off_t size; |
54 | }; | |
55 | ||
56 | struct ctf_fs_metadata { | |
7b33a0e0 PP |
57 | /* Owned by this */ |
58 | struct ctf_metadata_decoder *decoder; | |
59 | ||
1a9f7075 | 60 | /* Owned by this */ |
8eee8ea2 | 61 | bt_trace_class *trace_class; |
1a9f7075 | 62 | |
7b33a0e0 PP |
63 | /* Weak (owned by `decoder` above) */ |
64 | struct ctf_trace_class *tc; | |
65 | ||
1a9f7075 PP |
66 | /* Owned by this */ |
67 | char *text; | |
68 | ||
56a1cced | 69 | int bo; |
56a1cced JG |
70 | }; |
71 | ||
ea0b4b9e | 72 | struct ctf_fs_component { |
3d731ea9 PP |
73 | bt_logging_level log_level; |
74 | ||
94cf822e | 75 | /* Weak, guaranteed to exist */ |
f67894f9 PP |
76 | bt_self_component_source *self_comp_src; |
77 | ||
78 | /* Weak */ | |
79 | bt_self_component *self_comp; | |
1a9f7075 PP |
80 | |
81 | /* Array of struct ctf_fs_port_data *, owned by this */ | |
82 | GPtrArray *port_data; | |
83 | ||
84 | /* Array of struct ctf_fs_trace *, owned by this */ | |
85 | GPtrArray *traces; | |
86 | ||
53ac3428 | 87 | struct ctf_fs_metadata_config metadata_config; |
1a9f7075 PP |
88 | }; |
89 | ||
90 | struct ctf_fs_trace { | |
3d731ea9 PP |
91 | bt_logging_level log_level; |
92 | ||
f67894f9 PP |
93 | /* Weak */ |
94 | bt_self_component *self_comp; | |
95 | ||
1a9f7075 | 96 | /* Owned by this */ |
5b29e799 | 97 | struct ctf_fs_metadata *metadata; |
1a9f7075 | 98 | |
10b7a2e4 | 99 | /* Owned by this */ |
8eee8ea2 | 100 | bt_trace *trace; |
10b7a2e4 | 101 | |
94cf822e PP |
102 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
103 | GPtrArray *ds_file_groups; | |
104 | ||
1a9f7075 PP |
105 | /* Owned by this */ |
106 | GString *path; | |
107 | ||
108 | /* Owned by this */ | |
109 | GString *name; | |
8deee039 PP |
110 | |
111 | /* Next automatic stream ID when not provided by packet header */ | |
112 | uint64_t next_stream_id; | |
1a9f7075 PP |
113 | }; |
114 | ||
779f4a23 FD |
115 | struct ctf_fs_ds_index_entry { |
116 | /* Position, in bytes, of the packet from the beginning of the file. */ | |
117 | uint64_t offset; | |
118 | ||
119 | /* Size of the packet, in bytes. */ | |
120 | uint64_t packet_size; | |
121 | ||
122 | /* | |
123 | * Extracted from the packet context, relative to the respective fields' | |
124 | * mapped clock classes (in cycles). | |
125 | */ | |
126 | uint64_t timestamp_begin, timestamp_end; | |
127 | ||
128 | /* | |
129 | * Converted from the packet context, relative to the trace's EPOCH | |
130 | * (in ns since EPOCH). | |
131 | */ | |
132 | int64_t timestamp_begin_ns, timestamp_end_ns; | |
133 | }; | |
134 | ||
135 | struct ctf_fs_ds_index { | |
136 | /* Array of pointer to struct ctf_fs_fd_index_entry. */ | |
137 | GPtrArray *entries; | |
138 | }; | |
139 | ||
94cf822e PP |
140 | struct ctf_fs_ds_file_group { |
141 | /* | |
142 | * Array of struct ctf_fs_ds_file_info, owned by this. | |
143 | * | |
144 | * This is an _ordered_ array of data stream file infos which | |
145 | * belong to this group (a single stream instance). | |
146 | * | |
147 | * You can call ctf_fs_ds_file_create() with one of those paths | |
108b91d0 | 148 | * and the trace IR stream below. |
94cf822e PP |
149 | */ |
150 | GPtrArray *ds_file_infos; | |
151 | ||
d09752f8 | 152 | /* Owned by this */ |
28faa416 | 153 | struct ctf_stream_class *sc; |
d09752f8 | 154 | |
1a9f7075 | 155 | /* Owned by this */ |
8eee8ea2 | 156 | bt_stream *stream; |
1a9f7075 | 157 | |
d09752f8 PP |
158 | /* Stream (instance) ID; -1ULL means none */ |
159 | uint64_t stream_id; | |
160 | ||
94cf822e | 161 | /* Weak, belongs to component */ |
1a9f7075 | 162 | struct ctf_fs_trace *ctf_fs_trace; |
779f4a23 FD |
163 | |
164 | /* | |
165 | * Owned by this. May be NULL. | |
166 | * | |
167 | * A stream cannot be assumed to be indexed as the indexing might have | |
168 | * been skipped. Moreover, the index's fields may not all be available | |
169 | * depending on the producer (e.g. timestamp_begin/end are not | |
170 | * mandatory). | |
779f4a23 FD |
171 | */ |
172 | struct ctf_fs_ds_index *index; | |
ea0b4b9e JG |
173 | }; |
174 | ||
94cf822e PP |
175 | struct ctf_fs_port_data { |
176 | /* Weak, belongs to ctf_fs_trace */ | |
177 | struct ctf_fs_ds_file_group *ds_file_group; | |
f7c3ac09 PP |
178 | |
179 | /* Weak */ | |
180 | struct ctf_fs_component *ctf_fs; | |
94cf822e PP |
181 | }; |
182 | ||
b09a5592 | 183 | struct ctf_fs_msg_iter_data { |
3d731ea9 PP |
184 | bt_logging_level log_level; |
185 | ||
f67894f9 PP |
186 | /* Weak */ |
187 | bt_self_component *self_comp; | |
188 | ||
f7c3ac09 | 189 | /* Weak */ |
b09a5592 | 190 | bt_self_message_iterator *pc_msg_iter; |
f7c3ac09 | 191 | |
94cf822e PP |
192 | /* Weak, belongs to ctf_fs_trace */ |
193 | struct ctf_fs_ds_file_group *ds_file_group; | |
194 | ||
195 | /* Owned by this */ | |
196 | struct ctf_fs_ds_file *ds_file; | |
197 | ||
198 | /* Which file the iterator is _currently_ operating on */ | |
199 | size_t ds_file_info_index; | |
55fa6491 PP |
200 | |
201 | /* Owned by this */ | |
b09a5592 | 202 | struct bt_msg_iter *msg_iter; |
94cf822e PP |
203 | }; |
204 | ||
f3bc2010 | 205 | BT_HIDDEN |
fb25b9e3 | 206 | bt_component_class_init_method_status ctf_fs_init( |
8eee8ea2 PP |
207 | bt_self_component_source *source, |
208 | const bt_value *params, void *init_method_data); | |
490db841 | 209 | |
d3e4dcd8 | 210 | BT_HIDDEN |
8eee8ea2 | 211 | void ctf_fs_finalize(bt_self_component_source *component); |
d3e4dcd8 | 212 | |
55314f2a | 213 | BT_HIDDEN |
fb25b9e3 | 214 | bt_component_class_query_method_status ctf_fs_query( |
8eee8ea2 | 215 | bt_self_component_class_source *comp_class, |
bf403eb2 | 216 | bt_private_query_executor *priv_query_exec, |
8eee8ea2 | 217 | const char *object, const bt_value *params, |
f6e305ce | 218 | void *method_data, const bt_value **result); |
55314f2a | 219 | |
97ade20b | 220 | BT_HIDDEN |
fb25b9e3 | 221 | bt_component_class_message_iterator_init_method_status ctf_fs_iterator_init( |
b09a5592 | 222 | bt_self_message_iterator *self_msg_iter, |
8eee8ea2 PP |
223 | bt_self_component_source *self_comp, |
224 | bt_self_component_port_output *self_port); | |
834e9996 | 225 | |
97ade20b | 226 | BT_HIDDEN |
b09a5592 | 227 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it); |
d3eb6e8f | 228 | |
97ade20b | 229 | BT_HIDDEN |
fb25b9e3 | 230 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next( |
b09a5592 PP |
231 | bt_self_message_iterator *iterator, |
232 | bt_message_array_const msgs, uint64_t capacity, | |
3fd7b79d | 233 | uint64_t *count); |
d3eb6e8f | 234 | |
a02839ae | 235 | BT_HIDDEN |
fb25b9e3 | 236 | bt_component_class_message_iterator_seek_beginning_method_status ctf_fs_iterator_seek_beginning( |
a02839ae PP |
237 | bt_self_message_iterator *message_iterator); |
238 | ||
bf5b7748 SM |
239 | /* Create and initialize a new, empty ctf_fs_component. */ |
240 | ||
241 | BT_HIDDEN | |
f67894f9 PP |
242 | struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level, |
243 | bt_self_component *self_comp); | |
bf5b7748 SM |
244 | |
245 | /* | |
246 | * Search recursively under all paths in `paths_value` (an array of strings), | |
247 | * for CTF traces. For each CTF trace found, create a ctf_fs_trace in | |
248 | * `ctf_fs` representing that trace. | |
249 | */ | |
250 | ||
251 | BT_HIDDEN | |
252 | int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source *self_comp, | |
253 | struct ctf_fs_component *ctf_fs, | |
254 | const bt_value *paths_value); | |
255 | ||
256 | /* Free `ctf_fs` and everything it owns. */ | |
257 | ||
258 | BT_HIDDEN | |
259 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs); | |
260 | ||
c80d4c65 SM |
261 | /* |
262 | * Read and validate parameters taken by the src.ctf.fs plugin. | |
263 | * | |
264 | * - The mandatory `paths` parameter is returned in `*paths`. | |
265 | * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if | |
266 | * present, are recorded in the `ctf_fs` structure. | |
267 | * | |
268 | * Return true on success, false if any parameter didn't pass validation. | |
269 | */ | |
bf5b7748 SM |
270 | |
271 | BT_HIDDEN | |
c80d4c65 SM |
272 | bool read_src_fs_parameters(const bt_value *params, |
273 | const bt_value **paths, struct ctf_fs_component *ctf_fs); | |
bf5b7748 | 274 | |
ddf49b27 SM |
275 | /* |
276 | * Generate the port name to be used for a given data stream file group. | |
277 | * | |
278 | * The result must be freed using g_free by the caller. | |
279 | */ | |
280 | ||
281 | BT_HIDDEN | |
282 | gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group); | |
283 | ||
541b0a11 | 284 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |