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