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 pool_put_index (dev->ports, port->index);
101 vnet_dev_port_update_tx_node_runtime (vlib_main_t *vm, vnet_dev_port_t *port)
103 vnet_dev_port_validate (vm, port);
105 foreach_vnet_dev_port_tx_queue (q, port)
108 clib_bitmap_foreach (ti, q->assigned_threads)
110 vlib_main_t *tvm = vlib_get_main_by_index (ti);
111 vlib_node_runtime_t *nr =
112 vlib_node_get_runtime (tvm, port->intf.tx_node_index);
113 vnet_dev_tx_node_runtime_t *tnr = vnet_dev_get_tx_node_runtime (nr);
114 tnr->hw_if_index = port->intf.hw_if_index;
121 vnet_dev_port_stop (vlib_main_t *vm, vnet_dev_port_t *port)
123 vnet_dev_t *dev = port->dev;
124 vnet_dev_rt_op_t *ops = 0;
126 log_debug (dev, "stopping port %u", port->port_id);
128 foreach_vnet_dev_port_rx_queue (q, port)
131 vnet_dev_rt_op_t op = {
132 .type = VNET_DEV_RT_OP_TYPE_RX_QUEUE,
133 .action = VNET_DEV_RT_OP_ACTION_STOP,
134 .thread_index = q->rx_thread_index,
140 vnet_dev_rt_exec_ops (vm, dev, ops, vec_len (ops));
143 port->port_ops.stop (vm, port);
145 foreach_vnet_dev_port_rx_queue (q, port)
148 log_debug (dev, "port %u rx queue %u stopped", port->port_id,
152 foreach_vnet_dev_port_tx_queue (q, port)
155 log_debug (dev, "port %u tx queue %u stopped", port->port_id,
159 log_debug (dev, "port %u stopped", port->port_id);
164 vnet_dev_port_start_all_rx_queues (vlib_main_t *vm, vnet_dev_port_t *port)
166 vnet_dev_rv_t rv = VNET_DEV_OK;
168 vnet_dev_port_validate (vm, port);
170 foreach_vnet_dev_port_rx_queue (q, port)
172 rv = vnet_dev_rx_queue_start (vm, q);
173 if (rv != VNET_DEV_OK)
180 vnet_dev_port_start_all_tx_queues (vlib_main_t *vm, vnet_dev_port_t *port)
182 vnet_dev_rv_t rv = VNET_DEV_OK;
184 vnet_dev_port_validate (vm, port);
186 foreach_vnet_dev_port_tx_queue (q, port)
188 rv = vnet_dev_tx_queue_start (vm, q);
189 if (rv != VNET_DEV_OK)
196 vnet_dev_port_start (vlib_main_t *vm, vnet_dev_port_t *port)
198 vnet_dev_t *dev = port->dev;
199 vnet_dev_rt_op_t *ops = 0;
202 vnet_dev_port_validate (vm, port);
204 log_debug (dev, "starting port %u", port->port_id);
206 vnet_dev_port_update_tx_node_runtime (vm, port);
208 if ((rv = port->port_ops.start (vm, port)) != VNET_DEV_OK)
210 vnet_dev_port_stop (vm, port);
214 foreach_vnet_dev_port_rx_queue (q, port)
217 vnet_dev_rt_op_t op = {
218 .type = VNET_DEV_RT_OP_TYPE_RX_QUEUE,
219 .action = VNET_DEV_RT_OP_ACTION_START,
220 .thread_index = q->rx_thread_index,
226 vnet_dev_rt_exec_ops (vm, dev, ops, vec_len (ops));
229 foreach_vnet_dev_port_rx_queue (q, port)
232 log_debug (dev, "port %u rx queue %u started", port->port_id,
237 foreach_vnet_dev_port_tx_queue (q, port)
240 log_debug (dev, "port %u tx queue %u started", port->port_id,
246 log_debug (dev, "port %u started", port->port_id);
252 vnet_dev_port_add (vlib_main_t *vm, vnet_dev_t *dev, vnet_dev_port_id_t id,
253 vnet_dev_port_add_args_t *args)
255 vnet_dev_port_t **pp, *port;
256 vnet_dev_rv_t rv = VNET_DEV_OK;
258 ASSERT (args->port.attr.type != VNET_DEV_PORT_TYPE_UNKNOWN);
259 ASSERT (args->port.attr.max_supported_frame_size);
262 vnet_dev_alloc_with_data (sizeof (vnet_dev_port_t), args->port.data_size);
263 pool_get (dev->ports, pp);
265 clib_memcpy (vnet_dev_get_port_data (port), args->port.initial_data,
266 args->port.data_size);
268 port->index = pp - dev->ports;
270 port->attr = args->port.attr;
271 port->rx_queue_config = args->rx_queue.config;
272 port->tx_queue_config = args->tx_queue.config;
273 port->rx_queue_ops = args->rx_queue.ops;
274 port->tx_queue_ops = args->tx_queue.ops;
275 port->port_ops = args->port.ops;
276 port->rx_node = *args->rx_node;
277 port->tx_node = *args->tx_node;
279 /* defaults out of port attributes */
280 port->max_frame_size = args->port.attr.max_supported_frame_size;
281 port->primary_hw_addr = args->port.attr.hw_addr;
283 if (port->port_ops.alloc)
284 rv = port->port_ops.alloc (vm, port);
286 if (rv == VNET_DEV_OK)
287 port->initialized = 1;
293 vnet_dev_port_cfg_change_req_validate (vlib_main_t *vm, vnet_dev_port_t *port,
294 vnet_dev_port_cfg_change_req_t *req)
297 vnet_dev_hw_addr_t *addr;
305 case VNET_DEV_PORT_CFG_MAX_FRAME_SIZE:
306 if (req->max_frame_size > port->attr.max_supported_frame_size)
307 return VNET_DEV_ERR_INVALID_VALUE;
308 if (req->max_frame_size == port->max_frame_size)
309 return VNET_DEV_ERR_NO_CHANGE;
312 case VNET_DEV_PORT_CFG_PROMISC_MODE:
313 if (req->promisc == port->promisc)
314 return VNET_DEV_ERR_NO_CHANGE;
317 case VNET_DEV_PORT_CFG_CHANGE_PRIMARY_HW_ADDR:
318 if (clib_memcmp (&req->addr, &port->primary_hw_addr,
319 sizeof (vnet_dev_hw_addr_t)) == 0)
320 return VNET_DEV_ERR_NO_CHANGE;
323 case VNET_DEV_PORT_CFG_ADD_SECONDARY_HW_ADDR:
324 pool_foreach (addr, port->secondary_hw_addr)
325 if (clib_memcmp (addr, &req->addr, sizeof (*addr)) == 0)
326 return VNET_DEV_ERR_ALREADY_EXISTS;
329 case VNET_DEV_PORT_CFG_REMOVE_SECONDARY_HW_ADDR:
331 pool_foreach (addr, port->secondary_hw_addr)
332 if (clib_memcmp (addr, &req->addr, sizeof (*addr)) == 0)
335 return VNET_DEV_ERR_NO_SUCH_ENTRY;
342 if (port->port_ops.config_change_validate)
344 rv = port->port_ops.config_change_validate (vm, port, req);
345 if (rv != VNET_DEV_OK)
354 vnet_dev_port_cfg_change (vlib_main_t *vm, vnet_dev_port_t *port,
355 vnet_dev_port_cfg_change_req_t *req)
357 vnet_dev_rv_t rv = VNET_DEV_OK;
358 vnet_dev_hw_addr_t *a;
360 vnet_dev_port_validate (vm, port);
362 vnet_dev_port_cfg_change_req_validate (vm, port, req);
364 if (port->port_ops.config_change)
365 rv = port->port_ops.config_change (vm, port, req);
367 if (rv != VNET_DEV_OK)
372 case VNET_DEV_PORT_CFG_MAX_FRAME_SIZE:
373 port->max_frame_size = req->max_frame_size;
376 case VNET_DEV_PORT_CFG_PROMISC_MODE:
377 port->promisc = req->promisc;
380 case VNET_DEV_PORT_CFG_CHANGE_PRIMARY_HW_ADDR:
381 clib_memcpy (&port->primary_hw_addr, &req->addr,
382 sizeof (vnet_dev_hw_addr_t));
385 case VNET_DEV_PORT_CFG_ADD_SECONDARY_HW_ADDR:
386 pool_get (port->secondary_hw_addr, a);
387 clib_memcpy (a, &req->addr, sizeof (vnet_dev_hw_addr_t));
390 case VNET_DEV_PORT_CFG_REMOVE_SECONDARY_HW_ADDR:
391 pool_foreach (a, port->secondary_hw_addr)
392 if (clib_memcmp (a, &req->addr, sizeof (vnet_dev_hw_addr_t)) == 0)
394 pool_put (port->secondary_hw_addr, a);
407 vnet_dev_port_state_change (vlib_main_t *vm, vnet_dev_port_t *port,
408 vnet_dev_port_state_changes_t changes)
410 vnet_main_t *vnm = vnet_get_main ();
412 vnet_dev_port_validate (vm, port);
414 if (changes.change.link_speed)
416 port->speed = changes.link_speed;
417 if (port->interface_created)
418 vnet_hw_interface_set_link_speed (vnm, port->intf.hw_if_index,
420 log_debug (port->dev, "port speed changed to %u", changes.link_speed);
423 if (changes.change.link_state)
425 port->link_up = changes.link_state;
426 if (port->interface_created)
427 vnet_hw_interface_set_flags (
428 vnm, port->intf.hw_if_index,
429 changes.link_state ? VNET_HW_INTERFACE_FLAG_LINK_UP : 0);
430 log_debug (port->dev, "port link state changed to %s",
431 changes.link_state ? "up" : "down");
436 vnet_dev_port_add_counters (vlib_main_t *vm, vnet_dev_port_t *port,
437 vnet_dev_counter_t *counters, u16 n_counters)
439 vnet_dev_port_validate (vm, port);
442 vnet_dev_counters_alloc (vm, counters, n_counters, "%s port %u counters",
443 port->dev->device_id, port->port_id);
447 vnet_dev_port_free_counters (vlib_main_t *vm, vnet_dev_port_t *port)
449 vnet_dev_port_validate (vm, port);
451 if (port->counter_main)
452 vnet_dev_counters_free (vm, port->counter_main);
456 vnet_dev_port_if_create (vlib_main_t *vm, vnet_dev_port_t *port)
458 vnet_main_t *vnm = vnet_get_main ();
459 u16 n_threads = vlib_get_n_threads ();
460 vnet_dev_main_t *dm = &vnet_dev_main;
461 vnet_dev_t *dev = port->dev;
462 vnet_dev_port_t **pp;
466 if (port->intf.name[0] == 0)
469 s = format (0, "%s%u/%u",
470 dm->drivers[port->dev->driver_index].registration->name,
471 port->dev->index, port->index);
474 if (n >= sizeof (port->intf.name))
477 return VNET_DEV_ERR_BUG;
479 clib_memcpy (port->intf.name, s, n);
480 port->intf.name[n] = 0;
485 dev, "allocating %u rx queues with size %u and %u tx queues with size %u",
486 port->intf.num_rx_queues, port->intf.rxq_sz, port->intf.num_tx_queues,
489 for (int i = 0; i < port->intf.num_rx_queues; i++)
490 if ((rv = vnet_dev_rx_queue_alloc (vm, port, port->intf.rxq_sz)) !=
494 for (u32 i = 0; i < port->intf.num_tx_queues; i++)
495 if ((rv = vnet_dev_tx_queue_alloc (vm, port, port->intf.txq_sz)) !=
499 foreach_vnet_dev_port_tx_queue (q, port)
501 q->assigned_threads = clib_bitmap_set (q->assigned_threads, ti, 1);
502 log_debug (dev, "port %u tx queue %u assigned to thread %u",
503 port->port_id, q->queue_id, ti);
504 if (++ti >= n_threads)
508 /* pool of port pointers helps us to assign unique dev_instance */
509 pool_get (dm->ports_by_dev_instance, pp);
510 port->intf.dev_instance = pp - dm->ports_by_dev_instance;
513 if (port->attr.type == VNET_DEV_PORT_TYPE_ETHERNET)
515 vnet_device_class_t *dev_class;
516 vnet_dev_driver_t *driver;
517 vnet_sw_interface_t *sw;
518 vnet_hw_interface_t *hw;
521 driver = pool_elt_at_index (dm->drivers, dev->driver_index);
523 /* hack to provide per-port tx node function */
524 dev_class = vnet_get_device_class (vnm, driver->dev_class_index);
525 dev_class->tx_fn_registrations = port->tx_node.registrations;
526 dev_class->format_tx_trace = port->tx_node.format_trace;
527 dev_class->tx_function_error_counters = port->tx_node.error_counters;
528 dev_class->tx_function_n_errors = port->tx_node.n_error_counters;
530 /* create new interface including tx and output nodes */
531 port->intf.hw_if_index = vnet_eth_register_interface (
532 vnm, &(vnet_eth_interface_registration_t){
533 .address = port->primary_hw_addr.eth_mac,
534 .max_frame_size = port->max_frame_size,
535 .dev_class_index = driver->dev_class_index,
536 .dev_instance = port->intf.dev_instance,
537 .cb.set_max_frame_size = vnet_dev_port_set_max_frame_size,
538 .cb.flag_change = vnet_dev_port_eth_flag_change,
541 sw = vnet_get_hw_sw_interface (vnm, port->intf.hw_if_index);
542 hw = vnet_get_hw_interface (vnm, port->intf.hw_if_index);
543 port->intf.sw_if_index = sw->sw_if_index;
544 vnet_hw_interface_set_flags (
545 vnm, port->intf.hw_if_index,
546 port->link_up ? VNET_HW_INTERFACE_FLAG_LINK_UP : 0);
548 vnet_hw_interface_set_link_speed (vnm, port->intf.hw_if_index,
551 port->intf.tx_node_index = hw->tx_node_index;
553 /* create / reuse rx node */
554 if (vec_len (dm->free_rx_node_indices))
557 rx_node_index = vec_pop (dm->free_rx_node_indices);
558 vlib_node_rename (vm, rx_node_index, "%s-rx", port->intf.name);
559 n = vlib_get_node (vm, rx_node_index);
560 n->function = vlib_node_get_preferred_node_fn_variant (
561 vm, port->rx_node.registrations);
562 n->format_trace = port->rx_node.format_trace;
563 vlib_register_errors (vm, rx_node_index,
564 port->rx_node.n_error_counters, 0,
565 port->rx_node.error_counters);
569 dev_class->format_tx_trace = port->tx_node.format_trace;
570 dev_class->tx_function_error_counters = port->tx_node.error_counters;
571 dev_class->tx_function_n_errors = port->tx_node.n_error_counters;
572 vlib_node_registration_t rx_node_reg = {
573 .sibling_of = "port-rx-eth",
574 .type = VLIB_NODE_TYPE_INPUT,
575 .state = VLIB_NODE_STATE_DISABLED,
576 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
577 .node_fn_registrations = port->rx_node.registrations,
578 .format_trace = port->rx_node.format_trace,
579 .error_counters = port->rx_node.error_counters,
580 .n_errors = port->rx_node.n_error_counters,
583 vlib_register_node (vm, &rx_node_reg, "%s-rx", port->intf.name);
585 port->rx_node_assigned = 1;
586 port->intf.rx_node_index = rx_node_index;
587 port->intf.rx_next_index =
588 vnet_dev_default_next_index_by_port_type[port->attr.type];
590 vlib_worker_thread_node_runtime_update ();
592 "ethernet interface created, hw_if_index %u sw_if_index %u "
593 "rx_node_index %u tx_node_index %u",
594 port->intf.hw_if_index, port->intf.sw_if_index,
595 port->intf.rx_node_index, port->intf.tx_node_index);
598 port->interface_created = 1;
599 foreach_vnet_dev_port_rx_queue (q, port)
601 vnet_buffer (&q->buffer_template)->sw_if_index[VLIB_RX] =
602 port->intf.sw_if_index;
603 /* poison to catch node not calling runtime update function */
605 vnet_dev_rx_queue_rt_request (
606 vm, q, (vnet_dev_rx_queue_rt_req_t){ .update_next_index = 1 });
609 vnet_dev_port_update_tx_node_runtime (vm, port);
611 if (port->port_ops.init)
612 rv = port->port_ops.init (vm, port);
615 if (rv != VNET_DEV_OK)
616 vnet_dev_port_if_remove (vm, port);
621 vnet_dev_port_if_remove (vlib_main_t *vm, vnet_dev_port_t *port)
623 vnet_dev_main_t *dm = &vnet_dev_main;
624 vnet_main_t *vnm = vnet_get_main ();
626 vnet_dev_port_validate (vm, port);
629 vnet_dev_port_stop (vm, port);
631 if (port->rx_node_assigned)
633 vlib_node_rename (vm, port->intf.rx_node_index, "deleted-%u",
634 port->intf.rx_node_index);
635 vec_add1 (dm->free_rx_node_indices, port->intf.rx_node_index);
636 port->rx_node_assigned = 0;
639 if (port->interface_created)
641 vlib_worker_thread_barrier_sync (vm);
642 vnet_delete_hw_interface (vnm, port->intf.hw_if_index);
643 vlib_worker_thread_barrier_release (vm);
644 pool_put_index (dm->ports_by_dev_instance, port->intf.dev_instance);
645 port->interface_created = 0;
648 port->intf = (typeof (port->intf)){};
650 if (port->port_ops.deinit)
651 port->port_ops.deinit (vm, port);
653 foreach_vnet_dev_port_tx_queue (q, port)
654 vnet_dev_tx_queue_free (vm, q);
656 foreach_vnet_dev_port_rx_queue (q, port)
657 vnet_dev_rx_queue_free (vm, q);
659 vnet_dev_port_free_counters (vm, port);
664 vnet_dev_port_clear_counters (vlib_main_t *vm, vnet_dev_port_t *port)
666 if (port->counter_main)
667 vnet_dev_counters_clear (vm, port->counter_main);
669 foreach_vnet_dev_port_rx_queue (q, port)
671 vnet_dev_counters_clear (vm, q->counter_main);
673 foreach_vnet_dev_port_tx_queue (q, port)
675 vnet_dev_counters_clear (vm, q->counter_main);
677 log_notice (port->dev, "counters cleared on port %u", port->port_id);