interface: rx queue infra rework, part one
[vpp.git] / src / vnet / interface / rx_queue.c
1 /*
2  * Copyright (c) 2020 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <vnet/vnet.h>
17 #include <vnet/devices/devices.h>
18 #include <vnet/interface/rx_queue_funcs.h>
19 #include <vlib/unix/unix.h>
20
21 VLIB_REGISTER_LOG_CLASS (if_rxq_log, static) = {
22   .class_name = "interface",
23   .subclass_name = "rx-queue",
24 };
25
26 #define log_debug(fmt, ...) vlib_log_debug (if_rxq_log.class, fmt, __VA_ARGS__)
27 #define log_err(fmt, ...)   vlib_log_err (if_rxq_log.class, fmt, __VA_ARGS__)
28
29 static u32
30 next_thread_index (vnet_main_t *vnm, u32 thread_index)
31 {
32   vnet_device_main_t *vdm = &vnet_device_main;
33   if (vdm->first_worker_thread_index == 0)
34     return 0;
35
36   if (thread_index != 0 && (thread_index < vdm->first_worker_thread_index ||
37                             thread_index > vdm->last_worker_thread_index))
38     {
39       thread_index = vdm->next_worker_thread_index++;
40       if (vdm->next_worker_thread_index > vdm->last_worker_thread_index)
41         vdm->next_worker_thread_index = vdm->first_worker_thread_index;
42     }
43
44   return thread_index;
45 }
46
47 static u64
48 rx_queue_key (u32 hw_if_index, u32 queue_id)
49 {
50   return ((u64) hw_if_index << 32) | queue_id;
51 }
52
53 u32
54 vnet_hw_if_get_rx_queue_index_by_id (vnet_main_t *vnm, u32 hw_if_index,
55                                      u32 queue_id)
56 {
57   vnet_interface_main_t *im = &vnm->interface_main;
58   u64 key = rx_queue_key (hw_if_index, queue_id);
59   uword *p = hash_get_mem (im->rxq_index_by_hw_if_index_and_queue_id, &key);
60   return p ? p[0] : ~0;
61 }
62
63 u32
64 vnet_hw_if_register_rx_queue (vnet_main_t *vnm, u32 hw_if_index, u32 queue_id,
65                               u32 thread_index)
66 {
67   vnet_interface_main_t *im = &vnm->interface_main;
68   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
69   vnet_hw_if_rx_queue_t *rxq;
70   u64 key = rx_queue_key (hw_if_index, queue_id);
71   u32 queue_index;
72
73   if (hash_get_mem (im->rxq_index_by_hw_if_index_and_queue_id, &key))
74     clib_panic ("Trying to register already registered queue id (%u) in the "
75                 "interface %v\n",
76                 queue_id, hi->name);
77
78   thread_index = next_thread_index (vnm, thread_index);
79
80   pool_get_zero (im->hw_if_rx_queues, rxq);
81   queue_index = rxq - im->hw_if_rx_queues;
82   vec_add1 (hi->rx_queue_indices, queue_index);
83   hash_set_mem_alloc (&im->rxq_index_by_hw_if_index_and_queue_id, &key,
84                       queue_index);
85   rxq->hw_if_index = hw_if_index;
86   rxq->dev_instance = hi->dev_instance;
87   rxq->queue_id = queue_id;
88   rxq->thread_index = thread_index;
89   rxq->mode = VNET_HW_IF_RX_MODE_POLLING;
90   rxq->file_index = ~0;
91
92   log_debug ("register: interface %s queue-id %u thread %u", hi->name,
93              queue_id, thread_index);
94
95   return queue_index;
96 }
97
98 void
99 vnet_hw_if_unregister_rx_queue (vnet_main_t *vnm, u32 queue_index)
100 {
101   vnet_interface_main_t *im = &vnm->interface_main;
102   vnet_hw_if_rx_queue_t *rxq;
103   rxq = vnet_hw_if_get_rx_queue (vnm, queue_index);
104   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, rxq->hw_if_index);
105   u64 key;
106
107   key = ((u64) rxq->hw_if_index << 32) | rxq->queue_id;
108   hash_unset_mem_free (&im->rxq_index_by_hw_if_index_and_queue_id, &key);
109
110   for (int i = 0; i < vec_len (hi->rx_queue_indices); i++)
111     if (hi->rx_queue_indices[i] == queue_index)
112       {
113         vec_del1 (hi->rx_queue_indices, i);
114         break;
115       }
116
117   log_debug ("unregister: interface %s queue-id %u", hi->name, rxq->queue_id);
118   pool_put_index (im->hw_if_rx_queues, queue_index);
119 }
120
121 void
122 vnet_hw_if_unregister_all_rx_queues (vnet_main_t *vnm, u32 hw_if_index)
123 {
124   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
125
126   log_debug ("unregister_all: interface %s", hi->name);
127
128   for (int i = 0; i < vec_len (hi->rx_queue_indices); i++)
129     vnet_hw_if_unregister_rx_queue (vnm, hi->rx_queue_indices[i]);
130
131   vec_free (hi->rx_queue_indices);
132 }
133
134 void
135 vnet_hw_if_set_rx_queue_file_index (vnet_main_t *vnm, u32 queue_index,
136                                     u32 file_index)
137 {
138   vnet_hw_if_rx_queue_t *rxq = vnet_hw_if_get_rx_queue (vnm, queue_index);
139   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, rxq->hw_if_index);
140
141   rxq->file_index = file_index;
142   clib_file_set_polling_thread (&file_main, file_index, rxq->thread_index);
143   log_debug ("set_file_index: interface %s queue-id %u file-index %u",
144              hi->name, rxq->queue_id, file_index);
145 }
146
147 void
148 vnet_hw_if_set_input_node (vnet_main_t *vnm, u32 hw_if_index, u32 node_index)
149 {
150   vlib_main_t *vm = vlib_get_main ();
151   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
152   hi->input_node_index = node_index;
153   log_debug ("set_input_node: node %U for interface %s", format_vlib_node_name,
154              vm, node_index, hi->name);
155 }
156
157 int
158 vnet_hw_if_set_rx_queue_mode (vnet_main_t *vnm, u32 queue_index,
159                               vnet_hw_if_rx_mode mode)
160 {
161   vnet_hw_if_rx_queue_t *rxq = vnet_hw_if_get_rx_queue (vnm, queue_index);
162   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, rxq->hw_if_index);
163   vnet_device_class_t *dc = vnet_get_device_class (vnm, hi->dev_class_index);
164
165   ASSERT (mode != VNET_HW_IF_RX_MODE_UNKNOWN);
166
167   if (mode == VNET_HW_IF_RX_MODE_DEFAULT)
168     mode = hi->default_rx_mode;
169
170   if (rxq->mode == mode)
171     {
172       log_debug ("set_rx_queue_mode: interface %s queue-id %u mode "
173                  "unchanged (%U)",
174                  hi->name, rxq->queue_id, format_vnet_hw_if_rx_mode, mode);
175       return 0;
176     }
177
178   if (dc->rx_mode_change_function)
179     {
180       clib_error_t *err = dc->rx_mode_change_function (vnm, rxq->hw_if_index,
181                                                        rxq->queue_id, mode);
182       if (err)
183         {
184           log_err ("setting rx mode on the interface %s queue-id %u failed.\n"
185                    "   %U",
186                    hi->name, rxq->queue_id, format_clib_error, err);
187           clib_error_free (err);
188           return VNET_API_ERROR_UNSUPPORTED;
189         }
190     }
191
192   rxq->mode = mode;
193   log_debug ("set_rx_queue_mode: interface %s queue-id %u mode set to %U",
194              hi->name, rxq->queue_id, format_vnet_hw_if_rx_mode, mode);
195   return 0;
196 }
197
198 vnet_hw_if_rx_mode
199 vnet_hw_if_get_rx_queue_mode (vnet_main_t *vnm, u32 queue_index)
200 {
201   vnet_hw_if_rx_queue_t *rxq = vnet_hw_if_get_rx_queue (vnm, queue_index);
202   return rxq->mode;
203 }
204
205 void
206 vnet_hw_if_set_rx_queue_thread_index (vnet_main_t *vnm, u32 queue_index,
207                                       u32 thread_index)
208 {
209   vnet_hw_if_rx_queue_t *rxq = vnet_hw_if_get_rx_queue (vnm, queue_index);
210   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, rxq->hw_if_index);
211
212   rxq->thread_index = thread_index;
213
214   if (rxq->file_index != ~0)
215     clib_file_set_polling_thread (&file_main, rxq->file_index, thread_index);
216
217   log_debug ("set_rx_queue_thread_index: interface %s queue-id %u "
218              "thread-index set to %u",
219              hi->name, rxq->queue_id, thread_index);
220 }
221
222 void
223 vnet_hw_if_generate_rxq_int_poll_vector (vlib_main_t *vm,
224                                          vlib_node_runtime_t *node)
225 {
226   vnet_hw_if_rx_node_runtime_t *rt = (void *) node->runtime_data;
227   vnet_main_t *vnm = vnet_get_main ();
228   int int_num = -1;
229
230   ASSERT (node->state == VLIB_NODE_STATE_INTERRUPT);
231
232   vec_reset_length (rt->rxq_poll_vector);
233
234   while ((int_num = clib_interrupt_get_next (rt->rxq_interrupts, int_num)) !=
235          -1)
236     {
237       vnet_hw_if_rx_queue_t *rxq = vnet_hw_if_get_rx_queue (vnm, int_num);
238       vnet_hw_if_rxq_poll_vector_t *pv;
239
240       clib_interrupt_clear (rt->rxq_interrupts, int_num);
241
242       vec_add2 (rt->rxq_poll_vector, pv, 1);
243       pv->dev_instance = rxq->dev_instance;
244       pv->queue_id = rxq->queue_id;
245     }
246 }
247
248 /*
249  * fd.io coding-style-patch-verification: ON
250  *
251  * Local Variables:
252  * eval: (c-set-style "gnu")
253  * End:
254  */