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