2 * Copyright (C) 2013-2014 Universita` di Pisa. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/types.h>
29 #include <sys/module.h>
30 #include <sys/errno.h>
31 #include <sys/param.h> /* defines used in kernel.h */
32 #include <sys/poll.h> /* POLLIN, POLLOUT */
33 #include <sys/kernel.h> /* types used in module initialization */
34 #include <sys/conf.h> /* DEV_MODULE */
35 #include <sys/endian.h>
37 #include <sys/rwlock.h>
39 #include <vm/vm.h> /* vtophys */
40 #include <vm/pmap.h> /* vtophys */
41 #include <vm/vm_param.h>
42 #include <vm/vm_object.h>
43 #include <vm/vm_page.h>
44 #include <vm/vm_pager.h>
48 #include <sys/malloc.h>
49 #include <sys/socket.h> /* sockaddrs */
50 #include <sys/selinfo.h>
52 #include <net/if_var.h>
53 #include <machine/bus.h> /* bus_dmamap_* */
54 #include <netinet/in.h> /* in6_cksum_pseudo() */
55 #include <machine/in_cksum.h> /* in_pseudo(), in_cksum_hdr() */
57 #include <net/netmap.h>
58 #include <dev/netmap/netmap_kern.h>
59 #include <dev/netmap/netmap_mem2.h>
62 /* ======================== FREEBSD-SPECIFIC ROUTINES ================== */
64 rawsum_t nm_csum_raw(uint8_t *data, size_t len, rawsum_t cur_sum)
66 /* TODO XXX please use the FreeBSD implementation for this. */
67 uint16_t *words = (uint16_t *)data;
71 for (i = 0; i < nw; i++)
72 cur_sum += be16toh(words[i]);
75 cur_sum += (data[len-1] << 8);
80 /* Fold a raw checksum: 'cur_sum' is in host byte order, while the
81 * return value is in network byte order.
83 uint16_t nm_csum_fold(rawsum_t cur_sum)
85 /* TODO XXX please use the FreeBSD implementation for this. */
87 cur_sum = (cur_sum & 0xFFFF) + (cur_sum >> 16);
89 return htobe16((~cur_sum) & 0xFFFF);
92 uint16_t nm_csum_ipv4(struct nm_iphdr *iph)
95 return in_cksum_hdr((void *)iph);
97 return nm_csum_fold(nm_csum_raw((uint8_t*)iph, sizeof(struct nm_iphdr), 0));
101 void nm_csum_tcpudp_ipv4(struct nm_iphdr *iph, void *data,
102 size_t datalen, uint16_t *check)
105 uint16_t pseudolen = datalen + iph->protocol;
107 /* Compute and insert the pseudo-header cheksum. */
108 *check = in_pseudo(iph->saddr, iph->daddr,
110 /* Compute the checksum on TCP/UDP header + payload
111 * (includes the pseudo-header).
113 *check = nm_csum_fold(nm_csum_raw(data, datalen, 0));
115 static int notsupported = 0;
118 D("inet4 segmentation not supported");
123 void nm_csum_tcpudp_ipv6(struct nm_ipv6hdr *ip6h, void *data,
124 size_t datalen, uint16_t *check)
127 *check = in6_cksum_pseudo((void*)ip6h, datalen, ip6h->nexthdr, 0);
128 *check = nm_csum_fold(nm_csum_raw(data, datalen, 0));
130 static int notsupported = 0;
133 D("inet6 segmentation not supported");
140 * Intercept the rx routine in the standard device driver.
141 * Second argument is non-zero to intercept, 0 to restore
144 netmap_catch_rx(struct netmap_adapter *na, int intercept)
146 struct netmap_generic_adapter *gna = (struct netmap_generic_adapter *)na;
147 struct ifnet *ifp = na->ifp;
150 if (gna->save_if_input) {
151 D("cannot intercept again");
152 return EINVAL; /* already set */
154 gna->save_if_input = ifp->if_input;
155 ifp->if_input = generic_rx_handler;
157 if (!gna->save_if_input){
159 return EINVAL; /* not saved */
161 ifp->if_input = gna->save_if_input;
162 gna->save_if_input = NULL;
170 * Intercept the packet steering routine in the tx path,
171 * so that we can decide which queue is used for an mbuf.
172 * Second argument is non-zero to intercept, 0 to restore.
173 * On freebsd we just intercept if_transmit.
176 netmap_catch_tx(struct netmap_generic_adapter *gna, int enable)
178 struct netmap_adapter *na = &gna->up.up;
179 struct ifnet *ifp = na->ifp;
182 na->if_transmit = ifp->if_transmit;
183 ifp->if_transmit = netmap_transmit;
185 ifp->if_transmit = na->if_transmit;
191 * Transmit routine used by generic_netmap_txsync(). Returns 0 on success
192 * and non-zero on error (which may be packet drops or other errors).
193 * addr and len identify the netmap buffer, m is the (preallocated)
194 * mbuf to use for transmissions.
196 * We should add a reference to the mbuf so the m_freem() at the end
197 * of the transmission does not consume resources.
199 * On FreeBSD, and on multiqueue cards, we can force the queue using
200 * if ((m->m_flags & M_FLOWID) != 0)
201 * i = m->m_pkthdr.flowid % adapter->num_queues;
203 * i = curcpu % adapter->num_queues;
207 generic_xmit_frame(struct ifnet *ifp, struct mbuf *m,
208 void *addr, u_int len, u_int ring_nr)
212 m->m_len = m->m_pkthdr.len = 0;
214 // copy data to the mbuf
215 m_copyback(m, 0, len, addr);
216 // inc refcount. We are alone, so we can skip the atomic
217 atomic_fetchadd_int(m->m_ext.ref_cnt, 1);
218 m->m_flags |= M_FLOWID;
219 m->m_pkthdr.flowid = ring_nr;
220 m->m_pkthdr.rcvif = ifp; /* used for tx notification */
221 ret = NA(ifp)->if_transmit(ifp, m);
227 * The following two functions are empty until we have a generic
228 * way to extract the info from the ifp
231 generic_find_num_desc(struct ifnet *ifp, unsigned int *tx, unsigned int *rx)
239 generic_find_num_queues(struct ifnet *ifp, u_int *txq, u_int *rxq)
242 *txq = netmap_generic_rings;
243 *rxq = netmap_generic_rings;
247 void netmap_mitigation_init(struct nm_generic_mit *mit, struct netmap_adapter *na)
250 mit->mit_pending = 0;
255 void netmap_mitigation_start(struct nm_generic_mit *mit)
261 void netmap_mitigation_restart(struct nm_generic_mit *mit)
267 int netmap_mitigation_active(struct nm_generic_mit *mit)
274 void netmap_mitigation_cleanup(struct nm_generic_mit *mit)
281 * In order to track whether pages are still mapped, we hook into
282 * the standard cdev_pager and intercept the constructor and
286 struct netmap_vm_handle_t {
288 struct netmap_priv_d *priv;
293 netmap_dev_pager_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot,
294 vm_ooffset_t foff, struct ucred *cred, u_short *color)
296 struct netmap_vm_handle_t *vmh = handle;
299 D("handle %p size %jd prot %d foff %jd",
300 handle, (intmax_t)size, prot, (intmax_t)foff);
307 netmap_dev_pager_dtor(void *handle)
309 struct netmap_vm_handle_t *vmh = handle;
310 struct cdev *dev = vmh->dev;
311 struct netmap_priv_d *priv = vmh->priv;
314 D("handle %p", handle);
322 netmap_dev_pager_fault(vm_object_t object, vm_ooffset_t offset,
323 int prot, vm_page_t *mres)
325 struct netmap_vm_handle_t *vmh = object->handle;
326 struct netmap_priv_d *priv = vmh->priv;
329 vm_memattr_t memattr;
332 ND("object %p offset %jd prot %d mres %p",
333 object, (intmax_t)offset, prot, mres);
334 memattr = object->memattr;
335 pidx = OFF_TO_IDX(offset);
336 paddr = netmap_mem_ofstophys(priv->np_mref, offset);
338 return VM_PAGER_FAIL;
340 if (((*mres)->flags & PG_FICTITIOUS) != 0) {
342 * If the passed in result page is a fake page, update it with
343 * the new physical address.
346 vm_page_updatefake(page, paddr, memattr);
349 * Replace the passed in reqpage page with our own fake page and
350 * free up the all of the original pages.
352 #ifndef VM_OBJECT_WUNLOCK /* FreeBSD < 10.x */
353 #define VM_OBJECT_WUNLOCK VM_OBJECT_UNLOCK
354 #define VM_OBJECT_WLOCK VM_OBJECT_LOCK
355 #endif /* VM_OBJECT_WUNLOCK */
357 VM_OBJECT_WUNLOCK(object);
358 page = vm_page_getfake(paddr, memattr);
359 VM_OBJECT_WLOCK(object);
362 vm_page_unlock(*mres);
364 vm_page_insert(page, object, pidx);
366 page->valid = VM_PAGE_BITS_ALL;
367 return (VM_PAGER_OK);
371 static struct cdev_pager_ops netmap_cdev_pager_ops = {
372 .cdev_pg_ctor = netmap_dev_pager_ctor,
373 .cdev_pg_dtor = netmap_dev_pager_dtor,
374 .cdev_pg_fault = netmap_dev_pager_fault,
379 netmap_mmap_single(struct cdev *cdev, vm_ooffset_t *foff,
380 vm_size_t objsize, vm_object_t *objp, int prot)
383 struct netmap_vm_handle_t *vmh;
384 struct netmap_priv_d *priv;
388 D("cdev %p foff %jd size %jd objp %p prot %d", cdev,
389 (intmax_t )*foff, (intmax_t )objsize, objp, prot);
391 vmh = malloc(sizeof(struct netmap_vm_handle_t), M_DEVBUF,
398 error = devfs_get_cdevpriv((void**)&priv);
405 error = netmap_get_memory(priv);
409 obj = cdev_pager_allocate(vmh, OBJT_DEVICE,
410 &netmap_cdev_pager_ops, objsize, prot,
413 D("cdev_pager_allocate failed");
432 // XXX can we remove this ?
434 netmap_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
437 D("dev %p fflag 0x%x devtype %d td %p",
438 dev, fflag, devtype, td);
444 netmap_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
446 struct netmap_priv_d *priv;
454 // XXX wait or nowait ?
455 priv = malloc(sizeof(struct netmap_priv_d), M_DEVBUF,
460 error = devfs_set_cdevpriv(priv, netmap_dtor);
464 priv->np_refcount = 1;
469 /******************** kqueue support ****************/
472 * The OS_selwakeup also needs to issue a KNOTE_UNLOCKED.
473 * We use a non-zero argument to distinguish the call from the one
474 * in kevent_scan() which instead also needs to run netmap_poll().
475 * The knote uses a global mutex for the time being. We might
476 * try to reuse the one in the si, but it is not allocated
477 * permanently so it might be a bit tricky.
479 * The *kqfilter function registers one or another f_event
480 * depending on read or write mode.
481 * In the call to f_event() td_fpop is NULL so any child function
482 * calling devfs_get_cdevpriv() would fail - and we need it in
483 * netmap_poll(). As a workaround we store priv into kn->kn_hook
484 * and pass it as first argument to netmap_poll(), which then
485 * uses the failure to tell that we are called from f_event()
486 * and do not need the selrecord().
489 void freebsd_selwakeup(struct selinfo *si, int pri);
492 freebsd_selwakeup(struct selinfo *si, int pri)
495 D("on knote %p", &si->si_note);
496 selwakeuppri(si, pri);
497 /* use a non-zero hint to tell the notification from the
498 * call done in kqueue_scan() which uses 0
500 KNOTE_UNLOCKED(&si->si_note, 0x100 /* notification */);
504 netmap_knrdetach(struct knote *kn)
506 struct netmap_priv_d *priv = (struct netmap_priv_d *)kn->kn_hook;
507 struct selinfo *si = priv->np_rxsi;
509 D("remove selinfo %p", si);
510 knlist_remove(&si->si_note, kn, 0);
514 netmap_knwdetach(struct knote *kn)
516 struct netmap_priv_d *priv = (struct netmap_priv_d *)kn->kn_hook;
517 struct selinfo *si = priv->np_txsi;
519 D("remove selinfo %p", si);
520 knlist_remove(&si->si_note, kn, 0);
524 * callback from notifies (generated externally) and our
525 * calls to kevent(). The former we just return 1 (ready)
526 * since we do not know better.
527 * In the latter we call netmap_poll and return 0/1 accordingly.
530 netmap_knrw(struct knote *kn, long hint, int events)
532 struct netmap_priv_d *priv;
536 ND(5, "call from notify");
537 return 1; /* assume we are ready */
540 /* the notification may come from an external thread,
541 * in which case we do not want to run the netmap_poll
542 * This should be filtered above, but check just in case.
544 if (curthread != priv->np_td) { /* should not happen */
545 RD(5, "curthread changed %p %p", curthread, priv->np_td);
548 revents = netmap_poll((void *)priv, events, curthread);
549 return (events & revents) ? 1 : 0;
554 netmap_knread(struct knote *kn, long hint)
556 return netmap_knrw(kn, hint, POLLIN);
560 netmap_knwrite(struct knote *kn, long hint)
562 return netmap_knrw(kn, hint, POLLOUT);
565 static struct filterops netmap_rfiltops = {
567 .f_detach = netmap_knrdetach,
568 .f_event = netmap_knread,
571 static struct filterops netmap_wfiltops = {
573 .f_detach = netmap_knwdetach,
574 .f_event = netmap_knwrite,
579 * This is called when a thread invokes kevent() to record
580 * a change in the configuration of the kqueue().
581 * The 'priv' should be the same as in the netmap device.
584 netmap_kqfilter(struct cdev *dev, struct knote *kn)
586 struct netmap_priv_d *priv;
588 struct netmap_adapter *na;
590 int ev = kn->kn_filter;
592 if (ev != EVFILT_READ && ev != EVFILT_WRITE) {
593 D("bad filter request %d", ev);
596 error = devfs_get_cdevpriv((void**)&priv);
598 D("device not yet setup");
603 D("no netmap adapter for this file descriptor");
606 /* the si is indicated in the priv */
607 si = (ev == EVFILT_WRITE) ? priv->np_txsi : priv->np_rxsi;
609 kn->kn_fop = (ev == EVFILT_WRITE) ?
610 &netmap_wfiltops : &netmap_rfiltops;
612 knlist_add(&si->si_note, kn, 1);
614 ND("register %p %s td %p priv %p kn %p np_nifp %p kn_fp/fpop %s",
615 na, na->ifp->if_xname, curthread, priv, kn,
617 kn->kn_fp == curthread->td_fpop ? "match" : "MISMATCH");
621 struct cdevsw netmap_cdevsw = {
622 .d_version = D_VERSION,
624 .d_open = netmap_open,
625 .d_mmap_single = netmap_mmap_single,
626 .d_ioctl = netmap_ioctl,
627 .d_poll = netmap_poll,
628 .d_kqfilter = netmap_kqfilter,
629 .d_close = netmap_close,
631 /*--- end of kqueue support ----*/
634 * Kernel entry point.
636 * Initialize/finalize the module and return.
638 * Return 0 on success, errno on failure.
641 netmap_loader(__unused struct module *module, int event, __unused void *arg)
647 error = netmap_init();
663 DEV_MODULE(netmap, netmap_loader, NULL);