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