2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 2012-2014 Matteo Landi
5 * Copyright (C) 2012-2016 Luigi Rizzo
6 * Copyright (C) 2012-2016 Giuseppe Lettieri
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #endif /* __APPLE__ */
40 #include <sys/cdefs.h> /* prerequisite */
41 __FBSDID("$FreeBSD$");
43 #include <sys/types.h>
44 #include <sys/malloc.h>
45 #include <sys/kernel.h> /* MALLOC_DEFINE */
47 #include <vm/vm.h> /* vtophys */
48 #include <vm/pmap.h> /* vtophys */
49 #include <sys/socket.h> /* sockaddrs */
50 #include <sys/selinfo.h>
51 #include <sys/sysctl.h>
53 #include <net/if_var.h>
55 #include <machine/bus.h> /* bus_dmamap_* */
57 /* M_NETMAP only used in here */
58 MALLOC_DECLARE(M_NETMAP);
59 MALLOC_DEFINE(M_NETMAP, "netmap", "Network memory map");
61 #endif /* __FreeBSD__ */
67 #include <net/netmap.h>
68 #include <dev/netmap/netmap_kern.h>
69 #include <net/netmap_virt.h>
70 #include "netmap_mem2.h"
72 #ifdef _WIN32_USE_SMALL_GENERIC_DEVICES_MEMORY
73 #define NETMAP_BUF_MAX_NUM 8*4096 /* if too big takes too much time to allocate */
75 #define NETMAP_BUF_MAX_NUM 20*4096*2 /* large machine */
78 #define NETMAP_POOL_MAX_NAMSZ 32
89 struct netmap_obj_params {
97 struct netmap_obj_pool {
98 char name[NETMAP_POOL_MAX_NAMSZ]; /* name of the allocator */
100 /* ---------------------------------------------------*/
101 /* these are only meaningful if the pool is finalized */
102 /* (see 'finalized' field in netmap_mem_d) */
103 size_t memtotal; /* actual total memory space */
105 struct lut_entry *lut; /* virt,phys addresses, objtotal entries */
106 uint32_t *bitmap; /* one bit per buffer, 1 means free */
107 uint32_t *invalid_bitmap;/* one bit per buffer, 1 means invalid */
108 uint32_t bitmap_slots; /* number of uint32 entries in bitmap */
110 u_int objtotal; /* actual total number of objects. */
111 u_int numclusters; /* actual number of clusters */
112 u_int objfree; /* number of free objects. */
114 int alloc_done; /* we have allocated the memory */
115 /* ---------------------------------------------------*/
118 u_int objminsize; /* minimum object size */
119 u_int objmaxsize; /* maximum object size */
120 u_int nummin; /* minimum number of objects */
121 u_int nummax; /* maximum number of objects */
123 /* these are changed only by config */
124 u_int _objtotal; /* total number of objects */
125 u_int _objsize; /* object size */
126 u_int _clustsize; /* cluster size */
127 u_int _clustentries; /* objects per cluster */
128 u_int _numclusters; /* number of clusters */
130 /* requested values */
135 #define NMA_LOCK_T NM_MTX_T
136 #define NMA_LOCK_INIT(n) NM_MTX_INIT((n)->nm_mtx)
137 #define NMA_LOCK_DESTROY(n) NM_MTX_DESTROY((n)->nm_mtx)
138 #define NMA_LOCK(n) NM_MTX_LOCK((n)->nm_mtx)
139 #define NMA_SPINLOCK(n) NM_MTX_SPINLOCK((n)->nm_mtx)
140 #define NMA_UNLOCK(n) NM_MTX_UNLOCK((n)->nm_mtx)
142 struct netmap_mem_ops {
143 int (*nmd_get_lut)(struct netmap_mem_d *, struct netmap_lut*);
144 int (*nmd_get_info)(struct netmap_mem_d *, uint64_t *size,
145 u_int *memflags, uint16_t *id);
147 vm_paddr_t (*nmd_ofstophys)(struct netmap_mem_d *, vm_ooffset_t);
148 int (*nmd_config)(struct netmap_mem_d *);
149 int (*nmd_finalize)(struct netmap_mem_d *, struct netmap_adapter *);
150 void (*nmd_deref)(struct netmap_mem_d *, struct netmap_adapter *);
151 ssize_t (*nmd_if_offset)(struct netmap_mem_d *, const void *vaddr);
152 void (*nmd_delete)(struct netmap_mem_d *);
154 struct netmap_if * (*nmd_if_new)(struct netmap_mem_d *,
155 struct netmap_adapter *, struct netmap_priv_d *);
156 void (*nmd_if_delete)(struct netmap_mem_d *,
157 struct netmap_adapter *, struct netmap_if *);
158 int (*nmd_rings_create)(struct netmap_mem_d *,
159 struct netmap_adapter *);
160 void (*nmd_rings_delete)(struct netmap_mem_d *,
161 struct netmap_adapter *);
164 struct netmap_mem_d {
165 NMA_LOCK_T nm_mtx; /* protect the allocator */
166 size_t nm_totalsize; /* shorthand */
169 #define NETMAP_MEM_FINALIZED 0x1 /* preallocation done */
170 #define NETMAP_MEM_HIDDEN 0x8 /* being prepared */
171 #define NETMAP_MEM_NOMAP 0x10 /* do not map/unmap pdevs */
172 int lasterr; /* last error for curr config */
173 int active; /* active users */
175 /* the three allocators */
176 struct netmap_obj_pool pools[NETMAP_POOLS_NR];
178 nm_memid_t nm_id; /* allocator identifier */
179 int nm_grp; /* iommu group id */
181 /* list of all existing allocators, sorted by nm_id */
182 struct netmap_mem_d *prev, *next;
184 struct netmap_mem_ops *ops;
186 struct netmap_obj_params params[NETMAP_POOLS_NR];
188 #define NM_MEM_NAMESZ 16
189 char name[NM_MEM_NAMESZ];
193 netmap_mem_get_lut(struct netmap_mem_d *nmd, struct netmap_lut *lut)
198 rv = nmd->ops->nmd_get_lut(nmd, lut);
205 netmap_mem_get_info(struct netmap_mem_d *nmd, uint64_t *size,
206 u_int *memflags, nm_memid_t *memid)
211 rv = nmd->ops->nmd_get_info(nmd, size, memflags, memid);
218 netmap_mem_ofstophys(struct netmap_mem_d *nmd, vm_ooffset_t off)
222 #if defined(__FreeBSD__)
223 /* This function is called by netmap_dev_pager_fault(), which holds a
224 * non-sleepable lock since FreeBSD 12. Since we cannot sleep, we
225 * spin on the trylock. */
230 pa = nmd->ops->nmd_ofstophys(nmd, off);
237 netmap_mem_config(struct netmap_mem_d *nmd)
240 /* already in use. Not fatal, but we
241 * cannot change the configuration
246 return nmd->ops->nmd_config(nmd);
250 netmap_mem_if_offset(struct netmap_mem_d *nmd, const void *off)
255 rv = nmd->ops->nmd_if_offset(nmd, off);
262 netmap_mem_delete(struct netmap_mem_d *nmd)
264 nmd->ops->nmd_delete(nmd);
268 netmap_mem_if_new(struct netmap_adapter *na, struct netmap_priv_d *priv)
270 struct netmap_if *nifp;
271 struct netmap_mem_d *nmd = na->nm_mem;
274 nifp = nmd->ops->nmd_if_new(nmd, na, priv);
281 netmap_mem_if_delete(struct netmap_adapter *na, struct netmap_if *nif)
283 struct netmap_mem_d *nmd = na->nm_mem;
286 nmd->ops->nmd_if_delete(nmd, na, nif);
291 netmap_mem_rings_create(struct netmap_adapter *na)
294 struct netmap_mem_d *nmd = na->nm_mem;
297 rv = nmd->ops->nmd_rings_create(nmd, na);
304 netmap_mem_rings_delete(struct netmap_adapter *na)
306 struct netmap_mem_d *nmd = na->nm_mem;
309 nmd->ops->nmd_rings_delete(nmd, na);
313 static int netmap_mem_map(struct netmap_obj_pool *, struct netmap_adapter *);
314 static int netmap_mem_unmap(struct netmap_obj_pool *, struct netmap_adapter *);
315 static int nm_mem_check_group(struct netmap_mem_d *, bus_dma_tag_t);
316 static void nm_mem_release_id(struct netmap_mem_d *);
319 netmap_mem_get_id(struct netmap_mem_d *nmd)
324 #ifdef NM_DEBUG_MEM_PUTGET
325 #define NM_DBG_REFC(nmd, func, line) \
326 nm_prinf("%d mem[%d:%d] -> %d", line, (nmd)->nm_id, (nmd)->nm_grp, (nmd)->refcount);
328 #define NM_DBG_REFC(nmd, func, line)
331 /* circular list of all existing allocators */
332 static struct netmap_mem_d *netmap_last_mem_d = &nm_mem;
333 static NM_MTX_T nm_mem_list_lock;
335 struct netmap_mem_d *
336 __netmap_mem_get(struct netmap_mem_d *nmd, const char *func, int line)
338 NM_MTX_LOCK(nm_mem_list_lock);
340 NM_DBG_REFC(nmd, func, line);
341 NM_MTX_UNLOCK(nm_mem_list_lock);
346 __netmap_mem_put(struct netmap_mem_d *nmd, const char *func, int line)
349 NM_MTX_LOCK(nm_mem_list_lock);
350 last = (--nmd->refcount == 0);
352 nm_mem_release_id(nmd);
353 NM_DBG_REFC(nmd, func, line);
354 NM_MTX_UNLOCK(nm_mem_list_lock);
356 netmap_mem_delete(nmd);
360 netmap_mem_finalize(struct netmap_mem_d *nmd, struct netmap_adapter *na)
363 if (nm_mem_check_group(nmd, na->pdev) < 0) {
369 if (netmap_mem_config(nmd))
374 nmd->lasterr = nmd->ops->nmd_finalize(nmd, na);
376 if (!nmd->lasterr && !(nmd->flags & NETMAP_MEM_NOMAP)) {
377 nmd->lasterr = netmap_mem_map(&nmd->pools[NETMAP_BUF_POOL], na);
381 lasterr = nmd->lasterr;
385 netmap_mem_deref(nmd, na);
391 nm_isset(uint32_t *bitmap, u_int i)
393 return bitmap[ (i>>5) ] & ( 1U << (i & 31U) );
398 netmap_init_obj_allocator_bitmap(struct netmap_obj_pool *p)
402 if (p->bitmap == NULL) {
403 /* Allocate the bitmap */
404 n = (p->objtotal + 31) / 32;
405 p->bitmap = nm_os_malloc(sizeof(p->bitmap[0]) * n);
406 if (p->bitmap == NULL) {
407 nm_prerr("Unable to create bitmap (%d entries) for allocator '%s'", (int)n,
413 memset(p->bitmap, 0, p->bitmap_slots * sizeof(p->bitmap[0]));
418 * Set all the bits in the bitmap that have
419 * corresponding buffers to 1 to indicate they are
422 for (j = 0; j < p->objtotal; j++) {
423 if (p->invalid_bitmap && nm_isset(p->invalid_bitmap, j)) {
424 if (netmap_debug & NM_DEBUG_MEM)
425 nm_prinf("skipping %s %d", p->name, j);
428 p->bitmap[ (j>>5) ] |= ( 1U << (j & 31U) );
433 nm_prinf("%s free %u", p->name, p->objfree);
434 if (p->objfree == 0) {
436 nm_prerr("%s: no objects available", p->name);
444 netmap_mem_init_bitmaps(struct netmap_mem_d *nmd)
448 for (i = 0; i < NETMAP_POOLS_NR; i++) {
449 struct netmap_obj_pool *p = &nmd->pools[i];
451 error = netmap_init_obj_allocator_bitmap(p);
457 * buffers 0 and 1 are reserved
459 if (nmd->pools[NETMAP_BUF_POOL].objfree < 2) {
460 nm_prerr("%s: not enough buffers", nmd->pools[NETMAP_BUF_POOL].name);
464 nmd->pools[NETMAP_BUF_POOL].objfree -= 2;
465 if (nmd->pools[NETMAP_BUF_POOL].bitmap) {
466 /* XXX This check is a workaround that prevents a
467 * NULL pointer crash which currently happens only
468 * with ptnetmap guests.
469 * Removed shared-info --> is the bug still there? */
470 nmd->pools[NETMAP_BUF_POOL].bitmap[0] = ~3U;
476 netmap_mem_deref(struct netmap_mem_d *nmd, struct netmap_adapter *na)
480 if (na->active_fds <= 0 && !(nmd->flags & NETMAP_MEM_NOMAP))
481 netmap_mem_unmap(&nmd->pools[NETMAP_BUF_POOL], na);
482 if (nmd->active == 1) {
485 * Reset the allocator when it falls out of use so that any
486 * pool resources leaked by unclean application exits are
489 netmap_mem_init_bitmaps(nmd);
491 nmd->ops->nmd_deref(nmd, na);
503 /* accessor functions */
505 netmap_mem2_get_lut(struct netmap_mem_d *nmd, struct netmap_lut *lut)
507 lut->lut = nmd->pools[NETMAP_BUF_POOL].lut;
509 lut->plut = lut->lut;
511 lut->objtotal = nmd->pools[NETMAP_BUF_POOL].objtotal;
512 lut->objsize = nmd->pools[NETMAP_BUF_POOL]._objsize;
517 static struct netmap_obj_params netmap_min_priv_params[NETMAP_POOLS_NR] = {
522 [NETMAP_RING_POOL] = {
526 [NETMAP_BUF_POOL] = {
534 * nm_mem is the memory allocator used for all physical interfaces
535 * running in netmap mode.
536 * Virtual (VALE) ports will have each its own allocator.
538 extern struct netmap_mem_ops netmap_mem_global_ops; /* forward */
539 struct netmap_mem_d nm_mem = { /* Our memory allocator. */
543 .objminsize = sizeof(struct netmap_if),
545 .nummin = 10, /* don't be stingy */
546 .nummax = 10000, /* XXX very large */
548 [NETMAP_RING_POOL] = {
549 .name = "netmap_ring",
550 .objminsize = sizeof(struct netmap_ring),
551 .objmaxsize = 32*PAGE_SIZE,
555 [NETMAP_BUF_POOL] = {
556 .name = "netmap_buf",
560 .nummax = 1000000, /* one million! */
569 [NETMAP_RING_POOL] = {
573 [NETMAP_BUF_POOL] = {
575 .num = NETMAP_BUF_MAX_NUM,
585 .ops = &netmap_mem_global_ops,
590 static struct netmap_mem_d nm_mem_blueprint;
592 /* blueprint for the private memory allocators */
593 /* XXX clang is not happy about using name as a print format */
594 static const struct netmap_mem_d nm_blueprint = {
598 .objminsize = sizeof(struct netmap_if),
603 [NETMAP_RING_POOL] = {
605 .objminsize = sizeof(struct netmap_ring),
606 .objmaxsize = 32*PAGE_SIZE,
610 [NETMAP_BUF_POOL] = {
615 .nummax = 1000000, /* one million! */
621 .flags = NETMAP_MEM_PRIVATE,
623 .ops = &netmap_mem_global_ops,
626 /* memory allocator related sysctls */
628 #define STRINGIFY(x) #x
631 #define DECLARE_SYSCTLS(id, name) \
632 SYSBEGIN(mem2_ ## name); \
633 SYSCTL_INT(_dev_netmap, OID_AUTO, name##_size, \
634 CTLFLAG_RW, &nm_mem.params[id].size, 0, "Requested size of netmap " STRINGIFY(name) "s"); \
635 SYSCTL_INT(_dev_netmap, OID_AUTO, name##_curr_size, \
636 CTLFLAG_RD, &nm_mem.pools[id]._objsize, 0, "Current size of netmap " STRINGIFY(name) "s"); \
637 SYSCTL_INT(_dev_netmap, OID_AUTO, name##_num, \
638 CTLFLAG_RW, &nm_mem.params[id].num, 0, "Requested number of netmap " STRINGIFY(name) "s"); \
639 SYSCTL_INT(_dev_netmap, OID_AUTO, name##_curr_num, \
640 CTLFLAG_RD, &nm_mem.pools[id].objtotal, 0, "Current number of netmap " STRINGIFY(name) "s"); \
641 SYSCTL_INT(_dev_netmap, OID_AUTO, priv_##name##_size, \
642 CTLFLAG_RW, &netmap_min_priv_params[id].size, 0, \
643 "Default size of private netmap " STRINGIFY(name) "s"); \
644 SYSCTL_INT(_dev_netmap, OID_AUTO, priv_##name##_num, \
645 CTLFLAG_RW, &netmap_min_priv_params[id].num, 0, \
646 "Default number of private netmap " STRINGIFY(name) "s"); \
649 SYSCTL_DECL(_dev_netmap);
650 DECLARE_SYSCTLS(NETMAP_IF_POOL, if);
651 DECLARE_SYSCTLS(NETMAP_RING_POOL, ring);
652 DECLARE_SYSCTLS(NETMAP_BUF_POOL, buf);
654 /* call with nm_mem_list_lock held */
656 nm_mem_assign_id_locked(struct netmap_mem_d *nmd, int grp_id)
659 struct netmap_mem_d *scan = netmap_last_mem_d;
663 /* we rely on unsigned wrap around */
664 id = scan->nm_id + 1;
665 if (id == 0) /* reserve 0 as error value */
668 if (id != scan->nm_id) {
670 nmd->nm_grp = grp_id;
671 nmd->prev = scan->prev;
673 scan->prev->next = nmd;
675 netmap_last_mem_d = nmd;
677 NM_DBG_REFC(nmd, __FUNCTION__, __LINE__);
681 } while (scan != netmap_last_mem_d);
686 /* call with nm_mem_list_lock *not* held */
688 nm_mem_assign_id(struct netmap_mem_d *nmd, int grp_id)
692 NM_MTX_LOCK(nm_mem_list_lock);
693 ret = nm_mem_assign_id_locked(nmd, grp_id);
694 NM_MTX_UNLOCK(nm_mem_list_lock);
699 /* call with nm_mem_list_lock held */
701 nm_mem_release_id(struct netmap_mem_d *nmd)
703 nmd->prev->next = nmd->next;
704 nmd->next->prev = nmd->prev;
706 if (netmap_last_mem_d == nmd)
707 netmap_last_mem_d = nmd->prev;
709 nmd->prev = nmd->next = NULL;
712 struct netmap_mem_d *
713 netmap_mem_find(nm_memid_t id)
715 struct netmap_mem_d *nmd;
717 NM_MTX_LOCK(nm_mem_list_lock);
718 nmd = netmap_last_mem_d;
720 if (!(nmd->flags & NETMAP_MEM_HIDDEN) && nmd->nm_id == id) {
722 NM_DBG_REFC(nmd, __FUNCTION__, __LINE__);
723 NM_MTX_UNLOCK(nm_mem_list_lock);
727 } while (nmd != netmap_last_mem_d);
728 NM_MTX_UNLOCK(nm_mem_list_lock);
733 nm_mem_check_group(struct netmap_mem_d *nmd, bus_dma_tag_t dev)
737 /* Skip not hw adapters.
738 * Vale port can use particular allocator through vale-ctl -m option
742 id = nm_iommu_group_id(dev);
743 if (netmap_debug & NM_DEBUG_MEM)
744 nm_prinf("iommu_group %d", id);
748 if (nmd->nm_grp != id) {
750 nm_prerr("iommu group mismatch: %d vs %d",
752 nmd->lasterr = err = ENOMEM;
759 static struct lut_entry *
760 nm_alloc_lut(u_int nobj)
762 size_t n = sizeof(struct lut_entry) * nobj;
763 struct lut_entry *lut;
767 lut = nm_os_malloc(n);
773 nm_free_lut(struct lut_entry *lut, u_int objtotal)
775 bzero(lut, sizeof(struct lut_entry) * objtotal);
783 #if defined(linux) || defined(_WIN32)
784 static struct plut_entry *
785 nm_alloc_plut(u_int nobj)
787 size_t n = sizeof(struct plut_entry) * nobj;
788 struct plut_entry *lut;
794 nm_free_plut(struct plut_entry * lut)
798 #endif /* linux or _WIN32 */
802 * First, find the allocator that contains the requested offset,
803 * then locate the cluster through a lookup table.
806 netmap_mem2_ofstophys(struct netmap_mem_d* nmd, vm_ooffset_t offset)
809 vm_ooffset_t o = offset;
811 struct netmap_obj_pool *p;
815 for (i = 0; i < NETMAP_POOLS_NR; offset -= p[i].memtotal, i++) {
816 if (offset >= p[i].memtotal)
818 // now lookup the cluster's address
820 pa = vtophys(p[i].lut[offset / p[i]._objsize].vaddr) +
821 offset % p[i]._objsize;
823 pa = vtophys(p[i].lut[offset / p[i]._objsize].vaddr);
824 pa.QuadPart += offset % p[i]._objsize;
828 /* this is only in case of errors */
829 nm_prerr("invalid ofs 0x%x out of 0x%zx 0x%zx 0x%zx", (u_int)o,
830 p[NETMAP_IF_POOL].memtotal,
831 p[NETMAP_IF_POOL].memtotal
832 + p[NETMAP_RING_POOL].memtotal,
833 p[NETMAP_IF_POOL].memtotal
834 + p[NETMAP_RING_POOL].memtotal
835 + p[NETMAP_BUF_POOL].memtotal);
837 return 0; /* bad address */
848 * win32_build_virtual_memory_for_userspace
850 * This function get all the object making part of the pools and maps
851 * a contiguous virtual memory space for the userspace
853 * 1 - allocate a Memory Descriptor List wide as the sum
854 * of the memory needed for the pools
855 * 2 - cycle all the objects in every pool and for every object do
857 * 2a - cycle all the objects in every pool, get the list
858 * of the physical address descriptors
859 * 2b - calculate the offset in the array of pages descriptor in the
861 * 2c - copy the descriptors of the object in the main MDL
863 * 3 - return the resulting MDL that needs to be mapped in userland
865 * In this way we will have an MDL that describes all the memory for the
866 * objects in a single object
870 win32_build_user_vm_map(struct netmap_mem_d* nmd)
872 u_int memflags, ofs = 0;
873 PMDL mainMdl, tempMdl;
877 if (netmap_mem_get_info(nmd, &memsize, &memflags, NULL)) {
878 nm_prerr("memory not finalised yet");
882 mainMdl = IoAllocateMdl(NULL, memsize, FALSE, FALSE, NULL);
883 if (mainMdl == NULL) {
884 nm_prerr("failed to allocate mdl");
889 for (i = 0; i < NETMAP_POOLS_NR; i++) {
890 struct netmap_obj_pool *p = &nmd->pools[i];
891 int clsz = p->_clustsize;
892 int clobjs = p->_clustentries; /* objects per cluster */
893 int mdl_len = sizeof(PFN_NUMBER) * BYTES_TO_PAGES(clsz);
894 PPFN_NUMBER pSrc, pDst;
896 /* each pool has a different cluster size so we need to reallocate */
897 tempMdl = IoAllocateMdl(p->lut[0].vaddr, clsz, FALSE, FALSE, NULL);
898 if (tempMdl == NULL) {
900 nm_prerr("fail to allocate tempMdl");
904 pSrc = MmGetMdlPfnArray(tempMdl);
905 /* create one entry per cluster, the lut[] has one entry per object */
906 for (j = 0; j < p->numclusters; j++, ofs += clsz) {
907 pDst = &MmGetMdlPfnArray(mainMdl)[BYTES_TO_PAGES(ofs)];
908 MmInitializeMdl(tempMdl, p->lut[j*clobjs].vaddr, clsz);
909 MmBuildMdlForNonPagedPool(tempMdl); /* compute physical page addresses */
910 RtlCopyMemory(pDst, pSrc, mdl_len); /* copy the page descriptors */
911 mainMdl->MdlFlags = tempMdl->MdlFlags; /* XXX what is in here ? */
922 * helper function for OS-specific mmap routines (currently only windows).
923 * Given an nmd and a pool index, returns the cluster size and number of clusters.
924 * Returns 0 if memory is finalised and the pool is valid, otherwise 1.
925 * It should be called under NMA_LOCK(nmd) otherwise the underlying info can change.
929 netmap_mem2_get_pool_info(struct netmap_mem_d* nmd, u_int pool, u_int *clustsize, u_int *numclusters)
931 if (!nmd || !clustsize || !numclusters || pool >= NETMAP_POOLS_NR)
932 return 1; /* invalid arguments */
933 // NMA_LOCK_ASSERT(nmd);
934 if (!(nmd->flags & NETMAP_MEM_FINALIZED)) {
935 *clustsize = *numclusters = 0;
936 return 1; /* not ready yet */
938 *clustsize = nmd->pools[pool]._clustsize;
939 *numclusters = nmd->pools[pool].numclusters;
940 return 0; /* success */
944 netmap_mem2_get_info(struct netmap_mem_d* nmd, uint64_t* size,
945 u_int *memflags, nm_memid_t *id)
948 error = netmap_mem_config(nmd);
952 if (nmd->flags & NETMAP_MEM_FINALIZED) {
953 *size = nmd->nm_totalsize;
957 for (i = 0; i < NETMAP_POOLS_NR; i++) {
958 struct netmap_obj_pool *p = nmd->pools + i;
959 *size += ((size_t)p->_numclusters * (size_t)p->_clustsize);
964 *memflags = nmd->flags;
972 * we store objects by kernel address, need to find the offset
973 * within the pool to export the value to userspace.
974 * Algorithm: scan until we find the cluster, then add the
975 * actual offset in the cluster
978 netmap_obj_offset(struct netmap_obj_pool *p, const void *vaddr)
980 int i, k = p->_clustentries, n = p->objtotal;
983 for (i = 0; i < n; i += k, ofs += p->_clustsize) {
984 const char *base = p->lut[i].vaddr;
985 ssize_t relofs = (const char *) vaddr - base;
987 if (relofs < 0 || relofs >= p->_clustsize)
991 nm_prdis("%s: return offset %d (cluster %d) for pointer %p",
992 p->name, ofs, i, vaddr);
995 nm_prerr("address %p is not contained inside any cluster (%s)",
997 return 0; /* An error occurred */
1000 /* Helper functions which convert virtual addresses to offsets */
1001 #define netmap_if_offset(n, v) \
1002 netmap_obj_offset(&(n)->pools[NETMAP_IF_POOL], (v))
1004 #define netmap_ring_offset(n, v) \
1005 ((n)->pools[NETMAP_IF_POOL].memtotal + \
1006 netmap_obj_offset(&(n)->pools[NETMAP_RING_POOL], (v)))
1009 netmap_mem2_if_offset(struct netmap_mem_d *nmd, const void *addr)
1011 return netmap_if_offset(nmd, addr);
1015 * report the index, and use start position as a hint,
1016 * otherwise buffer allocation becomes terribly expensive.
1019 netmap_obj_malloc(struct netmap_obj_pool *p, u_int len, uint32_t *start, uint32_t *index)
1021 uint32_t i = 0; /* index in the bitmap */
1022 uint32_t mask, j = 0; /* slot counter */
1025 if (len > p->_objsize) {
1026 nm_prerr("%s request size %d too large", p->name, len);
1030 if (p->objfree == 0) {
1031 nm_prerr("no more %s objects", p->name);
1037 /* termination is guaranteed by p->free, but better check bounds on i */
1038 while (vaddr == NULL && i < p->bitmap_slots) {
1039 uint32_t cur = p->bitmap[i];
1040 if (cur == 0) { /* bitmask is fully used */
1045 for (j = 0, mask = 1; (cur & mask) == 0; j++, mask <<= 1)
1048 p->bitmap[i] &= ~mask; /* mark object as in use */
1051 vaddr = p->lut[i * 32 + j].vaddr;
1053 *index = i * 32 + j;
1055 nm_prdis("%s allocator: allocated object @ [%d][%d]: vaddr %p",p->name, i, j, vaddr);
1064 * free by index, not by address.
1065 * XXX should we also cleanup the content ?
1068 netmap_obj_free(struct netmap_obj_pool *p, uint32_t j)
1070 uint32_t *ptr, mask;
1072 if (j >= p->objtotal) {
1073 nm_prerr("invalid index %u, max %u", j, p->objtotal);
1076 ptr = &p->bitmap[j / 32];
1077 mask = (1 << (j % 32));
1079 nm_prerr("ouch, double free on buffer %d", j);
1089 * free by address. This is slow but is only used for a few
1090 * objects (rings, nifp)
1093 netmap_obj_free_va(struct netmap_obj_pool *p, void *vaddr)
1095 u_int i, j, n = p->numclusters;
1097 for (i = 0, j = 0; i < n; i++, j += p->_clustentries) {
1098 void *base = p->lut[i * p->_clustentries].vaddr;
1099 ssize_t relofs = (ssize_t) vaddr - (ssize_t) base;
1101 /* Given address, is out of the scope of the current cluster.*/
1102 if (base == NULL || vaddr < base || relofs >= p->_clustsize)
1105 j = j + relofs / p->_objsize;
1106 /* KASSERT(j != 0, ("Cannot free object 0")); */
1107 netmap_obj_free(p, j);
1110 nm_prerr("address %p is not contained inside any cluster (%s)",
1115 netmap_mem_bufsize(struct netmap_mem_d *nmd)
1117 return nmd->pools[NETMAP_BUF_POOL]._objsize;
1120 #define netmap_if_malloc(n, len) netmap_obj_malloc(&(n)->pools[NETMAP_IF_POOL], len, NULL, NULL)
1121 #define netmap_if_free(n, v) netmap_obj_free_va(&(n)->pools[NETMAP_IF_POOL], (v))
1122 #define netmap_ring_malloc(n, len) netmap_obj_malloc(&(n)->pools[NETMAP_RING_POOL], len, NULL, NULL)
1123 #define netmap_ring_free(n, v) netmap_obj_free_va(&(n)->pools[NETMAP_RING_POOL], (v))
1124 #define netmap_buf_malloc(n, _pos, _index) \
1125 netmap_obj_malloc(&(n)->pools[NETMAP_BUF_POOL], netmap_mem_bufsize(n), _pos, _index)
1128 #if 0 /* currently unused */
1129 /* Return the index associated to the given packet buffer */
1130 #define netmap_buf_index(n, v) \
1131 (netmap_obj_offset(&(n)->pools[NETMAP_BUF_POOL], (v)) / NETMAP_BDG_BUF_SIZE(n))
1135 * allocate extra buffers in a linked list.
1136 * returns the actual number.
1139 netmap_extra_alloc(struct netmap_adapter *na, uint32_t *head, uint32_t n)
1141 struct netmap_mem_d *nmd = na->nm_mem;
1142 uint32_t i, pos = 0; /* opaque, scan position in the bitmap */
1146 *head = 0; /* default, 'null' index ie empty list */
1147 for (i = 0 ; i < n; i++) {
1148 uint32_t cur = *head; /* save current head */
1149 uint32_t *p = netmap_buf_malloc(nmd, &pos, head);
1151 nm_prerr("no more buffers after %d of %d", i, n);
1152 *head = cur; /* restore */
1155 nm_prdis(5, "allocate buffer %d -> %d", *head, cur);
1156 *p = cur; /* link to previous head */
1165 netmap_extra_free(struct netmap_adapter *na, uint32_t head)
1167 struct lut_entry *lut = na->na_lut.lut;
1168 struct netmap_mem_d *nmd = na->nm_mem;
1169 struct netmap_obj_pool *p = &nmd->pools[NETMAP_BUF_POOL];
1170 uint32_t i, cur, *buf;
1172 nm_prdis("freeing the extra list");
1173 for (i = 0; head >=2 && head < p->objtotal; i++) {
1175 buf = lut[head].vaddr;
1178 if (netmap_obj_free(p, cur))
1182 nm_prerr("breaking with head %d", head);
1183 if (netmap_debug & NM_DEBUG_MEM)
1184 nm_prinf("freed %d buffers", i);
1188 /* Return nonzero on error */
1190 netmap_new_bufs(struct netmap_mem_d *nmd, struct netmap_slot *slot, u_int n)
1192 struct netmap_obj_pool *p = &nmd->pools[NETMAP_BUF_POOL];
1193 u_int i = 0; /* slot counter */
1194 uint32_t pos = 0; /* slot in p->bitmap */
1195 uint32_t index = 0; /* buffer index */
1197 for (i = 0; i < n; i++) {
1198 void *vaddr = netmap_buf_malloc(nmd, &pos, &index);
1199 if (vaddr == NULL) {
1200 nm_prerr("no more buffers after %d of %d", i, n);
1203 slot[i].buf_idx = index;
1204 slot[i].len = p->_objsize;
1209 nm_prdis("%s: allocated %d buffers, %d available, first at %d", p->name, n, p->objfree, pos);
1215 netmap_obj_free(p, slot[i].buf_idx);
1217 bzero(slot, n * sizeof(slot[0]));
1222 netmap_mem_set_ring(struct netmap_mem_d *nmd, struct netmap_slot *slot, u_int n, uint32_t index)
1224 struct netmap_obj_pool *p = &nmd->pools[NETMAP_BUF_POOL];
1227 for (i = 0; i < n; i++) {
1228 slot[i].buf_idx = index;
1229 slot[i].len = p->_objsize;
1236 netmap_free_buf(struct netmap_mem_d *nmd, uint32_t i)
1238 struct netmap_obj_pool *p = &nmd->pools[NETMAP_BUF_POOL];
1240 if (i < 2 || i >= p->objtotal) {
1241 nm_prerr("Cannot free buf#%d: should be in [2, %d[", i, p->objtotal);
1244 netmap_obj_free(p, i);
1249 netmap_free_bufs(struct netmap_mem_d *nmd, struct netmap_slot *slot, u_int n)
1253 for (i = 0; i < n; i++) {
1254 if (slot[i].buf_idx > 1)
1255 netmap_free_buf(nmd, slot[i].buf_idx);
1257 nm_prdis("%s: released some buffers, available: %u",
1258 p->name, p->objfree);
1262 netmap_reset_obj_allocator(struct netmap_obj_pool *p)
1268 nm_os_free(p->bitmap);
1270 if (p->invalid_bitmap)
1271 nm_os_free(p->invalid_bitmap);
1272 p->invalid_bitmap = NULL;
1273 if (!p->alloc_done) {
1274 /* allocation was done by somebody else.
1275 * Let them clean up after themselves.
1283 * Free each cluster allocated in
1284 * netmap_finalize_obj_allocator(). The cluster start
1285 * addresses are stored at multiples of p->_clusterentries
1288 for (i = 0; i < p->objtotal; i += p->_clustentries) {
1289 contigfree(p->lut[i].vaddr, p->_clustsize, M_NETMAP);
1291 nm_free_lut(p->lut, p->objtotal);
1302 * Free all resources related to an allocator.
1305 netmap_destroy_obj_allocator(struct netmap_obj_pool *p)
1309 netmap_reset_obj_allocator(p);
1313 * We receive a request for objtotal objects, of size objsize each.
1314 * Internally we may round up both numbers, as we allocate objects
1315 * in small clusters multiple of the page size.
1316 * We need to keep track of objtotal and clustentries,
1317 * as they are needed when freeing memory.
1319 * XXX note -- userspace needs the buffers to be contiguous,
1320 * so we cannot afford gaps at the end of a cluster.
1324 /* call with NMA_LOCK held */
1326 netmap_config_obj_allocator(struct netmap_obj_pool *p, u_int objtotal, u_int objsize)
1329 u_int clustsize; /* the cluster size, multiple of page size */
1330 u_int clustentries; /* how many objects per entry */
1332 /* we store the current request, so we can
1333 * detect configuration changes later */
1334 p->r_objtotal = objtotal;
1335 p->r_objsize = objsize;
1337 #define MAX_CLUSTSIZE (1<<22) // 4 MB
1338 #define LINE_ROUND NM_BUF_ALIGN // 64
1339 if (objsize >= MAX_CLUSTSIZE) {
1340 /* we could do it but there is no point */
1341 nm_prerr("unsupported allocation for %d bytes", objsize);
1344 /* make sure objsize is a multiple of LINE_ROUND */
1345 i = (objsize & (LINE_ROUND - 1));
1347 nm_prinf("aligning object by %d bytes", LINE_ROUND - i);
1348 objsize += LINE_ROUND - i;
1350 if (objsize < p->objminsize || objsize > p->objmaxsize) {
1351 nm_prerr("requested objsize %d out of range [%d, %d]",
1352 objsize, p->objminsize, p->objmaxsize);
1355 if (objtotal < p->nummin || objtotal > p->nummax) {
1356 nm_prerr("requested objtotal %d out of range [%d, %d]",
1357 objtotal, p->nummin, p->nummax);
1361 * Compute number of objects using a brute-force approach:
1362 * given a max cluster size,
1363 * we try to fill it with objects keeping track of the
1364 * wasted space to the next page boundary.
1366 for (clustentries = 0, i = 1;; i++) {
1367 u_int delta, used = i * objsize;
1368 if (used > MAX_CLUSTSIZE)
1370 delta = used % PAGE_SIZE;
1371 if (delta == 0) { // exact solution
1376 /* exact solution not found */
1377 if (clustentries == 0) {
1378 nm_prerr("unsupported allocation for %d bytes", objsize);
1381 /* compute clustsize */
1382 clustsize = clustentries * objsize;
1383 if (netmap_debug & NM_DEBUG_MEM)
1384 nm_prinf("objsize %d clustsize %d objects %d",
1385 objsize, clustsize, clustentries);
1388 * The number of clusters is n = ceil(objtotal/clustentries)
1389 * objtotal' = n * clustentries
1391 p->_clustentries = clustentries;
1392 p->_clustsize = clustsize;
1393 p->_numclusters = (objtotal + clustentries - 1) / clustentries;
1395 /* actual values (may be larger than requested) */
1396 p->_objsize = objsize;
1397 p->_objtotal = p->_numclusters * clustentries;
1402 /* call with NMA_LOCK held */
1404 netmap_finalize_obj_allocator(struct netmap_obj_pool *p)
1406 int i; /* must be signed */
1410 /* if the lut is already there we assume that also all the
1411 * clusters have already been allocated, possibly by somebody
1412 * else (e.g., extmem). In the latter case, the alloc_done flag
1413 * will remain at zero, so that we will not attempt to
1414 * deallocate the clusters by ourselves in
1415 * netmap_reset_obj_allocator.
1420 /* optimistically assume we have enough memory */
1421 p->numclusters = p->_numclusters;
1422 p->objtotal = p->_objtotal;
1425 p->lut = nm_alloc_lut(p->objtotal);
1426 if (p->lut == NULL) {
1427 nm_prerr("Unable to create lookup table for '%s'", p->name);
1432 * Allocate clusters, init pointers
1436 for (i = 0; i < (int)p->objtotal;) {
1437 int lim = i + p->_clustentries;
1441 * XXX Note, we only need contigmalloc() for buffers attached
1442 * to native interfaces. In all other cases (nifp, netmap rings
1443 * and even buffers for VALE ports or emulated interfaces) we
1444 * can live with standard malloc, because the hardware will not
1445 * access the pages directly.
1447 clust = contigmalloc(n, M_NETMAP, M_NOWAIT | M_ZERO,
1448 (size_t)0, -1UL, PAGE_SIZE, 0);
1449 if (clust == NULL) {
1451 * If we get here, there is a severe memory shortage,
1452 * so halve the allocated memory to reclaim some.
1454 nm_prerr("Unable to create cluster at %d for '%s' allocator",
1456 if (i < 2) /* nothing to halve */
1459 for (i--; i >= lim; i--) {
1460 if (i % p->_clustentries == 0 && p->lut[i].vaddr)
1461 contigfree(p->lut[i].vaddr,
1463 p->lut[i].vaddr = NULL;
1467 /* we may have stopped in the middle of a cluster */
1468 p->numclusters = (i + p->_clustentries - 1) / p->_clustentries;
1472 * Set lut state for all buffers in the current cluster.
1474 * [i, lim) is the set of buffer indexes that cover the
1477 * 'clust' is really the address of the current buffer in
1478 * the current cluster as we index through it with a stride
1481 for (; i < lim; i++, clust += p->_objsize) {
1482 p->lut[i].vaddr = clust;
1483 #if !defined(linux) && !defined(_WIN32)
1484 p->lut[i].paddr = vtophys(clust);
1488 p->memtotal = (size_t)p->numclusters * (size_t)p->_clustsize;
1490 nm_prinf("Pre-allocated %d clusters (%d/%zuKB) for '%s'",
1491 p->numclusters, p->_clustsize >> 10,
1492 p->memtotal >> 10, p->name);
1497 netmap_reset_obj_allocator(p);
1501 /* call with lock held */
1503 netmap_mem_params_changed(struct netmap_obj_params* p)
1507 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1508 if (p[i].last_size != p[i].size || p[i].last_num != p[i].num) {
1509 p[i].last_size = p[i].size;
1510 p[i].last_num = p[i].num;
1518 netmap_mem_reset_all(struct netmap_mem_d *nmd)
1522 if (netmap_debug & NM_DEBUG_MEM)
1523 nm_prinf("resetting %p", nmd);
1524 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1525 netmap_reset_obj_allocator(&nmd->pools[i]);
1527 nmd->flags &= ~NETMAP_MEM_FINALIZED;
1531 netmap_mem_unmap(struct netmap_obj_pool *p, struct netmap_adapter *na)
1533 int i, lim = p->objtotal;
1534 struct netmap_lut *lut;
1535 if (na == NULL || na->pdev == NULL)
1542 #if defined(__FreeBSD__)
1543 /* On FreeBSD mapping and unmapping is performed by the txsync
1544 * and rxsync routine, packet by packet. */
1548 #elif defined(_WIN32)
1552 nm_prerr("unsupported on Windows");
1554 nm_prdis("unmapping and freeing plut for %s", na->name);
1555 if (lut->plut == NULL || na->pdev == NULL)
1557 for (i = 0; i < lim; i += p->_clustentries) {
1558 if (lut->plut[i].paddr)
1559 netmap_unload_map(na, (bus_dma_tag_t) na->pdev, &lut->plut[i].paddr, p->_clustsize);
1561 nm_free_plut(lut->plut);
1569 netmap_mem_map(struct netmap_obj_pool *p, struct netmap_adapter *na)
1572 int i, lim = p->objtotal;
1573 struct netmap_lut *lut = &na->na_lut;
1575 if (na->pdev == NULL)
1578 #if defined(__FreeBSD__)
1579 /* On FreeBSD mapping and unmapping is performed by the txsync
1580 * and rxsync routine, packet by packet. */
1584 #elif defined(_WIN32)
1588 nm_prerr("unsupported on Windows");
1591 if (lut->plut != NULL) {
1592 nm_prdis("plut already allocated for %s", na->name);
1596 nm_prdis("allocating physical lut for %s", na->name);
1597 lut->plut = nm_alloc_plut(lim);
1598 if (lut->plut == NULL) {
1599 nm_prerr("Failed to allocate physical lut for %s", na->name);
1603 for (i = 0; i < lim; i += p->_clustentries) {
1604 lut->plut[i].paddr = 0;
1607 for (i = 0; i < lim; i += p->_clustentries) {
1610 if (p->lut[i].vaddr == NULL)
1613 error = netmap_load_map(na, (bus_dma_tag_t) na->pdev, &lut->plut[i].paddr,
1614 p->lut[i].vaddr, p->_clustsize);
1616 nm_prerr("Failed to map cluster #%d from the %s pool", i, p->name);
1620 for (j = 1; j < p->_clustentries; j++) {
1621 lut->plut[i + j].paddr = lut->plut[i + j - 1].paddr + p->_objsize;
1626 netmap_mem_unmap(p, na);
1634 netmap_mem_finalize_all(struct netmap_mem_d *nmd)
1637 if (nmd->flags & NETMAP_MEM_FINALIZED)
1640 nmd->nm_totalsize = 0;
1641 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1642 nmd->lasterr = netmap_finalize_obj_allocator(&nmd->pools[i]);
1645 nmd->nm_totalsize += nmd->pools[i].memtotal;
1647 nmd->nm_totalsize = (nmd->nm_totalsize + PAGE_SIZE - 1) & ~(PAGE_SIZE - 1);
1648 nmd->lasterr = netmap_mem_init_bitmaps(nmd);
1652 nmd->flags |= NETMAP_MEM_FINALIZED;
1655 nm_prinf("interfaces %zd KB, rings %zd KB, buffers %zd MB",
1656 nmd->pools[NETMAP_IF_POOL].memtotal >> 10,
1657 nmd->pools[NETMAP_RING_POOL].memtotal >> 10,
1658 nmd->pools[NETMAP_BUF_POOL].memtotal >> 20);
1661 nm_prinf("Free buffers: %d", nmd->pools[NETMAP_BUF_POOL].objfree);
1666 netmap_mem_reset_all(nmd);
1667 return nmd->lasterr;
1671 * allocator for private memory
1674 _netmap_mem_private_new(size_t size, struct netmap_obj_params *p, int grp_id,
1675 struct netmap_mem_ops *ops, uint64_t memtotal, int *perr)
1677 struct netmap_mem_d *d = NULL;
1681 /* if memtotal is !=0 we check that the request fits the available
1682 * memory. Moreover, any surprlus memory is assigned to buffers.
1684 checksz = (memtotal > 0);
1686 d = nm_os_malloc(size);
1695 err = nm_mem_assign_id(d, grp_id);
1698 snprintf(d->name, NM_MEM_NAMESZ, "%d", d->nm_id);
1700 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1701 snprintf(d->pools[i].name, NETMAP_POOL_MAX_NAMSZ,
1702 nm_blueprint.pools[i].name,
1705 uint64_t poolsz = (uint64_t)p[i].num * p[i].size;
1706 if (memtotal < poolsz) {
1707 nm_prerr("%s: request too large", d->pools[i].name);
1713 d->params[i].num = p[i].num;
1714 d->params[i].size = p[i].size;
1716 if (checksz && memtotal > 0) {
1717 uint64_t sz = d->params[NETMAP_BUF_POOL].size;
1718 uint64_t n = (memtotal + sz - 1) / sz;
1721 if (netmap_verbose) {
1722 nm_prinf("%s: adding %llu more buffers",
1723 d->pools[NETMAP_BUF_POOL].name,
1724 (unsigned long long)n);
1726 d->params[NETMAP_BUF_POOL].num += n;
1732 err = netmap_mem_config(d);
1734 goto error_destroy_lock;
1736 d->flags &= ~NETMAP_MEM_FINALIZED;
1741 NMA_LOCK_DESTROY(d);
1743 nm_mem_release_id(d);
1752 struct netmap_mem_d *
1753 netmap_mem_private_new(u_int txr, u_int txd, u_int rxr, u_int rxd,
1754 u_int extra_bufs, u_int npipes, int *perr)
1756 struct netmap_mem_d *d = NULL;
1757 struct netmap_obj_params p[NETMAP_POOLS_NR];
1760 /* account for the fake host rings */
1764 /* copy the min values */
1765 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1766 p[i] = netmap_min_priv_params[i];
1769 /* possibly increase them to fit user request */
1770 v = sizeof(struct netmap_if) + sizeof(ssize_t) * (txr + rxr);
1771 if (p[NETMAP_IF_POOL].size < v)
1772 p[NETMAP_IF_POOL].size = v;
1774 if (p[NETMAP_IF_POOL].num < v)
1775 p[NETMAP_IF_POOL].num = v;
1776 maxd = (txd > rxd) ? txd : rxd;
1777 v = sizeof(struct netmap_ring) + sizeof(struct netmap_slot) * maxd;
1778 if (p[NETMAP_RING_POOL].size < v)
1779 p[NETMAP_RING_POOL].size = v;
1780 /* each pipe endpoint needs two tx rings (1 normal + 1 host, fake)
1781 * and two rx rings (again, 1 normal and 1 fake host)
1783 v = txr + rxr + 8 * npipes;
1784 if (p[NETMAP_RING_POOL].num < v)
1785 p[NETMAP_RING_POOL].num = v;
1786 /* for each pipe we only need the buffers for the 4 "real" rings.
1787 * On the other end, the pipe ring dimension may be different from
1788 * the parent port ring dimension. As a compromise, we allocate twice the
1789 * space actually needed if the pipe rings were the same size as the parent rings
1791 v = (4 * npipes + rxr) * rxd + (4 * npipes + txr) * txd + 2 + extra_bufs;
1792 /* the +2 is for the tx and rx fake buffers (indices 0 and 1) */
1793 if (p[NETMAP_BUF_POOL].num < v)
1794 p[NETMAP_BUF_POOL].num = v;
1797 nm_prinf("req if %d*%d ring %d*%d buf %d*%d",
1798 p[NETMAP_IF_POOL].num,
1799 p[NETMAP_IF_POOL].size,
1800 p[NETMAP_RING_POOL].num,
1801 p[NETMAP_RING_POOL].size,
1802 p[NETMAP_BUF_POOL].num,
1803 p[NETMAP_BUF_POOL].size);
1805 d = _netmap_mem_private_new(sizeof(*d), p, -1, &netmap_mem_global_ops, 0, perr);
1810 /* Reference iommu allocator - find existing or create new,
1811 * for not hw addapeters fallback to global allocator.
1813 struct netmap_mem_d *
1814 netmap_mem_get_iommu(struct netmap_adapter *na)
1817 struct netmap_mem_d *nmd;
1819 if (na == NULL || na->pdev == NULL)
1820 return netmap_mem_get(&nm_mem);
1822 grp_id = nm_iommu_group_id(na->pdev);
1824 NM_MTX_LOCK(nm_mem_list_lock);
1825 nmd = netmap_last_mem_d;
1827 if (!(nmd->flags & NETMAP_MEM_HIDDEN) && nmd->nm_grp == grp_id) {
1829 NM_DBG_REFC(nmd, __FUNCTION__, __LINE__);
1830 NM_MTX_UNLOCK(nm_mem_list_lock);
1834 } while (nmd != netmap_last_mem_d);
1836 nmd = nm_os_malloc(sizeof(*nmd));
1840 *nmd = nm_mem_blueprint;
1842 err = nm_mem_assign_id_locked(nmd, grp_id);
1846 snprintf(nmd->name, sizeof(nmd->name), "%d", nmd->nm_id);
1848 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1849 snprintf(nmd->pools[i].name, NETMAP_POOL_MAX_NAMSZ, "%s-%s",
1850 nm_mem_blueprint.pools[i].name, nmd->name);
1855 NM_MTX_UNLOCK(nm_mem_list_lock);
1861 NM_MTX_UNLOCK(nm_mem_list_lock);
1865 /* call with lock held */
1867 netmap_mem2_config(struct netmap_mem_d *nmd)
1871 if (!netmap_mem_params_changed(nmd->params))
1874 nm_prdis("reconfiguring");
1876 if (nmd->flags & NETMAP_MEM_FINALIZED) {
1877 /* reset previous allocation */
1878 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1879 netmap_reset_obj_allocator(&nmd->pools[i]);
1881 nmd->flags &= ~NETMAP_MEM_FINALIZED;
1884 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1885 nmd->lasterr = netmap_config_obj_allocator(&nmd->pools[i],
1886 nmd->params[i].num, nmd->params[i].size);
1893 return nmd->lasterr;
1897 netmap_mem2_finalize(struct netmap_mem_d *nmd, struct netmap_adapter *na)
1899 if (nmd->flags & NETMAP_MEM_FINALIZED)
1902 if (netmap_mem_finalize_all(nmd))
1908 return nmd->lasterr;
1912 netmap_mem2_delete(struct netmap_mem_d *nmd)
1916 for (i = 0; i < NETMAP_POOLS_NR; i++) {
1917 netmap_destroy_obj_allocator(&nmd->pools[i]);
1920 NMA_LOCK_DESTROY(nmd);
1926 /* doubly linekd list of all existing external allocators */
1927 static struct netmap_mem_ext *netmap_mem_ext_list = NULL;
1928 NM_MTX_T nm_mem_ext_list_lock;
1929 #endif /* WITH_EXTMEM */
1932 netmap_mem_init(void)
1934 nm_mem_blueprint = nm_mem;
1935 NM_MTX_INIT(nm_mem_list_lock);
1936 NMA_LOCK_INIT(&nm_mem);
1937 netmap_mem_get(&nm_mem);
1939 NM_MTX_INIT(nm_mem_ext_list_lock);
1940 #endif /* WITH_EXTMEM */
1945 netmap_mem_fini(void)
1947 netmap_mem_put(&nm_mem);
1951 netmap_mem_ring_needed(struct netmap_kring *kring)
1953 return kring->ring == NULL &&
1954 (kring->users > 0 ||
1955 (kring->nr_kflags & NKR_NEEDRING));
1959 netmap_mem_ring_todelete(struct netmap_kring *kring)
1961 return kring->ring != NULL &&
1962 kring->users == 0 &&
1963 !(kring->nr_kflags & NKR_NEEDRING);
1967 /* call with NMA_LOCK held *
1969 * Allocate netmap rings and buffers for this card
1970 * The rings are contiguous, but have variable size.
1971 * The kring array must follow the layout described
1972 * in netmap_krings_create().
1975 netmap_mem2_rings_create(struct netmap_mem_d *nmd, struct netmap_adapter *na)
1982 for (i = 0; i < netmap_all_rings(na, t); i++) {
1983 struct netmap_kring *kring = NMR(na, t)[i];
1984 struct netmap_ring *ring = kring->ring;
1987 if (!netmap_mem_ring_needed(kring)) {
1988 /* unneeded, or already created by somebody else */
1989 if (netmap_debug & NM_DEBUG_MEM)
1990 nm_prinf("NOT creating ring %s (ring %p, users %d neekring %d)",
1991 kring->name, ring, kring->users, kring->nr_kflags & NKR_NEEDRING);
1994 if (netmap_debug & NM_DEBUG_MEM)
1995 nm_prinf("creating %s", kring->name);
1996 ndesc = kring->nkr_num_slots;
1997 len = sizeof(struct netmap_ring) +
1998 ndesc * sizeof(struct netmap_slot);
1999 ring = netmap_ring_malloc(nmd, len);
2001 nm_prerr("Cannot allocate %s_ring", nm_txrx2str(t));
2004 nm_prdis("txring at %p", ring);
2006 *(uint32_t *)(uintptr_t)&ring->num_slots = ndesc;
2007 *(int64_t *)(uintptr_t)&ring->buf_ofs =
2008 (nmd->pools[NETMAP_IF_POOL].memtotal +
2009 nmd->pools[NETMAP_RING_POOL].memtotal) -
2010 netmap_ring_offset(nmd, ring);
2012 /* copy values from kring */
2013 ring->head = kring->rhead;
2014 ring->cur = kring->rcur;
2015 ring->tail = kring->rtail;
2016 *(uint32_t *)(uintptr_t)&ring->nr_buf_size =
2017 netmap_mem_bufsize(nmd);
2018 nm_prdis("%s h %d c %d t %d", kring->name,
2019 ring->head, ring->cur, ring->tail);
2020 nm_prdis("initializing slots for %s_ring", nm_txrx2str(t));
2021 if (!(kring->nr_kflags & NKR_FAKERING)) {
2022 /* this is a real ring */
2023 if (netmap_debug & NM_DEBUG_MEM)
2024 nm_prinf("allocating buffers for %s", kring->name);
2025 if (netmap_new_bufs(nmd, ring->slot, ndesc)) {
2026 nm_prerr("Cannot allocate buffers for %s_ring", nm_txrx2str(t));
2030 /* this is a fake ring, set all indices to 0 */
2031 if (netmap_debug & NM_DEBUG_MEM)
2032 nm_prinf("NOT allocating buffers for %s", kring->name);
2033 netmap_mem_set_ring(nmd, ring->slot, ndesc, 0);
2036 *(uint16_t *)(uintptr_t)&ring->ringid = kring->ring_id;
2037 *(uint16_t *)(uintptr_t)&ring->dir = kring->tx;
2044 /* we cannot actually cleanup here, since we don't own kring->users
2045 * and kring->nr_klags & NKR_NEEDRING. The caller must decrement
2046 * the first or zero-out the second, then call netmap_free_rings()
2054 netmap_mem2_rings_delete(struct netmap_mem_d *nmd, struct netmap_adapter *na)
2060 for (i = 0; i < netmap_all_rings(na, t); i++) {
2061 struct netmap_kring *kring = NMR(na, t)[i];
2062 struct netmap_ring *ring = kring->ring;
2064 if (!netmap_mem_ring_todelete(kring)) {
2065 if (netmap_debug & NM_DEBUG_MEM)
2066 nm_prinf("NOT deleting ring %s (ring %p, users %d neekring %d)",
2067 kring->name, ring, kring->users, kring->nr_kflags & NKR_NEEDRING);
2070 if (netmap_debug & NM_DEBUG_MEM)
2071 nm_prinf("deleting ring %s", kring->name);
2072 if (!(kring->nr_kflags & NKR_FAKERING)) {
2073 nm_prdis("freeing bufs for %s", kring->name);
2074 netmap_free_bufs(nmd, ring->slot, kring->nkr_num_slots);
2076 nm_prdis("NOT freeing bufs for %s", kring->name);
2078 netmap_ring_free(nmd, ring);
2084 /* call with NMA_LOCK held */
2086 * Allocate the per-fd structure netmap_if.
2088 * We assume that the configuration stored in na
2089 * (number of tx/rx rings and descs) does not change while
2090 * the interface is in netmap mode.
2092 static struct netmap_if *
2093 netmap_mem2_if_new(struct netmap_mem_d *nmd,
2094 struct netmap_adapter *na, struct netmap_priv_d *priv)
2096 struct netmap_if *nifp;
2097 ssize_t base; /* handy for relative offsets between rings and nifp */
2098 u_int i, len, n[NR_TXRX], ntot;
2103 /* account for the (eventually fake) host rings */
2104 n[t] = netmap_all_rings(na, t);
2108 * the descriptor is followed inline by an array of offsets
2109 * to the tx and rx rings in the shared memory region.
2112 len = sizeof(struct netmap_if) + (ntot * sizeof(ssize_t));
2113 nifp = netmap_if_malloc(nmd, len);
2118 /* initialize base fields -- override const */
2119 *(u_int *)(uintptr_t)&nifp->ni_tx_rings = na->num_tx_rings;
2120 *(u_int *)(uintptr_t)&nifp->ni_rx_rings = na->num_rx_rings;
2121 *(u_int *)(uintptr_t)&nifp->ni_host_tx_rings =
2122 (na->num_host_tx_rings ? na->num_host_tx_rings : 1);
2123 *(u_int *)(uintptr_t)&nifp->ni_host_rx_rings =
2124 (na->num_host_rx_rings ? na->num_host_rx_rings : 1);
2125 strlcpy(nifp->ni_name, na->name, sizeof(nifp->ni_name));
2128 * fill the slots for the rx and tx rings. They contain the offset
2129 * between the ring and nifp, so the information is usable in
2130 * userspace to reach the ring from the nifp.
2132 base = netmap_if_offset(nmd, nifp);
2133 for (i = 0; i < n[NR_TX]; i++) {
2134 /* XXX instead of ofs == 0 maybe use the offset of an error
2135 * ring, like we do for buffers? */
2138 if (na->tx_rings[i]->ring != NULL && i >= priv->np_qfirst[NR_TX]
2139 && i < priv->np_qlast[NR_TX]) {
2140 ofs = netmap_ring_offset(nmd,
2141 na->tx_rings[i]->ring) - base;
2143 *(ssize_t *)(uintptr_t)&nifp->ring_ofs[i] = ofs;
2145 for (i = 0; i < n[NR_RX]; i++) {
2146 /* XXX instead of ofs == 0 maybe use the offset of an error
2147 * ring, like we do for buffers? */
2150 if (na->rx_rings[i]->ring != NULL && i >= priv->np_qfirst[NR_RX]
2151 && i < priv->np_qlast[NR_RX]) {
2152 ofs = netmap_ring_offset(nmd,
2153 na->rx_rings[i]->ring) - base;
2155 *(ssize_t *)(uintptr_t)&nifp->ring_ofs[i+n[NR_TX]] = ofs;
2162 netmap_mem2_if_delete(struct netmap_mem_d *nmd,
2163 struct netmap_adapter *na, struct netmap_if *nifp)
2168 if (nifp->ni_bufs_head)
2169 netmap_extra_free(na, nifp->ni_bufs_head);
2170 netmap_if_free(nmd, nifp);
2174 netmap_mem2_deref(struct netmap_mem_d *nmd, struct netmap_adapter *na)
2177 if (netmap_debug & NM_DEBUG_MEM)
2178 nm_prinf("active = %d", nmd->active);
2182 struct netmap_mem_ops netmap_mem_global_ops = {
2183 .nmd_get_lut = netmap_mem2_get_lut,
2184 .nmd_get_info = netmap_mem2_get_info,
2185 .nmd_ofstophys = netmap_mem2_ofstophys,
2186 .nmd_config = netmap_mem2_config,
2187 .nmd_finalize = netmap_mem2_finalize,
2188 .nmd_deref = netmap_mem2_deref,
2189 .nmd_delete = netmap_mem2_delete,
2190 .nmd_if_offset = netmap_mem2_if_offset,
2191 .nmd_if_new = netmap_mem2_if_new,
2192 .nmd_if_delete = netmap_mem2_if_delete,
2193 .nmd_rings_create = netmap_mem2_rings_create,
2194 .nmd_rings_delete = netmap_mem2_rings_delete
2198 netmap_mem_pools_info_get(struct nmreq_pools_info *req,
2199 struct netmap_mem_d *nmd)
2203 ret = netmap_mem_get_info(nmd, &req->nr_memsize, NULL,
2210 req->nr_if_pool_offset = 0;
2211 req->nr_if_pool_objtotal = nmd->pools[NETMAP_IF_POOL].objtotal;
2212 req->nr_if_pool_objsize = nmd->pools[NETMAP_IF_POOL]._objsize;
2214 req->nr_ring_pool_offset = nmd->pools[NETMAP_IF_POOL].memtotal;
2215 req->nr_ring_pool_objtotal = nmd->pools[NETMAP_RING_POOL].objtotal;
2216 req->nr_ring_pool_objsize = nmd->pools[NETMAP_RING_POOL]._objsize;
2218 req->nr_buf_pool_offset = nmd->pools[NETMAP_IF_POOL].memtotal +
2219 nmd->pools[NETMAP_RING_POOL].memtotal;
2220 req->nr_buf_pool_objtotal = nmd->pools[NETMAP_BUF_POOL].objtotal;
2221 req->nr_buf_pool_objsize = nmd->pools[NETMAP_BUF_POOL]._objsize;
2228 struct netmap_mem_ext {
2229 struct netmap_mem_d up;
2231 struct nm_os_extmem *os;
2232 struct netmap_mem_ext *next, *prev;
2235 /* call with nm_mem_list_lock held */
2237 netmap_mem_ext_register(struct netmap_mem_ext *e)
2239 NM_MTX_LOCK(nm_mem_ext_list_lock);
2240 if (netmap_mem_ext_list)
2241 netmap_mem_ext_list->prev = e;
2242 e->next = netmap_mem_ext_list;
2243 netmap_mem_ext_list = e;
2245 NM_MTX_UNLOCK(nm_mem_ext_list_lock);
2248 /* call with nm_mem_list_lock held */
2250 netmap_mem_ext_unregister(struct netmap_mem_ext *e)
2253 e->prev->next = e->next;
2255 netmap_mem_ext_list = e->next;
2257 e->next->prev = e->prev;
2258 e->prev = e->next = NULL;
2261 static struct netmap_mem_ext *
2262 netmap_mem_ext_search(struct nm_os_extmem *os)
2264 struct netmap_mem_ext *e;
2266 NM_MTX_LOCK(nm_mem_ext_list_lock);
2267 for (e = netmap_mem_ext_list; e; e = e->next) {
2268 if (nm_os_extmem_isequal(e->os, os)) {
2269 netmap_mem_get(&e->up);
2273 NM_MTX_UNLOCK(nm_mem_ext_list_lock);
2279 netmap_mem_ext_delete(struct netmap_mem_d *d)
2282 struct netmap_mem_ext *e =
2283 (struct netmap_mem_ext *)d;
2285 netmap_mem_ext_unregister(e);
2287 for (i = 0; i < NETMAP_POOLS_NR; i++) {
2288 struct netmap_obj_pool *p = &d->pools[i];
2291 nm_free_lut(p->lut, p->objtotal);
2296 nm_os_extmem_delete(e->os);
2297 netmap_mem2_delete(d);
2301 netmap_mem_ext_config(struct netmap_mem_d *nmd)
2306 struct netmap_mem_ops netmap_mem_ext_ops = {
2307 .nmd_get_lut = netmap_mem2_get_lut,
2308 .nmd_get_info = netmap_mem2_get_info,
2309 .nmd_ofstophys = netmap_mem2_ofstophys,
2310 .nmd_config = netmap_mem_ext_config,
2311 .nmd_finalize = netmap_mem2_finalize,
2312 .nmd_deref = netmap_mem2_deref,
2313 .nmd_delete = netmap_mem_ext_delete,
2314 .nmd_if_offset = netmap_mem2_if_offset,
2315 .nmd_if_new = netmap_mem2_if_new,
2316 .nmd_if_delete = netmap_mem2_if_delete,
2317 .nmd_rings_create = netmap_mem2_rings_create,
2318 .nmd_rings_delete = netmap_mem2_rings_delete
2321 struct netmap_mem_d *
2322 netmap_mem_ext_create(uint64_t usrptr, struct nmreq_pools_info *pi, int *perror)
2326 struct netmap_mem_ext *nme;
2329 struct nm_os_extmem *os = NULL;
2332 // XXX sanity checks
2333 if (pi->nr_if_pool_objtotal == 0)
2334 pi->nr_if_pool_objtotal = netmap_min_priv_params[NETMAP_IF_POOL].num;
2335 if (pi->nr_if_pool_objsize == 0)
2336 pi->nr_if_pool_objsize = netmap_min_priv_params[NETMAP_IF_POOL].size;
2337 if (pi->nr_ring_pool_objtotal == 0)
2338 pi->nr_ring_pool_objtotal = netmap_min_priv_params[NETMAP_RING_POOL].num;
2339 if (pi->nr_ring_pool_objsize == 0)
2340 pi->nr_ring_pool_objsize = netmap_min_priv_params[NETMAP_RING_POOL].size;
2341 if (pi->nr_buf_pool_objtotal == 0)
2342 pi->nr_buf_pool_objtotal = netmap_min_priv_params[NETMAP_BUF_POOL].num;
2343 if (pi->nr_buf_pool_objsize == 0)
2344 pi->nr_buf_pool_objsize = netmap_min_priv_params[NETMAP_BUF_POOL].size;
2345 if (netmap_verbose & NM_DEBUG_MEM)
2346 nm_prinf("if %d %d ring %d %d buf %d %d",
2347 pi->nr_if_pool_objtotal, pi->nr_if_pool_objsize,
2348 pi->nr_ring_pool_objtotal, pi->nr_ring_pool_objsize,
2349 pi->nr_buf_pool_objtotal, pi->nr_buf_pool_objsize);
2351 os = nm_os_extmem_create(usrptr, pi, &error);
2353 nm_prerr("os extmem creation failed");
2357 nme = netmap_mem_ext_search(os);
2359 nm_os_extmem_delete(os);
2362 if (netmap_verbose & NM_DEBUG_MEM)
2363 nm_prinf("not found, creating new");
2365 nme = _netmap_mem_private_new(sizeof(*nme),
2367 (struct netmap_obj_params[]){
2368 { pi->nr_if_pool_objsize, pi->nr_if_pool_objtotal },
2369 { pi->nr_ring_pool_objsize, pi->nr_ring_pool_objtotal },
2370 { pi->nr_buf_pool_objsize, pi->nr_buf_pool_objtotal }},
2372 &netmap_mem_ext_ops,
2378 nr_pages = nm_os_extmem_nr_pages(os);
2380 /* from now on pages will be released by nme destructor;
2381 * we let res = 0 to prevent release in out_unmap below
2384 os = NULL; /* pass ownership */
2386 clust = nm_os_extmem_nextpage(nme->os);
2388 for (i = 0; i < NETMAP_POOLS_NR; i++) {
2389 struct netmap_obj_pool *p = &nme->up.pools[i];
2390 struct netmap_obj_params *o = &nme->up.params[i];
2392 p->_objsize = o->size;
2393 p->_clustsize = o->size;
2394 p->_clustentries = 1;
2396 p->lut = nm_alloc_lut(o->num);
2397 if (p->lut == NULL) {
2402 p->bitmap_slots = (o->num + sizeof(uint32_t) - 1) / sizeof(uint32_t);
2403 p->invalid_bitmap = nm_os_malloc(sizeof(uint32_t) * p->bitmap_slots);
2404 if (p->invalid_bitmap == NULL) {
2409 if (nr_pages == 0) {
2416 for (j = 0; j < o->num && nr_pages > 0; j++) {
2419 p->lut[j].vaddr = clust + off;
2420 #if !defined(linux) && !defined(_WIN32)
2421 p->lut[j].paddr = vtophys(p->lut[j].vaddr);
2423 nm_prdis("%s %d at %p", p->name, j, p->lut[j].vaddr);
2424 noff = off + p->_objsize;
2425 if (noff < PAGE_SIZE) {
2429 nm_prdis("too big, recomputing offset...");
2430 while (noff >= PAGE_SIZE) {
2431 char *old_clust = clust;
2433 clust = nm_os_extmem_nextpage(nme->os);
2435 nm_prdis("noff %zu page %p nr_pages %d", noff,
2436 page_to_virt(*pages), nr_pages);
2437 if (noff > 0 && !nm_isset(p->invalid_bitmap, j) &&
2439 old_clust + PAGE_SIZE != clust))
2441 /* out of space or non contiguous,
2444 p->invalid_bitmap[ (j>>5) ] |= 1U << (j & 31U);
2445 nm_prdis("non contiguous at off %zu, drop", noff);
2453 p->numclusters = p->objtotal;
2454 p->memtotal = j * (size_t)p->_objsize;
2455 nm_prdis("%d memtotal %zu", j, p->memtotal);
2458 netmap_mem_ext_register(nme);
2463 netmap_mem_put(&nme->up);
2466 nm_os_extmem_delete(os);
2473 #endif /* WITH_EXTMEM */
2476 #ifdef WITH_PTNETMAP
2478 struct mem_pt_if *next;
2480 unsigned int nifp_offset;
2483 /* Netmap allocator for ptnetmap guests. */
2484 struct netmap_mem_ptg {
2485 struct netmap_mem_d up;
2487 vm_paddr_t nm_paddr; /* physical address in the guest */
2488 void *nm_addr; /* virtual address in the guest */
2489 struct netmap_lut buf_lut; /* lookup table for BUF pool in the guest */
2490 nm_memid_t host_mem_id; /* allocator identifier in the host */
2491 struct ptnetmap_memdev *ptn_dev;/* ptnetmap memdev */
2492 struct mem_pt_if *pt_ifs; /* list of interfaces in passthrough */
2495 /* Link a passthrough interface to a passthrough netmap allocator. */
2497 netmap_mem_pt_guest_ifp_add(struct netmap_mem_d *nmd, struct ifnet *ifp,
2498 unsigned int nifp_offset)
2500 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2501 struct mem_pt_if *ptif = nm_os_malloc(sizeof(*ptif));
2510 ptif->nifp_offset = nifp_offset;
2512 if (ptnmd->pt_ifs) {
2513 ptif->next = ptnmd->pt_ifs;
2515 ptnmd->pt_ifs = ptif;
2519 nm_prinf("ifp=%s,nifp_offset=%u",
2520 ptif->ifp->if_xname, ptif->nifp_offset);
2525 /* Called with NMA_LOCK(nmd) held. */
2526 static struct mem_pt_if *
2527 netmap_mem_pt_guest_ifp_lookup(struct netmap_mem_d *nmd, struct ifnet *ifp)
2529 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2530 struct mem_pt_if *curr;
2532 for (curr = ptnmd->pt_ifs; curr; curr = curr->next) {
2533 if (curr->ifp == ifp) {
2541 /* Unlink a passthrough interface from a passthrough netmap allocator. */
2543 netmap_mem_pt_guest_ifp_del(struct netmap_mem_d *nmd, struct ifnet *ifp)
2545 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2546 struct mem_pt_if *prev = NULL;
2547 struct mem_pt_if *curr;
2552 for (curr = ptnmd->pt_ifs; curr; curr = curr->next) {
2553 if (curr->ifp == ifp) {
2555 prev->next = curr->next;
2557 ptnmd->pt_ifs = curr->next;
2559 nm_prinf("removed (ifp=%s,nifp_offset=%u)",
2560 curr->ifp->if_xname, curr->nifp_offset);
2574 netmap_mem_pt_guest_get_lut(struct netmap_mem_d *nmd, struct netmap_lut *lut)
2576 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2578 if (!(nmd->flags & NETMAP_MEM_FINALIZED)) {
2582 *lut = ptnmd->buf_lut;
2587 netmap_mem_pt_guest_get_info(struct netmap_mem_d *nmd, uint64_t *size,
2588 u_int *memflags, uint16_t *id)
2592 error = nmd->ops->nmd_config(nmd);
2597 *size = nmd->nm_totalsize;
2599 *memflags = nmd->flags;
2609 netmap_mem_pt_guest_ofstophys(struct netmap_mem_d *nmd, vm_ooffset_t off)
2611 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2613 /* if the offset is valid, just return csb->base_addr + off */
2614 paddr = (vm_paddr_t)(ptnmd->nm_paddr + off);
2615 nm_prdis("off %lx padr %lx", off, (unsigned long)paddr);
2620 netmap_mem_pt_guest_config(struct netmap_mem_d *nmd)
2622 /* nothing to do, we are configured on creation
2623 * and configuration never changes thereafter
2629 netmap_mem_pt_guest_finalize(struct netmap_mem_d *nmd, struct netmap_adapter *na)
2631 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2641 if (nmd->flags & NETMAP_MEM_FINALIZED)
2644 if (ptnmd->ptn_dev == NULL) {
2645 nm_prerr("ptnetmap memdev not attached");
2649 /* Map memory through ptnetmap-memdev BAR. */
2650 error = nm_os_pt_memdev_iomap(ptnmd->ptn_dev, &ptnmd->nm_paddr,
2651 &ptnmd->nm_addr, &mem_size);
2655 /* Initialize the lut using the information contained in the
2656 * ptnetmap memory device. */
2657 bufsize = nm_os_pt_memdev_ioread(ptnmd->ptn_dev,
2658 PTNET_MDEV_IO_BUF_POOL_OBJSZ);
2659 nbuffers = nm_os_pt_memdev_ioread(ptnmd->ptn_dev,
2660 PTNET_MDEV_IO_BUF_POOL_OBJNUM);
2662 /* allocate the lut */
2663 if (ptnmd->buf_lut.lut == NULL) {
2664 nm_prinf("allocating lut");
2665 ptnmd->buf_lut.lut = nm_alloc_lut(nbuffers);
2666 if (ptnmd->buf_lut.lut == NULL) {
2667 nm_prerr("lut allocation failed");
2672 /* we have physically contiguous memory mapped through PCI BAR */
2673 poolofs = nm_os_pt_memdev_ioread(ptnmd->ptn_dev,
2674 PTNET_MDEV_IO_BUF_POOL_OFS);
2675 vaddr = (char *)(ptnmd->nm_addr) + poolofs;
2676 paddr = ptnmd->nm_paddr + poolofs;
2678 for (i = 0; i < nbuffers; i++) {
2679 ptnmd->buf_lut.lut[i].vaddr = vaddr;
2684 ptnmd->buf_lut.objtotal = nbuffers;
2685 ptnmd->buf_lut.objsize = bufsize;
2686 nmd->nm_totalsize = mem_size;
2688 /* Initialize these fields as are needed by
2689 * netmap_mem_bufsize().
2690 * XXX please improve this, why do we need this
2691 * replication? maybe we nmd->pools[] should no be
2692 * there for the guest allocator? */
2693 nmd->pools[NETMAP_BUF_POOL]._objsize = bufsize;
2694 nmd->pools[NETMAP_BUF_POOL]._objtotal = nbuffers;
2696 nmd->flags |= NETMAP_MEM_FINALIZED;
2702 netmap_mem_pt_guest_deref(struct netmap_mem_d *nmd, struct netmap_adapter *na)
2704 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2706 if (nmd->active == 1 &&
2707 (nmd->flags & NETMAP_MEM_FINALIZED)) {
2708 nmd->flags &= ~NETMAP_MEM_FINALIZED;
2709 /* unmap ptnetmap-memdev memory */
2710 if (ptnmd->ptn_dev) {
2711 nm_os_pt_memdev_iounmap(ptnmd->ptn_dev);
2713 ptnmd->nm_addr = NULL;
2714 ptnmd->nm_paddr = 0;
2719 netmap_mem_pt_guest_if_offset(struct netmap_mem_d *nmd, const void *vaddr)
2721 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2723 return (const char *)(vaddr) - (char *)(ptnmd->nm_addr);
2727 netmap_mem_pt_guest_delete(struct netmap_mem_d *nmd)
2732 nm_prinf("deleting %p", nmd);
2733 if (nmd->active > 0)
2734 nm_prerr("bug: deleting mem allocator with active=%d!", nmd->active);
2736 nm_prinf("done deleting %p", nmd);
2737 NMA_LOCK_DESTROY(nmd);
2741 static struct netmap_if *
2742 netmap_mem_pt_guest_if_new(struct netmap_mem_d *nmd,
2743 struct netmap_adapter *na, struct netmap_priv_d *priv)
2745 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2746 struct mem_pt_if *ptif;
2747 struct netmap_if *nifp = NULL;
2749 ptif = netmap_mem_pt_guest_ifp_lookup(nmd, na->ifp);
2751 nm_prerr("interface %s is not in passthrough", na->name);
2755 nifp = (struct netmap_if *)((char *)(ptnmd->nm_addr) +
2762 netmap_mem_pt_guest_if_delete(struct netmap_mem_d * nmd,
2763 struct netmap_adapter *na, struct netmap_if *nifp)
2765 struct mem_pt_if *ptif;
2767 ptif = netmap_mem_pt_guest_ifp_lookup(nmd, na->ifp);
2769 nm_prerr("interface %s is not in passthrough", na->name);
2774 netmap_mem_pt_guest_rings_create(struct netmap_mem_d *nmd,
2775 struct netmap_adapter *na)
2777 struct netmap_mem_ptg *ptnmd = (struct netmap_mem_ptg *)nmd;
2778 struct mem_pt_if *ptif;
2779 struct netmap_if *nifp;
2782 ptif = netmap_mem_pt_guest_ifp_lookup(nmd, na->ifp);
2784 nm_prerr("interface %s is not in passthrough", na->name);
2789 /* point each kring to the corresponding backend ring */
2790 nifp = (struct netmap_if *)((char *)ptnmd->nm_addr + ptif->nifp_offset);
2791 for (i = 0; i < netmap_all_rings(na, NR_TX); i++) {
2792 struct netmap_kring *kring = na->tx_rings[i];
2795 kring->ring = (struct netmap_ring *)
2796 ((char *)nifp + nifp->ring_ofs[i]);
2798 for (i = 0; i < netmap_all_rings(na, NR_RX); i++) {
2799 struct netmap_kring *kring = na->rx_rings[i];
2802 kring->ring = (struct netmap_ring *)
2804 nifp->ring_ofs[netmap_all_rings(na, NR_TX) + i]);
2813 netmap_mem_pt_guest_rings_delete(struct netmap_mem_d *nmd, struct netmap_adapter *na)
2820 for (i = 0; i < nma_get_nrings(na, t) + 1; i++) {
2821 struct netmap_kring *kring = &NMR(na, t)[i];
2831 static struct netmap_mem_ops netmap_mem_pt_guest_ops = {
2832 .nmd_get_lut = netmap_mem_pt_guest_get_lut,
2833 .nmd_get_info = netmap_mem_pt_guest_get_info,
2834 .nmd_ofstophys = netmap_mem_pt_guest_ofstophys,
2835 .nmd_config = netmap_mem_pt_guest_config,
2836 .nmd_finalize = netmap_mem_pt_guest_finalize,
2837 .nmd_deref = netmap_mem_pt_guest_deref,
2838 .nmd_if_offset = netmap_mem_pt_guest_if_offset,
2839 .nmd_delete = netmap_mem_pt_guest_delete,
2840 .nmd_if_new = netmap_mem_pt_guest_if_new,
2841 .nmd_if_delete = netmap_mem_pt_guest_if_delete,
2842 .nmd_rings_create = netmap_mem_pt_guest_rings_create,
2843 .nmd_rings_delete = netmap_mem_pt_guest_rings_delete
2846 /* Called with nm_mem_list_lock held. */
2847 static struct netmap_mem_d *
2848 netmap_mem_pt_guest_find_memid(nm_memid_t mem_id)
2850 struct netmap_mem_d *mem = NULL;
2851 struct netmap_mem_d *scan = netmap_last_mem_d;
2854 /* find ptnetmap allocator through host ID */
2855 if (scan->ops->nmd_deref == netmap_mem_pt_guest_deref &&
2856 ((struct netmap_mem_ptg *)(scan))->host_mem_id == mem_id) {
2859 NM_DBG_REFC(mem, __FUNCTION__, __LINE__);
2863 } while (scan != netmap_last_mem_d);
2868 /* Called with nm_mem_list_lock held. */
2869 static struct netmap_mem_d *
2870 netmap_mem_pt_guest_create(nm_memid_t mem_id)
2872 struct netmap_mem_ptg *ptnmd;
2875 ptnmd = nm_os_malloc(sizeof(struct netmap_mem_ptg));
2876 if (ptnmd == NULL) {
2881 ptnmd->up.ops = &netmap_mem_pt_guest_ops;
2882 ptnmd->host_mem_id = mem_id;
2883 ptnmd->pt_ifs = NULL;
2885 /* Assign new id in the guest (We have the lock) */
2886 err = nm_mem_assign_id_locked(&ptnmd->up, -1);
2890 ptnmd->up.flags &= ~NETMAP_MEM_FINALIZED;
2891 ptnmd->up.flags |= NETMAP_MEM_IO;
2893 NMA_LOCK_INIT(&ptnmd->up);
2895 snprintf(ptnmd->up.name, NM_MEM_NAMESZ, "%d", ptnmd->up.nm_id);
2900 netmap_mem_pt_guest_delete(&ptnmd->up);
2905 * find host id in guest allocators and create guest allocator
2906 * if it is not there
2908 static struct netmap_mem_d *
2909 netmap_mem_pt_guest_get(nm_memid_t mem_id)
2911 struct netmap_mem_d *nmd;
2913 NM_MTX_LOCK(nm_mem_list_lock);
2914 nmd = netmap_mem_pt_guest_find_memid(mem_id);
2916 nmd = netmap_mem_pt_guest_create(mem_id);
2918 NM_MTX_UNLOCK(nm_mem_list_lock);
2924 * The guest allocator can be created by ptnetmap_memdev (during the device
2925 * attach) or by ptnetmap device (ptnet), during the netmap_attach.
2927 * The order is not important (we have different order in LINUX and FreeBSD).
2928 * The first one, creates the device, and the second one simply attaches it.
2931 /* Called when ptnetmap_memdev is attaching, to attach a new allocator in
2933 struct netmap_mem_d *
2934 netmap_mem_pt_guest_attach(struct ptnetmap_memdev *ptn_dev, nm_memid_t mem_id)
2936 struct netmap_mem_d *nmd;
2937 struct netmap_mem_ptg *ptnmd;
2939 nmd = netmap_mem_pt_guest_get(mem_id);
2941 /* assign this device to the guest allocator */
2943 ptnmd = (struct netmap_mem_ptg *)nmd;
2944 ptnmd->ptn_dev = ptn_dev;
2950 /* Called when ptnet device is attaching */
2951 struct netmap_mem_d *
2952 netmap_mem_pt_guest_new(struct ifnet *ifp,
2953 unsigned int nifp_offset,
2956 struct netmap_mem_d *nmd;
2962 nmd = netmap_mem_pt_guest_get((nm_memid_t)memid);
2965 netmap_mem_pt_guest_ifp_add(nmd, ifp, nifp_offset);
2971 #endif /* WITH_PTNETMAP */