summaryrefslogtreecommitdiffstats
path: root/hicn-light/src/core/connectionManager.c
blob: 2089e14958c4c388d1a8d48e571d71d512d1b41c (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
/*
 * 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.
 */

/**
 * The Connection Manager sets itself up as a listener to the Messenger so it
 * can take action based on system events.
 *
 * The Connection Manager queues and then processes in a later time slice the
 * messages.
 *
 */

#include <src/config.h>
#include <src/core/connectionManager.h>
#include <src/core/forwarder.h>
#include <src/messenger/messenger.h>
#include <src/messenger/messengerRecipient.h>
#include <src/messenger/missiveDeque.h>
#include <stdio.h>

#include <parc/algol/parc_Memory.h>

#include <parc/assert/parc_Assert.h>

struct connection_manager {
  Forwarder *forwarder;
  Logger *logger;

  MessengerRecipient *messengerRecipient;

  // we queue missives as they come in to process in our own
  // event timeslice
  MissiveDeque *missiveQueue;

  // for deferred queue processing
  PARCEventTimer *timerEvent;
};

/**
 * Receives missives from the messenger, queues them, and schedules our
 * execution
 *
 * We defer processing of missives to a later time slice
 */
static void connectionManager_MessengerCallback(MessengerRecipient *recipient,
                                                Missive *missive);

/**
 * Event callback
 *
 * This is our main run loop to process our queue of messages.  It is scheduled
 * in {@link connectionManager_MessengerCallback} when the queue becomes
 * non-empty.
 *
 * When we are called here, we have exclusive use of the system, so we will not
 * create any message loops
 *
 * @param [in] fd unused, required for compliance with function prototype
 * @param [in] which_event unused, required for compliance with function
 * prototype
 * @param [in] connManagerVoidPtr A void* to ConnectionManager
 *
 */
static void connectionManager_ProcessQueue(int fd, PARCEventType which_event,
                                           void *connManagerVoidPtr);

static void connectionManager_ProcessClosedMissive(
    ConnectionManager *connManager, const Missive *missive);

// ========================================================
// Public API

ConnectionManager *connectionManager_Create(Forwarder *forwarder) {
  ConnectionManager *connManager =
      parcMemory_AllocateAndClear(sizeof(ConnectionManager));
  parcAssertNotNull(connManager,
                    "parcMemory_AllocateAndClear(%zu) returned NULL",
                    sizeof(ConnectionManager));
  connManager->forwarder = forwarder;
  connManager->missiveQueue = missiveDeque_Create();
  connManager->logger = logger_Acquire(forwarder_GetLogger(forwarder));

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

  // creates the timer, but does not start it
  PARCEventScheduler *base =
      dispatcher_GetEventScheduler(forwarder_GetDispatcher(forwarder));
  connManager->timerEvent = parcEventTimer_Create(
      base, 0, connectionManager_ProcessQueue, connManager);

  connManager->messengerRecipient = messengerRecipient_Create(
      connManager, connectionManager_MessengerCallback);
  messenger_Register(messenger, connManager->messengerRecipient);
  return connManager;
}

void connectionManager_Destroy(ConnectionManager **managerPtr) {
  parcAssertNotNull(managerPtr, "Double pointer must be non-null");
  parcAssertNotNull(*managerPtr, "Double pointer must dereference to non-null");

  ConnectionManager *connManager = *managerPtr;

  Messenger *messenger = forwarder_GetMessenger(connManager->forwarder);
  parcEventTimer_Destroy(&(connManager->timerEvent));
  messenger_Unregister(messenger, connManager->messengerRecipient);
  messengerRecipient_Destroy(&connManager->messengerRecipient);
  missiveDeque_Release(&connManager->missiveQueue);
  logger_Release(&connManager->logger);

  parcMemory_Deallocate((void **)&connManager);
  *managerPtr = NULL;
}

// ========================================================
// Internal Functions

static void connectionManager_MessengerCallback(MessengerRecipient *recipient,
                                                Missive *missive) {
  ConnectionManager *connManager =
      messengerRecipient_GetRecipientContext(recipient);

  // we do not release our reference count, we store it until later
  // We are called with our own reference, so we do not need to acquire the
  // missive here.
  missiveDeque_Append(connManager->missiveQueue, missive);

  if (missiveDeque_Size(connManager->missiveQueue) == 1) {
    // When it becomes non-empty, schedule {@link
    // connectionManager_ProcessQueue}
    struct timeval immediateTimeout = {0, 0};
    parcEventTimer_Start(connManager->timerEvent, &immediateTimeout);
  }
}

static void connectionManager_ProcessQueue(int fd, PARCEventType which_event,
                                           void *connManagerVoidPtr) {
  ConnectionManager *connManager = (ConnectionManager *)connManagerVoidPtr;

  Missive *missive;
  while ((missive = missiveDeque_RemoveFirst(connManager->missiveQueue)) !=
         NULL) {
    switch (missive_GetType(missive)) {
      case MissiveType_ConnectionCreate:
        // hook to signal that a new connection was created
        break;
      case MissiveType_ConnectionUp:
        // hook to signal that a new connection is up
        break;
      case MissiveType_ConnectionDown:
        // hook to signal that a connection is down
        break;
      case MissiveType_ConnectionClosed:
        connectionManager_ProcessClosedMissive(connManager, missive);
        break;
      case MissiveType_ConnectionDestroyed:
        // hook to signal that a connection was destroyed
        break;
      default:
        parcTrapUnexpectedState("Missive %p of unknown type: %d",
                                (void *)missive, missive_GetType(missive));
    }
    missive_Release(&missive);
  }
}

static void connectionManager_ProcessClosedMissive(
    ConnectionManager *connManager, const Missive *missive) {
  logger_Log(connManager->logger, LoggerFacility_Core, PARCLogLevel_Debug,
             __func__, "Processing CLOSED message for connid %u",
             missive_GetConnectionId(missive));

  ConnectionTable *table = forwarder_GetConnectionTable(connManager->forwarder);
  const Connection *conn =
      connectionTable_FindById(table, missive_GetConnectionId(missive));

  if (conn) {
    // this will destroy the connection if its the last reference count
    connectionTable_Remove(table, conn);

    // remove from FIB
    forwarder_RemoveConnectionIdFromRoutes(connManager->forwarder,
                                           missive_GetConnectionId(missive));
  }
}