sys/net/radix.h

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