Annotation of Net2/net/route.h, revision 1.1.1.1

1.1       root        1: /*
                      2:  * Copyright (c) 1980, 1986 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:  *
                     33:  *     @(#)route.h     7.13 (Berkeley) 4/25/91
                     34:  */
                     35: 
                     36: /*
                     37:  * Kernel resident routing tables.
                     38:  * 
                     39:  * The routing tables are initialized when interface addresses
                     40:  * are set by making entries for all directly connected interfaces.
                     41:  */
                     42: 
                     43: /*
                     44:  * A route consists of a destination address and a reference
                     45:  * to a routing entry.  These are often held by protocols
                     46:  * in their control blocks, e.g. inpcb.
                     47:  */
                     48: struct route {
                     49:        struct  rtentry *ro_rt;
                     50:        struct  sockaddr ro_dst;
                     51: };
                     52: 
                     53: /*
                     54:  * These numbers are used by reliable protocols for determining
                     55:  * retransmission behavior and are included in the routing structure.
                     56:  */
                     57: struct rt_metrics {
                     58:        u_long  rmx_locks;      /* Kernel must leave these values alone */
                     59:        u_long  rmx_mtu;        /* MTU for this path */
                     60:        u_long  rmx_hopcount;   /* max hops expected */
                     61:        u_long  rmx_expire;     /* lifetime for route, e.g. redirect */
                     62:        u_long  rmx_recvpipe;   /* inbound delay-bandwith product */
                     63:        u_long  rmx_sendpipe;   /* outbound delay-bandwith product */
                     64:        u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
                     65:        u_long  rmx_rtt;        /* estimated round trip time */
                     66:        u_long  rmx_rttvar;     /* estimated rtt variance */
                     67: };
                     68: 
                     69: /*
                     70:  * rmx_rtt and rmx_rttvar are stored as microseconds;
                     71:  * RTTTOPRHZ(rtt) converts to a value suitable for use
                     72:  * by a protocol slowtimo counter.
                     73:  */
                     74: #define        RTM_RTTUNIT     1000000 /* units for rtt, rttvar, as units per sec */
                     75: #define        RTTTOPRHZ(r)    ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
                     76: 
                     77: /*
                     78:  * We distinguish between routes to hosts and routes to networks,
                     79:  * preferring the former if available.  For each route we infer
                     80:  * the interface to use from the gateway address supplied when
                     81:  * the route was entered.  Routes that forward packets through
                     82:  * gateways are marked so that the output routines know to address the
                     83:  * gateway rather than the ultimate destination.
                     84:  */
                     85: #ifndef RNF_NORMAL
                     86: #include "radix.h"
                     87: #endif
                     88: struct rtentry {
                     89:        struct  radix_node rt_nodes[2]; /* tree glue, and other values */
                     90: #define        rt_key(r)       ((struct sockaddr *)((r)->rt_nodes->rn_key))
                     91: #define        rt_mask(r)      ((struct sockaddr *)((r)->rt_nodes->rn_mask))
                     92:        struct  sockaddr *rt_gateway;   /* value */
                     93:        short   rt_flags;               /* up/down?, host/net */
                     94:        short   rt_refcnt;              /* # held references */
                     95:        u_long  rt_use;                 /* raw # packets forwarded */
                     96:        struct  ifnet *rt_ifp;          /* the answer: interface to use */
                     97:        struct  ifaddr *rt_ifa;         /* the answer: interface to use */
                     98:        struct  sockaddr *rt_genmask;   /* for generation of cloned routes */
                     99:        caddr_t rt_llinfo;              /* pointer to link level info cache */
                    100:        struct  rt_metrics rt_rmx;      /* metrics used by rx'ing protocols */
                    101:        short   rt_idle;                /* easy to tell llayer still live */
                    102: };
                    103: 
                    104: /*
                    105:  * Following structure necessary for 4.3 compatibility;
                    106:  * We should eventually move it to a compat file.
                    107:  */
                    108: struct ortentry {
                    109:        u_long  rt_hash;                /* to speed lookups */
                    110:        struct  sockaddr rt_dst;        /* key */
                    111:        struct  sockaddr rt_gateway;    /* value */
                    112:        short   rt_flags;               /* up/down?, host/net */
                    113:        short   rt_refcnt;              /* # held references */
                    114:        u_long  rt_use;                 /* raw # packets forwarded */
                    115:        struct  ifnet *rt_ifp;          /* the answer: interface to use */
                    116: };
                    117: 
                    118: #define        RTF_UP          0x1             /* route useable */
                    119: #define        RTF_GATEWAY     0x2             /* destination is a gateway */
                    120: #define        RTF_HOST        0x4             /* host entry (net otherwise) */
                    121: #define        RTF_REJECT      0x8             /* host or net unreachable */
                    122: #define        RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
                    123: #define        RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
                    124: #define RTF_DONE       0x40            /* message confirmed */
                    125: #define RTF_MASK       0x80            /* subnet mask present */
                    126: #define RTF_CLONING    0x100           /* generate new routes on use */
                    127: #define RTF_XRESOLVE   0x200           /* external daemon resolves name */
                    128: #define RTF_LLINFO     0x400           /* generated by ARP or ESIS */
                    129: #define RTF_PROTO2     0x4000          /* protocol specific routing flag */
                    130: #define RTF_PROTO1     0x8000          /* protocol specific routing flag */
                    131: 
                    132: 
                    133: /*
                    134:  * Routing statistics.
                    135:  */
                    136: struct rtstat {
                    137:        short   rts_badredirect;        /* bogus redirect calls */
                    138:        short   rts_dynamic;            /* routes created by redirects */
                    139:        short   rts_newgateway;         /* routes modified by redirects */
                    140:        short   rts_unreach;            /* lookups which failed */
                    141:        short   rts_wildcard;           /* lookups satisfied by a wildcard */
                    142: };
                    143: /*
                    144:  * Structures for routing messages.
                    145:  */
                    146: struct rt_msghdr {
                    147:        u_short rtm_msglen;     /* to skip over non-understood messages */
                    148:        u_char  rtm_version;    /* future binary compatability */
                    149:        u_char  rtm_type;       /* message type */
                    150:        u_short rtm_index;      /* index for associated ifp */
                    151:        pid_t   rtm_pid;        /* identify sender */
                    152:        int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
                    153:        int     rtm_seq;        /* for sender to identify action */
                    154:        int     rtm_errno;      /* why failed */
                    155:        int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
                    156:        int     rtm_use;        /* from rtentry */
                    157:        u_long  rtm_inits;      /* which metrics we are initializing */
                    158:        struct  rt_metrics rtm_rmx; /* metrics themselves */
                    159: };
                    160: 
                    161: struct route_cb {
                    162:        int     ip_count;
                    163:        int     ns_count;
                    164:        int     iso_count;
                    165:        int     any_count;
                    166: };
                    167: #define RTM_VERSION    2       /* Up the ante and ignore older versions */
                    168: 
                    169: #define RTM_ADD                0x1     /* Add Route */
                    170: #define RTM_DELETE     0x2     /* Delete Route */
                    171: #define RTM_CHANGE     0x3     /* Change Metrics or flags */
                    172: #define RTM_GET                0x4     /* Report Metrics */
                    173: #define RTM_LOSING     0x5     /* Kernel Suspects Partitioning */
                    174: #define RTM_REDIRECT   0x6     /* Told to use different route */
                    175: #define RTM_MISS       0x7     /* Lookup failed on this address */
                    176: #define RTM_LOCK       0x8     /* fix specified metrics */
                    177: #define RTM_OLDADD     0x9     /* caused by SIOCADDRT */
                    178: #define RTM_OLDDEL     0xa     /* caused by SIOCDELRT */
                    179: #define RTM_RESOLVE    0xb     /* req to resolve dst to LL addr */
                    180: 
                    181: #define RTV_MTU                0x1     /* init or lock _mtu */
                    182: #define RTV_HOPCOUNT   0x2     /* init or lock _hopcount */
                    183: #define RTV_EXPIRE     0x4     /* init or lock _hopcount */
                    184: #define RTV_RPIPE      0x8     /* init or lock _recvpipe */
                    185: #define RTV_SPIPE      0x10    /* init or lock _sendpipe */
                    186: #define RTV_SSTHRESH   0x20    /* init or lock _ssthresh */
                    187: #define RTV_RTT                0x40    /* init or lock _rtt */
                    188: #define RTV_RTTVAR     0x80    /* init or lock _rttvar */
                    189: 
                    190: #define RTA_DST                0x1     /* destination sockaddr present */
                    191: #define RTA_GATEWAY    0x2     /* gateway sockaddr present */
                    192: #define RTA_NETMASK    0x4     /* netmask sockaddr present */
                    193: #define RTA_GENMASK    0x8     /* cloning mask sockaddr present */
                    194: #define RTA_IFP                0x10    /* interface name sockaddr present */
                    195: #define RTA_IFA                0x20    /* interface addr sockaddr present */
                    196: #define RTA_AUTHOR     0x40    /* sockaddr for author of redirect */
                    197: 
                    198: #ifdef KERNEL
                    199: struct route_cb route_cb;
                    200: #endif
                    201: 
                    202: #ifdef KERNEL
                    203: #define        RTFREE(rt) \
                    204:        if ((rt)->rt_refcnt <= 1) \
                    205:                rtfree(rt); \
                    206:        else \
                    207:                (rt)->rt_refcnt--;
                    208: 
                    209: #ifdef GATEWAY
                    210: #define        RTHASHSIZ       64
                    211: #else
                    212: #define        RTHASHSIZ       8
                    213: #endif
                    214: #if    (RTHASHSIZ & (RTHASHSIZ - 1)) == 0
                    215: #define RTHASHMOD(h)   ((h) & (RTHASHSIZ - 1))
                    216: #else
                    217: #define RTHASHMOD(h)   ((h) % RTHASHSIZ)
                    218: #endif
                    219: struct mbuf *rthost[RTHASHSIZ];
                    220: struct mbuf *rtnet[RTHASHSIZ];
                    221: struct rtstat  rtstat;
                    222: struct rtentry *rtalloc1();
                    223: #endif

unix.superglobalmegacorp.com

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