bsd/net/radix.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  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 #include <sys/appleapiopts.h>
  61
  62 #if !defined(KERNEL) || defined(__APPLE_API_PRIVATE)
  63
  64 #ifdef MALLOC_DECLARE
  65 MALLOC_DECLARE(M_RTABLE);
  66 #endif
  67
  68 /*
  69  * Radix search tree node layout.
  70  */
  71
  72 struct radix_node {
  73         struct  radix_mask *rn_mklist;  /* list of masks contained in subtree */
  74         struct  radix_node *rn_parent;  /* parent */
  75         short   rn_bit;                 /* bit offset; -1-index(netmask) */
  76         char    rn_bmask;               /* node: mask for bit test*/
  77         u_char  rn_flags;               /* enumerated next */
  78 #define RNF_NORMAL      1               /* leaf contains normal route */
  79 #define RNF_ROOT        2               /* leaf is root leaf for tree */
  80 #define RNF_ACTIVE      4               /* This node is alive (for rtfree) */
  81         union {
  82                 struct {                        /* leaf only data: */
  83                         caddr_t rn_Key;         /* object of search */
  84                         caddr_t rn_Mask;        /* netmask, if present */
  85                         struct  radix_node *rn_Dupedkey;
  86                 } rn_leaf;
  87                 struct {                        /* node only data: */
  88                         int     rn_Off;         /* where to start compare */
  89                         struct  radix_node *rn_L;/* progeny */
  90                         struct  radix_node *rn_R;/* progeny */
  91                 } rn_node;
  92         }               rn_u;
  93 #ifdef RN_DEBUG
  94         int rn_info;
  95         struct radix_node *rn_twin;
  96         struct radix_node *rn_ybro;
  97 #endif
  98 };
  99
 100 #define rn_dupedkey     rn_u.rn_leaf.rn_Dupedkey
 101 #define rn_key          rn_u.rn_leaf.rn_Key
 102 #define rn_mask         rn_u.rn_leaf.rn_Mask
 103 #define rn_offset       rn_u.rn_node.rn_Off
 104 #define rn_left         rn_u.rn_node.rn_L
 105 #define rn_right        rn_u.rn_node.rn_R
 106
 107 #if 0
 108 /* for backward compatibility with previous definitions */
 109 #define rn_p            rn_parent
 110 #define rn_b            rn_bit
 111 #define rn_off          rn_offset
 112 #define rn_l            rn_left
 113 #define rn_r            rn_right
 114 #endif
 115 /*
 116  * Annotations to tree concerning potential routes applying to subtrees.
 117  */
 118
 119 struct radix_mask {
 120         short   rm_bit;                 /* bit offset; -1-index(netmask) */
 121         char    rm_unused;              /* cf. rn_bmask */
 122         u_char  rm_flags;               /* cf. rn_flags */
 123         struct  radix_mask *rm_mklist;  /* more masks to try */
 124         union   {
 125                 caddr_t rmu_mask;               /* the mask */
 126                 struct  radix_node *rmu_leaf;   /* for normal routes */
 127         }       rm_rmu;
 128         int     rm_refs;                /* # of references to this struct */
 129 };
 130
 131 #define rm_mask rm_rmu.rmu_mask
 132 #define rm_leaf rm_rmu.rmu_leaf         /* extra field would make 32 bytes */
 133
 134
 135 #define MKGet(m) {\
 136         if (rn_mkfreelist) {\
 137                 m = rn_mkfreelist; \
 138                 rn_mkfreelist = (m)->rm_mklist; \
 139         } else \
 140                 R_Malloc(m, struct radix_mask *, sizeof (*(m))); }\
 141
 142 #define MKFree(m) { (m)->rm_mklist = rn_mkfreelist; rn_mkfreelist = (m);}
 143
 144 typedef int walktree_f_t __P((struct radix_node *, void *));
 145
 146 struct radix_node_head {
 147         struct  radix_node *rnh_treetop;
 148         int     rnh_addrsize;           /* permit, but not require fixed keys */
 149         int     rnh_pktsize;            /* permit, but not require fixed keys */
 150         struct  radix_node *(*rnh_addaddr)      /* add based on sockaddr */
 151                 __P((void *v, void *mask,
 152                      struct radix_node_head *head, struct radix_node nodes[]));
 153         struct  radix_node *(*rnh_addpkt)       /* add based on packet hdr */
 154                 __P((void *v, void *mask,
 155                      struct radix_node_head *head, struct radix_node nodes[]));
 156         struct  radix_node *(*rnh_deladdr)      /* remove based on sockaddr */
 157                 __P((void *v, void *mask, struct radix_node_head *head));
 158         struct  radix_node *(*rnh_delpkt)       /* remove based on packet hdr */
 159                 __P((void *v, void *mask, struct radix_node_head *head));
 160         struct  radix_node *(*rnh_matchaddr)    /* locate based on sockaddr */
 161                 __P((void *v, struct radix_node_head *head));
 162         struct  radix_node *(*rnh_lookup)       /* locate based on sockaddr */
 163                 __P((void *v, void *mask, struct radix_node_head *head));
 164         struct  radix_node *(*rnh_matchpkt)     /* locate based on packet hdr */
 165                 __P((void *v, struct radix_node_head *head));
 166         int     (*rnh_walktree)                 /* traverse tree */
 167                 __P((struct radix_node_head *head, walktree_f_t *f, void *w));
 168         int     (*rnh_walktree_from)            /* traverse tree below a */
 169                 __P((struct radix_node_head *head, void *a, void *m,
 170                      walktree_f_t *f, void *w));
 171         void    (*rnh_close)    /* do something when the last ref drops */
 172                 __P((struct radix_node *rn, struct radix_node_head *head));
 173         struct  radix_node rnh_nodes[3];        /* empty tree for common case */
 174 };
 175
 176 #ifndef KERNEL
 177 #define Bcmp(a, b, n) bcmp(((char *)(a)), ((char *)(b)), (n))
 178 #define Bcopy(a, b, n) bcopy(((char *)(a)), ((char *)(b)), (unsigned)(n))
 179 #define Bzero(p, n) bzero((char *)(p), (int)(n));
 180 #define R_Malloc(p, t, n) (p = (t) malloc((unsigned int)(n)))
 181 #define Free(p) free((char *)p);
 182 #else
 183 #define Bcmp(a, b, n) bcmp(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
 184 #define Bcopy(a, b, n) bcopy(((caddr_t)(a)), ((caddr_t)(b)), (unsigned)(n))
 185 #define Bzero(p, n) bzero((caddr_t)(p), (unsigned)(n));
 186 #define R_Malloc(p, t, n) (p = (t) _MALLOC((unsigned long)(n), M_RTABLE, M_WAITOK))
 187 #define Free(p) FREE((caddr_t)p, M_RTABLE);
 188 #endif /*KERNEL*/
 189
 190 void     rn_init __P((void));
 191 int      rn_inithead __P((void **, int));
 192 int      rn_refines __P((void *, void *));
 193 struct radix_node
 194          *rn_addmask __P((void *, int, int)),
 195          *rn_addroute __P((void *, void *, struct radix_node_head *,
 196                         struct radix_node [2])),
 197          *rn_delete __P((void *, void *, struct radix_node_head *)),
 198          *rn_lookup __P((void *v_arg, void *m_arg,
 199                         struct radix_node_head *head)),
 200          *rn_match __P((void *, struct radix_node_head *));
 201
 202 #endif /* __APPLE_API_PRIVATE || !KERNEL */
 203 #endif /* _RADIX_H_ */