sys/net/radix.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1988, 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)radix.h     8.2 (Berkeley) 10/31/94
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _RADIX_H_
  36 #define _RADIX_H_
  37
  38 #ifdef _KERNEL
  39 #include <sys/_lock.h>
  40 #include <sys/_mutex.h>
  41 #include <sys/_rmlock.h>
  42 #endif
  43
  44 #ifdef MALLOC_DECLARE
  45 MALLOC_DECLARE(M_RTABLE);
  46 #endif
  47
  48 /*
  49  * Radix search tree node layout.
  50  */
  51
  52 struct radix_node {
  53         struct  radix_mask *rn_mklist;  /* list of masks contained in subtree */
  54         struct  radix_node *rn_parent;  /* parent */
  55         short   rn_bit;                 /* bit offset; -1-index(netmask) */
  56         char    rn_bmask;               /* node: mask for bit test*/
  57         u_char  rn_flags;               /* enumerated next */
  58 #define RNF_NORMAL      1               /* leaf contains normal route */
  59 #define RNF_ROOT        2               /* leaf is root leaf for tree */
  60 #define RNF_ACTIVE      4               /* This node is alive (for rtfree) */
  61         union {
  62                 struct {                        /* leaf only data: */
  63                         caddr_t rn_Key;         /* object of search */
  64                         caddr_t rn_Mask;        /* netmask, if present */
  65                         struct  radix_node *rn_Dupedkey;
  66                 } rn_leaf;
  67                 struct {                        /* node only data: */
  68                         int     rn_Off;         /* where to start compare */
  69                         struct  radix_node *rn_L;/* progeny */
  70                         struct  radix_node *rn_R;/* progeny */
  71                 } rn_node;
  72         }               rn_u;
  73 #ifdef RN_DEBUG
  74         int rn_info;
  75         struct radix_node *rn_twin;
  76         struct radix_node *rn_ybro;
  77 #endif
  78 };
  79
  80 #define rn_dupedkey     rn_u.rn_leaf.rn_Dupedkey
  81 #define rn_key          rn_u.rn_leaf.rn_Key
  82 #define rn_mask         rn_u.rn_leaf.rn_Mask
  83 #define rn_offset       rn_u.rn_node.rn_Off
  84 #define rn_left         rn_u.rn_node.rn_L
  85 #define rn_right        rn_u.rn_node.rn_R
  86
  87 /*
  88  * Annotations to tree concerning potential routes applying to subtrees.
  89  */
  90
  91 struct radix_mask {
  92         short   rm_bit;                 /* bit offset; -1-index(netmask) */
  93         char    rm_unused;              /* cf. rn_bmask */
  94         u_char  rm_flags;               /* cf. rn_flags */
  95         struct  radix_mask *rm_mklist;  /* more masks to try */
  96         union   {
  97                 caddr_t rmu_mask;               /* the mask */
  98                 struct  radix_node *rmu_leaf;   /* for normal routes */
  99         }       rm_rmu;
 100         int     rm_refs;                /* # of references to this struct */
 101 };
 102
 103 #define rm_mask rm_rmu.rmu_mask
 104 #define rm_leaf rm_rmu.rmu_leaf         /* extra field would make 32 bytes */
 105
 106 struct radix_head;
 107
 108 typedef int walktree_f_t(struct radix_node *, void *);
 109 typedef struct radix_node *rn_matchaddr_f_t(void *v,
 110     struct radix_head *head);
 111 typedef struct radix_node *rn_addaddr_f_t(void *v, void *mask,
 112     struct radix_head *head, struct radix_node nodes[]);
 113 typedef struct radix_node *rn_deladdr_f_t(void *v, void *mask,
 114     struct radix_head *head);
 115 typedef struct radix_node *rn_lookup_f_t(void *v, void *mask,
 116     struct radix_head *head);
 117 typedef int rn_walktree_t(struct radix_head *head, walktree_f_t *f,
 118     void *w);
 119 typedef int rn_walktree_from_t(struct radix_head *head,
 120     void *a, void *m, walktree_f_t *f, void *w);
 121 typedef void rn_close_t(struct radix_node *rn, struct radix_head *head);
 122
 123 struct radix_mask_head;
 124
 125 struct radix_head {
 126         struct  radix_node *rnh_treetop;
 127         struct  radix_mask_head *rnh_masks;     /* Storage for our masks */
 128 };
 129
 130 struct radix_node_head {
 131         struct radix_head rh;
 132         rn_matchaddr_f_t        *rnh_matchaddr; /* longest match for sockaddr */
 133         rn_addaddr_f_t  *rnh_addaddr;   /* add based on sockaddr*/
 134         rn_deladdr_f_t  *rnh_deladdr;   /* remove based on sockaddr */
 135         rn_lookup_f_t   *rnh_lookup;    /* exact match for sockaddr */
 136         rn_walktree_t   *rnh_walktree;  /* traverse tree */
 137         rn_walktree_from_t      *rnh_walktree_from; /* traverse tree below a */
 138         rn_close_t      *rnh_close;     /*do something when the last ref drops*/
 139         struct  radix_node rnh_nodes[3];        /* empty tree for common case */
 140 #ifdef _KERNEL
 141         struct  rmlock rnh_lock;                /* locks entire radix tree */
 142 #endif
 143 };
 144
 145 struct radix_mask_head {
 146         struct radix_head head;
 147         struct radix_node mask_nodes[3];
 148 };
 149
 150 void rn_inithead_internal(struct radix_head *rh, struct radix_node *base_nodes,
 151     int off);
 152
 153 #ifndef _KERNEL
 154 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n)))
 155 #define R_Zalloc(p, t, n) (p = (t) calloc(1,(unsigned int)(n)))
 156 #define R_Free(p) free((char *)p);
 157 #else
 158 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT))
 159 #define R_Zalloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_NOWAIT | M_ZERO))
 160 #define R_Free(p) free((caddr_t)p, M_RTABLE);
 161
 162 #define RADIX_NODE_HEAD_RLOCK_TRACKER   struct rm_priotracker _rnh_tracker
 163 #define RADIX_NODE_HEAD_LOCK_INIT(rnh)  \
 164     rm_init(&(rnh)->rnh_lock, "radix node head")
 165 #define RADIX_NODE_HEAD_LOCK(rnh)       rm_wlock(&(rnh)->rnh_lock)
 166 #define RADIX_NODE_HEAD_UNLOCK(rnh)     rm_wunlock(&(rnh)->rnh_lock)
 167 #define RADIX_NODE_HEAD_RLOCK(rnh)      rm_rlock(&(rnh)->rnh_lock,\
 168     &_rnh_tracker)
 169 #define RADIX_NODE_HEAD_RUNLOCK(rnh)    rm_runlock(&(rnh)->rnh_lock,\
 170     &_rnh_tracker)
 171 #define RADIX_NODE_HEAD_DESTROY(rnh)    rm_destroy(&(rnh)->rnh_lock)
 172 #define RADIX_NODE_HEAD_LOCK_ASSERT(rnh) rm_assert(&(rnh)->rnh_lock, RA_LOCKED)
 173 #define RADIX_NODE_HEAD_WLOCK_ASSERT(rnh) rm_assert(&(rnh)->rnh_lock, RA_WLOCKED)
 174 #endif /* _KERNEL */
 175
 176 int      rn_inithead(void **, int);
 177 int      rn_detachhead(void **);
 178 int      rn_refines(void *, void *);
 179 struct radix_node *rn_addroute(void *, void *, struct radix_head *,
 180     struct radix_node[2]);
 181 struct radix_node *rn_delete(void *, void *, struct radix_head *);
 182 struct radix_node *rn_lookup (void *v_arg, void *m_arg,
 183     struct radix_head *head);
 184 struct radix_node *rn_match(void *, struct radix_head *);
 185 int rn_walktree_from(struct radix_head *h, void *a, void *m,
 186     walktree_f_t *f, void *w);
 187 int rn_walktree(struct radix_head *, walktree_f_t *, void *);
 188
 189 #endif /* _RADIX_H_ */