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