sessiond: clean-up: typo in ust-app.c comment
[lttng-tools.git] / src / bin / lttng-sessiond / consumer.h
CommitLineData
f1e16794
DG
1/*
2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 */
17
18#ifndef _CONSUMER_H
19#define _CONSUMER_H
20
c8fea79c 21#include <common/consumer/consumer.h>
173af62f 22#include <common/hashtable/hashtable.h>
00e2e675 23#include <lttng/lttng.h>
6addfa37 24#include <urcu/ref.h>
00e2e675 25
6dc3064a
DG
26#include "snapshot.h"
27
28struct snapshot;
29struct snapshot_output;
b178f53e 30struct ltt_session;
6dc3064a 31
00e2e675
DG
32enum consumer_dst_type {
33 CONSUMER_DST_LOCAL,
34 CONSUMER_DST_NET,
35};
f1e16794 36
d2956687
JG
37enum consumer_trace_chunk_exists_status {
38 CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_LOCAL,
39 CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_REMOTE,
40 CONSUMER_TRACE_CHUNK_EXISTS_STATUS_UNKNOWN_CHUNK,
41};
42
173af62f 43struct consumer_socket {
4ce514c4
DG
44 /*
45 * File descriptor. This is just a reference to the consumer data meaning
9363801e
DG
46 * that every access must be locked and checked for a possible invalid
47 * value.
4ce514c4 48 */
9363801e 49 int *fd_ptr;
4ce514c4 50
173af62f
DG
51 /*
52 * To use this socket (send/recv), this lock MUST be acquired.
53 */
54 pthread_mutex_t *lock;
2f77fc4b
DG
55
56 /*
57 * Indicates if the socket was registered by a third part
58 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
59 * During the destroy phase of a consumer output, we close the socket if
60 * this flag is set to 1 since we don't need the fd anymore.
61 */
62 unsigned int registered;
63
ffe60014
DG
64 /* Flag if network sockets were sent to the consumer. */
65 unsigned int control_sock_sent;
66 unsigned int data_sock_sent;
67
173af62f 68 struct lttng_ht_node_ulong node;
6dc3064a
DG
69
70 enum lttng_consumer_type type;
173af62f
DG
71};
72
f1e16794
DG
73struct consumer_data {
74 enum lttng_consumer_type type;
75
f1e16794
DG
76 /* Mutex to control consumerd pid assignation */
77 pthread_mutex_t pid_mutex;
78 pid_t pid;
79
80 int err_sock;
331744e3 81 /* These two sockets uses the cmd_unix_sock_path. */
f1e16794 82 int cmd_sock;
e9404c27
JG
83 /*
84 * Write-end of the channel monitoring pipe to be passed to the
85 * consumer.
86 */
87 int channel_monitor_pipe;
4ce514c4
DG
88 /*
89 * The metadata socket object is handled differently and only created
90 * locally in this object thus it's the only reference available in the
9363801e
DG
91 * session daemon. For that reason, a variable for the fd is required and
92 * the metadata socket fd points to it.
4ce514c4
DG
93 */
94 int metadata_fd;
331744e3 95 struct consumer_socket metadata_sock;
f1e16794
DG
96
97 /* consumer error and command Unix socket path */
e6142f2e
JG
98 const char *err_unix_sock_path;
99 const char *cmd_unix_sock_path;
44a5e5eb 100
92db7cdc
DG
101 /*
102 * This lock has two purposes. It protects any change to the consumer
103 * socket and make sure only one thread uses this object for read/write
104 * operations.
105 */
173af62f 106 pthread_mutex_t lock;
f1e16794
DG
107};
108
00e2e675
DG
109/*
110 * Network URIs
111 */
112struct consumer_net {
113 /*
114 * Indicate if URI type is set. Those flags should only be set when the
115 * created URI is done AND valid.
116 */
117 int control_isset;
118 int data_isset;
119
120 /*
121 * The following two URIs MUST have the same destination address for
122 * network streaming to work. Network hop are not yet supported.
123 */
124
125 /* Control path for network streaming. */
126 struct lttng_uri control;
127
128 /* Data path for network streaming. */
129 struct lttng_uri data;
2b29c638
JD
130
131 /* <hostname>/<session-name> */
132 char base_dir[PATH_MAX];
00e2e675
DG
133};
134
135/*
136 * Consumer output object describing where and how to send data.
137 */
138struct consumer_output {
6addfa37
MD
139 struct urcu_ref ref; /* Refcount */
140
00e2e675
DG
141 /* If the consumer is enabled meaning that should be used */
142 unsigned int enabled;
143 enum consumer_dst_type type;
173af62f 144
00e2e675
DG
145 /*
146 * The net_seq_index is the index of the network stream on the consumer
3f8e211f
DG
147 * side. It tells the consumer which streams goes to which relayd with this
148 * index. The relayd sockets are index with it on the consumer side.
00e2e675 149 */
d88aee68 150 uint64_t net_seq_index;
b31610f2
JD
151 /* Store the relay protocol in use if the session is remote. */
152 uint32_t relay_major_version;
153 uint32_t relay_minor_version;
173af62f 154
00e2e675 155 /*
366a9222 156 * Subdirectory path name used for both local and network
d2956687 157 * consumer ("kernel", "ust", or empty).
00e2e675 158 */
b178f53e
JG
159 char domain_subdir[max(sizeof(DEFAULT_KERNEL_TRACE_DIR),
160 sizeof(DEFAULT_UST_TRACE_DIR))];
173af62f
DG
161
162 /*
163 * Hashtable of consumer_socket index by the file descriptor value. For
b178f53e
JG
164 * multiarch consumer support, we can have more than one consumer (ex:
165 * 32 and 64 bit).
173af62f
DG
166 */
167 struct lttng_ht *socks;
168
7d2f7452
DG
169 /* Tell if this output is used for snapshot. */
170 unsigned int snapshot:1;
171
00e2e675 172 union {
61ba6b6d 173 char session_root_path[LTTNG_PATH_MAX];
00e2e675
DG
174 struct consumer_net net;
175 } dst;
366a9222
JD
176
177 /*
178 * Sub-directory below the session_root_path where the next chunk of
179 * trace will be stored (\0 before the first session rotation).
180 */
61ba6b6d 181 char chunk_path[LTTNG_PATH_MAX];
00e2e675
DG
182};
183
173af62f 184struct consumer_socket *consumer_find_socket(int key,
348a81dc 185 const struct consumer_output *consumer);
7972aab2 186struct consumer_socket *consumer_find_socket_by_bitness(int bits,
348a81dc 187 const struct consumer_output *consumer);
4ce514c4 188struct consumer_socket *consumer_allocate_socket(int *fd);
173af62f
DG
189void consumer_add_socket(struct consumer_socket *sock,
190 struct consumer_output *consumer);
191void consumer_del_socket(struct consumer_socket *sock,
192 struct consumer_output *consumer);
193void consumer_destroy_socket(struct consumer_socket *sock);
6dc3064a
DG
194int consumer_copy_sockets(struct consumer_output *dst,
195 struct consumer_output *src);
af706bb7 196void consumer_destroy_output_sockets(struct consumer_output *obj);
52898cb1
DG
197int consumer_socket_send(struct consumer_socket *socket, void *msg,
198 size_t len);
199int consumer_socket_recv(struct consumer_socket *socket, void *msg,
200 size_t len);
173af62f 201
00e2e675
DG
202struct consumer_output *consumer_create_output(enum consumer_dst_type type);
203struct consumer_output *consumer_copy_output(struct consumer_output *obj);
6addfa37
MD
204void consumer_output_get(struct consumer_output *obj);
205void consumer_output_put(struct consumer_output *obj);
b178f53e
JG
206int consumer_set_network_uri(const struct ltt_session *session,
207 struct consumer_output *obj,
00e2e675 208 struct lttng_uri *uri);
ac2f30af
JG
209int consumer_send_fds(struct consumer_socket *sock, const int *fds,
210 size_t nb_fd);
ffe60014
DG
211int consumer_send_msg(struct consumer_socket *sock,
212 struct lttcomm_consumer_msg *msg);
f50f23d9
DG
213int consumer_send_stream(struct consumer_socket *sock,
214 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
ac2f30af 215 const int *fds, size_t nb_fd);
f50f23d9
DG
216int consumer_send_channel(struct consumer_socket *sock,
217 struct lttcomm_consumer_msg *msg);
218int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
6151a90f 219 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
d3e2ba59 220 enum lttng_stream_type type, uint64_t session_id,
fb9a95c4 221 const char *session_name, const char *hostname,
6fa5fe7c 222 const char *base_path, int session_live_timer,
46ef2188
MD
223 const uint64_t *current_chunk_id, time_t session_creation_time,
224 bool session_name_contains_creation_time);
e9404c27
JG
225int consumer_send_channel_monitor_pipe(struct consumer_socket *consumer_sock,
226 int pipe);
173af62f
DG
227int consumer_send_destroy_relayd(struct consumer_socket *sock,
228 struct consumer_output *consumer);
f50f23d9 229int consumer_recv_status_reply(struct consumer_socket *sock);
ffe60014 230int consumer_recv_status_channel(struct consumer_socket *sock,
d88aee68 231 uint64_t *key, unsigned int *stream_count);
2f77fc4b 232void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
a4b92340
DG
233int consumer_create_socket(struct consumer_data *data,
234 struct consumer_output *output);
37278a1e 235
ffe60014
DG
236void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
237 uint64_t subbuf_size,
238 uint64_t num_subbuf,
239 int overwrite,
240 unsigned int switch_timer_interval,
241 unsigned int read_timer_interval,
ecc48a90 242 unsigned int live_timer_interval,
e9404c27 243 unsigned int monitor_timer_interval,
ffe60014
DG
244 int output,
245 int type,
246 uint64_t session_id,
247 const char *pathname,
248 const char *name,
d88aee68
DG
249 uint64_t relayd_id,
250 uint64_t key,
7972aab2 251 unsigned char *uuid,
1624d5b7
JD
252 uint32_t chan_id,
253 uint64_t tracefile_size,
2bba9e53 254 uint64_t tracefile_count,
1950109e 255 uint64_t session_id_per_pid,
567eb353 256 unsigned int monitor,
d7ba1388 257 uint32_t ust_app_uid,
491d1539 258 int64_t blocking_timeout,
3d071855 259 const char *root_shm_path,
e098433c 260 const char *shm_path,
1b0bebcb
JG
261 struct lttng_trace_chunk *trace_chunk,
262 const struct lttng_credentials *buffer_credentials);
e098433c 263void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg *msg,
d88aee68
DG
264 uint64_t channel_key,
265 uint64_t stream_key,
d2956687 266 int32_t cpu);
a4baae1b
JD
267void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
268 enum lttng_consumer_command cmd,
269 uint64_t channel_key, uint64_t net_seq_idx);
638e7b4e 270void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg *msg,
d88aee68 271 uint64_t channel_key,
ffe60014
DG
272 uint64_t session_id,
273 const char *pathname,
274 uid_t uid,
275 gid_t gid,
d88aee68 276 uint64_t relayd_id,
c30aaa51 277 const char *name,
ffe60014
DG
278 unsigned int nb_init_streams,
279 enum lttng_event_output output,
1624d5b7
JD
280 int type,
281 uint64_t tracefile_size,
2bba9e53 282 uint64_t tracefile_count,
ecc48a90 283 unsigned int monitor,
e9404c27 284 unsigned int live_timer_interval,
d2956687
JG
285 unsigned int monitor_timer_interval,
286 struct lttng_trace_chunk *trace_chunk);
d88aee68 287int consumer_is_data_pending(uint64_t session_id,
806e2684 288 struct consumer_output *consumer);
7972aab2
DG
289int consumer_close_metadata(struct consumer_socket *socket,
290 uint64_t metadata_key);
291int consumer_setup_metadata(struct consumer_socket *socket,
292 uint64_t metadata_key);
293int consumer_push_metadata(struct consumer_socket *socket,
294 uint64_t metadata_key, char *metadata_str, size_t len,
93ec662e 295 size_t target_offset, uint64_t version);
7972aab2 296int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
0dd01979 297int consumer_clear_quiescent_channel(struct consumer_socket *socket, uint64_t key);
fb83fe64
JD
298int consumer_get_discarded_events(uint64_t session_id, uint64_t channel_key,
299 struct consumer_output *consumer, uint64_t *discarded);
300int consumer_get_lost_packets(uint64_t session_id, uint64_t channel_key,
301 struct consumer_output *consumer, uint64_t *lost);
00e2e675 302
6dc3064a 303/* Snapshot command. */
9a654598 304enum lttng_error_code consumer_snapshot_channel(struct consumer_socket *socket,
348a81dc 305 uint64_t key, const struct consumer_output *output, int metadata,
d2956687
JG
306 uid_t uid, gid_t gid, const char *channel_path, int wait,
307 uint64_t nb_packets_per_stream);
6dc3064a 308
92816cc3 309/* Rotation commands. */
5c408ad8
JD
310int consumer_rotate_channel(struct consumer_socket *socket, uint64_t key,
311 uid_t uid, gid_t gid, struct consumer_output *output,
d2956687 312 bool is_metadata_channel);
09ede842
JG
313int consumer_init(struct consumer_socket *socket,
314 const lttng_uuid sessiond_uuid);
a1ae2ea5 315
d2956687
JG
316int consumer_create_trace_chunk(struct consumer_socket *socket,
317 uint64_t relayd_id, uint64_t session_id,
318 struct lttng_trace_chunk *chunk);
319int consumer_close_trace_chunk(struct consumer_socket *socket,
320 uint64_t relayd_id, uint64_t session_id,
ecd1a12f
MD
321 struct lttng_trace_chunk *chunk,
322 char *closed_trace_chunk_path);
d2956687
JG
323int consumer_trace_chunk_exists(struct consumer_socket *socket,
324 uint64_t relayd_id, uint64_t session_id,
325 struct lttng_trace_chunk *chunk,
326 enum consumer_trace_chunk_exists_status *result);
327
3b967712
MD
328char *setup_channel_trace_path(struct consumer_output *consumer,
329 const char *session_path);
330
f1e16794 331#endif /* _CONSUMER_H */
This page took 0.068018 seconds and 4 git commands to generate.