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