GCC Code Coverage Report

Directory: ./
File: Utils/Types/CircularBuffer.cpp
Date: 2026-10-14 21:15:02
Exec Total Coverage
Lines: 128 146 87.7%
Functions: 25 25 100.0%
Branches: 38 53 71.7%
Line Branch Exec Source
1 /*
2 * CircularBuffer.cpp:
3 *
4 * Buffer used to efficiently store data in ring data structure. Uses an externally supplied
5 * data store as the backing for this buffer. Thus it is dependent on receiving sole ownership
6 * of the supplied buffer.
7 *
8 * This implementation file contains the function definitions.
9 *
10 * Created on: Apr 4, 2019
11 * Author: lestarch
12 * Revised March 2022
13 * Author: bocchino
14 */
15 #include <Fw/FPrimeBasicTypes.hpp>
16 #include <Fw/Types/Assert.hpp>
17 #include <Utils/Types/CircularBuffer.hpp>
18
19 namespace Types {
20
21 1213 CircularBuffer ::CircularBuffer()
22 1213 : m_store(nullptr), m_store_size(0), m_head_idx(0), m_allocated_size(0), m_high_water_mark(0) {}
23
24 28 CircularBuffer ::CircularBuffer(U8* const buffer, const FwSizeType size)
25 28 : m_store(nullptr), m_store_size(0), m_head_idx(0), m_allocated_size(0), m_high_water_mark(0) {
26 28 setup(buffer, size);
27 28 }
28
29 1212 void CircularBuffer ::setup(U8* const buffer, const FwSizeType size) {
30 1212 FW_ASSERT(size > 0);
31 1212 FW_ASSERT(buffer != nullptr);
32 1212 FW_ASSERT(m_store == nullptr && m_store_size == 0); // Not already setup
33
34 // Initialize buffer data
35 1212 m_store = buffer;
36 1212 m_store_size = size;
37 1212 m_head_idx = 0;
38 1212 m_allocated_size = 0;
39 1212 m_high_water_mark = 0;
40 1212 }
41
42 20246 FwSizeType CircularBuffer ::get_allocated_size() const {
43 20246 return m_allocated_size;
44 }
45
46 15233 FwSizeType CircularBuffer ::get_free_size() const {
47 15233 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
48 15233 FW_ASSERT(m_allocated_size <= m_store_size, static_cast<FwAssertArgType>(m_allocated_size));
49 15233 return m_store_size - m_allocated_size;
50 }
51
52 1790162 FwSizeType CircularBuffer ::advance_idx(FwSizeType idx, FwSizeType amount) const {
53 1790162 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
54
1/2
✗ Branch 2 not taken.
✓ Branch 3 taken 1790162 times.
 1790162 return (idx + amount) % m_store_size;
55 }
56
57 14397 Fw::SerializeStatus CircularBuffer ::serialize(const U8* const buffer, const FwSizeType size) {
58 14397 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
59 14397 FW_ASSERT(buffer != nullptr);
60 // Check there is sufficient space
61
2/2
✓ Branch 2 taken 264 times.
✓ Branch 3 taken 14133 times.
 14397 if (size > get_free_size()) {
62 264 return Fw::FW_SERIALIZE_NO_ROOM_LEFT;
63 }
64 // Copy in all the supplied data
65 14133 FwSizeType idx = advance_idx(m_head_idx, m_allocated_size);
66
2/2
✓ Branch 0 taken 1127088 times.
✓ Branch 1 taken 14133 times.
 1141221 for (FwSizeType i = 0; i < size; i++) {
67 1127088 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
68 1127088 m_store[idx] = buffer[i];
69 1127088 idx = advance_idx(idx);
70 }
71 14133 m_allocated_size += size;
72 14133 FW_ASSERT(m_allocated_size <= this->get_capacity(), static_cast<FwAssertArgType>(m_allocated_size));
73
2/2
✓ Branch 4 taken 8351 times.
✓ Branch 5 taken 5782 times.
 14133 m_high_water_mark = (m_high_water_mark > m_allocated_size) ? m_high_water_mark : m_allocated_size;
74 14133 return Fw::FW_SERIALIZE_OK;
75 }
76
77 template <typename T>
78 398 Fw::SerializeStatus CircularBuffer ::serialize_impl(const T& serializable, const FwSizeType size) {
79 398 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
80 // Check there is sufficient space
81
3/3
✓ Branch 2 taken 199 times.
✓ Branch 4 taken 14 times.
✓ Branch 5 taken 185 times.
 398 if (size > get_free_size()) {
82 28 return Fw::FW_SERIALIZE_NO_ROOM_LEFT;
83 }
84
1/1
✓ Branch 6 taken 185 times.
 370 const FwSizeType idx = advance_idx(m_head_idx, m_allocated_size);
85 // Wrapping slot: serialize into a stack staging buffer, then byte-copy in with wrap-around
86
1/2
✗ Branch 2 not taken.
✓ Branch 3 taken 185 times.
 370 if ((idx + size) > m_store_size) {
87 ✗ FW_ASSERT(size <= STAGING_BUFFER_SIZE, static_cast<FwAssertArgType>(size),
88 static_cast<FwAssertArgType>(STAGING_BUFFER_SIZE));
89 ✗ U8 staging[STAGING_BUFFER_SIZE > 0 ? STAGING_BUFFER_SIZE : 1] = {};
90 ✗ Fw::ExternalSerializeBuffer stagingBuffer(staging, size);
91 ✗ const Fw::SerializeStatus stagingStatus = stagingBuffer.serializeFrom(serializable);
92 ✗ if (stagingStatus != Fw::FW_SERIALIZE_OK) {
93 ✗ return stagingStatus;
94 }
95 ✗ return this->serialize(staging, size);
96 ✗ }
97 // Linear slot: serialize directly into the store
98
1/1
✓ Branch 4 taken 185 times.
 370 Fw::ExternalSerializeBuffer slot(&m_store[idx], size);
99
1/1
✓ Branch 2 taken 185 times.
 370 const Fw::SerializeStatus status = slot.serializeFrom(serializable);
100
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 184 times.
 370 if (status != Fw::FW_SERIALIZE_OK) {
101 2 return status;
102 }
103 368 m_allocated_size += size;
104 368 FW_ASSERT(m_allocated_size <= this->get_capacity(), static_cast<FwAssertArgType>(m_allocated_size));
105
1/2
✗ Branch 4 not taken.
✓ Branch 5 taken 184 times.
 368 m_high_water_mark = (m_high_water_mark > m_allocated_size) ? m_high_water_mark : m_allocated_size;
106 368 return Fw::FW_SERIALIZE_OK;
107 370 }
108
109 99 Fw::SerializeStatus CircularBuffer ::serialize(const Fw::Serializable& serializable, const FwSizeType size) {
110 99 return this->serialize_impl(serializable, size);
111 }
112
113 100 Fw::SerializeStatus CircularBuffer ::serialize(const Fw::LinearBufferBase& buffer, const FwSizeType size) {
114 100 return this->serialize_impl(buffer, size);
115 }
116
117 41 Fw::SerializeStatus CircularBuffer ::peek(char& value, FwSizeType offset) const {
118 41 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
119 41 return peek(reinterpret_cast<U8&>(value), offset);
120 }
121
122 550577 Fw::SerializeStatus CircularBuffer ::peek(U8& value, FwSizeType offset) const {
123 550577 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
124 // Check there is sufficient data
125
2/2
✓ Branch 2 taken 48 times.
✓ Branch 3 taken 550529 times.
 550577 if ((sizeof(U8) + offset) > m_allocated_size) {
126 48 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
127 }
128 550529 const FwSizeType idx = advance_idx(m_head_idx, offset);
129 550529 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
130 550529 value = m_store[idx];
131 550529 return Fw::FW_SERIALIZE_OK;
132 }
133
134 76 Fw::SerializeStatus CircularBuffer ::peek(U32& value, FwSizeType offset) const {
135 76 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
136 // Check there is sufficient data
137
2/2
✓ Branch 2 taken 34 times.
✓ Branch 3 taken 42 times.
 76 if ((sizeof(U32) + offset) > m_allocated_size) {
138 34 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
139 }
140 42 value = 0;
141 42 FwSizeType idx = advance_idx(m_head_idx, offset);
142
143 // Deserialize all the bytes from network format
144
2/2
✓ Branch 0 taken 168 times.
✓ Branch 1 taken 42 times.
 210 for (FwSizeType i = 0; i < sizeof(U32); i++) {
145 168 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
146 168 value = (value << 8) | static_cast<U32>(m_store[idx]);
147 168 idx = advance_idx(idx);
148 }
149 42 return Fw::FW_SERIALIZE_OK;
150 }
151
152 21552 Fw::SerializeStatus CircularBuffer ::peek(U8* buffer, FwSizeType size, FwSizeType offset) const {
153 21552 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
154 21552 FW_ASSERT(buffer != nullptr);
155 // Check there is sufficient data
156
2/2
✓ Branch 2 taken 7718 times.
✓ Branch 3 taken 13834 times.
 21552 if ((size + offset) > m_allocated_size) {
157 7718 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
158 }
159 13834 FwSizeType idx = advance_idx(m_head_idx, offset);
160 // Deserialize all the bytes from network format
161
2/2
✓ Branch 0 taken 74232 times.
✓ Branch 1 taken 13834 times.
 88066 for (FwSizeType i = 0; i < size; i++) {
162 74232 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
163 74232 buffer[i] = m_store[idx];
164 74232 idx = advance_idx(idx);
165 }
166 13834 return Fw::FW_SERIALIZE_OK;
167 }
168
169 template <typename T>
170 352 Fw::SerializeStatus CircularBuffer ::peek_impl(T& serializable, FwSizeType size, FwSizeType offset) const {
171 352 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
172 // Check there is sufficient data
173
2/2
✓ Branch 2 taken 2 times.
✓ Branch 3 taken 174 times.
 352 if ((size + offset) > m_allocated_size) {
174 4 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
175 }
176
1/1
✓ Branch 4 taken 174 times.
 348 const FwSizeType idx = advance_idx(m_head_idx, offset);
177 // Wrapping slot: byte-copy out with wrap-around into a stack staging buffer, then deserialize
178
1/2
✗ Branch 2 not taken.
✓ Branch 3 taken 174 times.
 348 if ((idx + size) > m_store_size) {
179 ✗ FW_ASSERT(size <= STAGING_BUFFER_SIZE, static_cast<FwAssertArgType>(size),
180 static_cast<FwAssertArgType>(STAGING_BUFFER_SIZE));
181 ✗ U8 staging[STAGING_BUFFER_SIZE > 0 ? STAGING_BUFFER_SIZE : 1];
182 ✗ const Fw::SerializeStatus peekStatus = this->peek(staging, size, offset);
183 ✗ if (peekStatus != Fw::FW_SERIALIZE_OK) {
184 ✗ return peekStatus;
185 }
186 ✗ Fw::ExternalSerializeBuffer stagingBuffer(staging, size);
187 ✗ const Fw::SerializeStatus status = stagingBuffer.setBuffLen(size);
188 ✗ FW_ASSERT(status == Fw::FW_SERIALIZE_OK, static_cast<FwAssertArgType>(status));
189 ✗ return stagingBuffer.deserializeTo(serializable);
190 ✗ }
191 // Linear slot: deserialize directly from the store
192
1/1
✓ Branch 4 taken 174 times.
 348 Fw::ExternalSerializeBuffer slot(&m_store[idx], size);
193
1/1
✓ Branch 2 taken 174 times.
 348 Fw::SerializeStatus status = slot.setBuffLen(size);
194 348 FW_ASSERT(status == Fw::FW_SERIALIZE_OK, static_cast<FwAssertArgType>(status));
195
1/1
✓ Branch 2 taken 174 times.
 348 return slot.deserializeTo(serializable);
196 348 }
197
198 88 Fw::SerializeStatus CircularBuffer ::peek(Fw::Serializable& serializable, FwSizeType size, FwSizeType offset) const {
199 88 return this->peek_impl(serializable, size, offset);
200 }
201
202 88 Fw::SerializeStatus CircularBuffer ::peek(Fw::LinearBufferBase& buffer, FwSizeType size, FwSizeType offset) const {
203 88 return this->peek_impl(buffer, size, offset);
204 }
205
206 9912 Fw::SerializeStatus CircularBuffer ::rotate(FwSizeType amount) {
207 9912 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
208 // Check there is sufficient data
209
2/2
✓ Branch 2 taken 135 times.
✓ Branch 3 taken 9777 times.
 9912 if (amount > m_allocated_size) {
210 135 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
211 }
212 9777 m_head_idx = advance_idx(m_head_idx, amount);
213 9777 m_allocated_size -= amount;
214 9777 return Fw::FW_SERIALIZE_OK;
215 }
216
217 2681 Fw::SerializeStatus CircularBuffer ::trim(FwSizeType amount) {
218 2681 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
219 // Check there is sufficient data
220
2/2
✓ Branch 2 taken 122 times.
✓ Branch 3 taken 2559 times.
 2681 if (amount > m_allocated_size) {
221 122 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
222 }
223 // Simply reduce the allocated size without moving the head
224 2559 m_allocated_size -= amount;
225 2559 return Fw::FW_SERIALIZE_OK;
226 }
227
228 16473 FwSizeType CircularBuffer ::get_capacity() const {
229 16473 return m_store_size;
230 }
231
232 10013 FwSizeType CircularBuffer ::get_high_water_mark() const {
233 10013 return m_high_water_mark;
234 }
235
236 989 void CircularBuffer ::clear_high_water_mark() {
237 989 m_high_water_mark = 0;
238 989 }
239
240 1079 U8* CircularBuffer ::get_buffer() {
241 1079 return m_store;
242 }
243
244 } // End Namespace Types
245