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
|
/*
* Copyright (c) 2017-2019 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Event based router
*
* This module is the glue around the event scheduler.
* Its the packet i/o module.
*
* Packet processing is done in dispatcher.c, which is the actual wrapper around
* the event scheduler
*/
#include <errno.h>
#include <fcntl.h>
#include <signal.h>
#include <src/config.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include <arpa/inet.h>
#include <sys/socket.h>
#define __STDC_FORMAT_MACROS
#include <inttypes.h>
#include <parc/algol/parc_ArrayList.h>
#include <parc/algol/parc_Memory.h>
#include <parc/algol/parc_Object.h>
#include <parc/logging/parc_LogReporterTextStdout.h>
#include <src/core/connectionManager.h>
#include <src/core/connectionTable.h>
#include <src/core/dispatcher.h>
#include <src/core/forwarder.h>
#include <src/core/messagePacketType.h>
#ifdef WITH_MAPME
#include <src/core/mapMe.h>
#endif /* WITH_MAPME */
#include <src/config/configuration.h>
#include <src/config/configurationFile.h>
#include <src/config/configurationListeners.h>
#include <src/processor/messageProcessor.h>
#include <src/core/wldr.h>
#include <parc/assert/parc_Assert.h>
// the router's clock frequency (we now use the monotonic clock)
#define HZ 1000
// these will all be a little off because its all integer division
#define MSEC_PER_TICK (1000 / HZ)
#define USEC_PER_TICK (1000000 / HZ)
#define NSEC_PER_TICK ((1000000000ULL) / HZ)
#define MSEC_TO_TICKS(msec) \
((msec < FC_MSEC_PER_TICK) ? 1 : msec / FC_MSEC_PER_TICK)
#define NSEC_TO_TICKS(nsec) ((nsec < NSEC_PER_TICK) ? 1 : nsec / NSEC_PER_TICK)
struct forwarder {
Dispatcher *dispatcher;
uint16_t server_port;
PARCEventSignal *signal_int;
PARCEventSignal *signal_term;
PARCEventSignal *signal_usr1;
PARCEventTimer *keepalive_event;
// will skew the virtual clock forward. In normal operaiton, it is 0.
Ticks clockOffset;
unsigned nextConnectionid;
Messenger *messenger;
ConnectionManager *connectionManager;
ConnectionTable *connectionTable;
ListenerSet *listenerSet;
Configuration *config;
// we'll eventually want to setup a threadpool of these
MessageProcessor *processor;
Logger *logger;
PARCClock *clock;
hicn_socket_helper_t
*hicnSocketHelper; // state required to manage hicn connections
// used by seed48 and nrand48
unsigned short seed[3];
#ifdef WITH_MAPME
MapMe *mapme;
#endif /* WITH_MAPME */
};
// signal traps through the event scheduler
static void _signal_cb(int, PARCEventType, void *);
// A no-op keepalive to prevent Libevent from exiting the dispatch loop
static void _keepalive_cb(int, PARCEventType, void *);
/**
* Reseed our pseudo-random number generator.
*/
static void forwarder_Seed(Forwarder *forwarder) {
int fd;
ssize_t res;
res = -1;
fd = open("/dev/urandom", O_RDONLY);
if (fd != -1) {
res = read(fd, forwarder->seed, sizeof(forwarder->seed));
close(fd);
}
if (res != sizeof(forwarder->seed)) {
forwarder->seed[1] = (unsigned short)getpid(); /* better than no entropy */
forwarder->seed[2] = (unsigned short)time(NULL);
}
/*
* The call to seed48 is needed by cygwin, and should be harmless
* on other platforms.
*/
seed48(forwarder->seed);
}
Logger *forwarder_GetLogger(const Forwarder *forwarder) {
return forwarder->logger;
}
// ============================================================================
// Setup and destroy section
Forwarder *forwarder_Create(Logger *logger) {
Forwarder *forwarder = parcMemory_AllocateAndClear(sizeof(Forwarder));
parcAssertNotNull(forwarder, "parcMemory_AllocateAndClear(%zu) returned NULL",
sizeof(Forwarder));
memset(forwarder, 0, sizeof(Forwarder));
forwarder_Seed(forwarder);
forwarder->clock = parcClock_Monotonic();
forwarder->clockOffset = 0;
if (logger) {
forwarder->logger = logger_Acquire(logger);
logger_SetClock(forwarder->logger, forwarder->clock);
} else {
PARCLogReporter *reporter = parcLogReporterTextStdout_Create();
forwarder->logger = logger_Create(reporter, forwarder->clock);
parcLogReporter_Release(&reporter);
}
forwarder->nextConnectionid = 1;
forwarder->dispatcher = dispatcher_Create(forwarder->logger);
forwarder->messenger = messenger_Create(forwarder->dispatcher);
forwarder->connectionManager = connectionManager_Create(forwarder);
forwarder->connectionTable = connectionTable_Create();
forwarder->listenerSet = listenerSet_Create();
forwarder->config = configuration_Create(forwarder);
forwarder->processor = messageProcessor_Create(forwarder);
forwarder->signal_term = dispatcher_CreateSignalEvent(
forwarder->dispatcher, _signal_cb, forwarder, SIGTERM);
dispatcher_StartSignalEvent(forwarder->dispatcher, forwarder->signal_term);
forwarder->signal_int = dispatcher_CreateSignalEvent(
forwarder->dispatcher, _signal_cb, forwarder, SIGINT);
dispatcher_StartSignalEvent(forwarder->dispatcher, forwarder->signal_int);
forwarder->signal_usr1 = dispatcher_CreateSignalEvent(
forwarder->dispatcher, _signal_cb, forwarder, SIGPIPE);
dispatcher_StartSignalEvent(forwarder->dispatcher, forwarder->signal_usr1);
#ifndef __APPLE__
forwarder->hicnSocketHelper = hicn_create();
if (forwarder->hicnSocketHelper == NULL) return NULL;
#endif /* __APPLE__ */
/* ignore child */
signal(SIGCHLD, SIG_IGN);
/* ignore tty signals */
signal(SIGTSTP, SIG_IGN);
signal(SIGTTOU, SIG_IGN);
signal(SIGTTIN, SIG_IGN);
// We no longer use this for ticks, but we need to have at least one event
// schedule to keep Libevent happy.
struct timeval wtnow_timeout;
timerclear(&wtnow_timeout);
wtnow_timeout.tv_sec = 0;
wtnow_timeout.tv_usec = 50000; // 20 Hz keepalive
#ifdef WITH_MAPME
if (!(mapMe_Init(&forwarder->mapme, forwarder))) return NULL;
#endif /* WITH_MAPME */
PARCEventScheduler *base =
dispatcher_GetEventScheduler(forwarder->dispatcher);
forwarder->keepalive_event = parcEventTimer_Create(
base, PARCEventType_Persist, _keepalive_cb, (void *)forwarder);
parcEventTimer_Start(forwarder->keepalive_event, &wtnow_timeout);
return forwarder;
}
void forwarder_Destroy(Forwarder **ptr) {
parcAssertNotNull(ptr, "Parameter must be non-null double pointer");
parcAssertNotNull(*ptr, "Parameter must dereference to non-null pointer");
Forwarder *forwarder = *ptr;
#if !defined(__APPLE__) && !defined(__ANDROID__)
hicn_destroy();
#endif
parcEventTimer_Destroy(&(forwarder->keepalive_event));
listenerSet_Destroy(&(forwarder->listenerSet));
connectionManager_Destroy(&(forwarder->connectionManager));
connectionTable_Destroy(&(forwarder->connectionTable));
messageProcessor_Destroy(&(forwarder->processor));
configuration_Destroy(&(forwarder->config));
// the messenger is used by many of the other pieces, so destroy it last
messenger_Destroy(&(forwarder->messenger));
dispatcher_DestroySignalEvent(forwarder->dispatcher,
&(forwarder->signal_int));
dispatcher_DestroySignalEvent(forwarder->dispatcher,
&(forwarder->signal_term));
dispatcher_DestroySignalEvent(forwarder->dispatcher,
&(forwarder->signal_usr1));
parcClock_Release(&forwarder->clock);
logger_Release(&forwarder->logger);
// do the dispatcher last
dispatcher_Destroy(&(forwarder->dispatcher));
parcMemory_Deallocate((void **)&forwarder);
*ptr = NULL;
}
void forwarder_SetupAllListeners(Forwarder *forwarder, uint16_t port,
const char *localPath) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
configurationListeners_SetupAll(forwarder->config, port, localPath);
}
void forwarder_SetupFromConfigFile(Forwarder *forwarder, const char *filename) {
ConfigurationFile *configFile = configurationFile_Create(forwarder, filename);
if (configFile) {
configurationFile_Process(configFile);
configurationFile_Release(&configFile);
}
}
Configuration *forwarder_GetConfiguration(Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return forwarder->config;
}
// ============================================================================
unsigned forwarder_GetNextConnectionId(Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return forwarder->nextConnectionid++;
}
Messenger *forwarder_GetMessenger(Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return forwarder->messenger;
}
Dispatcher *forwarder_GetDispatcher(Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return forwarder->dispatcher;
}
ConnectionTable *forwarder_GetConnectionTable(Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return forwarder->connectionTable;
}
ListenerSet *forwarder_GetListenerSet(Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return forwarder->listenerSet;
}
void forwarder_SetChacheStoreFlag(Forwarder *forwarder, bool val) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
messageProcessor_SetCacheStoreFlag(forwarder->processor, val);
}
bool forwarder_GetChacheStoreFlag(Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return messageProcessor_GetCacheStoreFlag(forwarder->processor);
}
void forwarder_SetChacheServeFlag(Forwarder *forwarder, bool val) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
messageProcessor_SetCacheServeFlag(forwarder->processor, val);
}
bool forwarder_GetChacheServeFlag(Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return messageProcessor_GetCacheServeFlag(forwarder->processor);
}
void forwarder_ReceiveCommand(Forwarder *forwarder, command_id command,
struct iovec *message, unsigned ingressId) {
configuration_ReceiveCommand(forwarder->config, command, message, ingressId);
}
void forwarder_Receive(Forwarder *forwarder, Message *message) {
parcAssertNotNull(forwarder, "Parameter hicn-light must be non-null");
parcAssertNotNull(message, "Parameter message must be non-null");
// this takes ownership of the message, so we're done here
// this are the checks needed to implement WLDR. We set wldr only on the STAs
// and we let the AP to react according to choise of the client.
// if the STA enables wldr using the set command, the AP enable wldr as well
// otherwise, if the STA disable it the AP remove wldr
// WLDR should be enabled only on the STAs using the command line
// TODO
// disable WLDR command line on the AP
const Connection *conn = connectionTable_FindById(
forwarder->connectionTable, message_GetIngressConnectionId(message));
if (!conn) {
return;
}
if (message_HasWldr(message)) {
if (connection_HasWldr(conn)) {
// case 1: WLDR is enabled
connection_DetectLosses((Connection *)conn, message);
} else if (!connection_HasWldr(conn) &&
connection_WldrAutoStartAllowed(conn)) {
// case 2: We are on an AP. We enable WLDR
connection_EnableWldr((Connection *)conn);
connection_DetectLosses((Connection *)conn, message);
}
// case 3: Ignore WLDR
} else {
if (connection_HasWldr(conn) && connection_WldrAutoStartAllowed(conn)) {
// case 1: STA do not use WLDR, we disable it
connection_DisableWldr((Connection *)conn);
}
}
messageProcessor_Receive(forwarder->processor, message);
}
Ticks forwarder_GetTicks(const Forwarder *forwarder) {
parcAssertNotNull(forwarder, "Parameter must be non-null");
return parcClock_GetTime(forwarder->clock) + forwarder->clockOffset;
}
Ticks forwarder_NanosToTicks(uint64_t nanos) { return NSEC_TO_TICKS(nanos); }
uint64_t forwarder_TicksToNanos(Ticks ticks) {
return (1000000000ULL) * ticks / HZ;
}
bool forwarder_AddOrUpdateRoute(Forwarder *forwarder,
add_route_command *control, unsigned ifidx) {
parcAssertNotNull(forwarder, "Parameter hicn-light must be non-null");
parcAssertNotNull(control, "Parameter route must be non-null");
// we only have one message processor
bool res =
messageProcessor_AddOrUpdateRoute(forwarder->processor, control, ifidx);
return res;
}
bool forwarder_RemoveRoute(Forwarder *forwarder, remove_route_command *control,
unsigned ifidx) {
parcAssertNotNull(forwarder, "Parameter hicn-light must be non-null");
parcAssertNotNull(control, "Parameter route must be non-null");
// we only have one message processor
return messageProcessor_RemoveRoute(forwarder->processor, control, ifidx);
}
void forwarder_RemoveConnectionIdFromRoutes(Forwarder *forwarder,
unsigned connectionId) {
parcAssertNotNull(forwarder, "Parameter hicn-light must be non-null");
messageProcessor_RemoveConnectionIdFromRoutes(forwarder->processor,
connectionId);
}
void forwarder_SetStrategy(Forwarder *forwarder, Name *prefix,
strategy_type strategy) {
parcAssertNotNull(forwarder, "Parameter hicn-light must be non-null");
parcAssertNotNull(prefix, "Parameter prefix must be non-null");
// if (strategy == NULL) {
// strategy = SET_STRATEGY_RANDOM;
// }
processor_SetStrategy(forwarder->processor, prefix, strategy);
}
FibEntryList *forwarder_GetFibEntries(Forwarder *forwarder) {
return messageProcessor_GetFibEntries(forwarder->processor);
}
void forwarder_SetContentObjectStoreSize(Forwarder *forwarder,
size_t maximumContentStoreSize) {
messageProcessor_SetContentObjectStoreSize(forwarder->processor,
maximumContentStoreSize);
}
void forwarder_ClearCache(Forwarder *forwarder) {
messageProcessor_ClearCache(forwarder->processor);
}
PARCClock *forwarder_GetClock(const Forwarder *forwarder) {
return forwarder->clock;
}
hicn_socket_helper_t *forwarder_GetHicnSocketHelper(Forwarder *forwarder) {
return forwarder->hicnSocketHelper;
}
// =======================================================
static void _signal_cb(int sig, PARCEventType events, void *user_data) {
Forwarder *forwarder = (Forwarder *)user_data;
logger_Log(forwarder->logger, LoggerFacility_Core, PARCLogLevel_Warning,
__func__, "signal %d events %d", sig, events);
switch ((int)sig) {
case SIGTERM:
logger_Log(forwarder->logger, LoggerFacility_Core, PARCLogLevel_Warning,
__func__, "Caught an terminate signal; exiting cleanly.");
dispatcher_Stop(forwarder->dispatcher);
break;
case SIGINT:
logger_Log(forwarder->logger, LoggerFacility_Core, PARCLogLevel_Warning,
__func__, "Caught an interrupt signal; exiting cleanly.");
dispatcher_Stop(forwarder->dispatcher);
break;
case SIGUSR1:
// dump stats
break;
default:
break;
}
}
static void _keepalive_cb(int fd, PARCEventType what, void *user_data) {
parcAssertTrue(what & PARCEventType_Timeout, "Got unexpected tick_cb: %d",
what);
// function is just a keepalive for hicn-light, does not do anything
}
#ifdef WITH_MAPME
FIB *forwarder_getFib(Forwarder *forwarder) {
return messageProcessor_getFib(forwarder->processor);
}
void forwarder_onConnectionAdded(Forwarder *forwarder, const Connection *conn) {
mapMe_onConnectionAdded(forwarder->mapme, conn);
}
void forwarder_onConnectionRemoved(Forwarder *forwarder,
const Connection *conn) {}
void forwarder_ProcessMapMe(Forwarder *forwarder, uint8_t *msgBuffer,
unsigned conn_id) {
mapMe_Process(forwarder->mapme, msgBuffer, conn_id);
}
#endif /* WITH_MAPME */
|