include/radix.h

   1 /*
   2  * $Id: radix.h,v 1.18 2003/10/20 12:33:03 robertc Exp $
   3  */
   4 #ifndef SQUID_RADIX_H
   5 #define SQUID_RADIX_H
   6
   7 #include "config.h"
   8
   9 /*
  10  * Copyright (c) 1988, 1989, 1993
  11  *      The Regents of the University of California.  All rights reserved.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. All advertising materials mentioning features or use of this software
  22  *    must display the following acknowledgement:
  23  *      This product includes software developed by the University of
  24  *      California, Berkeley and its contributors.
  25  * 4. Neither the name of the University nor the names of its contributors
  26  *    may be used to endorse or promote products derived from this software
  27  *    without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  39  * SUCH DAMAGE.
  40  *
  41  *      @(#)radix.h     8.2 (Berkeley) 10/31/94
  42  */
  43
  44 #undef RN_DEBUG
  45 /*
  46  * Radix search tree node layout.
  47  */
  48
  49 struct squid_radix_node {
  50
  51     struct squid_radix_mask *rn_mklist; /* list of masks contained in subtree */
  52
  53     struct squid_radix_node *rn_p;      /* parent */
  54     short rn_b;                 /* bit offset; -1-index(netmask) */
  55     char rn_bmask;              /* node: mask for bit test */
  56     unsigned char rn_flags;     /* enumerated next */
  57 #define RNF_NORMAL      1       /* leaf contains normal route */
  58 #define RNF_ROOT        2       /* leaf is root leaf for tree */
  59 #define RNF_ACTIVE      4       /* This node is alive (for rtfree) */
  60
  61     union {
  62
  63         struct {                /* leaf only data: */
  64             char *rn_Key;       /* object of search */
  65             char *rn_Mask;      /* netmask, if present */
  66
  67             struct squid_radix_node *rn_Dupedkey;
  68         } rn_leaf;
  69
  70         struct {                /* node only data: */
  71             int rn_Off;         /* where to start compare */
  72
  73             struct squid_radix_node *rn_L;      /* progeny */
  74
  75             struct squid_radix_node *rn_R;      /* progeny */
  76         } rn_node;
  77     } rn_u;
  78 #ifdef RN_DEBUG
  79
  80     int rn_info;
  81
  82     struct squid_radix_node *rn_twin;
  83
  84     struct squid_radix_node *rn_ybro;
  85 #endif
  86 };
  87
  88 #define rn_key rn_u.rn_leaf.rn_Key
  89 #define rn_mask rn_u.rn_leaf.rn_Mask
  90
  91 /*
  92  * Annotations to tree concerning potential routes applying to subtrees.
  93  */
  94
  95 struct squid_radix_mask {
  96     short rm_b;                 /* bit offset; -1-index(netmask) */
  97     char rm_unused;             /* cf. rn_bmask */
  98     unsigned char rm_flags;     /* cf. rn_flags */
  99
 100     struct squid_radix_mask *rm_mklist; /* more masks to try */
 101     union {
 102         char *rmu_mask;         /* the mask */
 103
 104         struct squid_radix_node *rmu_leaf;      /* for normal routes */
 105     } rm_rmu;
 106     int rm_refs;                /* # of references to this struct */
 107 };
 108
 109 struct squid_radix_node_head {
 110
 111     struct squid_radix_node *rnh_treetop;
 112     int rnh_addrsize;           /* permit, but not require fixed keys */
 113     int rnh_pktsize;            /* permit, but not require fixed keys */
 114
 115     struct squid_radix_node *(*rnh_addaddr)     /* add based on sockaddr */
 116                 (void *v, void *mask,
 117
 118                  struct squid_radix_node_head * head, struct squid_radix_node nodes[]);
 119
 120     struct squid_radix_node *(*rnh_addpkt)      /* add based on packet hdr */
 121                 (void *v, void *mask,
 122
 123                  struct squid_radix_node_head * head, struct squid_radix_node nodes[]);
 124
 125     struct squid_radix_node *(*rnh_deladdr)     /* remove based on sockaddr */
 126
 127                 (void *v, void *mask, struct squid_radix_node_head * head);
 128
 129     struct squid_radix_node *(*rnh_delpkt)      /* remove based on packet hdr */
 130
 131                 (void *v, void *mask, struct squid_radix_node_head * head);
 132
 133     struct squid_radix_node *(*rnh_matchaddr)           /* locate based on sockaddr */
 134
 135                 (void *v, struct squid_radix_node_head * head);
 136
 137     struct squid_radix_node *(*rnh_lookup)      /* locate based on sockaddr */
 138
 139                 (void *v, void *mask, struct squid_radix_node_head * head);
 140
 141     struct squid_radix_node *(*rnh_matchpkt)    /* locate based on packet hdr */
 142
 143                 (void *v, struct squid_radix_node_head * head);
 144     int (*rnh_walktree)         /* traverse tree */
 145
 146     (struct squid_radix_node_head * head, int (*f) (struct squid_radix_node *, void *), void *w);
 147
 148     struct squid_radix_node rnh_nodes[3];       /* empty tree for common case */
 149 };
 150
 151
 152 SQUIDCEXTERN void squid_rn_init (void);
 153
 154 SQUIDCEXTERN int squid_rn_inithead(struct squid_radix_node_head **, int);
 155 SQUIDCEXTERN int squid_rn_refines(void *, void *);
 156
 157 SQUIDCEXTERN int squid_rn_walktree(struct squid_radix_node_head *, int (*)(struct squid_radix_node *, void *), void *);
 158
 159 SQUIDCEXTERN struct squid_radix_node *squid_rn_addmask(void *, int, int);
 160
 161 SQUIDCEXTERN struct squid_radix_node *squid_rn_addroute(void *, void *, struct squid_radix_node_head *, struct squid_radix_node[2]);
 162
 163 SQUIDCEXTERN struct squid_radix_node *squid_rn_delete(void *, void *, struct squid_radix_node_head *);
 164
 165 SQUIDCEXTERN struct squid_radix_node *squid_rn_insert(void *, struct squid_radix_node_head *, int *, struct squid_radix_node[2]);
 166
 167 SQUIDCEXTERN struct squid_radix_node *squid_rn_match(void *, struct squid_radix_node_head *);
 168
 169 SQUIDCEXTERN struct squid_radix_node *squid_rn_newpair(void *, int, struct squid_radix_node[2]);
 170
 171 SQUIDCEXTERN struct squid_radix_node *squid_rn_search(void *, struct squid_radix_node *);
 172
 173 SQUIDCEXTERN struct squid_radix_node *squid_rn_search_m(void *, struct squid_radix_node *, void *);
 174
 175 SQUIDCEXTERN struct squid_radix_node *squid_rn_lookup(void *, void *, struct squid_radix_node_head *);
 176
 177 #endif /* SQUID_RADIX_H */