plugins/ctf/lttng-live: use standard logging files and macros
[babeltrace.git] / plugins / ctf / lttng-live / lttng-live-internal.h
1 #ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H
2 #define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H
3
4 /*
5 * BabelTrace - LTTng-live client Component
6 *
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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
31 #include <stdbool.h>
32
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/graph/component.h>
35 #include <babeltrace/graph/notification-iterator.h>
36 #include <babeltrace/graph/clock-class-priority-map.h>
37 #include "viewer-connection.h"
38
39 //TODO: this should not be used by plugins. Should copy code into plugin
40 //instead.
41 #include "babeltrace/object-internal.h"
42 #include "babeltrace/list-internal.h"
43 #include "../common/metadata/decoder.h"
44
45 #define STREAM_NAME_PREFIX "stream-"
46 /* Account for u64 max string length. */
47 #define U64_STR_MAX_LEN 20
48 #define STREAM_NAME_MAX_LEN (sizeof(STREAM_NAME_PREFIX) + U64_STR_MAX_LEN)
49
50 struct lttng_live_component;
51 struct lttng_live_session;
52
53 enum lttng_live_stream_state {
54 LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
55 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA,
56 LTTNG_LIVE_STREAM_QUIESCENT,
57 LTTNG_LIVE_STREAM_ACTIVE_DATA,
58 LTTNG_LIVE_STREAM_EOF,
59 };
60
61 enum live_stream_type {
62 LIVE_STREAM_TYPE_NO_STREAM,
63 LIVE_STREAM_TYPE_STREAM,
64 };
65
66 struct lttng_live_stream_iterator_generic {
67 enum live_stream_type type;
68 };
69
70 /* Iterator over a live stream. */
71 struct lttng_live_stream_iterator {
72 struct lttng_live_stream_iterator_generic p;
73
74 struct bt_ctf_stream *stream;
75 struct lttng_live_trace *trace;
76 struct bt_private_port *port;
77
78 /* Node of stream list within the trace. */
79 struct bt_list_head node;
80
81 /*
82 * Since only a single iterator per viewer connection, we have
83 * only a single notification iterator per stream.
84 */
85 struct bt_ctf_notif_iter *notif_iter;
86
87 uint64_t viewer_stream_id;
88
89 uint64_t ctf_stream_class_id;
90 uint64_t base_offset; /* base offset in current index. */
91 uint64_t len; /* len to read in current index. */
92 uint64_t offset; /* offset in current index. */
93
94 int64_t last_returned_inactivity_timestamp;
95 int64_t current_inactivity_timestamp;
96
97 enum lttng_live_stream_state state;
98
99 uint64_t current_packet_end_timestamp;
100 struct bt_notification *packet_end_notif_queue;
101
102 uint8_t *buf;
103 size_t buflen;
104
105 char name[STREAM_NAME_MAX_LEN];
106 };
107
108 struct lttng_live_no_stream_iterator {
109 struct lttng_live_stream_iterator_generic p;
110
111 struct lttng_live_component *lttng_live;
112 struct bt_private_port *port;
113 };
114
115 struct lttng_live_component_options {
116 bool opt_dummy : 1;
117 };
118
119 struct lttng_live_metadata {
120 struct lttng_live_trace *trace;
121 uint64_t stream_id;
122 uint8_t uuid[16];
123 bool is_uuid_set;
124 int bo;
125 char *text;
126
127 struct ctf_metadata_decoder *decoder;
128
129 bool closed;
130 };
131
132 struct lttng_live_trace {
133 struct bt_object obj;
134
135 /* Node of trace list within the session. */
136 struct bt_list_head node;
137
138 /* Back reference to session. */
139 struct lttng_live_session *session;
140
141 uint64_t id; /* ctf trace ID within the session. */
142
143 struct bt_ctf_trace *trace;
144
145 struct lttng_live_metadata *metadata;
146 struct bt_clock_class_priority_map *cc_prio_map;
147
148 /* List of struct lttng_live_stream_iterator */
149 struct bt_list_head streams;
150
151 bool new_metadata_needed;
152 };
153
154 struct lttng_live_session {
155 /* Node of session list within the component. */
156 struct bt_list_head node;
157
158 struct lttng_live_component *lttng_live;
159
160 uint64_t id;
161
162 /* List of struct lttng_live_trace */
163 struct bt_list_head traces;
164
165 bool attached;
166 bool new_streams_needed;
167 bool lazy_stream_notif_init;
168 bool closed;
169 };
170
171 /*
172 * A component instance is an iterator on a single session.
173 */
174 struct lttng_live_component {
175 struct bt_object obj;
176 struct bt_private_component *private_component; /* weak */
177 struct bt_live_viewer_connection *viewer_connection;
178
179 /* List of struct lttng_live_session */
180 struct bt_list_head sessions;
181
182 GString *url;
183 size_t max_query_size;
184 struct lttng_live_component_options options;
185
186 struct bt_private_port *no_stream_port;
187 struct lttng_live_no_stream_iterator *no_stream_iter;
188
189 struct bt_component *downstream_component;
190 struct bt_graph *graph; /* weak */
191 };
192
193 enum bt_ctf_lttng_live_iterator_status {
194 /** Iterator state has progressed. Continue iteration immediately. */
195 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
196 /** No notification available for now. Try again later. */
197 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
198 /** No more CTF_LTTNG_LIVEs to be delivered. */
199 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_END = 1,
200 /** No error, okay. */
201 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
202 /** Invalid arguments. */
203 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
204 /** General error. */
205 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
206 /** Out of memory. */
207 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
208 /** Unsupported iterator feature. */
209 BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
210 };
211
212 enum bt_component_status lttng_live_component_init(struct bt_private_component *source,
213 struct bt_value *params, void *init_method_data);
214
215 struct bt_value *lttng_live_query(struct bt_component_class *comp_class,
216 const char *object, struct bt_value *params);
217
218 void lttng_live_component_finalize(struct bt_private_component *component);
219
220 struct bt_notification_iterator_next_return lttng_live_iterator_next(
221 struct bt_private_notification_iterator *iterator);
222
223 enum bt_component_status lttng_live_accept_port_connection(
224 struct bt_private_component *private_component,
225 struct bt_private_port *self_private_port,
226 struct bt_port *other_port);
227
228 enum bt_notification_iterator_status lttng_live_iterator_init(
229 struct bt_private_notification_iterator *it,
230 struct bt_private_port *port);
231
232 void lttng_live_iterator_finalize(struct bt_private_notification_iterator *it);
233
234 int lttng_live_create_viewer_session(struct lttng_live_component *lttng_live);
235 int lttng_live_attach_session(struct lttng_live_session *session);
236 int lttng_live_detach_session(struct lttng_live_session *session);
237 enum bt_ctf_lttng_live_iterator_status lttng_live_get_new_streams(
238 struct lttng_live_session *session);
239
240 int lttng_live_add_session(struct lttng_live_component *lttng_live, uint64_t session_id);
241
242 ssize_t lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace,
243 FILE *fp);
244 enum bt_ctf_lttng_live_iterator_status lttng_live_get_next_index(
245 struct lttng_live_component *lttng_live,
246 struct lttng_live_stream_iterator *stream,
247 struct packet_index *index);
248 enum bt_ctf_notif_iter_medium_status lttng_live_get_stream_bytes(
249 struct lttng_live_component *lttng_live,
250 struct lttng_live_stream_iterator *stream, uint8_t *buf, uint64_t offset,
251 uint64_t req_len, uint64_t *recv_len);
252
253 int lttng_live_add_port(struct lttng_live_component *lttng_live,
254 struct lttng_live_stream_iterator *stream_iter);
255 int lttng_live_remove_port(struct lttng_live_component *lttng_live,
256 struct bt_private_port *port);
257
258 struct lttng_live_trace *lttng_live_ref_trace(
259 struct lttng_live_session *session, uint64_t trace_id);
260 void lttng_live_unref_trace(struct lttng_live_trace *trace);
261 void lttng_live_need_new_streams(struct lttng_live_component *lttng_live);
262
263 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H */
This page took 0.036117 seconds and 4 git commands to generate.