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