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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
#pragma once
#include <stdint.h>
#include <algorithm>
#include <concepts>
#include <initializer_list>
#include <optional>
#include <ranges>
#include <span>
#include <string>
#include <string_view>
#include <tuple>
#include <utility>
#include <vector>
#include <version>
#include "wpi/DataLog_c.h"
#include "wpi/DenseMap.h"
#include "wpi/SmallVector.h"
#include "wpi/StringMap.h"
#include "wpi/mutex.h"
#include "wpi/protobuf/Protobuf.h"
#include "wpi/string.h"
#include "wpi/struct/Struct.h"
#include "wpi/timestamp.h"
namespace wpi {
class Logger;
} // namespace wpi
namespace wpi::log {
namespace impl {
enum ControlRecordType {
kControlStart = 0,
kControlFinish,
kControlSetMetadata
};
} // namespace impl
/**
* A data log for high-speed writing of data values.
*
* The lifetime of the data log object must be longer than any data log entry
* objects that refer to it.
*
* Finish() is needed only to indicate in the log that a particular entry is
* no longer being used (it releases the name to ID mapping). Finish() is not
* required to be called for data to be flushed to disk; entries in the log
* are written as Append() calls are being made. In fact, Finish() does not
* need to be called at all; this is helpful to avoid shutdown races where the
* DataLog object might be destroyed before other objects. It's often not a
* good idea to call Finish() from destructors for this reason.
*
* DataLog calls are thread safe. DataLog uses a typical multiple-supplier,
* single-consumer setup. Writes to the log are atomic, but there is no
* guaranteed order in the log when multiple threads are writing to it;
* whichever thread grabs the write mutex first will get written first.
* For this reason (as well as the fact that timestamps can be set to
* arbitrary values), records in the log are not guaranteed to be sorted by
* timestamp.
*/
class DataLog {
public:
virtual ~DataLog() = default;
DataLog(const DataLog&) = delete;
DataLog& operator=(const DataLog&) = delete;
DataLog(DataLog&&) = delete;
DataLog& operator=(const DataLog&&) = delete;
/**
* Explicitly flushes the log data to disk.
*/
virtual void Flush() = 0;
/**
* Pauses appending of data records to the log. While paused, no data records
* are saved (e.g. AppendX is a no-op). Has no effect on entry starts /
* finishes / metadata changes.
*/
virtual void Pause();
/**
* Resumes appending of data records to the log.
*/
virtual void Resume();
/**
* Stops appending start/metadata/schema records to the log.
*/
virtual void Stop();
/**
* Returns whether there is a data schema already registered with the given
* name.
*
* @param name Name (the string passed as the data type for records using this
* schema)
* @return True if schema already registered
*/
bool HasSchema(std::string_view name) const;
/**
* Registers a data schema. Data schemas provide information for how a
* certain data type string can be decoded. The type string of a data schema
* indicates the type of the schema itself (e.g. "protobuf" for protobuf
* schemas, "struct" for struct schemas, etc). In the data log, schemas are
* saved just like normal records, with the name being generated from the
* provided name: "/.schema/<name>". Duplicate calls to this function with
* the same name are silently ignored.
*
* @param name Name (the string passed as the data type for records using this
* schema)
* @param type Type of schema (e.g. "protobuf", "struct", etc)
* @param schema Schema data
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AddSchema(std::string_view name, std::string_view type,
std::span<const uint8_t> schema, int64_t timestamp = 0);
/**
* Registers a data schema. Data schemas provide information for how a
* certain data type string can be decoded. The type string of a data schema
* indicates the type of the schema itself (e.g. "protobuf" for protobuf
* schemas, "struct" for struct schemas, etc). In the data log, schemas are
* saved just like normal records, with the name being generated from the
* provided name: "/.schema/<name>". Duplicate calls to this function with
* the same name are silently ignored.
*
* @param name Name (the string passed as the data type for records using this
* schema)
* @param type Type of schema (e.g. "protobuf", "struct", etc)
* @param schema Schema data
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AddSchema(std::string_view name, std::string_view type,
std::string_view schema, int64_t timestamp = 0) {
AddSchema(
name, type,
std::span<const uint8_t>{
reinterpret_cast<const uint8_t*>(schema.data()), schema.size()},
timestamp);
}
/**
* Registers a protobuf schema. Duplicate calls to this function with the same
* name are silently ignored.
*
* @tparam T protobuf serializable type
* @param msg protobuf message
* @param timestamp Time stamp (0 to indicate now)
*/
template <ProtobufSerializable T>
void AddProtobufSchema(ProtobufMessage<T>& msg, int64_t timestamp = 0) {
if (timestamp == 0) {
timestamp = Now();
}
msg.ForEachProtobufDescriptor(
[this](auto typeString) { return HasSchema(typeString); },
[this, timestamp](auto typeString, auto schema) {
AddSchema(typeString, "proto:FileDescriptorProto", schema, timestamp);
});
}
/**
* Registers a struct schema. Duplicate calls to this function with the same
* name are silently ignored.
*
* @tparam T struct serializable type
* @param info optional struct type info
* @param timestamp Time stamp (0 to indicate now)
*/
template <typename T, typename... I>
requires StructSerializable<T, I...>
void AddStructSchema(const I&... info, int64_t timestamp = 0) {
if (timestamp == 0) {
timestamp = Now();
}
ForEachStructSchema<T>(
[this, timestamp](auto typeString, auto schema) {
this->AddSchema(typeString, "structschema", schema, timestamp);
},
info...);
}
/**
* Start an entry. Duplicate names are allowed (with the same type), and
* result in the same index being returned (Start/Finish are reference
* counted). A duplicate name with a different type will result in an error
* message being printed to the console and 0 being returned (which will be
* ignored by the Append functions).
*
* @param name Name
* @param type Data type
* @param metadata Initial metadata (e.g. data properties)
* @param timestamp Time stamp (may be 0 to indicate now)
*
* @return Entry index
*/
int Start(std::string_view name, std::string_view type,
std::string_view metadata = {}, int64_t timestamp = 0);
/**
* Finish an entry.
*
* @param entry Entry index
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Finish(int entry, int64_t timestamp = 0);
/**
* Updates the metadata for an entry.
*
* @param entry Entry index
* @param metadata New metadata for the entry
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void SetMetadata(int entry, std::string_view metadata, int64_t timestamp = 0);
/**
* Appends a raw record to the log.
*
* @param entry Entry index, as returned by Start()
* @param data Byte array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendRaw(int entry, std::span<const uint8_t> data, int64_t timestamp);
/**
* Appends a raw record to the log.
*
* @param entry Entry index, as returned by Start()
* @param data Byte array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendRaw2(int entry, std::span<const std::span<const uint8_t>> data,
int64_t timestamp);
/**
* Appends a boolean record to the log.
*
* @param entry Entry index, as returned by Start()
* @param value Boolean value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendBoolean(int entry, bool value, int64_t timestamp);
/**
* Appends an integer record to the log.
*
* @param entry Entry index, as returned by Start()
* @param value Integer value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendInteger(int entry, int64_t value, int64_t timestamp);
/**
* Appends a float record to the log.
*
* @param entry Entry index, as returned by Start()
* @param value Float value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendFloat(int entry, float value, int64_t timestamp);
/**
* Appends a double record to the log.
*
* @param entry Entry index, as returned by Start()
* @param value Double value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendDouble(int entry, double value, int64_t timestamp);
/**
* Appends a string record to the log.
*
* @param entry Entry index, as returned by Start()
* @param value String value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendString(int entry, std::string_view value, int64_t timestamp);
/**
* Appends a boolean array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr Boolean array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendBooleanArray(int entry, std::span<const bool> arr,
int64_t timestamp);
/**
* Appends a boolean array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr Boolean array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendBooleanArray(int entry, std::span<const int> arr,
int64_t timestamp);
/**
* Appends a boolean array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr Boolean array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendBooleanArray(int entry, std::span<const uint8_t> arr,
int64_t timestamp);
/**
* Appends an integer array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr Integer array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendIntegerArray(int entry, std::span<const int64_t> arr,
int64_t timestamp);
/**
* Appends a float array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr Float array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendFloatArray(int entry, std::span<const float> arr,
int64_t timestamp);
/**
* Appends a double array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr Double array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendDoubleArray(int entry, std::span<const double> arr,
int64_t timestamp);
/**
* Appends a string array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr String array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendStringArray(int entry, std::span<const std::string> arr,
int64_t timestamp);
/**
* Appends a string array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr String array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendStringArray(int entry, std::span<const std::string_view> arr,
int64_t timestamp);
/**
* Appends a string array record to the log.
*
* @param entry Entry index, as returned by Start()
* @param arr String array to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void AppendStringArray(int entry, std::span<const struct WPI_String> arr,
int64_t timestamp);
protected:
static constexpr size_t kBlockSize = 16 * 1024;
static wpi::Logger s_defaultMessageLog;
class Buffer {
public:
explicit Buffer(size_t alloc = kBlockSize)
: m_buf{new uint8_t[alloc]}, m_maxLen{alloc} {}
~Buffer() { delete[] m_buf; }
Buffer(const Buffer&) = delete;
Buffer& operator=(const Buffer&) = delete;
Buffer(Buffer&& oth)
: m_buf{oth.m_buf}, m_len{oth.m_len}, m_maxLen{oth.m_maxLen} {
oth.m_buf = nullptr;
oth.m_len = 0;
oth.m_maxLen = 0;
}
Buffer& operator=(Buffer&& oth) {
if (m_buf) {
delete[] m_buf;
}
m_buf = oth.m_buf;
m_len = oth.m_len;
m_maxLen = oth.m_maxLen;
oth.m_buf = nullptr;
oth.m_len = 0;
oth.m_maxLen = 0;
return *this;
}
uint8_t* Reserve(size_t size) {
assert(size <= GetRemaining());
uint8_t* rv = m_buf + m_len;
m_len += size;
return rv;
}
void Unreserve(size_t size) { m_len -= size; }
void Clear() { m_len = 0; }
size_t GetRemaining() const { return m_maxLen - m_len; }
std::span<uint8_t> GetData() { return {m_buf, m_len}; }
std::span<const uint8_t> GetData() const { return {m_buf, m_len}; }
private:
uint8_t* m_buf;
size_t m_len = 0;
size_t m_maxLen;
};
/**
* Constructs the log. StartFile() must be called to actually start the
* file output.
*
* @param msglog message logger (will be called from separate thread)
* @param extraHeader extra header metadata
*/
explicit DataLog(wpi::Logger& msglog, std::string_view extraHeader = "")
: m_msglog{msglog}, m_extraHeader{extraHeader} {}
/**
* Starts the log. Appends file header and Start records and schema data
* values for all previously started entries and schemas. No effect unless
* the data log is currently stopped.
*/
void StartFile();
/**
* Provides complete set of all buffers that need to be written.
*
* Any existing contents of writeBufs will be released as if ReleaseBufs()
* was called prior to this call.
*
* Returned buffers should provided back via ReleaseBufs() after the write is
* complete.
*
* @param writeBufs buffers to be written (output)
*/
void FlushBufs(std::vector<Buffer>* writeBufs);
/**
* Releases memory for a set of buffers back to the internal buffer pool.
*
* @param bufs buffers; empty on return
*/
void ReleaseBufs(std::vector<Buffer>* bufs);
/**
* Called when internal buffers are half the maximum count. Called with
* internal mutex held; do not call any other DataLog functions from this
* function.
*/
virtual void BufferHalfFull();
/**
* Called when internal buffers reach the maximum count. Called with internal
* mutex held; do not call any other DataLog functions from this function.
*
* @return true if log should be paused (don't call PauseLog)
*/
virtual bool BufferFull() = 0;
private:
static constexpr size_t kMaxBufferCount = 1024 * 1024 / kBlockSize;
static constexpr size_t kMaxFreeCount = 256 * 1024 / kBlockSize;
// must be called with m_mutex held
int StartImpl(std::string_view name, std::string_view type,
std::string_view metadata, int64_t timestamp);
uint8_t* StartRecord(uint32_t entry, uint64_t timestamp, uint32_t payloadSize,
size_t reserveSize);
uint8_t* Reserve(size_t size);
void AppendImpl(std::span<const uint8_t> data);
void AppendStringImpl(std::string_view str);
void AppendStartRecord(int id, std::string_view name, std::string_view type,
std::string_view metadata, int64_t timestamp);
void DoReleaseBufs(std::vector<Buffer>* bufs);
protected:
wpi::Logger& m_msglog;
private:
mutable wpi::mutex m_mutex;
bool m_active = false;
bool m_paused = false;
std::string m_extraHeader;
std::vector<Buffer> m_free;
std::vector<Buffer> m_outgoing;
struct EntryInfo {
std::string type;
std::vector<uint8_t> schemaData; // only set for schema entries
int id{0};
};
wpi::StringMap<EntryInfo> m_entries;
struct EntryInfo2 {
std::string metadata;
unsigned int count;
};
wpi::DenseMap<int, EntryInfo2> m_entryIds;
int m_lastId = 0;
};
/**
* Log entry base class.
*/
class DataLogEntry {
protected:
DataLogEntry() = default;
DataLogEntry(DataLog& log, std::string_view name, std::string_view type,
std::string_view metadata = {}, int64_t timestamp = 0)
: m_log{&log}, m_entry{log.Start(name, type, metadata, timestamp)} {}
public:
DataLogEntry(const DataLogEntry&) = delete;
DataLogEntry& operator=(const DataLogEntry&) = delete;
DataLogEntry(DataLogEntry&& rhs) : m_log{rhs.m_log}, m_entry{rhs.m_entry} {
rhs.m_log = nullptr;
}
DataLogEntry& operator=(DataLogEntry&& rhs) {
if (m_log) {
m_log->Finish(m_entry);
}
m_log = rhs.m_log;
rhs.m_log = nullptr;
m_entry = rhs.m_entry;
return *this;
}
explicit operator bool() const { return m_log != nullptr; }
/**
* Updates the metadata for the entry.
*
* @param metadata New metadata for the entry
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void SetMetadata(std::string_view metadata, int64_t timestamp = 0) {
m_log->SetMetadata(m_entry, metadata, timestamp);
}
/**
* Finishes the entry.
*
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Finish(int64_t timestamp = 0) { m_log->Finish(m_entry, timestamp); }
protected:
DataLog* m_log = nullptr;
int m_entry = 0;
};
template <typename T>
class DataLogValueEntryImpl : public DataLogEntry {
protected:
DataLogValueEntryImpl() = default;
DataLogValueEntryImpl(DataLog& log, std::string_view name,
std::string_view type, std::string_view metadata = {},
int64_t timestamp = 0)
: DataLogEntry{log, name, type, metadata, timestamp} {}
public:
DataLogValueEntryImpl(DataLogValueEntryImpl&& rhs)
: DataLogEntry{std::move(rhs)} {
std::scoped_lock lock{rhs.m_mutex};
m_lastValue = std::move(rhs.m_lastValue);
}
DataLogValueEntryImpl& operator=(DataLogValueEntryImpl&& rhs) {
DataLogEntry::operator=(std::move(rhs));
std::scoped_lock lock{m_mutex, rhs.m_mutex};
m_lastValue = std::move(rhs.m_lastValue);
return *this;
}
/**
* Gets whether there is a last value.
*
* @note The last value is local to this class instance and updated only with
* Update(), not Append().
*
* @return True if last value exists, false otherwise.
*/
bool HasLastValue() const { return m_lastValue.has_value(); }
/**
* Gets the last value.
*
* @note The last value is local to this class instance and updated only with
* Update(), not Append().
*
* @return Last value (empty if no last value)
*/
std::optional<T> GetLastValue() const {
std::scoped_lock lock{m_mutex};
return m_lastValue;
}
protected:
mutable wpi::mutex m_mutex;
std::optional<T> m_lastValue;
};
/**
* Log arbitrary byte data.
*/
class RawLogEntry : public DataLogValueEntryImpl<std::vector<uint8_t>> {
public:
static constexpr std::string_view kDataType = "raw";
RawLogEntry() = default;
RawLogEntry(DataLog& log, std::string_view name, int64_t timestamp = 0)
: RawLogEntry{log, name, {}, kDataType, timestamp} {}
RawLogEntry(DataLog& log, std::string_view name, std::string_view metadata,
int64_t timestamp = 0)
: RawLogEntry{log, name, metadata, kDataType, timestamp} {}
RawLogEntry(DataLog& log, std::string_view name, std::string_view metadata,
std::string_view type, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, type, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const uint8_t> data, int64_t timestamp = 0) {
m_log->AppendRaw(m_entry, data, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const uint8_t> data, int64_t timestamp = 0);
};
/**
* Log boolean values.
*/
class BooleanLogEntry : public DataLogValueEntryImpl<bool> {
public:
static constexpr std::string_view kDataType = "boolean";
BooleanLogEntry() = default;
BooleanLogEntry(DataLog& log, std::string_view name, int64_t timestamp = 0)
: BooleanLogEntry{log, name, {}, timestamp} {}
BooleanLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(bool value, int64_t timestamp = 0) {
m_log->AppendBoolean(m_entry, value, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(bool value, int64_t timestamp = 0) {
std::scoped_lock lock{m_mutex};
if (m_lastValue != value) {
m_lastValue = value;
Append(value, timestamp);
}
}
};
/**
* Log integer values.
*/
class IntegerLogEntry : public DataLogValueEntryImpl<int64_t> {
public:
static constexpr std::string_view kDataType = "int64";
IntegerLogEntry() = default;
IntegerLogEntry(DataLog& log, std::string_view name, int64_t timestamp = 0)
: IntegerLogEntry{log, name, {}, timestamp} {}
IntegerLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(int64_t value, int64_t timestamp = 0) {
m_log->AppendInteger(m_entry, value, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(int64_t value, int64_t timestamp = 0) {
std::scoped_lock lock{m_mutex};
if (m_lastValue != value) {
m_lastValue = value;
Append(value, timestamp);
}
}
};
/**
* Log float values.
*/
class FloatLogEntry : public DataLogValueEntryImpl<float> {
public:
static constexpr std::string_view kDataType = "float";
FloatLogEntry() = default;
FloatLogEntry(DataLog& log, std::string_view name, int64_t timestamp = 0)
: FloatLogEntry{log, name, {}, timestamp} {}
FloatLogEntry(DataLog& log, std::string_view name, std::string_view metadata,
int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(float value, int64_t timestamp = 0) {
m_log->AppendFloat(m_entry, value, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(float value, int64_t timestamp = 0) {
std::scoped_lock lock{m_mutex};
if (m_lastValue != value) {
m_lastValue = value;
Append(value, timestamp);
}
}
};
/**
* Log double values.
*/
class DoubleLogEntry : public DataLogValueEntryImpl<double> {
public:
static constexpr std::string_view kDataType = "double";
DoubleLogEntry() = default;
DoubleLogEntry(DataLog& log, std::string_view name, int64_t timestamp = 0)
: DoubleLogEntry{log, name, {}, timestamp} {}
DoubleLogEntry(DataLog& log, std::string_view name, std::string_view metadata,
int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(double value, int64_t timestamp = 0) {
m_log->AppendDouble(m_entry, value, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(double value, int64_t timestamp = 0) {
std::scoped_lock lock{m_mutex};
if (m_lastValue != value) {
m_lastValue = value;
Append(value, timestamp);
}
}
};
/**
* Log string values.
*/
class StringLogEntry : public DataLogValueEntryImpl<std::string> {
public:
static constexpr const char* kDataType = "string";
StringLogEntry() = default;
StringLogEntry(DataLog& log, std::string_view name, int64_t timestamp = 0)
: StringLogEntry{log, name, {}, kDataType, timestamp} {}
StringLogEntry(DataLog& log, std::string_view name, std::string_view metadata,
int64_t timestamp = 0)
: StringLogEntry{log, name, metadata, kDataType, timestamp} {}
StringLogEntry(DataLog& log, std::string_view name, std::string_view metadata,
std::string_view type, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, type, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::string_view value, int64_t timestamp = 0) {
m_log->AppendString(m_entry, value, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param value Value to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::string_view value, int64_t timestamp = 0) {
std::scoped_lock lock{m_mutex};
if (m_lastValue != value) {
m_lastValue = value;
Append(value, timestamp);
}
}
};
/**
* Log array of boolean values.
*/
class BooleanArrayLogEntry : public DataLogValueEntryImpl<std::vector<int>> {
public:
static constexpr const char* kDataType = "boolean[]";
BooleanArrayLogEntry() = default;
BooleanArrayLogEntry(DataLog& log, std::string_view name,
int64_t timestamp = 0)
: BooleanArrayLogEntry{log, name, {}, timestamp} {}
BooleanArrayLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log. For find functions to work, timestamp
* must be monotonically increasing.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const bool> arr, int64_t timestamp = 0) {
m_log->AppendBooleanArray(m_entry, arr, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::initializer_list<bool> arr, int64_t timestamp = 0) {
Append(std::span{arr.begin(), arr.end()}, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const int> arr, int64_t timestamp = 0) {
m_log->AppendBooleanArray(m_entry, arr, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::initializer_list<int> arr, int64_t timestamp = 0) {
Append(std::span{arr.begin(), arr.end()}, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const uint8_t> arr, int64_t timestamp = 0) {
m_log->AppendBooleanArray(m_entry, arr, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const bool> arr, int64_t timestamp = 0);
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::initializer_list<bool> arr, int64_t timestamp = 0) {
Update(std::span{arr.begin(), arr.end()}, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const int> arr, int64_t timestamp = 0);
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::initializer_list<int> arr, int64_t timestamp = 0) {
Update(std::span{arr.begin(), arr.end()}, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const uint8_t> arr, int64_t timestamp = 0);
};
/**
* Log array of integer values.
*/
class IntegerArrayLogEntry
: public DataLogValueEntryImpl<std::vector<int64_t>> {
public:
static constexpr const char* kDataType = "int64[]";
IntegerArrayLogEntry() = default;
IntegerArrayLogEntry(DataLog& log, std::string_view name,
int64_t timestamp = 0)
: IntegerArrayLogEntry{log, name, {}, timestamp} {}
IntegerArrayLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const int64_t> arr, int64_t timestamp = 0) {
m_log->AppendIntegerArray(m_entry, arr, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::initializer_list<int64_t> arr, int64_t timestamp = 0) {
Append({arr.begin(), arr.end()}, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const int64_t> arr, int64_t timestamp = 0);
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::initializer_list<int64_t> arr, int64_t timestamp = 0) {
Update({arr.begin(), arr.end()}, timestamp);
}
};
/**
* Log array of float values.
*/
class FloatArrayLogEntry : public DataLogValueEntryImpl<std::vector<float>> {
public:
static constexpr const char* kDataType = "float[]";
FloatArrayLogEntry() = default;
FloatArrayLogEntry(DataLog& log, std::string_view name, int64_t timestamp = 0)
: FloatArrayLogEntry{log, name, {}, timestamp} {}
FloatArrayLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const float> arr, int64_t timestamp = 0) {
m_log->AppendFloatArray(m_entry, arr, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::initializer_list<float> arr, int64_t timestamp = 0) {
Append({arr.begin(), arr.end()}, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const float> arr, int64_t timestamp = 0);
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::initializer_list<float> arr, int64_t timestamp = 0) {
Update({arr.begin(), arr.end()}, timestamp);
}
};
/**
* Log array of double values.
*/
class DoubleArrayLogEntry : public DataLogValueEntryImpl<std::vector<double>> {
public:
static constexpr const char* kDataType = "double[]";
DoubleArrayLogEntry() = default;
DoubleArrayLogEntry(DataLog& log, std::string_view name,
int64_t timestamp = 0)
: DoubleArrayLogEntry{log, name, {}, timestamp} {}
DoubleArrayLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const double> arr, int64_t timestamp = 0) {
m_log->AppendDoubleArray(m_entry, arr, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::initializer_list<double> arr, int64_t timestamp = 0) {
Append({arr.begin(), arr.end()}, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const double> arr, int64_t timestamp = 0);
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::initializer_list<double> arr, int64_t timestamp = 0) {
Update({arr.begin(), arr.end()}, timestamp);
}
};
/**
* Log array of string values.
*/
class StringArrayLogEntry
: public DataLogValueEntryImpl<std::vector<std::string>> {
public:
static constexpr const char* kDataType = "string[]";
StringArrayLogEntry() = default;
StringArrayLogEntry(DataLog& log, std::string_view name,
int64_t timestamp = 0)
: StringArrayLogEntry{log, name, {}, timestamp} {}
StringArrayLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, int64_t timestamp = 0)
: DataLogValueEntryImpl{log, name, kDataType, metadata, timestamp} {}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const std::string> arr, int64_t timestamp = 0) {
m_log->AppendStringArray(m_entry, arr, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const std::string_view> arr, int64_t timestamp = 0) {
m_log->AppendStringArray(m_entry, arr, timestamp);
}
/**
* Appends a record to the log.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::initializer_list<std::string_view> arr,
int64_t timestamp = 0) {
Append(std::span<const std::string_view>{arr.begin(), arr.end()},
timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const std::string> arr, int64_t timestamp = 0);
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const std::string_view> arr, int64_t timestamp = 0);
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param arr Values to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::initializer_list<std::string_view> arr,
int64_t timestamp = 0) {
Update(std::span<const std::string_view>{arr.begin(), arr.end()},
timestamp);
}
};
/**
* Log raw struct serializable objects.
*/
template <typename T, typename... I>
requires StructSerializable<T, I...>
class StructLogEntry : public DataLogEntry {
using S = Struct<T, I...>;
public:
StructLogEntry() = default;
StructLogEntry(DataLog& log, std::string_view name, I... info,
int64_t timestamp = 0)
: StructLogEntry{log, name, {}, std::move(info)..., timestamp} {}
StructLogEntry(DataLog& log, std::string_view name, std::string_view metadata,
I... info, int64_t timestamp = 0)
: m_info{std::move(info)...} {
m_log = &log;
log.AddStructSchema<T, I...>(info..., timestamp);
m_entry =
log.Start(name, GetStructTypeString<T>(info...), metadata, timestamp);
}
StructLogEntry(StructLogEntry&& rhs)
: DataLogEntry{std::move(rhs)}, m_info{std::move(rhs.m_info)} {
std::scoped_lock lock{rhs.m_mutex};
m_lastValue = std::move(rhs.m_lastValue);
}
StructLogEntry& operator=(StructLogEntry&& rhs) {
DataLogEntry::operator=(std::move(rhs));
m_info = std::move(rhs.m_info);
std::scoped_lock lock{m_mutex, rhs.m_mutex};
m_lastValue = std::move(rhs.m_lastValue);
return *this;
}
/**
* Appends a record to the log.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(const T& data, int64_t timestamp = 0) {
if constexpr (sizeof...(I) == 0) {
if constexpr (wpi::is_constexpr([] { S::GetSize(); })) {
uint8_t buf[S::GetSize()];
S::Pack(buf, data);
m_log->AppendRaw(m_entry, buf, timestamp);
return;
}
}
wpi::SmallVector<uint8_t, 128> buf;
buf.resize_for_overwrite(std::apply(S::GetSize, m_info));
std::apply([&](const I&... info) { S::Pack(buf, data, info...); }, m_info);
m_log->AppendRaw(m_entry, buf, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(const T& data, int64_t timestamp = 0) {
if constexpr (sizeof...(I) == 0) {
if constexpr (wpi::is_constexpr([] { S::GetSize(); })) {
uint8_t buf[S::GetSize()];
S::Pack(buf, data);
std::scoped_lock lock{m_mutex};
if (m_lastValue.empty() ||
!std::equal(buf, buf + S::GetSize(), m_lastValue.begin(),
m_lastValue.end())) {
m_lastValue.assign(buf, buf + S::GetSize());
m_log->AppendRaw(m_entry, buf, timestamp);
}
return;
}
}
wpi::SmallVector<uint8_t, 128> buf;
buf.resize_for_overwrite(std::apply(S::GetSize, m_info));
std::apply([&](const I&... info) { S::Pack(buf, data, info...); }, m_info);
std::scoped_lock lock{m_mutex};
if (m_lastValue.empty() ||
!std::equal(buf.begin(), buf.end(), m_lastValue.begin(),
m_lastValue.end())) {
m_lastValue.assign(buf.begin(), buf.end());
m_log->AppendRaw(m_entry, buf, timestamp);
}
}
/**
* Gets whether there is a last value.
*
* @note The last value is local to this class instance and updated only with
* Update(), not Append().
*
* @return True if last value exists, false otherwise.
*/
bool HasLastValue() const { return !m_lastValue.empty(); }
/**
* Gets the last value.
*
* @note The last value is local to this class instance and updated only with
* Update(), not Append().
*
* @return Last value (empty if no last value)
*/
std::optional<T> GetLastValue() const {
std::scoped_lock lock{m_mutex};
if (m_lastValue.empty()) {
return std::nullopt;
}
return std::apply(
[&](const I&... info) { return S::Unpack(m_lastValue, info...); },
m_info);
}
private:
mutable wpi::mutex m_mutex;
std::vector<uint8_t> m_lastValue;
[[no_unique_address]]
std::tuple<I...> m_info;
};
/**
* Log raw struct serializable array of objects.
*/
template <typename T, typename... I>
requires StructSerializable<T, I...>
class StructArrayLogEntry : public DataLogEntry {
using S = Struct<T, I...>;
public:
StructArrayLogEntry() = default;
StructArrayLogEntry(DataLog& log, std::string_view name, I... info,
int64_t timestamp = 0)
: StructArrayLogEntry{log, name, {}, std::move(info)..., timestamp} {}
StructArrayLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, I... info,
int64_t timestamp = 0)
: m_info{std::move(info)...} {
m_log = &log;
log.AddStructSchema<T, I...>(info..., timestamp);
m_entry = log.Start(
name, MakeStructArrayTypeString<T, std::dynamic_extent>(info...),
metadata, timestamp);
}
StructArrayLogEntry(StructArrayLogEntry&& rhs)
: DataLogEntry{std::move(rhs)},
m_buf{std::move(rhs.m_buf)},
m_info{std::move(rhs.m_info)} {
std::scoped_lock lock{rhs.m_mutex};
m_lastValue = std::move(rhs.m_lastValue);
}
StructArrayLogEntry& operator=(StructArrayLogEntry&& rhs) {
DataLogEntry::operator=(std::move(rhs));
m_buf = std::move(rhs.m_buf);
m_info = std::move(rhs.m_info);
std::scoped_lock lock{m_mutex, rhs.m_mutex};
m_lastValue = std::move(rhs.m_lastValue);
return *this;
}
/**
* Appends a record to the log.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
template <typename U>
#if __cpp_lib_ranges >= 201911L
requires std::ranges::range<U> &&
std::convertible_to<std::ranges::range_value_t<U>, T>
#endif
void Append(U&& data, int64_t timestamp = 0) {
std::apply(
[&](const I&... info) {
m_buf.Write(
std::forward<U>(data),
[&](auto bytes) { m_log->AppendRaw(m_entry, bytes, timestamp); },
info...);
},
m_info);
}
/**
* Appends a record to the log.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(std::span<const T> data, int64_t timestamp = 0) {
std::apply(
[&](const I&... info) {
m_buf.Write(
data,
[&](auto bytes) { m_log->AppendRaw(m_entry, bytes, timestamp); },
info...);
},
m_info);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(std::span<const T> data, int64_t timestamp = 0) {
std::apply(
[&](const I&... info) {
m_buf.Write(
data,
[&](auto bytes) {
std::scoped_lock lock{m_mutex};
if (!m_lastValue.has_value()) {
m_lastValue = std::vector(bytes.begin(), bytes.end());
m_log->AppendRaw(m_entry, bytes, timestamp);
} else if (!std::equal(bytes.begin(), bytes.end(),
m_lastValue->begin(),
m_lastValue->end())) {
m_lastValue->assign(bytes.begin(), bytes.end());
m_log->AppendRaw(m_entry, bytes, timestamp);
}
},
info...);
},
m_info);
}
/**
* Gets whether there is a last value.
*
* @note The last value is local to this class instance and updated only with
* Update(), not Append().
*
* @return True if last value exists, false otherwise.
*/
bool HasLastValue() const { return m_lastValue.has_value(); }
/**
* Gets the last value.
*
* @note The last value is local to this class instance and updated only with
* Update(), not Append().
*
* @return Last value (empty if no last value)
*/
std::optional<std::vector<T>> GetLastValue() const {
std::scoped_lock lock{m_mutex};
if (!m_lastValue.has_value()) {
return std::nullopt;
}
auto& lastValue = m_lastValue.value();
size_t size = std::apply(S::GetSize, m_info);
std::vector<T> rv;
rv.reserve(lastValue.size() / size);
for (auto in = lastValue.begin(), end = lastValue.end(); in < end;
in += size) {
std::apply(
[&](const I&... info) {
rv.emplace_back(S::Unpack(
std::span<const uint8_t>{std::to_address(in), size}, info...));
},
m_info);
}
return rv;
}
private:
mutable wpi::mutex m_mutex;
StructArrayBuffer<T, I...> m_buf;
std::optional<std::vector<uint8_t>> m_lastValue;
[[no_unique_address]]
std::tuple<I...> m_info;
};
/**
* Log protobuf serializable objects.
*/
template <ProtobufSerializable T>
class ProtobufLogEntry : public DataLogEntry {
using P = Protobuf<T>;
public:
ProtobufLogEntry() = default;
ProtobufLogEntry(DataLog& log, std::string_view name, int64_t timestamp = 0)
: ProtobufLogEntry{log, name, {}, timestamp} {}
ProtobufLogEntry(DataLog& log, std::string_view name,
std::string_view metadata, int64_t timestamp = 0) {
m_log = &log;
log.AddProtobufSchema<T>(m_msg, timestamp);
m_entry = log.Start(name, m_msg.GetTypeString(), metadata, timestamp);
}
/**
* Appends a record to the log.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Append(const T& data, int64_t timestamp = 0) {
SmallVector<uint8_t, 128> buf;
{
std::scoped_lock lock{m_mutex};
m_msg.Pack(buf, data);
}
m_log->AppendRaw(m_entry, buf, timestamp);
}
/**
* Updates the last value and appends a record to the log if it has changed.
*
* @note The last value is local to this class instance; using Update() with
* two instances pointing to the same underlying log entry name will likely
* result in unexpected results.
*
* @param data Data to record
* @param timestamp Time stamp (may be 0 to indicate now)
*/
void Update(const T& data, int64_t timestamp = 0) {
std::scoped_lock lock{m_mutex};
wpi::SmallVector<uint8_t, 128> buf;
m_msg.Pack(buf, data);
if (!m_lastValue.has_value()) {
m_lastValue = std::vector(buf.begin(), buf.end());
m_log->AppendRaw(m_entry, buf, timestamp);
} else if (!std::equal(buf.begin(), buf.end(), m_lastValue->begin(),
m_lastValue->end())) {
m_lastValue->assign(buf.begin(), buf.end());
m_log->AppendRaw(m_entry, buf, timestamp);
}
}
/**
* Gets whether there is a last value.
*
* @note The last value is local to this class instance and updated only with
* Update(), not Append().
*
* @return True if last value exists, false otherwise.
*/
bool HasLastValue() const { return m_lastValue.has_value(); }
/**
* Gets the last value.
*
* @note The last value is local to this class instance and updated only with
* Update(), not Append().
*
* @return Last value (empty if no last value)
*/
std::optional<T> GetLastValue() const {
std::scoped_lock lock{m_mutex};
if (!m_lastValue.has_value()) {
return std::nullopt;
}
return m_msg.Unpack(m_lastValue);
}
private:
mutable wpi::mutex m_mutex;
ProtobufMessage<T> m_msg;
std::optional<std::vector<uint8_t>> m_lastValue;
};
} // namespace wpi::log