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#ifndef ENGINE_SHARED_SNAPSHOT_H
4#define ENGINE_SHARED_SNAPSHOT_H
5
6#include <generated/protocol.h>
7#include <generated/protocol7.h>
8
9#include <cstddef>
10#include <cstdint>
11
12// CSnapshot
13
14class CSnapshotItem
15{
16 friend class CSnapshotBuilder;
17
18 int *Data() { return (int *)(this + 1); }
19
20public:
21 int m_TypeAndId;
22
23 const int *Data() const { return (int *)(this + 1); }
24 int InternalType() const { return m_TypeAndId >> 16; }
25 int Id() const { return m_TypeAndId & 0xffff; }
26 int Key() const { return m_TypeAndId; }
27 void Invalidate() { m_TypeAndId = -1; }
28};
29
30class CSnapshot
31{
32 friend class CSnapshotBuilder;
33 int m_DataSize = 0;
34 int m_NumItems = 0;
35
36 int *Offsets() const { return (int *)(this + 1); }
37 char *DataStart() const { return (char *)(Offsets() + m_NumItems); }
38
39 size_t OffsetSize() const { return sizeof(int) * m_NumItems; }
40 size_t TotalSize() const { return sizeof(CSnapshot) + OffsetSize() + m_DataSize; }
41
42 static const CSnapshot ms_EmptySnapshot;
43
44public:
45 enum
46 {
47 OFFSET_UUID_TYPE = 0x4000,
48 MAX_TYPE = 0x7fff,
49 MAX_ID = 0xffff,
50 MAX_ITEMS = 1024,
51 MAX_PARTS = 64,
52 MAX_SIZE = MAX_PARTS * 1024
53 };
54
55 int NumItems() const { return m_NumItems; }
56 int DataSize() const { return m_DataSize; }
57 const CSnapshotItem *GetItem(int Index) const;
58 int GetItemSize(int Index) const;
59 int GetItemIndex(int Key) const;
60 void InvalidateItem(int Index);
61 int GetItemType(int Index) const;
62 int GetExternalItemType(int InternalType) const;
63 const void *FindItem(int Type, int Id) const;
64
65 unsigned Crc() const;
66 // Prints the raw snapshot data showing item and int boundaries.
67 // See also `CNetObjHandler::DebugDumpSnapshot(const CSnapshot *pSnap)`
68 // For more detailed annotations of the data.
69 void DebugDump() const;
70 bool IsValid(size_t ActualSize) const;
71
72 static const CSnapshot *EmptySnapshot() { return &ms_EmptySnapshot; }
73};
74
75class alignas(int32_t) CSnapshotBuffer
76{
77public:
78 unsigned char m_aData[CSnapshot::MAX_SIZE];
79
80 CSnapshot *AsSnapshot() { return (CSnapshot *)m_aData; }
81 const CSnapshot *AsSnapshot() const { return (const CSnapshot *)m_aData; }
82};
83
84// CSnapshotDelta
85
86class CSnapshotDelta
87{
88public:
89 class CData
90 {
91 public:
92 int m_NumDeletedItems;
93 int m_NumUpdateItems;
94 int m_NumTempItems; // needed?
95 int m_aData[1];
96 };
97
98private:
99 enum
100 {
101 MAX_NETOBJSIZES = 64
102 };
103 short m_aItemSizes[MAX_NETOBJSIZES];
104 uint64_t m_aSnapshotDataRate[CSnapshot::MAX_TYPE + 1];
105 uint64_t m_aSnapshotDataUpdates[CSnapshot::MAX_TYPE + 1];
106 CData m_Empty;
107
108 static void UndiffItem(const int *pPast, const int *pDiff, int *pOut, int Size, uint64_t *pDataRate);
109
110public:
111 static int DiffItem(const int *pPast, const int *pCurrent, int *pOut, int Size);
112 CSnapshotDelta();
113 CSnapshotDelta(const CSnapshotDelta &Old);
114 uint64_t GetDataRate(int Index) const { return m_aSnapshotDataRate[Index]; }
115 uint64_t GetDataUpdates(int Index) const { return m_aSnapshotDataUpdates[Index]; }
116 void SetStaticsize(int ItemType, size_t Size);
117 const CData *EmptyDelta() const;
118 int CreateDelta(const CSnapshot *pFrom, const CSnapshot *pTo, void *pDstData);
119 int UnpackDelta(const CSnapshot *pFrom, CSnapshotBuffer *pTo, const void *pSrcData, int DataSize);
120 int DebugDumpDelta(const void *pSrcData, int DataSize);
121};
122
123// CSnapshotStorage
124
125class CSnapshotStorage
126{
127public:
128 class CHolder
129 {
130 public:
131 CHolder *m_pPrev;
132 CHolder *m_pNext;
133
134 int64_t m_Tagtime;
135 int m_Tick;
136
137 int m_SnapSize;
138 int m_AltSnapSize;
139
140 CSnapshot *m_pSnap;
141 CSnapshot *m_pAltSnap;
142 };
143
144 CHolder *m_pFirst;
145 CHolder *m_pLast;
146
147 CSnapshotStorage() { Init(); }
148 ~CSnapshotStorage() { PurgeAll(); }
149 void Init();
150 void PurgeAll();
151 void PurgeUntil(int Tick);
152 void Add(int Tick, int64_t Tagtime, size_t DataSize, const void *pData, size_t AltDataSize, const void *pAltData);
153 int Get(int Tick, int64_t *pTagtime, const CSnapshot **ppData, const CSnapshot **ppAltData) const;
154};
155
156class CSnapshotBuilder
157{
158 enum
159 {
160 MAX_EXTENDED_ITEM_TYPES = 64,
161 };
162
163 char m_aData[CSnapshot::MAX_SIZE];
164 int m_DataSize;
165
166 int m_aOffsets[CSnapshot::MAX_ITEMS];
167 int m_NumItems;
168
169 int m_aExtendedItemTypes[MAX_EXTENDED_ITEM_TYPES];
170 int m_NumExtendedItemTypes = 0;
171
172 bool AddExtendedItemType(int Index);
173 int GetExtendedItemTypeIndex(int TypeId);
174 int GetTypeFromIndex(int Index) const;
175
176 bool m_Building = false;
177 bool m_Sixup = false;
178
179public:
180 void Init(bool Sixup = false);
181 void Init7(const CSnapshot *pSnapshot);
182
183 void *NewItem(int Type, int Id, int Size);
184
185 CSnapshotItem *GetItem(int Index);
186 int *GetItemData(int Key);
187
188 int Finish(CSnapshotBuffer *pBuffer);
189};
190
191#endif // ENGINE_SHARED_SNAPSHOT_H
192