xref: /freebsd-14.2/sys/dev/netmap/netmap.c (revision ae10d1af)
168b8534bSLuigi Rizzo /*
2f196ce38SLuigi Rizzo  * Copyright (C) 2011-2012 Matteo Landi, Luigi Rizzo. All rights reserved.
368b8534bSLuigi Rizzo  *
468b8534bSLuigi Rizzo  * Redistribution and use in source and binary forms, with or without
568b8534bSLuigi Rizzo  * modification, are permitted provided that the following conditions
668b8534bSLuigi Rizzo  * are met:
768b8534bSLuigi Rizzo  *   1. Redistributions of source code must retain the above copyright
868b8534bSLuigi Rizzo  *      notice, this list of conditions and the following disclaimer.
968b8534bSLuigi Rizzo  *   2. Redistributions in binary form must reproduce the above copyright
1068b8534bSLuigi Rizzo  *      notice, this list of conditions and the following disclaimer in the
1168b8534bSLuigi Rizzo  *    documentation and/or other materials provided with the distribution.
1268b8534bSLuigi Rizzo  *
1368b8534bSLuigi Rizzo  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1468b8534bSLuigi Rizzo  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1568b8534bSLuigi Rizzo  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1668b8534bSLuigi Rizzo  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1768b8534bSLuigi Rizzo  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1868b8534bSLuigi Rizzo  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1968b8534bSLuigi Rizzo  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2068b8534bSLuigi Rizzo  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2168b8534bSLuigi Rizzo  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2268b8534bSLuigi Rizzo  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2368b8534bSLuigi Rizzo  * SUCH DAMAGE.
2468b8534bSLuigi Rizzo  */
2568b8534bSLuigi Rizzo 
26f196ce38SLuigi Rizzo #define NM_BRIDGE
27f196ce38SLuigi Rizzo 
2868b8534bSLuigi Rizzo /*
2968b8534bSLuigi Rizzo  * This module supports memory mapped access to network devices,
3068b8534bSLuigi Rizzo  * see netmap(4).
3168b8534bSLuigi Rizzo  *
3268b8534bSLuigi Rizzo  * The module uses a large, memory pool allocated by the kernel
3368b8534bSLuigi Rizzo  * and accessible as mmapped memory by multiple userspace threads/processes.
3468b8534bSLuigi Rizzo  * The memory pool contains packet buffers and "netmap rings",
3568b8534bSLuigi Rizzo  * i.e. user-accessible copies of the interface's queues.
3668b8534bSLuigi Rizzo  *
3768b8534bSLuigi Rizzo  * Access to the network card works like this:
3868b8534bSLuigi Rizzo  * 1. a process/thread issues one or more open() on /dev/netmap, to create
3968b8534bSLuigi Rizzo  *    select()able file descriptor on which events are reported.
4068b8534bSLuigi Rizzo  * 2. on each descriptor, the process issues an ioctl() to identify
4168b8534bSLuigi Rizzo  *    the interface that should report events to the file descriptor.
4268b8534bSLuigi Rizzo  * 3. on each descriptor, the process issues an mmap() request to
4368b8534bSLuigi Rizzo  *    map the shared memory region within the process' address space.
4468b8534bSLuigi Rizzo  *    The list of interesting queues is indicated by a location in
4568b8534bSLuigi Rizzo  *    the shared memory region.
4668b8534bSLuigi Rizzo  * 4. using the functions in the netmap(4) userspace API, a process
4768b8534bSLuigi Rizzo  *    can look up the occupation state of a queue, access memory buffers,
4868b8534bSLuigi Rizzo  *    and retrieve received packets or enqueue packets to transmit.
4968b8534bSLuigi Rizzo  * 5. using some ioctl()s the process can synchronize the userspace view
5068b8534bSLuigi Rizzo  *    of the queue with the actual status in the kernel. This includes both
5168b8534bSLuigi Rizzo  *    receiving the notification of new packets, and transmitting new
5268b8534bSLuigi Rizzo  *    packets on the output interface.
5368b8534bSLuigi Rizzo  * 6. select() or poll() can be used to wait for events on individual
5468b8534bSLuigi Rizzo  *    transmit or receive queues (or all queues for a given interface).
5568b8534bSLuigi Rizzo  */
5668b8534bSLuigi Rizzo 
57f196ce38SLuigi Rizzo #ifdef linux
58f196ce38SLuigi Rizzo #include "bsd_glue.h"
5942a3a5bdSLuigi Rizzo static netdev_tx_t linux_netmap_start(struct sk_buff *skb, struct net_device *dev);
60f196ce38SLuigi Rizzo #endif /* linux */
6101c7d25fSLuigi Rizzo 
62f196ce38SLuigi Rizzo #ifdef __APPLE__
63f196ce38SLuigi Rizzo #include "osx_glue.h"
6401c7d25fSLuigi Rizzo #endif /* __APPLE__ */
6501c7d25fSLuigi Rizzo 
66f196ce38SLuigi Rizzo #ifdef __FreeBSD__
6768b8534bSLuigi Rizzo #include <sys/cdefs.h> /* prerequisite */
6868b8534bSLuigi Rizzo __FBSDID("$FreeBSD$");
6968b8534bSLuigi Rizzo 
7068b8534bSLuigi Rizzo #include <sys/types.h>
7168b8534bSLuigi Rizzo #include <sys/module.h>
7268b8534bSLuigi Rizzo #include <sys/errno.h>
7368b8534bSLuigi Rizzo #include <sys/param.h>	/* defines used in kernel.h */
74506cc70cSLuigi Rizzo #include <sys/jail.h>
7568b8534bSLuigi Rizzo #include <sys/kernel.h>	/* types used in module initialization */
7668b8534bSLuigi Rizzo #include <sys/conf.h>	/* cdevsw struct */
7768b8534bSLuigi Rizzo #include <sys/uio.h>	/* uio struct */
7868b8534bSLuigi Rizzo #include <sys/sockio.h>
7968b8534bSLuigi Rizzo #include <sys/socketvar.h>	/* struct socket */
8068b8534bSLuigi Rizzo #include <sys/malloc.h>
8168b8534bSLuigi Rizzo #include <sys/mman.h>	/* PROT_EXEC */
8268b8534bSLuigi Rizzo #include <sys/poll.h>
83506cc70cSLuigi Rizzo #include <sys/proc.h>
8468b8534bSLuigi Rizzo #include <vm/vm.h>	/* vtophys */
8568b8534bSLuigi Rizzo #include <vm/pmap.h>	/* vtophys */
8668b8534bSLuigi Rizzo #include <sys/socket.h> /* sockaddrs */
8768b8534bSLuigi Rizzo #include <machine/bus.h>
8868b8534bSLuigi Rizzo #include <sys/selinfo.h>
8968b8534bSLuigi Rizzo #include <sys/sysctl.h>
9068b8534bSLuigi Rizzo #include <net/if.h>
9168b8534bSLuigi Rizzo #include <net/bpf.h>		/* BIOCIMMEDIATE */
92506cc70cSLuigi Rizzo #include <net/vnet.h>
9368b8534bSLuigi Rizzo #include <machine/bus.h>	/* bus_dmamap_* */
9468b8534bSLuigi Rizzo 
9568b8534bSLuigi Rizzo MALLOC_DEFINE(M_NETMAP, "netmap", "Network memory map");
96f196ce38SLuigi Rizzo #endif /* __FreeBSD__ */
9768b8534bSLuigi Rizzo 
980b8ed8e0SLuigi Rizzo #include <net/netmap.h>
990b8ed8e0SLuigi Rizzo #include <dev/netmap/netmap_kern.h>
1000b8ed8e0SLuigi Rizzo 
1015819da83SLuigi Rizzo u_int netmap_total_buffers;
1028241616dSLuigi Rizzo u_int netmap_buf_size;
1035819da83SLuigi Rizzo char *netmap_buffer_base;	/* address of an invalid buffer */
1045819da83SLuigi Rizzo 
1055819da83SLuigi Rizzo /* user-controlled variables */
1065819da83SLuigi Rizzo int netmap_verbose;
1075819da83SLuigi Rizzo 
1085819da83SLuigi Rizzo static int netmap_no_timestamp; /* don't timestamp on rxsync */
1095819da83SLuigi Rizzo 
1105819da83SLuigi Rizzo SYSCTL_NODE(_dev, OID_AUTO, netmap, CTLFLAG_RW, 0, "Netmap args");
1115819da83SLuigi Rizzo SYSCTL_INT(_dev_netmap, OID_AUTO, verbose,
1125819da83SLuigi Rizzo     CTLFLAG_RW, &netmap_verbose, 0, "Verbose mode");
1135819da83SLuigi Rizzo SYSCTL_INT(_dev_netmap, OID_AUTO, no_timestamp,
1145819da83SLuigi Rizzo     CTLFLAG_RW, &netmap_no_timestamp, 0, "no_timestamp");
1155819da83SLuigi Rizzo int netmap_mitigate = 1;
1165819da83SLuigi Rizzo SYSCTL_INT(_dev_netmap, OID_AUTO, mitigate, CTLFLAG_RW, &netmap_mitigate, 0, "");
117c85cb1a0SLuigi Rizzo int netmap_no_pendintr = 1;
1185819da83SLuigi Rizzo SYSCTL_INT(_dev_netmap, OID_AUTO, no_pendintr,
1195819da83SLuigi Rizzo     CTLFLAG_RW, &netmap_no_pendintr, 0, "Always look for new received packets.");
1205819da83SLuigi Rizzo 
121f196ce38SLuigi Rizzo int netmap_drop = 0;	/* debugging */
122f196ce38SLuigi Rizzo int netmap_flags = 0;	/* debug flags */
123f196ce38SLuigi Rizzo int netmap_copy = 0;	/* debugging, copy content */
124f196ce38SLuigi Rizzo 
125f196ce38SLuigi Rizzo SYSCTL_INT(_dev_netmap, OID_AUTO, drop, CTLFLAG_RW, &netmap_drop, 0 , "");
126f196ce38SLuigi Rizzo SYSCTL_INT(_dev_netmap, OID_AUTO, flags, CTLFLAG_RW, &netmap_flags, 0 , "");
127f196ce38SLuigi Rizzo SYSCTL_INT(_dev_netmap, OID_AUTO, copy, CTLFLAG_RW, &netmap_copy, 0 , "");
128f196ce38SLuigi Rizzo 
129f196ce38SLuigi Rizzo #ifdef NM_BRIDGE /* support for netmap bridge */
130f196ce38SLuigi Rizzo 
131f196ce38SLuigi Rizzo /*
132f196ce38SLuigi Rizzo  * system parameters.
133f196ce38SLuigi Rizzo  *
134f196ce38SLuigi Rizzo  * All switched ports have prefix NM_NAME.
135f196ce38SLuigi Rizzo  * The switch has a max of NM_BDG_MAXPORTS ports (often stored in a bitmap,
136f196ce38SLuigi Rizzo  * so a practical upper bound is 64).
137f196ce38SLuigi Rizzo  * Each tx ring is read-write, whereas rx rings are readonly (XXX not done yet).
138f196ce38SLuigi Rizzo  * The virtual interfaces use per-queue lock instead of core lock.
139f196ce38SLuigi Rizzo  * In the tx loop, we aggregate traffic in batches to make all operations
140f196ce38SLuigi Rizzo  * faster. The batch size is NM_BDG_BATCH
141f196ce38SLuigi Rizzo  */
142f196ce38SLuigi Rizzo #define	NM_NAME			"vale"	/* prefix for the interface */
143f196ce38SLuigi Rizzo #define NM_BDG_MAXPORTS		16	/* up to 64 ? */
144f196ce38SLuigi Rizzo #define NM_BRIDGE_RINGSIZE	1024	/* in the device */
145f196ce38SLuigi Rizzo #define NM_BDG_HASH		1024	/* forwarding table entries */
146f196ce38SLuigi Rizzo #define NM_BDG_BATCH		1024	/* entries in the forwarding buffer */
147f196ce38SLuigi Rizzo #define	NM_BRIDGES		4	/* number of bridges */
148f196ce38SLuigi Rizzo int netmap_bridge = NM_BDG_BATCH; /* bridge batch size */
149f196ce38SLuigi Rizzo SYSCTL_INT(_dev_netmap, OID_AUTO, bridge, CTLFLAG_RW, &netmap_bridge, 0 , "");
15001c7d25fSLuigi Rizzo 
151f196ce38SLuigi Rizzo #ifdef linux
152f196ce38SLuigi Rizzo #define	ADD_BDG_REF(ifp)	(NA(ifp)->if_refcount++)
153f196ce38SLuigi Rizzo #define	DROP_BDG_REF(ifp)	(NA(ifp)->if_refcount-- <= 1)
154f196ce38SLuigi Rizzo #else /* !linux */
155f196ce38SLuigi Rizzo #define	ADD_BDG_REF(ifp)	(ifp)->if_refcount++
156f196ce38SLuigi Rizzo #define	DROP_BDG_REF(ifp)	refcount_release(&(ifp)->if_refcount)
157f196ce38SLuigi Rizzo #ifdef __FreeBSD__
158f196ce38SLuigi Rizzo #include <sys/endian.h>
159f196ce38SLuigi Rizzo #include <sys/refcount.h>
160f196ce38SLuigi Rizzo #endif /* __FreeBSD__ */
16101c7d25fSLuigi Rizzo #define prefetch(x)	__builtin_prefetch(x)
162f196ce38SLuigi Rizzo #endif /* !linux */
163f196ce38SLuigi Rizzo 
164f196ce38SLuigi Rizzo static void bdg_netmap_attach(struct ifnet *ifp);
165f196ce38SLuigi Rizzo static int bdg_netmap_reg(struct ifnet *ifp, int onoff);
166f196ce38SLuigi Rizzo /* per-tx-queue entry */
167f196ce38SLuigi Rizzo struct nm_bdg_fwd {	/* forwarding entry for a bridge */
168f196ce38SLuigi Rizzo 	void *buf;
169f196ce38SLuigi Rizzo 	uint64_t dst;	/* dst mask */
170f196ce38SLuigi Rizzo 	uint32_t src;	/* src index ? */
171f196ce38SLuigi Rizzo 	uint16_t len;	/* src len */
172f196ce38SLuigi Rizzo };
173f196ce38SLuigi Rizzo 
174f196ce38SLuigi Rizzo struct nm_hash_ent {
175f196ce38SLuigi Rizzo 	uint64_t	mac;	/* the top 2 bytes are the epoch */
176f196ce38SLuigi Rizzo 	uint64_t	ports;
177f196ce38SLuigi Rizzo };
178f196ce38SLuigi Rizzo 
179f196ce38SLuigi Rizzo /*
180f196ce38SLuigi Rizzo  * Interfaces for a bridge are all in ports[].
181f196ce38SLuigi Rizzo  * The array has fixed size, an empty entry does not terminate
182f196ce38SLuigi Rizzo  * the search.
183f196ce38SLuigi Rizzo  */
184f196ce38SLuigi Rizzo struct nm_bridge {
185f196ce38SLuigi Rizzo 	struct ifnet *bdg_ports[NM_BDG_MAXPORTS];
186f196ce38SLuigi Rizzo 	int n_ports;
187f196ce38SLuigi Rizzo 	uint64_t act_ports;
188f196ce38SLuigi Rizzo 	int freelist;	/* first buffer index */
189f196ce38SLuigi Rizzo 	NM_SELINFO_T si;	/* poll/select wait queue */
190f196ce38SLuigi Rizzo 	NM_LOCK_T bdg_lock;	/* protect the selinfo ? */
191f196ce38SLuigi Rizzo 
192f196ce38SLuigi Rizzo 	/* the forwarding table, MAC+ports */
193f196ce38SLuigi Rizzo 	struct nm_hash_ent ht[NM_BDG_HASH];
194f196ce38SLuigi Rizzo 
195f196ce38SLuigi Rizzo 	int namelen;	/* 0 means free */
196f196ce38SLuigi Rizzo 	char basename[IFNAMSIZ];
197f196ce38SLuigi Rizzo };
198f196ce38SLuigi Rizzo 
199f196ce38SLuigi Rizzo struct nm_bridge nm_bridges[NM_BRIDGES];
200f196ce38SLuigi Rizzo 
201f196ce38SLuigi Rizzo #define BDG_LOCK(b)	mtx_lock(&(b)->bdg_lock)
202f196ce38SLuigi Rizzo #define BDG_UNLOCK(b)	mtx_unlock(&(b)->bdg_lock)
203f196ce38SLuigi Rizzo 
204f196ce38SLuigi Rizzo /*
205f196ce38SLuigi Rizzo  * NA(ifp)->bdg_port	port index
206f196ce38SLuigi Rizzo  */
207f196ce38SLuigi Rizzo 
208f196ce38SLuigi Rizzo // XXX only for multiples of 64 bytes, non overlapped.
209f196ce38SLuigi Rizzo static inline void
210f196ce38SLuigi Rizzo pkt_copy(void *_src, void *_dst, int l)
211f196ce38SLuigi Rizzo {
212f196ce38SLuigi Rizzo         uint64_t *src = _src;
213f196ce38SLuigi Rizzo         uint64_t *dst = _dst;
214f196ce38SLuigi Rizzo         if (unlikely(l >= 1024)) {
215f196ce38SLuigi Rizzo                 bcopy(src, dst, l);
216f196ce38SLuigi Rizzo                 return;
217f196ce38SLuigi Rizzo         }
218f196ce38SLuigi Rizzo         for (; likely(l > 0); l-=64) {
219f196ce38SLuigi Rizzo                 *dst++ = *src++;
220f196ce38SLuigi Rizzo                 *dst++ = *src++;
221f196ce38SLuigi Rizzo                 *dst++ = *src++;
222f196ce38SLuigi Rizzo                 *dst++ = *src++;
223f196ce38SLuigi Rizzo                 *dst++ = *src++;
224f196ce38SLuigi Rizzo                 *dst++ = *src++;
225f196ce38SLuigi Rizzo                 *dst++ = *src++;
226f196ce38SLuigi Rizzo                 *dst++ = *src++;
227f196ce38SLuigi Rizzo         }
228f196ce38SLuigi Rizzo }
229f196ce38SLuigi Rizzo 
230f196ce38SLuigi Rizzo /*
231f196ce38SLuigi Rizzo  * locate a bridge among the existing ones.
232f196ce38SLuigi Rizzo  * a ':' in the name terminates the bridge name. Otherwise, just NM_NAME.
233f196ce38SLuigi Rizzo  * We assume that this is called with a name of at least NM_NAME chars.
234f196ce38SLuigi Rizzo  */
235f196ce38SLuigi Rizzo static struct nm_bridge *
236f196ce38SLuigi Rizzo nm_find_bridge(const char *name)
237f196ce38SLuigi Rizzo {
238f196ce38SLuigi Rizzo 	int i, l, namelen, e;
239f196ce38SLuigi Rizzo 	struct nm_bridge *b = NULL;
240f196ce38SLuigi Rizzo 
241f196ce38SLuigi Rizzo 	namelen = strlen(NM_NAME);	/* base length */
242f196ce38SLuigi Rizzo 	l = strlen(name);		/* actual length */
243f196ce38SLuigi Rizzo 	for (i = namelen + 1; i < l; i++) {
244f196ce38SLuigi Rizzo 		if (name[i] == ':') {
245f196ce38SLuigi Rizzo 			namelen = i;
246f196ce38SLuigi Rizzo 			break;
247f196ce38SLuigi Rizzo 		}
248f196ce38SLuigi Rizzo 	}
249f196ce38SLuigi Rizzo 	if (namelen >= IFNAMSIZ)
250f196ce38SLuigi Rizzo 		namelen = IFNAMSIZ;
251f196ce38SLuigi Rizzo 	ND("--- prefix is '%.*s' ---", namelen, name);
252f196ce38SLuigi Rizzo 
253f196ce38SLuigi Rizzo 	/* use the first entry for locking */
254f196ce38SLuigi Rizzo 	BDG_LOCK(nm_bridges); // XXX do better
255f196ce38SLuigi Rizzo 	for (e = -1, i = 1; i < NM_BRIDGES; i++) {
256f196ce38SLuigi Rizzo 		b = nm_bridges + i;
257f196ce38SLuigi Rizzo 		if (b->namelen == 0)
258f196ce38SLuigi Rizzo 			e = i;	/* record empty slot */
259f196ce38SLuigi Rizzo 		else if (strncmp(name, b->basename, namelen) == 0) {
260f196ce38SLuigi Rizzo 			ND("found '%.*s' at %d", namelen, name, i);
261f196ce38SLuigi Rizzo 			break;
262f196ce38SLuigi Rizzo 		}
263f196ce38SLuigi Rizzo 	}
264f196ce38SLuigi Rizzo 	if (i == NM_BRIDGES) { /* all full */
265f196ce38SLuigi Rizzo 		if (e == -1) { /* no empty slot */
266f196ce38SLuigi Rizzo 			b = NULL;
267f196ce38SLuigi Rizzo 		} else {
268f196ce38SLuigi Rizzo 			b = nm_bridges + e;
269f196ce38SLuigi Rizzo 			strncpy(b->basename, name, namelen);
270f196ce38SLuigi Rizzo 			b->namelen = namelen;
271f196ce38SLuigi Rizzo 		}
272f196ce38SLuigi Rizzo 	}
273f196ce38SLuigi Rizzo 	BDG_UNLOCK(nm_bridges);
274f196ce38SLuigi Rizzo 	return b;
275f196ce38SLuigi Rizzo }
276f196ce38SLuigi Rizzo #endif /* NM_BRIDGE */
2775819da83SLuigi Rizzo 
278*ae10d1afSLuigi Rizzo 
279*ae10d1afSLuigi Rizzo /*
280*ae10d1afSLuigi Rizzo  * Fetch configuration from the device, to cope with dynamic
281*ae10d1afSLuigi Rizzo  * reconfigurations after loading the module.
282*ae10d1afSLuigi Rizzo  */
283*ae10d1afSLuigi Rizzo static int
284*ae10d1afSLuigi Rizzo netmap_update_config(struct netmap_adapter *na)
285*ae10d1afSLuigi Rizzo {
286*ae10d1afSLuigi Rizzo 	struct ifnet *ifp = na->ifp;
287*ae10d1afSLuigi Rizzo 	u_int txr, txd, rxr, rxd;
288*ae10d1afSLuigi Rizzo 
289*ae10d1afSLuigi Rizzo 	txr = txd = rxr = rxd = 0;
290*ae10d1afSLuigi Rizzo 	if (na->nm_config) {
291*ae10d1afSLuigi Rizzo 		na->nm_config(ifp, &txr, &txd, &rxr, &rxd);
292*ae10d1afSLuigi Rizzo 	} else {
293*ae10d1afSLuigi Rizzo 		/* take whatever we had at init time */
294*ae10d1afSLuigi Rizzo 		txr = na->num_tx_rings;
295*ae10d1afSLuigi Rizzo 		txd = na->num_tx_desc;
296*ae10d1afSLuigi Rizzo 		rxr = na->num_rx_rings;
297*ae10d1afSLuigi Rizzo 		rxd = na->num_rx_desc;
298*ae10d1afSLuigi Rizzo 	}
299*ae10d1afSLuigi Rizzo 
300*ae10d1afSLuigi Rizzo 	if (na->num_tx_rings == txr && na->num_tx_desc == txd &&
301*ae10d1afSLuigi Rizzo 	    na->num_rx_rings == rxr && na->num_rx_desc == rxd)
302*ae10d1afSLuigi Rizzo 		return 0; /* nothing changed */
303*ae10d1afSLuigi Rizzo 	if (netmap_verbose || na->refcount > 0) {
304*ae10d1afSLuigi Rizzo 		D("stored config %s: txring %d x %d, rxring %d x %d",
305*ae10d1afSLuigi Rizzo 			ifp->if_xname,
306*ae10d1afSLuigi Rizzo 			na->num_tx_rings, na->num_tx_desc,
307*ae10d1afSLuigi Rizzo 			na->num_rx_rings, na->num_rx_desc);
308*ae10d1afSLuigi Rizzo 		D("new config %s: txring %d x %d, rxring %d x %d",
309*ae10d1afSLuigi Rizzo 			ifp->if_xname, txr, txd, rxr, rxd);
310*ae10d1afSLuigi Rizzo 	}
311*ae10d1afSLuigi Rizzo 	if (na->refcount == 0) {
312*ae10d1afSLuigi Rizzo 		D("configuration changed (but fine)");
313*ae10d1afSLuigi Rizzo 		na->num_tx_rings = txr;
314*ae10d1afSLuigi Rizzo 		na->num_tx_desc = txd;
315*ae10d1afSLuigi Rizzo 		na->num_rx_rings = rxr;
316*ae10d1afSLuigi Rizzo 		na->num_rx_desc = rxd;
317*ae10d1afSLuigi Rizzo 		return 0;
318*ae10d1afSLuigi Rizzo 	}
319*ae10d1afSLuigi Rizzo 	D("configuration changed while active, this is bad...");
320*ae10d1afSLuigi Rizzo 	return 1;
321*ae10d1afSLuigi Rizzo }
322*ae10d1afSLuigi Rizzo 
3233c0caf6cSLuigi Rizzo /*------------- memory allocator -----------------*/
3243c0caf6cSLuigi Rizzo #ifdef NETMAP_MEM2
3253c0caf6cSLuigi Rizzo #include "netmap_mem2.c"
3263c0caf6cSLuigi Rizzo #else /* !NETMAP_MEM2 */
3273c0caf6cSLuigi Rizzo #include "netmap_mem1.c"
3283c0caf6cSLuigi Rizzo #endif /* !NETMAP_MEM2 */
3293c0caf6cSLuigi Rizzo /*------------ end of memory allocator ----------*/
33068b8534bSLuigi Rizzo 
3318241616dSLuigi Rizzo 
3328241616dSLuigi Rizzo /* Structure associated to each thread which registered an interface.
3338241616dSLuigi Rizzo  *
3348241616dSLuigi Rizzo  * The first 4 fields of this structure are written by NIOCREGIF and
3358241616dSLuigi Rizzo  * read by poll() and NIOC?XSYNC.
3368241616dSLuigi Rizzo  * There is low contention among writers (actually, a correct user program
3378241616dSLuigi Rizzo  * should have no contention among writers) and among writers and readers,
3388241616dSLuigi Rizzo  * so we use a single global lock to protect the structure initialization.
3398241616dSLuigi Rizzo  * Since initialization involves the allocation of memory, we reuse the memory
3408241616dSLuigi Rizzo  * allocator lock.
3418241616dSLuigi Rizzo  * Read access to the structure is lock free. Readers must check that
3428241616dSLuigi Rizzo  * np_nifp is not NULL before using the other fields.
3438241616dSLuigi Rizzo  * If np_nifp is NULL initialization has not been performed, so they should
3448241616dSLuigi Rizzo  * return an error to userlevel.
3458241616dSLuigi Rizzo  *
3468241616dSLuigi Rizzo  * The ref_done field is used to regulate access to the refcount in the
3478241616dSLuigi Rizzo  * memory allocator. The refcount must be incremented at most once for
3488241616dSLuigi Rizzo  * each open("/dev/netmap"). The increment is performed by the first
3498241616dSLuigi Rizzo  * function that calls netmap_get_memory() (currently called by
3508241616dSLuigi Rizzo  * mmap(), NIOCGINFO and NIOCREGIF).
3518241616dSLuigi Rizzo  * If the refcount is incremented, it is then decremented when the
3528241616dSLuigi Rizzo  * private structure is destroyed.
3538241616dSLuigi Rizzo  */
35468b8534bSLuigi Rizzo struct netmap_priv_d {
3558241616dSLuigi Rizzo 	struct netmap_if * volatile np_nifp;	/* netmap interface descriptor. */
35668b8534bSLuigi Rizzo 
35768b8534bSLuigi Rizzo 	struct ifnet	*np_ifp;	/* device for which we hold a reference */
35868b8534bSLuigi Rizzo 	int		np_ringid;	/* from the ioctl */
35968b8534bSLuigi Rizzo 	u_int		np_qfirst, np_qlast;	/* range of rings to scan */
36068b8534bSLuigi Rizzo 	uint16_t	np_txpoll;
3618241616dSLuigi Rizzo 
3628241616dSLuigi Rizzo 	unsigned long	ref_done;	/* use with NMA_LOCK held */
36368b8534bSLuigi Rizzo };
36468b8534bSLuigi Rizzo 
36568b8534bSLuigi Rizzo 
3668241616dSLuigi Rizzo static int
3678241616dSLuigi Rizzo netmap_get_memory(struct netmap_priv_d* p)
3688241616dSLuigi Rizzo {
3698241616dSLuigi Rizzo 	int error = 0;
3708241616dSLuigi Rizzo 	NMA_LOCK();
3718241616dSLuigi Rizzo 	if (!p->ref_done) {
3728241616dSLuigi Rizzo 		error = netmap_memory_finalize();
3738241616dSLuigi Rizzo 		if (!error)
3748241616dSLuigi Rizzo 			p->ref_done = 1;
3758241616dSLuigi Rizzo 	}
3768241616dSLuigi Rizzo 	NMA_UNLOCK();
3778241616dSLuigi Rizzo 	return error;
3788241616dSLuigi Rizzo }
3798241616dSLuigi Rizzo 
38068b8534bSLuigi Rizzo /*
38168b8534bSLuigi Rizzo  * File descriptor's private data destructor.
38268b8534bSLuigi Rizzo  *
38368b8534bSLuigi Rizzo  * Call nm_register(ifp,0) to stop netmap mode on the interface and
38468b8534bSLuigi Rizzo  * revert to normal operation. We expect that np_ifp has not gone.
38568b8534bSLuigi Rizzo  */
3868241616dSLuigi Rizzo /* call with NMA_LOCK held */
38768b8534bSLuigi Rizzo static void
3885819da83SLuigi Rizzo netmap_dtor_locked(void *data)
38968b8534bSLuigi Rizzo {
39068b8534bSLuigi Rizzo 	struct netmap_priv_d *priv = data;
39168b8534bSLuigi Rizzo 	struct ifnet *ifp = priv->np_ifp;
39268b8534bSLuigi Rizzo 	struct netmap_adapter *na = NA(ifp);
39368b8534bSLuigi Rizzo 	struct netmap_if *nifp = priv->np_nifp;
39468b8534bSLuigi Rizzo 
39568b8534bSLuigi Rizzo 	na->refcount--;
39668b8534bSLuigi Rizzo 	if (na->refcount <= 0) {	/* last instance */
39764ae02c3SLuigi Rizzo 		u_int i, j, lim;
39868b8534bSLuigi Rizzo 
399*ae10d1afSLuigi Rizzo 		if (netmap_verbose)
400*ae10d1afSLuigi Rizzo 			D("deleting last instance for %s", ifp->if_xname);
40168b8534bSLuigi Rizzo 		/*
40268b8534bSLuigi Rizzo 		 * there is a race here with *_netmap_task() and
4031a26580eSLuigi Rizzo 		 * netmap_poll(), which don't run under NETMAP_REG_LOCK.
40468b8534bSLuigi Rizzo 		 * na->refcount == 0 && na->ifp->if_capenable & IFCAP_NETMAP
40568b8534bSLuigi Rizzo 		 * (aka NETMAP_DELETING(na)) are a unique marker that the
40668b8534bSLuigi Rizzo 		 * device is dying.
40768b8534bSLuigi Rizzo 		 * Before destroying stuff we sleep a bit, and then complete
40868b8534bSLuigi Rizzo 		 * the job. NIOCREG should realize the condition and
40968b8534bSLuigi Rizzo 		 * loop until they can continue; the other routines
41068b8534bSLuigi Rizzo 		 * should check the condition at entry and quit if
41168b8534bSLuigi Rizzo 		 * they cannot run.
41268b8534bSLuigi Rizzo 		 */
4131a26580eSLuigi Rizzo 		na->nm_lock(ifp, NETMAP_REG_UNLOCK, 0);
41468b8534bSLuigi Rizzo 		tsleep(na, 0, "NIOCUNREG", 4);
4151a26580eSLuigi Rizzo 		na->nm_lock(ifp, NETMAP_REG_LOCK, 0);
41668b8534bSLuigi Rizzo 		na->nm_register(ifp, 0); /* off, clear IFCAP_NETMAP */
41768b8534bSLuigi Rizzo 		/* Wake up any sleeping threads. netmap_poll will
41868b8534bSLuigi Rizzo 		 * then return POLLERR
41968b8534bSLuigi Rizzo 		 */
420d76bf4ffSLuigi Rizzo 		for (i = 0; i < na->num_tx_rings + 1; i++)
42168b8534bSLuigi Rizzo 			selwakeuppri(&na->tx_rings[i].si, PI_NET);
422d76bf4ffSLuigi Rizzo 		for (i = 0; i < na->num_rx_rings + 1; i++)
42368b8534bSLuigi Rizzo 			selwakeuppri(&na->rx_rings[i].si, PI_NET);
42464ae02c3SLuigi Rizzo 		selwakeuppri(&na->tx_si, PI_NET);
42564ae02c3SLuigi Rizzo 		selwakeuppri(&na->rx_si, PI_NET);
42668b8534bSLuigi Rizzo 		/* release all buffers */
427d76bf4ffSLuigi Rizzo 		for (i = 0; i < na->num_tx_rings + 1; i++) {
42864ae02c3SLuigi Rizzo 			struct netmap_ring *ring = na->tx_rings[i].ring;
42968b8534bSLuigi Rizzo 			lim = na->tx_rings[i].nkr_num_slots;
43068b8534bSLuigi Rizzo 			for (j = 0; j < lim; j++)
431446ee301SLuigi Rizzo 				netmap_free_buf(nifp, ring->slot[j].buf_idx);
4322f70fca5SEd Maste 			/* knlist_destroy(&na->tx_rings[i].si.si_note); */
4332f70fca5SEd Maste 			mtx_destroy(&na->tx_rings[i].q_lock);
43464ae02c3SLuigi Rizzo 		}
435d76bf4ffSLuigi Rizzo 		for (i = 0; i < na->num_rx_rings + 1; i++) {
43664ae02c3SLuigi Rizzo 			struct netmap_ring *ring = na->rx_rings[i].ring;
43768b8534bSLuigi Rizzo 			lim = na->rx_rings[i].nkr_num_slots;
43868b8534bSLuigi Rizzo 			for (j = 0; j < lim; j++)
439446ee301SLuigi Rizzo 				netmap_free_buf(nifp, ring->slot[j].buf_idx);
4402f70fca5SEd Maste 			/* knlist_destroy(&na->rx_rings[i].si.si_note); */
4412f70fca5SEd Maste 			mtx_destroy(&na->rx_rings[i].q_lock);
44268b8534bSLuigi Rizzo 		}
4432f70fca5SEd Maste 		/* XXX kqueue(9) needed; these will mirror knlist_init. */
4442f70fca5SEd Maste 		/* knlist_destroy(&na->tx_si.si_note); */
4452f70fca5SEd Maste 		/* knlist_destroy(&na->rx_si.si_note); */
4466e10c8b8SLuigi Rizzo 		netmap_free_rings(na);
44768b8534bSLuigi Rizzo 		wakeup(na);
44868b8534bSLuigi Rizzo 	}
4496e10c8b8SLuigi Rizzo 	netmap_if_free(nifp);
4505819da83SLuigi Rizzo }
45168b8534bSLuigi Rizzo 
452f196ce38SLuigi Rizzo static void
453f196ce38SLuigi Rizzo nm_if_rele(struct ifnet *ifp)
454f196ce38SLuigi Rizzo {
455f196ce38SLuigi Rizzo #ifndef NM_BRIDGE
456f196ce38SLuigi Rizzo 	if_rele(ifp);
457f196ce38SLuigi Rizzo #else /* NM_BRIDGE */
458f196ce38SLuigi Rizzo 	int i, full;
459f196ce38SLuigi Rizzo 	struct nm_bridge *b;
460f196ce38SLuigi Rizzo 
461f196ce38SLuigi Rizzo 	if (strncmp(ifp->if_xname, NM_NAME, sizeof(NM_NAME) - 1)) {
462f196ce38SLuigi Rizzo 		if_rele(ifp);
463f196ce38SLuigi Rizzo 		return;
464f196ce38SLuigi Rizzo 	}
465f196ce38SLuigi Rizzo 	if (!DROP_BDG_REF(ifp))
466f196ce38SLuigi Rizzo 		return;
467f196ce38SLuigi Rizzo 	b = ifp->if_bridge;
468f196ce38SLuigi Rizzo 	BDG_LOCK(nm_bridges);
469f196ce38SLuigi Rizzo 	BDG_LOCK(b);
470f196ce38SLuigi Rizzo 	ND("want to disconnect %s from the bridge", ifp->if_xname);
471f196ce38SLuigi Rizzo 	full = 0;
472f196ce38SLuigi Rizzo 	for (i = 0; i < NM_BDG_MAXPORTS; i++) {
473f196ce38SLuigi Rizzo 		if (b->bdg_ports[i] == ifp) {
474f196ce38SLuigi Rizzo 			b->bdg_ports[i] = NULL;
475f196ce38SLuigi Rizzo 			bzero(ifp, sizeof(*ifp));
476f196ce38SLuigi Rizzo 			free(ifp, M_DEVBUF);
477f196ce38SLuigi Rizzo 			break;
478f196ce38SLuigi Rizzo 		}
479f196ce38SLuigi Rizzo 		else if (b->bdg_ports[i] != NULL)
480f196ce38SLuigi Rizzo 			full = 1;
481f196ce38SLuigi Rizzo 	}
482f196ce38SLuigi Rizzo 	BDG_UNLOCK(b);
483f196ce38SLuigi Rizzo 	if (full == 0) {
484f196ce38SLuigi Rizzo 		ND("freeing bridge %d", b - nm_bridges);
485f196ce38SLuigi Rizzo 		b->namelen = 0;
486f196ce38SLuigi Rizzo 	}
487f196ce38SLuigi Rizzo 	BDG_UNLOCK(nm_bridges);
488f196ce38SLuigi Rizzo 	if (i == NM_BDG_MAXPORTS)
489f196ce38SLuigi Rizzo 		D("ouch, cannot find ifp to remove");
490f196ce38SLuigi Rizzo #endif /* NM_BRIDGE */
491f196ce38SLuigi Rizzo }
4925819da83SLuigi Rizzo 
4935819da83SLuigi Rizzo static void
4945819da83SLuigi Rizzo netmap_dtor(void *data)
4955819da83SLuigi Rizzo {
4965819da83SLuigi Rizzo 	struct netmap_priv_d *priv = data;
4975819da83SLuigi Rizzo 	struct ifnet *ifp = priv->np_ifp;
4988241616dSLuigi Rizzo 	struct netmap_adapter *na;
4995819da83SLuigi Rizzo 
5008241616dSLuigi Rizzo 	NMA_LOCK();
5018241616dSLuigi Rizzo 	if (ifp) {
5028241616dSLuigi Rizzo 		na = NA(ifp);
5031a26580eSLuigi Rizzo 		na->nm_lock(ifp, NETMAP_REG_LOCK, 0);
5045819da83SLuigi Rizzo 		netmap_dtor_locked(data);
5051a26580eSLuigi Rizzo 		na->nm_lock(ifp, NETMAP_REG_UNLOCK, 0);
50668b8534bSLuigi Rizzo 
507f196ce38SLuigi Rizzo 		nm_if_rele(ifp);
5088241616dSLuigi Rizzo 	}
5098241616dSLuigi Rizzo 	if (priv->ref_done) {
5108241616dSLuigi Rizzo 		netmap_memory_deref();
5118241616dSLuigi Rizzo 	}
5128241616dSLuigi Rizzo 	NMA_UNLOCK();
51368b8534bSLuigi Rizzo 	bzero(priv, sizeof(*priv));	/* XXX for safety */
51468b8534bSLuigi Rizzo 	free(priv, M_DEVBUF);
51568b8534bSLuigi Rizzo }
51668b8534bSLuigi Rizzo 
5178241616dSLuigi Rizzo #ifdef __FreeBSD__
5188241616dSLuigi Rizzo #include <vm/vm.h>
5198241616dSLuigi Rizzo #include <vm/vm_param.h>
5208241616dSLuigi Rizzo #include <vm/vm_object.h>
5218241616dSLuigi Rizzo #include <vm/vm_page.h>
5228241616dSLuigi Rizzo #include <vm/vm_pager.h>
5238241616dSLuigi Rizzo #include <vm/uma.h>
5248241616dSLuigi Rizzo 
5258241616dSLuigi Rizzo static struct cdev_pager_ops saved_cdev_pager_ops;
5268241616dSLuigi Rizzo 
5278241616dSLuigi Rizzo static int
5288241616dSLuigi Rizzo netmap_dev_pager_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot,
5298241616dSLuigi Rizzo     vm_ooffset_t foff, struct ucred *cred, u_short *color)
5308241616dSLuigi Rizzo {
531*ae10d1afSLuigi Rizzo 	if (netmap_verbose)
5328241616dSLuigi Rizzo 		D("first mmap for %p", handle);
5338241616dSLuigi Rizzo 	return saved_cdev_pager_ops.cdev_pg_ctor(handle,
5348241616dSLuigi Rizzo 			size, prot, foff, cred, color);
5358241616dSLuigi Rizzo }
5368241616dSLuigi Rizzo 
5378241616dSLuigi Rizzo static void
5388241616dSLuigi Rizzo netmap_dev_pager_dtor(void *handle)
5398241616dSLuigi Rizzo {
5408241616dSLuigi Rizzo 	saved_cdev_pager_ops.cdev_pg_dtor(handle);
541*ae10d1afSLuigi Rizzo 	ND("ready to release memory for %p", handle);
5428241616dSLuigi Rizzo }
5438241616dSLuigi Rizzo 
5448241616dSLuigi Rizzo 
5458241616dSLuigi Rizzo static struct cdev_pager_ops netmap_cdev_pager_ops = {
5468241616dSLuigi Rizzo         .cdev_pg_ctor = netmap_dev_pager_ctor,
5478241616dSLuigi Rizzo         .cdev_pg_dtor = netmap_dev_pager_dtor,
5488241616dSLuigi Rizzo         .cdev_pg_fault = NULL,
5498241616dSLuigi Rizzo };
5508241616dSLuigi Rizzo 
5518241616dSLuigi Rizzo static int
5528241616dSLuigi Rizzo netmap_mmap_single(struct cdev *cdev, vm_ooffset_t *foff,
5538241616dSLuigi Rizzo 	vm_size_t objsize,  vm_object_t *objp, int prot)
5548241616dSLuigi Rizzo {
5558241616dSLuigi Rizzo 	vm_object_t obj;
5568241616dSLuigi Rizzo 
557*ae10d1afSLuigi Rizzo 	ND("cdev %p foff %jd size %jd objp %p prot %d", cdev,
55888f79057SGleb Smirnoff 	    (intmax_t )*foff, (intmax_t )objsize, objp, prot);
5598241616dSLuigi Rizzo 	obj = vm_pager_allocate(OBJT_DEVICE, cdev, objsize, prot, *foff,
5608241616dSLuigi Rizzo             curthread->td_ucred);
5618241616dSLuigi Rizzo 	ND("returns obj %p", obj);
5628241616dSLuigi Rizzo 	if (obj == NULL)
5638241616dSLuigi Rizzo 		return EINVAL;
5648241616dSLuigi Rizzo 	if (saved_cdev_pager_ops.cdev_pg_fault == NULL) {
565*ae10d1afSLuigi Rizzo 		ND("initialize cdev_pager_ops");
5668241616dSLuigi Rizzo 		saved_cdev_pager_ops = *(obj->un_pager.devp.ops);
5678241616dSLuigi Rizzo 		netmap_cdev_pager_ops.cdev_pg_fault =
5688241616dSLuigi Rizzo 			saved_cdev_pager_ops.cdev_pg_fault;
5698241616dSLuigi Rizzo 	};
5708241616dSLuigi Rizzo 	obj->un_pager.devp.ops = &netmap_cdev_pager_ops;
5718241616dSLuigi Rizzo 	*objp = obj;
5728241616dSLuigi Rizzo 	return 0;
5738241616dSLuigi Rizzo }
5748241616dSLuigi Rizzo #endif /* __FreeBSD__ */
5758241616dSLuigi Rizzo 
57668b8534bSLuigi Rizzo 
57768b8534bSLuigi Rizzo /*
57868b8534bSLuigi Rizzo  * mmap(2) support for the "netmap" device.
57968b8534bSLuigi Rizzo  *
58068b8534bSLuigi Rizzo  * Expose all the memory previously allocated by our custom memory
58168b8534bSLuigi Rizzo  * allocator: this way the user has only to issue a single mmap(2), and
58268b8534bSLuigi Rizzo  * can work on all the data structures flawlessly.
58368b8534bSLuigi Rizzo  *
58468b8534bSLuigi Rizzo  * Return 0 on success, -1 otherwise.
58568b8534bSLuigi Rizzo  */
586babc7c12SLuigi Rizzo 
587f196ce38SLuigi Rizzo #ifdef __FreeBSD__
58868b8534bSLuigi Rizzo static int
589babc7c12SLuigi Rizzo netmap_mmap(__unused struct cdev *dev,
59068b8534bSLuigi Rizzo #if __FreeBSD_version < 900000
591babc7c12SLuigi Rizzo 		vm_offset_t offset, vm_paddr_t *paddr, int nprot
59268b8534bSLuigi Rizzo #else
593babc7c12SLuigi Rizzo 		vm_ooffset_t offset, vm_paddr_t *paddr, int nprot,
594babc7c12SLuigi Rizzo 		__unused vm_memattr_t *memattr
59568b8534bSLuigi Rizzo #endif
596babc7c12SLuigi Rizzo 	)
59768b8534bSLuigi Rizzo {
5988241616dSLuigi Rizzo 	int error = 0;
5998241616dSLuigi Rizzo 	struct netmap_priv_d *priv;
6008241616dSLuigi Rizzo 
60168b8534bSLuigi Rizzo 	if (nprot & PROT_EXEC)
60268b8534bSLuigi Rizzo 		return (-1);	// XXX -1 or EINVAL ?
603446ee301SLuigi Rizzo 
6048241616dSLuigi Rizzo 	error = devfs_get_cdevpriv((void **)&priv);
6058241616dSLuigi Rizzo 	if (error == EBADF) {	/* called on fault, memory is initialized */
6068241616dSLuigi Rizzo 		ND(5, "handling fault at ofs 0x%x", offset);
6078241616dSLuigi Rizzo 		error = 0;
6088241616dSLuigi Rizzo 	} else if (error == 0)	/* make sure memory is set */
6098241616dSLuigi Rizzo 		error = netmap_get_memory(priv);
6108241616dSLuigi Rizzo 	if (error)
6118241616dSLuigi Rizzo 		return (error);
6128241616dSLuigi Rizzo 
61368b8534bSLuigi Rizzo 	ND("request for offset 0x%x", (uint32_t)offset);
614446ee301SLuigi Rizzo 	*paddr = netmap_ofstophys(offset);
61568b8534bSLuigi Rizzo 
6168241616dSLuigi Rizzo 	return (*paddr ? 0 : ENOMEM);
6178241616dSLuigi Rizzo }
6188241616dSLuigi Rizzo 
6198241616dSLuigi Rizzo static int
6208241616dSLuigi Rizzo netmap_close(struct cdev *dev, int fflag, int devtype, struct thread *td)
6218241616dSLuigi Rizzo {
622*ae10d1afSLuigi Rizzo 	if (netmap_verbose)
623*ae10d1afSLuigi Rizzo 		D("dev %p fflag 0x%x devtype %d td %p",
624*ae10d1afSLuigi Rizzo 			dev, fflag, devtype, td);
6258241616dSLuigi Rizzo 	return 0;
6268241616dSLuigi Rizzo }
6278241616dSLuigi Rizzo 
6288241616dSLuigi Rizzo static int
6298241616dSLuigi Rizzo netmap_open(struct cdev *dev, int oflags, int devtype, struct thread *td)
6308241616dSLuigi Rizzo {
6318241616dSLuigi Rizzo 	struct netmap_priv_d *priv;
6328241616dSLuigi Rizzo 	int error;
6338241616dSLuigi Rizzo 
6348241616dSLuigi Rizzo 	priv = malloc(sizeof(struct netmap_priv_d), M_DEVBUF,
6358241616dSLuigi Rizzo 			      M_NOWAIT | M_ZERO);
6368241616dSLuigi Rizzo 	if (priv == NULL)
6378241616dSLuigi Rizzo 		return ENOMEM;
6388241616dSLuigi Rizzo 
6398241616dSLuigi Rizzo 	error = devfs_set_cdevpriv(priv, netmap_dtor);
6408241616dSLuigi Rizzo 	if (error)
6418241616dSLuigi Rizzo 	        return error;
6428241616dSLuigi Rizzo 
6438241616dSLuigi Rizzo 	return 0;
64468b8534bSLuigi Rizzo }
645f196ce38SLuigi Rizzo #endif /* __FreeBSD__ */
64668b8534bSLuigi Rizzo 
64768b8534bSLuigi Rizzo 
64868b8534bSLuigi Rizzo /*
64902ad4083SLuigi Rizzo  * Handlers for synchronization of the queues from/to the host.
65002ad4083SLuigi Rizzo  *
65102ad4083SLuigi Rizzo  * netmap_sync_to_host() passes packets up. We are called from a
65202ad4083SLuigi Rizzo  * system call in user process context, and the only contention
65302ad4083SLuigi Rizzo  * can be among multiple user threads erroneously calling
65402ad4083SLuigi Rizzo  * this routine concurrently. In principle we should not even
65502ad4083SLuigi Rizzo  * need to lock.
65668b8534bSLuigi Rizzo  */
65768b8534bSLuigi Rizzo static void
65868b8534bSLuigi Rizzo netmap_sync_to_host(struct netmap_adapter *na)
65968b8534bSLuigi Rizzo {
660d76bf4ffSLuigi Rizzo 	struct netmap_kring *kring = &na->tx_rings[na->num_tx_rings];
66168b8534bSLuigi Rizzo 	struct netmap_ring *ring = kring->ring;
66268b8534bSLuigi Rizzo 	struct mbuf *head = NULL, *tail = NULL, *m;
66302ad4083SLuigi Rizzo 	u_int k, n, lim = kring->nkr_num_slots - 1;
66468b8534bSLuigi Rizzo 
66502ad4083SLuigi Rizzo 	k = ring->cur;
66602ad4083SLuigi Rizzo 	if (k > lim) {
66702ad4083SLuigi Rizzo 		netmap_ring_reinit(kring);
66802ad4083SLuigi Rizzo 		return;
66902ad4083SLuigi Rizzo 	}
6701a26580eSLuigi Rizzo 	// na->nm_lock(na->ifp, NETMAP_CORE_LOCK, 0);
67168b8534bSLuigi Rizzo 
67268b8534bSLuigi Rizzo 	/* Take packets from hwcur to cur and pass them up.
67368b8534bSLuigi Rizzo 	 * In case of no buffers we give up. At the end of the loop,
67468b8534bSLuigi Rizzo 	 * the queue is drained in all cases.
67568b8534bSLuigi Rizzo 	 */
67602ad4083SLuigi Rizzo 	for (n = kring->nr_hwcur; n != k;) {
67768b8534bSLuigi Rizzo 		struct netmap_slot *slot = &ring->slot[n];
67868b8534bSLuigi Rizzo 
67968b8534bSLuigi Rizzo 		n = (n == lim) ? 0 : n + 1;
68068b8534bSLuigi Rizzo 		if (slot->len < 14 || slot->len > NETMAP_BUF_SIZE) {
68168b8534bSLuigi Rizzo 			D("bad pkt at %d len %d", n, slot->len);
68268b8534bSLuigi Rizzo 			continue;
68368b8534bSLuigi Rizzo 		}
68468b8534bSLuigi Rizzo 		m = m_devget(NMB(slot), slot->len, 0, na->ifp, NULL);
68568b8534bSLuigi Rizzo 
68668b8534bSLuigi Rizzo 		if (m == NULL)
68768b8534bSLuigi Rizzo 			break;
68868b8534bSLuigi Rizzo 		if (tail)
68968b8534bSLuigi Rizzo 			tail->m_nextpkt = m;
69068b8534bSLuigi Rizzo 		else
69168b8534bSLuigi Rizzo 			head = m;
69268b8534bSLuigi Rizzo 		tail = m;
69368b8534bSLuigi Rizzo 		m->m_nextpkt = NULL;
69468b8534bSLuigi Rizzo 	}
69502ad4083SLuigi Rizzo 	kring->nr_hwcur = k;
69668b8534bSLuigi Rizzo 	kring->nr_hwavail = ring->avail = lim;
6971a26580eSLuigi Rizzo 	// na->nm_lock(na->ifp, NETMAP_CORE_UNLOCK, 0);
69868b8534bSLuigi Rizzo 
69968b8534bSLuigi Rizzo 	/* send packets up, outside the lock */
70068b8534bSLuigi Rizzo 	while ((m = head) != NULL) {
70168b8534bSLuigi Rizzo 		head = head->m_nextpkt;
70268b8534bSLuigi Rizzo 		m->m_nextpkt = NULL;
70368b8534bSLuigi Rizzo 		if (netmap_verbose & NM_VERB_HOST)
7041a26580eSLuigi Rizzo 			D("sending up pkt %p size %d", m, MBUF_LEN(m));
7051a26580eSLuigi Rizzo 		NM_SEND_UP(na->ifp, m);
70668b8534bSLuigi Rizzo 	}
70768b8534bSLuigi Rizzo }
70868b8534bSLuigi Rizzo 
70968b8534bSLuigi Rizzo /*
71002ad4083SLuigi Rizzo  * rxsync backend for packets coming from the host stack.
71102ad4083SLuigi Rizzo  * They have been put in the queue by netmap_start() so we
71202ad4083SLuigi Rizzo  * need to protect access to the kring using a lock.
71302ad4083SLuigi Rizzo  *
71468b8534bSLuigi Rizzo  * This routine also does the selrecord if called from the poll handler
71568b8534bSLuigi Rizzo  * (we know because td != NULL).
71601c7d25fSLuigi Rizzo  *
71701c7d25fSLuigi Rizzo  * NOTE: on linux, selrecord() is defined as a macro and uses pwait
71801c7d25fSLuigi Rizzo  *     as an additional hidden argument.
71968b8534bSLuigi Rizzo  */
72068b8534bSLuigi Rizzo static void
72101c7d25fSLuigi Rizzo netmap_sync_from_host(struct netmap_adapter *na, struct thread *td, void *pwait)
72268b8534bSLuigi Rizzo {
723d76bf4ffSLuigi Rizzo 	struct netmap_kring *kring = &na->rx_rings[na->num_rx_rings];
72468b8534bSLuigi Rizzo 	struct netmap_ring *ring = kring->ring;
72564ae02c3SLuigi Rizzo 	u_int j, n, lim = kring->nkr_num_slots;
72664ae02c3SLuigi Rizzo 	u_int k = ring->cur, resvd = ring->reserved;
72768b8534bSLuigi Rizzo 
72801c7d25fSLuigi Rizzo 	(void)pwait;	/* disable unused warnings */
7291a26580eSLuigi Rizzo 	na->nm_lock(na->ifp, NETMAP_CORE_LOCK, 0);
73064ae02c3SLuigi Rizzo 	if (k >= lim) {
73164ae02c3SLuigi Rizzo 		netmap_ring_reinit(kring);
73264ae02c3SLuigi Rizzo 		return;
73364ae02c3SLuigi Rizzo 	}
73464ae02c3SLuigi Rizzo 	/* new packets are already set in nr_hwavail */
73564ae02c3SLuigi Rizzo 	/* skip past packets that userspace has released */
73664ae02c3SLuigi Rizzo 	j = kring->nr_hwcur;
73764ae02c3SLuigi Rizzo 	if (resvd > 0) {
73864ae02c3SLuigi Rizzo 		if (resvd + ring->avail >= lim + 1) {
73964ae02c3SLuigi Rizzo 			D("XXX invalid reserve/avail %d %d", resvd, ring->avail);
74064ae02c3SLuigi Rizzo 			ring->reserved = resvd = 0; // XXX panic...
74164ae02c3SLuigi Rizzo 		}
74264ae02c3SLuigi Rizzo 		k = (k >= resvd) ? k - resvd : k + lim - resvd;
74364ae02c3SLuigi Rizzo         }
74464ae02c3SLuigi Rizzo 	if (j != k) {
74564ae02c3SLuigi Rizzo 		n = k >= j ? k - j : k + lim - j;
74664ae02c3SLuigi Rizzo 		kring->nr_hwavail -= n;
74702ad4083SLuigi Rizzo 		kring->nr_hwcur = k;
74864ae02c3SLuigi Rizzo 	}
74964ae02c3SLuigi Rizzo 	k = ring->avail = kring->nr_hwavail - resvd;
75002ad4083SLuigi Rizzo 	if (k == 0 && td)
75168b8534bSLuigi Rizzo 		selrecord(td, &kring->si);
75202ad4083SLuigi Rizzo 	if (k && (netmap_verbose & NM_VERB_HOST))
75302ad4083SLuigi Rizzo 		D("%d pkts from stack", k);
7541a26580eSLuigi Rizzo 	na->nm_lock(na->ifp, NETMAP_CORE_UNLOCK, 0);
75568b8534bSLuigi Rizzo }
75668b8534bSLuigi Rizzo 
75768b8534bSLuigi Rizzo 
75868b8534bSLuigi Rizzo /*
75968b8534bSLuigi Rizzo  * get a refcounted reference to an interface.
76068b8534bSLuigi Rizzo  * Return ENXIO if the interface does not exist, EINVAL if netmap
76168b8534bSLuigi Rizzo  * is not supported by the interface.
76268b8534bSLuigi Rizzo  * If successful, hold a reference.
76368b8534bSLuigi Rizzo  */
76468b8534bSLuigi Rizzo static int
76568b8534bSLuigi Rizzo get_ifp(const char *name, struct ifnet **ifp)
76668b8534bSLuigi Rizzo {
767f196ce38SLuigi Rizzo #ifdef NM_BRIDGE
768f196ce38SLuigi Rizzo 	struct ifnet *iter = NULL;
769f196ce38SLuigi Rizzo 
770f196ce38SLuigi Rizzo 	do {
771f196ce38SLuigi Rizzo 		struct nm_bridge *b;
772f196ce38SLuigi Rizzo 		int i, l, cand = -1;
773f196ce38SLuigi Rizzo 
774f196ce38SLuigi Rizzo 		if (strncmp(name, NM_NAME, sizeof(NM_NAME) - 1))
775f196ce38SLuigi Rizzo 			break;
776f196ce38SLuigi Rizzo 		b = nm_find_bridge(name);
777f196ce38SLuigi Rizzo 		if (b == NULL) {
778f196ce38SLuigi Rizzo 			D("no bridges available for '%s'", name);
779f196ce38SLuigi Rizzo 			return (ENXIO);
780f196ce38SLuigi Rizzo 		}
781f196ce38SLuigi Rizzo 		/* XXX locking */
782f196ce38SLuigi Rizzo 		BDG_LOCK(b);
783f196ce38SLuigi Rizzo 		/* lookup in the local list of ports */
784f196ce38SLuigi Rizzo 		for (i = 0; i < NM_BDG_MAXPORTS; i++) {
785f196ce38SLuigi Rizzo 			iter = b->bdg_ports[i];
786f196ce38SLuigi Rizzo 			if (iter == NULL) {
787f196ce38SLuigi Rizzo 				if (cand == -1)
788f196ce38SLuigi Rizzo 					cand = i; /* potential insert point */
789f196ce38SLuigi Rizzo 				continue;
790f196ce38SLuigi Rizzo 			}
791f196ce38SLuigi Rizzo 			if (!strcmp(iter->if_xname, name)) {
792f196ce38SLuigi Rizzo 				ADD_BDG_REF(iter);
793f196ce38SLuigi Rizzo 				ND("found existing interface");
794f196ce38SLuigi Rizzo 				BDG_UNLOCK(b);
795f196ce38SLuigi Rizzo 				break;
796f196ce38SLuigi Rizzo 			}
797f196ce38SLuigi Rizzo 		}
798f196ce38SLuigi Rizzo 		if (i < NM_BDG_MAXPORTS) /* already unlocked */
799f196ce38SLuigi Rizzo 			break;
800f196ce38SLuigi Rizzo 		if (cand == -1) {
801f196ce38SLuigi Rizzo 			D("bridge full, cannot create new port");
802f196ce38SLuigi Rizzo no_port:
803f196ce38SLuigi Rizzo 			BDG_UNLOCK(b);
804f196ce38SLuigi Rizzo 			*ifp = NULL;
805f196ce38SLuigi Rizzo 			return EINVAL;
806f196ce38SLuigi Rizzo 		}
807f196ce38SLuigi Rizzo 		ND("create new bridge port %s", name);
808f196ce38SLuigi Rizzo 		/* space for forwarding list after the ifnet */
809f196ce38SLuigi Rizzo 		l = sizeof(*iter) +
810f196ce38SLuigi Rizzo 			 sizeof(struct nm_bdg_fwd)*NM_BDG_BATCH ;
811f196ce38SLuigi Rizzo 		iter = malloc(l, M_DEVBUF, M_NOWAIT | M_ZERO);
812f196ce38SLuigi Rizzo 		if (!iter)
813f196ce38SLuigi Rizzo 			goto no_port;
814f196ce38SLuigi Rizzo 		strcpy(iter->if_xname, name);
815f196ce38SLuigi Rizzo 		bdg_netmap_attach(iter);
816f196ce38SLuigi Rizzo 		b->bdg_ports[cand] = iter;
817f196ce38SLuigi Rizzo 		iter->if_bridge = b;
818f196ce38SLuigi Rizzo 		ADD_BDG_REF(iter);
819f196ce38SLuigi Rizzo 		BDG_UNLOCK(b);
820f196ce38SLuigi Rizzo 		ND("attaching virtual bridge %p", b);
821f196ce38SLuigi Rizzo 	} while (0);
822f196ce38SLuigi Rizzo 	*ifp = iter;
823f196ce38SLuigi Rizzo 	if (! *ifp)
824f196ce38SLuigi Rizzo #endif /* NM_BRIDGE */
82568b8534bSLuigi Rizzo 	*ifp = ifunit_ref(name);
82668b8534bSLuigi Rizzo 	if (*ifp == NULL)
82768b8534bSLuigi Rizzo 		return (ENXIO);
82868b8534bSLuigi Rizzo 	/* can do this if the capability exists and if_pspare[0]
82968b8534bSLuigi Rizzo 	 * points to the netmap descriptor.
83068b8534bSLuigi Rizzo 	 */
8318241616dSLuigi Rizzo 	if (NETMAP_CAPABLE(*ifp))
83268b8534bSLuigi Rizzo 		return 0;	/* valid pointer, we hold the refcount */
833f196ce38SLuigi Rizzo 	nm_if_rele(*ifp);
83468b8534bSLuigi Rizzo 	return EINVAL;	// not NETMAP capable
83568b8534bSLuigi Rizzo }
83668b8534bSLuigi Rizzo 
83768b8534bSLuigi Rizzo 
83868b8534bSLuigi Rizzo /*
83968b8534bSLuigi Rizzo  * Error routine called when txsync/rxsync detects an error.
84068b8534bSLuigi Rizzo  * Can't do much more than resetting cur = hwcur, avail = hwavail.
84168b8534bSLuigi Rizzo  * Return 1 on reinit.
842506cc70cSLuigi Rizzo  *
843506cc70cSLuigi Rizzo  * This routine is only called by the upper half of the kernel.
844506cc70cSLuigi Rizzo  * It only reads hwcur (which is changed only by the upper half, too)
845506cc70cSLuigi Rizzo  * and hwavail (which may be changed by the lower half, but only on
846506cc70cSLuigi Rizzo  * a tx ring and only to increase it, so any error will be recovered
847506cc70cSLuigi Rizzo  * on the next call). For the above, we don't strictly need to call
848506cc70cSLuigi Rizzo  * it under lock.
84968b8534bSLuigi Rizzo  */
85068b8534bSLuigi Rizzo int
85168b8534bSLuigi Rizzo netmap_ring_reinit(struct netmap_kring *kring)
85268b8534bSLuigi Rizzo {
85368b8534bSLuigi Rizzo 	struct netmap_ring *ring = kring->ring;
85468b8534bSLuigi Rizzo 	u_int i, lim = kring->nkr_num_slots - 1;
85568b8534bSLuigi Rizzo 	int errors = 0;
85668b8534bSLuigi Rizzo 
8578241616dSLuigi Rizzo 	RD(10, "called for %s", kring->na->ifp->if_xname);
85868b8534bSLuigi Rizzo 	if (ring->cur > lim)
85968b8534bSLuigi Rizzo 		errors++;
86068b8534bSLuigi Rizzo 	for (i = 0; i <= lim; i++) {
86168b8534bSLuigi Rizzo 		u_int idx = ring->slot[i].buf_idx;
86268b8534bSLuigi Rizzo 		u_int len = ring->slot[i].len;
86368b8534bSLuigi Rizzo 		if (idx < 2 || idx >= netmap_total_buffers) {
86468b8534bSLuigi Rizzo 			if (!errors++)
86568b8534bSLuigi Rizzo 				D("bad buffer at slot %d idx %d len %d ", i, idx, len);
86668b8534bSLuigi Rizzo 			ring->slot[i].buf_idx = 0;
86768b8534bSLuigi Rizzo 			ring->slot[i].len = 0;
86868b8534bSLuigi Rizzo 		} else if (len > NETMAP_BUF_SIZE) {
86968b8534bSLuigi Rizzo 			ring->slot[i].len = 0;
87068b8534bSLuigi Rizzo 			if (!errors++)
87168b8534bSLuigi Rizzo 				D("bad len %d at slot %d idx %d",
87268b8534bSLuigi Rizzo 					len, i, idx);
87368b8534bSLuigi Rizzo 		}
87468b8534bSLuigi Rizzo 	}
87568b8534bSLuigi Rizzo 	if (errors) {
87668b8534bSLuigi Rizzo 		int pos = kring - kring->na->tx_rings;
877d76bf4ffSLuigi Rizzo 		int n = kring->na->num_tx_rings + 1;
87868b8534bSLuigi Rizzo 
8798241616dSLuigi Rizzo 		RD(10, "total %d errors", errors);
88068b8534bSLuigi Rizzo 		errors++;
8818241616dSLuigi Rizzo 		RD(10, "%s %s[%d] reinit, cur %d -> %d avail %d -> %d",
88268b8534bSLuigi Rizzo 			kring->na->ifp->if_xname,
88368b8534bSLuigi Rizzo 			pos < n ?  "TX" : "RX", pos < n ? pos : pos - n,
88468b8534bSLuigi Rizzo 			ring->cur, kring->nr_hwcur,
88568b8534bSLuigi Rizzo 			ring->avail, kring->nr_hwavail);
88668b8534bSLuigi Rizzo 		ring->cur = kring->nr_hwcur;
88768b8534bSLuigi Rizzo 		ring->avail = kring->nr_hwavail;
88868b8534bSLuigi Rizzo 	}
88968b8534bSLuigi Rizzo 	return (errors ? 1 : 0);
89068b8534bSLuigi Rizzo }
89168b8534bSLuigi Rizzo 
89268b8534bSLuigi Rizzo 
89368b8534bSLuigi Rizzo /*
89468b8534bSLuigi Rizzo  * Set the ring ID. For devices with a single queue, a request
89568b8534bSLuigi Rizzo  * for all rings is the same as a single ring.
89668b8534bSLuigi Rizzo  */
89768b8534bSLuigi Rizzo static int
89868b8534bSLuigi Rizzo netmap_set_ringid(struct netmap_priv_d *priv, u_int ringid)
89968b8534bSLuigi Rizzo {
90068b8534bSLuigi Rizzo 	struct ifnet *ifp = priv->np_ifp;
90168b8534bSLuigi Rizzo 	struct netmap_adapter *na = NA(ifp);
90268b8534bSLuigi Rizzo 	u_int i = ringid & NETMAP_RING_MASK;
90364ae02c3SLuigi Rizzo 	/* initially (np_qfirst == np_qlast) we don't want to lock */
90468b8534bSLuigi Rizzo 	int need_lock = (priv->np_qfirst != priv->np_qlast);
905d76bf4ffSLuigi Rizzo 	int lim = na->num_rx_rings;
90668b8534bSLuigi Rizzo 
907d76bf4ffSLuigi Rizzo 	if (na->num_tx_rings > lim)
908d76bf4ffSLuigi Rizzo 		lim = na->num_tx_rings;
90964ae02c3SLuigi Rizzo 	if ( (ringid & NETMAP_HW_RING) && i >= lim) {
91068b8534bSLuigi Rizzo 		D("invalid ring id %d", i);
91168b8534bSLuigi Rizzo 		return (EINVAL);
91268b8534bSLuigi Rizzo 	}
91368b8534bSLuigi Rizzo 	if (need_lock)
9141a26580eSLuigi Rizzo 		na->nm_lock(ifp, NETMAP_CORE_LOCK, 0);
91568b8534bSLuigi Rizzo 	priv->np_ringid = ringid;
91668b8534bSLuigi Rizzo 	if (ringid & NETMAP_SW_RING) {
91764ae02c3SLuigi Rizzo 		priv->np_qfirst = NETMAP_SW_RING;
91864ae02c3SLuigi Rizzo 		priv->np_qlast = 0;
91968b8534bSLuigi Rizzo 	} else if (ringid & NETMAP_HW_RING) {
92068b8534bSLuigi Rizzo 		priv->np_qfirst = i;
92168b8534bSLuigi Rizzo 		priv->np_qlast = i + 1;
92268b8534bSLuigi Rizzo 	} else {
92368b8534bSLuigi Rizzo 		priv->np_qfirst = 0;
92464ae02c3SLuigi Rizzo 		priv->np_qlast = NETMAP_HW_RING ;
92568b8534bSLuigi Rizzo 	}
92668b8534bSLuigi Rizzo 	priv->np_txpoll = (ringid & NETMAP_NO_TX_POLL) ? 0 : 1;
92768b8534bSLuigi Rizzo 	if (need_lock)
9281a26580eSLuigi Rizzo 		na->nm_lock(ifp, NETMAP_CORE_UNLOCK, 0);
929*ae10d1afSLuigi Rizzo     if (netmap_verbose) {
93068b8534bSLuigi Rizzo 	if (ringid & NETMAP_SW_RING)
93168b8534bSLuigi Rizzo 		D("ringid %s set to SW RING", ifp->if_xname);
93268b8534bSLuigi Rizzo 	else if (ringid & NETMAP_HW_RING)
93368b8534bSLuigi Rizzo 		D("ringid %s set to HW RING %d", ifp->if_xname,
93468b8534bSLuigi Rizzo 			priv->np_qfirst);
93568b8534bSLuigi Rizzo 	else
93664ae02c3SLuigi Rizzo 		D("ringid %s set to all %d HW RINGS", ifp->if_xname, lim);
937*ae10d1afSLuigi Rizzo     }
93868b8534bSLuigi Rizzo 	return 0;
93968b8534bSLuigi Rizzo }
94068b8534bSLuigi Rizzo 
94168b8534bSLuigi Rizzo /*
94268b8534bSLuigi Rizzo  * ioctl(2) support for the "netmap" device.
94368b8534bSLuigi Rizzo  *
94468b8534bSLuigi Rizzo  * Following a list of accepted commands:
94568b8534bSLuigi Rizzo  * - NIOCGINFO
94668b8534bSLuigi Rizzo  * - SIOCGIFADDR	just for convenience
94768b8534bSLuigi Rizzo  * - NIOCREGIF
94868b8534bSLuigi Rizzo  * - NIOCUNREGIF
94968b8534bSLuigi Rizzo  * - NIOCTXSYNC
95068b8534bSLuigi Rizzo  * - NIOCRXSYNC
95168b8534bSLuigi Rizzo  *
95268b8534bSLuigi Rizzo  * Return 0 on success, errno otherwise.
95368b8534bSLuigi Rizzo  */
95468b8534bSLuigi Rizzo static int
9550b8ed8e0SLuigi Rizzo netmap_ioctl(struct cdev *dev, u_long cmd, caddr_t data,
9560b8ed8e0SLuigi Rizzo 	int fflag, struct thread *td)
95768b8534bSLuigi Rizzo {
95868b8534bSLuigi Rizzo 	struct netmap_priv_d *priv = NULL;
95968b8534bSLuigi Rizzo 	struct ifnet *ifp;
96068b8534bSLuigi Rizzo 	struct nmreq *nmr = (struct nmreq *) data;
96168b8534bSLuigi Rizzo 	struct netmap_adapter *na;
96268b8534bSLuigi Rizzo 	int error;
96364ae02c3SLuigi Rizzo 	u_int i, lim;
96468b8534bSLuigi Rizzo 	struct netmap_if *nifp;
96568b8534bSLuigi Rizzo 
9660b8ed8e0SLuigi Rizzo 	(void)dev;	/* UNUSED */
9670b8ed8e0SLuigi Rizzo 	(void)fflag;	/* UNUSED */
968f196ce38SLuigi Rizzo #ifdef linux
969f196ce38SLuigi Rizzo #define devfs_get_cdevpriv(pp)				\
970f196ce38SLuigi Rizzo 	({ *(struct netmap_priv_d **)pp = ((struct file *)td)->private_data; 	\
971f196ce38SLuigi Rizzo 		(*pp ? 0 : ENOENT); })
972f196ce38SLuigi Rizzo 
973f196ce38SLuigi Rizzo /* devfs_set_cdevpriv cannot fail on linux */
974f196ce38SLuigi Rizzo #define devfs_set_cdevpriv(p, fn)				\
975f196ce38SLuigi Rizzo 	({ ((struct file *)td)->private_data = p; (p ? 0 : EINVAL); })
976f196ce38SLuigi Rizzo 
977f196ce38SLuigi Rizzo 
978f196ce38SLuigi Rizzo #define devfs_clear_cdevpriv()	do {				\
979f196ce38SLuigi Rizzo 		netmap_dtor(priv); ((struct file *)td)->private_data = 0;	\
980f196ce38SLuigi Rizzo 	} while (0)
981f196ce38SLuigi Rizzo #endif /* linux */
982f196ce38SLuigi Rizzo 
983506cc70cSLuigi Rizzo 	CURVNET_SET(TD_TO_VNET(td));
984506cc70cSLuigi Rizzo 
98568b8534bSLuigi Rizzo 	error = devfs_get_cdevpriv((void **)&priv);
9868241616dSLuigi Rizzo 	if (error) {
987506cc70cSLuigi Rizzo 		CURVNET_RESTORE();
9888241616dSLuigi Rizzo 		/* XXX ENOENT should be impossible, since the priv
9898241616dSLuigi Rizzo 		 * is now created in the open */
9908241616dSLuigi Rizzo 		return (error == ENOENT ? ENXIO : error);
991506cc70cSLuigi Rizzo 	}
99268b8534bSLuigi Rizzo 
993f196ce38SLuigi Rizzo 	nmr->nr_name[sizeof(nmr->nr_name) - 1] = '\0';	/* truncate name */
99468b8534bSLuigi Rizzo 	switch (cmd) {
99568b8534bSLuigi Rizzo 	case NIOCGINFO:		/* return capabilities etc */
99664ae02c3SLuigi Rizzo 		if (nmr->nr_version != NETMAP_API) {
99764ae02c3SLuigi Rizzo 			D("API mismatch got %d have %d",
99864ae02c3SLuigi Rizzo 				nmr->nr_version, NETMAP_API);
99964ae02c3SLuigi Rizzo 			nmr->nr_version = NETMAP_API;
100064ae02c3SLuigi Rizzo 			error = EINVAL;
100164ae02c3SLuigi Rizzo 			break;
100264ae02c3SLuigi Rizzo 		}
10038241616dSLuigi Rizzo 		/* update configuration */
10048241616dSLuigi Rizzo 		error = netmap_get_memory(priv);
10058241616dSLuigi Rizzo 		ND("get_memory returned %d", error);
10068241616dSLuigi Rizzo 		if (error)
10078241616dSLuigi Rizzo 			break;
10088241616dSLuigi Rizzo 		/* memsize is always valid */
10098241616dSLuigi Rizzo 		nmr->nr_memsize = nm_mem.nm_totalsize;
10108241616dSLuigi Rizzo 		nmr->nr_offset = 0;
10118241616dSLuigi Rizzo 		nmr->nr_rx_rings = nmr->nr_tx_rings = 0;
10128241616dSLuigi Rizzo 		nmr->nr_rx_slots = nmr->nr_tx_slots = 0;
101368b8534bSLuigi Rizzo 		if (nmr->nr_name[0] == '\0')	/* just get memory info */
101468b8534bSLuigi Rizzo 			break;
101568b8534bSLuigi Rizzo 		error = get_ifp(nmr->nr_name, &ifp); /* get a refcount */
101668b8534bSLuigi Rizzo 		if (error)
101768b8534bSLuigi Rizzo 			break;
101868b8534bSLuigi Rizzo 		na = NA(ifp); /* retrieve netmap_adapter */
1019*ae10d1afSLuigi Rizzo 		netmap_update_config(na);
1020d76bf4ffSLuigi Rizzo 		nmr->nr_rx_rings = na->num_rx_rings;
1021d76bf4ffSLuigi Rizzo 		nmr->nr_tx_rings = na->num_tx_rings;
102264ae02c3SLuigi Rizzo 		nmr->nr_rx_slots = na->num_rx_desc;
102364ae02c3SLuigi Rizzo 		nmr->nr_tx_slots = na->num_tx_desc;
1024f196ce38SLuigi Rizzo 		nm_if_rele(ifp);	/* return the refcount */
102568b8534bSLuigi Rizzo 		break;
102668b8534bSLuigi Rizzo 
102768b8534bSLuigi Rizzo 	case NIOCREGIF:
102864ae02c3SLuigi Rizzo 		if (nmr->nr_version != NETMAP_API) {
102964ae02c3SLuigi Rizzo 			nmr->nr_version = NETMAP_API;
103064ae02c3SLuigi Rizzo 			error = EINVAL;
103164ae02c3SLuigi Rizzo 			break;
103264ae02c3SLuigi Rizzo 		}
10338241616dSLuigi Rizzo 		/* ensure allocators are ready */
10348241616dSLuigi Rizzo 		error = netmap_get_memory(priv);
10358241616dSLuigi Rizzo 		ND("get_memory returned %d", error);
10368241616dSLuigi Rizzo 		if (error)
10378241616dSLuigi Rizzo 			break;
10388241616dSLuigi Rizzo 
10398241616dSLuigi Rizzo 		/* protect access to priv from concurrent NIOCREGIF */
10408241616dSLuigi Rizzo 		NMA_LOCK();
10418241616dSLuigi Rizzo 		if (priv->np_ifp != NULL) {	/* thread already registered */
1042506cc70cSLuigi Rizzo 			error = netmap_set_ringid(priv, nmr->nr_ringid);
10438241616dSLuigi Rizzo 			NMA_UNLOCK();
1044506cc70cSLuigi Rizzo 			break;
1045506cc70cSLuigi Rizzo 		}
104668b8534bSLuigi Rizzo 		/* find the interface and a reference */
104768b8534bSLuigi Rizzo 		error = get_ifp(nmr->nr_name, &ifp); /* keep reference */
10488241616dSLuigi Rizzo 		if (error) {
10498241616dSLuigi Rizzo 			NMA_UNLOCK();
105068b8534bSLuigi Rizzo 			break;
105168b8534bSLuigi Rizzo 		}
10528241616dSLuigi Rizzo 		na = NA(ifp); /* retrieve netmap adapter */
105368b8534bSLuigi Rizzo 
105468b8534bSLuigi Rizzo 		for (i = 10; i > 0; i--) {
10551a26580eSLuigi Rizzo 			na->nm_lock(ifp, NETMAP_REG_LOCK, 0);
105668b8534bSLuigi Rizzo 			if (!NETMAP_DELETING(na))
105768b8534bSLuigi Rizzo 				break;
10581a26580eSLuigi Rizzo 			na->nm_lock(ifp, NETMAP_REG_UNLOCK, 0);
105968b8534bSLuigi Rizzo 			tsleep(na, 0, "NIOCREGIF", hz/10);
106068b8534bSLuigi Rizzo 		}
106168b8534bSLuigi Rizzo 		if (i == 0) {
106268b8534bSLuigi Rizzo 			D("too many NIOCREGIF attempts, give up");
106368b8534bSLuigi Rizzo 			error = EINVAL;
1064f196ce38SLuigi Rizzo 			nm_if_rele(ifp);	/* return the refcount */
10658241616dSLuigi Rizzo 			NMA_UNLOCK();
106668b8534bSLuigi Rizzo 			break;
106768b8534bSLuigi Rizzo 		}
106868b8534bSLuigi Rizzo 
1069*ae10d1afSLuigi Rizzo 		/* ring configuration may have changed, fetch from the card */
1070*ae10d1afSLuigi Rizzo 		netmap_update_config(na);
107168b8534bSLuigi Rizzo 		priv->np_ifp = ifp;	/* store the reference */
107268b8534bSLuigi Rizzo 		error = netmap_set_ringid(priv, nmr->nr_ringid);
107368b8534bSLuigi Rizzo 		if (error)
107468b8534bSLuigi Rizzo 			goto error;
10758241616dSLuigi Rizzo 		nifp = netmap_if_new(nmr->nr_name, na);
107668b8534bSLuigi Rizzo 		if (nifp == NULL) { /* allocation failed */
107768b8534bSLuigi Rizzo 			error = ENOMEM;
107868b8534bSLuigi Rizzo 		} else if (ifp->if_capenable & IFCAP_NETMAP) {
107968b8534bSLuigi Rizzo 			/* was already set */
108068b8534bSLuigi Rizzo 		} else {
108168b8534bSLuigi Rizzo 			/* Otherwise set the card in netmap mode
108268b8534bSLuigi Rizzo 			 * and make it use the shared buffers.
108368b8534bSLuigi Rizzo 			 */
1084f196ce38SLuigi Rizzo 			for (i = 0 ; i < na->num_tx_rings + 1; i++)
1085f196ce38SLuigi Rizzo 				mtx_init(&na->tx_rings[i].q_lock, "nm_txq_lock", MTX_NETWORK_LOCK, MTX_DEF);
1086f196ce38SLuigi Rizzo 			for (i = 0 ; i < na->num_rx_rings + 1; i++) {
1087f196ce38SLuigi Rizzo 				mtx_init(&na->rx_rings[i].q_lock, "nm_rxq_lock", MTX_NETWORK_LOCK, MTX_DEF);
1088f196ce38SLuigi Rizzo 			}
108968b8534bSLuigi Rizzo 			error = na->nm_register(ifp, 1); /* mode on */
10908241616dSLuigi Rizzo 			if (error) {
10915819da83SLuigi Rizzo 				netmap_dtor_locked(priv);
10928241616dSLuigi Rizzo 				netmap_if_free(nifp);
10938241616dSLuigi Rizzo 			}
109468b8534bSLuigi Rizzo 		}
109568b8534bSLuigi Rizzo 
109668b8534bSLuigi Rizzo 		if (error) {	/* reg. failed, release priv and ref */
109768b8534bSLuigi Rizzo error:
10981a26580eSLuigi Rizzo 			na->nm_lock(ifp, NETMAP_REG_UNLOCK, 0);
1099f196ce38SLuigi Rizzo 			nm_if_rele(ifp);	/* return the refcount */
11008241616dSLuigi Rizzo 			priv->np_ifp = NULL;
11018241616dSLuigi Rizzo 			priv->np_nifp = NULL;
11028241616dSLuigi Rizzo 			NMA_UNLOCK();
110368b8534bSLuigi Rizzo 			break;
110468b8534bSLuigi Rizzo 		}
110568b8534bSLuigi Rizzo 
11061a26580eSLuigi Rizzo 		na->nm_lock(ifp, NETMAP_REG_UNLOCK, 0);
110768b8534bSLuigi Rizzo 
11088241616dSLuigi Rizzo 		/* the following assignment is a commitment.
11098241616dSLuigi Rizzo 		 * Readers (i.e., poll and *SYNC) check for
11108241616dSLuigi Rizzo 		 * np_nifp != NULL without locking
111168b8534bSLuigi Rizzo 		 */
11128241616dSLuigi Rizzo 		wmb(); /* make sure previous writes are visible to all CPUs */
11138241616dSLuigi Rizzo 		priv->np_nifp = nifp;
11148241616dSLuigi Rizzo 		NMA_UNLOCK();
111568b8534bSLuigi Rizzo 
111668b8534bSLuigi Rizzo 		/* return the offset of the netmap_if object */
1117d76bf4ffSLuigi Rizzo 		nmr->nr_rx_rings = na->num_rx_rings;
1118d76bf4ffSLuigi Rizzo 		nmr->nr_tx_rings = na->num_tx_rings;
111964ae02c3SLuigi Rizzo 		nmr->nr_rx_slots = na->num_rx_desc;
112064ae02c3SLuigi Rizzo 		nmr->nr_tx_slots = na->num_tx_desc;
11218241616dSLuigi Rizzo 		nmr->nr_memsize = nm_mem.nm_totalsize;
1122446ee301SLuigi Rizzo 		nmr->nr_offset = netmap_if_offset(nifp);
112368b8534bSLuigi Rizzo 		break;
112468b8534bSLuigi Rizzo 
112568b8534bSLuigi Rizzo 	case NIOCUNREGIF:
11268241616dSLuigi Rizzo 		// XXX we have no data here ?
11278241616dSLuigi Rizzo 		D("deprecated, data is %p", nmr);
11288241616dSLuigi Rizzo 		error = EINVAL;
112968b8534bSLuigi Rizzo 		break;
113068b8534bSLuigi Rizzo 
113168b8534bSLuigi Rizzo 	case NIOCTXSYNC:
113268b8534bSLuigi Rizzo 	case NIOCRXSYNC:
11338241616dSLuigi Rizzo 		nifp = priv->np_nifp;
11348241616dSLuigi Rizzo 
11358241616dSLuigi Rizzo 		if (nifp == NULL) {
1136506cc70cSLuigi Rizzo 			error = ENXIO;
1137506cc70cSLuigi Rizzo 			break;
1138506cc70cSLuigi Rizzo 		}
11398241616dSLuigi Rizzo 		rmb(); /* make sure following reads are not from cache */
11408241616dSLuigi Rizzo 
11418241616dSLuigi Rizzo 
114268b8534bSLuigi Rizzo 		ifp = priv->np_ifp;	/* we have a reference */
11438241616dSLuigi Rizzo 
11448241616dSLuigi Rizzo 		if (ifp == NULL) {
11458241616dSLuigi Rizzo 			D("Internal error: nifp != NULL && ifp == NULL");
11468241616dSLuigi Rizzo 			error = ENXIO;
11478241616dSLuigi Rizzo 			break;
11488241616dSLuigi Rizzo 		}
11498241616dSLuigi Rizzo 
115068b8534bSLuigi Rizzo 		na = NA(ifp); /* retrieve netmap adapter */
115164ae02c3SLuigi Rizzo 		if (priv->np_qfirst == NETMAP_SW_RING) { /* host rings */
115268b8534bSLuigi Rizzo 			if (cmd == NIOCTXSYNC)
115368b8534bSLuigi Rizzo 				netmap_sync_to_host(na);
115468b8534bSLuigi Rizzo 			else
115501c7d25fSLuigi Rizzo 				netmap_sync_from_host(na, NULL, NULL);
1156506cc70cSLuigi Rizzo 			break;
115768b8534bSLuigi Rizzo 		}
115864ae02c3SLuigi Rizzo 		/* find the last ring to scan */
115964ae02c3SLuigi Rizzo 		lim = priv->np_qlast;
116064ae02c3SLuigi Rizzo 		if (lim == NETMAP_HW_RING)
11613c0caf6cSLuigi Rizzo 			lim = (cmd == NIOCTXSYNC) ?
1162d76bf4ffSLuigi Rizzo 			    na->num_tx_rings : na->num_rx_rings;
116368b8534bSLuigi Rizzo 
116464ae02c3SLuigi Rizzo 		for (i = priv->np_qfirst; i < lim; i++) {
116568b8534bSLuigi Rizzo 			if (cmd == NIOCTXSYNC) {
116668b8534bSLuigi Rizzo 				struct netmap_kring *kring = &na->tx_rings[i];
116768b8534bSLuigi Rizzo 				if (netmap_verbose & NM_VERB_TXSYNC)
11683c0caf6cSLuigi Rizzo 					D("pre txsync ring %d cur %d hwcur %d",
116968b8534bSLuigi Rizzo 					    i, kring->ring->cur,
117068b8534bSLuigi Rizzo 					    kring->nr_hwcur);
11711a26580eSLuigi Rizzo 				na->nm_txsync(ifp, i, 1 /* do lock */);
117268b8534bSLuigi Rizzo 				if (netmap_verbose & NM_VERB_TXSYNC)
11733c0caf6cSLuigi Rizzo 					D("post txsync ring %d cur %d hwcur %d",
117468b8534bSLuigi Rizzo 					    i, kring->ring->cur,
117568b8534bSLuigi Rizzo 					    kring->nr_hwcur);
117668b8534bSLuigi Rizzo 			} else {
11771a26580eSLuigi Rizzo 				na->nm_rxsync(ifp, i, 1 /* do lock */);
117868b8534bSLuigi Rizzo 				microtime(&na->rx_rings[i].ring->ts);
117968b8534bSLuigi Rizzo 			}
118068b8534bSLuigi Rizzo 		}
118168b8534bSLuigi Rizzo 
118268b8534bSLuigi Rizzo 		break;
118368b8534bSLuigi Rizzo 
1184f196ce38SLuigi Rizzo #ifdef __FreeBSD__
118568b8534bSLuigi Rizzo 	case BIOCIMMEDIATE:
118668b8534bSLuigi Rizzo 	case BIOCGHDRCMPLT:
118768b8534bSLuigi Rizzo 	case BIOCSHDRCMPLT:
118868b8534bSLuigi Rizzo 	case BIOCSSEESENT:
118968b8534bSLuigi Rizzo 		D("ignore BIOCIMMEDIATE/BIOCSHDRCMPLT/BIOCSHDRCMPLT/BIOCSSEESENT");
119068b8534bSLuigi Rizzo 		break;
119168b8534bSLuigi Rizzo 
1192babc7c12SLuigi Rizzo 	default:	/* allow device-specific ioctls */
119368b8534bSLuigi Rizzo 	    {
119468b8534bSLuigi Rizzo 		struct socket so;
119568b8534bSLuigi Rizzo 		bzero(&so, sizeof(so));
119668b8534bSLuigi Rizzo 		error = get_ifp(nmr->nr_name, &ifp); /* keep reference */
119768b8534bSLuigi Rizzo 		if (error)
119868b8534bSLuigi Rizzo 			break;
119968b8534bSLuigi Rizzo 		so.so_vnet = ifp->if_vnet;
120068b8534bSLuigi Rizzo 		// so->so_proto not null.
120168b8534bSLuigi Rizzo 		error = ifioctl(&so, cmd, data, td);
1202f196ce38SLuigi Rizzo 		nm_if_rele(ifp);
1203babc7c12SLuigi Rizzo 		break;
120468b8534bSLuigi Rizzo 	    }
1205f196ce38SLuigi Rizzo 
1206f196ce38SLuigi Rizzo #else /* linux */
1207f196ce38SLuigi Rizzo 	default:
1208f196ce38SLuigi Rizzo 		error = EOPNOTSUPP;
1209f196ce38SLuigi Rizzo #endif /* linux */
121068b8534bSLuigi Rizzo 	}
121168b8534bSLuigi Rizzo 
1212506cc70cSLuigi Rizzo 	CURVNET_RESTORE();
121368b8534bSLuigi Rizzo 	return (error);
121468b8534bSLuigi Rizzo }
121568b8534bSLuigi Rizzo 
121668b8534bSLuigi Rizzo 
121768b8534bSLuigi Rizzo /*
121868b8534bSLuigi Rizzo  * select(2) and poll(2) handlers for the "netmap" device.
121968b8534bSLuigi Rizzo  *
122068b8534bSLuigi Rizzo  * Can be called for one or more queues.
122168b8534bSLuigi Rizzo  * Return true the event mask corresponding to ready events.
122268b8534bSLuigi Rizzo  * If there are no ready events, do a selrecord on either individual
122368b8534bSLuigi Rizzo  * selfd or on the global one.
122468b8534bSLuigi Rizzo  * Device-dependent parts (locking and sync of tx/rx rings)
122568b8534bSLuigi Rizzo  * are done through callbacks.
1226f196ce38SLuigi Rizzo  *
122701c7d25fSLuigi Rizzo  * On linux, arguments are really pwait, the poll table, and 'td' is struct file *
122801c7d25fSLuigi Rizzo  * The first one is remapped to pwait as selrecord() uses the name as an
122901c7d25fSLuigi Rizzo  * hidden argument.
123068b8534bSLuigi Rizzo  */
123168b8534bSLuigi Rizzo static int
123201c7d25fSLuigi Rizzo netmap_poll(struct cdev *dev, int events, struct thread *td)
123368b8534bSLuigi Rizzo {
123468b8534bSLuigi Rizzo 	struct netmap_priv_d *priv = NULL;
123568b8534bSLuigi Rizzo 	struct netmap_adapter *na;
123668b8534bSLuigi Rizzo 	struct ifnet *ifp;
123768b8534bSLuigi Rizzo 	struct netmap_kring *kring;
1238d0c7b075SLuigi Rizzo 	u_int core_lock, i, check_all, want_tx, want_rx, revents = 0;
123964ae02c3SLuigi Rizzo 	u_int lim_tx, lim_rx;
1240bcda432eSLuigi Rizzo 	enum {NO_CL, NEED_CL, LOCKED_CL }; /* see below */
124101c7d25fSLuigi Rizzo 	void *pwait = dev;	/* linux compatibility */
124201c7d25fSLuigi Rizzo 
124301c7d25fSLuigi Rizzo 	(void)pwait;
124468b8534bSLuigi Rizzo 
124568b8534bSLuigi Rizzo 	if (devfs_get_cdevpriv((void **)&priv) != 0 || priv == NULL)
124668b8534bSLuigi Rizzo 		return POLLERR;
124768b8534bSLuigi Rizzo 
12488241616dSLuigi Rizzo 	if (priv->np_nifp == NULL) {
12498241616dSLuigi Rizzo 		D("No if registered");
12508241616dSLuigi Rizzo 		return POLLERR;
12518241616dSLuigi Rizzo 	}
12528241616dSLuigi Rizzo 	rmb(); /* make sure following reads are not from cache */
12538241616dSLuigi Rizzo 
125468b8534bSLuigi Rizzo 	ifp = priv->np_ifp;
125568b8534bSLuigi Rizzo 	// XXX check for deleting() ?
125668b8534bSLuigi Rizzo 	if ( (ifp->if_capenable & IFCAP_NETMAP) == 0)
125768b8534bSLuigi Rizzo 		return POLLERR;
125868b8534bSLuigi Rizzo 
125968b8534bSLuigi Rizzo 	if (netmap_verbose & 0x8000)
126068b8534bSLuigi Rizzo 		D("device %s events 0x%x", ifp->if_xname, events);
126168b8534bSLuigi Rizzo 	want_tx = events & (POLLOUT | POLLWRNORM);
126268b8534bSLuigi Rizzo 	want_rx = events & (POLLIN | POLLRDNORM);
126368b8534bSLuigi Rizzo 
126468b8534bSLuigi Rizzo 	na = NA(ifp); /* retrieve netmap adapter */
126568b8534bSLuigi Rizzo 
1266d76bf4ffSLuigi Rizzo 	lim_tx = na->num_tx_rings;
1267d76bf4ffSLuigi Rizzo 	lim_rx = na->num_rx_rings;
126868b8534bSLuigi Rizzo 	/* how many queues we are scanning */
126964ae02c3SLuigi Rizzo 	if (priv->np_qfirst == NETMAP_SW_RING) {
127068b8534bSLuigi Rizzo 		if (priv->np_txpoll || want_tx) {
127168b8534bSLuigi Rizzo 			/* push any packets up, then we are always ready */
127264ae02c3SLuigi Rizzo 			kring = &na->tx_rings[lim_tx];
127368b8534bSLuigi Rizzo 			netmap_sync_to_host(na);
127468b8534bSLuigi Rizzo 			revents |= want_tx;
127568b8534bSLuigi Rizzo 		}
127668b8534bSLuigi Rizzo 		if (want_rx) {
127764ae02c3SLuigi Rizzo 			kring = &na->rx_rings[lim_rx];
127868b8534bSLuigi Rizzo 			if (kring->ring->avail == 0)
127901c7d25fSLuigi Rizzo 				netmap_sync_from_host(na, td, dev);
128068b8534bSLuigi Rizzo 			if (kring->ring->avail > 0) {
128168b8534bSLuigi Rizzo 				revents |= want_rx;
128268b8534bSLuigi Rizzo 			}
128368b8534bSLuigi Rizzo 		}
128468b8534bSLuigi Rizzo 		return (revents);
128568b8534bSLuigi Rizzo 	}
128668b8534bSLuigi Rizzo 
128768b8534bSLuigi Rizzo 	/*
128868b8534bSLuigi Rizzo 	 * check_all is set if the card has more than one queue and
128968b8534bSLuigi Rizzo 	 * the client is polling all of them. If true, we sleep on
129068b8534bSLuigi Rizzo 	 * the "global" selfd, otherwise we sleep on individual selfd
129168b8534bSLuigi Rizzo 	 * (we can only sleep on one of them per direction).
129268b8534bSLuigi Rizzo 	 * The interrupt routine in the driver should always wake on
129368b8534bSLuigi Rizzo 	 * the individual selfd, and also on the global one if the card
129468b8534bSLuigi Rizzo 	 * has more than one ring.
129568b8534bSLuigi Rizzo 	 *
129668b8534bSLuigi Rizzo 	 * If the card has only one lock, we just use that.
129768b8534bSLuigi Rizzo 	 * If the card has separate ring locks, we just use those
129868b8534bSLuigi Rizzo 	 * unless we are doing check_all, in which case the whole
129968b8534bSLuigi Rizzo 	 * loop is wrapped by the global lock.
130068b8534bSLuigi Rizzo 	 * We acquire locks only when necessary: if poll is called
130168b8534bSLuigi Rizzo 	 * when buffers are available, we can just return without locks.
130268b8534bSLuigi Rizzo 	 *
130368b8534bSLuigi Rizzo 	 * rxsync() is only called if we run out of buffers on a POLLIN.
130468b8534bSLuigi Rizzo 	 * txsync() is called if we run out of buffers on POLLOUT, or
130568b8534bSLuigi Rizzo 	 * there are pending packets to send. The latter can be disabled
130668b8534bSLuigi Rizzo 	 * passing NETMAP_NO_TX_POLL in the NIOCREG call.
130768b8534bSLuigi Rizzo 	 */
130864ae02c3SLuigi Rizzo 	check_all = (priv->np_qlast == NETMAP_HW_RING) && (lim_tx > 1 || lim_rx > 1);
130968b8534bSLuigi Rizzo 
131068b8534bSLuigi Rizzo 	/*
131168b8534bSLuigi Rizzo 	 * core_lock indicates what to do with the core lock.
131268b8534bSLuigi Rizzo 	 * The core lock is used when either the card has no individual
131368b8534bSLuigi Rizzo 	 * locks, or it has individual locks but we are cheking all
131468b8534bSLuigi Rizzo 	 * rings so we need the core lock to avoid missing wakeup events.
131568b8534bSLuigi Rizzo 	 *
131668b8534bSLuigi Rizzo 	 * It has three possible states:
131768b8534bSLuigi Rizzo 	 * NO_CL	we don't need to use the core lock, e.g.
131868b8534bSLuigi Rizzo 	 *		because we are protected by individual locks.
131968b8534bSLuigi Rizzo 	 * NEED_CL	we need the core lock. In this case, when we
132068b8534bSLuigi Rizzo 	 *		call the lock routine, move to LOCKED_CL
132168b8534bSLuigi Rizzo 	 *		to remember to release the lock once done.
132268b8534bSLuigi Rizzo 	 * LOCKED_CL	core lock is set, so we need to release it.
132368b8534bSLuigi Rizzo 	 */
1324d0c7b075SLuigi Rizzo 	core_lock = (check_all || !na->separate_locks) ? NEED_CL : NO_CL;
1325f196ce38SLuigi Rizzo #ifdef NM_BRIDGE
1326f196ce38SLuigi Rizzo 	/* the bridge uses separate locks */
1327f196ce38SLuigi Rizzo 	if (na->nm_register == bdg_netmap_reg) {
1328f196ce38SLuigi Rizzo 		ND("not using core lock for %s", ifp->if_xname);
1329f196ce38SLuigi Rizzo 		core_lock = NO_CL;
1330f196ce38SLuigi Rizzo 	}
1331f196ce38SLuigi Rizzo #endif /* NM_BRIDGE */
133264ae02c3SLuigi Rizzo 	if (priv->np_qlast != NETMAP_HW_RING) {
133364ae02c3SLuigi Rizzo 		lim_tx = lim_rx = priv->np_qlast;
133464ae02c3SLuigi Rizzo 	}
133564ae02c3SLuigi Rizzo 
133668b8534bSLuigi Rizzo 	/*
133768b8534bSLuigi Rizzo 	 * We start with a lock free round which is good if we have
133868b8534bSLuigi Rizzo 	 * data available. If this fails, then lock and call the sync
133968b8534bSLuigi Rizzo 	 * routines.
134068b8534bSLuigi Rizzo 	 */
134164ae02c3SLuigi Rizzo 	for (i = priv->np_qfirst; want_rx && i < lim_rx; i++) {
134268b8534bSLuigi Rizzo 		kring = &na->rx_rings[i];
134368b8534bSLuigi Rizzo 		if (kring->ring->avail > 0) {
134468b8534bSLuigi Rizzo 			revents |= want_rx;
134568b8534bSLuigi Rizzo 			want_rx = 0;	/* also breaks the loop */
134668b8534bSLuigi Rizzo 		}
134768b8534bSLuigi Rizzo 	}
134864ae02c3SLuigi Rizzo 	for (i = priv->np_qfirst; want_tx && i < lim_tx; i++) {
134968b8534bSLuigi Rizzo 		kring = &na->tx_rings[i];
135068b8534bSLuigi Rizzo 		if (kring->ring->avail > 0) {
135168b8534bSLuigi Rizzo 			revents |= want_tx;
135268b8534bSLuigi Rizzo 			want_tx = 0;	/* also breaks the loop */
135368b8534bSLuigi Rizzo 		}
135468b8534bSLuigi Rizzo 	}
135568b8534bSLuigi Rizzo 
135668b8534bSLuigi Rizzo 	/*
135768b8534bSLuigi Rizzo 	 * If we to push packets out (priv->np_txpoll) or want_tx is
135868b8534bSLuigi Rizzo 	 * still set, we do need to run the txsync calls (on all rings,
135968b8534bSLuigi Rizzo 	 * to avoid that the tx rings stall).
136068b8534bSLuigi Rizzo 	 */
136168b8534bSLuigi Rizzo 	if (priv->np_txpoll || want_tx) {
136264ae02c3SLuigi Rizzo 		for (i = priv->np_qfirst; i < lim_tx; i++) {
136368b8534bSLuigi Rizzo 			kring = &na->tx_rings[i];
13645819da83SLuigi Rizzo 			/*
13655819da83SLuigi Rizzo 			 * Skip the current ring if want_tx == 0
13665819da83SLuigi Rizzo 			 * (we have already done a successful sync on
13675819da83SLuigi Rizzo 			 * a previous ring) AND kring->cur == kring->hwcur
13685819da83SLuigi Rizzo 			 * (there are no pending transmissions for this ring).
13695819da83SLuigi Rizzo 			 */
137068b8534bSLuigi Rizzo 			if (!want_tx && kring->ring->cur == kring->nr_hwcur)
137168b8534bSLuigi Rizzo 				continue;
137268b8534bSLuigi Rizzo 			if (core_lock == NEED_CL) {
13731a26580eSLuigi Rizzo 				na->nm_lock(ifp, NETMAP_CORE_LOCK, 0);
137468b8534bSLuigi Rizzo 				core_lock = LOCKED_CL;
137568b8534bSLuigi Rizzo 			}
137668b8534bSLuigi Rizzo 			if (na->separate_locks)
13771a26580eSLuigi Rizzo 				na->nm_lock(ifp, NETMAP_TX_LOCK, i);
137868b8534bSLuigi Rizzo 			if (netmap_verbose & NM_VERB_TXSYNC)
137968b8534bSLuigi Rizzo 				D("send %d on %s %d",
138068b8534bSLuigi Rizzo 					kring->ring->cur,
138168b8534bSLuigi Rizzo 					ifp->if_xname, i);
13821a26580eSLuigi Rizzo 			if (na->nm_txsync(ifp, i, 0 /* no lock */))
138368b8534bSLuigi Rizzo 				revents |= POLLERR;
138468b8534bSLuigi Rizzo 
13855819da83SLuigi Rizzo 			/* Check avail/call selrecord only if called with POLLOUT */
138668b8534bSLuigi Rizzo 			if (want_tx) {
138768b8534bSLuigi Rizzo 				if (kring->ring->avail > 0) {
138868b8534bSLuigi Rizzo 					/* stop at the first ring. We don't risk
138968b8534bSLuigi Rizzo 					 * starvation.
139068b8534bSLuigi Rizzo 					 */
139168b8534bSLuigi Rizzo 					revents |= want_tx;
139268b8534bSLuigi Rizzo 					want_tx = 0;
139368b8534bSLuigi Rizzo 				} else if (!check_all)
139468b8534bSLuigi Rizzo 					selrecord(td, &kring->si);
139568b8534bSLuigi Rizzo 			}
139668b8534bSLuigi Rizzo 			if (na->separate_locks)
13971a26580eSLuigi Rizzo 				na->nm_lock(ifp, NETMAP_TX_UNLOCK, i);
139868b8534bSLuigi Rizzo 		}
139968b8534bSLuigi Rizzo 	}
140068b8534bSLuigi Rizzo 
140168b8534bSLuigi Rizzo 	/*
140268b8534bSLuigi Rizzo 	 * now if want_rx is still set we need to lock and rxsync.
140368b8534bSLuigi Rizzo 	 * Do it on all rings because otherwise we starve.
140468b8534bSLuigi Rizzo 	 */
140568b8534bSLuigi Rizzo 	if (want_rx) {
140664ae02c3SLuigi Rizzo 		for (i = priv->np_qfirst; i < lim_rx; i++) {
140768b8534bSLuigi Rizzo 			kring = &na->rx_rings[i];
140868b8534bSLuigi Rizzo 			if (core_lock == NEED_CL) {
14091a26580eSLuigi Rizzo 				na->nm_lock(ifp, NETMAP_CORE_LOCK, 0);
141068b8534bSLuigi Rizzo 				core_lock = LOCKED_CL;
141168b8534bSLuigi Rizzo 			}
141268b8534bSLuigi Rizzo 			if (na->separate_locks)
14131a26580eSLuigi Rizzo 				na->nm_lock(ifp, NETMAP_RX_LOCK, i);
141468b8534bSLuigi Rizzo 
14151a26580eSLuigi Rizzo 			if (na->nm_rxsync(ifp, i, 0 /* no lock */))
141668b8534bSLuigi Rizzo 				revents |= POLLERR;
14175819da83SLuigi Rizzo 			if (netmap_no_timestamp == 0 ||
14185819da83SLuigi Rizzo 					kring->ring->flags & NR_TIMESTAMP) {
141968b8534bSLuigi Rizzo 				microtime(&kring->ring->ts);
14205819da83SLuigi Rizzo 			}
142168b8534bSLuigi Rizzo 
142268b8534bSLuigi Rizzo 			if (kring->ring->avail > 0)
142368b8534bSLuigi Rizzo 				revents |= want_rx;
142468b8534bSLuigi Rizzo 			else if (!check_all)
142568b8534bSLuigi Rizzo 				selrecord(td, &kring->si);
142668b8534bSLuigi Rizzo 			if (na->separate_locks)
14271a26580eSLuigi Rizzo 				na->nm_lock(ifp, NETMAP_RX_UNLOCK, i);
142868b8534bSLuigi Rizzo 		}
142968b8534bSLuigi Rizzo 	}
143064ae02c3SLuigi Rizzo 	if (check_all && revents == 0) { /* signal on the global queue */
143168b8534bSLuigi Rizzo 		if (want_tx)
143264ae02c3SLuigi Rizzo 			selrecord(td, &na->tx_si);
143368b8534bSLuigi Rizzo 		if (want_rx)
143464ae02c3SLuigi Rizzo 			selrecord(td, &na->rx_si);
143568b8534bSLuigi Rizzo 	}
143668b8534bSLuigi Rizzo 	if (core_lock == LOCKED_CL)
14371a26580eSLuigi Rizzo 		na->nm_lock(ifp, NETMAP_CORE_UNLOCK, 0);
143868b8534bSLuigi Rizzo 
143968b8534bSLuigi Rizzo 	return (revents);
144068b8534bSLuigi Rizzo }
144168b8534bSLuigi Rizzo 
144268b8534bSLuigi Rizzo /*------- driver support routines ------*/
144368b8534bSLuigi Rizzo 
144468b8534bSLuigi Rizzo /*
1445babc7c12SLuigi Rizzo  * default lock wrapper.
14461a26580eSLuigi Rizzo  */
14471a26580eSLuigi Rizzo static void
1448babc7c12SLuigi Rizzo netmap_lock_wrapper(struct ifnet *dev, int what, u_int queueid)
14491a26580eSLuigi Rizzo {
1450babc7c12SLuigi Rizzo 	struct netmap_adapter *na = NA(dev);
14511a26580eSLuigi Rizzo 
14521a26580eSLuigi Rizzo 	switch (what) {
1453babc7c12SLuigi Rizzo #ifdef linux	/* some system do not need lock on register */
14541a26580eSLuigi Rizzo 	case NETMAP_REG_LOCK:
14551a26580eSLuigi Rizzo 	case NETMAP_REG_UNLOCK:
14561a26580eSLuigi Rizzo 		break;
1457babc7c12SLuigi Rizzo #endif /* linux */
14581a26580eSLuigi Rizzo 
14591a26580eSLuigi Rizzo 	case NETMAP_CORE_LOCK:
14601a26580eSLuigi Rizzo 		mtx_lock(&na->core_lock);
14611a26580eSLuigi Rizzo 		break;
14621a26580eSLuigi Rizzo 
14631a26580eSLuigi Rizzo 	case NETMAP_CORE_UNLOCK:
14641a26580eSLuigi Rizzo 		mtx_unlock(&na->core_lock);
14651a26580eSLuigi Rizzo 		break;
14661a26580eSLuigi Rizzo 
14671a26580eSLuigi Rizzo 	case NETMAP_TX_LOCK:
14681a26580eSLuigi Rizzo 		mtx_lock(&na->tx_rings[queueid].q_lock);
14691a26580eSLuigi Rizzo 		break;
14701a26580eSLuigi Rizzo 
14711a26580eSLuigi Rizzo 	case NETMAP_TX_UNLOCK:
14721a26580eSLuigi Rizzo 		mtx_unlock(&na->tx_rings[queueid].q_lock);
14731a26580eSLuigi Rizzo 		break;
14741a26580eSLuigi Rizzo 
14751a26580eSLuigi Rizzo 	case NETMAP_RX_LOCK:
14761a26580eSLuigi Rizzo 		mtx_lock(&na->rx_rings[queueid].q_lock);
14771a26580eSLuigi Rizzo 		break;
14781a26580eSLuigi Rizzo 
14791a26580eSLuigi Rizzo 	case NETMAP_RX_UNLOCK:
14801a26580eSLuigi Rizzo 		mtx_unlock(&na->rx_rings[queueid].q_lock);
14811a26580eSLuigi Rizzo 		break;
14821a26580eSLuigi Rizzo 	}
14831a26580eSLuigi Rizzo }
14841a26580eSLuigi Rizzo 
14851a26580eSLuigi Rizzo 
14861a26580eSLuigi Rizzo /*
148768b8534bSLuigi Rizzo  * Initialize a ``netmap_adapter`` object created by driver on attach.
148868b8534bSLuigi Rizzo  * We allocate a block of memory with room for a struct netmap_adapter
148968b8534bSLuigi Rizzo  * plus two sets of N+2 struct netmap_kring (where N is the number
149068b8534bSLuigi Rizzo  * of hardware rings):
149168b8534bSLuigi Rizzo  * krings	0..N-1	are for the hardware queues.
149268b8534bSLuigi Rizzo  * kring	N	is for the host stack queue
149368b8534bSLuigi Rizzo  * kring	N+1	is only used for the selinfo for all queues.
149468b8534bSLuigi Rizzo  * Return 0 on success, ENOMEM otherwise.
149564ae02c3SLuigi Rizzo  *
14960bf88954SEd Maste  * By default the receive and transmit adapter ring counts are both initialized
14970bf88954SEd Maste  * to num_queues.  na->num_tx_rings can be set for cards with different tx/rx
149824e57ec9SEd Maste  * setups.
149968b8534bSLuigi Rizzo  */
150068b8534bSLuigi Rizzo int
1501*ae10d1afSLuigi Rizzo netmap_attach(struct netmap_adapter *arg, int num_queues)
150268b8534bSLuigi Rizzo {
1503*ae10d1afSLuigi Rizzo 	struct netmap_adapter *na = NULL;
1504*ae10d1afSLuigi Rizzo 	struct ifnet *ifp = arg ? arg->ifp : NULL;
150568b8534bSLuigi Rizzo 
1506*ae10d1afSLuigi Rizzo 	if (arg == NULL || ifp == NULL)
1507*ae10d1afSLuigi Rizzo 		goto fail;
1508*ae10d1afSLuigi Rizzo 	na = malloc(sizeof(*na), M_DEVBUF, M_NOWAIT | M_ZERO);
1509*ae10d1afSLuigi Rizzo 	if (na == NULL)
1510*ae10d1afSLuigi Rizzo 		goto fail;
1511*ae10d1afSLuigi Rizzo 	WNA(ifp) = na;
1512*ae10d1afSLuigi Rizzo 	*na = *arg; /* copy everything, trust the driver to not pass junk */
1513*ae10d1afSLuigi Rizzo 	NETMAP_SET_CAPABLE(ifp);
1514d76bf4ffSLuigi Rizzo 	if (na->num_tx_rings == 0)
1515d76bf4ffSLuigi Rizzo 		na->num_tx_rings = num_queues;
1516d76bf4ffSLuigi Rizzo 	na->num_rx_rings = num_queues;
1517*ae10d1afSLuigi Rizzo 	na->refcount = na->na_single = na->na_multi = 0;
1518*ae10d1afSLuigi Rizzo 	/* Core lock initialized here, others after netmap_if_new. */
1519*ae10d1afSLuigi Rizzo 	mtx_init(&na->core_lock, "netmap core lock", MTX_NETWORK_LOCK, MTX_DEF);
1520f196ce38SLuigi Rizzo 	if (na->nm_lock == NULL) {
1521f196ce38SLuigi Rizzo 		ND("using default locks for %s", ifp->if_xname);
15221a26580eSLuigi Rizzo 		na->nm_lock = netmap_lock_wrapper;
1523f196ce38SLuigi Rizzo 	}
152464ae02c3SLuigi Rizzo #ifdef linux
1525f196ce38SLuigi Rizzo 	if (ifp->netdev_ops) {
15268241616dSLuigi Rizzo 		ND("netdev_ops %p", ifp->netdev_ops);
152764ae02c3SLuigi Rizzo 		/* prepare a clone of the netdev ops */
152864ae02c3SLuigi Rizzo 		na->nm_ndo = *ifp->netdev_ops;
1529f196ce38SLuigi Rizzo 	}
153042a3a5bdSLuigi Rizzo 	na->nm_ndo.ndo_start_xmit = linux_netmap_start;
153164ae02c3SLuigi Rizzo #endif
1532*ae10d1afSLuigi Rizzo 	D("success for %s", ifp->if_xname);
1533*ae10d1afSLuigi Rizzo 	return 0;
153468b8534bSLuigi Rizzo 
1535*ae10d1afSLuigi Rizzo fail:
1536*ae10d1afSLuigi Rizzo 	D("fail, arg %p ifp %p na %p", arg, ifp, na);
1537*ae10d1afSLuigi Rizzo 	return (na ? EINVAL : ENOMEM);
153868b8534bSLuigi Rizzo }
153968b8534bSLuigi Rizzo 
154068b8534bSLuigi Rizzo 
154168b8534bSLuigi Rizzo /*
154268b8534bSLuigi Rizzo  * Free the allocated memory linked to the given ``netmap_adapter``
154368b8534bSLuigi Rizzo  * object.
154468b8534bSLuigi Rizzo  */
154568b8534bSLuigi Rizzo void
154668b8534bSLuigi Rizzo netmap_detach(struct ifnet *ifp)
154768b8534bSLuigi Rizzo {
154868b8534bSLuigi Rizzo 	struct netmap_adapter *na = NA(ifp);
154968b8534bSLuigi Rizzo 
155068b8534bSLuigi Rizzo 	if (!na)
155168b8534bSLuigi Rizzo 		return;
155268b8534bSLuigi Rizzo 
15532f70fca5SEd Maste 	mtx_destroy(&na->core_lock);
15542f70fca5SEd Maste 
1555*ae10d1afSLuigi Rizzo 	if (na->tx_rings) { /* XXX should not happen */
1556*ae10d1afSLuigi Rizzo 		D("freeing leftover tx_rings");
1557*ae10d1afSLuigi Rizzo 		free(na->tx_rings, M_DEVBUF);
1558*ae10d1afSLuigi Rizzo 	}
155968b8534bSLuigi Rizzo 	bzero(na, sizeof(*na));
1560d0c7b075SLuigi Rizzo 	WNA(ifp) = NULL;
156168b8534bSLuigi Rizzo 	free(na, M_DEVBUF);
156268b8534bSLuigi Rizzo }
156368b8534bSLuigi Rizzo 
156468b8534bSLuigi Rizzo 
156568b8534bSLuigi Rizzo /*
156602ad4083SLuigi Rizzo  * Intercept packets from the network stack and pass them
156702ad4083SLuigi Rizzo  * to netmap as incoming packets on the 'software' ring.
156868b8534bSLuigi Rizzo  * We are not locked when called.
156968b8534bSLuigi Rizzo  */
157068b8534bSLuigi Rizzo int
157168b8534bSLuigi Rizzo netmap_start(struct ifnet *ifp, struct mbuf *m)
157268b8534bSLuigi Rizzo {
157368b8534bSLuigi Rizzo 	struct netmap_adapter *na = NA(ifp);
1574d76bf4ffSLuigi Rizzo 	struct netmap_kring *kring = &na->rx_rings[na->num_rx_rings];
15751a26580eSLuigi Rizzo 	u_int i, len = MBUF_LEN(m);
1576b3d53016SLuigi Rizzo 	u_int error = EBUSY, lim = kring->nkr_num_slots - 1;
157768b8534bSLuigi Rizzo 	struct netmap_slot *slot;
157868b8534bSLuigi Rizzo 
157968b8534bSLuigi Rizzo 	if (netmap_verbose & NM_VERB_HOST)
158068b8534bSLuigi Rizzo 		D("%s packet %d len %d from the stack", ifp->if_xname,
158168b8534bSLuigi Rizzo 			kring->nr_hwcur + kring->nr_hwavail, len);
15821a26580eSLuigi Rizzo 	na->nm_lock(ifp, NETMAP_CORE_LOCK, 0);
158302ad4083SLuigi Rizzo 	if (kring->nr_hwavail >= lim) {
15845b248374SLuigi Rizzo 		if (netmap_verbose)
158568b8534bSLuigi Rizzo 			D("stack ring %s full\n", ifp->if_xname);
158668b8534bSLuigi Rizzo 		goto done;	/* no space */
158768b8534bSLuigi Rizzo 	}
158864ae02c3SLuigi Rizzo 	if (len > NETMAP_BUF_SIZE) {
158964ae02c3SLuigi Rizzo 		D("drop packet size %d > %d", len, NETMAP_BUF_SIZE);
159068b8534bSLuigi Rizzo 		goto done;	/* too long for us */
159168b8534bSLuigi Rizzo 	}
159268b8534bSLuigi Rizzo 
159368b8534bSLuigi Rizzo 	/* compute the insert position */
159468b8534bSLuigi Rizzo 	i = kring->nr_hwcur + kring->nr_hwavail;
159502ad4083SLuigi Rizzo 	if (i > lim)
159602ad4083SLuigi Rizzo 		i -= lim + 1;
159768b8534bSLuigi Rizzo 	slot = &kring->ring->slot[i];
159868b8534bSLuigi Rizzo 	m_copydata(m, 0, len, NMB(slot));
159968b8534bSLuigi Rizzo 	slot->len = len;
160068b8534bSLuigi Rizzo 	kring->nr_hwavail++;
160168b8534bSLuigi Rizzo 	if (netmap_verbose  & NM_VERB_HOST)
1602d76bf4ffSLuigi Rizzo 		D("wake up host ring %s %d", na->ifp->if_xname, na->num_rx_rings);
160368b8534bSLuigi Rizzo 	selwakeuppri(&kring->si, PI_NET);
160468b8534bSLuigi Rizzo 	error = 0;
160568b8534bSLuigi Rizzo done:
16061a26580eSLuigi Rizzo 	na->nm_lock(ifp, NETMAP_CORE_UNLOCK, 0);
160768b8534bSLuigi Rizzo 
160868b8534bSLuigi Rizzo 	/* release the mbuf in either cases of success or failure. As an
160968b8534bSLuigi Rizzo 	 * alternative, put the mbuf in a free list and free the list
161068b8534bSLuigi Rizzo 	 * only when really necessary.
161168b8534bSLuigi Rizzo 	 */
161268b8534bSLuigi Rizzo 	m_freem(m);
161368b8534bSLuigi Rizzo 
161468b8534bSLuigi Rizzo 	return (error);
161568b8534bSLuigi Rizzo }
161668b8534bSLuigi Rizzo 
161768b8534bSLuigi Rizzo 
161868b8534bSLuigi Rizzo /*
161968b8534bSLuigi Rizzo  * netmap_reset() is called by the driver routines when reinitializing
162068b8534bSLuigi Rizzo  * a ring. The driver is in charge of locking to protect the kring.
162168b8534bSLuigi Rizzo  * If netmap mode is not set just return NULL.
162268b8534bSLuigi Rizzo  */
162368b8534bSLuigi Rizzo struct netmap_slot *
162468b8534bSLuigi Rizzo netmap_reset(struct netmap_adapter *na, enum txrx tx, int n,
162568b8534bSLuigi Rizzo 	u_int new_cur)
162668b8534bSLuigi Rizzo {
162768b8534bSLuigi Rizzo 	struct netmap_kring *kring;
1628506cc70cSLuigi Rizzo 	int new_hwofs, lim;
162968b8534bSLuigi Rizzo 
163068b8534bSLuigi Rizzo 	if (na == NULL)
163168b8534bSLuigi Rizzo 		return NULL;	/* no netmap support here */
163268b8534bSLuigi Rizzo 	if (!(na->ifp->if_capenable & IFCAP_NETMAP))
163368b8534bSLuigi Rizzo 		return NULL;	/* nothing to reinitialize */
163468b8534bSLuigi Rizzo 
163564ae02c3SLuigi Rizzo 	if (tx == NR_TX) {
16368241616dSLuigi Rizzo 		if (n >= na->num_tx_rings)
16378241616dSLuigi Rizzo 			return NULL;
163864ae02c3SLuigi Rizzo 		kring = na->tx_rings + n;
1639506cc70cSLuigi Rizzo 		new_hwofs = kring->nr_hwcur - new_cur;
164064ae02c3SLuigi Rizzo 	} else {
16418241616dSLuigi Rizzo 		if (n >= na->num_rx_rings)
16428241616dSLuigi Rizzo 			return NULL;
164364ae02c3SLuigi Rizzo 		kring = na->rx_rings + n;
1644506cc70cSLuigi Rizzo 		new_hwofs = kring->nr_hwcur + kring->nr_hwavail - new_cur;
164564ae02c3SLuigi Rizzo 	}
164664ae02c3SLuigi Rizzo 	lim = kring->nkr_num_slots - 1;
1647506cc70cSLuigi Rizzo 	if (new_hwofs > lim)
1648506cc70cSLuigi Rizzo 		new_hwofs -= lim + 1;
1649506cc70cSLuigi Rizzo 
1650506cc70cSLuigi Rizzo 	/* Alwayws set the new offset value and realign the ring. */
1651506cc70cSLuigi Rizzo 	kring->nkr_hwofs = new_hwofs;
1652506cc70cSLuigi Rizzo 	if (tx == NR_TX)
1653506cc70cSLuigi Rizzo 		kring->nr_hwavail = kring->nkr_num_slots - 1;
16548241616dSLuigi Rizzo 	ND(10, "new hwofs %d on %s %s[%d]",
1655506cc70cSLuigi Rizzo 			kring->nkr_hwofs, na->ifp->if_xname,
1656506cc70cSLuigi Rizzo 			tx == NR_TX ? "TX" : "RX", n);
1657506cc70cSLuigi Rizzo 
1658f196ce38SLuigi Rizzo #if 0 // def linux
1659f196ce38SLuigi Rizzo 	/* XXX check that the mappings are correct */
1660f196ce38SLuigi Rizzo 	/* need ring_nr, adapter->pdev, direction */
1661f196ce38SLuigi Rizzo 	buffer_info->dma = dma_map_single(&pdev->dev, addr, adapter->rx_buffer_len, DMA_FROM_DEVICE);
1662f196ce38SLuigi Rizzo 	if (dma_mapping_error(&adapter->pdev->dev, buffer_info->dma)) {
1663f196ce38SLuigi Rizzo 		D("error mapping rx netmap buffer %d", i);
1664f196ce38SLuigi Rizzo 		// XXX fix error handling
1665f196ce38SLuigi Rizzo 	}
1666f196ce38SLuigi Rizzo 
1667f196ce38SLuigi Rizzo #endif /* linux */
166868b8534bSLuigi Rizzo 	/*
166964ae02c3SLuigi Rizzo 	 * Wakeup on the individual and global lock
1670506cc70cSLuigi Rizzo 	 * We do the wakeup here, but the ring is not yet reconfigured.
1671506cc70cSLuigi Rizzo 	 * However, we are under lock so there are no races.
167268b8534bSLuigi Rizzo 	 */
167368b8534bSLuigi Rizzo 	selwakeuppri(&kring->si, PI_NET);
167464ae02c3SLuigi Rizzo 	selwakeuppri(tx == NR_TX ? &na->tx_si : &na->rx_si, PI_NET);
167568b8534bSLuigi Rizzo 	return kring->ring->slot;
167668b8534bSLuigi Rizzo }
167768b8534bSLuigi Rizzo 
167868b8534bSLuigi Rizzo 
167968b8534bSLuigi Rizzo /*
16801a26580eSLuigi Rizzo  * Default functions to handle rx/tx interrupts
16811a26580eSLuigi Rizzo  * we have 4 cases:
16821a26580eSLuigi Rizzo  * 1 ring, single lock:
16831a26580eSLuigi Rizzo  *	lock(core); wake(i=0); unlock(core)
16841a26580eSLuigi Rizzo  * N rings, single lock:
16851a26580eSLuigi Rizzo  *	lock(core); wake(i); wake(N+1) unlock(core)
16861a26580eSLuigi Rizzo  * 1 ring, separate locks: (i=0)
16871a26580eSLuigi Rizzo  *	lock(i); wake(i); unlock(i)
16881a26580eSLuigi Rizzo  * N rings, separate locks:
16891a26580eSLuigi Rizzo  *	lock(i); wake(i); unlock(i); lock(core) wake(N+1) unlock(core)
169064ae02c3SLuigi Rizzo  * work_done is non-null on the RX path.
16911a26580eSLuigi Rizzo  */
1692babc7c12SLuigi Rizzo int
1693babc7c12SLuigi Rizzo netmap_rx_irq(struct ifnet *ifp, int q, int *work_done)
16941a26580eSLuigi Rizzo {
16951a26580eSLuigi Rizzo 	struct netmap_adapter *na;
16961a26580eSLuigi Rizzo 	struct netmap_kring *r;
169764ae02c3SLuigi Rizzo 	NM_SELINFO_T *main_wq;
16981a26580eSLuigi Rizzo 
16991a26580eSLuigi Rizzo 	if (!(ifp->if_capenable & IFCAP_NETMAP))
17001a26580eSLuigi Rizzo 		return 0;
17018241616dSLuigi Rizzo 	ND(5, "received %s queue %d", work_done ? "RX" : "TX" , q);
17021a26580eSLuigi Rizzo 	na = NA(ifp);
17038241616dSLuigi Rizzo 	if (na->na_flags & NAF_SKIP_INTR) {
17048241616dSLuigi Rizzo 		ND("use regular interrupt");
17058241616dSLuigi Rizzo 		return 0;
17068241616dSLuigi Rizzo 	}
17078241616dSLuigi Rizzo 
170864ae02c3SLuigi Rizzo 	if (work_done) { /* RX path */
17098241616dSLuigi Rizzo 		if (q >= na->num_rx_rings)
17108241616dSLuigi Rizzo 			return 0;	// regular queue
171164ae02c3SLuigi Rizzo 		r = na->rx_rings + q;
171264ae02c3SLuigi Rizzo 		r->nr_kflags |= NKR_PENDINTR;
1713d76bf4ffSLuigi Rizzo 		main_wq = (na->num_rx_rings > 1) ? &na->rx_si : NULL;
171464ae02c3SLuigi Rizzo 	} else { /* tx path */
17158241616dSLuigi Rizzo 		if (q >= na->num_tx_rings)
17168241616dSLuigi Rizzo 			return 0;	// regular queue
171764ae02c3SLuigi Rizzo 		r = na->tx_rings + q;
1718d76bf4ffSLuigi Rizzo 		main_wq = (na->num_tx_rings > 1) ? &na->tx_si : NULL;
171964ae02c3SLuigi Rizzo 		work_done = &q; /* dummy */
172064ae02c3SLuigi Rizzo 	}
17211a26580eSLuigi Rizzo 	if (na->separate_locks) {
172264ae02c3SLuigi Rizzo 		mtx_lock(&r->q_lock);
172364ae02c3SLuigi Rizzo 		selwakeuppri(&r->si, PI_NET);
172464ae02c3SLuigi Rizzo 		mtx_unlock(&r->q_lock);
172564ae02c3SLuigi Rizzo 		if (main_wq) {
17261a26580eSLuigi Rizzo 			mtx_lock(&na->core_lock);
172764ae02c3SLuigi Rizzo 			selwakeuppri(main_wq, PI_NET);
17281a26580eSLuigi Rizzo 			mtx_unlock(&na->core_lock);
17291a26580eSLuigi Rizzo 		}
17301a26580eSLuigi Rizzo 	} else {
17311a26580eSLuigi Rizzo 		mtx_lock(&na->core_lock);
173264ae02c3SLuigi Rizzo 		selwakeuppri(&r->si, PI_NET);
173364ae02c3SLuigi Rizzo 		if (main_wq)
173464ae02c3SLuigi Rizzo 			selwakeuppri(main_wq, PI_NET);
17351a26580eSLuigi Rizzo 		mtx_unlock(&na->core_lock);
17361a26580eSLuigi Rizzo 	}
17371a26580eSLuigi Rizzo 	*work_done = 1; /* do not fire napi again */
17381a26580eSLuigi Rizzo 	return 1;
17391a26580eSLuigi Rizzo }
17401a26580eSLuigi Rizzo 
174164ae02c3SLuigi Rizzo 
174201c7d25fSLuigi Rizzo #ifdef linux	/* linux-specific routines */
174301c7d25fSLuigi Rizzo 
174401c7d25fSLuigi Rizzo /*
174501c7d25fSLuigi Rizzo  * Remap linux arguments into the FreeBSD call.
174601c7d25fSLuigi Rizzo  * - pwait is the poll table, passed as 'dev';
174701c7d25fSLuigi Rizzo  *   If pwait == NULL someone else already woke up before. We can report
174801c7d25fSLuigi Rizzo  *   events but they are filtered upstream.
174901c7d25fSLuigi Rizzo  *   If pwait != NULL, then pwait->key contains the list of events.
175001c7d25fSLuigi Rizzo  * - events is computed from pwait as above.
175101c7d25fSLuigi Rizzo  * - file is passed as 'td';
175201c7d25fSLuigi Rizzo  */
175301c7d25fSLuigi Rizzo static u_int
175401c7d25fSLuigi Rizzo linux_netmap_poll(struct file * file, struct poll_table_struct *pwait)
175501c7d25fSLuigi Rizzo {
175601c7d25fSLuigi Rizzo #if LINUX_VERSION_CODE < KERNEL_VERSION(3,4,0)
175701c7d25fSLuigi Rizzo 	int events = pwait ? pwait->key : POLLIN | POLLOUT;
175801c7d25fSLuigi Rizzo #else /* in 3.4.0 field 'key' was renamed to '_key' */
175901c7d25fSLuigi Rizzo 	int events = pwait ? pwait->_key : POLLIN | POLLOUT;
176001c7d25fSLuigi Rizzo #endif
176101c7d25fSLuigi Rizzo 	return netmap_poll((void *)pwait, events, (void *)file);
176201c7d25fSLuigi Rizzo }
176301c7d25fSLuigi Rizzo 
176401c7d25fSLuigi Rizzo static int
176542a3a5bdSLuigi Rizzo linux_netmap_mmap(struct file *f, struct vm_area_struct *vma)
176601c7d25fSLuigi Rizzo {
176701c7d25fSLuigi Rizzo 	int lut_skip, i, j;
176801c7d25fSLuigi Rizzo 	int user_skip = 0;
176901c7d25fSLuigi Rizzo 	struct lut_entry *l_entry;
17708241616dSLuigi Rizzo 	int error = 0;
17718241616dSLuigi Rizzo 	unsigned long off, tomap;
177201c7d25fSLuigi Rizzo 	/*
177301c7d25fSLuigi Rizzo 	 * vma->vm_start: start of mapping user address space
177401c7d25fSLuigi Rizzo 	 * vma->vm_end: end of the mapping user address space
17758241616dSLuigi Rizzo 	 * vma->vm_pfoff: offset of first page in the device
177601c7d25fSLuigi Rizzo 	 */
177701c7d25fSLuigi Rizzo 
177801c7d25fSLuigi Rizzo 	// XXX security checks
177901c7d25fSLuigi Rizzo 
17808241616dSLuigi Rizzo 	error = netmap_get_memory(f->private_data);
17818241616dSLuigi Rizzo 	ND("get_memory returned %d", error);
17828241616dSLuigi Rizzo 	if (error)
17838241616dSLuigi Rizzo 	    return -error;
17848241616dSLuigi Rizzo 
17858241616dSLuigi Rizzo 	off = vma->vm_pgoff << PAGE_SHIFT; /* offset in bytes */
17868241616dSLuigi Rizzo 	tomap = vma->vm_end - vma->vm_start;
17878241616dSLuigi Rizzo 	for (i = 0; i < NETMAP_POOLS_NR; i++) {  /* loop through obj_pools */
17888241616dSLuigi Rizzo 		const struct netmap_obj_pool *p = &nm_mem.pools[i];
178901c7d25fSLuigi Rizzo 		/*
179001c7d25fSLuigi Rizzo 		 * In each pool memory is allocated in clusters
179101c7d25fSLuigi Rizzo 		 * of size _clustsize, each containing clustentries
179201c7d25fSLuigi Rizzo 		 * entries. For each object k we already store the
17938241616dSLuigi Rizzo 		 * vtophys mapping in lut[k] so we use that, scanning
179401c7d25fSLuigi Rizzo 		 * the lut[] array in steps of clustentries,
179501c7d25fSLuigi Rizzo 		 * and we map each cluster (not individual pages,
179601c7d25fSLuigi Rizzo 		 * it would be overkill).
179701c7d25fSLuigi Rizzo 		 */
17988241616dSLuigi Rizzo 
17998241616dSLuigi Rizzo 		/*
18008241616dSLuigi Rizzo 		 * We interpret vm_pgoff as an offset into the whole
18018241616dSLuigi Rizzo 		 * netmap memory, as if all clusters where contiguous.
18028241616dSLuigi Rizzo 		 */
18038241616dSLuigi Rizzo 		for (lut_skip = 0, j = 0; j < p->_numclusters; j++, lut_skip += p->clustentries) {
18048241616dSLuigi Rizzo 			unsigned long paddr, mapsize;
18058241616dSLuigi Rizzo 			if (p->_clustsize <= off) {
18068241616dSLuigi Rizzo 				off -= p->_clustsize;
18078241616dSLuigi Rizzo 				continue;
18088241616dSLuigi Rizzo 			}
18098241616dSLuigi Rizzo 			l_entry = &p->lut[lut_skip]; /* first obj in the cluster */
18108241616dSLuigi Rizzo 			paddr = l_entry->paddr + off;
18118241616dSLuigi Rizzo 			mapsize = p->_clustsize - off;
18128241616dSLuigi Rizzo 			off = 0;
18138241616dSLuigi Rizzo 			if (mapsize > tomap)
18148241616dSLuigi Rizzo 				mapsize = tomap;
18158241616dSLuigi Rizzo 			ND("remap_pfn_range(%lx, %lx, %lx)",
18168241616dSLuigi Rizzo 				vma->vm_start + user_skip,
18178241616dSLuigi Rizzo 				paddr >> PAGE_SHIFT, mapsize);
181801c7d25fSLuigi Rizzo 			if (remap_pfn_range(vma, vma->vm_start + user_skip,
18198241616dSLuigi Rizzo 					paddr >> PAGE_SHIFT, mapsize,
182001c7d25fSLuigi Rizzo 					vma->vm_page_prot))
182101c7d25fSLuigi Rizzo 				return -EAGAIN; // XXX check return value
18228241616dSLuigi Rizzo 			user_skip += mapsize;
18238241616dSLuigi Rizzo 			tomap -= mapsize;
18248241616dSLuigi Rizzo 			if (tomap == 0)
18258241616dSLuigi Rizzo 				goto done;
182601c7d25fSLuigi Rizzo 		}
182701c7d25fSLuigi Rizzo 	}
18288241616dSLuigi Rizzo done:
182901c7d25fSLuigi Rizzo 
183001c7d25fSLuigi Rizzo 	return 0;
183101c7d25fSLuigi Rizzo }
183201c7d25fSLuigi Rizzo 
183301c7d25fSLuigi Rizzo static netdev_tx_t
183442a3a5bdSLuigi Rizzo linux_netmap_start(struct sk_buff *skb, struct net_device *dev)
183501c7d25fSLuigi Rizzo {
183601c7d25fSLuigi Rizzo 	netmap_start(dev, skb);
183701c7d25fSLuigi Rizzo 	return (NETDEV_TX_OK);
183801c7d25fSLuigi Rizzo }
183901c7d25fSLuigi Rizzo 
184001c7d25fSLuigi Rizzo 
18410b8ed8e0SLuigi Rizzo #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,37)	// XXX was 38
184201c7d25fSLuigi Rizzo #define LIN_IOCTL_NAME	.ioctl
184301c7d25fSLuigi Rizzo int
184401c7d25fSLuigi Rizzo linux_netmap_ioctl(struct inode *inode, struct file *file, u_int cmd, u_long data /* arg */)
184501c7d25fSLuigi Rizzo #else
184601c7d25fSLuigi Rizzo #define LIN_IOCTL_NAME	.unlocked_ioctl
184701c7d25fSLuigi Rizzo long
184801c7d25fSLuigi Rizzo linux_netmap_ioctl(struct file *file, u_int cmd, u_long data /* arg */)
184901c7d25fSLuigi Rizzo #endif
185001c7d25fSLuigi Rizzo {
185101c7d25fSLuigi Rizzo 	int ret;
185201c7d25fSLuigi Rizzo 	struct nmreq nmr;
185301c7d25fSLuigi Rizzo 	bzero(&nmr, sizeof(nmr));
185401c7d25fSLuigi Rizzo 
185501c7d25fSLuigi Rizzo 	if (data && copy_from_user(&nmr, (void *)data, sizeof(nmr) ) != 0)
185601c7d25fSLuigi Rizzo 		return -EFAULT;
185701c7d25fSLuigi Rizzo 	ret = netmap_ioctl(NULL, cmd, (caddr_t)&nmr, 0, (void *)file);
185801c7d25fSLuigi Rizzo 	if (data && copy_to_user((void*)data, &nmr, sizeof(nmr) ) != 0)
185901c7d25fSLuigi Rizzo 		return -EFAULT;
186001c7d25fSLuigi Rizzo 	return -ret;
186101c7d25fSLuigi Rizzo }
186201c7d25fSLuigi Rizzo 
186301c7d25fSLuigi Rizzo 
186401c7d25fSLuigi Rizzo static int
18650b8ed8e0SLuigi Rizzo netmap_release(struct inode *inode, struct file *file)
186601c7d25fSLuigi Rizzo {
18670b8ed8e0SLuigi Rizzo 	(void)inode;	/* UNUSED */
186801c7d25fSLuigi Rizzo 	if (file->private_data)
186901c7d25fSLuigi Rizzo 		netmap_dtor(file->private_data);
187001c7d25fSLuigi Rizzo 	return (0);
187101c7d25fSLuigi Rizzo }
187201c7d25fSLuigi Rizzo 
18738241616dSLuigi Rizzo static int
18748241616dSLuigi Rizzo linux_netmap_open(struct inode *inode, struct file *file)
18758241616dSLuigi Rizzo {
18768241616dSLuigi Rizzo 	struct netmap_priv_d *priv;
18778241616dSLuigi Rizzo 	(void)inode;	/* UNUSED */
18788241616dSLuigi Rizzo 
18798241616dSLuigi Rizzo 	priv = malloc(sizeof(struct netmap_priv_d), M_DEVBUF,
18808241616dSLuigi Rizzo 			      M_NOWAIT | M_ZERO);
18818241616dSLuigi Rizzo 	if (priv == NULL)
18828241616dSLuigi Rizzo 		return -ENOMEM;
18838241616dSLuigi Rizzo 
18848241616dSLuigi Rizzo 	file->private_data = priv;
18858241616dSLuigi Rizzo 
18868241616dSLuigi Rizzo 	return (0);
18878241616dSLuigi Rizzo }
188801c7d25fSLuigi Rizzo 
188901c7d25fSLuigi Rizzo static struct file_operations netmap_fops = {
18908241616dSLuigi Rizzo     .open = linux_netmap_open,
189142a3a5bdSLuigi Rizzo     .mmap = linux_netmap_mmap,
189201c7d25fSLuigi Rizzo     LIN_IOCTL_NAME = linux_netmap_ioctl,
189301c7d25fSLuigi Rizzo     .poll = linux_netmap_poll,
189401c7d25fSLuigi Rizzo     .release = netmap_release,
189501c7d25fSLuigi Rizzo };
189601c7d25fSLuigi Rizzo 
189701c7d25fSLuigi Rizzo static struct miscdevice netmap_cdevsw = {	/* same name as FreeBSD */
189801c7d25fSLuigi Rizzo 	MISC_DYNAMIC_MINOR,
189901c7d25fSLuigi Rizzo 	"netmap",
190001c7d25fSLuigi Rizzo 	&netmap_fops,
190101c7d25fSLuigi Rizzo };
190201c7d25fSLuigi Rizzo 
190301c7d25fSLuigi Rizzo static int netmap_init(void);
190401c7d25fSLuigi Rizzo static void netmap_fini(void);
190501c7d25fSLuigi Rizzo 
190642a3a5bdSLuigi Rizzo /* Errors have negative values on linux */
190742a3a5bdSLuigi Rizzo static int linux_netmap_init(void)
190842a3a5bdSLuigi Rizzo {
190942a3a5bdSLuigi Rizzo 	return -netmap_init();
191042a3a5bdSLuigi Rizzo }
191142a3a5bdSLuigi Rizzo 
191242a3a5bdSLuigi Rizzo module_init(linux_netmap_init);
191301c7d25fSLuigi Rizzo module_exit(netmap_fini);
191401c7d25fSLuigi Rizzo /* export certain symbols to other modules */
191501c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_attach);		// driver attach routines
191601c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_detach);		// driver detach routines
191701c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_ring_reinit);	// ring init on error
191801c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_buffer_lut);
191901c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_total_buffers);	// index check
192001c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_buffer_base);
192101c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_reset);		// ring init routines
192201c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_buf_size);
192301c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_rx_irq);		// default irq handler
192401c7d25fSLuigi Rizzo EXPORT_SYMBOL(netmap_no_pendintr);	// XXX mitigation - should go away
192501c7d25fSLuigi Rizzo 
192601c7d25fSLuigi Rizzo 
192701c7d25fSLuigi Rizzo MODULE_AUTHOR("http://info.iet.unipi.it/~luigi/netmap/");
192801c7d25fSLuigi Rizzo MODULE_DESCRIPTION("The netmap packet I/O framework");
192901c7d25fSLuigi Rizzo MODULE_LICENSE("Dual BSD/GPL"); /* the code here is all BSD. */
193001c7d25fSLuigi Rizzo 
193101c7d25fSLuigi Rizzo #else /* __FreeBSD__ */
193201c7d25fSLuigi Rizzo 
1933babc7c12SLuigi Rizzo static struct cdevsw netmap_cdevsw = {
1934babc7c12SLuigi Rizzo 	.d_version = D_VERSION,
1935babc7c12SLuigi Rizzo 	.d_name = "netmap",
19368241616dSLuigi Rizzo 	.d_open = netmap_open,
1937babc7c12SLuigi Rizzo 	.d_mmap = netmap_mmap,
19388241616dSLuigi Rizzo 	.d_mmap_single = netmap_mmap_single,
1939babc7c12SLuigi Rizzo 	.d_ioctl = netmap_ioctl,
1940babc7c12SLuigi Rizzo 	.d_poll = netmap_poll,
19418241616dSLuigi Rizzo 	.d_close = netmap_close,
1942babc7c12SLuigi Rizzo };
194301c7d25fSLuigi Rizzo #endif /* __FreeBSD__ */
1944babc7c12SLuigi Rizzo 
1945f196ce38SLuigi Rizzo #ifdef NM_BRIDGE
1946f196ce38SLuigi Rizzo /*
1947f196ce38SLuigi Rizzo  *---- support for virtual bridge -----
1948f196ce38SLuigi Rizzo  */
1949f196ce38SLuigi Rizzo 
1950f196ce38SLuigi Rizzo /* ----- FreeBSD if_bridge hash function ------- */
1951f196ce38SLuigi Rizzo 
1952f196ce38SLuigi Rizzo /*
1953f196ce38SLuigi Rizzo  * The following hash function is adapted from "Hash Functions" by Bob Jenkins
1954f196ce38SLuigi Rizzo  * ("Algorithm Alley", Dr. Dobbs Journal, September 1997).
1955f196ce38SLuigi Rizzo  *
1956f196ce38SLuigi Rizzo  * http://www.burtleburtle.net/bob/hash/spooky.html
1957f196ce38SLuigi Rizzo  */
1958f196ce38SLuigi Rizzo #define mix(a, b, c)                                                    \
1959f196ce38SLuigi Rizzo do {                                                                    \
1960f196ce38SLuigi Rizzo         a -= b; a -= c; a ^= (c >> 13);                                 \
1961f196ce38SLuigi Rizzo         b -= c; b -= a; b ^= (a << 8);                                  \
1962f196ce38SLuigi Rizzo         c -= a; c -= b; c ^= (b >> 13);                                 \
1963f196ce38SLuigi Rizzo         a -= b; a -= c; a ^= (c >> 12);                                 \
1964f196ce38SLuigi Rizzo         b -= c; b -= a; b ^= (a << 16);                                 \
1965f196ce38SLuigi Rizzo         c -= a; c -= b; c ^= (b >> 5);                                  \
1966f196ce38SLuigi Rizzo         a -= b; a -= c; a ^= (c >> 3);                                  \
1967f196ce38SLuigi Rizzo         b -= c; b -= a; b ^= (a << 10);                                 \
1968f196ce38SLuigi Rizzo         c -= a; c -= b; c ^= (b >> 15);                                 \
1969f196ce38SLuigi Rizzo } while (/*CONSTCOND*/0)
1970f196ce38SLuigi Rizzo 
1971f196ce38SLuigi Rizzo static __inline uint32_t
1972f196ce38SLuigi Rizzo nm_bridge_rthash(const uint8_t *addr)
1973f196ce38SLuigi Rizzo {
1974f196ce38SLuigi Rizzo         uint32_t a = 0x9e3779b9, b = 0x9e3779b9, c = 0; // hask key
1975f196ce38SLuigi Rizzo 
1976f196ce38SLuigi Rizzo         b += addr[5] << 8;
1977f196ce38SLuigi Rizzo         b += addr[4];
1978f196ce38SLuigi Rizzo         a += addr[3] << 24;
1979f196ce38SLuigi Rizzo         a += addr[2] << 16;
1980f196ce38SLuigi Rizzo         a += addr[1] << 8;
1981f196ce38SLuigi Rizzo         a += addr[0];
1982f196ce38SLuigi Rizzo 
1983f196ce38SLuigi Rizzo         mix(a, b, c);
1984f196ce38SLuigi Rizzo #define BRIDGE_RTHASH_MASK	(NM_BDG_HASH-1)
1985f196ce38SLuigi Rizzo         return (c & BRIDGE_RTHASH_MASK);
1986f196ce38SLuigi Rizzo }
1987f196ce38SLuigi Rizzo 
1988f196ce38SLuigi Rizzo #undef mix
1989f196ce38SLuigi Rizzo 
1990f196ce38SLuigi Rizzo 
1991f196ce38SLuigi Rizzo static int
1992f196ce38SLuigi Rizzo bdg_netmap_reg(struct ifnet *ifp, int onoff)
1993f196ce38SLuigi Rizzo {
1994f196ce38SLuigi Rizzo 	int i, err = 0;
1995f196ce38SLuigi Rizzo 	struct nm_bridge *b = ifp->if_bridge;
1996f196ce38SLuigi Rizzo 
1997f196ce38SLuigi Rizzo 	BDG_LOCK(b);
1998f196ce38SLuigi Rizzo 	if (onoff) {
1999f196ce38SLuigi Rizzo 		/* the interface must be already in the list.
2000f196ce38SLuigi Rizzo 		 * only need to mark the port as active
2001f196ce38SLuigi Rizzo 		 */
2002f196ce38SLuigi Rizzo 		ND("should attach %s to the bridge", ifp->if_xname);
2003f196ce38SLuigi Rizzo 		for (i=0; i < NM_BDG_MAXPORTS; i++)
2004f196ce38SLuigi Rizzo 			if (b->bdg_ports[i] == ifp)
2005f196ce38SLuigi Rizzo 				break;
2006f196ce38SLuigi Rizzo 		if (i == NM_BDG_MAXPORTS) {
2007f196ce38SLuigi Rizzo 			D("no more ports available");
2008f196ce38SLuigi Rizzo 			err = EINVAL;
2009f196ce38SLuigi Rizzo 			goto done;
2010f196ce38SLuigi Rizzo 		}
2011f196ce38SLuigi Rizzo 		ND("setting %s in netmap mode", ifp->if_xname);
2012f196ce38SLuigi Rizzo 		ifp->if_capenable |= IFCAP_NETMAP;
2013f196ce38SLuigi Rizzo 		NA(ifp)->bdg_port = i;
2014f196ce38SLuigi Rizzo 		b->act_ports |= (1<<i);
2015f196ce38SLuigi Rizzo 		b->bdg_ports[i] = ifp;
2016f196ce38SLuigi Rizzo 	} else {
2017f196ce38SLuigi Rizzo 		/* should be in the list, too -- remove from the mask */
2018f196ce38SLuigi Rizzo 		ND("removing %s from netmap mode", ifp->if_xname);
2019f196ce38SLuigi Rizzo 		ifp->if_capenable &= ~IFCAP_NETMAP;
2020f196ce38SLuigi Rizzo 		i = NA(ifp)->bdg_port;
2021f196ce38SLuigi Rizzo 		b->act_ports &= ~(1<<i);
2022f196ce38SLuigi Rizzo 	}
2023f196ce38SLuigi Rizzo done:
2024f196ce38SLuigi Rizzo 	BDG_UNLOCK(b);
2025f196ce38SLuigi Rizzo 	return err;
2026f196ce38SLuigi Rizzo }
2027f196ce38SLuigi Rizzo 
2028f196ce38SLuigi Rizzo 
2029f196ce38SLuigi Rizzo static int
2030f196ce38SLuigi Rizzo nm_bdg_flush(struct nm_bdg_fwd *ft, int n, struct ifnet *ifp)
2031f196ce38SLuigi Rizzo {
2032f196ce38SLuigi Rizzo 	int i, ifn;
2033f196ce38SLuigi Rizzo 	uint64_t all_dst, dst;
2034f196ce38SLuigi Rizzo 	uint32_t sh, dh;
2035f196ce38SLuigi Rizzo 	uint64_t mysrc = 1 << NA(ifp)->bdg_port;
2036f196ce38SLuigi Rizzo 	uint64_t smac, dmac;
2037f196ce38SLuigi Rizzo 	struct netmap_slot *slot;
2038f196ce38SLuigi Rizzo 	struct nm_bridge *b = ifp->if_bridge;
2039f196ce38SLuigi Rizzo 
2040f196ce38SLuigi Rizzo 	ND("prepare to send %d packets, act_ports 0x%x", n, b->act_ports);
2041f196ce38SLuigi Rizzo 	/* only consider valid destinations */
2042f196ce38SLuigi Rizzo 	all_dst = (b->act_ports & ~mysrc);
2043f196ce38SLuigi Rizzo 	/* first pass: hash and find destinations */
2044f196ce38SLuigi Rizzo 	for (i = 0; likely(i < n); i++) {
2045f196ce38SLuigi Rizzo 		uint8_t *buf = ft[i].buf;
2046f196ce38SLuigi Rizzo 		dmac = le64toh(*(uint64_t *)(buf)) & 0xffffffffffff;
2047f196ce38SLuigi Rizzo 		smac = le64toh(*(uint64_t *)(buf + 4));
2048f196ce38SLuigi Rizzo 		smac >>= 16;
2049f196ce38SLuigi Rizzo 		if (unlikely(netmap_verbose)) {
2050f196ce38SLuigi Rizzo 		    uint8_t *s = buf+6, *d = buf;
2051f196ce38SLuigi Rizzo 		    D("%d len %4d %02x:%02x:%02x:%02x:%02x:%02x -> %02x:%02x:%02x:%02x:%02x:%02x",
2052f196ce38SLuigi Rizzo 			i,
2053f196ce38SLuigi Rizzo 			ft[i].len,
2054f196ce38SLuigi Rizzo 			s[0], s[1], s[2], s[3], s[4], s[5],
2055f196ce38SLuigi Rizzo 			d[0], d[1], d[2], d[3], d[4], d[5]);
2056f196ce38SLuigi Rizzo 		}
2057f196ce38SLuigi Rizzo 		/*
2058f196ce38SLuigi Rizzo 		 * The hash is somewhat expensive, there might be some
2059f196ce38SLuigi Rizzo 		 * worthwhile optimizations here.
2060f196ce38SLuigi Rizzo 		 */
2061f196ce38SLuigi Rizzo 		if ((buf[6] & 1) == 0) { /* valid src */
2062f196ce38SLuigi Rizzo 		    	uint8_t *s = buf+6;
2063f196ce38SLuigi Rizzo 			sh = nm_bridge_rthash(buf+6); // XXX hash of source
2064f196ce38SLuigi Rizzo 			/* update source port forwarding entry */
2065f196ce38SLuigi Rizzo 			b->ht[sh].mac = smac;	/* XXX expire ? */
2066f196ce38SLuigi Rizzo 			b->ht[sh].ports = mysrc;
2067f196ce38SLuigi Rizzo 			if (netmap_verbose)
2068f196ce38SLuigi Rizzo 			    D("src %02x:%02x:%02x:%02x:%02x:%02x on port %d",
2069f196ce38SLuigi Rizzo 				s[0], s[1], s[2], s[3], s[4], s[5], NA(ifp)->bdg_port);
2070f196ce38SLuigi Rizzo 		}
2071f196ce38SLuigi Rizzo 		dst = 0;
2072f196ce38SLuigi Rizzo 		if ( (buf[0] & 1) == 0) { /* unicast */
2073f196ce38SLuigi Rizzo 		    	uint8_t *d = buf;
2074f196ce38SLuigi Rizzo 			dh = nm_bridge_rthash(buf); // XXX hash of dst
2075f196ce38SLuigi Rizzo 			if (b->ht[dh].mac == dmac) {	/* found dst */
2076f196ce38SLuigi Rizzo 				dst = b->ht[dh].ports;
2077f196ce38SLuigi Rizzo 				if (netmap_verbose)
2078f196ce38SLuigi Rizzo 				    D("dst %02x:%02x:%02x:%02x:%02x:%02x to port %x",
2079f196ce38SLuigi Rizzo 					d[0], d[1], d[2], d[3], d[4], d[5], (uint32_t)(dst >> 16));
2080f196ce38SLuigi Rizzo 			}
2081f196ce38SLuigi Rizzo 		}
2082f196ce38SLuigi Rizzo 		if (dst == 0)
2083f196ce38SLuigi Rizzo 			dst = all_dst;
2084f196ce38SLuigi Rizzo 		dst &= all_dst; /* only consider valid ports */
2085f196ce38SLuigi Rizzo 		if (unlikely(netmap_verbose))
2086f196ce38SLuigi Rizzo 			D("pkt goes to ports 0x%x", (uint32_t)dst);
2087f196ce38SLuigi Rizzo 		ft[i].dst = dst;
2088f196ce38SLuigi Rizzo 	}
2089f196ce38SLuigi Rizzo 
2090f196ce38SLuigi Rizzo 	/* second pass, scan interfaces and forward */
2091f196ce38SLuigi Rizzo 	all_dst = (b->act_ports & ~mysrc);
2092f196ce38SLuigi Rizzo 	for (ifn = 0; all_dst; ifn++) {
2093f196ce38SLuigi Rizzo 		struct ifnet *dst_ifp = b->bdg_ports[ifn];
2094f196ce38SLuigi Rizzo 		struct netmap_adapter *na;
2095f196ce38SLuigi Rizzo 		struct netmap_kring *kring;
2096f196ce38SLuigi Rizzo 		struct netmap_ring *ring;
2097f196ce38SLuigi Rizzo 		int j, lim, sent, locked;
2098f196ce38SLuigi Rizzo 
2099f196ce38SLuigi Rizzo 		if (!dst_ifp)
2100f196ce38SLuigi Rizzo 			continue;
2101f196ce38SLuigi Rizzo 		ND("scan port %d %s", ifn, dst_ifp->if_xname);
2102f196ce38SLuigi Rizzo 		dst = 1 << ifn;
2103f196ce38SLuigi Rizzo 		if ((dst & all_dst) == 0)	/* skip if not set */
2104f196ce38SLuigi Rizzo 			continue;
2105f196ce38SLuigi Rizzo 		all_dst &= ~dst;	/* clear current node */
2106f196ce38SLuigi Rizzo 		na = NA(dst_ifp);
2107f196ce38SLuigi Rizzo 
2108f196ce38SLuigi Rizzo 		ring = NULL;
2109f196ce38SLuigi Rizzo 		kring = NULL;
2110f196ce38SLuigi Rizzo 		lim = sent = locked = 0;
2111f196ce38SLuigi Rizzo 		/* inside, scan slots */
2112f196ce38SLuigi Rizzo 		for (i = 0; likely(i < n); i++) {
2113f196ce38SLuigi Rizzo 			if ((ft[i].dst & dst) == 0)
2114f196ce38SLuigi Rizzo 				continue;	/* not here */
2115f196ce38SLuigi Rizzo 			if (!locked) {
2116f196ce38SLuigi Rizzo 				kring = &na->rx_rings[0];
2117f196ce38SLuigi Rizzo 				ring = kring->ring;
2118f196ce38SLuigi Rizzo 				lim = kring->nkr_num_slots - 1;
2119f196ce38SLuigi Rizzo 				na->nm_lock(dst_ifp, NETMAP_RX_LOCK, 0);
2120f196ce38SLuigi Rizzo 				locked = 1;
2121f196ce38SLuigi Rizzo 			}
2122f196ce38SLuigi Rizzo 			if (unlikely(kring->nr_hwavail >= lim)) {
2123f196ce38SLuigi Rizzo 				if (netmap_verbose)
2124f196ce38SLuigi Rizzo 					D("rx ring full on %s", ifp->if_xname);
2125f196ce38SLuigi Rizzo 				break;
2126f196ce38SLuigi Rizzo 			}
2127f196ce38SLuigi Rizzo 			j = kring->nr_hwcur + kring->nr_hwavail;
2128f196ce38SLuigi Rizzo 			if (j > lim)
2129f196ce38SLuigi Rizzo 				j -= kring->nkr_num_slots;
2130f196ce38SLuigi Rizzo 			slot = &ring->slot[j];
2131f196ce38SLuigi Rizzo 			ND("send %d %d bytes at %s:%d", i, ft[i].len, dst_ifp->if_xname, j);
2132f196ce38SLuigi Rizzo 			pkt_copy(ft[i].buf, NMB(slot), ft[i].len);
2133f196ce38SLuigi Rizzo 			slot->len = ft[i].len;
2134f196ce38SLuigi Rizzo 			kring->nr_hwavail++;
2135f196ce38SLuigi Rizzo 			sent++;
2136f196ce38SLuigi Rizzo 		}
2137f196ce38SLuigi Rizzo 		if (locked) {
2138f196ce38SLuigi Rizzo 			ND("sent %d on %s", sent, dst_ifp->if_xname);
2139f196ce38SLuigi Rizzo 			if (sent)
2140f196ce38SLuigi Rizzo 				selwakeuppri(&kring->si, PI_NET);
2141f196ce38SLuigi Rizzo 			na->nm_lock(dst_ifp, NETMAP_RX_UNLOCK, 0);
2142f196ce38SLuigi Rizzo 		}
2143f196ce38SLuigi Rizzo 	}
2144f196ce38SLuigi Rizzo 	return 0;
2145f196ce38SLuigi Rizzo }
2146f196ce38SLuigi Rizzo 
2147f196ce38SLuigi Rizzo /*
2148f196ce38SLuigi Rizzo  * main dispatch routine
2149f196ce38SLuigi Rizzo  */
2150f196ce38SLuigi Rizzo static int
2151f196ce38SLuigi Rizzo bdg_netmap_txsync(struct ifnet *ifp, u_int ring_nr, int do_lock)
2152f196ce38SLuigi Rizzo {
2153f196ce38SLuigi Rizzo 	struct netmap_adapter *na = NA(ifp);
2154f196ce38SLuigi Rizzo 	struct netmap_kring *kring = &na->tx_rings[ring_nr];
2155f196ce38SLuigi Rizzo 	struct netmap_ring *ring = kring->ring;
2156f196ce38SLuigi Rizzo 	int i, j, k, lim = kring->nkr_num_slots - 1;
2157f196ce38SLuigi Rizzo 	struct nm_bdg_fwd *ft = (struct nm_bdg_fwd *)(ifp + 1);
2158f196ce38SLuigi Rizzo 	int ft_i;	/* position in the forwarding table */
2159f196ce38SLuigi Rizzo 
2160f196ce38SLuigi Rizzo 	k = ring->cur;
2161f196ce38SLuigi Rizzo 	if (k > lim)
2162f196ce38SLuigi Rizzo 		return netmap_ring_reinit(kring);
2163f196ce38SLuigi Rizzo 	if (do_lock)
2164f196ce38SLuigi Rizzo 		na->nm_lock(ifp, NETMAP_TX_LOCK, ring_nr);
2165f196ce38SLuigi Rizzo 
2166f196ce38SLuigi Rizzo 	if (netmap_bridge <= 0) { /* testing only */
2167f196ce38SLuigi Rizzo 		j = k; // used all
2168f196ce38SLuigi Rizzo 		goto done;
2169f196ce38SLuigi Rizzo 	}
2170f196ce38SLuigi Rizzo 	if (netmap_bridge > NM_BDG_BATCH)
2171f196ce38SLuigi Rizzo 		netmap_bridge = NM_BDG_BATCH;
2172f196ce38SLuigi Rizzo 
2173f196ce38SLuigi Rizzo 	ft_i = 0;	/* start from 0 */
2174f196ce38SLuigi Rizzo 	for (j = kring->nr_hwcur; likely(j != k); j = unlikely(j == lim) ? 0 : j+1) {
2175f196ce38SLuigi Rizzo 		struct netmap_slot *slot = &ring->slot[j];
2176f196ce38SLuigi Rizzo 		int len = ft[ft_i].len = slot->len;
2177f196ce38SLuigi Rizzo 		char *buf = ft[ft_i].buf = NMB(slot);
2178f196ce38SLuigi Rizzo 
2179f196ce38SLuigi Rizzo 		prefetch(buf);
2180f196ce38SLuigi Rizzo 		if (unlikely(len < 14))
2181f196ce38SLuigi Rizzo 			continue;
2182f196ce38SLuigi Rizzo 		if (unlikely(++ft_i == netmap_bridge))
2183f196ce38SLuigi Rizzo 			ft_i = nm_bdg_flush(ft, ft_i, ifp);
2184f196ce38SLuigi Rizzo 	}
2185f196ce38SLuigi Rizzo 	if (ft_i)
2186f196ce38SLuigi Rizzo 		ft_i = nm_bdg_flush(ft, ft_i, ifp);
2187f196ce38SLuigi Rizzo 	/* count how many packets we sent */
2188f196ce38SLuigi Rizzo 	i = k - j;
2189f196ce38SLuigi Rizzo 	if (i < 0)
2190f196ce38SLuigi Rizzo 		i += kring->nkr_num_slots;
2191f196ce38SLuigi Rizzo 	kring->nr_hwavail = kring->nkr_num_slots - 1 - i;
2192f196ce38SLuigi Rizzo 	if (j != k)
2193f196ce38SLuigi Rizzo 		D("early break at %d/ %d, avail %d", j, k, kring->nr_hwavail);
2194f196ce38SLuigi Rizzo 
2195f196ce38SLuigi Rizzo done:
2196f196ce38SLuigi Rizzo 	kring->nr_hwcur = j;
2197f196ce38SLuigi Rizzo 	ring->avail = kring->nr_hwavail;
2198f196ce38SLuigi Rizzo 	if (do_lock)
2199f196ce38SLuigi Rizzo 		na->nm_lock(ifp, NETMAP_TX_UNLOCK, ring_nr);
2200f196ce38SLuigi Rizzo 
2201f196ce38SLuigi Rizzo 	if (netmap_verbose)
2202f196ce38SLuigi Rizzo 		D("%s ring %d lock %d", ifp->if_xname, ring_nr, do_lock);
2203f196ce38SLuigi Rizzo 	return 0;
2204f196ce38SLuigi Rizzo }
2205f196ce38SLuigi Rizzo 
2206f196ce38SLuigi Rizzo static int
2207f196ce38SLuigi Rizzo bdg_netmap_rxsync(struct ifnet *ifp, u_int ring_nr, int do_lock)
2208f196ce38SLuigi Rizzo {
2209f196ce38SLuigi Rizzo 	struct netmap_adapter *na = NA(ifp);
2210f196ce38SLuigi Rizzo 	struct netmap_kring *kring = &na->rx_rings[ring_nr];
2211f196ce38SLuigi Rizzo 	struct netmap_ring *ring = kring->ring;
2212b3d53016SLuigi Rizzo 	u_int j, n, lim = kring->nkr_num_slots - 1;
2213f196ce38SLuigi Rizzo 	u_int k = ring->cur, resvd = ring->reserved;
2214f196ce38SLuigi Rizzo 
2215f196ce38SLuigi Rizzo 	ND("%s ring %d lock %d avail %d",
2216f196ce38SLuigi Rizzo 		ifp->if_xname, ring_nr, do_lock, kring->nr_hwavail);
2217f196ce38SLuigi Rizzo 
2218f196ce38SLuigi Rizzo 	if (k > lim)
2219f196ce38SLuigi Rizzo 		return netmap_ring_reinit(kring);
2220f196ce38SLuigi Rizzo 	if (do_lock)
2221f196ce38SLuigi Rizzo 		na->nm_lock(ifp, NETMAP_RX_LOCK, ring_nr);
2222f196ce38SLuigi Rizzo 
2223f196ce38SLuigi Rizzo 	/* skip past packets that userspace has released */
2224f196ce38SLuigi Rizzo 	j = kring->nr_hwcur;    /* netmap ring index */
2225f196ce38SLuigi Rizzo 	if (resvd > 0) {
2226f196ce38SLuigi Rizzo 		if (resvd + ring->avail >= lim + 1) {
2227f196ce38SLuigi Rizzo 			D("XXX invalid reserve/avail %d %d", resvd, ring->avail);
2228f196ce38SLuigi Rizzo 			ring->reserved = resvd = 0; // XXX panic...
2229f196ce38SLuigi Rizzo 		}
2230f196ce38SLuigi Rizzo 		k = (k >= resvd) ? k - resvd : k + lim + 1 - resvd;
2231f196ce38SLuigi Rizzo 	}
2232f196ce38SLuigi Rizzo 
2233f196ce38SLuigi Rizzo 	if (j != k) { /* userspace has released some packets. */
2234f196ce38SLuigi Rizzo 		n = k - j;
2235f196ce38SLuigi Rizzo 		if (n < 0)
2236f196ce38SLuigi Rizzo 			n += kring->nkr_num_slots;
2237f196ce38SLuigi Rizzo 		ND("userspace releases %d packets", n);
2238f196ce38SLuigi Rizzo                 for (n = 0; likely(j != k); n++) {
2239f196ce38SLuigi Rizzo                         struct netmap_slot *slot = &ring->slot[j];
2240f196ce38SLuigi Rizzo                         void *addr = NMB(slot);
2241f196ce38SLuigi Rizzo 
2242f196ce38SLuigi Rizzo                         if (addr == netmap_buffer_base) { /* bad buf */
2243f196ce38SLuigi Rizzo                                 if (do_lock)
2244f196ce38SLuigi Rizzo                                         na->nm_lock(ifp, NETMAP_RX_UNLOCK, ring_nr);
2245f196ce38SLuigi Rizzo                                 return netmap_ring_reinit(kring);
2246f196ce38SLuigi Rizzo                         }
2247f196ce38SLuigi Rizzo 			/* decrease refcount for buffer */
2248f196ce38SLuigi Rizzo 
2249f196ce38SLuigi Rizzo 			slot->flags &= ~NS_BUF_CHANGED;
2250f196ce38SLuigi Rizzo                         j = unlikely(j == lim) ? 0 : j + 1;
2251f196ce38SLuigi Rizzo                 }
2252f196ce38SLuigi Rizzo                 kring->nr_hwavail -= n;
2253f196ce38SLuigi Rizzo                 kring->nr_hwcur = k;
2254f196ce38SLuigi Rizzo         }
2255f196ce38SLuigi Rizzo         /* tell userspace that there are new packets */
2256f196ce38SLuigi Rizzo         ring->avail = kring->nr_hwavail - resvd;
2257f196ce38SLuigi Rizzo 
2258f196ce38SLuigi Rizzo 	if (do_lock)
2259f196ce38SLuigi Rizzo 		na->nm_lock(ifp, NETMAP_RX_UNLOCK, ring_nr);
2260f196ce38SLuigi Rizzo 	return 0;
2261f196ce38SLuigi Rizzo }
2262f196ce38SLuigi Rizzo 
2263f196ce38SLuigi Rizzo static void
2264f196ce38SLuigi Rizzo bdg_netmap_attach(struct ifnet *ifp)
2265f196ce38SLuigi Rizzo {
2266f196ce38SLuigi Rizzo 	struct netmap_adapter na;
2267f196ce38SLuigi Rizzo 
2268f196ce38SLuigi Rizzo 	ND("attaching virtual bridge");
2269f196ce38SLuigi Rizzo 	bzero(&na, sizeof(na));
2270f196ce38SLuigi Rizzo 
2271f196ce38SLuigi Rizzo 	na.ifp = ifp;
2272f196ce38SLuigi Rizzo 	na.separate_locks = 1;
2273f196ce38SLuigi Rizzo 	na.num_tx_desc = NM_BRIDGE_RINGSIZE;
2274f196ce38SLuigi Rizzo 	na.num_rx_desc = NM_BRIDGE_RINGSIZE;
2275f196ce38SLuigi Rizzo 	na.nm_txsync = bdg_netmap_txsync;
2276f196ce38SLuigi Rizzo 	na.nm_rxsync = bdg_netmap_rxsync;
2277f196ce38SLuigi Rizzo 	na.nm_register = bdg_netmap_reg;
2278f196ce38SLuigi Rizzo 	netmap_attach(&na, 1);
2279f196ce38SLuigi Rizzo }
2280f196ce38SLuigi Rizzo 
2281f196ce38SLuigi Rizzo #endif /* NM_BRIDGE */
2282babc7c12SLuigi Rizzo 
2283babc7c12SLuigi Rizzo static struct cdev *netmap_dev; /* /dev/netmap character device. */
2284babc7c12SLuigi Rizzo 
2285babc7c12SLuigi Rizzo 
22861a26580eSLuigi Rizzo /*
228768b8534bSLuigi Rizzo  * Module loader.
228868b8534bSLuigi Rizzo  *
228968b8534bSLuigi Rizzo  * Create the /dev/netmap device and initialize all global
229068b8534bSLuigi Rizzo  * variables.
229168b8534bSLuigi Rizzo  *
229268b8534bSLuigi Rizzo  * Return 0 on success, errno on failure.
229368b8534bSLuigi Rizzo  */
229468b8534bSLuigi Rizzo static int
229568b8534bSLuigi Rizzo netmap_init(void)
229668b8534bSLuigi Rizzo {
229768b8534bSLuigi Rizzo 	int error;
229868b8534bSLuigi Rizzo 
229968b8534bSLuigi Rizzo 	error = netmap_memory_init();
230068b8534bSLuigi Rizzo 	if (error != 0) {
230142a3a5bdSLuigi Rizzo 		printf("netmap: unable to initialize the memory allocator.\n");
230268b8534bSLuigi Rizzo 		return (error);
230368b8534bSLuigi Rizzo 	}
23048241616dSLuigi Rizzo 	printf("netmap: loaded module\n");
230568b8534bSLuigi Rizzo 	netmap_dev = make_dev(&netmap_cdevsw, 0, UID_ROOT, GID_WHEEL, 0660,
230668b8534bSLuigi Rizzo 			      "netmap");
2307f196ce38SLuigi Rizzo 
2308f196ce38SLuigi Rizzo #ifdef NM_BRIDGE
2309f196ce38SLuigi Rizzo 	{
2310f196ce38SLuigi Rizzo 	int i;
2311f196ce38SLuigi Rizzo 	for (i = 0; i < NM_BRIDGES; i++)
2312f196ce38SLuigi Rizzo 		mtx_init(&nm_bridges[i].bdg_lock, "bdg lock", "bdg_lock", MTX_DEF);
2313f196ce38SLuigi Rizzo 	}
2314f196ce38SLuigi Rizzo #endif
2315babc7c12SLuigi Rizzo 	return (error);
231668b8534bSLuigi Rizzo }
231768b8534bSLuigi Rizzo 
231868b8534bSLuigi Rizzo 
231968b8534bSLuigi Rizzo /*
232068b8534bSLuigi Rizzo  * Module unloader.
232168b8534bSLuigi Rizzo  *
232268b8534bSLuigi Rizzo  * Free all the memory, and destroy the ``/dev/netmap`` device.
232368b8534bSLuigi Rizzo  */
232468b8534bSLuigi Rizzo static void
232568b8534bSLuigi Rizzo netmap_fini(void)
232668b8534bSLuigi Rizzo {
232768b8534bSLuigi Rizzo 	destroy_dev(netmap_dev);
232868b8534bSLuigi Rizzo 	netmap_memory_fini();
232968b8534bSLuigi Rizzo 	printf("netmap: unloaded module.\n");
233068b8534bSLuigi Rizzo }
233168b8534bSLuigi Rizzo 
233268b8534bSLuigi Rizzo 
2333f196ce38SLuigi Rizzo #ifdef __FreeBSD__
233468b8534bSLuigi Rizzo /*
233568b8534bSLuigi Rizzo  * Kernel entry point.
233668b8534bSLuigi Rizzo  *
233768b8534bSLuigi Rizzo  * Initialize/finalize the module and return.
233868b8534bSLuigi Rizzo  *
233968b8534bSLuigi Rizzo  * Return 0 on success, errno on failure.
234068b8534bSLuigi Rizzo  */
234168b8534bSLuigi Rizzo static int
234268b8534bSLuigi Rizzo netmap_loader(__unused struct module *module, int event, __unused void *arg)
234368b8534bSLuigi Rizzo {
234468b8534bSLuigi Rizzo 	int error = 0;
234568b8534bSLuigi Rizzo 
234668b8534bSLuigi Rizzo 	switch (event) {
234768b8534bSLuigi Rizzo 	case MOD_LOAD:
234868b8534bSLuigi Rizzo 		error = netmap_init();
234968b8534bSLuigi Rizzo 		break;
235068b8534bSLuigi Rizzo 
235168b8534bSLuigi Rizzo 	case MOD_UNLOAD:
235268b8534bSLuigi Rizzo 		netmap_fini();
235368b8534bSLuigi Rizzo 		break;
235468b8534bSLuigi Rizzo 
235568b8534bSLuigi Rizzo 	default:
235668b8534bSLuigi Rizzo 		error = EOPNOTSUPP;
235768b8534bSLuigi Rizzo 		break;
235868b8534bSLuigi Rizzo 	}
235968b8534bSLuigi Rizzo 
236068b8534bSLuigi Rizzo 	return (error);
236168b8534bSLuigi Rizzo }
236268b8534bSLuigi Rizzo 
236368b8534bSLuigi Rizzo 
236468b8534bSLuigi Rizzo DEV_MODULE(netmap, netmap_loader, NULL);
2365f196ce38SLuigi Rizzo #endif /* __FreeBSD__ */
2366