Docs: describe the apps_thread's working in function header
[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
145 /*
146 * Consumer output object describing where and how to send data.
147 */
148 struct consumer_output {
149 struct urcu_ref ref; /* Refcount */
150
151 /* If the consumer is enabled meaning that should be used */
152 unsigned int enabled;
153 enum consumer_dst_type type;
154
155 /*
156 * The net_seq_index is the index of the network stream on the consumer
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.
159 */
160 uint64_t net_seq_index;
161 /* Store the relay protocol in use if the session is remote. */
162 uint32_t relay_major_version;
163 uint32_t relay_minor_version;
164
165 /*
166 * Subdirectory path name used for both local and network consumer.
167 */
168 char subdir[PATH_MAX];
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
177 /* Tell if this output is used for snapshot. */
178 unsigned int snapshot:1;
179
180 union {
181 char trace_path[PATH_MAX];
182 struct consumer_net net;
183 } dst;
184 };
185
186 struct consumer_socket *consumer_find_socket(int key,
187 struct consumer_output *consumer);
188 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
189 struct consumer_output *consumer);
190 struct consumer_socket *consumer_allocate_socket(int *fd);
191 void consumer_add_socket(struct consumer_socket *sock,
192 struct consumer_output *consumer);
193 void consumer_del_socket(struct consumer_socket *sock,
194 struct consumer_output *consumer);
195 void consumer_destroy_socket(struct consumer_socket *sock);
196 int consumer_copy_sockets(struct consumer_output *dst,
197 struct consumer_output *src);
198 void consumer_destroy_output_sockets(struct consumer_output *obj);
199 int consumer_socket_send(struct consumer_socket *socket, void *msg,
200 size_t len);
201 int consumer_socket_recv(struct consumer_socket *socket, void *msg,
202 size_t len);
203
204 struct consumer_output *consumer_create_output(enum consumer_dst_type type);
205 struct consumer_output *consumer_copy_output(struct consumer_output *obj);
206 void consumer_output_get(struct consumer_output *obj);
207 void consumer_output_put(struct consumer_output *obj);
208 int consumer_set_network_uri(struct consumer_output *obj,
209 struct lttng_uri *uri);
210 int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd);
211 int consumer_send_msg(struct consumer_socket *sock,
212 struct lttcomm_consumer_msg *msg);
213 int consumer_send_stream(struct consumer_socket *sock,
214 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
215 int *fds, size_t nb_fd);
216 int consumer_send_channel(struct consumer_socket *sock,
217 struct lttcomm_consumer_msg *msg);
218 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
219 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
220 enum lttng_stream_type type, uint64_t session_id,
221 char *session_name, char *hostname, int session_live_timer);
222 int consumer_send_channel_monitor_pipe(struct consumer_socket *consumer_sock,
223 int pipe);
224 int consumer_send_destroy_relayd(struct consumer_socket *sock,
225 struct consumer_output *consumer);
226 int consumer_recv_status_reply(struct consumer_socket *sock);
227 int consumer_recv_status_channel(struct consumer_socket *sock,
228 uint64_t *key, unsigned int *stream_count);
229 void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
230 int consumer_create_socket(struct consumer_data *data,
231 struct consumer_output *output);
232 int consumer_set_subdir(struct consumer_output *consumer,
233 const char *session_name);
234
235 void 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,
241 unsigned int live_timer_interval,
242 unsigned int monitor_timer_interval,
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,
250 uint64_t relayd_id,
251 uint64_t key,
252 unsigned char *uuid,
253 uint32_t chan_id,
254 uint64_t tracefile_size,
255 uint64_t tracefile_count,
256 uint64_t session_id_per_pid,
257 unsigned int monitor,
258 uint32_t ust_app_uid,
259 int64_t blocking_timeout,
260 const char *root_shm_path,
261 const char *shm_path);
262 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
263 enum lttng_consumer_command cmd,
264 uint64_t channel_key,
265 uint64_t stream_key,
266 int cpu);
267 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg,
268 enum lttng_consumer_command cmd,
269 uint64_t channel_key, uint64_t net_seq_idx);
270 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
271 enum lttng_consumer_command cmd,
272 uint64_t channel_key,
273 uint64_t session_id,
274 const char *pathname,
275 uid_t uid,
276 gid_t gid,
277 uint64_t relayd_id,
278 const char *name,
279 unsigned int nb_init_streams,
280 enum lttng_event_output output,
281 int type,
282 uint64_t tracefile_size,
283 uint64_t tracefile_count,
284 unsigned int monitor,
285 unsigned int live_timer_interval,
286 unsigned int monitor_timer_interval);
287 int consumer_is_data_pending(uint64_t session_id,
288 struct consumer_output *consumer);
289 int consumer_close_metadata(struct consumer_socket *socket,
290 uint64_t metadata_key);
291 int consumer_setup_metadata(struct consumer_socket *socket,
292 uint64_t metadata_key);
293 int consumer_push_metadata(struct consumer_socket *socket,
294 uint64_t metadata_key, char *metadata_str, size_t len,
295 size_t target_offset, uint64_t version);
296 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
297 int consumer_clear_quiescent_channel(struct consumer_socket *socket, uint64_t key);
298 int consumer_get_discarded_events(uint64_t session_id, uint64_t channel_key,
299 struct consumer_output *consumer, uint64_t *discarded);
300 int consumer_get_lost_packets(uint64_t session_id, uint64_t channel_key,
301 struct consumer_output *consumer, uint64_t *lost);
302
303 /* Snapshot command. */
304 int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key,
305 struct snapshot_output *output, int metadata, uid_t uid, gid_t gid,
306 const char *session_path, int wait, uint64_t nb_packets_per_stream);
307
308 #endif /* _CONSUMER_H */
This page took 0.054679 seconds and 4 git commands to generate.