packages/net/bsd_tcpip/v2_0/include/net/radix.h

   1 //==========================================================================
   2 //
   3 //      include/net/radix.h
   4 //
   5 //==========================================================================
   6 //####BSDCOPYRIGHTBEGIN####
   7 //
   8 // -------------------------------------------
   9 //
  10 // Portions of this software may have been derived from OpenBSD,
  11 // FreeBSD or other sources, and are covered by the appropriate
  12 // copyright disclaimers included herein.
  13 //
  14 // Portions created by Red Hat are
  15 // Copyright (C) 2002 Red Hat, Inc. All Rights Reserved.
  16 //
  17 // -------------------------------------------
  18 //
  19 //####BSDCOPYRIGHTEND####
  20 //==========================================================================
  21
  22 /*
  23  * Copyright (c) 1988, 1989, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions
  28  * are met:
  29  * 1. Redistributions of source code must retain the above copyright
  30  *    notice, this list of conditions and the following disclaimer.
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in the
  33  *    documentation and/or other materials provided with the distribution.
  34  * 3. All advertising materials mentioning features or use of this software
  35  *    must display the following acknowledgement:
  36  *      This product includes software developed by the University of
  37  *      California, Berkeley and its contributors.
  38  * 4. Neither the name of the University nor the names of its contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  *      @(#)radix.h     8.2 (Berkeley) 10/31/94
  55  * $FreeBSD: src/sys/net/radix.h,v 1.16.2.1 2000/05/03 19:17:11 wollman Exp $
  56  */
  57
  58 #ifndef _RADIX_H_
  59 #define _RADIX_H_
  60
  61 /*
  62  * Radix search tree node layout.
  63  */
  64
  65 struct radix_node {
  66         struct  radix_mask *rn_mklist;  /* list of masks contained in subtree */
  67         struct  radix_node *rn_parent;  /* parent */
  68         short   rn_bit;                 /* bit offset; -1-index(netmask) */
  69         char    rn_bmask;               /* node: mask for bit test*/
  70         u_char  rn_flags;               /* enumerated next */
  71 #define RNF_NORMAL      1               /* leaf contains normal route */
  72 #define RNF_ROOT        2               /* leaf is root leaf for tree */
  73 #define RNF_ACTIVE      4               /* This node is alive (for rtfree) */
  74         union {
  75                 struct {                        /* leaf only data: */
  76                         caddr_t rn_Key;         /* object of search */
  77                         caddr_t rn_Mask;        /* netmask, if present */
  78                         struct  radix_node *rn_Dupedkey;
  79                 } rn_leaf;
  80                 struct {                        /* node only data: */
  81                         int     rn_Off;         /* where to start compare */
  82                         struct  radix_node *rn_L;/* progeny */
  83                         struct  radix_node *rn_R;/* progeny */
  84                 } rn_node;
  85         }               rn_u;
  86 #ifdef RN_DEBUG
  87         int rn_info;
  88         struct radix_node *rn_twin;
  89         struct radix_node *rn_ybro;
  90 #endif
  91 };
  92
  93 #define rn_dupedkey     rn_u.rn_leaf.rn_Dupedkey
  94 #define rn_key          rn_u.rn_leaf.rn_Key
  95 #define rn_mask         rn_u.rn_leaf.rn_Mask
  96 #define rn_offset       rn_u.rn_node.rn_Off
  97 #define rn_left         rn_u.rn_node.rn_L
  98 #define rn_right        rn_u.rn_node.rn_R
  99
 100 /*
 101  * Annotations to tree concerning potential routes applying to subtrees.
 102  */
 103
 104 struct radix_mask {
 105         short   rm_bit;                 /* bit offset; -1-index(netmask) */
 106         char    rm_unused;              /* cf. rn_bmask */
 107         u_char  rm_flags;               /* cf. rn_flags */
 108         struct  radix_mask *rm_mklist;  /* more masks to try */
 109         union   {
 110                 caddr_t rmu_mask;               /* the mask */
 111                 struct  radix_node *rmu_leaf;   /* for normal routes */
 112         }       rm_rmu;
 113         int     rm_refs;                /* # of references to this struct */
 114 };
 115
 116 #define rm_mask rm_rmu.rmu_mask
 117 #define rm_leaf rm_rmu.rmu_leaf         /* extra field would make 32 bytes */
 118
 119 #define MKGet(m) {\
 120         if (rn_mkfreelist) {\
 121                 m = rn_mkfreelist; \
 122                 rn_mkfreelist = (m)->rm_mklist; \
 123         } else \
 124                 R_Malloc(m, struct radix_mask *, sizeof (*(m))); }\
 125
 126 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
 127
 128 typedef int walktree_f_t __P((struct radix_node *, void *));
 129
 130 struct radix_node_head {
 131         struct  radix_node *rnh_treetop;
 132         int     rnh_addrsize;           /* permit, but not require fixed keys */
 133         int     rnh_pktsize;            /* permit, but not require fixed keys */
 134         struct  radix_node *(*rnh_addaddr)      /* add based on sockaddr */
 135                 __P((void *v, void *mask,
 136                      struct radix_node_head *head, struct radix_node nodes[]));
 137         struct  radix_node *(*rnh_addpkt)       /* add based on packet hdr */
 138                 __P((void *v, void *mask,
 139                      struct radix_node_head *head, struct radix_node nodes[]));
 140         struct  radix_node *(*rnh_deladdr)      /* remove based on sockaddr */
 141                 __P((void *v, void *mask, struct radix_node_head *head));
 142         struct  radix_node *(*rnh_delpkt)       /* remove based on packet hdr */
 143                 __P((void *v, void *mask, struct radix_node_head *head));
 144         struct  radix_node *(*rnh_matchaddr)    /* locate based on sockaddr */
 145                 __P((void *v, struct radix_node_head *head));
 146         struct  radix_node *(*rnh_lookup)       /* locate based on sockaddr */
 147                 __P((void *v, void *mask, struct radix_node_head *head));
 148         struct  radix_node *(*rnh_matchpkt)     /* locate based on packet hdr */
 149                 __P((void *v, struct radix_node_head *head));
 150         int     (*rnh_walktree)                 /* traverse tree */
 151                 __P((struct radix_node_head *head, walktree_f_t *f, void *w));
 152         int     (*rnh_walktree_from)            /* traverse tree below a */
 153                 __P((struct radix_node_head *head, void *a, void *m,
 154                      walktree_f_t *f, void *w));
 155         void    (*rnh_close)    /* do something when the last ref drops */
 156                 __P((struct radix_node *rn, struct radix_node_head *head));
 157         struct  radix_node rnh_nodes[3];        /* empty tree for common case */
 158 };
 159
 160 #ifndef _KERNEL
 161 #define Bcmp(a, b, n) bcmp(((char *)(a)), ((char *)(b)), (n))
 162 #define Bcopy(a, b, n) bcopy(((char *)(a)), ((char *)(b)), (unsigned)(n))
 163 #define Bzero(p, n) bzero((char *)(p), (int)(n));
 164 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n)))
 165 #define R_Free(p) free((char *)p);
 166 #else
 167 #define Bcmp(a, b, n) bcmp(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
 168 #define Bcopy(a, b, n) bcopy(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
 169 #define Bzero(p, n) bzero((caddr_t)(p), (unsigned)(n));
 170 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned long)(n), M_RTABLE, M_DONTWAIT))
 171 #define R_Free(p) free((caddr_t)p, M_RTABLE);
 172 #endif /* _KERNEL */
 173
 174 void     rn_init __P((void));
 175 int      rn_inithead __P((void **, int));
 176 int      rn_refines __P((void *, void *));
 177 struct radix_node
 178          *rn_addmask __P((void *, int, int)),
 179          *rn_addroute __P((void *, void *, struct radix_node_head *,
 180                         struct radix_node [2])),
 181          *rn_delete __P((void *, void *, struct radix_node_head *)),
 182          *rn_lookup __P((void *v_arg, void *m_arg,
 183                         struct radix_node_head *head)),
 184          *rn_match __P((void *, struct radix_node_head *));
 185
 186
 187 #endif /* _RADIX_H_ */