workbench/network/common/include/net/if.h

   1 #ifndef _NET_IF_H_
   2 #define _NET_IF_H_
   3 /*
   4  * Copyright (c) 1982, 1986, 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * Copyright (c) 2005 - 2006
   7  *      Pavel Fedin
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed by the University of
  20  *      California, Berkeley and its contributors.
  21  * 4. Neither the name of the University nor the names of its contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  *      @(#)if.h        8.3 (Berkeley) 2/9/95
  38  */
  39
  40 /*
  41  * Structures defining a network interface, providing a packet
  42  * transport mechanism (ala level 0 of the PUP protocols).
  43  *
  44  * Each interface accepts output datagrams of a specified maximum
  45  * length, and provides higher level routines with input datagrams
  46  * received from its medium.
  47  *
  48  * Output occurs when the routine if_output is called, with three parameters:
  49  *      (*ifp->if_output)(ifp, m, dst, rt)
  50  * Here m is the mbuf chain to be sent and dst is the destination address.
  51  * The output routine encapsulates the supplied datagram if necessary,
  52  * and then transmits it on its medium.
  53  *
  54  * On input, each interface unwraps the data received by it, and either
  55  * places it on the input queue of a internetwork datagram routine
  56  * and posts the associated software interrupt, or passes the datagram to a raw
  57  * packet input routine.
  58  *
  59  * Routines exist for locating interfaces by their addresses
  60  * or for locating a interface on a certain network, as well as more general
  61  * routing and gateway routines maintaining information used to locate
  62  * interfaces.  These routines live in the files if.c and route.c
  63  */
  64 #include <utility/tagitem.h>
  65 #ifndef _TIME_ /*  XXX fast fix for SNMP, going away soon */
  66 #include <sys/time.h>
  67 #endif
  68 #include <sys/cdefs.h>
  69
  70 #ifndef KERNEL
  71 #ifdef __STDC__
  72 /*
  73  * Forward structure declarations for function prototypes [sic].
  74  */
  75 struct  mbuf;
  76 struct  proc;
  77 struct  rtentry;
  78 struct  socket;
  79 struct  ether_header;
  80 #endif
  81 #endif
  82
  83 #define IFNAMSIZ        16
  84
  85 /*
  86  * Structure describing information about an interface
  87  * which may be of interest to management entities.
  88  */
  89 /*
  90  * Structure defining a queue for a network interface.
  91  *
  92  * (Would like to call this struct ``if'', but C isn't PL/1.)
  93  */
  94
  95 struct if_data {
  96 /* generic interface information */
  97         u_char  ifi_type;       /* ethernet, tokenring, etc */
  98         u_char  ifi_addrlen;    /* media address length */
  99         u_char  ifi_hdrlen;     /* media header length */
 100         u_long  ifi_mtu;        /* maximum transmission unit */
 101         u_long  ifi_metric;     /* routing metric (external only) */
 102         u_long  ifi_baudrate;   /* linespeed */
 103 /* volatile statistics */
 104         u_long  ifi_ipackets;   /* packets received on interface */
 105         u_long  ifi_ierrors;    /* input errors on interface */
 106         u_long  ifi_opackets;   /* packets sent on interface */
 107         u_long  ifi_oerrors;    /* output errors on interface */
 108         u_long  ifi_collisions; /* collisions on csma interfaces */
 109         u_long  ifi_ibytes;     /* total number of octets received */
 110         u_long  ifi_obytes;     /* total number of octets sent */
 111         u_long  ifi_imcasts;    /* packets received via multicast */
 112         u_long  ifi_omcasts;    /* packets sent via multicast */
 113         u_long  ifi_iqdrops;    /* dropped on input, this interface */
 114         u_long  ifi_noproto;    /* destined for unsupported protocol */
 115         struct  timeval ifi_lastchange;/* last updated */
 116 /* AROSTCP/MOSNet specific additions */
 117    struct   timeval ifi_aros_ontime;
 118    u_quad_t ifi_aros_lasttotal;
 119    u_char   ifi_aros_usedhcp;
 120    pid_t    ifi_aros_dhcp_pid;
 121    char     ifi_aros_dhcp_args[IFNAMSIZ + 5];
 122 };
 123
 124 struct ifnet {
 125         char    *if_name;               /* name, e.g. ``en'' or ``lo'' */
 126         struct  ifnet *if_next;         /* all struct ifnets are chained */
 127         struct  ifaddr *if_addrlist;    /* linked list of addresses per if */
 128                 int     if_pcount;              /* number of promiscuous listeners */
 129         caddr_t if_bpf;                 /* packet filter structure */
 130         u_short if_index;               /* numeric abbreviation for this if  */
 131         short   if_unit;                /* sub-unit for lower level driver */
 132         short   if_timer;               /* time 'til if_watchdog called */
 133         short   if_flags;               /* up/down, broadcast, etc. */
 134         struct  if_data if_data;
 135 /* procedure handles */
 136         int     (*if_init)              /* init routine */
 137                 __P((int));
 138         int     (*if_output)            /* output routine (enqueue) */
 139                 __P((struct ifnet *, struct mbuf *, struct sockaddr *,
 140                      struct rtentry *));
 141         int     (*if_start)             /* initiate output routine */
 142                 __P((struct ifnet *));
 143         int     (*if_done)              /* output complete routine */
 144                 __P((struct ifnet *));  /* (XXX not used; fake prototype) */
 145         int     (*if_ioctl)             /* ioctl routine */
 146                 __P((struct ifnet *, int, caddr_t));
 147         int     (*if_reset)
 148                 __P((int));             /* new autoconfig will permit removal */
 149         int     (*if_watchdog)          /* timer routine */
 150                 __P((int));
 151         int     (*if_query)
 152                 __P((struct ifnet *, struct TagItem *));
 153         struct  ifqueue {
 154                 struct  mbuf *ifq_head;
 155                 struct  mbuf *ifq_tail;
 156                 int     ifq_len;
 157                 int     ifq_maxlen;
 158                 int     ifq_drops;
 159         } if_snd;                       /* output queue */
 160 };
 161 #define if_mtu          if_data.ifi_mtu
 162 #define if_type         if_data.ifi_type
 163 #define if_addrlen      if_data.ifi_addrlen
 164 #define if_hdrlen       if_data.ifi_hdrlen
 165 #define if_metric       if_data.ifi_metric
 166 #define if_baudrate     if_data.ifi_baudrate
 167 #define if_ipackets     if_data.ifi_ipackets
 168 #define if_ierrors      if_data.ifi_ierrors
 169 #define if_opackets     if_data.ifi_opackets
 170 #define if_oerrors      if_data.ifi_oerrors
 171 #define if_collisions   if_data.ifi_collisions
 172 #define if_ibytes       if_data.ifi_ibytes
 173 #define if_obytes       if_data.ifi_obytes
 174 #define if_imcasts      if_data.ifi_imcasts
 175 #define if_omcasts      if_data.ifi_omcasts
 176 #define if_iqdrops      if_data.ifi_iqdrops
 177 #define if_noproto      if_data.ifi_noproto
 178 #define if_lastchange   if_data.ifi_lastchange
 179
 180 #define IFF_UP          0x1             /* interface is up */
 181 #define IFF_BROADCAST   0x2             /* broadcast address valid */
 182 #define IFF_DEBUG       0x4             /* turn on debugging */
 183 #define IFF_LOOPBACK    0x8             /* is a loopback net */
 184 #define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
 185 #define IFF_NOTRAILERS  0x20            /* avoid use of trailers */
 186 #define IFF_RUNNING     0x40            /* resources allocated */
 187 #define IFF_NOARP       0x80            /* no address resolution protocol */
 188 #define IFF_PROMISC     0x100           /* receive all packets */
 189 #define IFF_ALLMULTI    0x200           /* receive all multicast packets */
 190 #define IFF_OACTIVE     0x400           /* transmission in progress */
 191 #define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
 192 #define IFF_LINK0       0x1000          /* per link layer defined bit */
 193 #define IFF_LINK1       0x2000          /* per link layer defined bit */
 194 #define IFF_LINK2       0x4000          /* per link layer defined bit */
 195 #define IFF_MULTICAST   0x8000          /* supports multicast */
 196
 197 /* flags set internally only: */
 198 #define IFF_CANTCHANGE \
 199         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
 200             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
 201
 202 /*
 203  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
 204  * input routines have queues of messages stored on ifqueue structures
 205  * (defined above).  Entries are added to and deleted from these structures
 206  * by these macros, which should be called with ipl raised to splimp().
 207  */
 208 #define IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
 209 #define IF_DROP(ifq)            ((ifq)->ifq_drops++)
 210 #define IF_ENQUEUE(ifq, m) { \
 211         (m)->m_nextpkt = 0; \
 212         if ((ifq)->ifq_tail == 0) \
 213                 (ifq)->ifq_head = m; \
 214         else \
 215                 (ifq)->ifq_tail->m_nextpkt = m; \
 216         (ifq)->ifq_tail = m; \
 217         (ifq)->ifq_len++; \
 218 }
 219 #define IF_PREPEND(ifq, m) { \
 220         (m)->m_nextpkt = (ifq)->ifq_head; \
 221         if ((ifq)->ifq_tail == 0) \
 222                 (ifq)->ifq_tail = (m); \
 223         (ifq)->ifq_head = (m); \
 224         (ifq)->ifq_len++; \
 225 }
 226 #define IF_DEQUEUE(ifq, m) { \
 227         (m) = (ifq)->ifq_head; \
 228         if (m) { \
 229                 if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
 230                         (ifq)->ifq_tail = 0; \
 231                 (m)->m_nextpkt = 0; \
 232                 (ifq)->ifq_len--; \
 233         } \
 234 }
 235
 236 #define IFQ_MAXLEN      50
 237 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
 238
 239 /*
 240  * The ifaddr structure contains information about one address
 241  * of an interface.  They are maintained by the different address families,
 242  * are allocated and attached when an address is set, and are linked
 243  * together so all addresses for an interface can be located.
 244  */
 245 struct ifaddr {
 246         struct  sockaddr *ifa_addr;     /* address of interface */
 247         struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
 248 #define ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
 249         struct  sockaddr *ifa_netmask;  /* used to determine subnet */
 250         struct  ifnet *ifa_ifp;         /* back-pointer to interface */
 251         struct  ifaddr *ifa_next;       /* next address for interface */
 252         void    (*ifa_rtrequest)(int,   /* check or clean routes (+ or -)'d */
 253                                  struct rtentry *, struct sockaddr *);
 254         struct  rtentry *ifa_rt;        /* XXXX for ROUTETOIF ????? */
 255         u_short ifa_flags;              /* mostly rt_flags for cloning */
 256         short   ifa_refcnt;             /* extra to malloc for link info */
 257         int     ifa_metric;             /* cost of going out this interface */
 258 };
 259 #define IFA_ROUTE       RTF_UP          /* route installed */
 260
 261 /*
 262  * Message format for use in obtaining information about interfaces
 263  * from getkerninfo and the routing socket
 264  */
 265 struct if_msghdr {
 266         u_short ifm_msglen;     /* to skip over non-understood messages */
 267         u_char  ifm_version;    /* future binary compatability */
 268         u_char  ifm_type;       /* message type */
 269         int     ifm_addrs;      /* like rtm_addrs */
 270         int     ifm_flags;      /* value of if_flags */
 271         u_short ifm_index;      /* index for associated ifp */
 272         struct  if_data ifm_data;/* statistics and other data about if */
 273 };
 274
 275 /*
 276  * Message format for use in obtaining information about interface addresses
 277  * from getkerninfo and the routing socket
 278  */
 279 struct ifa_msghdr {
 280         u_short ifam_msglen;    /* to skip over non-understood messages */
 281         u_char  ifam_version;   /* future binary compatability */
 282         u_char  ifam_type;      /* message type */
 283         int     ifam_addrs;     /* like rtm_addrs */
 284         int     ifam_flags;     /* value of ifa_flags */
 285         u_short ifam_index;     /* index for associated ifp */
 286         int     ifam_metric;    /* value of ifa_metric */
 287 };
 288
 289 /*
 290  * Interface request structure used for socket
 291  * ioctl's.  All interface ioctl's must have parameter
 292  * definitions which begin with ifr_name.  The
 293  * remainder may be interface specific.
 294  */
 295 struct  ifreq {
 296         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 297         union {
 298                 struct  sockaddr ifru_addr;
 299                 struct  sockaddr ifru_dstaddr;
 300                 struct  sockaddr ifru_broadaddr;
 301                 short   ifru_flags;
 302                 short   ifru_index;
 303                 int     ifru_metric;
 304                 int     ifru_mtu;
 305                 caddr_t ifru_data;
 306         } ifr_ifru;
 307 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 308 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 309 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 310 #define ifr_flags       ifr_ifru.ifru_flags     /* flags */
 311 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 312 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 313 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 314 #define ifr_index       ifr_ifru.ifru_index     /* interface index */
 315 #define ifr_ifindex     ifr_ifru.ifru_index     /* interface index (alias) */
 316 };
 317
 318 struct ifaliasreq {
 319         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 320         struct  sockaddr ifra_addr;
 321         struct  sockaddr ifra_broadaddr;
 322         struct  sockaddr ifra_mask;
 323 };
 324
 325 /*
 326  * Structure used in SIOCGIFCONF request.
 327  * Used to retrieve interface configuration
 328  * for machine (useful for programs which
 329  * must know all networks accessible).
 330  */
 331 struct  ifconf {
 332         int     ifc_len;                /* size of associated buffer */
 333         union {
 334                 caddr_t ifcu_buf;
 335                 struct  ifreq *ifcu_req;
 336         } ifc_ifcu;
 337 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 338 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 339 };
 340
 341 struct if_nameindex {
 342         unsigned long   if_index;
 343         char                    *if_name;
 344 };
 345
 346 #include <net/if_arp.h>
 347
 348 #endif /* !_NET_IF_H_ */