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