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> |
f3bc2010 | 32 | #include <babeltrace/babeltrace-internal.h> |
9d408fca | 33 | #include <babeltrace/babeltrace.h> |
94cf822e | 34 | #include "data-stream-file.h" |
97ade20b | 35 | #include "metadata.h" |
44c440bc | 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 { | |
1a9f7075 | 42 | /* Owned by this */ |
56a1cced | 43 | GString *path; |
1a9f7075 PP |
44 | |
45 | /* Owned by this */ | |
56a1cced | 46 | FILE *fp; |
1a9f7075 | 47 | |
56a1cced JG |
48 | off_t size; |
49 | }; | |
50 | ||
51 | struct ctf_fs_metadata { | |
44c440bc PP |
52 | /* Owned by this */ |
53 | struct ctf_metadata_decoder *decoder; | |
54 | ||
1a9f7075 | 55 | /* Owned by this */ |
b19ff26f | 56 | bt_trace_class *trace_class; |
1a9f7075 | 57 | |
44c440bc PP |
58 | /* Weak (owned by `decoder` above) */ |
59 | struct ctf_trace_class *tc; | |
60 | ||
61 | /* Owned by this */ | |
62 | ||
1a9f7075 PP |
63 | /* Owned by this */ |
64 | char *text; | |
65 | ||
56a1cced | 66 | int bo; |
56a1cced JG |
67 | }; |
68 | ||
ea0b4b9e | 69 | struct ctf_fs_component { |
94cf822e | 70 | /* Weak, guaranteed to exist */ |
b19ff26f | 71 | bt_self_component_source *self_comp; |
1a9f7075 PP |
72 | |
73 | /* Array of struct ctf_fs_port_data *, owned by this */ | |
74 | GPtrArray *port_data; | |
75 | ||
76 | /* Array of struct ctf_fs_trace *, owned by this */ | |
77 | GPtrArray *traces; | |
78 | ||
a2a54545 | 79 | struct ctf_fs_metadata_config metadata_config; |
1a9f7075 PP |
80 | }; |
81 | ||
82 | struct ctf_fs_trace { | |
1a9f7075 | 83 | /* Owned by this */ |
5b29e799 | 84 | struct ctf_fs_metadata *metadata; |
1a9f7075 | 85 | |
862ca4ed | 86 | /* Owned by this */ |
b19ff26f | 87 | bt_trace *trace; |
862ca4ed | 88 | |
94cf822e PP |
89 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
90 | GPtrArray *ds_file_groups; | |
91 | ||
1a9f7075 PP |
92 | /* Owned by this */ |
93 | GString *path; | |
94 | ||
95 | /* Owned by this */ | |
96 | GString *name; | |
3dca2276 PP |
97 | |
98 | /* Next automatic stream ID when not provided by packet header */ | |
99 | uint64_t next_stream_id; | |
1a9f7075 PP |
100 | }; |
101 | ||
94cf822e PP |
102 | struct ctf_fs_ds_file_group { |
103 | /* | |
104 | * Array of struct ctf_fs_ds_file_info, owned by this. | |
105 | * | |
106 | * This is an _ordered_ array of data stream file infos which | |
107 | * belong to this group (a single stream instance). | |
108 | * | |
109 | * You can call ctf_fs_ds_file_create() with one of those paths | |
56e18c4c | 110 | * and the trace IR stream below. |
94cf822e PP |
111 | */ |
112 | GPtrArray *ds_file_infos; | |
113 | ||
547eacf1 | 114 | /* Owned by this */ |
60363f2f | 115 | struct ctf_stream_class *sc; |
547eacf1 | 116 | |
1a9f7075 | 117 | /* Owned by this */ |
b19ff26f | 118 | bt_stream *stream; |
1a9f7075 | 119 | |
547eacf1 PP |
120 | /* Stream (instance) ID; -1ULL means none */ |
121 | uint64_t stream_id; | |
122 | ||
94cf822e | 123 | /* Weak, belongs to component */ |
1a9f7075 | 124 | struct ctf_fs_trace *ctf_fs_trace; |
ea0b4b9e JG |
125 | }; |
126 | ||
94cf822e PP |
127 | struct ctf_fs_port_data { |
128 | /* Weak, belongs to ctf_fs_trace */ | |
129 | struct ctf_fs_ds_file_group *ds_file_group; | |
5c563278 PP |
130 | |
131 | /* Weak */ | |
132 | struct ctf_fs_component *ctf_fs; | |
94cf822e PP |
133 | }; |
134 | ||
d6e69534 | 135 | struct ctf_fs_msg_iter_data { |
5c563278 | 136 | /* Weak */ |
d6e69534 | 137 | bt_self_message_iterator *pc_msg_iter; |
5c563278 | 138 | |
94cf822e PP |
139 | /* Weak, belongs to ctf_fs_trace */ |
140 | struct ctf_fs_ds_file_group *ds_file_group; | |
141 | ||
142 | /* Owned by this */ | |
143 | struct ctf_fs_ds_file *ds_file; | |
144 | ||
145 | /* Which file the iterator is _currently_ operating on */ | |
146 | size_t ds_file_info_index; | |
6de92955 PP |
147 | |
148 | /* Owned by this */ | |
d6e69534 | 149 | struct bt_msg_iter *msg_iter; |
94cf822e PP |
150 | }; |
151 | ||
f3bc2010 | 152 | BT_HIDDEN |
4cdfc5e8 | 153 | bt_self_component_status ctf_fs_init( |
b19ff26f PP |
154 | bt_self_component_source *source, |
155 | const bt_value *params, void *init_method_data); | |
490db841 | 156 | |
d3e4dcd8 | 157 | BT_HIDDEN |
b19ff26f | 158 | void ctf_fs_finalize(bt_self_component_source *component); |
d3e4dcd8 | 159 | |
55314f2a | 160 | BT_HIDDEN |
4cdfc5e8 | 161 | bt_query_status ctf_fs_query( |
b19ff26f PP |
162 | bt_self_component_class_source *comp_class, |
163 | const bt_query_executor *query_exec, | |
164 | const char *object, const bt_value *params, | |
165 | const bt_value **result); | |
55314f2a | 166 | |
97ade20b | 167 | BT_HIDDEN |
41693723 PP |
168 | struct ctf_fs_trace *ctf_fs_trace_create(bt_self_component_source *self_comp, |
169 | const char *path, const char *name, | |
e5be10ef | 170 | struct ctf_fs_metadata_config *config); |
97ade20b JG |
171 | |
172 | BT_HIDDEN | |
173 | void ctf_fs_trace_destroy(struct ctf_fs_trace *trace); | |
174 | ||
55314f2a JG |
175 | BT_HIDDEN |
176 | int ctf_fs_find_traces(GList **trace_paths, const char *start_path); | |
177 | ||
178 | BT_HIDDEN | |
179 | GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path); | |
180 | ||
97ade20b | 181 | BT_HIDDEN |
4cdfc5e8 | 182 | bt_self_message_iterator_status ctf_fs_iterator_init( |
d6e69534 | 183 | bt_self_message_iterator *self_msg_iter, |
b19ff26f PP |
184 | bt_self_component_source *self_comp, |
185 | bt_self_component_port_output *self_port); | |
d94d92ac | 186 | |
97ade20b | 187 | BT_HIDDEN |
d6e69534 | 188 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it); |
d3eb6e8f | 189 | |
97ade20b | 190 | BT_HIDDEN |
4cdfc5e8 | 191 | bt_self_message_iterator_status ctf_fs_iterator_next( |
d6e69534 PP |
192 | bt_self_message_iterator *iterator, |
193 | bt_message_array_const msgs, uint64_t capacity, | |
d4393e08 | 194 | uint64_t *count); |
d3eb6e8f | 195 | |
6a9bb5e9 PP |
196 | BT_HIDDEN |
197 | bt_self_message_iterator_status ctf_fs_iterator_seek_beginning( | |
198 | bt_self_message_iterator *message_iterator); | |
199 | ||
541b0a11 | 200 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |