1 #ifndef _LTTNG_UST_ABI_H
2 #define _LTTNG_UST_ABI_H
7 * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
12 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
14 * Permission is hereby granted to use or copy this program
15 * for any purpose, provided the above notices are retained on all copies.
16 * Permission to modify the code and to distribute modified code is granted,
17 * provided the above notices are retained, and a notice that the code was
18 * modified is included with the above copyright notice.
23 #define LTTNG_UST_SYM_NAME_LEN 256
25 #define LTTNG_UST_COMM_VERSION_MAJOR 0
26 #define LTTNG_UST_COMM_VERSION_MINOR 1
28 enum lttng_ust_instrumentation
{
29 LTTNG_UST_TRACEPOINT
= 0,
31 LTTNG_UST_FUNCTION
= 2,
34 enum lttng_ust_loglevel_type
{
35 LTTNG_UST_LOGLEVEL_ALL
= 0,
36 LTTNG_UST_LOGLEVEL_RANGE
= 1,
37 LTTNG_UST_LOGLEVEL_SINGLE
= 2,
40 enum lttng_ust_output
{
44 struct lttng_ust_tracer_version
{
50 struct lttng_ust_channel
{
51 int overwrite
; /* 1: overwrite, 0: discard */
52 uint64_t subbuf_size
; /* in bytes */
54 unsigned int switch_timer_interval
; /* usecs */
55 unsigned int read_timer_interval
; /* usecs */
56 enum lttng_ust_output output
; /* output mode */
59 struct lttng_ust_stream
{
62 struct lttng_ust_event
{
63 enum lttng_ust_instrumentation instrumentation
;
64 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* event name */
66 enum lttng_ust_loglevel_type loglevel_type
;
67 int loglevel
; /* value, -1: all */
69 /* Per instrumentation type configuration */
74 enum lttng_ust_context_type
{
75 LTTNG_UST_CONTEXT_VTID
= 0,
76 LTTNG_UST_CONTEXT_VPID
= 1,
77 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
78 LTTNG_UST_CONTEXT_PROCNAME
= 3,
81 struct lttng_ust_context
{
82 enum lttng_ust_context_type ctx
;
88 * Tracer channel attributes.
90 struct lttng_ust_channel_attr
{
91 int overwrite
; /* 1: overwrite, 0: discard */
92 uint64_t subbuf_size
; /* bytes */
93 uint64_t num_subbuf
; /* power of 2 */
94 unsigned int switch_timer_interval
; /* usec */
95 unsigned int read_timer_interval
; /* usec */
96 enum lttng_ust_output output
; /* splice, mmap */
99 struct lttng_ust_tracepoint_iter
{
100 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
104 struct lttng_ust_object_data
{
108 uint64_t memory_map_size
;
111 enum lttng_ust_calibrate_type
{
112 LTTNG_UST_CALIBRATE_TRACEPOINT
,
115 struct lttng_ust_calibrate
{
116 enum lttng_ust_calibrate_type type
; /* type (input) */
119 #define _UST_CMD(minor) (minor)
120 #define _UST_CMDR(minor, type) (minor)
121 #define _UST_CMDW(minor, type) (minor)
123 /* Handled by object descriptor */
124 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
126 /* Handled by object cmd */
128 /* LTTng-UST commands */
129 #define LTTNG_UST_SESSION _UST_CMD(0x40)
130 #define LTTNG_UST_TRACER_VERSION \
131 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
132 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
133 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
134 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
136 /* Session FD commands */
137 #define LTTNG_UST_METADATA \
138 _UST_CMDW(0x50, struct lttng_ust_channel)
139 #define LTTNG_UST_CHANNEL \
140 _UST_CMDW(0x51, struct lttng_ust_channel)
141 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
142 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
144 /* Channel FD commands */
145 #define LTTNG_UST_STREAM _UST_CMD(0x60)
146 #define LTTNG_UST_EVENT \
147 _UST_CMDW(0x61, struct lttng_ust_event)
149 /* Event and Channel FD commands */
150 #define LTTNG_UST_CONTEXT \
151 _UST_CMDW(0x70, struct lttng_ust_context)
152 #define LTTNG_UST_FLUSH_BUFFER \
155 /* Event, Channel and Session commands */
156 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
157 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
159 /* Tracepoint list commands */
160 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
162 #define LTTNG_UST_ROOT_HANDLE 0
164 struct lttng_ust_obj
;
170 uint64_t *memory_map_size
;
175 uint64_t *memory_map_size
;
179 struct lttng_ust_objd_ops
{
180 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
,
181 union ust_args
*args
);
182 int (*release
)(int objd
);
185 /* Create root handle. Always ID 0. */
186 int lttng_abi_create_root_handle(void);
188 const struct lttng_ust_objd_ops
*objd_ops(int id
);
189 int lttng_ust_objd_unref(int id
);
191 void lttng_ust_abi_exit(void);
192 void lttng_ust_events_exit(void);
194 #endif /* _LTTNG_UST_ABI_H */