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"
31 * Find the channel name for the given kernel session.
33 struct ltt_kernel_channel
*trace_kernel_get_channel_by_name(
34 char *name
, struct ltt_kernel_session
*session
)
36 struct ltt_kernel_channel
*chan
;
42 * If we receive an empty string for channel name, it means the
43 * default channel name is requested.
46 name
= DEFAULT_CHANNEL_NAME
;
48 DBG("Trying to find channel %s", name
);
50 cds_list_for_each_entry(chan
, &session
->channel_list
.head
, list
) {
51 if (strcmp(name
, chan
->channel
->name
) == 0) {
52 DBG("Found channel by name %s", name
);
61 * Find the event name for the given channel.
63 struct ltt_kernel_event
*trace_kernel_get_event_by_name(
64 char *name
, struct ltt_kernel_channel
*channel
)
66 struct ltt_kernel_event
*ev
;
71 cds_list_for_each_entry(ev
, &channel
->events_list
.head
, list
) {
72 if (strcmp(name
, ev
->event
->name
) == 0) {
73 DBG("Found event by name %s for channel %s", name
,
74 channel
->channel
->name
);
83 * Allocate and initialize a kernel session data structure.
85 * Return pointer to structure or NULL.
87 struct ltt_kernel_session
*trace_kernel_create_session(void)
89 struct ltt_kernel_session
*lks
= NULL
;
91 /* Allocate a new ltt kernel session */
92 lks
= zmalloc(sizeof(struct ltt_kernel_session
));
94 PERROR("create kernel session zmalloc");
98 /* Init data structure */
100 lks
->metadata_stream_fd
= -1;
101 lks
->channel_count
= 0;
102 lks
->stream_count_global
= 0;
103 lks
->metadata
= NULL
;
104 CDS_INIT_LIST_HEAD(&lks
->channel_list
.head
);
106 lks
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
107 if (lks
->consumer
== NULL
) {
112 * The tmp_consumer stays NULL until a set_consumer_uri command is
113 * executed. At this point, the consumer should be nullify until an
114 * enable_consumer command. This assignment is symbolic since we've zmalloc
117 lks
->tmp_consumer
= NULL
;
129 * Allocate and initialize a kernel channel data structure.
131 * Return pointer to structure or NULL.
133 struct ltt_kernel_channel
*trace_kernel_create_channel(
134 struct lttng_channel
*chan
)
136 struct ltt_kernel_channel
*lkc
;
140 lkc
= zmalloc(sizeof(struct ltt_kernel_channel
));
142 PERROR("ltt_kernel_channel zmalloc");
146 lkc
->channel
= zmalloc(sizeof(struct lttng_channel
));
147 if (lkc
->channel
== NULL
) {
148 PERROR("lttng_channel zmalloc");
152 memcpy(lkc
->channel
, chan
, sizeof(struct lttng_channel
));
155 * If we receive an empty string for channel name, it means the
156 * default channel name is requested.
158 if (chan
->name
[0] == '\0') {
159 strncpy(lkc
->channel
->name
, DEFAULT_CHANNEL_NAME
,
160 sizeof(lkc
->channel
->name
));
162 lkc
->channel
->name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
165 lkc
->stream_count
= 0;
166 lkc
->event_count
= 0;
169 /* Init linked list */
170 CDS_INIT_LIST_HEAD(&lkc
->events_list
.head
);
171 CDS_INIT_LIST_HEAD(&lkc
->stream_list
.head
);
180 * Allocate and initialize a kernel event. Set name and event type.
182 * Return pointer to structure or NULL.
184 struct ltt_kernel_event
*trace_kernel_create_event(struct lttng_event
*ev
)
186 struct ltt_kernel_event
*lke
;
187 struct lttng_kernel_event
*attr
;
191 lke
= zmalloc(sizeof(struct ltt_kernel_event
));
192 attr
= zmalloc(sizeof(struct lttng_kernel_event
));
193 if (lke
== NULL
|| attr
== NULL
) {
194 PERROR("kernel event zmalloc");
199 case LTTNG_EVENT_PROBE
:
200 attr
->instrumentation
= LTTNG_KERNEL_KPROBE
;
201 attr
->u
.kprobe
.addr
= ev
->attr
.probe
.addr
;
202 attr
->u
.kprobe
.offset
= ev
->attr
.probe
.offset
;
203 strncpy(attr
->u
.kprobe
.symbol_name
,
204 ev
->attr
.probe
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
205 attr
->u
.kprobe
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
207 case LTTNG_EVENT_FUNCTION
:
208 attr
->instrumentation
= LTTNG_KERNEL_KRETPROBE
;
209 attr
->u
.kretprobe
.addr
= ev
->attr
.probe
.addr
;
210 attr
->u
.kretprobe
.offset
= ev
->attr
.probe
.offset
;
211 strncpy(attr
->u
.kretprobe
.symbol_name
,
212 ev
->attr
.probe
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
213 attr
->u
.kretprobe
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
215 case LTTNG_EVENT_FUNCTION_ENTRY
:
216 attr
->instrumentation
= LTTNG_KERNEL_FUNCTION
;
217 strncpy(attr
->u
.ftrace
.symbol_name
,
218 ev
->attr
.ftrace
.symbol_name
, LTTNG_KERNEL_SYM_NAME_LEN
);
219 attr
->u
.ftrace
.symbol_name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
221 case LTTNG_EVENT_TRACEPOINT
:
222 attr
->instrumentation
= LTTNG_KERNEL_TRACEPOINT
;
224 case LTTNG_EVENT_SYSCALL
:
225 attr
->instrumentation
= LTTNG_KERNEL_SYSCALL
;
227 case LTTNG_EVENT_ALL
:
228 attr
->instrumentation
= LTTNG_KERNEL_ALL
;
231 ERR("Unknown kernel instrumentation type (%d)", ev
->type
);
235 /* Copy event name */
236 strncpy(attr
->name
, ev
->name
, LTTNG_KERNEL_SYM_NAME_LEN
);
237 attr
->name
[LTTNG_KERNEL_SYM_NAME_LEN
- 1] = '\0';
239 /* Setting up a kernel event */
253 * Allocate and initialize a kernel metadata.
255 * Return pointer to structure or NULL.
257 struct ltt_kernel_metadata
*trace_kernel_create_metadata(void)
259 struct ltt_kernel_metadata
*lkm
;
260 struct lttng_channel
*chan
;
262 lkm
= zmalloc(sizeof(struct ltt_kernel_metadata
));
263 chan
= zmalloc(sizeof(struct lttng_channel
));
264 if (lkm
== NULL
|| chan
== NULL
) {
265 PERROR("kernel metadata zmalloc");
269 /* Set default attributes */
270 chan
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
271 chan
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
272 chan
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
273 chan
->attr
.switch_timer_interval
= DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
274 chan
->attr
.read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
275 chan
->attr
.output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
290 * Allocate and initialize a kernel stream. The stream is set to ACTIVE_FD by
293 * Return pointer to structure or NULL.
295 struct ltt_kernel_stream
*trace_kernel_create_stream(const char *name
,
299 struct ltt_kernel_stream
*lks
;
303 lks
= zmalloc(sizeof(struct ltt_kernel_stream
));
305 PERROR("kernel stream zmalloc");
310 ret
= snprintf(lks
->name
, sizeof(lks
->name
), "%s_%d", name
, count
);
312 PERROR("snprintf stream name");
315 lks
->name
[sizeof(lks
->name
) - 1] = '\0';
329 * Cleanup kernel stream structure.
331 void trace_kernel_destroy_stream(struct ltt_kernel_stream
*stream
)
335 DBG("[trace] Closing stream fd %d", stream
->fd
);
336 /* Close kernel fd */
337 if (stream
->fd
>= 0) {
340 ret
= close(stream
->fd
);
345 /* Remove from stream list */
346 cds_list_del(&stream
->list
);
352 * Cleanup kernel event structure.
354 void trace_kernel_destroy_event(struct ltt_kernel_event
*event
)
358 if (event
->fd
>= 0) {
361 DBG("[trace] Closing event fd %d", event
->fd
);
362 /* Close kernel fd */
363 ret
= close(event
->fd
);
368 DBG("[trace] Tearing down event (no associated fd)");
371 /* Remove from event list */
372 cds_list_del(&event
->list
);
379 * Cleanup kernel channel structure.
381 void trace_kernel_destroy_channel(struct ltt_kernel_channel
*channel
)
383 struct ltt_kernel_stream
*stream
, *stmp
;
384 struct ltt_kernel_event
*event
, *etmp
;
389 DBG("[trace] Closing channel fd %d", channel
->fd
);
390 /* Close kernel fd */
391 if (channel
->fd
>= 0) {
392 ret
= close(channel
->fd
);
398 /* For each stream in the channel list */
399 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->stream_list
.head
, list
) {
400 trace_kernel_destroy_stream(stream
);
403 /* For each event in the channel list */
404 cds_list_for_each_entry_safe(event
, etmp
, &channel
->events_list
.head
, list
) {
405 trace_kernel_destroy_event(event
);
408 /* Remove from channel list */
409 cds_list_del(&channel
->list
);
411 free(channel
->channel
);
417 * Cleanup kernel metadata structure.
419 void trace_kernel_destroy_metadata(struct ltt_kernel_metadata
*metadata
)
423 DBG("[trace] Closing metadata fd %d", metadata
->fd
);
424 /* Close kernel fd */
425 if (metadata
->fd
>= 0) {
428 ret
= close(metadata
->fd
);
434 free(metadata
->conf
);
439 * Cleanup kernel session structure
441 * Should *NOT* be called with RCU read-side lock held.
443 void trace_kernel_destroy_session(struct ltt_kernel_session
*session
)
445 struct ltt_kernel_channel
*channel
, *ctmp
;
450 DBG("[trace] Closing session fd %d", session
->fd
);
451 /* Close kernel fds */
452 if (session
->fd
>= 0) {
453 ret
= close(session
->fd
);
459 if (session
->metadata_stream_fd
>= 0) {
460 DBG("[trace] Closing metadata stream fd %d", session
->metadata_stream_fd
);
461 ret
= close(session
->metadata_stream_fd
);
467 if (session
->metadata
!= NULL
) {
468 trace_kernel_destroy_metadata(session
->metadata
);
471 cds_list_for_each_entry_safe(channel
, ctmp
, &session
->channel_list
.head
, list
) {
472 trace_kernel_destroy_channel(channel
);
475 /* Wipe consumer output object */
476 consumer_destroy_output(session
->consumer
);
477 consumer_destroy_output(session
->tmp_consumer
);