Commit | Line | Data |
---|---|---|
14f28187 FD |
1 | #ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H |
2 | #define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H | |
3 | ||
4 | /* | |
5 | * BabelTrace - LTTng-live client Component | |
6 | * | |
7 | * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com> | |
8 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
10 | * | |
11 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
12 | * | |
13 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
14 | * of this software and associated documentation files (the "Software"), to deal | |
15 | * in the Software without restriction, including without limitation the rights | |
16 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
17 | * copies of the Software, and to permit persons to whom the Software is | |
18 | * furnished to do so, subject to the following conditions: | |
19 | * | |
20 | * The above copyright notice and this permission notice shall be included in | |
21 | * all copies or substantial portions of the Software. | |
22 | * | |
23 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
24 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
25 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
26 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
27 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
28 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
29 | * SOFTWARE. | |
30 | */ | |
31 | ||
32 | #include <stdbool.h> | |
33 | ||
34 | #include <babeltrace/babeltrace-internal.h> | |
35 | #include <babeltrace/babeltrace.h> | |
36 | ||
37 | #include "../common/metadata/decoder.h" | |
38 | #include "../common/msg-iter/msg-iter.h" | |
39 | ||
40 | #include "viewer-connection.h" | |
41 | ||
42 | struct lttng_live_component; | |
43 | struct lttng_live_session; | |
44 | struct lttng_live_msg_iter; | |
45 | ||
46 | enum lttng_live_stream_state { | |
47 | /* This stream won't have data until some known time in the future. */ | |
48 | LTTNG_LIVE_STREAM_QUIESCENT, | |
49 | /* | |
50 | * This stream won't have data until some known time in the future and | |
51 | * the message iterator inactivity message was already sent downstream. | |
52 | */ | |
53 | LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */ | |
54 | /* This stream has data ready to be consumed. */ | |
55 | LTTNG_LIVE_STREAM_ACTIVE_DATA, | |
56 | /* | |
57 | * This stream has no data left to consume. We should asked the relay | |
58 | * for more. | |
59 | */ | |
60 | LTTNG_LIVE_STREAM_ACTIVE_NO_DATA, | |
61 | /* This stream won't have anymore data, ever. */ | |
62 | LTTNG_LIVE_STREAM_EOF, | |
63 | }; | |
64 | ||
65 | /* Iterator over a live stream. */ | |
66 | struct lttng_live_stream_iterator { | |
67 | /* Owned by this. */ | |
68 | bt_stream *stream; | |
69 | ||
70 | /* Weak reference. */ | |
71 | struct lttng_live_trace *trace; | |
72 | ||
73 | /* | |
74 | * Since only a single iterator per viewer connection, we have | |
75 | * only a single message iterator per stream. | |
76 | */ | |
77 | struct bt_msg_iter *msg_iter; | |
78 | ||
79 | uint64_t viewer_stream_id; | |
80 | ||
81 | uint64_t ctf_stream_class_id; | |
82 | ||
83 | /* base offset in current index. */ | |
84 | uint64_t base_offset; | |
85 | /* len to read in current index. */ | |
86 | uint64_t len; | |
87 | /* offset in current index. */ | |
88 | uint64_t offset; | |
89 | ||
90 | /* | |
91 | * Clock Snapshot value of the last message iterator inactivity message | |
92 | * sent downstream. | |
93 | */ | |
94 | uint64_t last_inactivity_ts; | |
95 | ||
96 | /* | |
97 | * Clock Snapshot value of the current message iterator inactivity | |
98 | * message we might want to send downstream. | |
99 | */ | |
100 | uint64_t current_inactivity_ts; | |
101 | ||
102 | enum lttng_live_stream_state state; | |
103 | ||
104 | /* | |
105 | * The current message produced by this live stream iterator. Owned by | |
106 | * this. | |
107 | */ | |
108 | bt_message *current_msg; | |
109 | ||
110 | /* Timestamp in nanoseconds of the current message (current_msg). */ | |
111 | int64_t current_msg_ts_ns; | |
112 | ||
113 | /* Owned by this. */ | |
114 | uint8_t *buf; | |
115 | size_t buflen; | |
116 | ||
117 | /* Owned by this. */ | |
118 | GString *name; | |
119 | }; | |
120 | ||
121 | struct lttng_live_metadata { | |
122 | /* Weak reference. */ | |
123 | struct lttng_live_trace *trace; | |
124 | ||
125 | uint64_t stream_id; | |
126 | /* Weak reference. */ | |
127 | struct ctf_metadata_decoder *decoder; | |
128 | ||
129 | bool closed; | |
130 | }; | |
131 | ||
132 | struct lttng_live_trace { | |
133 | /* Back reference to session. */ | |
134 | struct lttng_live_session *session; | |
135 | ||
136 | /* ctf trace ID within the session. */ | |
137 | uint64_t id; | |
138 | ||
139 | /* Owned by this. */ | |
140 | bt_trace *trace; | |
141 | ||
142 | /* Weak reference. */ | |
143 | bt_trace_class *trace_class; | |
144 | ||
145 | struct lttng_live_metadata *metadata; | |
146 | ||
147 | const bt_clock_class *clock_class; | |
148 | ||
149 | /* Array of pointers to struct lttng_live_stream_iterator. */ | |
150 | /* Owned by this. */ | |
151 | GPtrArray *stream_iterators; | |
152 | ||
153 | bool new_metadata_needed; | |
154 | }; | |
155 | ||
156 | struct lttng_live_session { | |
157 | /* Weak reference. */ | |
158 | struct lttng_live_msg_iter *lttng_live_msg_iter; | |
159 | ||
160 | /* Owned by this. */ | |
161 | GString *hostname; | |
162 | ||
163 | /* Owned by this. */ | |
164 | GString *session_name; | |
165 | ||
166 | uint64_t id; | |
167 | ||
168 | /* Array of pointers to struct lttng_live_trace. */ | |
169 | GPtrArray *traces; | |
170 | ||
171 | bool attached; | |
172 | bool new_streams_needed; | |
173 | bool lazy_stream_msg_init; | |
174 | bool closed; | |
175 | }; | |
176 | ||
177 | enum session_not_found_action { | |
178 | SESSION_NOT_FOUND_ACTION_CONTINUE, | |
179 | SESSION_NOT_FOUND_ACTION_FAIL, | |
180 | SESSION_NOT_FOUND_ACTION_END, | |
181 | }; | |
182 | ||
183 | /* | |
184 | * A component instance is an iterator on a single session. | |
185 | */ | |
186 | struct lttng_live_component { | |
187 | /* Weak reference. */ | |
188 | bt_self_component_source *self_comp; | |
189 | ||
190 | struct { | |
191 | GString *url; | |
192 | enum session_not_found_action sess_not_found_act; | |
193 | } params; | |
194 | ||
195 | size_t max_query_size; | |
196 | ||
197 | /* | |
198 | * Keeps track of whether the downstream component already has a | |
199 | * message iterator on this component. | |
200 | */ | |
201 | bool has_msg_iter; | |
202 | }; | |
203 | ||
204 | struct lttng_live_msg_iter { | |
205 | /* Weak reference. */ | |
206 | struct lttng_live_component *lttng_live_comp; | |
207 | ||
208 | /* Weak reference. */ | |
209 | bt_self_message_iterator *self_msg_iter; | |
210 | ||
211 | /* Owned by this. */ | |
212 | struct live_viewer_connection *viewer_connection; | |
213 | ||
214 | /* Array of pointers to struct lttng_live_session. */ | |
215 | GPtrArray *sessions; | |
216 | ||
217 | /* Number of live stream iterator this message iterator has.*/ | |
218 | uint64_t active_stream_iter; | |
219 | ||
220 | /* Timestamp in nanosecond of the last message sent downstream. */ | |
221 | int64_t last_msg_ts_ns; | |
222 | }; | |
223 | ||
224 | enum lttng_live_iterator_status { | |
225 | /** Iterator state has progressed. Continue iteration immediately. */ | |
226 | LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3, | |
227 | /** No message available for now. Try again later. */ | |
228 | LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2, | |
229 | /** No more CTF_LTTNG_LIVEs to be delivered. */ | |
230 | LTTNG_LIVE_ITERATOR_STATUS_END = 1, | |
231 | /** No error, okay. */ | |
232 | LTTNG_LIVE_ITERATOR_STATUS_OK = 0, | |
233 | /** Invalid arguments. */ | |
234 | LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1, | |
235 | /** General error. */ | |
236 | LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2, | |
237 | /** Out of memory. */ | |
238 | LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3, | |
239 | /** Unsupported iterator feature. */ | |
240 | LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4, | |
241 | }; | |
242 | ||
243 | bt_self_component_status lttng_live_component_init( | |
244 | bt_self_component_source *self_comp, | |
245 | const bt_value *params, void *init_method_data); | |
246 | ||
247 | bt_query_status lttng_live_query( | |
248 | bt_self_component_class_source *comp_class, | |
249 | const bt_query_executor *query_exec, | |
250 | const char *object, const bt_value *params, | |
251 | const bt_value **result); | |
252 | ||
253 | void lttng_live_component_finalize(bt_self_component_source *component); | |
254 | ||
255 | bt_self_message_iterator_status lttng_live_msg_iter_next( | |
256 | bt_self_message_iterator *iterator, | |
257 | bt_message_array_const msgs, uint64_t capacity, | |
258 | uint64_t *count); | |
259 | ||
260 | bt_self_message_iterator_status lttng_live_msg_iter_init( | |
261 | bt_self_message_iterator *self_msg_it, | |
262 | bt_self_component_source *self_comp, | |
263 | bt_self_component_port_output *self_port); | |
264 | ||
265 | void lttng_live_msg_iter_finalize(bt_self_message_iterator *it); | |
266 | ||
267 | int lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter); | |
268 | int lttng_live_attach_session(struct lttng_live_session *session); | |
269 | int lttng_live_detach_session(struct lttng_live_session *session); | |
270 | enum lttng_live_iterator_status lttng_live_get_new_streams( | |
271 | struct lttng_live_session *session); | |
272 | ||
273 | int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
274 | uint64_t session_id, | |
275 | const char *hostname, | |
276 | const char *session_name); | |
277 | ||
278 | ssize_t lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, | |
279 | FILE *fp); | |
280 | enum lttng_live_iterator_status lttng_live_get_next_index( | |
281 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
282 | struct lttng_live_stream_iterator *stream, | |
283 | struct packet_index *index); | |
284 | ||
285 | enum bt_msg_iter_medium_status lttng_live_get_stream_bytes( | |
286 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
287 | struct lttng_live_stream_iterator *stream, uint8_t *buf, | |
288 | uint64_t offset, uint64_t req_len, uint64_t *recv_len); | |
289 | void lttng_live_add_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
290 | struct lttng_live_stream_iterator *stream_iter); | |
291 | void lttng_live_remove_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
292 | struct lttng_live_stream_iterator *stream_iter); | |
293 | ||
294 | struct lttng_live_trace *lttng_live_borrow_trace( | |
295 | struct lttng_live_session *session, uint64_t trace_id); | |
296 | void lttng_live_need_new_streams(struct lttng_live_msg_iter *lttng_live_msg_iter); | |
297 | ||
298 | bool lttng_live_is_canceled(struct lttng_live_component *lttng_live); | |
299 | ||
300 | #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */ |