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