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