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

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

unix.superglobalmegacorp.com

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