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