The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System, Second Edition

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/net/route.h

Version: -  FREEBSD  -  FREEBSD10  -  FREEBSD9  -  FREEBSD92  -  FREEBSD91  -  FREEBSD90  -  FREEBSD8  -  FREEBSD82  -  FREEBSD81  -  FREEBSD80  -  FREEBSD7  -  FREEBSD74  -  FREEBSD73  -  FREEBSD72  -  FREEBSD71  -  FREEBSD70  -  FREEBSD6  -  FREEBSD64  -  FREEBSD63  -  FREEBSD62  -  FREEBSD61  -  FREEBSD60  -  FREEBSD5  -  FREEBSD55  -  FREEBSD54  -  FREEBSD53  -  FREEBSD52  -  FREEBSD51  -  FREEBSD50  -  FREEBSD4  -  FREEBSD3  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    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  * 4. Neither the name of the University nor the names of its contributors
   14  *    may be used to endorse or promote products derived from this software
   15  *    without specific prior written permission.
   16  *
   17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   27  * SUCH DAMAGE.
   28  *
   29  *      @(#)route.h     8.4 (Berkeley) 1/9/95
   30  * $FreeBSD: releng/7.3/sys/net/route.h 189026 2009-02-25 10:59:56Z rwatson $
   31  */
   32 
   33 #ifndef _NET_ROUTE_H_
   34 #define _NET_ROUTE_H_
   35 
   36 /*
   37  * Kernel resident routing tables.
   38  *
   39  * The routing tables are initialized when interface addresses
   40  * are set by making entries for all directly connected interfaces.
   41  */
   42 
   43 /*
   44  * A route consists of a destination address and a reference
   45  * to a routing entry.  These are often held by protocols
   46  * in their control blocks, e.g. inpcb.
   47  */
   48 struct route {
   49         struct  rtentry *ro_rt;
   50         struct  sockaddr ro_dst;
   51 };
   52 
   53 /*
   54  * These numbers are used by reliable protocols for determining
   55  * retransmission behavior and are included in the routing structure.
   56  */
   57 struct rt_metrics_lite {
   58         u_long  rmx_mtu;        /* MTU for this path */
   59         u_long  rmx_expire;     /* lifetime for route, e.g. redirect */
   60         u_long  rmx_pksent;     /* packets sent using this route */
   61 };
   62 
   63 struct rt_metrics {
   64         u_long  rmx_locks;      /* Kernel must leave these values alone */
   65         u_long  rmx_mtu;        /* MTU for this path */
   66         u_long  rmx_hopcount;   /* max hops expected */
   67         u_long  rmx_expire;     /* lifetime for route, e.g. redirect */
   68         u_long  rmx_recvpipe;   /* inbound delay-bandwidth product */
   69         u_long  rmx_sendpipe;   /* outbound delay-bandwidth product */
   70         u_long  rmx_ssthresh;   /* outbound gateway buffer limit */
   71         u_long  rmx_rtt;        /* estimated round trip time */
   72         u_long  rmx_rttvar;     /* estimated rtt variance */
   73         u_long  rmx_pksent;     /* packets sent using this route */
   74         u_long  rmx_filler[4];  /* will be used for T/TCP later */
   75 };
   76 
   77 /*
   78  * rmx_rtt and rmx_rttvar are stored as microseconds;
   79  * RTTTOPRHZ(rtt) converts to a value suitable for use
   80  * by a protocol slowtimo counter.
   81  */
   82 #define RTM_RTTUNIT     1000000 /* units for rtt, rttvar, as units per sec */
   83 #define RTTTOPRHZ(r)    ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
   84 
   85 extern u_int rt_numfibs;        /* number fo usable routing tables */
   86 extern u_int tunnel_fib;        /* tunnels use these */
   87 extern u_int fwd_fib;           /* packets being forwarded use these routes */
   88 /*
   89  * XXX kernel function pointer `rt_output' is visible to applications.
   90  */
   91 struct mbuf;
   92 
   93 /*
   94  * We distinguish between routes to hosts and routes to networks,
   95  * preferring the former if available.  For each route we infer
   96  * the interface to use from the gateway address supplied when
   97  * the route was entered.  Routes that forward packets through
   98  * gateways are marked so that the output routines know to address the
   99  * gateway rather than the ultimate destination.
  100  */
  101 #ifndef RNF_NORMAL
  102 #include <net/radix.h>
  103 #endif
  104 struct rtentry {
  105         struct  radix_node rt_nodes[2]; /* tree glue, and other values */
  106         /*
  107          * XXX struct rtentry must begin with a struct radix_node (or two!)
  108          * because the code does some casts of a 'struct radix_node *'
  109          * to a 'struct rtentry *'
  110          */
  111 #define rt_key(r)       (*((struct sockaddr **)(&(r)->rt_nodes->rn_key)))
  112 #define rt_mask(r)      (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask)))
  113         struct  sockaddr *rt_gateway;   /* value */
  114         u_long  rt_flags;               /* up/down?, host/net */
  115         struct  ifnet *rt_ifp;          /* the answer: interface to use */
  116         struct  ifaddr *rt_ifa;         /* the answer: interface address to use */
  117         struct  rt_metrics_lite rt_rmx; /* metrics used by rx'ing protocols */
  118         long    rt_refcnt;              /* # held references */
  119         struct  sockaddr *rt_genmask;   /* for generation of cloned routes */
  120         caddr_t rt_llinfo;              /* pointer to link level info cache */
  121         struct  rtentry *rt_gwroute;    /* implied entry for gatewayed routes */
  122         struct  rtentry *rt_parent;     /* cloning parent of this route */
  123         u_int   rt_fibnum;              /* which FIB */
  124 #ifdef _KERNEL
  125         /* XXX ugly, user apps use this definition but don't have a mtx def */
  126         struct  mtx rt_mtx;             /* mutex for routing entry */
  127 #endif
  128 };
  129 
  130 /*
  131  * Following structure necessary for 4.3 compatibility;
  132  * We should eventually move it to a compat file.
  133  */
  134 struct ortentry {
  135         u_long  rt_hash;                /* to speed lookups */
  136         struct  sockaddr rt_dst;        /* key */
  137         struct  sockaddr rt_gateway;    /* value */
  138         short   rt_flags;               /* up/down?, host/net */
  139         short   rt_refcnt;              /* # held references */
  140         u_long  rt_use;                 /* raw # packets forwarded */
  141         struct  ifnet *rt_ifp;          /* the answer: interface to use */
  142 };
  143 
  144 #define rt_use rt_rmx.rmx_pksent
  145 
  146 #define RTF_UP          0x1             /* route usable */
  147 #define RTF_GATEWAY     0x2             /* destination is a gateway */
  148 #define RTF_HOST        0x4             /* host entry (net otherwise) */
  149 #define RTF_REJECT      0x8             /* host or net unreachable */
  150 #define RTF_DYNAMIC     0x10            /* created dynamically (by redirect) */
  151 #define RTF_MODIFIED    0x20            /* modified dynamically (by redirect) */
  152 #define RTF_DONE        0x40            /* message confirmed */
  153 /*                      0x80               unused, was RTF_DELCLONE */
  154 #define RTF_CLONING     0x100           /* generate new routes on use */
  155 #define RTF_XRESOLVE    0x200           /* external daemon resolves name */
  156 #define RTF_LLINFO      0x400           /* generated by link layer (e.g. ARP) */
  157 #define RTF_STATIC      0x800           /* manually added */
  158 #define RTF_BLACKHOLE   0x1000          /* just discard pkts (during updates) */
  159 #define RTF_PROTO2      0x4000          /* protocol specific routing flag */
  160 #define RTF_PROTO1      0x8000          /* protocol specific routing flag */
  161 
  162 /* XXX: temporary to stay API/ABI compatible with userland */
  163 #ifndef _KERNEL
  164 #define RTF_PRCLONING   0x10000         /* unused, for compatibility */
  165 #endif
  166 
  167 #define RTF_WASCLONED   0x20000         /* route generated through cloning */
  168 #define RTF_PROTO3      0x40000         /* protocol specific routing flag */
  169 /*                      0x80000            unused */
  170 #define RTF_PINNED      0x100000        /* future use */
  171 #define RTF_LOCAL       0x200000        /* route represents a local address */
  172 #define RTF_BROADCAST   0x400000        /* route represents a bcast address */
  173 #define RTF_MULTICAST   0x800000        /* route represents a mcast address */
  174                                         /* 0x1000000 and up unassigned */
  175 #define RTF_RNH_LOCKED  0x40000000      /* radix node head locked by caller */
  176 
  177 /* Mask of RTF flags that are allowed to be modified by RTM_CHANGE. */
  178 #define RTF_FMASK       \
  179         (RTF_PROTO1 | RTF_PROTO2 | RTF_PROTO3 | RTF_BLACKHOLE | \
  180          RTF_REJECT | RTF_STATIC)
  181 
  182 /*
  183  * Routing statistics.
  184  */
  185 struct  rtstat {
  186         short   rts_badredirect;        /* bogus redirect calls */
  187         short   rts_dynamic;            /* routes created by redirects */
  188         short   rts_newgateway;         /* routes modified by redirects */
  189         short   rts_unreach;            /* lookups which failed */
  190         short   rts_wildcard;           /* lookups satisfied by a wildcard */
  191 };
  192 /*
  193  * Structures for routing messages.
  194  */
  195 struct rt_msghdr {
  196         u_short rtm_msglen;     /* to skip over non-understood messages */
  197         u_char  rtm_version;    /* future binary compatibility */
  198         u_char  rtm_type;       /* message type */
  199         u_short rtm_index;      /* index for associated ifp */
  200         int     rtm_flags;      /* flags, incl. kern & message, e.g. DONE */
  201         int     rtm_addrs;      /* bitmask identifying sockaddrs in msg */
  202         pid_t   rtm_pid;        /* identify sender */
  203         int     rtm_seq;        /* for sender to identify action */
  204         int     rtm_errno;      /* why failed */
  205         int     rtm_fmask;      /* bitmask used in RTM_CHANGE message */
  206 #define rtm_use rtm_fmask       /* deprecated, use rtm_rmx->rmx_pksent */
  207         u_long  rtm_inits;      /* which metrics we are initializing */
  208         struct  rt_metrics rtm_rmx; /* metrics themselves */
  209 };
  210 
  211 #define RTM_VERSION     5       /* Up the ante and ignore older versions */
  212 
  213 /*
  214  * Message types.
  215  */
  216 #define RTM_ADD         0x1     /* Add Route */
  217 #define RTM_DELETE      0x2     /* Delete Route */
  218 #define RTM_CHANGE      0x3     /* Change Metrics or flags */
  219 #define RTM_GET         0x4     /* Report Metrics */
  220 #define RTM_LOSING      0x5     /* Kernel Suspects Partitioning */
  221 #define RTM_REDIRECT    0x6     /* Told to use different route */
  222 #define RTM_MISS        0x7     /* Lookup failed on this address */
  223 #define RTM_LOCK        0x8     /* fix specified metrics */
  224 #define RTM_OLDADD      0x9     /* caused by SIOCADDRT */
  225 #define RTM_OLDDEL      0xa     /* caused by SIOCDELRT */
  226 #define RTM_RESOLVE     0xb     /* req to resolve dst to LL addr */
  227 #define RTM_NEWADDR     0xc     /* address being added to iface */
  228 #define RTM_DELADDR     0xd     /* address being removed from iface */
  229 #define RTM_IFINFO      0xe     /* iface going up/down etc. */
  230 #define RTM_NEWMADDR    0xf     /* mcast group membership being added to if */
  231 #define RTM_DELMADDR    0x10    /* mcast group membership being deleted */
  232 #define RTM_IFANNOUNCE  0x11    /* iface arrival/departure */
  233 #define RTM_IEEE80211   0x12    /* IEEE80211 wireless event */
  234 
  235 /*
  236  * Bitmask values for rtm_inits and rmx_locks.
  237  */
  238 #define RTV_MTU         0x1     /* init or lock _mtu */
  239 #define RTV_HOPCOUNT    0x2     /* init or lock _hopcount */
  240 #define RTV_EXPIRE      0x4     /* init or lock _expire */
  241 #define RTV_RPIPE       0x8     /* init or lock _recvpipe */
  242 #define RTV_SPIPE       0x10    /* init or lock _sendpipe */
  243 #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
  244 #define RTV_RTT         0x40    /* init or lock _rtt */
  245 #define RTV_RTTVAR      0x80    /* init or lock _rttvar */
  246 
  247 /*
  248  * Bitmask values for rtm_addrs.
  249  */
  250 #define RTA_DST         0x1     /* destination sockaddr present */
  251 #define RTA_GATEWAY     0x2     /* gateway sockaddr present */
  252 #define RTA_NETMASK     0x4     /* netmask sockaddr present */
  253 #define RTA_GENMASK     0x8     /* cloning mask sockaddr present */
  254 #define RTA_IFP         0x10    /* interface name sockaddr present */
  255 #define RTA_IFA         0x20    /* interface addr sockaddr present */
  256 #define RTA_AUTHOR      0x40    /* sockaddr for author of redirect */
  257 #define RTA_BRD         0x80    /* for NEWADDR, broadcast or p-p dest addr */
  258 
  259 /*
  260  * Index offsets for sockaddr array for alternate internal encoding.
  261  */
  262 #define RTAX_DST        0       /* destination sockaddr present */
  263 #define RTAX_GATEWAY    1       /* gateway sockaddr present */
  264 #define RTAX_NETMASK    2       /* netmask sockaddr present */
  265 #define RTAX_GENMASK    3       /* cloning mask sockaddr present */
  266 #define RTAX_IFP        4       /* interface name sockaddr present */
  267 #define RTAX_IFA        5       /* interface addr sockaddr present */
  268 #define RTAX_AUTHOR     6       /* sockaddr for author of redirect */
  269 #define RTAX_BRD        7       /* for NEWADDR, broadcast or p-p dest addr */
  270 #define RTAX_MAX        8       /* size of array to allocate */
  271 
  272 struct rt_addrinfo {
  273         int     rti_addrs;
  274         struct  sockaddr *rti_info[RTAX_MAX];
  275         int     rti_flags;
  276         struct  ifaddr *rti_ifa;
  277         struct  ifnet *rti_ifp;
  278 };
  279 
  280 /*
  281  * This macro returns the size of a struct sockaddr when passed
  282  * through a routing socket. Basically we round up sa_len to
  283  * a multiple of sizeof(long), with a minimum of sizeof(long).
  284  * The check for a NULL pointer is just a convenience, probably never used.
  285  * The case sa_len == 0 should only apply to empty structures.
  286  */
  287 #define SA_SIZE(sa)                                             \
  288     (  (!(sa) || ((struct sockaddr *)(sa))->sa_len == 0) ?      \
  289         sizeof(long)            :                               \
  290         1 + ( (((struct sockaddr *)(sa))->sa_len - 1) | (sizeof(long) - 1) ) )
  291 
  292 #ifdef _KERNEL
  293 
  294 #define RT_LOCK_INIT(_rt) \
  295         mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK)
  296 #define RT_LOCK(_rt)            mtx_lock(&(_rt)->rt_mtx)
  297 #define RT_TRYLOCK(_rt)         mtx_trylock(&(_rt)->rt_mtx)
  298 #define RT_UNLOCK(_rt)          mtx_unlock(&(_rt)->rt_mtx)
  299 #define RT_LOCK_DESTROY(_rt)    mtx_destroy(&(_rt)->rt_mtx)
  300 #define RT_LOCK_ASSERT(_rt)     mtx_assert(&(_rt)->rt_mtx, MA_OWNED)
  301 
  302 #define RT_ADDREF(_rt)  do {                                    \
  303         RT_LOCK_ASSERT(_rt);                                    \
  304         KASSERT((_rt)->rt_refcnt >= 0,                          \
  305                 ("negative refcnt %ld", (_rt)->rt_refcnt));     \
  306         (_rt)->rt_refcnt++;                                     \
  307 } while (0)
  308 #define RT_REMREF(_rt)  do {                                    \
  309         RT_LOCK_ASSERT(_rt);                                    \
  310         KASSERT((_rt)->rt_refcnt > 0,                           \
  311                 ("bogus refcnt %ld", (_rt)->rt_refcnt));        \
  312         (_rt)->rt_refcnt--;                                     \
  313 } while (0)
  314 
  315 #define RTFREE_LOCKED(_rt) do {                                 \
  316         if ((_rt)->rt_refcnt <= 1)                              \
  317                 rtfree(_rt);                                    \
  318         else {                                                  \
  319                 RT_REMREF(_rt);                                 \
  320                 RT_UNLOCK(_rt);                                 \
  321         }                                                       \
  322         /* guard against invalid refs */                        \
  323         _rt = 0;                                                \
  324 } while (0)
  325 #define RTFREE(_rt) do {                                        \
  326         RT_LOCK(_rt);                                           \
  327         RTFREE_LOCKED(_rt);                                     \
  328 } while (0)
  329 
  330 #define RT_TEMP_UNLOCK(_rt) do {                                \
  331         RT_ADDREF(_rt);                                         \
  332         RT_UNLOCK(_rt);                                         \
  333 } while (0)
  334 
  335 #define RT_RELOCK(_rt) do {                                     \
  336         RT_LOCK(_rt);                                           \
  337         if ((_rt)->rt_refcnt <= 1) {                            \
  338                 rtfree(_rt);                                    \
  339                 _rt = 0; /*  signal that it went away */        \
  340         } else {                                                \
  341                 RT_REMREF(_rt);                                 \
  342                 /* note that _rt is still valid */              \
  343         }                                                       \
  344 } while (0)
  345 
  346 extern struct radix_node_head *rt_tables[][AF_MAX+1];
  347 
  348 struct ifmultiaddr;
  349 
  350 void     rt_ieee80211msg(struct ifnet *, int, void *, size_t);
  351 void     rt_ifannouncemsg(struct ifnet *, int);
  352 void     rt_ifmsg(struct ifnet *);
  353 void     rt_missmsg(int, struct rt_addrinfo *, int, int);
  354 void     rt_newaddrmsg(int, struct ifaddr *, int, struct rtentry *);
  355 void     rt_newmaddrmsg(int, struct ifmultiaddr *);
  356 int      rt_setgate(struct rtentry *, struct sockaddr *, struct sockaddr *);
  357 
  358 /*
  359  * Note the following locking behavior:
  360  *
  361  *    rtalloc_ign() and rtalloc() return ro->ro_rt unlocked
  362  *
  363  *    rtalloc1() returns a locked rtentry
  364  *
  365  *    rtfree() and RTFREE_LOCKED() require a locked rtentry
  366  *
  367  *    RTFREE() uses an unlocked entry.
  368  */
  369 
  370 int      rtexpunge(struct rtentry *);
  371 void     rtfree(struct rtentry *);
  372 int      rt_check(struct rtentry **, struct rtentry **, struct sockaddr *);
  373 
  374 /* XXX MRT COMPAT VERSIONS THAT SET UNIVERSE to 0 */
  375 /* Thes are used by old code not yet converted to use multiple FIBS */
  376 int      rt_getifa(struct rt_addrinfo *);
  377 void     rtalloc_ign(struct route *ro, u_long ignflags);
  378 void     rtalloc(struct route *ro); /* XXX deprecated, use rtalloc_ign(ro, 0) */
  379 struct rtentry *rtalloc1(struct sockaddr *, int, u_long);
  380 int      rtinit(struct ifaddr *, int, int);
  381 int      rtioctl(u_long, caddr_t);
  382 void     rtredirect(struct sockaddr *, struct sockaddr *,
  383             struct sockaddr *, int, struct sockaddr *);
  384 int      rtrequest(int, struct sockaddr *,
  385             struct sockaddr *, struct sockaddr *, int, struct rtentry **);
  386 int      rtrequest1(int, struct rt_addrinfo *, struct rtentry **);
  387 
  388 /* defaults to "all" FIBs */
  389 int      rtinit_fib(struct ifaddr *, int, int);
  390 
  391 /* XXX MRT NEW VERSIONS THAT USE FIBs
  392  * For now the protocol indepedent versions are the same as the AF_INET ones
  393  * but this will change.. 
  394  */
  395 int      rt_getifa_fib(struct rt_addrinfo *, u_int fibnum);
  396 void     rtalloc_ign_fib(struct route *ro, u_long ignflags, u_int fibnum);
  397 void     rtalloc_fib(struct route *ro, u_int fibnum);
  398 struct rtentry *rtalloc1_fib(struct sockaddr *, int, u_long, u_int);
  399 int      rtioctl_fib(u_long, caddr_t, u_int);
  400 void     rtredirect_fib(struct sockaddr *, struct sockaddr *,
  401             struct sockaddr *, int, struct sockaddr *, u_int);
  402 int      rtrequest_fib(int, struct sockaddr *,
  403             struct sockaddr *, struct sockaddr *, int, struct rtentry **, u_int);
  404 int      rtrequest1_fib(int, struct rt_addrinfo *, struct rtentry **, u_int);
  405 
  406 #include <sys/eventhandler.h>
  407 typedef void (*rtevent_arp_update_fn)(void *, struct rtentry *, uint8_t *, struct sockaddr *);
  408 typedef void (*rtevent_redirect_fn)(void *, struct rtentry *, struct rtentry *, struct sockaddr *);
  409 EVENTHANDLER_DECLARE(route_arp_update_event, rtevent_arp_update_fn);
  410 EVENTHANDLER_DECLARE(route_redirect_event, rtevent_redirect_fn);
  411 #endif
  412 
  413 #endif

Cache object: 11630105bebd71b20438eeb6fc535591


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.