git.mutantstargoat.com Git - oftp/blob - libs/watt32/net/route.h

   1 /*!\file net/route.h
   2  * Route handling.
   3  */
   4
   5 /*      $NetBSD: route.h,v 1.11 1997/04/02 21:17:29 christos Exp $      */
   6
   7 /*
   8  * Copyright (c) 1980, 1986, 1993
   9  *      The Regents of the University of California.  All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      @(#)route.h     8.5 (Berkeley) 2/8/95
  40  */
  41
  42 #ifndef __NET_ROUTE_H
  43 #define __NET_ROUTE_H
  44 /*
  45  * Kernel resident routing tables.
  46  *
  47  * The routing tables are initialized when interface addresses
  48  * are set by making entries for all directly connected interfaces.
  49  */
  50
  51 /*
  52  * A route consists of a destination address and a reference
  53  * to a routing entry.  These are often held by protocols
  54  * in their control blocks, e.g. inpcb.
  55  */
  56 struct route {
  57         struct  rtentry *ro_rt;
  58         struct  sockaddr ro_dst;
  59 };
  60
  61 /*
  62  * These numbers are used by reliable protocols for determining
  63  * retransmission behavior and are included in the routing structure.
  64  */
  65 struct rt_metrics {
  66         u_long  rmx_locks;      /* Kernel must leave these values alone */
  67         u_long  rmx_mtu;        /* MTU for this path */
  68         u_long  rmx_hopcount;   /* max hops expected */
  69         u_long  rmx_expire;     /* lifetime for route, e.g. redirect */
  70         u_long  rmx_recvpipe;   /* inbound delay-bandwith product */
  71         u_long  rmx_sendpipe;   /* outbound delay-bandwith product */
  72         u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
  73         u_long  rmx_rtt;        /* estimated round trip time */
  74         u_long  rmx_rttvar;     /* estimated rtt variance */
  75         u_long  rmx_pksent;     /* packets sent using this route */
  76 };
  77
  78 /*
  79  * rmx_rtt and rmx_rttvar are stored as microseconds;
  80  * RTTTOPRHZ(rtt) converts to a value suitable for use
  81  * by a protocol slowtimo counter.
  82  */
  83 #define RTM_RTTUNIT     1000000 /* units for rtt, rttvar, as units per sec */
  84 #define RTTTOPRHZ(r)    ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
  85
  86 /*
  87  * We distinguish between routes to hosts and routes to networks,
  88  * preferring the former if available.  For each route we infer
  89  * the interface to use from the gateway address supplied when
  90  * the route was entered.  Routes that forward packets through
  91  * gateways are marked so that the output routines know to address the
  92  * gateway rather than the ultimate destination.
  93  */
  94 #ifndef RNF_NORMAL
  95 #include <net/radix.h>
  96 #endif
  97
  98 struct rtentry {
  99         struct  radix_node rt_nodes[2]; /* tree glue, and other values */
 100 #define rt_key(r)       ((struct sockaddr *)((r)->rt_nodes->rn_key))
 101 #define rt_mask(r)      ((struct sockaddr *)((r)->rt_nodes->rn_mask))
 102         struct  sockaddr *rt_gateway;   /* value */
 103         short   rt_flags;               /* up/down?, host/net */
 104         short   rt_refcnt;              /* # held references */
 105         u_long  rt_use;                 /* raw # packets forwarded */
 106         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 107         struct  ifaddr *rt_ifa;         /* the answer: interface to use */
 108         struct  sockaddr *rt_genmask;   /* for generation of cloned routes */
 109         caddr_t rt_llinfo;              /* pointer to link level info cache */
 110         struct  rt_metrics rt_rmx;      /* metrics used by rx'ing protocols */
 111         struct  rtentry *rt_gwroute;    /* implied entry for gatewayed routes */
 112 };
 113
 114 /*
 115  * Following structure necessary for 4.3 compatibility;
 116  * We should eventually move it to a compat file.
 117  */
 118 struct ortentry {
 119         u_int32_t rt_hash;              /* to speed lookups */
 120         struct  sockaddr rt_dst;        /* key */
 121         struct  sockaddr rt_gateway;    /* value */
 122         int16_t rt_flags;               /* up/down?, host/net */
 123         int16_t rt_refcnt;              /* # held references */
 124         u_int32_t rt_use;               /* raw # packets forwarded */
 125         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 126 };
 127
 128 #define RTF_UP          0x1             /* route usable */
 129 #define RTF_GATEWAY     0x2             /* destination is a gateway */
 130 #define RTF_HOST        0x4             /* host entry (net otherwise) */
 131 #define RTF_REJECT      0x8             /* host or net unreachable */
 132 #define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
 133 #define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
 134 #define RTF_DONE        0x40            /* message confirmed */
 135 #define RTF_MASK        0x80            /* subnet mask present */
 136 #define RTF_CLONING     0x100           /* generate new routes on use */
 137 #define RTF_XRESOLVE    0x200           /* external daemon resolves name */
 138 #define RTF_LLINFO      0x400           /* generated by ARP or ESIS */
 139 #define RTF_STATIC      0x800           /* manually added */
 140 #define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
 141 #define RTF_PROTO2      0x4000          /* protocol specific routing flag */
 142 #define RTF_PROTO1      0x8000          /* protocol specific routing flag */
 143
 144
 145 /*
 146  * Routing statistics.
 147  */
 148 struct  rtstat {
 149         short   rts_badredirect;        /* bogus redirect calls */
 150         short   rts_dynamic;            /* routes created by redirects */
 151         short   rts_newgateway;         /* routes modified by redirects */
 152         short   rts_unreach;            /* lookups which failed */
 153         short   rts_wildcard;           /* lookups satisfied by a wildcard */
 154 };
 155 /*
 156  * Structures for routing messages.
 157  */
 158 struct rt_msghdr {
 159         u_short rtm_msglen;     /* to skip over non-understood messages */
 160         u_char  rtm_version;    /* future binary compatibility */
 161         u_char  rtm_type;       /* message type */
 162         u_short rtm_index;      /* index for associated ifp */
 163         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
 164         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
 165         int     rtm_pid;        /* identify sender */
 166         int     rtm_seq;        /* for sender to identify action */
 167         int     rtm_errno;      /* why failed */
 168         int     rtm_use;        /* from rtentry */
 169         u_long  rtm_inits;      /* which metrics we are initializing */
 170         struct  rt_metrics rtm_rmx; /* metrics themselves */
 171 };
 172
 173 #define RTM_VERSION     3       /* Up the ante and ignore older versions */
 174
 175 #define RTM_ADD         0x1     /* Add Route */
 176 #define RTM_DELETE      0x2     /* Delete Route */
 177 #define RTM_CHANGE      0x3     /* Change Metrics or flags */
 178 #define RTM_GET         0x4     /* Report Metrics */
 179 #define RTM_LOSING      0x5     /* Kernel Suspects Partitioning */
 180 #define RTM_REDIRECT    0x6     /* Told to use different route */
 181 #define RTM_MISS        0x7     /* Lookup failed on this address */
 182 #define RTM_LOCK        0x8     /* fix specified metrics */
 183 #define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
 184 #define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
 185 #define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
 186 #define RTM_NEWADDR     0xc     /* address being added to iface */
 187 #define RTM_DELADDR     0xd     /* address being removed from iface */
 188 #define RTM_IFINFO      0xe     /* iface going up/down etc. */
 189
 190 #define RTV_MTU         0x1     /* init or lock _mtu */
 191 #define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
 192 #define RTV_EXPIRE      0x4     /* init or lock _hopcount */
 193 #define RTV_RPIPE       0x8     /* init or lock _recvpipe */
 194 #define RTV_SPIPE       0x10    /* init or lock _sendpipe */
 195 #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
 196 #define RTV_RTT         0x40    /* init or lock _rtt */
 197 #define RTV_RTTVAR      0x80    /* init or lock _rttvar */
 198
 199 /*
 200  * Bitmask values for rtm_addr.
 201  */
 202 #define RTA_DST         0x1     /* destination sockaddr present */
 203 #define RTA_GATEWAY     0x2     /* gateway sockaddr present */
 204 #define RTA_NETMASK     0x4     /* netmask sockaddr present */
 205 #define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
 206 #define RTA_IFP         0x10    /* interface name sockaddr present */
 207 #define RTA_IFA         0x20    /* interface addr sockaddr present */
 208 #define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
 209 #define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
 210
 211 /*
 212  * Index offsets for sockaddr array for alternate internal encoding.
 213  */
 214 #define RTAX_DST        0       /* destination sockaddr present */
 215 #define RTAX_GATEWAY    1       /* gateway sockaddr present */
 216 #define RTAX_NETMASK    2       /* netmask sockaddr present */
 217 #define RTAX_GENMASK    3       /* cloning mask sockaddr present */
 218 #define RTAX_IFP        4       /* interface name sockaddr present */
 219 #define RTAX_IFA        5       /* interface addr sockaddr present */
 220 #define RTAX_AUTHOR     6       /* sockaddr for author of redirect */
 221 #define RTAX_BRD        7       /* for NEWADDR, broadcast or p-p dest addr */
 222 #define RTAX_MAX        8       /* size of array to allocate */
 223
 224 struct rt_addrinfo {
 225         int     rti_addrs;
 226         struct  sockaddr *rti_info[RTAX_MAX];
 227 };
 228
 229 struct route_cb {
 230         int     ip_count;
 231         int     ns_count;
 232         int     iso_count;
 233         int     any_count;
 234 };
 235
 236 #endif