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