| 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.21 2008/08/30 16:07:59 hasso Exp $ |
| 36 | */ |
| 37 | |
| 38 | #ifndef _NET_IF_H_ |
| 39 | #define _NET_IF_H_ |
| 40 | |
| 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 | |
| 51 | #ifdef _KERNEL |
| 52 | |
| 53 | #ifndef _SYS_QUEUE_H_ |
| 54 | #include <sys/queue.h> |
| 55 | #endif |
| 56 | |
| 57 | #endif |
| 58 | |
| 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 */ |
| 65 | #define LINK_STATE_IS_UP(_s) ((_s) >= LINK_STATE_UP) |
| 66 | |
| 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 |
| 75 | #define IF_MAXUNIT 0x7fff /* if_unit is 15bits */ |
| 76 | |
| 77 | /* |
| 78 | * Structure used to query names of interface cloners. |
| 79 | * XXX should be moved to net/if_clone.h |
| 80 | */ |
| 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) */ |
| 101 | u_long ifi_link_state; /* current link state */ |
| 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 */ |
| 137 | #define IFF_POLLING 0x10000 /* Interface is in polling mode. */ |
| 138 | #define IFF_PPROMISC 0x20000 /* user-requested promisc mode */ |
| 139 | #define IFF_MONITOR 0x40000 /* user-requested monitor mode */ |
| 140 | |
| 141 | /* flags set internally only: */ |
| 142 | #define IFF_CANTCHANGE \ |
| 143 | (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ |
| 144 | IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_SMART|IFF_POLLING) |
| 145 | |
| 146 | /* |
| 147 | * Some convenience macros used for setting ifi_baudrate. |
| 148 | * XXX 1000 vs. 1024? --thorpej@netbsd.org |
| 149 | */ |
| 150 | #define IF_Kbps(x) ((x) * 1000) /* kilobits/sec. */ |
| 151 | #define IF_Mbps(x) (IF_Kbps((x) * 1000)) /* megabits/sec. */ |
| 152 | #define IF_Gbps(x) (IF_Mbps((x) * 1000)) /* gigabits/sec. */ |
| 153 | |
| 154 | /* Capabilities that interfaces can advertise. */ |
| 155 | #define IFCAP_RXCSUM 0x0001 /* can offload checksum on RX */ |
| 156 | #define IFCAP_TXCSUM 0x0002 /* can offload checksum on TX */ |
| 157 | #define IFCAP_NETCONS 0x0004 /* can be a network console */ |
| 158 | #define IFCAP_VLAN_MTU 0x0008 /* VLAN-compatible MTU */ |
| 159 | #define IFCAP_VLAN_HWTAGGING 0x0010 /* hardware VLAN tag support */ |
| 160 | #define IFCAP_JUMBO_MTU 0x0020 /* 9000 byte MTU support */ |
| 161 | #define IFCAP_RSS 0x0040 /* Receive Side Scaling for IPv4 */ |
| 162 | |
| 163 | #define IFCAP_HWCSUM (IFCAP_RXCSUM | IFCAP_TXCSUM) |
| 164 | |
| 165 | #define IFQ_MAXLEN 50 |
| 166 | #define IFNET_SLOWHZ 1 /* granularity is 1 second */ |
| 167 | |
| 168 | /* |
| 169 | * Message format for use in obtaining information about interfaces |
| 170 | * from getkerninfo and the routing socket |
| 171 | */ |
| 172 | struct if_msghdr { |
| 173 | u_short ifm_msglen; /* to skip over non-understood messages */ |
| 174 | u_char ifm_version; /* future binary compatibility */ |
| 175 | u_char ifm_type; /* message type */ |
| 176 | int ifm_addrs; /* like rtm_addrs */ |
| 177 | int ifm_flags; /* value of if_flags */ |
| 178 | u_short ifm_index; /* index for associated ifp */ |
| 179 | struct if_data ifm_data;/* statistics and other data about if */ |
| 180 | }; |
| 181 | |
| 182 | /* |
| 183 | * Message format for use in obtaining information about interface addresses |
| 184 | * from getkerninfo and the routing socket |
| 185 | */ |
| 186 | struct ifa_msghdr { |
| 187 | u_short ifam_msglen; /* to skip over non-understood messages */ |
| 188 | u_char ifam_version; /* future binary compatibility */ |
| 189 | u_char ifam_type; /* message type */ |
| 190 | int ifam_addrs; /* like rtm_addrs */ |
| 191 | int ifam_flags; /* value of ifa_flags */ |
| 192 | u_short ifam_index; /* index for associated ifp */ |
| 193 | int ifam_metric; /* value of ifa_metric */ |
| 194 | }; |
| 195 | |
| 196 | /* |
| 197 | * Message format for use in obtaining information about multicast addresses |
| 198 | * from the routing socket |
| 199 | */ |
| 200 | struct ifma_msghdr { |
| 201 | u_short ifmam_msglen; /* to skip over non-understood messages */ |
| 202 | u_char ifmam_version; /* future binary compatibility */ |
| 203 | u_char ifmam_type; /* message type */ |
| 204 | int ifmam_addrs; /* like rtm_addrs */ |
| 205 | int ifmam_flags; /* value of ifa_flags */ |
| 206 | u_short ifmam_index; /* index for associated ifp */ |
| 207 | }; |
| 208 | |
| 209 | /* |
| 210 | * Message format announcing the arrival or departure of a network interface. |
| 211 | */ |
| 212 | struct if_announcemsghdr { |
| 213 | u_short ifan_msglen; /* to skip over non-understood messages */ |
| 214 | u_char ifan_version; /* future binary compatibility */ |
| 215 | u_char ifan_type; /* message type */ |
| 216 | u_short ifan_index; /* index for associated ifp */ |
| 217 | char ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
| 218 | u_short ifan_what; /* what type of announcement */ |
| 219 | }; |
| 220 | |
| 221 | #define IFAN_ARRIVAL 0 /* interface arrival */ |
| 222 | #define IFAN_DEPARTURE 1 /* interface departure */ |
| 223 | |
| 224 | /* |
| 225 | * Interface request structure used for socket |
| 226 | * ioctl's. All interface ioctl's must have parameter |
| 227 | * definitions which begin with ifr_name. The |
| 228 | * remainder may be interface specific. |
| 229 | */ |
| 230 | struct ifreq { |
| 231 | char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
| 232 | union { |
| 233 | struct sockaddr ifru_addr; |
| 234 | struct sockaddr ifru_dstaddr; |
| 235 | struct sockaddr ifru_broadaddr; |
| 236 | short ifru_flags[2]; |
| 237 | int ifru_metric; |
| 238 | int ifru_mtu; |
| 239 | int ifru_phys; |
| 240 | int ifru_media; |
| 241 | void *ifru_data; |
| 242 | int ifru_cap[2]; |
| 243 | int ifru_pollcpu; |
| 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 | #define ifr_pollcpu ifr_ifru.ifru_pollcpu /* polling(4) cpu */ |
| 258 | }; |
| 259 | |
| 260 | #define _SIZEOF_ADDR_IFREQ(ifr) \ |
| 261 | ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \ |
| 262 | (sizeof(struct ifreq) - sizeof(struct sockaddr) + \ |
| 263 | (ifr).ifr_addr.sa_len) : sizeof(struct ifreq)) |
| 264 | |
| 265 | struct ifaliasreq { |
| 266 | char ifra_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
| 267 | struct sockaddr ifra_addr; |
| 268 | struct sockaddr ifra_broadaddr; |
| 269 | struct sockaddr ifra_mask; |
| 270 | }; |
| 271 | |
| 272 | struct ifmediareq { |
| 273 | char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
| 274 | int ifm_current; /* current media options */ |
| 275 | int ifm_mask; /* don't care mask */ |
| 276 | int ifm_status; /* media status */ |
| 277 | int ifm_active; /* active options */ |
| 278 | int ifm_count; /* # entries in ifm_ulist array */ |
| 279 | int *ifm_ulist; /* media words */ |
| 280 | }; |
| 281 | |
| 282 | struct ifdrv { |
| 283 | char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
| 284 | unsigned long ifd_cmd; |
| 285 | size_t ifd_len; |
| 286 | void *ifd_data; |
| 287 | }; |
| 288 | |
| 289 | /* |
| 290 | * Structure used to retrieve aux status data from interfaces. |
| 291 | * Kernel suppliers to this interface should respect the formatting |
| 292 | * needed by ifconfig(8): each line starts with a TAB and ends with |
| 293 | * a newline. The canonical example to copy and paste is in if_tun.c. |
| 294 | */ |
| 295 | |
| 296 | #define IFSTATMAX 800 /* 10 lines of text */ |
| 297 | struct ifstat { |
| 298 | char ifs_name[IFNAMSIZ]; /* if name, e.g. "en0" */ |
| 299 | char ascii[IFSTATMAX + 1]; |
| 300 | }; |
| 301 | |
| 302 | /* |
| 303 | * Structure used in SIOCGIFCONF request. |
| 304 | * Used to retrieve interface configuration |
| 305 | * for machine (useful for programs which |
| 306 | * must know all networks accessible). |
| 307 | */ |
| 308 | struct ifconf { |
| 309 | int ifc_len; /* size of associated buffer */ |
| 310 | union { |
| 311 | caddr_t ifcu_buf; |
| 312 | struct ifreq *ifcu_req; |
| 313 | } ifc_ifcu; |
| 314 | #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ |
| 315 | #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ |
| 316 | }; |
| 317 | |
| 318 | |
| 319 | /* |
| 320 | * Structure for SIOC[AGD]LIFADDR |
| 321 | */ |
| 322 | struct if_laddrreq { |
| 323 | char iflr_name[IFNAMSIZ]; |
| 324 | u_int flags; |
| 325 | #define IFLR_PREFIX 0x8000 /* in: prefix given out: kernel fills id */ |
| 326 | u_int prefixlen; /* in/out */ |
| 327 | struct sockaddr_storage addr; /* in/out */ |
| 328 | struct sockaddr_storage dstaddr; /* out */ |
| 329 | }; |
| 330 | |
| 331 | #ifndef _KERNEL |
| 332 | struct if_nameindex { |
| 333 | u_int if_index; /* 1, 2, ... */ |
| 334 | const char *if_name; /* null terminated name: "le0", ... */ |
| 335 | }; |
| 336 | |
| 337 | __BEGIN_DECLS |
| 338 | u_int if_nametoindex (const char *); |
| 339 | char *if_indextoname(u_int, char *); |
| 340 | struct if_nameindex *if_nameindex (void); |
| 341 | void if_freenameindex (struct if_nameindex *); |
| 342 | __END_DECLS |
| 343 | #endif |
| 344 | |
| 345 | #ifdef _KERNEL |
| 346 | struct thread; |
| 347 | struct ucred; |
| 348 | |
| 349 | int prison_if (struct ucred *cred, struct sockaddr *sa); |
| 350 | |
| 351 | /* XXX - this should go away soon. */ |
| 352 | #include <net/if_var.h> |
| 353 | #endif |
| 354 | |
| 355 | #endif /* !_NET_IF_H_ */ |