aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/l2e/l2e.c
blob: a56c25c54f8c98ea1d9172724a911506d9c3d893 (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
/*
 * l2_emulation.h : Extract L3 packets from the L2 input and feed
 *                   them into the L3 path.
 *
 * Copyright (c) 2013 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.
 */

#include <plugins/l2e/l2e.h>
#include <vnet/l2/l2_input.h>
#include <vnet/l2/feat_bitmap.h>

/**
 * Grouping of global data for the L2 emulation feature
 */
typedef struct l2_emulation_main_t_
{
  /**
   * Next nodes for L2 output features
   */
  u32 l2_input_feat_next[32];
} l2_emulation_main_t;

static l2_emulation_main_t l2_emulation_main;

/**
 * Per-interface L2 configuration
 */
typedef struct l2_emulation_t_
{
  /**
   * Enabled or Disabled.
   *  this is required since one L3 protocl can be enabled, but others not
   */
  u8 enabled;
} l2_emulation_t;

/**
 * A zero'd out struct we can use in the vec_validate
 */
static const l2_emulation_t ezero = { };

/**
 * Per-interface vector of emulation configs
 */
l2_emulation_t *l2_emulations;

void
l2_emulation_enable (u32 sw_if_index)
{
  vec_validate_init_empty (l2_emulations, sw_if_index, ezero);

  l2_emulation_t *l23e = &l2_emulations[sw_if_index];

  l23e->enabled = 1;

  /*
   * L3 enable the interface - using IP unnumbered from the control
   * plane may not be possible since there may be no BVI interface
   * to which to unnumber
   */
  ip4_sw_interface_enable_disable (sw_if_index, 1);
  ip6_sw_interface_enable_disable (sw_if_index, 1);

  l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_L2_EMULATION, 1);
}


void
l2_emulation_disable (u32 sw_if_index)
{
  if (vec_len (l2_emulations) >= sw_if_index)
    {
      l2_emulation_t *l23e = &l2_emulations[sw_if_index];
      memset (l23e, 0, sizeof (*l23e));

      l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_L2_EMULATION, 0);
      ip4_sw_interface_enable_disable (sw_if_index, 0);
      ip6_sw_interface_enable_disable (sw_if_index, 0);
    }
}

static clib_error_t *
l2_emulation_interface_add_del (vnet_main_t * vnm,
				u32 sw_if_index, u32 is_add)
{
  if (is_add)
    {
      vec_validate_init_empty (l2_emulations, sw_if_index, ezero);
    }

  return (NULL);
}

VNET_SW_INTERFACE_ADD_DEL_FUNCTION (l2_emulation_interface_add_del);

static clib_error_t *
l2_emulation_cli (vlib_main_t * vm,
		  unformat_input_t * input, vlib_cli_command_t * cmd)
{
  vnet_main_t *vnm = vnet_get_main ();
  u32 sw_if_index = ~0;
  u8 enable = 1;

  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (input, "%U", unformat_vnet_sw_interface,
		    vnm, &sw_if_index))
	;
      else if (unformat (input, "enable"))
	enable = 1;
      else if (unformat (input, "disable"))
	enable = 0;
      else
	break;
    }

  if (~0 == sw_if_index)
    return clib_error_return (0, "interface must be specified");

  if (enable)
    l2_emulation_enable (sw_if_index);
  else
    l2_emulation_disable (sw_if_index);

  return (NULL);
}

/*?
 * Configure l2 emulation.
 *  When the interface is in L2 mode, configure the extraction of L3
 *  packets out of the L2 path and into the L3 path.
 *
 * @cliexpar
 * @cliexstart{set interface l2 input l2-emulation <interface-name> [disable]}
 * @cliexend
 ?*/
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (l2_emulation_cli_node, static) = {
  .path = "set interface l2 l2-emulation",
  .short_help =
  "set interface l2 l2-emulation <interface-name> [disable|enable]\n",
  .function = l2_emulation_cli,
};
/* *INDENT-ON* */

static clib_error_t *
l2_emulation_show (vlib_main_t * vm,
		   unformat_input_t * input, vlib_cli_command_t * cmd)
{
  vnet_main_t *vnm = vnet_get_main ();
  l2_emulation_t *l23e;
  u32 sw_if_index;

  vec_foreach_index (sw_if_index, l2_emulations)
  {
    l23e = &l2_emulations[sw_if_index];
    if (l23e->enabled)
      {
	vlib_cli_output (vm, "%U\n",
			 format_vnet_sw_if_index_name, vnm, sw_if_index);
      }
  }
  return (NULL);
}

/*?
 * Show l2 emulation.
 *  When the interface is in L2 mode, configure the extraction of L3
 *  packets out of the L2 path and into the L3 path.
 *
 * @cliexpar
 * @cliexstart{show interface l2 l2-emulation}
 * @cliexend
 ?*/
