summaryrefslogtreecommitdiffstats
path: root/hicn-light/src/io/hicnConnection.c
blob: 85cf50921a12a9407a934f71cc474f7006f45721 (plain)
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
/*
 * 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.
 */

/**
 * Embodies the reader/writer for a HIcn connection
 *
 * NB The Send() function may overflow the output buffer
 *
 */

#include <errno.h>
#include <src/config.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>

#include <src/core/message.h>
#include <src/io/hicnConnection.h>

#include <src/core/messageHandler.h>

#include <parc/algol/parc_Hash.h>
#include <parc/algol/parc_Memory.h>
#include <parc/assert/parc_Assert.h>
#include <src/core/connection.h>
#include <src/core/forwarder.h>

typedef struct hicn_state {
  Forwarder *forwarder;
  Logger *logger;

  // the hicn listener socket we receive packets on
  int hicnListenerSocket;

  AddressPair *addressPair;

  // We need to access this all the time, so grab it out
  // of the addressPair;
  struct sockaddr *peerAddress;
  socklen_t peerAddressLength;

  struct sockaddr *localAddress;
  socklen_t localAddressLength;

  // this address contains one of the content names reachable
  // throught the connection peer. We need this address beacuse it is
  // the only way we have to conntact the next hop, since the main tun
  // does not have address. Notice that a connection that sends probes
  // is a connection that sends interest. In a "data" connection this
  // value will remain NULL. We refresh the content address every time
  // we send a probe, in this way we don't need to waste to much time in
  // copy the address, but we can also react to the routing changes
  struct sockaddr *probeDestAddress;
  socklen_t probeDestAddressLength;
  bool refreshProbeDestAddress;

  bool isLocal;
  bool isUp;
  unsigned id;

  unsigned delay;
} _HicnState;

// Prototypes
static bool _send(IoOperations *ops, const Address *nexthop, Message *message);
static const Address *_getRemoteAddress(const IoOperations *ops);
static const AddressPair *_getAddressPair(const IoOperations *ops);
static unsigned _getConnectionId(const IoOperations *ops);
static bool _isUp(const IoOperations *ops);
static bool _isLocal(const IoOperations *ops);
static void _destroy(IoOperations **opsPtr);
static list_connections_type _getConnectionType(const IoOperations *ops);
static Ticks _sendProbe(IoOperations *ops, unsigned probeType,
                        uint8_t *message);

/*
 * This assigns a unique pointer to the void * which we use
 * as a GUID for this class.
 */
static const void *_ioOperationsGuid = __FILE__;

/*
 * Return our GUID
 */
static const void *_streamConnection_Class(const IoOperations *ops) {
  return _ioOperationsGuid;
}

static IoOperations _template = {.closure = NULL,
                                 .send = &_send,
                                 .getRemoteAddress = &_getRemoteAddress,
                                 .getAddressPair = &_getAddressPair,
                                 .getConnectionId = &_getConnectionId,
                                 .isUp = &_isUp,
                                 .isLocal = &_isLocal,
                                 .destroy = &_destroy,
                                 .class = &_streamConnection_Class,
                                 .getConnectionType = &_getConnectionType,
                                 .sendProbe = &_sendProbe};

// =================================================================

static void _setConnectionState(_HicnState *HIcn, bool isUp);
static bool _saveSockaddr(_HicnState *hicnConnState, const AddressPair *pair);
static void _refreshProbeDestAddress(_HicnState *hicnConnState,
                                     const uint8_t *message);

