sbin/routed/radix.h

   1 /*      $NetBSD: radix.h,v 1.5 1998/10/25 14:56:08 christos Exp $       */
   2
   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. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgment:
  17  *      This product includes software developed by the University of
  18  *      California, Berkeley and its contributors.
  19  * 4. Neither the name of the University nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  *      @(#)radix.h     8.2 (Berkeley) 10/31/94
  36  */
  37
  38 #ifndef __RADIX_H_
  39 #define __RADIX_H_
  40
  41 #include <sys/cdefs.h>
  42 struct walkarg;
  43
  44 /*
  45  * Radix search tree node layout.
  46  */
  47
  48 struct radix_node {
  49         struct  radix_mask *rn_mklist;  /* list of masks contained in subtree */
  50         struct  radix_node *rn_p;       /* parent */
  51         short   rn_b;                   /* bit offset; -1-index(netmask) */
  52         char    rn_bmask;               /* node: mask for bit test*/
  53         u_char  rn_flags;               /* enumerated next */
  54 #define RNF_NORMAL      1               /* leaf contains normal route */
  55 #define RNF_ROOT        2               /* leaf is root leaf for tree */
  56 #define RNF_ACTIVE      4               /* This node is alive (for rtfree) */
  57         union {
  58                 struct {                        /* leaf only data: */
  59                         caddr_t rn_Key; /* object of search */
  60                         caddr_t rn_Mask;        /* netmask, if present */
  61                         struct  radix_node *rn_Dupedkey;
  62                 } rn_leaf;
  63                 struct {                        /* node only data: */
  64                         int     rn_Off;         /* where to start compare */
  65                         struct  radix_node *rn_L;/* progeny */
  66                         struct  radix_node *rn_R;/* progeny */
  67                 }rn_node;
  68         }               rn_u;
  69 #ifdef RN_DEBUG
  70         int rn_info;
  71         struct radix_node *rn_twin;
  72         struct radix_node *rn_ybro;
  73 #endif
  74 };
  75
  76 #define rn_dupedkey rn_u.rn_leaf.rn_Dupedkey
  77 #define rn_key rn_u.rn_leaf.rn_Key
  78 #define rn_mask rn_u.rn_leaf.rn_Mask
  79 #define rn_off rn_u.rn_node.rn_Off
  80 #define rn_l rn_u.rn_node.rn_L
  81 #define rn_r rn_u.rn_node.rn_R
  82
  83 /*
  84  * Annotations to tree concerning potential routes applying to subtrees.
  85  */
  86
  87 extern struct radix_mask {
  88         short   rm_b;                   /* bit offset; -1-index(netmask) */
  89         char    rm_unused;              /* cf. rn_bmask */
  90         u_char  rm_flags;               /* cf. rn_flags */
  91         struct  radix_mask *rm_mklist;  /* more masks to try */
  92         union   {
  93                 caddr_t rmu_mask;               /* the mask */
  94                 struct  radix_node *rmu_leaf;   /* for normal routes */
  95         }       rm_rmu;
  96         int     rm_refs;                /* # of references to this struct */
  97 } *rn_mkfreelist;
  98
  99 #define rm_mask rm_rmu.rmu_mask
 100 #define rm_leaf rm_rmu.rmu_leaf         /* extra field would make 32 bytes */
 101
 102 #define MKGet(m) {\
 103         if (rn_mkfreelist) {\
 104                 m = rn_mkfreelist; \
 105                 rn_mkfreelist = (m)->rm_mklist; \
 106         } else \
 107                 m = (struct radix_mask *)rtmalloc(sizeof(*(m)), "MKGet"); }\
 108
 109 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
 110
 111 struct radix_node_head {
 112         struct  radix_node *rnh_treetop;
 113         int     rnh_addrsize;           /* permit, but not require fixed keys */
 114         int     rnh_pktsize;            /* permit, but not require fixed keys */
 115         struct  radix_node *(*rnh_addaddr)      /* add based on sockaddr */
 116                 (void *v, void *mask,
 117                      struct radix_node_head *head, struct radix_node nodes[]);
 118         struct  radix_node *(*rnh_addpkt)       /* add based on packet hdr */
 119                 (void *v, void *mask,
 120                      struct radix_node_head *head, struct radix_node nodes[]);
 121         struct  radix_node *(*rnh_deladdr)      /* remove based on sockaddr */
 122                 (void *v, void *mask, struct radix_node_head *head);
 123         struct  radix_node *(*rnh_delpkt)       /* remove based on packet hdr */
 124                 (void *v, void *mask, struct radix_node_head *head);
 125         struct  radix_node *(*rnh_matchaddr)    /* locate based on sockaddr */
 126                 (void *v, struct radix_node_head *head);
 127         struct  radix_node *(*rnh_lookup)       /* locate based on sockaddr */
 128                 (void *v, void *mask, struct radix_node_head *head);
 129         struct  radix_node *(*rnh_matchpkt)     /* locate based on packet hdr */
 130                 (void *v, struct radix_node_head *head);
 131         int     (*rnh_walktree)                 /* traverse tree */
 132                         (struct radix_node_head *head,
 133                          int (*f)(struct radix_node *, struct walkarg *),
 134                          struct walkarg *w);
 135         struct  radix_node rnh_nodes[3];        /* empty tree for common case */
 136 };
 137
 138
 139 #define Bcmp(a, b, n) memcmp(((void *)(a)), ((void *)(b)), (n))
 140 #define Bcopy(a, b, n) memmove(((void *)(b)), ((void *)(a)), (size_t)(n))
 141 #define Bzero(p, n) memset((void *)(p), 0, (size_t)(n));
 142 #define Free(p) free((void *)p);
 143
 144 void     rn_init(void);
 145 int      rn_inithead(void **, int);
 146 int      rn_refines(void *, void *);
 147 int      rn_walktree(struct radix_node_head *,
 148                      int (*)(struct radix_node *, struct walkarg *),
 149                      struct walkarg *);
 150
 151 struct radix_node
 152          *rn_addmask(void *, int, int),
 153          *rn_addroute(void *, void *, struct radix_node_head *,
 154                         struct radix_node [2]),
 155          *rn_delete(void *, void *, struct radix_node_head *),
 156          *rn_insert(void *, struct radix_node_head *, int *,
 157                         struct radix_node [2]),
 158          *rn_match(void *, struct radix_node_head *),
 159          *rn_newpair(void *, int, struct radix_node[2]),
 160          *rn_search(void *, struct radix_node *),
 161          *rn_search_m(void *, struct radix_node *, void *);
 162
 163 struct radix_node *rn_lookup(void *, void *, struct radix_node_head *);
 164
 165 #endif /* __RADIX_H_ */