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> |
b2e0c907 | 33 | #include <babeltrace/graph/component.h> |
599faa1c | 34 | #include <babeltrace/graph/clock-class-priority-map.h> |
94cf822e | 35 | #include "data-stream-file.h" |
97ade20b | 36 | #include "metadata.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 { | |
1a9f7075 | 52 | /* Owned by this */ |
56a1cced | 53 | struct bt_ctf_trace *trace; |
1a9f7075 PP |
54 | |
55 | /* Owned by this */ | |
56 | char *text; | |
57 | ||
56a1cced JG |
58 | uint8_t uuid[16]; |
59 | bool is_uuid_set; | |
60 | int bo; | |
56a1cced JG |
61 | }; |
62 | ||
ea0b4b9e | 63 | struct ctf_fs_component { |
94cf822e | 64 | /* Weak, guaranteed to exist */ |
4f1f88a6 | 65 | struct bt_private_component *priv_comp; |
1a9f7075 PP |
66 | |
67 | /* Array of struct ctf_fs_port_data *, owned by this */ | |
68 | GPtrArray *port_data; | |
69 | ||
70 | /* Array of struct ctf_fs_trace *, owned by this */ | |
71 | GPtrArray *traces; | |
72 | ||
a2a54545 | 73 | struct ctf_fs_metadata_config metadata_config; |
1a9f7075 PP |
74 | }; |
75 | ||
76 | struct ctf_fs_trace { | |
1a9f7075 | 77 | /* Owned by this */ |
5b29e799 | 78 | struct ctf_fs_metadata *metadata; |
1a9f7075 PP |
79 | |
80 | /* Owned by this */ | |
599faa1c | 81 | struct bt_clock_class_priority_map *cc_prio_map; |
4f1f88a6 | 82 | |
94cf822e PP |
83 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
84 | GPtrArray *ds_file_groups; | |
85 | ||
1a9f7075 PP |
86 | /* Owned by this */ |
87 | GString *path; | |
88 | ||
89 | /* Owned by this */ | |
90 | GString *name; | |
91 | }; | |
92 | ||
94cf822e PP |
93 | struct ctf_fs_ds_file_group { |
94 | /* | |
95 | * Array of struct ctf_fs_ds_file_info, owned by this. | |
96 | * | |
97 | * This is an _ordered_ array of data stream file infos which | |
98 | * belong to this group (a single stream instance). | |
99 | * | |
100 | * You can call ctf_fs_ds_file_create() with one of those paths | |
101 | * and the CTF IR stream below. | |
102 | */ | |
103 | GPtrArray *ds_file_infos; | |
104 | ||
547eacf1 PP |
105 | /* Owned by this */ |
106 | struct bt_ctf_stream_class *stream_class; | |
107 | ||
1a9f7075 | 108 | /* Owned by this */ |
94cf822e | 109 | struct bt_ctf_stream *stream; |
1a9f7075 | 110 | |
547eacf1 PP |
111 | /* Stream (instance) ID; -1ULL means none */ |
112 | uint64_t stream_id; | |
113 | ||
94cf822e | 114 | /* Weak, belongs to component */ |
1a9f7075 | 115 | struct ctf_fs_trace *ctf_fs_trace; |
ea0b4b9e JG |
116 | }; |
117 | ||
94cf822e PP |
118 | struct ctf_fs_port_data { |
119 | /* Weak, belongs to ctf_fs_trace */ | |
120 | struct ctf_fs_ds_file_group *ds_file_group; | |
121 | }; | |
122 | ||
123 | struct ctf_fs_notif_iter_data { | |
124 | /* Weak, belongs to ctf_fs_trace */ | |
125 | struct ctf_fs_ds_file_group *ds_file_group; | |
126 | ||
127 | /* Owned by this */ | |
128 | struct ctf_fs_ds_file *ds_file; | |
129 | ||
130 | /* Which file the iterator is _currently_ operating on */ | |
131 | size_t ds_file_info_index; | |
6de92955 PP |
132 | |
133 | /* Owned by this */ | |
134 | struct bt_ctf_notif_iter *notif_iter; | |
94cf822e PP |
135 | }; |
136 | ||
f3bc2010 | 137 | BT_HIDDEN |
890882ef | 138 | enum bt_component_status ctf_fs_init(struct bt_private_component *source, |
6358c163 | 139 | struct bt_value *params, void *init_method_data); |
490db841 | 140 | |
d3e4dcd8 | 141 | BT_HIDDEN |
64cadc66 | 142 | void ctf_fs_finalize(struct bt_private_component *component); |
d3e4dcd8 | 143 | |
55314f2a JG |
144 | BT_HIDDEN |
145 | struct bt_value *ctf_fs_query(struct bt_component_class *comp_class, | |
146 | const char *object, struct bt_value *params); | |
147 | ||
97ade20b JG |
148 | BT_HIDDEN |
149 | struct ctf_fs_trace *ctf_fs_trace_create(const char *path, const char *name, | |
a2a54545 | 150 | struct ctf_fs_metadata_config *config); |
97ade20b JG |
151 | |
152 | BT_HIDDEN | |
153 | void ctf_fs_trace_destroy(struct ctf_fs_trace *trace); | |
154 | ||
55314f2a JG |
155 | BT_HIDDEN |
156 | int ctf_fs_find_traces(GList **trace_paths, const char *start_path); | |
157 | ||
158 | BT_HIDDEN | |
159 | GList *ctf_fs_create_trace_names(GList *trace_paths, const char *base_path); | |
160 | ||
97ade20b JG |
161 | BT_HIDDEN |
162 | enum bt_notification_iterator_status ctf_fs_iterator_init( | |
163 | struct bt_private_notification_iterator *it, | |
164 | struct bt_private_port *port); | |
165 | BT_HIDDEN | |
64cadc66 | 166 | void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it); |
d3eb6e8f | 167 | |
97ade20b | 168 | BT_HIDDEN |
41a2b7ae | 169 | struct bt_notification_iterator_next_return ctf_fs_iterator_next( |
890882ef | 170 | struct bt_private_notification_iterator *iterator); |
d3eb6e8f | 171 | |
541b0a11 | 172 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |