Update lttng-ust header copy for disabled UST compilation
[lttng-tools.git] / src / bin / lttng-sessiond / lttng-ust-abi.h
CommitLineData
3bd1e081
MD
1#ifndef _LTTNG_UST_ABI_H
2#define _LTTNG_UST_ABI_H
3
4/*
9df8df5e 5 * lttng/ust-abi.h
3bd1e081
MD
6 *
7 * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * LTTng-UST ABI header
10 *
3f3c65dc
MD
11 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
12 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
13 *
bf74a86d
AM
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this software and associated documentation files (the "Software"), to deal
16 * in the Software without restriction, including without limitation the rights
17 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
18 * copies of the Software, and to permit persons to whom the Software is
19 * furnished to do so, subject to the following conditions:
20 *
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
3bd1e081
MD
23 */
24
25#include <stdint.h>
26
57ab7638 27#define LTTNG_UST_SYM_NAME_LEN 256
3bd1e081 28
3f3c65dc
MD
29#define LTTNG_UST_COMM_VERSION_MAJOR 2
30#define LTTNG_UST_COMM_VERSION_MINOR 0
3bd1e081
MD
31
32enum lttng_ust_instrumentation {
177f8533
MD
33 LTTNG_UST_TRACEPOINT = 0,
34 LTTNG_UST_PROBE = 1,
35 LTTNG_UST_FUNCTION = 2,
0cda4f28
MD
36};
37
38enum lttng_ust_loglevel_type {
8005f29a
MD
39 LTTNG_UST_LOGLEVEL_ALL = 0,
40 LTTNG_UST_LOGLEVEL_RANGE = 1,
41 LTTNG_UST_LOGLEVEL_SINGLE = 2,
3bd1e081
MD
42};
43
44enum lttng_ust_output {
45 LTTNG_UST_MMAP = 0,
46};
47
48struct lttng_ust_tracer_version {
3f3c65dc
MD
49 uint32_t major;
50 uint32_t minor;
3bd1e081 51 uint32_t patchlevel;
3bd1e081
MD
52};
53
3f3c65dc 54#define LTTNG_UST_CHANNEL_PADDING LTTNG_UST_SYM_NAME_LEN + 32
3bd1e081
MD
55struct lttng_ust_channel {
56 int overwrite; /* 1: overwrite, 0: discard */
57 uint64_t subbuf_size; /* in bytes */
58 uint64_t num_subbuf;
59 unsigned int switch_timer_interval; /* usecs */
60 unsigned int read_timer_interval; /* usecs */
61 enum lttng_ust_output output; /* output mode */
3f3c65dc
MD
62 char padding[LTTNG_UST_CHANNEL_PADDING];
63};
64
65#define LTTNG_UST_STREAM_PADDING1 16
66#define LTTNG_UST_STREAM_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
67struct lttng_ust_stream {
68 char padding[LTTNG_UST_STREAM_PADDING1];
69
70 union {
71 char padding[LTTNG_UST_STREAM_PADDING2];
72 } u;
3bd1e081
MD
73};
74
3f3c65dc
MD
75#define LTTNG_UST_EVENT_PADDING1 16
76#define LTTNG_UST_EVENT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
3bd1e081 77struct lttng_ust_event {
69892bbb 78 enum lttng_ust_instrumentation instrumentation;
0cda4f28
MD
79 char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
80
81 enum lttng_ust_loglevel_type loglevel_type;
8005f29a 82 int loglevel; /* value, -1: all */
3f3c65dc 83 char padding[LTTNG_UST_EVENT_PADDING1];
0cda4f28 84
3bd1e081
MD
85 /* Per instrumentation type configuration */
86 union {
3f3c65dc 87 char padding[LTTNG_UST_EVENT_PADDING2];
3bd1e081
MD
88 } u;
89};
90
f214d69a
MD
91enum lttng_ust_field_type {
92 LTTNG_UST_FIELD_OTHER = 0,
93 LTTNG_UST_FIELD_INTEGER = 1,
94 LTTNG_UST_FIELD_ENUM = 2,
95 LTTNG_UST_FIELD_FLOAT = 3,
96 LTTNG_UST_FIELD_STRING = 4,
97};
98
99#define LTTNG_UST_FIELD_ITER_PADDING LTTNG_UST_SYM_NAME_LEN + 32
100struct lttng_ust_field_iter {
101 char event_name[LTTNG_UST_SYM_NAME_LEN];
102 char field_name[LTTNG_UST_SYM_NAME_LEN];
103 enum lttng_ust_field_type type;
104 int loglevel; /* event loglevel */
105 char padding[LTTNG_UST_FIELD_ITER_PADDING];
106};
107
3bd1e081
MD
108enum lttng_ust_context_type {
109 LTTNG_UST_CONTEXT_VTID = 0,
110 LTTNG_UST_CONTEXT_VPID = 1,
111 LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
112 LTTNG_UST_CONTEXT_PROCNAME = 3,
113};
114
3f3c65dc
MD
115#define LTTNG_UST_CONTEXT_PADDING1 16
116#define LTTNG_UST_CONTEXT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
3bd1e081
MD
117struct lttng_ust_context {
118 enum lttng_ust_context_type ctx;
3f3c65dc
MD
119 char padding[LTTNG_UST_CONTEXT_PADDING1];
120
3bd1e081 121 union {
3f3c65dc 122 char padding[LTTNG_UST_CONTEXT_PADDING2];
3bd1e081
MD
123 } u;
124};
125
13161846
DG
126/*
127 * Tracer channel attributes.
128 */
3f3c65dc 129#define LTTNG_UST_CHANNEL_ATTR_PADDING LTTNG_UST_SYM_NAME_LEN + 32
13161846
DG
130struct lttng_ust_channel_attr {
131 int overwrite; /* 1: overwrite, 0: discard */
132 uint64_t subbuf_size; /* bytes */
133 uint64_t num_subbuf; /* power of 2 */
134 unsigned int switch_timer_interval; /* usec */
135 unsigned int read_timer_interval; /* usec */
136 enum lttng_ust_output output; /* splice, mmap */
3f3c65dc 137 char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
13161846
DG
138};
139
3f3c65dc 140#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
177f8533
MD
141struct lttng_ust_tracepoint_iter {
142 char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
8005f29a 143 int loglevel;
3f3c65dc 144 char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
177f8533
MD
145};
146
3f3c65dc 147#define LTTNG_UST_OBJECT_DATA_PADDING LTTNG_UST_SYM_NAME_LEN + 32
13161846
DG
148struct lttng_ust_object_data {
149 int handle;
150 int shm_fd;
151 int wait_fd;
152 uint64_t memory_map_size;
3f3c65dc 153 char padding[LTTNG_UST_OBJECT_DATA_PADDING];
13161846
DG
154};
155
f7e1a950
DG
156enum lttng_ust_calibrate_type {
157 LTTNG_UST_CALIBRATE_TRACEPOINT,
158};
159
3f3c65dc
MD
160#define LTTNG_UST_CALIBRATE_PADDING1 16
161#define LTTNG_UST_CALIBRATE_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
f7e1a950 162struct lttng_ust_calibrate {
3f3c65dc
MD
163 enum lttng_ust_calibrate_type type; /* type (input) */
164 char padding[LTTNG_UST_CALIBRATE_PADDING1];
165
166 union {
167 char padding[LTTNG_UST_CALIBRATE_PADDING2];
168 } u;
f7e1a950
DG
169};
170
3bd1e081
MD
171#define _UST_CMD(minor) (minor)
172#define _UST_CMDR(minor, type) (minor)
173#define _UST_CMDW(minor, type) (minor)
174
175/* Handled by object descriptor */
176#define LTTNG_UST_RELEASE _UST_CMD(0x1)
177
178/* Handled by object cmd */
179
180/* LTTng-UST commands */
181#define LTTNG_UST_SESSION _UST_CMD(0x40)
182#define LTTNG_UST_TRACER_VERSION \
183 _UST_CMDR(0x41, struct lttng_ust_tracer_version)
184#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
185#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
186#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
f214d69a 187#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
3bd1e081
MD
188
189/* Session FD commands */
190#define LTTNG_UST_METADATA \
191 _UST_CMDW(0x50, struct lttng_ust_channel)
192#define LTTNG_UST_CHANNEL \
193 _UST_CMDW(0x51, struct lttng_ust_channel)
194#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
195#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
196
197/* Channel FD commands */
198#define LTTNG_UST_STREAM _UST_CMD(0x60)
199#define LTTNG_UST_EVENT \
200 _UST_CMDW(0x61, struct lttng_ust_event)
201
202/* Event and Channel FD commands */
203#define LTTNG_UST_CONTEXT \
204 _UST_CMDW(0x70, struct lttng_ust_context)
2bdd86d4
MD
205#define LTTNG_UST_FLUSH_BUFFER \
206 _UST_CMD(0x71)
3bd1e081
MD
207
208/* Event, Channel and Session commands */
209#define LTTNG_UST_ENABLE _UST_CMD(0x80)
210#define LTTNG_UST_DISABLE _UST_CMD(0x81)
211
8ec2d32a
MD
212/* Tracepoint list commands */
213#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
f214d69a 214#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
8ec2d32a 215
3bd1e081
MD
216#define LTTNG_UST_ROOT_HANDLE 0
217
9df8df5e 218struct lttng_ust_obj;
3bd1e081 219
18cef803
MD
220union ust_args {
221 struct {
222 int *shm_fd;
223 int *wait_fd;
224 uint64_t *memory_map_size;
225 } channel;
226 struct {
227 int *shm_fd;
228 int *wait_fd;
229 uint64_t *memory_map_size;
230 } stream;
da0bdb87
MD
231 struct {
232 struct lttng_ust_field_iter entry;
233 } field_list;
18cef803
MD
234};
235
9df8df5e 236struct lttng_ust_objd_ops {
18cef803
MD
237 long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
238 union ust_args *args);
3bd1e081
MD
239 int (*release)(int objd);
240};
241
242/* Create root handle. Always ID 0. */
243int lttng_abi_create_root_handle(void);
244
9df8df5e
DG
245const struct lttng_ust_objd_ops *objd_ops(int id);
246int lttng_ust_objd_unref(int id);
3bd1e081
MD
247
248void lttng_ust_abi_exit(void);
9df8df5e 249void lttng_ust_events_exit(void);
3bd1e081
MD
250
251#endif /* _LTTNG_UST_ABI_H */
This page took 0.059692 seconds and 4 git commands to generate.