sbin/routed/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  *
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef __RADIX_H_
  37 #define __RADIX_H_
  38
  39 #include <sys/cdefs.h>
  40 struct walkarg;
  41
  42 /*
  43  * Radix search tree node layout.
  44  */
  45
  46 struct radix_node {
  47         struct  radix_mask *rn_mklist;  /* list of masks contained in subtree */
  48         struct  radix_node *rn_p;       /* parent */
  49         short   rn_b;                   /* bit offset; -1-index(netmask) */
  50         char    rn_bmask;               /* node: mask for bit test*/
  51         u_char  rn_flags;               /* enumerated next */
  52 #define RNF_NORMAL      1               /* leaf contains normal route */
  53 #define RNF_ROOT        2               /* leaf is root leaf for tree */
  54 #define RNF_ACTIVE      4               /* This node is alive (for rtfree) */
  55         union {
  56                 struct {                        /* leaf only data: */
  57                         caddr_t rn_Key; /* object of search */
  58                         caddr_t rn_Mask;        /* netmask, if present */
  59                         struct  radix_node *rn_Dupedkey;
  60                 } rn_leaf;
  61                 struct {                        /* node only data: */
  62                         int     rn_Off;         /* where to start compare */
  63                         struct  radix_node *rn_L;/* progeny */
  64                         struct  radix_node *rn_R;/* progeny */
  65                 }rn_node;
  66         }               rn_u;
  67 #ifdef RN_DEBUG
  68         int rn_info;
  69         struct radix_node *rn_twin;
  70         struct radix_node *rn_ybro;
  71 #endif
  72 };
  73
  74 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
  75 #define rn_key rn_u.rn_leaf.rn_Key
  76 #define rn_mask rn_u.rn_leaf.rn_Mask
  77 #define rn_off rn_u.rn_node.rn_Off
  78 #define rn_l rn_u.rn_node.rn_L
  79 #define rn_r rn_u.rn_node.rn_R
  80
  81 /*
  82  * Annotations to tree concerning potential routes applying to subtrees.
  83  */
  84
  85 struct radix_mask {
  86         short   rm_b;                   /* bit offset; -1-index(netmask) */
  87         char    rm_unused;              /* cf. rn_bmask */
  88         u_char  rm_flags;               /* cf. rn_flags */
  89         struct  radix_mask *rm_mklist;  /* more masks to try */
  90         union   {
  91                 caddr_t rmu_mask;               /* the mask */
  92                 struct  radix_node *rmu_leaf;   /* for normal routes */
  93         }       rm_rmu;
  94         int     rm_refs;                /* # of references to this struct */
  95 };
  96
  97 #define rm_mask rm_rmu.rmu_mask
  98 #define rm_leaf rm_rmu.rmu_leaf         /* extra field would make 32 bytes */
  99
 100 #define MKGet(m) {\
 101         if (rn_mkfreelist) {\
 102                 m = rn_mkfreelist; \
 103                 rn_mkfreelist = (m)->rm_mklist; \
 104         } else \
 105                 m = (struct radix_mask *)rtmalloc(sizeof(*(m)), "MKGet"); }\
 106
 107 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
 108
 109 struct radix_node_head {
 110         struct  radix_node *rnh_treetop;
 111         int     rnh_addrsize;           /* permit, but not require fixed keys */
 112         int     rnh_pktsize;            /* permit, but not require fixed keys */
 113         struct  radix_node *(*rnh_addaddr)      /* add based on sockaddr */
 114                 (void *v, void *mask,
 115                      struct radix_node_head *head, struct radix_node nodes[]);
 116         struct  radix_node *(*rnh_addpkt)       /* add based on packet hdr */
 117                 (void *v, void *mask,
 118                      struct radix_node_head *head, struct radix_node nodes[]);
 119         struct  radix_node *(*rnh_deladdr)      /* remove based on sockaddr */
 120                 (void *v, void *mask, struct radix_node_head *head);
 121         struct  radix_node *(*rnh_delpkt)       /* remove based on packet hdr */
 122                 (void *v, void *mask, struct radix_node_head *head);
 123         struct  radix_node *(*rnh_matchaddr)    /* locate based on sockaddr */
 124                 (void *v, struct radix_node_head *head);
 125         struct  radix_node *(*rnh_lookup)       /* locate based on sockaddr */
 126                 (void *v, void *mask, struct radix_node_head *head);
 127         struct  radix_node *(*rnh_matchpkt)     /* locate based on packet hdr */
 128                 (void *v, struct radix_node_head *head);
 129         int     (*rnh_walktree)                 /* traverse tree */
 130                         (struct radix_node_head *head,
 131                          int (*f)(struct radix_node *, struct walkarg *),
 132                          struct walkarg *w);
 133         struct  radix_node rnh_nodes[3];        /* empty tree for common case */
 134 };
 135
 136
 137 #define Bcopy(a, b, n) memmove(((void *)(b)), ((void *)(a)), (size_t)(n))
 138 #define Bzero(p, n) memset((void *)(p), 0, (size_t)(n));
 139 #define Free(p) free((void *)p);
 140
 141 void     rn_init(void);
 142 int      rn_inithead(struct radix_node_head **head, int off);
 143 int      rn_walktree(struct radix_node_head *,
 144                      int (*)(struct radix_node *, struct walkarg *),
 145                      struct walkarg *);
 146
 147 #endif /* __RADIX_H_ */