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 pathname
= setup_trace_path(consumer
, ua_sess
);
127 /* Depending on the buffer type, a different channel key is used. */
128 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
129 chan_reg_key
= ua_chan
->tracing_channel_id
;
131 chan_reg_key
= ua_chan
->key
;
134 if (ua_chan
->attr
.type
== LTTNG_UST_CHAN_METADATA
) {
137 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
139 chan_id
= chan_reg
->chan_id
;
142 consumer_init_ask_channel_comm_msg(&msg
,
143 ua_chan
->attr
.subbuf_size
,
144 ua_chan
->attr
.num_subbuf
,
145 ua_chan
->attr
.overwrite
,
146 ua_chan
->attr
.switch_timer_interval
,
147 ua_chan
->attr
.read_timer_interval
,
148 (int) ua_chan
->attr
.output
,
149 (int) ua_chan
->attr
.type
,
155 consumer
->net_seq_index
,
159 ua_chan
->tracefile_size
,
160 ua_chan
->tracefile_count
);
162 health_code_update();
164 ret
= lttcomm_send_unix_sock(socket
->fd
, &msg
, sizeof(msg
));
169 ret
= consumer_recv_status_channel(socket
, &key
,
170 &ua_chan
->expected_stream_count
);
174 /* Communication protocol error. */
175 assert(key
== ua_chan
->key
);
176 /* We need at least one where 1 stream for 1 cpu. */
177 assert(ua_chan
->expected_stream_count
> 0);
179 DBG2("UST ask channel %" PRIu64
" successfully done with %u stream(s)", key
,
180 ua_chan
->expected_stream_count
);
184 health_code_update();
189 * Ask consumer to create a channel for a given session.
191 * Returns 0 on success else a negative value.
193 int ust_consumer_ask_channel(struct ust_app_session
*ua_sess
,
194 struct ust_app_channel
*ua_chan
, struct consumer_output
*consumer
,
195 struct consumer_socket
*socket
, struct ust_registry_session
*registry
)
203 assert(socket
->fd
>= 0);
206 if (!consumer
->enabled
) {
207 ret
= -LTTNG_ERR_NO_CONSUMER
;
208 DBG3("Consumer is disabled");
212 pthread_mutex_lock(socket
->lock
);
214 ret
= ask_channel_creation(ua_sess
, ua_chan
, consumer
, socket
, registry
);
220 pthread_mutex_unlock(socket
->lock
);
225 * Send a get channel command to consumer using the given channel key. The
226 * channel object is populated and the stream list.
228 * Return 0 on success else a negative value.
230 int ust_consumer_get_channel(struct consumer_socket
*socket
,
231 struct ust_app_channel
*ua_chan
)
234 struct lttcomm_consumer_msg msg
;
238 assert(socket
->fd
>= 0);
240 msg
.cmd_type
= LTTNG_CONSUMER_GET_CHANNEL
;
241 msg
.u
.get_channel
.key
= ua_chan
->key
;
243 pthread_mutex_lock(socket
->lock
);
244 health_code_update();
246 /* Send command and wait for OK reply. */
247 ret
= consumer_send_msg(socket
, &msg
);
252 /* First, get the channel from consumer. */
253 ret
= ustctl_recv_channel_from_consumer(socket
->fd
, &ua_chan
->obj
);
256 ERR("Error recv channel from consumer %d with ret %d",
259 DBG3("UST app recv channel from consumer. Consumer is dead.");
264 /* Next, get all streams. */
266 struct ust_app_stream
*stream
;
268 /* Create UST stream */
269 stream
= ust_app_alloc_stream();
270 if (stream
== NULL
) {
275 /* Stream object is populated by this call if successful. */
276 ret
= ustctl_recv_stream_from_consumer(socket
->fd
, &stream
->obj
);
279 if (ret
== -LTTNG_UST_ERR_NOENT
) {
280 DBG3("UST app consumer has no more stream available");
285 ERR("Recv stream from consumer %d with ret %d",
288 DBG3("UST app recv stream from consumer. Consumer is dead.");
293 /* Order is important this is why a list is used. */
294 cds_list_add_tail(&stream
->list
, &ua_chan
->streams
.head
);
295 ua_chan
->streams
.count
++;
297 DBG2("UST app stream %d received succesfully", ua_chan
->streams
.count
);
300 /* This MUST match or else we have a synchronization problem. */
301 assert(ua_chan
->expected_stream_count
== ua_chan
->streams
.count
);
303 /* Wait for confirmation that we can proceed with the streams. */
304 ret
= consumer_recv_status_reply(socket
);
310 health_code_update();
311 pthread_mutex_unlock(socket
->lock
);
316 * Send a destroy channel command to consumer using the given channel key.
318 * Note that this command MUST be used prior to a successful
319 * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully,
320 * the streams are dispatched to the consumer threads and MUST be teardown
321 * through the hang up process.
323 * Return 0 on success else a negative value.
325 int ust_consumer_destroy_channel(struct consumer_socket
*socket
,
326 struct ust_app_channel
*ua_chan
)
329 struct lttcomm_consumer_msg msg
;
333 assert(socket
->fd
>= 0);
335 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_CHANNEL
;
336 msg
.u
.destroy_channel
.key
= ua_chan
->key
;
338 pthread_mutex_lock(socket
->lock
);
339 health_code_update();
341 ret
= consumer_send_msg(socket
, &msg
);
347 health_code_update();
348 pthread_mutex_unlock(socket
->lock
);
353 * Send a given stream to UST tracer.
355 * On success return 0 else a negative value.
357 int ust_consumer_send_stream_to_ust(struct ust_app
*app
,
358 struct ust_app_channel
*channel
, struct ust_app_stream
*stream
)
366 DBG2("UST consumer send stream to app %d", app
->sock
);
368 /* Relay stream to application. */
369 ret
= ustctl_send_stream_to_ust(app
->sock
, channel
->obj
, stream
->obj
);
371 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
372 ERR("Error ustctl send stream %s to app pid: %d with ret %d",
373 stream
->name
, app
->pid
, ret
);
375 DBG3("UST app send stream to ust failed. Application is dead.");
379 channel
->handle
= channel
->obj
->handle
;
386 * Send channel previously received from the consumer to the UST tracer.
388 * On success return 0 else a negative value.
390 int ust_consumer_send_channel_to_ust(struct ust_app
*app
,
391 struct ust_app_session
*ua_sess
, struct ust_app_channel
*channel
)
398 assert(channel
->obj
);
400 DBG2("UST app send channel to sock %d pid %d (name: %s, key: %" PRIu64
")",
401 app
->sock
, app
->pid
, channel
->name
, channel
->tracing_channel_id
);
403 /* Send stream to application. */
404 ret
= ustctl_send_channel_to_ust(app
->sock
, ua_sess
->handle
, channel
->obj
);
406 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
407 ERR("Error ustctl send channel %s to app pid: %d with ret %d",
408 channel
->name
, app
->pid
, ret
);
410 DBG3("UST app send channel to ust failed. Application is dead.");
420 * Handle the metadata requests from the UST consumer
422 * Return 0 on success else a negative value.
424 int ust_consumer_metadata_request(struct consumer_socket
*socket
)
428 struct lttcomm_metadata_request_msg request
;
429 struct buffer_reg_uid
*reg_uid
;
430 struct ust_registry_session
*ust_reg
;
431 struct lttcomm_consumer_msg msg
;
436 pthread_mutex_lock(socket
->lock
);
438 health_code_update();
440 /* Wait for a metadata request */
441 ret
= lttcomm_recv_unix_sock(socket
->fd
, &request
, sizeof(request
));
443 ERR("Consumer closed the metadata socket");
448 DBG("Metadata request received for session %u, key %" PRIu64
,
449 request
.session_id
, request
.key
);
451 reg_uid
= buffer_reg_uid_find(request
.session_id
,
452 request
.bits_per_long
, request
.uid
);
454 ust_reg
= reg_uid
->registry
->reg
.ust
;
456 struct buffer_reg_pid
*reg_pid
=
457 buffer_reg_pid_find(request
.session_id
);
459 DBG("PID registry not found for session id %u",
462 msg
.cmd_type
= LTTNG_ERR_UND
;
463 (void) consumer_send_msg(socket
, &msg
);
465 * This is possible since the session might have been destroyed
466 * during a consumer metadata request. So here, return gracefully
467 * because the destroy session will push the remaining metadata to
473 ust_reg
= reg_pid
->registry
->reg
.ust
;
477 ret_push
= ust_app_push_metadata(ust_reg
, socket
, 1);
479 ERR("Pushing metadata");
483 DBG("UST Consumer metadata pushed successfully");
487 pthread_mutex_unlock(socket
->lock
);