StdLib/Include/net/route.h

   1 /*
   2  * Copyright (c) 1980, 1986, 1993
   3  *      The Regents of the University of California.  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     8.3 (Berkeley) 4/19/94
  34  * $Id: route.h,v 1.1.1.1 2006/05/30 06:12:46 hhzhou Exp $
  35  */
  36
  37 #ifndef _NET_ROUTE_H_
  38 #define _NET_ROUTE_H_
  39
  40 #define __P(protos)     protos          /* full-blown ANSI C */
  41
  42
  43 /*
  44  * Kernel resident routing tables.
  45  *
  46  * The routing tables are initialized when interface addresses
  47  * are set by making entries for all directly connected interfaces.
  48  */
  49
  50 /*
  51  * A route consists of a destination address and a reference
  52  * to a routing entry.  These are often held by protocols
  53  * in their control blocks, e.g. inpcb.
  54  */
  55 struct route {
  56         struct  rtentry *ro_rt;
  57         struct  sockaddr ro_dst;
  58 };
  59
  60 /*
  61  * These numbers are used by reliable protocols for determining
  62  * retransmission behavior and are included in the routing structure.
  63  */
  64 struct rt_metrics {
  65         u_long  rmx_locks;      /* Kernel must leave these values alone */
  66         u_long  rmx_mtu;        /* MTU for this path */
  67         u_long  rmx_hopcount;   /* max hops expected */
  68         u_long  rmx_expire;     /* lifetime for route, e.g. redirect */
  69         u_long  rmx_recvpipe;   /* inbound delay-bandwidth product */
  70         u_long  rmx_sendpipe;   /* outbound delay-bandwidth product */
  71         u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
  72         u_long  rmx_rtt;        /* estimated round trip time */
  73         u_long  rmx_rttvar;     /* estimated rtt variance */
  74         u_long  rmx_pksent;     /* packets sent using this route */
  75         u_long  rmx_filler[4];  /* will be used for T/TCP later */
  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  * XXX kernel function pointer `rt_output' is visible to applications.
  88  */
  89 struct mbuf;
  90
  91 /*
  92  * We distinguish between routes to hosts and routes to networks,
  93  * preferring the former if available.  For each route we infer
  94  * the interface to use from the gateway address supplied when
  95  * the route was entered.  Routes that forward packets through
  96  * gateways are marked so that the output routines know to address the
  97  * gateway rather than the ultimate destination.
  98  */
  99 #ifndef RNF_NORMAL
 100 #include <net/radix.h>
 101 #endif
 102 struct rtentry {
 103         struct  radix_node rt_nodes[2]; /* tree glue, and other values */
 104 #define rt_key(r)       ((struct sockaddr *)((r)->rt_nodes->rn_key))
 105 #define rt_mask(r)      ((struct sockaddr *)((r)->rt_nodes->rn_mask))
 106         struct  sockaddr *rt_gateway;   /* value */
 107         short   rt_filler;              /* was short flags field */
 108         short   rt_refcnt;              /* # held references */
 109         u_long  rt_flags;               /* up/down?, host/net */
 110         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 111         struct  ifaddr *rt_ifa;         /* the answer: interface to use */
 112         struct  sockaddr *rt_genmask;   /* for generation of cloned routes */
 113         caddr_t rt_llinfo;              /* pointer to link level info cache */
 114         struct  rt_metrics rt_rmx;      /* metrics used by rx'ing protocols */
 115         struct  rtentry *rt_gwroute;    /* implied entry for gatewayed routes */
 116         int     (*rt_output) __P((struct ifnet *, struct mbuf *,
 117                                   struct sockaddr *, struct rtentry *));
 118                                         /* output routine for this (rt,if) */
 119         struct  rtentry *rt_parent;     /* cloning parent of this route */
 120         void    *rt_filler2;            /* more filler */
 121 };
 122
 123 /*
 124  * Following structure necessary for 4.3 compatibility;
 125  * We should eventually move it to a compat file.
 126  */
 127 struct ortentry {
 128         u_long  rt_hash;                /* to speed lookups */
 129         struct  sockaddr rt_dst;        /* key */
 130         struct  sockaddr rt_gateway;    /* value */
 131         short   rt_flags;               /* up/down?, host/net */
 132         short   rt_refcnt;              /* # held references */
 133         u_long  rt_use;                 /* raw # packets forwarded */
 134         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 135 };
 136
 137 #define rt_use rt_rmx.rmx_pksent
 138
 139 #define RTF_UP          0x1             /* route usable */
 140 #define RTF_GATEWAY     0x2             /* destination is a gateway */
 141 #define RTF_HOST        0x4             /* host entry (net otherwise) */
 142 #define RTF_REJECT      0x8             /* host or net unreachable */
 143 #define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
 144 #define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
 145 #define RTF_DONE        0x40            /* message confirmed */
 146 /*                      0x80               unused */
 147 #define RTF_CLONING     0x100           /* generate new routes on use */
 148 #define RTF_XRESOLVE    0x200           /* external daemon resolves name */
 149 #define RTF_LLINFO      0x400           /* generated by link layer (e.g. ARP) */
 150 #define RTF_STATIC      0x800           /* manually added */
 151 #define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
 152 #define RTF_PROTO2      0x4000          /* protocol specific routing flag */
 153 #define RTF_PROTO1      0x8000          /* protocol specific routing flag */
 154
 155 #define RTF_PRCLONING   0x10000         /* protocol requires cloning */
 156 #define RTF_WASCLONED   0x20000         /* route generated through cloning */
 157 #define RTF_PROTO3      0x40000         /* protocol specific routing flag */
 158 /*                      0x80000            unused */
 159 #define RTF_PINNED      0x100000        /* future use */
 160 #define RTF_LOCAL       0x200000        /* route represents a local address */
 161 #define RTF_BROADCAST   0x400000        /* route represents a bcast address */
 162 #define RTF_MULTICAST   0x800000        /* route represents a mcast address */
 163                                         /* 0x1000000 and up unassigned */
 164
 165 /*
 166  * Routing statistics.
 167  */
 168 struct  rtstat {
 169         short   rts_badredirect;        /* bogus redirect calls */
 170         short   rts_dynamic;            /* routes created by redirects */
 171         short   rts_newgateway;         /* routes modified by redirects */
 172         short   rts_unreach;            /* lookups which failed */
 173         short   rts_wildcard;           /* lookups satisfied by a wildcard */
 174 };
 175 /*
 176  * Structures for routing messages.
 177  */
 178 struct rt_msghdr {
 179         u_short rtm_msglen;     /* to skip over non-understood messages */
 180         u_char  rtm_version;    /* future binary compatibility */
 181         u_char  rtm_type;       /* message type */
 182         u_short rtm_index;      /* index for associated ifp */
 183         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
 184         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
 185         pid_t   rtm_pid;        /* identify sender */
 186         int     rtm_seq;        /* for sender to identify action */
 187         int     rtm_errno;      /* why failed */
 188         int     rtm_use;        /* from rtentry */
 189         u_long  rtm_inits;      /* which metrics we are initializing */
 190         struct  rt_metrics rtm_rmx; /* metrics themselves */
 191 };
 192
 193 #define RTM_VERSION     5       /* Up the ante and ignore older versions */
 194
 195 #define RTM_ADD         0x1     /* Add Route */
 196 #define RTM_DELETE      0x2     /* Delete Route */
 197 #define RTM_CHANGE      0x3     /* Change Metrics or flags */
 198 #define RTM_GET         0x4     /* Report Metrics */
 199 #define RTM_LOSING      0x5     /* Kernel Suspects Partitioning */
 200 #define RTM_REDIRECT    0x6     /* Told to use different route */
 201 #define RTM_MISS        0x7     /* Lookup failed on this address */
 202 #define RTM_LOCK        0x8     /* fix specified metrics */
 203 #define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
 204 #define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
 205 #define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
 206 #define RTM_NEWADDR     0xc     /* address being added to iface */
 207 #define RTM_DELADDR     0xd     /* address being removed from iface */
 208 #define RTM_IFINFO      0xe     /* iface going up/down etc. */
 209 #define RTM_NEWMADDR    0xf     /* mcast group membership being added to if */
 210 #define RTM_DELMADDR    0x10    /* mcast group membership being deleted */
 211
 212 #define RTV_MTU         0x1     /* init or lock _mtu */
 213 #define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
 214 #define RTV_EXPIRE      0x4     /* init or lock _hopcount */
 215 #define RTV_RPIPE       0x8     /* init or lock _recvpipe */
 216 #define RTV_SPIPE       0x10    /* init or lock _sendpipe */
 217 #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
 218 #define RTV_RTT         0x40    /* init or lock _rtt */
 219 #define RTV_RTTVAR      0x80    /* init or lock _rttvar */
 220
 221 /*
 222  * Bitmask values for rtm_addr.
 223  */
 224 #define RTA_DST         0x1     /* destination sockaddr present */
 225 #define RTA_GATEWAY     0x2     /* gateway sockaddr present */
 226 #define RTA_NETMASK     0x4     /* netmask sockaddr present */
 227 #define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
 228 #define RTA_IFP         0x10    /* interface name sockaddr present */
 229 #define RTA_IFA         0x20    /* interface addr sockaddr present */
 230 #define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
 231 #define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
 232
 233 /*
 234  * Index offsets for sockaddr array for alternate internal encoding.
 235  */
 236 #define RTAX_DST        0       /* destination sockaddr present */
 237 #define RTAX_GATEWAY    1       /* gateway sockaddr present */
 238 #define RTAX_NETMASK    2       /* netmask sockaddr present */
 239 #define RTAX_GENMASK    3       /* cloning mask sockaddr present */
 240 #define RTAX_IFP        4       /* interface name sockaddr present */
 241 #define RTAX_IFA        5       /* interface addr sockaddr present */
 242 #define RTAX_AUTHOR     6       /* sockaddr for author of redirect */
 243 #define RTAX_BRD        7       /* for NEWADDR, broadcast or p-p dest addr */
 244 #define RTAX_MAX        8       /* size of array to allocate */
 245
 246 struct rt_addrinfo {
 247         int     rti_addrs;
 248         struct  sockaddr *rti_info[RTAX_MAX];
 249 };
 250
 251 struct route_cb {
 252         int     ip_count;
 253         int     ipx_count;
 254         int     ns_count;
 255         int     iso_count;
 256         int     any_count;
 257 };
 258
 259 #ifdef KERNEL
 260 #define RTFREE(rt) \
 261         if ((rt)->rt_refcnt <= 1) \
 262                 rtfree(rt); \
 263         else \
 264                 (rt)->rt_refcnt--;
 265
 266 extern struct route_cb route_cb;
 267 extern struct radix_node_head *rt_tables[AF_MAX+1];
 268
 269 struct ifmultiaddr;
 270 struct proc;
 271
 272 void     route_init __P((void));
 273 void     rt_ifmsg __P((struct ifnet *));
 274 void     rt_missmsg __P((int, struct rt_addrinfo *, int, int));
 275 void     rt_newaddrmsg __P((int, struct ifaddr *, int, struct rtentry *));
 276 void     rt_newmaddrmsg __P((int, struct ifmultiaddr *));
 277 int      rt_setgate __P((struct rtentry *,
 278             struct sockaddr *, struct sockaddr *));
 279 void     rtalloc __P((struct route *));
 280 void     rtalloc_ign __P((struct route *, unsigned long));
 281 struct rtentry *
 282          rtalloc1 __P((struct sockaddr *, int, unsigned long));
 283 void     rtfree __P((struct rtentry *));
 284 int      rtinit __P((struct ifaddr *, int, int));
 285 int      rtioctl __P((int, caddr_t, struct proc *));
 286 void     rtredirect __P((struct sockaddr *, struct sockaddr *,
 287             struct sockaddr *, int, struct sockaddr *, struct rtentry **));
 288 int      rtrequest __P((int, struct sockaddr *,
 289             struct sockaddr *, struct sockaddr *, int, struct rtentry **));
 290 #endif
 291
 292 #endif