forked from sonic-net/sonic-sairedis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
VirtualObjectIdManager.cpp
454 lines (345 loc) · 15 KB
/
VirtualObjectIdManager.cpp
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
#include "VirtualObjectIdManager.h"
#include "meta/sai_serialize.h"
#include "swss/logger.h"
#include <inttypes.h>
extern "C" {
#include "saimetadata.h"
}
#define SAI_OBJECT_ID_BITS_SIZE (8 * sizeof(sai_object_id_t))
static_assert(SAI_OBJECT_ID_BITS_SIZE == 64, "sai_object_id_t must have 64 bits");
static_assert(sizeof(sai_object_id_t) == sizeof(uint64_t), "SAI object ID size should be uint64_t");
#define SAI_REDIS_SWITCH_INDEX_BITS_SIZE ( 8 )
#define SAI_REDIS_SWITCH_INDEX_MAX ( (1ULL << SAI_REDIS_SWITCH_INDEX_BITS_SIZE) - 1 )
#define SAI_REDIS_SWITCH_INDEX_MASK (SAI_REDIS_SWITCH_INDEX_MAX)
#define SAI_REDIS_GLOBAL_CONTEXT_BITS_SIZE ( 8 )
#define SAI_REDIS_GLOBAL_CONTEXT_MAX ( (1ULL << SAI_REDIS_GLOBAL_CONTEXT_BITS_SIZE) - 1 )
#define SAI_REDIS_GLOBAL_CONTEXT_MASK (SAI_REDIS_GLOBAL_CONTEXT_MAX)
#define SAI_REDIS_OBJECT_TYPE_BITS_SIZE ( 8 )
#define SAI_REDIS_OBJECT_TYPE_MAX ( (1ULL << SAI_REDIS_OBJECT_TYPE_BITS_SIZE) - 1 )
#define SAI_REDIS_OBJECT_TYPE_MASK (SAI_REDIS_OBJECT_TYPE_MAX)
#define SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE ( 1 )
#define SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_MAX ( (1ULL << SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE) - 1 )
#define SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_MASK (SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_MAX)
#define SAI_REDIS_OBJECT_INDEX_BITS_SIZE ( 39 )
#define SAI_REDIS_OBJECT_INDEX_MAX ( (1ULL << SAI_REDIS_OBJECT_INDEX_BITS_SIZE) - 1 )
#define SAI_REDIS_OBJECT_INDEX_MASK (SAI_REDIS_OBJECT_INDEX_MAX)
#define SAI_REDIS_OBJECT_ID_BITS_SIZE ( \
SAI_REDIS_SWITCH_INDEX_BITS_SIZE + \
SAI_REDIS_GLOBAL_CONTEXT_BITS_SIZE + \
SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE + \
SAI_REDIS_OBJECT_TYPE_BITS_SIZE + \
SAI_REDIS_OBJECT_INDEX_BITS_SIZE )
static_assert(SAI_REDIS_OBJECT_ID_BITS_SIZE == SAI_OBJECT_ID_BITS_SIZE, "redis object id size must be equal to SAI object id size");
/*
* This condition must be met, since we need to be able to encode SAI object
* type in object id on defined number of bits.
*/
static_assert(SAI_OBJECT_TYPE_MAX < 256, "object type must be possible to encode on 1 byte");
static_assert((SAI_OBJECT_TYPE_EXTENSIONS_RANGE_END - SAI_OBJECT_TYPE_EXTENSIONS_RANGE_START) < 256,
"extensions object type must be possible to encode on 1 byte");
/*
* Current OBJECT ID format:
*
* bits 63..56 - switch index
* bits 55..48 - SAI object type
* bits 47..40 - global context
* bits 39..39 - object type extensions flag
* bits 38..0 - object index
*
* So large number of bits is required, otherwise we would need to have map of
* OID to some struct that will have all those values. But having all this
* information in OID itself is more convenient.
*
* To be backward compatible with previous sairedis, we will still encode base
* object type on bit's 55..48, and extensions which will now start from range
* 0x20000000, will be encoded from 0x0, but extensions flag will be set to 1.
*
* For example SAI_OBJECT_TYPE_VIRTUAL_ROUTER oid will be encoded as 0x0003000000000001,
* SAI_OBJECT_TYPE_DASH_ACL_GROUP oid will be encoded as 0x0003008000000001.
*/
#define SAI_REDIS_GET_OBJECT_INDEX(oid) \
( ((uint64_t)oid) & ( SAI_REDIS_OBJECT_INDEX_MASK ) )
#define SAI_REDIS_GET_OBJECT_TYPE_EXTENSIONS_FLAG(oid) \
( (((uint64_t)oid) >> (SAI_REDIS_OBJECT_INDEX_BITS_SIZE) ) & ( SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_MAX ) )
#define SAI_REDIS_GET_GLOBAL_CONTEXT(oid) \
( (((uint64_t)oid) >> (SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE + SAI_REDIS_OBJECT_INDEX_BITS_SIZE) ) & ( SAI_REDIS_GLOBAL_CONTEXT_MASK ) )
#define SAI_REDIS_GET_OBJECT_TYPE(oid) \
( (((uint64_t)oid) >> ( SAI_REDIS_GLOBAL_CONTEXT_BITS_SIZE + SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE + SAI_REDIS_OBJECT_INDEX_BITS_SIZE) ) & ( SAI_REDIS_OBJECT_TYPE_MASK ) )
#define SAI_REDIS_GET_SWITCH_INDEX(oid) \
( (((uint64_t)oid) >> ( SAI_REDIS_OBJECT_TYPE_BITS_SIZE + SAI_REDIS_GLOBAL_CONTEXT_BITS_SIZE + SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE + SAI_REDIS_OBJECT_INDEX_BITS_SIZE) ) & ( SAI_REDIS_SWITCH_INDEX_MASK ) )
#define SAI_REDIS_TEST_OID (0x012345e789abcdef)
static_assert(SAI_REDIS_GET_SWITCH_INDEX(SAI_REDIS_TEST_OID) == 0x01, "test switch index");
static_assert(SAI_REDIS_GET_OBJECT_TYPE(SAI_REDIS_TEST_OID) == 0x23, "test object type");
static_assert(SAI_REDIS_GET_GLOBAL_CONTEXT(SAI_REDIS_TEST_OID) == 0x45, "test global context");
static_assert(SAI_REDIS_GET_OBJECT_TYPE_EXTENSIONS_FLAG(SAI_REDIS_TEST_OID) == 0x1, "test object type extensions flag");
static_assert(SAI_REDIS_GET_OBJECT_INDEX(SAI_REDIS_TEST_OID) == 0x6789abcdef, "test object index");
using namespace sairedis;
VirtualObjectIdManager::VirtualObjectIdManager(
_In_ uint32_t globalContext,
_In_ std::shared_ptr<SwitchConfigContainer> scc,
_In_ std::shared_ptr<OidIndexGenerator> oidIndexGenerator):
m_globalContext(globalContext),
m_container(scc),
m_oidIndexGenerator(oidIndexGenerator)
{
SWSS_LOG_ENTER();
if (globalContext > SAI_REDIS_GLOBAL_CONTEXT_MAX)
{
SWSS_LOG_THROW("specified globalContext(0x%x) > maximum global context 0x%llx",
globalContext,
SAI_REDIS_GLOBAL_CONTEXT_MAX);
}
}
sai_object_id_t VirtualObjectIdManager::saiSwitchIdQuery(
_In_ sai_object_id_t objectId) const
{
SWSS_LOG_ENTER();
if (objectId == SAI_NULL_OBJECT_ID)
{
return SAI_NULL_OBJECT_ID;
}
sai_object_type_t objectType = saiObjectTypeQuery(objectId);
if (objectType == SAI_OBJECT_TYPE_NULL)
{
// TODO don't throw, those 2 functions should never throw
// it doesn't matter whether oid is correct, that will be validated
// in metadata
SWSS_LOG_THROW("invalid object type of oid %s",
sai_serialize_object_id(objectId).c_str());
}
if (objectType == SAI_OBJECT_TYPE_SWITCH)
{
return objectId;
}
// NOTE: we could also check:
// - if object id has correct global context
// - if object id has existing switch index
// but then this method can't be made static
uint32_t switchIndex = (uint32_t)SAI_REDIS_GET_SWITCH_INDEX(objectId);
uint32_t globalContext = (uint32_t)SAI_REDIS_GET_GLOBAL_CONTEXT(objectId);
return constructObjectId(SAI_OBJECT_TYPE_SWITCH, switchIndex, switchIndex, globalContext);
}
sai_object_type_t VirtualObjectIdManager::saiObjectTypeQuery(
_In_ sai_object_id_t objectId) const
{
SWSS_LOG_ENTER();
if (objectId == SAI_NULL_OBJECT_ID)
{
return SAI_OBJECT_TYPE_NULL;
}
sai_object_type_t objectType = SAI_REDIS_GET_OBJECT_TYPE_EXTENSIONS_FLAG(objectId)
? (sai_object_type_t)(SAI_REDIS_GET_OBJECT_TYPE(objectId) + SAI_OBJECT_TYPE_EXTENSIONS_RANGE_START)
: (sai_object_type_t)(SAI_REDIS_GET_OBJECT_TYPE(objectId));
if (sai_metadata_is_object_type_valid(objectType) == false)
{
SWSS_LOG_ERROR("invalid object id %s",
sai_serialize_object_id(objectId).c_str());
/*
* We can't throw here, since it would give no meaningful message.
* Throwing at one level up is better.
*/
return SAI_OBJECT_TYPE_NULL;
}
// NOTE: we could also check:
// - if object id has correct global context
// - if object id has existing switch index
// but then this method can't be made static
return objectType;
}
void VirtualObjectIdManager::clear()
{
SWSS_LOG_ENTER();
SWSS_LOG_NOTICE("clearing switch index set");
m_switchIndexes.clear();
}
void VirtualObjectIdManager::releaseSwitchIndex(
_In_ uint32_t index)
{
SWSS_LOG_ENTER();
auto it = m_switchIndexes.find(index);
if (it == m_switchIndexes.end())
{
SWSS_LOG_THROW("switch index 0x%x is invalid! programming error", index);
}
m_switchIndexes.erase(it);
SWSS_LOG_DEBUG("released switch index 0x%x", index);
}
sai_object_id_t VirtualObjectIdManager::allocateNewObjectId(
_In_ sai_object_type_t objectType,
_In_ sai_object_id_t switchId)
{
SWSS_LOG_ENTER();
if (sai_metadata_is_object_type_valid(objectType) == false)
{
SWSS_LOG_THROW("invalid object type: %d", objectType);
}
if (objectType == SAI_OBJECT_TYPE_SWITCH)
{
SWSS_LOG_THROW("this function can't be used to allocate switch id");
}
sai_object_type_t switchObjectType = saiObjectTypeQuery(switchId);
if (switchObjectType != SAI_OBJECT_TYPE_SWITCH)
{
SWSS_LOG_THROW("object type of switch %s is %s, should be SWITCH",
sai_serialize_object_id(switchId).c_str(),
sai_serialize_object_type(switchObjectType).c_str());
}
uint32_t switchIndex = (uint32_t)SAI_REDIS_GET_SWITCH_INDEX(switchId);
uint64_t objectIndex = m_oidIndexGenerator->increment(); // get new object index
const uint64_t indexMax = SAI_REDIS_OBJECT_INDEX_MAX;
if (objectIndex > SAI_REDIS_OBJECT_INDEX_MAX)
{
SWSS_LOG_THROW("no more object indexes available, given: 0x%" PRIx64 " but limit is 0x%" PRIx64 " ",
objectIndex,
indexMax);
}
sai_object_id_t objectId = constructObjectId(objectType, switchIndex, objectIndex, m_globalContext);
SWSS_LOG_DEBUG("created VID %s",
sai_serialize_object_id(objectId).c_str());
return objectId;
}
sai_object_id_t VirtualObjectIdManager::allocateNewSwitchObjectId(
_In_ const std::string& hardwareInfo)
{
SWSS_LOG_ENTER();
auto config = m_container->getConfig(hardwareInfo);
if (config == nullptr)
{
SWSS_LOG_ERROR("no switch config for hardware info: '%s'", hardwareInfo.c_str());
return SAI_NULL_OBJECT_ID;
}
uint32_t switchIndex = config->m_switchIndex;
if (switchIndex > SAI_REDIS_SWITCH_INDEX_MAX)
{
SWSS_LOG_THROW("switch index %u > %llu (max)", switchIndex, SAI_REDIS_SWITCH_INDEX_MAX);
}
if (m_switchIndexes.find(switchIndex) != m_switchIndexes.end())
{
// this could happen, if we first create switch with INIT=true, and
// then with INIT=false but we should have other way to not double call
// allocate to obtain existing switch ID, like from switch container
SWSS_LOG_WARN("switch index %u already allocated, double call to allocate!", switchIndex);
}
m_switchIndexes.insert(switchIndex);
sai_object_id_t objectId = constructObjectId(SAI_OBJECT_TYPE_SWITCH, switchIndex, switchIndex, m_globalContext);
SWSS_LOG_NOTICE("created SWITCH VID %s for hwinfo: '%s'",
sai_serialize_object_id(objectId).c_str(),
hardwareInfo.c_str());
return objectId;
}
void VirtualObjectIdManager::releaseObjectId(
_In_ sai_object_id_t objectId)
{
SWSS_LOG_ENTER();
if (saiObjectTypeQuery(objectId) == SAI_OBJECT_TYPE_SWITCH)
{
releaseSwitchIndex((uint32_t)SAI_REDIS_GET_SWITCH_INDEX(objectId));
}
}
sai_object_id_t VirtualObjectIdManager::constructObjectId(
_In_ sai_object_type_t objectType,
_In_ uint32_t switchIndex,
_In_ uint64_t objectIndex,
_In_ uint32_t globalContext)
{
SWSS_LOG_ENTER();
if (sai_metadata_is_object_type_valid(objectType) == false)
{
SWSS_LOG_THROW("FATAL: invalid object type (0x%x), logic error, this is a bug!", objectType);
}
uint64_t extensionsFlag = (uint64_t)objectType >= SAI_OBJECT_TYPE_EXTENSIONS_RANGE_START;
objectType = extensionsFlag
? (sai_object_type_t)(objectType - SAI_OBJECT_TYPE_EXTENSIONS_RANGE_START)
: objectType;
return (sai_object_id_t)(
((uint64_t)switchIndex << (SAI_REDIS_OBJECT_TYPE_BITS_SIZE + SAI_REDIS_GLOBAL_CONTEXT_BITS_SIZE + SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE + SAI_REDIS_OBJECT_INDEX_BITS_SIZE)) |
((uint64_t)objectType << (SAI_REDIS_GLOBAL_CONTEXT_BITS_SIZE + SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE + SAI_REDIS_OBJECT_INDEX_BITS_SIZE)) |
((uint64_t)globalContext << (SAI_REDIS_OBJECT_TYPE_EXTENSIONS_FLAG_BITS_SIZE + SAI_REDIS_OBJECT_INDEX_BITS_SIZE)) |
((uint64_t)extensionsFlag << (SAI_REDIS_OBJECT_INDEX_BITS_SIZE)) |
objectIndex);
}
sai_object_id_t VirtualObjectIdManager::switchIdQuery(
_In_ sai_object_id_t objectId)
{
SWSS_LOG_ENTER();
if (objectId == SAI_NULL_OBJECT_ID)
{
return SAI_NULL_OBJECT_ID;
}
sai_object_type_t objectType = objectTypeQuery(objectId);
if (objectType == SAI_OBJECT_TYPE_NULL)
{
SWSS_LOG_ERROR("invalid object type of oid %s",
sai_serialize_object_id(objectId).c_str());
return SAI_NULL_OBJECT_ID;
}
if (objectType == SAI_OBJECT_TYPE_SWITCH)
{
return objectId;
}
uint32_t switchIndex = (uint32_t)SAI_REDIS_GET_SWITCH_INDEX(objectId);
uint32_t globalContext = (uint32_t)SAI_REDIS_GET_GLOBAL_CONTEXT(objectId);
return constructObjectId(SAI_OBJECT_TYPE_SWITCH, switchIndex, switchIndex, globalContext);
}
sai_object_type_t VirtualObjectIdManager::objectTypeQuery(
_In_ sai_object_id_t objectId)
{
SWSS_LOG_ENTER();
if (objectId == SAI_NULL_OBJECT_ID)
{
return SAI_OBJECT_TYPE_NULL;
}
sai_object_type_t objectType = SAI_REDIS_GET_OBJECT_TYPE_EXTENSIONS_FLAG(objectId)
? (sai_object_type_t)(SAI_REDIS_GET_OBJECT_TYPE(objectId) + SAI_OBJECT_TYPE_EXTENSIONS_RANGE_START)
: (sai_object_type_t)(SAI_REDIS_GET_OBJECT_TYPE(objectId));
if (!sai_metadata_is_object_type_valid(objectType))
{
SWSS_LOG_ERROR("invalid object id %s",
sai_serialize_object_id(objectId).c_str());
return SAI_OBJECT_TYPE_NULL;
}
return objectType;
}
uint32_t VirtualObjectIdManager::getSwitchIndex(
_In_ sai_object_id_t objectId)
{
SWSS_LOG_ENTER();
auto switchId = switchIdQuery(objectId);
return (uint32_t)SAI_REDIS_GET_SWITCH_INDEX(switchId);
}
uint32_t VirtualObjectIdManager::getGlobalContext(
_In_ sai_object_id_t objectId)
{
SWSS_LOG_ENTER();
auto switchId = switchIdQuery(objectId);
return (uint32_t)SAI_REDIS_GET_GLOBAL_CONTEXT(switchId);
}
uint64_t VirtualObjectIdManager::getObjectIndex(
_In_ sai_object_id_t objectId)
{
SWSS_LOG_ENTER();
return (uint32_t)SAI_REDIS_GET_OBJECT_INDEX(objectId);
}
sai_object_id_t VirtualObjectIdManager::updateObjectIndex(
_In_ sai_object_id_t objectId,
_In_ uint64_t objectIndex)
{
SWSS_LOG_ENTER();
if (objectId == SAI_NULL_OBJECT_ID)
{
SWSS_LOG_THROW("can't update object index on NULL_OBJECT_ID");
}
if (objectIndex > SAI_REDIS_OBJECT_INDEX_MAX)
{
SWSS_LOG_THROW("object index %lu over maximum %llu", objectIndex, SAI_REDIS_OBJECT_INDEX_MAX);
}
sai_object_type_t objectType = objectTypeQuery(objectId);
if (objectType == SAI_OBJECT_TYPE_NULL)
{
SWSS_LOG_THROW("invalid object type of oid %s",
sai_serialize_object_id(objectId).c_str());
}
uint32_t switchIndex = (uint32_t)SAI_REDIS_GET_SWITCH_INDEX(objectId);
uint32_t globalContext = (uint32_t)SAI_REDIS_GET_GLOBAL_CONTEXT(objectId);
return constructObjectId(objectType, switchIndex, objectIndex, globalContext);
}