1 #ifndef _LTTNG_UST_ABI_H
2 #define _LTTNG_UST_ABI_H
9 * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
24 #define LTTNG_UST_SYM_NAME_LEN 256
26 #define LTTNG_UST_COMM_VERSION_MAJOR 2
27 #define LTTNG_UST_COMM_VERSION_MINOR 0
29 enum lttng_ust_instrumentation
{
30 LTTNG_UST_TRACEPOINT
= 0,
32 LTTNG_UST_FUNCTION
= 2,
35 enum lttng_ust_loglevel_type
{
36 LTTNG_UST_LOGLEVEL_ALL
= 0,
37 LTTNG_UST_LOGLEVEL_RANGE
= 1,
38 LTTNG_UST_LOGLEVEL_SINGLE
= 2,
41 enum lttng_ust_output
{
45 struct lttng_ust_tracer_version
{
51 #define LTTNG_UST_CHANNEL_PADDING LTTNG_UST_SYM_NAME_LEN + 32
52 struct lttng_ust_channel
{
53 int overwrite
; /* 1: overwrite, 0: discard */
54 uint64_t subbuf_size
; /* in bytes */
56 unsigned int switch_timer_interval
; /* usecs */
57 unsigned int read_timer_interval
; /* usecs */
58 enum lttng_ust_output output
; /* output mode */
59 char padding
[LTTNG_UST_CHANNEL_PADDING
];
62 #define LTTNG_UST_STREAM_PADDING1 16
63 #define LTTNG_UST_STREAM_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
64 struct lttng_ust_stream
{
65 char padding
[LTTNG_UST_STREAM_PADDING1
];
68 char padding
[LTTNG_UST_STREAM_PADDING2
];
72 #define LTTNG_UST_EVENT_PADDING1 16
73 #define LTTNG_UST_EVENT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
74 struct lttng_ust_event
{
75 enum lttng_ust_instrumentation instrumentation
;
76 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* event name */
78 enum lttng_ust_loglevel_type loglevel_type
;
79 int loglevel
; /* value, -1: all */
80 char padding
[LTTNG_UST_EVENT_PADDING1
];
82 /* Per instrumentation type configuration */
84 char padding
[LTTNG_UST_EVENT_PADDING2
];
88 enum lttng_ust_field_type
{
89 LTTNG_UST_FIELD_OTHER
= 0,
90 LTTNG_UST_FIELD_INTEGER
= 1,
91 LTTNG_UST_FIELD_ENUM
= 2,
92 LTTNG_UST_FIELD_FLOAT
= 3,
93 LTTNG_UST_FIELD_STRING
= 4,
96 #define LTTNG_UST_FIELD_ITER_PADDING LTTNG_UST_SYM_NAME_LEN + 32
97 struct lttng_ust_field_iter
{
98 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
99 char field_name
[LTTNG_UST_SYM_NAME_LEN
];
100 enum lttng_ust_field_type type
;
101 int loglevel
; /* event loglevel */
102 char padding
[LTTNG_UST_FIELD_ITER_PADDING
];
105 enum lttng_ust_context_type
{
106 LTTNG_UST_CONTEXT_VTID
= 0,
107 LTTNG_UST_CONTEXT_VPID
= 1,
108 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
109 LTTNG_UST_CONTEXT_PROCNAME
= 3,
112 #define LTTNG_UST_CONTEXT_PADDING1 16
113 #define LTTNG_UST_CONTEXT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
114 struct lttng_ust_context
{
115 enum lttng_ust_context_type ctx
;
116 char padding
[LTTNG_UST_CONTEXT_PADDING1
];
119 char padding
[LTTNG_UST_CONTEXT_PADDING2
];
124 * Tracer channel attributes.
126 #define LTTNG_UST_CHANNEL_ATTR_PADDING LTTNG_UST_SYM_NAME_LEN + 32
127 struct lttng_ust_channel_attr
{
128 int overwrite
; /* 1: overwrite, 0: discard */
129 uint64_t subbuf_size
; /* bytes */
130 uint64_t num_subbuf
; /* power of 2 */
131 unsigned int switch_timer_interval
; /* usec */
132 unsigned int read_timer_interval
; /* usec */
133 enum lttng_ust_output output
; /* splice, mmap */
134 char padding
[LTTNG_UST_CHANNEL_ATTR_PADDING
];
137 #define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
138 struct lttng_ust_tracepoint_iter
{
139 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
141 char padding
[LTTNG_UST_TRACEPOINT_ITER_PADDING
];
144 #define LTTNG_UST_OBJECT_DATA_PADDING LTTNG_UST_SYM_NAME_LEN + 32
145 struct lttng_ust_object_data
{
149 uint64_t memory_map_size
;
150 char padding
[LTTNG_UST_OBJECT_DATA_PADDING
];
153 enum lttng_ust_calibrate_type
{
154 LTTNG_UST_CALIBRATE_TRACEPOINT
,
157 #define LTTNG_UST_CALIBRATE_PADDING1 16
158 #define LTTNG_UST_CALIBRATE_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
159 struct lttng_ust_calibrate
{
160 enum lttng_ust_calibrate_type type
; /* type (input) */
161 char padding
[LTTNG_UST_CALIBRATE_PADDING1
];
164 char padding
[LTTNG_UST_CALIBRATE_PADDING2
];
168 #define FILTER_BYTECODE_MAX_LEN 65535
169 struct lttng_ust_filter_bytecode
{
171 uint16_t reloc_offset
;
175 #define _UST_CMD(minor) (minor)
176 #define _UST_CMDR(minor, type) (minor)
177 #define _UST_CMDW(minor, type) (minor)
179 /* Handled by object descriptor */
180 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
182 /* Handled by object cmd */
184 /* LTTng-UST commands */
185 #define LTTNG_UST_SESSION _UST_CMD(0x40)
186 #define LTTNG_UST_TRACER_VERSION \
187 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
188 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
189 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
190 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
191 #define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
193 /* Session FD commands */
194 #define LTTNG_UST_METADATA \
195 _UST_CMDW(0x50, struct lttng_ust_channel)
196 #define LTTNG_UST_CHANNEL \
197 _UST_CMDW(0x51, struct lttng_ust_channel)
198 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
199 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
201 /* Channel FD commands */
202 #define LTTNG_UST_STREAM _UST_CMD(0x60)
203 #define LTTNG_UST_EVENT \
204 _UST_CMDW(0x61, struct lttng_ust_event)
206 /* Event and Channel FD commands */
207 #define LTTNG_UST_CONTEXT \
208 _UST_CMDW(0x70, struct lttng_ust_context)
209 #define LTTNG_UST_FLUSH_BUFFER \
212 /* Event, Channel and Session commands */
213 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
214 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
216 /* Tracepoint list commands */
217 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
218 #define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
220 /* Event FD commands */
221 #define LTTNG_UST_FILTER _UST_CMD(0xA0)
223 #define LTTNG_UST_ROOT_HANDLE 0
225 struct lttng_ust_obj
;
231 uint64_t *memory_map_size
;
236 uint64_t *memory_map_size
;
239 struct lttng_ust_field_iter entry
;
243 struct lttng_ust_objd_ops
{
244 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
,
245 union ust_args
*args
);
246 int (*release
)(int objd
);
249 /* Create root handle. Always ID 0. */
250 int lttng_abi_create_root_handle(void);
252 const struct lttng_ust_objd_ops
*objd_ops(int id
);
253 int lttng_ust_objd_unref(int id
);
255 void lttng_ust_abi_exit(void);
256 void lttng_ust_events_exit(void);
258 #endif /* _LTTNG_UST_ABI_H */