bsd/net/route.h

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