src/plugins/pppoe/pppoe.c

   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>
  27 #include <vnet/dpo/interface_tx_dpo.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>
  36 #include <vppinfra/bihash_template.c>
  37
  38 pppoe_main_t pppoe_main;
  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,
  48               format_ip46_address, &t->client_ip, IP46_TYPE_ANY,
  49               t->session_id);
  50
  51   s = format (s, "encap-if-index %d decap-fib-index %d\n",
  52               t->encap_if_index, t->decap_fib_index);
  53
  54   s = format (s, "    local-mac %U  client-mac %U",
  55               format_ethernet_address, t->local_mac,
  56               format_ethernet_address, t->client_mac);
  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
  69 dummy_interface_tx (vlib_main_t * vm,
  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 *
  77 pppoe_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
  78 {
  79   u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
  80     VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
  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 *
 104 pppoe_build_rewrite (vnet_main_t * vnm,
 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
 117   vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
 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
 149 pppoe_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b0)
 150 {
 151   pppoe_header_t *pppoe0;
 152
 153   pppoe0 = vlib_buffer_get_current (b0) + sizeof (ethernet_header_t);
 154
 155   pppoe0->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
 156                                          - sizeof (pppoe_header_t)
 157                                          + sizeof (pppoe0->ppp_proto)
 158                                          - sizeof (ethernet_header_t));
 159 }
 160
 161 static void
 162 pppoe_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
 163 {
 164   pppoe_main_t *pem = &pppoe_main;
 165   dpo_id_t dpo = DPO_INVALID;
 166   ip_adjacency_t *adj;
 167   pppoe_session_t *t;
 168   u32 session_id;
 169
 170   ASSERT (ADJ_INDEX_INVALID != ai);
 171
 172   adj = adj_get (ai);
 173
 174   switch (adj->lookup_next_index)
 175     {
 176     case IP_LOOKUP_NEXT_ARP:
 177     case IP_LOOKUP_NEXT_GLEAN:
 178       adj_nbr_midchain_update_rewrite (ai, pppoe_fixup,
 179                                        ADJ_FLAG_NONE,
 180                                        pppoe_build_rewrite (vnm,
 181                                                             sw_if_index,
 182                                                             adj->ia_link,
 183                                                             NULL));
 184       break;
 185     case IP_LOOKUP_NEXT_MCAST:
 186       /*
 187        * Construct a partial rewrite from the known ethernet mcast dest MAC
 188        * There's no MAC fixup, so the last 2 parameters are 0
 189        */
 190       adj_mcast_midchain_update_rewrite (ai, pppoe_fixup,
 191                                          ADJ_FLAG_NONE,
 192                                          pppoe_build_rewrite (vnm,
 193                                                               sw_if_index,
 194                                                               adj->ia_link,
 195                                                               NULL), 0, 0);
 196       break;
 197
 198     case IP_LOOKUP_NEXT_DROP:
 199     case IP_LOOKUP_NEXT_PUNT:
 200     case IP_LOOKUP_NEXT_LOCAL:
 201     case IP_LOOKUP_NEXT_REWRITE:
 202     case IP_LOOKUP_NEXT_MIDCHAIN:
 203     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
 204     case IP_LOOKUP_NEXT_ICMP_ERROR:
 205     case IP_LOOKUP_N_NEXT:
 206       ASSERT (0);
 207       break;
 208     }
 209
 210   session_id = pem->session_index_by_sw_if_index[sw_if_index];
 211   t = pool_elt_at_index (pem->sessions, session_id);
 212   interface_tx_dpo_add_or_lock (vnet_link_to_dpo_proto (adj->ia_link),
 213                                 t->encap_if_index, &dpo);
 214
 215   adj_nbr_midchain_stack (ai, &dpo);
 216
 217   dpo_reset (&dpo);
 218 }
 219
 220 /* *INDENT-OFF* */
 221 VNET_HW_INTERFACE_CLASS (pppoe_hw_class) =
 222 {
 223   .name = "PPPPOE",
 224   .format_header = format_pppoe_header_with_length,
 225   .build_rewrite = pppoe_build_rewrite,
 226   .update_adjacency = pppoe_update_adj,
 227   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 228 };
 229 /* *INDENT-ON* */
 230
 231 #define foreach_copy_field                      \
 232 _(session_id)                                   \
 233 _(encap_if_index)                               \
 234 _(decap_fib_index)                              \
 235 _(client_ip)
 236
 237 static bool
 238 pppoe_decap_next_is_valid (pppoe_main_t * pem, u32 is_ip6,
 239                            u32 decap_fib_index)
 240 {
 241   vlib_main_t *vm = pem->vlib_main;
 242   u32 input_idx = (!is_ip6) ? ip4_input_node.index : ip6_input_node.index;
 243   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
 244
 245   return decap_fib_index < r->n_next_nodes;
 246 }
 247
 248 int vnet_pppoe_add_del_session
 249   (vnet_pppoe_add_del_session_args_t * a, u32 * sw_if_indexp)
 250 {
 251   pppoe_main_t *pem = &pppoe_main;
 252   pppoe_session_t *t = 0;
 253   vnet_main_t *vnm = pem->vnet_main;
 254   u32 hw_if_index = ~0;
 255   u32 sw_if_index = ~0;
 256   u32 is_ip6 = a->is_ip6;
 257   pppoe_entry_key_t cached_key;
 258   pppoe_entry_result_t cached_result;
 259   u32 bucket;
 260   pppoe_entry_key_t key;
 261   pppoe_entry_result_t result;
 262   vnet_hw_interface_t *hi;
 263   vnet_sw_interface_t *si;
 264   fib_prefix_t pfx;
 265
 266   cached_key.raw = ~0;
 267   cached_result.raw = ~0;       /* warning be gone */
 268   memset (&pfx, 0, sizeof (pfx));
 269
 270   if (!is_ip6)
 271     {
 272       pfx.fp_addr.ip4.as_u32 = a->client_ip.ip4.as_u32;
 273       pfx.fp_len = 32;
 274       pfx.fp_proto = FIB_PROTOCOL_IP4;
 275     }
 276   else
 277     {
 278       pfx.fp_addr.ip6.as_u64[0] = a->client_ip.ip6.as_u64[0];
 279       pfx.fp_addr.ip6.as_u64[1] = a->client_ip.ip6.as_u64[1];
 280       pfx.fp_len = 128;
 281       pfx.fp_proto = FIB_PROTOCOL_IP6;
 282     }
 283
 284   /* Get encap_if_index and local mac address from link_table */
 285   pppoe_lookup_1 (&pem->link_table, &cached_key, &cached_result,
 286                   a->client_mac, 0, &key, &bucket, &result);
 287   a->encap_if_index = result.fields.sw_if_index;
 288
 289   if (a->encap_if_index == ~0)
 290     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 291
 292   si = vnet_get_sw_interface (vnm, a->encap_if_index);
 293   hi = vnet_get_hw_interface (vnm, si->hw_if_index);
 294
 295   /* lookup session_table */
 296   pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
 297                   a->client_mac, clib_host_to_net_u16 (a->session_id),
 298                   &key, &bucket, &result);
 299
 300   /* learn client session */
 301   pppoe_learn_process (&pem->session_table, a->encap_if_index,
 302                        &key, &cached_key, &bucket, &result);
 303
 304   if (a->is_add)
 305     {
 306       /* adding a session: session must not already exist */
 307       if (result.fields.session_index != ~0)
 308         return VNET_API_ERROR_TUNNEL_EXIST;
 309
 310       /*if not set explicitly, default to ip4 */
 311       if (!pppoe_decap_next_is_valid (pem, is_ip6, a->decap_fib_index))
 312         return VNET_API_ERROR_INVALID_DECAP_NEXT;
 313
 314       pool_get_aligned (pem->sessions, t, CLIB_CACHE_LINE_BYTES);
 315       memset (t, 0, sizeof (*t));
 316
 317       clib_memcpy (t->local_mac, hi->hw_address, 6);
 318
 319       /* copy from arg structure */
 320 #define _(x) t->x = a->x;
 321       foreach_copy_field;
 322 #undef _
 323
 324       clib_memcpy (t->client_mac, a->client_mac, 6);
 325
 326       /* update pppoe fib with session_index */
 327       result.fields.session_index = t - pem->sessions;
 328       pppoe_update_1 (&pem->session_table,
 329                       a->client_mac, clib_host_to_net_u16 (a->session_id),
 330                       &key, &bucket, &result);
 331
 332       vnet_hw_interface_t *hi;
 333       if (vec_len (pem->free_pppoe_session_hw_if_indices) > 0)
 334         {
 335           vnet_interface_main_t *im = &vnm->interface_main;
 336           hw_if_index = pem->free_pppoe_session_hw_if_indices
 337             [vec_len (pem->free_pppoe_session_hw_if_indices) - 1];
 338           _vec_len (pem->free_pppoe_session_hw_if_indices) -= 1;
 339
 340           hi = vnet_get_hw_interface (vnm, hw_if_index);
 341           hi->dev_instance = t - pem->sessions;
 342           hi->hw_instance = hi->dev_instance;
 343
 344           /* clear old stats of freed session before reuse */
 345           sw_if_index = hi->sw_if_index;
 346           vnet_interface_counter_lock (im);
 347           vlib_zero_combined_counter
 348             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
 349              sw_if_index);
 350           vlib_zero_combined_counter (&im->combined_sw_if_counters
 351                                       [VNET_INTERFACE_COUNTER_RX],
 352                                       sw_if_index);
 353           vlib_zero_simple_counter (&im->sw_if_counters
 354                                     [VNET_INTERFACE_COUNTER_DROP],
 355                                     sw_if_index);
 356           vnet_interface_counter_unlock (im);
 357         }
 358       else
 359         {
 360           hw_if_index = vnet_register_interface
 361             (vnm, pppoe_device_class.index, t - pem->sessions,
 362              pppoe_hw_class.index, t - pem->sessions);
 363           hi = vnet_get_hw_interface (vnm, hw_if_index);
 364         }
 365
 366       t->hw_if_index = hw_if_index;
 367       t->sw_if_index = sw_if_index = hi->sw_if_index;
 368
 369       vec_validate_init_empty (pem->session_index_by_sw_if_index, sw_if_index,
 370                                ~0);
 371       pem->session_index_by_sw_if_index[sw_if_index] = t - pem->sessions;
 372
 373       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
 374       si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
 375       vnet_sw_interface_set_flags (vnm, sw_if_index,
 376                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
 377
 378       /* add reverse route for client ip */
 379       fib_table_entry_path_add (a->decap_fib_index, &pfx,
 380                                 FIB_SOURCE_PLUGIN_HI, FIB_ENTRY_FLAG_NONE,
 381                                 fib_proto_to_dpo (pfx.fp_proto),
 382                                 &pfx.fp_addr, sw_if_index, ~0,
 383                                 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
 384
 385     }
 386   else
 387     {
 388       /* deleting a session: session must exist */
 389       if (result.fields.session_index == ~0)
 390         return VNET_API_ERROR_NO_SUCH_ENTRY;
 391
 392       t = pool_elt_at_index (pem->sessions, result.fields.session_index);
 393       sw_if_index = t->sw_if_index;
 394
 395       vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
 396       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
 397       si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
 398
 399       vec_add1 (pem->free_pppoe_session_hw_if_indices, t->hw_if_index);
 400
 401       pem->session_index_by_sw_if_index[t->sw_if_index] = ~0;
 402
 403       /* update pppoe fib with session_inde=~0x */
 404       result.fields.session_index = ~0;
 405       pppoe_update_1 (&pem->session_table,
 406                       a->client_mac, clib_host_to_net_u16 (a->session_id),
 407                       &key, &bucket, &result);
 408
 409
 410       /* delete reverse route for client ip */
 411       fib_table_entry_path_remove (a->decap_fib_index, &pfx,
 412                                    FIB_SOURCE_PLUGIN_HI,
 413                                    fib_proto_to_dpo (pfx.fp_proto),
 414                                    &pfx.fp_addr,
 415                                    sw_if_index, ~0, 1,
 416                                    FIB_ROUTE_PATH_FLAG_NONE);
 417
 418       pool_put (pem->sessions, t);
 419     }
 420
 421   if (sw_if_indexp)
 422     *sw_if_indexp = sw_if_index;
 423
 424   return 0;
 425 }
 426
 427 static clib_error_t *
 428 pppoe_add_del_session_command_fn (vlib_main_t * vm,
 429                                   unformat_input_t * input,
 430                                   vlib_cli_command_t * cmd)
 431 {
 432   unformat_input_t _line_input, *line_input = &_line_input;
 433   u16 session_id = 0;
 434   ip46_address_t client_ip;
 435   u8 is_add = 1;
 436   u8 client_ip_set = 0;
 437   u8 ipv4_set = 0;
 438   u8 ipv6_set = 0;
 439   u32 encap_if_index = 0;
 440   u32 decap_fib_index = 0;
 441   u8 client_mac[6] = { 0 };
 442   u8 client_mac_set = 0;
 443   int rv;
 444   u32 tmp;
 445   vnet_pppoe_add_del_session_args_t _a, *a = &_a;
 446   u32 session_sw_if_index;
 447   clib_error_t *error = NULL;
 448
 449   /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
 450   memset (&client_ip, 0, sizeof client_ip);
 451
 452   /* Get a line of input. */
 453   if (!unformat_user (input, unformat_line_input, line_input))
 454     return 0;
 455
 456   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 457     {
 458       if (unformat (line_input, "del"))
 459         {
 460           is_add = 0;
 461         }
 462       else if (unformat (line_input, "session-id %d", &session_id))
 463         ;
 464       else if (unformat (line_input, "client-ip %U",
 465                          unformat_ip4_address, &client_ip.ip4))
 466         {
 467           client_ip_set = 1;
 468           ipv4_set = 1;
 469         }
 470       else if (unformat (line_input, "client-ip %U",
 471                          unformat_ip6_address, &client_ip.ip6))
 472         {
 473           client_ip_set = 1;
 474           ipv6_set = 1;
 475         }
 476       else if (unformat (line_input, "decap-vrf-id %d", &tmp))
 477         {
 478           if (ipv6_set)
 479             decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
 480           else
 481             decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
 482
 483           if (decap_fib_index == ~0)
 484             {
 485               error =
 486                 clib_error_return (0, "nonexistent decap fib id %d", tmp);
 487               goto done;
 488             }
 489         }
 490       else
 491         if (unformat
 492             (line_input, "client-mac %U", unformat_ethernet_address,
 493              client_mac))
 494         client_mac_set = 1;
 495       else
 496         {
 497           error = clib_error_return (0, "parse error: '%U'",
 498                                      format_unformat_error, line_input);
 499           goto done;
 500         }
 501     }
 502
 503   if (client_ip_set == 0)
 504     {
 505       error =
 506         clib_error_return (0, "session client ip address not specified");
 507       goto done;
 508     }
 509
 510   if (ipv4_set && ipv6_set)
 511     {
 512       error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
 513       goto done;
 514     }
 515
 516   if (client_mac_set == 0)
 517     {
 518       error = clib_error_return (0, "session client mac not specified");
 519       goto done;
 520     }
 521
 522   memset (a, 0, sizeof (*a));
 523
 524   a->is_add = is_add;
 525   a->is_ip6 = ipv6_set;
 526
 527 #define _(x) a->x = x;
 528   foreach_copy_field;
 529 #undef _
 530
 531   clib_memcpy (a->client_mac, client_mac, 6);
 532
 533   rv = vnet_pppoe_add_del_session (a, &session_sw_if_index);
 534
 535   switch (rv)
 536     {
 537     case 0:
 538       if (is_add)
 539         vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
 540                          vnet_get_main (), session_sw_if_index);
 541       break;
 542
 543     case VNET_API_ERROR_TUNNEL_EXIST:
 544       error = clib_error_return (0, "session already exists...");
 545       goto done;
 546
 547     case VNET_API_ERROR_NO_SUCH_ENTRY:
 548       error = clib_error_return (0, "session does not exist...");
 549       goto done;
 550
 551     default:
 552       error = clib_error_return
 553         (0, "vnet_pppoe_add_del_session returned %d", rv);
 554       goto done;
 555     }
 556
 557 done:
 558   unformat_free (line_input);
 559
 560   return error;
 561 }
 562
 563 /*?
 564  * Add or delete a PPPPOE Session.
 565  *
 566  * @cliexpar
 567  * Example of how to create a PPPPOE Session:
 568  * @cliexcmd{create pppoe session client-ip 10.0.3.1 session-id 13
 569  *             client-mac 00:01:02:03:04:05 }
 570  * Example of how to delete a PPPPOE Session:
 571  * @cliexcmd{create pppoe session client-ip 10.0.3.1 session-id 13
 572  *             client-mac 00:01:02:03:04:05 del }
 573  ?*/
 574 /* *INDENT-OFF* */
 575 VLIB_CLI_COMMAND (create_pppoe_session_command, static) = {
 576   .path = "create pppoe session",
 577   .short_help =
 578   "create pppoe session client-ip <client-ip> session-id <nn>"
 579   " client-mac <client-mac> [decap-vrf-id <nn>] [del]",
 580   .function = pppoe_add_del_session_command_fn,
 581 };
 582 /* *INDENT-ON* */
 583
 584 /* *INDENT-OFF* */
 585 static clib_error_t *
 586 show_pppoe_session_command_fn (vlib_main_t * vm,
 587                                unformat_input_t * input,
 588                                vlib_cli_command_t * cmd)
 589 {
 590   pppoe_main_t *pem = &pppoe_main;
 591   pppoe_session_t *t;
 592
 593   if (pool_elts (pem->sessions) == 0)
 594     vlib_cli_output (vm, "No pppoe sessions configured...");
 595
 596   pool_foreach (t, pem->sessions,
 597                 ({
 598                     vlib_cli_output (vm, "%U",format_pppoe_session, t);
 599                 }));
 600
 601   return 0;
 602 }
 603 /* *INDENT-ON* */
 604
 605 /*?
 606  * Display all the PPPPOE Session entries.
 607  *
 608  * @cliexpar
 609  * Example of how to display the PPPPOE Session entries:
 610  * @cliexstart{show pppoe session}
 611  * [0] client-ip 10.0.3.1 session_id 13 encap-if-index 0 decap-vrf-id 13 sw_if_index 5
 612  *     local-mac a0:b0:c0:d0:e0:f0 client-mac 00:01:02:03:04:05
 613  * @cliexend
 614  ?*/
 615 /* *INDENT-OFF* */
 616 VLIB_CLI_COMMAND (show_pppoe_session_command, static) = {
 617     .path = "show pppoe session",
 618     .short_help = "show pppoe session",
 619     .function = show_pppoe_session_command_fn,
 620 };
 621 /* *INDENT-ON* */
 622
 623 /** Display the contents of the PPPoE Fib. */
 624 static clib_error_t *
 625 show_pppoe_fib_command_fn (vlib_main_t * vm,
 626                            unformat_input_t * input, vlib_cli_command_t * cmd)
 627 {
 628   pppoe_main_t *pem = &pppoe_main;
 629   BVT (clib_bihash) * h = &pem->session_table;
 630   BVT (clib_bihash_bucket) * b;
 631   BVT (clib_bihash_value) * v;
 632   pppoe_entry_key_t key;
 633   pppoe_entry_result_t result;
 634   u32 first_entry = 1;
 635   u64 total_entries = 0;
 636   int i, j, k;
 637   u8 *s = 0;
 638
 639   for (i = 0; i < h->nbuckets; i++)
 640     {
 641       b = &h->buckets[i];
 642       if (b->offset == 0)
 643         continue;
 644       v = BV (clib_bihash_get_value) (h, b->offset);
 645       for (j = 0; j < (1 << b->log2_pages); j++)
 646         {
 647           for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
 648             {
 649               if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
 650                 continue;
 651
 652               if (first_entry)
 653                 {
 654                   first_entry = 0;
 655                   vlib_cli_output (vm,
 656                                    "%=19s%=12s%=13s%=14s",
 657                                    "Mac-Address", "session_id", "sw_if_index",
 658                                    "session_index");
 659                 }
 660
 661               key.raw = v->kvp[k].key;
 662               result.raw = v->kvp[k].value;
 663
 664
 665               vlib_cli_output (vm,
 666                                "%=19U%=12d%=13d%=14d",
 667                                format_ethernet_address, key.fields.mac,
 668                                clib_net_to_host_u16 (key.fields.session_id),
 669                                result.fields.sw_if_index == ~0
 670                                ? -1 : result.fields.sw_if_index,
 671                                result.fields.session_index == ~0
 672                                ? -1 : result.fields.session_index);
 673               vec_reset_length (s);
 674               total_entries++;
 675             }
 676           v++;
 677         }
 678     }
 679
 680   if (total_entries == 0)
 681     vlib_cli_output (vm, "no pppoe fib entries");
 682   else
 683     vlib_cli_output (vm, "%lld pppoe fib entries", total_entries);
 684
 685   vec_free (s);
 686   return 0;
 687 }
 688
 689 /*?
 690  * This command dispays the MAC Address entries of the PPPoE FIB table.
 691  * Output can be filtered to just get the number of MAC Addresses or display
 692  * each MAC Address.
 693  *
 694  * @cliexpar
 695  * Example of how to display the number of MAC Address entries in the PPPoE
 696  * FIB table:
 697  * @cliexstart{show pppoe fib}
 698  *     Mac Address      session_id      Interface           sw_if_index  session_index
 699  *  52:54:00:53:18:33     1          GigabitEthernet0/8/0        2          0
 700  *  52:54:00:53:18:55     2          GigabitEthernet0/8/1        3          1
 701  * @cliexend
 702 ?*/
 703 /* *INDENT-OFF* */
 704 VLIB_CLI_COMMAND (show_pppoe_fib_command, static) = {
 705     .path = "show pppoe fib",
 706     .short_help = "show pppoe fib",
 707     .function = show_pppoe_fib_command_fn,
 708 };
 709 /* *INDENT-ON* */
 710
 711 clib_error_t *
 712 pppoe_init (vlib_main_t * vm)
 713 {
 714   pppoe_main_t *pem = &pppoe_main;
 715
 716   pem->vnet_main = vnet_get_main ();
 717   pem->vlib_main = vm;
 718
 719   /* Create the hash table  */
 720   BV (clib_bihash_init) (&pem->link_table, "pppoe link table",
 721                          PPPOE_NUM_BUCKETS, PPPOE_MEMORY_SIZE);
 722
 723   BV (clib_bihash_init) (&pem->session_table, "pppoe session table",
 724                          PPPOE_NUM_BUCKETS, PPPOE_MEMORY_SIZE);
 725
 726   ethernet_register_input_type (vm, ETHERNET_TYPE_PPPOE_SESSION,
 727                                 pppoe_input_node.index);
 728
 729   ethernet_register_input_type (vm, ETHERNET_TYPE_PPPOE_DISCOVERY,
 730                                 pppoe_cp_dispatch_node.index);
 731
 732   return 0;
 733 }
 734
 735 VLIB_INIT_FUNCTION (pppoe_init);
 736
 737 /* *INDENT-OFF* */
 738 VLIB_PLUGIN_REGISTER () = {
 739     .version = VPP_BUILD_VER,
 740     .description = "PPPoE",
 741 };
 742 /* *INDENT-ON* */
 743
 744 /*
 745  * fd.io coding-style-patch-verification: ON
 746  *
 747  * Local Variables:
 748  * eval: (c-set-style "gnu")
 749  * End:
 750  */