Commit | Line | Data |
---|---|---|
0a42beb6 MD |
1 | #ifndef _UST_LTTNG_EVENTS_H |
2 | #define _UST_LTTNG_EVENTS_H | |
8020ceb5 MD |
3 | |
4 | /* | |
0a42beb6 | 5 | * ust/lttng-events.h |
8020ceb5 MD |
6 | * |
7 | * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
8 | * | |
9 | * Holds LTTng per-session event registry. | |
10 | * | |
11 | * Dual LGPL v2.1/GPL v2 license. | |
12 | */ | |
13 | ||
9f3fdbc6 MD |
14 | #include <urcu/list.h> |
15 | #include <uuid/uuid.h> | |
16 | #include <stdint.h> | |
17 | #include <ust/lttng-ust-abi.h> | |
1dbfff0c | 18 | #include <ust/lttng-tracer.h> |
20f1eee7 MD |
19 | #include <endian.h> |
20 | #include <float.h> | |
8020ceb5 | 21 | |
8020ceb5 MD |
22 | struct ltt_channel; |
23 | struct ltt_session; | |
24 | struct lib_ring_buffer_ctx; | |
8020ceb5 MD |
25 | |
26 | /* Type description */ | |
27 | ||
28 | /* Update the astract_types name table in lttng-types.c along with this enum */ | |
29 | enum abstract_types { | |
30 | atype_integer, | |
31 | atype_enum, | |
32 | atype_array, | |
33 | atype_sequence, | |
34 | atype_string, | |
20f1eee7 | 35 | atype_float, |
8020ceb5 MD |
36 | NR_ABSTRACT_TYPES, |
37 | }; | |
38 | ||
39 | /* Update the string_encodings name table in lttng-types.c along with this enum */ | |
40 | enum lttng_string_encodings { | |
41 | lttng_encode_none = 0, | |
42 | lttng_encode_UTF8 = 1, | |
43 | lttng_encode_ASCII = 2, | |
44 | NR_STRING_ENCODINGS, | |
45 | }; | |
46 | ||
47 | struct lttng_enum_entry { | |
48 | unsigned long long start, end; /* start and end are inclusive */ | |
49 | const char *string; | |
50 | }; | |
51 | ||
52 | #define __type_integer(_type, _byte_order, _base, _encoding) \ | |
53 | { \ | |
54 | .atype = atype_integer, \ | |
55 | .u.basic.integer = \ | |
56 | { \ | |
57 | .size = sizeof(_type) * CHAR_BIT, \ | |
1dbfff0c MD |
58 | .alignment = lttng_alignof(_type) * CHAR_BIT, \ |
59 | .signedness = lttng_is_signed_type(_type), \ | |
8020ceb5 MD |
60 | .reverse_byte_order = _byte_order != __BYTE_ORDER, \ |
61 | .base = _base, \ | |
62 | .encoding = lttng_encode_##_encoding, \ | |
63 | }, \ | |
64 | } \ | |
65 | ||
66 | struct lttng_integer_type { | |
67 | unsigned int size; /* in bits */ | |
68 | unsigned short alignment; /* in bits */ | |
69 | unsigned int signedness:1; | |
70 | unsigned int reverse_byte_order:1; | |
71 | unsigned int base; /* 2, 8, 10, 16, for pretty print */ | |
72 | enum lttng_string_encodings encoding; | |
73 | }; | |
74 | ||
20f1eee7 MD |
75 | #define _float_mant_dig(_type) \ |
76 | (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \ | |
77 | : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \ | |
78 | : (sizeof(_type) == sizeof(long double) ? LDBL_MANT_DIG \ | |
79 | : 0))) | |
80 | ||
81 | #define __type_float(_type) \ | |
82 | { \ | |
83 | .atype = atype_float, \ | |
84 | .u.basic._float = \ | |
85 | { \ | |
86 | .exp_dig = sizeof(_type) * CHAR_BIT \ | |
87 | - _float_mant_dig(_type), \ | |
88 | .mant_dig = _float_mant_dig(_type), \ | |
1dbfff0c | 89 | .alignment = lttng_alignof(_type) * CHAR_BIT, \ |
20f1eee7 MD |
90 | .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \ |
91 | }, \ | |
92 | } \ | |
93 | ||
94 | struct lttng_float_type { | |
95 | unsigned int exp_dig; /* exponent digits, in bits */ | |
96 | unsigned int mant_dig; /* mantissa digits, in bits */ | |
97 | unsigned short alignment; /* in bits */ | |
98 | unsigned int reverse_byte_order:1; | |
99 | }; | |
100 | ||
8020ceb5 MD |
101 | union _lttng_basic_type { |
102 | struct lttng_integer_type integer; | |
103 | struct { | |
104 | const char *name; | |
105 | } enumeration; | |
106 | struct { | |
107 | enum lttng_string_encodings encoding; | |
108 | } string; | |
20f1eee7 | 109 | struct lttng_float_type _float; |
8020ceb5 MD |
110 | }; |
111 | ||
112 | struct lttng_basic_type { | |
113 | enum abstract_types atype; | |
114 | union { | |
115 | union _lttng_basic_type basic; | |
116 | } u; | |
117 | }; | |
118 | ||
119 | struct lttng_type { | |
120 | enum abstract_types atype; | |
121 | union { | |
122 | union _lttng_basic_type basic; | |
123 | struct { | |
124 | struct lttng_basic_type elem_type; | |
125 | unsigned int length; /* num. elems. */ | |
126 | } array; | |
127 | struct { | |
128 | struct lttng_basic_type length_type; | |
129 | struct lttng_basic_type elem_type; | |
130 | } sequence; | |
131 | } u; | |
132 | }; | |
133 | ||
134 | struct lttng_enum { | |
135 | const char *name; | |
136 | struct lttng_type container_type; | |
137 | const struct lttng_enum_entry *entries; | |
138 | unsigned int len; | |
139 | }; | |
140 | ||
141 | /* Event field description */ | |
142 | ||
143 | struct lttng_event_field { | |
144 | const char *name; | |
145 | struct lttng_type type; | |
146 | }; | |
147 | ||
148 | struct lttng_ctx_field { | |
149 | struct lttng_event_field event_field; | |
150 | size_t (*get_size)(size_t offset); | |
151 | void (*record)(struct lttng_ctx_field *field, | |
152 | struct lib_ring_buffer_ctx *ctx, | |
153 | struct ltt_channel *chan); | |
154 | union { | |
8020ceb5 MD |
155 | } u; |
156 | void (*destroy)(struct lttng_ctx_field *field); | |
157 | }; | |
158 | ||
159 | struct lttng_ctx { | |
160 | struct lttng_ctx_field *fields; | |
161 | unsigned int nr_fields; | |
162 | unsigned int allocated_fields; | |
163 | }; | |
164 | ||
165 | struct lttng_event_desc { | |
166 | const char *name; | |
167 | void *probe_callback; | |
168 | const struct lttng_event_ctx *ctx; /* context */ | |
169 | const struct lttng_event_field *fields; /* event payload */ | |
170 | unsigned int nr_fields; | |
8020ceb5 MD |
171 | }; |
172 | ||
173 | struct lttng_probe_desc { | |
174 | const struct lttng_event_desc *event_desc; | |
175 | unsigned int nr_events; | |
9f3fdbc6 | 176 | struct cds_list_head head; /* chain registered probes */ |
8020ceb5 MD |
177 | }; |
178 | ||
179 | /* | |
180 | * ltt_event structure is referred to by the tracing fast path. It must be | |
181 | * kept small. | |
182 | */ | |
183 | struct ltt_event { | |
184 | unsigned int id; | |
185 | struct ltt_channel *chan; | |
976fe9ea | 186 | int enabled; |
8020ceb5 MD |
187 | const struct lttng_event_desc *desc; |
188 | void *filter; | |
189 | struct lttng_ctx *ctx; | |
9f3fdbc6 | 190 | enum lttng_ust_instrumentation instrumentation; |
8020ceb5 | 191 | union { |
8020ceb5 | 192 | } u; |
9f3fdbc6 | 193 | struct cds_list_head list; /* Event list */ |
8020ceb5 MD |
194 | int metadata_dumped:1; |
195 | }; | |
196 | ||
8d8a24c8 | 197 | struct channel; |
1d498196 | 198 | struct shm_handle; |
8d8a24c8 | 199 | |
8020ceb5 | 200 | struct ltt_channel_ops { |
1d498196 | 201 | struct ltt_channel *(*channel_create)(const char *name, |
8020ceb5 MD |
202 | struct ltt_channel *ltt_chan, |
203 | void *buf_addr, | |
204 | size_t subbuf_size, size_t num_subbuf, | |
205 | unsigned int switch_timer_interval, | |
8d8a24c8 | 206 | unsigned int read_timer_interval); |
1d498196 MD |
207 | void (*channel_destroy)(struct ltt_channel *ltt_chan); |
208 | struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan, | |
209 | struct shm_handle *handle); | |
210 | void (*buffer_read_close)(struct lib_ring_buffer *buf, | |
211 | struct shm_handle *handle); | |
8020ceb5 MD |
212 | int (*event_reserve)(struct lib_ring_buffer_ctx *ctx, |
213 | uint32_t event_id); | |
214 | void (*event_commit)(struct lib_ring_buffer_ctx *ctx); | |
215 | void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src, | |
216 | size_t len); | |
217 | /* | |
218 | * packet_avail_size returns the available size in the current | |
219 | * packet. Note that the size returned is only a hint, since it | |
220 | * may change due to concurrent writes. | |
221 | */ | |
1d498196 MD |
222 | size_t (*packet_avail_size)(struct channel *chan, |
223 | struct shm_handle *handle); | |
9f3fdbc6 MD |
224 | //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan); |
225 | //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan); | |
8020ceb5 MD |
226 | int (*is_finalized)(struct channel *chan); |
227 | int (*is_disabled)(struct channel *chan); | |
228 | }; | |
229 | ||
230 | struct ltt_channel { | |
231 | unsigned int id; | |
232 | struct channel *chan; /* Channel buffers */ | |
976fe9ea | 233 | int enabled; |
8020ceb5 MD |
234 | struct lttng_ctx *ctx; |
235 | /* Event ID management */ | |
236 | struct ltt_session *session; | |
0a42beb6 | 237 | int objd; /* Object associated to channel */ |
8020ceb5 | 238 | unsigned int free_event_id; /* Next event ID to allocate */ |
9f3fdbc6 | 239 | struct cds_list_head list; /* Channel list */ |
8020ceb5 MD |
240 | struct ltt_channel_ops *ops; |
241 | int header_type; /* 0: unset, 1: compact, 2: large */ | |
8d8a24c8 | 242 | struct shm_handle *handle; /* shared-memory handle */ |
8020ceb5 MD |
243 | int metadata_dumped:1; |
244 | }; | |
245 | ||
246 | struct ltt_session { | |
247 | int active; /* Is trace session active ? */ | |
248 | int been_active; /* Has trace session been active ? */ | |
0a42beb6 | 249 | int objd; /* Object associated to session */ |
8020ceb5 | 250 | struct ltt_channel *metadata; /* Metadata channel */ |
9f3fdbc6 MD |
251 | struct cds_list_head chan; /* Channel list head */ |
252 | struct cds_list_head events; /* Event list head */ | |
253 | struct cds_list_head list; /* Session list */ | |
8020ceb5 | 254 | unsigned int free_chan_id; /* Next chan ID to allocate */ |
9f3fdbc6 | 255 | uuid_t uuid; /* Trace session unique ID */ |
8020ceb5 MD |
256 | int metadata_dumped:1; |
257 | }; | |
258 | ||
259 | struct ltt_transport { | |
260 | char *name; | |
9f3fdbc6 | 261 | struct cds_list_head node; |
8020ceb5 MD |
262 | struct ltt_channel_ops ops; |
263 | }; | |
264 | ||
265 | struct ltt_session *ltt_session_create(void); | |
976fe9ea MD |
266 | int ltt_session_enable(struct ltt_session *session); |
267 | int ltt_session_disable(struct ltt_session *session); | |
8020ceb5 MD |
268 | void ltt_session_destroy(struct ltt_session *session); |
269 | ||
270 | struct ltt_channel *ltt_channel_create(struct ltt_session *session, | |
271 | const char *transport_name, | |
272 | void *buf_addr, | |
273 | size_t subbuf_size, size_t num_subbuf, | |
274 | unsigned int switch_timer_interval, | |
0a42beb6 | 275 | unsigned int read_timer_interval); |
8020ceb5 MD |
276 | struct ltt_channel *ltt_global_channel_create(struct ltt_session *session, |
277 | int overwrite, void *buf_addr, | |
278 | size_t subbuf_size, size_t num_subbuf, | |
279 | unsigned int switch_timer_interval, | |
280 | unsigned int read_timer_interval); | |
281 | ||
282 | struct ltt_event *ltt_event_create(struct ltt_channel *chan, | |
9f3fdbc6 | 283 | struct lttng_ust_event *event_param, |
8020ceb5 MD |
284 | void *filter); |
285 | ||
976fe9ea MD |
286 | int ltt_channel_enable(struct ltt_channel *channel); |
287 | int ltt_channel_disable(struct ltt_channel *channel); | |
288 | int ltt_event_enable(struct ltt_event *event); | |
289 | int ltt_event_disable(struct ltt_event *event); | |
290 | ||
8020ceb5 MD |
291 | void ltt_transport_register(struct ltt_transport *transport); |
292 | void ltt_transport_unregister(struct ltt_transport *transport); | |
293 | ||
4b4de73e | 294 | void synchronize_trace(void); |
9f3fdbc6 MD |
295 | //int ltt_debugfs_abi_init(void); |
296 | //void ltt_debugfs_abi_exit(void); | |
8020ceb5 MD |
297 | |
298 | int ltt_probe_register(struct lttng_probe_desc *desc); | |
299 | void ltt_probe_unregister(struct lttng_probe_desc *desc); | |
300 | const struct lttng_event_desc *ltt_event_get(const char *name); | |
301 | void ltt_event_put(const struct lttng_event_desc *desc); | |
302 | int ltt_probes_init(void); | |
303 | void ltt_probes_exit(void); | |
304 | struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx); | |
305 | void lttng_remove_context_field(struct lttng_ctx **ctx, | |
306 | struct lttng_ctx_field *field); | |
307 | void lttng_destroy_context(struct lttng_ctx *ctx); | |
9f3fdbc6 MD |
308 | int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx); |
309 | ||
310 | //extern const struct file_operations lttng_tracepoint_list_fops; | |
8020ceb5 | 311 | |
0a42beb6 | 312 | #endif /* _UST_LTTNG_EVENTS_H */ |