include/net/route.h

   1 /*
   2  * Copyright (c) 1991, 2010, Oracle and/or its affiliates. All rights reserved.
   3  */
   4 /*
   5  * Copyright (c) 1980, 1986, 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  */
  36
  37 /*
  38  * Kernel resident routing tables.
  39  *
  40  * The routing tables are initialized when interface addresses
  41  * are set by making entries for all directly connected interfaces.
  42  */
  43
  44 #ifndef _NET_ROUTE_H
  45 #define _NET_ROUTE_H
  46
  47 /* from UCB 8.5 (Berkeley) 2/8/95 */
  48
  49 #ifdef  __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 /*
  54  * A route consists of a destination address and a reference
  55  * to a routing entry.  These are often held by protocols
  56  * in their control blocks, e.g. inpcb.
  57  */
  58 struct route {
  59         struct  rtentry *ro_rt;
  60         struct  sockaddr ro_dst;
  61 };
  62
  63 /*
  64  * These numbers are used by reliable protocols for determining
  65  * retransmission behavior and are included in the routing structure.
  66  *
  67  * rmx_rtt and rmx_rttvar are stored as microseconds;
  68  */
  69 typedef struct rt_metrics {
  70         uint32_t        rmx_locks;      /* Kernel must leave these values */
  71                                         /* alone */
  72         uint32_t        rmx_mtu;        /* MTU for this path */
  73         uint32_t        rmx_hopcount;   /* max hops expected */
  74         uint32_t        rmx_expire;     /* lifetime for route, e.g. redirect */
  75         uint32_t        rmx_recvpipe;   /* inbound delay-bandwith product */
  76         uint32_t        rmx_sendpipe;   /* outbound delay-bandwith product */
  77         uint32_t        rmx_ssthresh;   /* outbound gateway buffer limit */
  78         uint32_t        rmx_rtt;        /* estimated round trip time */
  79         uint32_t        rmx_rttvar;     /* estimated rtt variance */
  80         uint32_t        rmx_pksent;     /* packets sent using this route */
  81 } rt_metrics_t;
  82
  83 /*
  84  * OLD rtentry structure not used in the kernel. Instead the kernel
  85  * uses struct ire defined in <inet/ip.h>.
  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 struct rtentry {
  95         uint_t  rt_hash;                /* to speed lookups */
  96         struct  sockaddr rt_dst;        /* key */
  97         struct  sockaddr rt_gateway;    /* value */
  98         short   rt_flags;               /* up/down?, host/net */
  99         short   rt_refcnt;              /* # held references */
 100         uint_t  rt_use;                 /* raw # packets forwarded */
 101
 102 /*
 103  * The kernel does not use this field, and without it the structure is
 104  * datamodel independent.
 105  */
 106 #if !defined(_KERNEL)
 107         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 108 #endif /* !defined(_KERNEL) */
 109 };
 110
 111 #define RTF_UP          0x1             /* route usable */
 112 #define RTF_GATEWAY     0x2             /* destination is a gateway */
 113 #define RTF_HOST        0x4             /* host entry (net otherwise) */
 114 #define RTF_REJECT      0x8             /* host or net unreachable */
 115 #define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
 116 #define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
 117 #define RTF_DONE        0x40            /* message confirmed */
 118 #define RTF_MASK        0x80            /* subnet mask present */
 119 #define RTF_CLONING     0x100           /* generate new routes on use */
 120 #define RTF_XRESOLVE    0x200           /* external daemon resolves name */
 121 #define RTF_LLINFO      0x400           /* generated by ARP or ESIS */
 122 #define RTF_STATIC      0x800           /* manually added */
 123 #define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
 124 #define RTF_PRIVATE     0x2000          /* do not advertise this route */
 125 #define RTF_PROTO2      0x4000          /* protocol specific routing flag */
 126 #define RTF_PROTO1      0x8000          /* protocol specific routing flag */
 127 #define RTF_SETSRC      0x20000         /* set default outgoing src address */
 128 #define RTF_INDIRECT    0x40000         /* gateway not directly reachable */
 129 #define RTF_KERNEL      0x80000         /* created by kernel; can't delete */
 130 #define RTF_ZONE        0x100000        /* (NGZ only) route from global zone */
 131
 132 /*
 133  * OLD statistics not used by the kernel. The kernel uses <inet/mib2.h>.
 134  *
 135  * Routing statistics.
 136  */
 137 struct  rtstat {
 138         short   rts_badredirect;        /* bogus redirect calls */
 139         short   rts_dynamic;            /* routes created by redirects */
 140         short   rts_newgateway;         /* routes modified by redirects */
 141         short   rts_unreach;            /* lookups which failed */
 142         short   rts_wildcard;           /* lookups satisfied by a wildcard */
 143 };
 144
 145 /*
 146  * Structures for routing messages.
 147  */
 148 typedef struct rt_msghdr {
 149         ushort_t rtm_msglen;    /* to skip over non-understood messages */
 150         uchar_t rtm_version;    /* future binary compatibility */
 151         uchar_t rtm_type;       /* message type */
 152         ushort_t rtm_index;     /* index for associated ifp */
 153         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
 154         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
 155         pid_t   rtm_pid;        /* identify sender */
 156         int     rtm_seq;        /* for sender to identify action */
 157         int     rtm_errno;      /* why failed */
 158         int     rtm_use;        /* from rtentry */
 159         uint_t  rtm_inits;      /* which metrics we are initializing */
 160         struct  rt_metrics rtm_rmx; /* metrics themselves */
 161 } rt_msghdr_t;
 162
 163 #define RTM_VERSION     3       /* Up the ante and ignore older versions */
 164
 165 #define RTM_ADD         0x1     /* Add Route */
 166 #define RTM_DELETE      0x2     /* Delete Route */
 167 #define RTM_CHANGE      0x3     /* Change Metrics or flags */
 168 #define RTM_GET         0x4     /* Report Metrics */
 169 #define RTM_LOSING      0x5     /* Kernel Suspects Partitioning */
 170 #define RTM_REDIRECT    0x6     /* Told to use different route */
 171 #define RTM_MISS        0x7     /* Lookup failed on this address */
 172 #define RTM_LOCK        0x8     /* fix specified metrics */
 173 #define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
 174 #define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
 175 #define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
 176 #define RTM_NEWADDR     0xc     /* address being added to iface */
 177 #define RTM_DELADDR     0xd     /* address being removed from iface */
 178 #define RTM_IFINFO      0xe     /* iface going up/down etc. */
 179 #define RTM_CHGADDR     0xf     /* address added/changed (even while down) */
 180 #define RTM_FREEADDR    0x10    /* address removed (even while down) */
 181
 182 #define RTV_MTU         0x1     /* init or lock _mtu */
 183 #define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
 184 #define RTV_EXPIRE      0x4     /* init or lock _expire */
 185 #define RTV_RPIPE       0x8     /* init or lock _recvpipe */
 186 #define RTV_SPIPE       0x10    /* init or lock _sendpipe */
 187 #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
 188 #define RTV_RTT         0x40    /* init or lock _rtt */
 189 #define RTV_RTTVAR      0x80    /* init or lock _rttvar */
 190
 191 /*
 192  * Bitmask values for rtm_addr.
 193  */
 194 #define RTA_DST         0x1     /* destination sockaddr present */
 195 #define RTA_GATEWAY     0x2     /* gateway sockaddr present */
 196 #define RTA_NETMASK     0x4     /* netmask sockaddr present */
 197 #define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
 198 #define RTA_IFP         0x10    /* interface name sockaddr present */
 199 #define RTA_IFA         0x20    /* interface addr sockaddr present */
 200 #define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
 201 #define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
 202 #define RTA_SRC         0x100   /* source sockaddr present */
 203
 204 #define RTA_NUMBITS     9       /* Number of bits used in RTA_* */
 205
 206 /*
 207  * Index offsets for sockaddr_storage array for alternate internal encoding.
 208  * There should be an RTAX_* associated with each RTA_*.
 209  */
 210 #define RTAX_DST        0
 211 #define RTAX_GATEWAY    1
 212 #define RTAX_NETMASK    2
 213 #define RTAX_GENMASK    3
 214 #define RTAX_IFP        4
 215 #define RTAX_IFA        5
 216 #define RTAX_AUTHOR     6
 217 #define RTAX_BRD        7
 218 #define RTAX_SRC        8
 219 #define RTAX_MAX        RTA_NUMBITS     /* size of array to allocate */
 220
 221 /*
 222  * Routing socket message extension after sockaddrs.
 223  */
 224 typedef struct rtm_ext_s {
 225         uint32_t        rtmex_type;     /* identifier for type of extension */
 226         uint32_t        rtmex_len;      /* length of this extension */
 227 } rtm_ext_t;
 228
 229 /*
 230  * Routing socket options.
 231  */
 232 #define RT_AWARE        0x0001  /* set awareness of hidden interfaces */
 233
 234 /*
 235  * Supported RT_AWARE values.  As a convenience, the bit-values here mirror
 236  * the LIFC_* values.
 237  */
 238 #define RTAW_DEFAULT    0x0000  /* unaware application */
 239 #define RTAW_UNDER_IPMP 0x0010  /* aware of underlying IPMP interfaces */
 240
 241 #ifdef  __cplusplus
 242 }
 243 #endif
 244
 245 #endif  /* _NET_ROUTE_H */