bsd/net/radix.h

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