/* *INDENT-OFF* */
VLIB_CLI_COMMAND (l2_emulation_show_node, static) = {
  .path = "show interface l2 l2-emulation",
  .short_help = "show interface l2 l2-emulation\n",
  .function = l2_emulation_show,
};
/* *INDENT-ON* */

#define foreach_l2_emulation                    \
  _(IP4, "Extract IPv4")                        \
  _(IP6, "Extract IPv6")

typedef enum
{
#define _(sym,str) L2_EMULATION_ERROR_##sym,
  foreach_l2_emulation
#undef _
    L2_EMULATION_N_ERROR,
} l2_emulation_error_t;

static char *l2_emulation_error_strings[] = {
#define _(sym,string) string,
  foreach_l2_emulation
#undef _
};

typedef enum
{
#define _(sym,str) L2_EMULATION_NEXT_##sym,
  foreach_l2_emulation
#undef _
    L2_EMULATION_N_NEXT,
} l2_emulation_next_t;

/**
 * per-packet trace data
 */
typedef struct l2_emulation_trace_t_
{
  /* per-pkt trace data */
  u8 extracted;
} l2_emulation_trace_t;

static uword
l2_emulation_node_fn (vlib_main_t * vm,
		      vlib_node_runtime_t * node, vlib_frame_t * frame)
{
  l2_emulation_main_t *em = &l2_emulation_main;
  u32 n_left_from, *from, *to_next;
  l2_emulation_next_t next_index;
  u32 ip4_hits = 0;
  u32 ip6_hits = 0;

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

  while (n_left_from > 0)
    {
      u32 n_left_to_next;

      vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
      while (n_left_from >= 4 && n_left_to_next >= 2)
	{
	  vlib_buffer_t *b0, *b1;
	  u32 sw_if_index0, sw_if_index1;
	  u16 ether_type0, ether_type1;
	  u32 next0 = ~0, next1 = ~0;
	  u8 l2_len0, l2_len1;
	  u32 bi0, bi1;
	  u8 *h0, *h1;

	  bi0 = to_next[0] = from[0];
	  bi1 = to_next[1] = from[1];

	  from += 2;
	  n_left_from -= 2;
	  to_next += 2;
	  n_left_to_next -= 2;

	  b0 = vlib_get_buffer (vm, bi0);
	  b1 = vlib_get_buffer (vm, bi1);
	  l2_len0 = vnet_buffer (b0)->l2.l2_len;
	  l2_len1 = vnet_buffer (b1)->l2.l2_len;

	  h0 = vlib_buffer_get_current (b0);
	  h1 = vlib_buffer_get_current (b1);

	  ether_type0 = clib_net_to_host_u16 (*(u16 *) (h0 + l2_len0 - 2));
	  ether_type1 = clib_net_to_host_u16 (*(u16 *) (h1 + l2_len1 - 2));
	  sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
	  sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_RX];

	  /*
	   * only extract unicast
	   */
	  if (PREDICT_TRUE (!(h0[0] & 0x1)))
	    {
	      switch (ether_type0)
		{
		case ETHERNET_TYPE_IP4:
		  ASSERT (l2_emulations[sw_if_index0].enabled);
		  ++ip4_hits;
		  next0 = L2_EMULATION_NEXT_IP4;
		  vlib_buffer_advance (b0, l2_len0);
		  break;
		case ETHERNET_TYPE_IP6:
		  ASSERT (l2_emulations[sw_if_index0].enabled);
		  ++ip6_hits;
		  next0 = L2_EMULATION_NEXT_IP6;
		  vlib_buffer_advance (b0, l2_len0);
		default:
		  break;
		}
	    }
	  if (PREDICT_TRUE (!(h1[0] & 0x1)))
	    {
	      switch (ether_type1)
		{
		case ETHERNET_TYPE_IP4:
		  ASSERT (l2_emulations[sw_if_index1].enabled);
		  ++ip4_hits;
		  next1 = L2_EMULATION_NEXT_IP4;
		  vlib_buffer_advance (b1, l2_len1);
		  break;
		case ETHERNET_TYPE_IP6:
		  ASSERT (l2_emulations[sw_if_index1].enabled);
		  ++ip6_hits;
		  next1 = L2_EMULATION_NEXT_IP6;
		  vlib_buffer_advance (b1, l2_len1);
		default:
		  break;
		}
	    }
	  if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
			     && (b0->flags & VLIB_BUFFER_IS_TRACED)))
	    {
	      l2_emulation_trace_t *t =
		vlib_add_trace (vm, node, b0, sizeof (*t));
	      t->extracted = (next0 != ~0);
	    }
	  if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
			     && (b1->flags & VLIB_BUFFER_IS_TRACED)))
	    {
	      l2_emulation_trace_t *t =
		vlib_add_trace (vm, node, b1, sizeof (*t));
	      t->extracted = (next1 != ~0);
	    }

	  /* Determine the next node and remove ourself from bitmap */
	  if (PREDICT_TRUE (next0 == ~0))
	    next0 = vnet_l2_feature_next (b0, em->l2_input_feat_next,
					  L2INPUT_FEAT_L2_EMULATION);

	  /* Determine the next node and remove ourself from bitmap */
	  if (PREDICT_TRUE (next1 == ~0))
	    next1 = vnet_l2_feature_next (b1, em->l2_input_feat_next,
					  L2INPUT_FEAT_L2_EMULATION);

	  vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
					   to_next, n_left_to_next,
					   bi0, bi1, next0, next1);
	}
      while (n_left_from > 0 && n_left_to_next > 0)
	{
	  vlib_buffer_t *b0;
	  u32 sw_if_index0;
	  u16 ether_type0;
	  u32 next0 = ~0;
	  u8 l2_len0;
	  u32 bi0;
	  u8 *h0;

	  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);
	  l2_len0 = vnet_buffer (b0)->l2.l2_len;

	  h0 = vlib_buffer_get_current (b0);
	  ether_type0 = clib_net_to_host_u16 (*(u16 *) (h0 + l2_len0 - 2));
	  sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];

	  /*
	   * only extract unicast
	   */
	  if (PREDICT_TRUE (!(h0[0] & 0x1)))
	    {
	      switch (ether_type0)
		{
		case ETHERNET_TYPE_IP4:
		  ASSERT (l2_emulations[sw_if_index0].enabled);
		  ++ip4_hits;
		  next0 = L2_EMULATION_NEXT_IP4;
		  vlib_buffer_advance (b0, l2_len0);
		  break;
		case ETHERNET_TYPE_IP6:
		  ASSERT (l2_emulations[sw_if_index0].enabled);
		  ++ip6_hits;
		  next0 = L2_EMULATION_NEXT_IP6;
		  vlib_buffer_advance (b0, l2_len0);
		default:
		  break;
		}
	    }

	  if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
			     && (b0->flags & VLIB_BUFFER_IS_TRACED)))
	    {
	      l2_emulation_trace_t *t =
		vlib_add_trace (vm, node, b0, sizeof (*t));
	      t->extracted = (next0 != ~0);
	    }

	  /* Determine the next node and remove ourself from bitmap */
	  if (PREDICT_TRUE (next0 == ~0))
	    next0 = vnet_l2_feature_next (b0, em->l2_input_feat_next,
					  L2INPUT_FEAT_L2_EMULATION);

	  /* verify speculative enqueue, maybe switch current next frame */
	  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, node->node_index,
			       L2_EMULATION_ERROR_IP4, ip4_hits);
  vlib_node_increment_counter (vm, node->node_index,
			       L2_EMULATION_ERROR_IP6, ip6_hits);

  return frame->n_vectors;
}

