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