2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 2014-2018 Giuseppe Lettieri
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #if defined(__FreeBSD__)
32 #include <sys/cdefs.h> /* prerequisite */
34 #include <sys/types.h>
35 #include <sys/errno.h>
36 #include <sys/param.h> /* defines used in kernel.h */
37 #include <sys/kernel.h> /* types used in module initialization */
38 #include <sys/malloc.h>
41 #include <sys/rwlock.h>
42 #include <sys/selinfo.h>
43 #include <sys/sysctl.h>
44 #include <sys/socket.h> /* sockaddrs */
46 #include <net/if_var.h>
47 #include <machine/bus.h> /* bus_dmamap_* */
48 #include <sys/refcount.h>
55 #elif defined(__APPLE__)
57 #warning OSX support is only partial
65 #error Unsupported platform
67 #endif /* unsupported */
73 #include <net/netmap.h>
74 #include <dev/netmap/netmap_kern.h>
75 #include <dev/netmap/netmap_mem2.h>
79 #define NM_PIPE_MAXSLOTS 4096
80 #define NM_PIPE_MAXRINGS 256
82 static int netmap_default_pipes = 0; /* ignored, kept for compatibility */
84 SYSCTL_DECL(_dev_netmap);
85 SYSCTL_INT(_dev_netmap, OID_AUTO, default_pipes, CTLFLAG_RW,
86 &netmap_default_pipes, 0, "For compatibility only");
89 /* allocate the pipe array in the parent adapter */
91 nm_pipe_alloc(struct netmap_adapter *na, u_int npipes)
94 struct netmap_pipe_adapter **npa;
96 if (npipes <= na->na_max_pipes)
97 /* we already have more entries that requested */
100 if (npipes < na->na_next_pipe || npipes > NM_MAXPIPES)
103 old_len = sizeof(struct netmap_pipe_adapter *)*na->na_max_pipes;
104 len = sizeof(struct netmap_pipe_adapter *) * npipes;
105 npa = nm_os_realloc(na->na_pipes, len, old_len);
110 na->na_max_pipes = npipes;
115 /* deallocate the parent array in the parent adapter */
117 netmap_pipe_dealloc(struct netmap_adapter *na)
120 if (na->na_next_pipe > 0) {
121 nm_prerr("freeing not empty pipe array for %s (%d dangling pipes)!",
122 na->name, na->na_next_pipe);
124 nm_os_free(na->na_pipes);
126 na->na_max_pipes = 0;
127 na->na_next_pipe = 0;
131 /* find a pipe endpoint with the given id among the parent's pipes */
132 static struct netmap_pipe_adapter *
133 netmap_pipe_find(struct netmap_adapter *parent, const char *pipe_id)
136 struct netmap_pipe_adapter *na;
138 for (i = 0; i < parent->na_next_pipe; i++) {
139 const char *na_pipe_id;
140 na = parent->na_pipes[i];
141 na_pipe_id = strrchr(na->up.name,
142 na->role == NM_PIPE_ROLE_MASTER ? '{' : '}');
143 KASSERT(na_pipe_id != NULL, ("Invalid pipe name"));
145 if (!strcmp(na_pipe_id, pipe_id)) {
152 /* add a new pipe endpoint to the parent array */
154 netmap_pipe_add(struct netmap_adapter *parent, struct netmap_pipe_adapter *na)
156 if (parent->na_next_pipe >= parent->na_max_pipes) {
157 u_int npipes = parent->na_max_pipes ? 2*parent->na_max_pipes : 2;
158 int error = nm_pipe_alloc(parent, npipes);
163 parent->na_pipes[parent->na_next_pipe] = na;
164 na->parent_slot = parent->na_next_pipe;
165 parent->na_next_pipe++;
169 /* remove the given pipe endpoint from the parent array */
171 netmap_pipe_remove(struct netmap_adapter *parent, struct netmap_pipe_adapter *na)
174 n = --parent->na_next_pipe;
175 if (n != na->parent_slot) {
176 struct netmap_pipe_adapter **p =
177 &parent->na_pipes[na->parent_slot];
178 *p = parent->na_pipes[n];
179 (*p)->parent_slot = na->parent_slot;
181 parent->na_pipes[n] = NULL;
185 netmap_pipe_txsync(struct netmap_kring *txkring, int flags)
187 struct netmap_kring *rxkring = txkring->pipe;
188 u_int k, lim = txkring->nkr_num_slots - 1, nk;
189 int m; /* slots to transfer */
190 int complete; /* did we see a complete packet ? */
191 struct netmap_ring *txring = txkring->ring, *rxring = rxkring->ring;
193 nm_prdis("%p: %s %x -> %s", txkring, txkring->name, flags, rxkring->name);
194 nm_prdis(20, "TX before: hwcur %d hwtail %d cur %d head %d tail %d",
195 txkring->nr_hwcur, txkring->nr_hwtail,
196 txkring->rcur, txkring->rhead, txkring->rtail);
198 /* update the hwtail */
199 txkring->nr_hwtail = txkring->pipe_tail;
201 m = txkring->rhead - txkring->nr_hwcur; /* new slots */
203 m += txkring->nkr_num_slots;
206 /* nothing to send */
210 for (k = txkring->nr_hwcur, nk = lim + 1, complete = 0; m;
211 m--, k = nm_next(k, lim), nk = (complete ? k : nk)) {
212 struct netmap_slot *rs = &rxring->slot[k];
213 struct netmap_slot *ts = &txring->slot[k];
214 uint64_t off = nm_get_offset(rxkring, rs);
217 if (nm_get_offset(rxkring, rs) < off) {
218 nm_write_offset(rxkring, rs, off);
220 if (ts->flags & NS_BUF_CHANGED) {
221 ts->flags &= ~NS_BUF_CHANGED;
223 complete = !(ts->flags & NS_MOREFRAG);
226 txkring->nr_hwcur = k;
228 nm_prdis(20, "TX after : hwcur %d hwtail %d cur %d head %d tail %d k %d",
229 txkring->nr_hwcur, txkring->nr_hwtail,
230 txkring->rcur, txkring->rhead, txkring->rtail, k);
232 if (likely(nk <= lim)) {
233 mb(); /* make sure the slots are updated before publishing them */
234 rxkring->pipe_tail = nk; /* only publish complete packets */
235 rxkring->nm_notify(rxkring, 0);
242 netmap_pipe_rxsync(struct netmap_kring *rxkring, int flags)
244 struct netmap_kring *txkring = rxkring->pipe;
245 u_int k, lim = rxkring->nkr_num_slots - 1;
246 int m; /* slots to release */
247 struct netmap_ring *txring = txkring->ring, *rxring = rxkring->ring;
249 nm_prdis("%p: %s %x -> %s", txkring, txkring->name, flags, rxkring->name);
250 nm_prdis(20, "RX before: hwcur %d hwtail %d cur %d head %d tail %d",
251 rxkring->nr_hwcur, rxkring->nr_hwtail,
252 rxkring->rcur, rxkring->rhead, rxkring->rtail);
254 /* update the hwtail */
255 rxkring->nr_hwtail = rxkring->pipe_tail;
257 m = rxkring->rhead - rxkring->nr_hwcur; /* released slots */
259 m += rxkring->nkr_num_slots;
262 /* nothing to release */
266 for (k = rxkring->nr_hwcur; m; m--, k = nm_next(k, lim)) {
267 struct netmap_slot *rs = &rxring->slot[k];
268 struct netmap_slot *ts = &txring->slot[k];
270 /* copy the slot. This also propagates any offset */
272 if (rs->flags & NS_BUF_CHANGED) {
273 rs->flags &= ~NS_BUF_CHANGED;
277 mb(); /* make sure the slots are updated before publishing them */
278 txkring->pipe_tail = nm_prev(k, lim);
279 rxkring->nr_hwcur = k;
281 nm_prdis(20, "RX after : hwcur %d hwtail %d cur %d head %d tail %d k %d",
282 rxkring->nr_hwcur, rxkring->nr_hwtail,
283 rxkring->rcur, rxkring->rhead, rxkring->rtail, k);
285 txkring->nm_notify(txkring, 0);
290 /* Pipe endpoints are created and destroyed together, so that endopoints do not
291 * have to check for the existence of their peer at each ?xsync.
293 * To play well with the existing netmap infrastructure (refcounts etc.), we
294 * adopt the following strategy:
296 * 1) The first endpoint that is created also creates the other endpoint and
297 * grabs a reference to it.
299 * state A) user1 --> endpoint1 --> endpoint2
301 * 2) If, starting from state A, endpoint2 is then registered, endpoint1 gives
302 * its reference to the user:
304 * state B) user1 --> endpoint1 endpoint2 <--- user2
306 * 3) Assume that, starting from state B endpoint2 is closed. In the unregister
307 * callback endpoint2 notes that endpoint1 is still active and adds a reference
308 * from endpoint1 to itself. When user2 then releases her own reference,
309 * endpoint2 is not destroyed and we are back to state A. A symmetrical state
310 * would be reached if endpoint1 were released instead.
312 * 4) If, starting from state A, endpoint1 is closed, the destructor notes that
313 * it owns a reference to endpoint2 and releases it.
315 * Something similar goes on for the creation and destruction of the krings.
319 int netmap_pipe_krings_create_both(struct netmap_adapter *na,
320 struct netmap_adapter *ona)
327 nm_prdis("%p: case 1, create both ends", na);
328 error = netmap_krings_create(na, 0);
332 /* create the krings of the other end */
333 error = netmap_krings_create(ona, 0);
337 /* cross link the krings and initialize the pipe_tails */
339 enum txrx r = nm_txrx_swap(t); /* swap NR_TX <-> NR_RX */
340 for (i = 0; i < nma_get_nrings(na, t); i++) {
341 struct netmap_kring *k1 = NMR(na, t)[i],
342 *k2 = NMR(ona, r)[i];
345 /* mark all peer-adapter rings as fake */
346 k2->nr_kflags |= NKR_FAKERING;
348 k1->pipe_tail = k1->nr_hwtail;
349 k2->pipe_tail = k2->nr_hwtail;
356 netmap_krings_delete(na);
360 /* netmap_pipe_krings_create.
362 * There are two cases:
368 * and we are e1. We have to create both sets
375 * and we are e2. e1 is certainly registered and our
376 * krings already exist. Nothing to do.
379 netmap_pipe_krings_create(struct netmap_adapter *na)
381 struct netmap_pipe_adapter *pna =
382 (struct netmap_pipe_adapter *)na;
383 struct netmap_adapter *ona = &pna->peer->up;
386 return netmap_pipe_krings_create_both(na, ona);
392 netmap_pipe_reg_both(struct netmap_adapter *na, struct netmap_adapter *ona)
398 for (i = 0; i < nma_get_nrings(na, t); i++) {
399 struct netmap_kring *kring = NMR(na, t)[i];
401 if (nm_kring_pending_on(kring)) {
402 /* mark the peer ring as needed */
403 kring->pipe->nr_kflags |= NKR_NEEDRING;
408 /* create all missing needed rings on the other end.
409 * Either our end, or the other, has been marked as
410 * fake, so the allocation will not be done twice.
412 error = netmap_mem_rings_create(ona);
416 /* In case of no error we put our rings in netmap mode */
418 for (i = 0; i < nma_get_nrings(na, t); i++) {
419 struct netmap_kring *kring = NMR(na, t)[i];
420 if (nm_kring_pending_on(kring)) {
422 kring->nr_mode = NKR_NETMAP_ON;
423 if ((kring->nr_kflags & NKR_FAKERING) &&
424 (kring->pipe->nr_kflags & NKR_FAKERING)) {
425 /* this is a re-open of a pipe
426 * end-point kept alive by the other end.
427 * We need to leave everything as it is
432 /* copy the buffers from the non-fake ring
433 * (this also propagates any initial offset)
435 memcpy(kring->pipe->ring->slot,
437 sizeof(struct netmap_slot) *
438 kring->nkr_num_slots);
439 /* copy the offset-related fields */
440 *(uint64_t *)(uintptr_t)&kring->pipe->ring->offset_mask =
441 kring->ring->offset_mask;
442 *(uint64_t *)(uintptr_t)&kring->pipe->ring->buf_align =
443 kring->ring->buf_align;
444 /* mark both rings as fake and needed,
445 * so that buffers will not be
446 * deleted by the standard machinery
447 * (we will delete them by ourselves in
448 * netmap_pipe_krings_delete)
451 (NKR_FAKERING | NKR_NEEDRING);
452 kring->nr_mode = NKR_NETMAP_ON;
462 * There are two cases on registration (onoff==1)
468 * and we are e1. Create the needed rings of the
473 * usr1 --> e1 --> e2 <-- usr2
475 * and we are e2. Drop the ref e1 is holding.
477 * There are two additional cases on unregister (onoff==0)
483 * and we are e1. Nothing special to do, e2 will
484 * be cleaned up by the destructor of e1.
488 * usr1 --> e1 e2 <-- usr2
490 * and we are either e1 or e2. Add a ref from the
494 netmap_pipe_reg(struct netmap_adapter *na, int onoff)
496 struct netmap_pipe_adapter *pna =
497 (struct netmap_pipe_adapter *)na;
498 struct netmap_adapter *ona = &pna->peer->up;
501 nm_prdis("%p: onoff %d", na, onoff);
503 error = netmap_pipe_reg_both(na, ona);
507 if (na->active_fds == 0)
508 na->na_flags |= NAF_NETMAP_ON;
510 if (na->active_fds == 0)
511 na->na_flags &= ~NAF_NETMAP_ON;
512 netmap_krings_mode_commit(na, onoff);
515 if (na->active_fds) {
516 nm_prdis("active_fds %d", na->active_fds);
521 nm_prdis("%p: case 1.a or 2.a, nothing to do", na);
525 nm_prdis("%p: case 1.b, drop peer", na);
526 pna->peer->peer_ref = 0;
527 netmap_adapter_put(na);
529 nm_prdis("%p: case 2.b, grab peer", na);
530 netmap_adapter_get(na);
531 pna->peer->peer_ref = 1;
537 netmap_pipe_krings_delete_both(struct netmap_adapter *na,
538 struct netmap_adapter *ona)
540 struct netmap_adapter *sna;
545 nm_prdis("%p: case 1, deleting everything", na);
546 /* To avoid double-frees we zero-out all the buffers in the kernel part
547 * of each ring. The reason is this: If the user is behaving correctly,
548 * all buffers are found in exactly one slot in the userspace part of
549 * some ring. If the user is not behaving correctly, we cannot release
550 * buffers cleanly anyway. In the latter case, the allocator will
551 * return to a clean state only when all its users will close.
556 for (i = 0; i < nma_get_nrings(sna, t); i++) {
557 struct netmap_kring *kring = NMR(sna, t)[i];
558 struct netmap_ring *ring = kring->ring;
559 uint32_t j, lim = kring->nkr_num_slots - 1;
561 nm_prdis("%s ring %p hwtail %u hwcur %u",
562 kring->name, ring, kring->nr_hwtail, kring->nr_hwcur);
567 if (kring->tx == NR_RX)
568 ring->slot[kring->pipe_tail].buf_idx = 0;
570 for (j = nm_next(kring->pipe_tail, lim);
571 j != kring->nr_hwcur;
574 nm_prdis("%s[%d] %u", kring->name, j, ring->slot[j].buf_idx);
575 ring->slot[j].buf_idx = 0;
577 kring->nr_kflags &= ~(NKR_FAKERING | NKR_NEEDRING);
581 if (sna != ona && ona->tx_rings) {
586 netmap_mem_rings_delete(na);
587 netmap_krings_delete(na); /* also zeroes tx_rings etc. */
589 if (ona->tx_rings == NULL) {
590 /* already deleted, we must be on an
591 * cleanup-after-error path */
594 netmap_mem_rings_delete(ona);
595 netmap_krings_delete(ona);
598 /* netmap_pipe_krings_delete.
600 * There are two cases:
606 * and we are e1 (e2 is not registered, so krings_delete cannot be
611 * usr1 --> e1 e2 <-- usr2
613 * and we are either e1 or e2.
615 * In the former case we have to also delete the krings of e2;
616 * in the latter case we do nothing.
619 netmap_pipe_krings_delete(struct netmap_adapter *na)
621 struct netmap_pipe_adapter *pna =
622 (struct netmap_pipe_adapter *)na;
623 struct netmap_adapter *ona; /* na of the other end */
625 if (!pna->peer_ref) {
626 nm_prdis("%p: case 2, kept alive by peer", na);
629 ona = &pna->peer->up;
630 netmap_pipe_krings_delete_both(na, ona);
635 netmap_pipe_dtor(struct netmap_adapter *na)
637 struct netmap_pipe_adapter *pna =
638 (struct netmap_pipe_adapter *)na;
639 nm_prdis("%p %p", na, pna->parent_ifp);
641 nm_prdis("%p: clean up peer", na);
643 netmap_adapter_put(&pna->peer->up);
645 if (pna->role == NM_PIPE_ROLE_MASTER)
646 netmap_pipe_remove(pna->parent, pna);
648 if_rele(pna->parent_ifp);
649 netmap_adapter_put(pna->parent);
654 netmap_get_pipe_na(struct nmreq_header *hdr, struct netmap_adapter **na,
655 struct netmap_mem_d *nmd, int create)
657 struct nmreq_register *req = (struct nmreq_register *)(uintptr_t)hdr->nr_body;
658 struct netmap_adapter *pna; /* parent adapter */
659 struct netmap_pipe_adapter *mna, *sna, *reqna;
660 struct ifnet *ifp = NULL;
661 const char *pipe_id = NULL;
663 int error, retries = 0;
664 char *cbra, pipe_char;
666 /* Try to parse the pipe syntax 'xx{yy' or 'xx}yy'. */
667 cbra = strrchr(hdr->nr_name, '{');
669 role = NM_PIPE_ROLE_MASTER;
671 cbra = strrchr(hdr->nr_name, '}');
673 role = NM_PIPE_ROLE_SLAVE;
675 nm_prdis("not a pipe");
681 if (*pipe_id == '\0' || cbra == hdr->nr_name) {
682 /* Bracket is the last character, so pipe name is missing;
683 * or bracket is the first character, so base port name
688 if (req->nr_mode != NR_REG_ALL_NIC && req->nr_mode != NR_REG_ONE_NIC) {
689 /* We only accept modes involving hardware rings. */
693 /* first, try to find the parent adapter */
697 /* Temporarily remove the pipe suffix. */
699 error = netmap_get_na(hdr, &pna, &ifp, nmd, create);
700 /* Restore the pipe suffix. */
704 if (error != ENXIO || retries++) {
705 nm_prdis("parent lookup failed: %d", error);
708 nm_prdis("try to create a persistent vale port");
709 /* create a persistent vale port and try again */
712 create_error = netmap_vi_create(hdr, 1 /* autodelete */);
715 if (create_error && create_error != EEXIST) {
716 if (create_error != EOPNOTSUPP) {
717 nm_prerr("failed to create a persistent vale port: %d",
724 if (NETMAP_OWNED_BY_KERN(pna)) {
725 nm_prdis("parent busy");
730 /* next, lookup the pipe id in the parent list */
732 mna = netmap_pipe_find(pna, pipe_id);
734 if (mna->role == role) {
735 nm_prdis("found %s directly at %d", pipe_id, mna->parent_slot);
738 nm_prdis("found %s indirectly at %d", pipe_id, mna->parent_slot);
741 /* the pipe we have found already holds a ref to the parent,
742 * so we need to drop the one we got from netmap_get_na()
744 netmap_unget_na(pna, ifp);
747 nm_prdis("pipe %s not found, create %d", pipe_id, create);
752 /* we create both master and slave.
753 * The endpoint we were asked for holds a reference to
756 mna = nm_os_malloc(sizeof(*mna));
761 snprintf(mna->up.name, sizeof(mna->up.name), "%s{%s", pna->name, pipe_id);
763 mna->role = NM_PIPE_ROLE_MASTER;
765 mna->parent_ifp = ifp;
767 mna->up.nm_txsync = netmap_pipe_txsync;
768 mna->up.nm_rxsync = netmap_pipe_rxsync;
769 mna->up.nm_register = netmap_pipe_reg;
770 mna->up.nm_dtor = netmap_pipe_dtor;
771 mna->up.nm_krings_create = netmap_pipe_krings_create;
772 mna->up.nm_krings_delete = netmap_pipe_krings_delete;
773 mna->up.nm_mem = netmap_mem_get(pna->nm_mem);
774 mna->up.na_flags |= NAF_MEM_OWNER | NAF_OFFSETS;
775 mna->up.na_lut = pna->na_lut;
777 mna->up.num_tx_rings = req->nr_tx_rings;
778 nm_bound_var(&mna->up.num_tx_rings, 1,
779 1, NM_PIPE_MAXRINGS, NULL);
780 mna->up.num_rx_rings = req->nr_rx_rings;
781 nm_bound_var(&mna->up.num_rx_rings, 1,
782 1, NM_PIPE_MAXRINGS, NULL);
783 mna->up.num_tx_desc = req->nr_tx_slots;
784 nm_bound_var(&mna->up.num_tx_desc, pna->num_tx_desc,
785 1, NM_PIPE_MAXSLOTS, NULL);
786 mna->up.num_rx_desc = req->nr_rx_slots;
787 nm_bound_var(&mna->up.num_rx_desc, pna->num_rx_desc,
788 1, NM_PIPE_MAXSLOTS, NULL);
789 error = netmap_attach_common(&mna->up);
792 /* register the master with the parent */
793 error = netmap_pipe_add(pna, mna);
797 /* create the slave */
798 sna = nm_os_malloc(sizeof(*mna));
803 /* most fields are the same, copy from master and then fix */
805 sna->up.nm_mem = netmap_mem_get(mna->up.nm_mem);
806 /* swap the number of tx/rx rings and slots */
807 sna->up.num_tx_rings = mna->up.num_rx_rings;
808 sna->up.num_tx_desc = mna->up.num_rx_desc;
809 sna->up.num_rx_rings = mna->up.num_tx_rings;
810 sna->up.num_rx_desc = mna->up.num_tx_desc;
811 snprintf(sna->up.name, sizeof(sna->up.name), "%s}%s", pna->name, pipe_id);
812 sna->role = NM_PIPE_ROLE_SLAVE;
813 error = netmap_attach_common(&sna->up);
817 /* join the two endpoints */
821 /* we already have a reference to the parent, but we
822 * need another one for the other endpoint we created
824 netmap_adapter_get(pna);
825 /* likewise for the ifp, if any */
829 if (role == NM_PIPE_ROLE_MASTER) {
832 netmap_adapter_get(&sna->up);
836 netmap_adapter_get(&mna->up);
838 nm_prdis("created master %p and slave %p", mna, sna);
841 nm_prdis("pipe %s %s at %p", pipe_id,
842 (reqna->role == NM_PIPE_ROLE_MASTER ? "master" : "slave"), reqna);
844 netmap_adapter_get(*na);
846 /* keep the reference to the parent.
847 * It will be released by the req destructor
855 netmap_pipe_remove(pna, mna);
859 netmap_unget_na(pna, ifp);
864 #endif /* WITH_PIPES */