sys/net/route_var.h

   1 /*-
   2  * Copyright (c) 2015-2016
   3  *      Alexander V. Chernikov <melifaro@FreeBSD.org>
   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  * 3. 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  * $FreeBSD$
  30  */
  31
  32 #ifndef _NET_ROUTE_VAR_H_
  33 #define _NET_ROUTE_VAR_H_
  34
  35 #ifndef RNF_NORMAL
  36 #include <net/radix.h>
  37 #endif
  38 #include <sys/counter.h>
  39
  40 struct nh_control;
  41 typedef int rnh_preadd_entry_f_t(u_int fibnum, const struct sockaddr *addr,
  42         const struct sockaddr *mask, struct nhop_object *nh);
  43
  44 struct rib_head {
  45         struct radix_head       head;
  46         rn_matchaddr_f_t        *rnh_matchaddr; /* longest match for sockaddr */
  47         rn_addaddr_f_t          *rnh_addaddr;   /* add based on sockaddr*/
  48         rn_deladdr_f_t          *rnh_deladdr;   /* remove based on sockaddr */
  49         rn_lookup_f_t           *rnh_lookup;    /* exact match for sockaddr */
  50         rn_walktree_t           *rnh_walktree;  /* traverse tree */
  51         rn_walktree_from_t      *rnh_walktree_from; /* traverse tree below a */
  52         rn_close_t              *rnh_close;     /*do something when the last ref drops*/
  53         rnh_preadd_entry_f_t    *rnh_preadd;    /* hook to alter record prior to insertion */
  54         rt_gen_t                rnh_gen;        /* generation counter */
  55         int                     rnh_multipath;  /* multipath capable ? */
  56         struct radix_node       rnh_nodes[3];   /* empty tree for common case */
  57         struct rmlock           rib_lock;       /* config/data path lock */
  58         struct radix_mask_head  rmhead;         /* masks radix head */
  59         struct vnet             *rib_vnet;      /* vnet pointer */
  60         int                     rib_family;     /* AF of the rtable */
  61         u_int                   rib_fibnum;     /* fib number */
  62         struct callout          expire_callout; /* Callout for expiring dynamic routes */
  63         time_t                  next_expire;    /* Next expire run ts */
  64         struct nh_control       *nh_control;    /* nexthop subsystem data */
  65 };
  66
  67 #define RIB_RLOCK_TRACKER       struct rm_priotracker _rib_tracker
  68 #define RIB_LOCK_INIT(rh)       rm_init(&(rh)->rib_lock, "rib head lock")
  69 #define RIB_LOCK_DESTROY(rh)    rm_destroy(&(rh)->rib_lock)
  70 #define RIB_RLOCK(rh)           rm_rlock(&(rh)->rib_lock, &_rib_tracker)
  71 #define RIB_RUNLOCK(rh)         rm_runlock(&(rh)->rib_lock, &_rib_tracker)
  72 #define RIB_WLOCK(rh)           rm_wlock(&(rh)->rib_lock)
  73 #define RIB_WUNLOCK(rh)         rm_wunlock(&(rh)->rib_lock)
  74 #define RIB_LOCK_ASSERT(rh)     rm_assert(&(rh)->rib_lock, RA_LOCKED)
  75 #define RIB_WLOCK_ASSERT(rh)    rm_assert(&(rh)->rib_lock, RA_WLOCKED)
  76
  77 /* Macro for verifying fields in af-specific 'struct route' structures */
  78 #define CHK_STRUCT_FIELD_GENERIC(_s1, _f1, _s2, _f2)                    \
  79 _Static_assert(sizeof(((_s1 *)0)->_f1) == sizeof(((_s2 *)0)->_f2),      \
  80                 "Fields " #_f1 " and " #_f2 " size differs");           \
  81 _Static_assert(__offsetof(_s1, _f1) == __offsetof(_s2, _f2),            \
  82                 "Fields " #_f1 " and " #_f2 " offset differs");
  83
  84 #define _CHK_ROUTE_FIELD(_route_new, _field) \
  85         CHK_STRUCT_FIELD_GENERIC(struct route, _field, _route_new, _field)
  86
  87 #define CHK_STRUCT_ROUTE_FIELDS(_route_new)     \
  88         _CHK_ROUTE_FIELD(_route_new, ro_nh)     \
  89         _CHK_ROUTE_FIELD(_route_new, ro_lle)    \
  90         _CHK_ROUTE_FIELD(_route_new, ro_prepend)\
  91         _CHK_ROUTE_FIELD(_route_new, ro_plen)   \
  92         _CHK_ROUTE_FIELD(_route_new, ro_flags)  \
  93         _CHK_ROUTE_FIELD(_route_new, ro_mtu)    \
  94         _CHK_ROUTE_FIELD(_route_new, spare)
  95
  96 #define CHK_STRUCT_ROUTE_COMPAT(_ro_new, _dst_new)                              \
  97 CHK_STRUCT_ROUTE_FIELDS(_ro_new);                                               \
  98 _Static_assert(__offsetof(struct route, ro_dst) == __offsetof(_ro_new, _dst_new),\
  99                 "ro_dst and " #_dst_new " are at different offset")
 100
 101 struct rib_head *rt_tables_get_rnh(int fib, int family);
 102 void rt_mpath_init_rnh(struct rib_head *rnh);
 103
 104 VNET_PCPUSTAT_DECLARE(struct rtstat, rtstat);
 105 #define RTSTAT_ADD(name, val)   \
 106         VNET_PCPUSTAT_ADD(struct rtstat, rtstat, name, (val))
 107 #define RTSTAT_INC(name)        RTSTAT_ADD(name, 1)
 108
 109 struct rtentry {
 110         struct  radix_node rt_nodes[2]; /* tree glue, and other values */
 111         /*
 112          * XXX struct rtentry must begin with a struct radix_node (or two!)
 113          * because the code does some casts of a 'struct radix_node *'
 114          * to a 'struct rtentry *'
 115          */
 116 #define rt_key(r)       (*((struct sockaddr **)(&(r)->rt_nodes->rn_key)))
 117 #define rt_mask(r)      (*((struct sockaddr **)(&(r)->rt_nodes->rn_mask)))
 118 #define rt_key_const(r)         (*((const struct sockaddr * const *)(&(r)->rt_nodes->rn_key)))
 119 #define rt_mask_const(r)        (*((const struct sockaddr * const *)(&(r)->rt_nodes->rn_mask)))
 120         struct  sockaddr *rt_gateway;   /* value */
 121         struct  ifnet *rt_ifp;          /* the answer: interface to use */
 122         struct  ifaddr *rt_ifa;         /* the answer: interface address to use */
 123         struct nhop_object      *rt_nhop;       /* nexthop data */
 124         int             rt_flags;       /* up/down?, host/net */
 125         int             rt_refcnt;      /* # held references */
 126         u_int           rt_fibnum;      /* which FIB */
 127         u_long          rt_mtu;         /* MTU for this path */
 128         u_long          rt_weight;      /* absolute weight */
 129         u_long          rt_expire;      /* lifetime for route, e.g. redirect */
 130 #define rt_endzero      rt_pksent
 131         counter_u64_t   rt_pksent;      /* packets sent using this route */
 132         struct mtx      rt_mtx;         /* mutex for routing entry */
 133         struct rtentry  *rt_chain;      /* pointer to next rtentry to delete */
 134 };
 135
 136 #define RT_LOCK_INIT(_rt) \
 137         mtx_init(&(_rt)->rt_mtx, "rtentry", NULL, MTX_DEF | MTX_DUPOK | MTX_NEW)
 138 #define RT_LOCK(_rt)            mtx_lock(&(_rt)->rt_mtx)
 139 #define RT_UNLOCK(_rt)          mtx_unlock(&(_rt)->rt_mtx)
 140 #define RT_LOCK_DESTROY(_rt)    mtx_destroy(&(_rt)->rt_mtx)
 141 #define RT_LOCK_ASSERT(_rt)     mtx_assert(&(_rt)->rt_mtx, MA_OWNED)
 142 #define RT_UNLOCK_COND(_rt)     do {                            \
 143         if (mtx_owned(&(_rt)->rt_mtx))                          \
 144                 mtx_unlock(&(_rt)->rt_mtx);                     \
 145 } while (0)
 146
 147 #define RT_ADDREF(_rt)  do {                                    \
 148         RT_LOCK_ASSERT(_rt);                                    \
 149         KASSERT((_rt)->rt_refcnt >= 0,                          \
 150                 ("negative refcnt %d", (_rt)->rt_refcnt));      \
 151         (_rt)->rt_refcnt++;                                     \
 152 } while (0)
 153
 154 #define RT_REMREF(_rt)  do {                                    \
 155         RT_LOCK_ASSERT(_rt);                                    \
 156         KASSERT((_rt)->rt_refcnt > 0,                           \
 157                 ("bogus refcnt %d", (_rt)->rt_refcnt)); \
 158         (_rt)->rt_refcnt--;                                     \
 159 } while (0)
 160
 161 #define RTFREE_LOCKED(_rt) do {                                 \
 162         if ((_rt)->rt_refcnt <= 1)                              \
 163                 rtfree(_rt);                                    \
 164         else {                                                  \
 165                 RT_REMREF(_rt);                                 \
 166                 RT_UNLOCK(_rt);                                 \
 167         }                                                       \
 168         /* guard against invalid refs */                        \
 169         _rt = 0;                                                \
 170 } while (0)
 171
 172 #define RTFREE(_rt) do {                                        \
 173         RT_LOCK(_rt);                                           \
 174         RTFREE_LOCKED(_rt);                                     \
 175 } while (0)
 176
 177 /*
 178  * With the split between the routing entry and the nexthop,
 179  *  rt_flags has to be split between these 2 entries. As rtentry
 180  *  mostly contains prefix data and is thought to be generic enough
 181  *  so one can transparently change the nexthop pointer w/o requiring
 182  *  any other rtentry changes, most of rt_flags shifts to the particular nexthop.
 183  * /
 184  *
 185  * RTF_UP: rtentry, as an indication that it is linked.
 186  * RTF_HOST: rtentry, nhop. The latter indication is needed for the datapath
 187  * RTF_DYNAMIC: nhop, to make rtentry generic.
 188  * RTF_MODIFIED: nhop, to make rtentry generic. (legacy)
 189  * -- "native" path (nhop) properties:
 190  * RTF_GATEWAY, RTF_STATIC, RTF_PROTO1, RTF_PROTO2, RTF_PROTO3, RTF_FIXEDMTU,
 191  *  RTF_PINNED, RTF_REJECT, RTF_BLACKHOLE, RTF_BROADCAST
 192  */
 193
 194 /* Nexthop rt flags mask */
 195 #define NHOP_RT_FLAG_MASK       (RTF_GATEWAY | RTF_HOST | RTF_REJECT | RTF_DYNAMIC | \
 196     RTF_MODIFIED | RTF_STATIC | RTF_BLACKHOLE | RTF_PROTO1 | RTF_PROTO2 | \
 197     RTF_PROTO3 | RTF_FIXEDMTU | RTF_PINNED | RTF_BROADCAST)
 198
 199 /* rtentry rt flag mask */
 200 #define RTE_RT_FLAG_MASK        (RTF_UP | RTF_HOST)
 201
 202 /* Nexthop selection */
 203 #define _NH2MP(_nh)     ((struct nhgrp_object *)(_nh))
 204 #define _SELECT_NHOP(_nh, _flowid)      \
 205         (_NH2MP(_nh))->nhops[(_flowid) % (_NH2MP(_nh))->mp_size]
 206 #define _RT_SELECT_NHOP(_nh, _flowid)   \
 207         ((!NH_IS_MULTIPATH(_nh)) ? (_nh) : _SELECT_NHOP(_nh, _flowid))
 208 #define RT_SELECT_NHOP(_rt, _flowid)    _RT_SELECT_NHOP((_rt)->rt_nhop, _flowid)
 209
 210 /* rte<>nhop translation */
 211 static inline uint16_t
 212 fib_rte_to_nh_flags(int rt_flags)
 213 {
 214         uint16_t res;
 215
 216         res = (rt_flags & RTF_REJECT) ? NHF_REJECT : 0;
 217         res |= (rt_flags & RTF_HOST) ? NHF_HOST : 0;
 218         res |= (rt_flags & RTF_BLACKHOLE) ? NHF_BLACKHOLE : 0;
 219         res |= (rt_flags & (RTF_DYNAMIC|RTF_MODIFIED)) ? NHF_REDIRECT : 0;
 220         res |= (rt_flags & RTF_BROADCAST) ? NHF_BROADCAST : 0;
 221         res |= (rt_flags & RTF_GATEWAY) ? NHF_GATEWAY : 0;
 222
 223         return (res);
 224 }
 225
 226 void tmproutes_update(struct rib_head *rnh, struct rtentry *rt);
 227 void tmproutes_init(struct rib_head *rh);
 228 void tmproutes_destroy(struct rib_head *rh);
 229
 230 #endif