projects / lttng-modules.git / blob
? search:


9d1861160936638d44e7f9134c37639f4b9e0901
[lttng-modules.git] / src / lttng-events.c
1 /* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
2 *
3 * lttng-events.c
4 *
5 * Holds LTTng per-session event registry.
6 *
7 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 */
9
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
16 #include <linux/module.h>
17 #include <linux/mutex.h>
18 #include <linux/sched.h>
19 #include <linux/slab.h>
20 #include <linux/jiffies.h>
21 #include <linux/utsname.h>
22 #include <linux/err.h>
23 #include <linux/seq_file.h>
24 #include <linux/file.h>
25 #include <linux/anon_inodes.h>
26 #include <wrapper/file.h>
27 #include <linux/uaccess.h>
28 #include <linux/vmalloc.h>
29 #include <linux/dmi.h>
30
31 #include <wrapper/compiler_attributes.h>
32 #include <wrapper/uuid.h>
33 #include <wrapper/vmalloc.h> /* for wrapper_vmalloc_sync_mappings() */
34 #include <wrapper/random.h>
35 #include <wrapper/tracepoint.h>
36 #include <wrapper/list.h>
37 #include <wrapper/types.h>
38 #include <lttng/kernel-version.h>
39 #include <lttng/events.h>
40 #include <lttng/events-internal.h>
41 #include <lttng/lttng-bytecode.h>
42 #include <lttng/tracer.h>
43 #include <lttng/event-notifier-notification.h>
44 #include <lttng/abi-old.h>
45 #include <lttng/endian.h>
46 #include <lttng/string-utils.h>
47 #include <lttng/utils.h>
48 #include <ringbuffer/backend.h>
49 #include <ringbuffer/frontend.h>
50 #include <wrapper/time.h>
51
52 #define METADATA_CACHE_DEFAULT_SIZE 4096
53
54 static LIST_HEAD(sessions);
55 static LIST_HEAD(event_notifier_groups);
56 static LIST_HEAD(lttng_transport_list);
57 static LIST_HEAD(lttng_counter_transport_list);
58 /*
59 * Protect the sessions and metadata caches.
60 */
61 static DEFINE_MUTEX(sessions_mutex);
62 static struct kmem_cache *event_recorder_cache;
63 static struct kmem_cache *event_recorder_private_cache;
64 static struct kmem_cache *event_notifier_cache;
65 static struct kmem_cache *event_notifier_private_cache;
66
67 static void lttng_session_lazy_sync_event_enablers(struct lttng_kernel_session *session);
68 static void lttng_session_sync_event_enablers(struct lttng_kernel_session *session);
69 static void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group *event_notifier_group);
70 static void lttng_event_enabler_sync(struct lttng_event_enabler_common *event_enabler);
71
72 static void _lttng_event_destroy(struct lttng_kernel_event_common *event);
73 static void _lttng_channel_destroy(struct lttng_kernel_channel_buffer *chan);
74 static int _lttng_event_unregister(struct lttng_kernel_event_common *event);
75 static
76 int _lttng_event_recorder_metadata_statedump(struct lttng_kernel_event_common *event);
77 static
78 int _lttng_session_metadata_statedump(struct lttng_kernel_session *session);
79 static
80 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream *stream);
81 static
82 int _lttng_type_statedump(struct lttng_kernel_session *session,
83 const struct lttng_kernel_type_common *type,
84 enum lttng_kernel_string_encoding parent_encoding,
85 size_t nesting);
86 static
87 int _lttng_field_statedump(struct lttng_kernel_session *session,
88 const struct lttng_kernel_event_field *field,
89 size_t nesting, const char **prev_field_name_p);
90
91 void synchronize_trace(void)
92 {
93 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(5,1,0) || \
94 LTTNG_RHEL_KERNEL_RANGE(4,18,0,193,0,0, 4,19,0,0,0,0))
95 synchronize_rcu();
96 #else
97 synchronize_sched();
98 #endif
99
100 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0))
101 #ifdef CONFIG_PREEMPT_RT_FULL
102 synchronize_rcu();
103 #endif
104 #else /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
105 #ifdef CONFIG_PREEMPT_RT
106 synchronize_rcu();
107 #endif
108 #endif /* (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(3,4,0)) */
109 }
110
111 void lttng_lock_sessions(void)
112 {
113 mutex_lock(&sessions_mutex);
114 }
115
116 void lttng_unlock_sessions(void)
117 {
118 mutex_unlock(&sessions_mutex);
119 }
120
121 static struct lttng_transport *lttng_transport_find(const char *name)
122 {
123 struct lttng_transport *transport;
124
125 list_for_each_entry(transport, &lttng_transport_list, node) {
126 if (!strcmp(transport->name, name))
127 return transport;
128 }
129 return NULL;
130 }
131
132 /*
133 * Called with sessions lock held.
134 */
135 int lttng_session_active(void)
136 {
137 struct lttng_kernel_session_private *iter;
138
139 list_for_each_entry(iter, &sessions, list) {
140 if (iter->pub->active)
141 return 1;
142 }
143 return 0;
144 }
145
146 struct lttng_kernel_session *lttng_session_create(void)
147 {
148 struct lttng_kernel_session *session;
149 struct lttng_kernel_session_private *session_priv;
150 struct lttng_metadata_cache *metadata_cache;
151 int i;
152
153 mutex_lock(&sessions_mutex);
154 session = lttng_kvzalloc(sizeof(*session), GFP_KERNEL);
155 if (!session)
156 goto err;
157 session_priv = lttng_kvzalloc(sizeof(*session_priv), GFP_KERNEL);
158 if (!session_priv)
159 goto err_free_session;
160 session->priv = session_priv;
161 session_priv->pub = session;
162
163 INIT_LIST_HEAD(&session_priv->chan);
164 INIT_LIST_HEAD(&session_priv->events);
165 lttng_guid_gen(&session_priv->uuid);
166
167 metadata_cache = kzalloc(sizeof(struct lttng_metadata_cache),
168 GFP_KERNEL);
169 if (!metadata_cache)
170 goto err_free_session_private;
171 metadata_cache->data = vzalloc(METADATA_CACHE_DEFAULT_SIZE);
172 if (!metadata_cache->data)
173 goto err_free_cache;
174 metadata_cache->cache_alloc = METADATA_CACHE_DEFAULT_SIZE;
175 kref_init(&metadata_cache->refcount);
176 mutex_init(&metadata_cache->lock);
177 session_priv->metadata_cache = metadata_cache;
178 INIT_LIST_HEAD(&metadata_cache->metadata_stream);
179 memcpy(&metadata_cache->uuid, &session_priv->uuid,
180 sizeof(metadata_cache->uuid));
181 INIT_LIST_HEAD(&session_priv->enablers_head);
182 for (i = 0; i < LTTNG_EVENT_HT_SIZE; i++)
183 INIT_HLIST_HEAD(&session_priv->events_ht.table[i]);
184 list_add(&session_priv->list, &sessions);
185
186 if (lttng_id_tracker_init(&session->pid_tracker, session, TRACKER_PID))
187 goto tracker_alloc_error;
188 if (lttng_id_tracker_init(&session->vpid_tracker, session, TRACKER_VPID))
189 goto tracker_alloc_error;
190 if (lttng_id_tracker_init(&session->uid_tracker, session, TRACKER_UID))
191 goto tracker_alloc_error;
192 if (lttng_id_tracker_init(&session->vuid_tracker, session, TRACKER_VUID))
193 goto tracker_alloc_error;
194 if (lttng_id_tracker_init(&session->gid_tracker, session, TRACKER_GID))
195 goto tracker_alloc_error;
196 if (lttng_id_tracker_init(&session->vgid_tracker, session, TRACKER_VGID))
197 goto tracker_alloc_error;
198
199 mutex_unlock(&sessions_mutex);
200
201 return session;
202
203 tracker_alloc_error:
204 lttng_id_tracker_fini(&session->pid_tracker);
205 lttng_id_tracker_fini(&session->vpid_tracker);
206 lttng_id_tracker_fini(&session->uid_tracker);
207 lttng_id_tracker_fini(&session->vuid_tracker);
208 lttng_id_tracker_fini(&session->gid_tracker);
209 lttng_id_tracker_fini(&session->vgid_tracker);
210 err_free_cache:
211 kfree(metadata_cache);
212 err_free_session_private:
213 lttng_kvfree(session_priv);
214 err_free_session:
215 lttng_kvfree(session);
216 err:
217 mutex_unlock(&sessions_mutex);
218 return NULL;
219 }
220
221 static
222 struct lttng_counter_transport *lttng_counter_transport_find(const char *name)
223 {
224 struct lttng_counter_transport *transport;
225
226 list_for_each_entry(transport, &lttng_counter_transport_list, node) {
227 if (!strcmp(transport->name, name))
228 return transport;
229 }
230 return NULL;
231 }
232
233 struct lttng_counter *lttng_kernel_counter_create(
234 const char *counter_transport_name,
235 size_t number_dimensions, const size_t *dimensions_sizes)
236 {
237 struct lttng_counter *counter = NULL;
238 struct lttng_counter_transport *counter_transport = NULL;
239
240 counter_transport = lttng_counter_transport_find(counter_transport_name);
241 if (!counter_transport) {
242 printk(KERN_WARNING "LTTng: counter transport %s not found.\n",
243 counter_transport_name);
244 goto notransport;
245 }
246 if (!try_module_get(counter_transport->owner)) {
247 printk(KERN_WARNING "LTTng: Can't lock counter transport module.\n");
248 goto notransport;
249 }
250
251 counter = lttng_kvzalloc(sizeof(struct lttng_counter), GFP_KERNEL);
252 if (!counter)
253 goto nomem;
254
255 /* Create event notifier error counter. */
256 counter->ops = &counter_transport->ops;
257 counter->transport = counter_transport;
258
259 counter->counter = counter->ops->counter_create(
260 number_dimensions, dimensions_sizes, 0);
261 if (!counter->counter) {
262 goto create_error;
263 }
264
265 return counter;
266
267 create_error:
268 lttng_kvfree(counter);
269 nomem:
270 if (counter_transport)
271 module_put(counter_transport->owner);
272 notransport:
273 return NULL;
274 }
275
276 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void)
277 {
278 struct lttng_transport *transport = NULL;
279 struct lttng_event_notifier_group *event_notifier_group;
280 const char *transport_name = "relay-event-notifier";
281 size_t subbuf_size = 4096; //TODO
282 size_t num_subbuf = 16; //TODO
283 unsigned int switch_timer_interval = 0;
284 unsigned int read_timer_interval = 0;
285 int i;
286
287 mutex_lock(&sessions_mutex);
288
289 transport = lttng_transport_find(transport_name);
290 if (!transport) {
291 printk(KERN_WARNING "LTTng: transport %s not found\n",
292 transport_name);
293 goto notransport;
294 }
295 if (!try_module_get(transport->owner)) {
296 printk(KERN_WARNING "LTTng: Can't lock transport %s module.\n",
297 transport_name);
298 goto notransport;
299 }
300
301 event_notifier_group = lttng_kvzalloc(sizeof(struct lttng_event_notifier_group),
302 GFP_KERNEL);
303 if (!event_notifier_group)
304 goto nomem;
305
306 /*
307 * Initialize the ring buffer used to store event notifier
308 * notifications.
309 */
310 event_notifier_group->ops = &transport->ops;
311 event_notifier_group->chan = transport->ops.priv->channel_create(
312 transport_name, event_notifier_group, NULL,
313 subbuf_size, num_subbuf, switch_timer_interval,
314 read_timer_interval);
315 if (!event_notifier_group->chan)
316 goto create_error;
317
318 event_notifier_group->transport = transport;
319
320 INIT_LIST_HEAD(&event_notifier_group->enablers_head);
321 INIT_LIST_HEAD(&event_notifier_group->event_notifiers_head);
322 for (i = 0; i < LTTNG_EVENT_HT_SIZE; i++)
323 INIT_HLIST_HEAD(&event_notifier_group->events_ht.table[i]);
324
325 list_add(&event_notifier_group->node, &event_notifier_groups);
326
327 mutex_unlock(&sessions_mutex);
328
329 return event_notifier_group;
330
331 create_error:
332 lttng_kvfree(event_notifier_group);
333 nomem:
334 if (transport)
335 module_put(transport->owner);
336 notransport:
337 mutex_unlock(&sessions_mutex);
338 return NULL;
339 }
340
341 void metadata_cache_destroy(struct kref *kref)
342 {
343 struct lttng_metadata_cache *cache =
344 container_of(kref, struct lttng_metadata_cache, refcount);
345 vfree(cache->data);
346 kfree(cache);
347 }
348
349 void lttng_session_destroy(struct lttng_kernel_session *session)
350 {
351 struct lttng_kernel_channel_buffer_private *chan_priv, *tmpchan_priv;
352 struct lttng_kernel_event_recorder_private *event_recorder_priv, *tmpevent_recorder_priv;
353 struct lttng_metadata_stream *metadata_stream;
354 struct lttng_event_enabler_common *event_enabler, *tmp_event_enabler;
355 int ret;
356
357 mutex_lock(&sessions_mutex);
358 WRITE_ONCE(session->active, 0);
359 list_for_each_entry(chan_priv, &session->priv->chan, node) {
360 ret = lttng_syscalls_unregister_syscall_table(&chan_priv->parent.syscall_table);
361 WARN_ON(ret);
362 }
363 list_for_each_entry(event_recorder_priv, &session->priv->events, parent.node) {
364 ret = _lttng_event_unregister(&event_recorder_priv->pub->parent);
365 WARN_ON(ret);
366 }
367 synchronize_trace(); /* Wait for in-flight events to complete */
368 list_for_each_entry(chan_priv, &session->priv->chan, node) {
369 ret = lttng_syscalls_destroy_syscall_table(&chan_priv->parent.syscall_table);
370 WARN_ON(ret);
371 }
372 list_for_each_entry_safe(event_enabler, tmp_event_enabler, &session->priv->enablers_head, node)
373 lttng_event_enabler_destroy(event_enabler);
374 list_for_each_entry_safe(event_recorder_priv, tmpevent_recorder_priv, &session->priv->events, parent.node)
375 _lttng_event_destroy(&event_recorder_priv->pub->parent);
376 list_for_each_entry_safe(chan_priv, tmpchan_priv, &session->priv->chan, node) {
377 BUG_ON(chan_priv->channel_type == METADATA_CHANNEL);
378 _lttng_channel_destroy(chan_priv->pub);
379 }
380 mutex_lock(&session->priv->metadata_cache->lock);
381 list_for_each_entry(metadata_stream, &session->priv->metadata_cache->metadata_stream, list)
382 _lttng_metadata_channel_hangup(metadata_stream);
383 mutex_unlock(&session->priv->metadata_cache->lock);
384 lttng_id_tracker_fini(&session->pid_tracker);
385 lttng_id_tracker_fini(&session->vpid_tracker);
386 lttng_id_tracker_fini(&session->uid_tracker);
387 lttng_id_tracker_fini(&session->vuid_tracker);
388 lttng_id_tracker_fini(&session->gid_tracker);
389 lttng_id_tracker_fini(&session->vgid_tracker);
390 kref_put(&session->priv->metadata_cache->refcount, metadata_cache_destroy);
391 list_del(&session->priv->list);
392 mutex_unlock(&sessions_mutex);
393 lttng_kvfree(session->priv);
394 lttng_kvfree(session);
395 }
396
397 void lttng_event_notifier_group_destroy(
398 struct lttng_event_notifier_group *event_notifier_group)
399 {
400 struct lttng_event_enabler_common *event_enabler, *tmp_event_enabler;
401 struct lttng_kernel_event_notifier_private *event_notifier_priv, *tmpevent_notifier_priv;
402 int ret;
403
404 if (!event_notifier_group)
405 return;
406
407 mutex_lock(&sessions_mutex);
408
409 ret = lttng_syscalls_unregister_syscall_table(&event_notifier_group->syscall_table);
410 WARN_ON(ret);
411
412 list_for_each_entry_safe(event_notifier_priv, tmpevent_notifier_priv,
413 &event_notifier_group->event_notifiers_head, parent.node) {
414 ret = _lttng_event_unregister(&event_notifier_priv->pub->parent);
415 WARN_ON(ret);
416 }
417
418 /* Wait for in-flight event notifier to complete */
419 synchronize_trace();
420
421 irq_work_sync(&event_notifier_group->wakeup_pending);
422
423 ret = lttng_syscalls_destroy_syscall_table(&event_notifier_group->syscall_table);
424 WARN_ON(ret);
425
426 list_for_each_entry_safe(event_enabler, tmp_event_enabler,
427 &event_notifier_group->enablers_head, node)
428 lttng_event_enabler_destroy(event_enabler);
429
430 list_for_each_entry_safe(event_notifier_priv, tmpevent_notifier_priv,
431 &event_notifier_group->event_notifiers_head, parent.node)
432 _lttng_event_destroy(&event_notifier_priv->pub->parent);
433
434 if (event_notifier_group->error_counter) {
435 struct lttng_counter *error_counter = event_notifier_group->error_counter;
436
437 error_counter->ops->counter_destroy(error_counter->counter);
438 module_put(error_counter->transport->owner);
439 lttng_kvfree(error_counter);
440 event_notifier_group->error_counter = NULL;
441 }
442
443 event_notifier_group->ops->priv->channel_destroy(event_notifier_group->chan);
444 module_put(event_notifier_group->transport->owner);
445 list_del(&event_notifier_group->node);
446
447 mutex_unlock(&sessions_mutex);
448 lttng_kvfree(event_notifier_group);
449 }
450
451 int lttng_session_statedump(struct lttng_kernel_session *session)
452 {
453 int ret;
454
455 mutex_lock(&sessions_mutex);
456 ret = lttng_statedump_start(session);
457 mutex_unlock(&sessions_mutex);
458 return ret;
459 }
460
461 int lttng_session_enable(struct lttng_kernel_session *session)
462 {
463 int ret = 0;
464 struct lttng_kernel_channel_buffer_private *chan_priv;
465
466 mutex_lock(&sessions_mutex);
467 if (session->active) {
468 ret = -EBUSY;
469 goto end;
470 }
471
472 /* Set transient enabler state to "enabled" */
473 session->priv->tstate = 1;
474
475 /* We need to sync enablers with session before activation. */
476 lttng_session_sync_event_enablers(session);
477
478 /*
479 * Snapshot the number of events per channel to know the type of header
480 * we need to use.
481 */
482 list_for_each_entry(chan_priv, &session->priv->chan, node) {
483 if (chan_priv->header_type)
484 continue; /* don't change it if session stop/restart */
485 if (chan_priv->free_event_id < 31)
486 chan_priv->header_type = 1; /* compact */
487 else
488 chan_priv->header_type = 2; /* large */
489 }
490
491 /* Clear each stream's quiescent state. */
492 list_for_each_entry(chan_priv, &session->priv->chan, node) {
493 if (chan_priv->channel_type != METADATA_CHANNEL)
494 lib_ring_buffer_clear_quiescent_channel(chan_priv->rb_chan);
495 }
496
497 WRITE_ONCE(session->active, 1);
498 WRITE_ONCE(session->priv->been_active, 1);
499 ret = _lttng_session_metadata_statedump(session);
500 if (ret) {
501 WRITE_ONCE(session->active, 0);
502 goto end;
503 }
504 ret = lttng_statedump_start(session);
505 if (ret)
506 WRITE_ONCE(session->active, 0);
507 end:
508 mutex_unlock(&sessions_mutex);
509 return ret;
510 }
511
512 int lttng_session_disable(struct lttng_kernel_session *session)
513 {
514 int ret = 0;
515 struct lttng_kernel_channel_buffer_private *chan_priv;
516
517 mutex_lock(&sessions_mutex);
518 if (!session->active) {
519 ret = -EBUSY;
520 goto end;
521 }
522 WRITE_ONCE(session->active, 0);
523
524 /* Set transient enabler state to "disabled" */
525 session->priv->tstate = 0;
526 lttng_session_sync_event_enablers(session);
527
528 /* Set each stream's quiescent state. */
529 list_for_each_entry(chan_priv, &session->priv->chan, node) {
530 if (chan_priv->channel_type != METADATA_CHANNEL)
531 lib_ring_buffer_set_quiescent_channel(chan_priv->rb_chan);
532 }
533 end:
534 mutex_unlock(&sessions_mutex);
535 return ret;
536 }
537
538 int lttng_session_metadata_regenerate(struct lttng_kernel_session *session)
539 {
540 int ret = 0;
541 struct lttng_kernel_channel_buffer_private *chan_priv;
542 struct lttng_kernel_event_recorder_private *event_recorder_priv;
543 struct lttng_metadata_cache *cache = session->priv->metadata_cache;
544 struct lttng_metadata_stream *stream;
545
546 mutex_lock(&sessions_mutex);
547 if (!session->active) {
548 ret = -EBUSY;
549 goto end;
550 }
551
552 mutex_lock(&cache->lock);
553 memset(cache->data, 0, cache->cache_alloc);
554 cache->metadata_written = 0;
555 cache->version++;
556 list_for_each_entry(stream, &session->priv->metadata_cache->metadata_stream, list) {
557 stream->metadata_out = 0;
558 stream->metadata_in = 0;
559 }
560 mutex_unlock(&cache->lock);
561
562 session->priv->metadata_dumped = 0;
563 list_for_each_entry(chan_priv, &session->priv->chan, node) {
564 chan_priv->metadata_dumped = 0;
565 }
566
567 list_for_each_entry(event_recorder_priv, &session->priv->events, parent.node) {
568 event_recorder_priv->metadata_dumped = 0;
569 }
570
571 ret = _lttng_session_metadata_statedump(session);
572
573 end:
574 mutex_unlock(&sessions_mutex);
575 return ret;
576 }
577
578 static
579 bool is_channel_buffer_metadata(struct lttng_kernel_channel_common *channel)
580 {
581 struct lttng_kernel_channel_buffer *chan_buf;
582
583 if (channel->type != LTTNG_KERNEL_CHANNEL_TYPE_BUFFER)
584 return false;
585 chan_buf = container_of(channel, struct lttng_kernel_channel_buffer, parent);
586 if (chan_buf->priv->channel_type == METADATA_CHANNEL)
587 return true;
588 return false;
589 }
590
591 int lttng_channel_enable(struct lttng_kernel_channel_common *channel)
592 {
593 int ret = 0;
594
595 mutex_lock(&sessions_mutex);
596 if (is_channel_buffer_metadata(channel)) {
597 ret = -EPERM;
598 goto end;
599 }
600 if (channel->enabled) {
601 ret = -EEXIST;
602 goto end;
603 }
604 /* Set transient enabler state to "enabled" */
605 channel->priv->tstate = 1;
606 lttng_session_sync_event_enablers(channel->session);
607 /* Set atomically the state to "enabled" */
608 WRITE_ONCE(channel->enabled, 1);
609 end:
610 mutex_unlock(&sessions_mutex);
611 return ret;
612 }
613
614 int lttng_channel_disable(struct lttng_kernel_channel_common *channel)
615 {
616 int ret = 0;
617
618 mutex_lock(&sessions_mutex);
619 if (is_channel_buffer_metadata(channel)) {
620 ret = -EPERM;
621 goto end;
622 }
623 if (!channel->enabled) {
624 ret = -EEXIST;
625 goto end;
626 }
627 /* Set atomically the state to "disabled" */
628 WRITE_ONCE(channel->enabled, 0);
629 /* Set transient enabler state to "enabled" */
630 channel->priv->tstate = 0;
631 lttng_session_sync_event_enablers(channel->session);
632 end:
633 mutex_unlock(&sessions_mutex);
634 return ret;
635 }
636
637 int lttng_event_enable(struct lttng_kernel_event_common *event)
638 {
639 int ret = 0;
640
641 mutex_lock(&sessions_mutex);
642 switch (event->type) {
643 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
644 {
645 struct lttng_kernel_event_recorder *event_recorder =
646 container_of(event, struct lttng_kernel_event_recorder, parent);
647
648 if (event_recorder->chan->priv->channel_type == METADATA_CHANNEL) {
649 ret = -EPERM;
650 goto end;
651 }
652 break;
653 }
654 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
655 switch (event->priv->instrumentation) {
656 case LTTNG_KERNEL_ABI_KRETPROBE:
657 ret = -EINVAL;
658 goto end;
659 default:
660 break;
661 }
662 break;
663 default:
664 break;
665 }
666
667 if (event->enabled) {
668 ret = -EEXIST;
669 goto end;
670 }
671 switch (event->priv->instrumentation) {
672 case LTTNG_KERNEL_ABI_TRACEPOINT:
673 lttng_fallthrough;
674 case LTTNG_KERNEL_ABI_SYSCALL:
675 ret = -EINVAL;
676 break;
677
678 case LTTNG_KERNEL_ABI_KPROBE:
679 lttng_fallthrough;
680 case LTTNG_KERNEL_ABI_UPROBE:
681 WRITE_ONCE(event->enabled, 1);
682 break;
683
684 case LTTNG_KERNEL_ABI_KRETPROBE:
685 ret = lttng_kretprobes_event_enable_state(event, 1);
686 break;
687
688 case LTTNG_KERNEL_ABI_FUNCTION:
689 lttng_fallthrough;
690 case LTTNG_KERNEL_ABI_NOOP:
691 lttng_fallthrough;
692 default:
693 WARN_ON_ONCE(1);
694 ret = -EINVAL;
695 }
696 end:
697 mutex_unlock(&sessions_mutex);
698 return ret;
699 }
700
701 int lttng_event_disable(struct lttng_kernel_event_common *event)
702 {
703 int ret = 0;
704
705 mutex_lock(&sessions_mutex);
706 switch (event->type) {
707 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
708 {
709 struct lttng_kernel_event_recorder *event_recorder =
710 container_of(event, struct lttng_kernel_event_recorder, parent);
711
712 if (event_recorder->chan->priv->channel_type == METADATA_CHANNEL) {
713 ret = -EPERM;
714 goto end;
715 }
716 break;
717 }
718 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
719 switch (event->priv->instrumentation) {
720 case LTTNG_KERNEL_ABI_KRETPROBE:
721 ret = -EINVAL;
722 goto end;
723 default:
724 break;
725 }
726 break;
727 default:
728 break;
729 }
730
731 if (!event->enabled) {
732 ret = -EEXIST;
733 goto end;
734 }
735 switch (event->priv->instrumentation) {
736 case LTTNG_KERNEL_ABI_TRACEPOINT:
737 lttng_fallthrough;
738 case LTTNG_KERNEL_ABI_SYSCALL:
739 ret = -EINVAL;
740 break;
741
742 case LTTNG_KERNEL_ABI_KPROBE:
743 lttng_fallthrough;
744 case LTTNG_KERNEL_ABI_UPROBE:
745 WRITE_ONCE(event->enabled, 0);
746 break;
747
748 case LTTNG_KERNEL_ABI_KRETPROBE:
749 ret = lttng_kretprobes_event_enable_state(event, 0);
750 break;
751
752 case LTTNG_KERNEL_ABI_FUNCTION:
753 lttng_fallthrough;
754 case LTTNG_KERNEL_ABI_NOOP:
755 lttng_fallthrough;
756 default:
757 WARN_ON_ONCE(1);
758 ret = -EINVAL;
759 }
760 end:
761 mutex_unlock(&sessions_mutex);
762 return ret;
763 }
764
765 struct lttng_kernel_channel_buffer *lttng_channel_buffer_create(struct lttng_kernel_session *session,
766 const char *transport_name,
767 void *buf_addr,
768 size_t subbuf_size, size_t num_subbuf,
769 unsigned int switch_timer_interval,
770 unsigned int read_timer_interval,
771 enum channel_type channel_type)
772 {
773 struct lttng_kernel_channel_buffer *chan;
774 struct lttng_kernel_channel_buffer_private *chan_priv;
775 struct lttng_transport *transport = NULL;
776
777 mutex_lock(&sessions_mutex);
778 if (session->priv->been_active && channel_type != METADATA_CHANNEL)
779 goto active; /* Refuse to add channel to active session */
780 transport = lttng_transport_find(transport_name);
781 if (!transport) {
782 printk(KERN_WARNING "LTTng: transport %s not found\n",
783 transport_name);
784 goto notransport;
785 }
786 if (!try_module_get(transport->owner)) {
787 printk(KERN_WARNING "LTTng: Can't lock transport module.\n");
788 goto notransport;
789 }
790 chan = kzalloc(sizeof(struct lttng_kernel_channel_buffer), GFP_KERNEL);
791 if (!chan)
792 goto nomem;
793 chan_priv = kzalloc(sizeof(struct lttng_kernel_channel_buffer_private), GFP_KERNEL);
794 if (!chan_priv)
795 goto nomem_priv;
796 chan->priv = chan_priv;
797 chan_priv->pub = chan;
798 chan->parent.type = LTTNG_KERNEL_CHANNEL_TYPE_BUFFER;
799 chan->parent.session = session;
800 chan->priv->id = session->priv->free_chan_id++;
801 chan->ops = &transport->ops;
802 /*
803 * Note: the channel creation op already writes into the packet
804 * headers. Therefore the "chan" information used as input
805 * should be already accessible.
806 */
807 chan->priv->rb_chan = transport->ops.priv->channel_create(transport_name,
808 chan, buf_addr, subbuf_size, num_subbuf,
809 switch_timer_interval, read_timer_interval);
810 if (!chan->priv->rb_chan)
811 goto create_error;
812 chan->priv->parent.tstate = 1;
813 chan->parent.enabled = 1;
814 chan->priv->transport = transport;
815 chan->priv->channel_type = channel_type;
816 list_add(&chan->priv->node, &session->priv->chan);
817 mutex_unlock(&sessions_mutex);
818 return chan;
819
820 create_error:
821 kfree(chan_priv);
822 nomem_priv:
823 kfree(chan);
824 nomem:
825 if (transport)
826 module_put(transport->owner);
827 notransport:
828 active:
829 mutex_unlock(&sessions_mutex);
830 return NULL;
831 }
832
833 /*
834 * Only used internally at session destruction for per-cpu channels, and
835 * when metadata channel is released.
836 * Needs to be called with sessions mutex held.
837 */
838 static
839 void _lttng_channel_destroy(struct lttng_kernel_channel_buffer *chan)
840 {
841 chan->ops->priv->channel_destroy(chan->priv->rb_chan);
842 module_put(chan->priv->transport->owner);
843 list_del(&chan->priv->node);
844 lttng_kernel_destroy_context(chan->priv->ctx);
845 kfree(chan->priv);
846 kfree(chan);
847 }
848
849 void lttng_metadata_channel_destroy(struct lttng_kernel_channel_buffer *chan)
850 {
851 BUG_ON(chan->priv->channel_type != METADATA_CHANNEL);
852
853 /* Protect the metadata cache with the sessions_mutex. */
854 mutex_lock(&sessions_mutex);
855 _lttng_channel_destroy(chan);
856 mutex_unlock(&sessions_mutex);
857 }
858 EXPORT_SYMBOL_GPL(lttng_metadata_channel_destroy);
859
860 static
861 void _lttng_metadata_channel_hangup(struct lttng_metadata_stream *stream)
862 {
863 stream->finalized = 1;
864 wake_up_interruptible(&stream->read_wait);
865 }
866
867 static
868 bool lttng_kernel_event_id_available(struct lttng_event_enabler_common *event_enabler)
869 {
870 struct lttng_kernel_abi_event *event_param = &event_enabler->event_param;
871 enum lttng_kernel_abi_instrumentation itype = event_param->instrumentation;
872
873 switch (event_enabler->enabler_type) {
874 case LTTNG_EVENT_ENABLER_TYPE_RECORDER:
875 {
876 struct lttng_event_recorder_enabler *event_recorder_enabler =
877 container_of(event_enabler, struct lttng_event_recorder_enabler, parent);
878 struct lttng_kernel_channel_buffer *chan = event_recorder_enabler->chan;
879
880 switch (itype) {
881 case LTTNG_KERNEL_ABI_TRACEPOINT:
882 lttng_fallthrough;
883 case LTTNG_KERNEL_ABI_KPROBE:
884 lttng_fallthrough;
885 case LTTNG_KERNEL_ABI_SYSCALL:
886 lttng_fallthrough;
887 case LTTNG_KERNEL_ABI_UPROBE:
888 if (chan->priv->free_event_id == -1U)
889 return false;
890 return true;
891 case LTTNG_KERNEL_ABI_KRETPROBE:
892 /* kretprobes require 2 event IDs. */
893 if (chan->priv->free_event_id >= -2U)
894 return false;
895 return true;
896 default:
897 WARN_ON_ONCE(1);
898 return false;
899 }
900 }
901 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER:
902 return true;
903 default:
904 WARN_ON_ONCE(1);
905 return false;
906 }
907 }
908
909 static
910 struct lttng_kernel_event_common *lttng_kernel_event_alloc(struct lttng_event_enabler_common *event_enabler)
911 {
912 struct lttng_kernel_abi_event *event_param = &event_enabler->event_param;
913 enum lttng_kernel_abi_instrumentation itype = event_param->instrumentation;
914
915 switch (event_enabler->enabler_type) {
916 case LTTNG_EVENT_ENABLER_TYPE_RECORDER:
917 {
918 struct lttng_event_recorder_enabler *event_recorder_enabler =
919 container_of(event_enabler, struct lttng_event_recorder_enabler, parent);
920 struct lttng_kernel_event_recorder *event_recorder;
921 struct lttng_kernel_event_recorder_private *event_recorder_priv;
922 struct lttng_kernel_channel_buffer *chan = event_recorder_enabler->chan;
923
924 event_recorder = kmem_cache_zalloc(event_recorder_cache, GFP_KERNEL);
925 if (!event_recorder)
926 return NULL;
927 event_recorder_priv = kmem_cache_zalloc(event_recorder_private_cache, GFP_KERNEL);
928 if (!event_recorder_priv) {
929 kmem_cache_free(event_recorder_private_cache, event_recorder);
930 return NULL;
931 }
932 event_recorder_priv->pub = event_recorder;
933 event_recorder_priv->parent.pub = &event_recorder->parent;
934 event_recorder->priv = event_recorder_priv;
935 event_recorder->parent.priv = &event_recorder_priv->parent;
936
937 event_recorder->parent.type = LTTNG_KERNEL_EVENT_TYPE_RECORDER;
938 event_recorder->parent.run_filter = lttng_kernel_interpret_event_filter;
939 event_recorder->priv->parent.instrumentation = itype;
940 INIT_LIST_HEAD(&event_recorder->priv->parent.filter_bytecode_runtime_head);
941 INIT_LIST_HEAD(&event_recorder->priv->parent.enablers_ref_head);
942
943 event_recorder->chan = chan;
944 event_recorder->priv->id = chan->priv->free_event_id++;
945 return &event_recorder->parent;
946 }
947 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER:
948 {
949 struct lttng_event_notifier_enabler *event_notifier_enabler =
950 container_of(event_enabler, struct lttng_event_notifier_enabler, parent);
951 struct lttng_kernel_event_notifier *event_notifier;
952 struct lttng_kernel_event_notifier_private *event_notifier_priv;
953
954 event_notifier = kmem_cache_zalloc(event_notifier_cache, GFP_KERNEL);
955 if (!event_notifier)
956 return NULL;
957 event_notifier_priv = kmem_cache_zalloc(event_notifier_private_cache, GFP_KERNEL);
958 if (!event_notifier_priv) {
959 kmem_cache_free(event_notifier_private_cache, event_notifier);
960 return NULL;
961 }
962 event_notifier_priv->pub = event_notifier;
963 event_notifier_priv->parent.pub = &event_notifier->parent;
964 event_notifier->priv = event_notifier_priv;
965 event_notifier->parent.priv = &event_notifier_priv->parent;
966
967 event_notifier->parent.type = LTTNG_KERNEL_EVENT_TYPE_NOTIFIER;
968 event_notifier->parent.run_filter = lttng_kernel_interpret_event_filter;
969 event_notifier->priv->parent.instrumentation = itype;
970 event_notifier->priv->parent.user_token = event_enabler->user_token;
971 INIT_LIST_HEAD(&event_notifier->priv->parent.filter_bytecode_runtime_head);
972 INIT_LIST_HEAD(&event_notifier->priv->parent.enablers_ref_head);
973
974 event_notifier->priv->group = event_notifier_enabler->group;
975 event_notifier->priv->error_counter_index = event_notifier_enabler->error_counter_index;
976 event_notifier->priv->num_captures = 0;
977 event_notifier->notification_send = lttng_event_notifier_notification_send;
978 INIT_LIST_HEAD(&event_notifier->priv->capture_bytecode_runtime_head);
979 return &event_notifier->parent;
980 }
981 default:
982 return NULL;
983 }
984 }
985
986 static
987 void lttng_kernel_event_free(struct lttng_kernel_event_common *event)
988 {
989 switch (event->type) {
990 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
991 {
992 struct lttng_kernel_event_recorder *event_recorder =
993 container_of(event, struct lttng_kernel_event_recorder, parent);
994
995 kmem_cache_free(event_recorder_private_cache, event_recorder->priv);
996 kmem_cache_free(event_recorder_cache, event_recorder);
997 break;
998 }
999 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
1000 {
1001 struct lttng_kernel_event_notifier *event_notifier =
1002 container_of(event, struct lttng_kernel_event_notifier, parent);
1003
1004 kmem_cache_free(event_notifier_private_cache, event_notifier->priv);
1005 kmem_cache_free(event_notifier_cache, event_notifier);
1006 break;
1007 }
1008 default:
1009 WARN_ON_ONCE(1);
1010 }
1011 }
1012
1013 static
1014 int lttng_kernel_event_notifier_clear_error_counter(struct lttng_kernel_event_common *event)
1015 {
1016 switch (event->type) {
1017 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
1018 return 0;
1019 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
1020 {
1021 struct lttng_kernel_event_notifier *event_notifier =
1022 container_of(event, struct lttng_kernel_event_notifier, parent);
1023 struct lttng_counter *error_counter;
1024 struct lttng_event_notifier_group *event_notifier_group = event_notifier->priv->group;
1025 size_t dimension_index[1];
1026 int ret;
1027
1028 /*
1029 * Clear the error counter bucket. The sessiond keeps track of which
1030 * bucket is currently in use. We trust it. The session lock
1031 * synchronizes against concurrent creation of the error
1032 * counter.
1033 */
1034 error_counter = event_notifier_group->error_counter;
1035 if (!error_counter)
1036 return 0;
1037 /*
1038 * Check that the index is within the boundary of the counter.
1039 */
1040 if (event_notifier->priv->error_counter_index >= event_notifier_group->error_counter_len) {
1041 printk(KERN_INFO "LTTng: event_notifier: Error counter index out-of-bound: counter-len=%zu, index=%llu\n",
1042 event_notifier_group->error_counter_len, event_notifier->priv->error_counter_index);
1043 return -EINVAL;
1044 }
1045
1046 dimension_index[0] = event_notifier->priv->error_counter_index;
1047 ret = error_counter->ops->counter_clear(error_counter->counter, dimension_index);
1048 if (ret) {
1049 printk(KERN_INFO "LTTng: event_notifier: Unable to clear error counter bucket %llu\n",
1050 event_notifier->priv->error_counter_index);
1051 return -EINVAL;
1052 }
1053 return 0;
1054 }
1055 default:
1056 return -EINVAL;
1057 }
1058 }
1059
1060 /*
1061 * Supports event creation while tracing session is active.
1062 * Needs to be called with sessions mutex held.
1063 */
1064 struct lttng_kernel_event_common *_lttng_kernel_event_create(struct lttng_event_enabler_common *event_enabler,
1065 const struct lttng_kernel_event_desc *event_desc)
1066 {
1067 struct lttng_event_ht *events_ht = lttng_get_event_ht_from_enabler(event_enabler);
1068 struct list_head *event_list_head = lttng_get_event_list_head_from_enabler(event_enabler);
1069 struct lttng_kernel_abi_event *event_param = &event_enabler->event_param;
1070 enum lttng_kernel_abi_instrumentation itype = event_param->instrumentation;
1071 struct lttng_kernel_event_common_private *event_priv;
1072 struct lttng_kernel_event_common *event;
1073 const char *event_name;
1074 struct hlist_head *head;
1075 int ret;
1076
1077 if (!lttng_kernel_event_id_available(event_enabler)) {
1078 ret = -EMFILE;
1079 goto full;
1080 }
1081
1082 switch (itype) {
1083 case LTTNG_KERNEL_ABI_TRACEPOINT:
1084 event_name = event_desc->event_name;
1085 break;
1086
1087 case LTTNG_KERNEL_ABI_KPROBE:
1088 lttng_fallthrough;
1089 case LTTNG_KERNEL_ABI_UPROBE:
1090 lttng_fallthrough;
1091 case LTTNG_KERNEL_ABI_KRETPROBE:
1092 lttng_fallthrough;
1093 case LTTNG_KERNEL_ABI_SYSCALL:
1094 event_name = event_param->name;
1095 break;
1096
1097 case LTTNG_KERNEL_ABI_FUNCTION:
1098 lttng_fallthrough;
1099 case LTTNG_KERNEL_ABI_NOOP:
1100 lttng_fallthrough;
1101 default:
1102 WARN_ON_ONCE(1);
1103 ret = -EINVAL;
1104 goto type_error;
1105 }
1106
1107 head = utils_borrow_hash_table_bucket(events_ht->table, LTTNG_EVENT_HT_SIZE, event_name);
1108 lttng_hlist_for_each_entry(event_priv, head, hlist_node) {
1109 if (lttng_event_enabler_event_name_match_event(event_enabler, event_name, event_priv->pub)) {
1110 ret = -EEXIST;
1111 goto exist;
1112 }
1113 }
1114
1115 event = lttng_kernel_event_alloc(event_enabler);
1116 if (!event) {
1117 ret = -ENOMEM;
1118 goto alloc_error;
1119 }
1120
1121 switch (itype) {
1122 case LTTNG_KERNEL_ABI_TRACEPOINT:
1123 /* Event will be enabled by enabler sync. */
1124 event->enabled = 0;
1125 event->priv->registered = 0;
1126 event->priv->desc = lttng_event_desc_get(event_name);
1127 if (!event->priv->desc) {
1128 ret = -ENOENT;
1129 goto register_error;
1130 }
1131 /* Populate lttng_event structure before event registration. */
1132 smp_wmb();
1133 break;
1134
1135 case LTTNG_KERNEL_ABI_KPROBE:
1136 /*
1137 * Needs to be explicitly enabled after creation, since
1138 * we may want to apply filters.
1139 */
1140 event->enabled = 0;
1141 event->priv->registered = 1;
1142 /*
1143 * Populate lttng_event structure before event
1144 * registration.
1145 */
1146 smp_wmb();
1147 ret = lttng_kprobes_register_event(event_name,
1148 event_param->u.kprobe.symbol_name,
1149 event_param->u.kprobe.offset,
1150 event_param->u.kprobe.addr,
1151 event);
1152 if (ret) {
1153 ret = -EINVAL;
1154 goto register_error;
1155 }
1156 ret = try_module_get(event->priv->desc->owner);
1157 WARN_ON_ONCE(!ret);
1158 break;
1159
1160 case LTTNG_KERNEL_ABI_KRETPROBE:
1161 {
1162 struct lttng_kernel_event_common *event_return;
1163
1164 /* kretprobe defines 2 events */
1165 /*
1166 * Needs to be explicitly enabled after creation, since
1167 * we may want to apply filters.
1168 */
1169 event->enabled = 0;
1170 event->priv->registered = 1;
1171
1172 event_return = lttng_kernel_event_alloc(event_enabler);
1173 if (!event) {
1174 ret = -ENOMEM;
1175 goto alloc_error;
1176 }
1177
1178 event_return->enabled = 0;
1179 event_return->priv->registered = 1;
1180
1181 /*
1182 * Populate lttng_event structure before kretprobe registration.
1183 */
1184 smp_wmb();
1185 ret = lttng_kretprobes_register(event_name,
1186 event_param->u.kretprobe.symbol_name,
1187 event_param->u.kretprobe.offset,
1188 event_param->u.kretprobe.addr,
1189 event, event_return);
1190 if (ret) {
1191 lttng_kernel_event_free(event_return);
1192 ret = -EINVAL;
1193 goto register_error;
1194 }
1195 /* Take 2 refs on the module: one per event. */
1196 ret = try_module_get(event->priv->desc->owner);
1197 WARN_ON_ONCE(!ret);
1198 ret = try_module_get(event_return->priv->desc->owner);
1199 WARN_ON_ONCE(!ret);
1200 ret = _lttng_event_recorder_metadata_statedump(event_return);
1201 WARN_ON_ONCE(ret > 0);
1202 if (ret) {
1203 lttng_kernel_event_free(event_return);
1204 module_put(event_return->priv->desc->owner);
1205 module_put(event->priv->desc->owner);
1206 goto statedump_error;
1207 }
1208 list_add(&event_return->priv->node, event_list_head);
1209 break;
1210 }
1211
1212 case LTTNG_KERNEL_ABI_SYSCALL:
1213 /*
1214 * Needs to be explicitly enabled after creation, since
1215 * we may want to apply filters.
1216 */
1217 event->enabled = 0;
1218 event->priv->registered = 0;
1219 event->priv->desc = event_desc;
1220 switch (event_param->u.syscall.entryexit) {
1221 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT:
1222 ret = -EINVAL;
1223 goto register_error;
1224 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY:
1225 event->priv->u.syscall.entryexit = LTTNG_SYSCALL_ENTRY;
1226 break;
1227 case LTTNG_KERNEL_ABI_SYSCALL_EXIT:
1228 event->priv->u.syscall.entryexit = LTTNG_SYSCALL_EXIT;
1229 break;
1230 }
1231 switch (event_param->u.syscall.abi) {
1232 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL:
1233 ret = -EINVAL;
1234 goto register_error;
1235 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE:
1236 event->priv->u.syscall.abi = LTTNG_SYSCALL_ABI_NATIVE;
1237 break;
1238 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT:
1239 event->priv->u.syscall.abi = LTTNG_SYSCALL_ABI_COMPAT;
1240 break;
1241 }
1242 if (!event->priv->desc) {
1243 ret = -EINVAL;
1244 goto register_error;
1245 }
1246 break;
1247
1248 case LTTNG_KERNEL_ABI_UPROBE:
1249 /*
1250 * Needs to be explicitly enabled after creation, since
1251 * we may want to apply filters.
1252 */
1253 event->enabled = 0;
1254 event->priv->registered = 1;
1255
1256 /*
1257 * Populate lttng_event structure before event
1258 * registration.
1259 */
1260 smp_wmb();
1261
1262 ret = lttng_uprobes_register_event(event_param->name,
1263 event_param->u.uprobe.fd,
1264 event);
1265 if (ret)
1266 goto register_error;
1267 ret = try_module_get(event->priv->desc->owner);
1268 WARN_ON_ONCE(!ret);
1269 break;
1270
1271 case LTTNG_KERNEL_ABI_FUNCTION:
1272 lttng_fallthrough;
1273 case LTTNG_KERNEL_ABI_NOOP:
1274 lttng_fallthrough;
1275 default:
1276 WARN_ON_ONCE(1);
1277 ret = -EINVAL;
1278 goto register_error;
1279 }
1280
1281 ret = _lttng_event_recorder_metadata_statedump(event);
1282 WARN_ON_ONCE(ret > 0);
1283 if (ret) {
1284 goto statedump_error;
1285 }
1286
1287 ret = lttng_kernel_event_notifier_clear_error_counter(event);
1288 if (ret)
1289 goto register_error;
1290
1291 hlist_add_head(&event->priv->hlist_node, head);
1292 list_add(&event->priv->node, event_list_head);
1293
1294 return event;
1295
1296 statedump_error:
1297 /* If a statedump error occurs, events will not be readable. */
1298 register_error:
1299 lttng_kernel_event_free(event);
1300 alloc_error:
1301 exist:
1302 type_error:
1303 full:
1304 return ERR_PTR(ret);
1305 }
1306
1307 struct lttng_kernel_event_common *lttng_kernel_event_create(struct lttng_event_enabler_common *event_enabler,
1308 const struct lttng_kernel_event_desc *event_desc)
1309 {
1310 struct lttng_kernel_event_common *event;
1311
1312 mutex_lock(&sessions_mutex);
1313 event = _lttng_kernel_event_create(event_enabler, event_desc);
1314 mutex_unlock(&sessions_mutex);
1315 return event;
1316 }
1317
1318 int lttng_kernel_counter_read(struct lttng_counter *counter,
1319 const size_t *dim_indexes, int32_t cpu,
1320 int64_t *val, bool *overflow, bool *underflow)
1321 {
1322 return counter->ops->counter_read(counter->counter, dim_indexes,
1323 cpu, val, overflow, underflow);
1324 }
1325
1326 int lttng_kernel_counter_aggregate(struct lttng_counter *counter,
1327 const size_t *dim_indexes, int64_t *val,
1328 bool *overflow, bool *underflow)
1329 {
1330 return counter->ops->counter_aggregate(counter->counter, dim_indexes,
1331 val, overflow, underflow);
1332 }
1333
1334 int lttng_kernel_counter_clear(struct lttng_counter *counter,
1335 const size_t *dim_indexes)
1336 {
1337 return counter->ops->counter_clear(counter->counter, dim_indexes);
1338 }
1339
1340 /* Only used for tracepoints for now. */
1341 static
1342 void register_event(struct lttng_kernel_event_common *event)
1343 {
1344 const struct lttng_kernel_event_desc *desc;
1345 int ret = -EINVAL;
1346
1347 if (event->priv->registered)
1348 return;
1349
1350 desc = event->priv->desc;
1351 switch (event->priv->instrumentation) {
1352 case LTTNG_KERNEL_ABI_TRACEPOINT:
1353 ret = lttng_wrapper_tracepoint_probe_register(desc->event_kname,
1354 desc->tp_class->probe_callback,
1355 event);
1356 break;
1357
1358 case LTTNG_KERNEL_ABI_SYSCALL:
1359 ret = lttng_syscall_filter_enable_event(event);
1360 break;
1361
1362 case LTTNG_KERNEL_ABI_KPROBE:
1363 lttng_fallthrough;
1364 case LTTNG_KERNEL_ABI_UPROBE:
1365 ret = 0;
1366 break;
1367
1368 case LTTNG_KERNEL_ABI_KRETPROBE:
1369 switch (event->type) {
1370 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
1371 ret = 0;
1372 break;
1373 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
1374 WARN_ON_ONCE(1);
1375 break;
1376 }
1377 break;
1378
1379 case LTTNG_KERNEL_ABI_FUNCTION:
1380 lttng_fallthrough;
1381 case LTTNG_KERNEL_ABI_NOOP:
1382 lttng_fallthrough;
1383 default:
1384 WARN_ON_ONCE(1);
1385 }
1386 if (!ret)
1387 event->priv->registered = 1;
1388 }
1389
1390 int _lttng_event_unregister(struct lttng_kernel_event_common *event)
1391 {
1392 struct lttng_kernel_event_common_private *event_priv = event->priv;
1393 const struct lttng_kernel_event_desc *desc;
1394 int ret = -EINVAL;
1395
1396 if (!event_priv->registered)
1397 return 0;
1398
1399 desc = event_priv->desc;
1400 switch (event_priv->instrumentation) {
1401 case LTTNG_KERNEL_ABI_TRACEPOINT:
1402 ret = lttng_wrapper_tracepoint_probe_unregister(event_priv->desc->event_kname,
1403 event_priv->desc->tp_class->probe_callback,
1404 event);
1405 break;
1406
1407 case LTTNG_KERNEL_ABI_KPROBE:
1408 lttng_kprobes_unregister_event(event);
1409 ret = 0;
1410 break;
1411
1412 case LTTNG_KERNEL_ABI_KRETPROBE:
1413 switch (event->type) {
1414 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
1415 lttng_kretprobes_unregister(event);
1416 ret = 0;
1417 break;
1418 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
1419 WARN_ON_ONCE(1);
1420 break;
1421 }
1422 break;
1423
1424 case LTTNG_KERNEL_ABI_SYSCALL:
1425 ret = lttng_syscall_filter_disable_event(event);
1426 break;
1427
1428 case LTTNG_KERNEL_ABI_NOOP:
1429 switch (event->type) {
1430 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
1431 ret = 0;
1432 break;
1433 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
1434 WARN_ON_ONCE(1);
1435 break;
1436 }
1437 break;
1438
1439 case LTTNG_KERNEL_ABI_UPROBE:
1440 lttng_uprobes_unregister_event(event);
1441 ret = 0;
1442 break;
1443
1444 case LTTNG_KERNEL_ABI_FUNCTION:
1445 lttng_fallthrough;
1446 default:
1447 WARN_ON_ONCE(1);
1448 }
1449 if (!ret)
1450 event_priv->registered = 0;
1451 return ret;
1452 }
1453
1454 /*
1455 * Only used internally at session destruction.
1456 */
1457 static
1458 void _lttng_event_destroy(struct lttng_kernel_event_common *event)
1459 {
1460 struct lttng_kernel_event_common_private *event_priv = event->priv;
1461 struct lttng_enabler_ref *enabler_ref, *tmp_enabler_ref;
1462
1463 lttng_free_event_filter_runtime(event);
1464 /* Free event enabler refs */
1465 list_for_each_entry_safe(enabler_ref, tmp_enabler_ref,
1466 &event_priv->enablers_ref_head, node)
1467 kfree(enabler_ref);
1468
1469 switch (event->type) {
1470 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
1471 {
1472 struct lttng_kernel_event_recorder *event_recorder =
1473 container_of(event, struct lttng_kernel_event_recorder, parent);
1474
1475 switch (event_priv->instrumentation) {
1476 case LTTNG_KERNEL_ABI_TRACEPOINT:
1477 lttng_event_desc_put(event_priv->desc);
1478 break;
1479
1480 case LTTNG_KERNEL_ABI_KPROBE:
1481 module_put(event_priv->desc->owner);
1482 lttng_kprobes_destroy_event_private(&event_recorder->parent);
1483 break;
1484
1485 case LTTNG_KERNEL_ABI_KRETPROBE:
1486 module_put(event_priv->desc->owner);
1487 lttng_kretprobes_destroy_private(&event_recorder->parent);
1488 break;
1489
1490 case LTTNG_KERNEL_ABI_SYSCALL:
1491 break;
1492
1493 case LTTNG_KERNEL_ABI_UPROBE:
1494 module_put(event_priv->desc->owner);
1495 lttng_uprobes_destroy_event_private(&event_recorder->parent);
1496 break;
1497
1498 case LTTNG_KERNEL_ABI_FUNCTION:
1499 lttng_fallthrough;
1500 case LTTNG_KERNEL_ABI_NOOP:
1501 lttng_fallthrough;
1502 default:
1503 WARN_ON_ONCE(1);
1504 }
1505 list_del(&event_recorder->priv->parent.node);
1506 kmem_cache_free(event_recorder_private_cache, event_recorder->priv);
1507 kmem_cache_free(event_recorder_cache, event_recorder);
1508 break;
1509 }
1510 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
1511 {
1512 struct lttng_kernel_event_notifier *event_notifier =
1513 container_of(event, struct lttng_kernel_event_notifier, parent);
1514
1515 switch (event_notifier->priv->parent.instrumentation) {
1516 case LTTNG_KERNEL_ABI_TRACEPOINT:
1517 lttng_event_desc_put(event_notifier->priv->parent.desc);
1518 break;
1519
1520 case LTTNG_KERNEL_ABI_KPROBE:
1521 module_put(event_notifier->priv->parent.desc->owner);
1522 lttng_kprobes_destroy_event_private(&event_notifier->parent);
1523 break;
1524
1525 case LTTNG_KERNEL_ABI_SYSCALL:
1526 break;
1527
1528 case LTTNG_KERNEL_ABI_UPROBE:
1529 module_put(event_notifier->priv->parent.desc->owner);
1530 lttng_uprobes_destroy_event_private(&event_notifier->parent);
1531 break;
1532
1533 case LTTNG_KERNEL_ABI_KRETPROBE:
1534 lttng_fallthrough;
1535 case LTTNG_KERNEL_ABI_FUNCTION:
1536 lttng_fallthrough;
1537 case LTTNG_KERNEL_ABI_NOOP:
1538 lttng_fallthrough;
1539 default:
1540 WARN_ON_ONCE(1);
1541 }
1542 list_del(&event_notifier->priv->parent.node);
1543 kmem_cache_free(event_notifier_private_cache, event_notifier->priv);
1544 kmem_cache_free(event_notifier_cache, event_notifier);
1545 break;
1546 }
1547 default:
1548 WARN_ON_ONCE(1);
1549 }
1550 }
1551
1552 struct lttng_kernel_id_tracker *get_tracker(struct lttng_kernel_session *session,
1553 enum tracker_type tracker_type)
1554 {
1555 switch (tracker_type) {
1556 case TRACKER_PID:
1557 return &session->pid_tracker;
1558 case TRACKER_VPID:
1559 return &session->vpid_tracker;
1560 case TRACKER_UID:
1561 return &session->uid_tracker;
1562 case TRACKER_VUID:
1563 return &session->vuid_tracker;
1564 case TRACKER_GID:
1565 return &session->gid_tracker;
1566 case TRACKER_VGID:
1567 return &session->vgid_tracker;
1568 default:
1569 WARN_ON_ONCE(1);
1570 return NULL;
1571 }
1572 }
1573
1574 int lttng_session_track_id(struct lttng_kernel_session *session,
1575 enum tracker_type tracker_type, int id)
1576 {
1577 struct lttng_kernel_id_tracker *tracker;
1578 int ret;
1579
1580 tracker = get_tracker(session, tracker_type);
1581 if (!tracker)
1582 return -EINVAL;
1583 if (id < -1)
1584 return -EINVAL;
1585 mutex_lock(&sessions_mutex);
1586 if (id == -1) {
1587 /* track all ids: destroy tracker. */
1588 lttng_id_tracker_destroy(tracker, true);
1589 ret = 0;
1590 } else {
1591 ret = lttng_id_tracker_add(tracker, id);
1592 }
1593 mutex_unlock(&sessions_mutex);
1594 return ret;
1595 }
1596
1597 int lttng_session_untrack_id(struct lttng_kernel_session *session,
1598 enum tracker_type tracker_type, int id)
1599 {
1600 struct lttng_kernel_id_tracker *tracker;
1601 int ret;
1602
1603 tracker = get_tracker(session, tracker_type);
1604 if (!tracker)
1605 return -EINVAL;
1606 if (id < -1)
1607 return -EINVAL;
1608 mutex_lock(&sessions_mutex);
1609 if (id == -1) {
1610 /* untrack all ids: replace by empty tracker. */
1611 ret = lttng_id_tracker_empty_set(tracker);
1612 } else {
1613 ret = lttng_id_tracker_del(tracker, id);
1614 }
1615 mutex_unlock(&sessions_mutex);
1616 return ret;
1617 }
1618
1619 static
1620 void *id_list_start(struct seq_file *m, loff_t *pos)
1621 {
1622 struct lttng_kernel_id_tracker *id_tracker = m->private;
1623 struct lttng_kernel_id_tracker_rcu *id_tracker_p = id_tracker->p;
1624 struct lttng_id_hash_node *e;
1625 int iter = 0, i;
1626
1627 mutex_lock(&sessions_mutex);
1628 if (id_tracker_p) {
1629 for (i = 0; i < LTTNG_ID_TABLE_SIZE; i++) {
1630 struct hlist_head *head = &id_tracker_p->id_hash[i];
1631
1632 lttng_hlist_for_each_entry(e, head, hlist) {
1633 if (iter++ >= *pos)
1634 return e;
1635 }
1636 }
1637 } else {
1638 /* ID tracker disabled. */
1639 if (iter >= *pos && iter == 0) {
1640 return id_tracker_p; /* empty tracker */
1641 }
1642 iter++;
1643 }
1644 /* End of list */
1645 return NULL;
1646 }
1647
1648 /* Called with sessions_mutex held. */
1649 static
1650 void *id_list_next(struct seq_file *m, void *p, loff_t *ppos)
1651 {
1652 struct lttng_kernel_id_tracker *id_tracker = m->private;
1653 struct lttng_kernel_id_tracker_rcu *id_tracker_p = id_tracker->p;
1654 struct lttng_id_hash_node *e;
1655 int iter = 0, i;
1656
1657 (*ppos)++;
1658 if (id_tracker_p) {
1659 for (i = 0; i < LTTNG_ID_TABLE_SIZE; i++) {
1660 struct hlist_head *head = &id_tracker_p->id_hash[i];
1661
1662 lttng_hlist_for_each_entry(e, head, hlist) {
1663 if (iter++ >= *ppos)
1664 return e;
1665 }
1666 }
1667 } else {
1668 /* ID tracker disabled. */
1669 if (iter >= *ppos && iter == 0)
1670 return p; /* empty tracker */
1671 iter++;
1672 }
1673
1674 /* End of list */
1675 return NULL;
1676 }
1677
1678 static
1679 void id_list_stop(struct seq_file *m, void *p)
1680 {
1681 mutex_unlock(&sessions_mutex);
1682 }
1683
1684 static
1685 int id_list_show(struct seq_file *m, void *p)
1686 {
1687 struct lttng_kernel_id_tracker *id_tracker = m->private;
1688 struct lttng_kernel_id_tracker_rcu *id_tracker_p = id_tracker->p;
1689 int id;
1690
1691 if (p == id_tracker_p) {
1692 /* Tracker disabled. */
1693 id = -1;
1694 } else {
1695 const struct lttng_id_hash_node *e = p;
1696
1697 id = lttng_id_tracker_get_node_id(e);
1698 }
1699 switch (id_tracker->priv->tracker_type) {
1700 case TRACKER_PID:
1701 seq_printf(m, "process { pid = %d; };\n", id);
1702 break;
1703 case TRACKER_VPID:
1704 seq_printf(m, "process { vpid = %d; };\n", id);
1705 break;
1706 case TRACKER_UID:
1707 seq_printf(m, "user { uid = %d; };\n", id);
1708 break;
1709 case TRACKER_VUID:
1710 seq_printf(m, "user { vuid = %d; };\n", id);
1711 break;
1712 case TRACKER_GID:
1713 seq_printf(m, "group { gid = %d; };\n", id);
1714 break;
1715 case TRACKER_VGID:
1716 seq_printf(m, "group { vgid = %d; };\n", id);
1717 break;
1718 default:
1719 seq_printf(m, "UNKNOWN { field = %d };\n", id);
1720 }
1721 return 0;
1722 }
1723
1724 static
1725 const struct seq_operations lttng_tracker_ids_list_seq_ops = {
1726 .start = id_list_start,
1727 .next = id_list_next,
1728 .stop = id_list_stop,
1729 .show = id_list_show,
1730 };
1731
1732 static
1733 int lttng_tracker_ids_list_open(struct inode *inode, struct file *file)
1734 {
1735 return seq_open(file, &lttng_tracker_ids_list_seq_ops);
1736 }
1737
1738 static
1739 int lttng_tracker_ids_list_release(struct inode *inode, struct file *file)
1740 {
1741 struct seq_file *m = file->private_data;
1742 struct lttng_kernel_id_tracker *id_tracker = m->private;
1743 int ret;
1744
1745 WARN_ON_ONCE(!id_tracker);
1746 ret = seq_release(inode, file);
1747 if (!ret)
1748 fput(id_tracker->priv->session->priv->file);
1749 return ret;
1750 }
1751
1752 const struct file_operations lttng_tracker_ids_list_fops = {
1753 .owner = THIS_MODULE,
1754 .open = lttng_tracker_ids_list_open,
1755 .read = seq_read,
1756 .llseek = seq_lseek,
1757 .release = lttng_tracker_ids_list_release,
1758 };
1759
1760 int lttng_session_list_tracker_ids(struct lttng_kernel_session *session,
1761 enum tracker_type tracker_type)
1762 {
1763 struct file *tracker_ids_list_file;
1764 struct seq_file *m;
1765 int file_fd, ret;
1766
1767 file_fd = lttng_get_unused_fd();
1768 if (file_fd < 0) {
1769 ret = file_fd;
1770 goto fd_error;
1771 }
1772
1773 tracker_ids_list_file = anon_inode_getfile("[lttng_tracker_ids_list]",
1774 &lttng_tracker_ids_list_fops,
1775 NULL, O_RDWR);
1776 if (IS_ERR(tracker_ids_list_file)) {
1777 ret = PTR_ERR(tracker_ids_list_file);
1778 goto file_error;
1779 }
1780 if (!atomic_long_add_unless(&session->priv->file->f_count, 1, LONG_MAX)) {
1781 ret = -EOVERFLOW;
1782 goto refcount_error;
1783 }
1784 ret = lttng_tracker_ids_list_fops.open(NULL, tracker_ids_list_file);
1785 if (ret < 0)
1786 goto open_error;
1787 m = tracker_ids_list_file->private_data;
1788
1789 m->private = get_tracker(session, tracker_type);
1790 BUG_ON(!m->private);
1791 fd_install(file_fd, tracker_ids_list_file);
1792
1793 return file_fd;
1794
1795 open_error:
1796 atomic_long_dec(&session->priv->file->f_count);
1797 refcount_error:
1798 fput(tracker_ids_list_file);
1799 file_error:
1800 put_unused_fd(file_fd);
1801 fd_error:
1802 return ret;
1803 }
1804
1805 /*
1806 * Enabler management.
1807 */
1808 static
1809 int lttng_match_enabler_star_glob(const char *desc_name,
1810 const char *pattern)
1811 {
1812 if (!strutils_star_glob_match(pattern, LTTNG_SIZE_MAX,
1813 desc_name, LTTNG_SIZE_MAX))
1814 return 0;
1815 return 1;
1816 }
1817
1818 static
1819 int lttng_match_enabler_name(const char *desc_name,
1820 const char *name)
1821 {
1822 if (strcmp(desc_name, name))
1823 return 0;
1824 return 1;
1825 }
1826
1827 static
1828 int lttng_desc_match_enabler_check(const struct lttng_kernel_event_desc *desc,
1829 struct lttng_event_enabler_common *enabler)
1830 {
1831 const char *desc_name, *enabler_name;
1832 bool compat = false, entry = false;
1833
1834 enabler_name = enabler->event_param.name;
1835 switch (enabler->event_param.instrumentation) {
1836 case LTTNG_KERNEL_ABI_TRACEPOINT:
1837 desc_name = desc->event_name;
1838 switch (enabler->format_type) {
1839 case LTTNG_ENABLER_FORMAT_STAR_GLOB:
1840 return lttng_match_enabler_star_glob(desc_name, enabler_name);
1841 case LTTNG_ENABLER_FORMAT_NAME:
1842 return lttng_match_enabler_name(desc_name, enabler_name);
1843 default:
1844 return -EINVAL;
1845 }
1846 break;
1847
1848 case LTTNG_KERNEL_ABI_SYSCALL:
1849 desc_name = desc->event_name;
1850 if (!strncmp(desc_name, "compat_", strlen("compat_"))) {
1851 desc_name += strlen("compat_");
1852 compat = true;
1853 }
1854 if (!strncmp(desc_name, "syscall_exit_",
1855 strlen("syscall_exit_"))) {
1856 desc_name += strlen("syscall_exit_");
1857 } else if (!strncmp(desc_name, "syscall_entry_",
1858 strlen("syscall_entry_"))) {
1859 desc_name += strlen("syscall_entry_");
1860 entry = true;
1861 } else {
1862 WARN_ON_ONCE(1);
1863 return -EINVAL;
1864 }
1865 switch (enabler->event_param.u.syscall.entryexit) {
1866 case LTTNG_KERNEL_ABI_SYSCALL_ENTRYEXIT:
1867 break;
1868 case LTTNG_KERNEL_ABI_SYSCALL_ENTRY:
1869 if (!entry)
1870 return 0;
1871 break;
1872 case LTTNG_KERNEL_ABI_SYSCALL_EXIT:
1873 if (entry)
1874 return 0;
1875 break;
1876 default:
1877 return -EINVAL;
1878 }
1879 switch (enabler->event_param.u.syscall.abi) {
1880 case LTTNG_KERNEL_ABI_SYSCALL_ABI_ALL:
1881 break;
1882 case LTTNG_KERNEL_ABI_SYSCALL_ABI_NATIVE:
1883 if (compat)
1884 return 0;
1885 break;
1886 case LTTNG_KERNEL_ABI_SYSCALL_ABI_COMPAT:
1887 if (!compat)
1888 return 0;
1889 break;
1890 default:
1891 return -EINVAL;
1892 }
1893 switch (enabler->event_param.u.syscall.match) {
1894 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NAME:
1895 switch (enabler->format_type) {
1896 case LTTNG_ENABLER_FORMAT_STAR_GLOB:
1897 return lttng_match_enabler_star_glob(desc_name, enabler_name);
1898 case LTTNG_ENABLER_FORMAT_NAME:
1899 return lttng_match_enabler_name(desc_name, enabler_name);
1900 default:
1901 return -EINVAL;
1902 }
1903 break;
1904 case LTTNG_KERNEL_ABI_SYSCALL_MATCH_NR:
1905 return -EINVAL; /* Not implemented. */
1906 default:
1907 return -EINVAL;
1908 }
1909 break;
1910
1911 default:
1912 WARN_ON_ONCE(1);
1913 return -EINVAL;
1914 }
1915 }
1916
1917 bool lttng_desc_match_enabler(const struct lttng_kernel_event_desc *desc,
1918 struct lttng_event_enabler_common *enabler)
1919 {
1920 int ret;
1921
1922 ret = lttng_desc_match_enabler_check(desc, enabler);
1923 if (ret < 0) {
1924 WARN_ON_ONCE(1);
1925 return false;
1926 }
1927 return ret;
1928 }
1929
1930 bool lttng_event_enabler_match_event(struct lttng_event_enabler_common *event_enabler,
1931 struct lttng_kernel_event_common *event)
1932 {
1933 if (event_enabler->event_param.instrumentation != event->priv->instrumentation)
1934 return false;
1935
1936 switch (event_enabler->enabler_type) {
1937 case LTTNG_EVENT_ENABLER_TYPE_RECORDER:
1938 {
1939 struct lttng_event_recorder_enabler *event_recorder_enabler =
1940 container_of(event_enabler, struct lttng_event_recorder_enabler, parent);
1941 struct lttng_kernel_event_recorder *event_recorder =
1942 container_of(event, struct lttng_kernel_event_recorder, parent);
1943
1944 if (lttng_desc_match_enabler(event->priv->desc, event_enabler)
1945 && event_recorder->chan == event_recorder_enabler->chan)
1946 return true;
1947 else
1948 return false;
1949 }
1950 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER:
1951 {
1952 struct lttng_event_notifier_enabler *event_notifier_enabler =
1953 container_of(event_enabler, struct lttng_event_notifier_enabler, parent);
1954 struct lttng_kernel_event_notifier *event_notifier =
1955 container_of(event, struct lttng_kernel_event_notifier, parent);
1956
1957 if (lttng_desc_match_enabler(event->priv->desc, event_enabler)
1958 && event_notifier->priv->group == event_notifier_enabler->group
1959 && event->priv->user_token == event_enabler->user_token)
1960 return true;
1961 else
1962 return false;
1963 }
1964 default:
1965 WARN_ON_ONCE(1);
1966 return false;
1967 }
1968 }
1969
1970 bool lttng_event_enabler_desc_match_event(struct lttng_event_enabler_common *event_enabler,
1971 const struct lttng_kernel_event_desc *desc,
1972 struct lttng_kernel_event_common *event)
1973 {
1974 if (event_enabler->event_param.instrumentation != event->priv->instrumentation)
1975 return false;
1976
1977 switch (event_enabler->enabler_type) {
1978 case LTTNG_EVENT_ENABLER_TYPE_RECORDER:
1979 {
1980 struct lttng_event_recorder_enabler *event_recorder_enabler =
1981 container_of(event_enabler, struct lttng_event_recorder_enabler, parent);
1982 struct lttng_kernel_event_recorder *event_recorder =
1983 container_of(event, struct lttng_kernel_event_recorder, parent);
1984
1985 if (event->priv->desc == desc && event_recorder->chan == event_recorder_enabler->chan)
1986 return true;
1987 else
1988 return false;
1989 }
1990 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER:
1991 {
1992 struct lttng_event_notifier_enabler *event_notifier_enabler =
1993 container_of(event_enabler, struct lttng_event_notifier_enabler, parent);
1994 struct lttng_kernel_event_notifier *event_notifier =
1995 container_of(event, struct lttng_kernel_event_notifier, parent);
1996
1997 if (event->priv->desc == desc
1998 && event_notifier->priv->group == event_notifier_enabler->group
1999 && event->priv->user_token == event_enabler->user_token)
2000 return true;
2001 else
2002 return false;
2003 }
2004 default:
2005 WARN_ON_ONCE(1);
2006 return false;
2007 }
2008 }
2009
2010 bool lttng_event_enabler_event_name_match_event(struct lttng_event_enabler_common *event_enabler,
2011 const char *event_name,
2012 struct lttng_kernel_event_common *event)
2013 {
2014 if (event_enabler->event_param.instrumentation != event->priv->instrumentation)
2015 return false;
2016
2017 switch (event_enabler->enabler_type) {
2018 case LTTNG_EVENT_ENABLER_TYPE_RECORDER:
2019 {
2020 struct lttng_event_recorder_enabler *event_recorder_enabler =
2021 container_of(event_enabler, struct lttng_event_recorder_enabler, parent);
2022 struct lttng_kernel_event_recorder *event_recorder =
2023 container_of(event, struct lttng_kernel_event_recorder, parent);
2024
2025 if (!strncmp(event->priv->desc->event_name, event_name, LTTNG_KERNEL_ABI_SYM_NAME_LEN - 1)
2026 && event_recorder->chan == event_recorder_enabler->chan)
2027 return true;
2028 else
2029 return false;
2030 }
2031 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER:
2032 {
2033 struct lttng_event_notifier_enabler *event_notifier_enabler =
2034 container_of(event_enabler, struct lttng_event_notifier_enabler, parent);
2035 struct lttng_kernel_event_notifier *event_notifier =
2036 container_of(event, struct lttng_kernel_event_notifier, parent);
2037
2038 if (!strncmp(event->priv->desc->event_name, event_name, LTTNG_KERNEL_ABI_SYM_NAME_LEN - 1)
2039 && event_notifier->priv->group == event_notifier_enabler->group
2040 && event->priv->user_token == event_enabler->user_token)
2041 return true;
2042 else
2043 return false;
2044 }
2045 default:
2046 WARN_ON_ONCE(1);
2047 return false;
2048 }
2049 }
2050
2051 static
2052 struct lttng_enabler_ref *lttng_enabler_ref(
2053 struct list_head *enablers_ref_list,
2054 struct lttng_event_enabler_common *enabler)
2055 {
2056 struct lttng_enabler_ref *enabler_ref;
2057
2058 list_for_each_entry(enabler_ref, enablers_ref_list, node) {
2059 if (enabler_ref->ref == enabler)
2060 return enabler_ref;
2061 }
2062 return NULL;
2063 }
2064
2065 static
2066 void lttng_create_tracepoint_event_if_missing(struct lttng_event_enabler_common *event_enabler)
2067 {
2068 struct lttng_event_ht *events_ht = lttng_get_event_ht_from_enabler(event_enabler);
2069 struct lttng_kernel_probe_desc *probe_desc;
2070 const struct lttng_kernel_event_desc *desc;
2071 struct list_head *probe_list;
2072 int i;
2073
2074 probe_list = lttng_get_probe_list_head();
2075 /*
2076 * For each probe event, if we find that a probe event matches
2077 * our enabler, create an associated lttng_event if not
2078 * already present.
2079 */
2080 list_for_each_entry(probe_desc, probe_list, head) {
2081 for (i = 0; i < probe_desc->nr_events; i++) {
2082 int found = 0;
2083 struct hlist_head *head;
2084 struct lttng_kernel_event_common *event;
2085 struct lttng_kernel_event_common_private *event_priv;
2086
2087 desc = probe_desc->event_desc[i];
2088 if (!lttng_desc_match_enabler(desc, event_enabler))
2089 continue;
2090
2091 /*
2092 * Check if already created.
2093 */
2094 head = utils_borrow_hash_table_bucket(events_ht->table, LTTNG_EVENT_HT_SIZE, desc->event_name);
2095 lttng_hlist_for_each_entry(event_priv, head, hlist_node) {
2096 if (lttng_event_enabler_desc_match_event(event_enabler, desc, event_priv->pub))
2097 found = 1;
2098 }
2099 if (found)
2100 continue;
2101
2102 /*
2103 * We need to create an event for this event probe.
2104 */
2105 event = _lttng_kernel_event_create(event_enabler, desc);
2106 if (!event) {
2107 printk(KERN_INFO "LTTng: Unable to create event %s\n",
2108 probe_desc->event_desc[i]->event_name);
2109 }
2110 }
2111 }
2112 }
2113
2114 static
2115 void lttng_create_syscall_event_if_missing(struct lttng_event_enabler_common *event_enabler)
2116 {
2117 int ret;
2118
2119 ret = lttng_syscalls_register_event(event_enabler);
2120 WARN_ON_ONCE(ret);
2121 }
2122
2123 /*
2124 * Create event if it is missing and present in the list of tracepoint probes.
2125 * Should be called with sessions mutex held.
2126 */
2127 static
2128 void lttng_create_event_if_missing(struct lttng_event_enabler_common *event_enabler)
2129 {
2130 switch (event_enabler->event_param.instrumentation) {
2131 case LTTNG_KERNEL_ABI_TRACEPOINT:
2132 lttng_create_tracepoint_event_if_missing(event_enabler);
2133 break;
2134
2135 case LTTNG_KERNEL_ABI_SYSCALL:
2136 lttng_create_syscall_event_if_missing(event_enabler);
2137 break;
2138
2139 default:
2140 WARN_ON_ONCE(1);
2141 break;
2142 }
2143 }
2144
2145 static
2146 void lttng_event_enabler_init_event_filter(struct lttng_event_enabler_common *event_enabler,
2147 struct lttng_kernel_event_common *event)
2148 {
2149 /* Link filter bytecodes if not linked yet. */
2150 lttng_enabler_link_bytecode(event->priv->desc, lttng_static_ctx,
2151 &event->priv->filter_bytecode_runtime_head, &event_enabler->filter_bytecode_head);
2152 }
2153
2154 static
2155 void lttng_event_enabler_init_event_capture(struct lttng_event_enabler_common *event_enabler,
2156 struct lttng_kernel_event_common *event)
2157 {
2158 switch (event_enabler->enabler_type) {
2159 case LTTNG_EVENT_ENABLER_TYPE_RECORDER:
2160 break;
2161 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER:
2162 {
2163 struct lttng_event_notifier_enabler *event_notifier_enabler =
2164 container_of(event_enabler, struct lttng_event_notifier_enabler, parent);
2165 struct lttng_kernel_event_notifier *event_notifier =
2166 container_of(event, struct lttng_kernel_event_notifier, parent);
2167
2168 /* Link capture bytecodes if not linked yet. */
2169 lttng_enabler_link_bytecode(event->priv->desc,
2170 lttng_static_ctx, &event_notifier->priv->capture_bytecode_runtime_head,
2171 &event_notifier_enabler->capture_bytecode_head);
2172 event_notifier->priv->num_captures = event_notifier_enabler->num_captures;
2173 break;
2174 }
2175 default:
2176 WARN_ON_ONCE(1);
2177 }
2178 }
2179
2180 /*
2181 * Create events associated with an event_enabler (if not already present),
2182 * and add backward reference from the event to the enabler.
2183 * Should be called with sessions mutex held.
2184 */
2185 static
2186 int lttng_event_enabler_ref_events(struct lttng_event_enabler_common *event_enabler)
2187 {
2188 struct list_head *event_list_head = lttng_get_event_list_head_from_enabler(event_enabler);
2189 struct lttng_kernel_event_common_private *event_priv;
2190
2191 lttng_syscall_table_set_wildcard_all(event_enabler);
2192
2193 /* First ensure that probe events are created for this enabler. */
2194 lttng_create_event_if_missing(event_enabler);
2195
2196 /* Link the created event with its associated enabler. */
2197 list_for_each_entry(event_priv, event_list_head, node) {
2198 struct lttng_kernel_event_common *event = event_priv->pub;
2199 struct lttng_enabler_ref *enabler_ref;
2200
2201 if (!lttng_event_enabler_match_event(event_enabler, event))
2202 continue;
2203
2204 enabler_ref = lttng_enabler_ref(&event_priv->enablers_ref_head, event_enabler);
2205 if (!enabler_ref) {
2206 /*
2207 * If no backward ref, create it.
2208 * Add backward ref from event_notifier to enabler.
2209 */
2210 enabler_ref = kzalloc(sizeof(*enabler_ref), GFP_KERNEL);
2211 if (!enabler_ref)
2212 return -ENOMEM;
2213
2214 enabler_ref->ref = event_enabler;
2215 list_add(&enabler_ref->node, &event_priv->enablers_ref_head);
2216 }
2217
2218 lttng_event_enabler_init_event_filter(event_enabler, event);
2219 lttng_event_enabler_init_event_capture(event_enabler, event);
2220 }
2221 return 0;
2222 }
2223
2224 /*
2225 * Called at module load: connect the probe on all enablers matching
2226 * this event.
2227 * Called with sessions lock held.
2228 */
2229 int lttng_fix_pending_events(void)
2230 {
2231 struct lttng_kernel_session_private *session_priv;
2232
2233 list_for_each_entry(session_priv, &sessions, list)
2234 lttng_session_lazy_sync_event_enablers(session_priv->pub);
2235 return 0;
2236 }
2237
2238 static bool lttng_event_notifier_group_has_active_event_notifiers(
2239 struct lttng_event_notifier_group *event_notifier_group)
2240 {
2241 struct lttng_event_enabler_common *event_enabler;
2242
2243 list_for_each_entry(event_enabler, &event_notifier_group->enablers_head, node) {
2244 if (event_enabler->enabled)
2245 return true;
2246 }
2247 return false;
2248 }
2249
2250 bool lttng_event_notifier_active(void)
2251 {
2252 struct lttng_event_notifier_group *event_notifier_group;
2253
2254 list_for_each_entry(event_notifier_group, &event_notifier_groups, node) {
2255 if (lttng_event_notifier_group_has_active_event_notifiers(event_notifier_group))
2256 return true;
2257 }
2258 return false;
2259 }
2260
2261 int lttng_fix_pending_event_notifiers(void)
2262 {
2263 struct lttng_event_notifier_group *event_notifier_group;
2264
2265 list_for_each_entry(event_notifier_group, &event_notifier_groups, node)
2266 lttng_event_notifier_group_sync_enablers(event_notifier_group);
2267 return 0;
2268 }
2269
2270 struct lttng_event_recorder_enabler *lttng_event_recorder_enabler_create(
2271 enum lttng_enabler_format_type format_type,
2272 struct lttng_kernel_abi_event *event_param,
2273 struct lttng_kernel_channel_buffer *chan)
2274 {
2275 struct lttng_event_recorder_enabler *event_enabler;
2276
2277 event_enabler = kzalloc(sizeof(*event_enabler), GFP_KERNEL);
2278 if (!event_enabler)
2279 return NULL;
2280 event_enabler->parent.enabler_type = LTTNG_EVENT_ENABLER_TYPE_RECORDER;
2281 event_enabler->parent.format_type = format_type;
2282 INIT_LIST_HEAD(&event_enabler->parent.filter_bytecode_head);
2283 memcpy(&event_enabler->parent.event_param, event_param,
2284 sizeof(event_enabler->parent.event_param));
2285 event_enabler->chan = chan;
2286 /* ctx left NULL */
2287 event_enabler->parent.enabled = 0;
2288 return event_enabler;
2289 }
2290
2291 void lttng_event_enabler_session_add(struct lttng_kernel_session *session,
2292 struct lttng_event_recorder_enabler *event_enabler)
2293 {
2294 mutex_lock(&sessions_mutex);
2295 list_add(&event_enabler->parent.node, &session->priv->enablers_head);
2296 event_enabler->parent.published = true;
2297 lttng_session_lazy_sync_event_enablers(session);
2298 mutex_unlock(&sessions_mutex);
2299 }
2300
2301 int lttng_event_enabler_enable(struct lttng_event_enabler_common *event_enabler)
2302 {
2303 mutex_lock(&sessions_mutex);
2304 event_enabler->enabled = 1;
2305 lttng_event_enabler_sync(event_enabler);
2306 mutex_unlock(&sessions_mutex);
2307 return 0;
2308 }
2309
2310 int lttng_event_enabler_disable(struct lttng_event_enabler_common *event_enabler)
2311 {
2312 mutex_lock(&sessions_mutex);
2313 event_enabler->enabled = 0;
2314 lttng_event_enabler_sync(event_enabler);
2315 mutex_unlock(&sessions_mutex);
2316 return 0;
2317 }
2318
2319 static
2320 int lttng_enabler_attach_filter_bytecode(struct lttng_event_enabler_common *enabler,
2321 struct lttng_kernel_abi_filter_bytecode __user *bytecode)
2322 {
2323 struct lttng_kernel_bytecode_node *bytecode_node;
2324 uint32_t bytecode_len;
2325 int ret;
2326
2327 ret = get_user(bytecode_len, &bytecode->len);
2328 if (ret)
2329 return ret;
2330 bytecode_node = lttng_kvzalloc(sizeof(*bytecode_node) + bytecode_len,
2331 GFP_KERNEL);
2332 if (!bytecode_node)
2333 return -ENOMEM;
2334 ret = copy_from_user(&bytecode_node->bc, bytecode,
2335 sizeof(*bytecode) + bytecode_len);
2336 if (ret)
2337 goto error_free;
2338
2339 bytecode_node->type = LTTNG_KERNEL_BYTECODE_TYPE_FILTER;
2340 bytecode_node->enabler = enabler;
2341 /* Enforce length based on allocated size */
2342 bytecode_node->bc.len = bytecode_len;
2343 list_add_tail(&bytecode_node->node, &enabler->filter_bytecode_head);
2344
2345 return 0;
2346
2347 error_free:
2348 lttng_kvfree(bytecode_node);
2349 return ret;
2350 }
2351
2352 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler_common *event_enabler,
2353 struct lttng_kernel_abi_filter_bytecode __user *bytecode)
2354 {
2355 int ret;
2356 ret = lttng_enabler_attach_filter_bytecode(event_enabler, bytecode);
2357 if (ret)
2358 goto error;
2359 lttng_event_enabler_sync(event_enabler);
2360 return 0;
2361
2362 error:
2363 return ret;
2364 }
2365
2366 int lttng_event_add_callsite(struct lttng_kernel_event_common *event,
2367 struct lttng_kernel_abi_event_callsite __user *callsite)
2368 {
2369
2370 switch (event->priv->instrumentation) {
2371 case LTTNG_KERNEL_ABI_UPROBE:
2372 return lttng_uprobes_event_add_callsite(event, callsite);
2373 default:
2374 return -EINVAL;
2375 }
2376 }
2377
2378 static
2379 void lttng_enabler_destroy(struct lttng_event_enabler_common *enabler)
2380 {
2381 struct lttng_kernel_bytecode_node *filter_node, *tmp_filter_node;
2382
2383 /* Destroy filter bytecode */
2384 list_for_each_entry_safe(filter_node, tmp_filter_node,
2385 &enabler->filter_bytecode_head, node) {
2386 lttng_kvfree(filter_node);
2387 }
2388 }
2389
2390 void lttng_event_enabler_destroy(struct lttng_event_enabler_common *event_enabler)
2391 {
2392 lttng_enabler_destroy(event_enabler);
2393 if (event_enabler->published)
2394 list_del(&event_enabler->node);
2395
2396 switch (event_enabler->enabler_type) {
2397 case LTTNG_EVENT_ENABLER_TYPE_RECORDER:
2398 {
2399 struct lttng_event_recorder_enabler *event_recorder_enabler =
2400 container_of(event_enabler, struct lttng_event_recorder_enabler, parent);
2401
2402 kfree(event_recorder_enabler);
2403 break;
2404 }
2405 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER:
2406 {
2407 struct lttng_event_notifier_enabler *event_notifier_enabler =
2408 container_of(event_enabler, struct lttng_event_notifier_enabler, parent);
2409
2410 kfree(event_notifier_enabler);
2411 break;
2412 }
2413 default:
2414 WARN_ON_ONCE(1);
2415 }
2416 }
2417
2418 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
2419 enum lttng_enabler_format_type format_type,
2420 struct lttng_kernel_abi_event_notifier *event_notifier_param,
2421 struct lttng_event_notifier_group *event_notifier_group)
2422 {
2423 struct lttng_event_notifier_enabler *event_notifier_enabler;
2424
2425 event_notifier_enabler = kzalloc(sizeof(*event_notifier_enabler), GFP_KERNEL);
2426 if (!event_notifier_enabler)
2427 return NULL;
2428
2429 event_notifier_enabler->parent.enabler_type = LTTNG_EVENT_ENABLER_TYPE_NOTIFIER;
2430 event_notifier_enabler->parent.format_type = format_type;
2431 INIT_LIST_HEAD(&event_notifier_enabler->parent.filter_bytecode_head);
2432 INIT_LIST_HEAD(&event_notifier_enabler->capture_bytecode_head);
2433
2434 event_notifier_enabler->error_counter_index = event_notifier_param->error_counter_index;
2435 event_notifier_enabler->num_captures = 0;
2436
2437 memcpy(&event_notifier_enabler->parent.event_param, &event_notifier_param->event,
2438 sizeof(event_notifier_enabler->parent.event_param));
2439
2440 event_notifier_enabler->parent.enabled = 0;
2441 event_notifier_enabler->parent.user_token = event_notifier_param->event.token;
2442 event_notifier_enabler->group = event_notifier_group;
2443 return event_notifier_enabler;
2444 }
2445
2446 void lttng_event_notifier_enabler_group_add(struct lttng_event_notifier_group *event_notifier_group,
2447 struct lttng_event_notifier_enabler *event_notifier_enabler)
2448 {
2449 mutex_lock(&sessions_mutex);
2450 list_add(&event_notifier_enabler->parent.node, &event_notifier_enabler->group->enablers_head);
2451 event_notifier_enabler->parent.published = true;
2452 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
2453 mutex_unlock(&sessions_mutex);
2454 }
2455
2456 int lttng_event_notifier_enabler_enable(
2457 struct lttng_event_notifier_enabler *event_notifier_enabler)
2458 {
2459 mutex_lock(&sessions_mutex);
2460 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler)->enabled = 1;
2461 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
2462 mutex_unlock(&sessions_mutex);
2463 return 0;
2464 }
2465
2466 int lttng_event_notifier_enabler_disable(
2467 struct lttng_event_notifier_enabler *event_notifier_enabler)
2468 {
2469 mutex_lock(&sessions_mutex);
2470 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler)->enabled = 0;
2471 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
2472 mutex_unlock(&sessions_mutex);
2473 return 0;
2474 }
2475
2476 int lttng_event_notifier_enabler_attach_capture_bytecode(
2477 struct lttng_event_notifier_enabler *event_notifier_enabler,
2478 struct lttng_kernel_abi_capture_bytecode __user *bytecode)
2479 {
2480 struct lttng_kernel_bytecode_node *bytecode_node;
2481 struct lttng_event_enabler_common *enabler =
2482 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler);
2483 uint32_t bytecode_len;
2484 int ret;
2485
2486 ret = get_user(bytecode_len, &bytecode->len);
2487 if (ret)
2488 return ret;
2489
2490 bytecode_node = lttng_kvzalloc(sizeof(*bytecode_node) + bytecode_len,
2491 GFP_KERNEL);
2492 if (!bytecode_node)
2493 return -ENOMEM;
2494
2495 ret = copy_from_user(&bytecode_node->bc, bytecode,
2496 sizeof(*bytecode) + bytecode_len);
2497 if (ret)
2498 goto error_free;
2499
2500 bytecode_node->type = LTTNG_KERNEL_BYTECODE_TYPE_CAPTURE;
2501 bytecode_node->enabler = enabler;
2502
2503 /* Enforce length based on allocated size */
2504 bytecode_node->bc.len = bytecode_len;
2505 list_add_tail(&bytecode_node->node, &event_notifier_enabler->capture_bytecode_head);
2506
2507 event_notifier_enabler->num_captures++;
2508
2509 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
2510 goto end;
2511
2512 error_free:
2513 lttng_kvfree(bytecode_node);
2514 end:
2515 return ret;
2516 }
2517
2518 static
2519 void lttng_event_sync_filter_state(struct lttng_kernel_event_common *event)
2520 {
2521 int has_enablers_without_filter_bytecode = 0, nr_filters = 0;
2522 struct lttng_kernel_bytecode_runtime *runtime;
2523 struct lttng_enabler_ref *enabler_ref;
2524
2525 /* Check if has enablers without bytecode enabled */
2526 list_for_each_entry(enabler_ref, &event->priv->enablers_ref_head, node) {
2527 if (enabler_ref->ref->enabled
2528 && list_empty(&enabler_ref->ref->filter_bytecode_head)) {
2529 has_enablers_without_filter_bytecode = 1;
2530 break;
2531 }
2532 }
2533 event->priv->has_enablers_without_filter_bytecode = has_enablers_without_filter_bytecode;
2534
2535 /* Enable filters */
2536 list_for_each_entry(runtime, &event->priv->filter_bytecode_runtime_head, node) {
2537 lttng_bytecode_sync_state(runtime);
2538 nr_filters++;
2539 }
2540 WRITE_ONCE(event->eval_filter, !(has_enablers_without_filter_bytecode || !nr_filters));
2541 }
2542
2543 static
2544 void lttng_event_sync_capture_state(struct lttng_kernel_event_common *event)
2545 {
2546 switch (event->type) {
2547 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
2548 break;
2549 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
2550 {
2551 struct lttng_kernel_event_notifier *event_notifier =
2552 container_of(event, struct lttng_kernel_event_notifier, parent);
2553 struct lttng_kernel_bytecode_runtime *runtime;
2554 int nr_captures = 0;
2555
2556 /* Enable captures */
2557 list_for_each_entry(runtime, &event_notifier->priv->capture_bytecode_runtime_head, node) {
2558 lttng_bytecode_sync_state(runtime);
2559 nr_captures++;
2560 }
2561 WRITE_ONCE(event_notifier->eval_capture, !!nr_captures);
2562 break;
2563 }
2564 default:
2565 WARN_ON_ONCE(1);
2566 }
2567 }
2568
2569 static
2570 bool lttng_get_event_enabled_state(struct lttng_kernel_event_common *event)
2571 {
2572 struct lttng_enabler_ref *enabler_ref;
2573 bool enabled = false;
2574
2575 switch (event->priv->instrumentation) {
2576 case LTTNG_KERNEL_ABI_TRACEPOINT:
2577 lttng_fallthrough;
2578 case LTTNG_KERNEL_ABI_SYSCALL:
2579 /* Enable events */
2580 list_for_each_entry(enabler_ref, &event->priv->enablers_ref_head, node) {
2581 if (enabler_ref->ref->enabled) {
2582 enabled = true;
2583 break;
2584 }
2585 }
2586 break;
2587 default:
2588 WARN_ON_ONCE(1);
2589 return false;
2590 }
2591
2592 switch (event->type) {
2593 case LTTNG_KERNEL_EVENT_TYPE_RECORDER:
2594 {
2595 struct lttng_kernel_event_recorder *event_recorder =
2596 container_of(event, struct lttng_kernel_event_recorder, parent);
2597
2598 /*
2599 * Enabled state is based on union of enablers, with
2600 * intersection of session and channel transient enable
2601 * states.
2602 */
2603 return enabled && event_recorder->chan->parent.session->priv->tstate && event_recorder->chan->priv->parent.tstate;
2604 }
2605 case LTTNG_KERNEL_EVENT_TYPE_NOTIFIER:
2606 return enabled;
2607 default:
2608 WARN_ON_ONCE(1);
2609 return false;
2610 }
2611 }
2612
2613 static
2614 bool lttng_event_is_lazy_sync(struct lttng_kernel_event_common *event)
2615 {
2616 switch (event->priv->instrumentation) {
2617 case LTTNG_KERNEL_ABI_TRACEPOINT:
2618 lttng_fallthrough;
2619 case LTTNG_KERNEL_ABI_SYSCALL:
2620 return true;
2621
2622 default:
2623 /* Not handled with lazy sync. */
2624 return false;
2625 }
2626 }
2627
2628 /*
2629 * Should be called with sessions mutex held.
2630 */
2631 static
2632 void lttng_sync_event_list(struct list_head *event_enabler_list,
2633 struct list_head *event_list)
2634 {
2635 struct lttng_kernel_event_common_private *event_priv;
2636 struct lttng_event_enabler_common *event_enabler;
2637
2638 list_for_each_entry(event_enabler, event_enabler_list, node)
2639 lttng_event_enabler_ref_events(event_enabler);
2640
2641 /*
2642 * For each event, if at least one of its enablers is enabled,
2643 * and its channel and session transient states are enabled, we
2644 * enable the event, else we disable it.
2645 */
2646 list_for_each_entry(event_priv, event_list, node) {
2647 struct lttng_kernel_event_common *event = event_priv->pub;
2648 bool enabled;
2649
2650 if (!lttng_event_is_lazy_sync(event))
2651 continue;
2652
2653 enabled = lttng_get_event_enabled_state(event);
2654 WRITE_ONCE(event->enabled, enabled);
2655 /*
2656 * Sync tracepoint registration with event enabled state.
2657 */
2658 if (enabled) {
2659 register_event(event);
2660 } else {
2661 _lttng_event_unregister(event);
2662 }
2663
2664 lttng_event_sync_filter_state(event);
2665 lttng_event_sync_capture_state(event);
2666 }
2667 }
2668
2669 /*
2670 * lttng_session_sync_event_enablers should be called just before starting a
2671 * session.
2672 */
2673 static
2674 void lttng_session_sync_event_enablers(struct lttng_kernel_session *session)
2675 {
2676 lttng_sync_event_list(&session->priv->enablers_head, &session->priv->events);
2677 }
2678
2679 /*
2680 * Apply enablers to session events, adding events to session if need
2681 * be. It is required after each modification applied to an active
2682 * session, and right before session "start".
2683 * "lazy" sync means we only sync if required.
2684 * Should be called with sessions mutex held.
2685 */
2686 static
2687 void lttng_session_lazy_sync_event_enablers(struct lttng_kernel_session *session)
2688 {
2689 /* We can skip if session is not active */
2690 if (!session->active)
2691 return;
2692 lttng_session_sync_event_enablers(session);
2693 }
2694
2695 static
2696 void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group *event_notifier_group)
2697 {
2698 lttng_sync_event_list(&event_notifier_group->enablers_head, &event_notifier_group->event_notifiers_head);
2699 }
2700
2701 static
2702 void lttng_event_enabler_sync(struct lttng_event_enabler_common *event_enabler)
2703 {
2704 switch (event_enabler->enabler_type) {
2705 case LTTNG_EVENT_ENABLER_TYPE_RECORDER:
2706 {
2707 struct lttng_event_recorder_enabler *event_recorder_enabler =
2708 container_of(event_enabler, struct lttng_event_recorder_enabler, parent);
2709 lttng_session_lazy_sync_event_enablers(event_recorder_enabler->chan->parent.session);
2710 break;
2711 }
2712 case LTTNG_EVENT_ENABLER_TYPE_NOTIFIER:
2713 {
2714 struct lttng_event_notifier_enabler *event_notifier_enabler =
2715 container_of(event_enabler, struct lttng_event_notifier_enabler, parent);
2716 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
2717 break;
2718 }
2719 default:
2720 WARN_ON_ONCE(1);
2721 }
2722 }
2723
2724 /*
2725 * Serialize at most one packet worth of metadata into a metadata
2726 * channel.
2727 * We grab the metadata cache mutex to get exclusive access to our metadata
2728 * buffer and to the metadata cache. Exclusive access to the metadata buffer
2729 * allows us to do racy operations such as looking for remaining space left in
2730 * packet and write, since mutual exclusion protects us from concurrent writes.
2731 * Mutual exclusion on the metadata cache allow us to read the cache content
2732 * without racing against reallocation of the cache by updates.
2733 * Returns the number of bytes written in the channel, 0 if no data
2734 * was written and a negative value on error.
2735 */
2736 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
2737 struct lttng_kernel_ring_buffer_channel *chan, bool *coherent)
2738 {
2739 struct lttng_kernel_ring_buffer_ctx ctx;
2740 int ret = 0;
2741 size_t len, reserve_len;
2742
2743 /*
2744 * Ensure we support mutiple get_next / put sequences followed by
2745 * put_next. The metadata cache lock protects reading the metadata
2746 * cache. It can indeed be read concurrently by "get_next_subbuf" and
2747 * "flush" operations on the buffer invoked by different processes.
2748 * Moreover, since the metadata cache memory can be reallocated, we
2749 * need to have exclusive access against updates even though we only
2750 * read it.
2751 */
2752 mutex_lock(&stream->metadata_cache->lock);
2753 WARN_ON(stream->metadata_in < stream->metadata_out);
2754 if (stream->metadata_in != stream->metadata_out)
2755 goto end;
2756
2757 /* Metadata regenerated, change the version. */
2758 if (stream->metadata_cache->version != stream->version)
2759 stream->version = stream->metadata_cache->version;
2760
2761 len = stream->metadata_cache->metadata_written -
2762 stream->metadata_in;
2763 if (!len)
2764 goto end;
2765 reserve_len = min_t(size_t,
2766 stream->transport->ops.priv->packet_avail_size(chan),
2767 len);
2768 lib_ring_buffer_ctx_init(&ctx, chan, reserve_len,
2769 sizeof(char), NULL);
2770 /*
2771 * If reservation failed, return an error to the caller.
2772 */
2773 ret = stream->transport->ops.event_reserve(&ctx);
2774 if (ret != 0) {
2775 printk(KERN_WARNING "LTTng: Metadata event reservation failed\n");
2776 stream->coherent = false;
2777 goto end;
2778 }
2779 stream->transport->ops.event_write(&ctx,
2780 stream->metadata_cache->data + stream->metadata_in,
2781 reserve_len, 1);
2782 stream->transport->ops.event_commit(&ctx);
2783 stream->metadata_in += reserve_len;
2784 if (reserve_len < len)
2785 stream->coherent = false;
2786 else
2787 stream->coherent = true;
2788 ret = reserve_len;
2789
2790 end:
2791 if (coherent)
2792 *coherent = stream->coherent;
2793 mutex_unlock(&stream->metadata_cache->lock);
2794 return ret;
2795 }
2796
2797 static
2798 void lttng_metadata_begin(struct lttng_kernel_session *session)
2799 {
2800 if (atomic_inc_return(&session->priv->metadata_cache->producing) == 1)
2801 mutex_lock(&session->priv->metadata_cache->lock);
2802 }
2803
2804 static
2805 void lttng_metadata_end(struct lttng_kernel_session *session)
2806 {
2807 WARN_ON_ONCE(!atomic_read(&session->priv->metadata_cache->producing));
2808 if (atomic_dec_return(&session->priv->metadata_cache->producing) == 0) {
2809 struct lttng_metadata_stream *stream;
2810
2811 list_for_each_entry(stream, &session->priv->metadata_cache->metadata_stream, list)
2812 wake_up_interruptible(&stream->read_wait);
2813 mutex_unlock(&session->priv->metadata_cache->lock);
2814 }
2815 }
2816
2817 /*
2818 * Write the metadata to the metadata cache.
2819 * Must be called with sessions_mutex held.
2820 * The metadata cache lock protects us from concurrent read access from
2821 * thread outputting metadata content to ring buffer.
2822 * The content of the printf is printed as a single atomic metadata
2823 * transaction.
2824 */
2825 int lttng_metadata_printf(struct lttng_kernel_session *session,
2826 const char *fmt, ...)
2827 {
2828 char *str;
2829 size_t len;
2830 va_list ap;
2831
2832 WARN_ON_ONCE(!LTTNG_READ_ONCE(session->active));
2833
2834 va_start(ap, fmt);
2835 str = kvasprintf(GFP_KERNEL, fmt, ap);
2836 va_end(ap);
2837 if (!str)
2838 return -ENOMEM;
2839
2840 len = strlen(str);
2841 WARN_ON_ONCE(!atomic_read(&session->priv->metadata_cache->producing));
2842 if (session->priv->metadata_cache->metadata_written + len >
2843 session->priv->metadata_cache->cache_alloc) {
2844 char *tmp_cache_realloc;
2845 unsigned int tmp_cache_alloc_size;
2846
2847 tmp_cache_alloc_size = max_t(unsigned int,
2848 session->priv->metadata_cache->cache_alloc + len,
2849 session->priv->metadata_cache->cache_alloc << 1);
2850 tmp_cache_realloc = vzalloc(tmp_cache_alloc_size);
2851 if (!tmp_cache_realloc)
2852 goto err;
2853 if (session->priv->metadata_cache->data) {
2854 memcpy(tmp_cache_realloc,
2855 session->priv->metadata_cache->data,
2856 session->priv->metadata_cache->cache_alloc);
2857 vfree(session->priv->metadata_cache->data);
2858 }
2859
2860 session->priv->metadata_cache->cache_alloc = tmp_cache_alloc_size;
2861 session->priv->metadata_cache->data = tmp_cache_realloc;
2862 }
2863 memcpy(session->priv->metadata_cache->data +
2864 session->priv->metadata_cache->metadata_written,
2865 str, len);
2866 session->priv->metadata_cache->metadata_written += len;
2867 kfree(str);
2868
2869 return 0;
2870
2871 err:
2872 kfree(str);
2873 return -ENOMEM;
2874 }
2875
2876 static
2877 int print_tabs(struct lttng_kernel_session *session, size_t nesting)
2878 {
2879 size_t i;
2880
2881 for (i = 0; i < nesting; i++) {
2882 int ret;
2883
2884 ret = lttng_metadata_printf(session, " ");
2885 if (ret) {
2886 return ret;
2887 }
2888 }
2889 return 0;
2890 }
2891
2892 static
2893 int lttng_field_name_statedump(struct lttng_kernel_session *session,
2894 const struct lttng_kernel_event_field *field,
2895 size_t nesting)
2896 {
2897 return lttng_metadata_printf(session, " _%s;\n", field->name);
2898 }
2899
2900 static
2901 int _lttng_integer_type_statedump(struct lttng_kernel_session *session,
2902 const struct lttng_kernel_type_integer *type,
2903 enum lttng_kernel_string_encoding parent_encoding,
2904 size_t nesting)
2905 {
2906 int ret;
2907
2908 ret = print_tabs(session, nesting);
2909 if (ret)
2910 return ret;
2911 ret = lttng_metadata_printf(session,
2912 "integer { size = %u; align = %u; signed = %u; encoding = %s; base = %u;%s }",
2913 type->size,
2914 type->alignment,
2915 type->signedness,
2916 (parent_encoding == lttng_kernel_string_encoding_none)
2917 ? "none"
2918 : (parent_encoding == lttng_kernel_string_encoding_UTF8)
2919 ? "UTF8"
2920 : "ASCII",
2921 type->base,
2922 #if __BYTE_ORDER == __BIG_ENDIAN
2923 type->reverse_byte_order ? " byte_order = le;" : ""
2924 #else
2925 type->reverse_byte_order ? " byte_order = be;" : ""
2926 #endif
2927 );
2928 return ret;
2929 }
2930
2931 /*
2932 * Must be called with sessions_mutex held.
2933 */
2934 static
2935 int _lttng_struct_type_statedump(struct lttng_kernel_session *session,
2936 const struct lttng_kernel_type_struct *type,
2937 size_t nesting)
2938 {
2939 const char *prev_field_name = NULL;
2940 int ret;
2941 uint32_t i, nr_fields;
2942 unsigned int alignment;
2943
2944 ret = print_tabs(session, nesting);
2945 if (ret)
2946 return ret;
2947 ret = lttng_metadata_printf(session,
2948 "struct {\n");
2949 if (ret)
2950 return ret;
2951 nr_fields = type->nr_fields;
2952 for (i = 0; i < nr_fields; i++) {
2953 const struct lttng_kernel_event_field *iter_field;
2954
2955 iter_field = type->fields[i];
2956 ret = _lttng_field_statedump(session, iter_field, nesting + 1, &prev_field_name);
2957 if (ret)
2958 return ret;
2959 }
2960 ret = print_tabs(session, nesting);
2961 if (ret)
2962 return ret;
2963 alignment = type->alignment;
2964 if (alignment) {
2965 ret = lttng_metadata_printf(session,
2966 "} align(%u)",
2967 alignment);
2968 } else {
2969 ret = lttng_metadata_printf(session,
2970 "}");
2971 }
2972 return ret;
2973 }
2974
2975 /*
2976 * Must be called with sessions_mutex held.
2977 */
2978 static
2979 int _lttng_struct_field_statedump(struct lttng_kernel_session *session,
2980 const struct lttng_kernel_event_field *field,
2981 size_t nesting)
2982 {
2983 int ret;
2984
2985 ret = _lttng_struct_type_statedump(session,
2986 lttng_kernel_get_type_struct(field->type), nesting);
2987 if (ret)
2988 return ret;
2989 return lttng_field_name_statedump(session, field, nesting);
2990 }
2991
2992 /*
2993 * Must be called with sessions_mutex held.
2994 */
2995 static
2996 int _lttng_variant_type_statedump(struct lttng_kernel_session *session,
2997 const struct lttng_kernel_type_variant *type,
2998 size_t nesting,
2999 const char *prev_field_name)
3000 {
3001 const char *tag_name;
3002 int ret;
3003 uint32_t i, nr_choices;
3004
3005 tag_name = type->tag_name;
3006 if (!tag_name)
3007 tag_name = prev_field_name;
3008 if (!tag_name)
3009 return -EINVAL;
3010 /*
3011 * CTF 1.8 does not allow expressing nonzero variant alignment in a nestable way.
3012 */
3013 if (type->alignment != 0)
3014 return -EINVAL;
3015 ret = print_tabs(session, nesting);
3016 if (ret)
3017 return ret;
3018 ret = lttng_metadata_printf(session,
3019 "variant <_%s> {\n",
3020 tag_name);
3021 if (ret)
3022 return ret;
3023 nr_choices = type->nr_choices;
3024 for (i = 0; i < nr_choices; i++) {
3025 const struct lttng_kernel_event_field *iter_field;
3026
3027 iter_field = type->choices[i];
3028 ret = _lttng_field_statedump(session, iter_field, nesting + 1, NULL);
3029 if (ret)
3030 return ret;
3031 }
3032 ret = print_tabs(session, nesting);
3033 if (ret)
3034 return ret;
3035 ret = lttng_metadata_printf(session,
3036 "}");
3037 return ret;
3038 }
3039
3040 /*
3041 * Must be called with sessions_mutex held.
3042 */
3043 static
3044 int _lttng_variant_field_statedump(struct lttng_kernel_session *session,
3045 const struct lttng_kernel_event_field *field,
3046 size_t nesting,
3047 const char *prev_field_name)
3048 {
3049 int ret;
3050
3051 ret = _lttng_variant_type_statedump(session,
3052 lttng_kernel_get_type_variant(field->type), nesting,
3053 prev_field_name);
3054 if (ret)
3055 return ret;
3056 return lttng_field_name_statedump(session, field, nesting);
3057 }
3058
3059 /*
3060 * Must be called with sessions_mutex held.
3061 */
3062 static
3063 int _lttng_array_field_statedump(struct lttng_kernel_session *session,
3064 const struct lttng_kernel_event_field *field,
3065 size_t nesting)
3066 {
3067 int ret;
3068 const struct lttng_kernel_type_array *array_type;
3069 const struct lttng_kernel_type_common *elem_type;
3070
3071 array_type = lttng_kernel_get_type_array(field->type);
3072 WARN_ON_ONCE(!array_type);
3073
3074 if (array_type->alignment) {
3075 ret = print_tabs(session, nesting);
3076 if (ret)
3077 return ret;
3078 ret = lttng_metadata_printf(session,
3079 "struct { } align(%u) _%s_padding;\n",
3080 array_type->alignment * CHAR_BIT,
3081 field->name);
3082 if (ret)
3083 return ret;
3084 }
3085 /*
3086 * Nested compound types: Only array of structures and variants are
3087 * currently supported.
3088 */
3089 elem_type = array_type->elem_type;
3090 switch (elem_type->type) {
3091 case lttng_kernel_type_integer:
3092 case lttng_kernel_type_struct:
3093 case lttng_kernel_type_variant:
3094 ret = _lttng_type_statedump(session, elem_type,
3095 array_type->encoding, nesting);
3096 if (ret)
3097 return ret;
3098 break;
3099
3100 default:
3101 return -EINVAL;
3102 }
3103 ret = lttng_metadata_printf(session,
3104 " _%s[%u];\n",
3105 field->name,
3106 array_type->length);
3107 return ret;
3108 }
3109
3110 /*
3111 * Must be called with sessions_mutex held.
3112 */
3113 static
3114 int _lttng_sequence_field_statedump(struct lttng_kernel_session *session,
3115 const struct lttng_kernel_event_field *field,
3116 size_t nesting,
3117 const char *prev_field_name)
3118 {
3119 int ret;
3120 const char *length_name;
3121 const struct lttng_kernel_type_sequence *sequence_type;
3122 const struct lttng_kernel_type_common *elem_type;
3123
3124 sequence_type = lttng_kernel_get_type_sequence(field->type);
3125 WARN_ON_ONCE(!sequence_type);
3126
3127 length_name = sequence_type->length_name;
3128 if (!length_name)
3129 length_name = prev_field_name;
3130 if (!length_name)
3131 return -EINVAL;
3132
3133 if (sequence_type->alignment) {
3134 ret = print_tabs(session, nesting);
3135 if (ret)
3136 return ret;
3137 ret = lttng_metadata_printf(session,
3138 "struct { } align(%u) _%s_padding;\n",
3139 sequence_type->alignment * CHAR_BIT,
3140 field->name);
3141 if (ret)
3142 return ret;
3143 }
3144
3145 /*
3146 * Nested compound types: Only array of structures and variants are
3147 * currently supported.
3148 */
3149 elem_type = sequence_type->elem_type;
3150 switch (elem_type->type) {
3151 case lttng_kernel_type_integer:
3152 case lttng_kernel_type_struct:
3153 case lttng_kernel_type_variant:
3154 ret = _lttng_type_statedump(session, elem_type,
3155 sequence_type->encoding, nesting);
3156 if (ret)
3157 return ret;
3158 break;
3159
3160 default:
3161 return -EINVAL;
3162 }
3163 ret = lttng_metadata_printf(session,
3164 " _%s[ _%s ];\n",
3165 field->name,
3166 length_name);
3167 return ret;
3168 }
3169
3170 /*
3171 * Must be called with sessions_mutex held.
3172 */
3173 static
3174 int _lttng_enum_type_statedump(struct lttng_kernel_session *session,
3175 const struct lttng_kernel_type_enum *type,
3176 size_t nesting)
3177 {
3178 const struct lttng_kernel_enum_desc *enum_desc;
3179 const struct lttng_kernel_type_common *container_type;
3180 int ret;
3181 unsigned int i, nr_entries;
3182
3183 container_type = type->container_type;
3184 if (container_type->type != lttng_kernel_type_integer) {
3185 ret = -EINVAL;
3186 goto end;
3187 }
3188 enum_desc = type->desc;
3189 nr_entries = enum_desc->nr_entries;
3190
3191 ret = print_tabs(session, nesting);
3192 if (ret)
3193 goto end;
3194 ret = lttng_metadata_printf(session, "enum : ");
3195 if (ret)
3196 goto end;
3197 ret = _lttng_integer_type_statedump(session, lttng_kernel_get_type_integer(container_type),
3198 lttng_kernel_string_encoding_none, 0);
3199 if (ret)
3200 goto end;
3201 ret = lttng_metadata_printf(session, " {\n");
3202 if (ret)
3203 goto end;
3204 /* Dump all entries */
3205 for (i = 0; i < nr_entries; i++) {
3206 const struct lttng_kernel_enum_entry *entry = enum_desc->entries[i];
3207 int j, len;
3208
3209 ret = print_tabs(session, nesting + 1);
3210 if (ret)
3211 goto end;
3212 ret = lttng_metadata_printf(session,
3213 "\"");
3214 if (ret)
3215 goto end;
3216 len = strlen(entry->string);
3217 /* Escape the character '"' */
3218 for (j = 0; j < len; j++) {
3219 char c = entry->string[j];
3220
3221 switch (c) {
3222 case '"':
3223 ret = lttng_metadata_printf(session,
3224 "\\\"");
3225 break;
3226 case '\\':
3227 ret = lttng_metadata_printf(session,
3228 "\\\\");
3229 break;
3230 default:
3231 ret = lttng_metadata_printf(session,
3232 "%c", c);
3233 break;
3234 }
3235 if (ret)
3236 goto end;
3237 }
3238 ret = lttng_metadata_printf(session, "\"");
3239 if (ret)
3240 goto end;
3241
3242 if (entry->options.is_auto) {
3243 ret = lttng_metadata_printf(session, ",\n");
3244 if (ret)
3245 goto end;
3246 } else {
3247 ret = lttng_metadata_printf(session,
3248 " = ");
3249 if (ret)
3250 goto end;
3251 if (entry->start.signedness)
3252 ret = lttng_metadata_printf(session,
3253 "%lld", (long long) entry->start.value);
3254 else
3255 ret = lttng_metadata_printf(session,
3256 "%llu", entry->start.value);
3257 if (ret)
3258 goto end;
3259 if (entry->start.signedness == entry->end.signedness &&
3260 entry->start.value
3261 == entry->end.value) {
3262 ret = lttng_metadata_printf(session,
3263 ",\n");
3264 } else {
3265 if (entry->end.signedness) {
3266 ret = lttng_metadata_printf(session,
3267 " ... %lld,\n",
3268 (long long) entry->end.value);
3269 } else {
3270 ret = lttng_metadata_printf(session,
3271 " ... %llu,\n",
3272 entry->end.value);
3273 }
3274 }
3275 if (ret)
3276 goto end;
3277 }
3278 }
3279 ret = print_tabs(session, nesting);
3280 if (ret)
3281 goto end;
3282 ret = lttng_metadata_printf(session, "}");
3283 end:
3284 return ret;
3285 }
3286
3287 /*
3288 * Must be called with sessions_mutex held.
3289 */
3290 static
3291 int _lttng_enum_field_statedump(struct lttng_kernel_session *session,
3292 const struct lttng_kernel_event_field *field,
3293 size_t nesting)
3294 {
3295 int ret;
3296 const struct lttng_kernel_type_enum *enum_type;
3297
3298 enum_type = lttng_kernel_get_type_enum(field->type);
3299 WARN_ON_ONCE(!enum_type);
3300 ret = _lttng_enum_type_statedump(session, enum_type, nesting);
3301 if (ret)
3302 return ret;
3303 return lttng_field_name_statedump(session, field, nesting);
3304 }
3305
3306 static
3307 int _lttng_integer_field_statedump(struct lttng_kernel_session *session,
3308 const struct lttng_kernel_event_field *field,
3309 size_t nesting)
3310 {
3311 int ret;
3312
3313 ret = _lttng_integer_type_statedump(session, lttng_kernel_get_type_integer(field->type),
3314 lttng_kernel_string_encoding_none, nesting);
3315 if (ret)
3316 return ret;
3317 return lttng_field_name_statedump(session, field, nesting);
3318 }
3319
3320 static
3321 int _lttng_string_type_statedump(struct lttng_kernel_session *session,
3322 const struct lttng_kernel_type_string *type,
3323 size_t nesting)
3324 {
3325 int ret;
3326
3327 /* Default encoding is UTF8 */
3328 ret = print_tabs(session, nesting);
3329 if (ret)
3330 return ret;
3331 ret = lttng_metadata_printf(session,
3332 "string%s",
3333 type->encoding == lttng_kernel_string_encoding_ASCII ?
3334 " { encoding = ASCII; }" : "");
3335 return ret;
3336 }
3337
3338 static
3339 int _lttng_string_field_statedump(struct lttng_kernel_session *session,
3340 const struct lttng_kernel_event_field *field,
3341 size_t nesting)
3342 {
3343 const struct lttng_kernel_type_string *string_type;
3344 int ret;
3345
3346 string_type = lttng_kernel_get_type_string(field->type);
3347 WARN_ON_ONCE(!string_type);
3348 ret = _lttng_string_type_statedump(session, string_type, nesting);
3349 if (ret)
3350 return ret;
3351 return lttng_field_name_statedump(session, field, nesting);
3352 }
3353
3354 /*
3355 * Must be called with sessions_mutex held.
3356 */
3357 static
3358 int _lttng_type_statedump(struct lttng_kernel_session *session,
3359 const struct lttng_kernel_type_common *type,
3360 enum lttng_kernel_string_encoding parent_encoding,
3361 size_t nesting)
3362 {
3363 int ret = 0;
3364
3365 switch (type->type) {
3366 case lttng_kernel_type_integer:
3367 ret = _lttng_integer_type_statedump(session,
3368 lttng_kernel_get_type_integer(type),
3369 parent_encoding, nesting);
3370 break;
3371 case lttng_kernel_type_enum:
3372 ret = _lttng_enum_type_statedump(session,
3373 lttng_kernel_get_type_enum(type),
3374 nesting);
3375 break;
3376 case lttng_kernel_type_string:
3377 ret = _lttng_string_type_statedump(session,
3378 lttng_kernel_get_type_string(type),
3379 nesting);
3380 break;
3381 case lttng_kernel_type_struct:
3382 ret = _lttng_struct_type_statedump(session,
3383 lttng_kernel_get_type_struct(type),
3384 nesting);
3385 break;
3386 case lttng_kernel_type_variant:
3387 ret = _lttng_variant_type_statedump(session,
3388 lttng_kernel_get_type_variant(type),
3389 nesting, NULL);
3390 break;
3391
3392 /* Nested arrays and sequences are not supported yet. */
3393 case lttng_kernel_type_array:
3394 case lttng_kernel_type_sequence:
3395 default:
3396 WARN_ON_ONCE(1);
3397 return -EINVAL;
3398 }
3399 return ret;
3400 }
3401
3402 /*
3403 * Must be called with sessions_mutex held.
3404 */
3405 static
3406 int _lttng_field_statedump(struct lttng_kernel_session *session,
3407 const struct lttng_kernel_event_field *field,
3408 size_t nesting,
3409 const char **prev_field_name_p)
3410 {
3411 const char *prev_field_name = NULL;
3412 int ret = 0;
3413
3414 if (prev_field_name_p)
3415 prev_field_name = *prev_field_name_p;
3416 switch (field->type->type) {
3417 case lttng_kernel_type_integer:
3418 ret = _lttng_integer_field_statedump(session, field, nesting);
3419 break;
3420 case lttng_kernel_type_enum:
3421 ret = _lttng_enum_field_statedump(session, field, nesting);
3422 break;
3423 case lttng_kernel_type_string:
3424 ret = _lttng_string_field_statedump(session, field, nesting);
3425 break;
3426 case lttng_kernel_type_struct:
3427 ret = _lttng_struct_field_statedump(session, field, nesting);
3428 break;
3429 case lttng_kernel_type_array:
3430 ret = _lttng_array_field_statedump(session, field, nesting);
3431 break;
3432 case lttng_kernel_type_sequence:
3433 ret = _lttng_sequence_field_statedump(session, field, nesting, prev_field_name);
3434 break;
3435 case lttng_kernel_type_variant:
3436 ret = _lttng_variant_field_statedump(session, field, nesting, prev_field_name);
3437 break;
3438
3439 default:
3440 WARN_ON_ONCE(1);
3441 return -EINVAL;
3442 }
3443 if (prev_field_name_p)
3444 *prev_field_name_p = field->name;
3445 return ret;
3446 }
3447
3448 static
3449 int _lttng_context_metadata_statedump(struct lttng_kernel_session *session,
3450 struct lttng_kernel_ctx *ctx)
3451 {
3452 const char *prev_field_name = NULL;
3453 int ret = 0;
3454 int i;
3455
3456 if (!ctx)
3457 return 0;
3458 for (i = 0; i < ctx->nr_fields; i++) {
3459 const struct lttng_kernel_ctx_field *field = &ctx->fields[i];
3460
3461 ret = _lttng_field_statedump(session, field->event_field, 2, &prev_field_name);
3462 if (ret)
3463 return ret;
3464 }
3465 return ret;
3466 }
3467
3468 static
3469 int _lttng_fields_metadata_statedump(struct lttng_kernel_session *session,
3470 struct lttng_kernel_event_recorder *event_recorder)
3471 {
3472 const char *prev_field_name = NULL;
3473 const struct lttng_kernel_event_desc *desc = event_recorder->priv->parent.desc;
3474 int ret = 0;
3475 int i;
3476
3477 for (i = 0; i < desc->tp_class->nr_fields; i++) {
3478 const struct lttng_kernel_event_field *field = desc->tp_class->fields[i];
3479
3480 ret = _lttng_field_statedump(session, field, 2, &prev_field_name);
3481 if (ret)
3482 return ret;
3483 }
3484 return ret;
3485 }
3486
3487 /*
3488 * Must be called with sessions_mutex held.
3489 * The entire event metadata is printed as a single atomic metadata
3490 * transaction.
3491 */
3492 static
3493 int _lttng_event_recorder_metadata_statedump(struct lttng_kernel_event_common *event)
3494 {
3495 struct lttng_kernel_event_recorder *event_recorder;
3496 struct lttng_kernel_channel_buffer *chan;
3497 struct lttng_kernel_session *session;
3498 int ret = 0;
3499
3500 if (event->type != LTTNG_KERNEL_EVENT_TYPE_RECORDER)
3501 return 0;
3502 event_recorder = container_of(event, struct lttng_kernel_event_recorder, parent);
3503 chan = event_recorder->chan;
3504 session = chan->parent.session;
3505
3506 if (event_recorder->priv->metadata_dumped || !LTTNG_READ_ONCE(session->active))
3507 return 0;
3508 if (chan->priv->channel_type == METADATA_CHANNEL)
3509 return 0;
3510
3511 lttng_metadata_begin(session);
3512
3513 ret = lttng_metadata_printf(session,
3514 "event {\n"
3515 " name = \"%s\";\n"
3516 " id = %u;\n"
3517 " stream_id = %u;\n",
3518 event_recorder->priv->parent.desc->event_name,
3519 event_recorder->priv->id,
3520 event_recorder->chan->priv->id);
3521 if (ret)
3522 goto end;
3523
3524 ret = lttng_metadata_printf(session,
3525 " fields := struct {\n"
3526 );
3527 if (ret)
3528 goto end;
3529
3530 ret = _lttng_fields_metadata_statedump(session, event_recorder);
3531 if (ret)
3532 goto end;
3533
3534 /*
3535 * LTTng space reservation can only reserve multiples of the
3536 * byte size.
3537 */
3538 ret = lttng_metadata_printf(session,
3539 " };\n"
3540 "};\n\n");
3541 if (ret)
3542 goto end;
3543
3544 event_recorder->priv->metadata_dumped = 1;
3545 end:
3546 lttng_metadata_end(session);
3547 return ret;
3548
3549 }
3550
3551 /*
3552 * Must be called with sessions_mutex held.
3553 * The entire channel metadata is printed as a single atomic metadata
3554 * transaction.
3555 */
3556 static
3557 int _lttng_channel_metadata_statedump(struct lttng_kernel_session *session,
3558 struct lttng_kernel_channel_buffer *chan)
3559 {
3560 int ret = 0;
3561
3562 if (chan->priv->metadata_dumped || !LTTNG_READ_ONCE(session->active))
3563 return 0;
3564
3565 if (chan->priv->channel_type == METADATA_CHANNEL)
3566 return 0;
3567
3568 lttng_metadata_begin(session);
3569
3570 WARN_ON_ONCE(!chan->priv->header_type);
3571 ret = lttng_metadata_printf(session,
3572 "stream {\n"
3573 " id = %u;\n"
3574 " event.header := %s;\n"
3575 " packet.context := struct packet_context;\n",
3576 chan->priv->id,
3577 chan->priv->header_type == 1 ? "struct event_header_compact" :
3578 "struct event_header_large");
3579 if (ret)
3580 goto end;
3581
3582 if (chan->priv->ctx) {
3583 ret = lttng_metadata_printf(session,
3584 " event.context := struct {\n");
3585 if (ret)
3586 goto end;
3587 }
3588 ret = _lttng_context_metadata_statedump(session, chan->priv->ctx);
3589 if (ret)
3590 goto end;
3591 if (chan->priv->ctx) {
3592 ret = lttng_metadata_printf(session,
3593 " };\n");
3594 if (ret)
3595 goto end;
3596 }
3597
3598 ret = lttng_metadata_printf(session,
3599 "};\n\n");
3600
3601 chan->priv->metadata_dumped = 1;
3602 end:
3603 lttng_metadata_end(session);
3604 return ret;
3605 }
3606
3607 /*
3608 * Must be called with sessions_mutex held.
3609 */
3610 static
3611 int _lttng_stream_packet_context_declare(struct lttng_kernel_session *session)
3612 {
3613 return lttng_metadata_printf(session,
3614 "struct packet_context {\n"
3615 " uint64_clock_monotonic_t timestamp_begin;\n"
3616 " uint64_clock_monotonic_t timestamp_end;\n"
3617 " uint64_t content_size;\n"
3618 " uint64_t packet_size;\n"
3619 " uint64_t packet_seq_num;\n"
3620 " unsigned long events_discarded;\n"
3621 " uint32_t cpu_id;\n"
3622 "};\n\n"
3623 );
3624 }
3625
3626 /*
3627 * Compact header:
3628 * id: range: 0 - 30.
3629 * id 31 is reserved to indicate an extended header.
3630 *
3631 * Large header:
3632 * id: range: 0 - 65534.
3633 * id 65535 is reserved to indicate an extended header.
3634 *
3635 * Must be called with sessions_mutex held.
3636 */
3637 static
3638 int _lttng_event_header_declare(struct lttng_kernel_session *session)
3639 {
3640 return lttng_metadata_printf(session,
3641 "struct event_header_compact {\n"
3642 " enum : uint5_t { compact = 0 ... 30, extended = 31 } id;\n"
3643 " variant <id> {\n"
3644 " struct {\n"
3645 " uint27_clock_monotonic_t timestamp;\n"
3646 " } compact;\n"
3647 " struct {\n"
3648 " uint32_t id;\n"
3649 " uint64_clock_monotonic_t timestamp;\n"
3650 " } extended;\n"
3651 " } v;\n"
3652 "} align(%u);\n"
3653 "\n"
3654 "struct event_header_large {\n"
3655 " enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id;\n"
3656 " variant <id> {\n"
3657 " struct {\n"
3658 " uint32_clock_monotonic_t timestamp;\n"
3659 " } compact;\n"
3660 " struct {\n"
3661 " uint32_t id;\n"
3662 " uint64_clock_monotonic_t timestamp;\n"
3663 " } extended;\n"
3664 " } v;\n"
3665 "} align(%u);\n\n",
3666 lttng_alignof(uint32_t) * CHAR_BIT,
3667 lttng_alignof(uint16_t) * CHAR_BIT
3668 );
3669 }
3670
3671 /*
3672 * Approximation of NTP time of day to clock monotonic correlation,
3673 * taken at start of trace.
3674 * Yes, this is only an approximation. Yes, we can (and will) do better
3675 * in future versions.
3676 * This function may return a negative offset. It may happen if the
3677 * system sets the REALTIME clock to 0 after boot.
3678 *
3679 * Use 64bit timespec on kernels that have it, this makes 32bit arch
3680 * y2038 compliant.
3681 */
3682 static
3683 int64_t measure_clock_offset(void)
3684 {
3685 uint64_t monotonic_avg, monotonic[2], realtime;
3686 uint64_t tcf = trace_clock_freq();
3687 int64_t offset;
3688 unsigned long flags;
3689 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3690 struct timespec64 rts = { 0, 0 };
3691 #else
3692 struct timespec rts = { 0, 0 };
3693 #endif
3694
3695 /* Disable interrupts to increase correlation precision. */
3696 local_irq_save(flags);
3697 monotonic[0] = trace_clock_read64();
3698 #ifdef LTTNG_KERNEL_HAS_TIMESPEC64
3699 ktime_get_real_ts64(&rts);
3700 #else
3701 getnstimeofday(&rts);
3702 #endif
3703 monotonic[1] = trace_clock_read64();
3704 local_irq_restore(flags);
3705
3706 monotonic_avg = (monotonic[0] + monotonic[1]) >> 1;
3707 realtime = (uint64_t) rts.tv_sec * tcf;
3708 if (tcf == NSEC_PER_SEC) {
3709 realtime += rts.tv_nsec;
3710 } else {
3711 uint64_t n = rts.tv_nsec * tcf;
3712
3713 do_div(n, NSEC_PER_SEC);
3714 realtime += n;
3715 }
3716 offset = (int64_t) realtime - monotonic_avg;
3717 return offset;
3718 }
3719
3720 static
3721 int print_escaped_ctf_string(struct lttng_kernel_session *session, const char *string)
3722 {
3723 int ret = 0;
3724 size_t i;
3725 char cur;
3726
3727 i = 0;
3728 cur = string[i];
3729 while (cur != '\0') {
3730 switch (cur) {
3731 case '\n':
3732 ret = lttng_metadata_printf(session, "%s", "\\n");
3733 break;
3734 case '\\':
3735 case '"':
3736 ret = lttng_metadata_printf(session, "%c", '\\');
3737 if (ret)
3738 goto error;
3739 /* We still print the current char */
3740 lttng_fallthrough;
3741 default:
3742 ret = lttng_metadata_printf(session, "%c", cur);
3743 break;
3744 }
3745
3746 if (ret)
3747 goto error;
3748
3749 cur = string[++i];
3750 }
3751 error:
3752 return ret;
3753 }
3754
3755 static
3756 int print_metadata_escaped_field(struct lttng_kernel_session *session, const char *field,
3757 const char *field_value)
3758 {
3759 int ret;
3760
3761 ret = lttng_metadata_printf(session, " %s = \"", field);
3762 if (ret)
3763 goto error;
3764
3765 ret = print_escaped_ctf_string(session, field_value);
3766 if (ret)
3767 goto error;
3768
3769 ret = lttng_metadata_printf(session, "\";\n");
3770
3771 error:
3772 return ret;
3773 }
3774
3775 /*
3776 * Output metadata into this session's metadata buffers.
3777 * Must be called with sessions_mutex held.
3778 */
3779 static
3780 int _lttng_session_metadata_statedump(struct lttng_kernel_session *session)
3781 {
3782 unsigned char *uuid_c = session->priv->uuid.b;
3783 unsigned char uuid_s[37], clock_uuid_s[BOOT_ID_LEN];
3784 const char *product_uuid;
3785 struct lttng_kernel_channel_buffer_private *chan_priv;
3786 struct lttng_kernel_event_recorder_private *event_recorder_priv;
3787 int ret = 0;
3788
3789 if (!LTTNG_READ_ONCE(session->active))
3790 return 0;
3791
3792 lttng_metadata_begin(session);
3793
3794 if (session->priv->metadata_dumped)
3795 goto skip_session;
3796
3797 snprintf(uuid_s, sizeof(uuid_s),
3798 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
3799 uuid_c[0], uuid_c[1], uuid_c[2], uuid_c[3],
3800 uuid_c[4], uuid_c[5], uuid_c[6], uuid_c[7],
3801 uuid_c[8], uuid_c[9], uuid_c[10], uuid_c[11],
3802 uuid_c[12], uuid_c[13], uuid_c[14], uuid_c[15]);
3803
3804 ret = lttng_metadata_printf(session,
3805 "typealias integer { size = 8; align = %u; signed = false; } := uint8_t;\n"
3806 "typealias integer { size = 16; align = %u; signed = false; } := uint16_t;\n"
3807 "typealias integer { size = 32; align = %u; signed = false; } := uint32_t;\n"
3808 "typealias integer { size = 64; align = %u; signed = false; } := uint64_t;\n"
3809 "typealias integer { size = %u; align = %u; signed = false; } := unsigned long;\n"
3810 "typealias integer { size = 5; align = 1; signed = false; } := uint5_t;\n"
3811 "typealias integer { size = 27; align = 1; signed = false; } := uint27_t;\n"
3812 "\n"
3813 "trace {\n"
3814 " major = %u;\n"
3815 " minor = %u;\n"
3816 " uuid = \"%s\";\n"
3817 " byte_order = %s;\n"
3818 " packet.header := struct {\n"
3819 " uint32_t magic;\n"
3820 " uint8_t uuid[16];\n"
3821 " uint32_t stream_id;\n"
3822 " uint64_t stream_instance_id;\n"
3823 " };\n"
3824 "};\n\n",
3825 lttng_alignof(uint8_t) * CHAR_BIT,
3826 lttng_alignof(uint16_t) * CHAR_BIT,
3827 lttng_alignof(uint32_t) * CHAR_BIT,
3828 lttng_alignof(uint64_t) * CHAR_BIT,
3829 sizeof(unsigned long) * CHAR_BIT,
3830 lttng_alignof(unsigned long) * CHAR_BIT,
3831 CTF_SPEC_MAJOR,
3832 CTF_SPEC_MINOR,
3833 uuid_s,
3834 #if __BYTE_ORDER == __BIG_ENDIAN
3835 "be"
3836 #else
3837 "le"
3838 #endif
3839 );
3840 if (ret)
3841 goto end;
3842
3843 ret = lttng_metadata_printf(session,
3844 "env {\n"
3845 " hostname = \"%s\";\n"
3846 " domain = \"kernel\";\n"
3847 " sysname = \"%s\";\n"
3848 " kernel_release = \"%s\";\n"
3849 " kernel_version = \"%s\";\n"
3850 " tracer_name = \"lttng-modules\";\n"
3851 " tracer_major = %d;\n"
3852 " tracer_minor = %d;\n"
3853 " tracer_patchlevel = %d;\n"
3854 " trace_buffering_scheme = \"global\";\n",
3855 current->nsproxy->uts_ns->name.nodename,
3856 utsname()->sysname,
3857 utsname()->release,
3858 utsname()->version,
3859 LTTNG_MODULES_MAJOR_VERSION,
3860 LTTNG_MODULES_MINOR_VERSION,
3861 LTTNG_MODULES_PATCHLEVEL_VERSION
3862 );
3863 if (ret)
3864 goto end;
3865
3866 ret = print_metadata_escaped_field(session, "trace_name", session->priv->name);
3867 if (ret)
3868 goto end;
3869 ret = print_metadata_escaped_field(session, "trace_creation_datetime",
3870 session->priv->creation_time);
3871 if (ret)
3872 goto end;
3873
3874 /* Add the product UUID to the 'env' section */
3875 product_uuid = dmi_get_system_info(DMI_PRODUCT_UUID);
3876 if (product_uuid) {
3877 ret = lttng_metadata_printf(session,
3878 " product_uuid = \"%s\";\n",
3879 product_uuid
3880 );
3881 if (ret)
3882 goto end;
3883 }
3884
3885 /* Close the 'env' section */
3886 ret = lttng_metadata_printf(session, "};\n\n");
3887 if (ret)
3888 goto end;
3889
3890 ret = lttng_metadata_printf(session,
3891 "clock {\n"
3892 " name = \"%s\";\n",
3893 trace_clock_name()
3894 );
3895 if (ret)
3896 goto end;
3897
3898 if (!trace_clock_uuid(clock_uuid_s)) {
3899 ret = lttng_metadata_printf(session,
3900 " uuid = \"%s\";\n",
3901 clock_uuid_s
3902 );
3903 if (ret)
3904 goto end;
3905 }
3906
3907 ret = lttng_metadata_printf(session,
3908 " description = \"%s\";\n"
3909 " freq = %llu; /* Frequency, in Hz */\n"
3910 " /* clock value offset from Epoch is: offset * (1/freq) */\n"
3911 " offset = %lld;\n"
3912 "};\n\n",
3913 trace_clock_description(),
3914 (unsigned long long) trace_clock_freq(),
3915 (long long) measure_clock_offset()
3916 );
3917 if (ret)
3918 goto end;
3919
3920 ret = lttng_metadata_printf(session,
3921 "typealias integer {\n"
3922 " size = 27; align = 1; signed = false;\n"
3923 " map = clock.%s.value;\n"
3924 "} := uint27_clock_monotonic_t;\n"
3925 "\n"
3926 "typealias integer {\n"
3927 " size = 32; align = %u; signed = false;\n"
3928 " map = clock.%s.value;\n"
3929 "} := uint32_clock_monotonic_t;\n"
3930 "\n"
3931 "typealias integer {\n"
3932 " size = 64; align = %u; signed = false;\n"
3933 " map = clock.%s.value;\n"
3934 "} := uint64_clock_monotonic_t;\n\n",
3935 trace_clock_name(),
3936 lttng_alignof(uint32_t) * CHAR_BIT,
3937 trace_clock_name(),
3938 lttng_alignof(uint64_t) * CHAR_BIT,
3939 trace_clock_name()
3940 );
3941 if (ret)
3942 goto end;
3943
3944 ret = _lttng_stream_packet_context_declare(session);
3945 if (ret)
3946 goto end;
3947
3948 ret = _lttng_event_header_declare(session);
3949 if (ret)
3950 goto end;
3951
3952 skip_session:
3953 list_for_each_entry(chan_priv, &session->priv->chan, node) {
3954 ret = _lttng_channel_metadata_statedump(session, chan_priv->pub);
3955 if (ret)
3956 goto end;
3957 }
3958
3959 list_for_each_entry(event_recorder_priv, &session->priv->events, parent.node) {
3960 ret = _lttng_event_recorder_metadata_statedump(&event_recorder_priv->pub->parent);
3961 if (ret)
3962 goto end;
3963 }
3964 session->priv->metadata_dumped = 1;
3965 end:
3966 lttng_metadata_end(session);
3967 return ret;
3968 }
3969
3970 /**
3971 * lttng_transport_register - LTT transport registration
3972 * @transport: transport structure
3973 *
3974 * Registers a transport which can be used as output to extract the data out of
3975 * LTTng. The module calling this registration function must ensure that no
3976 * trap-inducing code will be executed by the transport functions. E.g.
3977 * vmalloc_sync_mappings() must be called between a vmalloc and the moment the memory
3978 * is made visible to the transport function. This registration acts as a
3979 * vmalloc_sync_mappings. Therefore, only if the module allocates virtual memory
3980 * after its registration must it synchronize the TLBs.
3981 */
3982 void lttng_transport_register(struct lttng_transport *transport)
3983 {
3984 /*
3985 * Make sure no page fault can be triggered by the module about to be
3986 * registered. We deal with this here so we don't have to call
3987 * vmalloc_sync_mappings() in each module's init.
3988 */
3989 wrapper_vmalloc_sync_mappings();
3990
3991 mutex_lock(&sessions_mutex);
3992 list_add_tail(&transport->node, &lttng_transport_list);
3993 mutex_unlock(&sessions_mutex);
3994 }
3995 EXPORT_SYMBOL_GPL(lttng_transport_register);
3996
3997 /**
3998 * lttng_transport_unregister - LTT transport unregistration
3999 * @transport: transport structure
4000 */
4001 void lttng_transport_unregister(struct lttng_transport *transport)
4002 {
4003 mutex_lock(&sessions_mutex);
4004 list_del(&transport->node);
4005 mutex_unlock(&sessions_mutex);
4006 }
4007 EXPORT_SYMBOL_GPL(lttng_transport_unregister);
4008
4009 void lttng_counter_transport_register(struct lttng_counter_transport *transport)
4010 {
4011 /*
4012 * Make sure no page fault can be triggered by the module about to be
4013 * registered. We deal with this here so we don't have to call
4014 * vmalloc_sync_mappings() in each module's init.
4015 */
4016 wrapper_vmalloc_sync_mappings();
4017
4018 mutex_lock(&sessions_mutex);
4019 list_add_tail(&transport->node, &lttng_counter_transport_list);
4020 mutex_unlock(&sessions_mutex);
4021 }
4022 EXPORT_SYMBOL_GPL(lttng_counter_transport_register);
4023
4024 void lttng_counter_transport_unregister(struct lttng_counter_transport *transport)
4025 {
4026 mutex_lock(&sessions_mutex);
4027 list_del(&transport->node);
4028 mutex_unlock(&sessions_mutex);
4029 }
4030 EXPORT_SYMBOL_GPL(lttng_counter_transport_unregister);
4031
4032 #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
4033
4034 enum cpuhp_state lttng_hp_prepare;
4035 enum cpuhp_state lttng_hp_online;
4036
4037 static int lttng_hotplug_prepare(unsigned int cpu, struct hlist_node *node)
4038 {
4039 struct lttng_cpuhp_node *lttng_node;
4040
4041 lttng_node = container_of(node, struct lttng_cpuhp_node, node);
4042 switch (lttng_node->component) {
4043 case LTTNG_RING_BUFFER_FRONTEND:
4044 return 0;
4045 case LTTNG_RING_BUFFER_BACKEND:
4046 return lttng_cpuhp_rb_backend_prepare(cpu, lttng_node);
4047 case LTTNG_RING_BUFFER_ITER:
4048 return 0;
4049 case LTTNG_CONTEXT_PERF_COUNTERS:
4050 return 0;
4051 default:
4052 return -EINVAL;
4053 }
4054 }
4055
4056 static int lttng_hotplug_dead(unsigned int cpu, struct hlist_node *node)
4057 {
4058 struct lttng_cpuhp_node *lttng_node;
4059
4060 lttng_node = container_of(node, struct lttng_cpuhp_node, node);
4061 switch (lttng_node->component) {
4062 case LTTNG_RING_BUFFER_FRONTEND:
4063 return lttng_cpuhp_rb_frontend_dead(cpu, lttng_node);
4064 case LTTNG_RING_BUFFER_BACKEND:
4065 return 0;
4066 case LTTNG_RING_BUFFER_ITER:
4067 return 0;
4068 case LTTNG_CONTEXT_PERF_COUNTERS:
4069 return lttng_cpuhp_perf_counter_dead(cpu, lttng_node);
4070 default:
4071 return -EINVAL;
4072 }
4073 }
4074
4075 static int lttng_hotplug_online(unsigned int cpu, struct hlist_node *node)
4076 {
4077 struct lttng_cpuhp_node *lttng_node;
4078
4079 lttng_node = container_of(node, struct lttng_cpuhp_node, node);
4080 switch (lttng_node->component) {
4081 case LTTNG_RING_BUFFER_FRONTEND:
4082 return lttng_cpuhp_rb_frontend_online(cpu, lttng_node);
4083 case LTTNG_RING_BUFFER_BACKEND:
4084 return 0;
4085 case LTTNG_RING_BUFFER_ITER:
4086 return lttng_cpuhp_rb_iter_online(cpu, lttng_node);
4087 case LTTNG_CONTEXT_PERF_COUNTERS:
4088 return lttng_cpuhp_perf_counter_online(cpu, lttng_node);
4089 default:
4090 return -EINVAL;
4091 }
4092 }
4093
4094 static int lttng_hotplug_offline(unsigned int cpu, struct hlist_node *node)
4095 {
4096 struct lttng_cpuhp_node *lttng_node;
4097
4098 lttng_node = container_of(node, struct lttng_cpuhp_node, node);
4099 switch (lttng_node->component) {
4100 case LTTNG_RING_BUFFER_FRONTEND:
4101 return lttng_cpuhp_rb_frontend_offline(cpu, lttng_node);
4102 case LTTNG_RING_BUFFER_BACKEND:
4103 return 0;
4104 case LTTNG_RING_BUFFER_ITER:
4105 return 0;
4106 case LTTNG_CONTEXT_PERF_COUNTERS:
4107 return 0;
4108 default:
4109 return -EINVAL;
4110 }
4111 }
4112
4113 static int __init lttng_init_cpu_hotplug(void)
4114 {
4115 int ret;
4116
4117 ret = cpuhp_setup_state_multi(CPUHP_BP_PREPARE_DYN, "lttng:prepare",
4118 lttng_hotplug_prepare,
4119 lttng_hotplug_dead);
4120 if (ret < 0) {
4121 return ret;
4122 }
4123 lttng_hp_prepare = ret;
4124 lttng_rb_set_hp_prepare(ret);
4125
4126 ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "lttng:online",
4127 lttng_hotplug_online,
4128 lttng_hotplug_offline);
4129 if (ret < 0) {
4130 cpuhp_remove_multi_state(lttng_hp_prepare);
4131 lttng_hp_prepare = 0;
4132 return ret;
4133 }
4134 lttng_hp_online = ret;
4135 lttng_rb_set_hp_online(ret);
4136
4137 return 0;
4138 }
4139
4140 static void __exit lttng_exit_cpu_hotplug(void)
4141 {
4142 lttng_rb_set_hp_online(0);
4143 cpuhp_remove_multi_state(lttng_hp_online);
4144 lttng_rb_set_hp_prepare(0);
4145 cpuhp_remove_multi_state(lttng_hp_prepare);
4146 }
4147
4148 #else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4149 static int lttng_init_cpu_hotplug(void)
4150 {
4151 return 0;
4152 }
4153 static void lttng_exit_cpu_hotplug(void)
4154 {
4155 }
4156 #endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
4157
4158 static int __init lttng_events_init(void)
4159 {
4160 int ret;
4161
4162 ret = wrapper_lttng_fixup_sig(THIS_MODULE);
4163 if (ret)
4164 return ret;
4165 ret = wrapper_get_pfnblock_flags_mask_init();
4166 if (ret)
4167 return ret;
4168 ret = wrapper_get_pageblock_flags_mask_init();
4169 if (ret)
4170 return ret;
4171 ret = lttng_probes_init();
4172 if (ret)
4173 return ret;
4174 ret = lttng_context_init();
4175 if (ret)
4176 return ret;
4177 ret = lttng_tracepoint_init();
4178 if (ret)
4179 goto error_tp;
4180 event_recorder_cache = KMEM_CACHE(lttng_kernel_event_recorder, 0);
4181 if (!event_recorder_cache) {
4182 ret = -ENOMEM;
4183 goto error_kmem_event_recorder;
4184 }
4185 event_recorder_private_cache = KMEM_CACHE(lttng_kernel_event_recorder_private, 0);
4186 if (!event_recorder_private_cache) {
4187 ret = -ENOMEM;
4188 goto error_kmem_event_recorder_private;
4189 }
4190 event_notifier_cache = KMEM_CACHE(lttng_kernel_event_notifier, 0);
4191 if (!event_notifier_cache) {
4192 ret = -ENOMEM;
4193 goto error_kmem_event_notifier;
4194 }
4195 event_notifier_private_cache = KMEM_CACHE(lttng_kernel_event_notifier_private, 0);
4196 if (!event_notifier_private_cache) {
4197 ret = -ENOMEM;
4198 goto error_kmem_event_notifier_private;
4199 }
4200 ret = lttng_abi_init();
4201 if (ret)
4202 goto error_abi;
4203 ret = lttng_logger_init();
4204 if (ret)
4205 goto error_logger;
4206 ret = lttng_init_cpu_hotplug();
4207 if (ret)
4208 goto error_hotplug;
4209 printk(KERN_NOTICE "LTTng: Loaded modules v%s.%s.%s%s (%s)%s%s\n",
4210 __stringify(LTTNG_MODULES_MAJOR_VERSION),
4211 __stringify(LTTNG_MODULES_MINOR_VERSION),
4212 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION),
4213 LTTNG_MODULES_EXTRAVERSION,
4214 LTTNG_VERSION_NAME,
4215 #ifdef LTTNG_EXTRA_VERSION_GIT
4216 LTTNG_EXTRA_VERSION_GIT[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT,
4217 #else
4218 "",
4219 #endif
4220 #ifdef LTTNG_EXTRA_VERSION_NAME
4221 LTTNG_EXTRA_VERSION_NAME[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME);
4222 #else
4223 "");
4224 #endif
4225 #ifdef CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM
4226 printk(KERN_NOTICE "LTTng: Experimental bitwise enum enabled.\n");
4227 #endif /* CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM */
4228 return 0;
4229
4230 error_hotplug:
4231 lttng_logger_exit();
4232 error_logger:
4233 lttng_abi_exit();
4234 error_abi:
4235 kmem_cache_destroy(event_notifier_private_cache);
4236 error_kmem_event_notifier_private:
4237 kmem_cache_destroy(event_notifier_cache);
4238 error_kmem_event_notifier:
4239 kmem_cache_destroy(event_recorder_private_cache);
4240 error_kmem_event_recorder_private:
4241 kmem_cache_destroy(event_recorder_cache);
4242 error_kmem_event_recorder:
4243 lttng_tracepoint_exit();
4244 error_tp:
4245 lttng_context_exit();
4246 printk(KERN_NOTICE "LTTng: Failed to load modules v%s.%s.%s%s (%s)%s%s\n",
4247 __stringify(LTTNG_MODULES_MAJOR_VERSION),
4248 __stringify(LTTNG_MODULES_MINOR_VERSION),
4249 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION),
4250 LTTNG_MODULES_EXTRAVERSION,
4251 LTTNG_VERSION_NAME,
4252 #ifdef LTTNG_EXTRA_VERSION_GIT
4253 LTTNG_EXTRA_VERSION_GIT[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT,
4254 #else
4255 "",
4256 #endif
4257 #ifdef LTTNG_EXTRA_VERSION_NAME
4258 LTTNG_EXTRA_VERSION_NAME[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME);
4259 #else
4260 "");
4261 #endif
4262 return ret;
4263 }
4264
4265 module_init(lttng_events_init);
4266
4267 static void __exit lttng_events_exit(void)
4268 {
4269 struct lttng_kernel_session_private *session_priv, *tmpsession_priv;
4270
4271 lttng_exit_cpu_hotplug();
4272 lttng_logger_exit();
4273 lttng_abi_exit();
4274 list_for_each_entry_safe(session_priv, tmpsession_priv, &sessions, list)
4275 lttng_session_destroy(session_priv->pub);
4276 kmem_cache_destroy(event_recorder_cache);
4277 kmem_cache_destroy(event_recorder_private_cache);
4278 kmem_cache_destroy(event_notifier_cache);
4279 kmem_cache_destroy(event_notifier_private_cache);
4280 lttng_tracepoint_exit();
4281 lttng_context_exit();
4282 printk(KERN_NOTICE "LTTng: Unloaded modules v%s.%s.%s%s (%s)%s%s\n",
4283 __stringify(LTTNG_MODULES_MAJOR_VERSION),
4284 __stringify(LTTNG_MODULES_MINOR_VERSION),
4285 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION),
4286 LTTNG_MODULES_EXTRAVERSION,
4287 LTTNG_VERSION_NAME,
4288 #ifdef LTTNG_EXTRA_VERSION_GIT
4289 LTTNG_EXTRA_VERSION_GIT[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_GIT,
4290 #else
4291 "",
4292 #endif
4293 #ifdef LTTNG_EXTRA_VERSION_NAME
4294 LTTNG_EXTRA_VERSION_NAME[0] == '\0' ? "" : " - " LTTNG_EXTRA_VERSION_NAME);
4295 #else
4296 "");
4297 #endif
4298 }
4299
4300 module_exit(lttng_events_exit);
4301
4302 #include <generated/patches.h>
4303 #ifdef LTTNG_EXTRA_VERSION_GIT
4304 MODULE_INFO(extra_version_git, LTTNG_EXTRA_VERSION_GIT);
4305 #endif
4306 #ifdef LTTNG_EXTRA_VERSION_NAME
4307 MODULE_INFO(extra_version_name, LTTNG_EXTRA_VERSION_NAME);
4308 #endif
4309 MODULE_LICENSE("GPL and additional rights");
4310 MODULE_AUTHOR("Mathieu Desnoyers <mathieu.desnoyers@efficios.com>");
4311 MODULE_DESCRIPTION("LTTng tracer");
4312 MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "."
4313 __stringify(LTTNG_MODULES_MINOR_VERSION) "."
4314 __stringify(LTTNG_MODULES_PATCHLEVEL_VERSION)
4315 LTTNG_MODULES_EXTRAVERSION);
LTTng 2.0/0.x modules
This page took 0.173498 seconds and 3 git commands to generate.