IoOperations *hicnConnection_Create(Forwarder *forwarder, int fd,
                                    const AddressPair *pair, bool isLocal) {
  IoOperations *io_ops = NULL;

  _HicnState *hicnConnState = parcMemory_AllocateAndClear(sizeof(_HicnState));
  parcAssertNotNull(hicnConnState,
                    "parcMemory_AllocateAndClear(%zu) returned NULL",
                    sizeof(_HicnState));

  hicnConnState->forwarder = forwarder;
  hicnConnState->logger = logger_Acquire(forwarder_GetLogger(forwarder));

  bool saved = _saveSockaddr(hicnConnState, pair);
  if (saved) {
    hicnConnState->hicnListenerSocket = fd;
    hicnConnState->id = forwarder_GetNextConnectionId(forwarder);
    hicnConnState->addressPair = addressPair_Acquire(pair);
    hicnConnState->isLocal = isLocal;

    // allocate a connection
    io_ops = parcMemory_AllocateAndClear(sizeof(IoOperations));
    parcAssertNotNull(io_ops, "parcMemory_AllocateAndClear(%zu) returned NULL",
                      sizeof(IoOperations));
    memcpy(io_ops, &_template, sizeof(IoOperations));
    io_ops->closure = hicnConnState;

    _setConnectionState(hicnConnState, true);

    if (logger_IsLoggable(hicnConnState->logger, LoggerFacility_IO,
                          PARCLogLevel_Info)) {
      char *str = addressPair_ToString(hicnConnState->addressPair);
      logger_Log(hicnConnState->logger, LoggerFacility_IO, PARCLogLevel_Info,
                 __func__,
                 "HIcnConnection %p created for address %s (isLocal %d)",
                 (void *)hicnConnState, str, hicnConnState->isLocal);
      free(str);
    }

    messenger_Send(
        forwarder_GetMessenger(forwarder),
        missive_Create(MissiveType_ConnectionCreate, hicnConnState->id));
    messenger_Send(forwarder_GetMessenger(forwarder),
                   missive_Create(MissiveType_ConnectionUp, hicnConnState->id));
  } else {
    // _saveSockaddr will already log an error, no need for extra log message
    // here
    logger_Release(&hicnConnState->logger);
    parcMemory_Deallocate((void **)&hicnConnState);
  }

  return io_ops;
}

// =================================================================
// I/O Operations implementation

static void _destroy(IoOperations **opsPtr) {
  parcAssertNotNull(opsPtr, "Parameter opsPtr must be non-null double pointer");
  parcAssertNotNull(*opsPtr,
                    "Parameter opsPtr must dereference to non-null pointer");

  IoOperations *ops = *opsPtr;
  parcAssertNotNull(ioOperations_GetClosure(ops),
                    "ops->context must not be null");

  _HicnState *hicnConnState = (_HicnState *)ioOperations_GetClosure(ops);
  addressPair_Release(&hicnConnState->addressPair);
  parcMemory_Deallocate((void **)&(hicnConnState->peerAddress));
  parcMemory_Deallocate((void **)&(hicnConnState->localAddress));
  if (hicnConnState->probeDestAddress != NULL)
    parcMemory_Deallocate((void **)&(hicnConnState->probeDestAddress));

  messenger_Send(
      forwarder_GetMessenger(hicnConnState->forwarder),
      missive_Create(MissiveType_ConnectionDestroyed, hicnConnState->id));

  if (logger_IsLoggable(hicnConnState->logger, LoggerFacility_IO,
                        PARCLogLevel_Info)) {
    logger_Log(hicnConnState->logger, LoggerFacility_IO, PARCLogLevel_Info,
               __func__, "HIcnConnection %p destroyed", (void *)hicnConnState);
  }

  // XXX
  // do not close hicListenerSocket, the listener will close
  // that when its done
  // should I say something to libhicn?

  logger_Release(&hicnConnState->logger);
  parcMemory_Deallocate((void **)&hicnConnState);
  parcMemory_Deallocate((void **)&ops);

  *opsPtr = NULL;
}

static bool _isUp(const IoOperations *ops) {
  parcAssertNotNull(ops, "Parameter must be non-null");
  const _HicnState *hicnConnState =
      (const _HicnState *)ioOperations_GetClosure(ops);
  return hicnConnState->isUp;
}

