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