Commit | Line | Data |
---|---|---|
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 | ||
c8fea79c | 21 | #include <common/consumer/consumer.h> |
173af62f | 22 | #include <common/hashtable/hashtable.h> |
00e2e675 | 23 | #include <lttng/lttng.h> |
6addfa37 | 24 | #include <urcu/ref.h> |
00e2e675 | 25 | |
6dc3064a DG |
26 | #include "snapshot.h" |
27 | ||
28 | struct snapshot; | |
29 | struct snapshot_output; | |
30 | ||
00e2e675 DG |
31 | enum consumer_dst_type { |
32 | CONSUMER_DST_LOCAL, | |
33 | CONSUMER_DST_NET, | |
34 | }; | |
f1e16794 | 35 | |
173af62f | 36 | struct consumer_socket { |
4ce514c4 DG |
37 | /* |
38 | * File descriptor. This is just a reference to the consumer data meaning | |
9363801e DG |
39 | * that every access must be locked and checked for a possible invalid |
40 | * value. | |
4ce514c4 | 41 | */ |
9363801e | 42 | int *fd_ptr; |
4ce514c4 | 43 | |
173af62f DG |
44 | /* |
45 | * To use this socket (send/recv), this lock MUST be acquired. | |
46 | */ | |
47 | pthread_mutex_t *lock; | |
2f77fc4b DG |
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 | ||
ffe60014 DG |
57 | /* Flag if network sockets were sent to the consumer. */ |
58 | unsigned int control_sock_sent; | |
59 | unsigned int data_sock_sent; | |
60 | ||
173af62f | 61 | struct lttng_ht_node_ulong node; |
6dc3064a DG |
62 | |
63 | enum lttng_consumer_type type; | |
173af62f DG |
64 | }; |
65 | ||
f1e16794 DG |
66 | struct consumer_data { |
67 | enum lttng_consumer_type type; | |
68 | ||
69 | pthread_t thread; /* Worker thread interacting with the consumer */ | |
a23ec3a7 DG |
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; | |
f1e16794 DG |
88 | |
89 | /* Mutex to control consumerd pid assignation */ | |
90 | pthread_mutex_t pid_mutex; | |
91 | pid_t pid; | |
92 | ||
93 | int err_sock; | |
331744e3 | 94 | /* These two sockets uses the cmd_unix_sock_path. */ |
f1e16794 | 95 | int cmd_sock; |
e9404c27 JG |
96 | /* |
97 | * Write-end of the channel monitoring pipe to be passed to the | |
98 | * consumer. | |
99 | */ | |
100 | int channel_monitor_pipe; | |
62c43103 JD |
101 | /* |
102 | * Write-end of the channel rotation pipe to be passed to the | |
103 | * consumer. | |
104 | */ | |
105 | int channel_rotate_pipe; | |
4ce514c4 DG |
106 | /* |
107 | * The metadata socket object is handled differently and only created | |
108 | * locally in this object thus it's the only reference available in the | |
9363801e DG |
109 | * session daemon. For that reason, a variable for the fd is required and |
110 | * the metadata socket fd points to it. | |
4ce514c4 DG |
111 | */ |
112 | int metadata_fd; | |
331744e3 | 113 | struct consumer_socket metadata_sock; |
f1e16794 DG |
114 | |
115 | /* consumer error and command Unix socket path */ | |
e6142f2e JG |
116 | const char *err_unix_sock_path; |
117 | const char *cmd_unix_sock_path; | |
44a5e5eb | 118 | |
92db7cdc DG |
119 | /* |
120 | * This lock has two purposes. It protects any change to the consumer | |
121 | * socket and make sure only one thread uses this object for read/write | |
122 | * operations. | |
123 | */ | |
173af62f | 124 | pthread_mutex_t lock; |
f1e16794 DG |
125 | }; |
126 | ||
00e2e675 DG |
127 | /* |
128 | * Network URIs | |
129 | */ | |
130 | struct consumer_net { | |
131 | /* | |
132 | * Indicate if URI type is set. Those flags should only be set when the | |
133 | * created URI is done AND valid. | |
134 | */ | |
135 | int control_isset; | |
136 | int data_isset; | |
137 | ||
138 | /* | |
139 | * The following two URIs MUST have the same destination address for | |
140 | * network streaming to work. Network hop are not yet supported. | |
141 | */ | |
142 | ||
143 | /* Control path for network streaming. */ | |
144 | struct lttng_uri control; | |
145 | ||
146 | /* Data path for network streaming. */ | |
147 | struct lttng_uri data; | |
2b29c638 JD |
148 | |
149 | /* <hostname>/<session-name> */ | |
150 | char base_dir[PATH_MAX]; | |
00e2e675 DG |
151 | }; |
152 | ||
153 | /* | |
154 | * Consumer output object describing where and how to send data. | |
155 | */ | |
156 | struct consumer_output { | |
6addfa37 MD |
157 | struct urcu_ref ref; /* Refcount */ |
158 | ||
00e2e675 DG |
159 | /* If the consumer is enabled meaning that should be used */ |
160 | unsigned int enabled; | |
161 | enum consumer_dst_type type; | |
173af62f | 162 | |
00e2e675 DG |
163 | /* |
164 | * The net_seq_index is the index of the network stream on the consumer | |
3f8e211f DG |
165 | * side. It tells the consumer which streams goes to which relayd with this |
166 | * index. The relayd sockets are index with it on the consumer side. | |
00e2e675 | 167 | */ |
d88aee68 | 168 | uint64_t net_seq_index; |
b31610f2 JD |
169 | /* Store the relay protocol in use if the session is remote. */ |
170 | uint32_t relay_major_version; | |
171 | uint32_t relay_minor_version; | |
173af62f | 172 | |
00e2e675 | 173 | /* |
366a9222 JD |
174 | * Subdirectory path name used for both local and network |
175 | * consumer (/kernel or /ust). | |
00e2e675 | 176 | */ |
61ba6b6d | 177 | char subdir[LTTNG_PATH_MAX]; |
173af62f DG |
178 | |
179 | /* | |
180 | * Hashtable of consumer_socket index by the file descriptor value. For | |
181 | * multiarch consumer support, we can have more than one consumer (ex: 32 | |
182 | * and 64 bit). | |
183 | */ | |
184 | struct lttng_ht *socks; | |
185 | ||
7d2f7452 DG |
186 | /* Tell if this output is used for snapshot. */ |
187 | unsigned int snapshot:1; | |
188 | ||
00e2e675 | 189 | union { |
61ba6b6d | 190 | char session_root_path[LTTNG_PATH_MAX]; |
00e2e675 DG |
191 | struct consumer_net net; |
192 | } dst; | |
366a9222 JD |
193 | |
194 | /* | |
195 | * Sub-directory below the session_root_path where the next chunk of | |
196 | * trace will be stored (\0 before the first session rotation). | |
197 | */ | |
61ba6b6d | 198 | char chunk_path[LTTNG_PATH_MAX]; |
00e2e675 DG |
199 | }; |
200 | ||
173af62f DG |
201 | struct consumer_socket *consumer_find_socket(int key, |
202 | struct consumer_output *consumer); | |
7972aab2 DG |
203 | struct consumer_socket *consumer_find_socket_by_bitness(int bits, |
204 | struct consumer_output *consumer); | |
4ce514c4 | 205 | struct consumer_socket *consumer_allocate_socket(int *fd); |
173af62f DG |
206 | void consumer_add_socket(struct consumer_socket *sock, |
207 | struct consumer_output *consumer); | |
208 | void consumer_del_socket(struct consumer_socket *sock, | |
209 | struct consumer_output *consumer); | |
210 | void consumer_destroy_socket(struct consumer_socket *sock); | |
6dc3064a DG |
211 | int consumer_copy_sockets(struct consumer_output *dst, |
212 | struct consumer_output *src); | |
af706bb7 | 213 | void consumer_destroy_output_sockets(struct consumer_output *obj); |
52898cb1 DG |
214 | int consumer_socket_send(struct consumer_socket *socket, void *msg, |
215 | size_t len); | |
216 | int consumer_socket_recv(struct consumer_socket *socket, void *msg, | |
217 | size_t len); | |
173af62f | 218 | |
00e2e675 DG |
219 | struct consumer_output *consumer_create_output(enum consumer_dst_type type); |
220 | struct consumer_output *consumer_copy_output(struct consumer_output *obj); | |
6addfa37 MD |
221 | void consumer_output_get(struct consumer_output *obj); |
222 | void consumer_output_put(struct consumer_output *obj); | |
00e2e675 DG |
223 | int consumer_set_network_uri(struct consumer_output *obj, |
224 | struct lttng_uri *uri); | |
ac2f30af JG |
225 | int consumer_send_fds(struct consumer_socket *sock, const int *fds, |
226 | size_t nb_fd); | |
ffe60014 DG |
227 | int consumer_send_msg(struct consumer_socket *sock, |
228 | struct lttcomm_consumer_msg *msg); | |
f50f23d9 DG |
229 | int consumer_send_stream(struct consumer_socket *sock, |
230 | struct consumer_output *dst, struct lttcomm_consumer_msg *msg, | |
ac2f30af | 231 | const int *fds, size_t nb_fd); |
f50f23d9 DG |
232 | int consumer_send_channel(struct consumer_socket *sock, |
233 | struct lttcomm_consumer_msg *msg); | |
234 | int consumer_send_relayd_socket(struct consumer_socket *consumer_sock, | |
6151a90f | 235 | struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer, |
d3e2ba59 JD |
236 | enum lttng_stream_type type, uint64_t session_id, |
237 | char *session_name, char *hostname, int session_live_timer); | |
e9404c27 JG |
238 | int consumer_send_channel_monitor_pipe(struct consumer_socket *consumer_sock, |
239 | int pipe); | |
62c43103 JD |
240 | int consumer_send_channel_rotate_pipe(struct consumer_socket *consumer_sock, |
241 | int pipe); | |
173af62f DG |
242 | int consumer_send_destroy_relayd(struct consumer_socket *sock, |
243 | struct consumer_output *consumer); | |
f50f23d9 | 244 | int consumer_recv_status_reply(struct consumer_socket *sock); |
ffe60014 | 245 | int consumer_recv_status_channel(struct consumer_socket *sock, |
d88aee68 | 246 | uint64_t *key, unsigned int *stream_count); |
2f77fc4b | 247 | void consumer_output_send_destroy_relayd(struct consumer_output *consumer); |
a4b92340 DG |
248 | int consumer_create_socket(struct consumer_data *data, |
249 | struct consumer_output *output); | |
2f77fc4b DG |
250 | int consumer_set_subdir(struct consumer_output *consumer, |
251 | const char *session_name); | |
37278a1e | 252 | |
ffe60014 DG |
253 | void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg, |
254 | uint64_t subbuf_size, | |
255 | uint64_t num_subbuf, | |
256 | int overwrite, | |
257 | unsigned int switch_timer_interval, | |
258 | unsigned int read_timer_interval, | |
ecc48a90 | 259 | unsigned int live_timer_interval, |
e9404c27 | 260 | unsigned int monitor_timer_interval, |
ffe60014 DG |
261 | int output, |
262 | int type, | |
263 | uint64_t session_id, | |
264 | const char *pathname, | |
265 | const char *name, | |
266 | uid_t uid, | |
267 | gid_t gid, | |
d88aee68 DG |
268 | uint64_t relayd_id, |
269 | uint64_t key, | |
7972aab2 | 270 | unsigned char *uuid, |
1624d5b7 JD |
271 | uint32_t chan_id, |
272 | uint64_t tracefile_size, | |
2bba9e53 | 273 | uint64_t tracefile_count, |
1950109e | 274 | uint64_t session_id_per_pid, |
567eb353 | 275 | unsigned int monitor, |
d7ba1388 | 276 | uint32_t ust_app_uid, |
491d1539 | 277 | int64_t blocking_timeout, |
3d071855 | 278 | const char *root_shm_path, |
e098433c JG |
279 | const char *shm_path, |
280 | uint64_t trace_archive_id); | |
281 | void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg *msg, | |
d88aee68 DG |
282 | uint64_t channel_key, |
283 | uint64_t stream_key, | |
e098433c JG |
284 | int32_t cpu, |
285 | uint64_t trace_archive_id); | |
a4baae1b JD |
286 | void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg, |
287 | enum lttng_consumer_command cmd, | |
288 | uint64_t channel_key, uint64_t net_seq_idx); | |
638e7b4e | 289 | void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg *msg, |
d88aee68 | 290 | uint64_t channel_key, |
ffe60014 DG |
291 | uint64_t session_id, |
292 | const char *pathname, | |
293 | uid_t uid, | |
294 | gid_t gid, | |
d88aee68 | 295 | uint64_t relayd_id, |
c30aaa51 | 296 | const char *name, |
ffe60014 DG |
297 | unsigned int nb_init_streams, |
298 | enum lttng_event_output output, | |
1624d5b7 JD |
299 | int type, |
300 | uint64_t tracefile_size, | |
2bba9e53 | 301 | uint64_t tracefile_count, |
ecc48a90 | 302 | unsigned int monitor, |
e9404c27 JG |
303 | unsigned int live_timer_interval, |
304 | unsigned int monitor_timer_interval); | |
d88aee68 | 305 | int consumer_is_data_pending(uint64_t session_id, |
806e2684 | 306 | struct consumer_output *consumer); |
7972aab2 DG |
307 | int consumer_close_metadata(struct consumer_socket *socket, |
308 | uint64_t metadata_key); | |
309 | int consumer_setup_metadata(struct consumer_socket *socket, | |
310 | uint64_t metadata_key); | |
311 | int consumer_push_metadata(struct consumer_socket *socket, | |
312 | uint64_t metadata_key, char *metadata_str, size_t len, | |
93ec662e | 313 | size_t target_offset, uint64_t version); |
7972aab2 | 314 | int consumer_flush_channel(struct consumer_socket *socket, uint64_t key); |
0dd01979 | 315 | int consumer_clear_quiescent_channel(struct consumer_socket *socket, uint64_t key); |
fb83fe64 JD |
316 | int consumer_get_discarded_events(uint64_t session_id, uint64_t channel_key, |
317 | struct consumer_output *consumer, uint64_t *discarded); | |
318 | int consumer_get_lost_packets(uint64_t session_id, uint64_t channel_key, | |
319 | struct consumer_output *consumer, uint64_t *lost); | |
00e2e675 | 320 | |
6dc3064a DG |
321 | /* Snapshot command. */ |
322 | int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key, | |
e098433c JG |
323 | struct snapshot_output *output, int metadata, |
324 | uid_t uid, gid_t gid, const char *session_path, int wait, | |
325 | uint64_t nb_packets_per_stream, uint64_t trace_archive_id); | |
6dc3064a | 326 | |
5c408ad8 JD |
327 | int consumer_rotate_channel(struct consumer_socket *socket, uint64_t key, |
328 | uid_t uid, gid_t gid, struct consumer_output *output, | |
329 | char *domain_path, bool is_metadata_channel, uint64_t new_chunk_id, | |
330 | bool *rotate_pending_relay); | |
00fb02ac JD |
331 | int consumer_rotate_rename(struct consumer_socket *socket, uint64_t session_id, |
332 | const struct consumer_output *output, const char *old_path, | |
333 | const char *new_path, uid_t uid, gid_t gid); | |
d88744a4 JD |
334 | int consumer_rotate_pending_relay(struct consumer_socket *socket, |
335 | struct consumer_output *output, uint64_t session_id, | |
336 | uint64_t chunk_id); | |
a1ae2ea5 JD |
337 | int consumer_mkdir(struct consumer_socket *socket, uint64_t session_id, |
338 | const struct consumer_output *output, const char *path, | |
339 | uid_t uid, gid_t gid); | |
340 | ||
f1e16794 | 341 | #endif /* _CONSUMER_H */ |