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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
19 #include <sys/ioctl.h>
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>
35 #include <vppinfra/hash.h>
36 #include <vppinfra/bihash_template.c>
38 pppoe_main_t pppoe_main;
41 format_pppoe_session (u8 * s, va_list * args)
43 pppoe_session_t *t = va_arg (*args, pppoe_session_t *);
44 pppoe_main_t *pem = &pppoe_main;
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,
51 s = format (s, "encap-if-index %d decap-fib-index %d\n",
52 t->encap_if_index, t->decap_fib_index);
54 s = format (s, " local-mac %U client-mac %U",
55 format_ethernet_address, t->local_mac,
56 format_ethernet_address, t->client_mac);
62 format_pppoe_name (u8 * s, va_list * args)
64 u32 dev_instance = va_arg (*args, u32);
65 return format (s, "pppoe_session%d", dev_instance);
69 dummy_interface_tx (vlib_main_t * vm,
70 vlib_node_runtime_t * node, vlib_frame_t * frame)
72 clib_warning ("you shouldn't be here, leaking buffers...");
73 return frame->n_vectors;
77 pppoe_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
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);
83 return /* no error */ 0;
87 VNET_DEVICE_CLASS (pppoe_device_class,static) = {
89 .format_device_name = format_pppoe_name,
90 .tx_function = dummy_interface_tx,
91 .admin_up_down_function = pppoe_interface_admin_up_down,
96 format_pppoe_header_with_length (u8 * s, va_list * args)
98 u32 dev_instance = va_arg (*args, u32);
99 s = format (s, "unimplemented dev %u", dev_instance);
104 pppoe_build_rewrite (vnet_main_t * vnm,
106 vnet_link_t link_type, const void *dst_address)
108 int len = sizeof (pppoe_header_t) + sizeof (ethernet_header_t);
109 pppoe_main_t *pem = &pppoe_main;
114 session_id = pem->session_index_by_sw_if_index[sw_if_index];
115 t = pool_elt_at_index (pem->sessions, session_id);
117 vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
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);
124 pppoe_header_t *pppoe = (pppoe_header_t *) (eth_hdr + 1);
125 pppoe->ver_type = PPPOE_VER_TYPE;
127 pppoe->session_id = clib_host_to_net_u16 (t->session_id);
128 pppoe->length = 0; /* To be filled in at run-time */
133 pppoe->ppp_proto = clib_host_to_net_u16 (PPP_PROTOCOL_ip4);
136 pppoe->ppp_proto = clib_host_to_net_u16 (PPP_PROTOCOL_ip6);
146 * @brief Fixup the adj rewrite post encap. Insert the packet's length
149 pppoe_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b0)
151 pppoe_header_t *pppoe0;
153 pppoe0 = vlib_buffer_get_current (b0);
155 pppoe0->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0)
156 - sizeof (pppoe_header_t)
157 - sizeof (ethernet_header_t));
161 pppoe_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
163 pppoe_main_t *pem = &pppoe_main;
164 dpo_id_t dpo = DPO_INVALID;
169 ASSERT (ADJ_INDEX_INVALID != ai);
173 switch (adj->lookup_next_index)
175 case IP_LOOKUP_NEXT_ARP:
176 case IP_LOOKUP_NEXT_GLEAN:
177 adj_nbr_midchain_update_rewrite (ai, pppoe_fixup,
179 pppoe_build_rewrite (vnm,
184 case IP_LOOKUP_NEXT_MCAST:
186 * Construct a partial rewrite from the known ethernet mcast dest MAC
187 * There's no MAC fixup, so the last 2 parameters are 0
189 adj_mcast_midchain_update_rewrite (ai, pppoe_fixup,
191 pppoe_build_rewrite (vnm,
197 case IP_LOOKUP_NEXT_DROP:
198 case IP_LOOKUP_NEXT_PUNT:
199 case IP_LOOKUP_NEXT_LOCAL:
200 case IP_LOOKUP_NEXT_REWRITE:
201 case IP_LOOKUP_NEXT_MIDCHAIN:
202 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
203 case IP_LOOKUP_NEXT_ICMP_ERROR:
204 case IP_LOOKUP_N_NEXT:
209 session_id = pem->session_index_by_sw_if_index[sw_if_index];
210 t = pool_elt_at_index (pem->sessions, session_id);
211 interface_tx_dpo_add_or_lock (vnet_link_to_dpo_proto (adj->ia_link),
212 t->encap_if_index, &dpo);
214 adj_nbr_midchain_stack (ai, &dpo);
220 VNET_HW_INTERFACE_CLASS (pppoe_hw_class) =
223 .format_header = format_pppoe_header_with_length,
224 .build_rewrite = pppoe_build_rewrite,
225 .update_adjacency = pppoe_update_adj,
226 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
230 #define foreach_copy_field \
237 pppoe_decap_next_is_valid (pppoe_main_t * pem, u32 is_ip6,
240 vlib_main_t *vm = pem->vlib_main;
241 u32 input_idx = (!is_ip6) ? ip4_input_node.index : ip6_input_node.index;
242 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
244 return decap_fib_index < r->n_next_nodes;
247 int vnet_pppoe_add_del_session
248 (vnet_pppoe_add_del_session_args_t * a, u32 * sw_if_indexp)
250 pppoe_main_t *pem = &pppoe_main;
251 pppoe_session_t *t = 0;
252 vnet_main_t *vnm = pem->vnet_main;
253 u32 hw_if_index = ~0;
254 u32 sw_if_index = ~0;
255 u32 is_ip6 = a->is_ip6;
256 pppoe_entry_key_t cached_key;
257 pppoe_entry_result_t cached_result;
259 pppoe_entry_key_t key;
260 pppoe_entry_result_t result;
261 vnet_hw_interface_t *hi;
262 vnet_sw_interface_t *si;
266 cached_result.raw = ~0; /* warning be gone */
267 memset (&pfx, 0, sizeof (pfx));
271 pfx.fp_addr.ip4.as_u32 = a->client_ip.ip4.as_u32;
273 pfx.fp_proto = FIB_PROTOCOL_IP4;
277 pfx.fp_addr.ip6.as_u64[0] = a->client_ip.ip6.as_u64[0];
278 pfx.fp_addr.ip6.as_u64[1] = a->client_ip.ip6.as_u64[1];
280 pfx.fp_proto = FIB_PROTOCOL_IP6;
283 /* Get encap_if_index and local mac address */
284 pppoe_lookup_1 (&pem->session_table, &cached_key, &cached_result,
285 a->client_mac, clib_host_to_net_u16 (a->session_id),
286 &key, &bucket, &result);
287 a->encap_if_index = result.fields.sw_if_index;
289 if (a->encap_if_index == ~0)
290 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
292 si = vnet_get_sw_interface (vnm, a->encap_if_index);
293 hi = vnet_get_hw_interface (vnm, si->hw_if_index);
298 /* adding a session: session must not already exist */
299 if (result.fields.session_index != ~0)
300 return VNET_API_ERROR_TUNNEL_EXIST;
302 /*if not set explicitly, default to ip4 */
303 if (!pppoe_decap_next_is_valid (pem, is_ip6, a->decap_fib_index))
304 return VNET_API_ERROR_INVALID_DECAP_NEXT;
306 pool_get_aligned (pem->sessions, t, CLIB_CACHE_LINE_BYTES);
307 memset (t, 0, sizeof (*t));
309 clib_memcpy (t->local_mac, hi->hw_address, 6);
311 /* copy from arg structure */
312 #define _(x) t->x = a->x;
316 clib_memcpy (t->client_mac, a->client_mac, 6);
318 /* update pppoe fib with session_index */
319 result.fields.session_index = t - pem->sessions;
320 pppoe_update_1 (&pem->session_table,
321 a->client_mac, clib_host_to_net_u16 (a->session_id),
322 &key, &bucket, &result);
324 vnet_hw_interface_t *hi;
325 if (vec_len (pem->free_pppoe_session_hw_if_indices) > 0)
327 vnet_interface_main_t *im = &vnm->interface_main;
328 hw_if_index = pem->free_pppoe_session_hw_if_indices
329 [vec_len (pem->free_pppoe_session_hw_if_indices) - 1];
330 _vec_len (pem->free_pppoe_session_hw_if_indices) -= 1;
332 hi = vnet_get_hw_interface (vnm, hw_if_index);
333 hi->dev_instance = t - pem->sessions;
334 hi->hw_instance = hi->dev_instance;
336 /* clear old stats of freed session before reuse */
337 sw_if_index = hi->sw_if_index;
338 vnet_interface_counter_lock (im);
339 vlib_zero_combined_counter
340 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
342 vlib_zero_combined_counter (&im->combined_sw_if_counters
343 [VNET_INTERFACE_COUNTER_RX],
345 vlib_zero_simple_counter (&im->sw_if_counters
346 [VNET_INTERFACE_COUNTER_DROP],
348 vnet_interface_counter_unlock (im);
352 hw_if_index = vnet_register_interface
353 (vnm, pppoe_device_class.index, t - pem->sessions,
354 pppoe_hw_class.index, t - pem->sessions);
355 hi = vnet_get_hw_interface (vnm, hw_if_index);
358 t->hw_if_index = hw_if_index;
359 t->sw_if_index = sw_if_index = hi->sw_if_index;
361 vec_validate_init_empty (pem->session_index_by_sw_if_index, sw_if_index,
363 pem->session_index_by_sw_if_index[sw_if_index] = t - pem->sessions;
365 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
366 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
367 vnet_sw_interface_set_flags (vnm, sw_if_index,
368 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
370 /* add reverse route for client ip */
371 fib_table_entry_path_add (a->decap_fib_index, &pfx,
372 FIB_SOURCE_PLUGIN_HI, FIB_ENTRY_FLAG_NONE,
373 fib_proto_to_dpo (pfx.fp_proto),
374 &pfx.fp_addr, sw_if_index, ~0,
375 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
380 /* deleting a session: session must exist */
381 if (result.fields.session_index == ~0)
382 return VNET_API_ERROR_NO_SUCH_ENTRY;
384 t = pool_elt_at_index (pem->sessions, result.fields.session_index);
385 sw_if_index = t->sw_if_index;
387 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
388 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
389 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
391 vec_add1 (pem->free_pppoe_session_hw_if_indices, t->hw_if_index);
393 pem->session_index_by_sw_if_index[t->sw_if_index] = ~0;
395 /* update pppoe fib with session_inde=~0x */
396 result.fields.session_index = ~0;
397 pppoe_update_1 (&pem->session_table,
398 a->client_mac, clib_host_to_net_u16 (a->session_id),
399 &key, &bucket, &result);
402 /* delete reverse route for client ip */
403 fib_table_entry_path_remove (a->decap_fib_index, &pfx,
404 FIB_SOURCE_PLUGIN_HI,
405 fib_proto_to_dpo (pfx.fp_proto),
408 FIB_ROUTE_PATH_FLAG_NONE);
410 pool_put (pem->sessions, t);
414 *sw_if_indexp = sw_if_index;
419 static clib_error_t *
420 pppoe_add_del_session_command_fn (vlib_main_t * vm,
421 unformat_input_t * input,
422 vlib_cli_command_t * cmd)
424 unformat_input_t _line_input, *line_input = &_line_input;
426 ip46_address_t client_ip;
428 u8 client_ip_set = 0;
431 u32 encap_if_index = 0;
432 u32 decap_fib_index = 0;
433 u8 client_mac[6] = { 0 };
434 u8 client_mac_set = 0;
437 vnet_pppoe_add_del_session_args_t _a, *a = &_a;
438 u32 session_sw_if_index;
439 clib_error_t *error = NULL;
441 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
442 memset (&client_ip, 0, sizeof client_ip);
444 /* Get a line of input. */
445 if (!unformat_user (input, unformat_line_input, line_input))
448 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
450 if (unformat (line_input, "del"))
454 else if (unformat (line_input, "session-id %d", &session_id))
456 else if (unformat (line_input, "client-ip %U",
457 unformat_ip4_address, &client_ip.ip4))
462 else if (unformat (line_input, "client-ip %U",
463 unformat_ip6_address, &client_ip.ip6))
468 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
471 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
473 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
475 if (decap_fib_index == ~0)
478 clib_error_return (0, "nonexistent decap fib id %d", tmp);
484 (line_input, "client-mac %U", unformat_ethernet_address,
489 error = clib_error_return (0, "parse error: '%U'",
490 format_unformat_error, line_input);
495 if (client_ip_set == 0)
498 clib_error_return (0, "session client ip address not specified");
502 if (ipv4_set && ipv6_set)
504 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
508 if (client_mac_set == 0)
510 error = clib_error_return (0, "session client mac not specified");
514 memset (a, 0, sizeof (*a));
517 a->is_ip6 = ipv6_set;
519 #define _(x) a->x = x;
523 clib_memcpy (a->client_mac, client_mac, 6);
525 rv = vnet_pppoe_add_del_session (a, &session_sw_if_index);
531 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
532 vnet_get_main (), session_sw_if_index);
535 case VNET_API_ERROR_TUNNEL_EXIST:
536 error = clib_error_return (0, "session already exists...");
539 case VNET_API_ERROR_NO_SUCH_ENTRY:
540 error = clib_error_return (0, "session does not exist...");
544 error = clib_error_return
545 (0, "vnet_pppoe_add_del_session returned %d", rv);
550 unformat_free (line_input);
556 * Add or delete a PPPPOE Session.
559 * Example of how to create a PPPPOE Session:
560 * @cliexcmd{create pppoe session client-ip 10.0.3.1 session-id 13
561 * client-mac 00:01:02:03:04:05 }
562 * Example of how to delete a PPPPOE Session:
563 * @cliexcmd{create pppoe session client-ip 10.0.3.1 session-id 13
564 * client-mac 00:01:02:03:04:05 del }
567 VLIB_CLI_COMMAND (create_pppoe_session_command, static) = {
568 .path = "create pppoe session",
570 "create pppoe session client-ip <client-ip> session-id <nn>"
571 " client-mac <client-mac> [decap-vrf-id <nn>] [del]",
572 .function = pppoe_add_del_session_command_fn,
577 static clib_error_t *
578 show_pppoe_session_command_fn (vlib_main_t * vm,
579 unformat_input_t * input,
580 vlib_cli_command_t * cmd)
582 pppoe_main_t *pem = &pppoe_main;
585 if (pool_elts (pem->sessions) == 0)
586 vlib_cli_output (vm, "No pppoe sessions configured...");
588 pool_foreach (t, pem->sessions,
590 vlib_cli_output (vm, "%U",format_pppoe_session, t);
598 * Display all the PPPPOE Session entries.
601 * Example of how to display the PPPPOE Session entries:
602 * @cliexstart{show pppoe session}
603 * [0] client-ip 10.0.3.1 session_id 13 encap-if-index 0 decap-vrf-id 13 sw_if_index 5
604 * local-mac a0:b0:c0:d0:e0:f0 client-mac 00:01:02:03:04:05
608 VLIB_CLI_COMMAND (show_pppoe_session_command, static) = {
609 .path = "show pppoe session",
610 .short_help = "show pppoe session",
611 .function = show_pppoe_session_command_fn,
615 /** Display the contents of the PPPoE Fib. */
616 static clib_error_t *
617 show_pppoe_fib_command_fn (vlib_main_t * vm,
618 unformat_input_t * input, vlib_cli_command_t * cmd)
620 pppoe_main_t *pem = &pppoe_main;
621 BVT (clib_bihash) * h = &pem->session_table;
622 BVT (clib_bihash_bucket) * b;
623 BVT (clib_bihash_value) * v;
624 pppoe_entry_key_t key;
625 pppoe_entry_result_t result;
627 u64 total_entries = 0;
631 for (i = 0; i < h->nbuckets; i++)
636 v = BV (clib_bihash_get_value) (h, b->offset);
637 for (j = 0; j < (1 << b->log2_pages); j++)
639 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
641 if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
648 "%=19s%=12s%=13s%=14s",
649 "Mac-Address", "session_id", "sw_if_index",
653 key.raw = v->kvp[k].key;
654 result.raw = v->kvp[k].value;
658 "%=19U%=12d%=13d%=14d",
659 format_ethernet_address, key.fields.mac,
660 clib_net_to_host_u16 (key.fields.session_id),
661 result.fields.sw_if_index == ~0
662 ? -1 : result.fields.sw_if_index,
663 result.fields.session_index == ~0
664 ? -1 : result.fields.session_index);
665 vec_reset_length (s);
672 if (total_entries == 0)
673 vlib_cli_output (vm, "no pppoe fib entries");
675 vlib_cli_output (vm, "%lld pppoe fib entries", total_entries);
682 * This command dispays the MAC Address entries of the PPPoE FIB table.
683 * Output can be filtered to just get the number of MAC Addresses or display
687 * Example of how to display the number of MAC Address entries in the PPPoE
689 * @cliexstart{show pppoe fib}
690 * Mac Address session_id Interface sw_if_index session_index
691 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0 2 0
692 * 52:54:00:53:18:55 2 GigabitEthernet0/8/1 3 1
696 VLIB_CLI_COMMAND (show_pppoe_fib_command, static) = {
697 .path = "show pppoe fib",
698 .short_help = "show pppoe fib",
699 .function = show_pppoe_fib_command_fn,
704 pppoe_init (vlib_main_t * vm)
706 pppoe_main_t *pem = &pppoe_main;
708 pem->vnet_main = vnet_get_main ();
711 /* Create the hash table */
712 BV (clib_bihash_init) (&pem->session_table, "pppoe session table",
713 PPPOE_NUM_BUCKETS, PPPOE_MEMORY_SIZE);
715 ethernet_register_input_type (vm, ETHERNET_TYPE_PPPOE_SESSION,
716 pppoe_input_node.index);
718 ethernet_register_input_type (vm, ETHERNET_TYPE_PPPOE_DISCOVERY,
719 pppoe_tap_dispatch_node.index);
724 VLIB_INIT_FUNCTION (pppoe_init);
727 VLIB_PLUGIN_REGISTER () = {
728 .version = VPP_BUILD_VER,
729 .description = "PPPoE",
734 * fd.io coding-style-patch-verification: ON
737 * eval: (c-set-style "gnu")