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> | |
3c22a242 FD |
33 | #include <stdint.h> |
34 | ||
35 | #include <glib.h> | |
14f28187 | 36 | |
3fadfbc0 | 37 | #include <babeltrace2/babeltrace.h> |
14f28187 | 38 | |
3c22a242 | 39 | #include "common/macros.h" |
14f28187 FD |
40 | #include "../common/metadata/decoder.h" |
41 | #include "../common/msg-iter/msg-iter.h" | |
14f28187 FD |
42 | #include "viewer-connection.h" |
43 | ||
44 | struct lttng_live_component; | |
45 | struct lttng_live_session; | |
46 | struct lttng_live_msg_iter; | |
47 | ||
48 | enum lttng_live_stream_state { | |
49 | /* This stream won't have data until some known time in the future. */ | |
50 | LTTNG_LIVE_STREAM_QUIESCENT, | |
51 | /* | |
52 | * This stream won't have data until some known time in the future and | |
53 | * the message iterator inactivity message was already sent downstream. | |
54 | */ | |
55 | LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */ | |
56 | /* This stream has data ready to be consumed. */ | |
57 | LTTNG_LIVE_STREAM_ACTIVE_DATA, | |
58 | /* | |
59 | * This stream has no data left to consume. We should asked the relay | |
60 | * for more. | |
61 | */ | |
62 | LTTNG_LIVE_STREAM_ACTIVE_NO_DATA, | |
63 | /* This stream won't have anymore data, ever. */ | |
64 | LTTNG_LIVE_STREAM_EOF, | |
65 | }; | |
66 | ||
67 | /* Iterator over a live stream. */ | |
68 | struct lttng_live_stream_iterator { | |
c01594de | 69 | bt_logging_level log_level; |
2ece7dd0 | 70 | bt_self_component *self_comp; |
c01594de | 71 | |
14f28187 FD |
72 | /* Owned by this. */ |
73 | bt_stream *stream; | |
74 | ||
75 | /* Weak reference. */ | |
76 | struct lttng_live_trace *trace; | |
77 | ||
78 | /* | |
79 | * Since only a single iterator per viewer connection, we have | |
80 | * only a single message iterator per stream. | |
81 | */ | |
18a1979b | 82 | struct ctf_msg_iter *msg_iter; |
14f28187 FD |
83 | |
84 | uint64_t viewer_stream_id; | |
85 | ||
86 | uint64_t ctf_stream_class_id; | |
87 | ||
88 | /* base offset in current index. */ | |
89 | uint64_t base_offset; | |
90 | /* len to read in current index. */ | |
91 | uint64_t len; | |
92 | /* offset in current index. */ | |
93 | uint64_t offset; | |
94 | ||
95 | /* | |
96 | * Clock Snapshot value of the last message iterator inactivity message | |
97 | * sent downstream. | |
98 | */ | |
99 | uint64_t last_inactivity_ts; | |
100 | ||
101 | /* | |
102 | * Clock Snapshot value of the current message iterator inactivity | |
103 | * message we might want to send downstream. | |
104 | */ | |
105 | uint64_t current_inactivity_ts; | |
106 | ||
107 | enum lttng_live_stream_state state; | |
108 | ||
109 | /* | |
110 | * The current message produced by this live stream iterator. Owned by | |
111 | * this. | |
112 | */ | |
113 | bt_message *current_msg; | |
114 | ||
115 | /* Timestamp in nanoseconds of the current message (current_msg). */ | |
116 | int64_t current_msg_ts_ns; | |
117 | ||
118 | /* Owned by this. */ | |
119 | uint8_t *buf; | |
120 | size_t buflen; | |
121 | ||
122 | /* Owned by this. */ | |
123 | GString *name; | |
4a39caef FD |
124 | |
125 | bool has_stream_hung_up; | |
14f28187 FD |
126 | }; |
127 | ||
128 | struct lttng_live_metadata { | |
c01594de | 129 | bt_logging_level log_level; |
2ece7dd0 | 130 | bt_self_component *self_comp; |
c01594de | 131 | |
14f28187 FD |
132 | /* Weak reference. */ |
133 | struct lttng_live_trace *trace; | |
134 | ||
135 | uint64_t stream_id; | |
136 | /* Weak reference. */ | |
137 | struct ctf_metadata_decoder *decoder; | |
14f28187 FD |
138 | }; |
139 | ||
140 | struct lttng_live_trace { | |
c01594de | 141 | bt_logging_level log_level; |
2ece7dd0 | 142 | bt_self_component *self_comp; |
c01594de | 143 | |
14f28187 FD |
144 | /* Back reference to session. */ |
145 | struct lttng_live_session *session; | |
146 | ||
147 | /* ctf trace ID within the session. */ | |
148 | uint64_t id; | |
149 | ||
150 | /* Owned by this. */ | |
151 | bt_trace *trace; | |
152 | ||
153 | /* Weak reference. */ | |
154 | bt_trace_class *trace_class; | |
155 | ||
156 | struct lttng_live_metadata *metadata; | |
157 | ||
158 | const bt_clock_class *clock_class; | |
159 | ||
160 | /* Array of pointers to struct lttng_live_stream_iterator. */ | |
161 | /* Owned by this. */ | |
162 | GPtrArray *stream_iterators; | |
163 | ||
164 | bool new_metadata_needed; | |
165 | }; | |
166 | ||
167 | struct lttng_live_session { | |
c01594de | 168 | bt_logging_level log_level; |
2ece7dd0 | 169 | bt_self_component *self_comp; |
c01594de | 170 | |
14f28187 FD |
171 | /* Weak reference. */ |
172 | struct lttng_live_msg_iter *lttng_live_msg_iter; | |
173 | ||
174 | /* Owned by this. */ | |
175 | GString *hostname; | |
176 | ||
177 | /* Owned by this. */ | |
178 | GString *session_name; | |
179 | ||
180 | uint64_t id; | |
181 | ||
182 | /* Array of pointers to struct lttng_live_trace. */ | |
183 | GPtrArray *traces; | |
184 | ||
185 | bool attached; | |
186 | bool new_streams_needed; | |
187 | bool lazy_stream_msg_init; | |
188 | bool closed; | |
189 | }; | |
190 | ||
191 | enum session_not_found_action { | |
192 | SESSION_NOT_FOUND_ACTION_CONTINUE, | |
193 | SESSION_NOT_FOUND_ACTION_FAIL, | |
194 | SESSION_NOT_FOUND_ACTION_END, | |
195 | }; | |
196 | ||
197 | /* | |
198 | * A component instance is an iterator on a single session. | |
199 | */ | |
200 | struct lttng_live_component { | |
c01594de PP |
201 | bt_logging_level log_level; |
202 | ||
14f28187 | 203 | /* Weak reference. */ |
2ece7dd0 | 204 | bt_self_component *self_comp; |
14f28187 FD |
205 | |
206 | struct { | |
207 | GString *url; | |
208 | enum session_not_found_action sess_not_found_act; | |
209 | } params; | |
210 | ||
211 | size_t max_query_size; | |
212 | ||
213 | /* | |
214 | * Keeps track of whether the downstream component already has a | |
215 | * message iterator on this component. | |
216 | */ | |
217 | bool has_msg_iter; | |
218 | }; | |
219 | ||
220 | struct lttng_live_msg_iter { | |
c01594de | 221 | bt_logging_level log_level; |
2ece7dd0 | 222 | bt_self_component *self_comp; |
c01594de | 223 | |
14f28187 FD |
224 | /* Weak reference. */ |
225 | struct lttng_live_component *lttng_live_comp; | |
226 | ||
227 | /* Weak reference. */ | |
228 | bt_self_message_iterator *self_msg_iter; | |
229 | ||
230 | /* Owned by this. */ | |
231 | struct live_viewer_connection *viewer_connection; | |
232 | ||
233 | /* Array of pointers to struct lttng_live_session. */ | |
234 | GPtrArray *sessions; | |
235 | ||
236 | /* Number of live stream iterator this message iterator has.*/ | |
237 | uint64_t active_stream_iter; | |
238 | ||
239 | /* Timestamp in nanosecond of the last message sent downstream. */ | |
240 | int64_t last_msg_ts_ns; | |
241 | }; | |
242 | ||
243 | enum lttng_live_iterator_status { | |
244 | /** Iterator state has progressed. Continue iteration immediately. */ | |
245 | LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3, | |
246 | /** No message available for now. Try again later. */ | |
247 | LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2, | |
248 | /** No more CTF_LTTNG_LIVEs to be delivered. */ | |
249 | LTTNG_LIVE_ITERATOR_STATUS_END = 1, | |
250 | /** No error, okay. */ | |
251 | LTTNG_LIVE_ITERATOR_STATUS_OK = 0, | |
252 | /** Invalid arguments. */ | |
253 | LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1, | |
254 | /** General error. */ | |
255 | LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2, | |
256 | /** Out of memory. */ | |
257 | LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3, | |
258 | /** Unsupported iterator feature. */ | |
259 | LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4, | |
260 | }; | |
261 | ||
21a9f056 | 262 | bt_component_class_initialize_method_status lttng_live_component_init( |
14f28187 | 263 | bt_self_component_source *self_comp, |
59225a3e | 264 | bt_self_component_source_configuration *config, |
14f28187 FD |
265 | const bt_value *params, void *init_method_data); |
266 | ||
d24d5663 | 267 | bt_component_class_query_method_status lttng_live_query( |
14f28187 | 268 | bt_self_component_class_source *comp_class, |
3c729b9a | 269 | bt_private_query_executor *priv_query_exec, |
14f28187 | 270 | const char *object, const bt_value *params, |
7c14d641 | 271 | void *method_data, const bt_value **result); |
14f28187 FD |
272 | |
273 | void lttng_live_component_finalize(bt_self_component_source *component); | |
274 | ||
d24d5663 | 275 | bt_component_class_message_iterator_next_method_status lttng_live_msg_iter_next( |
14f28187 FD |
276 | bt_self_message_iterator *iterator, |
277 | bt_message_array_const msgs, uint64_t capacity, | |
278 | uint64_t *count); | |
279 | ||
21a9f056 | 280 | bt_component_class_message_iterator_initialize_method_status lttng_live_msg_iter_init( |
14f28187 | 281 | bt_self_message_iterator *self_msg_it, |
8d8b141d | 282 | bt_self_message_iterator_configuration *config, |
14f28187 FD |
283 | bt_self_component_source *self_comp, |
284 | bt_self_component_port_output *self_port); | |
285 | ||
286 | void lttng_live_msg_iter_finalize(bt_self_message_iterator *it); | |
287 | ||
288 | int lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter); | |
eee8e741 FD |
289 | |
290 | enum lttng_live_attach_session_status { | |
291 | LTTNG_LIVE_ATTACH_SESSION_STATUS_OK = 0, | |
292 | LTTNG_LIVE_ATTACH_SESSION_STATUS_ERROR = -2, | |
293 | }; | |
294 | ||
295 | enum lttng_live_attach_session_status lttng_live_attach_session( | |
851de941 SM |
296 | struct lttng_live_session *session, |
297 | bt_self_message_iterator *self_msg_iter); | |
eee8e741 | 298 | |
14f28187 FD |
299 | int lttng_live_detach_session(struct lttng_live_session *session); |
300 | enum lttng_live_iterator_status lttng_live_get_new_streams( | |
851de941 SM |
301 | struct lttng_live_session *session, |
302 | bt_self_message_iterator *self_msg_iter); | |
14f28187 FD |
303 | |
304 | int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
305 | uint64_t session_id, | |
306 | const char *hostname, | |
307 | const char *session_name); | |
308 | ||
c28512ab FD |
309 | enum lttng_live_get_one_metadata_status { |
310 | /* The end of the metadata stream was reached. */ | |
311 | LTTNG_LIVE_GET_ONE_METADATA_STATUS_END = 1, | |
312 | /* One metadata packet was received and written to file. */ | |
313 | LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK = 0, | |
314 | /* The metadata stream was not found on the relay. */ | |
315 | LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED = -1, | |
316 | /* | |
317 | * A critical error occurred when contacting the relay or while | |
318 | * handling its response. | |
319 | */ | |
320 | LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR = -2, | |
321 | }; | |
322 | ||
323 | /* | |
324 | * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata. | |
325 | * If new metadata is received, the function writes it to the provided file | |
326 | * handle and updates the reply_len output parameter. This function should be | |
327 | * called in loop until _END status is received to ensure all metadata is | |
328 | * written to the file. | |
329 | */ | |
330 | enum lttng_live_get_one_metadata_status lttng_live_get_one_metadata_packet( | |
331 | struct lttng_live_trace *trace, FILE *fp, size_t *reply_len); | |
332 | ||
14f28187 FD |
333 | enum lttng_live_iterator_status lttng_live_get_next_index( |
334 | struct lttng_live_msg_iter *lttng_live_msg_iter, | |
335 | struct lttng_live_stream_iterator *stream, | |
336 | struct packet_index *index); | |
337 | ||
18a1979b | 338 | enum ctf_msg_iter_medium_status lttng_live_get_stream_bytes( |
14f28187 FD |
339 | struct lttng_live_msg_iter *lttng_live_msg_iter, |
340 | struct lttng_live_stream_iterator *stream, uint8_t *buf, | |
341 | uint64_t offset, uint64_t req_len, uint64_t *recv_len); | |
342 | void lttng_live_add_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
343 | struct lttng_live_stream_iterator *stream_iter); | |
344 | void lttng_live_remove_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
345 | struct lttng_live_stream_iterator *stream_iter); | |
346 | ||
347 | struct lttng_live_trace *lttng_live_borrow_trace( | |
348 | struct lttng_live_session *session, uint64_t trace_id); | |
349 | void lttng_live_need_new_streams(struct lttng_live_msg_iter *lttng_live_msg_iter); | |
350 | ||
9b4f9b42 | 351 | bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter); |
14f28187 FD |
352 | |
353 | #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */ |