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