bsd/net/route.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1980, 1986, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions
  28  * are met:
  29  * 1. Redistributions of source code must retain the above copyright
  30  *    notice, this list of conditions and the following disclaimer.
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in the
  33  *    documentation and/or other materials provided with the distribution.
  34  * 3. All advertising materials mentioning features or use of this software
  35  *    must display the following acknowledgement:
  36  *      This product includes software developed by the University of
  37  *      California, Berkeley and its contributors.
  38  * 4. Neither the name of the University nor the names of its contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  *      @(#)route.h     8.3 (Berkeley) 4/19/94
  55  * $FreeBSD: src/sys/net/route.h,v 1.36.2.1 2000/08/16 06:14:23 jayanth Exp $
  56  */
  57
  58 #ifndef _NET_ROUTE_H_
  59 #define _NET_ROUTE_H_
  60 #include <sys/appleapiopts.h>
  61
  62 /*
  63  * Kernel resident routing tables.
  64  *
  65  * The routing tables are initialized when interface addresses
  66  * are set by making entries for all directly connected interfaces.
  67  */
  68
  69 /*
  70  * A route consists of a destination address and a reference
  71  * to a routing entry.  These are often held by protocols
  72  * in their control blocks, e.g. inpcb.
  73  */
  74 #if !defined(KERNEL) || defined(__APPLE_API_PRIVATE)
  75 struct route {
  76         struct  rtentry *ro_rt;
  77         struct  sockaddr ro_dst;
  78         u_long  reserved[2];    /* for future use if needed */
  79 };
  80 #else
  81 struct route;
  82 #endif
  83
  84 /*
  85  * These numbers are used by reliable protocols for determining
  86  * retransmission behavior and are included in the routing structure.
  87  */
  88 struct rt_metrics {
  89         u_long  rmx_locks;      /* Kernel must leave these values alone */
  90         u_long  rmx_mtu;        /* MTU for this path */
  91         u_long  rmx_hopcount;   /* max hops expected */
  92         u_long  rmx_expire;     /* lifetime for route, e.g. redirect */
  93         u_long  rmx_recvpipe;   /* inbound delay-bandwidth product */
  94         u_long  rmx_sendpipe;   /* outbound delay-bandwidth product */
  95         u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
  96         u_long  rmx_rtt;        /* estimated round trip time */
  97         u_long  rmx_rttvar;     /* estimated rtt variance */
  98         u_long  rmx_pksent;     /* packets sent using this route */
  99         u_long  rmx_filler[4];  /* will be used for T/TCP later */
 100 };
 101
 102 /*
 103  * rmx_rtt and rmx_rttvar are stored as microseconds;
 104  * RTTTOPRHZ(rtt) converts to a value suitable for use
 105  * by a protocol slowtimo counter.
 106  */
 107 #define RTM_RTTUNIT     1000000 /* units for rtt, rttvar, as units per sec */
 108 #define RTTTOPRHZ(r)    ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
 109
 110 /*
 111  * XXX kernel function pointer `rt_output' is visible to applications.
 112  */
 113 struct mbuf;
 114
 115 /*
 116  * We distinguish between routes to hosts and routes to networks,
 117  * preferring the former if available.  For each route we infer
 118  * the interface to use from the gateway address supplied when
 119  * the route was entered.  Routes that forward packets through
 120  * gateways are marked so that the output routines know to address the
 121  * gateway rather than the ultimate destination.
 122  */
 123 #ifndef RNF_NORMAL
 124 #include <net/radix.h>
 125 #endif
 126 #ifdef __APPLE_API_UNSTABLE
 127 struct rtentry {
 128         struct  radix_node rt_nodes[2]; /* tree glue, and other values */
 129 #define rt_key(r)       ((struct sockaddr *)((r)->rt_nodes->rn_key))
 130 #define rt_mask(r)      ((struct sockaddr *)((r)->rt_nodes->rn_mask))
 131         struct  sockaddr *rt_gateway;   /* value */
 132         int32_t rt_refcnt;              /* # held references */
 133         u_long  rt_flags;               /* up/down?, host/net */
 134         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 135         u_long  rt_dlt;                 /* DLIL dl_tag */
 136         struct  ifaddr *rt_ifa;         /* the answer: interface to use */
 137         struct  sockaddr *rt_genmask;   /* for generation of cloned routes */
 138         caddr_t rt_llinfo;              /* pointer to link level info cache */
 139         struct  rt_metrics rt_rmx;      /* metrics used by rx'ing protocols */
 140         struct  rtentry *rt_gwroute;    /* implied entry for gatewayed routes */
 141         int     (*rt_output) __P((struct ifnet *, struct mbuf *,
 142                                   struct sockaddr *, struct rtentry *));
 143                                         /* output routine for this (rt,if) */
 144         struct  rtentry *rt_parent;     /* cloning parent of this route */
 145         u_long  generation_id;          /* route generation id */
 146 };
 147 #endif /* __APPLE_API_UNSTABLE */
 148
 149 /*
 150  * Following structure necessary for 4.3 compatibility;
 151  * We should eventually move it to a compat file.
 152  */
 153 struct ortentry {
 154         u_long  rt_hash;                /* to speed lookups */
 155         struct  sockaddr rt_dst;        /* key */
 156         struct  sockaddr rt_gateway;    /* value */
 157         short   rt_flags;               /* up/down?, host/net */
 158         short   rt_refcnt;              /* # held references */
 159         u_long  rt_use;                 /* raw # packets forwarded */
 160         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 161 };
 162
 163 #define rt_use rt_rmx.rmx_pksent
 164
 165 #define RTF_UP          0x1             /* route usable */
 166 #define RTF_GATEWAY     0x2             /* destination is a gateway */
 167 #define RTF_HOST        0x4             /* host entry (net otherwise) */
 168 #define RTF_REJECT      0x8             /* host or net unreachable */
 169 #define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
 170 #define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
 171 #define RTF_DONE        0x40            /* message confirmed */
 172 #define RTF_DELCLONE    0x80            /* delete cloned route */
 173 #define RTF_CLONING     0x100           /* generate new routes on use */
 174 #define RTF_XRESOLVE    0x200           /* external daemon resolves name */
 175 #define RTF_LLINFO      0x400           /* generated by link layer (e.g. ARP) */
 176 #define RTF_STATIC      0x800           /* manually added */
 177 #define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
 178 #define RTF_PROTO2      0x4000          /* protocol specific routing flag */
 179 #define RTF_PROTO1      0x8000          /* protocol specific routing flag */
 180
 181 #define RTF_PRCLONING   0x10000         /* protocol requires cloning */
 182 #define RTF_WASCLONED   0x20000         /* route generated through cloning */
 183 #define RTF_PROTO3      0x40000         /* protocol specific routing flag */
 184 /*                      0x80000            unused */
 185 #define RTF_PINNED      0x100000        /* future use */
 186 #define RTF_LOCAL       0x200000        /* route represents a local address */
 187 #define RTF_BROADCAST   0x400000        /* route represents a bcast address */
 188 #define RTF_MULTICAST   0x800000        /* route represents a mcast address */
 189                                         /* 0x1000000 and up unassigned */
 190
 191 /*
 192  * Routing statistics.
 193  */
 194 struct  rtstat {
 195         short   rts_badredirect;        /* bogus redirect calls */
 196         short   rts_dynamic;            /* routes created by redirects */
 197         short   rts_newgateway;         /* routes modified by redirects */
 198         short   rts_unreach;            /* lookups which failed */
 199         short   rts_wildcard;           /* lookups satisfied by a wildcard */
 200 };
 201 /*
 202  * Structures for routing messages.
 203  */
 204 struct rt_msghdr {
 205         u_short rtm_msglen;     /* to skip over non-understood messages */
 206         u_char  rtm_version;    /* future binary compatibility */
 207         u_char  rtm_type;       /* message type */
 208         u_short rtm_index;      /* index for associated ifp */
 209         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
 210         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
 211         pid_t   rtm_pid;        /* identify sender */
 212         int     rtm_seq;        /* for sender to identify action */
 213         int     rtm_errno;      /* why failed */
 214         int     rtm_use;        /* from rtentry */
 215         u_long  rtm_inits;      /* which metrics we are initializing */
 216         struct  rt_metrics rtm_rmx; /* metrics themselves */
 217 };
 218
 219 #define RTM_VERSION     5       /* Up the ante and ignore older versions */
 220
 221 /*
 222  * Message types.
 223  */
 224 #define RTM_ADD         0x1     /* Add Route */
 225 #define RTM_DELETE      0x2     /* Delete Route */
 226 #define RTM_CHANGE      0x3     /* Change Metrics or flags */
 227 #define RTM_GET         0x4     /* Report Metrics */
 228 #define RTM_LOSING      0x5     /* Kernel Suspects Partitioning */
 229 #define RTM_REDIRECT    0x6     /* Told to use different route */
 230 #define RTM_MISS        0x7     /* Lookup failed on this address */
 231 #define RTM_LOCK        0x8     /* fix specified metrics */
 232 #define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
 233 #define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
 234 #define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
 235 #define RTM_NEWADDR     0xc     /* address being added to iface */
 236 #define RTM_DELADDR     0xd     /* address being removed from iface */
 237 #define RTM_IFINFO      0xe     /* iface going up/down etc. */
 238 #define RTM_NEWMADDR    0xf     /* mcast group membership being added to if */
 239 #define RTM_DELMADDR    0x10    /* mcast group membership being deleted */
 240 #ifdef KERNEL_PRIVATE
 241 #define RTM_GET_SILENT  0x11
 242 #endif
 243
 244 /*
 245  * Bitmask values for rtm_inits and rmx_locks.
 246  */
 247 #define RTV_MTU         0x1     /* init or lock _mtu */
 248 #define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
 249 #define RTV_EXPIRE      0x4     /* init or lock _expire */
 250 #define RTV_RPIPE       0x8     /* init or lock _recvpipe */
 251 #define RTV_SPIPE       0x10    /* init or lock _sendpipe */
 252 #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
 253 #define RTV_RTT         0x40    /* init or lock _rtt */
 254 #define RTV_RTTVAR      0x80    /* init or lock _rttvar */
 255
 256 /*
 257  * Bitmask values for rtm_addrs.
 258  */
 259 #define RTA_DST         0x1     /* destination sockaddr present */
 260 #define RTA_GATEWAY     0x2     /* gateway sockaddr present */
 261 #define RTA_NETMASK     0x4     /* netmask sockaddr present */
 262 #define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
 263 #define RTA_IFP         0x10    /* interface name sockaddr present */
 264 #define RTA_IFA         0x20    /* interface addr sockaddr present */
 265 #define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
 266 #define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
 267
 268 /*
 269  * Index offsets for sockaddr array for alternate internal encoding.
 270  */
 271 #define RTAX_DST        0       /* destination sockaddr present */
 272 #define RTAX_GATEWAY    1       /* gateway sockaddr present */
 273 #define RTAX_NETMASK    2       /* netmask sockaddr present */
 274 #define RTAX_GENMASK    3       /* cloning mask sockaddr present */
 275 #define RTAX_IFP        4       /* interface name sockaddr present */
 276 #define RTAX_IFA        5       /* interface addr sockaddr present */
 277 #define RTAX_AUTHOR     6       /* sockaddr for author of redirect */
 278 #define RTAX_BRD        7       /* for NEWADDR, broadcast or p-p dest addr */
 279 #define RTAX_MAX        8       /* size of array to allocate */
 280
 281 struct rt_addrinfo {
 282         int     rti_addrs;
 283         struct  sockaddr *rti_info[RTAX_MAX];
 284 };
 285
 286 struct route_cb {
 287         int     ip_count;
 288         int     ip6_count;
 289         int     ipx_count;
 290         int     ns_count;
 291         int     iso_count;
 292         int     any_count;
 293 };
 294
 295 #ifdef KERNEL
 296 #ifndef __APPLE__
 297 #define RTFREE(rt) \
 298         do { \
 299                 if ((rt)->rt_refcnt <= 1) \
 300                         rtfree(rt); \
 301                 else \
 302                         (rt)->rt_refcnt--; \
 303         } while (0)
 304 #else
 305 #define RTFREE(rt)      rtfree(rt)
 306 #endif
 307
 308 #ifdef __APPLE_API_PRIVATE
 309 extern struct route_cb route_cb;
 310 extern struct radix_node_head *rt_tables[AF_MAX+1];
 311
 312 struct ifmultiaddr;
 313 struct proc;
 314
 315 void     route_init __P((void));
 316 void     rt_ifmsg __P((struct ifnet *));
 317 void     rt_missmsg __P((int, struct rt_addrinfo *, int, int));
 318 void     rt_newaddrmsg __P((int, struct ifaddr *, int, struct rtentry *));
 319 void     rt_newmaddrmsg __P((int, struct ifmultiaddr *));
 320 int      rt_setgate __P((struct rtentry *,
 321             struct sockaddr *, struct sockaddr *));
 322 void     rtalloc __P((struct route *));
 323 void     rtalloc_ign __P((struct route *, u_long));
 324 struct rtentry *
 325          rtalloc1 __P((struct sockaddr *, int, u_long));
 326 void    rtfree __P((struct rtentry *));
 327 void    rtref __P((struct rtentry *));
 328 /*
 329  * rtunref will decrement the refcount, rtfree will decrement and free if
 330  * the refcount has reached zero and the route is not up.
 331  * Unless you have good reason to do otherwise, use rtfree.
 332  */
 333 void    rtunref __P((struct rtentry *));
 334 void    rtsetifa __P((struct rtentry *, struct ifaddr *));
 335 int      rtinit __P((struct ifaddr *, int, int));
 336 int      rtioctl __P((int, caddr_t, struct proc *));
 337 void     rtredirect __P((struct sockaddr *, struct sockaddr *,
 338             struct sockaddr *, int, struct sockaddr *, struct rtentry **));
 339 int      rtrequest __P((int, struct sockaddr *,
 340             struct sockaddr *, struct sockaddr *, int, struct rtentry **));
 341 #endif /* __APPLE_API_PRIVATE */
 342 #endif
 343
 344 #endif