2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
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.
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.
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.
26 #include <common/common.h>
27 #include <common/consumer/consumer.h>
28 #include <common/defaults.h>
31 #include "health-sessiond.h"
32 #include "ust-consumer.h"
33 #include "buffer-registry.h"
35 #include "lttng-sessiond.h"
38 * Return allocated full pathname of the session using the consumer trace path
39 * and subdir if available. On a successful allocation, the directory of the
40 * trace is created with the session credentials.
42 * The caller can safely free(3) the returned value. On error, NULL is
45 static char *setup_trace_path(struct consumer_output
*consumer
,
46 struct ust_app_session
*ua_sess
)
57 * Allocate the string ourself to make sure we never exceed
60 pathname
= zmalloc(LTTNG_PATH_MAX
);
65 /* Get correct path name destination */
66 if (consumer
->type
== CONSUMER_DST_LOCAL
) {
67 /* Set application path to the destination path */
68 ret
= snprintf(pathname
, LTTNG_PATH_MAX
, "%s%s%s%s",
69 consumer
->dst
.session_root_path
,
71 consumer
->subdir
, ua_sess
->path
);
73 PERROR("snprintf channel path");
77 /* Create directory. Ignore if exist. */
78 ret
= run_as_mkdir_recursive(pathname
, S_IRWXU
| S_IRWXG
,
79 ua_sess
->euid
, ua_sess
->egid
);
81 if (errno
!= EEXIST
) {
82 ERR("Trace directory creation error");
87 ret
= snprintf(pathname
, LTTNG_PATH_MAX
, "%s%s%s%s",
88 consumer
->dst
.net
.base_dir
,
93 PERROR("snprintf channel path");
106 * Send a single channel to the consumer using command ASK_CHANNEL_CREATION.
108 * Consumer socket lock MUST be acquired before calling this.
110 static int ask_channel_creation(struct ust_app_session
*ua_sess
,
111 struct ust_app_channel
*ua_chan
, struct consumer_output
*consumer
,
112 struct consumer_socket
*socket
, struct ust_registry_session
*registry
)
116 uint64_t key
, chan_reg_key
;
117 char *pathname
= NULL
;
118 struct lttcomm_consumer_msg msg
;
119 struct ust_registry_channel
*chan_reg
;
120 char shm_path
[PATH_MAX
] = "";
121 char root_shm_path
[PATH_MAX
] = "";
129 DBG2("Asking UST consumer for channel");
131 /* Get and create full trace path of session. */
132 if (ua_sess
->output_traces
) {
133 pathname
= setup_trace_path(consumer
, ua_sess
);
140 /* Depending on the buffer type, a different channel key is used. */
141 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
142 chan_reg_key
= ua_chan
->tracing_channel_id
;
144 chan_reg_key
= ua_chan
->key
;
147 if (ua_chan
->attr
.type
== LTTNG_UST_CHAN_METADATA
) {
150 * Metadata channels shm_path (buffers) are handled within
151 * session daemon. Consumer daemon should not try to create
152 * those buffer files.
155 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
157 chan_id
= chan_reg
->chan_id
;
158 if (ua_sess
->shm_path
[0]) {
159 strncpy(shm_path
, ua_sess
->shm_path
, sizeof(shm_path
));
160 shm_path
[sizeof(shm_path
) - 1] = '\0';
161 strncat(shm_path
, "/",
162 sizeof(shm_path
) - strlen(shm_path
) - 1);
163 strncat(shm_path
, ua_chan
->name
,
164 sizeof(shm_path
) - strlen(shm_path
) - 1);
165 strncat(shm_path
, "_",
166 sizeof(shm_path
) - strlen(shm_path
) - 1);
168 strncpy(root_shm_path
, ua_sess
->root_shm_path
, sizeof(root_shm_path
));
169 root_shm_path
[sizeof(root_shm_path
) - 1] = '\0';
172 switch (ua_chan
->attr
.output
) {
175 output
= LTTNG_EVENT_MMAP
;
179 consumer_init_ask_channel_comm_msg(&msg
,
180 ua_chan
->attr
.subbuf_size
,
181 ua_chan
->attr
.num_subbuf
,
182 ua_chan
->attr
.overwrite
,
183 ua_chan
->attr
.switch_timer_interval
,
184 ua_chan
->attr
.read_timer_interval
,
185 ua_sess
->live_timer_interval
,
186 ua_chan
->monitor_timer_interval
,
188 (int) ua_chan
->attr
.type
,
194 consumer
->net_seq_index
,
198 ua_chan
->tracefile_size
,
199 ua_chan
->tracefile_count
,
201 ua_sess
->output_traces
,
203 ua_chan
->attr
.blocking_timeout
,
204 root_shm_path
, shm_path
);
206 health_code_update();
208 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
213 ret
= consumer_recv_status_channel(socket
, &key
,
214 &ua_chan
->expected_stream_count
);
218 /* Communication protocol error. */
219 assert(key
== ua_chan
->key
);
220 /* We need at least one where 1 stream for 1 cpu. */
221 if (ua_sess
->output_traces
) {
222 assert(ua_chan
->expected_stream_count
> 0);
225 DBG2("UST ask channel %" PRIu64
" successfully done with %u stream(s)", key
,
226 ua_chan
->expected_stream_count
);
230 health_code_update();
235 * Ask consumer to create a channel for a given session.
237 * Session list and rcu read side locks must be held by the caller.
239 * Returns 0 on success else a negative value.
241 int ust_consumer_ask_channel(struct ust_app_session
*ua_sess
,
242 struct ust_app_channel
*ua_chan
, struct consumer_output
*consumer
,
243 struct consumer_socket
*socket
, struct ust_registry_session
*registry
)
246 struct ltt_session
*session
;
254 if (!consumer
->enabled
) {
255 ret
= -LTTNG_ERR_NO_CONSUMER
;
256 DBG3("Consumer is disabled");
260 session
= session_find_by_id(ua_sess
->tracing_id
);
263 pthread_mutex_lock(socket
->lock
);
264 ret
= ask_channel_creation(ua_sess
, ua_chan
, consumer
, socket
, registry
);
265 pthread_mutex_unlock(socket
->lock
);
267 ERR("ask_channel_creation consumer command failed");
276 * Send a get channel command to consumer using the given channel key. The
277 * channel object is populated and the stream list.
279 * Return 0 on success else a negative value.
281 int ust_consumer_get_channel(struct consumer_socket
*socket
,
282 struct ust_app_channel
*ua_chan
)
285 struct lttcomm_consumer_msg msg
;
290 memset(&msg
, 0, sizeof(msg
));
291 msg
.cmd_type
= LTTNG_CONSUMER_GET_CHANNEL
;
292 msg
.u
.get_channel
.key
= ua_chan
->key
;
294 pthread_mutex_lock(socket
->lock
);
295 health_code_update();
297 /* Send command and wait for OK reply. */
298 ret
= consumer_send_msg(socket
, &msg
);
303 /* First, get the channel from consumer. */
304 ret
= ustctl_recv_channel_from_consumer(*socket
->fd_ptr
, &ua_chan
->obj
);
307 ERR("Error recv channel from consumer %d with ret %d",
308 *socket
->fd_ptr
, ret
);
310 DBG3("UST app recv channel from consumer. Consumer is dead.");
315 /* Next, get all streams. */
317 struct ust_app_stream
*stream
;
319 /* Create UST stream */
320 stream
= ust_app_alloc_stream();
321 if (stream
== NULL
) {
326 /* Stream object is populated by this call if successful. */
327 ret
= ustctl_recv_stream_from_consumer(*socket
->fd_ptr
, &stream
->obj
);
330 if (ret
== -LTTNG_UST_ERR_NOENT
) {
331 DBG3("UST app consumer has no more stream available");
335 ERR("Recv stream from consumer %d with ret %d",
336 *socket
->fd_ptr
, ret
);
338 DBG3("UST app recv stream from consumer. Consumer is dead.");
343 /* Order is important this is why a list is used. */
344 cds_list_add_tail(&stream
->list
, &ua_chan
->streams
.head
);
345 ua_chan
->streams
.count
++;
347 DBG2("UST app stream %d received successfully", ua_chan
->streams
.count
);
350 /* This MUST match or else we have a synchronization problem. */
351 assert(ua_chan
->expected_stream_count
== ua_chan
->streams
.count
);
353 /* Wait for confirmation that we can proceed with the streams. */
354 ret
= consumer_recv_status_reply(socket
);
360 health_code_update();
361 pthread_mutex_unlock(socket
->lock
);
366 * Send a destroy channel command to consumer using the given channel key.
368 * Note that this command MUST be used prior to a successful
369 * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully,
370 * the streams are dispatched to the consumer threads and MUST be teardown
371 * through the hang up process.
373 * Return 0 on success else a negative value.
375 int ust_consumer_destroy_channel(struct consumer_socket
*socket
,
376 struct ust_app_channel
*ua_chan
)
379 struct lttcomm_consumer_msg msg
;
384 memset(&msg
, 0, sizeof(msg
));
385 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_CHANNEL
;
386 msg
.u
.destroy_channel
.key
= ua_chan
->key
;
388 pthread_mutex_lock(socket
->lock
);
389 health_code_update();
391 ret
= consumer_send_msg(socket
, &msg
);
397 health_code_update();
398 pthread_mutex_unlock(socket
->lock
);
403 * Send a given stream to UST tracer.
405 * On success return 0 else a negative value.
407 int ust_consumer_send_stream_to_ust(struct ust_app
*app
,
408 struct ust_app_channel
*channel
, struct ust_app_stream
*stream
)
416 DBG2("UST consumer send stream to app %d", app
->sock
);
418 /* Relay stream to application. */
419 pthread_mutex_lock(&app
->sock_lock
);
420 ret
= ustctl_send_stream_to_ust(app
->sock
, channel
->obj
, stream
->obj
);
421 pthread_mutex_unlock(&app
->sock_lock
);
423 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
424 ERR("ustctl send stream handle %d to app pid: %d with ret %d",
425 stream
->obj
->handle
, app
->pid
, ret
);
427 DBG3("UST app send stream to ust failed. Application is dead.");
431 channel
->handle
= channel
->obj
->handle
;
438 * Send channel previously received from the consumer to the UST tracer.
440 * On success return 0 else a negative value.
442 int ust_consumer_send_channel_to_ust(struct ust_app
*app
,
443 struct ust_app_session
*ua_sess
, struct ust_app_channel
*channel
)
450 assert(channel
->obj
);
452 DBG2("UST app send channel to sock %d pid %d (name: %s, key: %" PRIu64
")",
453 app
->sock
, app
->pid
, channel
->name
, channel
->tracing_channel_id
);
455 /* Send stream to application. */
456 pthread_mutex_lock(&app
->sock_lock
);
457 ret
= ustctl_send_channel_to_ust(app
->sock
, ua_sess
->handle
, channel
->obj
);
458 pthread_mutex_unlock(&app
->sock_lock
);
460 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
461 ERR("Error ustctl send channel %s to app pid: %d with ret %d",
462 channel
->name
, app
->pid
, ret
);
464 DBG3("UST app send channel to ust failed. Application is dead.");
474 * Handle the metadata requests from the UST consumer
476 * Return 0 on success else a negative value.
478 int ust_consumer_metadata_request(struct consumer_socket
*socket
)
482 struct lttcomm_metadata_request_msg request
;
483 struct buffer_reg_uid
*reg_uid
;
484 struct ust_registry_session
*ust_reg
;
485 struct lttcomm_consumer_msg msg
;
490 health_code_update();
492 /* Wait for a metadata request */
493 pthread_mutex_lock(socket
->lock
);
494 ret
= consumer_socket_recv(socket
, &request
, sizeof(request
));
495 pthread_mutex_unlock(socket
->lock
);
500 DBG("Metadata request received for session %" PRIu64
", key %" PRIu64
,
501 request
.session_id
, request
.key
);
503 reg_uid
= buffer_reg_uid_find(request
.session_id
,
504 request
.bits_per_long
, request
.uid
);
506 ust_reg
= reg_uid
->registry
->reg
.ust
;
508 struct buffer_reg_pid
*reg_pid
=
509 buffer_reg_pid_find(request
.session_id_per_pid
);
511 DBG("PID registry not found for session id %" PRIu64
,
512 request
.session_id_per_pid
);
514 memset(&msg
, 0, sizeof(msg
));
515 msg
.cmd_type
= LTTNG_ERR_UND
;
516 (void) consumer_send_msg(socket
, &msg
);
518 * This is possible since the session might have been destroyed
519 * during a consumer metadata request. So here, return gracefully
520 * because the destroy session will push the remaining metadata to
526 ust_reg
= reg_pid
->registry
->reg
.ust
;
530 pthread_mutex_lock(&ust_reg
->lock
);
531 ret_push
= ust_app_push_metadata(ust_reg
, socket
, 1);
532 pthread_mutex_unlock(&ust_reg
->lock
);
533 if (ret_push
== -EPIPE
) {
534 DBG("Application or relay closed while pushing metadata");
535 } else if (ret_push
< 0) {
536 ERR("Pushing metadata");
540 DBG("UST Consumer metadata pushed successfully");