Implement event notifier error counter

[lttng-modules.git] / include / ringbuffer / config.h

diff --git a/include/ringbuffer/config.h b/include/ringbuffer/config.h
index 1b01935b3147affca70c5ccfa8a15d185dd54441..ccb683371cd9ec52176909f59e8a348dbfb01776 100644 (file)
--- a/include/ringbuffer/config.h
+++ b/include/ringbuffer/config.h
@@ -13,8 +13,8 @@
 
 #include <linux/types.h>
 #include <linux/percpu.h>
-#include <lib/align.h>
-#include <lttng-tracer-core.h>
+#include <lttng/align.h>
+#include <lttng/tracer-core.h>
 
 struct lib_ring_buffer;
 struct channel;
@@ -101,7 +101,9 @@ struct lib_ring_buffer_client_cb {
  *
  * RING_BUFFER_WAKEUP_BY_WRITER directly wakes up readers when a subbuffer is
  * ready to read. Lower latencies before the reader is woken up. Mainly suitable
- * for drivers.
+ * for drivers. Going through an "irq_work" allows triggering this type of wakeup
+ * even from NMI context: the wakeup will be slightly delayed until the next
+ * interrupts are handled.
  *
  * RING_BUFFER_WAKEUP_NONE does not perform any wakeup whatsoever. The client
  * has the responsibility to perform wakeups.
@@ -142,9 +144,8 @@ struct lib_ring_buffer_config {
        enum {
                RING_BUFFER_WAKEUP_BY_TIMER,    /* wake up performed by timer */
                RING_BUFFER_WAKEUP_BY_WRITER,   /*
-                                                * writer wakes up reader,
-                                                * not lock-free
-                                                * (takes spinlock).
+                                                * writer wakes up reader through
+                                                * irq_work.
                                                 */
        } wakeup;
        /*
@@ -234,7 +235,7 @@ void lib_ring_buffer_ctx_init(struct lib_ring_buffer_ctx *ctx,
 #define RING_BUFFER_RFLAG_END                  (1U << 1)
 
 #ifndef LTTNG_TRACER_CORE_H
-#error "lttng-tracer-core.h is needed for RING_BUFFER_ALIGN define"
+#error "lttng/tracer-core.h is needed for RING_BUFFER_ALIGN define"
 #endif
 
 /*