fc49ed629b8aaefaee159ca494d57cf276b63534
[vpp.git] / src / vnet / devices / netmap / netmap.c
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2016 Cisco and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *------------------------------------------------------------------
16  */
17
18 #include <stdint.h>
19 #include <net/if.h>
20 #include <sys/ioctl.h>
21 #include <sys/types.h>
22 #include <fcntl.h>
23 #include <vnet/devices/netmap/net_netmap.h>
24
25 #include <vlib/vlib.h>
26 #include <vlib/unix/unix.h>
27 #include <vnet/ethernet/ethernet.h>
28 #include <vnet/devices/netmap/netmap.h>
29
30 static u32
31 netmap_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
32                         u32 flags)
33 {
34   /* nothing for now */
35   return 0;
36 }
37
38 static clib_error_t *
39 netmap_fd_read_ready (clib_file_t * uf)
40 {
41   vlib_main_t *vm = vlib_get_main ();
42   netmap_main_t *nm = &netmap_main;
43   u32 idx = uf->private_data;
44
45   nm->pending_input_bitmap =
46     clib_bitmap_set (nm->pending_input_bitmap, idx, 1);
47
48   /* Schedule the rx node */
49   vlib_node_set_interrupt_pending (vm, netmap_input_node.index);
50
51   return 0;
52 }
53
54 static void
55 close_netmap_if (netmap_main_t * nm, netmap_if_t * nif)
56 {
57   if (nif->clib_file_index != ~0)
58     {
59       clib_file_del (&file_main, file_main.file_pool + nif->clib_file_index);
60       nif->clib_file_index = ~0;
61     }
62   else if (nif->fd > -1)
63     close (nif->fd);
64
65   if (nif->mem_region)
66     {
67       netmap_mem_region_t *reg = &nm->mem_regions[nif->mem_region];
68       if (--reg->refcnt == 0)
69         {
70           munmap (reg->mem, reg->region_size);
71           reg->region_size = 0;
72         }
73     }
74
75
76   mhash_unset (&nm->if_index_by_host_if_name, nif->host_if_name,
77                &nif->if_index);
78   vec_free (nif->host_if_name);
79   vec_free (nif->req);
80
81   memset (nif, 0, sizeof (*nif));
82   pool_put (nm->interfaces, nif);
83 }
84
85 int
86 netmap_worker_thread_enable ()
87 {
88   /* if worker threads are enabled, switch to polling mode */
89   foreach_vlib_main ((
90                        {
91                        vlib_node_set_state (this_vlib_main,
92                                             netmap_input_node.index,
93                                             VLIB_NODE_STATE_POLLING);
94                        }));
95
96   return 0;
97 }
98
99 int
100 netmap_worker_thread_disable ()
101 {
102   foreach_vlib_main ((
103                        {
104                        vlib_node_set_state (this_vlib_main,
105                                             netmap_input_node.index,
106                                             VLIB_NODE_STATE_INTERRUPT);
107                        }));
108
109   return 0;
110 }
111
112 int
113 netmap_create_if (vlib_main_t * vm, u8 * if_name, u8 * hw_addr_set,
114                   u8 is_pipe, u8 is_master, u32 * sw_if_index)
115 {
116   netmap_main_t *nm = &netmap_main;
117   int ret = 0;
118   netmap_if_t *nif = 0;
119   u8 hw_addr[6];
120   clib_error_t *error = 0;
121   vnet_sw_interface_t *sw;
122   vnet_main_t *vnm = vnet_get_main ();
123   uword *p;
124   struct nmreq *req = 0;
125   netmap_mem_region_t *reg;
126   vlib_thread_main_t *tm = vlib_get_thread_main ();
127   int fd;
128
129   p = mhash_get (&nm->if_index_by_host_if_name, if_name);
130   if (p)
131     return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
132
133   fd = open ("/dev/netmap", O_RDWR);
134   if (fd < 0)
135     return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
136
137   pool_get (nm->interfaces, nif);
138   nif->if_index = nif - nm->interfaces;
139   nif->fd = fd;
140   nif->clib_file_index = ~0;
141
142   vec_validate (req, 0);
143   nif->req = req;
144   req->nr_version = NETMAP_API;
145   req->nr_flags = NR_REG_ALL_NIC;
146
147   if (is_pipe)
148     req->nr_flags = is_master ? NR_REG_PIPE_MASTER : NR_REG_PIPE_SLAVE;
149   else
150     req->nr_flags = NR_REG_ALL_NIC;
151
152   req->nr_flags |= NR_ACCEPT_VNET_HDR;
153   snprintf (req->nr_name, IFNAMSIZ, "%s", if_name);
154   req->nr_name[IFNAMSIZ - 1] = 0;
155
156   if (ioctl (nif->fd, NIOCREGIF, req))
157     {
158       ret = VNET_API_ERROR_NOT_CONNECTED;
159       goto error;
160     }
161
162   nif->mem_region = req->nr_arg2;
163   vec_validate (nm->mem_regions, nif->mem_region);
164   reg = &nm->mem_regions[nif->mem_region];
165   if (reg->region_size == 0)
166     {
167       reg->mem = mmap (NULL, req->nr_memsize, PROT_READ | PROT_WRITE,
168                        MAP_SHARED, fd, 0);
169       clib_warning ("mem %p", reg->mem);
170       if (reg->mem == MAP_FAILED)
171         {
172           ret = VNET_API_ERROR_NOT_CONNECTED;
173           goto error;
174         }
175       reg->region_size = req->nr_memsize;
176     }
177   reg->refcnt++;
178
179   nif->nifp = NETMAP_IF (reg->mem, req->nr_offset);
180   nif->first_rx_ring = 0;
181   nif->last_rx_ring = 0;
182   nif->first_tx_ring = 0;
183   nif->last_tx_ring = 0;
184   nif->host_if_name = if_name;
185   nif->per_interface_next_index = ~0;
186
187   if (tm->n_vlib_mains > 1)
188     clib_spinlock_init (&nif->lockp);
189
190   {
191     clib_file_t template = { 0 };
192     template.read_function = netmap_fd_read_ready;
193     template.file_descriptor = nif->fd;
194     template.private_data = nif->if_index;
195     nif->clib_file_index = clib_file_add (&file_main, &template);
196   }
197
198   /*use configured or generate random MAC address */
199   if (hw_addr_set)
200     memcpy (hw_addr, hw_addr_set, 6);
201   else
202     {
203       f64 now = vlib_time_now (vm);
204       u32 rnd;
205       rnd = (u32) (now * 1e6);
206       rnd = random_u32 (&rnd);
207
208       memcpy (hw_addr + 2, &rnd, sizeof (rnd));
209       hw_addr[0] = 2;
210       hw_addr[1] = 0xfe;
211     }
212
213   error = ethernet_register_interface (vnm, netmap_device_class.index,
214                                        nif->if_index, hw_addr,
215                                        &nif->hw_if_index,
216                                        netmap_eth_flag_change);
217
218   if (error)
219     {
220       clib_error_report (error);
221       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
222       goto error;
223     }
224
225   sw = vnet_get_hw_sw_interface (vnm, nif->hw_if_index);
226   nif->sw_if_index = sw->sw_if_index;
227
228   mhash_set_mem (&nm->if_index_by_host_if_name, if_name, &nif->if_index, 0);
229
230   if (sw_if_index)
231     *sw_if_index = nif->sw_if_index;
232
233   if (tm->n_vlib_mains > 1 && pool_elts (nm->interfaces) == 1)
234     netmap_worker_thread_enable ();
235
236   return 0;
237
238 error:
239   close_netmap_if (nm, nif);
240   return ret;
241 }
242
243 int
244 netmap_delete_if (vlib_main_t * vm, u8 * host_if_name)
245 {
246   vnet_main_t *vnm = vnet_get_main ();
247   netmap_main_t *nm = &netmap_main;
248   netmap_if_t *nif;
249   uword *p;
250   vlib_thread_main_t *tm = vlib_get_thread_main ();
251
252   p = mhash_get (&nm->if_index_by_host_if_name, host_if_name);
253   if (p == NULL)
254     {
255       clib_warning ("Host interface %s does not exist", host_if_name);
256       return VNET_API_ERROR_SYSCALL_ERROR_1;
257     }
258   nif = pool_elt_at_index (nm->interfaces, p[0]);
259
260   /* bring down the interface */
261   vnet_hw_interface_set_flags (vnm, nif->hw_if_index, 0);
262
263   ethernet_delete_interface (vnm, nif->hw_if_index);
264
265   close_netmap_if (nm, nif);
266
267   if (tm->n_vlib_mains > 1 && pool_elts (nm->interfaces) == 0)
268     netmap_worker_thread_disable ();
269
270   return 0;
271 }
272
273 static clib_error_t *
274 netmap_init (vlib_main_t * vm)
275 {
276   netmap_main_t *nm = &netmap_main;
277   vlib_thread_main_t *tm = vlib_get_thread_main ();
278   vlib_thread_registration_t *tr;
279   uword *p;
280
281   memset (nm, 0, sizeof (netmap_main_t));
282
283   nm->input_cpu_first_index = 0;
284   nm->input_cpu_count = 1;
285
286   /* find out which cpus will be used for input */
287   p = hash_get_mem (tm->thread_registrations_by_name, "workers");
288   tr = p ? (vlib_thread_registration_t *) p[0] : 0;
289
290   if (tr && tr->count > 0)
291     {
292       nm->input_cpu_first_index = tr->first_index;
293       nm->input_cpu_count = tr->count;
294     }
295
296   mhash_init_vec_string (&nm->if_index_by_host_if_name, sizeof (uword));
297
298   vec_validate_aligned (nm->rx_buffers, tm->n_vlib_mains - 1,
299                         CLIB_CACHE_LINE_BYTES);
300
301   return 0;
302 }
303
304 VLIB_INIT_FUNCTION (netmap_init);
305
306 /*
307  * fd.io coding-style-patch-verification: ON
308  *
309  * Local Variables:
310  * eval: (c-set-style "gnu")
311  * End:
312  */