Commit | Line | Data |
---|---|---|
3bd1e081 | 1 | /* |
21cf9b6b | 2 | * Copyright (C) 2011 EfficiOS Inc. |
ab5be9fa MJ |
3 | * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
4 | * Copyright (C) 2012 David Goulet <dgoulet@efficios.com> | |
5 | * Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
3bd1e081 | 6 | * |
ab5be9fa | 7 | * SPDX-License-Identifier: GPL-2.0-only |
3bd1e081 | 8 | * |
3bd1e081 MD |
9 | */ |
10 | ||
f02e1e8a DG |
11 | #ifndef LIB_CONSUMER_H |
12 | #define LIB_CONSUMER_H | |
3bd1e081 | 13 | |
28f23191 | 14 | #include <common/buffer-view.hpp> |
28f23191 JG |
15 | #include <common/credentials.hpp> |
16 | #include <common/dynamic-array.hpp> | |
17 | #include <common/hashtable/hashtable.hpp> | |
18 | #include <common/index/ctf-index.hpp> | |
19 | #include <common/pipe.hpp> | |
20 | #include <common/sessiond-comm/sessiond-comm.hpp> | |
21 | #include <common/trace-chunk-registry.hpp> | |
22 | #include <common/uuid.hpp> | |
f40b76ae | 23 | #include <common/waiter.hpp> |
28f23191 JG |
24 | |
25 | #include <lttng/lttng.h> | |
26 | ||
3bd1e081 MD |
27 | #include <limits.h> |
28 | #include <poll.h> | |
4222116f | 29 | #include <stdint.h> |
6df2e2c9 | 30 | #include <unistd.h> |
ffe60014 | 31 | #include <urcu/list.h> |
e4421fec | 32 | |
6f9449c2 JG |
33 | struct lttng_consumer_local_data; |
34 | ||
3bd1e081 MD |
35 | /* Commands for consumer */ |
36 | enum lttng_consumer_command { | |
37 | LTTNG_CONSUMER_ADD_CHANNEL, | |
38 | LTTNG_CONSUMER_ADD_STREAM, | |
39 | /* pause, delete, active depending on fd state */ | |
40 | LTTNG_CONSUMER_UPDATE_STREAM, | |
41 | /* inform the consumer to quit when all fd has hang up */ | |
28f23191 | 42 | LTTNG_CONSUMER_STOP, /* deprecated */ |
00e2e675 | 43 | LTTNG_CONSUMER_ADD_RELAYD_SOCKET, |
173af62f DG |
44 | /* Inform the consumer to kill a specific relayd connection */ |
45 | LTTNG_CONSUMER_DESTROY_RELAYD, | |
53632229 | 46 | /* Return to the sessiond if there is data pending for a session */ |
6d805429 | 47 | LTTNG_CONSUMER_DATA_PENDING, |
ffe60014 DG |
48 | /* Consumer creates a channel and returns it to sessiond. */ |
49 | LTTNG_CONSUMER_ASK_CHANNEL_CREATION, | |
50 | LTTNG_CONSUMER_GET_CHANNEL, | |
51 | LTTNG_CONSUMER_DESTROY_CHANNEL, | |
d88aee68 DG |
52 | LTTNG_CONSUMER_PUSH_METADATA, |
53 | LTTNG_CONSUMER_CLOSE_METADATA, | |
54 | LTTNG_CONSUMER_SETUP_METADATA, | |
7972aab2 | 55 | LTTNG_CONSUMER_FLUSH_CHANNEL, |
6dc3064a DG |
56 | LTTNG_CONSUMER_SNAPSHOT_CHANNEL, |
57 | LTTNG_CONSUMER_SNAPSHOT_METADATA, | |
a4baae1b | 58 | LTTNG_CONSUMER_STREAMS_SENT, |
fb83fe64 JD |
59 | LTTNG_CONSUMER_DISCARDED_EVENTS, |
60 | LTTNG_CONSUMER_LOST_PACKETS, | |
0dd01979 | 61 | LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL, |
b3530820 | 62 | LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE, |
b99a8d42 | 63 | LTTNG_CONSUMER_ROTATE_CHANNEL, |
3654ed19 | 64 | LTTNG_CONSUMER_INIT, |
d2956687 JG |
65 | LTTNG_CONSUMER_CREATE_TRACE_CHUNK, |
66 | LTTNG_CONSUMER_CLOSE_TRACE_CHUNK, | |
67 | LTTNG_CONSUMER_TRACE_CHUNK_EXISTS, | |
5f3aff8b | 68 | LTTNG_CONSUMER_CLEAR_CHANNEL, |
04ed9e10 | 69 | LTTNG_CONSUMER_OPEN_CHANNEL_PACKETS, |
3bd1e081 MD |
70 | }; |
71 | ||
3bd1e081 MD |
72 | enum lttng_consumer_type { |
73 | LTTNG_CONSUMER_UNKNOWN = 0, | |
74 | LTTNG_CONSUMER_KERNEL, | |
7753dea8 MD |
75 | LTTNG_CONSUMER64_UST, |
76 | LTTNG_CONSUMER32_UST, | |
3bd1e081 MD |
77 | }; |
78 | ||
8994307f DG |
79 | enum consumer_endpoint_status { |
80 | CONSUMER_ENDPOINT_ACTIVE, | |
81 | CONSUMER_ENDPOINT_INACTIVE, | |
82 | }; | |
83 | ||
ffe60014 | 84 | enum consumer_channel_output { |
28f23191 JG |
85 | CONSUMER_CHANNEL_MMAP = 0, |
86 | CONSUMER_CHANNEL_SPLICE = 1, | |
ffe60014 DG |
87 | }; |
88 | ||
89 | enum consumer_channel_type { | |
28f23191 JG |
90 | CONSUMER_CHANNEL_TYPE_METADATA = 0, |
91 | CONSUMER_CHANNEL_TYPE_DATA = 1, | |
ffe60014 DG |
92 | }; |
93 | ||
577eea73 JG |
94 | enum sync_metadata_status { |
95 | SYNC_METADATA_STATUS_NEW_DATA, | |
96 | SYNC_METADATA_STATUS_NO_DATA, | |
97 | SYNC_METADATA_STATUS_ERROR, | |
98 | }; | |
99 | ||
fa29bfbf | 100 | extern struct lttng_consumer_global_data the_consumer_data; |
51230d70 | 101 | |
ffe60014 DG |
102 | struct stream_list { |
103 | struct cds_list_head head; | |
104 | unsigned int count; | |
105 | }; | |
106 | ||
331744e3 JD |
107 | /* Stub. */ |
108 | struct consumer_metadata_cache; | |
109 | ||
3bd1e081 | 110 | struct lttng_consumer_channel { |
d2956687 | 111 | /* Is the channel published in the channel hash tables? */ |
32670d71 | 112 | bool is_published = false; |
b6921a17 JG |
113 | /* |
114 | * Was the channel deleted (logically) and waiting to be reclaimed? | |
115 | * If this flag is set, no modification that is not cleaned-up by the | |
116 | * RCU reclamation callback should be made | |
117 | */ | |
32670d71 | 118 | bool is_deleted = false; |
ffe60014 | 119 | /* HT node used for consumer_data.channel_ht */ |
32670d71 | 120 | struct lttng_ht_node_u64 node = {}; |
5c3892a6 | 121 | /* HT node used for consumer_data.channels_by_session_id_ht */ |
32670d71 | 122 | struct lttng_ht_node_u64 channels_by_session_id_ht_node = {}; |
ffe60014 | 123 | /* Indexed key. Incremented value in the consumer. */ |
32670d71 | 124 | uint64_t key = 0; |
ffe60014 | 125 | /* Number of streams referencing this channel */ |
32670d71 | 126 | int refcount = 0; |
ffe60014 | 127 | /* Tracing session id on the session daemon side. */ |
32670d71 | 128 | uint64_t session_id = 0; |
d2956687 | 129 | /* Current trace chunk of the session in which this channel exists. */ |
32670d71 | 130 | struct lttng_trace_chunk *trace_chunk = nullptr; |
1950109e JD |
131 | /* |
132 | * Session id when requesting metadata to the session daemon for | |
133 | * a session with per-PID buffers. | |
134 | */ | |
32670d71 | 135 | uint64_t session_id_per_pid = 0; |
348a81dc JG |
136 | /* |
137 | * In the case of local streams, this field contains the channel's | |
138 | * output path; a path relative to the session's output path. | |
139 | * e.g. ust/uid/1000/64-bit | |
140 | * | |
141 | * In the case of remote streams, the contents of this field depends | |
142 | * on the version of the relay daemon peer. For 2.11+ peers, the | |
143 | * contents are the same as in the local case. However, for legacy | |
144 | * peers, this contains a path of the form: | |
145 | * /hostname/session_path/ust/uid/1000/64-bit | |
146 | */ | |
32670d71 | 147 | char pathname[PATH_MAX] = {}; |
ffe60014 | 148 | /* Channel name. */ |
32670d71 | 149 | char name[LTTNG_SYMBOL_NAME_LEN] = {}; |
da009f2c | 150 | /* Relayd id of the channel. -1ULL if it does not apply. */ |
32670d71 | 151 | uint64_t relayd_id = 0; |
c30aaa51 | 152 | /* |
ffe60014 DG |
153 | * Number of streams NOT initialized yet. This is used in order to not |
154 | * delete this channel if streams are getting initialized. | |
c30aaa51 | 155 | */ |
32670d71 | 156 | unsigned int nb_init_stream_left = 0; |
ffe60014 | 157 | /* Output type (mmap or splice). */ |
32670d71 | 158 | enum consumer_channel_output output = CONSUMER_CHANNEL_MMAP; |
ffe60014 | 159 | /* Channel type for stream */ |
32670d71 | 160 | enum consumer_channel_type type = CONSUMER_CHANNEL_TYPE_METADATA; |
c30aaa51 | 161 | |
3bd1e081 | 162 | /* For UST */ |
32670d71 JG |
163 | uid_t ust_app_uid = 65534; /* Application UID. */ |
164 | struct lttng_ust_ctl_consumer_channel *uchan = nullptr; | |
165 | unsigned char uuid[LTTNG_UUID_STR_LEN] = {}; | |
ffe60014 DG |
166 | /* |
167 | * Temporary stream list used to store the streams once created and waiting | |
168 | * to be sent to the session daemon by receiving the | |
169 | * LTTNG_CONSUMER_GET_CHANNEL. | |
170 | */ | |
32670d71 | 171 | struct stream_list streams = {}; |
07b86b52 | 172 | |
d88aee68 DG |
173 | /* |
174 | * Set if the channel is metadata. We keep a reference to the stream | |
175 | * because we have to flush data once pushed by the session daemon. For a | |
176 | * regular channel, this is always set to NULL. | |
177 | */ | |
32670d71 | 178 | struct lttng_consumer_stream *metadata_stream = nullptr; |
d8ef542d MD |
179 | |
180 | /* for UST */ | |
32670d71 | 181 | int wait_fd = -1; |
d8ef542d | 182 | /* Node within channel thread ht */ |
32670d71 | 183 | struct lttng_ht_node_u64 wait_fd_node = {}; |
331744e3 JD |
184 | |
185 | /* Metadata cache is metadata channel */ | |
32670d71 | 186 | struct consumer_metadata_cache *metadata_cache = nullptr; |
cf0bcb51 | 187 | |
f40b76ae JG |
188 | /* |
189 | * Wait queue awaiting updates to metadata stream's flushed position. | |
190 | */ | |
32670d71 | 191 | lttng::synchro::wait_queue metadata_pushed_wait_queue; |
f40b76ae | 192 | |
d3e2ba59 | 193 | /* For UST metadata periodical flush */ |
32670d71 JG |
194 | int switch_timer_enabled = 0; |
195 | timer_t switch_timer = {}; | |
196 | int switch_timer_error = 0; | |
4419b4fb | 197 | |
d3e2ba59 | 198 | /* For the live mode */ |
32670d71 JG |
199 | int live_timer_enabled = 0; |
200 | timer_t live_timer = {}; | |
201 | int live_timer_error = 0; | |
a2814ea7 | 202 | /* Channel is part of a live session ? */ |
32670d71 | 203 | bool is_live = false; |
d3e2ba59 | 204 | |
b3530820 | 205 | /* For channel monitoring timer. */ |
32670d71 JG |
206 | int monitor_timer_enabled = 0; |
207 | timer_t monitor_timer = {}; | |
b3530820 | 208 | |
1624d5b7 | 209 | /* On-disk circular buffer */ |
32670d71 JG |
210 | uint64_t tracefile_size = 0; |
211 | uint64_t tracefile_count = 0; | |
2bba9e53 DG |
212 | /* |
213 | * Monitor or not the streams of this channel meaning this indicates if the | |
214 | * streams should be sent to the data/metadata thread or added to the no | |
215 | * monitor list of the channel. | |
216 | */ | |
32670d71 | 217 | unsigned int monitor = 0; |
a9838785 MD |
218 | |
219 | /* | |
220 | * Channel lock. | |
221 | * | |
ec6ea7d0 MD |
222 | * This lock protects against concurrent update of channel. |
223 | * | |
a9838785 | 224 | * This is nested INSIDE the consumer data lock. |
ec6ea7d0 | 225 | * This is nested OUTSIDE the channel timer lock. |
a9838785 MD |
226 | * This is nested OUTSIDE the metadata cache lock. |
227 | * This is nested OUTSIDE stream lock. | |
228 | * This is nested OUTSIDE consumer_relayd_sock_pair lock. | |
229 | */ | |
32670d71 | 230 | pthread_mutex_t lock = {}; |
ec6ea7d0 MD |
231 | |
232 | /* | |
233 | * Channel teardown lock. | |
234 | * | |
235 | * This lock protect against teardown of channel. It is _never_ | |
236 | * taken by the timer handler. | |
237 | * | |
238 | * This is nested INSIDE the consumer data lock. | |
239 | * This is nested INSIDE the channel lock. | |
240 | * This is nested OUTSIDE the metadata cache lock. | |
241 | * This is nested OUTSIDE stream lock. | |
242 | * This is nested OUTSIDE consumer_relayd_sock_pair lock. | |
243 | */ | |
32670d71 | 244 | pthread_mutex_t timer_lock = {}; |
ecc48a90 JD |
245 | |
246 | /* Timer value in usec for live streaming. */ | |
32670d71 | 247 | unsigned int live_timer_interval = 0; |
d7ba1388 | 248 | |
32670d71 JG |
249 | int *stream_fds = nullptr; |
250 | int nr_stream_fds = 0; | |
251 | char root_shm_path[PATH_MAX] = {}; | |
252 | char shm_path[PATH_MAX] = {}; | |
d2956687 | 253 | /* Only set for UST channels. */ |
32670d71 | 254 | LTTNG_OPTIONAL(struct lttng_credentials) buffer_credentials = {}; |
fb83fe64 | 255 | /* Total number of discarded events for that channel. */ |
32670d71 | 256 | uint64_t discarded_events = 0; |
fb83fe64 | 257 | /* Total number of missed packets due to overwriting (overwrite). */ |
32670d71 | 258 | uint64_t lost_packets = 0; |
001b7e62 | 259 | |
32670d71 JG |
260 | bool streams_sent_to_relayd = false; |
261 | uint64_t last_consumed_size_sample_sent = false; | |
3bd1e081 MD |
262 | }; |
263 | ||
6f9449c2 JG |
264 | struct stream_subbuffer { |
265 | union { | |
266 | /* | |
267 | * CONSUMER_CHANNEL_SPLICE | |
268 | * No ownership assumed. | |
269 | */ | |
270 | int fd; | |
271 | /* CONSUMER_CHANNEL_MMAP */ | |
272 | struct lttng_buffer_view buffer; | |
273 | } buffer; | |
274 | union { | |
275 | /* | |
276 | * Common members are fine to access through either | |
277 | * union entries (as per C11, Common Initial Sequence). | |
278 | */ | |
279 | struct { | |
280 | unsigned long subbuf_size; | |
281 | unsigned long padded_subbuf_size; | |
282 | uint64_t version; | |
f5ba75b4 JG |
283 | /* |
284 | * Left unset when unsupported. | |
285 | * | |
286 | * Indicates that this is the last sub-buffer of | |
287 | * a series of sub-buffer that makes-up a coherent | |
288 | * (parseable) unit of metadata. | |
289 | */ | |
290 | LTTNG_OPTIONAL(bool) coherent; | |
6f9449c2 JG |
291 | } metadata; |
292 | struct { | |
293 | unsigned long subbuf_size; | |
294 | unsigned long padded_subbuf_size; | |
295 | uint64_t packet_size; | |
296 | uint64_t content_size; | |
297 | uint64_t timestamp_begin; | |
298 | uint64_t timestamp_end; | |
299 | uint64_t events_discarded; | |
300 | /* Left unset when unsupported. */ | |
301 | LTTNG_OPTIONAL(uint64_t) sequence_number; | |
302 | uint64_t stream_id; | |
303 | /* Left unset when unsupported. */ | |
304 | LTTNG_OPTIONAL(uint64_t) stream_instance_id; | |
305 | } data; | |
306 | } info; | |
307 | }; | |
308 | ||
b6797c8e JG |
309 | enum get_next_subbuffer_status { |
310 | GET_NEXT_SUBBUFFER_STATUS_OK, | |
311 | GET_NEXT_SUBBUFFER_STATUS_NO_DATA, | |
312 | GET_NEXT_SUBBUFFER_STATUS_ERROR, | |
313 | }; | |
314 | ||
6f9449c2 JG |
315 | /* |
316 | * Perform any operation required to acknowledge | |
317 | * the wake-up of a consumer stream (e.g. consume a byte on a wake-up pipe). | |
318 | * | |
319 | * Stream and channel locks are acquired during this call. | |
320 | */ | |
e665dfbc | 321 | using on_wake_up_cb = int (*)(struct lttng_consumer_stream *); |
6f9449c2 JG |
322 | |
323 | /* | |
324 | * Perform any operation required before a consumer stream is put | |
325 | * to sleep before awaiting a data availability notification. | |
326 | * | |
327 | * Stream and channel locks are acquired during this call. | |
328 | */ | |
e665dfbc | 329 | using on_sleep_cb = int (*)(struct lttng_consumer_stream *, struct lttng_consumer_local_data *); |
6f9449c2 JG |
330 | |
331 | /* | |
332 | * Acquire the subbuffer at the current 'consumed' position. | |
333 | * | |
334 | * Stream and channel locks are acquired during this call. | |
335 | */ | |
e665dfbc JG |
336 | using get_next_subbuffer_cb = enum get_next_subbuffer_status (*)(struct lttng_consumer_stream *, |
337 | struct stream_subbuffer *); | |
6f9449c2 JG |
338 | |
339 | /* | |
340 | * Populate the stream_subbuffer's info member. The info to populate | |
341 | * depends on the type (metadata/data) of the stream. | |
342 | * | |
343 | * Stream and channel locks are acquired during this call. | |
344 | */ | |
e665dfbc JG |
345 | using extract_subbuffer_info_cb = int (*)(struct lttng_consumer_stream *, |
346 | struct stream_subbuffer *); | |
6f9449c2 JG |
347 | |
348 | /* | |
349 | * Invoked after a subbuffer's info has been filled. | |
350 | * | |
351 | * Stream and channel locks are acquired during this call. | |
352 | */ | |
e665dfbc JG |
353 | using pre_consume_subbuffer_cb = int (*)(struct lttng_consumer_stream *, |
354 | const struct stream_subbuffer *); | |
6f9449c2 JG |
355 | |
356 | /* | |
357 | * Consume subbuffer contents. | |
358 | * | |
359 | * Stream and channel locks are acquired during this call. | |
360 | */ | |
e665dfbc JG |
361 | using consume_subbuffer_cb = ssize_t (*)(struct lttng_consumer_local_data *, |
362 | struct lttng_consumer_stream *, | |
363 | const struct stream_subbuffer *); | |
6f9449c2 JG |
364 | |
365 | /* | |
366 | * Release the current subbuffer and advance the 'consumed' position by | |
367 | * one subbuffer. | |
368 | * | |
369 | * Stream and channel locks are acquired during this call. | |
370 | */ | |
e665dfbc | 371 | using put_next_subbuffer_cb = int (*)(struct lttng_consumer_stream *, struct stream_subbuffer *); |
6f9449c2 JG |
372 | |
373 | /* | |
374 | * Invoked after consuming a subbuffer. | |
375 | * | |
376 | * Stream and channel locks are acquired during this call. | |
377 | */ | |
e665dfbc JG |
378 | using post_consume_cb = int (*)(struct lttng_consumer_stream *, |
379 | const struct stream_subbuffer *, | |
380 | struct lttng_consumer_local_data *); | |
6f9449c2 JG |
381 | |
382 | /* | |
383 | * Send a live beacon if no data is available. | |
384 | * | |
385 | * Stream and channel locks are acquired during this call. | |
386 | */ | |
e665dfbc | 387 | using send_live_beacon_cb = int (*)(struct lttng_consumer_stream *); |
6f9449c2 JG |
388 | |
389 | /* | |
390 | * Lock the stream and channel locks and any other stream-type specific | |
391 | * lock that need to be acquired during the processing of an | |
392 | * availability notification. | |
393 | */ | |
e665dfbc | 394 | using lock_cb = void (*)(struct lttng_consumer_stream *); |
6f9449c2 JG |
395 | |
396 | /* | |
397 | * Unlock the stream and channel locks and any other stream-type specific | |
398 | * lock before sleeping until the next availability notification. | |
399 | * | |
400 | * Stream and channel locks are acquired during this call. | |
401 | */ | |
e665dfbc | 402 | using unlock_cb = void (*)(struct lttng_consumer_stream *); |
6f9449c2 | 403 | |
947bd097 JR |
404 | /* |
405 | * Assert that the stream and channel lock and any other stream type specific | |
406 | * lock that need to be acquired during the processing of a read_subbuffer | |
407 | * operation is acquired. | |
408 | */ | |
e665dfbc | 409 | using assert_locked_cb = void (*)(struct lttng_consumer_stream *); |
947bd097 | 410 | |
6f9449c2 JG |
411 | /* |
412 | * Invoked when a subbuffer's metadata version does not match the last | |
413 | * known metadata version. | |
414 | * | |
415 | * Stream and channel locks are acquired during this call. | |
416 | */ | |
e665dfbc | 417 | using reset_metadata_cb = void (*)(struct lttng_consumer_stream *); |
6f9449c2 | 418 | |
3bd1e081 MD |
419 | /* |
420 | * Internal representation of the streams, sessiond_key is used to identify | |
421 | * uniquely a stream. | |
422 | */ | |
423 | struct lttng_consumer_stream { | |
53632229 | 424 | /* HT node used by the data_ht and metadata_ht */ |
d88aee68 | 425 | struct lttng_ht_node_u64 node; |
d8ef542d MD |
426 | /* stream indexed per channel key node */ |
427 | struct lttng_ht_node_u64 node_channel_id; | |
53632229 | 428 | /* HT node used in consumer_data.stream_list_ht */ |
d88aee68 | 429 | struct lttng_ht_node_u64 node_session_id; |
5c5e3d71 JG |
430 | /* |
431 | * List used by channels to reference streams that are not yet globally | |
432 | * visible. | |
433 | */ | |
434 | struct cds_list_head send_node; | |
ffe60014 DG |
435 | /* Pointer to associated channel. */ |
436 | struct lttng_consumer_channel *chan; | |
d2956687 JG |
437 | /* |
438 | * Current trace chunk. Holds a reference to the trace chunk. | |
439 | * `chunk` can be NULL when a stream is not associated to a chunk, e.g. | |
440 | * when it was created in the context of a no-output session. | |
441 | */ | |
442 | struct lttng_trace_chunk *trace_chunk; | |
ffe60014 DG |
443 | |
444 | /* Key by which the stream is indexed for 'node'. */ | |
d88aee68 | 445 | uint64_t key; |
3bd1e081 | 446 | /* |
ffe60014 DG |
447 | * File descriptor of the data output file. This can be either a file or a |
448 | * socket fd for relayd streaming. | |
3bd1e081 | 449 | */ |
3bd1e081 | 450 | int out_fd; /* output file to write the data */ |
ffe60014 DG |
451 | /* Write position in the output file descriptor */ |
452 | off_t out_fd_offset; | |
e5d1a9b3 MD |
453 | /* Amount of bytes written to the output */ |
454 | uint64_t output_written; | |
b5c5fc29 | 455 | int shm_fd_is_copy; |
c715ddc9 JG |
456 | /* |
457 | * When a stream's pipe is hung up, a final flush is performed (see hangup_flush_done). This | |
458 | * indicates whether or not the data resulting from this flush is still to be consumed. | |
459 | */ | |
460 | int has_data_left_to_be_read_before_teardown; | |
d056b477 | 461 | int hangup_flush_done; |
c585821b | 462 | |
0dd01979 MD |
463 | /* |
464 | * Whether the stream is in a "complete" state (e.g. it does not have a | |
465 | * partially written sub-buffer. | |
466 | * | |
467 | * Initialized to "false" on stream creation (first packet is empty). | |
468 | * | |
469 | * The various transitions of the quiescent state are: | |
470 | * - On "start" tracing: set to false, since the stream is not | |
471 | * "complete". | |
472 | * - On "stop" tracing: if !quiescent -> flush FINAL (update | |
473 | * timestamp_end), and set to true; the stream has entered a | |
474 | * complete/quiescent state. | |
475 | * - On "destroy" or stream/application hang-up: if !quiescent -> | |
476 | * flush FINAL, and set to true. | |
477 | * | |
478 | * NOTE: Update and read are protected by the stream lock. | |
479 | */ | |
480 | bool quiescent; | |
481 | ||
a40a503f MD |
482 | /* |
483 | * True if the sequence number is not available (lttng-modules < 2.8). | |
484 | */ | |
485 | bool sequence_number_unavailable; | |
486 | ||
c585821b MD |
487 | /* |
488 | * metadata_timer_lock protects flags waiting_on_metadata and | |
489 | * missed_metadata_flush. | |
490 | */ | |
491 | pthread_mutex_t metadata_timer_lock; | |
492 | /* | |
493 | * Flag set when awaiting metadata to be pushed. Used in the | |
494 | * timer thread to skip waiting on the stream (and stream lock) to | |
495 | * ensure we can proceed to flushing metadata in live mode. | |
496 | */ | |
497 | bool waiting_on_metadata; | |
498 | /* Raised when a timer misses a metadata flush. */ | |
499 | bool missed_metadata_flush; | |
500 | ||
ffe60014 | 501 | enum lttng_event_output output; |
c35f9726 | 502 | /* Maximum subbuffer size (in bytes). */ |
ffe60014 DG |
503 | unsigned long max_sb_size; |
504 | ||
505 | /* | |
506 | * Still used by the kernel for MMAP output. For UST, the ustctl getter is | |
507 | * used for the mmap base and offset. | |
508 | */ | |
509 | void *mmap_base; | |
510 | unsigned long mmap_len; | |
511 | ||
512 | /* For UST */ | |
513 | ||
514 | int wait_fd; | |
00e2e675 | 515 | /* Network sequence number. Indicating on which relayd socket it goes. */ |
d88aee68 | 516 | uint64_t net_seq_idx; |
d01178b6 DG |
517 | /* |
518 | * Indicate if this stream was successfully sent to a relayd. This is set | |
519 | * after the refcount of the relayd is incremented and is checked when the | |
520 | * stream is closed before decrementing the refcount in order to avoid an | |
521 | * unbalanced state. | |
522 | */ | |
523 | unsigned int sent_to_relayd; | |
524 | ||
00e2e675 DG |
525 | /* Identify if the stream is the metadata */ |
526 | unsigned int metadata_flag; | |
93ec662e JD |
527 | /* |
528 | * Last known metadata version, reset the metadata file in case | |
529 | * of change. | |
530 | */ | |
531 | uint64_t metadata_version; | |
00e2e675 DG |
532 | /* Used when the stream is set for network streaming */ |
533 | uint64_t relayd_stream_id; | |
3604f373 DG |
534 | /* |
535 | * When sending a stream packet to a relayd, this number is used to track | |
536 | * the packet sent by the consumer and seen by the relayd. When sending the | |
537 | * data header to the relayd, this number is sent and if the transmission | |
538 | * was successful, it is incremented. | |
539 | * | |
540 | * Even if the full data is not fully transmitted it won't matter since | |
541 | * only two possible error can happen after that where either the relayd | |
542 | * died or a read error is detected on the stream making this value useless | |
543 | * after that. | |
544 | * | |
545 | * This value SHOULD be read/updated atomically or with the lock acquired. | |
546 | */ | |
173af62f | 547 | uint64_t next_net_seq_num; |
63281d5d | 548 | /* |
74251bb8 DG |
549 | * Lock to use the stream FDs since they are used between threads. |
550 | * | |
551 | * This is nested INSIDE the consumer_data lock. | |
a9838785 | 552 | * This is nested INSIDE the channel lock. |
ec6ea7d0 | 553 | * This is nested INSIDE the channel timer lock. |
3dad2c0f | 554 | * This is nested OUTSIDE the metadata cache lock. |
74251bb8 | 555 | * This is nested OUTSIDE consumer_relayd_sock_pair lock. |
63281d5d | 556 | */ |
53632229 DG |
557 | pthread_mutex_t lock; |
558 | /* Tracing session id */ | |
559 | uint64_t session_id; | |
8994307f DG |
560 | /* |
561 | * Indicates if the stream end point is still active or not (network | |
562 | * streaming or local file system). The thread "owning" the stream is | |
563 | * handling this status and can be notified of a state change through the | |
564 | * consumer data appropriate pipe. | |
565 | */ | |
566 | enum consumer_endpoint_status endpoint_status; | |
ffe60014 DG |
567 | /* Stream name. Format is: <channel_name>_<cpu_number> */ |
568 | char name[LTTNG_SYMBOL_NAME_LEN]; | |
569 | /* Internal state of libustctl. */ | |
b623cb6a | 570 | struct lttng_ust_ctl_consumer_stream *ustream; |
1624d5b7 JD |
571 | /* On-disk circular buffer */ |
572 | uint64_t tracefile_size_current; | |
573 | uint64_t tracefile_count_current; | |
4891ece8 DG |
574 | /* |
575 | * Monitor or not the streams of this channel meaning this indicates if the | |
576 | * streams should be sent to the data/metadata thread or added to the no | |
577 | * monitor list of the channel. | |
578 | */ | |
579 | unsigned int monitor; | |
580 | /* | |
581 | * Indicate if the stream is globally visible meaning that it has been | |
582 | * added to the multiple hash tables. If *not* set, NO lock should be | |
583 | * acquired in the destroy path. | |
584 | */ | |
585 | unsigned int globally_visible; | |
feb78e88 MD |
586 | /* |
587 | * Pipe to wake up the metadata poll thread when the UST metadata | |
588 | * cache is updated. | |
589 | */ | |
590 | int ust_metadata_poll_pipe[2]; | |
591 | /* | |
592 | * How much metadata was read from the metadata cache and sent | |
593 | * to the channel. | |
594 | */ | |
595 | uint64_t ust_metadata_pushed; | |
fb83fe64 JD |
596 | /* |
597 | * Copy of the last discarded event value to detect the overflow of | |
598 | * the counter. | |
599 | */ | |
600 | uint64_t last_discarded_events; | |
601 | /* Copy of the sequence number of the last packet extracted. */ | |
602 | uint64_t last_sequence_number; | |
309167d2 | 603 | /* |
f8f3885c | 604 | * Index file object of the index file for this stream. |
309167d2 | 605 | */ |
f8f3885c | 606 | struct lttng_index_file *index_file; |
94d49140 | 607 | |
a2361a61 JD |
608 | /* |
609 | * Local pipe to extract data when using splice. | |
610 | */ | |
611 | int splice_pipe[2]; | |
612 | ||
94d49140 JD |
613 | /* |
614 | * Rendez-vous point between data and metadata stream in live mode. | |
615 | */ | |
616 | pthread_cond_t metadata_rdv; | |
617 | pthread_mutex_t metadata_rdv_lock; | |
02b3d176 | 618 | |
02d02e31 | 619 | /* |
a40a503f MD |
620 | * rotate_position represents the packet sequence number of the last |
621 | * packet which belongs to the current trace chunk prior to the rotation. | |
622 | * When that position is reached, this tracefile can be closed and a | |
623 | * new one is created in channel_read_only_attributes.path. | |
02d02e31 | 624 | */ |
a40a503f | 625 | uint64_t rotate_position; |
02d02e31 | 626 | |
f96af312 JG |
627 | /* Whether or not a packet was opened during the current trace chunk. */ |
628 | bool opened_packet_in_current_trace_chunk; | |
629 | ||
d9a2e16e JD |
630 | /* |
631 | * Read-only copies of channel values. We cannot safely access the | |
632 | * channel from a stream, so we need to have a local copy of these | |
633 | * fields in the stream object. These fields should be removed from | |
634 | * the stream objects when we introduce refcounting. | |
635 | */ | |
636 | struct { | |
d9a2e16e JD |
637 | uint64_t tracefile_size; |
638 | } channel_read_only_attributes; | |
639 | ||
02d02e31 JD |
640 | /* |
641 | * Flag to inform the data or metadata thread that a stream is | |
642 | * ready to be rotated. | |
643 | */ | |
644 | bool rotate_ready; | |
645 | ||
02b3d176 DG |
646 | /* Indicate if the stream still has some data to be read. */ |
647 | unsigned int has_data:1; | |
93ec662e JD |
648 | /* |
649 | * Inform the consumer or relay to reset the metadata | |
650 | * file before writing in it (regeneration). | |
651 | */ | |
652 | unsigned int reset_metadata_flag:1; | |
6f9449c2 JG |
653 | struct { |
654 | /* | |
655 | * Invoked in the order of declaration. | |
656 | * See callback type definitions. | |
657 | */ | |
658 | lock_cb lock; | |
659 | on_wake_up_cb on_wake_up; | |
660 | get_next_subbuffer_cb get_next_subbuffer; | |
661 | extract_subbuffer_info_cb extract_subbuffer_info; | |
662 | pre_consume_subbuffer_cb pre_consume_subbuffer; | |
663 | reset_metadata_cb reset_metadata; | |
664 | consume_subbuffer_cb consume_subbuffer; | |
665 | put_next_subbuffer_cb put_next_subbuffer; | |
503fefca | 666 | struct lttng_dynamic_array post_consume_cbs; |
6f9449c2 JG |
667 | send_live_beacon_cb send_live_beacon; |
668 | on_sleep_cb on_sleep; | |
669 | unlock_cb unlock; | |
947bd097 | 670 | assert_locked_cb assert_locked; |
6f9449c2 | 671 | } read_subbuffer_ops; |
f5ba75b4 | 672 | struct metadata_bucket *metadata_bucket; |
00e2e675 DG |
673 | }; |
674 | ||
675 | /* | |
676 | * Internal representation of a relayd socket pair. | |
677 | */ | |
678 | struct consumer_relayd_sock_pair { | |
679 | /* Network sequence number. */ | |
da009f2c | 680 | uint64_t net_seq_idx; |
00e2e675 | 681 | /* Number of stream associated with this relayd */ |
97056403 | 682 | int refcount; |
173af62f DG |
683 | |
684 | /* | |
685 | * This flag indicates whether or not we should destroy this object. The | |
686 | * destruction should ONLY occurs when this flag is set and the refcount is | |
687 | * set to zero. | |
688 | */ | |
689 | unsigned int destroy_flag; | |
690 | ||
51d7db73 DG |
691 | /* |
692 | * Mutex protecting the control socket to avoid out of order packets | |
693 | * between threads sending data to the relayd. Since metadata data is sent | |
694 | * over that socket, at least two sendmsg() are needed (header + data) | |
695 | * creating a race for packets to overlap between threads using it. | |
74251bb8 DG |
696 | * |
697 | * This is nested INSIDE the consumer_data lock. | |
698 | * This is nested INSIDE the stream lock. | |
51d7db73 | 699 | */ |
00e2e675 | 700 | pthread_mutex_t ctrl_sock_mutex; |
51d7db73 DG |
701 | |
702 | /* Control socket. Command and metadata are passed over it */ | |
6151a90f | 703 | struct lttcomm_relayd_sock control_sock; |
51d7db73 DG |
704 | |
705 | /* | |
706 | * We don't need a mutex at this point since we only splice or write single | |
707 | * large chunk of data with a header appended at the begining. Moreover, | |
708 | * this socket is for now only used in a single thread. | |
709 | */ | |
6151a90f | 710 | struct lttcomm_relayd_sock data_sock; |
d88aee68 | 711 | struct lttng_ht_node_u64 node; |
c5b6f4f0 | 712 | |
f7079f67 DG |
713 | /* Session id on both sides for the sockets. */ |
714 | uint64_t relayd_session_id; | |
715 | uint64_t sessiond_session_id; | |
9276e5c8 | 716 | struct lttng_consumer_local_data *ctx; |
3bd1e081 MD |
717 | }; |
718 | ||
719 | /* | |
720 | * UST consumer local data to the program. One or more instance per | |
721 | * process. | |
722 | */ | |
723 | struct lttng_consumer_local_data { | |
4078b776 MD |
724 | /* |
725 | * Function to call when data is available on a buffer. | |
726 | * Returns the number of bytes read, or negative error value. | |
727 | */ | |
728 | ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream, | |
28f23191 JG |
729 | struct lttng_consumer_local_data *ctx, |
730 | bool locked_by_caller); | |
3bd1e081 MD |
731 | /* |
732 | * function to call when we receive a new channel, it receives a | |
733 | * newly allocated channel, depending on the return code of this | |
734 | * function, the new channel will be handled by the application | |
735 | * or the library. | |
736 | * | |
737 | * Returns: | |
738 | * > 0 (success, FD is kept by application) | |
739 | * == 0 (success, FD is left to library) | |
740 | * < 0 (error) | |
741 | */ | |
742 | int (*on_recv_channel)(struct lttng_consumer_channel *channel); | |
743 | /* | |
744 | * function to call when we receive a new stream, it receives a | |
745 | * newly allocated stream, depending on the return code of this | |
746 | * function, the new stream will be handled by the application | |
747 | * or the library. | |
748 | * | |
749 | * Returns: | |
750 | * > 0 (success, FD is kept by application) | |
751 | * == 0 (success, FD is left to library) | |
752 | * < 0 (error) | |
753 | */ | |
754 | int (*on_recv_stream)(struct lttng_consumer_stream *stream); | |
755 | /* | |
756 | * function to call when a stream is getting updated by the session | |
757 | * daemon, this function receives the sessiond key and the new | |
758 | * state, depending on the return code of this function the | |
759 | * update of state for the stream is handled by the application | |
760 | * or the library. | |
761 | * | |
762 | * Returns: | |
763 | * > 0 (success, FD is kept by application) | |
764 | * == 0 (success, FD is left to library) | |
765 | * < 0 (error) | |
766 | */ | |
30319bcb | 767 | int (*on_update_stream)(uint64_t sessiond_key, uint32_t state); |
331744e3 | 768 | enum lttng_consumer_type type; |
3bd1e081 MD |
769 | /* socket to communicate errors with sessiond */ |
770 | int consumer_error_socket; | |
75d83e50 | 771 | /* socket to ask metadata to sessiond. */ |
331744e3 | 772 | int consumer_metadata_socket; |
ace17efa MD |
773 | /* |
774 | * Protect consumer_metadata_socket. | |
775 | * | |
776 | * This is nested OUTSIDE the metadata cache lock. | |
777 | */ | |
75d83e50 | 778 | pthread_mutex_t metadata_socket_lock; |
3bd1e081 MD |
779 | /* socket to exchange commands with sessiond */ |
780 | char *consumer_command_sock_path; | |
781 | /* communication with splice */ | |
d8ef542d | 782 | int consumer_channel_pipe[2]; |
50f8ae69 | 783 | /* Data stream poll thread pipe. To transfer data stream to the thread */ |
acdb9057 | 784 | struct lttng_pipe *consumer_data_pipe; |
02b3d176 DG |
785 | |
786 | /* | |
787 | * Data thread use that pipe to catch wakeup from read subbuffer that | |
788 | * detects that there is still data to be read for the stream encountered. | |
789 | * Before doing so, the stream is flagged to indicate that there is still | |
790 | * data to be read. | |
791 | * | |
792 | * Both pipes (read/write) are owned and used inside the data thread. | |
793 | */ | |
794 | struct lttng_pipe *consumer_wakeup_pipe; | |
795 | /* Indicate if the wakeup thread has been notified. */ | |
796 | unsigned int has_wakeup:1; | |
797 | ||
3bd1e081 MD |
798 | /* to let the signal handler wake up the fd receiver thread */ |
799 | int consumer_should_quit[2]; | |
fb3a43a9 | 800 | /* Metadata poll thread pipe. Transfer metadata stream to it */ |
13886d2d | 801 | struct lttng_pipe *consumer_metadata_pipe; |
b3530820 JG |
802 | /* |
803 | * Pipe used by the channel monitoring timers to provide state samples | |
804 | * to the session daemon (write-only). | |
805 | */ | |
806 | int channel_monitor_pipe; | |
3654ed19 | 807 | LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid; |
3bd1e081 MD |
808 | }; |
809 | ||
810 | /* | |
811 | * Library-level data. One instance per process. | |
812 | */ | |
813 | struct lttng_consumer_global_data { | |
814 | /* | |
e4421fec DG |
815 | * At this time, this lock is used to ensure coherence between the count |
816 | * and number of element in the hash table. It's also a protection for | |
6065ceec DG |
817 | * concurrent read/write between threads. |
818 | * | |
74251bb8 DG |
819 | * This is nested OUTSIDE the stream lock. |
820 | * This is nested OUTSIDE the consumer_relayd_sock_pair lock. | |
3bd1e081 | 821 | */ |
28f23191 | 822 | pthread_mutex_t lock{}; |
e4421fec | 823 | |
3bd1e081 | 824 | /* |
3cc2f24a DG |
825 | * Number of streams in the data stream hash table declared outside. |
826 | * Protected by consumer_data.lock. | |
3bd1e081 | 827 | */ |
97535efa | 828 | int stream_count = 0; |
3cc2f24a DG |
829 | |
830 | /* Channel hash table protected by consumer_data.lock. */ | |
97535efa | 831 | struct lttng_ht *channel_ht = nullptr; |
5c3892a6 | 832 | /* Channel hash table indexed by session id. */ |
97535efa | 833 | struct lttng_ht *channels_by_session_id_ht = nullptr; |
3bd1e081 MD |
834 | /* |
835 | * Flag specifying if the local array of FDs needs update in the | |
836 | * poll function. Protected by consumer_data.lock. | |
837 | */ | |
97535efa SM |
838 | unsigned int need_update = 1; |
839 | enum lttng_consumer_type type = LTTNG_CONSUMER_UNKNOWN; | |
00e2e675 DG |
840 | |
841 | /* | |
842 | * Relayd socket(s) hashtable indexed by network sequence number. Each | |
843 | * stream has an index which associate the right relayd socket to use. | |
844 | */ | |
97535efa | 845 | struct lttng_ht *relayd_ht = nullptr; |
53632229 DG |
846 | |
847 | /* | |
848 | * This hash table contains all streams (metadata and data) indexed by | |
849 | * session id. In other words, the ht is indexed by session id and each | |
850 | * bucket contains the list of associated streams. | |
851 | * | |
852 | * This HT uses the "node_session_id" of the consumer stream. | |
853 | */ | |
97535efa | 854 | struct lttng_ht *stream_list_ht = nullptr; |
d8ef542d MD |
855 | |
856 | /* | |
857 | * This HT uses the "node_channel_id" of the consumer stream. | |
858 | */ | |
97535efa | 859 | struct lttng_ht *stream_per_chan_id_ht = nullptr; |
28cc88f3 JG |
860 | |
861 | /* | |
862 | * Trace chunk registry indexed by (session_id, chunk_id). | |
863 | */ | |
97535efa | 864 | struct lttng_trace_chunk_registry *chunk_registry = nullptr; |
3bd1e081 MD |
865 | }; |
866 | ||
10211f5c MD |
867 | /* |
868 | * Set to nonzero when the consumer is exiting. Updated by signal | |
869 | * handler and thread exit, read by threads. | |
870 | */ | |
871 | extern int consumer_quit; | |
872 | ||
13675d0e MD |
873 | /* |
874 | * Set to nonzero when the consumer is exiting. Updated by signal | |
875 | * handler and thread exit, read by threads. | |
876 | */ | |
877 | extern int consumer_quit; | |
878 | ||
4bd69c5f SM |
879 | /* |
880 | * Flag used to temporarily pause data consumption from testpoints. | |
881 | * | |
882 | * This variable is dlsym-ed from a test, so needs to be exported. | |
883 | */ | |
884 | LTTNG_EXPORT extern int data_consumption_paused; | |
cf0bcb51 | 885 | |
92816cc3 | 886 | /* Return a human-readable consumer type string that is suitable for logging. */ |
28f23191 | 887 | static inline const char *lttng_consumer_type_str(enum lttng_consumer_type type) |
92816cc3 JG |
888 | { |
889 | switch (type) { | |
890 | case LTTNG_CONSUMER_UNKNOWN: | |
891 | return "unknown"; | |
892 | case LTTNG_CONSUMER_KERNEL: | |
893 | return "kernel"; | |
894 | case LTTNG_CONSUMER32_UST: | |
895 | return "32-bit user space"; | |
896 | case LTTNG_CONSUMER64_UST: | |
897 | return "64-bit user space"; | |
898 | default: | |
899 | abort(); | |
900 | } | |
901 | } | |
902 | ||
e4421fec DG |
903 | /* |
904 | * Init consumer data structures. | |
905 | */ | |
cd9adb8b | 906 | int lttng_consumer_init(); |
e4421fec | 907 | |
3bd1e081 MD |
908 | /* |
909 | * Set the error socket for communication with a session daemon. | |
910 | */ | |
28f23191 | 911 | void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx, int sock); |
3bd1e081 MD |
912 | |
913 | /* | |
914 | * Set the command socket path for communication with a session daemon. | |
915 | */ | |
28f23191 | 916 | void lttng_consumer_set_command_sock_path(struct lttng_consumer_local_data *ctx, char *sock); |
3bd1e081 MD |
917 | |
918 | /* | |
919 | * Send return code to session daemon. | |
920 | * | |
921 | * Returns the return code of sendmsg : the number of bytes transmitted or -1 | |
922 | * on error. | |
923 | */ | |
ffe60014 | 924 | int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd); |
3bd1e081 MD |
925 | |
926 | /* | |
927 | * Called from signal handler to ensure a clean exit. | |
928 | */ | |
ffe60014 | 929 | void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx); |
3bd1e081 MD |
930 | |
931 | /* | |
932 | * Cleanup the daemon's socket on exit. | |
933 | */ | |
cd9adb8b | 934 | void lttng_consumer_cleanup(); |
3bd1e081 | 935 | |
3bd1e081 MD |
936 | /* |
937 | * Poll on the should_quit pipe and the command socket return -1 on error and | |
938 | * should exit, 0 if data is available on the command socket | |
939 | */ | |
ffe60014 | 940 | int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll); |
3bd1e081 | 941 | |
d9a2e16e JD |
942 | /* |
943 | * Copy the fields from the channel that need to be accessed (read-only) | |
944 | * directly from the stream. | |
945 | */ | |
28f23191 JG |
946 | void consumer_stream_update_channel_attributes(struct lttng_consumer_stream *stream, |
947 | struct lttng_consumer_channel *channel); | |
948 | ||
949 | struct lttng_consumer_stream *consumer_allocate_stream(struct lttng_consumer_channel *channel, | |
950 | uint64_t channel_key, | |
951 | uint64_t stream_key, | |
952 | const char *channel_name, | |
953 | uint64_t relayd_id, | |
954 | uint64_t session_id, | |
955 | struct lttng_trace_chunk *trace_chunk, | |
956 | int cpu, | |
957 | int *alloc_ret, | |
958 | enum consumer_channel_type type, | |
959 | unsigned int monitor); | |
d88aee68 | 960 | struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key, |
28f23191 JG |
961 | uint64_t session_id, |
962 | const uint64_t *chunk_id, | |
963 | const char *pathname, | |
964 | const char *name, | |
965 | uint64_t relayd_id, | |
966 | enum lttng_event_output output, | |
967 | uint64_t tracefile_size, | |
968 | uint64_t tracefile_count, | |
969 | uint64_t session_id_per_pid, | |
970 | unsigned int monitor, | |
971 | unsigned int live_timer_interval, | |
972 | bool is_in_live_session, | |
973 | const char *root_shm_path, | |
974 | const char *shm_path); | |
975 | void consumer_del_stream(struct lttng_consumer_stream *stream, struct lttng_ht *ht); | |
976 | void consumer_del_metadata_stream(struct lttng_consumer_stream *stream, struct lttng_ht *ht); | |
d8ef542d | 977 | int consumer_add_channel(struct lttng_consumer_channel *channel, |
28f23191 | 978 | struct lttng_consumer_local_data *ctx); |
ffe60014 | 979 | void consumer_del_channel(struct lttng_consumer_channel *channel); |
3bd1e081 | 980 | |
00e2e675 | 981 | /* lttng-relayd consumer command */ |
d88aee68 | 982 | struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key); |
10a50311 | 983 | int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path); |
a4baae1b | 984 | int consumer_send_relayd_streams_sent(uint64_t net_seq_idx); |
10a50311 | 985 | void close_relayd_stream(struct lttng_consumer_stream *stream); |
d88aee68 | 986 | struct lttng_consumer_channel *consumer_find_channel(uint64_t key); |
28f23191 | 987 | int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream, size_t data_size); |
c869f647 | 988 | void consumer_steal_stream_key(int key, struct lttng_ht *ht); |
00e2e675 | 989 | |
28f23191 JG |
990 | struct lttng_consumer_local_data * |
991 | lttng_consumer_create(enum lttng_consumer_type type, | |
992 | ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream, | |
993 | struct lttng_consumer_local_data *ctx, | |
994 | bool locked_by_caller), | |
995 | int (*recv_channel)(struct lttng_consumer_channel *channel), | |
996 | int (*recv_stream)(struct lttng_consumer_stream *stream), | |
997 | int (*update_stream)(uint64_t sessiond_key, uint32_t state)); | |
ffe60014 | 998 | void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx); |
28f23191 JG |
999 | ssize_t lttng_consumer_on_read_subbuffer_mmap(struct lttng_consumer_stream *stream, |
1000 | const struct lttng_buffer_view *buffer, | |
1001 | unsigned long padding); | |
1002 | ssize_t lttng_consumer_on_read_subbuffer_splice(struct lttng_consumer_local_data *ctx, | |
1003 | struct lttng_consumer_stream *stream, | |
1004 | unsigned long len, | |
1005 | unsigned long padding); | |
15055ce5 | 1006 | int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream); |
ffe60014 | 1007 | int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream); |
28f23191 JG |
1008 | int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream, unsigned long *pos); |
1009 | int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream, unsigned long *pos); | |
6d574024 DG |
1010 | int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream); |
1011 | int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream); | |
ffe60014 DG |
1012 | void *consumer_thread_metadata_poll(void *data); |
1013 | void *consumer_thread_data_poll(void *data); | |
1014 | void *consumer_thread_sessiond_poll(void *data); | |
d8ef542d | 1015 | void *consumer_thread_channel_poll(void *data); |
ffe60014 | 1016 | int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx, |
28f23191 JG |
1017 | int sock, |
1018 | struct pollfd *consumer_sockpoll); | |
3bd1e081 | 1019 | |
4078b776 | 1020 | ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream, |
28f23191 JG |
1021 | struct lttng_consumer_local_data *ctx, |
1022 | bool locked_by_caller); | |
d41f73b7 | 1023 | int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream); |
4222116f | 1024 | void consumer_add_relayd_socket(uint64_t net_seq_idx, |
28f23191 JG |
1025 | int sock_type, |
1026 | struct lttng_consumer_local_data *ctx, | |
1027 | int sock, | |
1028 | struct pollfd *consumer_sockpoll, | |
1029 | uint64_t sessiond_id, | |
1030 | uint64_t relayd_session_id, | |
1031 | uint32_t relayd_version_major, | |
1032 | uint32_t relayd_version_minor, | |
1033 | enum lttcomm_sock_proto relayd_socket_protocol); | |
1034 | void consumer_flag_relayd_for_destroy(struct consumer_relayd_sock_pair *relayd); | |
6d805429 | 1035 | int consumer_data_pending(uint64_t id); |
f50f23d9 | 1036 | int consumer_send_status_msg(int sock, int ret_code); |
28f23191 JG |
1037 | int consumer_send_status_channel(int sock, struct lttng_consumer_channel *channel); |
1038 | void notify_thread_del_channel(struct lttng_consumer_local_data *ctx, uint64_t key); | |
51230d70 | 1039 | void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd); |
d07ceecd | 1040 | unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos, |
28f23191 JG |
1041 | unsigned long produced_pos, |
1042 | uint64_t nb_packets_per_stream, | |
1043 | uint64_t max_sb_size); | |
66d583dc | 1044 | void consumer_add_data_stream(struct lttng_consumer_stream *stream); |
5ab66908 | 1045 | void consumer_del_stream_for_data(struct lttng_consumer_stream *stream); |
66d583dc | 1046 | void consumer_add_metadata_stream(struct lttng_consumer_stream *stream); |
5ab66908 | 1047 | void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream); |
309167d2 | 1048 | int consumer_create_index_file(struct lttng_consumer_stream *stream); |
92b7a7f8 | 1049 | int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel, |
28f23191 JG |
1050 | uint64_t key, |
1051 | uint64_t relayd_id); | |
02d02e31 | 1052 | int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream); |
f46376a1 | 1053 | int lttng_consumer_rotate_stream(struct lttng_consumer_stream *stream); |
28f23191 | 1054 | int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel, uint64_t key); |
d73bf3d7 | 1055 | void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream); |
28f23191 JG |
1056 | enum lttcomm_return_code |
1057 | lttng_consumer_create_trace_chunk(const uint64_t *relayd_id, | |
1058 | uint64_t session_id, | |
1059 | uint64_t chunk_id, | |
1060 | time_t chunk_creation_timestamp, | |
1061 | const char *chunk_override_name, | |
1062 | const struct lttng_credentials *credentials, | |
1063 | struct lttng_directory_handle *chunk_directory_handle); | |
1064 | enum lttcomm_return_code | |
1065 | lttng_consumer_close_trace_chunk(const uint64_t *relayd_id, | |
1066 | uint64_t session_id, | |
1067 | uint64_t chunk_id, | |
1068 | time_t chunk_close_timestamp, | |
1069 | const enum lttng_trace_chunk_command_type *close_command, | |
1070 | char *path); | |
1071 | enum lttcomm_return_code lttng_consumer_trace_chunk_exists(const uint64_t *relayd_id, | |
1072 | uint64_t session_id, | |
1073 | uint64_t chunk_id); | |
9276e5c8 | 1074 | void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd); |
28f23191 JG |
1075 | enum lttcomm_return_code lttng_consumer_init_command(struct lttng_consumer_local_data *ctx, |
1076 | const lttng_uuid& sessiond_uuid); | |
5f3aff8b | 1077 | int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel); |
28f23191 JG |
1078 | enum lttcomm_return_code |
1079 | lttng_consumer_open_channel_packets(struct lttng_consumer_channel *channel); | |
b1316da1 | 1080 | int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel *channel); |
881fc67f | 1081 | void lttng_consumer_sigbus_handle(void *addr); |
9cc4ae91 | 1082 | void sample_and_send_channel_buffer_stats(struct lttng_consumer_channel *channel); |
d41f73b7 | 1083 | |
f02e1e8a | 1084 | #endif /* LIB_CONSUMER_H */ |