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 | ||
18 | #define _GNU_SOURCE | |
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> |
db758600 | 27 | #include <common/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" |
331744e3 JD |
33 | #include "buffer-registry.h" |
34 | #include "session.h" | |
48842b30 DG |
35 | |
36 | /* | |
ffe60014 DG |
37 | * Return allocated full pathname of the session using the consumer trace path |
38 | * and subdir if available. On a successful allocation, the directory of the | |
39 | * trace is created with the session credentials. | |
40 | * | |
41 | * The caller can safely free(3) the returned value. On error, NULL is | |
42 | * returned. | |
48842b30 | 43 | */ |
ffe60014 DG |
44 | static char *setup_trace_path(struct consumer_output *consumer, |
45 | struct ust_app_session *ua_sess) | |
48842b30 | 46 | { |
ffe60014 DG |
47 | int ret; |
48 | char *pathname; | |
37278a1e | 49 | |
ffe60014 DG |
50 | assert(consumer); |
51 | assert(ua_sess); | |
00e2e675 | 52 | |
840cb59c | 53 | health_code_update(); |
ca03de58 | 54 | |
ffe60014 DG |
55 | /* Allocate our self the string to make sure we never exceed PATH_MAX. */ |
56 | pathname = zmalloc(PATH_MAX); | |
57 | if (!pathname) { | |
48842b30 DG |
58 | goto error; |
59 | } | |
00e2e675 | 60 | |
ffe60014 DG |
61 | /* Get correct path name destination */ |
62 | if (consumer->type == CONSUMER_DST_LOCAL) { | |
63 | /* Set application path to the destination path */ | |
dec56f6c | 64 | ret = snprintf(pathname, PATH_MAX, "%s%s%s", |
ffe60014 DG |
65 | consumer->dst.trace_path, consumer->subdir, ua_sess->path); |
66 | if (ret < 0) { | |
67 | PERROR("snprintf channel path"); | |
68 | goto error; | |
69 | } | |
ca03de58 | 70 | |
ffe60014 | 71 | /* Create directory. Ignore if exist. */ |
7972aab2 DG |
72 | ret = run_as_mkdir_recursive(pathname, S_IRWXU | S_IRWXG, |
73 | ua_sess->euid, ua_sess->egid); | |
ffe60014 | 74 | if (ret < 0) { |
4ffbac14 | 75 | if (errno != EEXIST) { |
ffe60014 DG |
76 | ERR("Trace directory creation error"); |
77 | goto error; | |
78 | } | |
79 | } | |
80 | } else { | |
dec56f6c | 81 | ret = snprintf(pathname, PATH_MAX, "%s%s", consumer->subdir, |
ffe60014 DG |
82 | ua_sess->path); |
83 | if (ret < 0) { | |
84 | PERROR("snprintf channel path"); | |
85 | goto error; | |
86 | } | |
48842b30 DG |
87 | } |
88 | ||
ffe60014 | 89 | return pathname; |
ca03de58 | 90 | |
37278a1e | 91 | error: |
ffe60014 DG |
92 | free(pathname); |
93 | return NULL; | |
37278a1e DG |
94 | } |
95 | ||
96 | /* | |
ffe60014 DG |
97 | * Send a single channel to the consumer using command ADD_CHANNEL. |
98 | * | |
7972aab2 | 99 | * Consumer socket lock MUST be acquired before calling this. |
37278a1e | 100 | */ |
ffe60014 DG |
101 | static int ask_channel_creation(struct ust_app_session *ua_sess, |
102 | struct ust_app_channel *ua_chan, struct consumer_output *consumer, | |
7972aab2 | 103 | struct consumer_socket *socket, struct ust_registry_session *registry) |
37278a1e | 104 | { |
0c759fc9 | 105 | int ret, output; |
7972aab2 DG |
106 | uint32_t chan_id; |
107 | uint64_t key, chan_reg_key; | |
ffe60014 | 108 | char *pathname = NULL; |
37278a1e | 109 | struct lttcomm_consumer_msg msg; |
7972aab2 | 110 | struct ust_registry_channel *chan_reg; |
37278a1e | 111 | |
ffe60014 DG |
112 | assert(ua_sess); |
113 | assert(ua_chan); | |
114 | assert(socket); | |
37278a1e | 115 | assert(consumer); |
7972aab2 | 116 | assert(registry); |
ffe60014 DG |
117 | |
118 | DBG2("Asking UST consumer for channel"); | |
119 | ||
120 | /* Get and create full trace path of session. */ | |
10a50311 JD |
121 | if (ua_sess->output_traces) { |
122 | pathname = setup_trace_path(consumer, ua_sess); | |
123 | if (!pathname) { | |
124 | ret = -1; | |
125 | goto error; | |
126 | } | |
ffe60014 DG |
127 | } |
128 | ||
7972aab2 DG |
129 | /* Depending on the buffer type, a different channel key is used. */ |
130 | if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) { | |
131 | chan_reg_key = ua_chan->tracing_channel_id; | |
132 | } else { | |
133 | chan_reg_key = ua_chan->key; | |
134 | } | |
135 | ||
136 | if (ua_chan->attr.type == LTTNG_UST_CHAN_METADATA) { | |
137 | chan_id = -1U; | |
138 | } else { | |
139 | chan_reg = ust_registry_channel_find(registry, chan_reg_key); | |
140 | assert(chan_reg); | |
141 | chan_id = chan_reg->chan_id; | |
142 | } | |
143 | ||
0c759fc9 DG |
144 | switch (ua_chan->attr.output) { |
145 | case LTTNG_UST_MMAP: | |
146 | default: | |
147 | output = LTTNG_EVENT_MMAP; | |
148 | break; | |
149 | } | |
150 | ||
ffe60014 DG |
151 | consumer_init_ask_channel_comm_msg(&msg, |
152 | ua_chan->attr.subbuf_size, | |
153 | ua_chan->attr.num_subbuf, | |
154 | ua_chan->attr.overwrite, | |
155 | ua_chan->attr.switch_timer_interval, | |
156 | ua_chan->attr.read_timer_interval, | |
ecc48a90 | 157 | ua_sess->live_timer_interval, |
0c759fc9 | 158 | output, |
ffe60014 | 159 | (int) ua_chan->attr.type, |
7972aab2 | 160 | ua_sess->tracing_id, |
ca22feea | 161 | pathname, |
ffe60014 | 162 | ua_chan->name, |
7972aab2 DG |
163 | ua_sess->euid, |
164 | ua_sess->egid, | |
ffe60014 DG |
165 | consumer->net_seq_index, |
166 | ua_chan->key, | |
7972aab2 | 167 | registry->uuid, |
1624d5b7 JD |
168 | chan_id, |
169 | ua_chan->tracefile_size, | |
2bba9e53 | 170 | ua_chan->tracefile_count, |
1950109e | 171 | ua_sess->id, |
567eb353 DG |
172 | ua_sess->output_traces, |
173 | ua_sess->uid); | |
37278a1e | 174 | |
840cb59c | 175 | health_code_update(); |
ca03de58 | 176 | |
52898cb1 | 177 | ret = consumer_socket_send(socket, &msg, sizeof(msg)); |
37278a1e DG |
178 | if (ret < 0) { |
179 | goto error; | |
180 | } | |
181 | ||
ffe60014 DG |
182 | ret = consumer_recv_status_channel(socket, &key, |
183 | &ua_chan->expected_stream_count); | |
184 | if (ret < 0) { | |
185 | goto error; | |
186 | } | |
187 | /* Communication protocol error. */ | |
188 | assert(key == ua_chan->key); | |
189 | /* We need at least one where 1 stream for 1 cpu. */ | |
10a50311 JD |
190 | if (ua_sess->output_traces) { |
191 | assert(ua_chan->expected_stream_count > 0); | |
192 | } | |
ffe60014 | 193 | |
d88aee68 | 194 | DBG2("UST ask channel %" PRIu64 " successfully done with %u stream(s)", key, |
ffe60014 | 195 | ua_chan->expected_stream_count); |
ca03de58 | 196 | |
37278a1e | 197 | error: |
ffe60014 DG |
198 | free(pathname); |
199 | health_code_update(); | |
37278a1e DG |
200 | return ret; |
201 | } | |
202 | ||
203 | /* | |
ffe60014 DG |
204 | * Ask consumer to create a channel for a given session. |
205 | * | |
206 | * Returns 0 on success else a negative value. | |
37278a1e | 207 | */ |
ffe60014 DG |
208 | int ust_consumer_ask_channel(struct ust_app_session *ua_sess, |
209 | struct ust_app_channel *ua_chan, struct consumer_output *consumer, | |
7972aab2 | 210 | struct consumer_socket *socket, struct ust_registry_session *registry) |
37278a1e DG |
211 | { |
212 | int ret; | |
37278a1e | 213 | |
ffe60014 DG |
214 | assert(ua_sess); |
215 | assert(ua_chan); | |
216 | assert(consumer); | |
217 | assert(socket); | |
7972aab2 | 218 | assert(registry); |
f50f23d9 | 219 | |
d9078d0c DG |
220 | if (!consumer->enabled) { |
221 | ret = -LTTNG_ERR_NO_CONSUMER; | |
222 | DBG3("Consumer is disabled"); | |
223 | goto error; | |
224 | } | |
225 | ||
ffe60014 | 226 | pthread_mutex_lock(socket->lock); |
7972aab2 | 227 | ret = ask_channel_creation(ua_sess, ua_chan, consumer, socket, registry); |
7b2ec45e | 228 | pthread_mutex_unlock(socket->lock); |
37278a1e DG |
229 | if (ret < 0) { |
230 | goto error; | |
231 | } | |
232 | ||
48842b30 DG |
233 | error: |
234 | return ret; | |
235 | } | |
236 | ||
237 | /* | |
ffe60014 DG |
238 | * Send a get channel command to consumer using the given channel key. The |
239 | * channel object is populated and the stream list. | |
240 | * | |
241 | * Return 0 on success else a negative value. | |
48842b30 | 242 | */ |
ffe60014 DG |
243 | int ust_consumer_get_channel(struct consumer_socket *socket, |
244 | struct ust_app_channel *ua_chan) | |
48842b30 | 245 | { |
ffe60014 | 246 | int ret; |
37278a1e | 247 | struct lttcomm_consumer_msg msg; |
48842b30 | 248 | |
ffe60014 DG |
249 | assert(ua_chan); |
250 | assert(socket); | |
48842b30 | 251 | |
53efb85a | 252 | memset(&msg, 0, sizeof(msg)); |
ffe60014 DG |
253 | msg.cmd_type = LTTNG_CONSUMER_GET_CHANNEL; |
254 | msg.u.get_channel.key = ua_chan->key; | |
37278a1e | 255 | |
ffe60014 | 256 | pthread_mutex_lock(socket->lock); |
840cb59c | 257 | health_code_update(); |
ca03de58 | 258 | |
ffe60014 DG |
259 | /* Send command and wait for OK reply. */ |
260 | ret = consumer_send_msg(socket, &msg); | |
37278a1e DG |
261 | if (ret < 0) { |
262 | goto error; | |
263 | } | |
264 | ||
ffe60014 | 265 | /* First, get the channel from consumer. */ |
9363801e | 266 | ret = ustctl_recv_channel_from_consumer(*socket->fd_ptr, &ua_chan->obj); |
37278a1e | 267 | if (ret < 0) { |
ffe60014 DG |
268 | if (ret != -EPIPE) { |
269 | ERR("Error recv channel from consumer %d with ret %d", | |
9363801e | 270 | *socket->fd_ptr, ret); |
ffe60014 DG |
271 | } else { |
272 | DBG3("UST app recv channel from consumer. Consumer is dead."); | |
273 | } | |
37278a1e DG |
274 | goto error; |
275 | } | |
00e2e675 | 276 | |
ffe60014 DG |
277 | /* Next, get all streams. */ |
278 | while (1) { | |
279 | struct ust_app_stream *stream; | |
ca03de58 | 280 | |
ffe60014 DG |
281 | /* Create UST stream */ |
282 | stream = ust_app_alloc_stream(); | |
283 | if (stream == NULL) { | |
284 | ret = -ENOMEM; | |
48842b30 DG |
285 | goto error; |
286 | } | |
287 | ||
ffe60014 | 288 | /* Stream object is populated by this call if successful. */ |
9363801e | 289 | ret = ustctl_recv_stream_from_consumer(*socket->fd_ptr, &stream->obj); |
37278a1e | 290 | if (ret < 0) { |
ffe60014 DG |
291 | free(stream); |
292 | if (ret == -LTTNG_UST_ERR_NOENT) { | |
293 | DBG3("UST app consumer has no more stream available"); | |
294 | ret = 0; | |
295 | break; | |
296 | } | |
297 | if (ret != -EPIPE) { | |
298 | ERR("Recv stream from consumer %d with ret %d", | |
9363801e | 299 | *socket->fd_ptr, ret); |
ffe60014 DG |
300 | } else { |
301 | DBG3("UST app recv stream from consumer. Consumer is dead."); | |
00e2e675 | 302 | } |
48842b30 DG |
303 | goto error; |
304 | } | |
37278a1e | 305 | |
ffe60014 DG |
306 | /* Order is important this is why a list is used. */ |
307 | cds_list_add_tail(&stream->list, &ua_chan->streams.head); | |
308 | ua_chan->streams.count++; | |
37278a1e | 309 | |
5368d366 | 310 | DBG2("UST app stream %d received successfully", ua_chan->streams.count); |
ffe60014 DG |
311 | } |
312 | ||
313 | /* This MUST match or else we have a synchronization problem. */ | |
314 | assert(ua_chan->expected_stream_count == ua_chan->streams.count); | |
ca03de58 | 315 | |
ffe60014 DG |
316 | /* Wait for confirmation that we can proceed with the streams. */ |
317 | ret = consumer_recv_status_reply(socket); | |
37278a1e DG |
318 | if (ret < 0) { |
319 | goto error; | |
320 | } | |
321 | ||
322 | error: | |
ffe60014 DG |
323 | health_code_update(); |
324 | pthread_mutex_unlock(socket->lock); | |
37278a1e DG |
325 | return ret; |
326 | } | |
327 | ||
328 | /* | |
ffe60014 DG |
329 | * Send a destroy channel command to consumer using the given channel key. |
330 | * | |
331 | * Note that this command MUST be used prior to a successful | |
332 | * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully, | |
333 | * the streams are dispatched to the consumer threads and MUST be teardown | |
334 | * through the hang up process. | |
335 | * | |
336 | * Return 0 on success else a negative value. | |
37278a1e | 337 | */ |
ffe60014 DG |
338 | int ust_consumer_destroy_channel(struct consumer_socket *socket, |
339 | struct ust_app_channel *ua_chan) | |
37278a1e | 340 | { |
ffe60014 DG |
341 | int ret; |
342 | struct lttcomm_consumer_msg msg; | |
a4b92340 | 343 | |
ffe60014 DG |
344 | assert(ua_chan); |
345 | assert(socket); | |
37278a1e | 346 | |
53efb85a | 347 | memset(&msg, 0, sizeof(msg)); |
ffe60014 DG |
348 | msg.cmd_type = LTTNG_CONSUMER_DESTROY_CHANNEL; |
349 | msg.u.destroy_channel.key = ua_chan->key; | |
173af62f | 350 | |
ffe60014 DG |
351 | pthread_mutex_lock(socket->lock); |
352 | health_code_update(); | |
37278a1e | 353 | |
ffe60014 | 354 | ret = consumer_send_msg(socket, &msg); |
37278a1e DG |
355 | if (ret < 0) { |
356 | goto error; | |
48842b30 DG |
357 | } |
358 | ||
ffe60014 DG |
359 | error: |
360 | health_code_update(); | |
361 | pthread_mutex_unlock(socket->lock); | |
362 | return ret; | |
363 | } | |
aeb96892 | 364 | |
ffe60014 DG |
365 | /* |
366 | * Send a given stream to UST tracer. | |
367 | * | |
368 | * On success return 0 else a negative value. | |
369 | */ | |
370 | int ust_consumer_send_stream_to_ust(struct ust_app *app, | |
371 | struct ust_app_channel *channel, struct ust_app_stream *stream) | |
372 | { | |
373 | int ret; | |
374 | ||
375 | assert(app); | |
376 | assert(stream); | |
377 | assert(channel); | |
378 | ||
379 | DBG2("UST consumer send stream to app %d", app->sock); | |
380 | ||
381 | /* Relay stream to application. */ | |
382 | ret = ustctl_send_stream_to_ust(app->sock, channel->obj, stream->obj); | |
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 DG |
416 | /* Send stream to application. */ |
417 | ret = ustctl_send_channel_to_ust(app->sock, ua_sess->handle, channel->obj); | |
418 | if (ret < 0) { | |
419 | if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) { | |
420 | ERR("Error ustctl send channel %s to app pid: %d with ret %d", | |
421 | channel->name, app->pid, ret); | |
422 | } else { | |
423 | DBG3("UST app send channel to ust failed. Application is dead."); | |
424 | } | |
425 | goto error; | |
426 | } | |
48842b30 DG |
427 | |
428 | error: | |
429 | return ret; | |
430 | } | |
331744e3 JD |
431 | |
432 | /* | |
433 | * Handle the metadata requests from the UST consumer | |
434 | * | |
435 | * Return 0 on success else a negative value. | |
436 | */ | |
437 | int ust_consumer_metadata_request(struct consumer_socket *socket) | |
438 | { | |
439 | int ret; | |
440 | ssize_t ret_push; | |
441 | struct lttcomm_metadata_request_msg request; | |
442 | struct buffer_reg_uid *reg_uid; | |
443 | struct ust_registry_session *ust_reg; | |
444 | struct lttcomm_consumer_msg msg; | |
445 | ||
446 | assert(socket); | |
447 | ||
448 | rcu_read_lock(); | |
331744e3 JD |
449 | health_code_update(); |
450 | ||
451 | /* Wait for a metadata request */ | |
b2040829 | 452 | pthread_mutex_lock(socket->lock); |
52898cb1 | 453 | ret = consumer_socket_recv(socket, &request, sizeof(request)); |
b2040829 | 454 | pthread_mutex_unlock(socket->lock); |
52898cb1 | 455 | if (ret < 0) { |
331744e3 JD |
456 | goto end; |
457 | } | |
458 | ||
1950109e | 459 | DBG("Metadata request received for session %" PRIu64 ", key %" PRIu64, |
331744e3 JD |
460 | request.session_id, request.key); |
461 | ||
462 | reg_uid = buffer_reg_uid_find(request.session_id, | |
463 | request.bits_per_long, request.uid); | |
464 | if (reg_uid) { | |
465 | ust_reg = reg_uid->registry->reg.ust; | |
466 | } else { | |
467 | struct buffer_reg_pid *reg_pid = | |
1950109e | 468 | buffer_reg_pid_find(request.session_id_per_pid); |
331744e3 | 469 | if (!reg_pid) { |
1950109e JD |
470 | DBG("PID registry not found for session id %" PRIu64, |
471 | request.session_id_per_pid); | |
331744e3 | 472 | |
53efb85a | 473 | memset(&msg, 0, sizeof(msg)); |
331744e3 JD |
474 | msg.cmd_type = LTTNG_ERR_UND; |
475 | (void) consumer_send_msg(socket, &msg); | |
476 | /* | |
477 | * This is possible since the session might have been destroyed | |
478 | * during a consumer metadata request. So here, return gracefully | |
479 | * because the destroy session will push the remaining metadata to | |
480 | * the consumer. | |
481 | */ | |
482 | ret = 0; | |
483 | goto end; | |
484 | } | |
485 | ust_reg = reg_pid->registry->reg.ust; | |
486 | } | |
487 | assert(ust_reg); | |
488 | ||
b2040829 | 489 | pthread_mutex_lock(&ust_reg->lock); |
331744e3 | 490 | ret_push = ust_app_push_metadata(ust_reg, socket, 1); |
b2040829 | 491 | pthread_mutex_unlock(&ust_reg->lock); |
d81a925f MD |
492 | if (ret_push == -EPIPE) { |
493 | DBG("Application or relay closed while pushing metadata"); | |
494 | } else if (ret_push < 0) { | |
331744e3 JD |
495 | ERR("Pushing metadata"); |
496 | ret = -1; | |
497 | goto end; | |
d81a925f MD |
498 | } else { |
499 | DBG("UST Consumer metadata pushed successfully"); | |
331744e3 | 500 | } |
331744e3 JD |
501 | ret = 0; |
502 | ||
503 | end: | |
331744e3 JD |
504 | rcu_read_unlock(); |
505 | return ret; | |
506 | } |