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