dc426667058fbcb0882913172bf554880ce0009a
[vpp.git] / src / vnet / dev / dev.h
1 /* SPDX-License-Identifier: Apache-2.0
2  * Copyright (c) 2023 Cisco Systems, Inc.
3  */
4
5 #ifndef _VNET_DEV_H_
6 #define _VNET_DEV_H_
7
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>
13
14 #define VNET_DEV_DEVICE_ID_PREFIX_DELIMITER "/"
15
16 #define foreach_vnet_dev_port_type                                            \
17   _ (0, UNKNOWN)                                                              \
18   _ (1, ETHERNET)
19
20 typedef char vnet_dev_device_id_t[32];
21
22 typedef enum
23 {
24 #define _(b, n) VNET_DEV_PORT_TYPE_##n = (1U << (b)),
25   foreach_vnet_dev_port_type
26 #undef _
27 } vnet_dev_port_type_t;
28
29 #define foreach_vnet_dev_port_caps                                            \
30   _ (interrupt_mode)                                                          \
31   _ (rss)
32
33 typedef union
34 {
35   struct
36   {
37 #define _(n) u8 n : 1;
38     foreach_vnet_dev_port_caps
39 #undef _
40   };
41   u8 as_number;
42 } vnet_dev_port_caps_t;
43
44 typedef union
45 {
46   u8 eth_mac[6];
47   u8 raw[8];
48 } vnet_dev_hw_addr_t;
49
50 typedef struct vnet_dev_bus_registration vnet_dev_bus_registration_t;
51 typedef struct vnet_dev_driver_registration vnet_dev_driver_registration_t;
52
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;
62
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 *);
77
78 typedef u16 vnet_dev_queue_id_t;
79 typedef u16 vnet_dev_bus_index_t;
80 typedef u16 vnet_dev_driver_index_t;
81
82 typedef struct
83 {
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;
89
90 typedef struct
91 {
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;
97
98 typedef struct
99 {
100   u16 data_size;
101   u16 min_size;
102   u16 max_size;
103   u16 default_size;
104   u8 multiplier;
105   u8 size_is_power_of_two : 1;
106 } vnet_dev_queue_config_t;
107
108 #define foreach_vnet_dev_port_cfg_type                                        \
109   _ (PROMISC_MODE)                                                            \
110   _ (MAX_FRAME_SIZE)                                                          \
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)
116
117 typedef enum
118 {
119   VNET_DEV_PORT_CFG_UNKNOWN,
120 #define _(n) VNET_DEV_PORT_CFG_##n,
121   foreach_vnet_dev_port_cfg_type
122 #undef _
123 } __clib_packed vnet_dev_port_cfg_type_t;
124
125 typedef struct vnet_dev_port_cfg_change_req
126 {
127   vnet_dev_port_cfg_type_t type;
128   u8 validated : 1;
129   u8 all_queues : 1;
130
131   union
132   {
133     u8 promisc : 1;
134     vnet_dev_hw_addr_t addr;
135     u16 max_frame_size;
136     vnet_dev_queue_id_t queue_id;
137   };
138
139 } vnet_dev_port_cfg_change_req_t;
140
141 typedef struct
142 {
143   vnet_dev_hw_addr_t hw_addr;
144   u16 max_rx_queues;
145   u16 max_tx_queues;
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;
150
151 typedef enum
152 {
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;
156
157 typedef struct
158 {
159   f64 interval;
160   f64 last_run;
161   vnet_dev_periodic_op_type_t type;
162   union
163   {
164     vnet_dev_t *dev;
165     vnet_dev_port_t *port;
166     void *arg;
167   };
168   union
169   {
170     vnet_dev_op_no_rv_t *dev_op;
171     vnet_dev_port_op_no_rv_t *port_op;
172     void *op;
173   };
174 } vnet_dev_periodic_op_t;
175
176 typedef struct
177 {
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;
182 } vnet_dev_node_t;
183
184 typedef struct
185 {
186   vnet_dev_op_t *alloc;
187   vnet_dev_op_t *init;
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;
193 } vnet_dev_ops_t;
194
195 typedef struct
196 {
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;
207
208 typedef union
209 {
210   struct
211   {
212     u8 update_next_index : 1;
213     u8 update_feature_arc : 1;
214     u8 suspend_off : 1;
215     u8 suspend_on : 1;
216   };
217   u8 as_number;
218 } vnet_dev_rx_queue_rt_req_t;
219
220 typedef struct vnet_dev_rx_queue
221 {
222   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
223   vnet_dev_port_t *port;
224   u16 rx_thread_index;
225   u16 index;
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;
230   u8 enabled : 1;
231   u8 started : 1;
232   u8 suspended : 1;
233   vnet_dev_queue_id_t queue_id;
234   u16 size;
235   u16 next_index;
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);
240   u8 data[];
241 } vnet_dev_rx_queue_t;
242
243 STATIC_ASSERT_SIZEOF (vnet_dev_rx_queue_t, 3 * CLIB_CACHE_LINE_BYTES);
244
245 typedef struct vnet_dev_tx_queue
246 {
247   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
248   vnet_dev_port_t *port;
249   clib_bitmap_t *assigned_threads;
250   u16 index;
251   vnet_dev_counter_main_t *counter_main;
252   CLIB_CACHE_LINE_ALIGN_MARK (runtime0);
253   vnet_dev_queue_id_t queue_id;
254   u8 started : 1;
255   u8 enabled : 1;
256   u8 lock_needed : 1;
257   u8 lock;
258   u16 size;
259   CLIB_ALIGN_MARK (private_data, 16);
260   u8 data[];
261 } vnet_dev_tx_queue_t;
262
263 STATIC_ASSERT_SIZEOF (vnet_dev_tx_queue_t, 2 * CLIB_CACHE_LINE_BYTES);
264
265 typedef struct vnet_dev_port
266 {
267   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
268   vnet_dev_t *dev;
269   vnet_dev_port_id_t port_id;
270   vnet_dev_driver_index_t driver_index;
271   u8 initialized : 1;
272   u8 started : 1;
273   u8 link_up : 1;
274   u8 promisc : 1;
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;
281   u32 max_frame_size;
282   vnet_dev_hw_addr_t primary_hw_addr;
283   vnet_dev_hw_addr_t *secondary_hw_addr;
284   u32 index;
285   u32 speed;
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;
293
294   struct
295   {
296     vnet_dev_if_name_t name;
297     u32 dev_instance;
298     u32 rx_node_index;
299     u32 current_config_index;
300     u16 rx_next_index;
301     u16 redirect_to_node_next_index;
302     u8 feature_arc_index;
303     u8 feature_arc : 1;
304     u8 redirect_to_node : 1;
305     u8 default_is_intr_mode : 1;
306     u32 tx_node_index;
307     u32 hw_if_index;
308     u32 sw_if_index;
309     u16 num_rx_queues;
310     u16 num_tx_queues;
311     u16 txq_sz;
312     u16 rxq_sz;
313   } intf;
314
315   CLIB_CACHE_LINE_ALIGN_MARK (data0);
316   u8 data[];
317 } vnet_dev_port_t;
318
319 typedef struct vnet_dev
320 {
321   vnet_dev_device_id_t device_id;
322   u16 initialized : 1;
323   u16 not_first_init : 1;
324   u16 va_dma : 1;
325   u16 process_node_quit : 1;
326   u16 process_node_periodic : 1;
327   u16 poll_stats : 1;
328   u16 bus_index;
329   u8 numa_node;
330   u16 max_rx_queues;
331   u16 max_tx_queues;
332   vnet_dev_driver_index_t driver_index;
333   u32 index;
334   u32 process_node_index;
335   u8 bus_data[32] __clib_aligned (16);
336   vnet_dev_ops_t ops;
337   vnet_dev_port_t **ports;
338   vnet_dev_periodic_op_t *periodic_ops;
339   u8 *description;
340   u8 __clib_aligned (16)
341   data[];
342 } vnet_dev_t;
343
344 typedef struct
345 {
346   u16 vendor_id, device_id;
347   char *description;
348 } vnet_dev_match_t;
349
350 #define VNET_DEV_MATCH(...)                                                   \
351   (vnet_dev_match_t[])                                                        \
352   {                                                                           \
353     __VA_ARGS__, {}                                                           \
354   }
355
356 typedef struct
357 {
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,
361                                      void **);
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;
368
369 struct vnet_dev_bus_registration
370 {
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;
375 };
376
377 struct vnet_dev_driver_registration
378 {
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;
383   u16 device_data_sz;
384   u16 runtime_temp_space_sz;
385   vnet_dev_match_t *match;
386   int priority;
387   vnet_dev_ops_t ops;
388 };
389
390 typedef struct
391 {
392   u32 index;
393   vnet_dev_bus_registration_t *registration;
394   vnet_dev_bus_ops_t ops;
395 } vnet_dev_bus_t;
396
397 typedef struct
398 {
399   u32 index;
400   void *dev_data;
401   vnet_dev_driver_registration_t *registration;
402   u32 dev_class_index;
403   vnet_dev_bus_index_t bus_index;
404   vnet_dev_ops_t ops;
405 } vnet_dev_driver_t;
406
407 typedef struct
408 {
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;
420
421   u8 *startup_config;
422   u16 next_rx_queue_thread;
423   u8 eth_port_rx_feature_arc_index;
424 } vnet_dev_main_t;
425
426 extern vnet_dev_main_t vnet_dev_main;
427
428 typedef struct
429 {
430   struct
431   {
432     vnet_dev_port_attr_t attr;
433     vnet_dev_port_ops_t ops;
434     u16 data_size;
435     void *initial_data;
436   } port;
437
438   vnet_dev_node_t *rx_node;
439   vnet_dev_node_t *tx_node;
440
441   struct
442   {
443     vnet_dev_queue_config_t config;
444     vnet_dev_rx_queue_ops_t ops;
445   } rx_queue;
446
447   struct
448   {
449     vnet_dev_queue_config_t config;
450     vnet_dev_tx_queue_ops_t ops;
451   } tx_queue;
452 } vnet_dev_port_add_args_t;
453
454 typedef struct
455 {
456   union
457   {
458     struct
459     {
460       u8 link_speed : 1;
461       u8 link_state : 1;
462       u8 link_duplex : 1;
463     };
464     u8 any;
465   } change;
466   u8 link_state : 1;
467   u8 full_duplex : 1;
468   u32 link_speed;
469 } vnet_dev_port_state_changes_t;
470
471 /* dev.c */
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 *,
480                                  vnet_dev_port_id_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,
483                                       void **);
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);
487
488 /* error.c */
489 clib_error_t *vnet_dev_port_err (vlib_main_t *, vnet_dev_port_t *,
490                                  vnet_dev_rv_t, char *, ...);
491
492 /* handlers.c */
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 *,
497                                         const u8 *);
498 clib_error_t *vnet_dev_add_del_mac_address (vnet_hw_interface_t *, const u8 *,
499                                             u8);
500 int vnet_dev_flow_ops_fn (vnet_main_t *, vnet_flow_dev_op_t, u32, u32,
501                           uword *);
502 clib_error_t *vnet_dev_interface_set_rss_queues (vnet_main_t *,
503                                                  vnet_hw_interface_t *,
504                                                  clib_bitmap_t *);
505 void vnet_dev_clear_hw_interface_counters (u32);
506 void vnet_dev_set_interface_next_node (vnet_main_t *, u32, u32);
507
508 /* port.c */
509 vnet_dev_rv_t vnet_dev_port_start (vlib_main_t *, vnet_dev_port_t *);
510 vnet_dev_rv_t vnet_dev_port_start_all_rx_queues (vlib_main_t *,
511                                                  vnet_dev_port_t *);
512 vnet_dev_rv_t vnet_dev_port_start_all_tx_queues (vlib_main_t *,
513                                                  vnet_dev_port_t *);
514 void vnet_dev_port_stop (vlib_main_t *, vnet_dev_port_t *);
515 void vnet_dev_port_deinit (vlib_main_t *, vnet_dev_port_t *);
516 void vnet_dev_port_free (vlib_main_t *, vnet_dev_port_t *);
517 void vnet_dev_port_add_counters (vlib_main_t *, vnet_dev_port_t *,
518                                  vnet_dev_counter_t *, u16);
519 void vnet_dev_port_free_counters (vlib_main_t *, vnet_dev_port_t *);
520 void vnet_dev_port_update_tx_node_runtime (vlib_main_t *, vnet_dev_port_t *);
521 void vnet_dev_port_state_change (vlib_main_t *, vnet_dev_port_t *,
522                                  vnet_dev_port_state_changes_t);
523 void vnet_dev_port_clear_counters (vlib_main_t *, vnet_dev_port_t *);
524 vnet_dev_rv_t
525 vnet_dev_port_cfg_change_req_validate (vlib_main_t *, vnet_dev_port_t *,
526                                        vnet_dev_port_cfg_change_req_t *);
527 vnet_dev_rv_t vnet_dev_port_cfg_change (vlib_main_t *, vnet_dev_port_t *,
528                                         vnet_dev_port_cfg_change_req_t *);
529 vnet_dev_rv_t vnet_dev_port_if_create (vlib_main_t *, vnet_dev_port_t *);
530 vnet_dev_rv_t vnet_dev_port_if_remove (vlib_main_t *, vnet_dev_port_t *);
531
532 /* queue.c */
533 vnet_dev_rv_t vnet_dev_rx_queue_alloc (vlib_main_t *, vnet_dev_port_t *, u16);
534 vnet_dev_rv_t vnet_dev_tx_queue_alloc (vlib_main_t *, vnet_dev_port_t *, u16);
535 void vnet_dev_rx_queue_free (vlib_main_t *, vnet_dev_rx_queue_t *);
536 void vnet_dev_tx_queue_free (vlib_main_t *, vnet_dev_tx_queue_t *);
537 void vnet_dev_rx_queue_add_counters (vlib_main_t *, vnet_dev_rx_queue_t *,
538                                      vnet_dev_counter_t *, u16);
539 void vnet_dev_rx_queue_free_counters (vlib_main_t *, vnet_dev_rx_queue_t *);
540 void vnet_dev_tx_queue_add_counters (vlib_main_t *, vnet_dev_tx_queue_t *,
541                                      vnet_dev_counter_t *, u16);
542 void vnet_dev_tx_queue_free_counters (vlib_main_t *, vnet_dev_tx_queue_t *);
543 vnet_dev_rv_t vnet_dev_rx_queue_start (vlib_main_t *, vnet_dev_rx_queue_t *);
544 vnet_dev_rv_t vnet_dev_tx_queue_start (vlib_main_t *, vnet_dev_tx_queue_t *);
545 void vnet_dev_rx_queue_stop (vlib_main_t *, vnet_dev_rx_queue_t *);
546 void vnet_dev_tx_queue_stop (vlib_main_t *, vnet_dev_tx_queue_t *);
547
548 /* process.c */
549 vnet_dev_rv_t vnet_dev_process_create (vlib_main_t *, vnet_dev_t *);
550 vnet_dev_rv_t vnet_dev_process_call_op (vlib_main_t *, vnet_dev_t *,
551                                         vnet_dev_op_t *);
552 vnet_dev_rv_t vnet_dev_process_call_op_no_rv (vlib_main_t *, vnet_dev_t *,
553                                               vnet_dev_op_no_rv_t *);
554 void vnet_dev_process_call_op_no_wait (vlib_main_t *, vnet_dev_t *,
555                                        vnet_dev_op_no_rv_t *);
556 vnet_dev_rv_t vnet_dev_process_call_port_op (vlib_main_t *, vnet_dev_port_t *,
557                                              vnet_dev_port_op_t *);
558 vnet_dev_rv_t vnet_dev_process_call_port_op_no_rv (vlib_main_t *vm,
559                                                    vnet_dev_port_t *,
560                                                    vnet_dev_port_op_no_rv_t *);
561 void vnet_dev_process_call_port_op_no_wait (vlib_main_t *, vnet_dev_port_t *,
562                                             vnet_dev_port_op_no_rv_t *);
563 vnet_dev_rv_t
564 vnet_dev_process_port_cfg_change_req (vlib_main_t *, vnet_dev_port_t *,
565                                       vnet_dev_port_cfg_change_req_t *);
566 void vnet_dev_process_quit (vlib_main_t *, vnet_dev_t *);
567 void vnet_dev_poll_dev_add (vlib_main_t *, vnet_dev_t *, f64,
568                             vnet_dev_op_no_rv_t *);
569 void vnet_dev_poll_dev_remove (vlib_main_t *, vnet_dev_t *,
570                                vnet_dev_op_no_rv_t *);
571 void vnet_dev_poll_port_add (vlib_main_t *, vnet_dev_port_t *, f64,
572                              vnet_dev_port_op_no_rv_t *);
573 void vnet_dev_poll_port_remove (vlib_main_t *, vnet_dev_port_t *,
574                                 vnet_dev_port_op_no_rv_t *);
575
576 typedef struct
577 {
578   u16 thread_index;
579   u8 completed;
580   u8 in_order;
581   vnet_dev_port_t *port;
582 } vnet_dev_rt_op_t;
583
584 vnet_dev_rv_t vnet_dev_rt_exec_ops (vlib_main_t *, vnet_dev_t *,
585                                     vnet_dev_rt_op_t *, u32);
586
587 /* format.c */
588 typedef struct
589 {
590   u8 counters : 1;
591   u8 show_zero_counters : 1;
592   u8 debug : 1;
593 } vnet_dev_format_args_t;
594
595 format_function_t format_vnet_dev_addr;
596 format_function_t format_vnet_dev_hw_addr;
597 format_function_t format_vnet_dev_info;
598 format_function_t format_vnet_dev_interface_info;
599 format_function_t format_vnet_dev_interface_name;
600 format_function_t format_vnet_dev_port_info;
601 format_function_t format_vnet_dev_rv;
602 format_function_t format_vnet_dev_rx_queue_info;
603 format_function_t format_vnet_dev_tx_queue_info;
604 format_function_t format_vnet_dev_flags;
605 format_function_t format_vnet_dev_port_flags;
606 format_function_t format_vnet_dev_log;
607 unformat_function_t unformat_vnet_dev_flags;
608 unformat_function_t unformat_vnet_dev_port_flags;
609
610 typedef struct
611 {
612   vnet_dev_rx_queue_t *first_rx_queue;
613 } vnet_dev_rx_node_runtime_t;
614
615 STATIC_ASSERT (sizeof (vnet_dev_rx_node_runtime_t) <=
616                  VLIB_NODE_RUNTIME_DATA_SIZE,
617                "must fit into runtime data");
618
619 #define foreach_vnet_dev_port_rx_next                                         \
620   _ (ETH_INPUT, "ethernet-input")                                             \
621   _ (DROP, "error-drop")
622
623 typedef enum
624 {
625 #define _(n, s) VNET_DEV_ETH_RX_PORT_NEXT_##n,
626   foreach_vnet_dev_port_rx_next
627 #undef _
628     VNET_DEV_ETH_RX_PORT_N_NEXTS
629 } vnet_dev_eth_port_rx_next_t;
630
631 extern u16 vnet_dev_default_next_index_by_port_type[];
632 extern vlib_node_registration_t port_rx_eth_node;
633
634 typedef vnet_interface_output_runtime_t vnet_dev_tx_node_runtime_t;
635
636 STATIC_ASSERT (sizeof (vnet_dev_tx_node_runtime_t) <=
637                  VLIB_NODE_RUNTIME_DATA_SIZE,
638                "must fit into runtime data");
639
640 #define VNET_DEV_REGISTER_BUS(x, ...)                                         \
641   __VA_ARGS__ vnet_dev_bus_registration_t __vnet_dev_bus_registration_##x;    \
642   static void __clib_constructor __vnet_dev_bus_registration_fn_##x (void)    \
643   {                                                                           \
644     vnet_dev_main_t *dm = &vnet_dev_main;                                     \
645     __vnet_dev_bus_registration_##x.next_registration =                       \
646       dm->bus_registrations;                                                  \
647     dm->bus_registrations = &__vnet_dev_bus_registration_##x;                 \
648   }                                                                           \
649   __VA_ARGS__ vnet_dev_bus_registration_t __vnet_dev_bus_registration_##x
650
651 #define VNET_DEV_REGISTER_DRIVER(x, ...)                                      \
652   __VA_ARGS__ vnet_dev_driver_registration_t                                  \
653     __vnet_dev_driver_registration_##x;                                       \
654   static void __clib_constructor __vnet_dev_driver_registration_fn_##x (void) \
655   {                                                                           \
656     vnet_dev_main_t *dm = &vnet_dev_main;                                     \
657     __vnet_dev_driver_registration_##x.next_registration =                    \
658       dm->driver_registrations;                                               \
659     dm->driver_registrations = &__vnet_dev_driver_registration_##x;           \
660   }                                                                           \
661   __VA_ARGS__ vnet_dev_driver_registration_t __vnet_dev_driver_registration_##x
662
663 #define VNET_DEV_NODE_FN(node)                                                \
664   uword CLIB_MARCH_SFX (node##_fn) (vlib_main_t *, vlib_node_runtime_t *,     \
665                                     vlib_frame_t *);                          \
666   static vlib_node_fn_registration_t CLIB_MARCH_SFX (                         \
667     node##_fn_registration) = {                                               \
668     .function = &CLIB_MARCH_SFX (node##_fn),                                  \
669   };                                                                          \
670                                                                               \
671   static void __clib_constructor CLIB_MARCH_SFX (                             \
672     node##_fn_multiarch_register) (void)                                      \
673   {                                                                           \
674     extern vnet_dev_node_t node;                                              \
675     vlib_node_fn_registration_t *r;                                           \
676     r = &CLIB_MARCH_SFX (node##_fn_registration);                             \
677     r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE);              \
678     r->next_registration = (node).registrations;                              \
679     (node).registrations = r;                                                 \
680   }                                                                           \
681   uword CLIB_MARCH_SFX (node##_fn)
682
683 #define foreach_vnet_dev_port(p, d) pool_foreach_pointer (p, d->ports)
684 #define foreach_vnet_dev_port_rx_queue(q, p)                                  \
685   pool_foreach_pointer (q, p->rx_queues)
686 #define foreach_vnet_dev_port_tx_queue(q, p)                                  \
687   pool_foreach_pointer (q, p->tx_queues)
688
689 #include <vnet/dev/dev_funcs.h>
690
691 #endif /* _VNET_DEV_H_ */