Fix: wrapper random documentation
[lttng-modules.git] / lib / ringbuffer / frontend_types.h
index e8c4c5ce8a4f5dd89da66cce76d5c8af7e66e356..3fd634524f8ab9b59e59eed14f4adb6e169a4d5a 100644 (file)
@@ -1,25 +1,22 @@
-#ifndef _LINUX_RING_BUFFER_FRONTEND_TYPES_H
-#define _LINUX_RING_BUFFER_FRONTEND_TYPES_H
-
-/*
- * linux/ringbuffer/frontend_types.h
+/* SPDX-License-Identifier: (GPL-2.0-only OR LGPL-2.1-only)
  *
- * (C) Copyright 2005-2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * lib/ringbuffer/frontend_types.h
  *
  * Ring Buffer Library Synchronization Header (types).
  *
- * Author:
- *     Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
  * See ring_buffer_frontend.c for more information on wait-free algorithms.
- *
- * Dual LGPL v2.1/GPL v2 license.
  */
 
+#ifndef _LIB_RING_BUFFER_FRONTEND_TYPES_H
+#define _LIB_RING_BUFFER_FRONTEND_TYPES_H
+
 #include <linux/kref.h>
-#include "../../wrapper/ringbuffer/config.h"
-#include "../../wrapper/ringbuffer/backend_types.h"
-#include "../../wrapper/prio_heap.h"   /* For per-CPU read-side iterator */
+#include <wrapper/ringbuffer/config.h>
+#include <wrapper/ringbuffer/backend_types.h>
+#include <lib/prio_heap/lttng_prio_heap.h>     /* For per-CPU read-side iterator */
+#include <lttng-cpuhotplug.h>
 
 /*
  * A switch is done during tracing or as a final flush after tracing (so it
@@ -30,7 +27,7 @@ enum switch_mode { SWITCH_ACTIVE, SWITCH_FLUSH };
 /* channel-level read-side iterator */
 struct channel_iter {
        /* Prio heap of buffers. Lowest timestamps at the top. */
-       struct ptr_heap heap;           /* Heap of struct lib_ring_buffer ptrs */
+       struct lttng_ptr_heap heap;     /* Heap of struct lib_ring_buffer ptrs */
        struct list_head empty_head;    /* Empty buffers linked-list head */
        int read_open;                  /* Opened for reading ? */
        u64 last_qs;                    /* Last quiescent state timestamp */
@@ -56,12 +53,20 @@ struct channel {
 
        unsigned long switch_timer_interval;    /* Buffer flush (jiffies) */
        unsigned long read_timer_interval;      /* Reader wakeup (jiffies) */
+#if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
+       struct lttng_cpuhp_node cpuhp_prepare;
+       struct lttng_cpuhp_node cpuhp_online;
+       struct lttng_cpuhp_node cpuhp_iter_online;
+#else
        struct notifier_block cpu_hp_notifier;  /* CPU hotplug notifier */
-       struct notifier_block tick_nohz_notifier; /* CPU nohz notifier */
        struct notifier_block hp_iter_notifier; /* hotplug iterator notifier */
-       int cpu_hp_enable:1;                    /* Enable CPU hotplug notif. */
-       int hp_iter_enable:1;                   /* Enable hp iter notif. */
+       unsigned int cpu_hp_enable:1;           /* Enable CPU hotplug notif. */
+       unsigned int hp_iter_enable:1;          /* Enable hp iter notif. */
+#endif
+       struct notifier_block tick_nohz_notifier; /* CPU nohz notifier */
        wait_queue_head_t read_wait;            /* reader wait queue */
+       wait_queue_head_t hp_wait;              /* CPU hotplug wait queue */
+       int finalized;                          /* Has channel been finalized */
        struct channel_iter iter;               /* Channel read-side iterator */
        struct kref ref;                        /* Reference count */
 };
@@ -91,8 +96,8 @@ struct lib_ring_buffer_iter {
                ITER_NEXT_RECORD,
                ITER_PUT_SUBBUF,
        } state;
-       int allocated:1;
-       int read_open:1;                /* Opened for reading ? */
+       unsigned int allocated:1;
+       unsigned int read_open:1;       /* Opened for reading ? */
 };
 
 /* ring buffer state */
@@ -115,6 +120,20 @@ struct lib_ring_buffer {
 
        struct commit_counters_cold *commit_cold;
                                        /* Commit count per sub-buffer */
+       u64 *ts_end;                    /*
+                                        * timestamp_end per sub-buffer.
+                                        * Time is sampled by the
+                                        * switch_*_end() callbacks which
+                                        * are the last space reservation
+                                        * performed in the sub-buffer
+                                        * before it can be fully
+                                        * committed and delivered. This
+                                        * time value is then read by
+                                        * the deliver callback,
+                                        * performed by the last commit
+                                        * before the buffer becomes
+                                        * readable.
+                                        */
        atomic_long_t active_readers;   /*
                                         * Active readers count
                                         * standard atomic access (shared)
@@ -126,6 +145,7 @@ struct lib_ring_buffer {
        union v_atomic records_count;   /* Number of records written */
        union v_atomic records_overrun; /* Number of overwritten records */
        wait_queue_head_t read_wait;    /* reader buffer-level wait queue */
+       wait_queue_head_t write_wait;   /* writer buffer-level wait queue (for metadata only) */
        int finalized;                  /* buffer has been finalized */
        struct timer_list switch_timer; /* timer for periodical switch */
        struct timer_list read_timer;   /* timer for read poll */
@@ -134,9 +154,10 @@ struct lib_ring_buffer {
        unsigned long get_subbuf_consumed;      /* Read-side consumed */
        unsigned long prod_snapshot;    /* Producer count snapshot */
        unsigned long cons_snapshot;    /* Consumer count snapshot */
-       int get_subbuf:1;               /* Sub-buffer being held by reader */
-       int switch_timer_enabled:1;     /* Protected by ring_buffer_nohz_lock */
-       int read_timer_enabled:1;       /* Protected by ring_buffer_nohz_lock */
+       unsigned int get_subbuf:1,      /* Sub-buffer being held by reader */
+               switch_timer_enabled:1, /* Protected by ring_buffer_nohz_lock */
+               read_timer_enabled:1,   /* Protected by ring_buffer_nohz_lock */
+               quiescent:1;
 };
 
 static inline
@@ -145,6 +166,8 @@ void *channel_get_private(struct channel *chan)
        return chan->backend.priv;
 }
 
+void lib_ring_buffer_lost_event_too_big(struct channel *chan);
+
 /*
  * Issue warnings and disable channels upon internal error.
  * Can receive struct lib_ring_buffer or struct lib_ring_buffer_backend
@@ -169,4 +192,4 @@ void *channel_get_private(struct channel *chan)
                _____ret;                                               \
        })
 
-#endif /* _LINUX_RING_BUFFER_FRONTEND_TYPES_H */
+#endif /* _LIB_RING_BUFFER_FRONTEND_TYPES_H */
This page took 0.024348 seconds and 4 git commands to generate.