bsd/net/radix.h

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