Fix: HT must not be destroyed with a rcu_read_lock held
[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
f1e16794 21#include <common/consumer.h>
173af62f 22#include <common/hashtable/hashtable.h>
00e2e675
DG
23#include <lttng/lttng.h>
24
6dc3064a
DG
25#include "snapshot.h"
26
27struct snapshot;
28struct snapshot_output;
29
00e2e675
DG
30enum consumer_dst_type {
31 CONSUMER_DST_LOCAL,
32 CONSUMER_DST_NET,
33};
f1e16794 34
173af62f 35struct consumer_socket {
4ce514c4
DG
36 /*
37 * File descriptor. This is just a reference to the consumer data meaning
9363801e
DG
38 * that every access must be locked and checked for a possible invalid
39 * value.
4ce514c4 40 */
9363801e 41 int *fd_ptr;
4ce514c4 42
173af62f
DG
43 /*
44 * To use this socket (send/recv), this lock MUST be acquired.
45 */
46 pthread_mutex_t *lock;
2f77fc4b
DG
47
48 /*
49 * Indicates if the socket was registered by a third part
50 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
51 * During the destroy phase of a consumer output, we close the socket if
52 * this flag is set to 1 since we don't need the fd anymore.
53 */
54 unsigned int registered;
55
ffe60014
DG
56 /* Flag if network sockets were sent to the consumer. */
57 unsigned int control_sock_sent;
58 unsigned int data_sock_sent;
59
173af62f 60 struct lttng_ht_node_ulong node;
6dc3064a
DG
61
62 enum lttng_consumer_type type;
173af62f
DG
63};
64
f1e16794
DG
65struct consumer_data {
66 enum lttng_consumer_type type;
67
68 pthread_t thread; /* Worker thread interacting with the consumer */
a23ec3a7
DG
69
70 /* Conditions used by the consumer thread to indicate readiness. */
71 pthread_cond_t cond;
72 pthread_condattr_t condattr;
73 pthread_mutex_t cond_mutex;
74
75 /*
76 * This is a flag condition indicating that the consumer thread is ready
77 * and connected to the lttng-consumerd daemon. This flag MUST only be
78 * updated by locking the condition mutex above or before spawning a
79 * consumer thread.
80 *
81 * A value of 0 means that the thread is NOT ready. A value of 1 means that
82 * the thread consumer did connect successfully to the lttng-consumerd
83 * daemon. A negative value indicates that there is been an error and the
84 * thread has likely quit.
85 */
86 int consumer_thread_is_ready;
f1e16794
DG
87
88 /* Mutex to control consumerd pid assignation */
89 pthread_mutex_t pid_mutex;
90 pid_t pid;
91
92 int err_sock;
331744e3 93 /* These two sockets uses the cmd_unix_sock_path. */
f1e16794 94 int cmd_sock;
4ce514c4
DG
95 /*
96 * The metadata socket object is handled differently and only created
97 * locally in this object thus it's the only reference available in the
9363801e
DG
98 * session daemon. For that reason, a variable for the fd is required and
99 * the metadata socket fd points to it.
4ce514c4
DG
100 */
101 int metadata_fd;
331744e3 102 struct consumer_socket metadata_sock;
f1e16794
DG
103
104 /* consumer error and command Unix socket path */
105 char err_unix_sock_path[PATH_MAX];
106 char cmd_unix_sock_path[PATH_MAX];
44a5e5eb 107
92db7cdc
DG
108 /*
109 * This lock has two purposes. It protects any change to the consumer
110 * socket and make sure only one thread uses this object for read/write
111 * operations.
112 */
173af62f 113 pthread_mutex_t lock;
f1e16794
DG
114};
115
00e2e675
DG
116/*
117 * Network URIs
118 */
119struct consumer_net {
120 /*
121 * Indicate if URI type is set. Those flags should only be set when the
122 * created URI is done AND valid.
123 */
124 int control_isset;
125 int data_isset;
126
127 /*
128 * The following two URIs MUST have the same destination address for
129 * network streaming to work. Network hop are not yet supported.
130 */
131
132 /* Control path for network streaming. */
133 struct lttng_uri control;
134
135 /* Data path for network streaming. */
136 struct lttng_uri data;
137};
138
139/*
140 * Consumer output object describing where and how to send data.
141 */
142struct consumer_output {
00e2e675
DG
143 /* If the consumer is enabled meaning that should be used */
144 unsigned int enabled;
145 enum consumer_dst_type type;
173af62f 146
00e2e675
DG
147 /*
148 * The net_seq_index is the index of the network stream on the consumer
3f8e211f
DG
149 * side. It tells the consumer which streams goes to which relayd with this
150 * index. The relayd sockets are index with it on the consumer side.
00e2e675 151 */
d88aee68 152 uint64_t net_seq_index;
173af62f 153
00e2e675
DG
154 /*
155 * Subdirectory path name used for both local and network consumer.
156 */
157 char subdir[PATH_MAX];
173af62f
DG
158
159 /*
160 * Hashtable of consumer_socket index by the file descriptor value. For
161 * multiarch consumer support, we can have more than one consumer (ex: 32
162 * and 64 bit).
163 */
164 struct lttng_ht *socks;
165
7d2f7452
DG
166 /* Tell if this output is used for snapshot. */
167 unsigned int snapshot:1;
168
00e2e675
DG
169 union {
170 char trace_path[PATH_MAX];
171 struct consumer_net net;
172 } dst;
173};
174
173af62f
DG
175struct consumer_socket *consumer_find_socket(int key,
176 struct consumer_output *consumer);
7972aab2
DG
177struct consumer_socket *consumer_find_socket_by_bitness(int bits,
178 struct consumer_output *consumer);
4ce514c4 179struct consumer_socket *consumer_allocate_socket(int *fd);
173af62f
DG
180void consumer_add_socket(struct consumer_socket *sock,
181 struct consumer_output *consumer);
182void consumer_del_socket(struct consumer_socket *sock,
183 struct consumer_output *consumer);
184void consumer_destroy_socket(struct consumer_socket *sock);
6dc3064a
DG
185int consumer_copy_sockets(struct consumer_output *dst,
186 struct consumer_output *src);
af706bb7 187void consumer_destroy_output_sockets(struct consumer_output *obj);
52898cb1
DG
188int consumer_socket_send(struct consumer_socket *socket, void *msg,
189 size_t len);
190int consumer_socket_recv(struct consumer_socket *socket, void *msg,
191 size_t len);
173af62f 192
00e2e675
DG
193struct consumer_output *consumer_create_output(enum consumer_dst_type type);
194struct consumer_output *consumer_copy_output(struct consumer_output *obj);
195void consumer_destroy_output(struct consumer_output *obj);
196int consumer_set_network_uri(struct consumer_output *obj,
197 struct lttng_uri *uri);
f50f23d9 198int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd);
ffe60014
DG
199int consumer_send_msg(struct consumer_socket *sock,
200 struct lttcomm_consumer_msg *msg);
f50f23d9
DG
201int consumer_send_stream(struct consumer_socket *sock,
202 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
203 int *fds, size_t nb_fd);
204int consumer_send_channel(struct consumer_socket *sock,
205 struct lttcomm_consumer_msg *msg);
206int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
6151a90f 207 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
d3e2ba59
JD
208 enum lttng_stream_type type, uint64_t session_id,
209 char *session_name, char *hostname, int session_live_timer);
173af62f
DG
210int consumer_send_destroy_relayd(struct consumer_socket *sock,
211 struct consumer_output *consumer);
f50f23d9 212int consumer_recv_status_reply(struct consumer_socket *sock);
ffe60014 213int consumer_recv_status_channel(struct consumer_socket *sock,
d88aee68 214 uint64_t *key, unsigned int *stream_count);
2f77fc4b 215void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
a4b92340
DG
216int consumer_create_socket(struct consumer_data *data,
217 struct consumer_output *output);
2f77fc4b
DG
218int consumer_set_subdir(struct consumer_output *consumer,
219 const char *session_name);
37278a1e 220
ffe60014
DG
221void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
222 uint64_t subbuf_size,
223 uint64_t num_subbuf,
224 int overwrite,
225 unsigned int switch_timer_interval,
226 unsigned int read_timer_interval,
ecc48a90 227 unsigned int live_timer_interval,
ffe60014
DG
228 int output,
229 int type,
230 uint64_t session_id,
231 const char *pathname,
232 const char *name,
233 uid_t uid,
234 gid_t gid,
d88aee68
DG
235 uint64_t relayd_id,
236 uint64_t key,
7972aab2 237 unsigned char *uuid,
1624d5b7
JD
238 uint32_t chan_id,
239 uint64_t tracefile_size,
2bba9e53 240 uint64_t tracefile_count,
1950109e 241 uint64_t session_id_per_pid,
567eb353
DG
242 unsigned int monitor,
243 uint32_t ust_app_uid);
00e2e675
DG
244void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
245 enum lttng_consumer_command cmd,
d88aee68
DG
246 uint64_t channel_key,
247 uint64_t stream_key,
ffe60014 248 int cpu);
a4baae1b
JD
249void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
250 enum lttng_consumer_command cmd,
251 uint64_t channel_key, uint64_t net_seq_idx);
00e2e675
DG
252void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
253 enum lttng_consumer_command cmd,
d88aee68 254 uint64_t channel_key,
ffe60014
DG
255 uint64_t session_id,
256 const char *pathname,
257 uid_t uid,
258 gid_t gid,
d88aee68 259 uint64_t relayd_id,
c30aaa51 260 const char *name,
ffe60014
DG
261 unsigned int nb_init_streams,
262 enum lttng_event_output output,
1624d5b7
JD
263 int type,
264 uint64_t tracefile_size,
2bba9e53 265 uint64_t tracefile_count,
ecc48a90
JD
266 unsigned int monitor,
267 unsigned int live_timer_interval);
d88aee68 268int consumer_is_data_pending(uint64_t session_id,
806e2684 269 struct consumer_output *consumer);
7972aab2
DG
270int consumer_close_metadata(struct consumer_socket *socket,
271 uint64_t metadata_key);
272int consumer_setup_metadata(struct consumer_socket *socket,
273 uint64_t metadata_key);
274int consumer_push_metadata(struct consumer_socket *socket,
275 uint64_t metadata_key, char *metadata_str, size_t len,
276 size_t target_offset);
277int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
00e2e675 278
6dc3064a
DG
279/* Snapshot command. */
280int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key,
281 struct snapshot_output *output, int metadata, uid_t uid, gid_t gid,
5c786ded 282 const char *session_path, int wait, int max_size_per_stream);
6dc3064a 283
f1e16794 284#endif /* _CONSUMER_H */
This page took 0.046582 seconds and 4 git commands to generate.