1 /* 2 * Copyright (c) 1982, 1986, 1989 Regents of the University of California. 3 * All rights reserved. 4 * 5 * %sccs.include.redist.c% 6 * 7 * @(#)if.h 7.20 (Berkeley) 10/11/92 8 */ 9 10 /* 11 * Structures defining a network interface, providing a packet 12 * transport mechanism (ala level 0 of the PUP protocols). 13 * 14 * Each interface accepts output datagrams of a specified maximum 15 * length, and provides higher level routines with input datagrams 16 * received from its medium. 17 * 18 * Output occurs when the routine if_output is called, with three parameters: 19 * (*ifp->if_output)(ifp, m, dst, rt) 20 * Here m is the mbuf chain to be sent and dst is the destination address. 21 * The output routine encapsulates the supplied datagram if necessary, 22 * and then transmits it on its medium. 23 * 24 * On input, each interface unwraps the data received by it, and either 25 * places it on the input queue of a internetwork datagram routine 26 * and posts the associated software interrupt, or passes the datagram to a raw 27 * packet input routine. 28 * 29 * Routines exist for locating interfaces by their addresses 30 * or for locating a interface on a certain network, as well as more general 31 * routing and gateway routines maintaining information used to locate 32 * interfaces. These routines live in the files if.c and route.c 33 */ 34 #ifndef _TIME_ /* XXX fast fix for SNMP, going away soon */ 35 #include <sys/time.h> 36 #endif 37 38 #ifdef __STDC__ 39 /* 40 * Forward structure declarations for function prototypes [sic]. 41 */ 42 struct rtentry; 43 struct mbuf; 44 #endif 45 /* 46 * Structure describing information about an interface 47 * which may be of interest to management entities. 48 */ 49 /* 50 * Structure defining a queue for a network interface. 51 * 52 * (Would like to call this struct ``if'', but C isn't PL/1.) 53 */ 54 55 struct ifnet { 56 char *if_name; /* name, e.g. ``en'' or ``lo'' */ 57 struct ifnet *if_next; /* all struct ifnets are chained */ 58 struct ifaddr *if_addrlist; /* linked list of addresses per if */ 59 int if_pcount; /* number of promiscuous listeners */ 60 caddr_t if_bpf; /* packet filter structure */ 61 u_short if_index; /* numeric abbreviation for this if */ 62 short if_unit; /* sub-unit for lower level driver */ 63 short if_timer; /* time 'til if_watchdog called */ 64 short if_flags; /* up/down, broadcast, etc. */ 65 struct if_data { 66 /* generic interface information */ 67 u_char ifi_type; /* ethernet, tokenring, etc */ 68 u_char ifi_addrlen; /* media address length */ 69 u_char ifi_hdrlen; /* media header length */ 70 u_long ifi_mtu; /* maximum transmission unit */ 71 u_long ifi_metric; /* routing metric (external only) */ 72 u_long ifi_baudrate; /* linespeed */ 73 /* volatile statistics */ 74 u_long ifi_ipackets; /* packets received on interface */ 75 u_long ifi_ierrors; /* input errors on interface */ 76 u_long ifi_opackets; /* packets sent on interface */ 77 u_long ifi_oerrors; /* output errors on interface */ 78 u_long ifi_collisions; /* collisions on csma interfaces */ 79 u_long ifi_ibytes; /* total number of octets received */ 80 u_long ifi_obytes; /* total number of octets sent */ 81 u_long ifi_imcasts; /* packets received via multicast */ 82 u_long ifi_omcasts; /* packets sent via multicast */ 83 u_long ifi_iqdrops; /* dropped on input, this interface */ 84 u_long ifi_noproto; /* destined for unsupported protocol */ 85 struct timeval ifi_lastchange;/* last updated */ 86 } if_data; 87 /* procedure handles */ 88 int (*if_init) /* init routine */ 89 __P((int)); 90 int (*if_output) /* output routine (enqueue) */ 91 __P((struct ifnet *, struct mbuf *, struct sockaddr *, 92 struct rtentry *)); 93 int (*if_start) /* initiate output routine */ 94 __P((struct ifnet *)); 95 int (*if_done) /* output complete routine */ 96 __P((struct ifnet *)); /* (XXX not used; fake prototype) */ 97 int (*if_ioctl) /* ioctl routine */ 98 __P((struct ifnet *, int, caddr_t)); 99 int (*if_reset) 100 __P((int)); /* new autoconfig will permit removal */ 101 int (*if_watchdog) /* timer routine */ 102 __P((int)); 103 struct ifqueue { 104 struct mbuf *ifq_head; 105 struct mbuf *ifq_tail; 106 int ifq_len; 107 int ifq_maxlen; 108 int ifq_drops; 109 } if_snd; /* output queue */ 110 }; 111 #define if_mtu if_data.ifi_mtu 112 #define if_type if_data.ifi_type 113 #define if_addrlen if_data.ifi_addrlen 114 #define if_hdrlen if_data.ifi_hdrlen 115 #define if_metric if_data.ifi_metric 116 #define if_baudrate if_data.ifi_baudrate 117 #define if_ipackets if_data.ifi_ipackets 118 #define if_ierrors if_data.ifi_ierrors 119 #define if_opackets if_data.ifi_opackets 120 #define if_oerrors if_data.ifi_oerrors 121 #define if_collisions if_data.ifi_collisions 122 #define if_ibytes if_data.ifi_ibytes 123 #define if_obytes if_data.ifi_obytes 124 #define if_imcasts if_data.ifi_imcasts 125 #define if_omcasts if_data.ifi_omcasts 126 #define if_iqdrops if_data.ifi_iqdrops 127 #define if_noproto if_data.ifi_noproto 128 #define if_lastchange if_data.ifi_lastchange 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_NOTRAILERS 0x20 /* avoid use of trailers */ 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_MULTICAST 0x8000 /* supports multicast */ 146 147 /* flags set internally only: */ 148 #define IFF_CANTCHANGE \ 149 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 150 IFF_SIMPLEX|IFF_MULTICAST) 151 152 /* 153 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 154 * input routines have queues of messages stored on ifqueue structures 155 * (defined above). Entries are added to and deleted from these structures 156 * by these macros, which should be called with ipl raised to splimp(). 157 */ 158 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 159 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 160 #define IF_ENQUEUE(ifq, m) { \ 161 (m)->m_nextpkt = 0; \ 162 if ((ifq)->ifq_tail == 0) \ 163 (ifq)->ifq_head = m; \ 164 else \ 165 (ifq)->ifq_tail->m_nextpkt = m; \ 166 (ifq)->ifq_tail = m; \ 167 (ifq)->ifq_len++; \ 168 } 169 #define IF_PREPEND(ifq, m) { \ 170 (m)->m_nextpkt = (ifq)->ifq_head; \ 171 if ((ifq)->ifq_tail == 0) \ 172 (ifq)->ifq_tail = (m); \ 173 (ifq)->ifq_head = (m); \ 174 (ifq)->ifq_len++; \ 175 } 176 #define IF_DEQUEUE(ifq, m) { \ 177 (m) = (ifq)->ifq_head; \ 178 if (m) { \ 179 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \ 180 (ifq)->ifq_tail = 0; \ 181 (m)->m_nextpkt = 0; \ 182 (ifq)->ifq_len--; \ 183 } \ 184 } 185 186 #define IFQ_MAXLEN 50 187 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 188 189 /* 190 * The ifaddr structure contains information about one address 191 * of an interface. They are maintained by the different address families, 192 * are allocated and attached when an address is set, and are linked 193 * together so all addresses for an interface can be located. 194 */ 195 struct ifaddr { 196 struct sockaddr *ifa_addr; /* address of interface */ 197 struct sockaddr *ifa_dstaddr; /* other end of p-to-p link */ 198 #define ifa_broadaddr ifa_dstaddr /* broadcast address interface */ 199 struct sockaddr *ifa_netmask; /* used to determine subnet */ 200 struct ifnet *ifa_ifp; /* back-pointer to interface */ 201 struct ifaddr *ifa_next; /* next address for interface */ 202 void (*ifa_rtrequest)(); /* check or clean routes (+ or -)'d */ 203 u_short ifa_flags; /* mostly rt_flags for cloning */ 204 short ifa_refcnt; /* extra to malloc for link info */ 205 int ifa_metric; /* cost of going out this interface */ 206 #ifdef notdef 207 struct rtentry *ifa_rt; /* XXXX for ROUTETOIF ????? */ 208 #endif 209 }; 210 #define IFA_ROUTE RTF_UP /* route installed */ 211 212 /* 213 * Message format for use in obtaining information about interfaces 214 * from getkerninfo and the routing socket 215 */ 216 struct if_msghdr { 217 u_short ifm_msglen; /* to skip over non-understood messages */ 218 u_char ifm_version; /* future binary compatability */ 219 u_char ifm_type; /* message type */ 220 int ifm_addrs; /* like rtm_addrs */ 221 int ifm_flags; /* value of if_flags */ 222 u_short ifm_index; /* index for associated ifp */ 223 struct if_data ifm_data;/* statistics and other data about if */ 224 }; 225 226 /* 227 * Message format for use in obtaining information about interface addresses 228 * from getkerninfo and the routing socket 229 */ 230 struct ifa_msghdr { 231 u_short ifam_msglen; /* to skip over non-understood messages */ 232 u_char ifam_version; /* future binary compatability */ 233 u_char ifam_type; /* message type */ 234 int ifam_addrs; /* like rtm_addrs */ 235 int ifam_flags; /* value of ifa_flags */ 236 u_short ifam_index; /* index for associated ifp */ 237 int ifam_metric; /* value of ifa_metric */ 238 }; 239 240 /* 241 * Interface request structure used for socket 242 * ioctl's. All interface ioctl's must have parameter 243 * definitions which begin with ifr_name. The 244 * remainder may be interface specific. 245 */ 246 struct ifreq { 247 #define IFNAMSIZ 16 248 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 249 union { 250 struct sockaddr ifru_addr; 251 struct sockaddr ifru_dstaddr; 252 struct sockaddr ifru_broadaddr; 253 short ifru_flags; 254 int ifru_metric; 255 caddr_t ifru_data; 256 } ifr_ifru; 257 #define ifr_addr ifr_ifru.ifru_addr /* address */ 258 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 259 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 260 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 261 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 262 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 263 }; 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 /* 273 * Structure used in SIOCGIFCONF request. 274 * Used to retrieve interface configuration 275 * for machine (useful for programs which 276 * must know all networks accessible). 277 */ 278 struct ifconf { 279 int ifc_len; /* size of associated buffer */ 280 union { 281 caddr_t ifcu_buf; 282 struct ifreq *ifcu_req; 283 } ifc_ifcu; 284 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 285 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 286 }; 287 288 #include <net/if_arp.h> 289 290 #ifdef KERNEL 291 #define IFAFREE(ifa) \ 292 if ((ifa)->ifa_refcnt <= 0) \ 293 ifafree(ifa); \ 294 else \ 295 (ifa)->ifa_refcnt--; 296 297 struct ifnet *ifnet; 298 struct ifaddr *ifa_ifwithaddr __P((struct sockaddr *)), 299 *ifa_ifwithnet __P((struct sockaddr *)), 300 *ifa_ifwithdstaddr __P((struct sockaddr *)); 301 void ifafree __P((struct ifaddr *)); 302 void if_attach __P((struct ifnet *)); 303 #endif 304