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.
24 #include <common/common.h>
25 #include <common/defaults.h>
28 #include "trace-kernel.h"
29 #include "lttng-sessiond.h"
30 #include "notification-thread-commands.h"
33 * Find the channel name for the given kernel session.
35 struct ltt_kernel_channel
*trace_kernel_get_channel_by_name(
36 char *name
, struct ltt_kernel_session
*session
)
38 struct ltt_kernel_channel
*chan
;
44 * If we receive an empty string for channel name, it means the
45 * default channel name is requested.
48 name
= DEFAULT_CHANNEL_NAME
;
50 DBG("Trying to find channel %s", name
);
52 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
53 if (strcmp(name
, chan
->channel
->name
) == 0) {
54 DBG("Found channel by name %s", name
);
63 * Find the event for the given channel.
65 struct ltt_kernel_event
*trace_kernel_find_event(
66 char *name
, struct ltt_kernel_channel
*channel
,
67 enum lttng_event_type type
,
68 struct lttng_filter_bytecode
*filter
)
70 struct ltt_kernel_event
*ev
;
76 cds_list_for_each_entry(ev
, &channel
->events_list
.head
, list
) {
77 if (type
!= LTTNG_EVENT_ALL
&& ev
->type
!= type
) {
80 if (strcmp(name
, ev
->event
->name
)) {
83 if ((ev
->filter
&& !filter
) || (!ev
->filter
&& filter
)) {
86 if (ev
->filter
&& filter
) {
87 if (ev
->filter
->len
!= filter
->len
||
88 memcmp(ev
->filter
->data
, filter
->data
,
97 DBG("Found event %s for channel %s", name
,
98 channel
->channel
->name
);
106 * Find the event name for the given channel.
108 struct ltt_kernel_event
*trace_kernel_get_event_by_name(
109 char *name
, struct ltt_kernel_channel
*channel
,
110 enum lttng_event_type type
)
112 struct ltt_kernel_event
*ev
;
118 cds_list_for_each_entry(ev
, &channel
->events_list
.head
, list
) {
119 if (type
!= LTTNG_EVENT_ALL
&& ev
->type
!= type
) {
122 if (strcmp(name
, ev
->event
->name
)) {
129 DBG("Found event %s for channel %s", name
,
130 channel
->channel
->name
);
138 * Allocate and initialize a kernel session data structure.
140 * Return pointer to structure or NULL.
142 struct ltt_kernel_session
*trace_kernel_create_session(void)
144 struct ltt_kernel_session
*lks
= NULL
;
146 /* Allocate a new ltt kernel session */
147 lks
= zmalloc(sizeof(struct ltt_kernel_session
));
149 PERROR("create kernel session zmalloc");
153 /* Init data structure */
155 lks
->metadata_stream_fd
= -1;
156 lks
->channel_count
= 0;
157 lks
->stream_count_global
= 0;
158 lks
->metadata
= NULL
;
159 CDS_INIT_LIST_HEAD(&lks
->channel_list
.head
);
161 lks
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
162 if (lks
->consumer
== NULL
) {
176 * Allocate and initialize a kernel channel data structure.
178 * Return pointer to structure or NULL.
180 struct ltt_kernel_channel
*trace_kernel_create_channel(
181 struct lttng_channel
*chan
)
183 struct ltt_kernel_channel
*lkc
;
184 struct lttng_channel_extended
*extended
= NULL
;
188 lkc
= zmalloc(sizeof(struct ltt_kernel_channel
));
190 PERROR("ltt_kernel_channel zmalloc");
194 lkc
->channel
= zmalloc(sizeof(struct lttng_channel
));
195 if (lkc
->channel
== NULL
) {
196 PERROR("lttng_channel zmalloc");
200 extended
= zmalloc(sizeof(struct lttng_channel_extended
));
202 PERROR("lttng_channel_channel zmalloc");
205 memcpy(lkc
->channel
, chan
, sizeof(struct lttng_channel
));
206 memcpy(extended
, chan
->attr
.extended
.ptr
, sizeof(struct lttng_channel_extended
));
207 lkc
->channel
->attr
.extended
.ptr
= extended
;
211 * If we receive an empty string for channel name, it means the
212 * default channel name is requested.
214 if (chan
->name
[0] == '\0') {
215 strncpy(lkc
->channel
->name
, DEFAULT_CHANNEL_NAME
,
216 sizeof(lkc
->channel
->name
));
218 lkc
->channel
->name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
221 lkc
->stream_count
= 0;
222 lkc
->event_count
= 0;
224 lkc
->published_to_notification_thread
= false;
225 /* Init linked list */
226 CDS_INIT_LIST_HEAD(&lkc
->events_list
.head
);
227 CDS_INIT_LIST_HEAD(&lkc
->stream_list
.head
);
228 CDS_INIT_LIST_HEAD(&lkc
->ctx_list
);
242 * Allocate and init a kernel context object.
244 * Return the allocated object or NULL on error.
246 struct ltt_kernel_context
*trace_kernel_create_context(
247 struct lttng_kernel_context
*ctx
)
249 struct ltt_kernel_context
*kctx
;
251 kctx
= zmalloc(sizeof(*kctx
));
253 PERROR("zmalloc kernel context");
258 memcpy(&kctx
->ctx
, ctx
, sizeof(kctx
->ctx
));
261 CDS_INIT_LIST_HEAD(&kctx
->list
);
268 * Allocate and initialize a kernel event. Set name and event type.
269 * We own filter_expression, and filter.
271 * Return pointer to structure or NULL.
273 struct ltt_kernel_event
*trace_kernel_create_event(struct lttng_event
*ev
,
274 char *filter_expression
, struct lttng_filter_bytecode
*filter
)
276 struct ltt_kernel_event
*lke
;
277 struct lttng_kernel_event
*attr
;
281 lke
= zmalloc(sizeof(struct ltt_kernel_event
));
282 attr
= zmalloc(sizeof(struct lttng_kernel_event
));
283 if (lke
== NULL
|| attr
== NULL
) {
284 PERROR("kernel event zmalloc");
289 case LTTNG_EVENT_PROBE
:
290 attr
->instrumentation
= LTTNG_KERNEL_KPROBE
;
291 attr
->u
.kprobe
.addr
= ev
->attr
.probe
.addr
;
292 attr
->u
.kprobe
.offset
= ev
->attr
.probe
.offset
;
293 strncpy(attr
->u
.kprobe
.symbol_name
,
294 ev
->attr
.probe
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
295 attr
->u
.kprobe
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
297 case LTTNG_EVENT_FUNCTION
:
298 attr
->instrumentation
= LTTNG_KERNEL_KRETPROBE
;
299 attr
->u
.kretprobe
.addr
= ev
->attr
.probe
.addr
;
300 attr
->u
.kretprobe
.offset
= ev
->attr
.probe
.offset
;
301 strncpy(attr
->u
.kretprobe
.symbol_name
,
302 ev
->attr
.probe
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
303 attr
->u
.kretprobe
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
305 case LTTNG_EVENT_FUNCTION_ENTRY
:
306 attr
->instrumentation
= LTTNG_KERNEL_FUNCTION
;
307 strncpy(attr
->u
.ftrace
.symbol_name
,
308 ev
->attr
.ftrace
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
309 attr
->u
.ftrace
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
311 case LTTNG_EVENT_TRACEPOINT
:
312 attr
->instrumentation
= LTTNG_KERNEL_TRACEPOINT
;
314 case LTTNG_EVENT_SYSCALL
:
315 attr
->instrumentation
= LTTNG_KERNEL_SYSCALL
;
317 case LTTNG_EVENT_ALL
:
318 attr
->instrumentation
= LTTNG_KERNEL_ALL
;
321 ERR("Unknown kernel instrumentation type (%d)", ev
->type
);
325 /* Copy event name */
326 strncpy(attr
->name
, ev
->name
, LTTNG_KERNEL_SYM_NAME_LEN
);
327 attr
->name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
329 /* Setting up a kernel event */
333 lke
->filter_expression
= filter_expression
;
334 lke
->filter
= filter
;
339 free(filter_expression
);
347 * Allocate and initialize a kernel metadata.
349 * Return pointer to structure or NULL.
351 struct ltt_kernel_metadata
*trace_kernel_create_metadata(void)
353 struct ltt_kernel_metadata
*lkm
;
354 struct lttng_channel
*chan
;
356 lkm
= zmalloc(sizeof(struct ltt_kernel_metadata
));
357 chan
= zmalloc(sizeof(struct lttng_channel
));
358 if (lkm
== NULL
|| chan
== NULL
) {
359 PERROR("kernel metadata zmalloc");
363 /* Set default attributes */
364 chan
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
365 chan
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
366 chan
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
367 chan
->attr
.switch_timer_interval
= DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
368 chan
->attr
.read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
369 chan
->attr
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
384 * Allocate and initialize a kernel stream. The stream is set to ACTIVE_FD by
387 * Return pointer to structure or NULL.
389 struct ltt_kernel_stream
*trace_kernel_create_stream(const char *name
,
393 struct ltt_kernel_stream
*lks
;
397 lks
= zmalloc(sizeof(struct ltt_kernel_stream
));
399 PERROR("kernel stream zmalloc");
404 ret
= snprintf(lks
->name
, sizeof(lks
->name
), "%s_%u", name
, count
);
406 PERROR("snprintf stream name");
409 lks
->name
[sizeof(lks
->name
) - 1] = '\0';
423 * Cleanup kernel stream structure.
425 void trace_kernel_destroy_stream(struct ltt_kernel_stream
*stream
)
429 DBG("[trace] Closing stream fd %d", stream
->fd
);
430 /* Close kernel fd */
431 if (stream
->fd
>= 0) {
434 ret
= close(stream
->fd
);
439 /* Remove from stream list */
440 cds_list_del(&stream
->list
);
446 * Cleanup kernel event structure.
448 void trace_kernel_destroy_event(struct ltt_kernel_event
*event
)
452 if (event
->fd
>= 0) {
455 DBG("[trace] Closing event fd %d", event
->fd
);
456 /* Close kernel fd */
457 ret
= close(event
->fd
);
462 DBG("[trace] Tearing down event (no associated fd)");
465 /* Remove from event list */
466 cds_list_del(&event
->list
);
468 free(event
->filter_expression
);
476 * Cleanup kernel context structure.
478 void trace_kernel_destroy_context(struct ltt_kernel_context
*ctx
)
482 cds_list_del(&ctx
->list
);
487 * Cleanup kernel channel structure.
489 void trace_kernel_destroy_channel(struct ltt_kernel_channel
*channel
)
491 struct ltt_kernel_stream
*stream
, *stmp
;
492 struct ltt_kernel_event
*event
, *etmp
;
493 struct ltt_kernel_context
*ctx
, *ctmp
;
495 enum lttng_error_code status
;
499 DBG("[trace] Closing channel fd %d", channel
->fd
);
500 /* Close kernel fd */
501 if (channel
->fd
>= 0) {
502 ret
= close(channel
->fd
);
508 /* For each stream in the channel list */
509 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->stream_list
.head
, list
) {
510 trace_kernel_destroy_stream(stream
);
513 /* For each event in the channel list */
514 cds_list_for_each_entry_safe(event
, etmp
, &channel
->events_list
.head
, list
) {
515 trace_kernel_destroy_event(event
);
518 /* For each context in the channel list */
519 cds_list_for_each_entry_safe(ctx
, ctmp
, &channel
->ctx_list
, list
) {
520 trace_kernel_destroy_context(ctx
);
523 /* Remove from channel list */
524 cds_list_del(&channel
->list
);
526 if (notification_thread_handle
527 && channel
->published_to_notification_thread
) {
528 status
= notification_thread_command_remove_channel(
529 notification_thread_handle
,
530 channel
->fd
, LTTNG_DOMAIN_KERNEL
);
531 assert(status
== LTTNG_OK
);
533 free(channel
->channel
->attr
.extended
.ptr
);
534 free(channel
->channel
);
539 * Cleanup kernel metadata structure.
541 void trace_kernel_destroy_metadata(struct ltt_kernel_metadata
*metadata
)
545 DBG("[trace] Closing metadata fd %d", metadata
->fd
);
546 /* Close kernel fd */
547 if (metadata
->fd
>= 0) {
550 ret
= close(metadata
->fd
);
556 free(metadata
->conf
);
561 * Cleanup kernel session structure
563 * Should *NOT* be called with RCU read-side lock held.
565 void trace_kernel_destroy_session(struct ltt_kernel_session
*session
)
567 struct ltt_kernel_channel
*channel
, *ctmp
;
572 DBG("[trace] Closing session fd %d", session
->fd
);
573 /* Close kernel fds */
574 if (session
->fd
>= 0) {
575 ret
= close(session
->fd
);
581 if (session
->metadata_stream_fd
>= 0) {
582 DBG("[trace] Closing metadata stream fd %d", session
->metadata_stream_fd
);
583 ret
= close(session
->metadata_stream_fd
);
589 if (session
->metadata
!= NULL
) {
590 trace_kernel_destroy_metadata(session
->metadata
);
593 cds_list_for_each_entry_safe(channel
, ctmp
, &session
->channel_list
.head
, list
) {
594 trace_kernel_destroy_channel(channel
);
597 /* Wipe consumer output object */
598 consumer_output_put(session
->consumer
);