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