-
Notifications
You must be signed in to change notification settings - Fork 587
/
NodeStore.c
559 lines (492 loc) · 20.2 KB
/
NodeStore.c
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
/* vim: set expandtab ts=4 sw=4: */
/*
* You may redistribute this program and/or modify it under the terms of
* the GNU General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#define string_strlen
#define string_strcpy
#include "admin/Admin.h"
#include "benc/Int.h"
#include "benc/List.h"
#include "benc/Dict.h"
#include "benc/String.h"
#include "benc/Object.h"
#include "crypto/AddressCalc.h"
#include "dht/Address.h"
#include "dht/CJDHTConstants.h"
#include "dht/dhtcore/DistanceNodeCollector.h"
#include "dht/dhtcore/LinkStateNodeCollector.h"
#include "dht/dhtcore/Node.h"
#include "dht/dhtcore/NodeHeader.h"
#include "dht/dhtcore/NodeStore_pvt.h"
#include "dht/dhtcore/NodeCollector.h"
#include "dht/dhtcore/NodeList.h"
#include "util/platform/libc/string.h"
#include "util/Assert.h"
#include "util/Bits.h"
#include "util/log/Log.h"
#include "util/version/Version.h"
#include "switch/NumberCompress.h"
#include "switch/LabelSplicer.h"
#include <stdbool.h>
#include <stdio.h>
#include <inttypes.h>
static void dumpTable(Dict* msg, void* vnodeStore, String* txid);
/** See: NodeStore.h */
struct NodeStore* NodeStore_new(struct Address* myAddress,
const uint32_t capacity,
const struct Allocator* allocator,
struct Log* logger,
struct Admin* admin)
{
struct NodeStore* out = Allocator_malloc(allocator, sizeof(struct NodeStore));
out->thisNodeAddress = myAddress;
out->headers = Allocator_calloc(allocator, sizeof(struct NodeHeader), capacity);
out->nodes = Allocator_calloc(allocator, sizeof(struct Node), capacity);
out->capacity = capacity;
out->logger = logger;
out->size = 0;
out->admin = admin;
out->labelSum = 0;
struct Admin_FunctionArg adma[1] = {
{ .name = "page", .required = 1, .type = "Int" },
};
Admin_registerFunction("NodeStore_dumpTable", dumpTable, out, false, adma, admin);
return out;
}
static struct Node* nodeForIndex(struct NodeStore* store, uint32_t index)
{
struct Node* out = &store->nodes[index];
out->reach = store->headers[index].reach;
out->version = store->headers[index].version;
return out;
}
/** See: NodeStore.h */
struct Node* NodeStore_getNode(struct NodeStore* store, struct Address* addr)
{
uint32_t pfx = Address_getPrefix(addr);
// If multiple nodes with the same address, get the one with the best reach.
int32_t bestIndex = -1;
uint32_t bestReach = 0;
for (int32_t i = 0; i < (int32_t) store->size; i++) {
if (pfx == store->headers[i].addressPrefix
&& Bits_memcmp(addr->key, store->nodes[i].address.key, Address_KEY_SIZE) == 0
&& store->headers[i].reach >= bestReach)
{
bestIndex = i;
bestReach = store->headers[i].reach;
}
}
if (bestIndex == -1) {
return NULL;
}
// Synchronize the reach values.
return nodeForIndex(store, bestIndex);
}
static inline uint32_t getSwitchIndex(struct Address* addr)
{
uint32_t bits = NumberCompress_bitsUsedForLabel(addr->path);
return NumberCompress_getDecompressed(addr->path, bits);
}
static inline void replaceNode(struct Node* nodeToReplace,
struct NodeHeader* headerToReplace,
struct Address* addr,
struct NodeStore* store)
{
headerToReplace->addressPrefix = Address_getPrefix(addr);
headerToReplace->reach = 0;
headerToReplace->version = 0;
headerToReplace->switchIndex = getSwitchIndex(addr);
store->labelSum -= Bits_log2x64(nodeToReplace->address.path);
store->labelSum += Bits_log2x64(addr->path);
Assert_true(store->labelSum > 0);
Bits_memcpyConst(&nodeToReplace->address, addr, sizeof(struct Address));
}
#ifdef Log_DEBUG
static void logNodeZeroed(struct Log* logger, struct Node* node)
{
uint8_t ip6[40];
AddrTools_printIp(ip6, node->address.ip6.bytes);
Log_debug(logger, "Zeroing reach for node [%s]", ip6);
}
#else
#define logNodeZeroed(x, y)
#endif
static struct Node* nodeForHeader(struct NodeHeader* header, struct NodeStore* store)
{
return nodeForIndex(store, header - store->headers);
}
static inline void adjustReach(struct NodeHeader* header,
const int64_t reachDiff,
struct NodeStore* store)
{
if (reachDiff == 0) {
return;
}
int64_t newReach = reachDiff + header->reach;
if (newReach <= 0) {
header->reach = 0;
logNodeZeroed(store->logger, nodeForHeader(header, store));
} else if (newReach > INT32_MAX) {
header->reach = INT32_MAX;
} else {
header->reach = (uint32_t) newReach;
}
}
struct Node* NodeStore_addNode(struct NodeStore* store,
struct Address* addr,
int64_t reachDifference,
uint32_t version)
{
if (!Version_isCompatible(Version_CURRENT_PROTOCOL, version)) {
Log_debug(store->logger, "node with incompatable version");
return NULL;
}
uint32_t pfx = Address_getPrefix(addr);
if (Bits_memcmp(addr->ip6.bytes, store->thisNodeAddress, 16) == 0) {
Log_debug(store->logger, "got introduced to ourselves");
return NULL;
}
if (!AddressCalc_validAddress(addr->ip6.bytes)) {
uint8_t address[60];
Address_print(address, addr);
Log_critical(store->logger,
"tried to insert address %s which does not begin with 0xFC.\n",
address);
Assert_true(false);
}
// Keep track of the worst node so if the store is full, it can be replaced.
int worstNode = 0;
int64_t worstValue = INT64_MAX;
for (int i = 0; i < store->size; i++) {
if (store->headers[i].addressPrefix == pfx
&& Address_isSameIp(&store->nodes[i].address, addr))
{
if (store->nodes[i].address.path == addr->path) {
// same address...
} else if (LabelSplicer_routesThrough(store->nodes[i].address.path, addr->path)) {
#ifdef Log_DEBUG
uint8_t nodeAddr[60];
Address_print(nodeAddr, &store->nodes[i].address);
uint8_t newAddr[20];
AddrTools_printPath(newAddr, addr->path);
Log_debug(store->logger,
"Found a better route to %s via %s\n",
nodeAddr,
newAddr);
#endif
// Remove the node and continue on to add this one.
// If we just change the path, we get duplicates.
NodeStore_remove(&store->nodes[i], store);
i--;
continue;
} else if (!LabelSplicer_routesThrough(addr->path, store->nodes[i].address.path)) {
// Completely different routes, store seperately.
continue;
}
/*#ifdef Log_DEBUG
uint32_t oldReach = store->headers[i].reach;
#endif*/
adjustReach(&store->headers[i], reachDifference, store);
if (version) {
store->headers[i].version = version;
}
/*#ifdef Log_DEBUG
if (oldReach != store->headers[i].reach) {
uint8_t nodeAddr[60];
Address_print(nodeAddr, addr);
Log_debug(store->logger,
"Altering reach for node %s, old reach %u, new reach %u.\n",
nodeAddr,
oldReach,
store->headers[i].reach);
if (oldReach > store->headers[i].reach) {
Log_debug(store->logger, "Reach was decreased!\n");
}
}
#endif*/
return nodeForIndex(store, i);
}
if (store->size >= store->capacity) {
// keep track of the worst node so it can be replaced.
int64_t value = ((int64_t)store->headers[i].reach)
- (Address_getPrefix(store->thisNodeAddress) ^ store->headers[i].addressPrefix);
if (value < worstValue) {
worstValue = value;
worstNode = i;
}
}
#ifdef Log_DEBUG
if (store->headers[i].addressPrefix == pfx) {
uint8_t realAddr[16];
AddressCalc_addressForPublicKey(realAddr, addr->key);
Assert_true(!Bits_memcmp(realAddr, addr->ip6.bytes, 16));
}
#endif
}
#ifdef Log_DEBUG
uint8_t nodeAddr[60];
Address_print(nodeAddr, addr);
Log_debug(store->logger,
"Discovered node: %s reach %" PRIu64,
nodeAddr,
reachDifference);
#endif
for (int i = 0; i < store->size; i++) {
Assert_true(store->headers[i].addressPrefix == Address_getPrefix(&store->nodes[i].address));
Assert_true(!(!Bits_memcmp(&store->nodes[i].address.ip6, &addr->ip6, 16)
&& store->nodes[i].address.path == addr->path));
}
int insertionIndex = (store->size >= store->capacity) ? worstNode : store->size++;
replaceNode(&store->nodes[insertionIndex], &store->headers[insertionIndex], addr, store);
adjustReach(&store->headers[insertionIndex], reachDifference, store);
store->headers[insertionIndex].version = version;
return nodeForIndex(store, insertionIndex);
}
struct Node* NodeStore_getBest(struct Address* targetAddress, struct NodeStore* store)
{
struct NodeCollector_Element element = {
.value = 0,
.distance = UINT32_MAX,
.node = NULL
};
struct NodeCollector collector = {
.capacity = 1,
.targetPrefix = Address_getPrefix(targetAddress),
.targetAddress = targetAddress,
.nodes = &element,
.logger = store->logger
};
collector.thisNodeDistance =
Address_getPrefix(store->thisNodeAddress) ^ collector.targetPrefix;
for (int i = 0; i < store->size; i++) {
if (store->headers[i].reach != 0) {
LinkStateNodeCollector_addNode(store->headers + i, store->nodes + i, &collector);
}
}
return element.node ? nodeForHeader(element.node, store) : NULL;
}
struct NodeList* NodeStore_getNodesByAddr(struct Address* address,
const uint32_t max,
const struct Allocator* allocator,
struct NodeStore* store)
{
struct NodeCollector* collector = NodeCollector_new(address,
max,
store->thisNodeAddress,
true,
store->logger,
allocator);
for (int i = 0; i < store->size; i++) {
DistanceNodeCollector_addNode(store->headers + i, store->nodes + i, collector);
}
struct NodeList* out = Allocator_malloc(allocator, sizeof(struct NodeList));
out->nodes = Allocator_malloc(allocator, max * sizeof(char*));
uint32_t outIndex = 0;
for (uint32_t i = 0; i < max; i++) {
if (collector->nodes[i].node != NULL
&& !Bits_memcmp(collector->nodes[i].body->address.ip6.bytes, address->ip6.bytes, 16))
{
out->nodes[outIndex] = collector->nodes[i].body;
outIndex++;
}
}
out->size = outIndex;
return out;
}
/** See: NodeStore.h */
struct NodeList* NodeStore_getClosestNodes(struct NodeStore* store,
struct Address* targetAddress,
struct Address* requestorsAddress,
const uint32_t count,
bool allowNodesFartherThanUs,
uint32_t versionOfRequestingNode,
const struct Allocator* allocator)
{
// LinkStateNodeCollector strictly requires that allowNodesFartherThanUs be true.
struct NodeCollector* collector = NodeCollector_new(targetAddress,
count,
store->thisNodeAddress,
true,
store->logger,
allocator);
// Don't send nodes which route back to the node which asked us.
uint32_t index = (requestorsAddress) ? getSwitchIndex(requestorsAddress) : 0;
// naive implementation, todo make this faster
for (int i = 0; i < store->size; i++) {
if (requestorsAddress && store->headers[i].switchIndex == index) {
// Nodes which are down the same interface as the node who asked.
continue;
}
if (!Version_isCompatible(store->headers[i].version, versionOfRequestingNode)) {
// Known not to be compatable.
continue;
}
LinkStateNodeCollector_addNode(store->headers + i, store->nodes + i, collector);
}
struct NodeList* out = Allocator_malloc(allocator, sizeof(struct NodeList));
out->nodes = Allocator_malloc(allocator, count * sizeof(char*));
uint32_t outIndex = 0;
for (uint32_t i = 0; i < count; i++) {
if (collector->nodes[i].node != NULL) {
out->nodes[outIndex] = nodeForHeader(collector->nodes[i].node, store);
outIndex++;
}
}
out->size = outIndex;
return out;
}
/** See: NodeStore.h */
void NodeStore_updateReach(const struct Node* const node,
const struct NodeStore* const store)
{
store->headers[node - store->nodes].reach = node->reach;
uint64_t path = node->address.path;
for (int i = 0; i < store->size; i++) {
uint64_t dest = store->nodes[i].address.path;
if (LabelSplicer_routesThrough(dest, path)) {
if (store->headers[i].reach > node->reach) {
store->headers[i].reach = node->reach;
if (node->reach == 0) {
logNodeZeroed(store->logger, &store->nodes[i]);
}
}
} else if (LabelSplicer_routesThrough(path, dest)) {
/* BUG:
* When a switch restarts, it repopulates it's slots in random order.
* Nodes have stale entries in their tables that predate the switch restart.
* these entries contain valid keys with valid paths but the key does not match
* the path. Worse these nodes share the stale routes with others.
*
* Normally the reach of nodes which are invalid is set to 0 and they are not
* bothered with anymore. Unfortunately in this case, the path is valid and
* there are valid entries which are "behind" that node.
* When one of these nodes is pinged, it's reach is updated and the invalid node
* gets it's reach updated at the same time so it will potentially be selected for
* forwarding a packet to.
*
* This is a temporary workaround which just skips increasing the reach for a node
* whose reach is 0 so that these stale nodes will not do damage.
*/
if (store->headers[i].reach < node->reach && store->headers[i].reach != 0) {
store->headers[i].reach = node->reach;
}
}
}
}
uint32_t NodeStore_size(const struct NodeStore* const store)
{
return store->size;
}
/** see: NodeStore.h */
struct Node* NodeStore_getNodeByNetworkAddr(uint64_t path, struct NodeStore* store)
{
if (path == 0) {
return (store->size > 0) ? &store->nodes[rand() % store->size] : NULL;
}
for (int i = 0; i < store->size; i++) {
if (path == store->nodes[i].address.path) {
return nodeForIndex(store, i);
}
}
return NULL;
}
void NodeStore_remove(struct Node* node, struct NodeStore* store)
{
Assert_true(node >= store->nodes && node < store->nodes + store->size);
#ifdef Log_DEBUG
uint8_t addr[60];
Address_print(addr, &node->address);
Log_debug(store->logger, "Removing route to %s\n", addr);
#endif
store->size--;
if (node != &store->nodes[store->size]) {
Bits_memcpyConst(node, &store->nodes[store->size], sizeof(struct Node));
struct NodeHeader* header = &store->headers[node - store->nodes];
Bits_memcpyConst(header, &store->headers[store->size], sizeof(struct NodeHeader));
}
// This is needed because otherwise replaceNode will cause the labelSum to skew.
store->nodes[store->size].address.path = 0;
}
int NodeStore_brokenPath(uint64_t path, struct NodeStore* store)
{
int out = 0;
for (int32_t i = (int32_t) store->size - 1; i >= 0; i--) {
if (LabelSplicer_routesThrough(store->nodes[i].address.path, path)) {
if (!LabelSplicer_isOneHop(store->nodes[i].address.path)) {
NodeStore_remove(&store->nodes[i], store);
out++;
} else {
logNodeZeroed(store->logger, &store->nodes[i]);
store->headers[i].reach = 0;
}
}
}
return out;
}
static void sendEntries(struct NodeStore* store,
struct List_Item* last,
bool isMore,
String* txid)
{
Dict table = Dict_CONST(String_CONST("routingTable"), List_OBJ(&last), NULL);
if (isMore) {
table = Dict_CONST(String_CONST("more"), Int_OBJ(1), table);
} else {
// the self route is synthetic so add 1 to the count.
table = Dict_CONST(String_CONST("count"), Int_OBJ(store->size + 1), table);
}
Admin_sendMessage(&table, txid, store->admin);
}
#define ENTRIES_PER_PAGE 8
static void addRoutingTableEntries(struct NodeStore* store,
int i,
int j,
struct List_Item* last,
String* txid)
{
uint8_t path[20];
uint8_t ip[40];
String* pathStr = &(String) { .len = 19, .bytes = (char*)path };
String* ipStr = &(String) { .len = 39, .bytes = (char*)ip };
Object* link = Int_OBJ(0xFFFFFFFF);
Object* version = Int_OBJ(Version_CURRENT_PROTOCOL);
Dict entry = Dict_CONST(
String_CONST("ip"), String_OBJ(ipStr), Dict_CONST(
String_CONST("link"), link, Dict_CONST(
String_CONST("path"), String_OBJ(pathStr), Dict_CONST(
String_CONST("version"), version, NULL
))));
struct List_Item next = { .next = last, .elem = Dict_OBJ(&entry) };
if (i >= store->size || j >= ENTRIES_PER_PAGE) {
if (i > j) {
sendEntries(store, last, (j >= ENTRIES_PER_PAGE), txid);
return;
}
Address_printIp(ip, store->thisNodeAddress);
strcpy((char*)path, "0000.0000.0000.0001");
sendEntries(store, &next, (j >= ENTRIES_PER_PAGE), txid);
return;
}
link->as.number = store->headers[i].reach;
version->as.number = store->headers[i].version;
Address_printIp(ip, &store->nodes[i].address);
AddrTools_printPath(path, store->nodes[i].address.path);
addRoutingTableEntries(store, i + 1, j + 1, &next, txid);
}
static void dumpTable(Dict* args, void* vnodeStore, String* txid)
{
struct NodeStore* store = (struct NodeStore*) vnodeStore;
int64_t* page = Dict_getInt(args, String_CONST("page"));
int i = (page) ? *page * ENTRIES_PER_PAGE : 0;
addRoutingTableEntries(store, i, 0, NULL, txid);
}