xref: /dragonfly/sys/net/radix.c (revision 1de703da)
1 /*
2  * Copyright (c) 1988, 1989, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the University of
16  *	California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)radix.c	8.4 (Berkeley) 11/2/94
34  * $FreeBSD: src/sys/net/radix.c,v 1.20.2.3 2002/04/28 05:40:25 suz Exp $
35  * $DragonFly: src/sys/net/radix.c,v 1.2 2003/06/17 04:28:48 dillon Exp $
36  */
37 
38 /*
39  * Routines to build and maintain radix trees for routing lookups.
40  */
41 #ifndef _RADIX_H_
42 #include <sys/param.h>
43 #ifdef	_KERNEL
44 #include <sys/systm.h>
45 #include <sys/malloc.h>
46 #define	M_DONTWAIT M_NOWAIT
47 #include <sys/domain.h>
48 #else
49 #include <stdlib.h>
50 #endif
51 #include <sys/syslog.h>
52 #include <net/radix.h>
53 #endif
54 
55 static int	rn_walktree_from __P((struct radix_node_head *h, void *a,
56 				      void *m, walktree_f_t *f, void *w));
57 static int rn_walktree __P((struct radix_node_head *, walktree_f_t *, void *));
58 static struct radix_node
59 	 *rn_insert __P((void *, struct radix_node_head *, int *,
60 			struct radix_node [2])),
61 	 *rn_newpair __P((void *, int, struct radix_node[2])),
62 	 *rn_search __P((void *, struct radix_node *)),
63 	 *rn_search_m __P((void *, struct radix_node *, void *));
64 
65 static int	max_keylen;
66 static struct radix_mask *rn_mkfreelist;
67 static struct radix_node_head *mask_rnhead;
68 static char *addmask_key;
69 static char normal_chars[] = {0, 0x80, 0xc0, 0xe0, 0xf0, 0xf8, 0xfc, 0xfe, -1};
70 static char *rn_zeros, *rn_ones;
71 
72 #define rn_masktop (mask_rnhead->rnh_treetop)
73 #undef Bcmp
74 #define Bcmp(a, b, l) \
75 	(l == 0 ? 0 : bcmp((caddr_t)(a), (caddr_t)(b), (u_long)l))
76 
77 static int	rn_lexobetter __P((void *m_arg, void *n_arg));
78 static struct radix_mask *
79 		rn_new_radix_mask __P((struct radix_node *tt,
80 				       struct radix_mask *next));
81 static int	rn_satsifies_leaf __P((char *trial, struct radix_node *leaf,
82 				       int skip));
83 
84 /*
85  * The data structure for the keys is a radix tree with one way
86  * branching removed.  The index rn_bit at an internal node n represents a bit
87  * position to be tested.  The tree is arranged so that all descendants
88  * of a node n have keys whose bits all agree up to position rn_bit - 1.
89  * (We say the index of n is rn_bit.)
90  *
91  * There is at least one descendant which has a one bit at position rn_bit,
92  * and at least one with a zero there.
93  *
94  * A route is determined by a pair of key and mask.  We require that the
95  * bit-wise logical and of the key and mask to be the key.
96  * We define the index of a route to associated with the mask to be
97  * the first bit number in the mask where 0 occurs (with bit number 0
98  * representing the highest order bit).
99  *
100  * We say a mask is normal if every bit is 0, past the index of the mask.
101  * If a node n has a descendant (k, m) with index(m) == index(n) == rn_bit,
102  * and m is a normal mask, then the route applies to every descendant of n.
103  * If the index(m) < rn_bit, this implies the trailing last few bits of k
104  * before bit b are all 0, (and hence consequently true of every descendant
105  * of n), so the route applies to all descendants of the node as well.
106  *
107  * Similar logic shows that a non-normal mask m such that
108  * index(m) <= index(n) could potentially apply to many children of n.
109  * Thus, for each non-host route, we attach its mask to a list at an internal
110  * node as high in the tree as we can go.
111  *
112  * The present version of the code makes use of normal routes in short-
113  * circuiting an explict mask and compare operation when testing whether
114  * a key satisfies a normal route, and also in remembering the unique leaf
115  * that governs a subtree.
116  */
117 
118 static struct radix_node *
119 rn_search(v_arg, head)
120 	void *v_arg;
121 	struct radix_node *head;
122 {
123 	register struct radix_node *x;
124 	register caddr_t v;
125 
126 	for (x = head, v = v_arg; x->rn_bit >= 0;) {
127 		if (x->rn_bmask & v[x->rn_offset])
128 			x = x->rn_right;
129 		else
130 			x = x->rn_left;
131 	}
132 	return (x);
133 }
134 
135 static struct radix_node *
136 rn_search_m(v_arg, head, m_arg)
137 	struct radix_node *head;
138 	void *v_arg, *m_arg;
139 {
140 	register struct radix_node *x;
141 	register caddr_t v = v_arg, m = m_arg;
142 
143 	for (x = head; x->rn_bit >= 0;) {
144 		if ((x->rn_bmask & m[x->rn_offset]) &&
145 		    (x->rn_bmask & v[x->rn_offset]))
146 			x = x->rn_right;
147 		else
148 			x = x->rn_left;
149 	}
150 	return x;
151 }
152 
153 int
154 rn_refines(m_arg, n_arg)
155 	void *m_arg, *n_arg;
156 {
157 	register caddr_t m = m_arg, n = n_arg;
158 	register caddr_t lim, lim2 = lim = n + *(u_char *)n;
159 	int longer = (*(u_char *)n++) - (int)(*(u_char *)m++);
160 	int masks_are_equal = 1;
161 
162 	if (longer > 0)
163 		lim -= longer;
164 	while (n < lim) {
165 		if (*n & ~(*m))
166 			return 0;
167 		if (*n++ != *m++)
168 			masks_are_equal = 0;
169 	}
170 	while (n < lim2)
171 		if (*n++)
172 			return 0;
173 	if (masks_are_equal && (longer < 0))
174 		for (lim2 = m - longer; m < lim2; )
175 			if (*m++)
176 				return 1;
177 	return (!masks_are_equal);
178 }
179 
180 struct radix_node *
181 rn_lookup(v_arg, m_arg, head)
182 	void *v_arg, *m_arg;
183 	struct radix_node_head *head;
184 {
185 	register struct radix_node *x;
186 	caddr_t netmask = 0;
187 
188 	if (m_arg) {
189 		x = rn_addmask(m_arg, 1, head->rnh_treetop->rn_offset);
190 		if (x == 0)
191 			return (0);
192 		netmask = x->rn_key;
193 	}
194 	x = rn_match(v_arg, head);
195 	if (x && netmask) {
196 		while (x && x->rn_mask != netmask)
197 			x = x->rn_dupedkey;
198 	}
199 	return x;
200 }
201 
202 static int
203 rn_satsifies_leaf(trial, leaf, skip)
204 	char *trial;
205 	register struct radix_node *leaf;
206 	int skip;
207 {
208 	register char *cp = trial, *cp2 = leaf->rn_key, *cp3 = leaf->rn_mask;
209 	char *cplim;
210 	int length = min(*(u_char *)cp, *(u_char *)cp2);
211 
212 	if (cp3 == 0)
213 		cp3 = rn_ones;
214 	else
215 		length = min(length, *(u_char *)cp3);
216 	cplim = cp + length; cp3 += skip; cp2 += skip;
217 	for (cp += skip; cp < cplim; cp++, cp2++, cp3++)
218 		if ((*cp ^ *cp2) & *cp3)
219 			return 0;
220 	return 1;
221 }
222 
223 struct radix_node *
224 rn_match(v_arg, head)
225 	void *v_arg;
226 	struct radix_node_head *head;
227 {
228 	caddr_t v = v_arg;
229 	register struct radix_node *t = head->rnh_treetop, *x;
230 	register caddr_t cp = v, cp2;
231 	caddr_t cplim;
232 	struct radix_node *saved_t, *top = t;
233 	int off = t->rn_offset, vlen = *(u_char *)cp, matched_off;
234 	register int test, b, rn_bit;
235 
236 	/*
237 	 * Open code rn_search(v, top) to avoid overhead of extra
238 	 * subroutine call.
239 	 */
240 	for (; t->rn_bit >= 0; ) {
241 		if (t->rn_bmask & cp[t->rn_offset])
242 			t = t->rn_right;
243 		else
244 			t = t->rn_left;
245 	}
246 	/*
247 	 * See if we match exactly as a host destination
248 	 * or at least learn how many bits match, for normal mask finesse.
249 	 *
250 	 * It doesn't hurt us to limit how many bytes to check
251 	 * to the length of the mask, since if it matches we had a genuine
252 	 * match and the leaf we have is the most specific one anyway;
253 	 * if it didn't match with a shorter length it would fail
254 	 * with a long one.  This wins big for class B&C netmasks which
255 	 * are probably the most common case...
256 	 */
257 	if (t->rn_mask)
258 		vlen = *(u_char *)t->rn_mask;
259 	cp += off; cp2 = t->rn_key + off; cplim = v + vlen;
260 	for (; cp < cplim; cp++, cp2++)
261 		if (*cp != *cp2)
262 			goto on1;
263 	/*
264 	 * This extra grot is in case we are explicitly asked
265 	 * to look up the default.  Ugh!
266 	 *
267 	 * Never return the root node itself, it seems to cause a
268 	 * lot of confusion.
269 	 */
270 	if (t->rn_flags & RNF_ROOT)
271 		t = t->rn_dupedkey;
272 	return t;
273 on1:
274 	test = (*cp ^ *cp2) & 0xff; /* find first bit that differs */
275 	for (b = 7; (test >>= 1) > 0;)
276 		b--;
277 	matched_off = cp - v;
278 	b += matched_off << 3;
279 	rn_bit = -1 - b;
280 	/*
281 	 * If there is a host route in a duped-key chain, it will be first.
282 	 */
283 	if ((saved_t = t)->rn_mask == 0)
284 		t = t->rn_dupedkey;
285 	for (; t; t = t->rn_dupedkey)
286 		/*
287 		 * Even if we don't match exactly as a host,
288 		 * we may match if the leaf we wound up at is
289 		 * a route to a net.
290 		 */
291 		if (t->rn_flags & RNF_NORMAL) {
292 			if (rn_bit <= t->rn_bit)
293 				return t;
294 		} else if (rn_satsifies_leaf(v, t, matched_off))
295 				return t;
296 	t = saved_t;
297 	/* start searching up the tree */
298 	do {
299 		register struct radix_mask *m;
300 		t = t->rn_parent;
301 		m = t->rn_mklist;
302 		/*
303 		 * If non-contiguous masks ever become important
304 		 * we can restore the masking and open coding of
305 		 * the search and satisfaction test and put the
306 		 * calculation of "off" back before the "do".
307 		 */
308 		while (m) {
309 			if (m->rm_flags & RNF_NORMAL) {
310 				if (rn_bit <= m->rm_bit)
311 					return (m->rm_leaf);
312 			} else {
313 				off = min(t->rn_offset, matched_off);
314 				x = rn_search_m(v, t, m->rm_mask);
315 				while (x && x->rn_mask != m->rm_mask)
316 					x = x->rn_dupedkey;
317 				if (x && rn_satsifies_leaf(v, x, off))
318 					return x;
319 			}
320 			m = m->rm_mklist;
321 		}
322 	} while (t != top);
323 	return 0;
324 }
325 
326 #ifdef RN_DEBUG
327 int	rn_nodenum;
328 struct	radix_node *rn_clist;
329 int	rn_saveinfo;
330 int	rn_debug =  1;
331 #endif
332 
333 static struct radix_node *
334 rn_newpair(v, b, nodes)
335 	void *v;
336 	int b;
337 	struct radix_node nodes[2];
338 {
339 	register struct radix_node *tt = nodes, *t = tt + 1;
340 	t->rn_bit = b;
341 	t->rn_bmask = 0x80 >> (b & 7);
342 	t->rn_left = tt;
343 	t->rn_offset = b >> 3;
344 	tt->rn_bit = -1;
345 	tt->rn_key = (caddr_t)v;
346 	tt->rn_parent = t;
347 	tt->rn_flags = t->rn_flags = RNF_ACTIVE;
348 	tt->rn_mklist = t->rn_mklist = 0;
349 #ifdef RN_DEBUG
350 	tt->rn_info = rn_nodenum++; t->rn_info = rn_nodenum++;
351 	tt->rn_twin = t;
352 	tt->rn_ybro = rn_clist;
353 	rn_clist = tt;
354 #endif
355 	return t;
356 }
357 
358 static struct radix_node *
359 rn_insert(v_arg, head, dupentry, nodes)
360 	void *v_arg;
361 	struct radix_node_head *head;
362 	int *dupentry;
363 	struct radix_node nodes[2];
364 {
365 	caddr_t v = v_arg;
366 	struct radix_node *top = head->rnh_treetop;
367 	int head_off = top->rn_offset, vlen = (int)*((u_char *)v);
368 	register struct radix_node *t = rn_search(v_arg, top);
369 	register caddr_t cp = v + head_off;
370 	register int b;
371 	struct radix_node *tt;
372     	/*
373 	 * Find first bit at which v and t->rn_key differ
374 	 */
375     {
376 	register caddr_t cp2 = t->rn_key + head_off;
377 	register int cmp_res;
378 	caddr_t cplim = v + vlen;
379 
380 	while (cp < cplim)
381 		if (*cp2++ != *cp++)
382 			goto on1;
383 	*dupentry = 1;
384 	return t;
385 on1:
386 	*dupentry = 0;
387 	cmp_res = (cp[-1] ^ cp2[-1]) & 0xff;
388 	for (b = (cp - v) << 3; cmp_res; b--)
389 		cmp_res >>= 1;
390     }
391     {
392 	register struct radix_node *p, *x = top;
393 	cp = v;
394 	do {
395 		p = x;
396 		if (cp[x->rn_offset] & x->rn_bmask)
397 			x = x->rn_right;
398 		else
399 			x = x->rn_left;
400 	} while (b > (unsigned) x->rn_bit);
401 				/* x->rn_bit < b && x->rn_bit >= 0 */
402 #ifdef RN_DEBUG
403 	if (rn_debug)
404 		log(LOG_DEBUG, "rn_insert: Going In:\n"), traverse(p);
405 #endif
406 	t = rn_newpair(v_arg, b, nodes);
407 	tt = t->rn_left;
408 	if ((cp[p->rn_offset] & p->rn_bmask) == 0)
409 		p->rn_left = t;
410 	else
411 		p->rn_right = t;
412 	x->rn_parent = t;
413 	t->rn_parent = p; /* frees x, p as temp vars below */
414 	if ((cp[t->rn_offset] & t->rn_bmask) == 0) {
415 		t->rn_right = x;
416 	} else {
417 		t->rn_right = tt;
418 		t->rn_left = x;
419 	}
420 #ifdef RN_DEBUG
421 	if (rn_debug)
422 		log(LOG_DEBUG, "rn_insert: Coming Out:\n"), traverse(p);
423 #endif
424     }
425 	return (tt);
426 }
427 
428 struct radix_node *
429 rn_addmask(n_arg, search, skip)
430 	int search, skip;
431 	void *n_arg;
432 {
433 	caddr_t netmask = (caddr_t)n_arg;
434 	register struct radix_node *x;
435 	register caddr_t cp, cplim;
436 	register int b = 0, mlen, j;
437 	int maskduplicated, m0, isnormal;
438 	struct radix_node *saved_x;
439 	static int last_zeroed = 0;
440 
441 	if ((mlen = *(u_char *)netmask) > max_keylen)
442 		mlen = max_keylen;
443 	if (skip == 0)
444 		skip = 1;
445 	if (mlen <= skip)
446 		return (mask_rnhead->rnh_nodes);
447 	if (skip > 1)
448 		Bcopy(rn_ones + 1, addmask_key + 1, skip - 1);
449 	if ((m0 = mlen) > skip)
450 		Bcopy(netmask + skip, addmask_key + skip, mlen - skip);
451 	/*
452 	 * Trim trailing zeroes.
453 	 */
454 	for (cp = addmask_key + mlen; (cp > addmask_key) && cp[-1] == 0;)
455 		cp--;
456 	mlen = cp - addmask_key;
457 	if (mlen <= skip) {
458 		if (m0 >= last_zeroed)
459 			last_zeroed = mlen;
460 		return (mask_rnhead->rnh_nodes);
461 	}
462 	if (m0 < last_zeroed)
463 		Bzero(addmask_key + m0, last_zeroed - m0);
464 	*addmask_key = last_zeroed = mlen;
465 	x = rn_search(addmask_key, rn_masktop);
466 	if (Bcmp(addmask_key, x->rn_key, mlen) != 0)
467 		x = 0;
468 	if (x || search)
469 		return (x);
470 	R_Malloc(x, struct radix_node *, max_keylen + 2 * sizeof (*x));
471 	if ((saved_x = x) == 0)
472 		return (0);
473 	Bzero(x, max_keylen + 2 * sizeof (*x));
474 	netmask = cp = (caddr_t)(x + 2);
475 	Bcopy(addmask_key, cp, mlen);
476 	x = rn_insert(cp, mask_rnhead, &maskduplicated, x);
477 	if (maskduplicated) {
478 		log(LOG_ERR, "rn_addmask: mask impossibly already in tree");
479 		Free(saved_x);
480 		return (x);
481 	}
482 	/*
483 	 * Calculate index of mask, and check for normalcy.
484 	 */
485 	cplim = netmask + mlen; isnormal = 1;
486 	for (cp = netmask + skip; (cp < cplim) && *(u_char *)cp == 0xff;)
487 		cp++;
488 	if (cp != cplim) {
489 		for (j = 0x80; (j & *cp) != 0; j >>= 1)
490 			b++;
491 		if (*cp != normal_chars[b] || cp != (cplim - 1))
492 			isnormal = 0;
493 	}
494 	b += (cp - netmask) << 3;
495 	x->rn_bit = -1 - b;
496 	if (isnormal)
497 		x->rn_flags |= RNF_NORMAL;
498 	return (x);
499 }
500 
501 static int	/* XXX: arbitrary ordering for non-contiguous masks */
502 rn_lexobetter(m_arg, n_arg)
503 	void *m_arg, *n_arg;
504 {
505 	register u_char *mp = m_arg, *np = n_arg, *lim;
506 
507 	if (*mp > *np)
508 		return 1;  /* not really, but need to check longer one first */
509 	if (*mp == *np)
510 		for (lim = mp + *mp; mp < lim;)
511 			if (*mp++ > *np++)
512 				return 1;
513 	return 0;
514 }
515 
516 static struct radix_mask *
517 rn_new_radix_mask(tt, next)
518 	register struct radix_node *tt;
519 	register struct radix_mask *next;
520 {
521 	register struct radix_mask *m;
522 
523 	MKGet(m);
524 	if (m == 0) {
525 		log(LOG_ERR, "Mask for route not entered\n");
526 		return (0);
527 	}
528 	Bzero(m, sizeof *m);
529 	m->rm_bit = tt->rn_bit;
530 	m->rm_flags = tt->rn_flags;
531 	if (tt->rn_flags & RNF_NORMAL)
532 		m->rm_leaf = tt;
533 	else
534 		m->rm_mask = tt->rn_mask;
535 	m->rm_mklist = next;
536 	tt->rn_mklist = m;
537 	return m;
538 }
539 
540 struct radix_node *
541 rn_addroute(v_arg, n_arg, head, treenodes)
542 	void *v_arg, *n_arg;
543 	struct radix_node_head *head;
544 	struct radix_node treenodes[2];
545 {
546 	caddr_t v = (caddr_t)v_arg, netmask = (caddr_t)n_arg;
547 	register struct radix_node *t, *x = 0, *tt;
548 	struct radix_node *saved_tt, *top = head->rnh_treetop;
549 	short b = 0, b_leaf = 0;
550 	int keyduplicated;
551 	caddr_t mmask;
552 	struct radix_mask *m, **mp;
553 
554 	/*
555 	 * In dealing with non-contiguous masks, there may be
556 	 * many different routes which have the same mask.
557 	 * We will find it useful to have a unique pointer to
558 	 * the mask to speed avoiding duplicate references at
559 	 * nodes and possibly save time in calculating indices.
560 	 */
561 	if (netmask)  {
562 		if ((x = rn_addmask(netmask, 0, top->rn_offset)) == 0)
563 			return (0);
564 		b_leaf = x->rn_bit;
565 		b = -1 - x->rn_bit;
566 		netmask = x->rn_key;
567 	}
568 	/*
569 	 * Deal with duplicated keys: attach node to previous instance
570 	 */
571 	saved_tt = tt = rn_insert(v, head, &keyduplicated, treenodes);
572 	if (keyduplicated) {
573 		for (t = tt; tt; t = tt, tt = tt->rn_dupedkey) {
574 			if (tt->rn_mask == netmask)
575 				return (0);
576 			if (netmask == 0 ||
577 			    (tt->rn_mask &&
578 			     ((b_leaf < tt->rn_bit) /* index(netmask) > node */
579 			      || rn_refines(netmask, tt->rn_mask)
580 			      || rn_lexobetter(netmask, tt->rn_mask))))
581 				break;
582 		}
583 		/*
584 		 * If the mask is not duplicated, we wouldn't
585 		 * find it among possible duplicate key entries
586 		 * anyway, so the above test doesn't hurt.
587 		 *
588 		 * We sort the masks for a duplicated key the same way as
589 		 * in a masklist -- most specific to least specific.
590 		 * This may require the unfortunate nuisance of relocating
591 		 * the head of the list.
592 		 */
593 		if (tt == saved_tt) {
594 			struct	radix_node *xx = x;
595 			/* link in at head of list */
596 			(tt = treenodes)->rn_dupedkey = t;
597 			tt->rn_flags = t->rn_flags;
598 			tt->rn_parent = x = t->rn_parent;
599 			t->rn_parent = tt;	 		/* parent */
600 			if (x->rn_left == t)
601 				x->rn_left = tt;
602 			else
603 				x->rn_right = tt;
604 			saved_tt = tt; x = xx;
605 		} else {
606 			(tt = treenodes)->rn_dupedkey = t->rn_dupedkey;
607 			t->rn_dupedkey = tt;
608 			tt->rn_parent = t;			/* parent */
609 			if (tt->rn_dupedkey)			/* parent */
610 				tt->rn_dupedkey->rn_parent = tt; /* parent */
611 		}
612 #ifdef RN_DEBUG
613 		t=tt+1; tt->rn_info = rn_nodenum++; t->rn_info = rn_nodenum++;
614 		tt->rn_twin = t; tt->rn_ybro = rn_clist; rn_clist = tt;
615 #endif
616 		tt->rn_key = (caddr_t) v;
617 		tt->rn_bit = -1;
618 		tt->rn_flags = RNF_ACTIVE;
619 	}
620 	/*
621 	 * Put mask in tree.
622 	 */
623 	if (netmask) {
624 		tt->rn_mask = netmask;
625 		tt->rn_bit = x->rn_bit;
626 		tt->rn_flags |= x->rn_flags & RNF_NORMAL;
627 	}
628 	t = saved_tt->rn_parent;
629 	if (keyduplicated)
630 		goto on2;
631 	b_leaf = -1 - t->rn_bit;
632 	if (t->rn_right == saved_tt)
633 		x = t->rn_left;
634 	else
635 		x = t->rn_right;
636 	/* Promote general routes from below */
637 	if (x->rn_bit < 0) {
638 	    for (mp = &t->rn_mklist; x; x = x->rn_dupedkey)
639 		if (x->rn_mask && (x->rn_bit >= b_leaf) && x->rn_mklist == 0) {
640 			*mp = m = rn_new_radix_mask(x, 0);
641 			if (m)
642 				mp = &m->rm_mklist;
643 		}
644 	} else if (x->rn_mklist) {
645 		/*
646 		 * Skip over masks whose index is > that of new node
647 		 */
648 		for (mp = &x->rn_mklist; (m = *mp); mp = &m->rm_mklist)
649 			if (m->rm_bit >= b_leaf)
650 				break;
651 		t->rn_mklist = m; *mp = 0;
652 	}
653 on2:
654 	/* Add new route to highest possible ancestor's list */
655 	if ((netmask == 0) || (b > t->rn_bit ))
656 		return tt; /* can't lift at all */
657 	b_leaf = tt->rn_bit;
658 	do {
659 		x = t;
660 		t = t->rn_parent;
661 	} while (b <= t->rn_bit && x != top);
662 	/*
663 	 * Search through routes associated with node to
664 	 * insert new route according to index.
665 	 * Need same criteria as when sorting dupedkeys to avoid
666 	 * double loop on deletion.
667 	 */
668 	for (mp = &x->rn_mklist; (m = *mp); mp = &m->rm_mklist) {
669 		if (m->rm_bit < b_leaf)
670 			continue;
671 		if (m->rm_bit > b_leaf)
672 			break;
673 		if (m->rm_flags & RNF_NORMAL) {
674 			mmask = m->rm_leaf->rn_mask;
675 			if (tt->rn_flags & RNF_NORMAL) {
676 			    log(LOG_ERR,
677 			        "Non-unique normal route, mask not entered\n");
678 				return tt;
679 			}
680 		} else
681 			mmask = m->rm_mask;
682 		if (mmask == netmask) {
683 			m->rm_refs++;
684 			tt->rn_mklist = m;
685 			return tt;
686 		}
687 		if (rn_refines(netmask, mmask)
688 		    || rn_lexobetter(netmask, mmask))
689 			break;
690 	}
691 	*mp = rn_new_radix_mask(tt, *mp);
692 	return tt;
693 }
694 
695 struct radix_node *
696 rn_delete(v_arg, netmask_arg, head)
697 	void *v_arg, *netmask_arg;
698 	struct radix_node_head *head;
699 {
700 	register struct radix_node *t, *p, *x, *tt;
701 	struct radix_mask *m, *saved_m, **mp;
702 	struct radix_node *dupedkey, *saved_tt, *top;
703 	caddr_t v, netmask;
704 	int b, head_off, vlen;
705 
706 	v = v_arg;
707 	netmask = netmask_arg;
708 	x = head->rnh_treetop;
709 	tt = rn_search(v, x);
710 	head_off = x->rn_offset;
711 	vlen =  *(u_char *)v;
712 	saved_tt = tt;
713 	top = x;
714 	if (tt == 0 ||
715 	    Bcmp(v + head_off, tt->rn_key + head_off, vlen - head_off))
716 		return (0);
717 	/*
718 	 * Delete our route from mask lists.
719 	 */
720 	if (netmask) {
721 		if ((x = rn_addmask(netmask, 1, head_off)) == 0)
722 			return (0);
723 		netmask = x->rn_key;
724 		while (tt->rn_mask != netmask)
725 			if ((tt = tt->rn_dupedkey) == 0)
726 				return (0);
727 	}
728 	if (tt->rn_mask == 0 || (saved_m = m = tt->rn_mklist) == 0)
729 		goto on1;
730 	if (tt->rn_flags & RNF_NORMAL) {
731 		if (m->rm_leaf != tt || m->rm_refs > 0) {
732 			log(LOG_ERR, "rn_delete: inconsistent annotation\n");
733 			return 0;  /* dangling ref could cause disaster */
734 		}
735 	} else {
736 		if (m->rm_mask != tt->rn_mask) {
737 			log(LOG_ERR, "rn_delete: inconsistent annotation\n");
738 			goto on1;
739 		}
740 		if (--m->rm_refs >= 0)
741 			goto on1;
742 	}
743 	b = -1 - tt->rn_bit;
744 	t = saved_tt->rn_parent;
745 	if (b > t->rn_bit)
746 		goto on1; /* Wasn't lifted at all */
747 	do {
748 		x = t;
749 		t = t->rn_parent;
750 	} while (b <= t->rn_bit && x != top);
751 	for (mp = &x->rn_mklist; (m = *mp); mp = &m->rm_mklist)
752 		if (m == saved_m) {
753 			*mp = m->rm_mklist;
754 			MKFree(m);
755 			break;
756 		}
757 	if (m == 0) {
758 		log(LOG_ERR, "rn_delete: couldn't find our annotation\n");
759 		if (tt->rn_flags & RNF_NORMAL)
760 			return (0); /* Dangling ref to us */
761 	}
762 on1:
763 	/*
764 	 * Eliminate us from tree
765 	 */
766 	if (tt->rn_flags & RNF_ROOT)
767 		return (0);
768 #ifdef RN_DEBUG
769 	/* Get us out of the creation list */
770 	for (t = rn_clist; t && t->rn_ybro != tt; t = t->rn_ybro) {}
771 	if (t) t->rn_ybro = tt->rn_ybro;
772 #endif
773 	t = tt->rn_parent;
774 	dupedkey = saved_tt->rn_dupedkey;
775 	if (dupedkey) {
776 		/*
777 		 * at this point, tt is the deletion target and saved_tt
778 		 * is the head of the dupekey chain
779 		 */
780 		if (tt == saved_tt) {
781 			/* remove from head of chain */
782 			x = dupedkey; x->rn_parent = t;
783 			if (t->rn_left == tt)
784 				t->rn_left = x;
785 			else
786 				t->rn_right = x;
787 		} else {
788 			/* find node in front of tt on the chain */
789 			for (x = p = saved_tt; p && p->rn_dupedkey != tt;)
790 				p = p->rn_dupedkey;
791 			if (p) {
792 				p->rn_dupedkey = tt->rn_dupedkey;
793 				if (tt->rn_dupedkey)		/* parent */
794 					tt->rn_dupedkey->rn_parent = p;
795 								/* parent */
796 			} else log(LOG_ERR, "rn_delete: couldn't find us\n");
797 		}
798 		t = tt + 1;
799 		if  (t->rn_flags & RNF_ACTIVE) {
800 #ifndef RN_DEBUG
801 			*++x = *t;
802 			p = t->rn_parent;
803 #else
804 			b = t->rn_info;
805 			*++x = *t;
806 			t->rn_info = b;
807 			p = t->rn_parent;
808 #endif
809 			if (p->rn_left == t)
810 				p->rn_left = x;
811 			else
812 				p->rn_right = x;
813 			x->rn_left->rn_parent = x;
814 			x->rn_right->rn_parent = x;
815 		}
816 		goto out;
817 	}
818 	if (t->rn_left == tt)
819 		x = t->rn_right;
820 	else
821 		x = t->rn_left;
822 	p = t->rn_parent;
823 	if (p->rn_right == t)
824 		p->rn_right = x;
825 	else
826 		p->rn_left = x;
827 	x->rn_parent = p;
828 	/*
829 	 * Demote routes attached to us.
830 	 */
831 	if (t->rn_mklist) {
832 		if (x->rn_bit >= 0) {
833 			for (mp = &x->rn_mklist; (m = *mp);)
834 				mp = &m->rm_mklist;
835 			*mp = t->rn_mklist;
836 		} else {
837 			/* If there are any key,mask pairs in a sibling
838 			   duped-key chain, some subset will appear sorted
839 			   in the same order attached to our mklist */
840 			for (m = t->rn_mklist; m && x; x = x->rn_dupedkey)
841 				if (m == x->rn_mklist) {
842 					struct radix_mask *mm = m->rm_mklist;
843 					x->rn_mklist = 0;
844 					if (--(m->rm_refs) < 0)
845 						MKFree(m);
846 					m = mm;
847 				}
848 			if (m)
849 				log(LOG_ERR,
850 				    "rn_delete: Orphaned Mask %p at %p\n",
851 				    (void *)m, (void *)x);
852 		}
853 	}
854 	/*
855 	 * We may be holding an active internal node in the tree.
856 	 */
857 	x = tt + 1;
858 	if (t != x) {
859 #ifndef RN_DEBUG
860 		*t = *x;
861 #else
862 		b = t->rn_info;
863 		*t = *x;
864 		t->rn_info = b;
865 #endif
866 		t->rn_left->rn_parent = t;
867 		t->rn_right->rn_parent = t;
868 		p = x->rn_parent;
869 		if (p->rn_left == x)
870 			p->rn_left = t;
871 		else
872 			p->rn_right = t;
873 	}
874 out:
875 	tt->rn_flags &= ~RNF_ACTIVE;
876 	tt[1].rn_flags &= ~RNF_ACTIVE;
877 	return (tt);
878 }
879 
880 /*
881  * This is the same as rn_walktree() except for the parameters and the
882  * exit.
883  */
884 static int
885 rn_walktree_from(h, a, m, f, w)
886 	struct radix_node_head *h;
887 	void *a, *m;
888 	walktree_f_t *f;
889 	void *w;
890 {
891 	int error;
892 	struct radix_node *base, *next;
893 	u_char *xa = (u_char *)a;
894 	u_char *xm = (u_char *)m;
895 	register struct radix_node *rn, *last = 0 /* shut up gcc */;
896 	int stopping = 0;
897 	int lastb;
898 
899 	/*
900 	 * rn_search_m is sort-of-open-coded here.
901 	 */
902 	/* printf("about to search\n"); */
903 	for (rn = h->rnh_treetop; rn->rn_bit >= 0; ) {
904 		last = rn;
905 		/* printf("rn_bit %d, rn_bmask %x, xm[rn_offset] %x\n",
906 		       rn->rn_bit, rn->rn_bmask, xm[rn->rn_offset]); */
907 		if (!(rn->rn_bmask & xm[rn->rn_offset])) {
908 			break;
909 		}
910 		if (rn->rn_bmask & xa[rn->rn_offset]) {
911 			rn = rn->rn_right;
912 		} else {
913 			rn = rn->rn_left;
914 		}
915 	}
916 	/* printf("done searching\n"); */
917 
918 	/*
919 	 * Two cases: either we stepped off the end of our mask,
920 	 * in which case last == rn, or we reached a leaf, in which
921 	 * case we want to start from the last node we looked at.
922 	 * Either way, last is the node we want to start from.
923 	 */
924 	rn = last;
925 	lastb = rn->rn_bit;
926 
927 	/* printf("rn %p, lastb %d\n", rn, lastb);*/
928 
929 	/*
930 	 * This gets complicated because we may delete the node
931 	 * while applying the function f to it, so we need to calculate
932 	 * the successor node in advance.
933 	 */
934 	while (rn->rn_bit >= 0)
935 		rn = rn->rn_left;
936 
937 	while (!stopping) {
938 		/* printf("node %p (%d)\n", rn, rn->rn_bit); */
939 		base = rn;
940 		/* If at right child go back up, otherwise, go right */
941 		while (rn->rn_parent->rn_right == rn
942 		       && !(rn->rn_flags & RNF_ROOT)) {
943 			rn = rn->rn_parent;
944 
945 			/* if went up beyond last, stop */
946 			if (rn->rn_bit < lastb) {
947 				stopping = 1;
948 				/* printf("up too far\n"); */
949 			}
950 		}
951 
952 		/* Find the next *leaf* since next node might vanish, too */
953 		for (rn = rn->rn_parent->rn_right; rn->rn_bit >= 0;)
954 			rn = rn->rn_left;
955 		next = rn;
956 		/* Process leaves */
957 		while ((rn = base) != 0) {
958 			base = rn->rn_dupedkey;
959 			/* printf("leaf %p\n", rn); */
960 			if (!(rn->rn_flags & RNF_ROOT)
961 			    && (error = (*f)(rn, w)))
962 				return (error);
963 		}
964 		rn = next;
965 
966 		if (rn->rn_flags & RNF_ROOT) {
967 			/* printf("root, stopping"); */
968 			stopping = 1;
969 		}
970 
971 	}
972 	return 0;
973 }
974 
975 static int
976 rn_walktree(h, f, w)
977 	struct radix_node_head *h;
978 	walktree_f_t *f;
979 	void *w;
980 {
981 	int error;
982 	struct radix_node *base, *next;
983 	register struct radix_node *rn = h->rnh_treetop;
984 	/*
985 	 * This gets complicated because we may delete the node
986 	 * while applying the function f to it, so we need to calculate
987 	 * the successor node in advance.
988 	 */
989 	/* First time through node, go left */
990 	while (rn->rn_bit >= 0)
991 		rn = rn->rn_left;
992 	for (;;) {
993 		base = rn;
994 		/* If at right child go back up, otherwise, go right */
995 		while (rn->rn_parent->rn_right == rn
996 		       && (rn->rn_flags & RNF_ROOT) == 0)
997 			rn = rn->rn_parent;
998 		/* Find the next *leaf* since next node might vanish, too */
999 		for (rn = rn->rn_parent->rn_right; rn->rn_bit >= 0;)
1000 			rn = rn->rn_left;
1001 		next = rn;
1002 		/* Process leaves */
1003 		while ((rn = base)) {
1004 			base = rn->rn_dupedkey;
1005 			if (!(rn->rn_flags & RNF_ROOT)
1006 			    && (error = (*f)(rn, w)))
1007 				return (error);
1008 		}
1009 		rn = next;
1010 		if (rn->rn_flags & RNF_ROOT)
1011 			return (0);
1012 	}
1013 	/* NOTREACHED */
1014 }
1015 
1016 int
1017 rn_inithead(head, off)
1018 	void **head;
1019 	int off;
1020 {
1021 	register struct radix_node_head *rnh;
1022 	register struct radix_node *t, *tt, *ttt;
1023 	if (*head)
1024 		return (1);
1025 	R_Malloc(rnh, struct radix_node_head *, sizeof (*rnh));
1026 	if (rnh == 0)
1027 		return (0);
1028 	Bzero(rnh, sizeof (*rnh));
1029 	*head = rnh;
1030 	t = rn_newpair(rn_zeros, off, rnh->rnh_nodes);
1031 	ttt = rnh->rnh_nodes + 2;
1032 	t->rn_right = ttt;
1033 	t->rn_parent = t;
1034 	tt = t->rn_left;
1035 	tt->rn_flags = t->rn_flags = RNF_ROOT | RNF_ACTIVE;
1036 	tt->rn_bit = -1 - off;
1037 	*ttt = *tt;
1038 	ttt->rn_key = rn_ones;
1039 	rnh->rnh_addaddr = rn_addroute;
1040 	rnh->rnh_deladdr = rn_delete;
1041 	rnh->rnh_matchaddr = rn_match;
1042 	rnh->rnh_lookup = rn_lookup;
1043 	rnh->rnh_walktree = rn_walktree;
1044 	rnh->rnh_walktree_from = rn_walktree_from;
1045 	rnh->rnh_treetop = t;
1046 	return (1);
1047 }
1048 
1049 void
1050 rn_init()
1051 {
1052 	char *cp, *cplim;
1053 #ifdef _KERNEL
1054 	struct domain *dom;
1055 
1056 	for (dom = domains; dom; dom = dom->dom_next)
1057 		if (dom->dom_maxrtkey > max_keylen)
1058 			max_keylen = dom->dom_maxrtkey;
1059 #endif
1060 	if (max_keylen == 0) {
1061 		log(LOG_ERR,
1062 		    "rn_init: radix functions require max_keylen be set\n");
1063 		return;
1064 	}
1065 	R_Malloc(rn_zeros, char *, 3 * max_keylen);
1066 	if (rn_zeros == NULL)
1067 		panic("rn_init");
1068 	Bzero(rn_zeros, 3 * max_keylen);
1069 	rn_ones = cp = rn_zeros + max_keylen;
1070 	addmask_key = cplim = rn_ones + max_keylen;
1071 	while (cp < cplim)
1072 		*cp++ = -1;
1073 	if (rn_inithead((void **)&mask_rnhead, 0) == 0)
1074 		panic("rn_init 2");
1075 }
1076