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 struct nh_control;
  36 typedef int rnh_preadd_entry_f_t(u_int fibnum, const struct sockaddr *addr,
  37         const struct sockaddr *mask, struct nhop_object *nh);
  38
  39 struct rib_head {
  40         struct radix_head       head;
  41         rn_matchaddr_f_t        *rnh_matchaddr; /* longest match for sockaddr */
  42         rn_addaddr_f_t          *rnh_addaddr;   /* add based on sockaddr*/
  43         rn_deladdr_f_t          *rnh_deladdr;   /* remove based on sockaddr */
  44         rn_lookup_f_t           *rnh_lookup;    /* exact match for sockaddr */
  45         rn_walktree_t           *rnh_walktree;  /* traverse tree */
  46         rn_walktree_from_t      *rnh_walktree_from; /* traverse tree below a */
  47         rn_close_t              *rnh_close;     /*do something when the last ref drops*/
  48         rnh_preadd_entry_f_t    *rnh_preadd;    /* hook to alter record prior to insertion */
  49         rt_gen_t                rnh_gen;        /* generation counter */
  50         int                     rnh_multipath;  /* multipath capable ? */
  51         struct radix_node       rnh_nodes[3];   /* empty tree for common case */
  52         struct rmlock           rib_lock;       /* config/data path lock */
  53         struct radix_mask_head  rmhead;         /* masks radix head */
  54         struct vnet             *rib_vnet;      /* vnet pointer */
  55         int                     rib_family;     /* AF of the rtable */
  56         u_int                   rib_fibnum;     /* fib number */
  57         struct callout          expire_callout; /* Callout for expiring dynamic routes */
  58         time_t                  next_expire;    /* Next expire run ts */
  59         struct nh_control       *nh_control;    /* nexthop subsystem data */
  60 };
  61
  62 #define RIB_RLOCK_TRACKER       struct rm_priotracker _rib_tracker
  63 #define RIB_LOCK_INIT(rh)       rm_init(&(rh)->rib_lock, "rib head lock")
  64 #define RIB_LOCK_DESTROY(rh)    rm_destroy(&(rh)->rib_lock)
  65 #define RIB_RLOCK(rh)           rm_rlock(&(rh)->rib_lock, &_rib_tracker)
  66 #define RIB_RUNLOCK(rh)         rm_runlock(&(rh)->rib_lock, &_rib_tracker)
  67 #define RIB_WLOCK(rh)           rm_wlock(&(rh)->rib_lock)
  68 #define RIB_WUNLOCK(rh)         rm_wunlock(&(rh)->rib_lock)
  69 #define RIB_LOCK_ASSERT(rh)     rm_assert(&(rh)->rib_lock, RA_LOCKED)
  70 #define RIB_WLOCK_ASSERT(rh)    rm_assert(&(rh)->rib_lock, RA_WLOCKED)
  71
  72 /* Macro for verifying fields in af-specific 'struct route' structures */
  73 #define CHK_STRUCT_FIELD_GENERIC(_s1, _f1, _s2, _f2)                    \
  74 _Static_assert(sizeof(((_s1 *)0)->_f1) == sizeof(((_s2 *)0)->_f2),      \
  75                 "Fields " #_f1 " and " #_f2 " size differs");           \
  76 _Static_assert(__offsetof(_s1, _f1) == __offsetof(_s2, _f2),            \
  77                 "Fields " #_f1 " and " #_f2 " offset differs");
  78
  79 #define _CHK_ROUTE_FIELD(_route_new, _field) \
  80         CHK_STRUCT_FIELD_GENERIC(struct route, _field, _route_new, _field)
  81
  82 #define CHK_STRUCT_ROUTE_FIELDS(_route_new)     \
  83         _CHK_ROUTE_FIELD(_route_new, ro_nh)     \
  84         _CHK_ROUTE_FIELD(_route_new, ro_lle)    \
  85         _CHK_ROUTE_FIELD(_route_new, ro_prepend)\
  86         _CHK_ROUTE_FIELD(_route_new, ro_plen)   \
  87         _CHK_ROUTE_FIELD(_route_new, ro_flags)  \
  88         _CHK_ROUTE_FIELD(_route_new, ro_mtu)    \
  89         _CHK_ROUTE_FIELD(_route_new, spare)
  90
  91 #define CHK_STRUCT_ROUTE_COMPAT(_ro_new, _dst_new)                              \
  92 CHK_STRUCT_ROUTE_FIELDS(_ro_new);                                               \
  93 _Static_assert(__offsetof(struct route, ro_dst) == __offsetof(_ro_new, _dst_new),\
  94                 "ro_dst and " #_dst_new " are at different offset")
  95
  96 struct rib_head *rt_tables_get_rnh(int fib, int family);
  97 void rt_mpath_init_rnh(struct rib_head *rnh);
  98
  99 VNET_PCPUSTAT_DECLARE(struct rtstat, rtstat);
 100 #define RTSTAT_ADD(name, val)   \
 101         VNET_PCPUSTAT_ADD(struct rtstat, rtstat, name, (val))
 102 #define RTSTAT_INC(name)        RTSTAT_ADD(name, 1)
 103
 104 /*
 105  * With the split between the routing entry and the nexthop,
 106  *  rt_flags has to be split between these 2 entries. As rtentry
 107  *  mostly contains prefix data and is thought to be generic enough
 108  *  so one can transparently change the nexthop pointer w/o requiring
 109  *  any other rtentry changes, most of rt_flags shifts to the particular nexthop.
 110  * /
 111  *
 112  * RTF_UP: rtentry, as an indication that it is linked.
 113  * RTF_HOST: rtentry, nhop. The latter indication is needed for the datapath
 114  * RTF_DYNAMIC: nhop, to make rtentry generic.
 115  * RTF_MODIFIED: nhop, to make rtentry generic. (legacy)
 116  * -- "native" path (nhop) properties:
 117  * RTF_GATEWAY, RTF_STATIC, RTF_PROTO1, RTF_PROTO2, RTF_PROTO3, RTF_FIXEDMTU,
 118  *  RTF_PINNED, RTF_REJECT, RTF_BLACKHOLE, RTF_BROADCAST
 119  */
 120
 121 /* Nexthop rt flags mask */
 122 #define NHOP_RT_FLAG_MASK       (RTF_GATEWAY | RTF_HOST | RTF_REJECT | RTF_DYNAMIC | \
 123     RTF_MODIFIED | RTF_STATIC | RTF_BLACKHOLE | RTF_PROTO1 | RTF_PROTO2 | \
 124     RTF_PROTO3 | RTF_FIXEDMTU | RTF_PINNED | RTF_BROADCAST)
 125
 126 /* rtentry rt flag mask */
 127 #define RTE_RT_FLAG_MASK        (RTF_UP | RTF_HOST)
 128
 129 /* Nexthop selection */
 130 #define _NH2MP(_nh)     ((struct nhgrp_object *)(_nh))
 131 #define _SELECT_NHOP(_nh, _flowid)      \
 132         (_NH2MP(_nh))->nhops[(_flowid) % (_NH2MP(_nh))->mp_size]
 133 #define _RT_SELECT_NHOP(_nh, _flowid)   \
 134         ((!NH_IS_MULTIPATH(_nh)) ? (_nh) : _SELECT_NHOP(_nh, _flowid))
 135 #define RT_SELECT_NHOP(_rt, _flowid)    _RT_SELECT_NHOP((_rt)->rt_nhop, _flowid)
 136
 137 /* rte<>nhop translation */
 138 static inline uint16_t
 139 fib_rte_to_nh_flags(int rt_flags)
 140 {
 141         uint16_t res;
 142
 143         res = (rt_flags & RTF_REJECT) ? NHF_REJECT : 0;
 144         res |= (rt_flags & RTF_HOST) ? NHF_HOST : 0;
 145         res |= (rt_flags & RTF_BLACKHOLE) ? NHF_BLACKHOLE : 0;
 146         res |= (rt_flags & (RTF_DYNAMIC|RTF_MODIFIED)) ? NHF_REDIRECT : 0;
 147         res |= (rt_flags & RTF_BROADCAST) ? NHF_BROADCAST : 0;
 148         res |= (rt_flags & RTF_GATEWAY) ? NHF_GATEWAY : 0;
 149
 150         return (res);
 151 }
 152
 153 void tmproutes_update(struct rib_head *rnh, struct rtentry *rt);
 154 void tmproutes_init(struct rib_head *rh);
 155 void tmproutes_destroy(struct rib_head *rh);
 156
 157 #endif