summaryrefslogtreecommitdiffstats
path: root/hicn-plugin/src/mapme_ctrl_node.c
blob: e3d340e531218ecbac1996ae08288ada3131c14f (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
/*
 * Copyright (c) 2021 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.
 */

/*
 * This node processses MAP-Me control messages.
 */
#include <vnet/ip/ip6_packet.h>
#include <vnet/dpo/load_balance.h>
#include <vlib/log.h>

#include "hicn.h"
#include "mapme.h"
#include "mapme_ctrl.h"
#include "mapme_eventmgr.h"
#include "mgmt.h"
#include "parser.h"
#include "infra.h"
#include "strategy_dpo_manager.h"
#include "strategy_dpo_ctx.h"
#include "error.h"
#include "state.h"
#include "route.h"

extern hicn_mapme_main_t mapme_main;

#define MS2NS(x) x * 1000000

/* Functions declarations */

/* packet trace format function */
static u8 *hicn_mapme_ctrl_format_trace (u8 *s, va_list *args);

/* Stats string values */
static char *hicn_mapme_ctrl_error_strings[] = {
#define _(sym, string) string,
  foreach_hicnfwd_error
#undef _
};

static_always_inline int
hicn_mapme_nh_set (hicn_mapme_tfib_t *tfib, hicn_face_id_t face_id)
{
  hicn_dpo_ctx_t *strategy_ctx = (hicn_dpo_ctx_t *) tfib;
  const fib_prefix_t *prefix =
    fib_entry_get_prefix (strategy_ctx->fib_entry_index);

  int ret = 0;

  if ((tfib->entry_count == 1) && (tfib->next_hops[0] == face_id))
    return ret;

  u32 n_entries = tfib->entry_count;
  /* Remove all the existing next hops and set the new one */
  for (int i = 0; i < n_entries; i++)
    {
      hicn_face_t *face = hicn_dpoi_get_from_idx (strategy_ctx->next_hops[0]);
      if (dpo_is_adj (&face->dpo))
	{
	  ip_adjacency_t *adj = adj_get (face->dpo.dpoi_index);
	  ip_nh_adj_add_del_helper (prefix->fp_proto, prefix,
				    &adj->sub_type.nbr.next_hop, face->sw_if,
				    0);
	}
      else if (face->dpo.dpoi_type == dpo_type_udp_ip4 ||
	       face->dpo.dpoi_type == dpo_type_udp_ip6)
	{
	  ip_nh_udp_tunnel_add_del_helper (prefix->fp_proto, prefix,
					   face->dpo.dpoi_index,
					   face->dpo.dpoi_proto, 0);
	}
      else
	{
	  continue;
	}
    }

  ret = HICN_ERROR_MAPME_NEXT_HOP_ADDED;
  hicn_face_t *face = hicn_dpoi_get_from_idx (face_id);
  if (face->dpo.dpoi_type == dpo_type_udp_ip4 ||
      face->dpo.dpoi_type == dpo_type_udp_ip6)
    {
      ip_nh_udp_tunnel_add_del_helper (prefix->fp_proto, prefix,
				       face->dpo.dpoi_index,
				       face->dpo.dpoi_proto, 1);
    }
  else if (dpo_is_adj (&face->dpo))
    {
      ip_nh_adj_add_del_helper (prefix->fp_proto, prefix, &face->nat_addr,
				face->sw_if, 1);
    }
  else
    {
      ret = HICN_ERROR_MAPME_NEXT_HOP_NOT_ADDED;
    }

  return ret;
}

/**
 * @brief Check whether a face is already included in the FIB nexthops.
 *
 * NOTE: linear scan on a contiguous small array should be the most efficient.
 */
static_always_inline int
hicn_mapme_nh_has (hicn_mapme_tfib_t *tfib, hicn_face_id_t face_id)
{
  for (u8 pos = 0; pos < tfib->entry_count; pos++)
    if (tfib->next_hops[pos] == face_id)
      return 1;
  return 0;
}

/**
 * @brief Add a next hop iif it is not already a next hops
 */
static_always_inline int
hicn_mapme_nh_add (hicn_mapme_tfib_t *tfib, hicn_face_id_t face_id)
{
  if (hicn_mapme_nh_has (tfib, face_id))
    return 0;

  /* Add the next hop in the vrf 0 which will add it to the entry in the hICN
   * vrf */
  hicn_dpo_ctx_t *strategy_ctx = (hicn_dpo_ctx_t *) tfib;
  const fib_prefix_t *prefix =
    fib_entry_get_prefix (strategy_ctx->fib_entry_index);
  hicn_face_t *face = hicn_dpoi_get_from_idx (face_id);
  if (face->dpo.dpoi_type == dpo_type_udp_ip4 ||
      face->dpo.dpoi_type == dpo_type_udp_ip6)
    {
      ip_nh_udp_tunnel_add_del_helper ((fib_protocol_t) face->dpo.dpoi_proto,
				       prefix, face->dpo.dpoi_index,
				       face->dpo.dpoi_proto, 1);
    }
  else
    {
      ip_nh_adj_add_del_helper ((fib_protocol_t) face->dpo.dpoi_proto, prefix,
				&face->nat_addr, face->sw_if, 1);
    }

  return 0;
}

/*
 * @brief Process incoming control messages (Interest Update)
 * @param vm vlib main data structure
 * @param b Control packet (IU)
 * @param face_id Ingress face id
 *
 * NOTE:
 *  - this function answers locally to the IU interest by replying with a Ack
 *  (Data) packet, unless in case of outdated information, in which we can
 *  consider the interest is dropped, and another IU (aka ICMP error) is sent
 * so that retransmissions stop.
 */
static_always_inline bool
hicn_mapme_process_ctrl (vlib_main_t *vm, vlib_buffer_t *b,
			 hicn_face_id_t in_face_id)
{
  seq_t fib_seq;
  const dpo_id_t *dpo;
  hicn_prefix_t prefix;
  mapme_params_t params;
  int rc;

  /* Parse incoming message */
  rc = hicn_mapme_parse_packet (vlib_buffer_get_current (b), &prefix, &params);
  if (rc < 0)
    goto ERR_PARSE;

  vlib_cli_output (vm, "IU - type:%d seq:%d len:%d", params.type, params.seq,
		   prefix.len);

  /* if (params.seq == INVALID_SEQ) */
  /*   { */
  /*     vlib_log_warn (mapme_main.log_class, */
  /*                 "Invalid sequence number found in IU"); */

  /*     return true; */
  /*   } */

  /* We forge the ACK which we be the packet forwarded by the node */
  hicn_mapme_create_ack (vlib_buffer_get_current (b), &params);

  dpo = fib_epm_lookup (&prefix.name.as_ip46, prefix.len);
  if (!dpo)
    {
#ifdef HICN_MAPME_ALLOW_NONEXISTING_FIB_ENTRY
      /*
       * This might happen for a node hosting a producer which has moved.
       * Destroying the face has led to removing all corresponding FIB
       * entries. In that case, we need to correctly restore the FIB entries.
       */
      HICN_DEBUG ("Re-creating FIB entry with next hop on connection")
#error "not implemented"
#else
      // ERROR("Received IU for non-existing FIB entry");
      return false;
#endif /* HICN_MAPME_ALLOW_NONEXISTING_FIB_ENTRY */
    }

#ifdef HICN_MAPME_ALLOW_LOCATORS
  if (!dpo_is_hicn ((dpo)))
    {
      /* We have an IP DPO */
      HICN_ERROR ("Not implemented yet.");
      return false;
    }
#endif

  /* Process the hICN DPO */
  hicn_mapme_tfib_t *tfib = TFIB (hicn_strategy_dpo_ctx_get (dpo->dpoi_index));

  if (tfib == NULL)
    {
      HICN_ERROR ("Unable to get strategy ctx.");
      return false;
    }

  fib_seq = tfib->seq;

  if (params.seq > fib_seq)
    {
      HICN_DEBUG (
	"Higher sequence number than FIB %d > %d, updating seq and next hops",
	params.seq, fib_seq);

      /* This has to be done first to allow processing ack */
      tfib->seq = params.seq;

      // in_face and next_hops are face_id_t

      /* Remove ingress face from TFIB in case it was present */
      hicn_mapme_tfib_del (tfib, in_face_id);

      HICN_DEBUG ("Locks on face %d: %d", in_face_id,
		  hicn_dpoi_get_from_idx (in_face_id)->locks);

      /* Move next hops to TFIB... but in_face... */
      for (u8 pos = 0; pos < tfib->entry_count; pos++)
	{
	  if (tfib->next_hops[pos] == in_face_id)
	    continue;
	  HICN_DEBUG (
	    "Adding nexthop to the tfib, dpo index in_face %d, dpo index "
	    "tfib %d",
	    in_face_id, tfib->next_hops[pos]);
	  hicn_mapme_tfib_add (tfib, tfib->next_hops[pos]);
	}

      int ret = hicn_mapme_nh_set (tfib, in_face_id);
      HICN_DEBUG ("Locks on face %d: %d", in_face_id,
		  hicn_dpoi_get_from_idx (in_face_id)->locks);
      if (ret == HICN_ERROR_MAPME_NEXT_HOP_ADDED &&
	  hicn_get_buffer (b)->flags & HICN_BUFFER_FLAGS_NEW_FACE)
	{
	  hicn_face_unlock_with_id (in_face_id);
	}

      /* We transmit both the prefix and the full dpo (type will be needed to
       * pick the right transmit node */
      retx_t *retx = vlib_process_signal_event_data (
	vm, hicn_mapme_eventmgr_process_node.index,
	HICN_MAPME_EVENT_FACE_NH_SET, 1, sizeof (retx_t));
      *retx = (retx_t){ .prefix = prefix, .dpo = *dpo };
    }
  else if (params.seq == fib_seq)
    {
      HICN_DEBUG ("Same sequence number than FIB %d > %d, adding next hop",
		  params.seq, fib_seq);

      /**
       * Add nh BEFORE removing the face from the tfib, as if the last lock is
       * held by the tfib, deleting it first would also delete the face,
       * resulting in a undefined behavior after (Debug mode -> SIGABRT,
       * Release Mode -> Corrupted memory / SIGSEGV).
       **/

      /* Add ingress face to next hops */
      hicn_mapme_nh_add (tfib, in_face_id);

      /* Remove ingress face from TFIB in case it was present */
      hicn_mapme_tfib_del (tfib, in_face_id);

      /* Multipath, multihoming, multiple producers or duplicate interest */
      retx_t *retx = vlib_process_signal_event_data (
	vm, hicn_mapme_eventmgr_process_node.index,
	HICN_MAPME_EVENT_FACE_NH_ADD, 1, sizeof (retx_t));
      *retx = (retx_t){ .prefix = prefix, .dpo = *dpo };
    }
  else // params.seq < fib_seq
    {
      /*
       * face is propagating outdated information, we can just consider it as a
       * prevHops, unless it is the current nexthop.
       */
      if (hicn_mapme_nh_has (tfib, in_face_id))
	{
	  HICN_DEBUG ("Ignored seq %d < fib_seq %d from current nexthop",
		      params.seq, fib_seq);
	  return true;
	}
      HICN_DEBUG ("Received seq %d < fib_seq %d, sending backwards",
		  params.seq, fib_seq);

      hicn_mapme_tfib_add (tfib, in_face_id);

      retx_t *retx = vlib_process_signal_event_data (
	vm, hicn_mapme_eventmgr_process_node.index,
	HICN_MAPME_EVENT_FACE_PH_ADD, 1, sizeof (retx_t));
      *retx = (retx_t){ .prefix = prefix, .dpo = *dpo };
    }

  /* We just raise events, the event_mgr is in charge of forging packet. */

  return true;

// ERR_ACK_CREATE:
ERR_PARSE:
  return false;
}

vlib_node_registration_t hicn_mapme_ctrl_node;

static uword
hicn_mapme_ctrl_node_fn (vlib_main_t *vm, vlib_node_runtime_t *node,
			 vlib_frame_t *frame)
{
  hicn_buffer_t *hb;
  hicn_mapme_ctrl_next_t next_index;
  u32 n_left_from, *from, *to_next;
  n_left_from = frame->n_vectors;
  // hicn_face_id_t in_face;

  from = vlib_frame_vector_args (frame);
  n_left_from = frame->n_vectors;
  next_index = node->cached_next_index;

  while (n_left_from > 0) // buffers in the current frame
    {
      u32 n_left_to_next;
      vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);

      while (n_left_from > 0 && n_left_to_next > 0)
	{
	  u32 bi0;
	  vlib_buffer_t *b0;

	  /* speculatively enqueue b0 to the current next frame */
	  bi0 = from[0];
	  to_next[0] = bi0;
	  from += 1;
	  to_next += 1;
	  n_left_from -= 1;
	  n_left_to_next -= 1;
	  b0 = vlib_get_buffer (vm, bi0);
	  hb = hicn_get_buffer (b0);

	  /* This determines the next node on which the ack will be sent back
	   */
	  u32 next0 = hicn_mapme_ctrl_get_iface_node (hb->face_id);

	  hicn_mapme_process_ctrl (vm, b0, hb->face_id);

	  vnet_buffer (b0)->ip.adj_index[VLIB_TX] = hb->face_id;

	  vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
					   n_left_to_next, bi0, next0);
	}
      vlib_put_next_frame (vm, node, next_index, n_left_to_next);
    }
  //  vlib_node_increment_counter (vm, hicn_mapme_ctrl_node.index,
  //                               HICN_MAPME_CTRL_ERROR_SWAPPED,
  //                               pkts_swapped);
  return frame->n_vectors;
}

