Commit | Line | Data |
---|---|---|
48842b30 DG |
1 | /* |
2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
3 | * | |
d14d33bf AM |
4 | * This program is free software; you can redistribute it and/or modify |
5 | * it under the terms of the GNU General Public License, version 2 only, | |
6 | * as published by the Free Software Foundation. | |
48842b30 | 7 | * |
d14d33bf AM |
8 | * This program is distributed in the hope that it will be useful, |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
11 | * GNU General Public License for more details. | |
48842b30 | 12 | * |
d14d33bf AM |
13 | * You should have received a copy of the GNU General Public License along |
14 | * with this program; if not, write to the Free Software Foundation, Inc., | |
15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
48842b30 DG |
16 | */ |
17 | ||
6c1c0768 | 18 | #define _LGPL_SOURCE |
48842b30 DG |
19 | #include <errno.h> |
20 | #include <stdio.h> | |
21 | #include <stdlib.h> | |
22 | #include <string.h> | |
23 | #include <unistd.h> | |
d88aee68 | 24 | #include <inttypes.h> |
48842b30 | 25 | |
990570ed | 26 | #include <common/common.h> |
c8fea79c | 27 | #include <common/consumer/consumer.h> |
990570ed | 28 | #include <common/defaults.h> |
48842b30 | 29 | |
00e2e675 | 30 | #include "consumer.h" |
8782cc74 | 31 | #include "health-sessiond.h" |
48842b30 | 32 | #include "ust-consumer.h" |
75018ab6 | 33 | #include "lttng-ust-error.h" |
331744e3 JD |
34 | #include "buffer-registry.h" |
35 | #include "session.h" | |
e9404c27 | 36 | #include "lttng-sessiond.h" |
48842b30 | 37 | |
37278a1e | 38 | /* |
e9404c27 | 39 | * Send a single channel to the consumer using command ASK_CHANNEL_CREATION. |
ffe60014 | 40 | * |
7972aab2 | 41 | * Consumer socket lock MUST be acquired before calling this. |
37278a1e | 42 | */ |
ffe60014 | 43 | static int ask_channel_creation(struct ust_app_session *ua_sess, |
e098433c JG |
44 | struct ust_app_channel *ua_chan, |
45 | struct consumer_output *consumer, | |
46 | struct consumer_socket *socket, | |
47 | struct ust_registry_session *registry, | |
d2956687 | 48 | struct lttng_trace_chunk *trace_chunk) |
37278a1e | 49 | { |
0c759fc9 | 50 | int ret, output; |
7972aab2 DG |
51 | uint32_t chan_id; |
52 | uint64_t key, chan_reg_key; | |
ffe60014 | 53 | char *pathname = NULL; |
37278a1e | 54 | struct lttcomm_consumer_msg msg; |
7972aab2 | 55 | struct ust_registry_channel *chan_reg; |
d7ba1388 | 56 | char shm_path[PATH_MAX] = ""; |
3d071855 | 57 | char root_shm_path[PATH_MAX] = ""; |
d2956687 | 58 | bool is_local_trace; |
37278a1e | 59 | |
ffe60014 DG |
60 | assert(ua_sess); |
61 | assert(ua_chan); | |
62 | assert(socket); | |
37278a1e | 63 | assert(consumer); |
7972aab2 | 64 | assert(registry); |
ffe60014 DG |
65 | |
66 | DBG2("Asking UST consumer for channel"); | |
67 | ||
d2956687 JG |
68 | is_local_trace = consumer->net_seq_index == -1ULL; |
69 | /* Format the channel's path (relative to the current trace chunk). */ | |
3b967712 | 70 | pathname = setup_channel_trace_path(consumer, ua_sess->path); |
d2956687 JG |
71 | if (!pathname) { |
72 | ret = -1; | |
73 | goto error; | |
74 | } | |
75 | ||
76 | if (is_local_trace && trace_chunk) { | |
77 | enum lttng_trace_chunk_status chunk_status; | |
78 | char *pathname_index; | |
79 | ||
80 | ret = asprintf(&pathname_index, "%s/" DEFAULT_INDEX_DIR, | |
81 | pathname); | |
82 | if (ret < 0) { | |
83 | ERR("Failed to format channel index directory"); | |
84 | ret = -1; | |
85 | goto error; | |
86 | } | |
87 | ||
88 | /* | |
89 | * Create the index subdirectory which will take care | |
90 | * of implicitly creating the channel's path. | |
91 | */ | |
92 | chunk_status = lttng_trace_chunk_create_subdirectory( | |
93 | trace_chunk, pathname_index); | |
94 | free(pathname_index); | |
95 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { | |
10a50311 JD |
96 | ret = -1; |
97 | goto error; | |
98 | } | |
ffe60014 DG |
99 | } |
100 | ||
7972aab2 DG |
101 | /* Depending on the buffer type, a different channel key is used. */ |
102 | if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) { | |
103 | chan_reg_key = ua_chan->tracing_channel_id; | |
104 | } else { | |
105 | chan_reg_key = ua_chan->key; | |
106 | } | |
107 | ||
108 | if (ua_chan->attr.type == LTTNG_UST_CHAN_METADATA) { | |
109 | chan_id = -1U; | |
d7ba1388 MD |
110 | /* |
111 | * Metadata channels shm_path (buffers) are handled within | |
112 | * session daemon. Consumer daemon should not try to create | |
113 | * those buffer files. | |
114 | */ | |
7972aab2 DG |
115 | } else { |
116 | chan_reg = ust_registry_channel_find(registry, chan_reg_key); | |
117 | assert(chan_reg); | |
118 | chan_id = chan_reg->chan_id; | |
d7ba1388 MD |
119 | if (ua_sess->shm_path[0]) { |
120 | strncpy(shm_path, ua_sess->shm_path, sizeof(shm_path)); | |
121 | shm_path[sizeof(shm_path) - 1] = '\0'; | |
122 | strncat(shm_path, "/", | |
123 | sizeof(shm_path) - strlen(shm_path) - 1); | |
124 | strncat(shm_path, ua_chan->name, | |
125 | sizeof(shm_path) - strlen(shm_path) - 1); | |
126 | strncat(shm_path, "_", | |
127 | sizeof(shm_path) - strlen(shm_path) - 1); | |
128 | } | |
3d071855 MD |
129 | strncpy(root_shm_path, ua_sess->root_shm_path, sizeof(root_shm_path)); |
130 | root_shm_path[sizeof(root_shm_path) - 1] = '\0'; | |
7972aab2 DG |
131 | } |
132 | ||
0c759fc9 DG |
133 | switch (ua_chan->attr.output) { |
134 | case LTTNG_UST_MMAP: | |
135 | default: | |
136 | output = LTTNG_EVENT_MMAP; | |
137 | break; | |
138 | } | |
139 | ||
ffe60014 DG |
140 | consumer_init_ask_channel_comm_msg(&msg, |
141 | ua_chan->attr.subbuf_size, | |
142 | ua_chan->attr.num_subbuf, | |
143 | ua_chan->attr.overwrite, | |
144 | ua_chan->attr.switch_timer_interval, | |
145 | ua_chan->attr.read_timer_interval, | |
ecc48a90 | 146 | ua_sess->live_timer_interval, |
e9404c27 | 147 | ua_chan->monitor_timer_interval, |
0c759fc9 | 148 | output, |
ffe60014 | 149 | (int) ua_chan->attr.type, |
7972aab2 | 150 | ua_sess->tracing_id, |
ca22feea | 151 | pathname, |
ffe60014 | 152 | ua_chan->name, |
ffe60014 DG |
153 | consumer->net_seq_index, |
154 | ua_chan->key, | |
7972aab2 | 155 | registry->uuid, |
1624d5b7 JD |
156 | chan_id, |
157 | ua_chan->tracefile_size, | |
2bba9e53 | 158 | ua_chan->tracefile_count, |
1950109e | 159 | ua_sess->id, |
567eb353 | 160 | ua_sess->output_traces, |
470cc211 | 161 | ua_sess->real_credentials.uid, |
491d1539 | 162 | ua_chan->attr.blocking_timeout, |
e098433c | 163 | root_shm_path, shm_path, |
470cc211 JG |
164 | trace_chunk, |
165 | &ua_sess->effective_credentials); | |
37278a1e | 166 | |
840cb59c | 167 | health_code_update(); |
ca03de58 | 168 | |
52898cb1 | 169 | ret = consumer_socket_send(socket, &msg, sizeof(msg)); |
37278a1e DG |
170 | if (ret < 0) { |
171 | goto error; | |
172 | } | |
173 | ||
ffe60014 DG |
174 | ret = consumer_recv_status_channel(socket, &key, |
175 | &ua_chan->expected_stream_count); | |
176 | if (ret < 0) { | |
177 | goto error; | |
178 | } | |
179 | /* Communication protocol error. */ | |
180 | assert(key == ua_chan->key); | |
181 | /* We need at least one where 1 stream for 1 cpu. */ | |
10a50311 JD |
182 | if (ua_sess->output_traces) { |
183 | assert(ua_chan->expected_stream_count > 0); | |
184 | } | |
ffe60014 | 185 | |
d88aee68 | 186 | DBG2("UST ask channel %" PRIu64 " successfully done with %u stream(s)", key, |
ffe60014 | 187 | ua_chan->expected_stream_count); |
ca03de58 | 188 | |
37278a1e | 189 | error: |
ffe60014 DG |
190 | free(pathname); |
191 | health_code_update(); | |
37278a1e DG |
192 | return ret; |
193 | } | |
194 | ||
195 | /* | |
ffe60014 DG |
196 | * Ask consumer to create a channel for a given session. |
197 | * | |
e9404c27 JG |
198 | * Session list and rcu read side locks must be held by the caller. |
199 | * | |
ffe60014 | 200 | * Returns 0 on success else a negative value. |
37278a1e | 201 | */ |
ffe60014 | 202 | int ust_consumer_ask_channel(struct ust_app_session *ua_sess, |
e098433c JG |
203 | struct ust_app_channel *ua_chan, |
204 | struct consumer_output *consumer, | |
205 | struct consumer_socket *socket, | |
206 | struct ust_registry_session *registry, | |
d2956687 | 207 | struct lttng_trace_chunk * trace_chunk) |
37278a1e DG |
208 | { |
209 | int ret; | |
37278a1e | 210 | |
ffe60014 DG |
211 | assert(ua_sess); |
212 | assert(ua_chan); | |
213 | assert(consumer); | |
214 | assert(socket); | |
7972aab2 | 215 | assert(registry); |
f50f23d9 | 216 | |
d9078d0c DG |
217 | if (!consumer->enabled) { |
218 | ret = -LTTNG_ERR_NO_CONSUMER; | |
219 | DBG3("Consumer is disabled"); | |
220 | goto error; | |
221 | } | |
222 | ||
ffe60014 | 223 | pthread_mutex_lock(socket->lock); |
e098433c | 224 | ret = ask_channel_creation(ua_sess, ua_chan, consumer, socket, registry, |
d2956687 | 225 | trace_chunk); |
2898de39 | 226 | pthread_mutex_unlock(socket->lock); |
37278a1e | 227 | if (ret < 0) { |
e9404c27 | 228 | ERR("ask_channel_creation consumer command failed"); |
37278a1e DG |
229 | goto error; |
230 | } | |
231 | ||
48842b30 DG |
232 | error: |
233 | return ret; | |
234 | } | |
235 | ||
236 | /* | |
ffe60014 DG |
237 | * Send a get channel command to consumer using the given channel key. The |
238 | * channel object is populated and the stream list. | |
239 | * | |
240 | * Return 0 on success else a negative value. | |
48842b30 | 241 | */ |
ffe60014 DG |
242 | int ust_consumer_get_channel(struct consumer_socket *socket, |
243 | struct ust_app_channel *ua_chan) | |
48842b30 | 244 | { |
ffe60014 | 245 | int ret; |
37278a1e | 246 | struct lttcomm_consumer_msg msg; |
48842b30 | 247 | |
ffe60014 DG |
248 | assert(ua_chan); |
249 | assert(socket); | |
48842b30 | 250 | |
53efb85a | 251 | memset(&msg, 0, sizeof(msg)); |
ffe60014 DG |
252 | msg.cmd_type = LTTNG_CONSUMER_GET_CHANNEL; |
253 | msg.u.get_channel.key = ua_chan->key; | |
37278a1e | 254 | |
ffe60014 | 255 | pthread_mutex_lock(socket->lock); |
840cb59c | 256 | health_code_update(); |
ca03de58 | 257 | |
ffe60014 DG |
258 | /* Send command and wait for OK reply. */ |
259 | ret = consumer_send_msg(socket, &msg); | |
37278a1e DG |
260 | if (ret < 0) { |
261 | goto error; | |
262 | } | |
263 | ||
ffe60014 | 264 | /* First, get the channel from consumer. */ |
9363801e | 265 | ret = ustctl_recv_channel_from_consumer(*socket->fd_ptr, &ua_chan->obj); |
37278a1e | 266 | if (ret < 0) { |
ffe60014 DG |
267 | if (ret != -EPIPE) { |
268 | ERR("Error recv channel from consumer %d with ret %d", | |
9363801e | 269 | *socket->fd_ptr, ret); |
ffe60014 DG |
270 | } else { |
271 | DBG3("UST app recv channel from consumer. Consumer is dead."); | |
272 | } | |
37278a1e DG |
273 | goto error; |
274 | } | |
00e2e675 | 275 | |
ffe60014 DG |
276 | /* Next, get all streams. */ |
277 | while (1) { | |
278 | struct ust_app_stream *stream; | |
ca03de58 | 279 | |
ffe60014 DG |
280 | /* Create UST stream */ |
281 | stream = ust_app_alloc_stream(); | |
282 | if (stream == NULL) { | |
283 | ret = -ENOMEM; | |
48842b30 DG |
284 | goto error; |
285 | } | |
286 | ||
ffe60014 | 287 | /* Stream object is populated by this call if successful. */ |
9363801e | 288 | ret = ustctl_recv_stream_from_consumer(*socket->fd_ptr, &stream->obj); |
37278a1e | 289 | if (ret < 0) { |
ffe60014 DG |
290 | free(stream); |
291 | if (ret == -LTTNG_UST_ERR_NOENT) { | |
292 | DBG3("UST app consumer has no more stream available"); | |
ffe60014 DG |
293 | break; |
294 | } | |
295 | if (ret != -EPIPE) { | |
296 | ERR("Recv stream from consumer %d with ret %d", | |
9363801e | 297 | *socket->fd_ptr, ret); |
ffe60014 DG |
298 | } else { |
299 | DBG3("UST app recv stream from consumer. Consumer is dead."); | |
00e2e675 | 300 | } |
48842b30 DG |
301 | goto error; |
302 | } | |
37278a1e | 303 | |
ffe60014 DG |
304 | /* Order is important this is why a list is used. */ |
305 | cds_list_add_tail(&stream->list, &ua_chan->streams.head); | |
306 | ua_chan->streams.count++; | |
37278a1e | 307 | |
5368d366 | 308 | DBG2("UST app stream %d received successfully", ua_chan->streams.count); |
ffe60014 DG |
309 | } |
310 | ||
311 | /* This MUST match or else we have a synchronization problem. */ | |
312 | assert(ua_chan->expected_stream_count == ua_chan->streams.count); | |
ca03de58 | 313 | |
ffe60014 DG |
314 | /* Wait for confirmation that we can proceed with the streams. */ |
315 | ret = consumer_recv_status_reply(socket); | |
37278a1e DG |
316 | if (ret < 0) { |
317 | goto error; | |
318 | } | |
319 | ||
320 | error: | |
ffe60014 DG |
321 | health_code_update(); |
322 | pthread_mutex_unlock(socket->lock); | |
37278a1e DG |
323 | return ret; |
324 | } | |
325 | ||
326 | /* | |
ffe60014 DG |
327 | * Send a destroy channel command to consumer using the given channel key. |
328 | * | |
329 | * Note that this command MUST be used prior to a successful | |
330 | * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully, | |
331 | * the streams are dispatched to the consumer threads and MUST be teardown | |
332 | * through the hang up process. | |
333 | * | |
334 | * Return 0 on success else a negative value. | |
37278a1e | 335 | */ |
ffe60014 DG |
336 | int ust_consumer_destroy_channel(struct consumer_socket *socket, |
337 | struct ust_app_channel *ua_chan) | |
37278a1e | 338 | { |
ffe60014 DG |
339 | int ret; |
340 | struct lttcomm_consumer_msg msg; | |
a4b92340 | 341 | |
ffe60014 DG |
342 | assert(ua_chan); |
343 | assert(socket); | |
37278a1e | 344 | |
53efb85a | 345 | memset(&msg, 0, sizeof(msg)); |
ffe60014 DG |
346 | msg.cmd_type = LTTNG_CONSUMER_DESTROY_CHANNEL; |
347 | msg.u.destroy_channel.key = ua_chan->key; | |
173af62f | 348 | |
ffe60014 DG |
349 | pthread_mutex_lock(socket->lock); |
350 | health_code_update(); | |
37278a1e | 351 | |
ffe60014 | 352 | ret = consumer_send_msg(socket, &msg); |
37278a1e DG |
353 | if (ret < 0) { |
354 | goto error; | |
48842b30 DG |
355 | } |
356 | ||
ffe60014 DG |
357 | error: |
358 | health_code_update(); | |
359 | pthread_mutex_unlock(socket->lock); | |
360 | return ret; | |
361 | } | |
aeb96892 | 362 | |
ffe60014 DG |
363 | /* |
364 | * Send a given stream to UST tracer. | |
365 | * | |
366 | * On success return 0 else a negative value. | |
367 | */ | |
368 | int ust_consumer_send_stream_to_ust(struct ust_app *app, | |
369 | struct ust_app_channel *channel, struct ust_app_stream *stream) | |
370 | { | |
371 | int ret; | |
372 | ||
373 | assert(app); | |
374 | assert(stream); | |
375 | assert(channel); | |
376 | ||
377 | DBG2("UST consumer send stream to app %d", app->sock); | |
378 | ||
379 | /* Relay stream to application. */ | |
fb45065e | 380 | pthread_mutex_lock(&app->sock_lock); |
ffe60014 | 381 | ret = ustctl_send_stream_to_ust(app->sock, channel->obj, stream->obj); |
fb45065e | 382 | pthread_mutex_unlock(&app->sock_lock); |
ffe60014 DG |
383 | if (ret < 0) { |
384 | if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) { | |
8cf93def DG |
385 | ERR("ustctl send stream handle %d to app pid: %d with ret %d", |
386 | stream->obj->handle, app->pid, ret); | |
ffe60014 DG |
387 | } else { |
388 | DBG3("UST app send stream to ust failed. Application is dead."); | |
48842b30 | 389 | } |
ffe60014 | 390 | goto error; |
48842b30 | 391 | } |
d0b96690 | 392 | channel->handle = channel->obj->handle; |
48842b30 | 393 | |
ffe60014 DG |
394 | error: |
395 | return ret; | |
396 | } | |
397 | ||
398 | /* | |
399 | * Send channel previously received from the consumer to the UST tracer. | |
400 | * | |
401 | * On success return 0 else a negative value. | |
402 | */ | |
403 | int ust_consumer_send_channel_to_ust(struct ust_app *app, | |
404 | struct ust_app_session *ua_sess, struct ust_app_channel *channel) | |
405 | { | |
406 | int ret; | |
407 | ||
408 | assert(app); | |
409 | assert(ua_sess); | |
410 | assert(channel); | |
411 | assert(channel->obj); | |
412 | ||
7972aab2 DG |
413 | DBG2("UST app send channel to sock %d pid %d (name: %s, key: %" PRIu64 ")", |
414 | app->sock, app->pid, channel->name, channel->tracing_channel_id); | |
48842b30 | 415 | |
ffe60014 | 416 | /* Send stream to application. */ |
fb45065e | 417 | pthread_mutex_lock(&app->sock_lock); |
ffe60014 | 418 | ret = ustctl_send_channel_to_ust(app->sock, ua_sess->handle, channel->obj); |
fb45065e | 419 | pthread_mutex_unlock(&app->sock_lock); |
ffe60014 DG |
420 | if (ret < 0) { |
421 | if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) { | |
422 | ERR("Error ustctl send channel %s to app pid: %d with ret %d", | |
423 | channel->name, app->pid, ret); | |
424 | } else { | |
425 | DBG3("UST app send channel to ust failed. Application is dead."); | |
426 | } | |
427 | goto error; | |
428 | } | |
48842b30 DG |
429 | |
430 | error: | |
431 | return ret; | |
432 | } | |
331744e3 JD |
433 | |
434 | /* | |
435 | * Handle the metadata requests from the UST consumer | |
436 | * | |
437 | * Return 0 on success else a negative value. | |
438 | */ | |
439 | int ust_consumer_metadata_request(struct consumer_socket *socket) | |
440 | { | |
441 | int ret; | |
442 | ssize_t ret_push; | |
443 | struct lttcomm_metadata_request_msg request; | |
444 | struct buffer_reg_uid *reg_uid; | |
445 | struct ust_registry_session *ust_reg; | |
446 | struct lttcomm_consumer_msg msg; | |
447 | ||
448 | assert(socket); | |
449 | ||
450 | rcu_read_lock(); | |
331744e3 JD |
451 | health_code_update(); |
452 | ||
453 | /* Wait for a metadata request */ | |
dc2bbdae | 454 | pthread_mutex_lock(socket->lock); |
52898cb1 | 455 | ret = consumer_socket_recv(socket, &request, sizeof(request)); |
dc2bbdae | 456 | pthread_mutex_unlock(socket->lock); |
52898cb1 | 457 | if (ret < 0) { |
331744e3 JD |
458 | goto end; |
459 | } | |
460 | ||
1950109e | 461 | DBG("Metadata request received for session %" PRIu64 ", key %" PRIu64, |
331744e3 JD |
462 | request.session_id, request.key); |
463 | ||
464 | reg_uid = buffer_reg_uid_find(request.session_id, | |
465 | request.bits_per_long, request.uid); | |
466 | if (reg_uid) { | |
467 | ust_reg = reg_uid->registry->reg.ust; | |
468 | } else { | |
469 | struct buffer_reg_pid *reg_pid = | |
1950109e | 470 | buffer_reg_pid_find(request.session_id_per_pid); |
331744e3 | 471 | if (!reg_pid) { |
1950109e JD |
472 | DBG("PID registry not found for session id %" PRIu64, |
473 | request.session_id_per_pid); | |
331744e3 | 474 | |
53efb85a | 475 | memset(&msg, 0, sizeof(msg)); |
331744e3 | 476 | msg.cmd_type = LTTNG_ERR_UND; |
cb7d882c | 477 | pthread_mutex_lock(socket->lock); |
331744e3 | 478 | (void) consumer_send_msg(socket, &msg); |
cb7d882c | 479 | pthread_mutex_unlock(socket->lock); |
331744e3 JD |
480 | /* |
481 | * This is possible since the session might have been destroyed | |
482 | * during a consumer metadata request. So here, return gracefully | |
483 | * because the destroy session will push the remaining metadata to | |
484 | * the consumer. | |
485 | */ | |
486 | ret = 0; | |
487 | goto end; | |
488 | } | |
489 | ust_reg = reg_pid->registry->reg.ust; | |
490 | } | |
491 | assert(ust_reg); | |
492 | ||
dc2bbdae | 493 | pthread_mutex_lock(&ust_reg->lock); |
331744e3 | 494 | ret_push = ust_app_push_metadata(ust_reg, socket, 1); |
dc2bbdae | 495 | pthread_mutex_unlock(&ust_reg->lock); |
2c57e06d MD |
496 | if (ret_push == -EPIPE) { |
497 | DBG("Application or relay closed while pushing metadata"); | |
498 | } else if (ret_push < 0) { | |
331744e3 JD |
499 | ERR("Pushing metadata"); |
500 | ret = -1; | |
501 | goto end; | |
2c57e06d MD |
502 | } else { |
503 | DBG("UST Consumer metadata pushed successfully"); | |
331744e3 | 504 | } |
331744e3 JD |
505 | ret = 0; |
506 | ||
507 | end: | |
331744e3 JD |
508 | rcu_read_unlock(); |
509 | return ret; | |
510 | } |