Annotation of Net2/net/if.h, revision 1.1.1.3

1.1       root        1: /*
                      2:  * Copyright (c) 1982, 1986, 1989 Regents of the University of California.
                      3:  * 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:  *
1.1.1.3 ! root       33:  *     from: @(#)if.h  7.11 (Berkeley) 3/19/91
        !            34:  *     if.h,v 1.3 1993/05/20 03:05:56 cgd Exp
1.1       root       35:  */
                     36: 
1.1.1.3 ! root       37: #ifndef _NET_IF_H_
        !            38: #define _NET_IF_H_
        !            39: 
1.1       root       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)
                     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: #ifndef _TIME_ /*  XXX fast fix for SNMP, going away soon */
                     65: #ifdef KERNEL
                     66: #include "../sys/time.h"
                     67: #else
                     68: #include <sys/time.h>
                     69: #endif
                     70: #endif
                     71: 
                     72: /*
                     73:  * Structure defining a queue for a network interface.
                     74:  *
                     75:  * (Would like to call this struct ``if'', but C isn't PL/1.)
                     76:  */
                     77: 
                     78: struct ifnet {
                     79:        char    *if_name;               /* name, e.g. ``en'' or ``lo'' */
                     80:        short   if_unit;                /* sub-unit for lower level driver */
                     81:        short   if_mtu;                 /* maximum transmission unit */
                     82:        short   if_flags;               /* up/down, broadcast, etc. */
                     83:        short   if_timer;               /* time 'til if_watchdog called */
                     84:        int     if_metric;              /* routing metric (external only) */
                     85:        struct  ifaddr *if_addrlist;    /* linked list of addresses per if */
                     86:        struct  ifqueue {
                     87:                struct  mbuf *ifq_head;
                     88:                struct  mbuf *ifq_tail;
                     89:                int     ifq_len;
                     90:                int     ifq_maxlen;
                     91:                int     ifq_drops;
                     92:        } if_snd;                       /* output queue */
                     93: /* procedure handles */
                     94:        int     (*if_init)();           /* init routine */
                     95:        int     (*if_output)();         /* output routine (enqueue) */
                     96:        int     (*if_start)();          /* initiate output routine */
                     97:        int     (*if_done)();           /* output complete routine */
                     98:        int     (*if_ioctl)();          /* ioctl routine */
                     99:        int     (*if_reset)();          /* bus reset routine */
                    100:        int     (*if_watchdog)();       /* timer routine */
                    101: /* generic interface statistics */
                    102:        int     if_ipackets;            /* packets received on interface */
                    103:        int     if_ierrors;             /* input errors on interface */
                    104:        int     if_opackets;            /* packets sent on interface */
                    105:        int     if_oerrors;             /* output errors on interface */
                    106:        int     if_collisions;          /* collisions on csma interfaces */
                    107: /* end statistics */
                    108:        struct  ifnet *if_next;
                    109:        u_char  if_type;                /* ethernet, tokenring, etc */
                    110:        u_char  if_addrlen;             /* media address length */
                    111:        u_char  if_hdrlen;              /* media header length */
                    112:        u_char  if_index;               /* numeric abbreviation for this if  */
                    113: /* more statistics here to avoid recompiling netstat */
                    114:        struct  timeval if_lastchange;  /* last updated */
                    115:        int     if_ibytes;              /* total number of octets received */
                    116:        int     if_obytes;              /* total number of octets sent */
                    117:        int     if_imcasts;             /* packets received via multicast */
                    118:        int     if_omcasts;             /* packets sent via multicast */
                    119:        int     if_iqdrops;             /* dropped on input, this interface */
                    120:        int     if_noproto;             /* destined for unsupported protocol */
                    121:        int     if_baudrate;            /* linespeed */
                    122:         int    if_pcount;              /* number of promiscuous listeners */
                    123: };
                    124: 
                    125: #define        IFF_UP          0x1             /* interface is up */
                    126: #define        IFF_BROADCAST   0x2             /* broadcast address valid */
                    127: #define        IFF_DEBUG       0x4             /* turn on debugging */
                    128: #define        IFF_LOOPBACK    0x8             /* is a loopback net */
                    129: #define        IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
                    130: #define        IFF_NOTRAILERS  0x20            /* avoid use of trailers */
                    131: #define        IFF_RUNNING     0x40            /* resources allocated */
                    132: #define        IFF_NOARP       0x80            /* no address resolution protocol */
                    133: /* next two not supported now, but reserved: */
                    134: #define        IFF_PROMISC     0x100           /* receive all packets */
                    135: #define        IFF_ALLMULTI    0x200           /* receive all multicast packets */
                    136: #define        IFF_OACTIVE     0x400           /* transmission in progress */
                    137: #define        IFF_SIMPLEX     0x800           /* can't hear own transmissions */
1.1.1.2   root      138: #define        IFF_LLC0        0x1000          /* interface driver control/status */
                    139: #define        IFF_LLC1        0x2000          /* interface driver control/status */
                    140: #define        IFF_LLC2        0x4000          /* interface driver control/status */
