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.h>
28 #include <common/defaults.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
);
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
;
118 DBG2("Asking UST consumer for channel");
120 /* Get and create full trace path of session. */
121 if (ua_sess
->output_traces
) {
122 pathname
= setup_trace_path(consumer
, ua_sess
);
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
;
133 chan_reg_key
= ua_chan
->key
;
136 if (ua_chan
->attr
.type
== LTTNG_UST_CHAN_METADATA
) {
139 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
141 chan_id
= chan_reg
->chan_id
;
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
,
150 (int) ua_chan
->attr
.output
,
151 (int) ua_chan
->attr
.type
,
157 consumer
->net_seq_index
,
161 ua_chan
->tracefile_size
,
162 ua_chan
->tracefile_count
,
164 ua_sess
->output_traces
,
167 health_code_update();
169 ret
= lttcomm_send_unix_sock(socket
->fd
, &msg
, sizeof(msg
));
174 ret
= consumer_recv_status_channel(socket
, &key
,
175 &ua_chan
->expected_stream_count
);
179 /* Communication protocol error. */
180 assert(key
== ua_chan
->key
);
181 /* We need at least one where 1 stream for 1 cpu. */
182 if (ua_sess
->output_traces
) {
183 assert(ua_chan
->expected_stream_count
> 0);
186 DBG2("UST ask channel %" PRIu64
" successfully done with %u stream(s)", key
,
187 ua_chan
->expected_stream_count
);
191 health_code_update();
196 * Ask consumer to create a channel for a given session.
198 * Returns 0 on success else a negative value.
200 int ust_consumer_ask_channel(struct ust_app_session
*ua_sess
,
201 struct ust_app_channel
*ua_chan
, struct consumer_output
*consumer
,
202 struct consumer_socket
*socket
, struct ust_registry_session
*registry
)
210 assert(socket
->fd
>= 0);
213 if (!consumer
->enabled
) {
214 ret
= -LTTNG_ERR_NO_CONSUMER
;
215 DBG3("Consumer is disabled");
219 pthread_mutex_lock(socket
->lock
);
221 ret
= ask_channel_creation(ua_sess
, ua_chan
, consumer
, socket
, registry
);
227 pthread_mutex_unlock(socket
->lock
);
232 * Send a get channel command to consumer using the given channel key. The
233 * channel object is populated and the stream list.
235 * Return 0 on success else a negative value.
237 int ust_consumer_get_channel(struct consumer_socket
*socket
,
238 struct ust_app_channel
*ua_chan
)
241 struct lttcomm_consumer_msg msg
;
245 assert(socket
->fd
>= 0);
247 msg
.cmd_type
= LTTNG_CONSUMER_GET_CHANNEL
;
248 msg
.u
.get_channel
.key
= ua_chan
->key
;
250 pthread_mutex_lock(socket
->lock
);
251 health_code_update();
253 /* Send command and wait for OK reply. */
254 ret
= consumer_send_msg(socket
, &msg
);
259 /* First, get the channel from consumer. */
260 ret
= ustctl_recv_channel_from_consumer(socket
->fd
, &ua_chan
->obj
);
263 ERR("Error recv channel from consumer %d with ret %d",
266 DBG3("UST app recv channel from consumer. Consumer is dead.");
271 /* Next, get all streams. */
273 struct ust_app_stream
*stream
;
275 /* Create UST stream */
276 stream
= ust_app_alloc_stream();
277 if (stream
== NULL
) {
282 /* Stream object is populated by this call if successful. */
283 ret
= ustctl_recv_stream_from_consumer(socket
->fd
, &stream
->obj
);
286 if (ret
== -LTTNG_UST_ERR_NOENT
) {
287 DBG3("UST app consumer has no more stream available");
292 ERR("Recv stream from consumer %d with ret %d",
295 DBG3("UST app recv stream from consumer. Consumer is dead.");
300 /* Order is important this is why a list is used. */
301 cds_list_add_tail(&stream
->list
, &ua_chan
->streams
.head
);
302 ua_chan
->streams
.count
++;
304 DBG2("UST app stream %d received succesfully", ua_chan
->streams
.count
);
307 /* This MUST match or else we have a synchronization problem. */
308 assert(ua_chan
->expected_stream_count
== ua_chan
->streams
.count
);
310 /* Wait for confirmation that we can proceed with the streams. */
311 ret
= consumer_recv_status_reply(socket
);
317 health_code_update();
318 pthread_mutex_unlock(socket
->lock
);
323 * Send a destroy channel command to consumer using the given channel key.
325 * Note that this command MUST be used prior to a successful
326 * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully,
327 * the streams are dispatched to the consumer threads and MUST be teardown
328 * through the hang up process.
330 * Return 0 on success else a negative value.
332 int ust_consumer_destroy_channel(struct consumer_socket
*socket
,
333 struct ust_app_channel
*ua_chan
)
336 struct lttcomm_consumer_msg msg
;
340 assert(socket
->fd
>= 0);
342 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_CHANNEL
;
343 msg
.u
.destroy_channel
.key
= ua_chan
->key
;
345 pthread_mutex_lock(socket
->lock
);
346 health_code_update();
348 ret
= consumer_send_msg(socket
, &msg
);
354 health_code_update();
355 pthread_mutex_unlock(socket
->lock
);
360 * Send a given stream to UST tracer.
362 * On success return 0 else a negative value.
364 int ust_consumer_send_stream_to_ust(struct ust_app
*app
,
365 struct ust_app_channel
*channel
, struct ust_app_stream
*stream
)
373 DBG2("UST consumer send stream to app %d", app
->sock
);
375 /* Relay stream to application. */
376 ret
= ustctl_send_stream_to_ust(app
->sock
, channel
->obj
, stream
->obj
);
378 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
379 ERR("Error ustctl send stream %s to app pid: %d with ret %d",
380 stream
->name
, app
->pid
, ret
);
382 DBG3("UST app send stream to ust failed. Application is dead.");
386 channel
->handle
= channel
->obj
->handle
;
393 * Send channel previously received from the consumer to the UST tracer.
395 * On success return 0 else a negative value.
397 int ust_consumer_send_channel_to_ust(struct ust_app
*app
,
398 struct ust_app_session
*ua_sess
, struct ust_app_channel
*channel
)
405 assert(channel
->obj
);
407 DBG2("UST app send channel to sock %d pid %d (name: %s, key: %" PRIu64
")",
408 app
->sock
, app
->pid
, channel
->name
, channel
->tracing_channel_id
);
410 /* Send stream to application. */
411 ret
= ustctl_send_channel_to_ust(app
->sock
, ua_sess
->handle
, channel
->obj
);
413 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
414 ERR("Error ustctl send channel %s to app pid: %d with ret %d",
415 channel
->name
, app
->pid
, ret
);
417 DBG3("UST app send channel to ust failed. Application is dead.");
427 * Handle the metadata requests from the UST consumer
429 * Return 0 on success else a negative value.
431 int ust_consumer_metadata_request(struct consumer_socket
*socket
)
435 struct lttcomm_metadata_request_msg request
;
436 struct buffer_reg_uid
*reg_uid
;
437 struct ust_registry_session
*ust_reg
;
438 struct lttcomm_consumer_msg msg
;
443 pthread_mutex_lock(socket
->lock
);
445 health_code_update();
447 /* Wait for a metadata request */
448 ret
= lttcomm_recv_unix_sock(socket
->fd
, &request
, sizeof(request
));
450 ERR("Consumer closed the metadata socket");
455 DBG("Metadata request received for session %" PRIu64
", key %" PRIu64
,
456 request
.session_id
, request
.key
);
458 reg_uid
= buffer_reg_uid_find(request
.session_id
,
459 request
.bits_per_long
, request
.uid
);
461 ust_reg
= reg_uid
->registry
->reg
.ust
;
463 struct buffer_reg_pid
*reg_pid
=
464 buffer_reg_pid_find(request
.session_id_per_pid
);
466 DBG("PID registry not found for session id %" PRIu64
,
467 request
.session_id_per_pid
);
469 msg
.cmd_type
= LTTNG_ERR_UND
;
470 (void) consumer_send_msg(socket
, &msg
);
472 * This is possible since the session might have been destroyed
473 * during a consumer metadata request. So here, return gracefully
474 * because the destroy session will push the remaining metadata to
480 ust_reg
= reg_pid
->registry
->reg
.ust
;
484 ret_push
= ust_app_push_metadata(ust_reg
, socket
, 1);
486 ERR("Pushing metadata");
490 DBG("UST Consumer metadata pushed successfully");
494 pthread_mutex_unlock(socket
->lock
);