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