/* packet trace format function */
static u8 *
hicn_mapme_ctrl_format_trace (u8 *s, va_list *args)
{
  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  hicn_mapme_ctrl_trace_t *t = va_arg (*args, hicn_mapme_ctrl_trace_t *);

  s = format (s, "MAPME_CTRL: pkt: %d, sw_if_index %d, next index %d",
	      (int) t->pkt_type, t->sw_if_index, t->next_index);
  return (s);
}

/*
 * Node registration for the MAP-Me node processing special interests
 */
VLIB_REGISTER_NODE (hicn_mapme_ctrl_node) =
{
  .function = hicn_mapme_ctrl_node_fn,
  .name = "hicn-mapme-ctrl",
  .vector_size =  sizeof (u32),
  .runtime_data_bytes = sizeof (hicn_mapme_ctrl_runtime_t),
  .format_trace = hicn_mapme_ctrl_format_trace,
  .type = VLIB_NODE_TYPE_INTERNAL,
  .n_errors = ARRAY_LEN (hicn_mapme_ctrl_error_strings),
  .error_strings = hicn_mapme_ctrl_error_strings,
  .n_next_nodes = HICN_MAPME_CTRL_N_NEXT,
  .next_nodes =
  {
    /*
     * Control packets are not forwarded by this node, but sent by the Event
     * Manager. This node is only responsible for sending ACK back,
     * Acks are like data packets are output on iface's
     */
    [HICN_MAPME_CTRL_NEXT_IP4_OUTPUT]   = "hicn4-iface-output",
    [HICN_MAPME_CTRL_NEXT_IP6_OUTPUT]   = "hicn6-iface-output",
    [HICN_MAPME_CTRL_NEXT_ERROR_DROP]   = "error-drop",
  },
};

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */