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; | |
c7496bc7 | 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 | ||
70 | pthread_t thread; /* Worker thread interacting with the consumer */ | |
a23ec3a7 DG |
71 | |
72 | /* Conditions used by the consumer thread to indicate readiness. */ | |
73 | pthread_cond_t cond; | |
74 | pthread_condattr_t condattr; | |
75 | pthread_mutex_t cond_mutex; | |
76 | ||
77 | /* | |
78 | * This is a flag condition indicating that the consumer thread is ready | |
79 | * and connected to the lttng-consumerd daemon. This flag MUST only be | |
80 | * updated by locking the condition mutex above or before spawning a | |
81 | * consumer thread. | |
82 | * | |
83 | * A value of 0 means that the thread is NOT ready. A value of 1 means that | |
84 | * the thread consumer did connect successfully to the lttng-consumerd | |
85 | * daemon. A negative value indicates that there is been an error and the | |
86 | * thread has likely quit. | |
87 | */ | |
88 | int consumer_thread_is_ready; | |
f1e16794 DG |
89 | |
90 | /* Mutex to control consumerd pid assignation */ | |
91 | pthread_mutex_t pid_mutex; | |
92 | pid_t pid; | |
93 | ||
94 | int err_sock; | |
331744e3 | 95 | /* These two sockets uses the cmd_unix_sock_path. */ |
f1e16794 | 96 | int cmd_sock; |
e9404c27 JG |
97 | /* |
98 | * Write-end of the channel monitoring pipe to be passed to the | |
99 | * consumer. | |
100 | */ | |
101 | int channel_monitor_pipe; | |
4ce514c4 DG |
102 | /* |
103 | * The metadata socket object is handled differently and only created | |
104 | * locally in this object thus it's the only reference available in the | |
9363801e DG |
105 | * session daemon. For that reason, a variable for the fd is required and |
106 | * the metadata socket fd points to it. | |
4ce514c4 DG |
107 | */ |
108 | int metadata_fd; | |
331744e3 | 109 | struct consumer_socket metadata_sock; |
f1e16794 DG |
110 | |
111 | /* consumer error and command Unix socket path */ | |
87c3f04b JG |
112 | const char *err_unix_sock_path; |
113 | const char *cmd_unix_sock_path; | |
44a5e5eb | 114 | |
92db7cdc DG |
115 | /* |
116 | * This lock has two purposes. It protects any change to the consumer | |
117 | * socket and make sure only one thread uses this object for read/write | |
118 | * operations. | |
119 | */ | |
173af62f | 120 | pthread_mutex_t lock; |
f1e16794 DG |
121 | }; |
122 | ||
00e2e675 DG |
123 | /* |
124 | * Network URIs | |
125 | */ | |
126 | struct consumer_net { | |
127 | /* | |
128 | * Indicate if URI type is set. Those flags should only be set when the | |
129 | * created URI is done AND valid. | |
130 | */ | |
131 | int control_isset; | |
132 | int data_isset; | |
133 | ||
134 | /* | |
135 | * The following two URIs MUST have the same destination address for | |
136 | * network streaming to work. Network hop are not yet supported. | |
137 | */ | |
138 | ||
139 | /* Control path for network streaming. */ | |
140 | struct lttng_uri control; | |
141 | ||
142 | /* Data path for network streaming. */ | |
143 | struct lttng_uri data; | |
144 | }; | |
145 | ||
146 | /* | |
147 | * Consumer output object describing where and how to send data. | |
148 | */ | |
149 | struct consumer_output { | |
6addfa37 MD |
150 | struct urcu_ref ref; /* Refcount */ |
151 | ||
00e2e675 DG |
152 | /* If the consumer is enabled meaning that should be used */ |
153 | unsigned int enabled; | |
154 | enum consumer_dst_type type; | |
173af62f | 155 | |
00e2e675 DG |
156 | /* |
157 | * The net_seq_index is the index of the network stream on the consumer | |
3f8e211f DG |
158 | * side. It tells the consumer which streams goes to which relayd with this |
159 | * index. The relayd sockets are index with it on the consumer side. | |
00e2e675 | 160 | */ |
d88aee68 | 161 | uint64_t net_seq_index; |
b31610f2 JD |
162 | /* Store the relay protocol in use if the session is remote. */ |
163 | uint32_t relay_major_version; | |
164 | uint32_t relay_minor_version; | |
173af62f | 165 | |
00e2e675 DG |
166 | /* |
167 | * Subdirectory path name used for both local and network consumer. | |
168 | */ | |
169 | char subdir[PATH_MAX]; | |
173af62f DG |
170 | |
171 | /* | |
172 | * Hashtable of consumer_socket index by the file descriptor value. For | |
173 | * multiarch consumer support, we can have more than one consumer (ex: 32 | |
174 | * and 64 bit). | |
175 | */ | |
176 | struct lttng_ht *socks; | |
177 | ||
7d2f7452 DG |
178 | /* Tell if this output is used for snapshot. */ |
179 | unsigned int snapshot:1; | |
180 | ||
00e2e675 DG |
181 | union { |
182 | char trace_path[PATH_MAX]; | |
183 | struct consumer_net net; | |
184 | } dst; | |
185 | }; | |
186 | ||
173af62f DG |
187 | struct consumer_socket *consumer_find_socket(int key, |
188 | struct consumer_output *consumer); | |
7972aab2 DG |
189 | struct consumer_socket *consumer_find_socket_by_bitness(int bits, |
190 | struct consumer_output *consumer); | |
4ce514c4 | 191 | struct consumer_socket *consumer_allocate_socket(int *fd); |
173af62f DG |
192 | void consumer_add_socket(struct consumer_socket *sock, |
193 | struct consumer_output *consumer); | |
194 | void consumer_del_socket(struct consumer_socket *sock, | |
195 | struct consumer_output *consumer); | |
196 | void consumer_destroy_socket(struct consumer_socket *sock); | |
6dc3064a DG |
197 | int consumer_copy_sockets(struct consumer_output *dst, |
198 | struct consumer_output *src); | |
af706bb7 | 199 | void consumer_destroy_output_sockets(struct consumer_output *obj); |
52898cb1 DG |
200 | int consumer_socket_send(struct consumer_socket *socket, void *msg, |
201 | size_t len); | |
202 | int consumer_socket_recv(struct consumer_socket *socket, void *msg, | |
203 | size_t len); | |
173af62f | 204 | |
00e2e675 DG |
205 | struct consumer_output *consumer_create_output(enum consumer_dst_type type); |
206 | struct consumer_output *consumer_copy_output(struct consumer_output *obj); | |
6addfa37 MD |
207 | void consumer_output_get(struct consumer_output *obj); |
208 | void consumer_output_put(struct consumer_output *obj); | |
00e2e675 DG |
209 | int consumer_set_network_uri(struct consumer_output *obj, |
210 | struct lttng_uri *uri); | |
f50f23d9 | 211 | int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd); |
ffe60014 DG |
212 | int consumer_send_msg(struct consumer_socket *sock, |
213 | struct lttcomm_consumer_msg *msg); | |
f50f23d9 DG |
214 | int consumer_send_stream(struct consumer_socket *sock, |
215 | struct consumer_output *dst, struct lttcomm_consumer_msg *msg, | |
216 | int *fds, size_t nb_fd); | |
217 | int consumer_send_channel(struct consumer_socket *sock, | |
218 | struct lttcomm_consumer_msg *msg); | |
219 | int consumer_send_relayd_socket(struct consumer_socket *consumer_sock, | |
6151a90f | 220 | struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer, |
d3e2ba59 JD |
221 | enum lttng_stream_type type, uint64_t session_id, |
222 | char *session_name, char *hostname, int session_live_timer); | |
e9404c27 JG |
223 | int consumer_send_channel_monitor_pipe(struct consumer_socket *consumer_sock, |
224 | int pipe); | |
173af62f DG |
225 | int consumer_send_destroy_relayd(struct consumer_socket *sock, |
226 | struct consumer_output *consumer); | |
f50f23d9 | 227 | int consumer_recv_status_reply(struct consumer_socket *sock); |
ffe60014 | 228 | int consumer_recv_status_channel(struct consumer_socket *sock, |
d88aee68 | 229 | uint64_t *key, unsigned int *stream_count); |
2f77fc4b | 230 | void consumer_output_send_destroy_relayd(struct consumer_output *consumer); |
a4b92340 DG |
231 | int consumer_create_socket(struct consumer_data *data, |
232 | struct consumer_output *output); | |
2f77fc4b DG |
233 | int consumer_set_subdir(struct consumer_output *consumer, |
234 | const char *session_name); | |
37278a1e | 235 | |
ffe60014 DG |
236 | void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg, |
237 | uint64_t subbuf_size, | |
238 | uint64_t num_subbuf, | |
239 | int overwrite, | |
240 | unsigned int switch_timer_interval, | |
241 | unsigned int read_timer_interval, | |
ecc48a90 | 242 | unsigned int live_timer_interval, |
e9404c27 | 243 | unsigned int monitor_timer_interval, |
ffe60014 DG |
244 | int output, |
245 | int type, | |
246 | uint64_t session_id, | |
247 | const char *pathname, | |
248 | const char *name, | |
249 | uid_t uid, | |
250 | gid_t gid, | |
d88aee68 DG |
251 | uint64_t relayd_id, |
252 | uint64_t key, | |
7972aab2 | 253 | unsigned char *uuid, |
1624d5b7 JD |
254 | uint32_t chan_id, |
255 | uint64_t tracefile_size, | |
2bba9e53 | 256 | uint64_t tracefile_count, |
1950109e | 257 | uint64_t session_id_per_pid, |
567eb353 | 258 | unsigned int monitor, |
d7ba1388 | 259 | uint32_t ust_app_uid, |
f515d318 | 260 | int64_t blocking_timeout, |
3d071855 | 261 | const char *root_shm_path, |
d7ba1388 | 262 | const char *shm_path); |
00e2e675 DG |
263 | void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg, |
264 | enum lttng_consumer_command cmd, | |
d88aee68 DG |
265 | uint64_t channel_key, |
266 | uint64_t stream_key, | |
ffe60014 | 267 | int cpu); |
a4baae1b JD |
268 | void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg, |
269 | enum lttng_consumer_command cmd, | |
270 | uint64_t channel_key, uint64_t net_seq_idx); | |
00e2e675 DG |
271 | void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg, |
272 | enum lttng_consumer_command cmd, | |
d88aee68 | 273 | uint64_t channel_key, |
ffe60014 DG |
274 | uint64_t session_id, |
275 | const char *pathname, | |
276 | uid_t uid, | |
277 | gid_t gid, | |
d88aee68 | 278 | uint64_t relayd_id, |
c30aaa51 | 279 | const char *name, |
ffe60014 DG |
280 | unsigned int nb_init_streams, |
281 | enum lttng_event_output output, | |
1624d5b7 JD |
282 | int type, |
283 | uint64_t tracefile_size, | |
2bba9e53 | 284 | uint64_t tracefile_count, |
ecc48a90 | 285 | unsigned int monitor, |
e9404c27 JG |
286 | unsigned int live_timer_interval, |
287 | unsigned int monitor_timer_interval); | |
d88aee68 | 288 | int consumer_is_data_pending(uint64_t session_id, |
806e2684 | 289 | struct consumer_output *consumer); |
7972aab2 DG |
290 | int consumer_close_metadata(struct consumer_socket *socket, |
291 | uint64_t metadata_key); | |
292 | int consumer_setup_metadata(struct consumer_socket *socket, | |
293 | uint64_t metadata_key); | |
294 | int consumer_push_metadata(struct consumer_socket *socket, | |
295 | uint64_t metadata_key, char *metadata_str, size_t len, | |
93ec662e | 296 | size_t target_offset, uint64_t version); |
7972aab2 | 297 | int consumer_flush_channel(struct consumer_socket *socket, uint64_t key); |
0dd01979 | 298 | int consumer_clear_quiescent_channel(struct consumer_socket *socket, uint64_t key); |
fb83fe64 JD |
299 | int consumer_get_discarded_events(uint64_t session_id, uint64_t channel_key, |
300 | struct consumer_output *consumer, uint64_t *discarded); | |
301 | int consumer_get_lost_packets(uint64_t session_id, uint64_t channel_key, | |
302 | struct consumer_output *consumer, uint64_t *lost); | |
00e2e675 | 303 | |
6dc3064a DG |
304 | /* Snapshot command. */ |
305 | int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key, | |
306 | struct snapshot_output *output, int metadata, uid_t uid, gid_t gid, | |
d07ceecd | 307 | const char *session_path, int wait, uint64_t nb_packets_per_stream); |
6dc3064a | 308 | |
38cd0ad9 JR |
309 | /* Clear command */ |
310 | int consumer_clear_channel(struct consumer_socket *socket, uint64_t key, | |
311 | struct consumer_output *output); | |
c7496bc7 | 312 | int consumer_clear_session(struct ltt_session *session); |
f1e16794 | 313 | #endif /* _CONSUMER_H */ |