GCC Code Coverage Report

Directory: /home/runner/work/fprime/fprime/Fw/Buffer/
File: Buffer.cpp
Date: 2026-09-23 22:12:08
Exec Total Coverage
Lines: 100 143 69.9%
Functions: 14 22 63.6%
Branches: 41 73 56.2%
Line Branch Exec Source
1 // ======================================================================
2 // \title Buffer.cpp
3 // \author mstarch
4 // \brief cpp file for Fw::Buffer implementation
5 //
6 // \copyright
7 // Copyright 2009-2020, by the California Institute of Technology.
8 // ALL RIGHTS RESERVED. United States Government Sponsorship
9 // acknowledged.
10 //
11 // ======================================================================
12 #include <Fw/Buffer/Buffer.hpp>
13 #include <Fw/FPrimeBasicTypes.hpp>
14 #include <Fw/Types/Assert.hpp>
15
16 #if FW_SERIALIZABLE_TO_STRING
17 #include <Fw/Types/String.hpp>
18 #endif
19 #include <cstring>
20
21 namespace Fw {
22
23 3726 Buffer::Buffer()
24 : Serializable(),
25 3726 m_serialize_repr(),
26 3726 m_bufferData(nullptr),
27 3726 m_offset(0),
28 3726 m_size(0),
29 3726 m_capacity(0),
30
1/1
✓ Branch 2 taken 3726 times.
 3726 m_context(0xFFFFFFFF) {}
31
32 4315 Buffer::Buffer(const Buffer& src)
33 : Serializable(),
34 4315 m_serialize_repr(),
35 4315 m_bufferData(src.m_bufferData),
36 4315 m_offset(src.m_offset),
37 4315 m_size(src.m_size),
38 4315 m_capacity(src.m_capacity),
39
1/1
✓ Branch 2 taken 4315 times.
 4315 m_context(src.m_context) {
40
1/2
✓ Branch 0 taken 4315 times.
✗ Branch 1 not taken.
 4315 if (src.m_bufferData != nullptr) {
41
1/1
✓ Branch 1 taken 4315 times.
 4315 this->m_serialize_repr.setExtBuffer(this->m_bufferData + this->m_offset, this->m_size);
42 }
43 4315 }
44
45 1009 Buffer::Buffer(U8* data, FwSizeType size, U32 context)
46 : Serializable(),
47 1009 m_serialize_repr(),
48 1009 m_bufferData(data),
49 1009 m_offset(0),
50 1009 m_size(size),
51 1009 m_capacity(size),
52
1/1
✓ Branch 2 taken 1009 times.
 1009 m_context(context) {
53
1/2
✓ Branch 0 taken 1009 times.
✗ Branch 1 not taken.
 1009 if (m_bufferData != nullptr) {
54
1/1
✓ Branch 1 taken 1009 times.
 1009 this->m_serialize_repr.setExtBuffer(this->m_bufferData, this->m_size);
55 }
56 1009 }
57
58 3002 Buffer& Buffer::operator=(const Buffer& src) {
59 // Ward against self-assignment
60
1/2
✓ Branch 0 taken 3002 times.
✗ Branch 1 not taken.
 3002 if (this != &src) {
61 3002 this->m_bufferData = src.m_bufferData;
62 3002 this->m_offset = src.m_offset;
63 3002 this->m_size = src.m_size;
64 3002 this->m_capacity = src.m_capacity;
65 3002 this->m_context = src.m_context;
66
2/2
✓ Branch 0 taken 2993 times.
✓ Branch 1 taken 9 times.
 3002 if (this->m_bufferData != nullptr) {
67 2993 this->m_serialize_repr.setExtBuffer(this->m_bufferData + this->m_offset, this->m_size);
68 }
69 }
70 3002 return *this;
71 }
72
73 ✗ bool Buffer::operator==(const Buffer& src) const {
74 ✗ return (this->m_bufferData == src.m_bufferData) && (this->m_offset == src.m_offset) &&
75 ✗ (this->m_size == src.m_size) && (this->m_capacity == src.m_capacity) && (this->m_context == src.m_context);
76 }
77
78 3776 bool Buffer::isValid() const {
79
3/4
✓ Branch 0 taken 3536 times.
✓ Branch 1 taken 240 times.
✓ Branch 2 taken 3536 times.
✗ Branch 3 not taken.
 3776 return (this->m_bufferData != nullptr) && (this->m_size > 0);
80 }
81
82 9438 U8* Buffer::getData() const {
83
1/2
✓ Branch 0 taken 9438 times.
✗ Branch 1 not taken.
 9438 return (this->m_bufferData == nullptr) ? nullptr : (this->m_bufferData + this->m_offset);
84 }
85
86 ✗ U8* Buffer::getOriginalData() const {
87 ✗ return this->m_bufferData;
88 }
89
90 12228 FwSizeType Buffer::getSize() const {
91 12228 return this->m_size;
92 }
93
94 ✗ FwSizeType Buffer::getCapacity() const {
95 ✗ return this->m_capacity;
96 }
97
98 ✗ FwSizeType Buffer::getOffset() const {
99 ✗ return this->m_offset;
100 }
101
102 1486 U32 Buffer::getContext() const {
103 1486 return this->m_context;
104 }
105
106 302 void Buffer::advance(const FwSignedSizeType amount) {
107 302 FW_ASSERT(this->m_bufferData != nullptr);
108 // New offset must remain within [0, capacity]
109
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 302 times.
 302 if (amount < 0) {
110 ✗ FW_ASSERT(this->m_offset >= static_cast<FwSizeType>(-amount), static_cast<FwAssertArgType>(this->m_offset),
111 static_cast<FwAssertArgType>(amount));
112 } else {
113 // Advancing must not move past the end of the represented data
114 302 FW_ASSERT(static_cast<FwSizeType>(amount) <= this->m_size, static_cast<FwAssertArgType>(this->m_size),
115 static_cast<FwAssertArgType>(amount));
116 }
117 302 this->m_offset = static_cast<FwSizeType>(static_cast<FwSignedSizeType>(this->m_offset) + amount);
118 // Keep the end of the represented data fixed
119 302 this->m_size = static_cast<FwSizeType>(static_cast<FwSignedSizeType>(this->m_size) - amount);
120 302 FW_ASSERT(this->m_offset + this->m_size <= this->m_capacity, static_cast<FwAssertArgType>(this->m_offset),
121 static_cast<FwAssertArgType>(this->m_size), static_cast<FwAssertArgType>(this->m_capacity));
122 302 this->m_serialize_repr.setExtBuffer(this->m_bufferData + this->m_offset, this->m_size);
123 302 }
124
125 ✗ void Buffer::setData(U8* const data) {
126 ✗ FW_ASSERT(this->m_bufferData != nullptr);
127 ✗ FW_ASSERT(data >= this->m_bufferData && data <= &this->m_bufferData[this->m_capacity]);
128 ✗ this->advance(static_cast<FwSignedSizeType>(data - (this->m_bufferData + this->m_offset)));
129 ✗ }
130
131 3753 void Buffer::setSize(const FwSizeType size) {
132 3753 FW_ASSERT(this->m_offset + size <= this->m_capacity, static_cast<FwAssertArgType>(this->m_offset),
133 static_cast<FwAssertArgType>(size), static_cast<FwAssertArgType>(this->m_capacity));
134 3753 this->m_size = size;
135
1/2
✓ Branch 0 taken 3753 times.
✗ Branch 1 not taken.
 3753 if (m_bufferData != nullptr) {
136 3753 this->m_serialize_repr.setExtBuffer(this->m_bufferData + this->m_offset, this->m_size);
137 }
138 3753 }
139
140 ✗ void Buffer::setContext(const U32 context) {
141 ✗ this->m_context = context;
142 ✗ }
143
144 ✗ void Buffer::set(U8* const data, const FwSizeType size, const U32 context) {
145 ✗ this->m_bufferData = data;
146 ✗ this->m_offset = 0;
147 ✗ this->m_size = size;
148 ✗ this->m_capacity = size;
149 ✗ if (m_bufferData != nullptr) {
150 ✗ this->m_serialize_repr.setExtBuffer(this->m_bufferData, this->m_size);
151 }
152 ✗ this->m_context = context;
153 ✗ }
154
155 945 Fw::ExternalSerializeBufferWithMemberCopy Buffer::getSerializer() {
156
1/2
✓ Branch 1 taken 945 times.
✗ Branch 2 not taken.
 945 if (this->isValid()) {
157
1/1
✓ Branch 1 taken 945 times.
 945 Fw::ExternalSerializeBufferWithMemberCopy esb(this->m_bufferData + this->m_offset, this->m_size);
158
1/1
✓ Branch 1 taken 945 times.
 945 esb.resetSer();
159
1/1
✓ Branch 1 taken 945 times.
 945 return esb;
160 945 } else {
161 ✗ return ExternalSerializeBufferWithMemberCopy();
162 }
163 }
164
165 461 Fw::ExternalSerializeBufferWithMemberCopy Buffer::getDeserializer() {
166
1/2
✓ Branch 1 taken 461 times.
✗ Branch 2 not taken.
 461 if (this->isValid()) {
167
1/1
✓ Branch 1 taken 461 times.
 461 Fw::ExternalSerializeBufferWithMemberCopy esb(this->m_bufferData + this->m_offset, this->m_size);
168
1/1
✓ Branch 1 taken 461 times.
 461 Fw::SerializeStatus stat = esb.setBuffLen(this->m_size);
169 461 FW_ASSERT(stat == Fw::FW_SERIALIZE_OK);
170
1/1
✓ Branch 1 taken 461 times.
 461 return esb;
171 461 } else {
172 ✗ return ExternalSerializeBufferWithMemberCopy();
173 }
174 }
175
176 717 Fw::SerializeStatus Buffer::serializeTo(Fw::SerialBufferBase& buffer, Fw::Endianness mode) const {
177 Fw::SerializeStatus stat;
178 717 stat = buffer.serializeFrom(reinterpret_cast<PlatformPointerCastType>(this->m_bufferData), mode);
179
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
180 ✗ return stat;
181 }
182 717 stat = buffer.serializeFrom(this->m_size, mode);
183
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
184 ✗ return stat;
185 }
186 717 stat = buffer.serializeFrom(this->m_context, mode);
187
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
188 ✗ return stat;
189 }
190 717 stat = buffer.serializeFrom(this->m_offset, mode);
191
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
192 ✗ return stat;
193 }
194 717 stat = buffer.serializeFrom(this->m_capacity, mode);
195
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
196 ✗ return stat;
197 }
198 717 return stat;
199 }
200
201 717 Fw::SerializeStatus Buffer::deserializeFrom(Fw::SerialBufferBase& buffer, Fw::Endianness mode) {
202 Fw::SerializeStatus stat;
203 PlatformPointerCastType pointer;
204
1/1
✓ Branch 1 taken 717 times.
 717 stat = buffer.deserializeTo(pointer, mode);
205
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
206 ✗ return stat;
207 }
208 717 this->m_bufferData = reinterpret_cast<U8*>(pointer);
209
210
1/1
✓ Branch 1 taken 717 times.
 717 stat = buffer.deserializeTo(this->m_size, mode);