1.1       root      141: 
                    142: /* flags set internally only: */
                    143: #define        IFF_CANTCHANGE \
                    144:        (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|IFF_SIMPLEX)
                    145: 
                    146: /*
                    147:  * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1)
                    148:  * input routines have queues of messages stored on ifqueue structures
                    149:  * (defined above).  Entries are added to and deleted from these structures
                    150:  * by these macros, which should be called with ipl raised to splimp().
                    151:  */
                    152: #define        IF_QFULL(ifq)           ((ifq)->ifq_len >= (ifq)->ifq_maxlen)
                    153: #define        IF_DROP(ifq)            ((ifq)->ifq_drops++)
                    154: #define        IF_ENQUEUE(ifq, m) { \
                    155:        (m)->m_nextpkt = 0; \
                    156:        if ((ifq)->ifq_tail == 0) \
                    157:                (ifq)->ifq_head = m; \
                    158:        else \
                    159:                (ifq)->ifq_tail->m_nextpkt = m; \
                    160:        (ifq)->ifq_tail = m; \
                    161:        (ifq)->ifq_len++; \
                    162: }
                    163: #define        IF_PREPEND(ifq, m) { \
                    164:        (m)->m_nextpkt = (ifq)->ifq_head; \
                    165:        if ((ifq)->ifq_tail == 0) \
                    166:                (ifq)->ifq_tail = (m); \
                    167:        (ifq)->ifq_head = (m); \
                    168:        (ifq)->ifq_len++; \
                    169: }
                    170: #define        IF_DEQUEUE(ifq, m) { \
                    171:        (m) = (ifq)->ifq_head; \
                    172:        if (m) { \
                    173:                if (((ifq)->ifq_head = (m)->m_nextpkt) == 0) \
                    174:                        (ifq)->ifq_tail = 0; \
                    175:                (m)->m_nextpkt = 0; \
                    176:                (ifq)->ifq_len--; \
                    177:        } \
                    178: }
                    179: 
                    180: #define        IFQ_MAXLEN      50
                    181: #define        IFNET_SLOWHZ    1               /* granularity is 1 second */
                    182: 
                    183: /*
                    184:  * The ifaddr structure contains information about one address
                    185:  * of an interface.  They are maintained by the different address families,
                    186:  * are allocated and attached when an address is set, and are linked
                    187:  * together so all addresses for an interface can be located.
                    188:  */
                    189: struct ifaddr {
                    190:        struct  sockaddr *ifa_addr;     /* address of interface */
                    191:        struct  sockaddr *ifa_dstaddr;  /* other end of p-to-p link */
                    192: #define        ifa_broadaddr   ifa_dstaddr     /* broadcast address interface */
                    193:        struct  sockaddr *ifa_netmask;  /* used to determine subnet */
                    194:        struct  ifnet *ifa_ifp;         /* back-pointer to interface */
                    195:        struct  ifaddr *ifa_next;       /* next address for interface */
                    196:        int     (*ifa_rtrequest)();     /* check or clean routes (+ or -)'d */
                    197:        struct  rtentry *ifa_rt;        /* ??? for ROUTETOIF */
                    198:        u_short ifa_flags;              /* mostly rt_flags for cloning */
                    199:        u_short ifa_llinfolen;          /* extra to malloc for link info */
                    200: };
                    201: #define IFA_ROUTE      RTF_UP          /* route installed */
                    202: /*
                    203:  * Interface request structure used for socket
                    204:  * ioctl's.  All interface ioctl's must have parameter
                    205:  * definitions which begin with ifr_name.  The
                    206:  * remainder may be interface specific.
                    207:  */
                    208: struct ifreq {
                    209: #define        IFNAMSIZ        16
                    210:        char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
                    211:        union {
                    212:                struct  sockaddr ifru_addr;
                    213:                struct  sockaddr ifru_dstaddr;
                    214:                struct  sockaddr ifru_broadaddr;
                    215:                short   ifru_flags;
                    216:                int     ifru_metric;
                    217:                caddr_t ifru_data;
                    218:        } ifr_ifru;
                    219: #define        ifr_addr        ifr_ifru.ifru_addr      /* address */
                    220: #define        ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
                    221: #define        ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
                    222: #define        ifr_flags       ifr_ifru.ifru_flags     /* flags */
                    223: #define        ifr_metric      ifr_ifru.ifru_metric    /* metric */
                    224: #define        ifr_data        ifr_ifru.ifru_data      /* for use by interface */
                    225: };
                    226: 
                    227: struct ifaliasreq {
                    228:        char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
                    229:        struct  sockaddr ifra_addr;
                    230:        struct  sockaddr ifra_broadaddr;
                    231:        struct  sockaddr ifra_mask;
                    232: };
                    233: 
                    234: /*
                    235:  * Structure used in SIOCGIFCONF request.
                    236:  * Used to retrieve interface configuration
                    237:  * for machine (useful for programs which
                    238:  * must know all networks accessible).
                    239:  */
                    240: struct ifconf {
                    241:        int     ifc_len;                /* size of associated buffer */
                    242:        union {
                    243:                caddr_t ifcu_buf;
                    244:                struct  ifreq *ifcu_req;
                    245:        } ifc_ifcu;
                    246: #define        ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
                    247: #define        ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
                    248: };
                    249: 
                    250: #ifdef KERNEL
                    251: #include "../net/if_arp.h"
                    252: struct ifqueue rawintrq;               /* raw packet input queue */
                    253: struct ifnet *ifnet;
                    254: struct ifaddr *ifa_ifwithaddr(), *ifa_ifwithnet();
                    255: struct ifaddr *ifa_ifwithdstaddr();
                    256: #else KERNEL
                    257: #include <net/if_arp.h>
                    258: #endif KERNEL
1.1.1.3 ! root      259: 
        !           260: #endif /* !_NET_IF_H_ */

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.