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