include/radix.h

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