Commit | Line | Data |
---|---|---|
852c2936 | 1 | /* |
c0c0989a | 2 | * SPDX-License-Identifier: LGPL-2.1-only |
852c2936 | 3 | * |
e92f3e28 MD |
4 | * Copyright (C) 2008-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
5 | * | |
c0c0989a | 6 | * Ring buffer backend (types). |
852c2936 MD |
7 | */ |
8 | ||
c0c0989a MJ |
9 | #ifndef _LTTNG_RING_BUFFER_BACKEND_TYPES_H |
10 | #define _LTTNG_RING_BUFFER_BACKEND_TYPES_H | |
11 | ||
2fed87ae | 12 | #include <limits.h> |
fb31eb73 | 13 | #include <stdint.h> |
1d498196 | 14 | #include "shm_internal.h" |
a3bb4b27 | 15 | #include "vatomic.h" |
852c2936 | 16 | |
3c8964ba | 17 | #define RB_BACKEND_PAGES_PADDING 16 |
b5457df5 | 18 | struct lttng_ust_ring_buffer_backend_pages { |
852c2936 MD |
19 | unsigned long mmap_offset; /* offset of the subbuffer in mmap */ |
20 | union v_atomic records_commit; /* current records committed count */ | |
21 | union v_atomic records_unread; /* records to read */ | |
22 | unsigned long data_size; /* Amount of data to read from subbuf */ | |
a6352fd4 | 23 | DECLARE_SHMP(char, p); /* Backing memory map */ |
3c8964ba | 24 | char padding[RB_BACKEND_PAGES_PADDING]; |
852c2936 MD |
25 | }; |
26 | ||
b5457df5 | 27 | struct lttng_ust_ring_buffer_backend_subbuffer { |
852c2936 MD |
28 | /* Identifier for subbuf backend pages. Exchanged atomically. */ |
29 | unsigned long id; /* backend subbuffer identifier */ | |
30 | }; | |
31 | ||
b5457df5 | 32 | struct lttng_ust_ring_buffer_backend_counts { |
1ff31389 JD |
33 | /* |
34 | * Counter specific to the sub-buffer location within the ring buffer. | |
35 | * The actual sequence number of the packet within the entire ring | |
36 | * buffer can be derived from the formula nr_subbuffers * seq_cnt + | |
37 | * subbuf_idx. | |
38 | */ | |
39 | uint64_t seq_cnt; /* packet sequence number */ | |
40 | }; | |
41 | ||
852c2936 MD |
42 | /* |
43 | * Forward declaration of frontend-specific channel and ring_buffer. | |
44 | */ | |
b5457df5 MD |
45 | struct lttng_ust_ring_buffer_channel; |
46 | struct lttng_ust_ring_buffer; | |
852c2936 | 47 | |
b5457df5 MD |
48 | struct lttng_ust_ring_buffer_backend_pages_shmp { |
49 | DECLARE_SHMP(struct lttng_ust_ring_buffer_backend_pages, shmp); | |
1d498196 MD |
50 | }; |
51 | ||
3c8964ba | 52 | #define RB_BACKEND_RING_BUFFER_PADDING 64 |
b5457df5 | 53 | struct lttng_ust_ring_buffer_backend { |
852c2936 | 54 | /* Array of ring_buffer_backend_subbuffer for writer */ |
b5457df5 | 55 | DECLARE_SHMP(struct lttng_ust_ring_buffer_backend_subbuffer, buf_wsb); |
852c2936 | 56 | /* ring_buffer_backend_subbuffer for reader */ |
b5457df5 | 57 | struct lttng_ust_ring_buffer_backend_subbuffer buf_rsb; |
1ff31389 | 58 | /* Array of lib_ring_buffer_backend_counts for the packet counter */ |
b5457df5 | 59 | DECLARE_SHMP(struct lttng_ust_ring_buffer_backend_counts, buf_cnt); |
852c2936 MD |
60 | /* |
61 | * Pointer array of backend pages, for whole buffer. | |
62 | * Indexed by ring_buffer_backend_subbuffer identifier (id) index. | |
63 | */ | |
b5457df5 | 64 | DECLARE_SHMP(struct lttng_ust_ring_buffer_backend_pages_shmp, array); |
a6352fd4 | 65 | DECLARE_SHMP(char, memory_map); /* memory mapping */ |
852c2936 | 66 | |
b5457df5 | 67 | DECLARE_SHMP(struct lttng_ust_ring_buffer_channel, chan); /* Associated channel */ |
852c2936 MD |
68 | int cpu; /* This buffer's cpu. -1 if global. */ |
69 | union v_atomic records_read; /* Number of records read */ | |
7c2caf2b | 70 | unsigned int allocated:1; /* is buffer allocated ? */ |
3c8964ba | 71 | char padding[RB_BACKEND_RING_BUFFER_PADDING]; |
852c2936 MD |
72 | }; |
73 | ||
b5457df5 MD |
74 | struct lttng_ust_ring_buffer_shmp { |
75 | DECLARE_SHMP(struct lttng_ust_ring_buffer, shmp); /* Channel per-cpu buffers */ | |
1d498196 MD |
76 | }; |
77 | ||
3c8964ba | 78 | #define RB_BACKEND_CHANNEL_PADDING 64 |
852c2936 MD |
79 | struct channel_backend { |
80 | unsigned long buf_size; /* Size of the buffer */ | |
81 | unsigned long subbuf_size; /* Sub-buffer size */ | |
82 | unsigned int subbuf_size_order; /* Order of sub-buffer size */ | |
83 | unsigned int num_subbuf_order; /* | |
84 | * Order of number of sub-buffers/buffer | |
85 | * for writer. | |
86 | */ | |
87 | unsigned int buf_size_order; /* Order of buffer size */ | |
7c2caf2b | 88 | unsigned int extra_reader_sb:1; /* has extra reader subbuffer ? */ |
852c2936 | 89 | unsigned long num_subbuf; /* Number of sub-buffers for writer */ |
373ea80a | 90 | uint64_t start_timestamp; /* Channel creation timestamp value */ |
a3f61e7f | 91 | DECLARE_SHMP(void *, priv_data);/* Client-specific information */ |
b5457df5 | 92 | struct lttng_ust_ring_buffer_config config; /* Ring buffer configuration */ |
852c2936 | 93 | char name[NAME_MAX]; /* Channel name */ |
3c8964ba | 94 | char padding[RB_BACKEND_CHANNEL_PADDING]; |
b5457df5 | 95 | struct lttng_ust_ring_buffer_shmp buf[]; |
852c2936 MD |
96 | }; |
97 | ||
e92f3e28 | 98 | #endif /* _LTTNG_RING_BUFFER_BACKEND_TYPES_H */ |