sys/net/radix.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1988, 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)radix.c     8.5 (Berkeley) 5/19/95
  32  * $FreeBSD$
  33  */
  34
  35 /*
  36  * Routines to build and maintain radix trees for routing lookups.
  37  */
  38 #include <sys/param.h>
  39 #ifdef  _KERNEL
  40 #include <sys/lock.h>
  41 #include <sys/mutex.h>
  42 #include <sys/rmlock.h>
  43 #include <sys/systm.h>
  44 #include <sys/malloc.h>
  45 #include <sys/syslog.h>
  46 #include <net/radix.h>
  47 #else /* !_KERNEL */
  48 #include <stdio.h>
  49 #include <strings.h>
  50 #include <stdlib.h>
  51 #define log(x, arg...)  fprintf(stderr, ## arg)
  52 #define panic(x)        fprintf(stderr, "PANIC: %s", x), exit(1)
  53 #define min(a, b) ((a) < (b) ? (a) : (b) )
  54 #include <net/radix.h>
  55 #endif /* !_KERNEL */
  56
  57 static struct radix_node
  58          *rn_insert(void *, struct radix_head *, int *,
  59              struct radix_node [2]),
  60          *rn_newpair(void *, int, struct radix_node[2]),
  61          *rn_search(void *, struct radix_node *),
  62          *rn_search_m(void *, struct radix_node *, void *);
  63 static struct radix_node *rn_addmask(void *, struct radix_mask_head *, int,int);
  64
  65 static void rn_detachhead_internal(struct radix_head *);
  66
  67 #define RADIX_MAX_KEY_LEN       32
  68
  69 static char rn_zeros[RADIX_MAX_KEY_LEN];
  70 static char rn_ones[RADIX_MAX_KEY_LEN] = {
  71         -1, -1, -1, -1, -1, -1, -1, -1,
  72         -1, -1, -1, -1, -1, -1, -1, -1,
  73         -1, -1, -1, -1, -1, -1, -1, -1,
  74         -1, -1, -1, -1, -1, -1, -1, -1,
  75 };
  76
  77 static int      rn_lexobetter(void *m_arg, void *n_arg);
  78 static struct radix_mask *
  79                 rn_new_radix_mask(struct radix_node *tt,
  80                     struct radix_mask *next);
  81 static int      rn_satisfies_leaf(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 /*
 119  * Most of the functions in this code assume that the key/mask arguments
 120  * are sockaddr-like structures, where the first byte is an u_char
 121  * indicating the size of the entire structure.
 122  *
 123  * To make the assumption more explicit, we use the LEN() macro to access
 124  * this field. It is safe to pass an expression with side effects
 125  * to LEN() as the argument is evaluated only once.
 126  * We cast the result to int as this is the dominant usage.
 127  */
 128 #define LEN(x) ( (int) (*(const u_char *)(x)) )
 129
 130 /*
 131  * XXX THIS NEEDS TO BE FIXED
 132  * In the code, pointers to keys and masks are passed as either
 133  * 'void *' (because callers use to pass pointers of various kinds), or
 134  * 'caddr_t' (which is fine for pointer arithmetics, but not very
 135  * clean when you dereference it to access data). Furthermore, caddr_t
 136  * is really 'char *', while the natural type to operate on keys and
 137  * masks would be 'u_char'. This mismatch require a lot of casts and
 138  * intermediate variables to adapt types that clutter the code.
 139  */
 140
 141 /*
 142  * Search a node in the tree matching the key.
 143  */
 144 static struct radix_node *
 145 rn_search(void *v_arg, struct radix_node *head)
 146 {
 147         struct radix_node *x;
 148         caddr_t v;
 149
 150         for (x = head, v = v_arg; x->rn_bit >= 0;) {
 151                 if (x->rn_bmask & v[x->rn_offset])
 152                         x = x->rn_right;
 153                 else
 154                         x = x->rn_left;
 155         }
 156         return (x);
 157 }
 158
 159 /*
 160  * Same as above, but with an additional mask.
 161  * XXX note this function is used only once.
 162  */
 163 static struct radix_node *
 164 rn_search_m(void *v_arg, struct radix_node *head, void *m_arg)
 165 {
 166         struct radix_node *x;
 167         caddr_t v = v_arg, m = m_arg;
 168
 169         for (x = head; x->rn_bit >= 0;) {
 170                 if ((x->rn_bmask & m[x->rn_offset]) &&
 171                     (x->rn_bmask & v[x->rn_offset]))
 172                         x = x->rn_right;
 173                 else
 174                         x = x->rn_left;
 175         }
 176         return (x);
 177 }
 178
 179 int
 180 rn_refines(void *m_arg, void *n_arg)
 181 {
 182         caddr_t m = m_arg, n = n_arg;
 183         caddr_t lim, lim2 = lim = n + LEN(n);
 184         int longer = LEN(n++) - LEN(m++);
 185         int masks_are_equal = 1;
 186
 187         if (longer > 0)
 188                 lim -= longer;
 189         while (n < lim) {
 190                 if (*n & ~(*m))
 191                         return (0);
 192                 if (*n++ != *m++)
 193                         masks_are_equal = 0;
 194         }
 195         while (n < lim2)
 196                 if (*n++)
 197                         return (0);
 198         if (masks_are_equal && (longer < 0))
 199                 for (lim2 = m - longer; m < lim2; )
 200                         if (*m++)
 201                                 return (1);
 202         return (!masks_are_equal);
 203 }
 204
 205 /*
 206  * Search for exact match in given @head.
 207  * Assume host bits are cleared in @v_arg if @m_arg is not NULL
 208  * Note that prefixes with /32 or /128 masks are treated differently
 209  * from host routes.
 210  */
 211 struct radix_node *
 212 rn_lookup(void *v_arg, void *m_arg, struct radix_head *head)
 213 {
 214         struct radix_node *x;
 215         caddr_t netmask;
 216
 217         if (m_arg != NULL) {
 218                 /*
 219                  * Most common case: search exact prefix/mask
 220                  */
 221                 x = rn_addmask(m_arg, head->rnh_masks, 1,
 222                     head->rnh_treetop->rn_offset);
 223                 if (x == NULL)
 224                         return (NULL);
 225                 netmask = x->rn_key;
 226
 227                 x = rn_match(v_arg, head);
 228
 229                 while (x != NULL && x->rn_mask != netmask)
 230                         x = x->rn_dupedkey;
 231
 232                 return (x);
 233         }
 234
 235         /*
 236          * Search for host address.
 237          */
 238         if ((x = rn_match(v_arg, head)) == NULL)
 239                 return (NULL);
 240
 241         /* Check if found key is the same */
 242         if (LEN(x->rn_key) != LEN(v_arg) || bcmp(x->rn_key, v_arg, LEN(v_arg)))
 243                 return (NULL);
 244
 245         /* Check if this is not host route */
 246         if (x->rn_mask != NULL)
 247                 return (NULL);
 248
 249         return (x);
 250 }
 251
 252 static int
 253 rn_satisfies_leaf(char *trial, struct radix_node *leaf, int skip)
 254 {
 255         char *cp = trial, *cp2 = leaf->rn_key, *cp3 = leaf->rn_mask;
 256         char *cplim;
 257         int length = min(LEN(cp), LEN(cp2));
 258
 259         if (cp3 == NULL)
 260                 cp3 = rn_ones;
 261         else
 262                 length = min(length, LEN(cp3));
 263         cplim = cp + length; cp3 += skip; cp2 += skip;
 264         for (cp += skip; cp < cplim; cp++, cp2++, cp3++)
 265                 if ((*cp ^ *cp2) & *cp3)
 266                         return (0);
 267         return (1);
 268 }
 269
 270 /*
 271  * Search for longest-prefix match in given @head
 272  */
 273 struct radix_node *
 274 rn_match(void *v_arg, struct radix_head *head)
 275 {
 276         caddr_t v = v_arg;
 277         struct radix_node *t = head->rnh_treetop, *x;
 278         caddr_t cp = v, cp2;
 279         caddr_t cplim;
 280         struct radix_node *saved_t, *top = t;
 281         int off = t->rn_offset, vlen = LEN(cp), matched_off;
 282         int test, b, rn_bit;
 283
 284         /*
 285          * Open code rn_search(v, top) to avoid overhead of extra
 286          * subroutine call.
 287          */
 288         for (; t->rn_bit >= 0; ) {
 289                 if (t->rn_bmask & cp[t->rn_offset])
 290                         t = t->rn_right;
 291                 else
 292                         t = t->rn_left;
 293         }
 294         /*
 295          * See if we match exactly as a host destination
 296          * or at least learn how many bits match, for normal mask finesse.
 297          *
 298          * It doesn't hurt us to limit how many bytes to check
 299          * to the length of the mask, since if it matches we had a genuine
 300          * match and the leaf we have is the most specific one anyway;
 301          * if it didn't match with a shorter length it would fail
 302          * with a long one.  This wins big for class B&C netmasks which
 303          * are probably the most common case...
 304          */
 305         if (t->rn_mask)
 306                 vlen = *(u_char *)t->rn_mask;
 307         cp += off; cp2 = t->rn_key + off; cplim = v + vlen;
 308         for (; cp < cplim; cp++, cp2++)
 309                 if (*cp != *cp2)
 310                         goto on1;
 311         /*
 312          * This extra grot is in case we are explicitly asked
 313          * to look up the default.  Ugh!
 314          *
 315          * Never return the root node itself, it seems to cause a
 316          * lot of confusion.
 317          */
 318         if (t->rn_flags & RNF_ROOT)
 319                 t = t->rn_dupedkey;
 320         return (t);
 321 on1:
 322         test = (*cp ^ *cp2) & 0xff; /* find first bit that differs */
 323         for (b = 7; (test >>= 1) > 0;)
 324                 b--;
 325         matched_off = cp - v;
 326         b += matched_off << 3;
 327         rn_bit = -1 - b;
 328         /*
 329          * If there is a host route in a duped-key chain, it will be first.
 330          */
 331         if ((saved_t = t)->rn_mask == 0)
 332                 t = t->rn_dupedkey;
 333         for (; t; t = t->rn_dupedkey)
 334                 /*
 335                  * Even if we don't match exactly as a host,
 336                  * we may match if the leaf we wound up at is
 337                  * a route to a net.
 338                  */
 339                 if (t->rn_flags & RNF_NORMAL) {
 340                         if (rn_bit <= t->rn_bit)
 341                                 return (t);
 342                 } else if (rn_satisfies_leaf(v, t, matched_off))
 343                                 return (t);
 344         t = saved_t;
 345         /* start searching up the tree */
 346         do {
 347                 struct radix_mask *m;
 348                 t = t->rn_parent;
 349                 m = t->rn_mklist;
 350                 /*
 351                  * If non-contiguous masks ever become important
 352                  * we can restore the masking and open coding of
 353                  * the search and satisfaction test and put the
 354                  * calculation of "off" back before the "do".
 355                  */
 356                 while (m) {
 357                         if (m->rm_flags & RNF_NORMAL) {
 358                                 if (rn_bit <= m->rm_bit)
 359                                         return (m->rm_leaf);
 360                         } else {
 361                                 off = min(t->rn_offset, matched_off);
 362                                 x = rn_search_m(v, t, m->rm_mask);
 363                                 while (x && x->rn_mask != m->rm_mask)
 364                                         x = x->rn_dupedkey;
 365                                 if (x && rn_satisfies_leaf(v, x, off))
 366                                         return (x);
 367                         }
 368                         m = m->rm_mklist;
 369                 }
 370         } while (t != top);
 371         return (0);
 372 }
 373
 374 #ifdef RN_DEBUG
 375 int     rn_nodenum;
 376 struct  radix_node *rn_clist;
 377 int     rn_saveinfo;
 378 int     rn_debug =  1;
 379 #endif
 380
 381 /*
 382  * Whenever we add a new leaf to the tree, we also add a parent node,
 383  * so we allocate them as an array of two elements: the first one must be
 384  * the leaf (see RNTORT() in route.c), the second one is the parent.
 385  * This routine initializes the relevant fields of the nodes, so that
 386  * the leaf is the left child of the parent node, and both nodes have
 387  * (almost) all all fields filled as appropriate.
 388  * (XXX some fields are left unset, see the '#if 0' section).
 389  * The function returns a pointer to the parent node.
 390  */
 391
 392 static struct radix_node *
 393 rn_newpair(void *v, int b, struct radix_node nodes[2])
 394 {
 395         struct radix_node *tt = nodes, *t = tt + 1;
 396         t->rn_bit = b;
 397         t->rn_bmask = 0x80 >> (b & 7);
 398         t->rn_left = tt;
 399         t->rn_offset = b >> 3;
 400
 401 #if 0  /* XXX perhaps we should fill these fields as well. */
 402         t->rn_parent = t->rn_right = NULL;
 403
 404         tt->rn_mask = NULL;
 405         tt->rn_dupedkey = NULL;
 406         tt->rn_bmask = 0;
 407 #endif
 408         tt->rn_bit = -1;
 409         tt->rn_key = (caddr_t)v;
 410         tt->rn_parent = t;
 411         tt->rn_flags = t->rn_flags = RNF_ACTIVE;
 412         tt->rn_mklist = t->rn_mklist = 0;
 413 #ifdef RN_DEBUG
 414         tt->rn_info = rn_nodenum++; t->rn_info = rn_nodenum++;
 415         tt->rn_twin = t;
 416         tt->rn_ybro = rn_clist;
 417         rn_clist = tt;
 418 #endif
 419         return (t);
 420 }
 421
 422 static struct radix_node *
 423 rn_insert(void *v_arg, struct radix_head *head, int *dupentry,
 424     struct radix_node nodes[2])
 425 {
 426         caddr_t v = v_arg;
 427         struct radix_node *top = head->rnh_treetop;
 428         int head_off = top->rn_offset, vlen = LEN(v);
 429         struct radix_node *t = rn_search(v_arg, top);
 430         caddr_t cp = v + head_off;
 431         int b;
 432         struct radix_node *p, *tt, *x;
 433         /*
 434          * Find first bit at which v and t->rn_key differ
 435          */
 436         caddr_t cp2 = t->rn_key + head_off;
 437         int cmp_res;
 438         caddr_t cplim = v + vlen;
 439
 440         while (cp < cplim)
 441                 if (*cp2++ != *cp++)
 442                         goto on1;
 443         *dupentry = 1;
 444         return (t);
 445 on1:
 446         *dupentry = 0;
 447         cmp_res = (cp[-1] ^ cp2[-1]) & 0xff;
 448         for (b = (cp - v) << 3; cmp_res; b--)
 449                 cmp_res >>= 1;
 450
 451         x = top;
 452         cp = v;
 453         do {
 454                 p = x;
 455                 if (cp[x->rn_offset] & x->rn_bmask)
 456                         x = x->rn_right;
 457                 else
 458                         x = x->rn_left;
 459         } while (b > (unsigned) x->rn_bit);
 460                                 /* x->rn_bit < b && x->rn_bit >= 0 */
 461 #ifdef RN_DEBUG
 462         if (rn_debug)
 463                 log(LOG_DEBUG, "rn_insert: Going In:\n"), traverse(p);
 464 #endif
 465         t = rn_newpair(v_arg, b, nodes);
 466         tt = t->rn_left;
 467         if ((cp[p->rn_offset] & p->rn_bmask) == 0)
 468                 p->rn_left = t;
 469         else
 470                 p->rn_right = t;
 471         x->rn_parent = t;
 472         t->rn_parent = p; /* frees x, p as temp vars below */
 473         if ((cp[t->rn_offset] & t->rn_bmask) == 0) {
 474                 t->rn_right = x;
 475         } else {
 476                 t->rn_right = tt;
 477                 t->rn_left = x;
 478         }
 479 #ifdef RN_DEBUG
 480         if (rn_debug)
 481                 log(LOG_DEBUG, "rn_insert: Coming Out:\n"), traverse(p);
 482 #endif
 483         return (tt);
 484 }
 485
 486 struct radix_node *
 487 rn_addmask(void *n_arg, struct radix_mask_head *maskhead, int search, int skip)
 488 {
 489         unsigned char *netmask = n_arg;
 490         unsigned char *cp, *cplim;
 491         struct radix_node *x;
 492         int b = 0, mlen, j;
 493         int maskduplicated, isnormal;
 494         struct radix_node *saved_x;
 495         unsigned char addmask_key[RADIX_MAX_KEY_LEN];
 496
 497         if ((mlen = LEN(netmask)) > RADIX_MAX_KEY_LEN)
 498                 mlen = RADIX_MAX_KEY_LEN;
 499         if (skip == 0)
 500                 skip = 1;
 501         if (mlen <= skip)
 502                 return (maskhead->mask_nodes);
 503
 504         bzero(addmask_key, RADIX_MAX_KEY_LEN);
 505         if (skip > 1)
 506                 bcopy(rn_ones + 1, addmask_key + 1, skip - 1);
 507         bcopy(netmask + skip, addmask_key + skip, mlen - skip);
 508         /*
 509          * Trim trailing zeroes.
 510          */
 511         for (cp = addmask_key + mlen; (cp > addmask_key) && cp[-1] == 0;)
 512                 cp--;
 513         mlen = cp - addmask_key;
 514         if (mlen <= skip)
 515                 return (maskhead->mask_nodes);
 516         *addmask_key = mlen;
 517         x = rn_search(addmask_key, maskhead->head.rnh_treetop);
 518         if (bcmp(addmask_key, x->rn_key, mlen) != 0)
 519                 x = NULL;
 520         if (x || search)
 521                 return (x);
 522         R_Zalloc(x, struct radix_node *, RADIX_MAX_KEY_LEN + 2 * sizeof (*x));
 523         if ((saved_x = x) == NULL)
 524                 return (0);
 525         netmask = cp = (unsigned char *)(x + 2);
 526         bcopy(addmask_key, cp, mlen);
 527         x = rn_insert(cp, &maskhead->head, &maskduplicated, x);
 528         if (maskduplicated) {
 529                 log(LOG_ERR, "rn_addmask: mask impossibly already in tree");
 530                 R_Free(saved_x);
 531                 return (x);
 532         }
 533         /*
 534          * Calculate index of mask, and check for normalcy.
 535          * First find the first byte with a 0 bit, then if there are
 536          * more bits left (remember we already trimmed the trailing 0's),
 537          * the bits should be contiguous, otherwise we have got
 538          * a non-contiguous mask.
 539          */
 540 #define CONTIG(_c)      (((~(_c) + 1) & (_c)) == (unsigned char)(~(_c) + 1))
 541         cplim = netmask + mlen;
 542         isnormal = 1;
 543         for (cp = netmask + skip; (cp < cplim) && *(u_char *)cp == 0xff;)
 544                 cp++;
 545         if (cp != cplim) {
 546                 for (j = 0x80; (j & *cp) != 0; j >>= 1)
 547                         b++;
 548                 if (!CONTIG(*cp) || cp != (cplim - 1))
 549                         isnormal = 0;
 550         }
 551         b += (cp - netmask) << 3;
 552         x->rn_bit = -1 - b;
 553         if (isnormal)
 554                 x->rn_flags |= RNF_NORMAL;
 555         return (x);
 556 }
 557
 558 static int      /* XXX: arbitrary ordering for non-contiguous masks */
 559 rn_lexobetter(void *m_arg, void *n_arg)
 560 {
 561         u_char *mp = m_arg, *np = n_arg, *lim;
 562
 563         if (LEN(mp) > LEN(np))
 564                 return (1);  /* not really, but need to check longer one first */
 565         if (LEN(mp) == LEN(np))
 566                 for (lim = mp + LEN(mp); mp < lim;)
 567                         if (*mp++ > *np++)
 568                                 return (1);
 569         return (0);
 570 }
 571
 572 static struct radix_mask *
 573 rn_new_radix_mask(struct radix_node *tt, struct radix_mask *next)
 574 {
 575         struct radix_mask *m;
 576
 577         R_Malloc(m, struct radix_mask *, sizeof (struct radix_mask));
 578         if (m == NULL) {
 579                 log(LOG_ERR, "Failed to allocate route mask\n");
 580                 return (0);
 581         }
 582         bzero(m, sizeof(*m));
 583         m->rm_bit = tt->rn_bit;
 584         m->rm_flags = tt->rn_flags;
 585         if (tt->rn_flags & RNF_NORMAL)
 586                 m->rm_leaf = tt;
 587         else
 588                 m->rm_mask = tt->rn_mask;
 589         m->rm_mklist = next;
 590         tt->rn_mklist = m;
 591         return (m);
 592 }
 593
 594 struct radix_node *
 595 rn_addroute(void *v_arg, void *n_arg, struct radix_head *head,
 596     struct radix_node treenodes[2])
 597 {
 598         caddr_t v = (caddr_t)v_arg, netmask = (caddr_t)n_arg;
 599         struct radix_node *t, *x = NULL, *tt;
 600         struct radix_node *saved_tt, *top = head->rnh_treetop;
 601         short b = 0, b_leaf = 0;
 602         int keyduplicated;
 603         caddr_t mmask;
 604         struct radix_mask *m, **mp;
 605
 606         /*
 607          * In dealing with non-contiguous masks, there may be
 608          * many different routes which have the same mask.
 609          * We will find it useful to have a unique pointer to
 610          * the mask to speed avoiding duplicate references at
 611          * nodes and possibly save time in calculating indices.
 612          */
 613         if (netmask)  {
 614                 x = rn_addmask(netmask, head->rnh_masks, 0, top->rn_offset);
 615                 if (x == NULL)
 616                         return (0);
 617                 b_leaf = x->rn_bit;
 618                 b = -1 - x->rn_bit;
 619                 netmask = x->rn_key;
 620         }
 621         /*
 622          * Deal with duplicated keys: attach node to previous instance
 623          */
 624         saved_tt = tt = rn_insert(v, head, &keyduplicated, treenodes);
 625         if (keyduplicated) {
 626                 for (t = tt; tt; t = tt, tt = tt->rn_dupedkey) {
 627 #ifdef RADIX_MPATH
 628                         /* permit multipath, if enabled for the family */
 629                         if (rn_mpath_capable(head) && netmask == tt->rn_mask) {
 630                                 /*
 631                                  * go down to the end of multipaths, so that
 632                                  * new entry goes into the end of rn_dupedkey
 633                                  * chain.
 634                                  */
 635                                 do {
 636                                         t = tt;
 637                                         tt = tt->rn_dupedkey;
 638                                 } while (tt && t->rn_mask == tt->rn_mask);
 639                                 break;
 640                         }
 641 #endif
 642                         if (tt->rn_mask == netmask)
 643                                 return (0);
 644                         if (netmask == 0 ||
 645                             (tt->rn_mask &&
 646                              ((b_leaf < tt->rn_bit) /* index(netmask) > node */
 647                               || rn_refines(netmask, tt->rn_mask)
 648                               || rn_lexobetter(netmask, tt->rn_mask))))
 649                                 break;
 650                 }
 651                 /*
 652                  * If the mask is not duplicated, we wouldn't
 653                  * find it among possible duplicate key entries
 654                  * anyway, so the above test doesn't hurt.
 655                  *
 656                  * We sort the masks for a duplicated key the same way as
 657                  * in a masklist -- most specific to least specific.
 658                  * This may require the unfortunate nuisance of relocating
 659                  * the head of the list.
 660                  *
 661                  * We also reverse, or doubly link the list through the
 662                  * parent pointer.
 663                  */
 664                 if (tt == saved_tt) {
 665                         struct  radix_node *xx = x;
 666                         /* link in at head of list */
 667                         (tt = treenodes)->rn_dupedkey = t;
 668                         tt->rn_flags = t->rn_flags;
 669                         tt->rn_parent = x = t->rn_parent;
 670                         t->rn_parent = tt;                      /* parent */
 671                         if (x->rn_left == t)
 672                                 x->rn_left = tt;
 673                         else
 674                                 x->rn_right = tt;
 675                         saved_tt = tt; x = xx;
 676                 } else {
 677                         (tt = treenodes)->rn_dupedkey = t->rn_dupedkey;
 678                         t->rn_dupedkey = tt;
 679                         tt->rn_parent = t;                      /* parent */
 680                         if (tt->rn_dupedkey)                    /* parent */
 681                                 tt->rn_dupedkey->rn_parent = tt; /* parent */
 682                 }
 683 #ifdef RN_DEBUG
 684                 t=tt+1; tt->rn_info = rn_nodenum++; t->rn_info = rn_nodenum++;
 685                 tt->rn_twin = t; tt->rn_ybro = rn_clist; rn_clist = tt;
 686 #endif
 687                 tt->rn_key = (caddr_t) v;
 688                 tt->rn_bit = -1;
 689                 tt->rn_flags = RNF_ACTIVE;
 690         }
 691         /*
 692          * Put mask in tree.
 693          */
 694         if (netmask) {
 695                 tt->rn_mask = netmask;
 696                 tt->rn_bit = x->rn_bit;
 697                 tt->rn_flags |= x->rn_flags & RNF_NORMAL;
 698         }
 699         t = saved_tt->rn_parent;
 700         if (keyduplicated)
 701                 goto on2;
 702         b_leaf = -1 - t->rn_bit;
 703         if (t->rn_right == saved_tt)
 704                 x = t->rn_left;
 705         else
 706                 x = t->rn_right;
 707         /* Promote general routes from below */
 708         if (x->rn_bit < 0) {
 709             for (mp = &t->rn_mklist; x; x = x->rn_dupedkey)
 710                 if (x->rn_mask && (x->rn_bit >= b_leaf) && x->rn_mklist == 0) {
 711                         *mp = m = rn_new_radix_mask(x, 0);
 712                         if (m)
 713                                 mp = &m->rm_mklist;
 714                 }
 715         } else if (x->rn_mklist) {
 716                 /*
 717                  * Skip over masks whose index is > that of new node
 718                  */
 719                 for (mp = &x->rn_mklist; (m = *mp); mp = &m->rm_mklist)
 720                         if (m->rm_bit >= b_leaf)
 721                                 break;
 722                 t->rn_mklist = m; *mp = NULL;
 723         }
 724 on2:
 725         /* Add new route to highest possible ancestor's list */
 726         if ((netmask == 0) || (b > t->rn_bit ))
 727                 return (tt); /* can't lift at all */
 728         b_leaf = tt->rn_bit;
 729         do {
 730                 x = t;
 731                 t = t->rn_parent;
 732         } while (b <= t->rn_bit && x != top);
 733         /*
 734          * Search through routes associated with node to
 735          * insert new route according to index.
 736          * Need same criteria as when sorting dupedkeys to avoid
 737          * double loop on deletion.
 738          */
 739         for (mp = &x->rn_mklist; (m = *mp); mp = &m->rm_mklist) {
 740                 if (m->rm_bit < b_leaf)
 741                         continue;
 742                 if (m->rm_bit > b_leaf)
 743                         break;
 744                 if (m->rm_flags & RNF_NORMAL) {
 745                         mmask = m->rm_leaf->rn_mask;
 746                         if (tt->rn_flags & RNF_NORMAL) {
 747 #if !defined(RADIX_MPATH)
 748                             log(LOG_ERR,
 749                                 "Non-unique normal route, mask not entered\n");
 750 #endif
 751                                 return (tt);
 752                         }
 753                 } else
 754                         mmask = m->rm_mask;
 755                 if (mmask == netmask) {
 756                         m->rm_refs++;
 757                         tt->rn_mklist = m;
 758                         return (tt);
 759                 }
 760                 if (rn_refines(netmask, mmask)
 761                     || rn_lexobetter(netmask, mmask))
 762                         break;
 763         }
 764         *mp = rn_new_radix_mask(tt, *mp);
 765         return (tt);
 766 }
 767
 768 struct radix_node *
 769 rn_delete(void *v_arg, void *netmask_arg, struct radix_head *head)
 770 {
 771         struct radix_node *t, *p, *x, *tt;
 772         struct radix_mask *m, *saved_m, **mp;
 773         struct radix_node *dupedkey, *saved_tt, *top;
 774         caddr_t v, netmask;
 775         int b, head_off, vlen;
 776
 777         v = v_arg;
 778         netmask = netmask_arg;
 779         x = head->rnh_treetop;
 780         tt = rn_search(v, x);
 781         head_off = x->rn_offset;
 782         vlen =  LEN(v);
 783         saved_tt = tt;
 784         top = x;
 785         if (tt == NULL ||
 786             bcmp(v + head_off, tt->rn_key + head_off, vlen - head_off))
 787                 return (0);
 788         /*
 789          * Delete our route from mask lists.
 790          */
 791         if (netmask) {
 792                 x = rn_addmask(netmask, head->rnh_masks, 1, head_off);
 793                 if (x == NULL)
 794                         return (0);
 795                 netmask = x->rn_key;
 796                 while (tt->rn_mask != netmask)
 797                         if ((tt = tt->rn_dupedkey) == NULL)
 798                                 return (0);
 799         }
 800         if (tt->rn_mask == 0 || (saved_m = m = tt->rn_mklist) == NULL)
 801                 goto on1;
 802         if (tt->rn_flags & RNF_NORMAL) {
 803                 if (m->rm_leaf != tt || m->rm_refs > 0) {
 804                         log(LOG_ERR, "rn_delete: inconsistent annotation\n");
 805                         return (0);  /* dangling ref could cause disaster */
 806                 }
 807         } else {
 808                 if (m->rm_mask != tt->rn_mask) {
 809                         log(LOG_ERR, "rn_delete: inconsistent annotation\n");
 810                         goto on1;
 811                 }
 812                 if (--m->rm_refs >= 0)
 813                         goto on1;
 814         }
 815         b = -1 - tt->rn_bit;
 816         t = saved_tt->rn_parent;
 817         if (b > t->rn_bit)
 818                 goto on1; /* Wasn't lifted at all */
 819         do {
 820                 x = t;
 821                 t = t->rn_parent;
 822         } while (b <= t->rn_bit && x != top);
 823         for (mp = &x->rn_mklist; (m = *mp); mp = &m->rm_mklist)
 824                 if (m == saved_m) {
 825                         *mp = m->rm_mklist;
 826                         R_Free(m);
 827                         break;
 828                 }
 829         if (m == NULL) {
 830                 log(LOG_ERR, "rn_delete: couldn't find our annotation\n");
 831                 if (tt->rn_flags & RNF_NORMAL)
 832                         return (0); /* Dangling ref to us */
 833         }
 834 on1:
 835         /*
 836          * Eliminate us from tree
 837          */
 838         if (tt->rn_flags & RNF_ROOT)
 839                 return (0);
 840 #ifdef RN_DEBUG
 841         /* Get us out of the creation list */
 842         for (t = rn_clist; t && t->rn_ybro != tt; t = t->rn_ybro) {}
 843         if (t) t->rn_ybro = tt->rn_ybro;
 844 #endif
 845         t = tt->rn_parent;
 846         dupedkey = saved_tt->rn_dupedkey;
 847         if (dupedkey) {
 848                 /*
 849                  * Here, tt is the deletion target and
 850                  * saved_tt is the head of the dupekey chain.
 851                  */
 852                 if (tt == saved_tt) {
 853                         /* remove from head of chain */
 854                         x = dupedkey; x->rn_parent = t;
 855                         if (t->rn_left == tt)
 856                                 t->rn_left = x;
 857                         else
 858                                 t->rn_right = x;
 859                 } else {
 860                         /* find node in front of tt on the chain */
 861                         for (x = p = saved_tt; p && p->rn_dupedkey != tt;)
 862                                 p = p->rn_dupedkey;
 863                         if (p) {
 864                                 p->rn_dupedkey = tt->rn_dupedkey;
 865                                 if (tt->rn_dupedkey)            /* parent */
 866                                         tt->rn_dupedkey->rn_parent = p;
 867                                                                 /* parent */
 868                         } else log(LOG_ERR, "rn_delete: couldn't find us\n");
 869                 }
 870                 t = tt + 1;
 871                 if  (t->rn_flags & RNF_ACTIVE) {
 872 #ifndef RN_DEBUG
 873                         *++x = *t;
 874                         p = t->rn_parent;
 875 #else
 876                         b = t->rn_info;
 877                         *++x = *t;
 878                         t->rn_info = b;
 879                         p = t->rn_parent;
 880 #endif
 881                         if (p->rn_left == t)
 882                                 p->rn_left = x;
 883                         else
 884                                 p->rn_right = x;
 885                         x->rn_left->rn_parent = x;
 886                         x->rn_right->rn_parent = x;
 887                 }
 888                 goto out;
 889         }
 890         if (t->rn_left == tt)
 891                 x = t->rn_right;
 892         else
 893                 x = t->rn_left;
 894         p = t->rn_parent;
 895         if (p->rn_right == t)
 896                 p->rn_right = x;
 897         else
 898                 p->rn_left = x;
 899         x->rn_parent = p;
 900         /*
 901          * Demote routes attached to us.
 902          */
 903         if (t->rn_mklist) {
 904                 if (x->rn_bit >= 0) {
 905                         for (mp = &x->rn_mklist; (m = *mp);)
 906                                 mp = &m->rm_mklist;
 907                         *mp = t->rn_mklist;
 908                 } else {
 909                         /* If there are any key,mask pairs in a sibling
 910                            duped-key chain, some subset will appear sorted
 911                            in the same order attached to our mklist */
 912                         for (m = t->rn_mklist; m && x; x = x->rn_dupedkey)
 913                                 if (m == x->rn_mklist) {
 914                                         struct radix_mask *mm = m->rm_mklist;
 915                                         x->rn_mklist = 0;
 916                                         if (--(m->rm_refs) < 0)
 917                                                 R_Free(m);
 918                                         m = mm;
 919                                 }
 920                         if (m)
 921                                 log(LOG_ERR,
 922                                     "rn_delete: Orphaned Mask %p at %p\n",
 923                                     m, x);
 924                 }
 925         }
 926         /*
 927          * We may be holding an active internal node in the tree.
 928          */
 929         x = tt + 1;
 930         if (t != x) {
 931 #ifndef RN_DEBUG
 932                 *t = *x;
 933 #else
 934                 b = t->rn_info;
 935                 *t = *x;
 936                 t->rn_info = b;
 937 #endif
 938                 t->rn_left->rn_parent = t;
 939                 t->rn_right->rn_parent = t;
 940                 p = x->rn_parent;
 941                 if (p->rn_left == x)
 942                         p->rn_left = t;
 943                 else
 944                         p->rn_right = t;
 945         }
 946 out:
 947         tt->rn_flags &= ~RNF_ACTIVE;
 948         tt[1].rn_flags &= ~RNF_ACTIVE;
 949         return (tt);
 950 }
 951
 952 /*
 953  * This is the same as rn_walktree() except for the parameters and the
 954  * exit.
 955  */
 956 int
 957 rn_walktree_from(struct radix_head *h, void *a, void *m,
 958     walktree_f_t *f, void *w)
 959 {
 960         int error;
 961         struct radix_node *base, *next;
 962         u_char *xa = (u_char *)a;
 963         u_char *xm = (u_char *)m;
 964         struct radix_node *rn, *last = NULL; /* shut up gcc */
 965         int stopping = 0;
 966         int lastb;
 967
 968         KASSERT(m != NULL, ("%s: mask needs to be specified", __func__));
 969
 970         /*
 971          * rn_search_m is sort-of-open-coded here. We cannot use the
 972          * function because we need to keep track of the last node seen.
 973          */
 974         /* printf("about to search\n"); */
 975         for (rn = h->rnh_treetop; rn->rn_bit >= 0; ) {
 976                 last = rn;
 977                 /* printf("rn_bit %d, rn_bmask %x, xm[rn_offset] %x\n",
 978                        rn->rn_bit, rn->rn_bmask, xm[rn->rn_offset]); */
 979                 if (!(rn->rn_bmask & xm[rn->rn_offset])) {
 980                         break;
 981                 }
 982                 if (rn->rn_bmask & xa[rn->rn_offset]) {
 983                         rn = rn->rn_right;
 984                 } else {
 985                         rn = rn->rn_left;
 986                 }
 987         }
 988         /* printf("done searching\n"); */
 989
 990         /*
 991          * Two cases: either we stepped off the end of our mask,
 992          * in which case last == rn, or we reached a leaf, in which
 993          * case we want to start from the leaf.
 994          */
 995         if (rn->rn_bit >= 0)
 996                 rn = last;
 997         lastb = last->rn_bit;
 998
 999         /* printf("rn %p, lastb %d\n", rn, lastb);*/
1000
1001         /*
1002          * This gets complicated because we may delete the node
1003          * while applying the function f to it, so we need to calculate
1004          * the successor node in advance.
1005          */
1006         while (rn->rn_bit >= 0)
1007                 rn = rn->rn_left;
1008
1009         while (!stopping) {
1010                 /* printf("node %p (%d)\n", rn, rn->rn_bit); */
1011                 base = rn;
1012                 /* If at right child go back up, otherwise, go right */
1013                 while (rn->rn_parent->rn_right == rn
1014                        && !(rn->rn_flags & RNF_ROOT)) {
1015                         rn = rn->rn_parent;
1016
1017                         /* if went up beyond last, stop */
1018                         if (rn->rn_bit <= lastb) {
1019                                 stopping = 1;
1020                                 /* printf("up too far\n"); */
1021                                 /*
1022                                  * XXX we should jump to the 'Process leaves'
1023                                  * part, because the values of 'rn' and 'next'
1024                                  * we compute will not be used. Not a big deal
1025                                  * because this loop will terminate, but it is
1026                                  * inefficient and hard to understand!
1027                                  */
1028                         }
1029                 }
1030
1031                 /*
1032                  * At the top of the tree, no need to traverse the right
1033                  * half, prevent the traversal of the entire tree in the
1034                  * case of default route.
1035                  */
1036                 if (rn->rn_parent->rn_flags & RNF_ROOT)
1037                         stopping = 1;
1038
1039                 /* Find the next *leaf* since next node might vanish, too */
1040                 for (rn = rn->rn_parent->rn_right; rn->rn_bit >= 0;)
1041                         rn = rn->rn_left;
1042                 next = rn;
1043                 /* Process leaves */
1044                 while ((rn = base) != NULL) {
1045                         base = rn->rn_dupedkey;
1046                         /* printf("leaf %p\n", rn); */
1047                         if (!(rn->rn_flags & RNF_ROOT)
1048                             && (error = (*f)(rn, w)))
1049                                 return (error);
1050                 }
1051                 rn = next;
1052
1053                 if (rn->rn_flags & RNF_ROOT) {
1054                         /* printf("root, stopping"); */
1055                         stopping = 1;
1056                 }
1057         }
1058         return (0);
1059 }
1060
1061 int
1062 rn_walktree(struct radix_head *h, walktree_f_t *f, void *w)
1063 {
1064         int error;
1065         struct radix_node *base, *next;
1066         struct radix_node *rn = h->rnh_treetop;
1067         /*
1068          * This gets complicated because we may delete the node
1069          * while applying the function f to it, so we need to calculate
1070          * the successor node in advance.
1071          */
1072
1073         /* First time through node, go left */
1074         while (rn->rn_bit >= 0)
1075                 rn = rn->rn_left;
1076         for (;;) {
1077                 base = rn;
1078                 /* If at right child go back up, otherwise, go right */
1079                 while (rn->rn_parent->rn_right == rn
1080                        && (rn->rn_flags & RNF_ROOT) == 0)
1081                         rn = rn->rn_parent;
1082                 /* Find the next *leaf* since next node might vanish, too */
1083                 for (rn = rn->rn_parent->rn_right; rn->rn_bit >= 0;)
1084                         rn = rn->rn_left;
1085                 next = rn;
1086                 /* Process leaves */
1087                 while ((rn = base)) {
1088                         base = rn->rn_dupedkey;
1089                         if (!(rn->rn_flags & RNF_ROOT)
1090                             && (error = (*f)(rn, w)))
1091                                 return (error);
1092                 }
1093                 rn = next;
1094                 if (rn->rn_flags & RNF_ROOT)
1095                         return (0);
1096         }
1097         /* NOTREACHED */
1098 }
1099
1100 /*
1101  * Initialize an empty tree. This has 3 nodes, which are passed
1102  * via base_nodes (in the order <left,root,right>) and are
1103  * marked RNF_ROOT so they cannot be freed.
1104  * The leaves have all-zero and all-one keys, with significant
1105  * bits starting at 'off'.
1106  */
1107 void
1108 rn_inithead_internal(struct radix_head *rh, struct radix_node *base_nodes, int off)
1109 {
1110         struct radix_node *t, *tt, *ttt;
1111
1112         t = rn_newpair(rn_zeros, off, base_nodes);
1113         ttt = base_nodes + 2;
1114         t->rn_right = ttt;
1115         t->rn_parent = t;
1116         tt = t->rn_left;        /* ... which in turn is base_nodes */
1117         tt->rn_flags = t->rn_flags = RNF_ROOT | RNF_ACTIVE;
1118         tt->rn_bit = -1 - off;
1119         *ttt = *tt;
1120         ttt->rn_key = rn_ones;
1121
1122         rh->rnh_treetop = t;
1123 }
1124
1125 static void
1126 rn_detachhead_internal(struct radix_head *head)
1127 {
1128
1129         KASSERT((head != NULL),
1130             ("%s: head already freed", __func__));
1131
1132         /* Free <left,root,right> nodes. */
1133         R_Free(head);
1134 }
1135
1136 /* Functions used by 'struct radix_node_head' users */
1137
1138 int
1139 rn_inithead(void **head, int off)
1140 {
1141         struct radix_node_head *rnh;
1142         struct radix_mask_head *rmh;
1143
1144         rnh = *head;
1145         rmh = NULL;
1146
1147         if (*head != NULL)
1148                 return (1);
1149
1150         R_Zalloc(rnh, struct radix_node_head *, sizeof (*rnh));
1151         R_Zalloc(rmh, struct radix_mask_head *, sizeof (*rmh));
1152         if (rnh == NULL || rmh == NULL) {
1153                 if (rnh != NULL)
1154                         R_Free(rnh);
1155                 if (rmh != NULL)
1156                         R_Free(rmh);
1157                 return (0);
1158         }
1159
1160         /* Init trees */
1161         rn_inithead_internal(&rnh->rh, rnh->rnh_nodes, off);
1162         rn_inithead_internal(&rmh->head, rmh->mask_nodes, 0);
1163         *head = rnh;
1164         rnh->rh.rnh_masks = rmh;
1165
1166         /* Finally, set base callbacks */
1167         rnh->rnh_addaddr = rn_addroute;
1168         rnh->rnh_deladdr = rn_delete;
1169         rnh->rnh_matchaddr = rn_match;
1170         rnh->rnh_lookup = rn_lookup;
1171         rnh->rnh_walktree = rn_walktree;
1172         rnh->rnh_walktree_from = rn_walktree_from;
1173
1174         return (1);
1175 }
1176
1177 static int
1178 rn_freeentry(struct radix_node *rn, void *arg)
1179 {
1180         struct radix_head * const rnh = arg;
1181         struct radix_node *x;
1182
1183         x = (struct radix_node *)rn_delete(rn + 2, NULL, rnh);
1184         if (x != NULL)
1185                 R_Free(x);
1186         return (0);
1187 }
1188
1189 int
1190 rn_detachhead(void **head)
1191 {
1192         struct radix_node_head *rnh;
1193
1194         KASSERT((head != NULL && *head != NULL),
1195             ("%s: head already freed", __func__));
1196
1197         rnh = (struct radix_node_head *)(*head);
1198
1199         rn_walktree(&rnh->rh.rnh_masks->head, rn_freeentry, rnh->rh.rnh_masks);
1200         rn_detachhead_internal(&rnh->rh.rnh_masks->head);
1201         rn_detachhead_internal(&rnh->rh);
1202
1203         *head = NULL;
1204
1205         return (1);
1206 }