static bool _isLocal(const IoOperations *ops) {
  parcAssertNotNull(ops, "Parameter must be non-null");
  const _HicnState *hicnConnState =
      (const _HicnState *)ioOperations_GetClosure(ops);
  return hicnConnState->isLocal;
}

static const Address *_getRemoteAddress(const IoOperations *ops) {
  parcAssertNotNull(ops, "Parameter must be non-null");
  const _HicnState *hicnConnState =
      (const _HicnState *)ioOperations_GetClosure(ops);
  return addressPair_GetRemote(hicnConnState->addressPair);
}

static const AddressPair *_getAddressPair(const IoOperations *ops) {
  parcAssertNotNull(ops, "Parameter must be non-null");
  const _HicnState *hicnConnState =
      (const _HicnState *)ioOperations_GetClosure(ops);
  return hicnConnState->addressPair;
}

static unsigned _getConnectionId(const IoOperations *ops) {
  parcAssertNotNull(ops, "Parameter must be non-null");
  const _HicnState *hicnConnState =
      (const _HicnState *)ioOperations_GetClosure(ops);
  return hicnConnState->id;
}

/**
 * @function hicnConnection_Send
 * @abstract Non-destructive send of the message.
 * @discussion
 *   sends a message to the peer.
 *
 * @param dummy is ignored. .
 * @return <#return#>
 */
static bool _send(IoOperations *ops, const Address *dummy, Message *message) {
  parcAssertNotNull(ops, "Parameter ops must be non-null");
  parcAssertNotNull(message, "Parameter message must be non-null");
  _HicnState *hicnConnState = (_HicnState *)ioOperations_GetClosure(ops);

  // NAT for HICN
  // XXX
  if (message_GetType(message) == MessagePacketType_ContentObject) {
    // this is a data packet. We need to put the remote address in the
    // destination field

    if (messageHandler_GetIPPacketType(message_FixedHeader(message)) ==
        IPv6_TYPE) {
      messageHandler_SetDestination_IPv6(
          (uint8_t *)message_FixedHeader(message),
          &((struct sockaddr_in6 *)hicnConnState->peerAddress)->sin6_addr);
    } else {
      messageHandler_SetDestination_IPv4(
          (uint8_t *)message_FixedHeader(message),
          &(((struct sockaddr_in *)hicnConnState->peerAddress)
                ->sin_addr.s_addr));
    }
  } else if (message_GetType(message) == MessagePacketType_Interest) {
    // this si an interest packet. We need to put the local address in the
    // source field
    if (messageHandler_GetIPPacketType(message_FixedHeader(message)) ==
        IPv6_TYPE) {
      messageHandler_SetSource_IPv6(
          (uint8_t *)message_FixedHeader(message),
          &((struct sockaddr_in6 *)hicnConnState->localAddress)->sin6_addr);
    } else {
      messageHandler_SetSource_IPv4(
          (uint8_t *)message_FixedHeader(message),
          &(((struct sockaddr_in *)hicnConnState->localAddress)
                ->sin_addr.s_addr));
    }

    // only in this case we may need to set the probeDestAddress
    if (hicnConnState->refreshProbeDestAddress) {
      _refreshProbeDestAddress(hicnConnState, message_FixedHeader(message));
    }

  } else if (message_GetType(message) == MessagePacketType_WldrNotification) {
    // here we don't need to do anything for now
  } else {
    // unkown packet
    if (logger_IsLoggable(hicnConnState->logger, LoggerFacility_IO,
                          PARCLogLevel_Debug)) {
      logger_Log(hicnConnState->logger, LoggerFacility_IO, PARCLogLevel_Debug,
                 __func__, "connid %u can't parse the message",
                 hicnConnState->id);
    }
    return false;
  }

  ssize_t writeLength =
      write(hicnConnState->hicnListenerSocket, message_FixedHeader(message),
            message_Length(message));

  if (writeLength < 0) {
    if (errno == EAGAIN || errno == EWOULDBLOCK) {
      return false;
    } else {
      // this print is for debugging
      printf("Incorrect write length %zd, expected %zd: (%d) %s\n", writeLength,
             message_Length(message), errno, strerror(errno));
      return false;
    }
  }

  return true;
}

