diff options
Diffstat (limited to 'include/linux/ring_buffer.h')
-rw-r--r-- | include/linux/ring_buffer.h | 106 |
1 files changed, 82 insertions, 24 deletions
diff --git a/include/linux/ring_buffer.h b/include/linux/ring_buffer.h index b3b359660082..29f8599e6bea 100644 --- a/include/linux/ring_buffer.h +++ b/include/linux/ring_buffer.h | |||
@@ -1,6 +1,7 @@ | |||
1 | #ifndef _LINUX_RING_BUFFER_H | 1 | #ifndef _LINUX_RING_BUFFER_H |
2 | #define _LINUX_RING_BUFFER_H | 2 | #define _LINUX_RING_BUFFER_H |
3 | 3 | ||
4 | #include <linux/kmemcheck.h> | ||
4 | #include <linux/mm.h> | 5 | #include <linux/mm.h> |
5 | #include <linux/seq_file.h> | 6 | #include <linux/seq_file.h> |
6 | 7 | ||
@@ -8,20 +9,27 @@ struct ring_buffer; | |||
8 | struct ring_buffer_iter; | 9 | struct ring_buffer_iter; |
9 | 10 | ||
10 | /* | 11 | /* |
11 | * Don't reference this struct directly, use functions below. | 12 | * Don't refer to this struct directly, use functions below. |
12 | */ | 13 | */ |
13 | struct ring_buffer_event { | 14 | struct ring_buffer_event { |
14 | u32 type:2, len:3, time_delta:27; | 15 | kmemcheck_bitfield_begin(bitfield); |
16 | u32 type_len:5, time_delta:27; | ||
17 | kmemcheck_bitfield_end(bitfield); | ||
18 | |||
15 | u32 array[]; | 19 | u32 array[]; |
16 | }; | 20 | }; |
17 | 21 | ||
18 | /** | 22 | /** |
19 | * enum ring_buffer_type - internal ring buffer types | 23 | * enum ring_buffer_type - internal ring buffer types |
20 | * | 24 | * |
21 | * @RINGBUF_TYPE_PADDING: Left over page padding | 25 | * @RINGBUF_TYPE_PADDING: Left over page padding or discarded event |
22 | * array is ignored | 26 | * If time_delta is 0: |
23 | * size is variable depending on how much | 27 | * array is ignored |
28 | * size is variable depending on how much | ||
24 | * padding is needed | 29 | * padding is needed |
30 | * If time_delta is non zero: | ||
31 | * array[0] holds the actual length | ||
32 | * size = 4 + length (bytes) | ||
25 | * | 33 | * |
26 | * @RINGBUF_TYPE_TIME_EXTEND: Extend the time delta | 34 | * @RINGBUF_TYPE_TIME_EXTEND: Extend the time delta |
27 | * array[0] = time delta (28 .. 59) | 35 | * array[0] = time delta (28 .. 59) |
@@ -32,22 +40,23 @@ struct ring_buffer_event { | |||
32 | * array[1..2] = tv_sec | 40 | * array[1..2] = tv_sec |
33 | * size = 16 bytes | 41 | * size = 16 bytes |
34 | * | 42 | * |
35 | * @RINGBUF_TYPE_DATA: Data record | 43 | * <= @RINGBUF_TYPE_DATA_TYPE_LEN_MAX: |
36 | * If len is zero: | 44 | * Data record |
45 | * If type_len is zero: | ||
37 | * array[0] holds the actual length | 46 | * array[0] holds the actual length |
38 | * array[1..(length+3)/4] holds data | 47 | * array[1..(length+3)/4] holds data |
39 | * size = 4 + 4 + length (bytes) | 48 | * size = 4 + length (bytes) |
40 | * else | 49 | * else |
41 | * length = len << 2 | 50 | * length = type_len << 2 |
42 | * array[0..(length+3)/4-1] holds data | 51 | * array[0..(length+3)/4-1] holds data |
43 | * size = 4 + length (bytes) | 52 | * size = 4 + length (bytes) |
44 | */ | 53 | */ |
45 | enum ring_buffer_type { | 54 | enum ring_buffer_type { |
55 | RINGBUF_TYPE_DATA_TYPE_LEN_MAX = 28, | ||
46 | RINGBUF_TYPE_PADDING, | 56 | RINGBUF_TYPE_PADDING, |
47 | RINGBUF_TYPE_TIME_EXTEND, | 57 | RINGBUF_TYPE_TIME_EXTEND, |
48 | /* FIXME: RINGBUF_TYPE_TIME_STAMP not implemented */ | 58 | /* FIXME: RINGBUF_TYPE_TIME_STAMP not implemented */ |
49 | RINGBUF_TYPE_TIME_STAMP, | 59 | RINGBUF_TYPE_TIME_STAMP, |
50 | RINGBUF_TYPE_DATA, | ||
51 | }; | 60 | }; |
52 | 61 | ||
53 | unsigned ring_buffer_event_length(struct ring_buffer_event *event); | 62 | unsigned ring_buffer_event_length(struct ring_buffer_event *event); |
@@ -66,21 +75,61 @@ ring_buffer_event_time_delta(struct ring_buffer_event *event) | |||
66 | } | 75 | } |
67 | 76 | ||
68 | /* | 77 | /* |
78 | * ring_buffer_event_discard can discard any event in the ring buffer. | ||
79 | * it is up to the caller to protect against a reader from | ||
80 | * consuming it or a writer from wrapping and replacing it. | ||
81 | * | ||
82 | * No external protection is needed if this is called before | ||
83 | * the event is commited. But in that case it would be better to | ||
84 | * use ring_buffer_discard_commit. | ||
85 | * | ||
86 | * Note, if an event that has not been committed is discarded | ||
87 | * with ring_buffer_event_discard, it must still be committed. | ||
88 | */ | ||
89 | void ring_buffer_event_discard(struct ring_buffer_event *event); | ||
90 | |||
91 | /* | ||
92 | * ring_buffer_discard_commit will remove an event that has not | ||
93 | * ben committed yet. If this is used, then ring_buffer_unlock_commit | ||
94 | * must not be called on the discarded event. This function | ||
95 | * will try to remove the event from the ring buffer completely | ||
96 | * if another event has not been written after it. | ||
97 | * | ||
98 | * Example use: | ||
99 | * | ||
100 | * if (some_condition) | ||
101 | * ring_buffer_discard_commit(buffer, event); | ||
102 | * else | ||
103 | * ring_buffer_unlock_commit(buffer, event); | ||
104 | */ | ||
105 | void ring_buffer_discard_commit(struct ring_buffer *buffer, | ||
106 | struct ring_buffer_event *event); | ||
107 | |||
108 | /* | ||
69 | * size is in bytes for each per CPU buffer. | 109 | * size is in bytes for each per CPU buffer. |
70 | */ | 110 | */ |
71 | struct ring_buffer * | 111 | struct ring_buffer * |
72 | ring_buffer_alloc(unsigned long size, unsigned flags); | 112 | __ring_buffer_alloc(unsigned long size, unsigned flags, struct lock_class_key *key); |
113 | |||
114 | /* | ||
115 | * Because the ring buffer is generic, if other users of the ring buffer get | ||
116 | * traced by ftrace, it can produce lockdep warnings. We need to keep each | ||
117 | * ring buffer's lock class separate. | ||
118 | */ | ||
119 | #define ring_buffer_alloc(size, flags) \ | ||
120 | ({ \ | ||
121 | static struct lock_class_key __key; \ | ||
122 | __ring_buffer_alloc((size), (flags), &__key); \ | ||
123 | }) | ||
124 | |||
73 | void ring_buffer_free(struct ring_buffer *buffer); | 125 | void ring_buffer_free(struct ring_buffer *buffer); |
74 | 126 | ||
75 | int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size); | 127 | int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size); |
76 | 128 | ||
77 | struct ring_buffer_event * | 129 | struct ring_buffer_event *ring_buffer_lock_reserve(struct ring_buffer *buffer, |
78 | ring_buffer_lock_reserve(struct ring_buffer *buffer, | 130 | unsigned long length); |
79 | unsigned long length, | ||
80 | unsigned long *flags); | ||
81 | int ring_buffer_unlock_commit(struct ring_buffer *buffer, | 131 | int ring_buffer_unlock_commit(struct ring_buffer *buffer, |
82 | struct ring_buffer_event *event, | 132 | struct ring_buffer_event *event); |
83 | unsigned long flags); | ||
84 | int ring_buffer_write(struct ring_buffer *buffer, | 133 | int ring_buffer_write(struct ring_buffer *buffer, |
85 | unsigned long length, void *data); | 134 | unsigned long length, void *data); |
86 | 135 | ||
@@ -120,18 +169,27 @@ unsigned long ring_buffer_entries(struct ring_buffer *buffer); | |||
120 | unsigned long ring_buffer_overruns(struct ring_buffer *buffer); | 169 | unsigned long ring_buffer_overruns(struct ring_buffer *buffer); |
121 | unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu); | 170 | unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu); |
122 | unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu); | 171 | unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu); |
172 | unsigned long ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu); | ||
173 | unsigned long ring_buffer_nmi_dropped_cpu(struct ring_buffer *buffer, int cpu); | ||
174 | |||
175 | u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu); | ||
176 | void ring_buffer_normalize_time_stamp(struct ring_buffer *buffer, | ||
177 | int cpu, u64 *ts); | ||
178 | void ring_buffer_set_clock(struct ring_buffer *buffer, | ||
179 | u64 (*clock)(void)); | ||
123 | 180 | ||
124 | u64 ring_buffer_time_stamp(int cpu); | 181 | size_t ring_buffer_page_len(void *page); |
125 | void ring_buffer_normalize_time_stamp(int cpu, u64 *ts); | ||
126 | 182 | ||
127 | void tracing_on(void); | ||
128 | void tracing_off(void); | ||
129 | void tracing_off_permanent(void); | ||
130 | 183 | ||
131 | void *ring_buffer_alloc_read_page(struct ring_buffer *buffer); | 184 | void *ring_buffer_alloc_read_page(struct ring_buffer *buffer); |
132 | void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data); | 185 | void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data); |
133 | int ring_buffer_read_page(struct ring_buffer *buffer, | 186 | int ring_buffer_read_page(struct ring_buffer *buffer, void **data_page, |
134 | void **data_page, int cpu, int full); | 187 | size_t len, int cpu, int full); |
188 | |||
189 | struct trace_seq; | ||
190 | |||
191 | int ring_buffer_print_entry_header(struct trace_seq *s); | ||
192 | int ring_buffer_print_page_header(struct trace_seq *s); | ||
135 | 193 | ||
136 | enum ring_buffer_flags { | 194 | enum ring_buffer_flags { |
137 | RB_FL_OVERWRITE = 1 << 0, | 195 | RB_FL_OVERWRITE = 1 << 0, |