bsd/net/radix.h

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