1 /* 2 * Copyright (C) 2011-2014 Matteo Landi, Luigi Rizzo. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``S IS''AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 /* $FreeBSD$ */ 27 28 #ifndef _NET_NETMAP_LEGACY_H_ 29 #define _NET_NETMAP_LEGACY_H_ 30 31 /* 32 * ioctl names and related fields 33 * 34 * NIOCTXSYNC, NIOCRXSYNC synchronize tx or rx queues, 35 * whose identity is set in NIOCREGIF through nr_ringid. 36 * These are non blocking and take no argument. 37 * 38 * NIOCGINFO takes a struct ifreq, the interface name is the input, 39 * the outputs are number of queues and number of descriptor 40 * for each queue (useful to set number of threads etc.). 41 * The info returned is only advisory and may change before 42 * the interface is bound to a file descriptor. 43 * 44 * NIOCREGIF takes an interface name within a struct nmre, 45 * and activates netmap mode on the interface (if possible). 46 * 47 * The argument to NIOCGINFO/NIOCREGIF overlays struct ifreq so we 48 * can pass it down to other NIC-related ioctls. 49 * 50 * The actual argument (struct nmreq) has a number of options to request 51 * different functions. 52 * The following are used in NIOCREGIF when nr_cmd == 0: 53 * 54 * nr_name (in) 55 * The name of the port (em0, valeXXX:YYY, etc.) 56 * limited to IFNAMSIZ for backward compatibility. 57 * 58 * nr_version (in/out) 59 * Must match NETMAP_API as used in the kernel, error otherwise. 60 * Always returns the desired value on output. 61 * 62 * nr_tx_slots, nr_tx_slots, nr_tx_rings, nr_rx_rings (in/out) 63 * On input, non-zero values may be used to reconfigure the port 64 * according to the requested values, but this is not guaranteed. 65 * On output the actual values in use are reported. 66 * 67 * nr_ringid (in) 68 * Indicates how rings should be bound to the file descriptors. 69 * If nr_flags != 0, then the low bits (in NETMAP_RING_MASK) 70 * are used to indicate the ring number, and nr_flags specifies 71 * the actual rings to bind. NETMAP_NO_TX_POLL is unaffected. 72 * 73 * NOTE: THE FOLLOWING (nr_flags == 0) IS DEPRECATED: 74 * If nr_flags == 0, NETMAP_HW_RING and NETMAP_SW_RING control 75 * the binding as follows: 76 * 0 (default) binds all physical rings 77 * NETMAP_HW_RING | ring number binds a single ring pair 78 * NETMAP_SW_RING binds only the host tx/rx rings 79 * 80 * NETMAP_NO_TX_POLL can be OR-ed to make select()/poll() push 81 * packets on tx rings only if POLLOUT is set. 82 * The default is to push any pending packet. 83 * 84 * NETMAP_DO_RX_POLL can be OR-ed to make select()/poll() release 85 * packets on rx rings also when POLLIN is NOT set. 86 * The default is to touch the rx ring only with POLLIN. 87 * Note that this is the opposite of TX because it 88 * reflects the common usage. 89 * 90 * NOTE: NETMAP_PRIV_MEM IS DEPRECATED, use nr_arg2 instead. 91 * NETMAP_PRIV_MEM is set on return for ports that do not use 92 * the global memory allocator. 93 * This information is not significant and applications 94 * should look at the region id in nr_arg2 95 * 96 * nr_flags is the recommended mode to indicate which rings should 97 * be bound to a file descriptor. Values are NR_REG_* 98 * 99 * nr_arg1 (in) The number of extra rings to be reserved. 100 * Especially when allocating a VALE port the system only 101 * allocates the amount of memory needed for the port. 102 * If more shared memory rings are desired (e.g. for pipes), 103 * the first invocation for the same basename/allocator 104 * should specify a suitable number. Memory cannot be 105 * extended after the first allocation without closing 106 * all ports on the same region. 107 * 108 * nr_arg2 (in/out) The identity of the memory region used. 109 * On input, 0 means the system decides autonomously, 110 * other values may try to select a specific region. 111 * On return the actual value is reported. 112 * Region '1' is the global allocator, normally shared 113 * by all interfaces. Other values are private regions. 114 * If two ports the same region zero-copy is possible. 115 * 116 * nr_arg3 (in/out) number of extra buffers to be allocated. 117 * 118 * 119 * 120 * nr_cmd (in) if non-zero indicates a special command: 121 * NETMAP_BDG_ATTACH and nr_name = vale*:ifname 122 * attaches the NIC to the switch; nr_ringid specifies 123 * which rings to use. Used by vale-ctl -a ... 124 * nr_arg1 = NETMAP_BDG_HOST also attaches the host port 125 * as in vale-ctl -h ... 126 * 127 * NETMAP_BDG_DETACH and nr_name = vale*:ifname 128 * disconnects a previously attached NIC. 129 * Used by vale-ctl -d ... 130 * 131 * NETMAP_BDG_LIST 132 * list the configuration of VALE switches. 133 * 134 * NETMAP_BDG_VNET_HDR 135 * Set the virtio-net header length used by the client 136 * of a VALE switch port. 137 * 138 * NETMAP_BDG_NEWIF 139 * create a persistent VALE port with name nr_name. 140 * Used by vale-ctl -n ... 141 * 142 * NETMAP_BDG_DELIF 143 * delete a persistent VALE port. Used by vale-ctl -d ... 144 * 145 * nr_arg1, nr_arg2, nr_arg3 (in/out) command specific 146 * 147 * 148 * 149 */ 150 151 152 /* 153 * struct nmreq overlays a struct ifreq (just the name) 154 */ 155 struct nmreq { 156 char nr_name[IFNAMSIZ]; 157 uint32_t nr_version; /* API version */ 158 uint32_t nr_offset; /* nifp offset in the shared region */ 159 uint32_t nr_memsize; /* size of the shared region */ 160 uint32_t nr_tx_slots; /* slots in tx rings */ 161 uint32_t nr_rx_slots; /* slots in rx rings */ 162 uint16_t nr_tx_rings; /* number of tx rings */ 163 uint16_t nr_rx_rings; /* number of rx rings */ 164 165 uint16_t nr_ringid; /* ring(s) we care about */ 166 #define NETMAP_HW_RING 0x4000 /* single NIC ring pair */ 167 #define NETMAP_SW_RING 0x2000 /* only host ring pair */ 168 169 #define NETMAP_RING_MASK 0x0fff /* the ring number */ 170 171 #define NETMAP_NO_TX_POLL 0x1000 /* no automatic txsync on poll */ 172 173 #define NETMAP_DO_RX_POLL 0x8000 /* DO automatic rxsync on poll */ 174 175 uint16_t nr_cmd; 176 #define NETMAP_BDG_ATTACH 1 /* attach the NIC */ 177 #define NETMAP_BDG_DETACH 2 /* detach the NIC */ 178 #define NETMAP_BDG_REGOPS 3 /* register bridge callbacks */ 179 #define NETMAP_BDG_LIST 4 /* get bridge's info */ 180 #define NETMAP_BDG_VNET_HDR 5 /* set the port virtio-net-hdr length */ 181 #define NETMAP_BDG_NEWIF 6 /* create a virtual port */ 182 #define NETMAP_BDG_DELIF 7 /* destroy a virtual port */ 183 #define NETMAP_PT_HOST_CREATE 8 /* create ptnetmap kthreads */ 184 #define NETMAP_PT_HOST_DELETE 9 /* delete ptnetmap kthreads */ 185 #define NETMAP_BDG_POLLING_ON 10 /* delete polling kthread */ 186 #define NETMAP_BDG_POLLING_OFF 11 /* delete polling kthread */ 187 #define NETMAP_VNET_HDR_GET 12 /* get the port virtio-net-hdr length */ 188 uint16_t nr_arg1; /* reserve extra rings in NIOCREGIF */ 189 #define NETMAP_BDG_HOST 1 /* nr_arg1 value for NETMAP_BDG_ATTACH */ 190 191 uint16_t nr_arg2; /* id of the memory allocator */ 192 uint32_t nr_arg3; /* req. extra buffers in NIOCREGIF */ 193 uint32_t nr_flags; /* specify NR_REG_* mode and other flags */ 194 #define NR_REG_MASK 0xf /* to extract NR_REG_* mode from nr_flags */ 195 /* various modes, extends nr_ringid */ 196 uint32_t spare2[1]; 197 }; 198 199 #ifdef _WIN32 200 /* 201 * Windows does not have _IOWR(). _IO(), _IOW() and _IOR() are defined 202 * in ws2def.h but not sure if they are in the form we need. 203 * We therefore redefine them in a convenient way to use for DeviceIoControl 204 * signatures. 205 */ 206 #undef _IO // ws2def.h 207 #define _WIN_NM_IOCTL_TYPE 40000 208 #define _IO(_c, _n) CTL_CODE(_WIN_NM_IOCTL_TYPE, ((_n) + 0x800) , \ 209 METHOD_BUFFERED, FILE_ANY_ACCESS ) 210 #define _IO_direct(_c, _n) CTL_CODE(_WIN_NM_IOCTL_TYPE, ((_n) + 0x800) , \ 211 METHOD_OUT_DIRECT, FILE_ANY_ACCESS ) 212 213 #define _IOWR(_c, _n, _s) _IO(_c, _n) 214 215 /* We havesome internal sysctl in addition to the externally visible ones */ 216 #define NETMAP_MMAP _IO_direct('i', 160) // note METHOD_OUT_DIRECT 217 #define NETMAP_POLL _IO('i', 162) 218 219 /* and also two setsockopt for sysctl emulation */ 220 #define NETMAP_SETSOCKOPT _IO('i', 140) 221 #define NETMAP_GETSOCKOPT _IO('i', 141) 222 223 224 /* These linknames are for the Netmap Core Driver */ 225 #define NETMAP_NT_DEVICE_NAME L"\\Device\\NETMAP" 226 #define NETMAP_DOS_DEVICE_NAME L"\\DosDevices\\netmap" 227 228 /* Definition of a structure used to pass a virtual address within an IOCTL */ 229 typedef struct _MEMORY_ENTRY { 230 PVOID pUsermodeVirtualAddress; 231 } MEMORY_ENTRY, *PMEMORY_ENTRY; 232 233 typedef struct _POLL_REQUEST_DATA { 234 int events; 235 int timeout; 236 int revents; 237 } POLL_REQUEST_DATA; 238 #endif /* _WIN32 */ 239 240 /* 241 * Opaque structure that is passed to an external kernel 242 * module via ioctl(fd, NIOCCONFIG, req) for a user-owned 243 * bridge port (at this point ephemeral VALE interface). 244 */ 245 #define NM_IFRDATA_LEN 256 246 struct nm_ifreq { 247 char nifr_name[IFNAMSIZ]; 248 char data[NM_IFRDATA_LEN]; 249 }; 250 251 /* 252 * FreeBSD uses the size value embedded in the _IOWR to determine 253 * how much to copy in/out. So we need it to match the actual 254 * data structure we pass. We put some spares in the structure 255 * to ease compatibility with other versions 256 */ 257 #define NIOCGINFO _IOWR('i', 145, struct nmreq) /* return IF info */ 258 #define NIOCREGIF _IOWR('i', 146, struct nmreq) /* interface register */ 259 #define NIOCCONFIG _IOWR('i',150, struct nm_ifreq) /* for ext. modules */ 260 261 #endif /* _NET_NETMAP_LEGACY_H_ */ 262