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 #include <sys/types.h>
  62 #include <sys/socket.h>
  63
  64 /*
  65  * Kernel resident routing tables.
  66  *
  67  * The routing tables are initialized when interface addresses
  68  * are set by making entries for all directly connected interfaces.
  69  */
  70
  71 /*
  72  * A route consists of a destination address and a reference
  73  * to a routing entry.  These are often held by protocols
  74  * in their control blocks, e.g. inpcb.
  75  */
  76 #ifdef PRIVATE
  77 struct  rtentry;
  78 struct route {
  79         struct  rtentry *ro_rt;
  80         struct  sockaddr ro_dst;
  81         u_long  reserved[2];    /* for future use if needed */
  82 };
  83 #else
  84 struct route;
  85 #endif /* PRIVATE */
  86
  87 /*
  88  * These numbers are used by reliable protocols for determining
  89  * retransmission behavior and are included in the routing structure.
  90  */
  91 struct rt_metrics {
  92         u_long  rmx_locks;      /* Kernel must leave these values alone */
  93         u_long  rmx_mtu;        /* MTU for this path */
  94         u_long  rmx_hopcount;   /* max hops expected */
  95         int32_t rmx_expire;     /* lifetime for route, e.g. redirect */
  96         u_long  rmx_recvpipe;   /* inbound delay-bandwidth product */
  97         u_long  rmx_sendpipe;   /* outbound delay-bandwidth product */
  98         u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
  99         u_long  rmx_rtt;        /* estimated round trip time */
 100         u_long  rmx_rttvar;     /* estimated rtt variance */
 101         u_long  rmx_pksent;     /* packets sent using this route */
 102         u_long  rmx_filler[4];  /* will be used for T/TCP later */
 103 };
 104
 105 /*
 106  * rmx_rtt and rmx_rttvar are stored as microseconds;
 107  * RTTTOPRHZ(rtt) converts to a value suitable for use
 108  * by a protocol slowtimo counter.
 109  */
 110 #define RTM_RTTUNIT     1000000 /* units for rtt, rttvar, as units per sec */
 111 #define RTTTOPRHZ(r)    ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
 112
 113 /*
 114  * XXX kernel function pointer `rt_output' is visible to applications.
 115  */
 116
 117 /*
 118  * We distinguish between routes to hosts and routes to networks,
 119  * preferring the former if available.  For each route we infer
 120  * the interface to use from the gateway address supplied when
 121  * the route was entered.  Routes that forward packets through
 122  * gateways are marked so that the output routines know to address the
 123  * gateway rather than the ultimate destination.
 124  */
 125 #ifdef PRIVATE
 126 #ifndef RNF_NORMAL
 127 #include <net/radix.h>
 128 #endif
 129 struct rtentry {
 130         struct  radix_node rt_nodes[2]; /* tree glue, and other values */
 131 #define rt_key(r)       ((struct sockaddr *)((r)->rt_nodes->rn_key))
 132 #define rt_mask(r)      ((struct sockaddr *)((r)->rt_nodes->rn_mask))
 133         struct  sockaddr *rt_gateway;   /* value */
 134         int32_t rt_refcnt;              /* # held references */
 135         u_long  rt_flags;               /* up/down?, host/net */
 136         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 137         u_long  rt_dlt;                 /* DLIL dl_tag */
 138         struct  ifaddr *rt_ifa;         /* the answer: interface to use */
 139         struct  sockaddr *rt_genmask;   /* for generation of cloned routes */
 140         caddr_t rt_llinfo;              /* pointer to link level info cache */
 141         struct  rt_metrics rt_rmx;      /* metrics used by rx'ing protocols */
 142         struct  rtentry *rt_gwroute;    /* implied entry for gatewayed routes */
 143         int     (*rt_output)(struct ifnet *, struct mbuf *,
 144                                   struct sockaddr *, struct rtentry *);
 145                                         /* output routine for this (rt,if) */
 146         struct  rtentry *rt_parent;     /* cloning parent of this route */
 147         u_long  generation_id;          /* route generation id */
 148 };
 149 #endif /* PRIVATE */
 150
 151 #ifdef __APPLE_API_OBSOLETE
 152 /*
 153  * Following structure necessary for 4.3 compatibility;
 154  * We should eventually move it to a compat file.
 155  */
 156 struct ortentry {
 157         u_long  rt_hash;                /* to speed lookups */
 158         struct  sockaddr rt_dst;        /* key */
 159         struct  sockaddr rt_gateway;    /* value */
 160         short   rt_flags;               /* up/down?, host/net */
 161         short   rt_refcnt;              /* # held references */
 162         u_long  rt_use;                 /* raw # packets forwarded */
 163         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 164 };
 165 #endif /* __APPLE_API_OBSOLETE */
 166
 167 #ifdef PRIVATE
 168 #define rt_use rt_rmx.rmx_pksent
 169 #endif /* PRIVATE */
 170
 171 #define RTF_UP          0x1             /* route usable */
 172 #define RTF_GATEWAY     0x2             /* destination is a gateway */
 173 #define RTF_HOST        0x4             /* host entry (net otherwise) */
 174 #define RTF_REJECT      0x8             /* host or net unreachable */
 175 #define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
 176 #define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
 177 #define RTF_DONE        0x40            /* message confirmed */
 178 #define RTF_DELCLONE    0x80            /* delete cloned route */
 179 #define RTF_CLONING     0x100           /* generate new routes on use */
 180 #define RTF_XRESOLVE    0x200           /* external daemon resolves name */
 181 #define RTF_LLINFO      0x400           /* generated by link layer (e.g. ARP) */
 182 #define RTF_STATIC      0x800           /* manually added */
 183 #define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
 184 #define RTF_PROTO2      0x4000          /* protocol specific routing flag */
 185 #define RTF_PROTO1      0x8000          /* protocol specific routing flag */
 186
 187 #define RTF_PRCLONING   0x10000         /* protocol requires cloning */
 188 #define RTF_WASCLONED   0x20000         /* route generated through cloning */
 189 #define RTF_PROTO3      0x40000         /* protocol specific routing flag */
 190                                         /* 0x80000 unused */
 191 #define RTF_PINNED      0x100000        /* future use */
 192 #define RTF_LOCAL       0x200000        /* route represents a local address */
 193 #define RTF_BROADCAST   0x400000        /* route represents a bcast address */
 194 #define RTF_MULTICAST   0x800000        /* route represents a mcast address */
 195                                         /* 0x1000000 and up unassigned */
 196
 197 /*
 198  * Routing statistics.
 199  */
 200 struct  rtstat {
 201         short   rts_badredirect;        /* bogus redirect calls */
 202         short   rts_dynamic;            /* routes created by redirects */
 203         short   rts_newgateway;         /* routes modified by redirects */
 204         short   rts_unreach;            /* lookups which failed */
 205         short   rts_wildcard;           /* lookups satisfied by a wildcard */
 206 };
 207
 208 /*
 209  * Structures for routing messages.
 210  */
 211 struct rt_msghdr {
 212         u_short rtm_msglen;     /* to skip over non-understood messages */
 213         u_char  rtm_version;    /* future binary compatibility */
 214         u_char  rtm_type;       /* message type */
 215         u_short rtm_index;      /* index for associated ifp */
 216         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
 217         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
 218         pid_t   rtm_pid;        /* identify sender */
 219         int     rtm_seq;        /* for sender to identify action */
 220         int     rtm_errno;      /* why failed */
 221         int     rtm_use;        /* from rtentry */
 222         u_long  rtm_inits;      /* which metrics we are initializing */
 223         struct  rt_metrics rtm_rmx; /* metrics themselves */
 224 };
 225
 226 struct rt_msghdr2 {
 227         u_short rtm_msglen;     /* to skip over non-understood messages */
 228         u_char  rtm_version;    /* future binary compatibility */
 229         u_char  rtm_type;       /* message type */
 230         u_short rtm_index;      /* index for associated ifp */
 231         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
 232         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
 233         int32_t rtm_refcnt;         /* reference count */
 234         int     rtm_parentflags;      /* flags of the parent route */
 235         int     rtm_reserved;      /* reserved field set to 0 */
 236         int     rtm_use;        /* from rtentry */
 237         u_long  rtm_inits;      /* which metrics we are initializing */
 238         struct  rt_metrics rtm_rmx; /* metrics themselves */
 239 };
 240
 241
 242 #define RTM_VERSION     5       /* Up the ante and ignore older versions */
 243
 244 /*
 245  * Message types.
 246  */
 247 #define RTM_ADD         0x1     /* Add Route */
 248 #define RTM_DELETE      0x2     /* Delete Route */
 249 #define RTM_CHANGE      0x3     /* Change Metrics or flags */
 250 #define RTM_GET         0x4     /* Report Metrics */
 251 #define RTM_LOSING      0x5     /* Kernel Suspects Partitioning */
 252 #define RTM_REDIRECT    0x6     /* Told to use different route */
 253 #define RTM_MISS        0x7     /* Lookup failed on this address */
 254 #define RTM_LOCK        0x8     /* fix specified metrics */
 255 #define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
 256 #define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
 257 #define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
 258 #define RTM_NEWADDR     0xc     /* address being added to iface */
 259 #define RTM_DELADDR     0xd     /* address being removed from iface */
 260 #define RTM_IFINFO      0xe     /* iface going up/down etc. */
 261 #define RTM_NEWMADDR    0xf     /* mcast group membership being added to if */
 262 #define RTM_DELMADDR    0x10    /* mcast group membership being deleted */
 263 #ifdef PRIVATE
 264 #define RTM_GET_SILENT  0x11
 265 #endif PRIVATE
 266 #define RTM_IFINFO2     0x12    /* */
 267 #define RTM_NEWMADDR2   0x13    /* */
 268 #define RTM_GET2        0x14    /* */
 269
 270 /*
 271  * Bitmask values for rtm_inits and rmx_locks.
 272  */
 273 #define RTV_MTU         0x1     /* init or lock _mtu */
 274 #define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
 275 #define RTV_EXPIRE      0x4     /* init or lock _expire */
 276 #define RTV_RPIPE       0x8     /* init or lock _recvpipe */
 277 #define RTV_SPIPE       0x10    /* init or lock _sendpipe */
 278 #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
 279 #define RTV_RTT         0x40    /* init or lock _rtt */
 280 #define RTV_RTTVAR      0x80    /* init or lock _rttvar */
 281
 282 /*
 283  * Bitmask values for rtm_addrs.
 284  */
 285 #define RTA_DST         0x1     /* destination sockaddr present */
 286 #define RTA_GATEWAY     0x2     /* gateway sockaddr present */
 287 #define RTA_NETMASK     0x4     /* netmask sockaddr present */
 288 #define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
 289 #define RTA_IFP         0x10    /* interface name sockaddr present */
 290 #define RTA_IFA         0x20    /* interface addr sockaddr present */
 291 #define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
 292 #define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
 293
 294 /*
 295  * Index offsets for sockaddr array for alternate internal encoding.
 296  */
 297 #define RTAX_DST        0       /* destination sockaddr present */
 298 #define RTAX_GATEWAY    1       /* gateway sockaddr present */
 299 #define RTAX_NETMASK    2       /* netmask sockaddr present */
 300 #define RTAX_GENMASK    3       /* cloning mask sockaddr present */
 301 #define RTAX_IFP        4       /* interface name sockaddr present */
 302 #define RTAX_IFA        5       /* interface addr sockaddr present */
 303 #define RTAX_AUTHOR     6       /* sockaddr for author of redirect */
 304 #define RTAX_BRD        7       /* for NEWADDR, broadcast or p-p dest addr */
 305 #define RTAX_MAX        8       /* size of array to allocate */
 306
 307 struct rt_addrinfo {
 308         int     rti_addrs;
 309         struct  sockaddr *rti_info[RTAX_MAX];
 310 };
 311
 312 struct route_cb {
 313         int     ip_count;
 314         int     ip6_count;
 315         int     ipx_count;
 316         int     ns_count;
 317         int     iso_count;
 318         int     any_count;
 319 };
 320
 321 #ifdef KERNEL_PRIVATE
 322 #define RTFREE(rt)      rtfree(rt)
 323 extern struct route_cb route_cb;
 324 extern struct radix_node_head *rt_tables[AF_MAX+1];
 325
 326 struct ifmultiaddr;
 327 struct proc;
 328
 329 void     route_init(void);
 330 void     rt_ifmsg(struct ifnet *);
 331 void     rt_missmsg(int, struct rt_addrinfo *, int, int);
 332 void     rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
 333 void     rt_newmaddrmsg(int, struct ifmultiaddr *);
 334 int      rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
 335 void     rtalloc(struct route *);
 336 void     rtalloc_ign(struct route *, u_long);
 337 struct rtentry *
 338          rtalloc1(struct sockaddr *, int, u_long);
 339 struct rtentry *
 340          rtalloc1_locked(const struct sockaddr *, int, u_long);
 341 void    rtfree(struct rtentry *);
 342 void    rtfree_locked(struct rtentry *);
 343 void    rtref(struct rtentry *);
 344 /*
 345  * rtunref will decrement the refcount, rtfree will decrement and free if
 346  * the refcount has reached zero and the route is not up.
 347  * Unless you have good reason to do otherwise, use rtfree.
 348  */
 349 void    rtunref(struct rtentry *);
 350 void    rtsetifa(struct rtentry *, struct ifaddr *);
 351 int      rtinit(struct ifaddr *, int, int);
 352 int      rtinit_locked(struct ifaddr *, int, int);
 353 int      rtioctl(int, caddr_t, struct proc *);
 354 void     rtredirect(struct sockaddr *, struct sockaddr *,
 355             struct sockaddr *, int, struct sockaddr *, struct rtentry **);
 356 int      rtrequest(int, struct sockaddr *,
 357             struct sockaddr *, struct sockaddr *, int, struct rtentry **);
 358 int      rtrequest_locked(int, struct sockaddr *,
 359             struct sockaddr *, struct sockaddr *, int, struct rtentry **);
 360 #endif KERNEL_PRIVATE
 361
 362 #endif