Commit | Line | Data |
---|---|---|
e92f3e28 MD |
1 | #ifndef _LTTNG_RING_BUFFER_BACKEND_TYPES_H |
2 | #define _LTTNG_RING_BUFFER_BACKEND_TYPES_H | |
852c2936 MD |
3 | |
4 | /* | |
5 | * linux/ringbuffer/backend_types.h | |
6 | * | |
852c2936 MD |
7 | * Ring buffer backend (types). |
8 | * | |
e92f3e28 MD |
9 | * Copyright (C) 2008-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
10 | * | |
11 | * This library is free software; you can redistribute it and/or | |
12 | * modify it under the terms of the GNU Lesser General Public | |
13 | * License as published by the Free Software Foundation; only | |
14 | * version 2.1 of the License. | |
15 | * | |
16 | * This library is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
19 | * Lesser General Public License for more details. | |
20 | * | |
21 | * You should have received a copy of the GNU Lesser General Public | |
22 | * License along with this library; if not, write to the Free Software | |
23 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
852c2936 MD |
24 | */ |
25 | ||
2fed87ae | 26 | #include <limits.h> |
fb31eb73 | 27 | #include <stdint.h> |
1d498196 | 28 | #include "shm_internal.h" |
a3bb4b27 | 29 | #include "vatomic.h" |
852c2936 | 30 | |
3c8964ba | 31 | #define RB_BACKEND_PAGES_PADDING 16 |
4cfec15c | 32 | struct lttng_ust_lib_ring_buffer_backend_pages { |
852c2936 MD |
33 | unsigned long mmap_offset; /* offset of the subbuffer in mmap */ |
34 | union v_atomic records_commit; /* current records committed count */ | |
35 | union v_atomic records_unread; /* records to read */ | |
36 | unsigned long data_size; /* Amount of data to read from subbuf */ | |
a6352fd4 | 37 | DECLARE_SHMP(char, p); /* Backing memory map */ |
3c8964ba | 38 | char padding[RB_BACKEND_PAGES_PADDING]; |
852c2936 MD |
39 | }; |
40 | ||
4cfec15c | 41 | struct lttng_ust_lib_ring_buffer_backend_subbuffer { |
852c2936 MD |
42 | /* Identifier for subbuf backend pages. Exchanged atomically. */ |
43 | unsigned long id; /* backend subbuffer identifier */ | |
44 | }; | |
45 | ||
1ff31389 JD |
46 | struct lttng_ust_lib_ring_buffer_backend_counts { |
47 | /* | |
48 | * Counter specific to the sub-buffer location within the ring buffer. | |
49 | * The actual sequence number of the packet within the entire ring | |
50 | * buffer can be derived from the formula nr_subbuffers * seq_cnt + | |
51 | * subbuf_idx. | |
52 | */ | |
53 | uint64_t seq_cnt; /* packet sequence number */ | |
54 | }; | |
55 | ||
852c2936 MD |
56 | /* |
57 | * Forward declaration of frontend-specific channel and ring_buffer. | |
58 | */ | |
59 | struct channel; | |
4cfec15c | 60 | struct lttng_ust_lib_ring_buffer; |
852c2936 | 61 | |
4cfec15c MD |
62 | struct lttng_ust_lib_ring_buffer_backend_pages_shmp { |
63 | DECLARE_SHMP(struct lttng_ust_lib_ring_buffer_backend_pages, shmp); | |
1d498196 MD |
64 | }; |
65 | ||
3c8964ba | 66 | #define RB_BACKEND_RING_BUFFER_PADDING 64 |
4cfec15c | 67 | struct lttng_ust_lib_ring_buffer_backend { |
852c2936 | 68 | /* Array of ring_buffer_backend_subbuffer for writer */ |
4cfec15c | 69 | DECLARE_SHMP(struct lttng_ust_lib_ring_buffer_backend_subbuffer, buf_wsb); |
852c2936 | 70 | /* ring_buffer_backend_subbuffer for reader */ |
4cfec15c | 71 | struct lttng_ust_lib_ring_buffer_backend_subbuffer buf_rsb; |
1ff31389 JD |
72 | /* Array of lib_ring_buffer_backend_counts for the packet counter */ |
73 | DECLARE_SHMP(struct lttng_ust_lib_ring_buffer_backend_counts, buf_cnt); | |
852c2936 MD |
74 | /* |
75 | * Pointer array of backend pages, for whole buffer. | |
76 | * Indexed by ring_buffer_backend_subbuffer identifier (id) index. | |
77 | */ | |
4cfec15c | 78 | DECLARE_SHMP(struct lttng_ust_lib_ring_buffer_backend_pages_shmp, array); |
a6352fd4 | 79 | DECLARE_SHMP(char, memory_map); /* memory mapping */ |
852c2936 | 80 | |
a6352fd4 | 81 | DECLARE_SHMP(struct channel, chan); /* Associated channel */ |
852c2936 MD |
82 | int cpu; /* This buffer's cpu. -1 if global. */ |
83 | union v_atomic records_read; /* Number of records read */ | |
7c2caf2b | 84 | unsigned int allocated:1; /* is buffer allocated ? */ |
3c8964ba | 85 | char padding[RB_BACKEND_RING_BUFFER_PADDING]; |
852c2936 MD |
86 | }; |
87 | ||
4cfec15c MD |
88 | struct lttng_ust_lib_ring_buffer_shmp { |
89 | DECLARE_SHMP(struct lttng_ust_lib_ring_buffer, shmp); /* Channel per-cpu buffers */ | |
1d498196 MD |
90 | }; |
91 | ||
3c8964ba | 92 | #define RB_BACKEND_CHANNEL_PADDING 64 |
852c2936 MD |
93 | struct channel_backend { |
94 | unsigned long buf_size; /* Size of the buffer */ | |
95 | unsigned long subbuf_size; /* Sub-buffer size */ | |
96 | unsigned int subbuf_size_order; /* Order of sub-buffer size */ | |
97 | unsigned int num_subbuf_order; /* | |
98 | * Order of number of sub-buffers/buffer | |
99 | * for writer. | |
100 | */ | |
101 | unsigned int buf_size_order; /* Order of buffer size */ | |
7c2caf2b | 102 | unsigned int extra_reader_sb:1; /* has extra reader subbuffer ? */ |
852c2936 | 103 | unsigned long num_subbuf; /* Number of sub-buffers for writer */ |
2fed87ae | 104 | uint64_t start_tsc; /* Channel creation TSC value */ |
a3f61e7f | 105 | DECLARE_SHMP(void *, priv_data);/* Client-specific information */ |
4cfec15c | 106 | struct lttng_ust_lib_ring_buffer_config config; /* Ring buffer configuration */ |
852c2936 | 107 | char name[NAME_MAX]; /* Channel name */ |
3c8964ba | 108 | char padding[RB_BACKEND_CHANNEL_PADDING]; |
4cfec15c | 109 | struct lttng_ust_lib_ring_buffer_shmp buf[]; |
852c2936 MD |
110 | }; |
111 | ||
e92f3e28 | 112 | #endif /* _LTTNG_RING_BUFFER_BACKEND_TYPES_H */ |