/* packet trace format function */
static u8 *
format_l2_emulation_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 *);
  l2_emulation_trace_t *t = va_arg (*args, l2_emulation_trace_t *);

  s = format (s, "l2-emulation: %s", (t->extracted ? "yes" : "no"));

  return s;
}

/* *INDENT-OFF* */
VLIB_REGISTER_NODE (l2_emulation_node) = {
  .function = l2_emulation_node_fn,
  .name = "l2-emulation",
  .vector_size = sizeof (u32),
  .format_trace = format_l2_emulation_trace,
  .type = VLIB_NODE_TYPE_INTERNAL,

  .n_errors = ARRAY_LEN(l2_emulation_error_strings),
  .error_strings = l2_emulation_error_strings,

  .n_next_nodes = L2_EMULATION_N_NEXT,

  /* edit / add dispositions here */
  .next_nodes = {
    [L2_EMULATION_NEXT_IP4] = "ip4-input",
    [L2_EMULATION_NEXT_IP6] = "ip6-input",
  },
};
/* *INDENT-ON* */

VLIB_NODE_FUNCTION_MULTIARCH (l2_emulation_node, l2_emulation_node_fn);


static clib_error_t *
l2_emulation_init (vlib_main_t * vm)
{
  l2_emulation_main_t *em = &l2_emulation_main;

  /* Initialize the feature next-node indexes */
  feat_bitmap_init_next_nodes (vm,
			       l2_emulation_node.index,
			       L2INPUT_N_FEAT,
			       l2input_get_feat_names (),
			       em->l2_input_feat_next);

  return 0;
}

VLIB_INIT_FUNCTION (l2_emulation_init);

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