static list_connections_type _getConnectionType(const IoOperations *ops) {
  return CONN_HICN;
}

static Ticks _sendProbe(IoOperations *ops, unsigned probeType,
                        uint8_t *message) {
  parcAssertNotNull(ops, "Parameter ops must be non-null");
  _HicnState *hicnConnState = (_HicnState *)ioOperations_GetClosure(ops);

  if ((hicnConnState->peerAddressLength == sizeof(struct sockaddr_in)) ||
      (hicnConnState->localAddressLength == sizeof(struct sockaddr_in)))
    return false;

  if (hicnConnState->probeDestAddress == NULL &&
      probeType == PACKET_TYPE_PROBE_REPLY) {
    uint8_t *pkt = parcMemory_AllocateAndClear(
        messageHandler_GetICMPPacketSize(IPv6_TYPE));
    messageHandler_SetProbePacket(
        pkt, probeType,
        (struct in6_addr *)messageHandler_GetDestination(message),
        (struct in6_addr *)messageHandler_GetSource(message));

    ssize_t writeLength = write(hicnConnState->hicnListenerSocket, pkt,
                                messageHandler_GetICMPPacketSize(IPv6_TYPE));

    parcMemory_Deallocate((void **)&pkt);

    if (writeLength < 0) {
      return 0;
    }

  } else if (hicnConnState->probeDestAddress != NULL &&
             probeType == PACKET_TYPE_PROBE_REQUEST) {
    hicnConnState->refreshProbeDestAddress = true;

    uint8_t *pkt = parcMemory_AllocateAndClear(
        messageHandler_GetICMPPacketSize(IPv6_TYPE));
    messageHandler_SetProbePacket(
        pkt, probeType,
        &((struct sockaddr_in6 *)hicnConnState->localAddress)->sin6_addr,
        &((struct sockaddr_in6 *)hicnConnState->probeDestAddress)->sin6_addr);

    ssize_t writeLength = write(hicnConnState->hicnListenerSocket, pkt,
                                messageHandler_GetICMPPacketSize(IPv6_TYPE));

    parcMemory_Deallocate((void **)&pkt);

    if (writeLength < 0) {
      return 0;
    }

  } else {
    if (hicnConnState->probeDestAddress == NULL &&
        probeType == PACKET_TYPE_PROBE_REQUEST) {
      // this happen for the first probe
      hicnConnState->refreshProbeDestAddress = true;
    }
    // do nothing
    return 0;
  }

  return forwarder_GetTicks(hicnConnState->forwarder);
}

// =================================================================
// Internal API

