1/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
2/* If you are missing that file, acquire a complete release at teeworlds.com. */
3#include "snapshot.h"
4
5#include "compression.h"
6#include "uuid_manager.h"
7
8#include <base/bytes.h>
9#include <base/dbg.h>
10#include <base/math.h>
11#include <base/mem.h>
12#include <base/str.h>
13
14#include <generated/protocol7.h>
15#include <generated/protocolglue.h>
16
17#include <cstdlib>
18#include <limits>
19
20// CSnapshot
21
22const CSnapshotItem *CSnapshot::GetItem(int Index) const
23{
24 return (const CSnapshotItem *)(DataStart() + Offsets()[Index]);
25}
26
27const CSnapshot CSnapshot::ms_EmptySnapshot;
28
29int CSnapshot::GetItemSize(int Index) const
30{
31 if(Index == m_NumItems - 1)
32 return (m_DataSize - Offsets()[Index]) - sizeof(CSnapshotItem);
33 return (Offsets()[Index + 1] - Offsets()[Index]) - sizeof(CSnapshotItem);
34}
35
36int CSnapshot::GetItemType(int Index) const
37{
38 int InternalType = GetItem(Index)->Type();
39 return GetExternalItemType(InternalType);
40}
41
42int CSnapshot::GetExternalItemType(int InternalType) const
43{
44 if(InternalType < OFFSET_UUID_TYPE)
45 {
46 return InternalType;
47 }
48
49 int TypeItemIndex = GetItemIndex(Key: InternalType); // NETOBJTYPE_EX
50 if(TypeItemIndex == -1 || GetItemSize(Index: TypeItemIndex) < (int)sizeof(CUuid))
51 {
52 return InternalType;
53 }
54 const CSnapshotItem *pTypeItem = GetItem(Index: TypeItemIndex);
55 CUuid Uuid;
56 for(size_t i = 0; i < sizeof(CUuid) / sizeof(int32_t); i++)
57 uint_to_bytes_be(bytes: &Uuid.m_aData[i * sizeof(int32_t)], value: pTypeItem->Data()[i]);
58
59 return g_UuidManager.LookupUuid(Uuid);
60}
61
62int CSnapshot::GetItemIndex(int Key) const
63{
64 // TODO: OPT: this should not be a linear search. very bad
65 for(int i = 0; i < m_NumItems; i++)
66 {
67 if(GetItem(Index: i)->Key() == Key)
68 return i;
69 }
70 return -1;
71}
72
73void CSnapshot::InvalidateItem(int Index)
74{
75 ((CSnapshotItem *)(DataStart() + Offsets()[Index]))->Invalidate();
76}
77
78const void *CSnapshot::FindItem(int Type, int Id) const
79{
80 int InternalType = Type;
81 if(Type >= OFFSET_UUID)
82 {
83 CUuid TypeUuid = g_UuidManager.GetUuid(Id: Type);
84 int aTypeUuidItem[sizeof(CUuid) / sizeof(int32_t)];
85 for(size_t i = 0; i < sizeof(CUuid) / sizeof(int32_t); i++)
86 aTypeUuidItem[i] = bytes_be_to_uint(bytes: &TypeUuid.m_aData[i * sizeof(int32_t)]);
87
88 bool Found = false;
89 for(int i = 0; i < m_NumItems; i++)
90 {
91 const CSnapshotItem *pItem = GetItem(Index: i);
92 if(pItem->Type() == 0 && pItem->Id() >= OFFSET_UUID_TYPE) // NETOBJTYPE_EX
93 {
94 if(mem_comp(a: pItem->Data(), b: aTypeUuidItem, size: sizeof(CUuid)) == 0)
95 {
96 InternalType = pItem->Id();
97 Found = true;
98 break;
99 }
100 }
101 }
102 if(!Found)
103 {
104 return nullptr;
105 }
106 }
107 int Index = GetItemIndex(Key: (InternalType << 16) | Id);
108 return Index < 0 ? nullptr : GetItem(Index)->Data();
109}
110
111unsigned CSnapshot::Crc() const
112{
113 unsigned int Crc = 0;
114
115 for(int i = 0; i < m_NumItems; i++)
116 {
117 const CSnapshotItem *pItem = GetItem(Index: i);
118 int Size = GetItemSize(Index: i);
119
120 for(size_t b = 0; b < Size / sizeof(int32_t); b++)
121 Crc += pItem->Data()[b];
122 }
123 return Crc;
124}
125
126void CSnapshot::DebugDump() const
127{
128 dbg_msg(sys: "snapshot", fmt: "data_size=%d num_items=%d", m_DataSize, m_NumItems);
129 for(int i = 0; i < m_NumItems; i++)
130 {
131 const CSnapshotItem *pItem = GetItem(Index: i);
132 int Size = GetItemSize(Index: i);
133 dbg_msg(sys: "snapshot", fmt: "\ttype=%d id=%d", pItem->Type(), pItem->Id());
134 for(size_t b = 0; b < Size / sizeof(int32_t); b++)
135 dbg_msg(sys: "snapshot", fmt: "\t\t%3d %12d\t%08x", (int)b, pItem->Data()[b], pItem->Data()[b]);
136 }
137}
138
139bool CSnapshot::IsValid(size_t ActualSize) const
140{
141 // validate total size
142 if(ActualSize < sizeof(CSnapshot) ||
143 ActualSize > MAX_SIZE ||
144 m_NumItems < 0 ||
145 m_NumItems > MAX_ITEMS ||
146 m_DataSize < 0 ||
147 ActualSize != TotalSize())
148 {
149 return false;
150 }
151
152 // validate item offsets
153 const int *pOffsets = Offsets();
154 for(int Index = 0; Index < m_NumItems; Index++)
155 if(pOffsets[Index] < 0 || pOffsets[Index] > m_DataSize)
156 return false;
157
158 // validate item sizes
159 for(int Index = 0; Index < m_NumItems; Index++)
160 if(GetItemSize(Index) < 0) // the offsets must be validated before using this
161 return false;
162
163 return true;
164}
165
166// CSnapshotDelta
167
168enum
169{
170 HASHLIST_SIZE = 256,
171 HASHLIST_BUCKET_SIZE = 64,
172};
173
174struct CItemList
175{
176 int m_Num;
177 int m_aKeys[HASHLIST_BUCKET_SIZE];
178 int m_aIndex[HASHLIST_BUCKET_SIZE];
179};
180
181static inline size_t CalcHashId(int Key)
182{
183 // djb2 (http://www.cse.yorku.ca/~oz/hash.html)
184 unsigned Hash = 5381;
185 for(unsigned Shift = 0; Shift < sizeof(int); Shift++)
186 Hash = ((Hash << 5) + Hash) + ((Key >> (Shift * 8)) & 0xFF);
187 return Hash % HASHLIST_SIZE;
188}
189
190static void GenerateHash(CItemList *pHashlist, const CSnapshot *pSnapshot)
191{
192 for(int i = 0; i < HASHLIST_SIZE; i++)
193 pHashlist[i].m_Num = 0;
194
195 for(int i = 0; i < pSnapshot->NumItems(); i++)
196 {
197 int Key = pSnapshot->GetItem(Index: i)->Key();
198 size_t HashId = CalcHashId(Key);
199 if(pHashlist[HashId].m_Num < HASHLIST_BUCKET_SIZE)
200 {
201 pHashlist[HashId].m_aIndex[pHashlist[HashId].m_Num] = i;
202 pHashlist[HashId].m_aKeys[pHashlist[HashId].m_Num] = Key;
203 pHashlist[HashId].m_Num++;
204 }
205 }
206}
207
208static int GetItemIndexHashed(int Key, const CItemList *pHashlist)
209{
210 size_t HashId = CalcHashId(Key);
211 for(int i = 0; i < pHashlist[HashId].m_Num; i++)
212 {
213 if(pHashlist[HashId].m_aKeys[i] == Key)
214 return pHashlist[HashId].m_aIndex[i];
215 }
216
217 return -1;
218}
219
220int CSnapshotDelta::DiffItem(const int *pPast, const int *pCurrent, int *pOut, int Size)
221{
222 int Needed = 0;
223 while(Size)
224 {
225 // subtraction with wrapping by casting to unsigned
226 *pOut = (unsigned)*pCurrent - (unsigned)*pPast;
227 Needed |= *pOut;
228 pOut++;
229 pPast++;
230 pCurrent++;
231 Size--;
232 }
233
234 return Needed;
235}
236
237void CSnapshotDelta::UndiffItem(const int *pPast, const int *pDiff, int *pOut, int Size, uint64_t *pDataRate)
238{
239 while(Size)
240 {
241 // addition with wrapping by casting to unsigned
242 *pOut = (unsigned)*pPast + (unsigned)*pDiff;
243
244 if(*pDiff == 0)
245 *pDataRate += 1;
246 else
247 {
248 unsigned char aBuf[CVariableInt::MAX_BYTES_PACKED];
249 unsigned char *pEnd = CVariableInt::Pack(pDst: aBuf, i: *pDiff, DstSize: sizeof(aBuf));
250 *pDataRate += (uint64_t)(pEnd - (unsigned char *)aBuf) * 8;
251 }
252
253 pOut++;
254 pPast++;
255 pDiff++;
256 Size--;
257 }
258}
259
260CSnapshotDelta::CSnapshotDelta()
261{
262 std::fill(first: std::begin(arr&: m_aItemSizes), last: std::end(arr&: m_aItemSizes), value: 0);
263 std::fill(first: std::begin(arr&: m_aItemSizes7), last: std::end(arr&: m_aItemSizes7), value: 0);
264 std::fill(first: std::begin(arr&: m_aSnapshotDataRate), last: std::end(arr&: m_aSnapshotDataRate), value: 0);
265 std::fill(first: std::begin(arr&: m_aSnapshotDataUpdates), last: std::end(arr&: m_aSnapshotDataUpdates), value: 0);
266 mem_zero(block: &m_Empty, size: sizeof(m_Empty));
267}
268
269CSnapshotDelta::CSnapshotDelta(const CSnapshotDelta &Old)
270{
271 mem_copy(dest: m_aItemSizes, source: Old.m_aItemSizes, size: sizeof(m_aItemSizes));
272 mem_copy(dest: m_aItemSizes7, source: Old.m_aItemSizes7, size: sizeof(m_aItemSizes7));
273 mem_copy(dest: m_aSnapshotDataRate, source: Old.m_aSnapshotDataRate, size: sizeof(m_aSnapshotDataRate));
274 mem_copy(dest: m_aSnapshotDataUpdates, source: Old.m_aSnapshotDataUpdates, size: sizeof(m_aSnapshotDataUpdates));
275 mem_zero(block: &m_Empty, size: sizeof(m_Empty));
276}
277
278void CSnapshotDelta::SetStaticsize(int ItemType, size_t Size)
279{
280 dbg_assert(ItemType >= 0 && ItemType < MAX_NETOBJSIZES, "ItemType invalid");
281 dbg_assert(Size <= (size_t)std::numeric_limits<int16_t>::max(), "Size invalid");
282 m_aItemSizes[ItemType] = Size;
283}
284
285void CSnapshotDelta::SetStaticsize7(int ItemType, size_t Size)
286{
287 dbg_assert(ItemType >= 0 && ItemType < MAX_NETOBJSIZES, "ItemType invalid");
288 dbg_assert(Size <= (size_t)std::numeric_limits<int16_t>::max(), "Size invalid");
289 m_aItemSizes7[ItemType] = Size;
290}
291
292const CSnapshotDelta::CData *CSnapshotDelta::EmptyDelta() const
293{
294 return &m_Empty;
295}
296
297// TODO: OPT: this should be made much faster
298int CSnapshotDelta::CreateDelta(const CSnapshot *pFrom, const CSnapshot *pTo, void *pDstData)
299{
300 CData *pDelta = (CData *)pDstData;
301 int *pData = (int *)pDelta->m_aData;
302
303 pDelta->m_NumDeletedItems = 0;
304 pDelta->m_NumUpdateItems = 0;
305 pDelta->m_NumTempItems = 0;
306
307 CItemList aHashlist[HASHLIST_SIZE];
308 GenerateHash(pHashlist: aHashlist, pSnapshot: pTo);
309
310 // pack deleted stuff
311 for(int i = 0; i < pFrom->NumItems(); i++)
312 {
313 const CSnapshotItem *pFromItem = pFrom->GetItem(Index: i);
314 if(GetItemIndexHashed(Key: pFromItem->Key(), pHashlist: aHashlist) == -1)
315 {
316 // deleted
317 pDelta->m_NumDeletedItems++;
318 *pData = pFromItem->Key();
319 pData++;
320 }
321 }
322
323 GenerateHash(pHashlist: aHashlist, pSnapshot: pFrom);
324
325 // fetch previous indices
326 // we do this as a separate pass because it helps the cache
327 int aPastIndices[CSnapshot::MAX_ITEMS];
328 const int NumItems = pTo->NumItems();
329 for(int i = 0; i < NumItems; i++)
330 {
331 const CSnapshotItem *pCurItem = pTo->GetItem(Index: i); // O(1) .. O(n)
332 aPastIndices[i] = GetItemIndexHashed(Key: pCurItem->Key(), pHashlist: aHashlist); // O(n) .. O(n^n)
333 }
334
335 for(int i = 0; i < NumItems; i++)
336 {
337 // do delta
338 const int ItemSize = pTo->GetItemSize(Index: i); // O(1) .. O(n)
339 const CSnapshotItem *pCurItem = pTo->GetItem(Index: i); // O(1) .. O(n)
340 const int PastIndex = aPastIndices[i];
341 const bool IncludeSize = pCurItem->Type() >= MAX_NETOBJSIZES || !m_aItemSizes[pCurItem->Type()];
342
343 if(PastIndex != -1)
344 {
345 int *pItemDataDst = pData + 3;
346
347 const CSnapshotItem *pPastItem = pFrom->GetItem(Index: PastIndex);
348
349 if(!IncludeSize)
350 pItemDataDst = pData + 2;
351
352 if(DiffItem(pPast: pPastItem->Data(), pCurrent: pCurItem->Data(), pOut: pItemDataDst, Size: ItemSize / sizeof(int32_t)))
353 {
354 *pData++ = pCurItem->Type();
355 *pData++ = pCurItem->Id();
356 if(IncludeSize)
357 *pData++ = ItemSize / sizeof(int32_t);
358 pData += ItemSize / sizeof(int32_t); // NOLINT(bugprone-sizeof-expression)
359 pDelta->m_NumUpdateItems++;
360 }
361 }
362 else
363 {
364 *pData++ = pCurItem->Type();
365 *pData++ = pCurItem->Id();
366 if(IncludeSize)
367 *pData++ = ItemSize / sizeof(int32_t);
368
369 mem_copy(dest: pData, source: pCurItem->Data(), size: ItemSize);
370 pData += ItemSize / sizeof(int32_t); // NOLINT(bugprone-sizeof-expression)
371 pDelta->m_NumUpdateItems++;
372 }
373 }
374
375 if(!pDelta->m_NumDeletedItems && !pDelta->m_NumUpdateItems && !pDelta->m_NumTempItems)
376 return 0;
377
378 return (int)((char *)pData - (char *)pDstData);
379}
380
381int CSnapshotDelta::DebugDumpDelta(const void *pSrcData, int DataSize)
382{
383 CData *pDelta = (CData *)pSrcData;
384 int *pData = (int *)pDelta->m_aData;
385 int *pEnd = (int *)(((char *)pSrcData + DataSize));
386
387 dbg_msg(sys: "delta_dump", fmt: "+-----------------------------------------------");
388 if(DataSize < 3 * (int)sizeof(int32_t))
389 {
390 dbg_msg(sys: "delta_dump", fmt: "| delta size %d too small. Should at least fit the empty delta header.", DataSize);
391 return -505;
392 }
393
394 dbg_msg(sys: "delta_dump", fmt: "| data_size=%d", DataSize);
395
396 int DumpIndex = 0;
397
398 // dump header
399 {
400 int *pDumpHeader = (int *)pSrcData;
401 dbg_msg(sys: "delta_dump", fmt: "| %3d %12d %08x m_NumDeletedItems=%d", DumpIndex++, *pDumpHeader, *pDumpHeader, *pDumpHeader);
402 pDumpHeader++;
403 dbg_msg(sys: "delta_dump", fmt: "| %3d %12d %08x m_NumUpdatedItems=%d", DumpIndex++, *pDumpHeader, *pDumpHeader, *pDumpHeader);
404 pDumpHeader++;
405 dbg_msg(sys: "delta_dump", fmt: "| %3d %12d %08x _zero=%d", DumpIndex++, *pDumpHeader, *pDumpHeader, *pDumpHeader);
406 pDumpHeader++;
407
408 dbg_assert(pDumpHeader == pData, "invalid header size");
409 }
410
411 // unpack deleted stuff
412 int *pDeleted = pData;
413 if(pDelta->m_NumDeletedItems < 0)
414 {
415 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. Number of deleted items %d is negative.", pDelta->m_NumDeletedItems);
416 return -201;
417 }
418 pData += pDelta->m_NumDeletedItems;
419 if(pData > pEnd)
420 {
421 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. Read past the end.");
422 return -101;
423 }
424
425 // list deleted items
426 // (all other items should be copied from the last full snap)
427 for(int d = 0; d < pDelta->m_NumDeletedItems; d++)
428 {
429 int Type = pDeleted[d] >> 16;
430 int Id = pDeleted[d] & 0xffff;
431 dbg_msg(sys: "delta_dump", fmt: " %3d %12d %08x deleted Type=%d Id=%d", DumpIndex++, pDeleted[d], pDeleted[d], Type, Id);
432 }
433
434 // unpack updated stuff
435 for(int i = 0; i < pDelta->m_NumUpdateItems; i++)
436 {
437 if(pData + 2 > pEnd)
438 {
439 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. NumUpdateItems=%d can't be fit into DataSize=%d", pDelta->m_NumUpdateItems, DataSize);
440 return -102;
441 }
442
443 dbg_msg(sys: "delta_dump", fmt: "| --------------------------------");
444 dbg_msg(sys: "delta_dump", fmt: "| %3d %12d %08x updated Type=%d", DumpIndex++, *pData, *pData, *pData);
445 const int Type = *pData++;
446 if(Type < 0 || Type > CSnapshot::MAX_TYPE)
447 {
448 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. Type=%d out of range (0 - %d)", Type, CSnapshot::MAX_TYPE);
449 return -202;
450 }
451
452 dbg_msg(sys: "delta_dump", fmt: "| %3d %12d %08x updated Id=%d", DumpIndex++, *pData, *pData, *pData);
453 const int Id = *pData++;
454 if(Id < 0 || Id > CSnapshot::MAX_ID)
455 {
456 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. Id=%d out of range (0 - %d)", Id, CSnapshot::MAX_ID);
457 return -203;
458 }
459
460 // size of the item in bytes
461 int ItemSize;
462 if(Type < MAX_NETOBJSIZES && m_aItemSizes[Type])
463 {
464 ItemSize = m_aItemSizes[Type];
465 dbg_msg(sys: "delta_dump", fmt: "| updated size=%d (known)", ItemSize);
466 }
467 else
468 {
469 if(pData + 1 > pEnd)
470 {
471 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. Expected item size but got end of data.");
472 return -103;
473 }
474 if(*pData < 0 || (size_t)*pData > std::numeric_limits<int32_t>::max() / sizeof(int32_t))
475 {
476 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. Item size %d out of range (0 - %" PRIzu ")", *pData, std::numeric_limits<int32_t>::max() / sizeof(int32_t));
477 return -204;
478 }
479 dbg_msg(sys: "delta_dump", fmt: "| %3d %12d %08x updated size=%d", DumpIndex++, *pData, *pData, *pData);
480 ItemSize = (*pData++) * sizeof(int32_t);
481 }
482
483 if(ItemSize < 0)
484 {
485 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. Item size %d is negative.", ItemSize);
486 return -205;
487 }
488 if((const char *)pEnd - (const char *)pData < ItemSize)
489 {
490 dbg_msg(sys: "delta_dump", fmt: "| Invalid delta. Item with type=%d id=%d size=%d does not fit into the delta.", Type, Id, ItemSize);
491 return -205;
492 }
493
494 // divide item size in bytes by size of integers
495 // to get the number of integers we want to increment the pointer
496 const int *pItemEnd = pData + (ItemSize / sizeof(int32_t));
497
498 for(size_t b = 0; b < ItemSize / sizeof(int32_t); b++)
499 {
500 dbg_msg(sys: "delta_dump", fmt: "| %3d %12d %08x item data", DumpIndex++, *pData, *pData);
501 pData++;
502 }
503
504 dbg_assert(pItemEnd == pData, "Incorrect amount of data dumped for this item.");
505 }
506
507 dbg_msg(sys: "delta_dump", fmt: "| Finished with expected_data_size=%d parsed_data_size=%" PRIzu, DataSize, (pData - (int *)pSrcData) * sizeof(int32_t));
508 dbg_msg(sys: "delta_dump", fmt: "+--------------------");
509
510 return 0;
511}
512
513int CSnapshotDelta::UnpackDelta(const CSnapshot *pFrom, CSnapshot *pTo, const void *pSrcData, int DataSize, bool Sixup)
514{
515 CData *pDelta = (CData *)pSrcData;
516 int *pData = (int *)pDelta->m_aData;
517 int *pEnd = (int *)(((char *)pSrcData + DataSize));
518
519 CSnapshotBuilder Builder;
520 Builder.Init();
521
522 // unpack deleted stuff
523 int *pDeleted = pData;
524 if(pDelta->m_NumDeletedItems < 0)
525 return -201;
526 pData += pDelta->m_NumDeletedItems;
527 if(pData > pEnd)
528 return -101;
529
530 // copy all non deleted stuff
531 for(int i = 0; i < pFrom->NumItems(); i++)
532 {
533 const CSnapshotItem *pFromItem = pFrom->GetItem(Index: i);
534 const int ItemSize = pFrom->GetItemSize(Index: i);
535 bool Keep = true;
536 for(int d = 0; d < pDelta->m_NumDeletedItems; d++)
537 {
538 if(pDeleted[d] == pFromItem->Key())
539 {
540 Keep = false;
541 break;
542 }
543 }
544
545 if(Keep)
546 {
547 void *pObj = Builder.NewItem(Type: pFromItem->Type(), Id: pFromItem->Id(), Size: ItemSize);
548 if(!pObj)
549 return -301;
550
551 // keep it
552 mem_copy(dest: pObj, source: pFromItem->Data(), size: ItemSize);
553 }
554 }
555
556 // unpack updated stuff
557 for(int i = 0; i < pDelta->m_NumUpdateItems; i++)
558 {
559 if(pData + 2 > pEnd)
560 return -102;
561
562 const int Type = *pData++;
563 if(Type < 0 || Type > CSnapshot::MAX_TYPE)
564 return -202;
565
566 const int Id = *pData++;
567 if(Id < 0 || Id > CSnapshot::MAX_ID)
568 return -203;
569
570 int ItemSize;
571 const short *pItemSizes = Sixup ? m_aItemSizes7 : m_aItemSizes;
572 if(Type < MAX_NETOBJSIZES && pItemSizes[Type])
573 ItemSize = pItemSizes[Type];
574 else
575 {
576 if(pData + 1 > pEnd)
577 return -103;
578 if(*pData < 0 || (size_t)*pData > std::numeric_limits<int32_t>::max() / sizeof(int32_t))
579 return -204;
580 ItemSize = (*pData++) * sizeof(int32_t);
581 }
582
583 if(ItemSize < 0 || (const char *)pEnd - (const char *)pData < ItemSize)
584 return -205;
585
586 const int Key = (Type << 16) | Id;
587
588 // create the item if needed
589 int *pNewData = Builder.GetItemData(Key);
590 if(!pNewData)
591 pNewData = (int *)Builder.NewItem(Type, Id, Size: ItemSize);
592
593 if(!pNewData)
594 return -302;
595
596 const int FromIndex = pFrom->GetItemIndex(Key);
597 if(FromIndex != -1)
598 {
599 // we got an update so we need to apply the diff
600 UndiffItem(pPast: pFrom->GetItem(Index: FromIndex)->Data(), pDiff: pData, pOut: pNewData, Size: ItemSize / sizeof(int32_t), pDataRate: &m_aSnapshotDataRate[Type]);
601 }
602 else // no previous, just copy the pData
603 {
604 mem_copy(dest: pNewData, source: pData, size: ItemSize);
605 m_aSnapshotDataRate[Type] += ItemSize * 8;
606 }
607 m_aSnapshotDataUpdates[Type]++;
608
609 pData += ItemSize / sizeof(int32_t); // NOLINT(bugprone-sizeof-expression)
610 }
611
612 // finish up
613 return Builder.Finish(pSnapdata: pTo);
614}
615
616// CSnapshotStorage
617
618void CSnapshotStorage::Init()
619{
620 m_pFirst = nullptr;
621 m_pLast = nullptr;
622}
623
624void CSnapshotStorage::PurgeAll()
625{
626 while(m_pFirst)
627 {
628 CHolder *pNext = m_pFirst->m_pNext;
629 free(ptr: m_pFirst->m_pSnap);
630 free(ptr: m_pFirst->m_pAltSnap);
631 free(ptr: m_pFirst);
632 m_pFirst = pNext;
633 }
634 m_pLast = nullptr;
635}
636
637void CSnapshotStorage::PurgeUntil(int Tick)
638{
639 CHolder *pHolder = m_pFirst;
640
641 while(pHolder)
642 {
643 CHolder *pNext = pHolder->m_pNext;
644 if(pHolder->m_Tick >= Tick)
645 return; // no more to remove
646 free(ptr: pHolder->m_pSnap);
647 free(ptr: pHolder->m_pAltSnap);
648 free(ptr: pHolder);
649
650 // did we come to the end of the list?
651 if(!pNext)
652 break;
653
654 m_pFirst = pNext;
655 pNext->m_pPrev = nullptr;
656 pHolder = pNext;
657 }
658
659 // no more snapshots in storage
660 m_pFirst = nullptr;
661 m_pLast = nullptr;
662}
663
664void CSnapshotStorage::Add(int Tick, int64_t Tagtime, size_t DataSize, const void *pData, size_t AltDataSize, const void *pAltData)
665{
666 dbg_assert(DataSize <= (size_t)CSnapshot::MAX_SIZE, "Snapshot data size invalid");
667 dbg_assert(AltDataSize <= (size_t)CSnapshot::MAX_SIZE, "Alt snapshot data size invalid");
668
669 CHolder *pHolder = static_cast<CHolder *>(malloc(size: sizeof(CHolder)));
670 pHolder->m_Tick = Tick;
671 pHolder->m_Tagtime = Tagtime;
672
673 pHolder->m_pSnap = static_cast<CSnapshot *>(malloc(size: DataSize));
674 mem_copy(dest: pHolder->m_pSnap, source: pData, size: DataSize);
675 pHolder->m_SnapSize = DataSize;
676
677 if(AltDataSize) // create alternative if wanted
678 {
679 pHolder->m_pAltSnap = static_cast<CSnapshot *>(malloc(size: AltDataSize));
680 mem_copy(dest: pHolder->m_pAltSnap, source: pAltData, size: AltDataSize);
681 pHolder->m_AltSnapSize = AltDataSize;
682 }
683 else
684 {
685 pHolder->m_pAltSnap = nullptr;
686 pHolder->m_AltSnapSize = 0;
687 }
688
689 // link
690 pHolder->m_pNext = nullptr;
691 pHolder->m_pPrev = m_pLast;
692 if(m_pLast)
693 m_pLast->m_pNext = pHolder;
694 else
695 m_pFirst = pHolder;
696 m_pLast = pHolder;
697}
698
699int CSnapshotStorage::Get(int Tick, int64_t *pTagtime, const CSnapshot **ppData, const CSnapshot **ppAltData) const
700{
701 CHolder *pHolder = m_pFirst;
702
703 while(pHolder)
704 {
705 if(pHolder->m_Tick == Tick)
706 {
707 if(pTagtime)
708 *pTagtime = pHolder->m_Tagtime;
709 if(ppData)
710 *ppData = pHolder->m_pSnap;
711 if(ppAltData)
712 *ppAltData = pHolder->m_pAltSnap;
713 return pHolder->m_SnapSize;
714 }
715
716 pHolder = pHolder->m_pNext;
717 }
718
719 return -1;
720}
721
722// CSnapshotBuilder
723void CSnapshotBuilder::Init(bool Sixup)
724{
725 dbg_assert(!m_Building, "Snapshot builder is already building snapshot. Call `Finish` for each call to `Init`.");
726
727 m_DataSize = 0;
728 m_NumItems = 0;
729 m_Building = true;
730 m_Sixup = Sixup;
731
732 for(int i = 0; i < m_NumExtendedItemTypes; i++)
733 {
734 AddExtendedItemType(Index: i);
735 }
736}
737
738CSnapshotItem *CSnapshotBuilder::GetItem(int Index)
739{
740 return (CSnapshotItem *)&(m_aData[m_aOffsets[Index]]);
741}
742
743int *CSnapshotBuilder::GetItemData(int Key)
744{
745 for(int i = 0; i < m_NumItems; i++)
746 {
747 CSnapshotItem *pItem = GetItem(Index: i);
748 if(pItem->Key() == Key)
749 {
750 return pItem->Data();
751 }
752 }
753 return nullptr;
754}
755
756int CSnapshotBuilder::Finish(void *pSnapData)
757{
758 dbg_assert(m_Building, "Snapshot builder is not building snapshot. Call `Finish` after `Init`.");
759 m_Building = false;
760
761 // flatten and make the snapshot
762 dbg_assert(m_NumItems <= CSnapshot::MAX_ITEMS, "Too many snap items");
763 CSnapshot *pSnap = (CSnapshot *)pSnapData;
764 pSnap->m_DataSize = m_DataSize;
765 pSnap->m_NumItems = m_NumItems;
766 const size_t TotalSize = pSnap->TotalSize();
767 dbg_assert(TotalSize <= (size_t)CSnapshot::MAX_SIZE, "Snapshot too large");
768 mem_copy(dest: pSnap->Offsets(), source: m_aOffsets, size: pSnap->OffsetSize());
769 mem_copy(dest: pSnap->DataStart(), source: m_aData, size: m_DataSize);
770 return TotalSize;
771}
772
773int CSnapshotBuilder::GetTypeFromIndex(int Index) const
774{
775 return CSnapshot::MAX_TYPE - Index;
776}
777
778bool CSnapshotBuilder::AddExtendedItemType(int Index)
779{
780 dbg_assert(m_Building, "Snapshot builder is not building snapshot. Call `AddExtendedItemType` between `Init` and `Finish`.");
781 dbg_assert(0 <= Index && Index < m_NumExtendedItemTypes, "Index out of range: %d", Index);
782
783 int *pUuidItem = static_cast<int *>(NewItem(Type: 0, Id: GetTypeFromIndex(Index), Size: sizeof(CUuid))); // NETOBJTYPE_EX
784 if(pUuidItem == nullptr)
785 {
786 return false;
787 }
788
789 const int TypeId = m_aExtendedItemTypes[Index];
790 const CUuid Uuid = g_UuidManager.GetUuid(Id: TypeId);
791 for(size_t i = 0; i < sizeof(CUuid) / sizeof(int32_t); i++)
792 {
793 pUuidItem[i] = bytes_be_to_uint(bytes: &Uuid.m_aData[i * sizeof(int32_t)]);
794 }
795 return true;
796}
797
798int CSnapshotBuilder::GetExtendedItemTypeIndex(int TypeId)
799{
800 for(int i = 0; i < m_NumExtendedItemTypes; i++)
801 {
802 if(m_aExtendedItemTypes[i] == TypeId)
803 {
804 return i;
805 }
806 }
807 dbg_assert(m_NumExtendedItemTypes < MAX_EXTENDED_ITEM_TYPES, "too many extended item types");
808 int Index = m_NumExtendedItemTypes;
809 m_NumExtendedItemTypes++;
810 m_aExtendedItemTypes[Index] = TypeId;
811 if(AddExtendedItemType(Index))
812 {
813 return Index;
814 }
815 m_NumExtendedItemTypes--;
816 return -1;
817}
818
819void *CSnapshotBuilder::NewItem(int Type, int Id, int Size)
820{
821 dbg_assert(m_Building, "Snapshot builder is not building snapshot. Call `NewItem` between `Init` and `Finish`.");
822 const bool Extended = Type >= OFFSET_UUID;
823 dbg_assert((Type >= 0 && Type <= CSnapshot::MAX_TYPE) || Extended || (m_Sixup && Type >= -CSnapshot::MAX_TYPE && Type < 0), "Invalid snap item Type: %d", Type);
824 dbg_assert(Id >= 0 && Id <= CSnapshot::MAX_ID, "Invalid snap item Id: %d", Id);
825 dbg_assert(Size >= 0 && (size_t)Size <= CSnapshot::MAX_SIZE - sizeof(CSnapshot) - sizeof(CSnapshotItem) - sizeof(int), "Invalid snap item Size: %d", Size);
826
827 if(m_NumItems >= CSnapshot::MAX_ITEMS)
828 {
829 return nullptr;
830 }
831
832 const size_t OffsetSize = (m_NumItems + 1) * sizeof(int);
833 const size_t ItemSize = sizeof(CSnapshotItem) + Size;
834 if(sizeof(CSnapshot) + OffsetSize + m_DataSize + ItemSize > CSnapshot::MAX_SIZE)
835 {
836 return nullptr;
837 }
838
839 if(Extended)
840 {
841 const int ExtendedItemTypeIndex = GetExtendedItemTypeIndex(TypeId: Type);
842 if(ExtendedItemTypeIndex == -1)
843 {
844 return nullptr;
845 }
846 Type = GetTypeFromIndex(Index: ExtendedItemTypeIndex);
847 }
848
849 CSnapshotItem *pObj = (CSnapshotItem *)(m_aData + m_DataSize);
850
851 if(m_Sixup && !Extended)
852 {
853 if(Type >= 0)
854 Type = Obj_SixToSeven(a: Type);
855 else
856 Type *= -1;
857
858 if(Type < 0)
859 return pObj;
860 }
861 else if(Type < 0)
862 return nullptr;
863
864 pObj->m_TypeAndId = (Type << 16) | Id;
865 m_aOffsets[m_NumItems] = m_DataSize;
866 m_DataSize += ItemSize;
867 m_NumItems++;
868
869 mem_zero(block: pObj->Data(), size: Size);
870 return pObj->Data();
871}
872