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