FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
pppoe.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2017 Intel and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *------------------------------------------------------------------
16  */
17 #include <stdint.h>
18 #include <net/if.h>
19 #include <sys/ioctl.h>
20 #include <inttypes.h>
21 
22 #include <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vnet/ethernet/ethernet.h>
25 #include <vnet/fib/fib_entry.h>
26 #include <vnet/fib/fib_table.h>
28 #include <vnet/plugin/plugin.h>
29 #include <vpp/app/version.h>
30 #include <vnet/ppp/packet.h>
31 #include <pppoe/pppoe.h>
32 #include <vnet/adj/adj_midchain.h>
33 #include <vnet/adj/adj_mcast.h>
34 
35 #include <vppinfra/hash.h>
37 
39 
40 u8 *
41 format_pppoe_session (u8 * s, va_list * args)
42 {
43  pppoe_session_t *t = va_arg (*args, pppoe_session_t *);
44  pppoe_main_t *pem = &pppoe_main;
45 
46  s = format (s, "[%d] sw-if-index %d client-ip %U session-id %d ",
47  t - pem->sessions, t->sw_if_index,
49  t->session_id);
50 
51  s = format (s, "encap-if-index %d decap-fib-index %d\n",
53 
54  s = format (s, " local-mac %U client-mac %U",
57 
58  return s;
59 }
60 
61 static u8 *
62 format_pppoe_name (u8 * s, va_list * args)
63 {
64  u32 dev_instance = va_arg (*args, u32);
65  return format (s, "pppoe_session%d", dev_instance);
66 }
67 
68 static uword
70  vlib_node_runtime_t * node, vlib_frame_t * frame)
71 {
72  clib_warning ("you shouldn't be here, leaking buffers...");
73  return frame->n_vectors;
74 }
75 
76 static clib_error_t *
78 {
79  u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
81  vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
82 
83  return /* no error */ 0;
84 }
85 
86 /* *INDENT-OFF* */
87 VNET_DEVICE_CLASS (pppoe_device_class,static) = {
88  .name = "PPPPOE",
89  .format_device_name = format_pppoe_name,
90  .tx_function = dummy_interface_tx,
91  .admin_up_down_function = pppoe_interface_admin_up_down,
92 };
93 /* *INDENT-ON* */
94 
95 static u8 *
96 format_pppoe_header_with_length (u8 * s, va_list * args)
97 {
98  u32 dev_instance = va_arg (*args, u32);
99  s = format (s, "unimplemented dev %u", dev_instance);
100  return s;
101 }
102 
103 static u8 *
105  u32 sw_if_index,
106  vnet_link_t link_type, const void *dst_address)
107 {
108  int len = sizeof (pppoe_header_t) + sizeof (ethernet_header_t);
109  pppoe_main_t *pem = &pppoe_main;
110  pppoe_session_t *t;
111  u32 session_id;
112  u8 *rw = 0;
113 
114  session_id = pem->session_index_by_sw_if_index[sw_if_index];
115  t = pool_elt_at_index (pem->sessions, session_id);
116 
118 
119  ethernet_header_t *eth_hdr = (ethernet_header_t *) rw;
120  clib_memcpy (eth_hdr->dst_address, t->client_mac, 6);
121  clib_memcpy (eth_hdr->src_address, t->local_mac, 6);
122  eth_hdr->type = clib_host_to_net_u16 (ETHERNET_TYPE_PPPOE_SESSION);
123 
124  pppoe_header_t *pppoe = (pppoe_header_t *) (eth_hdr + 1);
125  pppoe->ver_type = PPPOE_VER_TYPE;
126  pppoe->code = 0;
127  pppoe->session_id = clib_host_to_net_u16 (t->session_id);
128  pppoe->length = 0; /* To be filled in at run-time */
129 
130  switch (link_type)
131  {
132  case VNET_LINK_IP4:
133  pppoe->ppp_proto = clib_host_to_net_u16 (PPP_PROTOCOL_ip4);
134  break;
135  case VNET_LINK_IP6:
136  pppoe->ppp_proto = clib_host_to_net_u16 (PPP_PROTOCOL_ip6);
137  break;
138  default:
139  break;
140  }
141 
142  return rw;
143 }
144 
145 /**
146  * @brief Fixup the adj rewrite post encap. Insert the packet's length
147  */
148 static void
150  ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
151 {
152  const pppoe_session_t *t;
153  pppoe_header_t *pppoe0;
154 
155  /* update the rewrite string */
156  pppoe0 = vlib_buffer_get_current (b0) + sizeof (ethernet_header_t);
157 
158  pppoe0->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
159  - sizeof (pppoe_header_t)
160  + sizeof (pppoe0->ppp_proto)
161  - sizeof (ethernet_header_t));
162  /* Swap to the the packet's output interface to the encap (not the
163  * session) interface */
164  t = data;
165  vnet_buffer (b0)->sw_if_index[VLIB_TX] = t->encap_if_index;
166 }
167 
168 static void
169 pppoe_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
170 {
171  pppoe_main_t *pem = &pppoe_main;
172  dpo_id_t dpo = DPO_INVALID;
173  ip_adjacency_t *adj;
174  pppoe_session_t *t;
175  u32 session_id;
176 
177  ASSERT (ADJ_INDEX_INVALID != ai);
178 
179  adj = adj_get (ai);
180  session_id = pem->session_index_by_sw_if_index[sw_if_index];
181  t = pool_elt_at_index (pem->sessions, session_id);
182 
183  switch (adj->lookup_next_index)
184  {
185  case IP_LOOKUP_NEXT_ARP:
189  pppoe_build_rewrite (vnm,
190  sw_if_index,
191  adj->ia_link,
192  NULL));
193  break;
195  /*
196  * Construct a partial rewrite from the known ethernet mcast dest MAC
197  * There's no MAC fixup, so the last 2 parameters are 0
198  */
201  pppoe_build_rewrite (vnm,
202  sw_if_index,
203  adj->ia_link,
204  NULL), 0, 0);
205  break;
206 
207  case IP_LOOKUP_NEXT_DROP:
208  case IP_LOOKUP_NEXT_PUNT:
214  case IP_LOOKUP_N_NEXT:
215  ASSERT (0);
216  break;
217  }
218 
220  t->encap_if_index, &dpo);
221 
222  adj_nbr_midchain_stack (ai, &dpo);
223 
224  dpo_reset (&dpo);
225 }
226 
227 /* *INDENT-OFF* */
228 VNET_HW_INTERFACE_CLASS (pppoe_hw_class) =
229 {
230  .name = "PPPPOE",
231  .format_header = format_pppoe_header_with_length,
232  .build_rewrite = pppoe_build_rewrite,
233  .update_adjacency = pppoe_update_adj,
235 };
236 /* *INDENT-ON* */
237 
238 #define foreach_copy_field \
239 _(session_id) \
240 _(encap_if_index) \
241 _(decap_fib_index) \
242 _(client_ip)
243 
244 static bool
246  u32 decap_fib_index)
247 {
248  vlib_main_t *vm = pem->vlib_main;
249  u32 input_idx = (!is_ip6) ? ip4_input_node.index : ip6_input_node.index;
250  vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
251 
252  return decap_fib_index < r->n_next_nodes;
253 }
254 
257 {
258  pppoe_main_t *pem = &pppoe_main;
259  pppoe_session_t *t = 0;
260  vnet_main_t *vnm = pem->vnet_main;
261  u32 hw_if_index = ~0;
262  u32 sw_if_index = ~0;
263  u32 is_ip6 = a->is_ip6;
264  pppoe_entry_key_t cached_key;
265  pppoe_entry_result_t cached_result;
266  u32 bucket;
267  pppoe_entry_key_t key;
268  pppoe_entry_result_t result;
271  fib_prefix_t pfx;
272 
273  cached_key.raw = ~0;
274  cached_result.raw = ~0; /* warning be gone */
275  memset (&pfx, 0, sizeof (pfx));
276 
277  if (!is_ip6)
278  {
279  pfx.fp_addr.ip4.as_u32 = a->client_ip.ip4.as_u32;
280  pfx.fp_len = 32;
282  }
283  else
284  {
285  pfx.fp_addr.ip6.as_u64[0] = a->client_ip.ip6.as_u64[0];
286  pfx.fp_addr.ip6.as_u64[1] = a->client_ip.ip6.as_u64[1];
287  pfx.fp_len = 128;
289  }
290 
291  /* Get encap_if_index and local mac address from link_table */
292  pppoe_lookup_1 (&pem->link_table, &cached_key, &cached_result,
293  a->client_mac, 0, &key, &bucket, &result);
294  a->encap_if_index = result.fields.sw_if_index;
295 
296  if (a->encap_if_index == ~0)
297  return VNET_API_ERROR_INVALID_SW_IF_INDEX;
298 
299  si = vnet_get_sw_interface (vnm, a->encap_if_index);
300  hi = vnet_get_hw_interface (vnm, si->hw_if_index);
301 
302  /* lookup session_table */
303  pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
304  a->client_mac, clib_host_to_net_u16 (a->session_id),
305  &key, &bucket, &result);
306 
307  /* learn client session */
308  pppoe_learn_process (&pem->session_table, a->encap_if_index,
309  &key, &cached_key, &bucket, &result);
310 
311  if (a->is_add)
312  {
313  /* adding a session: session must not already exist */
314  if (result.fields.session_index != ~0)
315  return VNET_API_ERROR_TUNNEL_EXIST;
316 
317  /*if not set explicitly, default to ip4 */
318  if (!pppoe_decap_next_is_valid (pem, is_ip6, a->decap_fib_index))
319  return VNET_API_ERROR_INVALID_DECAP_NEXT;
320 
322  memset (t, 0, sizeof (*t));
323 
324  clib_memcpy (t->local_mac, hi->hw_address, 6);
325 
326  /* copy from arg structure */
327 #define _(x) t->x = a->x;
329 #undef _
330 
331  clib_memcpy (t->client_mac, a->client_mac, 6);
332 
333  /* update pppoe fib with session_index */
334  result.fields.session_index = t - pem->sessions;
335  pppoe_update_1 (&pem->session_table,
336  a->client_mac, clib_host_to_net_u16 (a->session_id),
337  &key, &bucket, &result);
338 
341  {
343  hw_if_index = pem->free_pppoe_session_hw_if_indices
345  _vec_len (pem->free_pppoe_session_hw_if_indices) -= 1;
346 
347  hi = vnet_get_hw_interface (vnm, hw_if_index);
348  hi->dev_instance = t - pem->sessions;
349  hi->hw_instance = hi->dev_instance;
350 
351  /* clear old stats of freed session before reuse */
352  sw_if_index = hi->sw_if_index;
356  sw_if_index);
359  sw_if_index);
362  sw_if_index);
364  }
365  else
366  {
367  hw_if_index = vnet_register_interface
368  (vnm, pppoe_device_class.index, t - pem->sessions,
369  pppoe_hw_class.index, t - pem->sessions);
370  hi = vnet_get_hw_interface (vnm, hw_if_index);
371  }
372 
373  t->hw_if_index = hw_if_index;
374  t->sw_if_index = sw_if_index = hi->sw_if_index;
375 
377  ~0);
378  pem->session_index_by_sw_if_index[sw_if_index] = t - pem->sessions;
379 
380  vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
382  vnet_sw_interface_set_flags (vnm, sw_if_index,
384 
385  /* add reverse route for client ip */
389  &pfx.fp_addr, sw_if_index, ~0,
391 
392  }
393  else
394  {
395  /* deleting a session: session must exist */
396  if (result.fields.session_index == ~0)
397  return VNET_API_ERROR_NO_SUCH_ENTRY;
398 
399  t = pool_elt_at_index (pem->sessions, result.fields.session_index);
400  sw_if_index = t->sw_if_index;
401 
402  vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
405 
407 
409 
410  /* update pppoe fib with session_inde=~0x */
411  result.fields.session_index = ~0;
412  pppoe_update_1 (&pem->session_table,
413  a->client_mac, clib_host_to_net_u16 (a->session_id),
414  &key, &bucket, &result);
415 
416 
417  /* delete reverse route for client ip */
421  &pfx.fp_addr,
422  sw_if_index, ~0, 1,
424 
425  pool_put (pem->sessions, t);
426  }
427 
428  if (sw_if_indexp)
429  *sw_if_indexp = sw_if_index;
430 
431  return 0;
432 }
433 
434 static clib_error_t *
436  unformat_input_t * input,
437  vlib_cli_command_t * cmd)
438 {
439  unformat_input_t _line_input, *line_input = &_line_input;
440  u16 session_id = 0;
441  ip46_address_t client_ip;
442  u8 is_add = 1;
443  u8 client_ip_set = 0;
444  u8 ipv4_set = 0;
445  u8 ipv6_set = 0;
446  u32 encap_if_index = 0;
447  u32 decap_fib_index = 0;
448  u8 client_mac[6] = { 0 };
449  u8 client_mac_set = 0;
450  int rv;
451  u32 tmp;
453  u32 session_sw_if_index;
454  clib_error_t *error = NULL;
455 
456  /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
457  memset (&client_ip, 0, sizeof client_ip);
458 
459  /* Get a line of input. */
460  if (!unformat_user (input, unformat_line_input, line_input))
461  return 0;
462 
463  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
464  {
465  if (unformat (line_input, "del"))
466  {
467  is_add = 0;
468  }
469  else if (unformat (line_input, "session-id %d", &session_id))
470  ;
471  else if (unformat (line_input, "client-ip %U",
472  unformat_ip4_address, &client_ip.ip4))
473  {
474  client_ip_set = 1;
475  ipv4_set = 1;
476  }
477  else if (unformat (line_input, "client-ip %U",
478  unformat_ip6_address, &client_ip.ip6))
479  {
480  client_ip_set = 1;
481  ipv6_set = 1;
482  }
483  else if (unformat (line_input, "decap-vrf-id %d", &tmp))
484  {
485  if (ipv6_set)
486  decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
487  else
488  decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
489 
490  if (decap_fib_index == ~0)
491  {
492  error =
493  clib_error_return (0, "nonexistent decap fib id %d", tmp);
494  goto done;
495  }
496  }
497  else
498  if (unformat
499  (line_input, "client-mac %U", unformat_ethernet_address,
500  client_mac))
501  client_mac_set = 1;
502  else
503  {
504  error = clib_error_return (0, "parse error: '%U'",
505  format_unformat_error, line_input);
506  goto done;
507  }
508  }
509 
510  if (client_ip_set == 0)
511  {
512  error =
513  clib_error_return (0, "session client ip address not specified");
514  goto done;
515  }
516 
517  if (ipv4_set && ipv6_set)
518  {
519  error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
520  goto done;
521  }
522 
523  if (client_mac_set == 0)
524  {
525  error = clib_error_return (0, "session client mac not specified");
526  goto done;
527  }
528 
529  memset (a, 0, sizeof (*a));
530 
531  a->is_add = is_add;
532  a->is_ip6 = ipv6_set;
533 
534 #define _(x) a->x = x;
536 #undef _
537 
538  clib_memcpy (a->client_mac, client_mac, 6);
539 
540  rv = vnet_pppoe_add_del_session (a, &session_sw_if_index);
541 
542  switch (rv)
543  {
544  case 0:
545  if (is_add)
547  vnet_get_main (), session_sw_if_index);
548  break;
549 
550  case VNET_API_ERROR_TUNNEL_EXIST:
551  error = clib_error_return (0, "session already exists...");
552  goto done;
553 
554  case VNET_API_ERROR_NO_SUCH_ENTRY:
555  error = clib_error_return (0, "session does not exist...");
556  goto done;
557 
558  default:
559  error = clib_error_return
560  (0, "vnet_pppoe_add_del_session returned %d", rv);
561  goto done;
562  }
563 
564 done:
565  unformat_free (line_input);
566 
567  return error;
568 }
569 
570 /*?
571  * Add or delete a PPPPOE Session.
572  *
573  * @cliexpar
574  * Example of how to create a PPPPOE Session:
575  * @cliexcmd{create pppoe session client-ip 10.0.3.1 session-id 13
576  * client-mac 00:01:02:03:04:05 }
577  * Example of how to delete a PPPPOE Session:
578  * @cliexcmd{create pppoe session client-ip 10.0.3.1 session-id 13
579  * client-mac 00:01:02:03:04:05 del }
580  ?*/
581 /* *INDENT-OFF* */
582 VLIB_CLI_COMMAND (create_pppoe_session_command, static) = {
583  .path = "create pppoe session",
584  .short_help =
585  "create pppoe session client-ip <client-ip> session-id <nn>"
586  " client-mac <client-mac> [decap-vrf-id <nn>] [del]",
588 };
589 /* *INDENT-ON* */
590 
591 /* *INDENT-OFF* */
592 static clib_error_t *
594  unformat_input_t * input,
595  vlib_cli_command_t * cmd)
596 {
597  pppoe_main_t *pem = &pppoe_main;
598  pppoe_session_t *t;
599 
600  if (pool_elts (pem->sessions) == 0)
601  vlib_cli_output (vm, "No pppoe sessions configured...");
602 
603  pool_foreach (t, pem->sessions,
604  ({
605  vlib_cli_output (vm, "%U",format_pppoe_session, t);
606  }));
607 
608  return 0;
609 }
610 /* *INDENT-ON* */
611 
612 /*?
613  * Display all the PPPPOE Session entries.
614  *
615  * @cliexpar
616  * Example of how to display the PPPPOE Session entries:
617  * @cliexstart{show pppoe session}
618  * [0] client-ip 10.0.3.1 session_id 13 encap-if-index 0 decap-vrf-id 13 sw_if_index 5
619  * local-mac a0:b0:c0:d0:e0:f0 client-mac 00:01:02:03:04:05
620  * @cliexend
621  ?*/
622 /* *INDENT-OFF* */
623 VLIB_CLI_COMMAND (show_pppoe_session_command, static) = {
624  .path = "show pppoe session",
625  .short_help = "show pppoe session",
626  .function = show_pppoe_session_command_fn,
627 };
628 /* *INDENT-ON* */
629 
630 /** Display the contents of the PPPoE Fib. */
631 static clib_error_t *
633  unformat_input_t * input, vlib_cli_command_t * cmd)
634 {
635  pppoe_main_t *pem = &pppoe_main;
636  BVT (clib_bihash) * h = &pem->session_table;
637  BVT (clib_bihash_bucket) * b;
638  BVT (clib_bihash_value) * v;
639  pppoe_entry_key_t key;
640  pppoe_entry_result_t result;
641  u32 first_entry = 1;
642  u64 total_entries = 0;
643  int i, j, k;
644  u8 *s = 0;
645 
646  for (i = 0; i < h->nbuckets; i++)
647  {
648  b = &h->buckets[i];
649  if (b->offset == 0)
650  continue;
651  v = BV (clib_bihash_get_value) (h, b->offset);
652  for (j = 0; j < (1 << b->log2_pages); j++)
653  {
654  for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
655  {
656  if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
657  continue;
658 
659  if (first_entry)
660  {
661  first_entry = 0;
662  vlib_cli_output (vm,
663  "%=19s%=12s%=13s%=14s",
664  "Mac-Address", "session_id", "sw_if_index",
665  "session_index");
666  }
667 
668  key.raw = v->kvp[k].key;
669  result.raw = v->kvp[k].value;
670 
671 
672  vlib_cli_output (vm,
673  "%=19U%=12d%=13d%=14d",
675  clib_net_to_host_u16 (key.fields.session_id),
676  result.fields.sw_if_index == ~0
677  ? -1 : result.fields.sw_if_index,
678  result.fields.session_index == ~0
679  ? -1 : result.fields.session_index);
680  vec_reset_length (s);
681  total_entries++;
682  }
683  v++;
684  }
685  }
686 
687  if (total_entries == 0)
688  vlib_cli_output (vm, "no pppoe fib entries");
689  else
690  vlib_cli_output (vm, "%lld pppoe fib entries", total_entries);
691 
692  vec_free (s);
693  return 0;
694 }
695 
696 /*?
697  * This command dispays the MAC Address entries of the PPPoE FIB table.
698  * Output can be filtered to just get the number of MAC Addresses or display
699  * each MAC Address.
700  *
701  * @cliexpar
702  * Example of how to display the number of MAC Address entries in the PPPoE
703  * FIB table:
704  * @cliexstart{show pppoe fib}
705  * Mac Address session_id Interface sw_if_index session_index
706  * 52:54:00:53:18:33 1 GigabitEthernet0/8/0 2 0
707  * 52:54:00:53:18:55 2 GigabitEthernet0/8/1 3 1
708  * @cliexend
709 ?*/
710 /* *INDENT-OFF* */
711 VLIB_CLI_COMMAND (show_pppoe_fib_command, static) = {
712  .path = "show pppoe fib",
713  .short_help = "show pppoe fib",
714  .function = show_pppoe_fib_command_fn,
715 };
716 /* *INDENT-ON* */
717 
718 clib_error_t *
720 {
721  pppoe_main_t *pem = &pppoe_main;
722 
723  pem->vnet_main = vnet_get_main ();
724  pem->vlib_main = vm;
725 
726  /* Create the hash table */
727  BV (clib_bihash_init) (&pem->link_table, "pppoe link table",
729 
730  BV (clib_bihash_init) (&pem->session_table, "pppoe session table",
732 
733  ethernet_register_input_type (vm, ETHERNET_TYPE_PPPOE_SESSION,
734  pppoe_input_node.index);
735 
736  ethernet_register_input_type (vm, ETHERNET_TYPE_PPPOE_DISCOVERY,
737  pppoe_cp_dispatch_node.index);
738 
739  return 0;
740 }
741 
743 
744 /* *INDENT-OFF* */
746  .version = VPP_BUILD_VER,
747  .description = "PPPoE",
748 };
749 /* *INDENT-ON* */
750 
751 /*
752  * fd.io coding-style-patch-verification: ON
753  *
754  * Local Variables:
755  * eval: (c-set-style "gnu")
756  * End:
757  */
u16 ppp_proto
Definition: pppoe.h:43
VLIB_PLUGIN_REGISTER()
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:197
vmrglw vmrglh hi
fib_node_index_t fib_table_entry_path_add(u32 fib_index, const fib_prefix_t *prefix, fib_source_t source, fib_entry_flag_t flags, dpo_proto_t next_hop_proto, const ip46_address_t *next_hop, u32 next_hop_sw_if_index, u32 next_hop_fib_index, u32 next_hop_weight, fib_mpls_label_t *next_hop_labels, fib_route_path_flags_t path_flags)
Add one path to an entry (aka route) in the FIB.
Definition: fib_table.c:514
Definition: pppoe.h:112
clib_error_t * vnet_hw_interface_set_flags(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:554
#define BIHASH_KVP_PER_PAGE
Definition: bihash_16_8.h:20
vlib_main_t * vlib_main
Definition: pppoe.h:175
VNET_HW_INTERFACE_CLASS(pppoe_hw_class)
static_always_inline void pppoe_learn_process(BVT(clib_bihash)*table, u32 sw_if_index0, pppoe_entry_key_t *key0, pppoe_entry_key_t *cached_key, u32 *bucket0, pppoe_entry_result_t *result0)
Perform learning on one packet based on the mac table lookup result.
Definition: pppoe.h:239
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
vnet_interface_main_t interface_main
Definition: vnet.h:56
u32 encap_if_index
Definition: pppoe.h:61
#define PPPOE_MEMORY_SIZE
Definition: pppoe.h:106
Multicast Adjacency.
Definition: adj.h:82
u16 session_id
Definition: pppoe.h:55
u64 raw
Definition: pppoe.h:146
#define NULL
Definition: clib.h:55
IP unicast adjacency.
Definition: adj.h:175
u8 src_address[6]
Definition: packet.h:56
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
This packet is to be rewritten and forwarded to the next processing node.
Definition: adj.h:73
#define vec_add1(V, E)
Add 1 element to end of vector (unspecified alignment).
Definition: vec.h:520
int i
uword unformat_user(unformat_input_t *input, unformat_function_t *func,...)
Definition: unformat.c:983
static clib_error_t * pppoe_interface_admin_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: pppoe.c:77
format_function_t format_ip46_address
Definition: format.h:61
static vnet_sw_interface_t * vnet_get_sw_interface(vnet_main_t *vnm, u32 sw_if_index)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
#define VNET_HW_INTERFACE_FLAG_LINK_UP
Definition: interface.h:390
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:445
static uword vlib_buffer_length_in_chain(vlib_main_t *vm, vlib_buffer_t *b)
Get length in bytes of the buffer chain.
Definition: buffer_funcs.h:107
format_function_t format_vnet_sw_if_index_name
static clib_error_t * show_pppoe_fib_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Display the contents of the PPPoE Fib.
Definition: pppoe.c:632
clib_error_t * pppoe_init(vlib_main_t *vm)
Definition: pppoe.c:719
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
vnet_link_t ia_link
link/ether-type 1 bytes
Definition: adj.h:196
VNET_DEVICE_CLASS(pppoe_device_class, static)
Adjacency to punt this packet.
Definition: adj.h:55
static void pppoe_update_adj(vnet_main_t *vnm, u32 sw_if_index, adj_index_t ai)
Definition: pppoe.c:169
static_always_inline void pppoe_lookup_1(BVT(clib_bihash)*table, pppoe_entry_key_t *cached_key, pppoe_entry_result_t *cached_result, u8 *mac0, u16 session_id0, pppoe_entry_key_t *key0, u32 *bucket0, pppoe_entry_result_t *result0)
Definition: pppoe.h:274
static ip_adjacency_t * adj_get(adj_index_t adj_index)
Get a pointer to an adjacency object from its index.
Definition: adj.h:376
u8 * format_ethernet_address(u8 *s, va_list *args)
Definition: format.c:44
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:440
unformat_function_t unformat_ip4_address
Definition: format.h:76
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
dpo_proto_t vnet_link_to_dpo_proto(vnet_link_t linkt)
Definition: dpo.c:95
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:718
u8 dst_address[6]
Definition: packet.h:55
static BVT(clib_bihash)
Definition: adj_nbr.c:26
A high priority source a plugin can use.
Definition: fib_entry.h:62
Aggregrate type for a prefix.
Definition: fib_types.h:188
#define clib_error_return(e, args...)
Definition: error.h:99
unsigned long u64
Definition: types.h:89
u32 fib_table_find(fib_protocol_t proto, u32 table_id)
Get the index of the FIB for a Table-ID.
Definition: fib_table.c:1037
u16 fp_len
The mask length.
Definition: fib_types.h:192
static bool pppoe_decap_next_is_valid(pppoe_main_t *pem, u32 is_ip6, u32 decap_fib_index)
Definition: pppoe.c:245
u32 vnet_register_interface(vnet_main_t *vnm, u32 dev_class_index, u32 dev_instance, u32 hw_class_index, u32 hw_instance)
Definition: interface.c:705
static u8 * format_pppoe_header_with_length(u8 *s, va_list *args)
Definition: pppoe.c:96
Definition: fib_entry.h:270
unformat_function_t unformat_line_input
Definition: format.h:281
u64 raw
Definition: pppoe.h:126
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
#define ADJ_INDEX_INVALID
Invalid ADJ index - used when no adj is known likewise blazoned capitals INVALID speak volumes where ...
Definition: adj_types.h:36
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:461
static void vlib_zero_combined_counter(vlib_combined_counter_main_t *cm, u32 index)
Clear a combined counter Clears the set of per-thread counters.
Definition: counter.h:276
vlib_node_registration_t ip4_input_node
Global ip4 input node.
Definition: ip4_input.c:277
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:211
static uword dummy_interface_tx(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: pppoe.c:69
vlib_node_registration_t ip6_input_node
(constructor) VLIB_REGISTER_NODE (ip6_input_node)
Definition: ip6_input.c:228
#define v
Definition: acl.c:495
struct _unformat_input_t unformat_input_t
u16 session_id
Definition: pppoe.h:41
u16 length
Definition: pppoe.h:42
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:209
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:273
u32 hw_if_index
Definition: pppoe.h:71
ip46_address_t client_ip
Definition: pppoe.h:58
This packet matches an "interface route" and packets need to be passed to ARP to find rewrite string ...
Definition: adj.h:68
vlib_simple_counter_main_t * sw_if_counters
Definition: interface.h:717
void interface_tx_dpo_add_or_lock(dpo_proto_t proto, u32 sw_if_index, dpo_id_t *dpo)
The data-path object representing transmitting the packet on a n interface.
void clib_bihash_init(clib_bihash *h, char *name, u32 nbuckets, uword memory_size)
initialize a bounded index extensible hash table
struct pppoe_entry_key_t::@466::@468 fields
unformat_function_t unformat_ip6_address
Definition: format.h:94
#define pool_get_aligned(P, E, A)
Allocate an object E from a pool P (general version).
Definition: pool.h:188
pppoe_main_t pppoe_main
Definition: pppoe.c:38
This packet matches an "incomplete adjacency" and packets need to be passed to ARP to find rewrite st...
Definition: adj.h:63
Adjacency to drop this packet.
Definition: adj.h:53
#define UNFORMAT_END_OF_INPUT
Definition: format.h:143
u16 n_vectors
Definition: node.h:344
vlib_main_t * vm
Definition: buffer.c:294
vlib_node_registration_t pppoe_input_node
(constructor) VLIB_REGISTER_NODE (pppoe_input_node)
Definition: pppoe_decap.c:401
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
Multicast Midchain Adjacency.
Definition: adj.h:86
static clib_error_t * pppoe_add_del_session_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: pppoe.c:435
#define PPPOE_NUM_BUCKETS
Definition: pppoe.h:105
#define clib_warning(format, args...)
Definition: error.h:59
void adj_nbr_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, const void *fixup_data, adj_flags_t flags, u8 *rewrite)
adj_nbr_midchain_update_rewrite
Definition: adj_midchain.c:506
static vlib_node_runtime_t * vlib_node_get_runtime(vlib_main_t *vm, u32 node_index)
Get node runtime by node index.
Definition: node_funcs.h:89
#define clib_memcpy(a, b, c)
Definition: string.h:75
static void vnet_interface_counter_unlock(vnet_interface_main_t *im)
Definition: interface.h:743
#define VNET_SW_INTERFACE_FLAG_HIDDEN
Definition: interface.h:600
u8 * format_pppoe_session(u8 *s, va_list *args)
Definition: pppoe.c:41
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
void adj_mcast_midchain_update_rewrite(adj_index_t adj_index, adj_midchain_fixup_t fixup, const void *fixup_data, adj_flags_t flags, u8 *rewrite, u8 offset, u32 mask)
adj_mcast_midchain_update_rewrite
Definition: adj_mcast.c:140
pppoe_session_t * sessions
Definition: pppoe.h:154
static_always_inline void pppoe_update_1(BVT(clib_bihash)*table, u8 *mac0, u16 session_id0, pppoe_entry_key_t *key0, u32 *bucket0, pppoe_entry_result_t *result0)
Definition: pppoe.h:308
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
This packets follow a mid-chain adjacency.
Definition: adj.h:76
static void vnet_interface_counter_lock(vnet_interface_main_t *im)
Definition: interface.h:735
struct pppoe_entry_result_t::@470::@472 fields
#define VNET_SW_INTERFACE_FLAG_ADMIN_UP
Definition: interface.h:588
uword unformat_ethernet_address(unformat_input_t *input, va_list *args)
Definition: format.c:227
#define ASSERT(truth)
void adj_nbr_midchain_stack(adj_index_t adj_index, const dpo_id_t *next)
adj_nbr_midchain_stack
Definition: adj_midchain.c:570
unsigned int u32
Definition: types.h:88
vnet_main_t * vnet_main
Definition: pppoe.h:176
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
static u8 * format_pppoe_name(u8 *s, va_list *args)
Definition: pppoe.c:62
Definition: pppoe.h:135
u32 sw_if_index
Definition: pppoe.h:70
vlib_node_registration_t pppoe_cp_dispatch_node
(constructor) VLIB_REGISTER_NODE (pppoe_cp_dispatch_node)
static void vlib_zero_simple_counter(vlib_simple_counter_main_t *cm, u32 index)
Clear a simple counter Clears the set of per-thread u16 counters, and the u64 counter.
Definition: counter.h:123
u8 client_mac[6]
Definition: pppoe.h:67
dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto)
Definition: fib_types.c:236
void fib_table_entry_path_remove(u32 fib_index, const fib_prefix_t *prefix, fib_source_t source, dpo_proto_t next_hop_proto, const ip46_address_t *next_hop, u32 next_hop_sw_if_index, u32 next_hop_fib_index, u32 next_hop_weight, fib_route_path_flags_t path_flags)
remove one path to an entry (aka route) in the FIB.
Definition: fib_table.c:674
void ethernet_register_input_type(vlib_main_t *vm, ethernet_type_t type, u32 node_index)
Definition: node.c:1333
u32 * session_index_by_sw_if_index
Definition: pppoe.h:166
h total_entries
u64 uword
Definition: types.h:112
template key/value backing page structure
Definition: bihash_doc.h:44
int vnet_pppoe_add_del_session(vnet_pppoe_add_del_session_args_t *a, u32 *sw_if_indexp)
Definition: pppoe.c:256
This packets needs to go to ICMP error.
Definition: adj.h:79
This packet is for one of our own IP addresses.
Definition: adj.h:58
Definition: defs.h:47
unsigned short u16
Definition: types.h:57
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
#define foreach_copy_field
Definition: pppoe.c:238
unsigned char u8
Definition: types.h:56
static u8 * pppoe_build_rewrite(vnet_main_t *vnm, u32 sw_if_index, vnet_link_t link_type, const void *dst_address)
Definition: pppoe.c:104
ip_lookup_next_t lookup_next_index
Next hop after ip4-lookup.
Definition: adj.h:190
u32 decap_fib_index
FIB indices - inner IP packet lookup here.
Definition: pppoe.h:64
static void unformat_free(unformat_input_t *i)
Definition: format.h:161
#define DPO_INVALID
An initialiser for DPOs declared on the stack.
Definition: dpo.h:195
a point 2 point interface
Definition: interface.h:285
static clib_error_t * show_pppoe_session_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: pppoe.c:593
#define vnet_buffer(b)
Definition: buffer.h:372
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
void dpo_reset(dpo_id_t *dpo)
reset a DPO ID The DPO will be unlocked.
Definition: dpo.c:231
clib_error_t * vnet_sw_interface_set_flags(vnet_main_t *vnm, u32 sw_if_index, u32 flags)
Definition: interface.c:562
static void * clib_bihash_get_value(clib_bihash *h, uword offset)
Get pointer to value page given its clib mheap offset.
u32 * free_pppoe_session_hw_if_indices
Definition: pppoe.h:163
u32 flags
Definition: vhost-user.h:77
#define vec_validate_init_empty(V, I, INIT)
Make sure vector is long enough for given index and initialize empty space (no header, unspecified alignment)
Definition: vec.h:483
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
u8 ver_type
Definition: pppoe.h:39
u8 local_mac[6]
Definition: pppoe.h:66
#define PPPOE_VER_TYPE
Definition: pppoe.h:46
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:680
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:169
static void pppoe_fixup(vlib_main_t *vm, ip_adjacency_t *adj, vlib_buffer_t *b0, const void *data)
Fixup the adj rewrite post encap.
Definition: pppoe.c:149
static uword pool_elts(void *v)
Number of active elements in a pool.
Definition: pool.h:128