Stop rotation pending check timer from the rotation thread
[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 * Write-end of the channel monitoring pipe to be passed to the
98 * consumer.
99 */
100 int channel_monitor_pipe;
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
104 * session daemon. For that reason, a variable for the fd is required and
105 * the metadata socket fd points to it.
106 */
107 int metadata_fd;
108 struct consumer_socket metadata_sock;
109
110 /* consumer error and command Unix socket path */
111 const char *err_unix_sock_path;
112 const char *cmd_unix_sock_path;
113
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 */
119 pthread_mutex_t lock;
120 };
121
122 /*
123 * Network URIs
124 */
125 struct 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 /* <hostname>/<session-name> */
145 char base_dir[PATH_MAX];
146 };
147
148 /*
149 * Consumer output object describing where and how to send data.
150 */
151 struct consumer_output {
152 struct urcu_ref ref; /* Refcount */
153
154 /* If the consumer is enabled meaning that should be used */
155 unsigned int enabled;
156 enum consumer_dst_type type;
157
158 /*
159 * The net_seq_index is the index of the network stream on the consumer
160 * side. It tells the consumer which streams goes to which relayd with this
161 * index. The relayd sockets are index with it on the consumer side.
162 */
163 uint64_t net_seq_index;
164 /* Store the relay protocol in use if the session is remote. */
165 uint32_t relay_major_version;
166 uint32_t relay_minor_version;
167
168 /*
169 * Subdirectory path name used for both local and network
170 * consumer (/kernel or /ust).
171 */
172 char subdir[LTTNG_PATH_MAX];
173
174 /*
175 * Hashtable of consumer_socket index by the file descriptor value. For
176 * multiarch consumer support, we can have more than one consumer (ex: 32
177 * and 64 bit).
178 */
179 struct lttng_ht *socks;
180
181 /* Tell if this output is used for snapshot. */
182 unsigned int snapshot:1;
183
184 union {
185 char session_root_path[LTTNG_PATH_MAX];
186 struct consumer_net net;
187 } dst;
188
189 /*
190 * Sub-directory below the session_root_path where the next chunk of
191 * trace will be stored (\0 before the first session rotation).
192 */
193 char chunk_path[LTTNG_PATH_MAX];
194 };
195
196 struct consumer_socket *consumer_find_socket(int key,
197 struct consumer_output *consumer);
198 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
199 struct consumer_output *consumer);
200 struct consumer_socket *consumer_allocate_socket(int *fd);
201 void consumer_add_socket(struct consumer_socket *sock,
202 struct consumer_output *consumer);
203 void consumer_del_socket(struct consumer_socket *sock,
204 struct consumer_output *consumer);
205 void consumer_destroy_socket(struct consumer_socket *sock);
206 int consumer_copy_sockets(struct consumer_output *dst,
207 struct consumer_output *src);
208 void consumer_destroy_output_sockets(struct consumer_output *obj);
209 int consumer_socket_send(struct consumer_socket *socket, void *msg,
210 size_t len);
211 int consumer_socket_recv(struct consumer_socket *socket, void *msg,
212 size_t len);
213
214 struct consumer_output *consumer_create_output(enum consumer_dst_type type);
215 struct consumer_output *consumer_copy_output(struct consumer_output *obj);
216 void consumer_output_get(struct consumer_output *obj);
217 void consumer_output_put(struct consumer_output *obj);
218 int consumer_set_network_uri(struct consumer_output *obj,
219 struct lttng_uri *uri);
220 int consumer_send_fds(struct consumer_socket *sock, const int *fds,
221 size_t nb_fd);
222 int consumer_send_msg(struct consumer_socket *sock,
223 struct lttcomm_consumer_msg *msg);
224 int consumer_send_stream(struct consumer_socket *sock,
225 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
226 const int *fds, size_t nb_fd);
227 int consumer_send_channel(struct consumer_socket *sock,
228 struct lttcomm_consumer_msg *msg);
229 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
230 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
231 enum lttng_stream_type type, uint64_t session_id,
232 char *session_name, char *hostname, int session_live_timer);
233 int consumer_send_channel_monitor_pipe(struct consumer_socket *consumer_sock,
234 int pipe);
235 int consumer_send_destroy_relayd(struct consumer_socket *sock,
236 struct consumer_output *consumer);
237 int consumer_recv_status_reply(struct consumer_socket *sock);
238 int consumer_recv_status_channel(struct consumer_socket *sock,
239 uint64_t *key, unsigned int *stream_count);
240 void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
241 int consumer_create_socket(struct consumer_data *data,
242 struct consumer_output *output);
243 int consumer_set_subdir(struct consumer_output *consumer,
244 const char *session_name);
245
246 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
247 uint64_t subbuf_size,
248 uint64_t num_subbuf,
249 int overwrite,
250 unsigned int switch_timer_interval,
251 unsigned int read_timer_interval,
252 unsigned int live_timer_interval,
253 unsigned int monitor_timer_interval,
254 int output,
255 int type,
256 uint64_t session_id,
257 const char *pathname,
258 const char *name,
259 uid_t uid,
260 gid_t gid,
261 uint64_t relayd_id,
262 uint64_t key,
263 unsigned char *uuid,
264 uint32_t chan_id,
265 uint64_t tracefile_size,
266 uint64_t tracefile_count,
267 uint64_t session_id_per_pid,
268 unsigned int monitor,
269 uint32_t ust_app_uid,
270 int64_t blocking_timeout,
271 const char *root_shm_path,
272 const char *shm_path,
273 uint64_t trace_archive_id);
274 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg *msg,
275 uint64_t channel_key,
276 uint64_t stream_key,
277 int32_t cpu,
278 uint64_t trace_archive_id);
279 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
280 enum lttng_consumer_command cmd,
281 uint64_t channel_key, uint64_t net_seq_idx);
282 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg *msg,
283 uint64_t channel_key,
284 uint64_t session_id,
285 const char *pathname,
286 uid_t uid,
287 gid_t gid,
288 uint64_t relayd_id,
289 const char *name,
290 unsigned int nb_init_streams,
291 enum lttng_event_output output,
292 int type,
293 uint64_t tracefile_size,
294 uint64_t tracefile_count,
295 unsigned int monitor,
296 unsigned int live_timer_interval,
297 unsigned int monitor_timer_interval);
298 int consumer_is_data_pending(uint64_t session_id,
299 struct consumer_output *consumer);
300 int consumer_close_metadata(struct consumer_socket *socket,
301 uint64_t metadata_key);
302 int consumer_setup_metadata(struct consumer_socket *socket,
303 uint64_t metadata_key);
304 int consumer_push_metadata(struct consumer_socket *socket,
305 uint64_t metadata_key, char *metadata_str, size_t len,
306 size_t target_offset, uint64_t version);
307 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
308 int consumer_clear_quiescent_channel(struct consumer_socket *socket, uint64_t key);
309 int consumer_get_discarded_events(uint64_t session_id, uint64_t channel_key,
310 struct consumer_output *consumer, uint64_t *discarded);
311 int consumer_get_lost_packets(uint64_t session_id, uint64_t channel_key,
312 struct consumer_output *consumer, uint64_t *lost);
313
314 /* Snapshot command. */
315 enum lttng_error_code consumer_snapshot_channel(struct consumer_socket *socket,
316 uint64_t key, struct snapshot_output *output, int metadata,
317 uid_t uid, gid_t gid, const char *session_path, int wait,
318 uint64_t nb_packets_per_stream, uint64_t trace_archive_id);
319
320 /* Rotation commands. */
321 int consumer_rotate_channel(struct consumer_socket *socket, uint64_t key,
322 uid_t uid, gid_t gid, struct consumer_output *output,
323 char *domain_path, bool is_metadata_channel, uint64_t new_chunk_id);
324 int consumer_rotate_rename(struct consumer_socket *socket, uint64_t session_id,
325 const struct consumer_output *output, const char *old_path,
326 const char *new_path, uid_t uid, gid_t gid);
327 int consumer_check_rotation_pending_local(struct consumer_socket *socket,
328 uint64_t session_id, uint64_t chunk_id);
329 int consumer_check_rotation_pending_relay(struct consumer_socket *socket,
330 const struct consumer_output *output, uint64_t session_id,
331 uint64_t chunk_id);
332 int consumer_mkdir(struct consumer_socket *socket, uint64_t session_id,
333 const struct consumer_output *output, const char *path,
334 uid_t uid, gid_t gid);
335
336 #endif /* _CONSUMER_H */
This page took 0.038646 seconds and 4 git commands to generate.