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