2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
15 #include <common/common.hpp>
16 #include <common/defaults.hpp>
17 #include <common/compat/string.hpp>
19 #include "consumer.hpp"
20 #include "health-sessiond.hpp"
21 #include "kernel-consumer.hpp"
22 #include "notification-thread-commands.hpp"
23 #include "session.hpp"
24 #include "lttng-sessiond.hpp"
26 static char *create_channel_path(struct consumer_output
*consumer
,
27 size_t *consumer_path_offset
)
30 char tmp_path
[PATH_MAX
];
31 char *pathname
= NULL
;
33 LTTNG_ASSERT(consumer
);
35 /* Get the right path name destination */
36 if (consumer
->type
== CONSUMER_DST_LOCAL
||
37 (consumer
->type
== CONSUMER_DST_NET
&&
38 consumer
->relay_major_version
== 2 &&
39 consumer
->relay_minor_version
>= 11)) {
40 pathname
= strdup(consumer
->domain_subdir
);
42 PERROR("Failed to copy domain subdirectory string %s",
43 consumer
->domain_subdir
);
46 *consumer_path_offset
= strlen(consumer
->domain_subdir
);
47 DBG3("Kernel local consumer trace path relative to current trace chunk: \"%s\"",
50 /* Network output, relayd < 2.11. */
51 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s%s",
52 consumer
->dst
.net
.base_dir
,
53 consumer
->domain_subdir
);
55 PERROR("snprintf kernel metadata path");
57 } else if (ret
>= sizeof(tmp_path
)) {
58 ERR("Kernel channel path exceeds the maximal allowed length of of %zu bytes (%i bytes required) with path \"%s%s\"",
59 sizeof(tmp_path
), ret
,
60 consumer
->dst
.net
.base_dir
,
61 consumer
->domain_subdir
);
64 pathname
= lttng_strndup(tmp_path
, sizeof(tmp_path
));
66 PERROR("lttng_strndup");
69 *consumer_path_offset
= 0;
70 DBG3("Kernel network consumer subdir path: %s", pathname
);
81 * Sending a single channel to the consumer with command ADD_CHANNEL.
84 int kernel_consumer_add_channel(struct consumer_socket
*sock
,
85 struct ltt_kernel_channel
*channel
,
86 struct ltt_kernel_session
*ksession
,
90 char *pathname
= NULL
;
91 struct lttcomm_consumer_msg lkm
;
92 struct consumer_output
*consumer
;
93 enum lttng_error_code status
;
94 struct ltt_session
*session
= NULL
;
95 struct lttng_channel_extended
*channel_attr_extended
;
97 size_t consumer_path_offset
= 0;
100 LTTNG_ASSERT(channel
);
101 LTTNG_ASSERT(ksession
);
102 LTTNG_ASSERT(ksession
->consumer
);
104 consumer
= ksession
->consumer
;
105 channel_attr_extended
= (struct lttng_channel_extended
*)
106 channel
->channel
->attr
.extended
.ptr
;
108 DBG("Kernel consumer adding channel %s to kernel consumer",
109 channel
->channel
->name
);
110 is_local_trace
= consumer
->net_seq_index
== -1ULL;
112 pathname
= create_channel_path(consumer
, &consumer_path_offset
);
118 if (is_local_trace
&& ksession
->current_trace_chunk
) {
119 enum lttng_trace_chunk_status chunk_status
;
120 char *pathname_index
;
122 ret
= asprintf(&pathname_index
, "%s/" DEFAULT_INDEX_DIR
,
125 ERR("Failed to format channel index directory");
131 * Create the index subdirectory which will take care
132 * of implicitly creating the channel's path.
134 chunk_status
= lttng_trace_chunk_create_subdirectory(
135 ksession
->current_trace_chunk
, pathname_index
);
136 free(pathname_index
);
137 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
143 /* Prep channel message structure */
144 consumer_init_add_channel_comm_msg(&lkm
,
147 &pathname
[consumer_path_offset
],
148 consumer
->net_seq_index
,
149 channel
->channel
->name
,
150 channel
->stream_count
,
151 channel
->channel
->attr
.output
,
152 CONSUMER_CHANNEL_TYPE_DATA
,
153 channel
->channel
->attr
.tracefile_size
,
154 channel
->channel
->attr
.tracefile_count
,
156 channel
->channel
->attr
.live_timer_interval
,
157 ksession
->is_live_session
,
158 channel_attr_extended
->monitor_timer_interval
,
159 ksession
->current_trace_chunk
);
161 health_code_update();
163 ret
= consumer_send_channel(sock
, &lkm
);
168 health_code_update();
170 session
= session_find_by_id(ksession
->id
);
171 LTTNG_ASSERT(session
);
172 LTTNG_ASSERT(pthread_mutex_trylock(&session
->lock
));
173 LTTNG_ASSERT(session_trylock_list());
175 status
= notification_thread_command_add_channel(
176 the_notification_thread_handle
, session
->name
,
177 ksession
->uid
, ksession
->gid
, channel
->channel
->name
,
178 channel
->key
, LTTNG_DOMAIN_KERNEL
,
179 channel
->channel
->attr
.subbuf_size
*
180 channel
->channel
->attr
.num_subbuf
);
182 if (status
!= LTTNG_OK
) {
187 channel
->published_to_notification_thread
= true;
191 session_put(session
);
198 * Sending metadata to the consumer with command ADD_CHANNEL and ADD_STREAM.
200 * The consumer socket lock must be held by the caller.
202 int kernel_consumer_add_metadata(struct consumer_socket
*sock
,
203 struct ltt_kernel_session
*ksession
, unsigned int monitor
)
206 struct lttcomm_consumer_msg lkm
;
207 struct consumer_output
*consumer
;
212 LTTNG_ASSERT(ksession
);
213 LTTNG_ASSERT(ksession
->consumer
);
216 DBG("Sending metadata %d to kernel consumer",
217 ksession
->metadata_stream_fd
);
219 /* Get consumer output pointer */
220 consumer
= ksession
->consumer
;
222 /* Prep channel message structure */
223 consumer_init_add_channel_comm_msg(&lkm
,
224 ksession
->metadata
->key
,
227 consumer
->net_seq_index
,
228 ksession
->metadata
->conf
->name
,
230 ksession
->metadata
->conf
->attr
.output
,
231 CONSUMER_CHANNEL_TYPE_METADATA
,
232 ksession
->metadata
->conf
->attr
.tracefile_size
,
233 ksession
->metadata
->conf
->attr
.tracefile_count
,
235 ksession
->metadata
->conf
->attr
.live_timer_interval
,
236 ksession
->is_live_session
,
238 ksession
->current_trace_chunk
);
240 health_code_update();
242 ret
= consumer_send_channel(sock
, &lkm
);
247 health_code_update();
249 /* Prep stream message structure */
250 consumer_init_add_stream_comm_msg(&lkm
,
251 ksession
->metadata
->key
,
252 ksession
->metadata_stream_fd
,
253 0 /* CPU: 0 for metadata. */);
255 health_code_update();
257 /* Send stream and file descriptor */
258 ret
= consumer_send_stream(sock
, consumer
, &lkm
,
259 &ksession
->metadata_stream_fd
, 1);
264 health_code_update();
272 * Sending a single stream to the consumer with command ADD_STREAM.
275 int kernel_consumer_add_stream(struct consumer_socket
*sock
,
276 struct ltt_kernel_channel
*channel
,
277 struct ltt_kernel_stream
*stream
,
278 struct ltt_kernel_session
*session
)
281 struct lttcomm_consumer_msg lkm
;
282 struct consumer_output
*consumer
;
284 LTTNG_ASSERT(channel
);
285 LTTNG_ASSERT(stream
);
286 LTTNG_ASSERT(session
);
287 LTTNG_ASSERT(session
->consumer
);
290 DBG("Sending stream %d of channel %s to kernel consumer",
291 stream
->fd
, channel
->channel
->name
);
293 /* Get consumer output pointer */
294 consumer
= session
->consumer
;
296 /* Prep stream consumer message */
297 consumer_init_add_stream_comm_msg(&lkm
,
302 health_code_update();
304 /* Send stream and file descriptor */
305 ret
= consumer_send_stream(sock
, consumer
, &lkm
, &stream
->fd
, 1);
310 health_code_update();
317 * Sending the notification that all streams were sent with STREAMS_SENT.
319 int kernel_consumer_streams_sent(struct consumer_socket
*sock
,
320 struct ltt_kernel_session
*session
, uint64_t channel_key
)
323 struct lttcomm_consumer_msg lkm
;
324 struct consumer_output
*consumer
;
327 LTTNG_ASSERT(session
);
329 DBG("Sending streams_sent");
330 /* Get consumer output pointer */
331 consumer
= session
->consumer
;
333 /* Prep stream consumer message */
334 consumer_init_streams_sent_comm_msg(&lkm
,
335 LTTNG_CONSUMER_STREAMS_SENT
,
336 channel_key
, consumer
->net_seq_index
);
338 health_code_update();
340 /* Send stream and file descriptor */
341 ret
= consumer_send_msg(sock
, &lkm
);
351 * Send all stream fds of kernel channel to the consumer.
353 * The consumer socket lock must be held by the caller.
355 int kernel_consumer_send_channel_streams(struct consumer_socket
*sock
,
356 struct ltt_kernel_channel
*channel
, struct ltt_kernel_session
*ksession
,
357 unsigned int monitor
)
360 struct ltt_kernel_stream
*stream
;
363 LTTNG_ASSERT(channel
);
364 LTTNG_ASSERT(ksession
);
365 LTTNG_ASSERT(ksession
->consumer
);
370 /* Bail out if consumer is disabled */
371 if (!ksession
->consumer
->enabled
) {
376 DBG("Sending streams of channel %s to kernel consumer",
377 channel
->channel
->name
);
379 if (!channel
->sent_to_consumer
) {
380 ret
= kernel_consumer_add_channel(sock
, channel
, ksession
, monitor
);
384 channel
->sent_to_consumer
= true;
388 cds_list_for_each_entry(stream
, &channel
->stream_list
.head
, list
) {
389 if (!stream
->fd
|| stream
->sent_to_consumer
) {
393 /* Add stream on the kernel consumer side. */
394 ret
= kernel_consumer_add_stream(sock
, channel
, stream
,
399 stream
->sent_to_consumer
= true;
408 * Send all stream fds of the kernel session to the consumer.
410 * The consumer socket lock must be held by the caller.
412 int kernel_consumer_send_session(struct consumer_socket
*sock
,
413 struct ltt_kernel_session
*session
)
415 int ret
, monitor
= 0;
416 struct ltt_kernel_channel
*chan
;
419 LTTNG_ASSERT(session
);
420 LTTNG_ASSERT(session
->consumer
);
423 /* Bail out if consumer is disabled */
424 if (!session
->consumer
->enabled
) {
429 /* Don't monitor the streams on the consumer if in flight recorder. */
430 if (session
->output_traces
) {
434 DBG("Sending session stream to kernel consumer");
436 if (session
->metadata_stream_fd
>= 0 && session
->metadata
) {
437 ret
= kernel_consumer_add_metadata(sock
, session
, monitor
);
443 /* Send channel and streams of it */
444 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
445 ret
= kernel_consumer_send_channel_streams(sock
, chan
, session
,
452 * Inform the relay that all the streams for the
455 ret
= kernel_consumer_streams_sent(sock
, session
, chan
->key
);
462 DBG("Kernel consumer FDs of metadata and channel streams sent");
464 session
->consumer_fds_sent
= 1;
471 int kernel_consumer_destroy_channel(struct consumer_socket
*socket
,
472 struct ltt_kernel_channel
*channel
)
475 struct lttcomm_consumer_msg msg
;
477 LTTNG_ASSERT(channel
);
478 LTTNG_ASSERT(socket
);
480 DBG("Sending kernel consumer destroy channel key %" PRIu64
, channel
->key
);
482 memset(&msg
, 0, sizeof(msg
));
483 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_CHANNEL
;
484 msg
.u
.destroy_channel
.key
= channel
->key
;
486 pthread_mutex_lock(socket
->lock
);
487 health_code_update();
489 ret
= consumer_send_msg(socket
, &msg
);
495 health_code_update();
496 pthread_mutex_unlock(socket
->lock
);
500 int kernel_consumer_destroy_metadata(struct consumer_socket
*socket
,
501 struct ltt_kernel_metadata
*metadata
)
504 struct lttcomm_consumer_msg msg
;
506 LTTNG_ASSERT(metadata
);
507 LTTNG_ASSERT(socket
);
509 DBG("Sending kernel consumer destroy channel key %" PRIu64
, metadata
->key
);
511 memset(&msg
, 0, sizeof(msg
));
512 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_CHANNEL
;
513 msg
.u
.destroy_channel
.key
= metadata
->key
;
515 pthread_mutex_lock(socket
->lock
);
516 health_code_update();
518 ret
= consumer_send_msg(socket
, &msg
);
524 health_code_update();
525 pthread_mutex_unlock(socket
->lock
);