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.
25 #include <common/common.h>
26 #include <common/defaults.h>
29 #include "trace-kernel.h"
32 * Find the channel name for the given kernel session.
34 struct ltt_kernel_channel
*trace_kernel_get_channel_by_name(
35 char *name
, struct ltt_kernel_session
*session
)
37 struct ltt_kernel_channel
*chan
;
43 * If we receive an empty string for channel name, it means the
44 * default channel name is requested.
47 name
= DEFAULT_CHANNEL_NAME
;
49 DBG("Trying to find channel %s", name
);
51 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
52 if (strcmp(name
, chan
->channel
->name
) == 0) {
53 DBG("Found channel by name %s", name
);
62 * Find the event for the given channel.
64 struct ltt_kernel_event
*trace_kernel_find_event(
65 char *name
, struct ltt_kernel_channel
*channel
,
66 enum lttng_event_type type
,
67 struct lttng_filter_bytecode
*filter
)
69 struct ltt_kernel_event
*ev
;
75 cds_list_for_each_entry(ev
, &channel
->events_list
.head
, list
) {
76 if (type
!= LTTNG_EVENT_ALL
&& ev
->type
!= type
) {
79 if (strcmp(name
, ev
->event
->name
)) {
82 if ((ev
->filter
&& !filter
) || (!ev
->filter
&& filter
)) {
85 if (ev
->filter
&& filter
) {
86 if (ev
->filter
->len
!= filter
->len
||
87 memcmp(ev
->filter
->data
, filter
->data
,
96 DBG("Found event %s for channel %s", name
,
97 channel
->channel
->name
);
105 * Find the event name for the given channel.
107 struct ltt_kernel_event
*trace_kernel_get_event_by_name(
108 char *name
, struct ltt_kernel_channel
*channel
,
109 enum lttng_event_type type
)
111 struct ltt_kernel_event
*ev
;
117 cds_list_for_each_entry(ev
, &channel
->events_list
.head
, list
) {
118 if (type
!= LTTNG_EVENT_ALL
&& ev
->type
!= type
) {
121 if (strcmp(name
, ev
->event
->name
)) {
128 DBG("Found event %s for channel %s", name
,
129 channel
->channel
->name
);
137 * Allocate and initialize a kernel session data structure.
139 * Return pointer to structure or NULL.
141 struct ltt_kernel_session
*trace_kernel_create_session(void)
143 struct ltt_kernel_session
*lks
= NULL
;
145 /* Allocate a new ltt kernel session */
146 lks
= zmalloc(sizeof(struct ltt_kernel_session
));
148 PERROR("create kernel session zmalloc");
152 /* Init data structure */
154 lks
->metadata_stream_fd
= -1;
155 lks
->channel_count
= 0;
156 lks
->stream_count_global
= 0;
157 lks
->metadata
= NULL
;
158 CDS_INIT_LIST_HEAD(&lks
->channel_list
.head
);
160 lks
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
161 if (lks
->consumer
== NULL
) {
175 * Allocate and initialize a kernel channel data structure.
177 * Return pointer to structure or NULL.
179 struct ltt_kernel_channel
*trace_kernel_create_channel(
180 struct lttng_channel
*chan
)
182 struct ltt_kernel_channel
*lkc
;
186 lkc
= zmalloc(sizeof(struct ltt_kernel_channel
));
188 PERROR("ltt_kernel_channel zmalloc");
192 lkc
->channel
= zmalloc(sizeof(struct lttng_channel
));
193 if (lkc
->channel
== NULL
) {
194 PERROR("lttng_channel zmalloc");
198 memcpy(lkc
->channel
, chan
, sizeof(struct lttng_channel
));
201 * If we receive an empty string for channel name, it means the
202 * default channel name is requested.
204 if (chan
->name
[0] == '\0') {
205 strncpy(lkc
->channel
->name
, DEFAULT_CHANNEL_NAME
,
206 sizeof(lkc
->channel
->name
));
208 lkc
->channel
->name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
211 lkc
->stream_count
= 0;
212 lkc
->event_count
= 0;
214 /* Init linked list */
215 CDS_INIT_LIST_HEAD(&lkc
->events_list
.head
);
216 CDS_INIT_LIST_HEAD(&lkc
->stream_list
.head
);
217 CDS_INIT_LIST_HEAD(&lkc
->ctx_list
);
226 * Allocate and init a kernel context object.
228 * Return the allocated object or NULL on error.
230 struct ltt_kernel_context
*trace_kernel_create_context(
231 struct lttng_kernel_context
*ctx
)
233 struct ltt_kernel_context
*kctx
;
235 kctx
= zmalloc(sizeof(*kctx
));
237 PERROR("zmalloc kernel context");
242 memcpy(&kctx
->ctx
, ctx
, sizeof(kctx
->ctx
));
245 CDS_INIT_LIST_HEAD(&kctx
->list
);
252 * Allocate and initialize a kernel event. Set name and event type.
253 * We own filter_expression, and filter.
255 * Return pointer to structure or NULL.
257 struct ltt_kernel_event
*trace_kernel_create_event(struct lttng_event
*ev
,
258 char *filter_expression
, struct lttng_filter_bytecode
*filter
)
260 struct ltt_kernel_event
*lke
;
261 struct lttng_kernel_event
*attr
;
265 lke
= zmalloc(sizeof(struct ltt_kernel_event
));
266 attr
= zmalloc(sizeof(struct lttng_kernel_event
));
267 if (lke
== NULL
|| attr
== NULL
) {
268 PERROR("kernel event zmalloc");
273 case LTTNG_EVENT_PROBE
:
274 attr
->instrumentation
= LTTNG_KERNEL_KPROBE
;
275 attr
->u
.kprobe
.addr
= ev
->attr
.probe
.addr
;
276 attr
->u
.kprobe
.offset
= ev
->attr
.probe
.offset
;
277 strncpy(attr
->u
.kprobe
.symbol_name
,
278 ev
->attr
.probe
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
279 attr
->u
.kprobe
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
281 case LTTNG_EVENT_FUNCTION
:
282 attr
->instrumentation
= LTTNG_KERNEL_KRETPROBE
;
283 attr
->u
.kretprobe
.addr
= ev
->attr
.probe
.addr
;
284 attr
->u
.kretprobe
.offset
= ev
->attr
.probe
.offset
;
285 strncpy(attr
->u
.kretprobe
.symbol_name
,
286 ev
->attr
.probe
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
287 attr
->u
.kretprobe
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
289 case LTTNG_EVENT_FUNCTION_ENTRY
:
290 attr
->instrumentation
= LTTNG_KERNEL_FUNCTION
;
291 strncpy(attr
->u
.ftrace
.symbol_name
,
292 ev
->attr
.ftrace
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
293 attr
->u
.ftrace
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
295 case LTTNG_EVENT_TRACEPOINT
:
296 attr
->instrumentation
= LTTNG_KERNEL_TRACEPOINT
;
298 case LTTNG_EVENT_SYSCALL
:
299 attr
->instrumentation
= LTTNG_KERNEL_SYSCALL
;
301 case LTTNG_EVENT_ALL
:
302 attr
->instrumentation
= LTTNG_KERNEL_ALL
;
305 ERR("Unknown kernel instrumentation type (%d)", ev
->type
);
309 /* Copy event name */
310 strncpy(attr
->name
, ev
->name
, LTTNG_KERNEL_SYM_NAME_LEN
);
311 attr
->name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
313 /* Setting up a kernel event */
317 lke
->filter_expression
= filter_expression
;
318 lke
->filter
= filter
;
323 free(filter_expression
);
331 * Allocate and initialize a kernel metadata.
333 * Return pointer to structure or NULL.
335 struct ltt_kernel_metadata
*trace_kernel_create_metadata(void)
337 struct ltt_kernel_metadata
*lkm
;
338 struct lttng_channel
*chan
;
340 lkm
= zmalloc(sizeof(struct ltt_kernel_metadata
));
341 chan
= zmalloc(sizeof(struct lttng_channel
));
342 if (lkm
== NULL
|| chan
== NULL
) {
343 PERROR("kernel metadata zmalloc");
347 /* Set default attributes */
348 chan
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
349 chan
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
350 chan
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
351 chan
->attr
.switch_timer_interval
= DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
352 chan
->attr
.read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
353 chan
->attr
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
368 * Allocate and initialize a kernel stream. The stream is set to ACTIVE_FD by
371 * Return pointer to structure or NULL.
373 struct ltt_kernel_stream
*trace_kernel_create_stream(const char *name
,
377 struct ltt_kernel_stream
*lks
;
381 lks
= zmalloc(sizeof(struct ltt_kernel_stream
));
383 PERROR("kernel stream zmalloc");
388 ret
= snprintf(lks
->name
, sizeof(lks
->name
), "%s_%u", name
, count
);
390 PERROR("snprintf stream name");
393 lks
->name
[sizeof(lks
->name
) - 1] = '\0';
407 * Cleanup kernel stream structure.
409 void trace_kernel_destroy_stream(struct ltt_kernel_stream
*stream
)
413 DBG("[trace] Closing stream fd %d", stream
->fd
);
414 /* Close kernel fd */
415 if (stream
->fd
>= 0) {
418 ret
= close(stream
->fd
);
423 /* Remove from stream list */
424 cds_list_del(&stream
->list
);
430 * Cleanup kernel event structure.
432 void trace_kernel_destroy_event(struct ltt_kernel_event
*event
)
436 if (event
->fd
>= 0) {
439 DBG("[trace] Closing event fd %d", event
->fd
);
440 /* Close kernel fd */
441 ret
= close(event
->fd
);
446 DBG("[trace] Tearing down event (no associated fd)");
449 /* Remove from event list */
450 cds_list_del(&event
->list
);
452 free(event
->filter_expression
);
460 * Cleanup kernel context structure.
462 void trace_kernel_destroy_context(struct ltt_kernel_context
*ctx
)
466 cds_list_del(&ctx
->list
);
471 * Cleanup kernel channel structure.
473 void trace_kernel_destroy_channel(struct ltt_kernel_channel
*channel
)
475 struct ltt_kernel_stream
*stream
, *stmp
;
476 struct ltt_kernel_event
*event
, *etmp
;
477 struct ltt_kernel_context
*ctx
, *ctmp
;
482 DBG("[trace] Closing channel fd %d", channel
->fd
);
483 /* Close kernel fd */
484 if (channel
->fd
>= 0) {
485 ret
= close(channel
->fd
);
491 /* For each stream in the channel list */
492 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->stream_list
.head
, list
) {
493 trace_kernel_destroy_stream(stream
);
496 /* For each event in the channel list */
497 cds_list_for_each_entry_safe(event
, etmp
, &channel
->events_list
.head
, list
) {
498 trace_kernel_destroy_event(event
);
501 /* For each context in the channel list */
502 cds_list_for_each_entry_safe(ctx
, ctmp
, &channel
->ctx_list
, list
) {
503 trace_kernel_destroy_context(ctx
);
506 /* Remove from channel list */
507 cds_list_del(&channel
->list
);
509 free(channel
->channel
);
514 * Cleanup kernel metadata structure.
516 void trace_kernel_destroy_metadata(struct ltt_kernel_metadata
*metadata
)
520 DBG("[trace] Closing metadata fd %d", metadata
->fd
);
521 /* Close kernel fd */
522 if (metadata
->fd
>= 0) {
525 ret
= close(metadata
->fd
);
531 free(metadata
->conf
);
536 * Cleanup kernel session structure
538 * Should *NOT* be called with RCU read-side lock held.
540 void trace_kernel_destroy_session(struct ltt_kernel_session
*session
)
542 struct ltt_kernel_channel
*channel
, *ctmp
;
547 DBG("[trace] Closing session fd %d", session
->fd
);
548 /* Close kernel fds */
549 if (session
->fd
>= 0) {
550 ret
= close(session
->fd
);
556 if (session
->metadata_stream_fd
>= 0) {
557 DBG("[trace] Closing metadata stream fd %d", session
->metadata_stream_fd
);
558 ret
= close(session
->metadata_stream_fd
);
564 if (session
->metadata
!= NULL
) {
565 trace_kernel_destroy_metadata(session
->metadata
);
568 cds_list_for_each_entry_safe(channel
, ctmp
, &session
->channel_list
.head
, list
) {
569 trace_kernel_destroy_channel(channel
);
572 /* Wipe consumer output object */
573 consumer_output_put(session
->consumer
);