static bool _saveSockaddr(_HicnState *hicnConnState, const AddressPair *pair) {
  bool success = false;
  const Address *remoteAddress = addressPair_GetRemote(pair);
  const Address *localAddress = addressPair_GetLocal(pair);
  switch (addressGetType(remoteAddress)) {  // local must be of the same type

    case ADDR_INET: {
      size_t bytes = sizeof(struct sockaddr_in);
      hicnConnState->peerAddress = parcMemory_Allocate(bytes);
      parcAssertNotNull(hicnConnState->peerAddress,
                        "parcMemory_Allocate(%zu) returned NULL", bytes);

      addressGetInet(remoteAddress,
                     (struct sockaddr_in *)hicnConnState->peerAddress);
      hicnConnState->peerAddressLength = (socklen_t)bytes;

      hicnConnState->localAddress = parcMemory_Allocate(bytes);
      parcAssertNotNull(hicnConnState->localAddress,
                        "parcMemory_Allocate(%zu) returned NULL", bytes);

      addressGetInet(localAddress,
                     (struct sockaddr_in *)hicnConnState->localAddress);
      hicnConnState->localAddressLength = (socklen_t)bytes;

      hicnConnState->probeDestAddress = NULL;
      hicnConnState->probeDestAddressLength = (socklen_t)bytes;
      hicnConnState->refreshProbeDestAddress = false;

      success = true;
      break;
    }

    case ADDR_INET6: {
      size_t bytes = sizeof(struct sockaddr_in6);
      hicnConnState->peerAddress = parcMemory_Allocate(bytes);
      parcAssertNotNull(hicnConnState->peerAddress,
                        "parcMemory_Allocate(%zu) returned NULL", bytes);

      addressGetInet6(remoteAddress,
                      (struct sockaddr_in6 *)hicnConnState->peerAddress);
      hicnConnState->peerAddressLength = (socklen_t)bytes;

      hicnConnState->localAddress = parcMemory_Allocate(bytes);
      parcAssertNotNull(hicnConnState->localAddress,
                        "parcMemory_Allocate(%zu) returned NULL", bytes);

      addressGetInet6(localAddress,
                      (struct sockaddr_in6 *)hicnConnState->localAddress);
      hicnConnState->localAddressLength = (socklen_t)bytes;

      hicnConnState->probeDestAddress = NULL;
      hicnConnState->probeDestAddressLength = (socklen_t)bytes;
      hicnConnState->refreshProbeDestAddress = false;

      success = true;
      break;
    }

    default:
      if (logger_IsLoggable(hicnConnState->logger, LoggerFacility_IO,
                            PARCLogLevel_Error)) {
        char *str = addressToString(remoteAddress);
        logger_Log(hicnConnState->logger, LoggerFacility_IO, PARCLogLevel_Error,
                   __func__, "Remote address is not INET or INET6: %s", str);
        parcMemory_Deallocate((void **)&str);
      }
      break;
  }
  return success;
}

static void _refreshProbeDestAddress(_HicnState *hicnConnState,
                                     const uint8_t *message) {
  if ((hicnConnState->peerAddressLength == sizeof(struct sockaddr_in)) ||
      (hicnConnState->localAddressLength == sizeof(struct sockaddr_in)))
    return;

  if (hicnConnState->probeDestAddress == NULL) {
    hicnConnState->probeDestAddress =
        parcMemory_AllocateAndClear(sizeof(struct sockaddr_in6));
    parcAssertNotNull(hicnConnState->probeDestAddress,
                      "parcMemory_Allocate(%zu) returned NULL",
                      sizeof(struct sockaddr_in6));
  }

  ((struct sockaddr_in6 *)hicnConnState->probeDestAddress)->sin6_family =
      AF_INET6;
  ((struct sockaddr_in6 *)hicnConnState->probeDestAddress)->sin6_port =
      htons(1234);
  ((struct sockaddr_in6 *)hicnConnState->probeDestAddress)->sin6_scope_id = 0;
  ((struct sockaddr_in6 *)hicnConnState->probeDestAddress)->sin6_flowinfo = 0;
  ((struct sockaddr_in6 *)hicnConnState->probeDestAddress)->sin6_addr =
      *((struct in6_addr *)messageHandler_GetDestination(message));
  hicnConnState->refreshProbeDestAddress = false;
}

static void _setConnectionState(_HicnState *hicnConnState, bool isUp) {
  parcAssertNotNull(hicnConnState, "Parameter HICN must be non-null");

  Messenger *messenger = forwarder_GetMessenger(hicnConnState->forwarder);

  bool oldStateIsUp = hicnConnState->isUp;
  hicnConnState->isUp = isUp;

  if (oldStateIsUp && !isUp) {
    // bring connection DOWN
    Missive *missive =
        missive_Create(MissiveType_ConnectionDown, hicnConnState->id);
    messenger_Send(messenger, missive);
    return;
  }

  if (!oldStateIsUp && isUp) {
    // bring connection UP
    Missive *missive =
        missive_Create(MissiveType_ConnectionUp, hicnConnState->id);
    messenger_Send(messenger, missive);
    return;
  }
}