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