Add new snapshot ustctl API
[lttng-tools.git] / src / bin / lttng-sessiond / consumer.h
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
21 #include <common/consumer/consumer.h>
22 #include <common/hashtable/hashtable.h>
23 #include <lttng/lttng.h>
24 #include <urcu/ref.h>
25
26 #include "snapshot.h"
27
28 struct snapshot;
29 struct snapshot_output;
30
31 enum consumer_dst_type {
32 CONSUMER_DST_LOCAL,
33 CONSUMER_DST_NET,
34 };
35
36 struct consumer_socket {
37 /*
38 * File descriptor. This is just a reference to the consumer data meaning
39 * that every access must be locked and checked for a possible invalid
40 * value.
41 */
42 int *fd_ptr;
43
44 /*
45 * To use this socket (send/recv), this lock MUST be acquired.
46 */
47 pthread_mutex_t *lock;
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
57 /* Flag if network sockets were sent to the consumer. */
58 unsigned int control_sock_sent;
59 unsigned int data_sock_sent;
60
61 struct lttng_ht_node_ulong node;
62
63 enum lttng_consumer_type type;
64 };
65
66 struct consumer_data {
67 enum lttng_consumer_type type;
68
69 pthread_t thread; /* Worker thread interacting with the consumer */
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;
88
89 /* Mutex to control consumerd pid assignation */
90 pthread_mutex_t pid_mutex;
91 pid_t pid;
92
93 int err_sock;
94 /* These two sockets uses the cmd_unix_sock_path. */
95 int cmd_sock;
96 /*
97 * The metadata socket object is handled differently and only created
98 * locally in this object thus it's the only reference available in the
99 * session daemon. For that reason, a variable for the fd is required and
100 * the metadata socket fd points to it.
101 */
102 int metadata_fd;
103 struct consumer_socket metadata_sock;
104
105 /* consumer error and command Unix socket path */
106 char err_unix_sock_path[PATH_MAX];
107 char cmd_unix_sock_path[PATH_MAX];
108
109 /*
110 * This lock has two purposes. It protects any change to the consumer
111 * socket and make sure only one thread uses this object for read/write
112 * operations.
113 */
114 pthread_mutex_t lock;
115 };
116
117 /*
118 * Network URIs
119 */
120 struct consumer_net {
121 /*
122 * Indicate if URI type is set. Those flags should only be set when the
123 * created URI is done AND valid.
124 */
125 int control_isset;
126 int data_isset;
127
128 /*
129 * The following two URIs MUST have the same destination address for
130 * network streaming to work. Network hop are not yet supported.
131 */
132
133 /* Control path for network streaming. */
134 struct lttng_uri control;
135
136 /* Data path for network streaming. */
137 struct lttng_uri data;
138 };
139
140 /*
141 * Consumer output object describing where and how to send data.
142 */
143 struct consumer_output {
144 struct urcu_ref ref; /* Refcount */
145
146 /* If the consumer is enabled meaning that should be used */
147 unsigned int enabled;
148 enum consumer_dst_type type;
149
150 /*
151 * The net_seq_index is the index of the network stream on the consumer
152 * side. It tells the consumer which streams goes to which relayd with this
153 * index. The relayd sockets are index with it on the consumer side.
154 */
155 uint64_t net_seq_index;
156 /* Store the relay protocol in use if the session is remote. */
157 uint32_t relay_major_version;
158 uint32_t relay_minor_version;
159
160 /*
161 * Subdirectory path name used for both local and network consumer.
162 */
163 char subdir[PATH_MAX];
164
165 /*
166 * Hashtable of consumer_socket index by the file descriptor value. For
167 * multiarch consumer support, we can have more than one consumer (ex: 32
168 * and 64 bit).
169 */
170 struct lttng_ht *socks;
171
172 /* Tell if this output is used for snapshot. */
173 unsigned int snapshot:1;
174
175 union {
176 char trace_path[PATH_MAX];
177 struct consumer_net net;
178 } dst;
179 };
180
181 struct consumer_socket *consumer_find_socket(int key,
182 struct consumer_output *consumer);
183 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
184 struct consumer_output *consumer);
185 struct consumer_socket *consumer_allocate_socket(int *fd);
186 void consumer_add_socket(struct consumer_socket *sock,
187 struct consumer_output *consumer);
188 void consumer_del_socket(struct consumer_socket *sock,
189 struct consumer_output *consumer);
190 void consumer_destroy_socket(struct consumer_socket *sock);
191 int consumer_copy_sockets(struct consumer_output *dst,
192 struct consumer_output *src);
193 void consumer_destroy_output_sockets(struct consumer_output *obj);
194 int consumer_socket_send(struct consumer_socket *socket, void *msg,
195 size_t len);
196 int consumer_socket_recv(struct consumer_socket *socket, void *msg,
197 size_t len);
198
199 struct consumer_output *consumer_create_output(enum consumer_dst_type type);
200 struct consumer_output *consumer_copy_output(struct consumer_output *obj);
201 void consumer_output_get(struct consumer_output *obj);
202 void consumer_output_put(struct consumer_output *obj);
203 int consumer_set_network_uri(struct consumer_output *obj,
204 struct lttng_uri *uri);
205 int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd);
206 int consumer_send_msg(struct consumer_socket *sock,
207 struct lttcomm_consumer_msg *msg);
208 int consumer_send_stream(struct consumer_socket *sock,
209 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
210 int *fds, size_t nb_fd);
211 int consumer_send_channel(struct consumer_socket *sock,
212 struct lttcomm_consumer_msg *msg);
213 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
214 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
215 enum lttng_stream_type type, uint64_t session_id,
216 char *session_name, char *hostname, int session_live_timer);
217 int consumer_send_destroy_relayd(struct consumer_socket *sock,
218 struct consumer_output *consumer);
219 int consumer_recv_status_reply(struct consumer_socket *sock);
220 int consumer_recv_status_channel(struct consumer_socket *sock,
221 uint64_t *key, unsigned int *stream_count);
222 void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
223 int consumer_create_socket(struct consumer_data *data,
224 struct consumer_output *output);
225 int consumer_set_subdir(struct consumer_output *consumer,
226 const char *session_name);
227
228 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
229 uint64_t subbuf_size,
230 uint64_t num_subbuf,
231 int overwrite,
232 unsigned int switch_timer_interval,
233 unsigned int read_timer_interval,
234 unsigned int live_timer_interval,
235 int output,
236 int type,
237 uint64_t session_id,
238 const char *pathname,
239 const char *name,
240 uid_t uid,
241 gid_t gid,
242 uint64_t relayd_id,
243 uint64_t key,
244 unsigned char *uuid,
245 uint32_t chan_id,
246 uint64_t tracefile_size,
247 uint64_t tracefile_count,
248 uint64_t session_id_per_pid,
249 unsigned int monitor,
250 uint32_t ust_app_uid,
251 const char *root_shm_path,
252 const char *shm_path);
253 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
254 enum lttng_consumer_command cmd,
255 uint64_t channel_key,
256 uint64_t stream_key,
257 int cpu);
258 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
259 enum lttng_consumer_command cmd,
260 uint64_t channel_key, uint64_t net_seq_idx);
261 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
262 enum lttng_consumer_command cmd,
263 uint64_t channel_key,
264 uint64_t session_id,
265 const char *pathname,
266 uid_t uid,
267 gid_t gid,
268 uint64_t relayd_id,
269 const char *name,
270 unsigned int nb_init_streams,
271 enum lttng_event_output output,
272 int type,
273 uint64_t tracefile_size,
274 uint64_t tracefile_count,
275 unsigned int monitor,
276 unsigned int live_timer_interval);
277 int consumer_is_data_pending(uint64_t session_id,
278 struct consumer_output *consumer);
279 int consumer_close_metadata(struct consumer_socket *socket,
280 uint64_t metadata_key);
281 int consumer_setup_metadata(struct consumer_socket *socket,
282 uint64_t metadata_key);
283 int consumer_push_metadata(struct consumer_socket *socket,
284 uint64_t metadata_key, char *metadata_str, size_t len,
285 size_t target_offset, uint64_t version);
286 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
287 int consumer_clear_quiescent_channel(struct consumer_socket *socket, uint64_t key);
288 int consumer_get_discarded_events(uint64_t session_id, uint64_t channel_key,
289 struct consumer_output *consumer, uint64_t *discarded);
290 int consumer_get_lost_packets(uint64_t session_id, uint64_t channel_key,
291 struct consumer_output *consumer, uint64_t *lost);
292
293 /* Snapshot command. */
294 int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key,
295 struct snapshot_output *output, int metadata, uid_t uid, gid_t gid,
296 const char *session_path, int wait, uint64_t nb_packets_per_stream);
297
298 #endif /* _CONSUMER_H */
This page took 0.035108 seconds and 4 git commands to generate.