4 * Linux Trace Toolkit Control Library Header File
6 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <asm/types.h>
30 /* Default unix group name for tracing. */
31 #define LTTNG_DEFAULT_TRACING_GROUP "tracing"
33 /* Environment variable to set session daemon binary path. */
34 #define LTTNG_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
37 * Event symbol length.
39 #define LTTNG_SYMBOL_NAME_LEN 128
41 enum lttng_event_type
{
42 LTTNG_EVENT_TRACEPOINTS
,
47 /* Kernel context possible type */
48 enum lttng_kernel_context_type
{
49 LTTNG_KERNEL_CONTEXT_PID
= 0,
50 LTTNG_KERNEL_CONTEXT_PERF_COUNTER
= 1,
51 LTTNG_KERNEL_CONTEXT_COMM
= 2,
52 LTTNG_KERNEL_CONTEXT_PRIO
= 3,
53 LTTNG_KERNEL_CONTEXT_NICE
= 4,
54 LTTNG_KERNEL_CONTEXT_VPID
= 5,
55 LTTNG_KERNEL_CONTEXT_TID
= 6,
56 LTTNG_KERNEL_CONTEXT_VTID
= 7,
57 LTTNG_KERNEL_CONTEXT_PPID
= 8,
58 LTTNG_KERNEL_CONTEXT_VPPID
= 9,
61 /* Perf counter attributes */
62 struct lttng_kernel_perf_counter_ctx
{
65 char name
[LTTNG_SYMBOL_NAME_LEN
];
68 /* Event/Channel context */
69 struct lttng_kernel_context
{
70 enum lttng_kernel_context_type ctx
;
72 struct lttng_kernel_perf_counter_ctx perf_counter
;
77 * Either addr is used or symbol_name and offset.
79 struct lttng_event_kprobe_attr
{
83 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
89 struct lttng_event_function_attr
{
90 char symbol_name
[LTTNG_SYMBOL_NAME_LEN
];
97 char name
[LTTNG_SYMBOL_NAME_LEN
];
98 enum lttng_event_type type
;
99 /* Per event type configuration */
101 struct lttng_event_kprobe_attr kprobe
;
102 struct lttng_event_function_attr ftrace
;
106 /* Tracer channel attributes */
107 struct lttng_channel_attr
{
108 int overwrite
; /* 1: overwrite, 0: discard */
109 uint64_t subbuf_size
; /* bytes */
110 uint64_t num_subbuf
; /* power of 2 */
111 unsigned int switch_timer_interval
; /* usec */
112 unsigned int read_timer_interval
; /* usec */
116 * Basic session information.
118 struct lttng_session
{
123 /* Channel information structure */
124 struct lttng_channel
{
126 struct lttng_channel_attr attr
;
130 * Session daemon control
132 extern int lttng_connect_sessiond(void);
134 extern int lttng_create_session(char *name
, char *path
);
136 extern int lttng_destroy_session(char *name
);
138 extern int lttng_disconnect_sessiond(void);
140 /* Return an allocated array of lttng_session */
141 extern int lttng_list_sessions(struct lttng_session
**sessions
);
143 extern int lttng_session_daemon_alive(void);
145 /* Set tracing group for the current execution */
146 extern int lttng_set_tracing_group(const char *name
);
148 extern void lttng_set_session_name(char *name
);
150 extern const char *lttng_get_readable_code(int code
);
152 extern int lttng_start_tracing(char *session_name
);
154 extern int lttng_stop_tracing(char *session_name
);
156 //extern int lttng_ust_list_traceable_apps(pid_t **pids);
159 * LTTng Kernel tracer control
161 extern int lttng_kernel_add_context(struct lttng_kernel_context
*ctx
,
162 char *event_name
, char *channel_name
);
164 extern int lttng_kernel_create_channel(struct lttng_channel
*chan
);
166 extern int lttng_kernel_enable_event(struct lttng_event
*ev
, char *channel_name
);
168 extern int lttng_kernel_enable_channel(char *name
);
170 extern int lttng_kernel_disable_event(char *name
, char *channel_name
);
172 extern int lttng_kernel_disable_channel(char *name
);
174 extern int lttng_kernel_list_events(char **event_list
);
177 * LTTng User-space tracer control
180 #endif /* _LTTNG_H */