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"
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.
41 * The caller can safely free(3) the returned value. On error, NULL is
44 static char *setup_trace_path(struct consumer_output
*consumer
,
45 struct ust_app_session
*ua_sess
)
55 /* Allocate our self the string to make sure we never exceed PATH_MAX. */
56 pathname
= zmalloc(PATH_MAX
);
61 /* Get correct path name destination */
62 if (consumer
->type
== CONSUMER_DST_LOCAL
) {
63 /* Set application path to the destination path */
64 ret
= snprintf(pathname
, PATH_MAX
, "%s%s%s",
65 consumer
->dst
.trace_path
, consumer
->subdir
, ua_sess
->path
);
67 PERROR("snprintf channel path");
71 /* Create directory. Ignore if exist. */
72 ret
= run_as_mkdir_recursive(pathname
, S_IRWXU
| S_IRWXG
,
73 ua_sess
->euid
, ua_sess
->egid
);
75 if (errno
!= EEXIST
) {
76 ERR("Trace directory creation error");
81 ret
= snprintf(pathname
, PATH_MAX
, "%s%s", consumer
->subdir
,
84 PERROR("snprintf channel path");
97 * Send a single channel to the consumer using command ADD_CHANNEL.
99 * Consumer socket lock MUST be acquired before calling this.
101 static int ask_channel_creation(struct ust_app_session
*ua_sess
,
102 struct ust_app_channel
*ua_chan
, struct consumer_output
*consumer
,
103 struct consumer_socket
*socket
, struct ust_registry_session
*registry
)
107 uint64_t key
, chan_reg_key
;
108 char *pathname
= NULL
;
109 struct lttcomm_consumer_msg msg
;
110 struct ust_registry_channel
*chan_reg
;
111 char shm_path
[PATH_MAX
] = "";
112 char root_shm_path
[PATH_MAX
] = "";
120 DBG2("Asking UST consumer for channel");
122 /* Get and create full trace path of session. */
123 if (ua_sess
->output_traces
) {
124 pathname
= setup_trace_path(consumer
, ua_sess
);
131 /* Depending on the buffer type, a different channel key is used. */
132 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
133 chan_reg_key
= ua_chan
->tracing_channel_id
;
135 chan_reg_key
= ua_chan
->key
;
138 if (ua_chan
->attr
.type
== LTTNG_UST_CHAN_METADATA
) {
141 * Metadata channels shm_path (buffers) are handled within
142 * session daemon. Consumer daemon should not try to create
143 * those buffer files.
146 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
148 chan_id
= chan_reg
->chan_id
;
149 if (ua_sess
->shm_path
[0]) {
150 strncpy(shm_path
, ua_sess
->shm_path
, sizeof(shm_path
));
151 shm_path
[sizeof(shm_path
) - 1] = '\0';
152 strncat(shm_path
, "/",
153 sizeof(shm_path
) - strlen(shm_path
) - 1);
154 strncat(shm_path
, ua_chan
->name
,
155 sizeof(shm_path
) - strlen(shm_path
) - 1);
156 strncat(shm_path
, "_",
157 sizeof(shm_path
) - strlen(shm_path
) - 1);
159 strncpy(root_shm_path
, ua_sess
->root_shm_path
, sizeof(root_shm_path
));
160 root_shm_path
[sizeof(root_shm_path
) - 1] = '\0';
163 switch (ua_chan
->attr
.output
) {
166 output
= LTTNG_EVENT_MMAP
;
170 consumer_init_ask_channel_comm_msg(&msg
,
171 ua_chan
->attr
.subbuf_size
,
172 ua_chan
->attr
.num_subbuf
,
173 ua_chan
->attr
.overwrite
,
174 ua_chan
->attr
.switch_timer_interval
,
175 ua_chan
->attr
.read_timer_interval
,
176 ua_sess
->live_timer_interval
,
178 (int) ua_chan
->attr
.type
,
184 consumer
->net_seq_index
,
188 ua_chan
->tracefile_size
,
189 ua_chan
->tracefile_count
,
191 ua_sess
->output_traces
,
193 root_shm_path
, shm_path
);
195 health_code_update();
197 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
202 ret
= consumer_recv_status_channel(socket
, &key
,
203 &ua_chan
->expected_stream_count
);
207 /* Communication protocol error. */
208 assert(key
== ua_chan
->key
);
209 /* We need at least one where 1 stream for 1 cpu. */
210 if (ua_sess
->output_traces
) {
211 assert(ua_chan
->expected_stream_count
> 0);
214 DBG2("UST ask channel %" PRIu64
" successfully done with %u stream(s)", key
,
215 ua_chan
->expected_stream_count
);
219 health_code_update();
224 * Ask consumer to create a channel for a given session.
226 * Returns 0 on success else a negative value.
228 int ust_consumer_ask_channel(struct ust_app_session
*ua_sess
,
229 struct ust_app_channel
*ua_chan
, struct consumer_output
*consumer
,
230 struct consumer_socket
*socket
, struct ust_registry_session
*registry
)
240 if (!consumer
->enabled
) {
241 ret
= -LTTNG_ERR_NO_CONSUMER
;
242 DBG3("Consumer is disabled");
246 pthread_mutex_lock(socket
->lock
);
247 ret
= ask_channel_creation(ua_sess
, ua_chan
, consumer
, socket
, registry
);
248 pthread_mutex_unlock(socket
->lock
);
258 * Send a get channel command to consumer using the given channel key. The
259 * channel object is populated and the stream list.
261 * Return 0 on success else a negative value.
263 int ust_consumer_get_channel(struct consumer_socket
*socket
,
264 struct ust_app_channel
*ua_chan
)
267 struct lttcomm_consumer_msg msg
;
272 memset(&msg
, 0, sizeof(msg
));
273 msg
.cmd_type
= LTTNG_CONSUMER_GET_CHANNEL
;
274 msg
.u
.get_channel
.key
= ua_chan
->key
;
276 pthread_mutex_lock(socket
->lock
);
277 health_code_update();
279 /* Send command and wait for OK reply. */
280 ret
= consumer_send_msg(socket
, &msg
);
285 /* First, get the channel from consumer. */
286 ret
= ustctl_recv_channel_from_consumer(*socket
->fd_ptr
, &ua_chan
->obj
);
289 ERR("Error recv channel from consumer %d with ret %d",
290 *socket
->fd_ptr
, ret
);
292 DBG3("UST app recv channel from consumer. Consumer is dead.");
297 /* Next, get all streams. */
299 struct ust_app_stream
*stream
;
301 /* Create UST stream */
302 stream
= ust_app_alloc_stream();
303 if (stream
== NULL
) {
308 /* Stream object is populated by this call if successful. */
309 ret
= ustctl_recv_stream_from_consumer(*socket
->fd_ptr
, &stream
->obj
);
312 if (ret
== -LTTNG_UST_ERR_NOENT
) {
313 DBG3("UST app consumer has no more stream available");
318 ERR("Recv stream from consumer %d with ret %d",
319 *socket
->fd_ptr
, ret
);
321 DBG3("UST app recv stream from consumer. Consumer is dead.");
326 /* Order is important this is why a list is used. */
327 cds_list_add_tail(&stream
->list
, &ua_chan
->streams
.head
);
328 ua_chan
->streams
.count
++;
330 DBG2("UST app stream %d received successfully", ua_chan
->streams
.count
);
333 /* This MUST match or else we have a synchronization problem. */
334 assert(ua_chan
->expected_stream_count
== ua_chan
->streams
.count
);
336 /* Wait for confirmation that we can proceed with the streams. */
337 ret
= consumer_recv_status_reply(socket
);
343 health_code_update();
344 pthread_mutex_unlock(socket
->lock
);
349 * Send a destroy channel command to consumer using the given channel key.
351 * Note that this command MUST be used prior to a successful
352 * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully,
353 * the streams are dispatched to the consumer threads and MUST be teardown
354 * through the hang up process.
356 * Return 0 on success else a negative value.
358 int ust_consumer_destroy_channel(struct consumer_socket
*socket
,
359 struct ust_app_channel
*ua_chan
)
362 struct lttcomm_consumer_msg msg
;
367 memset(&msg
, 0, sizeof(msg
));
368 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_CHANNEL
;
369 msg
.u
.destroy_channel
.key
= ua_chan
->key
;
371 pthread_mutex_lock(socket
->lock
);
372 health_code_update();
374 ret
= consumer_send_msg(socket
, &msg
);
380 health_code_update();
381 pthread_mutex_unlock(socket
->lock
);
386 * Send a given stream to UST tracer.
388 * On success return 0 else a negative value.
390 int ust_consumer_send_stream_to_ust(struct ust_app
*app
,
391 struct ust_app_channel
*channel
, struct ust_app_stream
*stream
)
399 DBG2("UST consumer send stream to app %d", app
->sock
);
401 /* Relay stream to application. */
402 pthread_mutex_lock(&app
->sock_lock
);
403 ret
= ustctl_send_stream_to_ust(app
->sock
, channel
->obj
, stream
->obj
);
404 pthread_mutex_unlock(&app
->sock_lock
);
406 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
407 ERR("ustctl send stream handle %d to app pid: %d with ret %d",
408 stream
->obj
->handle
, app
->pid
, ret
);
410 DBG3("UST app send stream to ust failed. Application is dead.");
414 channel
->handle
= channel
->obj
->handle
;
421 * Send channel previously received from the consumer to the UST tracer.
423 * On success return 0 else a negative value.
425 int ust_consumer_send_channel_to_ust(struct ust_app
*app
,
426 struct ust_app_session
*ua_sess
, struct ust_app_channel
*channel
)
433 assert(channel
->obj
);
435 DBG2("UST app send channel to sock %d pid %d (name: %s, key: %" PRIu64
")",
436 app
->sock
, app
->pid
, channel
->name
, channel
->tracing_channel_id
);
438 /* Send stream to application. */
439 pthread_mutex_lock(&app
->sock_lock
);
440 ret
= ustctl_send_channel_to_ust(app
->sock
, ua_sess
->handle
, channel
->obj
);
441 pthread_mutex_unlock(&app
->sock_lock
);
443 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
444 ERR("Error ustctl send channel %s to app pid: %d with ret %d",
445 channel
->name
, app
->pid
, ret
);
447 DBG3("UST app send channel to ust failed. Application is dead.");
457 * Handle the metadata requests from the UST consumer
459 * Return 0 on success else a negative value.
461 int ust_consumer_metadata_request(struct consumer_socket
*socket
)
465 struct lttcomm_metadata_request_msg request
;
466 struct buffer_reg_uid
*reg_uid
;
467 struct ust_registry_session
*ust_reg
;
468 struct lttcomm_consumer_msg msg
;
473 health_code_update();
475 /* Wait for a metadata request */
476 pthread_mutex_lock(socket
->lock
);
477 ret
= consumer_socket_recv(socket
, &request
, sizeof(request
));
478 pthread_mutex_unlock(socket
->lock
);
483 DBG("Metadata request received for session %" PRIu64
", key %" PRIu64
,
484 request
.session_id
, request
.key
);
486 reg_uid
= buffer_reg_uid_find(request
.session_id
,
487 request
.bits_per_long
, request
.uid
);
489 ust_reg
= reg_uid
->registry
->reg
.ust
;
491 struct buffer_reg_pid
*reg_pid
=
492 buffer_reg_pid_find(request
.session_id_per_pid
);
494 DBG("PID registry not found for session id %" PRIu64
,
495 request
.session_id_per_pid
);
497 memset(&msg
, 0, sizeof(msg
));
498 msg
.cmd_type
= LTTNG_ERR_UND
;
499 (void) consumer_send_msg(socket
, &msg
);
501 * This is possible since the session might have been destroyed
502 * during a consumer metadata request. So here, return gracefully
503 * because the destroy session will push the remaining metadata to
509 ust_reg
= reg_pid
->registry
->reg
.ust
;
513 pthread_mutex_lock(&ust_reg
->lock
);
514 ret_push
= ust_app_push_metadata(ust_reg
, socket
, 1);
515 pthread_mutex_unlock(&ust_reg
->lock
);
516 if (ret_push
== -EPIPE
) {
517 DBG("Application or relay closed while pushing metadata");
518 } else if (ret_push
< 0) {
519 ERR("Pushing metadata");
523 DBG("UST Consumer metadata pushed successfully");