usr/src/cmd/cmd-inet/usr.sbin/in.routed/radix.h

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