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