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; |
4ce514c4 DG |
96 | /* |
97 | * The metadata socket object is handled differently and only created | |
98 | * locally in this object thus it's the only reference available in the | |
9363801e DG |
99 | * session daemon. For that reason, a variable for the fd is required and |
100 | * the metadata socket fd points to it. | |
4ce514c4 DG |
101 | */ |
102 | int metadata_fd; | |
331744e3 | 103 | struct consumer_socket metadata_sock; |
f1e16794 DG |
104 | |
105 | /* consumer error and command Unix socket path */ | |
106 | char err_unix_sock_path[PATH_MAX]; | |
107 | char cmd_unix_sock_path[PATH_MAX]; | |
44a5e5eb | 108 | |
92db7cdc DG |
109 | /* |
110 | * This lock has two purposes. It protects any change to the consumer | |
111 | * socket and make sure only one thread uses this object for read/write | |
112 | * operations. | |
113 | */ | |
173af62f | 114 | pthread_mutex_t lock; |
f1e16794 DG |
115 | }; |
116 | ||
00e2e675 DG |
117 | /* |
118 | * Network URIs | |
119 | */ | |
120 | struct consumer_net { | |
121 | /* | |
122 | * Indicate if URI type is set. Those flags should only be set when the | |
123 | * created URI is done AND valid. | |
124 | */ | |
125 | int control_isset; | |
126 | int data_isset; | |
127 | ||
128 | /* | |
129 | * The following two URIs MUST have the same destination address for | |
130 | * network streaming to work. Network hop are not yet supported. | |
131 | */ | |
132 | ||
133 | /* Control path for network streaming. */ | |
134 | struct lttng_uri control; | |
135 | ||
136 | /* Data path for network streaming. */ | |
137 | struct lttng_uri data; | |
138 | }; | |
139 | ||
140 | /* | |
141 | * Consumer output object describing where and how to send data. | |
142 | */ | |
143 | struct consumer_output { | |
6addfa37 MD |
144 | struct urcu_ref ref; /* Refcount */ |
145 | ||
00e2e675 DG |
146 | /* If the consumer is enabled meaning that should be used */ |
147 | unsigned int enabled; | |
148 | enum consumer_dst_type type; | |
173af62f | 149 | |
00e2e675 DG |
150 | /* |
151 | * The net_seq_index is the index of the network stream on the consumer | |
3f8e211f DG |
152 | * side. It tells the consumer which streams goes to which relayd with this |
153 | * index. The relayd sockets are index with it on the consumer side. | |
00e2e675 | 154 | */ |
d88aee68 | 155 | uint64_t net_seq_index; |
173af62f | 156 | |
00e2e675 DG |
157 | /* |
158 | * Subdirectory path name used for both local and network consumer. | |
159 | */ | |
160 | char subdir[PATH_MAX]; | |
173af62f DG |
161 | |
162 | /* | |
163 | * Hashtable of consumer_socket index by the file descriptor value. For | |
164 | * multiarch consumer support, we can have more than one consumer (ex: 32 | |
165 | * and 64 bit). | |
166 | */ | |
167 | struct lttng_ht *socks; | |
168 | ||
7d2f7452 DG |
169 | /* Tell if this output is used for snapshot. */ |
170 | unsigned int snapshot:1; | |
171 | ||
00e2e675 DG |
172 | union { |
173 | char trace_path[PATH_MAX]; | |
174 | struct consumer_net net; | |
175 | } dst; | |
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); | |
00e2e675 DG |
200 | int consumer_set_network_uri(struct consumer_output *obj, |
201 | struct lttng_uri *uri); | |
f50f23d9 | 202 | int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd); |
ffe60014 DG |
203 | int consumer_send_msg(struct consumer_socket *sock, |
204 | struct lttcomm_consumer_msg *msg); | |
f50f23d9 DG |
205 | int consumer_send_stream(struct consumer_socket *sock, |
206 | struct consumer_output *dst, struct lttcomm_consumer_msg *msg, | |
207 | int *fds, size_t nb_fd); | |
208 | int consumer_send_channel(struct consumer_socket *sock, | |
209 | struct lttcomm_consumer_msg *msg); | |
210 | int consumer_send_relayd_socket(struct consumer_socket *consumer_sock, | |
6151a90f | 211 | struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer, |
d3e2ba59 JD |
212 | enum lttng_stream_type type, uint64_t session_id, |
213 | char *session_name, char *hostname, int session_live_timer); | |
173af62f DG |
214 | int consumer_send_destroy_relayd(struct consumer_socket *sock, |
215 | struct consumer_output *consumer); | |
f50f23d9 | 216 | int consumer_recv_status_reply(struct consumer_socket *sock); |
ffe60014 | 217 | int consumer_recv_status_channel(struct consumer_socket *sock, |
d88aee68 | 218 | uint64_t *key, unsigned int *stream_count); |
2f77fc4b | 219 | void consumer_output_send_destroy_relayd(struct consumer_output *consumer); |
a4b92340 DG |
220 | int consumer_create_socket(struct consumer_data *data, |
221 | struct consumer_output *output); | |
2f77fc4b DG |
222 | int consumer_set_subdir(struct consumer_output *consumer, |
223 | const char *session_name); | |
37278a1e | 224 | |
ffe60014 DG |
225 | void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg, |
226 | uint64_t subbuf_size, | |
227 | uint64_t num_subbuf, | |
228 | int overwrite, | |
229 | unsigned int switch_timer_interval, | |
230 | unsigned int read_timer_interval, | |
ecc48a90 | 231 | unsigned int live_timer_interval, |
ffe60014 DG |
232 | int output, |
233 | int type, | |
234 | uint64_t session_id, | |
235 | const char *pathname, | |
236 | const char *name, | |
237 | uid_t uid, | |
238 | gid_t gid, | |
d88aee68 DG |
239 | uint64_t relayd_id, |
240 | uint64_t key, | |
7972aab2 | 241 | unsigned char *uuid, |
1624d5b7 JD |
242 | uint32_t chan_id, |
243 | uint64_t tracefile_size, | |
2bba9e53 | 244 | uint64_t tracefile_count, |
1950109e | 245 | uint64_t session_id_per_pid, |
567eb353 | 246 | unsigned int monitor, |
d7ba1388 | 247 | uint32_t ust_app_uid, |
3d071855 | 248 | const char *root_shm_path, |
d7ba1388 | 249 | const char *shm_path); |
00e2e675 DG |
250 | void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg, |
251 | enum lttng_consumer_command cmd, | |
d88aee68 DG |
252 | uint64_t channel_key, |
253 | uint64_t stream_key, | |
ffe60014 | 254 | int cpu); |
a4baae1b JD |
255 | void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg *msg, |
256 | enum lttng_consumer_command cmd, | |
257 | uint64_t channel_key, uint64_t net_seq_idx); | |
00e2e675 DG |
258 | void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg, |
259 | enum lttng_consumer_command cmd, | |
d88aee68 | 260 | uint64_t channel_key, |
ffe60014 DG |
261 | uint64_t session_id, |
262 | const char *pathname, | |
263 | uid_t uid, | |
264 | gid_t gid, | |
d88aee68 | 265 | uint64_t relayd_id, |
c30aaa51 | 266 | const char *name, |
ffe60014 DG |
267 | unsigned int nb_init_streams, |
268 | enum lttng_event_output output, | |
1624d5b7 JD |
269 | int type, |
270 | uint64_t tracefile_size, | |
2bba9e53 | 271 | uint64_t tracefile_count, |
ecc48a90 JD |
272 | unsigned int monitor, |
273 | unsigned int live_timer_interval); | |
d88aee68 | 274 | int consumer_is_data_pending(uint64_t session_id, |
806e2684 | 275 | struct consumer_output *consumer); |
7972aab2 DG |
276 | int consumer_close_metadata(struct consumer_socket *socket, |
277 | uint64_t metadata_key); | |
278 | int consumer_setup_metadata(struct consumer_socket *socket, | |
279 | uint64_t metadata_key); | |
280 | int consumer_push_metadata(struct consumer_socket *socket, | |
281 | uint64_t metadata_key, char *metadata_str, size_t len, | |
282 | size_t target_offset); | |
283 | int consumer_flush_channel(struct consumer_socket *socket, uint64_t key); | |
00e2e675 | 284 | |
6dc3064a DG |
285 | /* Snapshot command. */ |
286 | int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key, | |
287 | struct snapshot_output *output, int metadata, uid_t uid, gid_t gid, | |
d07ceecd | 288 | const char *session_path, int wait, uint64_t nb_packets_per_stream); |
6dc3064a | 289 | |
f1e16794 | 290 | #endif /* _CONSUMER_H */ |