| 1 | #ifndef BABELTRACE_PLUGIN_CTF_FS_H |
| 2 | #define BABELTRACE_PLUGIN_CTF_FS_H |
| 3 | |
| 4 | /* |
| 5 | * BabelTrace - CTF on File System Component |
| 6 | * |
| 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 8 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> |
| 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 | |
| 31 | #include <stdbool.h> |
| 32 | #include "common/macros.h" |
| 33 | #include <babeltrace2/babeltrace.h> |
| 34 | #include "data-stream-file.h" |
| 35 | #include "metadata.h" |
| 36 | #include "../common/metadata/decoder.h" |
| 37 | |
| 38 | BT_HIDDEN |
| 39 | extern bool ctf_fs_debug; |
| 40 | |
| 41 | struct ctf_fs_file { |
| 42 | bt_logging_level log_level; |
| 43 | |
| 44 | /* Weak */ |
| 45 | bt_self_component *self_comp; |
| 46 | |
| 47 | /* Owned by this */ |
| 48 | GString *path; |
| 49 | |
| 50 | /* Owned by this */ |
| 51 | FILE *fp; |
| 52 | |
| 53 | off_t size; |
| 54 | }; |
| 55 | |
| 56 | struct ctf_fs_metadata { |
| 57 | /* Owned by this */ |
| 58 | struct ctf_metadata_decoder *decoder; |
| 59 | |
| 60 | /* Owned by this */ |
| 61 | bt_trace_class *trace_class; |
| 62 | |
| 63 | /* Weak (owned by `decoder` above) */ |
| 64 | struct ctf_trace_class *tc; |
| 65 | |
| 66 | /* Owned by this */ |
| 67 | char *text; |
| 68 | |
| 69 | int bo; |
| 70 | }; |
| 71 | |
| 72 | struct ctf_fs_component { |
| 73 | bt_logging_level log_level; |
| 74 | |
| 75 | /* Array of struct ctf_fs_port_data *, owned by this */ |
| 76 | GPtrArray *port_data; |
| 77 | |
| 78 | /* Owned by this */ |
| 79 | struct ctf_fs_trace *trace; |
| 80 | |
| 81 | struct ctf_fs_metadata_config metadata_config; |
| 82 | }; |
| 83 | |
| 84 | struct ctf_fs_trace { |
| 85 | bt_logging_level log_level; |
| 86 | |
| 87 | /* |
| 88 | * Weak. These are mostly used to generate log messages or to append |
| 89 | * error causes. They are mutually exclusive, only one of them must is |
| 90 | * set. |
| 91 | */ |
| 92 | bt_self_component *self_comp; |
| 93 | bt_self_component_class *self_comp_class; |
| 94 | |
| 95 | /* Owned by this */ |
| 96 | struct ctf_fs_metadata *metadata; |
| 97 | |
| 98 | /* Owned by this */ |
| 99 | bt_trace *trace; |
| 100 | |
| 101 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
| 102 | GPtrArray *ds_file_groups; |
| 103 | |
| 104 | /* Owned by this */ |
| 105 | GString *path; |
| 106 | |
| 107 | /* Next automatic stream ID when not provided by packet header */ |
| 108 | uint64_t next_stream_id; |
| 109 | }; |
| 110 | |
| 111 | struct ctf_fs_ds_index_entry { |
| 112 | /* Weak, belongs to ctf_fs_ds_file_info. */ |
| 113 | const char *path; |
| 114 | |
| 115 | /* Position, in bytes, of the packet from the beginning of the file. */ |
| 116 | uint64_t offset; |
| 117 | |
| 118 | /* Size of the packet, in bytes. */ |
| 119 | uint64_t packet_size; |
| 120 | |
| 121 | /* |
| 122 | * Extracted from the packet context, relative to the respective fields' |
| 123 | * mapped clock classes (in cycles). |
| 124 | */ |
| 125 | uint64_t timestamp_begin, timestamp_end; |
| 126 | |
| 127 | /* |
| 128 | * Converted from the packet context, relative to the trace's EPOCH |
| 129 | * (in ns since EPOCH). |
| 130 | */ |
| 131 | int64_t timestamp_begin_ns, timestamp_end_ns; |
| 132 | }; |
| 133 | |
| 134 | struct ctf_fs_ds_index { |
| 135 | /* Array of pointer to struct ctf_fs_fd_index_entry. */ |
| 136 | GPtrArray *entries; |
| 137 | }; |
| 138 | |
| 139 | struct ctf_fs_ds_file_group { |
| 140 | /* |
| 141 | * Array of struct ctf_fs_ds_file_info, owned by this. |
| 142 | * |
| 143 | * This is an _ordered_ array of data stream file infos which |
| 144 | * belong to this group (a single stream instance). |
| 145 | * |
| 146 | * You can call ctf_fs_ds_file_create() with one of those paths |
| 147 | * and the trace IR stream below. |
| 148 | */ |
| 149 | GPtrArray *ds_file_infos; |
| 150 | |
| 151 | /* Owned by this */ |
| 152 | struct ctf_stream_class *sc; |
| 153 | |
| 154 | /* Owned by this */ |
| 155 | bt_stream *stream; |
| 156 | |
| 157 | /* Stream (instance) ID; -1ULL means none */ |
| 158 | uint64_t stream_id; |
| 159 | |
| 160 | /* Weak, belongs to component */ |
| 161 | struct ctf_fs_trace *ctf_fs_trace; |
| 162 | |
| 163 | /* |
| 164 | * Owned by this. May be NULL. |
| 165 | * |
| 166 | * A stream cannot be assumed to be indexed as the indexing might have |
| 167 | * been skipped. Moreover, the index's fields may not all be available |
| 168 | * depending on the producer (e.g. timestamp_begin/end are not |
| 169 | * mandatory). |
| 170 | */ |
| 171 | struct ctf_fs_ds_index *index; |
| 172 | }; |
| 173 | |
| 174 | struct ctf_fs_port_data { |
| 175 | /* Weak, belongs to ctf_fs_trace */ |
| 176 | struct ctf_fs_ds_file_group *ds_file_group; |
| 177 | |
| 178 | /* Weak */ |
| 179 | struct ctf_fs_component *ctf_fs; |
| 180 | }; |
| 181 | |
| 182 | struct ctf_fs_msg_iter_data { |
| 183 | bt_logging_level log_level; |
| 184 | |
| 185 | /* Weak */ |
| 186 | bt_self_component *self_comp; |
| 187 | |
| 188 | /* Weak */ |
| 189 | bt_self_message_iterator *pc_msg_iter; |
| 190 | |
| 191 | /* Weak, belongs to ctf_fs_trace */ |
| 192 | struct ctf_fs_ds_file_group *ds_file_group; |
| 193 | |
| 194 | /* Owned by this */ |
| 195 | struct ctf_fs_ds_file *ds_file; |
| 196 | |
| 197 | /* Which file the iterator is _currently_ operating on */ |
| 198 | size_t ds_file_info_index; |
| 199 | |
| 200 | /* Owned by this */ |
| 201 | struct bt_msg_iter *msg_iter; |
| 202 | }; |
| 203 | |
| 204 | BT_HIDDEN |
| 205 | bt_component_class_initialize_method_status ctf_fs_init( |
| 206 | bt_self_component_source *source, |
| 207 | bt_self_component_source_configuration *config, |
| 208 | const bt_value *params, void *init_method_data); |
| 209 | |
| 210 | BT_HIDDEN |
| 211 | void ctf_fs_finalize(bt_self_component_source *component); |
| 212 | |
| 213 | BT_HIDDEN |
| 214 | bt_component_class_query_method_status ctf_fs_query( |
| 215 | bt_self_component_class_source *comp_class, |
| 216 | bt_private_query_executor *priv_query_exec, |
| 217 | const char *object, const bt_value *params, |
| 218 | void *method_data, const bt_value **result); |
| 219 | |
| 220 | BT_HIDDEN |
| 221 | bt_component_class_message_iterator_initialize_method_status ctf_fs_iterator_init( |
| 222 | bt_self_message_iterator *self_msg_iter, |
| 223 | bt_self_message_iterator_configuration *config, |
| 224 | bt_self_component_source *self_comp, |
| 225 | bt_self_component_port_output *self_port); |
| 226 | |
| 227 | BT_HIDDEN |
| 228 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it); |
| 229 | |
| 230 | BT_HIDDEN |
| 231 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next( |
| 232 | bt_self_message_iterator *iterator, |
| 233 | bt_message_array_const msgs, uint64_t capacity, |
| 234 | uint64_t *count); |
| 235 | |
| 236 | BT_HIDDEN |
| 237 | bt_component_class_message_iterator_seek_beginning_method_status ctf_fs_iterator_seek_beginning( |
| 238 | bt_self_message_iterator *message_iterator); |
| 239 | |
| 240 | /* Create and initialize a new, empty ctf_fs_component. */ |
| 241 | |
| 242 | BT_HIDDEN |
| 243 | struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level, |
| 244 | bt_self_component *self_comp); |
| 245 | |
| 246 | /* |
| 247 | * Create one `struct ctf_fs_trace` from one trace, or multiple traces sharing |
| 248 | * the same UUID. |
| 249 | * |
| 250 | * `paths_value` must be an array of strings, |
| 251 | * |
| 252 | * The created `struct ctf_fs_trace` is assigned to `ctf_fs->trace`. |
| 253 | * |
| 254 | * `self_comp` and `self_comp_class` are used for logging, only one of them |
| 255 | * should be set. |
| 256 | */ |
| 257 | |
| 258 | BT_HIDDEN |
| 259 | int ctf_fs_component_create_ctf_fs_trace( |
| 260 | struct ctf_fs_component *ctf_fs, |
| 261 | const bt_value *paths_value, |
| 262 | const bt_value *trace_name_value, |
| 263 | bt_self_component *self_comp, |
| 264 | bt_self_component_class *self_comp_class); |
| 265 | |
| 266 | /* Free `ctf_fs` and everything it owns. */ |
| 267 | |
| 268 | BT_HIDDEN |
| 269 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs); |
| 270 | |
| 271 | /* |
| 272 | * Read and validate parameters taken by the src.ctf.fs plugin. |
| 273 | * |
| 274 | * - The mandatory `paths` parameter is returned in `*paths`. |
| 275 | * - The optional `clock-class-offset-s` and `clock-class-offset-ns`, if |
| 276 | * present, are recorded in the `ctf_fs` structure. |
| 277 | * - The optional `trace-name` parameter is returned in `*trace_name` if |
| 278 | * present, else `*trace_name` is set to NULL. |
| 279 | * |
| 280 | * `self_comp` and `self_comp_class` are used for logging, only one of them |
| 281 | * should be set. |
| 282 | * |
| 283 | * Return true on success, false if any parameter didn't pass validation. |
| 284 | */ |
| 285 | |
| 286 | BT_HIDDEN |
| 287 | bool read_src_fs_parameters(const bt_value *params, |
| 288 | const bt_value **paths, |
| 289 | const bt_value **trace_name, |
| 290 | struct ctf_fs_component *ctf_fs, |
| 291 | bt_self_component *self_comp, |
| 292 | bt_self_component_class *self_comp_class); |
| 293 | |
| 294 | /* |
| 295 | * Generate the port name to be used for a given data stream file group. |
| 296 | * |
| 297 | * The result must be freed using g_free by the caller. |
| 298 | */ |
| 299 | |
| 300 | BT_HIDDEN |
| 301 | gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group); |
| 302 | |
| 303 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |