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