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