-
Notifications
You must be signed in to change notification settings - Fork 743
/
SequenceNumber.h
421 lines (360 loc) · 9.59 KB
/
SequenceNumber.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* @file SequenceNumber.h
*/
#ifndef _FASTDDS_RPTS_ELEM_SEQNUM_H_
#define _FASTDDS_RPTS_ELEM_SEQNUM_H_
#include <algorithm>
#include <cassert>
#include <limits>
#include <vector>
#include <fastrtps/fastrtps_dll.h>
#include <fastrtps/utils/fixed_size_bitmap.hpp>
#include <fastdds/rtps/common/Types.h>
namespace eprosima {
namespace fastrtps {
namespace rtps {
//!@brief Structure SequenceNumber_t, different for each change in the same writer.
//!@ingroup COMMON_MODULE
struct RTPS_DllAPI SequenceNumber_t
{
//!
int32_t high = 0;
//!
uint32_t low = 0;
//!Default constructor
SequenceNumber_t() noexcept
{
high = 0;
low = 0;
}
/*!
* @param hi
* @param lo
*/
SequenceNumber_t(
int32_t hi,
uint32_t lo) noexcept
: high(hi)
, low(lo)
{
}
/*!
* @param u
*/
explicit
SequenceNumber_t(
uint64_t u) noexcept
: high(static_cast<int32_t>(u >> 32u))
, low(static_cast<uint32_t>(u))
{
}
/*! Convert the number to 64 bit.
* @return 64 bit representation of the SequenceNumber
*/
uint64_t to64long() const noexcept
{
return (static_cast<uint64_t>(high) << 32u) + low;
}
//! Increase SequenceNumber in 1.
SequenceNumber_t& operator ++() noexcept
{
++low;
if (low == 0)
{
assert(std::numeric_limits<decltype(high)>::max() > high);
++high;
}
return *this;
}
SequenceNumber_t operator ++(
int) noexcept
{
SequenceNumber_t result(*this);
++(*this);
return result;
}
/**
* Increase SequenceNumber.
* @param inc Number to add to the SequenceNumber
*/
SequenceNumber_t& operator +=(
int inc) noexcept
{
assert(inc >= 0);
uint32_t aux_low = low;
low += static_cast<uint32_t>(inc);
if (low < aux_low)
{
// Being the type of the parameter an 'int', the increment of 'high' will be as much as 1.
assert(std::numeric_limits<decltype(high)>::max() > high);
++high;
}
return *this;
}
static SequenceNumber_t unknown() noexcept
{
return { -1, 0 };
}
};
#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
/**
* Compares two SequenceNumber_t.
* @param sn1 First SequenceNumber_t to compare
* @param sn2 Second SequenceNumber_t to compare
* @return True if equal
*/
inline bool operator ==(
const SequenceNumber_t& sn1,
const SequenceNumber_t& sn2) noexcept
{
return (sn1.low == sn2.low) && (sn1.high == sn2.high);
}
/**
* Compares two SequenceNumber_t.
* @param sn1 First SequenceNumber_t to compare
* @param sn2 Second SequenceNumber_t to compare
* @return True if not equal
*/
inline bool operator !=(
const SequenceNumber_t& sn1,
const SequenceNumber_t& sn2) noexcept
{
return (sn1.low != sn2.low) || (sn1.high != sn2.high);
}
/**
* Checks if a SequenceNumber_t is greater than other.
* @param seq1 First SequenceNumber_t to compare
* @param seq2 Second SequenceNumber_t to compare
* @return True if the first SequenceNumber_t is greater than the second
*/
inline bool operator >(
const SequenceNumber_t& seq1,
const SequenceNumber_t& seq2) noexcept
{
if (seq1.high == seq2.high)
{
return seq1.low > seq2.low;
}
return seq1.high > seq2.high;
}
/**
* Checks if a SequenceNumber_t is less than other.
* @param seq1 First SequenceNumber_t to compare
* @param seq2 Second SequenceNumber_t to compare
* @return True if the first SequenceNumber_t is less than the second
*/
inline bool operator <(
const SequenceNumber_t& seq1,
const SequenceNumber_t& seq2) noexcept
{
if (seq1.high == seq2.high)
{
return seq1.low < seq2.low;
}
return seq1.high < seq2.high;
}
/**
* Checks if a SequenceNumber_t is greater or equal than other.
* @param seq1 First SequenceNumber_t to compare
* @param seq2 Second SequenceNumber_t to compare
* @return True if the first SequenceNumber_t is greater or equal than the second
*/
inline bool operator >=(
const SequenceNumber_t& seq1,
const SequenceNumber_t& seq2) noexcept
{
if (seq1.high == seq2.high)
{
return seq1.low >= seq2.low;
}
return seq1.high > seq2.high;
}
/**
* Checks if a SequenceNumber_t is less or equal than other.
* @param seq1 First SequenceNumber_t to compare
* @param seq2 Second SequenceNumber_t to compare
* @return True if the first SequenceNumber_t is less or equal than the second
*/
inline bool operator <=(
const SequenceNumber_t& seq1,
const SequenceNumber_t& seq2) noexcept
{
if (seq1.high == seq2.high)
{
return seq1.low <= seq2.low;
}
return seq1.high < seq2.high;
}
/**
* Subtract one uint32_t from a SequenceNumber_t
* @param seq Base SequenceNumber_t
* @param inc uint32_t to subtract
* @return Result of the subtraction
*/
inline SequenceNumber_t operator -(
const SequenceNumber_t& seq,
const uint32_t inc) noexcept
{
SequenceNumber_t res(seq.high, seq.low - inc);
if (inc > seq.low)
{
// Being the type of the parameter an 'uint32_t', the decrement of 'high' will be as much as 1.
assert(0 < res.high);
--res.high;
}
return res;
}
/**
* Add one uint32_t to a SequenceNumber_t
* @param[in] seq Base sequence number
* @param inc value to add to the base
* @return Result of the addition
*/
inline SequenceNumber_t operator +(
const SequenceNumber_t& seq,
const uint32_t inc) noexcept
{
SequenceNumber_t res(seq.high, seq.low + inc);
if (res.low < seq.low)
{
// Being the type of the parameter an 'uint32_t', the increment of 'high' will be as much as 1.
assert(std::numeric_limits<decltype(res.high)>::max() > res.high);
++res.high;
}
return res;
}
/**
* Subtract one SequenceNumber_t to another
* @param minuend Minuend. Has to be greater than or equal to subtrahend.
* @param subtrahend Subtrahend.
* @return Result of the subtraction
*/
inline SequenceNumber_t operator -(
const SequenceNumber_t& minuend,
const SequenceNumber_t& subtrahend) noexcept
{
assert(minuend >= subtrahend);
SequenceNumber_t res(minuend.high - subtrahend.high, minuend.low - subtrahend.low);
if (minuend.low < subtrahend.low)
{
assert(0 < res.high);
--res.high;
}
return res;
}
#endif // ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
const SequenceNumber_t c_SequenceNumber_Unknown{-1, 0};
#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
/**
* Sorts two instances of SequenceNumber_t
* @param s1 First SequenceNumber_t to compare
* @param s2 First SequenceNumber_t to compare
* @return True if s1 is less than s2
*/
inline bool sort_seqNum(
const SequenceNumber_t& s1,
const SequenceNumber_t& s2) noexcept
{
return s1 < s2;
}
/**
*
* @param output
* @param seqNum
* @return
*/
inline std::ostream& operator <<(
std::ostream& output,
const SequenceNumber_t& seqNum)
{
return output << seqNum.to64long();
}
inline std::ostream& operator <<(
std::ostream& output,
const std::vector<SequenceNumber_t>& seqNumSet)
{
for (const SequenceNumber_t& sn : seqNumSet)
{
output << sn << " ";
}
return output;
}
/*!
* @brief Defines the STL hash function for type SequenceNumber_t.
*/
struct SequenceNumberHash
{
std::size_t operator ()(
const SequenceNumber_t& sequence_number) const noexcept
{
return static_cast<std::size_t>(sequence_number.to64long());
}
};
struct SequenceNumberDiff
{
uint32_t operator ()(
const SequenceNumber_t& a,
const SequenceNumber_t& b) const noexcept
{
SequenceNumber_t diff = a - b;
return diff.low;
}
};
#endif // ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
//!Structure SequenceNumberSet_t, contains a group of sequencenumbers.
//!@ingroup COMMON_MODULE
using SequenceNumberSet_t = BitmapRange<SequenceNumber_t, SequenceNumberDiff, 256>;
#ifndef DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
/**
* Prints a sequence Number set
* @param output Output Stream
* @param sns SequenceNumber set
* @return OStream.
*/
inline std::ostream& operator <<(
std::ostream& output,
const SequenceNumberSet_t& sns)
{
output << sns.base().to64long() << ":";
sns.for_each([&output](
SequenceNumber_t it)
{
output << it.to64long() << "-";
});
return output;
}
/**
*
* @param input
* @param seqNum
* @return
*/
inline std::istream& operator >>(
std::istream& input,
SequenceNumber_t& seqNum)
{
uint64_t aux;
if (input >> aux)
{
seqNum = SequenceNumber_t(aux);
}
return input;
}
#endif // DOXYGEN_SHOULD_SKIP_THIS_PUBLIC
} // namespace rtps
} // namespace fastrtps
} // namespace eprosima
#endif /* _FASTDDS_RTPS_ELEM_SEQNUM_H_ */