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