GCC Code Coverage Report

Directory: Utils/Types/
File: CircularBuffer.cpp
Date: 2026-09-03 21:18:40
Exec Total Coverage
Lines: 127 145 87.6%
Functions: 24 24 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 24 CircularBuffer ::CircularBuffer()
22 24 : m_store(nullptr), m_store_size(0), m_head_idx(0), m_allocated_size(0), m_high_water_mark(0) {}
23
24 12 CircularBuffer ::CircularBuffer(U8* const buffer, const FwSizeType size)
25 12 : m_store(nullptr), m_store_size(0), m_head_idx(0), m_allocated_size(0), m_high_water_mark(0) {
26 12 setup(buffer, size);
27 12 }
28
29 36 void CircularBuffer ::setup(U8* const buffer, const FwSizeType size) {
30 36 FW_ASSERT(size > 0);
31 36 FW_ASSERT(buffer != nullptr);
32 36 FW_ASSERT(m_store == nullptr && m_store_size == 0); // Not already setup
33
34 // Initialize buffer data
35 36 m_store = buffer;
36 36 m_store_size = size;
37 36 m_head_idx = 0;
38 36 m_allocated_size = 0;
39 36 m_high_water_mark = 0;
40 36 }
41
42 15739 FwSizeType CircularBuffer ::get_allocated_size() const {
43 15739 return m_allocated_size;
44 }
45
46 10952 FwSizeType CircularBuffer ::get_free_size() const {
47 10952 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
48 10952 FW_ASSERT(m_allocated_size <= m_store_size, static_cast<FwAssertArgType>(m_allocated_size));
49 10952 return m_store_size - m_allocated_size;
50 }
51
52 652642 FwSizeType CircularBuffer ::advance_idx(FwSizeType idx, FwSizeType amount) const {
53 652642 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
54
1/2
✗ Branch 2 not taken.
✓ Branch 3 taken 652642 times.
 652642 return (idx + amount) % m_store_size;
55 }
56
57 10222 Fw::SerializeStatus CircularBuffer ::serialize(const U8* const buffer, const FwSizeType size) {
58 10222 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
59 10222 FW_ASSERT(buffer != nullptr);
60 // Check there is sufficient space
61
2/2
✓ Branch 2 taken 245 times.
✓ Branch 3 taken 9977 times.
 10222 if (size > get_free_size()) {
62 245 return Fw::FW_SERIALIZE_NO_ROOM_LEFT;
63 }
64 // Copy in all the supplied data
65 9977 FwSizeType idx = advance_idx(m_head_idx, m_allocated_size);
66
2/2
✓ Branch 0 taken 582980 times.
✓ Branch 1 taken 9977 times.
 592957 for (FwSizeType i = 0; i < size; i++) {
67 582980 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
68 582980 m_store[idx] = buffer[i];
69 582980 idx = advance_idx(idx);
70 }
71 9977 m_allocated_size += size;
72 9977 FW_ASSERT(m_allocated_size <= this->get_capacity(), static_cast<FwAssertArgType>(m_allocated_size));
73
2/2
✓ Branch 4 taken 5212 times.
✓ Branch 5 taken 4765 times.
 9977 m_high_water_mark = (m_high_water_mark > m_allocated_size) ? m_high_water_mark : m_allocated_size;
74 9977 return Fw::FW_SERIALIZE_OK;
75 }
76
77 template <typename T>
78 264 Fw::SerializeStatus CircularBuffer ::serialize_impl(const T& serializable, const FwSizeType size) {
79 264 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 132 times.
✓ Branch 4 taken 2 times.
✓ Branch 5 taken 130 times.
 264 if (size > get_free_size()) {
82 4 return Fw::FW_SERIALIZE_NO_ROOM_LEFT;
83 }
84
1/1
✓ Branch 6 taken 130 times.
 260 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 130 times.
 260 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 130 times.
 260 Fw::ExternalSerializeBuffer slot(&m_store[idx], size);
99
1/1
✓ Branch 2 taken 130 times.
 260 const Fw::SerializeStatus status = slot.serializeFrom(serializable);
100
2/2
✓ Branch 0 taken 1 times.
✓ Branch 1 taken 129 times.
 260 if (status != Fw::FW_SERIALIZE_OK) {
101 2 return status;
102 }
103 258 m_allocated_size += size;
104 258 FW_ASSERT(m_allocated_size <= this->get_capacity(), static_cast<FwAssertArgType>(m_allocated_size));
105
1/2
✗ Branch 4 not taken.
✓ Branch 5 taken 129 times.
 258 m_high_water_mark = (m_high_water_mark > m_allocated_size) ? m_high_water_mark : m_allocated_size;
106 258 return Fw::FW_SERIALIZE_OK;
107 260 }
108
109 76 Fw::SerializeStatus CircularBuffer ::serialize(const Fw::Serializable& serializable, const FwSizeType size) {
110 76 return this->serialize_impl(serializable, size);
111 }
112
113 56 Fw::SerializeStatus CircularBuffer ::serialize(const Fw::LinearBufferBase& buffer, const FwSizeType size) {
114 56 return this->serialize_impl(buffer, size);
115 }
116
117 69 Fw::SerializeStatus CircularBuffer ::peek(char& value, FwSizeType offset) const {
118 69 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
119 69 return peek(reinterpret_cast<U8&>(value), offset);
120 }
121
122 103 Fw::SerializeStatus CircularBuffer ::peek(U8& value, FwSizeType offset) const {
123 103 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 64 times.
✓ Branch 3 taken 39 times.
 103 if ((sizeof(U8) + offset) > m_allocated_size) {
126 64 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
127 }
128 39 const FwSizeType idx = advance_idx(m_head_idx, offset);
129 39 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
130 39 value = m_store[idx];
131 39 return Fw::FW_SERIALIZE_OK;
132 }
133
134 45 Fw::SerializeStatus CircularBuffer ::peek(U32& value, FwSizeType offset) const {
135 45 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 21 times.
✓ Branch 3 taken 24 times.
 45 if ((sizeof(U32) + offset) > m_allocated_size) {
138 21 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
139 }
140 24 value = 0;
141 24 FwSizeType idx = advance_idx(m_head_idx, offset);
142
143 // Deserialize all the bytes from network format
144
2/2
✓ Branch 0 taken 96 times.
✓ Branch 1 taken 24 times.
 120 for (FwSizeType i = 0; i < sizeof(U32); i++) {
145 96 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
146 96 value = (value << 8) | static_cast<U32>(m_store[idx]);
147 96 idx = advance_idx(idx);
148 }
149 24 return Fw::FW_SERIALIZE_OK;
150 }
151
152 17454 Fw::SerializeStatus CircularBuffer ::peek(U8* buffer, FwSizeType size, FwSizeType offset) const {
153 17454 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
154 17454 FW_ASSERT(buffer != nullptr);
155 // Check there is sufficient data
156
2/2
✓ Branch 2 taken 7711 times.
✓ Branch 3 taken 9743 times.
 17454 if ((size + offset) > m_allocated_size) {
157 7711 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
158 }
159 9743 FwSizeType idx = advance_idx(m_head_idx, offset);
160 // Deserialize all the bytes from network format
161
2/2
✓ Branch 0 taken 41923 times.
✓ Branch 1 taken 9743 times.
 51666 for (FwSizeType i = 0; i < size; i++) {
162 41923 FW_ASSERT(idx < m_store_size, static_cast<FwAssertArgType>(idx));
163 41923 buffer[i] = m_store[idx];
164 41923 idx = advance_idx(idx);
165 }
166 9743 return Fw::FW_SERIALIZE_OK;
167 }
168
169 template <typename T>
170 246 Fw::SerializeStatus CircularBuffer ::peek_impl(T& serializable, FwSizeType size, FwSizeType offset) const {
171 246 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 121 times.
 246 if ((size + offset) > m_allocated_size) {
174 4 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
175 }
176
1/1
✓ Branch 4 taken 121 times.
 242 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 121 times.
 242 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 121 times.
 242 Fw::ExternalSerializeBuffer slot(&m_store[idx], size);
193
1/1
✓ Branch 2 taken 121 times.
 242 Fw::SerializeStatus status = slot.setBuffLen(size);
194 242 FW_ASSERT(status == Fw::FW_SERIALIZE_OK, static_cast<FwAssertArgType>(status));
195
1/1
✓ Branch 2 taken 121 times.
 242 return slot.deserializeTo(serializable);
196 242 }
197
198 68 Fw::SerializeStatus CircularBuffer ::peek(Fw::Serializable& serializable, FwSizeType size, FwSizeType offset) const {
199 68 return this->peek_impl(serializable, size, offset);
200 }
201
202 55 Fw::SerializeStatus CircularBuffer ::peek(Fw::LinearBufferBase& buffer, FwSizeType size, FwSizeType offset) const {
203 55 return this->peek_impl(buffer, size, offset);
204 }
205
206 7735 Fw::SerializeStatus CircularBuffer ::rotate(FwSizeType amount) {
207 7735 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 126 times.
✓ Branch 3 taken 7609 times.
 7735 if (amount > m_allocated_size) {
210 126 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
211 }
212 7609 m_head_idx = advance_idx(m_head_idx, amount);
213 7609 m_allocated_size -= amount;
214 7609 return Fw::FW_SERIALIZE_OK;
215 }
216
217 2618 Fw::SerializeStatus CircularBuffer ::trim(FwSizeType amount) {
218 2618 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 134 times.
✓ Branch 3 taken 2484 times.
 2618 if (amount > m_allocated_size) {
221 134 return Fw::FW_DESERIALIZE_BUFFER_EMPTY;
222 }
223 // Simply reduce the allocated size without moving the head
224 2484 m_allocated_size -= amount;
225 2484 return Fw::FW_SERIALIZE_OK;
226 }
227
228 10106 FwSizeType CircularBuffer ::get_capacity() const {
229 10106 FW_ASSERT(m_store != nullptr && m_store_size != 0); // setup method was called
230 10106 return m_store_size;
231 }
232
233 10102 FwSizeType CircularBuffer ::get_high_water_mark() const {
234 10102 return m_high_water_mark;
235 }
236
237 1059 void CircularBuffer ::clear_high_water_mark() {
238 1059 m_high_water_mark = 0;
239 1059 }
240
241 } // End Namespace Types
242