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 rib_head {
  36         struct radix_head       head;
  37         rn_matchaddr_f_t        *rnh_matchaddr; /* longest match for sockaddr */
  38         rn_addaddr_f_t          *rnh_addaddr;   /* add based on sockaddr*/
  39         rn_deladdr_f_t          *rnh_deladdr;   /* remove based on sockaddr */
  40         rn_lookup_f_t           *rnh_lookup;    /* exact match for sockaddr */
  41         rn_walktree_t           *rnh_walktree;  /* traverse tree */
  42         rn_walktree_from_t      *rnh_walktree_from; /* traverse tree below a */
  43         rn_close_t              *rnh_close;     /*do something when the last ref drops*/
  44         rt_gen_t                rnh_gen;        /* generation counter */
  45         int                     rnh_multipath;  /* multipath capable ? */
  46         struct radix_node       rnh_nodes[3];   /* empty tree for common case */
  47         struct rmlock           rib_lock;       /* config/data path lock */
  48         struct radix_mask_head  rmhead;         /* masks radix head */
  49         struct vnet             *rib_vnet;      /* vnet pointer */
  50         int                     rib_family;     /* AF of the rtable */
  51         u_int                   rib_fibnum;     /* fib number */
  52         struct callout          expire_callout; /* Callout for expiring dynamic routes */
  53         time_t                  next_expire;    /* Next expire run ts */
  54 };
  55
  56 #define RIB_RLOCK_TRACKER       struct rm_priotracker _rib_tracker
  57 #define RIB_LOCK_INIT(rh)       rm_init(&(rh)->rib_lock, "rib head lock")
  58 #define RIB_LOCK_DESTROY(rh)    rm_destroy(&(rh)->rib_lock)
  59 #define RIB_RLOCK(rh)           rm_rlock(&(rh)->rib_lock, &_rib_tracker)
  60 #define RIB_RUNLOCK(rh)         rm_runlock(&(rh)->rib_lock, &_rib_tracker)
  61 #define RIB_WLOCK(rh)           rm_wlock(&(rh)->rib_lock)
  62 #define RIB_WUNLOCK(rh)         rm_wunlock(&(rh)->rib_lock)
  63 #define RIB_LOCK_ASSERT(rh)     rm_assert(&(rh)->rib_lock, RA_LOCKED)
  64 #define RIB_WLOCK_ASSERT(rh)    rm_assert(&(rh)->rib_lock, RA_WLOCKED)
  65
  66 /* Macro for verifying fields in af-specific 'struct route' structures */
  67 #define CHK_STRUCT_FIELD_GENERIC(_s1, _f1, _s2, _f2)                    \
  68 _Static_assert(sizeof(((_s1 *)0)->_f1) == sizeof(((_s2 *)0)->_f2),      \
  69                 "Fields " #_f1 " and " #_f2 " size differs");           \
  70 _Static_assert(__offsetof(_s1, _f1) == __offsetof(_s2, _f2),            \
  71                 "Fields " #_f1 " and " #_f2 " offset differs");
  72
  73 #define _CHK_ROUTE_FIELD(_route_new, _field) \
  74         CHK_STRUCT_FIELD_GENERIC(struct route, _field, _route_new, _field)
  75
  76 #define CHK_STRUCT_ROUTE_FIELDS(_route_new)     \
  77         _CHK_ROUTE_FIELD(_route_new, ro_rt)     \
  78         _CHK_ROUTE_FIELD(_route_new, ro_lle)    \
  79         _CHK_ROUTE_FIELD(_route_new, ro_prepend)\
  80         _CHK_ROUTE_FIELD(_route_new, ro_plen)   \
  81         _CHK_ROUTE_FIELD(_route_new, ro_flags)  \
  82         _CHK_ROUTE_FIELD(_route_new, ro_mtu)    \
  83         _CHK_ROUTE_FIELD(_route_new, spare)
  84
  85 #define CHK_STRUCT_ROUTE_COMPAT(_ro_new, _dst_new)                              \
  86 CHK_STRUCT_ROUTE_FIELDS(_ro_new);                                               \
  87 _Static_assert(__offsetof(struct route, ro_dst) == __offsetof(_ro_new, _dst_new),\
  88                 "ro_dst and " #_dst_new " are at different offset")
  89
  90 struct rib_head *rt_tables_get_rnh(int fib, int family);
  91
  92 /* rte<>nhop translation */
  93 static inline uint16_t
  94 fib_rte_to_nh_flags(int rt_flags)
  95 {
  96         uint16_t res;
  97
  98         res = (rt_flags & RTF_REJECT) ? NHF_REJECT : 0;
  99         res |= (rt_flags & RTF_HOST) ? NHF_HOST : 0;
 100         res |= (rt_flags & RTF_BLACKHOLE) ? NHF_BLACKHOLE : 0;
 101         res |= (rt_flags & (RTF_DYNAMIC|RTF_MODIFIED)) ? NHF_REDIRECT : 0;
 102         res |= (rt_flags & RTF_BROADCAST) ? NHF_BROADCAST : 0;
 103         res |= (rt_flags & RTF_GATEWAY) ? NHF_GATEWAY : 0;
 104
 105         return (res);
 106 }
 107
 108 void tmproutes_update(struct rib_head *rnh, struct rtentry *rt);
 109 void tmproutes_init(struct rib_head *rh);
 110 void tmproutes_destroy(struct rib_head *rh);
 111
 112 #endif