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