Copy exclusion data in shadow_copy_event
[lttng-tools.git] / src / bin / lttng-sessiond / ust-consumer.c
CommitLineData
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
44static 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
DG
74 if (ret < 0) {
75 if (ret != -EEXIST) {
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 91error:
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
101static 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{
ffe60014 105 int ret;
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
ffe60014
DG
144 consumer_init_ask_channel_comm_msg(&msg,
145 ua_chan->attr.subbuf_size,
146 ua_chan->attr.num_subbuf,
147 ua_chan->attr.overwrite,
148 ua_chan->attr.switch_timer_interval,
149 ua_chan->attr.read_timer_interval,
ecc48a90 150 ua_sess->live_timer_interval,
ffe60014
DG
151 (int) ua_chan->attr.output,
152 (int) ua_chan->attr.type,
7972aab2 153 ua_sess->tracing_id,
ca22feea 154 pathname,
ffe60014 155 ua_chan->name,
7972aab2
DG
156 ua_sess->euid,
157 ua_sess->egid,
ffe60014
DG
158 consumer->net_seq_index,
159 ua_chan->key,
7972aab2 160 registry->uuid,
1624d5b7
JD
161 chan_id,
162 ua_chan->tracefile_size,
2bba9e53 163 ua_chan->tracefile_count,
1950109e 164 ua_sess->id,
567eb353
DG
165 ua_sess->output_traces,
166 ua_sess->uid);
37278a1e 167
840cb59c 168 health_code_update();
ca03de58 169
52898cb1 170 ret = consumer_socket_send(socket, &msg, sizeof(msg));
37278a1e
DG
171 if (ret < 0) {
172 goto error;
173 }
174
ffe60014
DG
175 ret = consumer_recv_status_channel(socket, &key,
176 &ua_chan->expected_stream_count);
177 if (ret < 0) {
178 goto error;
179 }
180 /* Communication protocol error. */
181 assert(key == ua_chan->key);
182 /* We need at least one where 1 stream for 1 cpu. */
10a50311
JD
183 if (ua_sess->output_traces) {
184 assert(ua_chan->expected_stream_count > 0);
185 }
ffe60014 186
d88aee68 187 DBG2("UST ask channel %" PRIu64 " successfully done with %u stream(s)", key,
ffe60014 188 ua_chan->expected_stream_count);
ca03de58 189
37278a1e 190error:
ffe60014
DG
191 free(pathname);
192 health_code_update();
37278a1e
DG
193 return ret;
194}
195
196/*
ffe60014
DG
197 * Ask consumer to create a channel for a given session.
198 *
199 * Returns 0 on success else a negative value.
37278a1e 200 */
ffe60014
DG
201int ust_consumer_ask_channel(struct ust_app_session *ua_sess,
202 struct ust_app_channel *ua_chan, struct consumer_output *consumer,
7972aab2 203 struct consumer_socket *socket, struct ust_registry_session *registry)
37278a1e
DG
204{
205 int ret;
37278a1e 206
ffe60014
DG
207 assert(ua_sess);
208 assert(ua_chan);
209 assert(consumer);
210 assert(socket);
7972aab2 211 assert(registry);
f50f23d9 212
d9078d0c
DG
213 if (!consumer->enabled) {
214 ret = -LTTNG_ERR_NO_CONSUMER;
215 DBG3("Consumer is disabled");
216 goto error;
217 }
218
ffe60014 219 pthread_mutex_lock(socket->lock);
37278a1e 220
7972aab2 221 ret = ask_channel_creation(ua_sess, ua_chan, consumer, socket, registry);
37278a1e
DG
222 if (ret < 0) {
223 goto error;
224 }
225
48842b30 226error:
ffe60014 227 pthread_mutex_unlock(socket->lock);
48842b30
DG
228 return ret;
229}
230
231/*
ffe60014
DG
232 * Send a get channel command to consumer using the given channel key. The
233 * channel object is populated and the stream list.
234 *
235 * Return 0 on success else a negative value.
48842b30 236 */
ffe60014
DG
237int ust_consumer_get_channel(struct consumer_socket *socket,
238 struct ust_app_channel *ua_chan)
48842b30 239{
ffe60014 240 int ret;
37278a1e 241 struct lttcomm_consumer_msg msg;
48842b30 242
ffe60014
DG
243 assert(ua_chan);
244 assert(socket);
48842b30 245
ffe60014
DG
246 msg.cmd_type = LTTNG_CONSUMER_GET_CHANNEL;
247 msg.u.get_channel.key = ua_chan->key;
37278a1e 248
ffe60014 249 pthread_mutex_lock(socket->lock);
840cb59c 250 health_code_update();
ca03de58 251
ffe60014
DG
252 /* Send command and wait for OK reply. */
253 ret = consumer_send_msg(socket, &msg);
37278a1e
DG
254 if (ret < 0) {
255 goto error;
256 }
257
ffe60014 258 /* First, get the channel from consumer. */
9363801e 259 ret = ustctl_recv_channel_from_consumer(*socket->fd_ptr, &ua_chan->obj);
37278a1e 260 if (ret < 0) {
ffe60014
DG
261 if (ret != -EPIPE) {
262 ERR("Error recv channel from consumer %d with ret %d",
9363801e 263 *socket->fd_ptr, ret);
ffe60014
DG
264 } else {
265 DBG3("UST app recv channel from consumer. Consumer is dead.");
266 }
37278a1e
DG
267 goto error;
268 }
00e2e675 269
ffe60014
DG
270 /* Next, get all streams. */
271 while (1) {
272 struct ust_app_stream *stream;
ca03de58 273
ffe60014
DG
274 /* Create UST stream */
275 stream = ust_app_alloc_stream();
276 if (stream == NULL) {
277 ret = -ENOMEM;
48842b30
DG
278 goto error;
279 }
280
ffe60014 281 /* Stream object is populated by this call if successful. */
9363801e 282 ret = ustctl_recv_stream_from_consumer(*socket->fd_ptr, &stream->obj);
37278a1e 283 if (ret < 0) {
ffe60014
DG
284 free(stream);
285 if (ret == -LTTNG_UST_ERR_NOENT) {
286 DBG3("UST app consumer has no more stream available");
287 ret = 0;
288 break;
289 }
290 if (ret != -EPIPE) {
291 ERR("Recv stream from consumer %d with ret %d",
9363801e 292 *socket->fd_ptr, ret);
ffe60014
DG
293 } else {
294 DBG3("UST app recv stream from consumer. Consumer is dead.");
00e2e675 295 }
48842b30
DG
296 goto error;
297 }
37278a1e 298
ffe60014
DG
299 /* Order is important this is why a list is used. */
300 cds_list_add_tail(&stream->list, &ua_chan->streams.head);
301 ua_chan->streams.count++;
37278a1e 302
ffe60014
DG
303 DBG2("UST app stream %d received succesfully", ua_chan->streams.count);
304 }
305
306 /* This MUST match or else we have a synchronization problem. */
307 assert(ua_chan->expected_stream_count == ua_chan->streams.count);
ca03de58 308
ffe60014
DG
309 /* Wait for confirmation that we can proceed with the streams. */
310 ret = consumer_recv_status_reply(socket);
37278a1e
DG
311 if (ret < 0) {
312 goto error;
313 }
314
315error:
ffe60014
DG
316 health_code_update();
317 pthread_mutex_unlock(socket->lock);
37278a1e
DG
318 return ret;
319}
320
321/*
ffe60014
DG
322 * Send a destroy channel command to consumer using the given channel key.
323 *
324 * Note that this command MUST be used prior to a successful
325 * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully,
326 * the streams are dispatched to the consumer threads and MUST be teardown
327 * through the hang up process.
328 *
329 * Return 0 on success else a negative value.
37278a1e 330 */
ffe60014
DG
331int ust_consumer_destroy_channel(struct consumer_socket *socket,
332 struct ust_app_channel *ua_chan)
37278a1e 333{
ffe60014
DG
334 int ret;
335 struct lttcomm_consumer_msg msg;
a4b92340 336
ffe60014
DG
337 assert(ua_chan);
338 assert(socket);
37278a1e 339
ffe60014
DG
340 msg.cmd_type = LTTNG_CONSUMER_DESTROY_CHANNEL;
341 msg.u.destroy_channel.key = ua_chan->key;
173af62f 342
ffe60014
DG
343 pthread_mutex_lock(socket->lock);
344 health_code_update();
37278a1e 345
ffe60014 346 ret = consumer_send_msg(socket, &msg);
37278a1e
DG
347 if (ret < 0) {
348 goto error;
48842b30
DG
349 }
350
ffe60014
DG
351error:
352 health_code_update();
353 pthread_mutex_unlock(socket->lock);
354 return ret;
355}
aeb96892 356
ffe60014
DG
357/*
358 * Send a given stream to UST tracer.
359 *
360 * On success return 0 else a negative value.
361 */
362int ust_consumer_send_stream_to_ust(struct ust_app *app,
363 struct ust_app_channel *channel, struct ust_app_stream *stream)
364{
365 int ret;
366
367 assert(app);
368 assert(stream);
369 assert(channel);
370
371 DBG2("UST consumer send stream to app %d", app->sock);
372
373 /* Relay stream to application. */
374 ret = ustctl_send_stream_to_ust(app->sock, channel->obj, stream->obj);
375 if (ret < 0) {
376 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
377 ERR("Error ustctl send stream %s to app pid: %d with ret %d",
378 stream->name, app->pid, ret);
379 } else {
380 DBG3("UST app send stream to ust failed. Application is dead.");
48842b30 381 }
ffe60014 382 goto error;
48842b30 383 }
d0b96690 384 channel->handle = channel->obj->handle;
48842b30 385
ffe60014
DG
386error:
387 return ret;
388}
389
390/*
391 * Send channel previously received from the consumer to the UST tracer.
392 *
393 * On success return 0 else a negative value.
394 */
395int ust_consumer_send_channel_to_ust(struct ust_app *app,
396 struct ust_app_session *ua_sess, struct ust_app_channel *channel)
397{
398 int ret;
399
400 assert(app);
401 assert(ua_sess);
402 assert(channel);
403 assert(channel->obj);
404
7972aab2
DG
405 DBG2("UST app send channel to sock %d pid %d (name: %s, key: %" PRIu64 ")",
406 app->sock, app->pid, channel->name, channel->tracing_channel_id);
48842b30 407
ffe60014
DG
408 /* Send stream to application. */
409 ret = ustctl_send_channel_to_ust(app->sock, ua_sess->handle, channel->obj);
410 if (ret < 0) {
411 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
412 ERR("Error ustctl send channel %s to app pid: %d with ret %d",
413 channel->name, app->pid, ret);
414 } else {
415 DBG3("UST app send channel to ust failed. Application is dead.");
416 }
417 goto error;
418 }
48842b30
DG
419
420error:
421 return ret;
422}
331744e3
JD
423
424/*
425 * Handle the metadata requests from the UST consumer
426 *
427 * Return 0 on success else a negative value.
428 */
429int ust_consumer_metadata_request(struct consumer_socket *socket)
430{
431 int ret;
432 ssize_t ret_push;
433 struct lttcomm_metadata_request_msg request;
434 struct buffer_reg_uid *reg_uid;
435 struct ust_registry_session *ust_reg;
436 struct lttcomm_consumer_msg msg;
437
438 assert(socket);
439
440 rcu_read_lock();
441 pthread_mutex_lock(socket->lock);
442
443 health_code_update();
444
445 /* Wait for a metadata request */
52898cb1
DG
446 ret = consumer_socket_recv(socket, &request, sizeof(request));
447 if (ret < 0) {
331744e3
JD
448 goto end;
449 }
450
1950109e 451 DBG("Metadata request received for session %" PRIu64 ", key %" PRIu64,
331744e3
JD
452 request.session_id, request.key);
453
454 reg_uid = buffer_reg_uid_find(request.session_id,
455 request.bits_per_long, request.uid);
456 if (reg_uid) {
457 ust_reg = reg_uid->registry->reg.ust;
458 } else {
459 struct buffer_reg_pid *reg_pid =
1950109e 460 buffer_reg_pid_find(request.session_id_per_pid);
331744e3 461 if (!reg_pid) {
1950109e
JD
462 DBG("PID registry not found for session id %" PRIu64,
463 request.session_id_per_pid);
331744e3
JD
464
465 msg.cmd_type = LTTNG_ERR_UND;
466 (void) consumer_send_msg(socket, &msg);
467 /*
468 * This is possible since the session might have been destroyed
469 * during a consumer metadata request. So here, return gracefully
470 * because the destroy session will push the remaining metadata to
471 * the consumer.
472 */
473 ret = 0;
474 goto end;
475 }
476 ust_reg = reg_pid->registry->reg.ust;
477 }
478 assert(ust_reg);
479
480 ret_push = ust_app_push_metadata(ust_reg, socket, 1);
481 if (ret_push < 0) {
482 ERR("Pushing metadata");
483 ret = -1;
484 goto end;
485 }
486 DBG("UST Consumer metadata pushed successfully");
487 ret = 0;
488
489end:
490 pthread_mutex_unlock(socket->lock);
491 rcu_read_unlock();
492 return ret;
493}
This page took 0.063785 seconds and 4 git commands to generate.