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,
32 LTTNG_UST_TRACEPOINT_LOGLEVEL
= 3,
35 enum lttng_ust_output
{
39 struct lttng_ust_tracer_version
{
45 struct lttng_ust_channel
{
46 int overwrite
; /* 1: overwrite, 0: discard */
47 uint64_t subbuf_size
; /* in bytes */
49 unsigned int switch_timer_interval
; /* usecs */
50 unsigned int read_timer_interval
; /* usecs */
51 enum lttng_ust_output output
; /* output mode */
52 /* The following fields are used internally within UST. */
55 uint64_t memory_map_size
;
59 * This structure is only used internally within UST. It is not per-se
60 * part of the communication between sessiond and UST.
62 struct lttng_ust_stream
{
65 uint64_t memory_map_size
;
68 struct lttng_ust_event
{
69 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* event name */
70 enum lttng_ust_instrumentation instrumentation
;
71 /* Per instrumentation type configuration */
76 enum lttng_ust_context_type
{
77 LTTNG_UST_CONTEXT_VTID
= 0,
78 LTTNG_UST_CONTEXT_VPID
= 1,
79 LTTNG_UST_CONTEXT_PTHREAD_ID
= 2,
80 LTTNG_UST_CONTEXT_PROCNAME
= 3,
83 struct lttng_ust_context
{
84 enum lttng_ust_context_type ctx
;
90 * Tracer channel attributes.
92 struct lttng_ust_channel_attr
{
93 int overwrite
; /* 1: overwrite, 0: discard */
94 uint64_t subbuf_size
; /* bytes */
95 uint64_t num_subbuf
; /* power of 2 */
96 unsigned int switch_timer_interval
; /* usec */
97 unsigned int read_timer_interval
; /* usec */
98 enum lttng_ust_output output
; /* splice, mmap */
101 struct lttng_ust_tracepoint_iter
{
102 char name
[LTTNG_UST_SYM_NAME_LEN
]; /* provider:name */
103 char loglevel
[LTTNG_UST_SYM_NAME_LEN
]; /* loglevel */
104 int64_t loglevel_value
;
107 struct lttng_ust_object_data
{
111 uint64_t memory_map_size
;
114 #define _UST_CMD(minor) (minor)
115 #define _UST_CMDR(minor, type) (minor)
116 #define _UST_CMDW(minor, type) (minor)
118 /* Handled by object descriptor */
119 #define LTTNG_UST_RELEASE _UST_CMD(0x1)
121 /* Handled by object cmd */
123 /* LTTng-UST commands */
124 #define LTTNG_UST_SESSION _UST_CMD(0x40)
125 #define LTTNG_UST_TRACER_VERSION \
126 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
127 #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
128 #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
129 #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
131 /* Session FD commands */
132 #define LTTNG_UST_METADATA \
133 _UST_CMDW(0x50, struct lttng_ust_channel)
134 #define LTTNG_UST_CHANNEL \
135 _UST_CMDW(0x51, struct lttng_ust_channel)
136 #define LTTNG_UST_SESSION_START _UST_CMD(0x52)
137 #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
139 /* Channel FD commands */
140 #define LTTNG_UST_STREAM _UST_CMD(0x60)
141 #define LTTNG_UST_EVENT \
142 _UST_CMDW(0x61, struct lttng_ust_event)
144 /* Event and Channel FD commands */
145 #define LTTNG_UST_CONTEXT \
146 _UST_CMDW(0x70, struct lttng_ust_context)
147 #define LTTNG_UST_FLUSH_BUFFER \
150 /* Event, Channel and Session commands */
151 #define LTTNG_UST_ENABLE _UST_CMD(0x80)
152 #define LTTNG_UST_DISABLE _UST_CMD(0x81)
154 /* Tracepoint list commands */
155 #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
157 #define LTTNG_UST_ROOT_HANDLE 0
159 struct lttng_ust_obj
;
161 struct lttng_ust_objd_ops
{
162 long (*cmd
)(int objd
, unsigned int cmd
, unsigned long arg
);
163 int (*release
)(int objd
);
166 /* Create root handle. Always ID 0. */
167 int lttng_abi_create_root_handle(void);
169 const struct lttng_ust_objd_ops
*objd_ops(int id
);
170 int lttng_ust_objd_unref(int id
);
172 void lttng_ust_abi_exit(void);
173 void lttng_ust_events_exit(void);
175 #endif /* _LTTNG_UST_ABI_H */