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,
150 ip_adjacency_t * adj, vlib_buffer_t * b0, const void *data)
152 const pppoe_session_t *t;
153 pppoe_header_t *pppoe0;
155 /* update the rewrite string */
156 pppoe0 = vlib_buffer_get_current (b0) + sizeof (ethernet_header_t);
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 */
165 vnet_buffer (b0)->sw_if_index[VLIB_TX] = t->encap_if_index;
169 pppoe_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
171 pppoe_main_t *pem = &pppoe_main;
172 dpo_id_t dpo = DPO_INVALID;
177 ASSERT (ADJ_INDEX_INVALID != ai);
180 session_id = pem->session_index_by_sw_if_index[sw_if_index];
181 t = pool_elt_at_index (pem->sessions, session_id);
183 switch (adj->lookup_next_index)
185 case IP_LOOKUP_NEXT_ARP:
186 case IP_LOOKUP_NEXT_GLEAN:
187 adj_nbr_midchain_update_rewrite (ai, pppoe_fixup, t,
189 pppoe_build_rewrite (vnm,
194 case IP_LOOKUP_NEXT_MCAST:
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
199 adj_mcast_midchain_update_rewrite (ai, pppoe_fixup, t,
201 pppoe_build_rewrite (vnm,
207 case IP_LOOKUP_NEXT_DROP:
208 case IP_LOOKUP_NEXT_PUNT:
209 case IP_LOOKUP_NEXT_LOCAL:
210 case IP_LOOKUP_NEXT_REWRITE:
211 case IP_LOOKUP_NEXT_MIDCHAIN:
212 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
213 case IP_LOOKUP_NEXT_ICMP_ERROR:
214 case IP_LOOKUP_N_NEXT:
219 interface_tx_dpo_add_or_lock (vnet_link_to_dpo_proto (adj->ia_link),
220 t->encap_if_index, &dpo);
222 adj_nbr_midchain_stack (ai, &dpo);
228 VNET_HW_INTERFACE_CLASS (pppoe_hw_class) =
231 .format_header = format_pppoe_header_with_length,
232 .build_rewrite = pppoe_build_rewrite,
233 .update_adjacency = pppoe_update_adj,
234 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
238 #define foreach_copy_field \
245 pppoe_decap_next_is_valid (pppoe_main_t * pem, u32 is_ip6,
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);
252 return decap_fib_index < r->n_next_nodes;
255 int vnet_pppoe_add_del_session
256 (vnet_pppoe_add_del_session_args_t * a, u32 * sw_if_indexp)
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;
267 pppoe_entry_key_t key;
268 pppoe_entry_result_t result;
269 vnet_hw_interface_t *hi;
270 vnet_sw_interface_t *si;
274 cached_result.raw = ~0; /* warning be gone */
275 memset (&pfx, 0, sizeof (pfx));
279 pfx.fp_addr.ip4.as_u32 = a->client_ip.ip4.as_u32;
281 pfx.fp_proto = FIB_PROTOCOL_IP4;
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];
288 pfx.fp_proto = FIB_PROTOCOL_IP6;
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;
296 if (a->encap_if_index == ~0)
297 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
299 si = vnet_get_sw_interface (vnm, a->encap_if_index);
300 hi = vnet_get_hw_interface (vnm, si->hw_if_index);
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);
307 /* learn client session */
308 pppoe_learn_process (&pem->session_table, a->encap_if_index,
309 &key, &cached_key, &bucket, &result);
313 /* adding a session: session must not already exist */
314 if (result.fields.session_index != ~0)
315 return VNET_API_ERROR_TUNNEL_EXIST;
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;
321 pool_get_aligned (pem->sessions, t, CLIB_CACHE_LINE_BYTES);
322 memset (t, 0, sizeof (*t));
324 clib_memcpy (t->local_mac, hi->hw_address, 6);
326 /* copy from arg structure */
327 #define _(x) t->x = a->x;
331 clib_memcpy (t->client_mac, a->client_mac, 6);
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);
339 vnet_hw_interface_t *hi;
340 if (vec_len (pem->free_pppoe_session_hw_if_indices) > 0)
342 vnet_interface_main_t *im = &vnm->interface_main;
343 hw_if_index = pem->free_pppoe_session_hw_if_indices
344 [vec_len (pem->free_pppoe_session_hw_if_indices) - 1];
345 _vec_len (pem->free_pppoe_session_hw_if_indices) -= 1;
347 hi = vnet_get_hw_interface (vnm, hw_if_index);
348 hi->dev_instance = t - pem->sessions;
349 hi->hw_instance = hi->dev_instance;
351 /* clear old stats of freed session before reuse */
352 sw_if_index = hi->sw_if_index;
353 vnet_interface_counter_lock (im);
354 vlib_zero_combined_counter
355 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
357 vlib_zero_combined_counter (&im->combined_sw_if_counters
358 [VNET_INTERFACE_COUNTER_RX],
360 vlib_zero_simple_counter (&im->sw_if_counters
361 [VNET_INTERFACE_COUNTER_DROP],
363 vnet_interface_counter_unlock (im);
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);
373 t->hw_if_index = hw_if_index;
374 t->sw_if_index = sw_if_index = hi->sw_if_index;
376 vec_validate_init_empty (pem->session_index_by_sw_if_index, sw_if_index,
378 pem->session_index_by_sw_if_index[sw_if_index] = t - pem->sessions;
380 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
381 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
382 vnet_sw_interface_set_flags (vnm, sw_if_index,
383 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
385 /* add reverse route for client ip */
386 fib_table_entry_path_add (a->decap_fib_index, &pfx,
387 FIB_SOURCE_PLUGIN_HI, FIB_ENTRY_FLAG_NONE,
388 fib_proto_to_dpo (pfx.fp_proto),
389 &pfx.fp_addr, sw_if_index, ~0,
390 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
395 /* deleting a session: session must exist */
396 if (result.fields.session_index == ~0)
397 return VNET_API_ERROR_NO_SUCH_ENTRY;
399 t = pool_elt_at_index (pem->sessions, result.fields.session_index);
400 sw_if_index = t->sw_if_index;
402 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
403 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
404 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
406 vec_add1 (pem->free_pppoe_session_hw_if_indices, t->hw_if_index);
408 pem->session_index_by_sw_if_index[t->sw_if_index] = ~0;
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);
417 /* delete reverse route for client ip */
418 fib_table_entry_path_remove (a->decap_fib_index, &pfx,
419 FIB_SOURCE_PLUGIN_HI,
420 fib_proto_to_dpo (pfx.fp_proto),
423 FIB_ROUTE_PATH_FLAG_NONE);
425 pool_put (pem->sessions, t);
429 *sw_if_indexp = sw_if_index;
434 static clib_error_t *
435 pppoe_add_del_session_command_fn (vlib_main_t * vm,
436 unformat_input_t * input,
437 vlib_cli_command_t * cmd)
439 unformat_input_t _line_input, *line_input = &_line_input;
441 ip46_address_t client_ip;
443 u8 client_ip_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;
452 vnet_pppoe_add_del_session_args_t _a, *a = &_a;
453 u32 session_sw_if_index;
454 clib_error_t *error = NULL;
456 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
457 memset (&client_ip, 0, sizeof client_ip);
459 /* Get a line of input. */
460 if (!unformat_user (input, unformat_line_input, line_input))
463 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
465 if (unformat (line_input, "del"))
469 else if (unformat (line_input, "session-id %d", &session_id))
471 else if (unformat (line_input, "client-ip %U",
472 unformat_ip4_address, &client_ip.ip4))
477 else if (unformat (line_input, "client-ip %U",
478 unformat_ip6_address, &client_ip.ip6))
483 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
486 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
488 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
490 if (decap_fib_index == ~0)
493 clib_error_return (0, "nonexistent decap fib id %d", tmp);
499 (line_input, "client-mac %U", unformat_ethernet_address,
504 error = clib_error_return (0, "parse error: '%U'",
505 format_unformat_error, line_input);
510 if (client_ip_set == 0)
513 clib_error_return (0, "session client ip address not specified");
517 if (ipv4_set && ipv6_set)
519 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
523 if (client_mac_set == 0)
525 error = clib_error_return (0, "session client mac not specified");
529 memset (a, 0, sizeof (*a));
532 a->is_ip6 = ipv6_set;
534 #define _(x) a->x = x;
538 clib_memcpy (a->client_mac, client_mac, 6);
540 rv = vnet_pppoe_add_del_session (a, &session_sw_if_index);
546 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
547 vnet_get_main (), session_sw_if_index);
550 case VNET_API_ERROR_TUNNEL_EXIST:
551 error = clib_error_return (0, "session already exists...");
554 case VNET_API_ERROR_NO_SUCH_ENTRY:
555 error = clib_error_return (0, "session does not exist...");
559 error = clib_error_return
560 (0, "vnet_pppoe_add_del_session returned %d", rv);
565 unformat_free (line_input);
571 * Add or delete a PPPPOE Session.
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 }
582 VLIB_CLI_COMMAND (create_pppoe_session_command, static) = {
583 .path = "create pppoe session",
585 "create pppoe session client-ip <client-ip> session-id <nn>"
586 " client-mac <client-mac> [decap-vrf-id <nn>] [del]",
587 .function = pppoe_add_del_session_command_fn,
592 static clib_error_t *
593 show_pppoe_session_command_fn (vlib_main_t * vm,
594 unformat_input_t * input,
595 vlib_cli_command_t * cmd)
597 pppoe_main_t *pem = &pppoe_main;
600 if (pool_elts (pem->sessions) == 0)
601 vlib_cli_output (vm, "No pppoe sessions configured...");
603 pool_foreach (t, pem->sessions,
605 vlib_cli_output (vm, "%U",format_pppoe_session, t);
613 * Display all the PPPPOE Session entries.
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
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,
630 /** Display the contents of the PPPoE Fib. */
631 static clib_error_t *
632 show_pppoe_fib_command_fn (vlib_main_t * vm,
633 unformat_input_t * input, vlib_cli_command_t * cmd)
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;
642 u64 total_entries = 0;
646 for (i = 0; i < h->nbuckets; i++)
651 v = BV (clib_bihash_get_value) (h, b->offset);
652 for (j = 0; j < (1 << b->log2_pages); j++)
654 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
656 if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
663 "%=19s%=12s%=13s%=14s",
664 "Mac-Address", "session_id", "sw_if_index",
668 key.raw = v->kvp[k].key;
669 result.raw = v->kvp[k].value;
673 "%=19U%=12d%=13d%=14d",
674 format_ethernet_address, key.fields.mac,
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);
687 if (total_entries == 0)
688 vlib_cli_output (vm, "no pppoe fib entries");
690 vlib_cli_output (vm, "%lld pppoe fib entries", total_entries);
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
702 * Example of how to display the number of MAC Address entries in the PPPoE
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
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,
719 pppoe_init (vlib_main_t * vm)
721 pppoe_main_t *pem = &pppoe_main;
723 pem->vnet_main = vnet_get_main ();
726 /* Create the hash table */
727 BV (clib_bihash_init) (&pem->link_table, "pppoe link table",
728 PPPOE_NUM_BUCKETS, PPPOE_MEMORY_SIZE);
730 BV (clib_bihash_init) (&pem->session_table, "pppoe session table",
731 PPPOE_NUM_BUCKETS, PPPOE_MEMORY_SIZE);
733 ethernet_register_input_type (vm, ETHERNET_TYPE_PPPOE_SESSION,
734 pppoe_input_node.index);
736 ethernet_register_input_type (vm, ETHERNET_TYPE_PPPOE_DISCOVERY,
737 pppoe_cp_dispatch_node.index);
742 VLIB_INIT_FUNCTION (pppoe_init);
745 VLIB_PLUGIN_REGISTER () = {
746 .version = VPP_BUILD_VER,
747 .description = "PPPoE",
752 * fd.io coding-style-patch-verification: ON
755 * eval: (c-set-style "gnu")