1 #ifndef _LINUX_RING_BUFFER_FRONTEND_TYPES_H
2 #define _LINUX_RING_BUFFER_FRONTEND_TYPES_H
5 * linux/ringbuffer/frontend_types.h
7 * (C) Copyright 2005-2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * Ring Buffer Library Synchronization Header (types).
12 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
14 * See ring_buffer_frontend.c for more information on wait-free algorithms.
16 * Dual LGPL v2.1/GPL v2 license.
21 #include <urcu/list.h>
22 #include <urcu/uatomic.h>
24 #include "lttng/core.h"
26 #include <lttng/usterr-signal-safe.h>
27 #include <lttng/ringbuffer-config.h>
28 #include "backend_types.h"
29 #include "shm_internal.h"
32 * A switch is done during tracing or as a final flush after tracing (so it
33 * won't write in the new sub-buffer).
35 enum switch_mode
{ SWITCH_ACTIVE
, SWITCH_FLUSH
};
37 /* channel: collection of per-cpu ring buffers. */
40 unsigned long commit_count_mask
; /*
41 * Commit count mask, removing
42 * the MSBs corresponding to
43 * bits used to represent the
47 unsigned long switch_timer_interval
; /* Buffer flush (jiffies) */
48 unsigned long read_timer_interval
; /* Reader wakeup (jiffies) */
49 //wait_queue_head_t read_wait; /* reader wait queue */
50 int finalized
; /* Has channel been finalized */
51 size_t priv_data_offset
;
53 * Associated backend contains a variable-length array. Needs to
56 struct channel_backend backend
; /* Associated backend */
57 } ____cacheline_aligned
;
59 /* Per-subbuffer commit counters used on the hot path */
60 struct commit_counters_hot
{
61 union v_atomic cc
; /* Commit counter */
62 union v_atomic seq
; /* Consecutive commits */
63 } ____cacheline_aligned
;
65 /* Per-subbuffer commit counters used only on cold paths */
66 struct commit_counters_cold
{
67 union v_atomic cc_sb
; /* Incremented _once_ at sb switch */
68 } ____cacheline_aligned
;
70 /* ring buffer state */
71 struct lttng_ust_lib_ring_buffer
{
72 /* First 32 bytes cache-hot cacheline */
73 union v_atomic offset
; /* Current offset in the buffer */
74 DECLARE_SHMP(struct commit_counters_hot
, commit_hot
);
75 /* Commit count per sub-buffer */
77 * Current offset in the buffer
78 * standard atomic access (shared)
81 /* End of first 32 bytes cacheline */
82 union v_atomic last_tsc
; /*
83 * Last timestamp written in the buffer.
86 struct lttng_ust_lib_ring_buffer_backend backend
; /* Associated backend */
88 DECLARE_SHMP(struct commit_counters_cold
, commit_cold
);
89 /* Commit count per sub-buffer */
90 long active_readers
; /*
91 * Active readers count
92 * standard atomic access (shared)
94 long active_shadow_readers
;
96 union v_atomic records_lost_full
; /* Buffer full */
97 union v_atomic records_lost_wrap
; /* Nested wrap-around */
98 union v_atomic records_lost_big
; /* Events too big */
99 union v_atomic records_count
; /* Number of records written */
100 union v_atomic records_overrun
; /* Number of overwritten records */
101 //wait_queue_head_t read_wait; /* reader buffer-level wait queue */
102 int finalized
; /* buffer has been finalized */
103 //struct timer_list switch_timer; /* timer for periodical switch */
104 //struct timer_list read_timer; /* timer for read poll */
105 unsigned long get_subbuf_consumed
; /* Read-side consumed */
106 unsigned long prod_snapshot
; /* Producer count snapshot */
107 unsigned long cons_snapshot
; /* Consumer count snapshot */
108 int get_subbuf
:1; /* Sub-buffer being held by reader */
109 int switch_timer_enabled
:1; /* Protected by ring_buffer_nohz_lock */
110 int read_timer_enabled
:1; /* Protected by ring_buffer_nohz_lock */
111 /* shmp pointer to self */
112 DECLARE_SHMP(struct lttng_ust_lib_ring_buffer
, self
);
113 } ____cacheline_aligned
;
116 void *channel_get_private(struct channel
*chan
)
118 return ((char *) chan
) + chan
->priv_data_offset
;
122 * Issue warnings and disable channels upon internal error.
123 * Can receive struct lttng_ust_lib_ring_buffer or struct lttng_ust_lib_ring_buffer_backend
126 #define CHAN_WARN_ON(c, cond) \
128 struct channel *__chan; \
129 int _____ret = caa_unlikely(cond); \
131 if (__same_type(*(c), struct channel_backend)) \
132 __chan = caa_container_of((void *) (c), \
135 else if (__same_type(*(c), struct channel)) \
136 __chan = (void *) (c); \
139 uatomic_inc(&__chan->record_disabled); \
145 #endif /* _LINUX_RING_BUFFER_FRONTEND_TYPES_H */