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