1 #ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
2 #define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
5 * BabelTrace - LTTng-live client Component
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>
11 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
20 * The above copyright notice and this permission notice shall be included in
21 * all copies or substantial portions of the Software.
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
34 #include "common/babeltrace.h"
35 #include <babeltrace2/babeltrace.h>
37 #include "../common/metadata/decoder.h"
38 #include "../common/msg-iter/msg-iter.h"
40 #include "viewer-connection.h"
42 struct lttng_live_component
;
43 struct lttng_live_session
;
44 struct lttng_live_msg_iter
;
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
,
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.
53 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA
, /* */
54 /* This stream has data ready to be consumed. */
55 LTTNG_LIVE_STREAM_ACTIVE_DATA
,
57 * This stream has no data left to consume. We should asked the relay
60 LTTNG_LIVE_STREAM_ACTIVE_NO_DATA
,
61 /* This stream won't have anymore data, ever. */
62 LTTNG_LIVE_STREAM_EOF
,
65 /* Iterator over a live stream. */
66 struct lttng_live_stream_iterator
{
71 struct lttng_live_trace
*trace
;
74 * Since only a single iterator per viewer connection, we have
75 * only a single message iterator per stream.
77 struct bt_msg_iter
*msg_iter
;
79 uint64_t viewer_stream_id
;
81 uint64_t ctf_stream_class_id
;
83 /* base offset in current index. */
85 /* len to read in current index. */
87 /* offset in current index. */
91 * Clock Snapshot value of the last message iterator inactivity message
94 uint64_t last_inactivity_ts
;
97 * Clock Snapshot value of the current message iterator inactivity
98 * message we might want to send downstream.
100 uint64_t current_inactivity_ts
;
102 enum lttng_live_stream_state state
;
105 * The current message produced by this live stream iterator. Owned by
108 bt_message
*current_msg
;
110 /* Timestamp in nanoseconds of the current message (current_msg). */
111 int64_t current_msg_ts_ns
;
121 struct lttng_live_metadata
{
122 /* Weak reference. */
123 struct lttng_live_trace
*trace
;
126 /* Weak reference. */
127 struct ctf_metadata_decoder
*decoder
;
132 struct lttng_live_trace
{
133 /* Back reference to session. */
134 struct lttng_live_session
*session
;
136 /* ctf trace ID within the session. */
142 /* Weak reference. */
143 bt_trace_class
*trace_class
;
145 struct lttng_live_metadata
*metadata
;
147 const bt_clock_class
*clock_class
;
149 /* Array of pointers to struct lttng_live_stream_iterator. */
151 GPtrArray
*stream_iterators
;
153 bool new_metadata_needed
;
156 struct lttng_live_session
{
157 /* Weak reference. */
158 struct lttng_live_msg_iter
*lttng_live_msg_iter
;
164 GString
*session_name
;
168 /* Array of pointers to struct lttng_live_trace. */
172 bool new_streams_needed
;
173 bool lazy_stream_msg_init
;
177 enum session_not_found_action
{
178 SESSION_NOT_FOUND_ACTION_CONTINUE
,
179 SESSION_NOT_FOUND_ACTION_FAIL
,
180 SESSION_NOT_FOUND_ACTION_END
,
184 * A component instance is an iterator on a single session.
186 struct lttng_live_component
{
187 /* Weak reference. */
188 bt_self_component_source
*self_comp
;
192 enum session_not_found_action sess_not_found_act
;
195 size_t max_query_size
;
198 * Keeps track of whether the downstream component already has a
199 * message iterator on this component.
204 struct lttng_live_msg_iter
{
205 /* Weak reference. */
206 struct lttng_live_component
*lttng_live_comp
;
208 /* Weak reference. */
209 bt_self_message_iterator
*self_msg_iter
;
212 struct live_viewer_connection
*viewer_connection
;
214 /* Array of pointers to struct lttng_live_session. */
217 /* Number of live stream iterator this message iterator has.*/
218 uint64_t active_stream_iter
;
220 /* Timestamp in nanosecond of the last message sent downstream. */
221 int64_t last_msg_ts_ns
;
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,
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
);
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
);
253 void lttng_live_component_finalize(bt_self_component_source
*component
);
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
,
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
);
265 void lttng_live_msg_iter_finalize(bt_self_message_iterator
*it
);
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
);
273 int lttng_live_add_session(struct lttng_live_msg_iter
*lttng_live_msg_iter
,
275 const char *hostname
,
276 const char *session_name
);
278 ssize_t
lttng_live_get_one_metadata_packet(struct lttng_live_trace
*trace
,
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
);
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
);
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
);
298 bool lttng_live_graph_is_canceled(struct lttng_live_component
*lttng_live
);
300 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */