1 /* SPDX-License-Identifier: Apache-2.0
2 * Copyright (c) 2023 Cisco Systems, Inc.
8 #include <vppinfra/clib.h>
9 #include <vppinfra/error_bootstrap.h>
10 #include <vppinfra/format.h>
11 #include <vnet/vnet.h>
12 #include <vnet/dev/types.h>
14 #define VNET_DEV_DEVICE_ID_PREFIX_DELIMITER "/"
16 #define foreach_vnet_dev_port_type \
20 typedef char vnet_dev_device_id_t[32];
24 #define _(b, n) VNET_DEV_PORT_TYPE_##n = (1U << (b)),
25 foreach_vnet_dev_port_type
27 } vnet_dev_port_type_t;
29 #define foreach_vnet_dev_port_caps \
37 #define _(n) u8 n : 1;
38 foreach_vnet_dev_port_caps
42 } vnet_dev_port_caps_t;
50 typedef struct vnet_dev_bus_registration vnet_dev_bus_registration_t;
51 typedef struct vnet_dev_driver_registration vnet_dev_driver_registration_t;
53 typedef struct vnet_dev vnet_dev_t;
54 typedef struct vnet_dev_port vnet_dev_port_t;
55 typedef struct vnet_dev_rx_queue vnet_dev_rx_queue_t;
56 typedef struct vnet_dev_tx_queue vnet_dev_tx_queue_t;
57 typedef struct vnet_dev_bus_registration vnet_dev_bus_registration_t;
58 typedef struct vnet_dev_driver_registration vnet_dev_driver_registration_t;
59 typedef struct vnet_dev_counter vnet_dev_counter_t;
60 typedef struct vnet_dev_counter_main vnet_dev_counter_main_t;
61 typedef struct vnet_dev_port_cfg_change_req vnet_dev_port_cfg_change_req_t;
63 typedef vnet_dev_rv_t (vnet_dev_op_t) (vlib_main_t *, vnet_dev_t *);
64 typedef vnet_dev_rv_t (vnet_dev_port_op_t) (vlib_main_t *, vnet_dev_port_t *);
65 typedef vnet_dev_rv_t (vnet_dev_port_cfg_change_op_t) (
66 vlib_main_t *, vnet_dev_port_t *, vnet_dev_port_cfg_change_req_t *);
67 typedef vnet_dev_rv_t (vnet_dev_rx_queue_op_t) (vlib_main_t *,
68 vnet_dev_rx_queue_t *);
69 typedef vnet_dev_rv_t (vnet_dev_tx_queue_op_t) (vlib_main_t *,
70 vnet_dev_tx_queue_t *);
71 typedef void (vnet_dev_op_no_rv_t) (vlib_main_t *, vnet_dev_t *);
72 typedef void (vnet_dev_port_op_no_rv_t) (vlib_main_t *, vnet_dev_port_t *);
73 typedef void (vnet_dev_rx_queue_op_no_rv_t) (vlib_main_t *,
74 vnet_dev_rx_queue_t *);
75 typedef void (vnet_dev_tx_queue_op_no_rv_t) (vlib_main_t *,
76 vnet_dev_tx_queue_t *);
78 typedef u16 vnet_dev_queue_id_t;
79 typedef u16 vnet_dev_bus_index_t;
80 typedef u16 vnet_dev_driver_index_t;
84 vnet_dev_rx_queue_op_t *alloc;
85 vnet_dev_rx_queue_op_t *start;
86 vnet_dev_rx_queue_op_no_rv_t *stop;
87 vnet_dev_rx_queue_op_no_rv_t *free;
88 } vnet_dev_rx_queue_ops_t;
92 vnet_dev_tx_queue_op_t *alloc;
93 vnet_dev_tx_queue_op_t *start;
94 vnet_dev_tx_queue_op_no_rv_t *stop;
95 vnet_dev_tx_queue_op_no_rv_t *free;
96 } vnet_dev_tx_queue_ops_t;
105 u8 size_is_power_of_two : 1;
106 } vnet_dev_queue_config_t;
108 #define foreach_vnet_dev_port_cfg_type \
111 _ (CHANGE_PRIMARY_HW_ADDR) \
112 _ (ADD_SECONDARY_HW_ADDR) \
113 _ (REMOVE_SECONDARY_HW_ADDR) \
114 _ (RXQ_INTR_MODE_ENABLE) \
115 _ (RXQ_INTR_MODE_DISABLE)
119 VNET_DEV_PORT_CFG_UNKNOWN,
120 #define _(n) VNET_DEV_PORT_CFG_##n,
121 foreach_vnet_dev_port_cfg_type
123 } __clib_packed vnet_dev_port_cfg_type_t;
125 typedef struct vnet_dev_port_cfg_change_req
127 vnet_dev_port_cfg_type_t type;
134 vnet_dev_hw_addr_t addr;
136 vnet_dev_queue_id_t queue_id;
139 } vnet_dev_port_cfg_change_req_t;
143 vnet_dev_hw_addr_t hw_addr;
146 u16 max_supported_frame_size;
147 vnet_dev_port_type_t type;
148 vnet_dev_port_caps_t caps;
149 } vnet_dev_port_attr_t;
153 VNET_DEV_PERIODIC_OP_TYPE_DEV = 1,
154 VNET_DEV_PERIODIC_OP_TYPE_PORT = 2,
155 } __clib_packed vnet_dev_periodic_op_type_t;
161 vnet_dev_periodic_op_type_t type;
165 vnet_dev_port_t *port;
170 vnet_dev_op_no_rv_t *dev_op;
171 vnet_dev_port_op_no_rv_t *port_op;
174 } vnet_dev_periodic_op_t;
178 struct _vlib_node_fn_registration *registrations;
179 format_function_t *format_trace;
180 vlib_error_desc_t *error_counters;
181 u16 n_error_counters;
186 vnet_dev_op_t *alloc;
188 vnet_dev_op_no_rv_t *deinit;
189 vnet_dev_op_t *reset;
190 vnet_dev_op_no_rv_t *free;
191 u8 *(*probe) (vlib_main_t *, vnet_dev_bus_index_t, void *);
192 format_function_t *format_info;
197 vnet_dev_port_op_t *alloc;
198 vnet_dev_port_op_t *init;
199 vnet_dev_port_cfg_change_op_t *config_change;
200 vnet_dev_port_cfg_change_op_t *config_change_validate;
201 vnet_dev_port_op_t *start;
202 vnet_dev_port_op_no_rv_t *stop;
203 vnet_dev_port_op_no_rv_t *deinit;
204 vnet_dev_port_op_no_rv_t *free;
205 format_function_t *format_status;
206 } vnet_dev_port_ops_t;
212 u8 update_next_index : 1;
213 u8 update_feature_arc : 1;
218 } vnet_dev_rx_queue_rt_req_t;
220 typedef struct vnet_dev_rx_queue
222 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
223 vnet_dev_port_t *port;
226 vnet_dev_counter_main_t *counter_main;
227 CLIB_CACHE_LINE_ALIGN_MARK (runtime0);
228 vnet_dev_rx_queue_t *next_on_thread;
229 u8 interrupt_mode : 1;
233 vnet_dev_queue_id_t queue_id;
236 vnet_dev_rx_queue_rt_req_t runtime_request;
237 CLIB_CACHE_LINE_ALIGN_MARK (runtime1);
238 vlib_buffer_template_t buffer_template;
239 CLIB_CACHE_LINE_ALIGN_MARK (driver_data);
241 } vnet_dev_rx_queue_t;
243 STATIC_ASSERT_SIZEOF (vnet_dev_rx_queue_t, 3 * CLIB_CACHE_LINE_BYTES);
245 typedef struct vnet_dev_tx_queue
247 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
248 vnet_dev_port_t *port;
249 clib_bitmap_t *assigned_threads;
251 vnet_dev_counter_main_t *counter_main;
252 CLIB_CACHE_LINE_ALIGN_MARK (runtime0);
253 vnet_dev_queue_id_t queue_id;
259 CLIB_ALIGN_MARK (private_data, 16);
261 } vnet_dev_tx_queue_t;
263 STATIC_ASSERT_SIZEOF (vnet_dev_tx_queue_t, 2 * CLIB_CACHE_LINE_BYTES);
265 typedef struct vnet_dev_port
267 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
269 vnet_dev_port_id_t port_id;
270 vnet_dev_driver_index_t driver_index;
275 u8 interface_created : 1;
276 u8 rx_node_assigned : 1;
277 vnet_dev_counter_main_t *counter_main;
278 vnet_dev_queue_config_t rx_queue_config;
279 vnet_dev_queue_config_t tx_queue_config;
280 vnet_dev_port_attr_t attr;
282 vnet_dev_hw_addr_t primary_hw_addr;
283 vnet_dev_hw_addr_t *secondary_hw_addr;
286 vnet_dev_rx_queue_t **rx_queues;
287 vnet_dev_tx_queue_t **tx_queues;
288 vnet_dev_port_ops_t port_ops;
289 vnet_dev_rx_queue_ops_t rx_queue_ops;
290 vnet_dev_tx_queue_ops_t tx_queue_ops;
291 vnet_dev_node_t rx_node;
292 vnet_dev_node_t tx_node;
296 vnet_dev_if_name_t name;
299 u32 current_config_index;
301 u16 redirect_to_node_next_index;
302 u8 feature_arc_index;
304 u8 redirect_to_node : 1;
305 u8 default_is_intr_mode : 1;
315 CLIB_CACHE_LINE_ALIGN_MARK (data0);
319 typedef struct vnet_dev
321 vnet_dev_device_id_t device_id;
323 u16 not_first_init : 1;
325 u16 process_node_quit : 1;
326 u16 process_node_periodic : 1;
332 vnet_dev_driver_index_t driver_index;
334 u32 process_node_index;
335 u8 bus_data[32] __clib_aligned (16);
337 vnet_dev_port_t **ports;
338 vnet_dev_periodic_op_t *periodic_ops;
340 u8 __clib_aligned (16)
346 u16 vendor_id, device_id;
350 #define VNET_DEV_MATCH(...) \
351 (vnet_dev_match_t[]) \
358 vnet_dev_op_t *device_open;
359 vnet_dev_op_no_rv_t *device_close;
360 vnet_dev_rv_t (*dma_mem_alloc_fn) (vlib_main_t *, vnet_dev_t *, u32, u32,
362 void (*dma_mem_free_fn) (vlib_main_t *, vnet_dev_t *, void *);
363 void *(*get_device_info) (vlib_main_t *, char *);
364 void (*free_device_info) (vlib_main_t *, void *);
365 format_function_t *format_device_info;
366 format_function_t *format_device_addr;
367 } vnet_dev_bus_ops_t;
369 struct vnet_dev_bus_registration
371 vnet_dev_bus_registration_t *next_registration;
372 vnet_dev_driver_name_t name;
373 u16 device_data_size;
374 vnet_dev_bus_ops_t ops;
377 struct vnet_dev_driver_registration
379 vnet_dev_driver_registration_t *next_registration;
380 u8 bus_master_enable : 1;
381 vnet_dev_driver_name_t name;
382 vnet_dev_bus_name_t bus;
384 u16 runtime_temp_space_sz;
385 vnet_dev_match_t *match;
393 vnet_dev_bus_registration_t *registration;
394 vnet_dev_bus_ops_t ops;
401 vnet_dev_driver_registration_t *registration;
403 vnet_dev_bus_index_t bus_index;
409 vnet_dev_bus_t *buses;
410 vnet_dev_driver_t *drivers;
411 vnet_dev_t **devices;
412 vnet_dev_port_t **ports_by_dev_instance;
413 vnet_dev_bus_registration_t *bus_registrations;
414 vnet_dev_driver_registration_t *driver_registrations;
415 void *runtime_temp_spaces;
416 u32 log2_runtime_temp_space_sz;
417 u32 *free_process_node_indices;
418 u32 *free_rx_node_indices;
419 uword *device_index_by_id;
422 u16 next_rx_queue_thread;
423 u8 eth_port_rx_feature_arc_index;
426 extern vnet_dev_main_t vnet_dev_main;
432 vnet_dev_port_attr_t attr;
433 vnet_dev_port_ops_t ops;
438 vnet_dev_node_t *rx_node;
439 vnet_dev_node_t *tx_node;
443 vnet_dev_queue_config_t config;
444 vnet_dev_rx_queue_ops_t ops;
449 vnet_dev_queue_config_t config;
450 vnet_dev_tx_queue_ops_t ops;
452 } vnet_dev_port_add_args_t;
469 } vnet_dev_port_state_changes_t;
472 vnet_dev_t *vnet_dev_alloc (vlib_main_t *, vnet_dev_device_id_t,
473 vnet_dev_driver_t *);
474 void vnet_dev_free (vlib_main_t *, vnet_dev_t *);
475 vnet_dev_rv_t vnet_dev_init (vlib_main_t *, vnet_dev_t *);
476 void vnet_dev_deinit (vlib_main_t *, vnet_dev_t *);
477 vnet_dev_rv_t vnet_dev_reset (vlib_main_t *, vnet_dev_t *);
478 void vnet_dev_detach (vlib_main_t *, vnet_dev_t *);
479 vnet_dev_rv_t vnet_dev_port_add (vlib_main_t *, vnet_dev_t *,
481 vnet_dev_port_add_args_t *);
482 vnet_dev_rv_t vnet_dev_dma_mem_alloc (vlib_main_t *, vnet_dev_t *, u32, u32,
484 void vnet_dev_dma_mem_free (vlib_main_t *, vnet_dev_t *, void *);
485 vnet_dev_bus_t *vnet_dev_find_device_bus (vlib_main_t *, vnet_dev_device_id_t);
486 void *vnet_dev_get_device_info (vlib_main_t *, vnet_dev_device_id_t);
489 clib_error_t *vnet_dev_port_err (vlib_main_t *, vnet_dev_port_t *,
490 vnet_dev_rv_t, char *, ...);
493 clib_error_t *vnet_dev_port_set_max_frame_size (vnet_main_t *,
494 vnet_hw_interface_t *, u32);
495 u32 vnet_dev_port_eth_flag_change (vnet_main_t *, vnet_hw_interface_t *, u32);
496 clib_error_t *vnet_dev_port_mac_change (vnet_hw_interface_t *, const u8 *,
498 clib_error_t *vnet_dev_add_del_mac_address (vnet_hw_interface_t *, const u8 *,
500 int vnet_dev_flow_ops_fn (vnet_main_t *, vnet_flow_dev_op_t, u32, u32,
502 clib_error_t *vnet_dev_interface_set_rss_queues (vnet_main_t *,
503 vnet_hw_interface_t *,
505 void vnet_dev_clear_hw_interface_counters (u32);
506 clib_error_t *vnet_dev_rx_mode_change_fn (vnet_main_t *, u32, u32,
508 void vnet_dev_set_interface_next_node (vnet_main_t *, u32, u32);
511 vnet_dev_rv_t vnet_dev_port_start (vlib_main_t *, vnet_dev_port_t *);
512 vnet_dev_rv_t vnet_dev_port_start_all_rx_queues (vlib_main_t *,
514 vnet_dev_rv_t vnet_dev_port_start_all_tx_queues (vlib_main_t *,
516 void vnet_dev_port_stop (vlib_main_t *, vnet_dev_port_t *);
517 void vnet_dev_port_deinit (vlib_main_t *, vnet_dev_port_t *);
518 void vnet_dev_port_free (vlib_main_t *, vnet_dev_port_t *);
519 void vnet_dev_port_add_counters (vlib_main_t *, vnet_dev_port_t *,
520 vnet_dev_counter_t *, u16);
521 void vnet_dev_port_free_counters (vlib_main_t *, vnet_dev_port_t *);
522 void vnet_dev_port_update_tx_node_runtime (vlib_main_t *, vnet_dev_port_t *);
523 void vnet_dev_port_state_change (vlib_main_t *, vnet_dev_port_t *,
524 vnet_dev_port_state_changes_t);
525 void vnet_dev_port_clear_counters (vlib_main_t *, vnet_dev_port_t *);
527 vnet_dev_port_cfg_change_req_validate (vlib_main_t *, vnet_dev_port_t *,
528 vnet_dev_port_cfg_change_req_t *);
529 vnet_dev_rv_t vnet_dev_port_cfg_change (vlib_main_t *, vnet_dev_port_t *,
530 vnet_dev_port_cfg_change_req_t *);
531 vnet_dev_rv_t vnet_dev_port_if_create (vlib_main_t *, vnet_dev_port_t *);
532 vnet_dev_rv_t vnet_dev_port_if_remove (vlib_main_t *, vnet_dev_port_t *);
535 vnet_dev_rv_t vnet_dev_rx_queue_alloc (vlib_main_t *, vnet_dev_port_t *, u16);
536 vnet_dev_rv_t vnet_dev_tx_queue_alloc (vlib_main_t *, vnet_dev_port_t *, u16);
537 void vnet_dev_rx_queue_free (vlib_main_t *, vnet_dev_rx_queue_t *);
538 void vnet_dev_tx_queue_free (vlib_main_t *, vnet_dev_tx_queue_t *);
539 void vnet_dev_rx_queue_add_counters (vlib_main_t *, vnet_dev_rx_queue_t *,
540 vnet_dev_counter_t *, u16);
541 void vnet_dev_rx_queue_free_counters (vlib_main_t *, vnet_dev_rx_queue_t *);
542 void vnet_dev_tx_queue_add_counters (vlib_main_t *, vnet_dev_tx_queue_t *,
543 vnet_dev_counter_t *, u16);
544 void vnet_dev_tx_queue_free_counters (vlib_main_t *, vnet_dev_tx_queue_t *);
545 vnet_dev_rv_t vnet_dev_rx_queue_start (vlib_main_t *, vnet_dev_rx_queue_t *);
546 vnet_dev_rv_t vnet_dev_tx_queue_start (vlib_main_t *, vnet_dev_tx_queue_t *);
547 void vnet_dev_rx_queue_stop (vlib_main_t *, vnet_dev_rx_queue_t *);
548 void vnet_dev_tx_queue_stop (vlib_main_t *, vnet_dev_tx_queue_t *);
551 vnet_dev_rv_t vnet_dev_process_create (vlib_main_t *, vnet_dev_t *);
552 vnet_dev_rv_t vnet_dev_process_call_op (vlib_main_t *, vnet_dev_t *,
554 vnet_dev_rv_t vnet_dev_process_call_op_no_rv (vlib_main_t *, vnet_dev_t *,
555 vnet_dev_op_no_rv_t *);
556 void vnet_dev_process_call_op_no_wait (vlib_main_t *, vnet_dev_t *,
557 vnet_dev_op_no_rv_t *);
558 vnet_dev_rv_t vnet_dev_process_call_port_op (vlib_main_t *, vnet_dev_port_t *,
559 vnet_dev_port_op_t *);
560 vnet_dev_rv_t vnet_dev_process_call_port_op_no_rv (vlib_main_t *vm,
562 vnet_dev_port_op_no_rv_t *);
563 void vnet_dev_process_call_port_op_no_wait (vlib_main_t *, vnet_dev_port_t *,
564 vnet_dev_port_op_no_rv_t *);
566 vnet_dev_process_port_cfg_change_req (vlib_main_t *, vnet_dev_port_t *,
567 vnet_dev_port_cfg_change_req_t *);
568 void vnet_dev_process_quit (vlib_main_t *, vnet_dev_t *);
569 void vnet_dev_poll_dev_add (vlib_main_t *, vnet_dev_t *, f64,
570 vnet_dev_op_no_rv_t *);
571 void vnet_dev_poll_dev_remove (vlib_main_t *, vnet_dev_t *,
572 vnet_dev_op_no_rv_t *);
573 void vnet_dev_poll_port_add (vlib_main_t *, vnet_dev_port_t *, f64,
574 vnet_dev_port_op_no_rv_t *);
575 void vnet_dev_poll_port_remove (vlib_main_t *, vnet_dev_port_t *,
576 vnet_dev_port_op_no_rv_t *);
583 vnet_dev_port_t *port;
586 vnet_dev_rv_t vnet_dev_rt_exec_ops (vlib_main_t *, vnet_dev_t *,
587 vnet_dev_rt_op_t *, u32);
593 u8 show_zero_counters : 1;
595 } vnet_dev_format_args_t;
597 format_function_t format_vnet_dev_addr;
598 format_function_t format_vnet_dev_hw_addr;
599 format_function_t format_vnet_dev_info;
600 format_function_t format_vnet_dev_interface_info;
601 format_function_t format_vnet_dev_interface_name;
602 format_function_t format_vnet_dev_port_info;
603 format_function_t format_vnet_dev_rv;
604 format_function_t format_vnet_dev_rx_queue_info;
605 format_function_t format_vnet_dev_tx_queue_info;
606 format_function_t format_vnet_dev_flags;
607 format_function_t format_vnet_dev_port_flags;
608 format_function_t format_vnet_dev_log;
609 unformat_function_t unformat_vnet_dev_flags;
610 unformat_function_t unformat_vnet_dev_port_flags;
614 vnet_dev_rx_queue_t *first_rx_queue;
615 } vnet_dev_rx_node_runtime_t;
617 STATIC_ASSERT (sizeof (vnet_dev_rx_node_runtime_t) <=
618 VLIB_NODE_RUNTIME_DATA_SIZE,
619 "must fit into runtime data");
621 #define foreach_vnet_dev_port_rx_next \
622 _ (ETH_INPUT, "ethernet-input") \
623 _ (DROP, "error-drop")
627 #define _(n, s) VNET_DEV_ETH_RX_PORT_NEXT_##n,
628 foreach_vnet_dev_port_rx_next
630 VNET_DEV_ETH_RX_PORT_N_NEXTS
631 } vnet_dev_eth_port_rx_next_t;
633 extern u16 vnet_dev_default_next_index_by_port_type[];
634 extern vlib_node_registration_t port_rx_eth_node;
636 typedef vnet_interface_output_runtime_t vnet_dev_tx_node_runtime_t;
638 STATIC_ASSERT (sizeof (vnet_dev_tx_node_runtime_t) <=
639 VLIB_NODE_RUNTIME_DATA_SIZE,
640 "must fit into runtime data");
642 #define VNET_DEV_REGISTER_BUS(x, ...) \
643 __VA_ARGS__ vnet_dev_bus_registration_t __vnet_dev_bus_registration_##x; \
644 static void __clib_constructor __vnet_dev_bus_registration_fn_##x (void) \
646 vnet_dev_main_t *dm = &vnet_dev_main; \
647 __vnet_dev_bus_registration_##x.next_registration = \
648 dm->bus_registrations; \
649 dm->bus_registrations = &__vnet_dev_bus_registration_##x; \
651 __VA_ARGS__ vnet_dev_bus_registration_t __vnet_dev_bus_registration_##x
653 #define VNET_DEV_REGISTER_DRIVER(x, ...) \
654 __VA_ARGS__ vnet_dev_driver_registration_t \
655 __vnet_dev_driver_registration_##x; \
656 static void __clib_constructor __vnet_dev_driver_registration_fn_##x (void) \
658 vnet_dev_main_t *dm = &vnet_dev_main; \
659 __vnet_dev_driver_registration_##x.next_registration = \
660 dm->driver_registrations; \
661 dm->driver_registrations = &__vnet_dev_driver_registration_##x; \
663 __VA_ARGS__ vnet_dev_driver_registration_t __vnet_dev_driver_registration_##x
665 #define VNET_DEV_NODE_FN(node) \
666 uword CLIB_MARCH_SFX (node##_fn) (vlib_main_t *, vlib_node_runtime_t *, \
668 static vlib_node_fn_registration_t CLIB_MARCH_SFX ( \
669 node##_fn_registration) = { \
670 .function = &CLIB_MARCH_SFX (node##_fn), \
673 static void __clib_constructor CLIB_MARCH_SFX ( \
674 node##_fn_multiarch_register) (void) \
676 extern vnet_dev_node_t node; \
677 vlib_node_fn_registration_t *r; \
678 r = &CLIB_MARCH_SFX (node##_fn_registration); \
679 r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE); \
680 r->next_registration = (node).registrations; \
681 (node).registrations = r; \
683 uword CLIB_MARCH_SFX (node##_fn)
685 #define foreach_vnet_dev_port(p, d) pool_foreach_pointer (p, d->ports)
686 #define foreach_vnet_dev_port_rx_queue(q, p) \
687 pool_foreach_pointer (q, p->rx_queues)
688 #define foreach_vnet_dev_port_tx_queue(q, p) \
689 pool_foreach_pointer (q, p->tx_queues)
691 #include <vnet/dev/dev_funcs.h>
693 #endif /* _VNET_DEV_H_ */