2 * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 #ifndef SQUID_INCLUDE_RADIX_H
10 #define SQUID_INCLUDE_RADIX_H
13 * Copyright (c) 1988, 1989, 1993
14 * The Regents of the University of California. All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
24 * 3. All advertising materials mentioning features or use of this software
25 * must display the following acknowledgement:
26 * This product includes software developed by the University of
27 * California, Berkeley and its contributors.
28 * 4. Neither the name of the University nor the names of its contributors
29 * may be used to endorse or promote products derived from this software
30 * without specific prior written permission.
32 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
33 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
36 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
40 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
41 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44 * @(#)radix.h 8.2 (Berkeley) 10/31/94
48 * Radix search tree node layout.
51 struct squid_radix_node
{
53 struct squid_radix_mask
*rn_mklist
; /* list of masks contained in subtree */
55 struct squid_radix_node
*rn_p
; /* parent */
56 short rn_b
; /* bit offset; -1-index(netmask) */
57 char rn_bmask
; /* node: mask for bit test */
58 unsigned char rn_flags
; /* enumerated next */
59 #define RNF_NORMAL 1 /* leaf contains normal route */
60 #define RNF_ROOT 2 /* leaf is root leaf for tree */
61 #define RNF_ACTIVE 4 /* This node is alive (for rtfree) */
65 struct { /* leaf only data: */
66 char *rn_Key
; /* object of search */
67 char *rn_Mask
; /* netmask, if present */
69 struct squid_radix_node
*rn_Dupedkey
;
72 struct { /* node only data: */
73 int rn_Off
; /* where to start compare */
75 struct squid_radix_node
*rn_L
; /* progeny */
77 struct squid_radix_node
*rn_R
; /* progeny */
82 #define rn_key rn_u.rn_leaf.rn_Key
83 #define rn_mask rn_u.rn_leaf.rn_Mask
86 * Annotations to tree concerning potential routes applying to subtrees.
89 struct squid_radix_mask
{
90 short rm_b
; /* bit offset; -1-index(netmask) */
91 char rm_unused
; /* cf. rn_bmask */
92 unsigned char rm_flags
; /* cf. rn_flags */
94 struct squid_radix_mask
*rm_mklist
; /* more masks to try */
96 char *rmu_mask
; /* the mask */
98 struct squid_radix_node
*rmu_leaf
; /* for normal routes */
100 int rm_refs
; /* # of references to this struct */
103 struct squid_radix_node_head
{
105 struct squid_radix_node
*rnh_treetop
;
106 int rnh_addrsize
; /* permit, but not require fixed keys */
107 int rnh_pktsize
; /* permit, but not require fixed keys */
109 struct squid_radix_node
*(*rnh_addaddr
) /* add based on sockaddr */
110 (void *v
, void *mask
, struct squid_radix_node_head
* head
, struct squid_radix_node nodes
[]);
112 struct squid_radix_node
*(*rnh_addpkt
) /* add based on packet hdr */
113 (void *v
, void *mask
, struct squid_radix_node_head
* head
, struct squid_radix_node nodes
[]);
115 struct squid_radix_node
*(*rnh_deladdr
) /* remove based on sockaddr */
116 (void *v
, void *mask
, struct squid_radix_node_head
* head
);
118 struct squid_radix_node
*(*rnh_delpkt
) /* remove based on packet hdr */
119 (void *v
, void *mask
, struct squid_radix_node_head
* head
);
121 struct squid_radix_node
*(*rnh_matchaddr
) /* locate based on sockaddr */
122 (void *v
, struct squid_radix_node_head
* head
);
124 struct squid_radix_node
*(*rnh_lookup
) /* locate based on sockaddr */
126 (void *v
, void *mask
, struct squid_radix_node_head
* head
);
128 struct squid_radix_node
*(*rnh_matchpkt
) /* locate based on packet hdr */
129 (void *v
, struct squid_radix_node_head
* head
);
131 int (*rnh_walktree
) /* traverse tree */
132 (struct squid_radix_node_head
* head
, int (*f
) (struct squid_radix_node
*, void *), void *w
);
134 struct squid_radix_node rnh_nodes
[3]; /* empty tree for common case */
137 SQUIDCEXTERN
void squid_rn_init (void);
139 SQUIDCEXTERN
int squid_rn_inithead(struct squid_radix_node_head
**, int);
140 SQUIDCEXTERN
int squid_rn_refines(void *, void *);
142 SQUIDCEXTERN
int squid_rn_walktree(struct squid_radix_node_head
*, int (*)(struct squid_radix_node
*, void *), void *);
144 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_addmask(void *, int, int);
146 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_addroute(void *, void *, struct squid_radix_node_head
*, struct squid_radix_node
[2]);
148 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_delete(void *, void *, struct squid_radix_node_head
*);
150 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_insert(void *, struct squid_radix_node_head
*, int *, struct squid_radix_node
[2]);
152 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_match(void *, struct squid_radix_node_head
*);
154 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_newpair(void *, int, struct squid_radix_node
[2]);
156 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_search(void *, struct squid_radix_node
*);
158 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_search_m(void *, struct squid_radix_node
*, void *);
160 SQUIDCEXTERN
struct squid_radix_node
*squid_rn_lookup(void *, void *, struct squid_radix_node_head
*);
162 #endif /* SQUID_INCLUDE_RADIX_H */