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" |
490db841 | 36 | |
78bb6992 MD |
37 | BT_HIDDEN |
38 | extern bool ctf_fs_debug; | |
56a1cced JG |
39 | |
40 | struct ctf_fs_file { | |
94cf822e | 41 | /* Weak, belongs to component */ |
56a1cced | 42 | struct ctf_fs_component *ctf_fs; |
1a9f7075 PP |
43 | |
44 | /* Owned by this */ | |
56a1cced | 45 | GString *path; |
1a9f7075 PP |
46 | |
47 | /* Owned by this */ | |
56a1cced | 48 | FILE *fp; |
1a9f7075 | 49 | |
56a1cced JG |
50 | off_t size; |
51 | }; | |
52 | ||
53 | struct ctf_fs_metadata { | |
1a9f7075 | 54 | /* Owned by this */ |
56a1cced | 55 | struct bt_ctf_trace *trace; |
1a9f7075 PP |
56 | |
57 | /* Owned by this */ | |
58 | char *text; | |
59 | ||
56a1cced JG |
60 | uint8_t uuid[16]; |
61 | bool is_uuid_set; | |
62 | int bo; | |
56a1cced JG |
63 | }; |
64 | ||
94cf822e PP |
65 | struct ctf_fs_ds_file_info { |
66 | GString *path; | |
67 | uint64_t begin_ns; | |
68 | }; | |
69 | ||
70 | struct ctf_fs_ds_file { | |
1a9f7075 | 71 | /* Owned by this */ |
56a1cced | 72 | struct ctf_fs_file *file; |
1a9f7075 PP |
73 | |
74 | /* Owned by this */ | |
56a1cced | 75 | struct bt_ctf_stream *stream; |
1a9f7075 PP |
76 | |
77 | /* Owned by this */ | |
0982a26d | 78 | struct bt_clock_class_priority_map *cc_prio_map; |
1a9f7075 PP |
79 | |
80 | /* Owned by this */ | |
56a1cced | 81 | struct bt_ctf_notif_iter *notif_iter; |
1a9f7075 | 82 | |
b6c3dcb2 JG |
83 | /* A stream is assumed to be indexed. */ |
84 | struct index index; | |
56a1cced | 85 | void *mmap_addr; |
fc9a526c JG |
86 | /* Max length of chunk to mmap() when updating the current mapping. */ |
87 | size_t mmap_max_len; | |
88 | /* Length of the current mapping. */ | |
56a1cced | 89 | size_t mmap_len; |
fc9a526c JG |
90 | /* Length of the current mapping which *exists* in the backing file. */ |
91 | size_t mmap_valid_len; | |
92 | /* Offset in the file where the current mapping starts. */ | |
56a1cced | 93 | off_t mmap_offset; |
fc9a526c JG |
94 | /* |
95 | * Offset, in the current mapping, of the address to return on the next | |
96 | * request. | |
97 | */ | |
56a1cced | 98 | off_t request_offset; |
043e2020 | 99 | bool end_reached; |
56a1cced JG |
100 | }; |
101 | ||
4f1f88a6 | 102 | struct ctf_fs_component_options { |
92540773 JD |
103 | uint64_t clock_offset; |
104 | uint64_t clock_offset_ns; | |
760051fa JG |
105 | }; |
106 | ||
ea0b4b9e | 107 | struct ctf_fs_component { |
94cf822e | 108 | /* Weak, guaranteed to exist */ |
4f1f88a6 | 109 | struct bt_private_component *priv_comp; |
1a9f7075 PP |
110 | |
111 | /* Array of struct ctf_fs_port_data *, owned by this */ | |
112 | GPtrArray *port_data; | |
113 | ||
114 | /* Array of struct ctf_fs_trace *, owned by this */ | |
115 | GPtrArray *traces; | |
116 | ||
117 | struct ctf_fs_component_options options; | |
56a1cced JG |
118 | FILE *error_fp; |
119 | size_t page_size; | |
1a9f7075 PP |
120 | }; |
121 | ||
122 | struct ctf_fs_trace { | |
94cf822e | 123 | /* Weak, belongs to component */ |
1a9f7075 PP |
124 | struct ctf_fs_component *ctf_fs; |
125 | ||
126 | /* Owned by this */ | |
5b29e799 | 127 | struct ctf_fs_metadata *metadata; |
1a9f7075 PP |
128 | |
129 | /* Owned by this */ | |
599faa1c | 130 | struct bt_clock_class_priority_map *cc_prio_map; |
4f1f88a6 | 131 | |
94cf822e PP |
132 | /* Array of struct ctf_fs_ds_file_group *, owned by this */ |
133 | GPtrArray *ds_file_groups; | |
134 | ||
1a9f7075 PP |
135 | /* Owned by this */ |
136 | GString *path; | |
137 | ||
138 | /* Owned by this */ | |
139 | GString *name; | |
140 | }; | |
141 | ||
94cf822e PP |
142 | struct ctf_fs_ds_file_group { |
143 | /* | |
144 | * Array of struct ctf_fs_ds_file_info, owned by this. | |
145 | * | |
146 | * This is an _ordered_ array of data stream file infos which | |
147 | * belong to this group (a single stream instance). | |
148 | * | |
149 | * You can call ctf_fs_ds_file_create() with one of those paths | |
150 | * and the CTF IR stream below. | |
151 | */ | |
152 | GPtrArray *ds_file_infos; | |
153 | ||
1a9f7075 | 154 | /* Owned by this */ |
94cf822e | 155 | struct bt_ctf_stream *stream; |
1a9f7075 | 156 | |
94cf822e | 157 | /* Weak, belongs to component */ |
1a9f7075 | 158 | struct ctf_fs_trace *ctf_fs_trace; |
ea0b4b9e JG |
159 | }; |
160 | ||
94cf822e PP |
161 | struct ctf_fs_port_data { |
162 | /* Weak, belongs to ctf_fs_trace */ | |
163 | struct ctf_fs_ds_file_group *ds_file_group; | |
164 | }; | |
165 | ||
166 | struct ctf_fs_notif_iter_data { | |
167 | /* Weak, belongs to ctf_fs_trace */ | |
168 | struct ctf_fs_ds_file_group *ds_file_group; | |
169 | ||
170 | /* Owned by this */ | |
171 | struct ctf_fs_ds_file *ds_file; | |
172 | ||
173 | /* Which file the iterator is _currently_ operating on */ | |
174 | size_t ds_file_info_index; | |
175 | }; | |
176 | ||
f3bc2010 | 177 | BT_HIDDEN |
890882ef | 178 | enum bt_component_status ctf_fs_init(struct bt_private_component *source, |
6358c163 | 179 | struct bt_value *params, void *init_method_data); |
490db841 | 180 | |
d3e4dcd8 | 181 | BT_HIDDEN |
64cadc66 | 182 | void ctf_fs_finalize(struct bt_private_component *component); |
d3e4dcd8 PP |
183 | |
184 | BT_HIDDEN | |
d3eb6e8f | 185 | enum bt_notification_iterator_status ctf_fs_iterator_init( |
91457551 PP |
186 | struct bt_private_notification_iterator *it, |
187 | struct bt_private_port *port); | |
d3e4dcd8 | 188 | |
64cadc66 | 189 | void ctf_fs_iterator_finalize(struct bt_private_notification_iterator *it); |
d3eb6e8f | 190 | |
41a2b7ae | 191 | struct bt_notification_iterator_next_return ctf_fs_iterator_next( |
890882ef | 192 | struct bt_private_notification_iterator *iterator); |
d3eb6e8f | 193 | |
33f93973 | 194 | BT_HIDDEN |
a67681c1 PP |
195 | struct bt_value *ctf_fs_query(struct bt_component_class *comp_class, |
196 | const char *object, struct bt_value *params); | |
33f93973 | 197 | |
541b0a11 | 198 | #endif /* BABELTRACE_PLUGIN_CTF_FS_H */ |