Commit | Line | Data |
---|---|---|
b7cdc182 | 1 | /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only) |
9f36eaed | 2 | * |
a90917c3 | 3 | * lttng-events.c |
4e3c1b9b | 4 | * |
4e3c1b9b | 5 | * Holds LTTng per-session event registry. |
17baffe2 | 6 | * |
886d51a3 | 7 | * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
4e3c1b9b MD |
8 | */ |
9 | ||
389d7070 MD |
10 | /* |
11 | * This page_alloc.h wrapper needs to be included before gfpflags.h because it | |
12 | * overrides a function with a define. | |
13 | */ | |
14 | #include "wrapper/page_alloc.h" | |
15 | ||
4e3c1b9b | 16 | #include <linux/module.h> |
c0e31d2e MD |
17 | #include <linux/mutex.h> |
18 | #include <linux/sched.h> | |
11b5a3c2 | 19 | #include <linux/slab.h> |
c099397a | 20 | #include <linux/jiffies.h> |
99dc9597 | 21 | #include <linux/utsname.h> |
abc0446a | 22 | #include <linux/err.h> |
7e6f9ef6 MD |
23 | #include <linux/seq_file.h> |
24 | #include <linux/file.h> | |
25 | #include <linux/anon_inodes.h> | |
241ae9a8 | 26 | #include <wrapper/file.h> |
3c997079 | 27 | #include <linux/jhash.h> |
8c6e7f13 | 28 | #include <linux/uaccess.h> |
a606b6e8 | 29 | #include <linux/vmalloc.h> |
c88f762e | 30 | #include <linux/dmi.h> |
3c997079 | 31 | |
a7008254 | 32 | #include <wrapper/uuid.h> |
263b6c88 | 33 | #include <wrapper/vmalloc.h> /* for wrapper_vmalloc_sync_mappings() */ |
241ae9a8 MD |
34 | #include <wrapper/random.h> |
35 | #include <wrapper/tracepoint.h> | |
36 | #include <wrapper/list.h> | |
cbc19040 | 37 | #include <wrapper/types.h> |
2df37e95 MD |
38 | #include <lttng/kernel-version.h> |
39 | #include <lttng/events.h> | |
40 | #include <lttng/tracer.h> | |
41 | #include <lttng/abi-old.h> | |
42 | #include <lttng/endian.h> | |
43 | #include <lttng/string-utils.h> | |
24591303 MD |
44 | #include <ringbuffer/backend.h> |
45 | #include <ringbuffer/frontend.h> | |
3636085f | 46 | #include <wrapper/time.h> |
4e3c1b9b | 47 | |
d83004aa JD |
48 | #define METADATA_CACHE_DEFAULT_SIZE 4096 |
49 | ||
4e3c1b9b | 50 | static LIST_HEAD(sessions); |
a90917c3 | 51 | static LIST_HEAD(lttng_transport_list); |
d83004aa JD |
52 | /* |
53 | * Protect the sessions and metadata caches. | |
54 | */ | |
4e3c1b9b MD |
55 | static DEFINE_MUTEX(sessions_mutex); |
56 | static struct kmem_cache *event_cache; | |
57 | ||
3c997079 MD |
58 | static void lttng_session_lazy_sync_enablers(struct lttng_session *session); |
59 | static void lttng_session_sync_enablers(struct lttng_session *session); | |
60 | static void lttng_enabler_destroy(struct lttng_enabler *enabler); | |
61 | ||
a90917c3 MD |
62 | static void _lttng_event_destroy(struct lttng_event *event); |
63 | static void _lttng_channel_destroy(struct lttng_channel *chan); | |
64 | static int _lttng_event_unregister(struct lttng_event *event); | |
c099397a | 65 | static |
a90917c3 MD |
66 | int _lttng_event_metadata_statedump(struct lttng_session *session, |
67 | struct lttng_channel *chan, | |
68 | struct lttng_event *event); | |
c099397a | 69 | static |
a90917c3 | 70 | int _lttng_session_metadata_statedump(struct lttng_session *session); |
d83004aa JD |
71 | static |
72 | void _lttng_metadata_channel_hangup(struct lttng_metadata_stream *stream); | |
f513b2bf | 73 | static |
ceabb767 MD |
74 | int _lttng_type_statedump(struct lttng_session *session, |
75 | const struct lttng_type *type, | |
76 | size_t nesting); | |
77 | static | |
f513b2bf MD |
78 | int _lttng_field_statedump(struct lttng_session *session, |
79 | const struct lttng_event_field *field, | |
80 | size_t nesting); | |
c099397a | 81 | |
c099397a | 82 | void synchronize_trace(void) |
abcca994 | 83 | { |
92da05ce MJ |
84 | #if (LINUX_VERSION_CODE >= KERNEL_VERSION(5,1,0)) |
85 | synchronize_rcu(); | |
86 | #else | |
abcca994 | 87 | synchronize_sched(); |
92da05ce MJ |
88 | #endif |
89 | ||
b8590f40 MD |
90 | #if (LINUX_VERSION_CODE >= KERNEL_VERSION(3,4,0)) |
91 | #ifdef CONFIG_PREEMPT_RT_FULL | |
92 | synchronize_rcu(); | |
93 | #endif | |
94 | #else /* (LINUX_VERSION_CODE >= KERNEL_VERSION(3,4,0)) */ | |
abcca994 MD |
95 | #ifdef CONFIG_PREEMPT_RT |
96 | synchronize_rcu(); | |
97 | #endif | |
b8590f40 | 98 | #endif /* (LINUX_VERSION_CODE >= KERNEL_VERSION(3,4,0)) */ |
abcca994 MD |
99 | } |
100 | ||
3c997079 MD |
101 | void lttng_lock_sessions(void) |
102 | { | |
103 | mutex_lock(&sessions_mutex); | |
104 | } | |
105 | ||
106 | void lttng_unlock_sessions(void) | |
107 | { | |
108 | mutex_unlock(&sessions_mutex); | |
109 | } | |
110 | ||
111 | /* | |
112 | * Called with sessions lock held. | |
113 | */ | |
114 | int lttng_session_active(void) | |
115 | { | |
116 | struct lttng_session *iter; | |
117 | ||
118 | list_for_each_entry(iter, &sessions, list) { | |
119 | if (iter->active) | |
120 | return 1; | |
121 | } | |
122 | return 0; | |
123 | } | |
124 | ||
a90917c3 | 125 | struct lttng_session *lttng_session_create(void) |
4e3c1b9b | 126 | { |
a90917c3 | 127 | struct lttng_session *session; |
d83004aa | 128 | struct lttng_metadata_cache *metadata_cache; |
3c997079 | 129 | int i; |
4e3c1b9b MD |
130 | |
131 | mutex_lock(&sessions_mutex); | |
48f5e0b5 | 132 | session = lttng_kvzalloc(sizeof(struct lttng_session), GFP_KERNEL); |
4e3c1b9b | 133 | if (!session) |
d83004aa | 134 | goto err; |
4e3c1b9b | 135 | INIT_LIST_HEAD(&session->chan); |
f3d01b96 | 136 | INIT_LIST_HEAD(&session->events); |
a7008254 | 137 | lttng_guid_gen(&session->uuid); |
d83004aa JD |
138 | |
139 | metadata_cache = kzalloc(sizeof(struct lttng_metadata_cache), | |
140 | GFP_KERNEL); | |
141 | if (!metadata_cache) | |
142 | goto err_free_session; | |
0ca42eb7 | 143 | metadata_cache->data = vzalloc(METADATA_CACHE_DEFAULT_SIZE); |
d83004aa JD |
144 | if (!metadata_cache->data) |
145 | goto err_free_cache; | |
146 | metadata_cache->cache_alloc = METADATA_CACHE_DEFAULT_SIZE; | |
147 | kref_init(&metadata_cache->refcount); | |
92d9f5e6 | 148 | mutex_init(&metadata_cache->lock); |
d83004aa JD |
149 | session->metadata_cache = metadata_cache; |
150 | INIT_LIST_HEAD(&metadata_cache->metadata_stream); | |
a36580d5 MD |
151 | memcpy(&metadata_cache->uuid, &session->uuid, |
152 | sizeof(metadata_cache->uuid)); | |
3c997079 MD |
153 | INIT_LIST_HEAD(&session->enablers_head); |
154 | for (i = 0; i < LTTNG_EVENT_HT_SIZE; i++) | |
155 | INIT_HLIST_HEAD(&session->events_ht.table[i]); | |
4e3c1b9b | 156 | list_add(&session->list, &sessions); |
d1f652f8 MD |
157 | session->pid_tracker.session = session; |
158 | session->pid_tracker.tracker_type = TRACKER_PID; | |
159 | session->vpid_tracker.session = session; | |
160 | session->vpid_tracker.tracker_type = TRACKER_VPID; | |
161 | session->uid_tracker.session = session; | |
162 | session->uid_tracker.tracker_type = TRACKER_UID; | |
163 | session->vuid_tracker.session = session; | |
164 | session->vuid_tracker.tracker_type = TRACKER_VUID; | |
165 | session->gid_tracker.session = session; | |
166 | session->gid_tracker.tracker_type = TRACKER_GID; | |
167 | session->vgid_tracker.session = session; | |
168 | session->vgid_tracker.tracker_type = TRACKER_VGID; | |
4e3c1b9b MD |
169 | mutex_unlock(&sessions_mutex); |
170 | return session; | |
d83004aa JD |
171 | |
172 | err_free_cache: | |
173 | kfree(metadata_cache); | |
174 | err_free_session: | |
48f5e0b5 | 175 | lttng_kvfree(session); |
d83004aa JD |
176 | err: |
177 | mutex_unlock(&sessions_mutex); | |
178 | return NULL; | |
179 | } | |
180 | ||
181 | void metadata_cache_destroy(struct kref *kref) | |
182 | { | |
183 | struct lttng_metadata_cache *cache = | |
184 | container_of(kref, struct lttng_metadata_cache, refcount); | |
a606b6e8 | 185 | vfree(cache->data); |
d83004aa | 186 | kfree(cache); |
4e3c1b9b MD |
187 | } |
188 | ||
a90917c3 | 189 | void lttng_session_destroy(struct lttng_session *session) |
4e3c1b9b | 190 | { |
a90917c3 MD |
191 | struct lttng_channel *chan, *tmpchan; |
192 | struct lttng_event *event, *tmpevent; | |
d83004aa | 193 | struct lttng_metadata_stream *metadata_stream; |
3c997079 | 194 | struct lttng_enabler *enabler, *tmpenabler; |
dda6a249 | 195 | int ret; |
4e3c1b9b MD |
196 | |
197 | mutex_lock(&sessions_mutex); | |
a8f2d0c7 | 198 | WRITE_ONCE(session->active, 0); |
1ec65de1 MD |
199 | list_for_each_entry(chan, &session->chan, list) { |
200 | ret = lttng_syscalls_unregister(chan); | |
201 | WARN_ON(ret); | |
202 | } | |
dda6a249 | 203 | list_for_each_entry(event, &session->events, list) { |
a90917c3 | 204 | ret = _lttng_event_unregister(event); |
dda6a249 MD |
205 | WARN_ON(ret); |
206 | } | |
abcca994 | 207 | synchronize_trace(); /* Wait for in-flight events to complete */ |
3c997079 MD |
208 | list_for_each_entry_safe(enabler, tmpenabler, |
209 | &session->enablers_head, node) | |
210 | lttng_enabler_destroy(enabler); | |
4e3c1b9b | 211 | list_for_each_entry_safe(event, tmpevent, &session->events, list) |
a90917c3 | 212 | _lttng_event_destroy(event); |
d83004aa JD |
213 | list_for_each_entry_safe(chan, tmpchan, &session->chan, list) { |
214 | BUG_ON(chan->channel_type == METADATA_CHANNEL); | |
a90917c3 | 215 | _lttng_channel_destroy(chan); |
d83004aa JD |
216 | } |
217 | list_for_each_entry(metadata_stream, &session->metadata_cache->metadata_stream, list) | |
218 | _lttng_metadata_channel_hangup(metadata_stream); | |
d1f652f8 MD |
219 | lttng_id_tracker_destroy(&session->pid_tracker, false); |
220 | lttng_id_tracker_destroy(&session->vpid_tracker, false); | |
221 | lttng_id_tracker_destroy(&session->uid_tracker, false); | |
222 | lttng_id_tracker_destroy(&session->vuid_tracker, false); | |
223 | lttng_id_tracker_destroy(&session->gid_tracker, false); | |
224 | lttng_id_tracker_destroy(&session->vgid_tracker, false); | |
d83004aa | 225 | kref_put(&session->metadata_cache->refcount, metadata_cache_destroy); |
4e3c1b9b MD |
226 | list_del(&session->list); |
227 | mutex_unlock(&sessions_mutex); | |
48f5e0b5 | 228 | lttng_kvfree(session); |
4e3c1b9b MD |
229 | } |
230 | ||
601252cf MD |
231 | int lttng_session_statedump(struct lttng_session *session) |
232 | { | |
233 | int ret; | |
234 | ||
235 | mutex_lock(&sessions_mutex); | |
236 | ret = lttng_statedump_start(session); | |
237 | mutex_unlock(&sessions_mutex); | |
238 | return ret; | |
239 | } | |
240 | ||
a90917c3 | 241 | int lttng_session_enable(struct lttng_session *session) |
c0e31d2e MD |
242 | { |
243 | int ret = 0; | |
a90917c3 | 244 | struct lttng_channel *chan; |
c0e31d2e MD |
245 | |
246 | mutex_lock(&sessions_mutex); | |
247 | if (session->active) { | |
248 | ret = -EBUSY; | |
249 | goto end; | |
250 | } | |
c099397a | 251 | |
3c997079 MD |
252 | /* Set transient enabler state to "enabled" */ |
253 | session->tstate = 1; | |
254 | ||
4ef81e4a MD |
255 | /* We need to sync enablers with session before activation. */ |
256 | lttng_session_sync_enablers(session); | |
257 | ||
c099397a MD |
258 | /* |
259 | * Snapshot the number of events per channel to know the type of header | |
260 | * we need to use. | |
261 | */ | |
262 | list_for_each_entry(chan, &session->chan, list) { | |
263 | if (chan->header_type) | |
264 | continue; /* don't change it if session stop/restart */ | |
265 | if (chan->free_event_id < 31) | |
266 | chan->header_type = 1; /* compact */ | |
267 | else | |
268 | chan->header_type = 2; /* large */ | |
269 | } | |
270 | ||
64af2437 | 271 | /* Clear each stream's quiescent state. */ |
09b93db9 MD |
272 | list_for_each_entry(chan, &session->chan, list) { |
273 | if (chan->channel_type != METADATA_CHANNEL) | |
274 | lib_ring_buffer_clear_quiescent_channel(chan->chan); | |
275 | } | |
64af2437 | 276 | |
a8f2d0c7 MJ |
277 | WRITE_ONCE(session->active, 1); |
278 | WRITE_ONCE(session->been_active, 1); | |
a90917c3 | 279 | ret = _lttng_session_metadata_statedump(session); |
c337ddc2 | 280 | if (ret) { |
a8f2d0c7 | 281 | WRITE_ONCE(session->active, 0); |
c337ddc2 MD |
282 | goto end; |
283 | } | |
284 | ret = lttng_statedump_start(session); | |
360f38ea | 285 | if (ret) |
a8f2d0c7 | 286 | WRITE_ONCE(session->active, 0); |
c0e31d2e MD |
287 | end: |
288 | mutex_unlock(&sessions_mutex); | |
11b5a3c2 | 289 | return ret; |
c0e31d2e MD |
290 | } |
291 | ||
a90917c3 | 292 | int lttng_session_disable(struct lttng_session *session) |
c0e31d2e MD |
293 | { |
294 | int ret = 0; | |
64af2437 | 295 | struct lttng_channel *chan; |
c0e31d2e MD |
296 | |
297 | mutex_lock(&sessions_mutex); | |
298 | if (!session->active) { | |
299 | ret = -EBUSY; | |
300 | goto end; | |
301 | } | |
a8f2d0c7 | 302 | WRITE_ONCE(session->active, 0); |
3c997079 MD |
303 | |
304 | /* Set transient enabler state to "disabled" */ | |
305 | session->tstate = 0; | |
306 | lttng_session_sync_enablers(session); | |
64af2437 MD |
307 | |
308 | /* Set each stream's quiescent state. */ | |
09b93db9 MD |
309 | list_for_each_entry(chan, &session->chan, list) { |
310 | if (chan->channel_type != METADATA_CHANNEL) | |
311 | lib_ring_buffer_set_quiescent_channel(chan->chan); | |
312 | } | |
c0e31d2e MD |
313 | end: |
314 | mutex_unlock(&sessions_mutex); | |
11b5a3c2 | 315 | return ret; |
c0e31d2e MD |
316 | } |
317 | ||
9616f0bf JD |
318 | int lttng_session_metadata_regenerate(struct lttng_session *session) |
319 | { | |
320 | int ret = 0; | |
321 | struct lttng_channel *chan; | |
322 | struct lttng_event *event; | |
323 | struct lttng_metadata_cache *cache = session->metadata_cache; | |
324 | struct lttng_metadata_stream *stream; | |
325 | ||
326 | mutex_lock(&sessions_mutex); | |
327 | if (!session->active) { | |
328 | ret = -EBUSY; | |
329 | goto end; | |
330 | } | |
331 | ||
332 | mutex_lock(&cache->lock); | |
333 | memset(cache->data, 0, cache->cache_alloc); | |
334 | cache->metadata_written = 0; | |
335 | cache->version++; | |
336 | list_for_each_entry(stream, &session->metadata_cache->metadata_stream, list) { | |
337 | stream->metadata_out = 0; | |
338 | stream->metadata_in = 0; | |
339 | } | |
340 | mutex_unlock(&cache->lock); | |
341 | ||
342 | session->metadata_dumped = 0; | |
343 | list_for_each_entry(chan, &session->chan, list) { | |
344 | chan->metadata_dumped = 0; | |
345 | } | |
346 | ||
347 | list_for_each_entry(event, &session->events, list) { | |
348 | event->metadata_dumped = 0; | |
349 | } | |
350 | ||
351 | ret = _lttng_session_metadata_statedump(session); | |
352 | ||
353 | end: | |
354 | mutex_unlock(&sessions_mutex); | |
355 | return ret; | |
356 | } | |
357 | ||
a90917c3 | 358 | int lttng_channel_enable(struct lttng_channel *channel) |
e64957da | 359 | { |
3c997079 | 360 | int ret = 0; |
e64957da | 361 | |
3c997079 MD |
362 | mutex_lock(&sessions_mutex); |
363 | if (channel->channel_type == METADATA_CHANNEL) { | |
364 | ret = -EPERM; | |
365 | goto end; | |
366 | } | |
367 | if (channel->enabled) { | |
368 | ret = -EEXIST; | |
369 | goto end; | |
370 | } | |
371 | /* Set transient enabler state to "enabled" */ | |
372 | channel->tstate = 1; | |
373 | lttng_session_sync_enablers(channel->session); | |
374 | /* Set atomically the state to "enabled" */ | |
a8f2d0c7 | 375 | WRITE_ONCE(channel->enabled, 1); |
3c997079 MD |
376 | end: |
377 | mutex_unlock(&sessions_mutex); | |
378 | return ret; | |
e64957da MD |
379 | } |
380 | ||
a90917c3 | 381 | int lttng_channel_disable(struct lttng_channel *channel) |
e64957da | 382 | { |
3c997079 | 383 | int ret = 0; |
e64957da | 384 | |
3c997079 MD |
385 | mutex_lock(&sessions_mutex); |
386 | if (channel->channel_type == METADATA_CHANNEL) { | |
387 | ret = -EPERM; | |
388 | goto end; | |
389 | } | |
390 | if (!channel->enabled) { | |
391 | ret = -EEXIST; | |
392 | goto end; | |
393 | } | |
394 | /* Set atomically the state to "disabled" */ | |
a8f2d0c7 | 395 | WRITE_ONCE(channel->enabled, 0); |
3c997079 MD |
396 | /* Set transient enabler state to "enabled" */ |
397 | channel->tstate = 0; | |
398 | lttng_session_sync_enablers(channel->session); | |
399 | end: | |
400 | mutex_unlock(&sessions_mutex); | |
401 | return ret; | |
e64957da MD |
402 | } |
403 | ||
a90917c3 | 404 | int lttng_event_enable(struct lttng_event *event) |
e64957da | 405 | { |
3c997079 | 406 | int ret = 0; |
e64957da | 407 | |
3c997079 MD |
408 | mutex_lock(&sessions_mutex); |
409 | if (event->chan->channel_type == METADATA_CHANNEL) { | |
410 | ret = -EPERM; | |
411 | goto end; | |
412 | } | |
413 | if (event->enabled) { | |
414 | ret = -EEXIST; | |
415 | goto end; | |
416 | } | |
a0493bef MD |
417 | switch (event->instrumentation) { |
418 | case LTTNG_KERNEL_TRACEPOINT: | |
419 | case LTTNG_KERNEL_SYSCALL: | |
420 | ret = -EINVAL; | |
421 | break; | |
422 | case LTTNG_KERNEL_KPROBE: | |
149b9a9d | 423 | case LTTNG_KERNEL_UPROBE: |
a0493bef | 424 | case LTTNG_KERNEL_NOOP: |
a8f2d0c7 | 425 | WRITE_ONCE(event->enabled, 1); |
a0493bef MD |
426 | break; |
427 | case LTTNG_KERNEL_KRETPROBE: | |
428 | ret = lttng_kretprobes_event_enable_state(event, 1); | |
429 | break; | |
e884017c | 430 | case LTTNG_KERNEL_FUNCTION: /* Fall-through. */ |
a0493bef MD |
431 | default: |
432 | WARN_ON_ONCE(1); | |
433 | ret = -EINVAL; | |
434 | } | |
3c997079 MD |
435 | end: |
436 | mutex_unlock(&sessions_mutex); | |
437 | return ret; | |
e64957da MD |
438 | } |
439 | ||
a90917c3 | 440 | int lttng_event_disable(struct lttng_event *event) |
e64957da | 441 | { |
3c997079 | 442 | int ret = 0; |
e64957da | 443 | |
3c997079 MD |
444 | mutex_lock(&sessions_mutex); |
445 | if (event->chan->channel_type == METADATA_CHANNEL) { | |
446 | ret = -EPERM; | |
447 | goto end; | |
448 | } | |
449 | if (!event->enabled) { | |
450 | ret = -EEXIST; | |
451 | goto end; | |
452 | } | |
a0493bef MD |
453 | switch (event->instrumentation) { |
454 | case LTTNG_KERNEL_TRACEPOINT: | |
455 | case LTTNG_KERNEL_SYSCALL: | |
456 | ret = -EINVAL; | |
457 | break; | |
458 | case LTTNG_KERNEL_KPROBE: | |
149b9a9d | 459 | case LTTNG_KERNEL_UPROBE: |
a0493bef | 460 | case LTTNG_KERNEL_NOOP: |
a8f2d0c7 | 461 | WRITE_ONCE(event->enabled, 0); |
a0493bef MD |
462 | break; |
463 | case LTTNG_KERNEL_KRETPROBE: | |
464 | ret = lttng_kretprobes_event_enable_state(event, 0); | |
465 | break; | |
e884017c | 466 | case LTTNG_KERNEL_FUNCTION: /* Fall-through. */ |
a0493bef MD |
467 | default: |
468 | WARN_ON_ONCE(1); | |
469 | ret = -EINVAL; | |
470 | } | |
3c997079 MD |
471 | end: |
472 | mutex_unlock(&sessions_mutex); | |
473 | return ret; | |
e64957da MD |
474 | } |
475 | ||
a90917c3 | 476 | static struct lttng_transport *lttng_transport_find(const char *name) |
f3d01b96 | 477 | { |
a90917c3 | 478 | struct lttng_transport *transport; |
f3d01b96 | 479 | |
a90917c3 | 480 | list_for_each_entry(transport, <tng_transport_list, node) { |
f3d01b96 MD |
481 | if (!strcmp(transport->name, name)) |
482 | return transport; | |
483 | } | |
484 | return NULL; | |
485 | } | |
486 | ||
a90917c3 | 487 | struct lttng_channel *lttng_channel_create(struct lttng_session *session, |
5dbbdb43 MD |
488 | const char *transport_name, |
489 | void *buf_addr, | |
4e3c1b9b MD |
490 | size_t subbuf_size, size_t num_subbuf, |
491 | unsigned int switch_timer_interval, | |
d83004aa JD |
492 | unsigned int read_timer_interval, |
493 | enum channel_type channel_type) | |
4e3c1b9b | 494 | { |
a90917c3 MD |
495 | struct lttng_channel *chan; |
496 | struct lttng_transport *transport = NULL; | |
4e3c1b9b MD |
497 | |
498 | mutex_lock(&sessions_mutex); | |
d83004aa | 499 | if (session->been_active && channel_type != METADATA_CHANNEL) |
e5382b6d | 500 | goto active; /* Refuse to add channel to active session */ |
a90917c3 | 501 | transport = lttng_transport_find(transport_name); |
f3d01b96 MD |
502 | if (!transport) { |
503 | printk(KERN_WARNING "LTTng transport %s not found\n", | |
504 | transport_name); | |
c0e31d2e | 505 | goto notransport; |
f3d01b96 | 506 | } |
a33c9927 MD |
507 | if (!try_module_get(transport->owner)) { |
508 | printk(KERN_WARNING "LTT : Can't lock transport module.\n"); | |
509 | goto notransport; | |
510 | } | |
a90917c3 | 511 | chan = kzalloc(sizeof(struct lttng_channel), GFP_KERNEL); |
4e3c1b9b | 512 | if (!chan) |
c0e31d2e | 513 | goto nomem; |
4e3c1b9b | 514 | chan->session = session; |
05d32c64 | 515 | chan->id = session->free_chan_id++; |
3b731ab1 | 516 | chan->ops = &transport->ops; |
125b4df4 MD |
517 | /* |
518 | * Note: the channel creation op already writes into the packet | |
519 | * headers. Therefore the "chan" information used as input | |
520 | * should be already accessible. | |
521 | */ | |
5f5ddf01 MD |
522 | chan->chan = transport->ops.channel_create(transport_name, |
523 | chan, buf_addr, subbuf_size, num_subbuf, | |
524 | switch_timer_interval, read_timer_interval); | |
f3d01b96 MD |
525 | if (!chan->chan) |
526 | goto create_error; | |
3c997079 | 527 | chan->tstate = 1; |
e64957da | 528 | chan->enabled = 1; |
a33c9927 | 529 | chan->transport = transport; |
d83004aa | 530 | chan->channel_type = channel_type; |
4e3c1b9b MD |
531 | list_add(&chan->list, &session->chan); |
532 | mutex_unlock(&sessions_mutex); | |
533 | return chan; | |
534 | ||
f3d01b96 MD |
535 | create_error: |
536 | kfree(chan); | |
c0e31d2e | 537 | nomem: |
a33c9927 MD |
538 | if (transport) |
539 | module_put(transport->owner); | |
c0e31d2e | 540 | notransport: |
e5382b6d | 541 | active: |
4e3c1b9b MD |
542 | mutex_unlock(&sessions_mutex); |
543 | return NULL; | |
544 | } | |
545 | ||
546 | /* | |
d83004aa JD |
547 | * Only used internally at session destruction for per-cpu channels, and |
548 | * when metadata channel is released. | |
549 | * Needs to be called with sessions mutex held. | |
4e3c1b9b | 550 | */ |
aa7c23a9 | 551 | static |
a90917c3 | 552 | void _lttng_channel_destroy(struct lttng_channel *chan) |
4e3c1b9b | 553 | { |
11b5a3c2 | 554 | chan->ops->channel_destroy(chan->chan); |
a33c9927 | 555 | module_put(chan->transport->owner); |
4e3c1b9b | 556 | list_del(&chan->list); |
8070f5c0 | 557 | lttng_destroy_context(chan->ctx); |
4e3c1b9b MD |
558 | kfree(chan); |
559 | } | |
560 | ||
d83004aa JD |
561 | void lttng_metadata_channel_destroy(struct lttng_channel *chan) |
562 | { | |
563 | BUG_ON(chan->channel_type != METADATA_CHANNEL); | |
564 | ||
565 | /* Protect the metadata cache with the sessions_mutex. */ | |
566 | mutex_lock(&sessions_mutex); | |
567 | _lttng_channel_destroy(chan); | |
568 | mutex_unlock(&sessions_mutex); | |
569 | } | |
570 | EXPORT_SYMBOL_GPL(lttng_metadata_channel_destroy); | |
571 | ||
572 | static | |
573 | void _lttng_metadata_channel_hangup(struct lttng_metadata_stream *stream) | |
574 | { | |
575 | stream->finalized = 1; | |
576 | wake_up_interruptible(&stream->read_wait); | |
577 | } | |
578 | ||
e5382b6d MD |
579 | /* |
580 | * Supports event creation while tracing session is active. | |
3c997079 | 581 | * Needs to be called with sessions mutex held. |
e5382b6d | 582 | */ |
3c997079 MD |
583 | struct lttng_event *_lttng_event_create(struct lttng_channel *chan, |
584 | struct lttng_kernel_event *event_param, | |
585 | void *filter, | |
586 | const struct lttng_event_desc *event_desc, | |
587 | enum lttng_kernel_instrumentation itype) | |
4e3c1b9b | 588 | { |
3c997079 | 589 | struct lttng_session *session = chan->session; |
a90917c3 | 590 | struct lttng_event *event; |
3c997079 MD |
591 | const char *event_name; |
592 | struct hlist_head *head; | |
593 | size_t name_len; | |
594 | uint32_t hash; | |
3d084699 | 595 | int ret; |
4e3c1b9b | 596 | |
abc0446a | 597 | if (chan->free_event_id == -1U) { |
4cf0bf51 | 598 | ret = -EMFILE; |
e5382b6d | 599 | goto full; |
abc0446a | 600 | } |
3c997079 MD |
601 | |
602 | switch (itype) { | |
603 | case LTTNG_KERNEL_TRACEPOINT: | |
604 | event_name = event_desc->name; | |
605 | break; | |
606 | case LTTNG_KERNEL_KPROBE: | |
149b9a9d | 607 | case LTTNG_KERNEL_UPROBE: |
3c997079 | 608 | case LTTNG_KERNEL_KRETPROBE: |
3c997079 | 609 | case LTTNG_KERNEL_NOOP: |
33a39a3c | 610 | case LTTNG_KERNEL_SYSCALL: |
3c997079 MD |
611 | event_name = event_param->name; |
612 | break; | |
e884017c | 613 | case LTTNG_KERNEL_FUNCTION: /* Fall-through. */ |
3c997079 MD |
614 | default: |
615 | WARN_ON_ONCE(1); | |
616 | ret = -EINVAL; | |
617 | goto type_error; | |
618 | } | |
619 | name_len = strlen(event_name); | |
620 | hash = jhash(event_name, name_len, 0); | |
621 | head = &session->events_ht.table[hash & (LTTNG_EVENT_HT_SIZE - 1)]; | |
d216ecae | 622 | lttng_hlist_for_each_entry(event, head, hlist) { |
3c997079 MD |
623 | WARN_ON_ONCE(!event->desc); |
624 | if (!strncmp(event->desc->name, event_name, | |
625 | LTTNG_KERNEL_SYM_NAME_LEN - 1) | |
626 | && chan == event->chan) { | |
627 | ret = -EEXIST; | |
628 | goto exist; | |
abc0446a MD |
629 | } |
630 | } | |
3c997079 | 631 | |
11b5a3c2 | 632 | event = kmem_cache_zalloc(event_cache, GFP_KERNEL); |
abc0446a | 633 | if (!event) { |
4cf0bf51 | 634 | ret = -ENOMEM; |
4e3c1b9b | 635 | goto cache_error; |
abc0446a | 636 | } |
4e3c1b9b MD |
637 | event->chan = chan; |
638 | event->filter = filter; | |
e5382b6d | 639 | event->id = chan->free_event_id++; |
3c997079 MD |
640 | event->instrumentation = itype; |
641 | event->evtype = LTTNG_TYPE_EVENT; | |
07dfc1d0 | 642 | INIT_LIST_HEAD(&event->bytecode_runtime_head); |
3c997079 MD |
643 | INIT_LIST_HEAD(&event->enablers_ref_head); |
644 | ||
645 | switch (itype) { | |
ab2277d6 | 646 | case LTTNG_KERNEL_TRACEPOINT: |
3c997079 MD |
647 | /* Event will be enabled by enabler sync. */ |
648 | event->enabled = 0; | |
649 | event->registered = 0; | |
650 | event->desc = lttng_event_get(event_name); | |
abc0446a | 651 | if (!event->desc) { |
4cf0bf51 | 652 | ret = -ENOENT; |
d3dbe23c | 653 | goto register_error; |
abc0446a | 654 | } |
3c997079 MD |
655 | /* Populate lttng_event structure before event registration. */ |
656 | smp_wmb(); | |
baf20995 | 657 | break; |
ab2277d6 | 658 | case LTTNG_KERNEL_KPROBE: |
a0493bef MD |
659 | /* |
660 | * Needs to be explicitly enabled after creation, since | |
661 | * we may want to apply filters. | |
662 | */ | |
663 | event->enabled = 0; | |
3c997079 MD |
664 | event->registered = 1; |
665 | /* | |
666 | * Populate lttng_event structure before event | |
667 | * registration. | |
668 | */ | |
669 | smp_wmb(); | |
670 | ret = lttng_kprobes_register(event_name, | |
f17701fb MD |
671 | event_param->u.kprobe.symbol_name, |
672 | event_param->u.kprobe.offset, | |
673 | event_param->u.kprobe.addr, | |
674 | event); | |
abc0446a | 675 | if (ret) { |
4cf0bf51 | 676 | ret = -EINVAL; |
d6d808f3 | 677 | goto register_error; |
abc0446a | 678 | } |
edeb3137 MD |
679 | ret = try_module_get(event->desc->owner); |
680 | WARN_ON_ONCE(!ret); | |
d6d808f3 | 681 | break; |
7371f44c MD |
682 | case LTTNG_KERNEL_KRETPROBE: |
683 | { | |
a90917c3 | 684 | struct lttng_event *event_return; |
7371f44c MD |
685 | |
686 | /* kretprobe defines 2 events */ | |
a0493bef MD |
687 | /* |
688 | * Needs to be explicitly enabled after creation, since | |
689 | * we may want to apply filters. | |
690 | */ | |
691 | event->enabled = 0; | |
3c997079 | 692 | event->registered = 1; |
7371f44c MD |
693 | event_return = |
694 | kmem_cache_zalloc(event_cache, GFP_KERNEL); | |
abc0446a | 695 | if (!event_return) { |
4cf0bf51 | 696 | ret = -ENOMEM; |
7371f44c | 697 | goto register_error; |
abc0446a | 698 | } |
7371f44c MD |
699 | event_return->chan = chan; |
700 | event_return->filter = filter; | |
701 | event_return->id = chan->free_event_id++; | |
a0493bef | 702 | event_return->enabled = 0; |
3c997079 MD |
703 | event_return->registered = 1; |
704 | event_return->instrumentation = itype; | |
7371f44c | 705 | /* |
a90917c3 | 706 | * Populate lttng_event structure before kretprobe registration. |
7371f44c MD |
707 | */ |
708 | smp_wmb(); | |
3c997079 | 709 | ret = lttng_kretprobes_register(event_name, |
7371f44c MD |
710 | event_param->u.kretprobe.symbol_name, |
711 | event_param->u.kretprobe.offset, | |
712 | event_param->u.kretprobe.addr, | |
713 | event, event_return); | |
714 | if (ret) { | |
715 | kmem_cache_free(event_cache, event_return); | |
4cf0bf51 | 716 | ret = -EINVAL; |
7371f44c MD |
717 | goto register_error; |
718 | } | |
719 | /* Take 2 refs on the module: one per event. */ | |
720 | ret = try_module_get(event->desc->owner); | |
721 | WARN_ON_ONCE(!ret); | |
722 | ret = try_module_get(event->desc->owner); | |
723 | WARN_ON_ONCE(!ret); | |
a90917c3 | 724 | ret = _lttng_event_metadata_statedump(chan->session, chan, |
7371f44c | 725 | event_return); |
abc0446a | 726 | WARN_ON_ONCE(ret > 0); |
7371f44c MD |
727 | if (ret) { |
728 | kmem_cache_free(event_cache, event_return); | |
729 | module_put(event->desc->owner); | |
730 | module_put(event->desc->owner); | |
731 | goto statedump_error; | |
732 | } | |
733 | list_add(&event_return->list, &chan->session->events); | |
734 | break; | |
735 | } | |
1ec65de1 | 736 | case LTTNG_KERNEL_NOOP: |
33a39a3c | 737 | case LTTNG_KERNEL_SYSCALL: |
a0493bef MD |
738 | /* |
739 | * Needs to be explicitly enabled after creation, since | |
740 | * we may want to apply filters. | |
741 | */ | |
742 | event->enabled = 0; | |
3c997079 MD |
743 | event->registered = 0; |
744 | event->desc = event_desc; | |
abc0446a | 745 | if (!event->desc) { |
4cf0bf51 | 746 | ret = -EINVAL; |
259b6cb3 | 747 | goto register_error; |
abc0446a | 748 | } |
1ec65de1 | 749 | break; |
149b9a9d | 750 | case LTTNG_KERNEL_UPROBE: |
a344f64b FD |
751 | /* |
752 | * Needs to be explicitly enabled after creation, since | |
753 | * we may want to apply filters. | |
754 | */ | |
755 | event->enabled = 0; | |
756 | event->registered = 1; | |
3aed4dca | 757 | |
a344f64b FD |
758 | /* |
759 | * Populate lttng_event structure before event | |
760 | * registration. | |
761 | */ | |
762 | smp_wmb(); | |
149b9a9d YB |
763 | |
764 | ret = lttng_uprobes_register(event_param->name, | |
56377c91 | 765 | event_param->u.uprobe.fd, |
149b9a9d YB |
766 | event); |
767 | if (ret) | |
768 | goto register_error; | |
769 | ret = try_module_get(event->desc->owner); | |
770 | WARN_ON_ONCE(!ret); | |
771 | break; | |
e884017c | 772 | case LTTNG_KERNEL_FUNCTION: /* Fall-through */ |
baf20995 MD |
773 | default: |
774 | WARN_ON_ONCE(1); | |
4cf0bf51 | 775 | ret = -EINVAL; |
df07930b | 776 | goto register_error; |
baf20995 | 777 | } |
a90917c3 | 778 | ret = _lttng_event_metadata_statedump(chan->session, chan, event); |
abc0446a MD |
779 | WARN_ON_ONCE(ret > 0); |
780 | if (ret) { | |
c099397a | 781 | goto statedump_error; |
abc0446a | 782 | } |
3c997079 | 783 | hlist_add_head(&event->hlist, head); |
dda6a249 | 784 | list_add(&event->list, &chan->session->events); |
4e3c1b9b MD |
785 | return event; |
786 | ||
c099397a | 787 | statedump_error: |
259b6cb3 | 788 | /* If a statedump error occurs, events will not be readable. */ |
11b5a3c2 | 789 | register_error: |
11b5a3c2 | 790 | kmem_cache_free(event_cache, event); |
4e3c1b9b MD |
791 | cache_error: |
792 | exist: | |
3c997079 | 793 | type_error: |
e5382b6d | 794 | full: |
4cf0bf51 | 795 | return ERR_PTR(ret); |
4e3c1b9b MD |
796 | } |
797 | ||
3c997079 MD |
798 | struct lttng_event *lttng_event_create(struct lttng_channel *chan, |
799 | struct lttng_kernel_event *event_param, | |
800 | void *filter, | |
801 | const struct lttng_event_desc *event_desc, | |
802 | enum lttng_kernel_instrumentation itype) | |
803 | { | |
804 | struct lttng_event *event; | |
805 | ||
806 | mutex_lock(&sessions_mutex); | |
807 | event = _lttng_event_create(chan, event_param, filter, event_desc, | |
808 | itype); | |
809 | mutex_unlock(&sessions_mutex); | |
810 | return event; | |
811 | } | |
812 | ||
813 | /* Only used for tracepoints for now. */ | |
814 | static | |
815 | void register_event(struct lttng_event *event) | |
816 | { | |
817 | const struct lttng_event_desc *desc; | |
f127e61e | 818 | int ret = -EINVAL; |
3c997079 | 819 | |
3c997079 MD |
820 | if (event->registered) |
821 | return; | |
4ecb5ad5 | 822 | |
3c997079 | 823 | desc = event->desc; |
4ecb5ad5 MD |
824 | switch (event->instrumentation) { |
825 | case LTTNG_KERNEL_TRACEPOINT: | |
826 | ret = lttng_wrapper_tracepoint_probe_register(desc->kname, | |
827 | desc->probe_callback, | |
828 | event); | |
829 | break; | |
830 | case LTTNG_KERNEL_SYSCALL: | |
831 | ret = lttng_syscall_filter_enable(event->chan, | |
832 | desc->name); | |
833 | break; | |
834 | case LTTNG_KERNEL_KPROBE: | |
a344f64b | 835 | case LTTNG_KERNEL_UPROBE: |
4ecb5ad5 | 836 | case LTTNG_KERNEL_KRETPROBE: |
4ecb5ad5 MD |
837 | case LTTNG_KERNEL_NOOP: |
838 | ret = 0; | |
839 | break; | |
e884017c | 840 | case LTTNG_KERNEL_FUNCTION: /* Fall-through */ |
4ecb5ad5 MD |
841 | default: |
842 | WARN_ON_ONCE(1); | |
843 | } | |
3c997079 MD |
844 | if (!ret) |
845 | event->registered = 1; | |
846 | } | |
847 | ||
4e3c1b9b MD |
848 | /* |
849 | * Only used internally at session destruction. | |
850 | */ | |
a90917c3 | 851 | int _lttng_event_unregister(struct lttng_event *event) |
4e3c1b9b | 852 | { |
4ecb5ad5 | 853 | const struct lttng_event_desc *desc; |
11b5a3c2 MD |
854 | int ret = -EINVAL; |
855 | ||
3c997079 MD |
856 | if (!event->registered) |
857 | return 0; | |
858 | ||
4ecb5ad5 | 859 | desc = event->desc; |
38d024ae | 860 | switch (event->instrumentation) { |
ab2277d6 | 861 | case LTTNG_KERNEL_TRACEPOINT: |
20591cf7 | 862 | ret = lttng_wrapper_tracepoint_probe_unregister(event->desc->kname, |
85a9ca7f | 863 | event->desc->probe_callback, |
11b5a3c2 | 864 | event); |
baf20995 | 865 | break; |
ab2277d6 | 866 | case LTTNG_KERNEL_KPROBE: |
f17701fb | 867 | lttng_kprobes_unregister(event); |
d6d808f3 MD |
868 | ret = 0; |
869 | break; | |
7371f44c MD |
870 | case LTTNG_KERNEL_KRETPROBE: |
871 | lttng_kretprobes_unregister(event); | |
872 | ret = 0; | |
873 | break; | |
33a39a3c | 874 | case LTTNG_KERNEL_SYSCALL: |
4ecb5ad5 MD |
875 | ret = lttng_syscall_filter_disable(event->chan, |
876 | desc->name); | |
877 | break; | |
878 | case LTTNG_KERNEL_NOOP: | |
259b6cb3 MD |
879 | ret = 0; |
880 | break; | |
149b9a9d YB |
881 | case LTTNG_KERNEL_UPROBE: |
882 | lttng_uprobes_unregister(event); | |
883 | ret = 0; | |
884 | break; | |
e884017c | 885 | case LTTNG_KERNEL_FUNCTION: /* Fall-through */ |
baf20995 MD |
886 | default: |
887 | WARN_ON_ONCE(1); | |
888 | } | |
3c997079 MD |
889 | if (!ret) |
890 | event->registered = 0; | |
dda6a249 MD |
891 | return ret; |
892 | } | |
893 | ||
894 | /* | |
895 | * Only used internally at session destruction. | |
896 | */ | |
be066e6c | 897 | static |
a90917c3 | 898 | void _lttng_event_destroy(struct lttng_event *event) |
dda6a249 | 899 | { |
edeb3137 MD |
900 | switch (event->instrumentation) { |
901 | case LTTNG_KERNEL_TRACEPOINT: | |
a90917c3 | 902 | lttng_event_put(event->desc); |
edeb3137 MD |
903 | break; |
904 | case LTTNG_KERNEL_KPROBE: | |
905 | module_put(event->desc->owner); | |
906 | lttng_kprobes_destroy_private(event); | |
907 | break; | |
7371f44c MD |
908 | case LTTNG_KERNEL_KRETPROBE: |
909 | module_put(event->desc->owner); | |
910 | lttng_kretprobes_destroy_private(event); | |
911 | break; | |
259b6cb3 | 912 | case LTTNG_KERNEL_NOOP: |
33a39a3c | 913 | case LTTNG_KERNEL_SYSCALL: |
259b6cb3 | 914 | break; |
149b9a9d YB |
915 | case LTTNG_KERNEL_UPROBE: |
916 | module_put(event->desc->owner); | |
917 | lttng_uprobes_destroy_private(event); | |
918 | break; | |
e884017c | 919 | case LTTNG_KERNEL_FUNCTION: /* Fall-through */ |
edeb3137 MD |
920 | default: |
921 | WARN_ON_ONCE(1); | |
922 | } | |
dda6a249 | 923 | list_del(&event->list); |
8070f5c0 | 924 | lttng_destroy_context(event->ctx); |
11b5a3c2 | 925 | kmem_cache_free(event_cache, event); |
4e3c1b9b MD |
926 | } |
927 | ||
d1f652f8 MD |
928 | struct lttng_id_tracker *get_tracker(struct lttng_session *session, |
929 | enum tracker_type tracker_type) | |
e0130fab | 930 | { |
d1f652f8 MD |
931 | switch (tracker_type) { |
932 | case TRACKER_PID: | |
933 | return &session->pid_tracker; | |
934 | case TRACKER_VPID: | |
935 | return &session->vpid_tracker; | |
936 | case TRACKER_UID: | |
937 | return &session->uid_tracker; | |
938 | case TRACKER_VUID: | |
939 | return &session->vuid_tracker; | |
940 | case TRACKER_GID: | |
941 | return &session->gid_tracker; | |
942 | case TRACKER_VGID: | |
943 | return &session->vgid_tracker; | |
944 | default: | |
945 | WARN_ON_ONCE(1); | |
946 | return NULL; | |
947 | } | |
948 | } | |
949 | ||
950 | int lttng_session_track_id(struct lttng_session *session, | |
951 | enum tracker_type tracker_type, int id) | |
952 | { | |
953 | struct lttng_id_tracker *tracker; | |
e0130fab MD |
954 | int ret; |
955 | ||
d1f652f8 MD |
956 | tracker = get_tracker(session, tracker_type); |
957 | if (!tracker) | |
958 | return -EINVAL; | |
959 | if (id < -1) | |
e0130fab MD |
960 | return -EINVAL; |
961 | mutex_lock(&sessions_mutex); | |
d1f652f8 MD |
962 | if (id == -1) { |
963 | /* track all ids: destroy tracker. */ | |
964 | lttng_id_tracker_destroy(tracker, true); | |
e0130fab MD |
965 | ret = 0; |
966 | } else { | |
d1f652f8 | 967 | ret = lttng_id_tracker_add(tracker, id); |
e0130fab | 968 | } |
e0130fab MD |
969 | mutex_unlock(&sessions_mutex); |
970 | return ret; | |
971 | } | |
972 | ||
d1f652f8 MD |
973 | int lttng_session_untrack_id(struct lttng_session *session, |
974 | enum tracker_type tracker_type, int id) | |
e0130fab | 975 | { |
d1f652f8 | 976 | struct lttng_id_tracker *tracker; |
e0130fab MD |
977 | int ret; |
978 | ||
d1f652f8 MD |
979 | tracker = get_tracker(session, tracker_type); |
980 | if (!tracker) | |
981 | return -EINVAL; | |
982 | if (id < -1) | |
e0130fab MD |
983 | return -EINVAL; |
984 | mutex_lock(&sessions_mutex); | |
d1f652f8 MD |
985 | if (id == -1) { |
986 | /* untrack all ids: replace by empty tracker. */ | |
987 | ret = lttng_id_tracker_empty_set(tracker); | |
e0130fab | 988 | } else { |
d1f652f8 | 989 | ret = lttng_id_tracker_del(tracker, id); |
e0130fab | 990 | } |
e0130fab MD |
991 | mutex_unlock(&sessions_mutex); |
992 | return ret; | |
993 | } | |
994 | ||
7e6f9ef6 | 995 | static |
d1f652f8 | 996 | void *id_list_start(struct seq_file *m, loff_t *pos) |
7e6f9ef6 | 997 | { |
d1f652f8 MD |
998 | struct lttng_id_tracker *id_tracker = m->private; |
999 | struct lttng_id_tracker_rcu *id_tracker_p = id_tracker->p; | |
1000 | struct lttng_id_hash_node *e; | |
7e6f9ef6 MD |
1001 | int iter = 0, i; |
1002 | ||
1003 | mutex_lock(&sessions_mutex); | |
d1f652f8 MD |
1004 | if (id_tracker_p) { |
1005 | for (i = 0; i < LTTNG_ID_TABLE_SIZE; i++) { | |
1006 | struct hlist_head *head = &id_tracker_p->id_hash[i]; | |
7e6f9ef6 | 1007 | |
f934e302 | 1008 | lttng_hlist_for_each_entry(e, head, hlist) { |
7e6f9ef6 MD |
1009 | if (iter++ >= *pos) |
1010 | return e; | |
1011 | } | |
1012 | } | |
1013 | } else { | |
d1f652f8 | 1014 | /* ID tracker disabled. */ |
7e6f9ef6 | 1015 | if (iter >= *pos && iter == 0) { |
d1f652f8 | 1016 | return id_tracker_p; /* empty tracker */ |
7e6f9ef6 MD |
1017 | } |
1018 | iter++; | |
1019 | } | |
1020 | /* End of list */ | |
1021 | return NULL; | |
1022 | } | |
1023 | ||
1024 | /* Called with sessions_mutex held. */ | |
1025 | static | |
d1f652f8 | 1026 | void *id_list_next(struct seq_file *m, void *p, loff_t *ppos) |
7e6f9ef6 | 1027 | { |
d1f652f8 MD |
1028 | struct lttng_id_tracker *id_tracker = m->private; |
1029 | struct lttng_id_tracker_rcu *id_tracker_p = id_tracker->p; | |
1030 | struct lttng_id_hash_node *e; | |
7e6f9ef6 MD |
1031 | int iter = 0, i; |
1032 | ||
1033 | (*ppos)++; | |
d1f652f8 MD |
1034 | if (id_tracker_p) { |
1035 | for (i = 0; i < LTTNG_ID_TABLE_SIZE; i++) { | |
1036 | struct hlist_head *head = &id_tracker_p->id_hash[i]; | |
7e6f9ef6 | 1037 | |
f934e302 | 1038 | lttng_hlist_for_each_entry(e, head, hlist) { |
7e6f9ef6 MD |
1039 | if (iter++ >= *ppos) |
1040 | return e; | |
1041 | } | |
1042 | } | |
1043 | } else { | |
d1f652f8 | 1044 | /* ID tracker disabled. */ |
7e6f9ef6 | 1045 | if (iter >= *ppos && iter == 0) |
d1f652f8 | 1046 | return p; /* empty tracker */ |
7e6f9ef6 MD |
1047 | iter++; |
1048 | } | |
1049 | ||
1050 | /* End of list */ | |
1051 | return NULL; | |
1052 | } | |
1053 | ||
1054 | static | |
d1f652f8 | 1055 | void id_list_stop(struct seq_file *m, void *p) |
7e6f9ef6 MD |
1056 | { |
1057 | mutex_unlock(&sessions_mutex); | |
1058 | } | |
1059 | ||
1060 | static | |
d1f652f8 | 1061 | int id_list_show(struct seq_file *m, void *p) |
7e6f9ef6 | 1062 | { |
d1f652f8 MD |
1063 | struct lttng_id_tracker *id_tracker = m->private; |
1064 | struct lttng_id_tracker_rcu *id_tracker_p = id_tracker->p; | |
1065 | int id; | |
7e6f9ef6 | 1066 | |
d1f652f8 | 1067 | if (p == id_tracker_p) { |
7e6f9ef6 | 1068 | /* Tracker disabled. */ |
d1f652f8 | 1069 | id = -1; |
7e6f9ef6 | 1070 | } else { |
d1f652f8 | 1071 | const struct lttng_id_hash_node *e = p; |
7e6f9ef6 | 1072 | |
d1f652f8 MD |
1073 | id = lttng_id_tracker_get_node_id(e); |
1074 | } | |
1075 | switch (id_tracker->tracker_type) { | |
1076 | case TRACKER_PID: | |
1077 | seq_printf(m, "process { pid = %d; };\n", id); | |
1078 | break; | |
1079 | case TRACKER_VPID: | |
1080 | seq_printf(m, "process { vpid = %d; };\n", id); | |
1081 | break; | |
1082 | case TRACKER_UID: | |
1083 | seq_printf(m, "user { uid = %d; };\n", id); | |
1084 | break; | |
1085 | case TRACKER_VUID: | |
1086 | seq_printf(m, "user { vuid = %d; };\n", id); | |
1087 | break; | |
1088 | case TRACKER_GID: | |
1089 | seq_printf(m, "group { gid = %d; };\n", id); | |
1090 | break; | |
1091 | case TRACKER_VGID: | |
1092 | seq_printf(m, "group { vgid = %d; };\n", id); | |
1093 | break; | |
1094 | default: | |
1095 | seq_printf(m, "UNKNOWN { field = %d };\n", id); | |
7e6f9ef6 | 1096 | } |
7e6f9ef6 MD |
1097 | return 0; |
1098 | } | |
1099 | ||
1100 | static | |
d1f652f8 MD |
1101 | const struct seq_operations lttng_tracker_ids_list_seq_ops = { |
1102 | .start = id_list_start, | |
1103 | .next = id_list_next, | |
1104 | .stop = id_list_stop, | |
1105 | .show = id_list_show, | |
7e6f9ef6 MD |
1106 | }; |
1107 | ||
1108 | static | |
d1f652f8 | 1109 | int lttng_tracker_ids_list_open(struct inode *inode, struct file *file) |
7e6f9ef6 | 1110 | { |
d1f652f8 | 1111 | return seq_open(file, <tng_tracker_ids_list_seq_ops); |
7e6f9ef6 MD |
1112 | } |
1113 | ||
1114 | static | |
d1f652f8 | 1115 | int lttng_tracker_ids_list_release(struct inode *inode, struct file *file) |
7e6f9ef6 MD |
1116 | { |
1117 | struct seq_file *m = file->private_data; | |
d1f652f8 | 1118 | struct lttng_id_tracker *id_tracker = m->private; |
7e6f9ef6 MD |
1119 | int ret; |
1120 | ||
d1f652f8 | 1121 | WARN_ON_ONCE(!id_tracker); |
7e6f9ef6 | 1122 | ret = seq_release(inode, file); |
d1f652f8 MD |
1123 | if (!ret) |
1124 | fput(id_tracker->session->file); | |
7e6f9ef6 MD |
1125 | return ret; |
1126 | } | |
1127 | ||
d1f652f8 | 1128 | const struct file_operations lttng_tracker_ids_list_fops = { |
7e6f9ef6 | 1129 | .owner = THIS_MODULE, |
d1f652f8 | 1130 | .open = lttng_tracker_ids_list_open, |
7e6f9ef6 MD |
1131 | .read = seq_read, |
1132 | .llseek = seq_lseek, | |
d1f652f8 | 1133 | .release = lttng_tracker_ids_list_release, |
7e6f9ef6 MD |
1134 | }; |
1135 | ||
d1f652f8 MD |
1136 | int lttng_session_list_tracker_ids(struct lttng_session *session, |
1137 | enum tracker_type tracker_type) | |
7e6f9ef6 | 1138 | { |
d1f652f8 | 1139 | struct file *tracker_ids_list_file; |
7e6f9ef6 MD |
1140 | struct seq_file *m; |
1141 | int file_fd, ret; | |
1142 | ||
1143 | file_fd = lttng_get_unused_fd(); | |
1144 | if (file_fd < 0) { | |
1145 | ret = file_fd; | |
1146 | goto fd_error; | |
1147 | } | |
1148 | ||
d1f652f8 MD |
1149 | tracker_ids_list_file = anon_inode_getfile("[lttng_tracker_ids_list]", |
1150 | <tng_tracker_ids_list_fops, | |
7e6f9ef6 | 1151 | NULL, O_RDWR); |
d1f652f8 MD |
1152 | if (IS_ERR(tracker_ids_list_file)) { |
1153 | ret = PTR_ERR(tracker_ids_list_file); | |
7e6f9ef6 MD |
1154 | goto file_error; |
1155 | } | |
98d7281c MJ |
1156 | if (!atomic_long_add_unless(&session->file->f_count, 1, LONG_MAX)) { |
1157 | ret = -EOVERFLOW; | |
9c1f4643 MD |
1158 | goto refcount_error; |
1159 | } | |
d1f652f8 | 1160 | ret = lttng_tracker_ids_list_fops.open(NULL, tracker_ids_list_file); |
7e6f9ef6 MD |
1161 | if (ret < 0) |
1162 | goto open_error; | |
d1f652f8 MD |
1163 | m = tracker_ids_list_file->private_data; |
1164 | ||
1165 | m->private = get_tracker(session, tracker_type); | |
1166 | BUG_ON(!m->private); | |
1167 | fd_install(file_fd, tracker_ids_list_file); | |
7e6f9ef6 MD |
1168 | |
1169 | return file_fd; | |
1170 | ||
1171 | open_error: | |
9c1f4643 MD |
1172 | atomic_long_dec(&session->file->f_count); |
1173 | refcount_error: | |
d1f652f8 | 1174 | fput(tracker_ids_list_file); |
7e6f9ef6 MD |
1175 | file_error: |
1176 | put_unused_fd(file_fd); | |
1177 | fd_error: | |
1178 | return ret; | |
1179 | } | |
1180 | ||
3c997079 MD |
1181 | /* |
1182 | * Enabler management. | |
1183 | */ | |
1184 | static | |
4993071a PP |
1185 | int lttng_match_enabler_star_glob(const char *desc_name, |
1186 | const char *pattern) | |
3c997079 | 1187 | { |
cbc19040 MD |
1188 | if (!strutils_star_glob_match(pattern, LTTNG_SIZE_MAX, |
1189 | desc_name, LTTNG_SIZE_MAX)) | |
3c997079 MD |
1190 | return 0; |
1191 | return 1; | |
1192 | } | |
1193 | ||
1194 | static | |
4ecb5ad5 MD |
1195 | int lttng_match_enabler_name(const char *desc_name, |
1196 | const char *name) | |
3c997079 | 1197 | { |
4ecb5ad5 | 1198 | if (strcmp(desc_name, name)) |
3c997079 MD |
1199 | return 0; |
1200 | return 1; | |
1201 | } | |
1202 | ||
1203 | static | |
1204 | int lttng_desc_match_enabler(const struct lttng_event_desc *desc, | |
1205 | struct lttng_enabler *enabler) | |
1206 | { | |
4ecb5ad5 MD |
1207 | const char *desc_name, *enabler_name; |
1208 | ||
1209 | enabler_name = enabler->event_param.name; | |
1210 | switch (enabler->event_param.instrumentation) { | |
1211 | case LTTNG_KERNEL_TRACEPOINT: | |
1212 | desc_name = desc->name; | |
1213 | break; | |
1214 | case LTTNG_KERNEL_SYSCALL: | |
1215 | desc_name = desc->name; | |
1216 | if (!strncmp(desc_name, "compat_", strlen("compat_"))) | |
1217 | desc_name += strlen("compat_"); | |
1218 | if (!strncmp(desc_name, "syscall_exit_", | |
1219 | strlen("syscall_exit_"))) { | |
1220 | desc_name += strlen("syscall_exit_"); | |
1221 | } else if (!strncmp(desc_name, "syscall_entry_", | |
1222 | strlen("syscall_entry_"))) { | |
1223 | desc_name += strlen("syscall_entry_"); | |
1224 | } else { | |
1225 | WARN_ON_ONCE(1); | |
1226 | return -EINVAL; | |
1227 | } | |
1228 | break; | |
1229 | default: | |
1230 | WARN_ON_ONCE(1); | |
1231 | return -EINVAL; | |
1232 | } | |
3c997079 | 1233 | switch (enabler->type) { |
4993071a PP |
1234 | case LTTNG_ENABLER_STAR_GLOB: |
1235 | return lttng_match_enabler_star_glob(desc_name, enabler_name); | |
3c997079 | 1236 | case LTTNG_ENABLER_NAME: |
4ecb5ad5 | 1237 | return lttng_match_enabler_name(desc_name, enabler_name); |
3c997079 MD |
1238 | default: |
1239 | return -EINVAL; | |
1240 | } | |
1241 | } | |
1242 | ||
1243 | static | |
1244 | int lttng_event_match_enabler(struct lttng_event *event, | |
1245 | struct lttng_enabler *enabler) | |
1246 | { | |
33a39a3c MD |
1247 | if (enabler->event_param.instrumentation != event->instrumentation) |
1248 | return 0; | |
3c997079 MD |
1249 | if (lttng_desc_match_enabler(event->desc, enabler) |
1250 | && event->chan == enabler->chan) | |
1251 | return 1; | |
1252 | else | |
1253 | return 0; | |
1254 | } | |
1255 | ||
1256 | static | |
1257 | struct lttng_enabler_ref *lttng_event_enabler_ref(struct lttng_event *event, | |
1258 | struct lttng_enabler *enabler) | |
1259 | { | |
1260 | struct lttng_enabler_ref *enabler_ref; | |
1261 | ||
1262 | list_for_each_entry(enabler_ref, | |
1263 | &event->enablers_ref_head, node) { | |
1264 | if (enabler_ref->ref == enabler) | |
1265 | return enabler_ref; | |
1266 | } | |
1267 | return NULL; | |
1268 | } | |
1269 | ||
3c997079 | 1270 | static |
33a39a3c | 1271 | void lttng_create_tracepoint_if_missing(struct lttng_enabler *enabler) |
3c997079 MD |
1272 | { |
1273 | struct lttng_session *session = enabler->chan->session; | |
1274 | struct lttng_probe_desc *probe_desc; | |
1275 | const struct lttng_event_desc *desc; | |
1276 | int i; | |
1277 | struct list_head *probe_list; | |
1278 | ||
1279 | probe_list = lttng_get_probe_list_head(); | |
1280 | /* | |
1281 | * For each probe event, if we find that a probe event matches | |
1282 | * our enabler, create an associated lttng_event if not | |
1283 | * already present. | |
1284 | */ | |
1285 | list_for_each_entry(probe_desc, probe_list, head) { | |
1286 | for (i = 0; i < probe_desc->nr_events; i++) { | |
1287 | int found = 0; | |
1288 | struct hlist_head *head; | |
1289 | const char *event_name; | |
1290 | size_t name_len; | |
1291 | uint32_t hash; | |
1292 | struct lttng_event *event; | |
1293 | ||
1294 | desc = probe_desc->event_desc[i]; | |
1295 | if (!lttng_desc_match_enabler(desc, enabler)) | |
1296 | continue; | |
1297 | event_name = desc->name; | |
1298 | name_len = strlen(event_name); | |
1299 | ||
1300 | /* | |
1301 | * Check if already created. | |
1302 | */ | |
1303 | hash = jhash(event_name, name_len, 0); | |
1304 | head = &session->events_ht.table[hash & (LTTNG_EVENT_HT_SIZE - 1)]; | |
d216ecae | 1305 | lttng_hlist_for_each_entry(event, head, hlist) { |
3c997079 MD |
1306 | if (event->desc == desc |
1307 | && event->chan == enabler->chan) | |
1308 | found = 1; | |
1309 | } | |
1310 | if (found) | |
1311 | continue; | |
1312 | ||
1313 | /* | |
1314 | * We need to create an event for this | |
1315 | * event probe. | |
1316 | */ | |
1317 | event = _lttng_event_create(enabler->chan, | |
1318 | NULL, NULL, desc, | |
1319 | LTTNG_KERNEL_TRACEPOINT); | |
1320 | if (!event) { | |
1321 | printk(KERN_INFO "Unable to create event %s\n", | |
1322 | probe_desc->event_desc[i]->name); | |
1323 | } | |
1324 | } | |
1325 | } | |
1326 | } | |
1327 | ||
33a39a3c MD |
1328 | static |
1329 | void lttng_create_syscall_if_missing(struct lttng_enabler *enabler) | |
1330 | { | |
1331 | int ret; | |
1332 | ||
1333 | ret = lttng_syscalls_register(enabler->chan, NULL); | |
1334 | WARN_ON_ONCE(ret); | |
1335 | } | |
1336 | ||
1337 | /* | |
1338 | * Create struct lttng_event if it is missing and present in the list of | |
1339 | * tracepoint probes. | |
1340 | * Should be called with sessions mutex held. | |
1341 | */ | |
1342 | static | |
1343 | void lttng_create_event_if_missing(struct lttng_enabler *enabler) | |
1344 | { | |
1345 | switch (enabler->event_param.instrumentation) { | |
1346 | case LTTNG_KERNEL_TRACEPOINT: | |
1347 | lttng_create_tracepoint_if_missing(enabler); | |
1348 | break; | |
1349 | case LTTNG_KERNEL_SYSCALL: | |
1350 | lttng_create_syscall_if_missing(enabler); | |
1351 | break; | |
1352 | default: | |
1353 | WARN_ON_ONCE(1); | |
1354 | break; | |
1355 | } | |
1356 | } | |
1357 | ||
3c997079 MD |
1358 | /* |
1359 | * Create events associated with an enabler (if not already present), | |
1360 | * and add backward reference from the event to the enabler. | |
1361 | * Should be called with sessions mutex held. | |
1362 | */ | |
1363 | static | |
1364 | int lttng_enabler_ref_events(struct lttng_enabler *enabler) | |
1365 | { | |
1366 | struct lttng_session *session = enabler->chan->session; | |
1367 | struct lttng_event *event; | |
1368 | ||
1369 | /* First ensure that probe events are created for this enabler. */ | |
1370 | lttng_create_event_if_missing(enabler); | |
1371 | ||
1372 | /* For each event matching enabler in session event list. */ | |
1373 | list_for_each_entry(event, &session->events, list) { | |
1374 | struct lttng_enabler_ref *enabler_ref; | |
1375 | ||
1376 | if (!lttng_event_match_enabler(event, enabler)) | |
1377 | continue; | |
1378 | enabler_ref = lttng_event_enabler_ref(event, enabler); | |
1379 | if (!enabler_ref) { | |
1380 | /* | |
1381 | * If no backward ref, create it. | |
1382 | * Add backward ref from event to enabler. | |
1383 | */ | |
1384 | enabler_ref = kzalloc(sizeof(*enabler_ref), GFP_KERNEL); | |
1385 | if (!enabler_ref) | |
1386 | return -ENOMEM; | |
1387 | enabler_ref->ref = enabler; | |
1388 | list_add(&enabler_ref->node, | |
1389 | &event->enablers_ref_head); | |
1390 | } | |
1391 | ||
f127e61e MD |
1392 | /* |
1393 | * Link filter bytecodes if not linked yet. | |
1394 | */ | |
1395 | lttng_enabler_event_link_bytecode(event, enabler); | |
1396 | ||
3c997079 MD |
1397 | /* TODO: merge event context. */ |
1398 | } | |
1399 | return 0; | |
1400 | } | |
1401 | ||
1402 | /* | |
1403 | * Called at module load: connect the probe on all enablers matching | |
1404 | * this event. | |
1405 | * Called with sessions lock held. | |
1406 | */ | |
1407 | int lttng_fix_pending_events(void) | |
1408 | { | |
1409 | struct lttng_session *session; | |
1410 | ||
1411 | list_for_each_entry(session, &sessions, list) | |
1412 | lttng_session_lazy_sync_enablers(session); | |
1413 | return 0; | |
1414 | } | |
1415 | ||
1416 | struct lttng_enabler *lttng_enabler_create(enum lttng_enabler_type type, | |
1417 | struct lttng_kernel_event *event_param, | |
1418 | struct lttng_channel *chan) | |
1419 | { | |
1420 | struct lttng_enabler *enabler; | |
1421 | ||
1422 | enabler = kzalloc(sizeof(*enabler), GFP_KERNEL); | |
1423 | if (!enabler) | |
1424 | return NULL; | |
1425 | enabler->type = type; | |
07dfc1d0 | 1426 | INIT_LIST_HEAD(&enabler->filter_bytecode_head); |
3c997079 MD |
1427 | memcpy(&enabler->event_param, event_param, |
1428 | sizeof(enabler->event_param)); | |
1429 | enabler->chan = chan; | |
1430 | /* ctx left NULL */ | |
4fd19d8a | 1431 | enabler->enabled = 0; |
3c997079 MD |
1432 | enabler->evtype = LTTNG_TYPE_ENABLER; |
1433 | mutex_lock(&sessions_mutex); | |
1434 | list_add(&enabler->node, &enabler->chan->session->enablers_head); | |
1435 | lttng_session_lazy_sync_enablers(enabler->chan->session); | |
1436 | mutex_unlock(&sessions_mutex); | |
1437 | return enabler; | |
1438 | } | |
1439 | ||
1440 | int lttng_enabler_enable(struct lttng_enabler *enabler) | |
1441 | { | |
1442 | mutex_lock(&sessions_mutex); | |
1443 | enabler->enabled = 1; | |
1444 | lttng_session_lazy_sync_enablers(enabler->chan->session); | |
1445 | mutex_unlock(&sessions_mutex); | |
1446 | return 0; | |
1447 | } | |
1448 | ||
1449 | int lttng_enabler_disable(struct lttng_enabler *enabler) | |
1450 | { | |
1451 | mutex_lock(&sessions_mutex); | |
1452 | enabler->enabled = 0; | |
1453 | lttng_session_lazy_sync_enablers(enabler->chan->session); | |
1454 | mutex_unlock(&sessions_mutex); | |
1455 | return 0; | |
1456 | } | |
1457 | ||
07dfc1d0 MD |
1458 | int lttng_enabler_attach_bytecode(struct lttng_enabler *enabler, |
1459 | struct lttng_kernel_filter_bytecode __user *bytecode) | |
1460 | { | |
1461 | struct lttng_filter_bytecode_node *bytecode_node; | |
1462 | uint32_t bytecode_len; | |
1463 | int ret; | |
1464 | ||
1465 | ret = get_user(bytecode_len, &bytecode->len); | |
1466 | if (ret) | |
1467 | return ret; | |
1468 | bytecode_node = kzalloc(sizeof(*bytecode_node) + bytecode_len, | |
1469 | GFP_KERNEL); | |
1470 | if (!bytecode_node) | |
1471 | return -ENOMEM; | |
1472 | ret = copy_from_user(&bytecode_node->bc, bytecode, | |
1473 | sizeof(*bytecode) + bytecode_len); | |
1474 | if (ret) | |
1475 | goto error_free; | |
1476 | bytecode_node->enabler = enabler; | |
1477 | /* Enforce length based on allocated size */ | |
1478 | bytecode_node->bc.len = bytecode_len; | |
1479 | list_add_tail(&bytecode_node->node, &enabler->filter_bytecode_head); | |
1480 | lttng_session_lazy_sync_enablers(enabler->chan->session); | |
1481 | return 0; | |
1482 | ||
1483 | error_free: | |
1484 | kfree(bytecode_node); | |
1485 | return ret; | |
1486 | } | |
1487 | ||
3aed4dca FD |
1488 | int lttng_event_add_callsite(struct lttng_event *event, |
1489 | struct lttng_kernel_event_callsite __user *callsite) | |
1490 | { | |
1491 | ||
1492 | switch (event->instrumentation) { | |
1493 | case LTTNG_KERNEL_UPROBE: | |
1494 | return lttng_uprobes_add_callsite(event, callsite); | |
1495 | default: | |
1496 | return -EINVAL; | |
1497 | } | |
1498 | } | |
1499 | ||
3c997079 MD |
1500 | int lttng_enabler_attach_context(struct lttng_enabler *enabler, |
1501 | struct lttng_kernel_context *context_param) | |
1502 | { | |
1503 | return -ENOSYS; | |
1504 | } | |
1505 | ||
1506 | static | |
1507 | void lttng_enabler_destroy(struct lttng_enabler *enabler) | |
1508 | { | |
07dfc1d0 MD |
1509 | struct lttng_filter_bytecode_node *filter_node, *tmp_filter_node; |
1510 | ||
1511 | /* Destroy filter bytecode */ | |
1512 | list_for_each_entry_safe(filter_node, tmp_filter_node, | |
1513 | &enabler->filter_bytecode_head, node) { | |
1514 | kfree(filter_node); | |
1515 | } | |
1516 | ||
3c997079 MD |
1517 | /* Destroy contexts */ |
1518 | lttng_destroy_context(enabler->ctx); | |
1519 | ||
1520 | list_del(&enabler->node); | |
1521 | kfree(enabler); | |
1522 | } | |
1523 | ||
1524 | /* | |
1525 | * lttng_session_sync_enablers should be called just before starting a | |
1526 | * session. | |
1527 | * Should be called with sessions mutex held. | |
1528 | */ | |
1529 | static | |
1530 | void lttng_session_sync_enablers(struct lttng_session *session) | |
1531 | { | |
1532 | struct lttng_enabler *enabler; | |
1533 | struct lttng_event *event; | |
1534 | ||
1535 | list_for_each_entry(enabler, &session->enablers_head, node) | |
1536 | lttng_enabler_ref_events(enabler); | |
1537 | /* | |
1538 | * For each event, if at least one of its enablers is enabled, | |
1539 | * and its channel and session transient states are enabled, we | |
1540 | * enable the event, else we disable it. | |
1541 | */ | |
1542 | list_for_each_entry(event, &session->events, list) { | |
1543 | struct lttng_enabler_ref *enabler_ref; | |
07dfc1d0 MD |
1544 | struct lttng_bytecode_runtime *runtime; |
1545 | int enabled = 0, has_enablers_without_bytecode = 0; | |
3c997079 | 1546 | |
4ecb5ad5 MD |
1547 | switch (event->instrumentation) { |
1548 | case LTTNG_KERNEL_TRACEPOINT: | |
1549 | case LTTNG_KERNEL_SYSCALL: | |
3c997079 MD |
1550 | /* Enable events */ |
1551 | list_for_each_entry(enabler_ref, | |
1552 | &event->enablers_ref_head, node) { | |
1553 | if (enabler_ref->ref->enabled) { | |
1554 | enabled = 1; | |
1555 | break; | |
1556 | } | |
1557 | } | |
4ecb5ad5 MD |
1558 | break; |
1559 | default: | |
3c997079 MD |
1560 | /* Not handled with lazy sync. */ |
1561 | continue; | |
1562 | } | |
1563 | /* | |
1564 | * Enabled state is based on union of enablers, with | |
1565 | * intesection of session and channel transient enable | |
1566 | * states. | |
1567 | */ | |
1568 | enabled = enabled && session->tstate && event->chan->tstate; | |
1569 | ||
a8f2d0c7 | 1570 | WRITE_ONCE(event->enabled, enabled); |
3c997079 MD |
1571 | /* |
1572 | * Sync tracepoint registration with event enabled | |
1573 | * state. | |
1574 | */ | |
1575 | if (enabled) { | |
1576 | register_event(event); | |
1577 | } else { | |
1578 | _lttng_event_unregister(event); | |
1579 | } | |
07dfc1d0 MD |
1580 | |
1581 | /* Check if has enablers without bytecode enabled */ | |
1582 | list_for_each_entry(enabler_ref, | |
1583 | &event->enablers_ref_head, node) { | |
1584 | if (enabler_ref->ref->enabled | |
1585 | && list_empty(&enabler_ref->ref->filter_bytecode_head)) { | |
1586 | has_enablers_without_bytecode = 1; | |
1587 | break; | |
1588 | } | |
1589 | } | |
1590 | event->has_enablers_without_bytecode = | |
1591 | has_enablers_without_bytecode; | |
1592 | ||
1593 | /* Enable filters */ | |
1594 | list_for_each_entry(runtime, | |
f127e61e | 1595 | &event->bytecode_runtime_head, node) |
07dfc1d0 | 1596 | lttng_filter_sync_state(runtime); |
3c997079 MD |
1597 | } |
1598 | } | |
1599 | ||
1600 | /* | |
1601 | * Apply enablers to session events, adding events to session if need | |
1602 | * be. It is required after each modification applied to an active | |
1603 | * session, and right before session "start". | |
1604 | * "lazy" sync means we only sync if required. | |
1605 | * Should be called with sessions mutex held. | |
1606 | */ | |
1607 | static | |
1608 | void lttng_session_lazy_sync_enablers(struct lttng_session *session) | |
1609 | { | |
1610 | /* We can skip if session is not active */ | |
1611 | if (!session->active) | |
1612 | return; | |
1613 | lttng_session_sync_enablers(session); | |
1614 | } | |
1615 | ||
1ec3f75a | 1616 | /* |
d83004aa JD |
1617 | * Serialize at most one packet worth of metadata into a metadata |
1618 | * channel. | |
92d9f5e6 MD |
1619 | * We grab the metadata cache mutex to get exclusive access to our metadata |
1620 | * buffer and to the metadata cache. Exclusive access to the metadata buffer | |
1621 | * allows us to do racy operations such as looking for remaining space left in | |
1622 | * packet and write, since mutual exclusion protects us from concurrent writes. | |
1623 | * Mutual exclusion on the metadata cache allow us to read the cache content | |
1624 | * without racing against reallocation of the cache by updates. | |
35097f36 JD |
1625 | * Returns the number of bytes written in the channel, 0 if no data |
1626 | * was written and a negative value on error. | |
1ec3f75a | 1627 | */ |
b3b8072b MD |
1628 | int lttng_metadata_output_channel(struct lttng_metadata_stream *stream, |
1629 | struct channel *chan) | |
d83004aa JD |
1630 | { |
1631 | struct lib_ring_buffer_ctx ctx; | |
1632 | int ret = 0; | |
1633 | size_t len, reserve_len; | |
1634 | ||
f613e3e6 | 1635 | /* |
92d9f5e6 MD |
1636 | * Ensure we support mutiple get_next / put sequences followed by |
1637 | * put_next. The metadata cache lock protects reading the metadata | |
1638 | * cache. It can indeed be read concurrently by "get_next_subbuf" and | |
1639 | * "flush" operations on the buffer invoked by different processes. | |
1640 | * Moreover, since the metadata cache memory can be reallocated, we | |
1641 | * need to have exclusive access against updates even though we only | |
1642 | * read it. | |
f613e3e6 | 1643 | */ |
92d9f5e6 | 1644 | mutex_lock(&stream->metadata_cache->lock); |
f613e3e6 MD |
1645 | WARN_ON(stream->metadata_in < stream->metadata_out); |
1646 | if (stream->metadata_in != stream->metadata_out) | |
de23d59d | 1647 | goto end; |
f613e3e6 | 1648 | |
9616f0bf JD |
1649 | /* Metadata regenerated, change the version. */ |
1650 | if (stream->metadata_cache->version != stream->version) | |
1651 | stream->version = stream->metadata_cache->version; | |
1652 | ||
d83004aa | 1653 | len = stream->metadata_cache->metadata_written - |
f613e3e6 | 1654 | stream->metadata_in; |
9de2c215 | 1655 | if (!len) |
de23d59d | 1656 | goto end; |
d83004aa | 1657 | reserve_len = min_t(size_t, |
b3b8072b | 1658 | stream->transport->ops.packet_avail_size(chan), |
d83004aa | 1659 | len); |
b3b8072b | 1660 | lib_ring_buffer_ctx_init(&ctx, chan, NULL, reserve_len, |
d83004aa JD |
1661 | sizeof(char), -1); |
1662 | /* | |
1663 | * If reservation failed, return an error to the caller. | |
1664 | */ | |
b3b8072b | 1665 | ret = stream->transport->ops.event_reserve(&ctx, 0); |
d83004aa JD |
1666 | if (ret != 0) { |
1667 | printk(KERN_WARNING "LTTng: Metadata event reservation failed\n"); | |
1668 | goto end; | |
1669 | } | |
b3b8072b | 1670 | stream->transport->ops.event_write(&ctx, |
f613e3e6 | 1671 | stream->metadata_cache->data + stream->metadata_in, |
d83004aa | 1672 | reserve_len); |
b3b8072b | 1673 | stream->transport->ops.event_commit(&ctx); |
f613e3e6 | 1674 | stream->metadata_in += reserve_len; |
d83004aa JD |
1675 | ret = reserve_len; |
1676 | ||
1677 | end: | |
92d9f5e6 | 1678 | mutex_unlock(&stream->metadata_cache->lock); |
d83004aa JD |
1679 | return ret; |
1680 | } | |
1681 | ||
1682 | /* | |
1683 | * Write the metadata to the metadata cache. | |
1684 | * Must be called with sessions_mutex held. | |
92d9f5e6 MD |
1685 | * The metadata cache lock protects us from concurrent read access from |
1686 | * thread outputting metadata content to ring buffer. | |
d83004aa | 1687 | */ |
a90917c3 | 1688 | int lttng_metadata_printf(struct lttng_session *session, |
c099397a MD |
1689 | const char *fmt, ...) |
1690 | { | |
c099397a | 1691 | char *str; |
d83004aa | 1692 | size_t len; |
c099397a | 1693 | va_list ap; |
d83004aa | 1694 | struct lttng_metadata_stream *stream; |
c099397a | 1695 | |
a8f2d0c7 | 1696 | WARN_ON_ONCE(!READ_ONCE(session->active)); |
c099397a MD |
1697 | |
1698 | va_start(ap, fmt); | |
1699 | str = kvasprintf(GFP_KERNEL, fmt, ap); | |
1700 | va_end(ap); | |
1701 | if (!str) | |
1702 | return -ENOMEM; | |
1703 | ||
1ec3f75a | 1704 | len = strlen(str); |
92d9f5e6 | 1705 | mutex_lock(&session->metadata_cache->lock); |
d83004aa JD |
1706 | if (session->metadata_cache->metadata_written + len > |
1707 | session->metadata_cache->cache_alloc) { | |
1708 | char *tmp_cache_realloc; | |
1709 | unsigned int tmp_cache_alloc_size; | |
1710 | ||
1711 | tmp_cache_alloc_size = max_t(unsigned int, | |
1712 | session->metadata_cache->cache_alloc + len, | |
1713 | session->metadata_cache->cache_alloc << 1); | |
0ca42eb7 | 1714 | tmp_cache_realloc = vzalloc(tmp_cache_alloc_size); |
d83004aa JD |
1715 | if (!tmp_cache_realloc) |
1716 | goto err; | |
a606b6e8 ML |
1717 | if (session->metadata_cache->data) { |
1718 | memcpy(tmp_cache_realloc, | |
1719 | session->metadata_cache->data, | |
1720 | session->metadata_cache->cache_alloc); | |
1721 | vfree(session->metadata_cache->data); | |
1722 | } | |
1723 | ||
d83004aa JD |
1724 | session->metadata_cache->cache_alloc = tmp_cache_alloc_size; |
1725 | session->metadata_cache->data = tmp_cache_realloc; | |
c099397a | 1726 | } |
d83004aa JD |
1727 | memcpy(session->metadata_cache->data + |
1728 | session->metadata_cache->metadata_written, | |
1729 | str, len); | |
1730 | session->metadata_cache->metadata_written += len; | |
92d9f5e6 | 1731 | mutex_unlock(&session->metadata_cache->lock); |
c099397a | 1732 | kfree(str); |
d83004aa JD |
1733 | |
1734 | list_for_each_entry(stream, &session->metadata_cache->metadata_stream, list) | |
1735 | wake_up_interruptible(&stream->read_wait); | |
1736 | ||
1737 | return 0; | |
1738 | ||
1739 | err: | |
92d9f5e6 | 1740 | mutex_unlock(&session->metadata_cache->lock); |
d83004aa JD |
1741 | kfree(str); |
1742 | return -ENOMEM; | |
c099397a MD |
1743 | } |
1744 | ||
f513b2bf MD |
1745 | static |
1746 | int print_tabs(struct lttng_session *session, size_t nesting) | |
1747 | { | |
1748 | size_t i; | |
1749 | ||
1750 | for (i = 0; i < nesting; i++) { | |
1751 | int ret; | |
1752 | ||
1753 | ret = lttng_metadata_printf(session, " "); | |
1754 | if (ret) { | |
1755 | return ret; | |
1756 | } | |
1757 | } | |
1758 | return 0; | |
1759 | } | |
1760 | ||
ceabb767 MD |
1761 | static |
1762 | int lttng_field_name_statedump(struct lttng_session *session, | |
1763 | const struct lttng_event_field *field, | |
1764 | size_t nesting) | |
1765 | { | |
1766 | return lttng_metadata_printf(session, " _%s;\n", field->name); | |
1767 | } | |
1768 | ||
1769 | static | |
1770 | int _lttng_integer_type_statedump(struct lttng_session *session, | |
1771 | const struct lttng_type *type, | |
1772 | size_t nesting) | |
1773 | { | |
1774 | int ret; | |
1775 | ||
1776 | WARN_ON_ONCE(type->atype != atype_integer); | |
1777 | ret = print_tabs(session, nesting); | |
1778 | if (ret) | |
1779 | return ret; | |
1780 | ret = lttng_metadata_printf(session, | |
1781 | "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s }", | |
1782 | type->u.integer.size, | |
1783 | type->u.integer.alignment, | |
1784 | type->u.integer.signedness, | |
1785 | (type->u.integer.encoding == lttng_encode_none) | |
1786 | ? "none" | |
1787 | : (type->u.integer.encoding == lttng_encode_UTF8) | |
1788 | ? "UTF8" | |
1789 | : "ASCII", | |
1790 | type->u.integer.base, | |
1791 | #if __BYTE_ORDER == __BIG_ENDIAN | |
1792 | type->u.integer.reverse_byte_order ? " byte_order = le;" : "" | |
1793 | #else | |
1794 | type->u.integer.reverse_byte_order ? " byte_order = be;" : "" | |
1795 | #endif | |
1796 | ); | |
1797 | return ret; | |
1798 | } | |
1799 | ||
f513b2bf MD |
1800 | /* |
1801 | * Must be called with sessions_mutex held. | |
1802 | */ | |
1803 | static | |
1804 | int _lttng_struct_type_statedump(struct lttng_session *session, | |
1805 | const struct lttng_type *type, | |
1806 | size_t nesting) | |
1807 | { | |
1808 | int ret; | |
1809 | uint32_t i, nr_fields; | |
ceabb767 MD |
1810 | unsigned int alignment; |
1811 | ||
1812 | WARN_ON_ONCE(type->atype != atype_struct_nestable); | |
f513b2bf MD |
1813 | |
1814 | ret = print_tabs(session, nesting); | |
1815 | if (ret) | |
1816 | return ret; | |
1817 | ret = lttng_metadata_printf(session, | |
1818 | "struct {\n"); | |
1819 | if (ret) | |
1820 | return ret; | |
ceabb767 | 1821 | nr_fields = type->u.struct_nestable.nr_fields; |
f513b2bf MD |
1822 | for (i = 0; i < nr_fields; i++) { |
1823 | const struct lttng_event_field *iter_field; | |
1824 | ||
ceabb767 | 1825 | iter_field = &type->u.struct_nestable.fields[i]; |
f513b2bf MD |
1826 | ret = _lttng_field_statedump(session, iter_field, nesting + 1); |
1827 | if (ret) | |
1828 | return ret; | |
1829 | } | |
1830 | ret = print_tabs(session, nesting); | |
1831 | if (ret) | |
1832 | return ret; | |
ceabb767 MD |
1833 | alignment = type->u.struct_nestable.alignment; |
1834 | if (alignment) { | |
1835 | ret = lttng_metadata_printf(session, | |
1836 | "} align(%u)", | |
1837 | alignment); | |
1838 | } else { | |
1839 | ret = lttng_metadata_printf(session, | |
1840 | "}"); | |
1841 | } | |
f513b2bf MD |
1842 | return ret; |
1843 | } | |
1844 | ||
1845 | /* | |
1846 | * Must be called with sessions_mutex held. | |
1847 | */ | |
1848 | static | |
ceabb767 | 1849 | int _lttng_struct_field_statedump(struct lttng_session *session, |
f513b2bf MD |
1850 | const struct lttng_event_field *field, |
1851 | size_t nesting) | |
1852 | { | |
1853 | int ret; | |
1854 | ||
1855 | ret = _lttng_struct_type_statedump(session, | |
1856 | &field->type, nesting); | |
1857 | if (ret) | |
1858 | return ret; | |
ceabb767 | 1859 | return lttng_field_name_statedump(session, field, nesting); |
f513b2bf MD |
1860 | } |
1861 | ||
65c85aa6 MD |
1862 | /* |
1863 | * Must be called with sessions_mutex held. | |
1864 | */ | |
1865 | static | |
1866 | int _lttng_variant_type_statedump(struct lttng_session *session, | |
1867 | const struct lttng_type *type, | |
1868 | size_t nesting) | |
1869 | { | |
1870 | int ret; | |
1871 | uint32_t i, nr_choices; | |
1872 | ||
ceabb767 MD |
1873 | WARN_ON_ONCE(type->atype != atype_variant_nestable); |
1874 | /* | |
1875 | * CTF 1.8 does not allow expressing nonzero variant alignment in a nestable way. | |
1876 | */ | |
1877 | if (type->u.variant_nestable.alignment != 0) | |
1878 | return -EINVAL; | |
65c85aa6 MD |
1879 | ret = print_tabs(session, nesting); |
1880 | if (ret) | |
1881 | return ret; | |
1882 | ret = lttng_metadata_printf(session, | |
1883 | "variant <_%s> {\n", | |
ceabb767 | 1884 | type->u.variant_nestable.tag_name); |
65c85aa6 MD |
1885 | if (ret) |
1886 | return ret; | |
ceabb767 | 1887 | nr_choices = type->u.variant_nestable.nr_choices; |
65c85aa6 MD |
1888 | for (i = 0; i < nr_choices; i++) { |
1889 | const struct lttng_event_field *iter_field; | |
1890 | ||
ceabb767 | 1891 | iter_field = &type->u.variant_nestable.choices[i]; |
65c85aa6 MD |
1892 | ret = _lttng_field_statedump(session, iter_field, nesting + 1); |
1893 | if (ret) | |
1894 | return ret; | |
1895 | } | |
1896 | ret = print_tabs(session, nesting); | |
1897 | if (ret) | |
1898 | return ret; | |
1899 | ret = lttng_metadata_printf(session, | |
1900 | "}"); | |
1901 | return ret; | |
1902 | } | |
1903 | ||
1904 | /* | |
1905 | * Must be called with sessions_mutex held. | |
1906 | */ | |
1907 | static | |
ceabb767 | 1908 | int _lttng_variant_field_statedump(struct lttng_session *session, |
65c85aa6 MD |
1909 | const struct lttng_event_field *field, |
1910 | size_t nesting) | |
1911 | { | |
1912 | int ret; | |
1913 | ||
1914 | ret = _lttng_variant_type_statedump(session, | |
1915 | &field->type, nesting); | |
1916 | if (ret) | |
1917 | return ret; | |
ceabb767 | 1918 | return lttng_field_name_statedump(session, field, nesting); |
65c85aa6 MD |
1919 | } |
1920 | ||
f513b2bf MD |
1921 | /* |
1922 | * Must be called with sessions_mutex held. | |
1923 | */ | |
1924 | static | |
ceabb767 | 1925 | int _lttng_array_field_statedump(struct lttng_session *session, |
f513b2bf MD |
1926 | const struct lttng_event_field *field, |
1927 | size_t nesting) | |
1928 | { | |
1929 | int ret; | |
1930 | const struct lttng_type *elem_type; | |
1931 | ||
ceabb767 MD |
1932 | WARN_ON_ONCE(field->type.atype != atype_array_nestable); |
1933 | ||
1934 | if (field->type.u.array_nestable.alignment) { | |
1935 | ret = print_tabs(session, nesting); | |
f513b2bf MD |
1936 | if (ret) |
1937 | return ret; | |
ceabb767 MD |
1938 | ret = lttng_metadata_printf(session, |
1939 | "struct { } align(%u) _%s_padding;\n", | |
1940 | field->type.u.array_nestable.alignment * CHAR_BIT, | |
1941 | field->name); | |
1942 | if (ret) | |
1943 | return ret; | |
1944 | } | |
1945 | /* | |
1946 | * Nested compound types: Only array of structures and variants are | |
1947 | * currently supported. | |
1948 | */ | |
1949 | elem_type = field->type.u.array_nestable.elem_type; | |
1950 | switch (elem_type->atype) { | |
1951 | case atype_integer: | |
1952 | case atype_struct_nestable: | |
1953 | case atype_variant_nestable: | |
1954 | ret = _lttng_type_statedump(session, elem_type, nesting); | |
65c85aa6 MD |
1955 | if (ret) |
1956 | return ret; | |
1957 | break; | |
ceabb767 | 1958 | |
f513b2bf MD |
1959 | default: |
1960 | return -EINVAL; | |
1961 | } | |
1962 | ret = lttng_metadata_printf(session, | |
1963 | " _%s[%u];\n", | |
1964 | field->name, | |
ceabb767 | 1965 | field->type.u.array_nestable.length); |
f513b2bf MD |
1966 | return ret; |
1967 | } | |
1968 | ||
1969 | /* | |
1970 | * Must be called with sessions_mutex held. | |
1971 | */ | |
1972 | static | |
ceabb767 | 1973 | int _lttng_sequence_field_statedump(struct lttng_session *session, |
f513b2bf MD |
1974 | const struct lttng_event_field *field, |
1975 | size_t nesting) | |
1976 | { | |
1977 | int ret; | |
1978 | const char *length_name; | |
1979 | const struct lttng_type *elem_type; | |
1980 | ||
ceabb767 | 1981 | WARN_ON_ONCE(field->type.atype != atype_sequence_nestable); |
f513b2bf | 1982 | |
ceabb767 MD |
1983 | length_name = field->type.u.sequence_nestable.length_name; |
1984 | ||
1985 | if (field->type.u.sequence_nestable.alignment) { | |
1986 | ret = print_tabs(session, nesting); | |
f513b2bf MD |
1987 | if (ret) |
1988 | return ret; | |
ceabb767 MD |
1989 | ret = lttng_metadata_printf(session, |
1990 | "struct { } align(%u) _%s_padding;\n", | |
1991 | field->type.u.sequence_nestable.alignment * CHAR_BIT, | |
1992 | field->name); | |
1993 | if (ret) | |
1994 | return ret; | |
1995 | } | |
1996 | ||
1997 | /* | |
1998 | * Nested compound types: Only array of structures and variants are | |
1999 | * currently supported. | |
2000 | */ | |
2001 | elem_type = field->type.u.sequence_nestable.elem_type; | |
2002 | switch (elem_type->atype) { | |
2003 | case atype_integer: | |
2004 | case atype_struct_nestable: | |
2005 | case atype_variant_nestable: | |
2006 | ret = _lttng_type_statedump(session, elem_type, nesting); | |
65c85aa6 MD |
2007 | if (ret) |
2008 | return ret; | |
2009 | break; | |
ceabb767 | 2010 | |
f513b2bf MD |
2011 | default: |
2012 | return -EINVAL; | |
2013 | } | |
2014 | ret = lttng_metadata_printf(session, | |
2015 | " _%s[ _%s ];\n", | |
2016 | field->name, | |
ceabb767 | 2017 | field->type.u.sequence_nestable.length_name); |
f513b2bf MD |
2018 | return ret; |
2019 | } | |
2020 | ||
141ddf28 MD |
2021 | /* |
2022 | * Must be called with sessions_mutex held. | |
2023 | */ | |
2024 | static | |
ceabb767 MD |
2025 | int _lttng_enum_type_statedump(struct lttng_session *session, |
2026 | const struct lttng_type *type, | |
141ddf28 MD |
2027 | size_t nesting) |
2028 | { | |
2029 | const struct lttng_enum_desc *enum_desc; | |
ceabb767 | 2030 | const struct lttng_type *container_type; |
141ddf28 MD |
2031 | int ret; |
2032 | unsigned int i, nr_entries; | |
2033 | ||
ceabb767 MD |
2034 | container_type = type->u.enum_nestable.container_type; |
2035 | if (container_type->atype != atype_integer) { | |
2036 | ret = -EINVAL; | |
2037 | goto end; | |
2038 | } | |
2039 | enum_desc = type->u.enum_nestable.desc; | |
141ddf28 MD |
2040 | nr_entries = enum_desc->nr_entries; |
2041 | ||
2042 | ret = print_tabs(session, nesting); | |
2043 | if (ret) | |
2044 | goto end; | |
ceabb767 MD |
2045 | ret = lttng_metadata_printf(session, "enum : "); |
2046 | if (ret) | |
2047 | goto end; | |
2048 | ret = _lttng_integer_type_statedump(session, container_type, 0); | |
141ddf28 | 2049 | if (ret) |
ceabb767 MD |
2050 | goto end; |
2051 | ret = lttng_metadata_printf(session, " {\n"); | |
2052 | if (ret) | |
2053 | goto end; | |
141ddf28 MD |
2054 | /* Dump all entries */ |
2055 | for (i = 0; i < nr_entries; i++) { | |
2056 | const struct lttng_enum_entry *entry = &enum_desc->entries[i]; | |
2057 | int j, len; | |
2058 | ||
2059 | ret = print_tabs(session, nesting + 1); | |
2060 | if (ret) | |
2061 | goto end; | |
2062 | ret = lttng_metadata_printf(session, | |
2063 | "\""); | |
2064 | if (ret) | |
2065 | goto end; | |
2066 | len = strlen(entry->string); | |
2067 | /* Escape the character '"' */ | |
2068 | for (j = 0; j < len; j++) { | |
2069 | char c = entry->string[j]; | |
2070 | ||
2071 | switch (c) { | |
2072 | case '"': | |
2073 | ret = lttng_metadata_printf(session, | |
2074 | "\\\""); | |
2075 | break; | |
2076 | case '\\': | |
2077 | ret = lttng_metadata_printf(session, | |
2078 | "\\\\"); | |
2079 | break; | |
2080 | default: | |
2081 | ret = lttng_metadata_printf(session, | |
2082 | "%c", c); | |
2083 | break; | |
2084 | } | |
2085 | if (ret) | |
2086 | goto end; | |
2087 | } | |
08ad1061 PP |
2088 | ret = lttng_metadata_printf(session, "\""); |
2089 | if (ret) | |
2090 | goto end; | |
2091 | ||
2092 | if (entry->options.is_auto) { | |
2093 | ret = lttng_metadata_printf(session, ",\n"); | |
2094 | if (ret) | |
2095 | goto end; | |
141ddf28 | 2096 | } else { |
7c559490 MD |
2097 | ret = lttng_metadata_printf(session, |
2098 | " = "); | |
2099 | if (ret) | |
2100 | goto end; | |
2101 | if (entry->start.signedness) | |
141ddf28 | 2102 | ret = lttng_metadata_printf(session, |
7c559490 MD |
2103 | "%lld", (long long) entry->start.value); |
2104 | else | |
2105 | ret = lttng_metadata_printf(session, | |
2106 | "%llu", entry->start.value); | |
2107 | if (ret) | |
2108 | goto end; | |
2109 | if (entry->start.signedness == entry->end.signedness && | |
2110 | entry->start.value | |
2111 | == entry->end.value) { | |
141ddf28 | 2112 | ret = lttng_metadata_printf(session, |
7c559490 MD |
2113 | ",\n"); |
2114 | } else { | |
2115 | if (entry->end.signedness) { | |
2116 | ret = lttng_metadata_printf(session, | |
2117 | " ... %lld,\n", | |
2118 | (long long) entry->end.value); | |
2119 | } else { | |
2120 | ret = lttng_metadata_printf(session, | |
2121 | " ... %llu,\n", | |
2122 | entry->end.value); | |
2123 | } | |
141ddf28 | 2124 | } |
7c559490 MD |
2125 | if (ret) |
2126 | goto end; | |
141ddf28 | 2127 | } |
141ddf28 MD |
2128 | } |
2129 | ret = print_tabs(session, nesting); | |
2130 | if (ret) | |
2131 | goto end; | |
ceabb767 | 2132 | ret = lttng_metadata_printf(session, "}"); |
141ddf28 MD |
2133 | end: |
2134 | return ret; | |
2135 | } | |
2136 | ||
d83004aa JD |
2137 | /* |
2138 | * Must be called with sessions_mutex held. | |
2139 | */ | |
c099397a | 2140 | static |
ceabb767 MD |
2141 | int _lttng_enum_field_statedump(struct lttng_session *session, |
2142 | const struct lttng_event_field *field, | |
2143 | size_t nesting) | |
2144 | { | |
2145 | int ret; | |
2146 | ||
2147 | ret = _lttng_enum_type_statedump(session, &field->type, nesting); | |
2148 | if (ret) | |
2149 | return ret; | |
2150 | return lttng_field_name_statedump(session, field, nesting); | |
2151 | } | |
2152 | ||
2153 | static | |
2154 | int _lttng_integer_field_statedump(struct lttng_session *session, | |
2155 | const struct lttng_event_field *field, | |
2156 | size_t nesting) | |
2157 | { | |
2158 | int ret; | |
2159 | ||
2160 | ret = _lttng_integer_type_statedump(session, &field->type, nesting); | |
2161 | if (ret) | |
2162 | return ret; | |
2163 | return lttng_field_name_statedump(session, field, nesting); | |
2164 | } | |
2165 | ||
2166 | static | |
2167 | int _lttng_string_type_statedump(struct lttng_session *session, | |
2168 | const struct lttng_type *type, | |
2169 | size_t nesting) | |
2170 | { | |
2171 | int ret; | |
2172 | ||
2173 | WARN_ON_ONCE(type->atype != atype_string); | |
2174 | /* Default encoding is UTF8 */ | |
2175 | ret = print_tabs(session, nesting); | |
2176 | if (ret) | |
2177 | return ret; | |
2178 | ret = lttng_metadata_printf(session, | |
2179 | "string%s", | |
2180 | type->u.string.encoding == lttng_encode_ASCII ? | |
2181 | " { encoding = ASCII; }" : ""); | |
2182 | return ret; | |
2183 | } | |
2184 | ||
2185 | static | |
2186 | int _lttng_string_field_statedump(struct lttng_session *session, | |
f513b2bf MD |
2187 | const struct lttng_event_field *field, |
2188 | size_t nesting) | |
ceabb767 MD |
2189 | { |
2190 | int ret; | |
2191 | ||
2192 | WARN_ON_ONCE(field->type.atype != atype_string); | |
2193 | ret = _lttng_string_type_statedump(session, &field->type, nesting); | |
2194 | if (ret) | |
2195 | return ret; | |
2196 | return lttng_field_name_statedump(session, field, nesting); | |
2197 | } | |
2198 | ||
2199 | /* | |
2200 | * Must be called with sessions_mutex held. | |
2201 | */ | |
2202 | static | |
2203 | int _lttng_type_statedump(struct lttng_session *session, | |
2204 | const struct lttng_type *type, | |
2205 | size_t nesting) | |
c099397a | 2206 | { |
c099397a | 2207 | int ret = 0; |
c099397a | 2208 | |
ceabb767 | 2209 | switch (type->atype) { |
8070f5c0 | 2210 | case atype_integer: |
ceabb767 | 2211 | ret = _lttng_integer_type_statedump(session, type, nesting); |
8070f5c0 | 2212 | break; |
ceabb767 MD |
2213 | case atype_enum_nestable: |
2214 | ret = _lttng_enum_type_statedump(session, type, nesting); | |
8070f5c0 | 2215 | break; |
ceabb767 MD |
2216 | case atype_string: |
2217 | ret = _lttng_string_type_statedump(session, type, nesting); | |
2218 | break; | |
2219 | case atype_struct_nestable: | |
2220 | ret = _lttng_struct_type_statedump(session, type, nesting); | |
8070f5c0 | 2221 | break; |
ceabb767 MD |
2222 | case atype_variant_nestable: |
2223 | ret = _lttng_variant_type_statedump(session, type, nesting); | |
2224 | break; | |
2225 | ||
2226 | /* Nested arrays and sequences are not supported yet. */ | |
2227 | case atype_array_nestable: | |
2228 | case atype_sequence_nestable: | |
2229 | default: | |
2230 | WARN_ON_ONCE(1); | |
2231 | return -EINVAL; | |
8070f5c0 | 2232 | } |
ceabb767 MD |
2233 | return ret; |
2234 | } | |
8070f5c0 | 2235 | |
ceabb767 MD |
2236 | /* |
2237 | * Must be called with sessions_mutex held. | |
2238 | */ | |
2239 | static | |
2240 | int _lttng_field_statedump(struct lttng_session *session, | |
2241 | const struct lttng_event_field *field, | |
2242 | size_t nesting) | |
2243 | { | |
2244 | int ret = 0; | |
27d2368e | 2245 | |
ceabb767 MD |
2246 | switch (field->type.atype) { |
2247 | case atype_integer: | |
2248 | ret = _lttng_integer_field_statedump(session, field, nesting); | |
2249 | break; | |
2250 | case atype_enum_nestable: | |
2251 | ret = _lttng_enum_field_statedump(session, field, nesting); | |
8070f5c0 | 2252 | break; |
8070f5c0 | 2253 | case atype_string: |
ceabb767 | 2254 | ret = _lttng_string_field_statedump(session, field, nesting); |
8070f5c0 | 2255 | break; |
ceabb767 MD |
2256 | case atype_struct_nestable: |
2257 | ret = _lttng_struct_field_statedump(session, field, nesting); | |
f513b2bf | 2258 | break; |
ceabb767 MD |
2259 | case atype_array_nestable: |
2260 | ret = _lttng_array_field_statedump(session, field, nesting); | |
f513b2bf | 2261 | break; |
ceabb767 MD |
2262 | case atype_sequence_nestable: |
2263 | ret = _lttng_sequence_field_statedump(session, field, nesting); | |
f513b2bf | 2264 | break; |
ceabb767 MD |
2265 | case atype_variant_nestable: |
2266 | ret = _lttng_variant_field_statedump(session, field, nesting); | |
65c85aa6 | 2267 | break; |
f513b2bf | 2268 | |
8070f5c0 MD |
2269 | default: |
2270 | WARN_ON_ONCE(1); | |
2271 | return -EINVAL; | |
2272 | } | |
2273 | return ret; | |
2274 | } | |
2275 | ||
2276 | static | |
a90917c3 | 2277 | int _lttng_context_metadata_statedump(struct lttng_session *session, |
8070f5c0 MD |
2278 | struct lttng_ctx *ctx) |
2279 | { | |
2280 | int ret = 0; | |
2281 | int i; | |
2282 | ||
2283 | if (!ctx) | |
2284 | return 0; | |
2285 | for (i = 0; i < ctx->nr_fields; i++) { | |
2286 | const struct lttng_ctx_field *field = &ctx->fields[i]; | |
2287 | ||
f513b2bf | 2288 | ret = _lttng_field_statedump(session, &field->event_field, 2); |
8070f5c0 MD |
2289 | if (ret) |
2290 | return ret; | |
2291 | } | |
2292 | return ret; | |
2293 | } | |
2294 | ||
2295 | static | |
a90917c3 MD |
2296 | int _lttng_fields_metadata_statedump(struct lttng_session *session, |
2297 | struct lttng_event *event) | |
8070f5c0 MD |
2298 | { |
2299 | const struct lttng_event_desc *desc = event->desc; | |
2300 | int ret = 0; | |
2301 | int i; | |
2302 | ||
2303 | for (i = 0; i < desc->nr_fields; i++) { | |
2304 | const struct lttng_event_field *field = &desc->fields[i]; | |
2305 | ||
f513b2bf | 2306 | ret = _lttng_field_statedump(session, field, 2); |
8070f5c0 MD |
2307 | if (ret) |
2308 | return ret; | |
c099397a MD |
2309 | } |
2310 | return ret; | |
2311 | } | |
2312 | ||
d83004aa JD |
2313 | /* |
2314 | * Must be called with sessions_mutex held. | |
2315 | */ | |
c099397a | 2316 | static |
a90917c3 MD |
2317 | int _lttng_event_metadata_statedump(struct lttng_session *session, |
2318 | struct lttng_channel *chan, | |
2319 | struct lttng_event *event) | |
c099397a MD |
2320 | { |
2321 | int ret = 0; | |
2322 | ||
a8f2d0c7 | 2323 | if (event->metadata_dumped || !READ_ONCE(session->active)) |
c099397a | 2324 | return 0; |
d83004aa | 2325 | if (chan->channel_type == METADATA_CHANNEL) |
c099397a MD |
2326 | return 0; |
2327 | ||
2328 | ret = lttng_metadata_printf(session, | |
2329 | "event {\n" | |
ae734547 | 2330 | " name = \"%s\";\n" |
c099397a | 2331 | " id = %u;\n" |
b9074a1b | 2332 | " stream_id = %u;\n", |
c099397a MD |
2333 | event->desc->name, |
2334 | event->id, | |
2335 | event->chan->id); | |
2336 | if (ret) | |
2337 | goto end; | |
2338 | ||
b9074a1b MD |
2339 | if (event->ctx) { |
2340 | ret = lttng_metadata_printf(session, | |
2341 | " context := struct {\n"); | |
2342 | if (ret) | |
2343 | goto end; | |
2344 | } | |
a90917c3 | 2345 | ret = _lttng_context_metadata_statedump(session, event->ctx); |
8070f5c0 MD |
2346 | if (ret) |
2347 | goto end; | |
b9074a1b MD |
2348 | if (event->ctx) { |
2349 | ret = lttng_metadata_printf(session, | |
2350 | " };\n"); | |
2351 | if (ret) | |
2352 | goto end; | |
2353 | } | |
8070f5c0 MD |
2354 | |
2355 | ret = lttng_metadata_printf(session, | |
8070f5c0 MD |
2356 | " fields := struct {\n" |
2357 | ); | |
2358 | if (ret) | |
2359 | goto end; | |
2360 | ||
a90917c3 | 2361 | ret = _lttng_fields_metadata_statedump(session, event); |
c099397a MD |
2362 | if (ret) |
2363 | goto end; | |
2364 | ||
2365 | /* | |
2366 | * LTTng space reservation can only reserve multiples of the | |
2367 | * byte size. | |
2368 | */ | |
2369 | ret = lttng_metadata_printf(session, | |
9115fbdc MD |
2370 | " };\n" |
2371 | "};\n\n"); | |
c099397a MD |
2372 | if (ret) |
2373 | goto end; | |
2374 | ||
c099397a MD |
2375 | event->metadata_dumped = 1; |
2376 | end: | |
2377 | return ret; | |
2378 | ||
2379 | } | |
2380 | ||
d83004aa JD |
2381 | /* |
2382 | * Must be called with sessions_mutex held. | |
2383 | */ | |
c099397a | 2384 | static |
a90917c3 MD |
2385 | int _lttng_channel_metadata_statedump(struct lttng_session *session, |
2386 | struct lttng_channel *chan) | |
c099397a MD |
2387 | { |
2388 | int ret = 0; | |
2389 | ||
a8f2d0c7 | 2390 | if (chan->metadata_dumped || !READ_ONCE(session->active)) |
c099397a | 2391 | return 0; |
d83004aa JD |
2392 | |
2393 | if (chan->channel_type == METADATA_CHANNEL) | |
c099397a MD |
2394 | return 0; |
2395 | ||
2396 | WARN_ON_ONCE(!chan->header_type); | |
2397 | ret = lttng_metadata_printf(session, | |
2398 | "stream {\n" | |
2399 | " id = %u;\n" | |
9115fbdc | 2400 | " event.header := %s;\n" |
b9074a1b | 2401 | " packet.context := struct packet_context;\n", |
c099397a MD |
2402 | chan->id, |
2403 | chan->header_type == 1 ? "struct event_header_compact" : | |
2404 | "struct event_header_large"); | |
2405 | if (ret) | |
2406 | goto end; | |
2407 | ||
b9074a1b MD |
2408 | if (chan->ctx) { |
2409 | ret = lttng_metadata_printf(session, | |
2410 | " event.context := struct {\n"); | |
2411 | if (ret) | |
2412 | goto end; | |
2413 | } | |
a90917c3 | 2414 | ret = _lttng_context_metadata_statedump(session, chan->ctx); |
8070f5c0 MD |
2415 | if (ret) |
2416 | goto end; | |
b9074a1b MD |
2417 | if (chan->ctx) { |
2418 | ret = lttng_metadata_printf(session, | |
2419 | " };\n"); | |
2420 | if (ret) | |
2421 | goto end; | |
2422 | } | |
8070f5c0 MD |
2423 | |
2424 | ret = lttng_metadata_printf(session, | |
b9074a1b | 2425 | "};\n\n"); |
8070f5c0 | 2426 | |
c099397a MD |
2427 | chan->metadata_dumped = 1; |
2428 | end: | |
2429 | return ret; | |
2430 | } | |
2431 | ||
d83004aa JD |
2432 | /* |
2433 | * Must be called with sessions_mutex held. | |
2434 | */ | |
9115fbdc | 2435 | static |
a90917c3 | 2436 | int _lttng_stream_packet_context_declare(struct lttng_session *session) |
9115fbdc MD |
2437 | { |
2438 | return lttng_metadata_printf(session, | |
2439 | "struct packet_context {\n" | |
a3ccff4f MD |
2440 | " uint64_clock_monotonic_t timestamp_begin;\n" |
2441 | " uint64_clock_monotonic_t timestamp_end;\n" | |
576ca06a MD |
2442 | " uint64_t content_size;\n" |
2443 | " uint64_t packet_size;\n" | |
5b3cf4f9 | 2444 | " uint64_t packet_seq_num;\n" |
a9afe705 | 2445 | " unsigned long events_discarded;\n" |
9115fbdc | 2446 | " uint32_t cpu_id;\n" |
c6dfdf6f | 2447 | "};\n\n" |
9115fbdc MD |
2448 | ); |
2449 | } | |
2450 | ||
2451 | /* | |
2452 | * Compact header: | |
2453 | * id: range: 0 - 30. | |
2454 | * id 31 is reserved to indicate an extended header. | |
2455 | * | |
2456 | * Large header: | |
2457 | * id: range: 0 - 65534. | |
2458 | * id 65535 is reserved to indicate an extended header. | |
d83004aa JD |
2459 | * |
2460 | * Must be called with sessions_mutex held. | |
9115fbdc MD |
2461 | */ |
2462 | static | |
a90917c3 | 2463 | int _lttng_event_header_declare(struct lttng_session *session) |
9115fbdc MD |
2464 | { |
2465 | return lttng_metadata_printf(session, | |
2466 | "struct event_header_compact {\n" | |
2467 | " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n" | |
2468 | " variant <id> {\n" | |
2469 | " struct {\n" | |
a3ccff4f | 2470 | " uint27_clock_monotonic_t timestamp;\n" |
9115fbdc MD |
2471 | " } compact;\n" |
2472 | " struct {\n" | |
2473 | " uint32_t id;\n" | |
a3ccff4f | 2474 | " uint64_clock_monotonic_t timestamp;\n" |
9115fbdc MD |
2475 | " } extended;\n" |
2476 | " } v;\n" | |
2477 | "} align(%u);\n" | |
2478 | "\n" | |
2479 | "struct event_header_large {\n" | |
2480 | " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n" | |
2481 | " variant <id> {\n" | |
2482 | " struct {\n" | |
a3ccff4f | 2483 | " uint32_clock_monotonic_t timestamp;\n" |
9115fbdc MD |
2484 | " } compact;\n" |
2485 | " struct {\n" | |
2486 | " uint32_t id;\n" | |
a3ccff4f | 2487 | " uint64_clock_monotonic_t timestamp;\n" |
9115fbdc MD |
2488 | " } extended;\n" |
2489 | " } v;\n" | |
2490 | "} align(%u);\n\n", | |
a90917c3 MD |
2491 | lttng_alignof(uint32_t) * CHAR_BIT, |
2492 | lttng_alignof(uint16_t) * CHAR_BIT | |
9115fbdc MD |
2493 | ); |
2494 | } | |
2495 | ||
a3ccff4f MD |
2496 | /* |
2497 | * Approximation of NTP time of day to clock monotonic correlation, | |
2498 | * taken at start of trace. | |
2499 | * Yes, this is only an approximation. Yes, we can (and will) do better | |
2500 | * in future versions. | |
5283350b MD |
2501 | * This function may return a negative offset. It may happen if the |
2502 | * system sets the REALTIME clock to 0 after boot. | |
3636085f MJ |
2503 | * |
2504 | * Use 64bit timespec on kernels that have it, this makes 32bit arch | |
2505 | * y2038 compliant. | |
a3ccff4f MD |
2506 | */ |
2507 | static | |
8967b2a3 | 2508 | int64_t measure_clock_offset(void) |
a3ccff4f | 2509 | { |
dcb93448 | 2510 | uint64_t monotonic_avg, monotonic[2], realtime; |
2754583e | 2511 | uint64_t tcf = trace_clock_freq(); |
dcb93448 | 2512 | int64_t offset; |
a3ccff4f | 2513 | unsigned long flags; |
3636085f MJ |
2514 | #ifdef LTTNG_KERNEL_HAS_TIMESPEC64 |
2515 | struct timespec64 rts = { 0, 0 }; | |
2516 | #else | |
2517 | struct timespec rts = { 0, 0 }; | |
2518 | #endif | |
a3ccff4f MD |
2519 | |
2520 | /* Disable interrupts to increase correlation precision. */ | |
2521 | local_irq_save(flags); | |
2522 | monotonic[0] = trace_clock_read64(); | |
3636085f MJ |
2523 | #ifdef LTTNG_KERNEL_HAS_TIMESPEC64 |
2524 | ktime_get_real_ts64(&rts); | |
2525 | #else | |
216b6baa | 2526 | getnstimeofday(&rts); |
3636085f | 2527 | #endif |
a3ccff4f MD |
2528 | monotonic[1] = trace_clock_read64(); |
2529 | local_irq_restore(flags); | |
2530 | ||
dcb93448 | 2531 | monotonic_avg = (monotonic[0] + monotonic[1]) >> 1; |
2754583e MD |
2532 | realtime = (uint64_t) rts.tv_sec * tcf; |
2533 | if (tcf == NSEC_PER_SEC) { | |
2534 | realtime += rts.tv_nsec; | |
2535 | } else { | |
2536 | uint64_t n = rts.tv_nsec * tcf; | |
2537 | ||
2538 | do_div(n, NSEC_PER_SEC); | |
2539 | realtime += n; | |
2540 | } | |
dcb93448 | 2541 | offset = (int64_t) realtime - monotonic_avg; |
a3ccff4f MD |
2542 | return offset; |
2543 | } | |
2544 | ||
3eb95be4 JR |
2545 | static |
2546 | int print_escaped_ctf_string(struct lttng_session *session, const char *string) | |
2547 | { | |
0f3eaad4 | 2548 | int ret = 0; |
3eb95be4 JR |
2549 | size_t i; |
2550 | char cur; | |
2551 | ||
2552 | i = 0; | |
2553 | cur = string[i]; | |
2554 | while (cur != '\0') { | |
2555 | switch (cur) { | |
2556 | case '\n': | |
2557 | ret = lttng_metadata_printf(session, "%s", "\\n"); | |
2558 | break; | |
2559 | case '\\': | |
2560 | case '"': | |
2561 | ret = lttng_metadata_printf(session, "%c", '\\'); | |
2562 | if (ret) | |
2563 | goto error; | |
2564 | /* We still print the current char */ | |
2565 | /* Fallthrough */ | |
2566 | default: | |
2567 | ret = lttng_metadata_printf(session, "%c", cur); | |
2568 | break; | |
2569 | } | |
2570 | ||
2571 | if (ret) | |
2572 | goto error; | |
2573 | ||
2574 | cur = string[++i]; | |
2575 | } | |
2576 | error: | |
2577 | return ret; | |
2578 | } | |
2579 | ||
2580 | static | |
1c88f269 JR |
2581 | int print_metadata_escaped_field(struct lttng_session *session, const char *field, |
2582 | const char *field_value) | |
3eb95be4 JR |
2583 | { |
2584 | int ret; | |
2585 | ||
1c88f269 | 2586 | ret = lttng_metadata_printf(session, " %s = \"", field); |
3eb95be4 JR |
2587 | if (ret) |
2588 | goto error; | |
2589 | ||
1c88f269 | 2590 | ret = print_escaped_ctf_string(session, field_value); |
3eb95be4 JR |
2591 | if (ret) |
2592 | goto error; | |
2593 | ||
2594 | ret = lttng_metadata_printf(session, "\";\n"); | |
2595 | ||
2596 | error: | |
2597 | return ret; | |
2598 | } | |
2599 | ||
c099397a MD |
2600 | /* |
2601 | * Output metadata into this session's metadata buffers. | |
d83004aa | 2602 | * Must be called with sessions_mutex held. |
c099397a MD |
2603 | */ |
2604 | static | |
a90917c3 | 2605 | int _lttng_session_metadata_statedump(struct lttng_session *session) |
c099397a | 2606 | { |
30bdb6e4 | 2607 | unsigned char *uuid_c = session->uuid.b; |
a82c63f1 | 2608 | unsigned char uuid_s[37], clock_uuid_s[BOOT_ID_LEN]; |
c88f762e | 2609 | const char *product_uuid; |
a90917c3 MD |
2610 | struct lttng_channel *chan; |
2611 | struct lttng_event *event; | |
c099397a MD |
2612 | int ret = 0; |
2613 | ||
a8f2d0c7 | 2614 | if (!READ_ONCE(session->active)) |
c099397a MD |
2615 | return 0; |
2616 | if (session->metadata_dumped) | |
2617 | goto skip_session; | |
c099397a | 2618 | |
d793d5e1 | 2619 | snprintf(uuid_s, sizeof(uuid_s), |
30bdb6e4 MD |
2620 | "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x", |
2621 | uuid_c[0], uuid_c[1], uuid_c[2], uuid_c[3], | |
2622 | uuid_c[4], uuid_c[5], uuid_c[6], uuid_c[7], | |
2623 | uuid_c[8], uuid_c[9], uuid_c[10], uuid_c[11], | |
2624 | uuid_c[12], uuid_c[13], uuid_c[14], uuid_c[15]); | |
d793d5e1 MD |
2625 | |
2626 | ret = lttng_metadata_printf(session, | |
9115fbdc MD |
2627 | "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n" |
2628 | "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n" | |
2629 | "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n" | |
2630 | "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n" | |
a9afe705 | 2631 | "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n" |
9115fbdc MD |
2632 | "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n" |
2633 | "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n" | |
d793d5e1 MD |
2634 | "\n" |
2635 | "trace {\n" | |
2636 | " major = %u;\n" | |
2637 | " minor = %u;\n" | |
30bdb6e4 | 2638 | " uuid = \"%s\";\n" |
d793d5e1 MD |
2639 | " byte_order = %s;\n" |
2640 | " packet.header := struct {\n" | |
2641 | " uint32_t magic;\n" | |
1ec3f75a | 2642 | " uint8_t uuid[16];\n" |
d793d5e1 | 2643 | " uint32_t stream_id;\n" |
5594698f | 2644 | " uint64_t stream_instance_id;\n" |
0eb25f58 | 2645 | " };\n" |
d793d5e1 | 2646 | "};\n\n", |
a90917c3 MD |
2647 | lttng_alignof(uint8_t) * CHAR_BIT, |
2648 | lttng_alignof(uint16_t) * CHAR_BIT, | |
2649 | lttng_alignof(uint32_t) * CHAR_BIT, | |
2650 | lttng_alignof(uint64_t) * CHAR_BIT, | |
a9afe705 MD |
2651 | sizeof(unsigned long) * CHAR_BIT, |
2652 | lttng_alignof(unsigned long) * CHAR_BIT, | |
c6c9e10f MD |
2653 | CTF_SPEC_MAJOR, |
2654 | CTF_SPEC_MINOR, | |
d793d5e1 | 2655 | uuid_s, |
5214fa50 | 2656 | #if __BYTE_ORDER == __BIG_ENDIAN |
d793d5e1 MD |
2657 | "be" |
2658 | #else | |
2659 | "le" | |
2660 | #endif | |
2661 | ); | |
2662 | if (ret) | |
2663 | goto end; | |
2664 | ||
99dc9597 MD |
2665 | ret = lttng_metadata_printf(session, |
2666 | "env {\n" | |
a6058143 | 2667 | " hostname = \"%s\";\n" |
c6c9e10f | 2668 | " domain = \"kernel\";\n" |
99dc9597 | 2669 | " sysname = \"%s\";\n" |
c6c9e10f MD |
2670 | " kernel_release = \"%s\";\n" |
2671 | " kernel_version = \"%s\";\n" | |
2672 | " tracer_name = \"lttng-modules\";\n" | |
2673 | " tracer_major = %d;\n" | |
2674 | " tracer_minor = %d;\n" | |
2675 | " tracer_patchlevel = %d;\n" | |
3eb95be4 | 2676 | " trace_buffering_scheme = \"global\";\n", |
3d0d43db | 2677 | current->nsproxy->uts_ns->name.nodename, |
99dc9597 MD |
2678 | utsname()->sysname, |
2679 | utsname()->release, | |
c6c9e10f MD |
2680 | utsname()->version, |
2681 | LTTNG_MODULES_MAJOR_VERSION, | |
2682 | LTTNG_MODULES_MINOR_VERSION, | |
2683 | LTTNG_MODULES_PATCHLEVEL_VERSION | |
99dc9597 MD |
2684 | ); |
2685 | if (ret) | |
2686 | goto end; | |
2687 | ||
1c88f269 JR |
2688 | ret = print_metadata_escaped_field(session, "trace_name", session->name); |
2689 | if (ret) | |
2690 | goto end; | |
2691 | ret = print_metadata_escaped_field(session, "trace_creation_datetime", | |
2692 | session->creation_time); | |
3eb95be4 JR |
2693 | if (ret) |
2694 | goto end; | |
2695 | ||
c88f762e GB |
2696 | /* Add the product UUID to the 'env' section */ |
2697 | product_uuid = dmi_get_system_info(DMI_PRODUCT_UUID); | |
2698 | if (product_uuid) { | |
2699 | ret = lttng_metadata_printf(session, | |
2700 | " product_uuid = \"%s\";\n", | |
2701 | product_uuid | |
2702 | ); | |
2703 | if (ret) | |
2704 | goto end; | |
2705 | } | |
2706 | ||
2707 | /* Close the 'env' section */ | |
3eb95be4 JR |
2708 | ret = lttng_metadata_printf(session, "};\n\n"); |
2709 | if (ret) | |
2710 | goto end; | |
2711 | ||
a3ccff4f MD |
2712 | ret = lttng_metadata_printf(session, |
2713 | "clock {\n" | |
2754583e MD |
2714 | " name = \"%s\";\n", |
2715 | trace_clock_name() | |
a82c63f1 MD |
2716 | ); |
2717 | if (ret) | |
2718 | goto end; | |
2719 | ||
2720 | if (!trace_clock_uuid(clock_uuid_s)) { | |
2721 | ret = lttng_metadata_printf(session, | |
7c27cb17 | 2722 | " uuid = \"%s\";\n", |
a82c63f1 MD |
2723 | clock_uuid_s |
2724 | ); | |
2725 | if (ret) | |
2726 | goto end; | |
2727 | } | |
2728 | ||
2729 | ret = lttng_metadata_printf(session, | |
2754583e | 2730 | " description = \"%s\";\n" |
a3ccff4f MD |
2731 | " freq = %llu; /* Frequency, in Hz */\n" |
2732 | " /* clock value offset from Epoch is: offset * (1/freq) */\n" | |
8967b2a3 | 2733 | " offset = %lld;\n" |
a3ccff4f | 2734 | "};\n\n", |
2754583e | 2735 | trace_clock_description(), |
a3ccff4f | 2736 | (unsigned long long) trace_clock_freq(), |
8967b2a3 | 2737 | (long long) measure_clock_offset() |
a3ccff4f MD |
2738 | ); |
2739 | if (ret) | |
2740 | goto end; | |
2741 | ||
2742 | ret = lttng_metadata_printf(session, | |
2743 | "typealias integer {\n" | |
2744 | " size = 27; align = 1; signed = false;\n" | |
2754583e | 2745 | " map = clock.%s.value;\n" |
a3ccff4f MD |
2746 | "} := uint27_clock_monotonic_t;\n" |
2747 | "\n" | |
2748 | "typealias integer {\n" | |
2749 | " size = 32; align = %u; signed = false;\n" | |
2754583e | 2750 | " map = clock.%s.value;\n" |
a3ccff4f MD |
2751 | "} := uint32_clock_monotonic_t;\n" |
2752 | "\n" | |
2753 | "typealias integer {\n" | |
2754 | " size = 64; align = %u; signed = false;\n" | |
2754583e | 2755 | " map = clock.%s.value;\n" |
a3ccff4f | 2756 | "} := uint64_clock_monotonic_t;\n\n", |
2754583e | 2757 | trace_clock_name(), |
a3ccff4f | 2758 | lttng_alignof(uint32_t) * CHAR_BIT, |
2754583e MD |
2759 | trace_clock_name(), |
2760 | lttng_alignof(uint64_t) * CHAR_BIT, | |
2761 | trace_clock_name() | |
a3ccff4f MD |
2762 | ); |
2763 | if (ret) | |
2764 | goto end; | |
2765 | ||
a90917c3 | 2766 | ret = _lttng_stream_packet_context_declare(session); |
9115fbdc MD |
2767 | if (ret) |
2768 | goto end; | |
2769 | ||
a90917c3 | 2770 | ret = _lttng_event_header_declare(session); |
9115fbdc MD |
2771 | if (ret) |
2772 | goto end; | |
2773 | ||
c099397a MD |
2774 | skip_session: |
2775 | list_for_each_entry(chan, &session->chan, list) { | |
a90917c3 | 2776 | ret = _lttng_channel_metadata_statedump(session, chan); |
c099397a MD |
2777 | if (ret) |
2778 | goto end; | |
2779 | } | |
2780 | ||
2781 | list_for_each_entry(event, &session->events, list) { | |
a90917c3 | 2782 | ret = _lttng_event_metadata_statedump(session, event->chan, event); |
c099397a MD |
2783 | if (ret) |
2784 | goto end; | |
2785 | } | |
2786 | session->metadata_dumped = 1; | |
2787 | end: | |
2788 | return ret; | |
2789 | } | |
2790 | ||
c0e31d2e | 2791 | /** |
a90917c3 | 2792 | * lttng_transport_register - LTT transport registration |
c0e31d2e MD |
2793 | * @transport: transport structure |
2794 | * | |
2795 | * Registers a transport which can be used as output to extract the data out of | |
2796 | * LTTng. The module calling this registration function must ensure that no | |
2797 | * trap-inducing code will be executed by the transport functions. E.g. | |
263b6c88 | 2798 | * vmalloc_sync_mappings() must be called between a vmalloc and the moment the memory |
c0e31d2e | 2799 | * is made visible to the transport function. This registration acts as a |
263b6c88 | 2800 | * vmalloc_sync_mappings. Therefore, only if the module allocates virtual memory |
c0e31d2e MD |
2801 | * after its registration must it synchronize the TLBs. |
2802 | */ | |
a90917c3 | 2803 | void lttng_transport_register(struct lttng_transport *transport) |
c0e31d2e MD |
2804 | { |
2805 | /* | |
2806 | * Make sure no page fault can be triggered by the module about to be | |
2807 | * registered. We deal with this here so we don't have to call | |
263b6c88 | 2808 | * vmalloc_sync_mappings() in each module's init. |
c0e31d2e | 2809 | */ |
263b6c88 | 2810 | wrapper_vmalloc_sync_mappings(); |
c0e31d2e MD |
2811 | |
2812 | mutex_lock(&sessions_mutex); | |
a90917c3 | 2813 | list_add_tail(&transport->node, <tng_transport_list); |
c0e31d2e MD |
2814 | mutex_unlock(&sessions_mutex); |
2815 | } | |
a90917c3 | 2816 | EXPORT_SYMBOL_GPL(lttng_transport_register); |
c0e31d2e MD |
2817 | |
2818 | /** | |
a90917c3 | 2819 | * lttng_transport_unregister - LTT transport unregistration |
c0e31d2e MD |
2820 | * @transport: transport structure |
2821 | */ | |
a90917c3 | 2822 | void lttng_transport_unregister(struct lttng_transport *transport) |
c0e31d2e MD |
2823 | { |
2824 | mutex_lock(&sessions_mutex); | |
2825 | list_del(&transport->node); | |
2826 | mutex_unlock(&sessions_mutex); | |
2827 | } | |
a90917c3 | 2828 | EXPORT_SYMBOL_GPL(lttng_transport_unregister); |
c0e31d2e | 2829 | |
894ce5dc | 2830 | #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) |
1e367326 MD |
2831 | |
2832 | enum cpuhp_state lttng_hp_prepare; | |
2833 | enum cpuhp_state lttng_hp_online; | |
2834 | ||
2835 | static int lttng_hotplug_prepare(unsigned int cpu, struct hlist_node *node) | |
2836 | { | |
2837 | struct lttng_cpuhp_node *lttng_node; | |
2838 | ||
2839 | lttng_node = container_of(node, struct lttng_cpuhp_node, node); | |
2840 | switch (lttng_node->component) { | |
2841 | case LTTNG_RING_BUFFER_FRONTEND: | |
2842 | return 0; | |
2843 | case LTTNG_RING_BUFFER_BACKEND: | |
2844 | return lttng_cpuhp_rb_backend_prepare(cpu, lttng_node); | |
2845 | case LTTNG_RING_BUFFER_ITER: | |
2846 | return 0; | |
2847 | case LTTNG_CONTEXT_PERF_COUNTERS: | |
2848 | return 0; | |
2849 | default: | |
2850 | return -EINVAL; | |
2851 | } | |
2852 | } | |
2853 | ||
2854 | static int lttng_hotplug_dead(unsigned int cpu, struct hlist_node *node) | |
2855 | { | |
2856 | struct lttng_cpuhp_node *lttng_node; | |
2857 | ||
2858 | lttng_node = container_of(node, struct lttng_cpuhp_node, node); | |
2859 | switch (lttng_node->component) { | |
2860 | case LTTNG_RING_BUFFER_FRONTEND: | |
2861 | return lttng_cpuhp_rb_frontend_dead(cpu, lttng_node); | |
2862 | case LTTNG_RING_BUFFER_BACKEND: | |
2863 | return 0; | |
2864 | case LTTNG_RING_BUFFER_ITER: | |
2865 | return 0; | |
2866 | case LTTNG_CONTEXT_PERF_COUNTERS: | |
2867 | return lttng_cpuhp_perf_counter_dead(cpu, lttng_node); | |
2868 | default: | |
2869 | return -EINVAL; | |
2870 | } | |
2871 | } | |
2872 | ||
2873 | static int lttng_hotplug_online(unsigned int cpu, struct hlist_node *node) | |
2874 | { | |
2875 | struct lttng_cpuhp_node *lttng_node; | |
2876 | ||
2877 | lttng_node = container_of(node, struct lttng_cpuhp_node, node); | |
2878 | switch (lttng_node->component) { | |
2879 | case LTTNG_RING_BUFFER_FRONTEND: | |
2880 | return lttng_cpuhp_rb_frontend_online(cpu, lttng_node); | |
2881 | case LTTNG_RING_BUFFER_BACKEND: | |
2882 | return 0; | |
2883 | case LTTNG_RING_BUFFER_ITER: | |
2884 | return lttng_cpuhp_rb_iter_online(cpu, lttng_node); | |
2885 | case LTTNG_CONTEXT_PERF_COUNTERS: | |
2886 | return lttng_cpuhp_perf_counter_online(cpu, lttng_node); | |
2887 | default: | |
2888 | return -EINVAL; | |
2889 | } | |
2890 | } | |
2891 | ||
2892 | static int lttng_hotplug_offline(unsigned int cpu, struct hlist_node *node) | |
2893 | { | |
2894 | struct lttng_cpuhp_node *lttng_node; | |
2895 | ||
2896 | lttng_node = container_of(node, struct lttng_cpuhp_node, node); | |
2897 | switch (lttng_node->component) { | |
2898 | case LTTNG_RING_BUFFER_FRONTEND: | |
2899 | return lttng_cpuhp_rb_frontend_offline(cpu, lttng_node); | |
2900 | case LTTNG_RING_BUFFER_BACKEND: | |
2901 | return 0; | |
2902 | case LTTNG_RING_BUFFER_ITER: | |
2903 | return 0; | |
2904 | case LTTNG_CONTEXT_PERF_COUNTERS: | |
2905 | return 0; | |
2906 | default: | |
2907 | return -EINVAL; | |
2908 | } | |
2909 | } | |
2910 | ||
2911 | static int __init lttng_init_cpu_hotplug(void) | |
2912 | { | |
2913 | int ret; | |
2914 | ||
2915 | ret = cpuhp_setup_state_multi(CPUHP_BP_PREPARE_DYN, "lttng:prepare", | |
2916 | lttng_hotplug_prepare, | |
2917 | lttng_hotplug_dead); | |
2918 | if (ret < 0) { | |
2919 | return ret; | |
2920 | } | |
2921 | lttng_hp_prepare = ret; | |
2922 | lttng_rb_set_hp_prepare(ret); | |
2923 | ||
2924 | ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "lttng:online", | |
2925 | lttng_hotplug_online, | |
2926 | lttng_hotplug_offline); | |
2927 | if (ret < 0) { | |
2928 | cpuhp_remove_multi_state(lttng_hp_prepare); | |
2929 | lttng_hp_prepare = 0; | |
2930 | return ret; | |
2931 | } | |
2932 | lttng_hp_online = ret; | |
2933 | lttng_rb_set_hp_online(ret); | |
2934 | ||
2935 | return 0; | |
2936 | } | |
2937 | ||
2938 | static void __exit lttng_exit_cpu_hotplug(void) | |
2939 | { | |
2940 | lttng_rb_set_hp_online(0); | |
2941 | cpuhp_remove_multi_state(lttng_hp_online); | |
2942 | lttng_rb_set_hp_prepare(0); | |
2943 | cpuhp_remove_multi_state(lttng_hp_prepare); | |
2944 | } | |
2945 | ||
1ee63d8d | 2946 | #else /* #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */ |
1e367326 MD |
2947 | static int lttng_init_cpu_hotplug(void) |
2948 | { | |
2949 | return 0; | |
2950 | } | |
2951 | static void lttng_exit_cpu_hotplug(void) | |
2952 | { | |
2953 | } | |
1ee63d8d | 2954 | #endif /* #else #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */ |
1e367326 MD |
2955 | |
2956 | ||
a90917c3 | 2957 | static int __init lttng_events_init(void) |
4e3c1b9b | 2958 | { |
1c25284c MD |
2959 | int ret; |
2960 | ||
453b2495 JD |
2961 | ret = wrapper_lttng_fixup_sig(THIS_MODULE); |
2962 | if (ret) | |
2963 | return ret; | |
389d7070 | 2964 | ret = wrapper_get_pfnblock_flags_mask_init(); |
36561775 MD |
2965 | if (ret) |
2966 | return ret; | |
2967 | ret = wrapper_get_pageblock_flags_mask_init(); | |
114667d5 MD |
2968 | if (ret) |
2969 | return ret; | |
2970 | ret = lttng_probes_init(); | |
389d7070 MD |
2971 | if (ret) |
2972 | return ret; | |
07dfc1d0 | 2973 | ret = lttng_context_init(); |
20591cf7 MD |
2974 | if (ret) |
2975 | return ret; | |
07dfc1d0 MD |
2976 | ret = lttng_tracepoint_init(); |
2977 | if (ret) | |
2978 | goto error_tp; | |
a90917c3 | 2979 | event_cache = KMEM_CACHE(lttng_event, 0); |
20591cf7 MD |
2980 | if (!event_cache) { |
2981 | ret = -ENOMEM; | |
2982 | goto error_kmem; | |
2983 | } | |
80996790 | 2984 | ret = lttng_abi_init(); |
02119ee5 MD |
2985 | if (ret) |
2986 | goto error_abi; | |
0c956676 MD |
2987 | ret = lttng_logger_init(); |
2988 | if (ret) | |
2989 | goto error_logger; | |
1e367326 MD |
2990 | ret = lttng_init_cpu_hotplug(); |
2991 | if (ret) | |
2992 | goto error_hotplug; | |
101215b7 | 2993 | printk(KERN_NOTICE "LTTng: Loaded modules v%s.%s.%s%s (%s)%s%s\n", |
489de24b MJ |
2994 | __stringify(LTTNG_MODULES_MAJOR_VERSION), |
2995 | __stringify(LTTNG_MODULES_MINOR_VERSION), | |
2996 | __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION), | |
2997 | LTTNG_MODULES_EXTRAVERSION, | |
101215b7 MJ |
2998 | LTTNG_VERSION_NAME, |
2999 | #ifdef LTTNG_EXTRA_VERSION_GIT | |
3000 | LTTNG_EXTRA_VERSION_GIT[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT, | |
3001 | #else | |
3002 | "", | |
3003 | #endif | |
3004 | #ifdef LTTNG_EXTRA_VERSION_NAME | |
3005 | LTTNG_EXTRA_VERSION_NAME[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME); | |
3006 | #else | |
3007 | ""); | |
3008 | #endif | |
4e3c1b9b | 3009 | return 0; |
0c956676 | 3010 | |
1e367326 MD |
3011 | error_hotplug: |
3012 | lttng_logger_exit(); | |
0c956676 MD |
3013 | error_logger: |
3014 | lttng_abi_exit(); | |
02119ee5 | 3015 | error_abi: |
1c25284c | 3016 | kmem_cache_destroy(event_cache); |
20591cf7 MD |
3017 | error_kmem: |
3018 | lttng_tracepoint_exit(); | |
07dfc1d0 MD |
3019 | error_tp: |
3020 | lttng_context_exit(); | |
101215b7 | 3021 | printk(KERN_NOTICE "LTTng: Failed to load modules v%s.%s.%s%s (%s)%s%s\n", |
489de24b MJ |
3022 | __stringify(LTTNG_MODULES_MAJOR_VERSION), |
3023 | __stringify(LTTNG_MODULES_MINOR_VERSION), | |
3024 | __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION), | |
3025 | LTTNG_MODULES_EXTRAVERSION, | |
101215b7 MJ |
3026 | LTTNG_VERSION_NAME, |
3027 | #ifdef LTTNG_EXTRA_VERSION_GIT | |
3028 | LTTNG_EXTRA_VERSION_GIT[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT, | |
3029 | #else | |
3030 | "", | |
3031 | #endif | |
3032 | #ifdef LTTNG_EXTRA_VERSION_NAME | |
3033 | LTTNG_EXTRA_VERSION_NAME[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME); | |
3034 | #else | |
3035 | ""); | |
3036 | #endif | |
1c25284c | 3037 | return ret; |
4e3c1b9b MD |
3038 | } |
3039 | ||
a90917c3 | 3040 | module_init(lttng_events_init); |
11b5a3c2 | 3041 | |
a90917c3 | 3042 | static void __exit lttng_events_exit(void) |
4e3c1b9b | 3043 | { |
a90917c3 | 3044 | struct lttng_session *session, *tmpsession; |
92e94819 | 3045 | |
1e367326 | 3046 | lttng_exit_cpu_hotplug(); |
0c956676 | 3047 | lttng_logger_exit(); |
80996790 | 3048 | lttng_abi_exit(); |
92e94819 | 3049 | list_for_each_entry_safe(session, tmpsession, &sessions, list) |
a90917c3 | 3050 | lttng_session_destroy(session); |
11b5a3c2 | 3051 | kmem_cache_destroy(event_cache); |
20591cf7 | 3052 | lttng_tracepoint_exit(); |
07dfc1d0 | 3053 | lttng_context_exit(); |
101215b7 | 3054 | printk(KERN_NOTICE "LTTng: Unloaded modules v%s.%s.%s%s (%s)%s%s\n", |
489de24b MJ |
3055 | __stringify(LTTNG_MODULES_MAJOR_VERSION), |
3056 | __stringify(LTTNG_MODULES_MINOR_VERSION), | |
3057 | __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION), | |
3058 | LTTNG_MODULES_EXTRAVERSION, | |
101215b7 MJ |
3059 | LTTNG_VERSION_NAME, |
3060 | #ifdef LTTNG_EXTRA_VERSION_GIT | |
3061 | LTTNG_EXTRA_VERSION_GIT[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT, | |
3062 | #else | |
3063 | "", | |
3064 | #endif | |
3065 | #ifdef LTTNG_EXTRA_VERSION_NAME | |
3066 | LTTNG_EXTRA_VERSION_NAME[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME); | |
3067 | #else | |
3068 | ""); | |
3069 | #endif | |
4e3c1b9b | 3070 | } |
92e94819 | 3071 | |
a90917c3 | 3072 | module_exit(lttng_events_exit); |
11b5a3c2 | 3073 | |
101215b7 MJ |
3074 | #include "extra_version/patches.i" |
3075 | #ifdef LTTNG_EXTRA_VERSION_GIT | |
3076 | MODULE_INFO(extra_version_git, LTTNG_EXTRA_VERSION_GIT); | |
3077 | #endif | |
3078 | #ifdef LTTNG_EXTRA_VERSION_NAME | |
3079 | MODULE_INFO(extra_version_name, LTTNG_EXTRA_VERSION_NAME); | |
3080 | #endif | |
92e94819 MD |
3081 | MODULE_LICENSE("GPL and additional rights"); |
3082 | MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>"); | |
1c124020 | 3083 | MODULE_DESCRIPTION("LTTng tracer"); |
9a9973ef MD |
3084 | MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "." |
3085 | __stringify(LTTNG_MODULES_MINOR_VERSION) "." | |
309370e2 MD |
3086 | __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION) |
3087 | LTTNG_MODULES_EXTRAVERSION); |