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