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> |
e0831b38 | 33 | #include <babeltrace/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 { | |
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 { | |
7b33a0e0 PP |
52 | /* Owned by this */ |
53 | struct ctf_metadata_decoder *decoder; | |
54 | ||
1a9f7075 | 55 | /* Owned by this */ |
10b7a2e4 | 56 | struct bt_trace_class *trace_class; |
1a9f7075 | 57 | |
7b33a0e0 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 JG |
66 | uint8_t uuid[16]; |
67 | bool is_uuid_set; | |
68 | int bo; | |
56a1cced JG |
69 | }; |
70 | ||
ea0b4b9e | 71 | struct ctf_fs_component { |
94cf822e | 72 | /* Weak, guaranteed to exist */ |
834e9996 | 73 | struct bt_self_component_source *self_comp; |
1a9f7075 PP |
74 | |
75 | /* Array of struct ctf_fs_port_data *, owned by this */ | |
76 | GPtrArray *port_data; | |
77 | ||
78 | /* Array of struct ctf_fs_trace *, owned by this */ | |
79 | GPtrArray *traces; | |
80 | ||
53ac3428 | 81 | struct ctf_fs_metadata_config metadata_config; |
1a9f7075 PP |
82 | }; |
83 | ||
84 | struct ctf_fs_trace { | |
1a9f7075 | 85 | /* Owned by this */ |
5b29e799 | 86 | struct ctf_fs_metadata *metadata; |
1a9f7075 | 87 | |
10b7a2e4 PP |
88 | /* Owned by this */ |
89 | struct bt_trace *trace; | |
90 | ||
94cf822e PP |
91 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
92 | GPtrArray *ds_file_groups; | |
93 | ||
1a9f7075 PP |
94 | /* Owned by this */ |
95 | GString *path; | |
96 | ||
97 | /* Owned by this */ | |
98 | GString *name; | |
8deee039 PP |
99 | |
100 | /* Next automatic stream ID when not provided by packet header */ | |
101 | uint64_t next_stream_id; | |
1a9f7075 PP |
102 | }; |
103 | ||
94cf822e PP |
104 | struct ctf_fs_ds_file_group { |
105 | /* | |
106 | * Array of struct ctf_fs_ds_file_info, owned by this. | |
107 | * | |
108 | * This is an _ordered_ array of data stream file infos which | |
109 | * belong to this group (a single stream instance). | |
110 | * | |
111 | * You can call ctf_fs_ds_file_create() with one of those paths | |
108b91d0 | 112 | * and the trace IR stream below. |
94cf822e PP |
113 | */ |
114 | GPtrArray *ds_file_infos; | |
115 | ||
d09752f8 | 116 | /* Owned by this */ |
78cf9df6 | 117 | struct bt_stream_class *stream_class; |
d09752f8 | 118 | |
1a9f7075 | 119 | /* Owned by this */ |
78cf9df6 | 120 | struct bt_stream *stream; |
1a9f7075 | 121 | |
d09752f8 PP |
122 | /* Stream (instance) ID; -1ULL means none */ |
123 | uint64_t stream_id; | |
124 | ||
94cf822e | 125 | /* Weak, belongs to component */ |
1a9f7075 | 126 | struct ctf_fs_trace *ctf_fs_trace; |
ea0b4b9e JG |
127 | }; |
128 | ||
94cf822e PP |
129 | struct ctf_fs_port_data { |
130 | /* Weak, belongs to ctf_fs_trace */ | |
131 | struct ctf_fs_ds_file_group *ds_file_group; | |
f7c3ac09 PP |
132 | |
133 | /* Weak */ | |
134 | struct ctf_fs_component *ctf_fs; | |
94cf822e PP |
135 | }; |
136 | ||
137 | struct ctf_fs_notif_iter_data { | |
f7c3ac09 | 138 | /* Weak */ |
834e9996 | 139 | struct bt_self_notification_iterator *pc_notif_iter; |
f7c3ac09 | 140 | |
94cf822e PP |
141 | /* Weak, belongs to ctf_fs_trace */ |
142 | struct ctf_fs_ds_file_group *ds_file_group; | |
143 | ||
144 | /* Owned by this */ | |
145 | struct ctf_fs_ds_file *ds_file; | |
146 | ||
147 | /* Which file the iterator is _currently_ operating on */ | |
148 | size_t ds_file_info_index; | |
55fa6491 PP |
149 | |
150 | /* Owned by this */ | |
839d52a5 | 151 | struct bt_notif_iter *notif_iter; |
6ff151ad PP |
152 | |
153 | /* True to skip BT_NOTIFICATION_TYPE_STREAM_BEGIN notifications */ | |
154 | bool skip_stream_begin_notifs; | |
94cf822e PP |
155 | }; |
156 | ||
f3bc2010 | 157 | BT_HIDDEN |
834e9996 PP |
158 | enum bt_self_component_status ctf_fs_init( |
159 | struct bt_self_component_source *source, | |
ce141536 | 160 | const struct bt_value *params, void *init_method_data); |
490db841 | 161 | |
d3e4dcd8 | 162 | BT_HIDDEN |
834e9996 | 163 | void ctf_fs_finalize(struct bt_self_component_source *component); |
d3e4dcd8 | 164 | |
55314f2a | 165 | BT_HIDDEN |
834e9996 PP |
166 | enum bt_query_status ctf_fs_query( |
167 | struct bt_self_component_class_source *comp_class, | |
7b53201c | 168 | const struct bt_query_executor *query_exec, |
ce141536 PP |
169 | const char *object, const struct bt_value *params, |
170 | const struct bt_value **result); | |
55314f2a | 171 | |
97ade20b JG |
172 | BT_HIDDEN |
173 | struct ctf_fs_trace *ctf_fs_trace_create(const char *path, const char *name, | |
9e550e5f | 174 | struct ctf_fs_metadata_config *config); |
97ade20b JG |
175 | |
176 | BT_HIDDEN | |
177 | void ctf_fs_trace_destroy(struct ctf_fs_trace *trace); | |
178 | ||
55314f2a JG |
179 | BT_HIDDEN |
180 | int ctf_fs_find_traces(GList **trace_paths, const char *start_path); | |
181 | ||
182 | BT_HIDDEN | |
183 | GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path); | |
184 | ||
97ade20b | 185 | BT_HIDDEN |
834e9996 PP |
186 | enum bt_self_notification_iterator_status ctf_fs_iterator_init( |
187 | struct bt_self_notification_iterator *self_notif_iter, | |
188 | struct bt_self_component_source *self_comp, | |
189 | struct bt_self_component_port_output *self_port); | |
190 | ||
97ade20b | 191 | BT_HIDDEN |
834e9996 | 192 | void ctf_fs_iterator_finalize(struct bt_self_notification_iterator *it); |
d3eb6e8f | 193 | |
97ade20b | 194 | BT_HIDDEN |
834e9996 PP |
195 | enum bt_self_notification_iterator_status ctf_fs_iterator_next( |
196 | struct bt_self_notification_iterator *iterator, | |
7b53201c | 197 | bt_notification_array_const notifs, uint64_t capacity, |
3fd7b79d | 198 | uint64_t *count); |
d3eb6e8f | 199 | |
541b0a11 | 200 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |