1 /* 2 * Copyright (c) 1982, 1986, 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)if.h 8.1 (Berkeley) 6/10/93 34 * $FreeBSD: src/sys/net/if.h,v 1.58.2.9 2002/08/30 14:23:38 sobomax Exp $ 35 * $DragonFly: src/sys/net/if.h,v 1.8 2003/12/30 03:56:00 dillon Exp $ 36 */ 37 38 #ifndef _NET_IF_H_ 39 #define _NET_IF_H_ 40 41 #ifdef _KERNEL 42 #include <sys/queue.h> 43 #endif 44 45 /* 46 * <net/if.h> does not depend on <sys/time.h> on most other systems. This 47 * helps userland compatibility. (struct timeval ifi_lastchange) 48 */ 49 #ifndef _KERNEL 50 #include <sys/time.h> 51 #endif 52 53 struct ifnet; 54 55 /* 56 * Length of interface external name, including terminating '\0'. 57 * Note: this is the same size as a generic device's external name. 58 */ 59 #define IFNAMSIZ 16 60 #define IF_NAMESIZE IFNAMSIZ 61 #define IF_MAXUNIT 0x7fff /* if_unit is 15bits */ 62 63 #ifdef _KERNEL 64 /* 65 * Structure describing a `cloning' interface. 66 */ 67 struct if_clone { 68 LIST_ENTRY(if_clone) ifc_list; /* on list of cloners */ 69 const char *ifc_name; /* name of device, e.g. `gif' */ 70 size_t ifc_namelen; /* length of name */ 71 int ifc_minifs; /* minimum number of interfaces */ 72 int ifc_maxunit; /* maximum unit number */ 73 unsigned char *ifc_units; /* bitmap to handle units */ 74 int ifc_bmlen; /* bitmap length */ 75 76 int (*ifc_create)(struct if_clone *, int); 77 void (*ifc_destroy)(struct ifnet *); 78 }; 79 80 #define IF_CLONE_INITIALIZER(name, create, destroy, minifs, maxunit) \ 81 { { 0 }, name, sizeof(name) - 1, minifs, maxunit, NULL, 0, create, destroy } 82 #endif 83 84 /* 85 * Structure used to query names of interface cloners. 86 */ 87 88 struct if_clonereq { 89 int ifcr_total; /* total cloners (out) */ 90 int ifcr_count; /* room for this many in user buffer */ 91 char *ifcr_buffer; /* buffer for cloner names */ 92 }; 93 94 /* 95 * Structure describing information about an interface 96 * which may be of interest to management entities. 97 */ 98 struct if_data { 99 /* generic interface information */ 100 u_char ifi_type; /* ethernet, tokenring, etc */ 101 u_char ifi_physical; /* e.g., AUI, Thinnet, 10base-T, etc */ 102 u_char ifi_addrlen; /* media address length */ 103 u_char ifi_hdrlen; /* media header length */ 104 u_char ifi_recvquota; /* polling quota for receive intrs */ 105 u_char ifi_xmitquota; /* polling quota for xmit intrs */ 106 u_long ifi_mtu; /* maximum transmission unit */ 107 u_long ifi_metric; /* routing metric (external only) */ 108 u_long ifi_baudrate; /* linespeed */ 109 /* volatile statistics */ 110 u_long ifi_ipackets; /* packets received on interface */ 111 u_long ifi_ierrors; /* input errors on interface */ 112 u_long ifi_opackets; /* packets sent on interface */ 113 u_long ifi_oerrors; /* output errors on interface */ 114 u_long ifi_collisions; /* collisions on csma interfaces */ 115 u_long ifi_ibytes; /* total number of octets received */ 116 u_long ifi_obytes; /* total number of octets sent */ 117 u_long ifi_imcasts; /* packets received via multicast */ 118 u_long ifi_omcasts; /* packets sent via multicast */ 119 u_long ifi_iqdrops; /* dropped on input, this interface */ 120 u_long ifi_noproto; /* destined for unsupported protocol */ 121 u_long ifi_hwassist; /* HW offload capabilities */ 122 u_long ifi_unused; /* XXX was ifi_xmittiming */ 123 struct timeval ifi_lastchange; /* time of last administrative change */ 124 }; 125 126 #define IFF_UP 0x1 /* interface is up */ 127 #define IFF_BROADCAST 0x2 /* broadcast address valid */ 128 #define IFF_DEBUG 0x4 /* turn on debugging */ 129 #define IFF_LOOPBACK 0x8 /* is a loopback net */ 130 #define IFF_POINTOPOINT 0x10 /* interface is point-to-point link */ 131 #define IFF_SMART 0x20 /* interface manages own routes */ 132 #define IFF_RUNNING 0x40 /* resources allocated */ 133 #define IFF_NOARP 0x80 /* no address resolution protocol */ 134 #define IFF_PROMISC 0x100 /* receive all packets */ 135 #define IFF_ALLMULTI 0x200 /* receive all multicast packets */ 136 #define IFF_OACTIVE 0x400 /* transmission in progress */ 137 #define IFF_SIMPLEX 0x800 /* can't hear own transmissions */ 138 #define IFF_LINK0 0x1000 /* per link layer defined bit */ 139 #define IFF_LINK1 0x2000 /* per link layer defined bit */ 140 #define IFF_LINK2 0x4000 /* per link layer defined bit */ 141 #define IFF_ALTPHYS IFF_LINK2 /* use alternate physical connection */ 142 #define IFF_MULTICAST 0x8000 /* supports multicast */ 143 144 /* 145 * The following flag(s) ought to go in if_flags, but we cannot change 146 * struct ifnet because of binary compatibility, so we store them in 147 * if_ipending, which is not used so far. 148 * If possible, make sure the value is not conflicting with other 149 * IFF flags, so we have an easier time when we want to merge them. 150 */ 151 #define IFF_POLLING 0x10000 /* Interface is in polling mode. */ 152 #define IFF_PPROMISC 0x20000 /* user-requested promisc mode */ 153 154 /* flags set internally only: */ 155 #define IFF_CANTCHANGE \ 156 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 157 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING) 158 159 /* Capabilities that interfaces can advertise. */ 160 #define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ 161 #define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ 162 #define IFCAP_NETCONS 0x0004 /* can be a network console */ 163 164 #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) 165 166 #define IFQ_MAXLEN 50 167 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 168 169 /* 170 * Message format for use in obtaining information about interfaces 171 * from getkerninfo and the routing socket 172 */ 173 struct if_msghdr { 174 u_short ifm_msglen; /* to skip over non-understood messages */ 175 u_char ifm_version; /* future binary compatibility */ 176 u_char ifm_type; /* message type */ 177 int ifm_addrs; /* like rtm_addrs */ 178 int ifm_flags; /* value of if_flags */ 179 u_short ifm_index; /* index for associated ifp */ 180 struct if_data ifm_data;/* statistics and other data about if */ 181 }; 182 183 /* 184 * Message format for use in obtaining information about interface addresses 185 * from getkerninfo and the routing socket 186 */ 187 struct ifa_msghdr { 188 u_short ifam_msglen; /* to skip over non-understood messages */ 189 u_char ifam_version; /* future binary compatibility */ 190 u_char ifam_type; /* message type */ 191 int ifam_addrs; /* like rtm_addrs */ 192 int ifam_flags; /* value of ifa_flags */ 193 u_short ifam_index; /* index for associated ifp */ 194 int ifam_metric; /* value of ifa_metric */ 195 }; 196 197 /* 198 * Message format for use in obtaining information about multicast addresses 199 * from the routing socket 200 */ 201 struct ifma_msghdr { 202 u_short ifmam_msglen; /* to skip over non-understood messages */ 203 u_char ifmam_version; /* future binary compatibility */ 204 u_char ifmam_type; /* message type */ 205 int ifmam_addrs; /* like rtm_addrs */ 206 int ifmam_flags; /* value of ifa_flags */ 207 u_short ifmam_index; /* index for associated ifp */ 208 }; 209 210 /* 211 * Message format announcing the arrival or departure of a network interface. 212 */ 213 struct if_announcemsghdr { 214 u_short ifan_msglen; /* to skip over non-understood messages */ 215 u_char ifan_version; /* future binary compatibility */ 216 u_char ifan_type; /* message type */ 217 u_short ifan_index; /* index for associated ifp */ 218 char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 219 u_short ifan_what; /* what type of announcement */ 220 }; 221 222 #define IFAN_ARRIVAL 0 /* interface arrival */ 223 #define IFAN_DEPARTURE 1 /* interface departure */ 224 225 /* 226 * Interface request structure used for socket 227 * ioctl's. All interface ioctl's must have parameter 228 * definitions which begin with ifr_name. The 229 * remainder may be interface specific. 230 */ 231 struct ifreq { 232 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 233 union { 234 struct sockaddr ifru_addr; 235 struct sockaddr ifru_dstaddr; 236 struct sockaddr ifru_broadaddr; 237 short ifru_flags[2]; 238 int ifru_metric; 239 int ifru_mtu; 240 int ifru_phys; 241 int ifru_media; 242 caddr_t ifru_data; 243 int ifru_cap[2]; 244 } ifr_ifru; 245 #define ifr_addr ifr_ifru.ifru_addr /* address */ 246 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 247 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 248 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags (low 16 bits) */ 249 #define ifr_flagshigh ifr_ifru.ifru_flags[1] /* flags (high 16 bits) */ 250 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 251 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 252 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 253 #define ifr_media ifr_ifru.ifru_media /* physical media */ 254 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 255 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 256 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 257 }; 258 259 #define _SIZEOF_ADDR_IFREQ(ifr) \ 260 ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ 261 (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ 262 (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) 263 264 struct ifaliasreq { 265 char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 266 struct sockaddr ifra_addr; 267 struct sockaddr ifra_broadaddr; 268 struct sockaddr ifra_mask; 269 }; 270 271 struct ifmediareq { 272 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 273 int ifm_current; /* current media options */ 274 int ifm_mask; /* don't care mask */ 275 int ifm_status; /* media status */ 276 int ifm_active; /* active options */ 277 int ifm_count; /* # entries in ifm_ulist array */ 278 int *ifm_ulist; /* media words */ 279 }; 280 281 /* 282 * Structure used to retrieve aux status data from interfaces. 283 * Kernel suppliers to this interface should respect the formatting 284 * needed by ifconfig(8): each line starts with a TAB and ends with 285 * a newline. The canonical example to copy and paste is in if_tun.c. 286 */ 287 288 #define IFSTATMAX 800 /* 10 lines of text */ 289 struct ifstat { 290 char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 291 char ascii[IFSTATMAX + 1]; 292 }; 293 294 /* 295 * Structure used in SIOCGIFCONF request. 296 * Used to retrieve interface configuration 297 * for machine (useful for programs which 298 * must know all networks accessible). 299 */ 300 struct ifconf { 301 int ifc_len; /* size of associated buffer */ 302 union { 303 caddr_t ifcu_buf; 304 struct ifreq *ifcu_req; 305 } ifc_ifcu; 306 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 307 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 308 }; 309 310 311 /* 312 * Structure for SIOC[AGD]LIFADDR 313 */ 314 struct if_laddrreq { 315 char iflr_name[IFNAMSIZ]; 316 u_int flags; 317 #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ 318 u_int prefixlen; /* in/out */ 319 struct sockaddr_storage addr; /* in/out */ 320 struct sockaddr_storage dstaddr; /* out */ 321 }; 322 323 #ifdef _KERNEL 324 #ifdef MALLOC_DECLARE 325 MALLOC_DECLARE(M_IFADDR); 326 MALLOC_DECLARE(M_IFMADDR); 327 #endif 328 #endif 329 330 #ifndef _KERNEL 331 struct if_nameindex { 332 u_int if_index; /* 1, 2, ... */ 333 const char *if_name; /* null terminated name: "le0", ... */ 334 }; 335 336 __BEGIN_DECLS 337 u_int if_nametoindex (const char *); 338 char *if_indextoname(u_int, char *); 339 struct if_nameindex *if_nameindex (void); 340 void if_freenameindex (struct if_nameindex *); 341 __END_DECLS 342 #endif 343 344 #ifdef _KERNEL 345 struct thread; 346 347 int prison_if (struct thread *td, struct sockaddr *sa); 348 349 /* XXX - this should go away soon. */ 350 #include <net/if_var.h> 351 #endif 352 353 #endif /* !_NET_IF_H_ */ 354