2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include <common/common.h>
25 #include <common/defaults.h>
26 #include <common/sessiond-comm/sessiond-comm.h>
29 #include "lttng-sessiond.h"
37 * Return allocated channel attributes.
39 struct lttng_channel
*channel_new_default_attr(int dom
,
40 enum lttng_buffer_type type
)
42 struct lttng_channel
*chan
;
43 const char *channel_name
= DEFAULT_CHANNEL_NAME
;
45 chan
= zmalloc(sizeof(struct lttng_channel
));
47 PERROR("zmalloc channel init");
51 /* Same for all domains. */
52 chan
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
53 chan
->attr
.tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
54 chan
->attr
.tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
57 case LTTNG_DOMAIN_KERNEL
:
58 assert(type
== LTTNG_BUFFER_GLOBAL
);
59 chan
->attr
.subbuf_size
=
60 default_get_kernel_channel_subbuf_size();
61 chan
->attr
.num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
62 chan
->attr
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
63 chan
->attr
.switch_timer_interval
= DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
64 chan
->attr
.read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
65 chan
->attr
.live_timer_interval
= DEFAULT_KERNEL_CHANNEL_LIVE_TIMER
;
67 case LTTNG_DOMAIN_JUL
:
68 channel_name
= DEFAULT_JUL_CHANNEL_NAME
;
70 case LTTNG_DOMAIN_LOG4J
:
71 channel_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
73 case LTTNG_DOMAIN_PYTHON
:
74 channel_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
76 case LTTNG_DOMAIN_UST
:
79 case LTTNG_BUFFER_PER_UID
:
80 chan
->attr
.subbuf_size
= default_get_ust_uid_channel_subbuf_size();
81 chan
->attr
.num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
82 chan
->attr
.output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
83 chan
->attr
.switch_timer_interval
=
84 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
85 chan
->attr
.read_timer_interval
=
86 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
87 chan
->attr
.live_timer_interval
=
88 DEFAULT_UST_UID_CHANNEL_LIVE_TIMER
;
90 case LTTNG_BUFFER_PER_PID
:
92 chan
->attr
.subbuf_size
= default_get_ust_pid_channel_subbuf_size();
93 chan
->attr
.num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
94 chan
->attr
.output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
95 chan
->attr
.switch_timer_interval
=
96 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
97 chan
->attr
.read_timer_interval
=
98 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
99 chan
->attr
.live_timer_interval
=
100 DEFAULT_UST_UID_CHANNEL_LIVE_TIMER
;
105 goto error
; /* Not implemented */
108 if (snprintf(chan
->name
, sizeof(chan
->name
), "%s",
110 PERROR("snprintf default channel name");
122 * Disable kernel channel of the kernel session.
124 int channel_kernel_disable(struct ltt_kernel_session
*ksession
,
128 struct ltt_kernel_channel
*kchan
;
131 assert(channel_name
);
133 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksession
);
135 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
139 /* Only if channel is enabled disable it. */
140 if (kchan
->enabled
== 1) {
141 ret
= kernel_disable_channel(kchan
);
142 if (ret
< 0 && ret
!= -EEXIST
) {
143 ret
= LTTNG_ERR_KERN_CHAN_DISABLE_FAIL
;
155 * Enable kernel channel of the kernel session.
157 int channel_kernel_enable(struct ltt_kernel_session
*ksession
,
158 struct ltt_kernel_channel
*kchan
)
165 if (kchan
->enabled
== 0) {
166 ret
= kernel_enable_channel(kchan
);
168 ret
= LTTNG_ERR_KERN_CHAN_ENABLE_FAIL
;
172 ret
= LTTNG_ERR_KERN_CHAN_EXIST
;
182 static int channel_validate(struct lttng_channel
*attr
)
185 * The ringbuffer (both in user space and kernel) behaves badly
186 * in overwrite mode and with less than 2 subbuffers so block it
187 * right away and send back an invalid attribute error.
189 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
196 * Create kernel channel of the kernel session and notify kernel thread.
198 int channel_kernel_create(struct ltt_kernel_session
*ksession
,
199 struct lttng_channel
*attr
, int kernel_pipe
)
202 struct lttng_channel
*defattr
= NULL
;
206 /* Creating channel attributes if needed */
208 defattr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
209 LTTNG_BUFFER_GLOBAL
);
210 if (defattr
== NULL
) {
211 ret
= LTTNG_ERR_FATAL
;
218 * Set the overwrite mode for this channel based on the session
219 * type unless the client explicitly overrides the channel mode.
221 if (attr
->attr
.overwrite
== DEFAULT_CHANNEL_OVERWRITE
) {
222 attr
->attr
.overwrite
= !!ksession
->snapshot_mode
;
225 /* Enforce mmap output for snapshot sessions. */
226 if (ksession
->snapshot_mode
) {
227 attr
->attr
.output
= LTTNG_EVENT_MMAP
;
230 /* Validate common channel properties. */
231 if (channel_validate(attr
) < 0) {
232 ret
= LTTNG_ERR_INVALID
;
236 /* Channel not found, creating it */
237 ret
= kernel_create_channel(ksession
, attr
);
239 ret
= LTTNG_ERR_KERN_CHAN_FAIL
;
243 /* Notify kernel thread that there is a new channel */
244 ret
= notify_thread_pipe(kernel_pipe
);
246 ret
= LTTNG_ERR_FATAL
;
257 * Enable UST channel for session and domain.
259 int channel_ust_enable(struct ltt_ust_session
*usess
,
260 struct ltt_ust_channel
*uchan
)
267 /* If already enabled, everything is OK */
268 if (uchan
->enabled
) {
269 DBG3("Channel %s already enabled. Skipping", uchan
->name
);
270 ret
= LTTNG_ERR_UST_CHAN_EXIST
;
274 DBG2("Channel %s being enabled in UST domain", uchan
->name
);
277 * Enable channel for UST global domain on all applications. Ignore return
278 * value here since whatever error we got, it means that the channel was
279 * not created on one or many registered applications and we can not report
280 * this to the user yet. However, at this stage, the channel was
281 * successfully created on the session daemon side so the enable-channel
282 * command is a success.
284 (void) ust_app_enable_channel_glb(usess
, uchan
);
287 DBG2("Channel %s enabled successfully", uchan
->name
);
294 * Create UST channel for session and domain.
296 int channel_ust_create(struct ltt_ust_session
*usess
,
297 struct lttng_channel
*attr
, enum lttng_buffer_type type
)
300 struct ltt_ust_channel
*uchan
= NULL
;
301 struct lttng_channel
*defattr
= NULL
;
302 enum lttng_domain_type domain
= LTTNG_DOMAIN_UST
;
303 bool chan_published
= false;
307 /* Creating channel attributes if needed */
309 defattr
= channel_new_default_attr(LTTNG_DOMAIN_UST
, type
);
310 if (defattr
== NULL
) {
311 ret
= LTTNG_ERR_FATAL
;
317 * HACK: Set the channel's subdomain (JUL, Log4j, Python, etc.)
318 * based on the default name.
320 if (!strcmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
)) {
321 domain
= LTTNG_DOMAIN_JUL
;
322 } else if (!strcmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
)) {
323 domain
= LTTNG_DOMAIN_LOG4J
;
324 } else if (!strcmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
)) {
325 domain
= LTTNG_DOMAIN_PYTHON
;
330 * Set the overwrite mode for this channel based on the session
331 * type unless the client explicitly overrides the channel mode.
333 if (attr
->attr
.overwrite
== DEFAULT_CHANNEL_OVERWRITE
) {
334 attr
->attr
.overwrite
= !!usess
->snapshot_mode
;
337 /* Enforce mmap output for snapshot sessions. */
338 if (usess
->snapshot_mode
) {
339 attr
->attr
.output
= LTTNG_EVENT_MMAP
;
342 /* Validate common channel properties. */
343 if (channel_validate(attr
) < 0) {
344 ret
= LTTNG_ERR_INVALID
;
349 * Validate UST buffer size and number of buffers: must both be power of 2
350 * and nonzero. We validate right here for UST, because applications will
351 * not report the error to the user (unlike kernel tracing).
353 if (!attr
->attr
.subbuf_size
||
354 (attr
->attr
.subbuf_size
& (attr
->attr
.subbuf_size
- 1))) {
355 ret
= LTTNG_ERR_INVALID
;
360 * Invalid subbuffer size if it's lower then the page size.
362 if (attr
->attr
.subbuf_size
< page_size
) {
363 ret
= LTTNG_ERR_INVALID
;
367 if (!attr
->attr
.num_subbuf
||
368 (attr
->attr
.num_subbuf
& (attr
->attr
.num_subbuf
- 1))) {
369 ret
= LTTNG_ERR_INVALID
;
373 if (attr
->attr
.output
!= LTTNG_EVENT_MMAP
) {
374 ret
= LTTNG_ERR_NOT_SUPPORTED
;
379 * The tracefile_size should not be < to the subbuf_size, otherwise
380 * we won't be able to write the packets on disk
382 if ((attr
->attr
.tracefile_size
> 0) &&
383 (attr
->attr
.tracefile_size
< attr
->attr
.subbuf_size
)) {
384 ret
= LTTNG_ERR_INVALID
;
388 /* Validate buffer type. */
390 case LTTNG_BUFFER_PER_PID
:
392 case LTTNG_BUFFER_PER_UID
:
395 ret
= LTTNG_ERR_BUFFER_NOT_SUPPORTED
;
399 /* Create UST channel */
400 uchan
= trace_ust_create_channel(attr
, domain
);
402 ret
= LTTNG_ERR_FATAL
;
407 if (trace_ust_is_max_id(usess
->used_channel_id
)) {
408 ret
= LTTNG_ERR_UST_CHAN_FAIL
;
411 uchan
->id
= trace_ust_get_next_chan_id(usess
);
413 DBG2("Channel %s is being created for UST with buffer %d and id %" PRIu64
,
414 uchan
->name
, type
, uchan
->id
);
416 /* Flag session buffer type. */
417 if (!usess
->buffer_type_changed
) {
418 usess
->buffer_type
= type
;
419 usess
->buffer_type_changed
= 1;
420 } else if (usess
->buffer_type
!= type
) {
421 /* Buffer type was already set. Refuse to create channel. */
422 ret
= LTTNG_ERR_BUFFER_TYPE_MISMATCH
;
423 goto error_free_chan
;
426 /* Enable channel for global domain */
427 ret
= ust_app_create_channel_glb(usess
, uchan
);
428 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
429 ret
= LTTNG_ERR_UST_CHAN_FAIL
;
430 goto error_free_chan
;
433 /* Adding the channel to the channel hash table. */
435 if (strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
436 sizeof(uchan
->name
))) {
437 lttng_ht_add_unique_str(usess
->domain_global
.channels
, &uchan
->node
);
438 chan_published
= true;
441 * Copy channel attribute to session if this is metadata so if NO
442 * application exists we can access that data in the shadow copy during
443 * the global update of newly registered application.
445 memcpy(&usess
->metadata_attr
, &uchan
->attr
,
446 sizeof(usess
->metadata_attr
));
450 DBG2("Channel %s created successfully", uchan
->name
);
451 if (domain
!= LTTNG_DOMAIN_UST
) {
452 struct agent
*agt
= trace_ust_find_agent(usess
, domain
);
455 agt
= agent_create(domain
);
457 ret
= LTTNG_ERR_NOMEM
;
458 goto error_remove_chan
;
460 agent_add(agt
, usess
->agents
);
468 if (chan_published
) {
469 trace_ust_delete_channel(usess
->domain_global
.channels
, uchan
);
472 trace_ust_destroy_channel(uchan
);
479 * Disable UST channel for session and domain.
481 int channel_ust_disable(struct ltt_ust_session
*usess
,
482 struct ltt_ust_channel
*uchan
)
489 /* Already disabled */
490 if (uchan
->enabled
== 0) {
491 DBG2("Channel UST %s already disabled", uchan
->name
);
495 DBG2("Channel %s being disabled in UST global domain", uchan
->name
);
496 /* Disable channel for global domain */
497 ret
= ust_app_disable_channel_glb(usess
, uchan
);
498 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXIST
) {
499 ret
= LTTNG_ERR_UST_CHAN_DISABLE_FAIL
;
505 DBG2("Channel %s disabled successfully", uchan
->name
);