211
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
212 ✗ return stat;
213 }
214
1/1
✓ Branch 1 taken 717 times.
 717 stat = buffer.deserializeTo(this->m_context, mode);
215
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
216 ✗ return stat;
217 }
218
1/1
✓ Branch 1 taken 717 times.
 717 stat = buffer.deserializeTo(this->m_offset, mode);
219
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
220 ✗ return stat;
221 }
222
1/1
✓ Branch 1 taken 717 times.
 717 stat = buffer.deserializeTo(this->m_capacity, mode);
223
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 717 times.
 717 if (stat != Fw::FW_SERIALIZE_OK) {
224 ✗ return stat;
225 }
226
227
1/2
✓ Branch 0 taken 717 times.
✗ Branch 1 not taken.
 717 if (this->m_bufferData != nullptr) {
228
1/1
✓ Branch 1 taken 717 times.
 717 this->m_serialize_repr.setExtBuffer(this->m_bufferData + this->m_offset, this->m_size);
229 }
230 717 return stat;
231 }
232
233 #if FW_SERIALIZABLE_TO_STRING
234 ✗ void Buffer::toString(Fw::StringBase& text) const {
235 static const char* formatString = "(data = %p, size = %u, context = %u, offset = %u, capacity = %u)";
236 ✗ (void)text.format(formatString, this->m_bufferData, this->m_size, this->m_context, this->m_offset,
237 ✗ this->m_capacity); // display string may safely truncate
238 ✗ }
239 #endif
240
241 #ifdef BUILD_UT
242 std::ostream& operator<<(std::ostream& os, const Buffer& obj) {
243 Fw::String str;
244 obj.toString(str);
245 os << str.toChar();
246 return os;
247 }
248 #endif
249
250 } // end namespace Fw
251