1 /* SPDX-License-Identifier: Apache-2.0
2 * Copyright (c) 2023 Cisco Systems, Inc.
6 #include <vnet/ethernet/ethernet.h>
7 #include <vnet/dev/dev.h>
8 #include <vnet/dev/counters.h>
9 #include <vnet/dev/log.h>
11 VLIB_REGISTER_LOG_CLASS (dev_log, static) = {
13 .subclass_name = "port",
17 dummy_input_fn (vlib_main_t *vm, vlib_node_runtime_t *node,
24 VLIB_REGISTER_NODE (port_rx_eth_node) = {
25 .function = dummy_input_fn,
26 .name = "port-rx-eth",
27 .runtime_data_bytes = sizeof (vnet_dev_rx_node_runtime_t),
28 .type = VLIB_NODE_TYPE_INPUT,
29 .state = VLIB_NODE_STATE_DISABLED,
30 .n_next_nodes = VNET_DEV_ETH_RX_PORT_N_NEXTS,
32 #define _(n, s) [VNET_DEV_ETH_RX_PORT_NEXT_##n] = s,
33 foreach_vnet_dev_port_rx_next
38 u16 vnet_dev_default_next_index_by_port_type[] = {
39 [VNET_DEV_PORT_TYPE_ETHERNET] = VNET_DEV_ETH_RX_PORT_NEXT_ETH_INPUT,
42 VNET_FEATURE_ARC_INIT (eth_port_rx, static) = {
43 .arc_name = "port-rx-eth",
44 .start_nodes = VNET_FEATURES ("port-rx-eth"),
45 .last_in_arc = "ethernet-input",
46 .arc_index_ptr = &vnet_dev_main.eth_port_rx_feature_arc_index,
49 VNET_FEATURE_INIT (l2_patch, static) = {
50 .arc_name = "port-rx-eth",
51 .node_name = "l2-patch",
52 .runs_before = VNET_FEATURES ("ethernet-input"),
55 VNET_FEATURE_INIT (worker_handoff, static) = {
56 .arc_name = "port-rx-eth",
57 .node_name = "worker-handoff",
58 .runs_before = VNET_FEATURES ("ethernet-input"),
61 VNET_FEATURE_INIT (span_input, static) = {
62 .arc_name = "port-rx-eth",
63 .node_name = "span-input",
64 .runs_before = VNET_FEATURES ("ethernet-input"),
67 VNET_FEATURE_INIT (p2p_ethernet_node, static) = {
68 .arc_name = "port-rx-eth",
69 .node_name = "p2p-ethernet-input",
70 .runs_before = VNET_FEATURES ("ethernet-input"),
73 VNET_FEATURE_INIT (ethernet_input, static) = {
74 .arc_name = "port-rx-eth",
75 .node_name = "ethernet-input",
76 .runs_before = 0, /* not before any other features */
80 vnet_dev_port_free (vlib_main_t *vm, vnet_dev_port_t *port)
82 vnet_dev_t *dev = port->dev;
84 vnet_dev_port_validate (vm, port);
86 ASSERT (port->started == 0);
88 log_debug (dev, "port %u", port->port_id);
90 if (port->port_ops.free)
91 port->port_ops.free (vm, port);
93 pool_free (port->secondary_hw_addr);
94 pool_free (port->rx_queues);
95 pool_free (port->tx_queues);
96 vnet_dev_arg_free (&port->args);
97 pool_put_index (dev->ports, port->index);
102 vnet_dev_port_update_tx_node_runtime (vlib_main_t *vm, vnet_dev_port_t *port)
104 vnet_dev_port_validate (vm, port);
106 foreach_vnet_dev_port_tx_queue (q, port)
109 clib_bitmap_foreach (ti, q->assigned_threads)
111 vlib_main_t *tvm = vlib_get_main_by_index (ti);
112 vlib_node_runtime_t *nr =
113 vlib_node_get_runtime (tvm, port->intf.tx_node_index);
114 vnet_dev_tx_node_runtime_t *tnr = vnet_dev_get_tx_node_runtime (nr);
115 tnr->hw_if_index = port->intf.hw_if_index;
122 vnet_dev_port_stop (vlib_main_t *vm, vnet_dev_port_t *port)
124 vnet_dev_t *dev = port->dev;
125 vnet_dev_rt_op_t *ops = 0;
126 u16 n_threads = vlib_get_n_threads ();
128 log_debug (dev, "stopping port %u", port->port_id);
130 for (u16 i = 0; i < n_threads; i++)
132 vnet_dev_rt_op_t op = { .thread_index = i, .port = port };
136 vnet_dev_rt_exec_ops (vm, dev, ops, vec_len (ops));
139 port->port_ops.stop (vm, port);
141 foreach_vnet_dev_port_rx_queue (q, port)
144 log_debug (dev, "port %u rx queue %u stopped", port->port_id,
148 foreach_vnet_dev_port_tx_queue (q, port)
151 log_debug (dev, "port %u tx queue %u stopped", port->port_id,
155 log_debug (dev, "port %u stopped", port->port_id);
160 vnet_dev_port_start_all_rx_queues (vlib_main_t *vm, vnet_dev_port_t *port)
162 vnet_dev_rv_t rv = VNET_DEV_OK;
164 vnet_dev_port_validate (vm, port);
166 foreach_vnet_dev_port_rx_queue (q, port)
168 rv = vnet_dev_rx_queue_start (vm, q);
169 if (rv != VNET_DEV_OK)
176 vnet_dev_port_start_all_tx_queues (vlib_main_t *vm, vnet_dev_port_t *port)
178 vnet_dev_rv_t rv = VNET_DEV_OK;
180 vnet_dev_port_validate (vm, port);
182 foreach_vnet_dev_port_tx_queue (q, port)
184 rv = vnet_dev_tx_queue_start (vm, q);
185 if (rv != VNET_DEV_OK)
192 vnet_dev_port_start (vlib_main_t *vm, vnet_dev_port_t *port)
194 u16 n_threads = vlib_get_n_threads ();
195 vnet_dev_t *dev = port->dev;
196 vnet_dev_rt_op_t *ops = 0;
199 vnet_dev_port_validate (vm, port);
201 log_debug (dev, "starting port %u", port->port_id);
203 vnet_dev_port_update_tx_node_runtime (vm, port);
205 if ((rv = port->port_ops.start (vm, port)) != VNET_DEV_OK)
207 vnet_dev_port_stop (vm, port);
211 for (u16 i = 0; i < n_threads; i++)
213 vnet_dev_rt_op_t op = { .thread_index = i, .port = port };
217 vnet_dev_rt_exec_ops (vm, dev, ops, vec_len (ops));
220 foreach_vnet_dev_port_rx_queue (q, port)
223 log_debug (dev, "port %u rx queue %u started", port->port_id,
228 foreach_vnet_dev_port_tx_queue (q, port)
231 log_debug (dev, "port %u tx queue %u started", port->port_id,
237 log_debug (dev, "port %u started", port->port_id);
243 vnet_dev_port_add (vlib_main_t *vm, vnet_dev_t *dev, vnet_dev_port_id_t id,
244 vnet_dev_port_add_args_t *args)
246 vnet_dev_port_t **pp, *port;
247 vnet_dev_rv_t rv = VNET_DEV_OK;
249 ASSERT (args->port.attr.type != VNET_DEV_PORT_TYPE_UNKNOWN);
250 ASSERT (args->port.attr.max_supported_rx_frame_size);
253 vnet_dev_alloc_with_data (sizeof (vnet_dev_port_t), args->port.data_size);
254 pool_get (dev->ports, pp);
256 clib_memcpy (vnet_dev_get_port_data (port), args->port.initial_data,
257 args->port.data_size);
259 port->index = pp - dev->ports;
261 port->attr = args->port.attr;
262 port->rx_queue_config = args->rx_queue.config;
263 port->tx_queue_config = args->tx_queue.config;
264 port->rx_queue_ops = args->rx_queue.ops;
265 port->tx_queue_ops = args->tx_queue.ops;
266 port->port_ops = args->port.ops;
267 port->rx_node = *args->rx_node;
268 port->tx_node = *args->tx_node;
271 for (vnet_dev_arg_t *a = args->port.args; a->type != VNET_DEV_ARG_END; a++)
272 vec_add1 (port->args, *a);
274 /* defaults out of port attributes */
275 port->max_rx_frame_size = args->port.attr.max_supported_rx_frame_size;
276 port->primary_hw_addr = args->port.attr.hw_addr;
278 if (port->attr.type == VNET_DEV_PORT_TYPE_ETHERNET)
280 if (port->max_rx_frame_size > 1514 &&
281 port->attr.caps.change_max_rx_frame_size)
282 port->max_rx_frame_size = 1514;
285 if (port->port_ops.alloc)
286 rv = port->port_ops.alloc (vm, port);
288 if (rv == VNET_DEV_OK)
289 port->initialized = 1;
295 vnet_dev_port_cfg_change_req_validate (vlib_main_t *vm, vnet_dev_port_t *port,
296 vnet_dev_port_cfg_change_req_t *req)
299 vnet_dev_hw_addr_t *addr;
307 case VNET_DEV_PORT_CFG_MAX_RX_FRAME_SIZE:
308 if (req->max_rx_frame_size > port->attr.max_supported_rx_frame_size)
309 return VNET_DEV_ERR_INVALID_VALUE;
310 if (req->max_rx_frame_size == port->max_rx_frame_size)
311 return VNET_DEV_ERR_NO_CHANGE;
314 case VNET_DEV_PORT_CFG_PROMISC_MODE:
315 if (req->promisc == port->promisc)
316 return VNET_DEV_ERR_NO_CHANGE;
319 case VNET_DEV_PORT_CFG_CHANGE_PRIMARY_HW_ADDR:
320 if (clib_memcmp (&req->addr, &port->primary_hw_addr,
321 sizeof (vnet_dev_hw_addr_t)) == 0)
322 return VNET_DEV_ERR_NO_CHANGE;
325 case VNET_DEV_PORT_CFG_ADD_SECONDARY_HW_ADDR:
326 pool_foreach (addr, port->secondary_hw_addr)
327 if (clib_memcmp (addr, &req->addr, sizeof (*addr)) == 0)
328 return VNET_DEV_ERR_ALREADY_EXISTS;
331 case VNET_DEV_PORT_CFG_REMOVE_SECONDARY_HW_ADDR:
333 pool_foreach (addr, port->secondary_hw_addr)
334 if (clib_memcmp (addr, &req->addr, sizeof (*addr)) == 0)
337 return VNET_DEV_ERR_NO_SUCH_ENTRY;
344 if (port->port_ops.config_change_validate)
346 rv = port->port_ops.config_change_validate (vm, port, req);
347 if (rv != VNET_DEV_OK)
351 return VNET_DEV_ERR_NOT_SUPPORTED;
358 vnet_dev_port_cfg_change (vlib_main_t *vm, vnet_dev_port_t *port,
359 vnet_dev_port_cfg_change_req_t *req)
361 vnet_dev_rv_t rv = VNET_DEV_OK;
362 vnet_dev_hw_addr_t *a;
363 vnet_dev_rx_queue_t *rxq = 0;
366 vnet_dev_port_validate (vm, port);
368 if (req->type == VNET_DEV_PORT_CFG_RXQ_INTR_MODE_ENABLE ||
369 req->type == VNET_DEV_PORT_CFG_RXQ_INTR_MODE_DISABLE)
371 if (req->all_queues == 0)
373 rxq = vnet_dev_port_get_rx_queue_by_id (port, req->queue_id);
375 return VNET_DEV_ERR_BUG;
379 if ((rv = vnet_dev_port_cfg_change_req_validate (vm, port, req)))
382 if (port->port_ops.config_change)
383 rv = port->port_ops.config_change (vm, port, req);
385 return VNET_DEV_ERR_NOT_SUPPORTED;
387 if (rv != VNET_DEV_OK)
392 case VNET_DEV_PORT_CFG_MAX_RX_FRAME_SIZE:
393 port->max_rx_frame_size = req->max_rx_frame_size;
396 case VNET_DEV_PORT_CFG_PROMISC_MODE:
397 port->promisc = req->promisc;
400 case VNET_DEV_PORT_CFG_RXQ_INTR_MODE_ENABLE:
402 case VNET_DEV_PORT_CFG_RXQ_INTR_MODE_DISABLE:
405 clib_bitmap_t *bmp = 0;
406 vnet_dev_rt_op_t *ops = 0;
409 foreach_vnet_dev_port_rx_queue (q, port)
411 q->interrupt_mode = enable;
412 bmp = clib_bitmap_set (bmp, q->rx_thread_index, 1);
415 clib_bitmap_foreach (i, bmp)
417 vnet_dev_rt_op_t op = { .port = port, .thread_index = i };
421 vnet_dev_rt_exec_ops (vm, port->dev, ops, vec_len (ops));
422 clib_bitmap_free (bmp);
427 rxq->interrupt_mode = enable;
428 vnet_dev_rt_exec_ops (vm, port->dev,
431 .thread_index = rxq->rx_thread_index,
437 case VNET_DEV_PORT_CFG_CHANGE_PRIMARY_HW_ADDR:
438 clib_memcpy (&port->primary_hw_addr, &req->addr,
439 sizeof (vnet_dev_hw_addr_t));
442 case VNET_DEV_PORT_CFG_ADD_SECONDARY_HW_ADDR:
443 pool_get (port->secondary_hw_addr, a);
444 clib_memcpy (a, &req->addr, sizeof (vnet_dev_hw_addr_t));
447 case VNET_DEV_PORT_CFG_REMOVE_SECONDARY_HW_ADDR:
448 pool_foreach (a, port->secondary_hw_addr)
449 if (clib_memcmp (a, &req->addr, sizeof (vnet_dev_hw_addr_t)) == 0)
451 pool_put (port->secondary_hw_addr, a);
464 vnet_dev_port_state_change (vlib_main_t *vm, vnet_dev_port_t *port,
465 vnet_dev_port_state_changes_t changes)
467 vnet_main_t *vnm = vnet_get_main ();
469 vnet_dev_port_validate (vm, port);
471 if (changes.change.link_speed)
473 port->speed = changes.link_speed;
474 if (port->interface_created)
475 vnet_hw_interface_set_link_speed (vnm, port->intf.hw_if_index,
477 log_debug (port->dev, "port speed changed to %u", changes.link_speed);
480 if (changes.change.link_state)
482 port->link_up = changes.link_state;
483 if (port->interface_created)
484 vnet_hw_interface_set_flags (
485 vnm, port->intf.hw_if_index,
486 changes.link_state ? VNET_HW_INTERFACE_FLAG_LINK_UP : 0);
487 log_debug (port->dev, "port link state changed to %s",
488 changes.link_state ? "up" : "down");
493 vnet_dev_port_add_counters (vlib_main_t *vm, vnet_dev_port_t *port,
494 vnet_dev_counter_t *counters, u16 n_counters)
496 vnet_dev_port_validate (vm, port);
499 vnet_dev_counters_alloc (vm, counters, n_counters, "%s port %u counters",
500 port->dev->device_id, port->port_id);
504 vnet_dev_port_free_counters (vlib_main_t *vm, vnet_dev_port_t *port)
506 vnet_dev_port_validate (vm, port);
508 if (port->counter_main)
509 vnet_dev_counters_free (vm, port->counter_main);
513 vnet_dev_port_if_create (vlib_main_t *vm, vnet_dev_port_t *port)
515 vnet_main_t *vnm = vnet_get_main ();
516 u16 n_threads = vlib_get_n_threads ();
517 vnet_dev_main_t *dm = &vnet_dev_main;
518 vnet_dev_t *dev = port->dev;
519 vnet_dev_port_t **pp;
523 if (port->intf.name[0] == 0)
526 s = format (0, "%s%u/%u",
527 dm->drivers[port->dev->driver_index].registration->name,
528 port->dev->index, port->index);
531 if (n >= sizeof (port->intf.name))
534 return VNET_DEV_ERR_BUG;
536 clib_memcpy (port->intf.name, s, n);
537 port->intf.name[n] = 0;
542 dev, "allocating %u rx queues with size %u and %u tx queues with size %u",
543 port->intf.num_rx_queues, port->intf.rxq_sz, port->intf.num_tx_queues,
546 for (int i = 0; i < port->intf.num_rx_queues; i++)
547 if ((rv = vnet_dev_rx_queue_alloc (vm, port, port->intf.rxq_sz)) !=
551 for (u32 i = 0; i < port->intf.num_tx_queues; i++)
552 if ((rv = vnet_dev_tx_queue_alloc (vm, port, port->intf.txq_sz)) !=
556 foreach_vnet_dev_port_tx_queue (q, port)
558 q->assigned_threads = clib_bitmap_set (q->assigned_threads, ti, 1);
559 log_debug (dev, "port %u tx queue %u assigned to thread %u",
560 port->port_id, q->queue_id, ti);
561 if (++ti >= n_threads)
565 /* pool of port pointers helps us to assign unique dev_instance */
566 pool_get (dm->ports_by_dev_instance, pp);
567 port->intf.dev_instance = pp - dm->ports_by_dev_instance;
570 if (port->attr.type == VNET_DEV_PORT_TYPE_ETHERNET)
572 vnet_device_class_t *dev_class;
573 vnet_dev_driver_t *driver;
574 vnet_sw_interface_t *sw;
575 vnet_hw_interface_t *hw;
578 driver = pool_elt_at_index (dm->drivers, dev->driver_index);
580 /* hack to provide per-port tx node function */
581 dev_class = vnet_get_device_class (vnm, driver->dev_class_index);
582 dev_class->tx_fn_registrations = port->tx_node.registrations;
583 dev_class->format_tx_trace = port->tx_node.format_trace;
584 dev_class->tx_function_error_counters = port->tx_node.error_counters;
585 dev_class->tx_function_n_errors = port->tx_node.n_error_counters;
587 /* create new interface including tx and output nodes */
588 port->intf.hw_if_index = vnet_eth_register_interface (
589 vnm, &(vnet_eth_interface_registration_t){
590 .address = port->primary_hw_addr.eth_mac,
591 .max_frame_size = port->max_rx_frame_size,
592 .dev_class_index = driver->dev_class_index,
593 .dev_instance = port->intf.dev_instance,
594 .cb.set_max_frame_size = vnet_dev_port_set_max_frame_size,
595 .cb.flag_change = vnet_dev_port_eth_flag_change,
598 sw = vnet_get_hw_sw_interface (vnm, port->intf.hw_if_index);
599 hw = vnet_get_hw_interface (vnm, port->intf.hw_if_index);
600 port->intf.sw_if_index = sw->sw_if_index;
601 vnet_hw_interface_set_flags (
602 vnm, port->intf.hw_if_index,
603 port->link_up ? VNET_HW_INTERFACE_FLAG_LINK_UP : 0);
605 vnet_hw_interface_set_link_speed (vnm, port->intf.hw_if_index,
608 port->intf.tx_node_index = hw->tx_node_index;
610 /* create / reuse rx node */
611 if (vec_len (dm->free_rx_node_indices))
614 rx_node_index = vec_pop (dm->free_rx_node_indices);
615 vlib_node_rename (vm, rx_node_index, "%s-rx", port->intf.name);
616 n = vlib_get_node (vm, rx_node_index);
617 n->function = vlib_node_get_preferred_node_fn_variant (
618 vm, port->rx_node.registrations);
619 n->format_trace = port->rx_node.format_trace;
620 vlib_register_errors (vm, rx_node_index,
621 port->rx_node.n_error_counters, 0,
622 port->rx_node.error_counters);
626 dev_class->format_tx_trace = port->tx_node.format_trace;
627 dev_class->tx_function_error_counters = port->tx_node.error_counters;
628 dev_class->tx_function_n_errors = port->tx_node.n_error_counters;
629 vlib_node_registration_t rx_node_reg = {
630 .sibling_of = "port-rx-eth",
631 .type = VLIB_NODE_TYPE_INPUT,
632 .state = VLIB_NODE_STATE_DISABLED,
633 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
634 .node_fn_registrations = port->rx_node.registrations,
635 .format_trace = port->rx_node.format_trace,
636 .error_counters = port->rx_node.error_counters,
637 .n_errors = port->rx_node.n_error_counters,
640 vlib_register_node (vm, &rx_node_reg, "%s-rx", port->intf.name);
642 port->rx_node_assigned = 1;
643 port->intf.rx_node_index = rx_node_index;
644 port->intf.rx_next_index =
645 vnet_dev_default_next_index_by_port_type[port->attr.type];
647 vlib_worker_thread_node_runtime_update ();
649 "ethernet interface created, hw_if_index %u sw_if_index %u "
650 "rx_node_index %u tx_node_index %u",
651 port->intf.hw_if_index, port->intf.sw_if_index,
652 port->intf.rx_node_index, port->intf.tx_node_index);
655 port->interface_created = 1;
656 foreach_vnet_dev_port_rx_queue (q, port)
658 vnet_buffer (&q->buffer_template)->sw_if_index[VLIB_RX] =
659 port->intf.sw_if_index;
660 /* poison to catch node not calling runtime update function */
662 q->interrupt_mode = port->intf.default_is_intr_mode;
663 vnet_dev_rx_queue_rt_request (
664 vm, q, (vnet_dev_rx_queue_rt_req_t){ .update_next_index = 1 });
667 vnet_dev_port_update_tx_node_runtime (vm, port);
669 if (port->port_ops.init)
670 rv = port->port_ops.init (vm, port);
673 if (rv != VNET_DEV_OK)
674 vnet_dev_port_if_remove (vm, port);
679 vnet_dev_port_if_remove (vlib_main_t *vm, vnet_dev_port_t *port)
681 vnet_dev_main_t *dm = &vnet_dev_main;
682 vnet_main_t *vnm = vnet_get_main ();
684 vnet_dev_port_validate (vm, port);
687 vnet_dev_port_stop (vm, port);
689 if (port->rx_node_assigned)
691 vlib_node_rename (vm, port->intf.rx_node_index, "deleted-%u",
692 port->intf.rx_node_index);
693 vec_add1 (dm->free_rx_node_indices, port->intf.rx_node_index);
694 port->rx_node_assigned = 0;
697 if (port->interface_created)
699 vlib_worker_thread_barrier_sync (vm);
700 vnet_delete_hw_interface (vnm, port->intf.hw_if_index);
701 vlib_worker_thread_barrier_release (vm);
702 pool_put_index (dm->ports_by_dev_instance, port->intf.dev_instance);
703 port->interface_created = 0;
706 port->intf = (typeof (port->intf)){};
708 if (port->port_ops.deinit)
709 port->port_ops.deinit (vm, port);
711 foreach_vnet_dev_port_tx_queue (q, port)
712 vnet_dev_tx_queue_free (vm, q);
714 foreach_vnet_dev_port_rx_queue (q, port)
715 vnet_dev_rx_queue_free (vm, q);
717 vnet_dev_port_free_counters (vm, port);
719 foreach_vnet_dev_port_args (v, port)
720 vnet_dev_arg_clear_value (v);
725 vnet_dev_port_clear_counters (vlib_main_t *vm, vnet_dev_port_t *port)
727 if (port->counter_main)
728 vnet_dev_counters_clear (vm, port->counter_main);
730 foreach_vnet_dev_port_rx_queue (q, port)
732 vnet_dev_counters_clear (vm, q->counter_main);
734 foreach_vnet_dev_port_tx_queue (q, port)
736 vnet_dev_counters_clear (vm, q->counter_main);
738 log_notice (port->dev, "counters cleared on port %u", port->port_id);