bsd/netat/routing_tables.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  *    This include file defines the RTMP table and ZIP table
  25  *    for the AppleTalk AIX router
  26  *
  27  *
  28  *  0.01        03/16/94        LD      Creation
  29  *  0.10        08/19/94        LD      merged
  30  *
  31  */
  32
  33 #ifndef _NETAT_ROUTING_TABLES_H_
  34 #define _NETAT_ROUTING_TABLES_H_
  35 #include <sys/appleapiopts.h>
  36 #ifdef PRIVATE
  37
  38 /* RTMP table entry state bitmap (EntryState) values */
  39
  40 #define RTE_STATE_UNUSED        0               /* this entry is not in used */
  41 #define RTE_STATE_BAD           2               /* The route is almost ready to be removed */
  42 #define RTE_STATE_SUSPECT       4               /* didn't received an update for route */
  43 #define RTE_STATE_GOOD          8               /* this route is 100% valid */
  44 #define RTE_STATE_ZKNOWN        16              /* we know the zones for this entry */
  45 #define RTE_STATE_UPDATED       32              /* set when updated from received rtmp table */
  46 #define RTE_STATE_BKUP          64      /* for future use : AURP */
  47 #define RTE_STATE_PERMANENT     128     /* This is a directly attached route */
  48
  49 #define PORT_ONLINE             32      /* router port in forwarding state */
  50 #define PORT_SEEDING            31      /* router port seeding  */
  51 #define PORT_ACTIVATING         16      /* router port waiting for net infos */
  52 #define PORT_ERR_NOZONE         6       /* router no zones for non seed port*/
  53 #define PORT_ERR_BADRTMP        5       /* router problem bad rtmp version*/
  54 #define PORT_ERR_STARTUP        4       /* router problem cable in start range*/
  55 #define PORT_ERR_CABLER         3       /* router problem bad cable range*/
  56 #define PORT_ERR_SEED           2       /* router startup seeding problem */
  57 #define PORT_ONERROR            1       /* router port with generic problem*/
  58 #define PORT_OFFLINE            0       /* router port disabled/not ready */
  59
  60 #define ZT_MAX                  1024    /* Don't allow more zones than that */
  61 #define ZT_MIN                  32      /* Minimum for a good behaviour*/
  62 #define ZT_DEFAULT              512     /* Minimum for a good behaviour*/
  63 #define RT_MAX                  4096    /* Don't allow more entries than that */
  64 #define RT_MIN                  128     /* Minimum for a good behaviour*/
  65 #define RT_DEFAULT              1024    /* Minimum for a good behaviour*/
  66 #define ZT_BYTES                (ZT_MAX/8)      /* Bytes in Zone Bitmap */
  67 #define ZT_MAXEDOUT             ZT_MAX+1        /* reached the entry limit.. */
  68 #define RT_MIX_DEFAULT          2000    /* default for nbr of ppsec */
  69
  70
  71 #define NOTIFY_N_DIST   31      /* Notify Neighbor distance (when shutdown or so) */
  72
  73 /* Useful macros to access the RTMP tuple fields */
  74
  75 #define TUPLENET(x) NET_VALUE(((at_rtmp_tuple *)(x))->at_rtmp_net)
  76 #define TUPLEDIST(x)  ((((at_rtmp_tuple *)(x))->at_rtmp_data) & RTMP_DISTANCE)
  77 #define TUPLERANGE(x) ((((at_rtmp_tuple *)(x))->at_rtmp_data) & RTMP_RANGE_FLAG)
  78
  79 #define CableStart  ifID->ifThisCableStart
  80 #define CableStop  ifID->ifThisCableEnd
  81
  82 #define RTMP_IDLENGTH   4       /* RTMP packet Node header length */
  83
  84
  85 #define RTMP_VERSION_NUMBER 0x82        /* V2 only version of RTMP supported */
  86
  87 #define ERTR_SEED_CONFLICT  0x101   /* Conflict between port information and net
  88                                      * value received for the port (fatal for Rtr)
  89                                      */
  90 #define ERTR_CABLE_CONFLICT 0x102   /* Conflict between port information and net
  91                                      * information received in a RTMP packet
  92                                      */
  93
  94 #define ERTR_RTMP_BAD_VERSION  0x103   /* We received a non phase-II RTMP packet
  95                                          * that's bad... We can't deal with it
  96                                          */
  97
  98 #define ERTR_CABLE_STARTUP  0x104   /* the cable range we're on happen to
  99                                                                          * be in the startup range. Shouldn't
 100                                      */
 101
 102 #define ERTR_CABLE_NOZONE       0x105   /* We haven't found any zones for that port
 103                                                                          * after all the timeout expired
 104                                                                          */
 105
 106
 107 /* RTMP table entry */
 108
 109 typedef struct rt_entry {
 110
 111         struct rt_entry *left;          /* btree left pointer */
 112         struct rt_entry *right;         /* btree right pointer */
 113
 114         at_net_al NetStop;              /* Last net # in the range, or network # if
 115                                            non extended network */
 116         at_net_al NetStart;             /* Starting network number in the range, 0
 117                                            non extended network */
 118         at_net_al NextIRNet;            /* Network number of next Internet Router */
 119         at_node NextIRNode;             /* Node ID of next Router */
 120         u_char ZoneBitMap[ZT_BYTES];    /* One bit per Zone defined for this entry */
 121         u_char NetDist;                 /* Distance in hops of the destination net */
 122         u_char NetPort;                 /* Physical port number to forward to */
 123         u_char EntryState;              /* State of the entry bitmap field */
 124         u_char RTMPFlag;
 125         u_char AURPFlag;
 126
 127 } RT_entry;
 128
 129
 130 /* ZIP Table entry */
 131
 132 typedef struct {
 133
 134         u_short ZoneCount;              /* Count of reference to zone entry */
 135         at_nvestr_t Zone;               /* zone name as a Network Visible Entity */
 136
 137 } ZT_entry;
 138
 139 /* for zone retrieval to user space only */
 140 typedef struct {
 141         unsigned short  entryno;        /* zone table entry number (1st = 0) */
 142         ZT_entry        zt;             /* the zone table entry */
 143 } ZT_entryno;
 144
 145 #ifdef KERNEL_PRIVATE
 146
 147 /* Macros for Routing table B-tree easy access */
 148
 149 #define RT_DELETE(NetStop, NetStart) {\
 150     RT_entry *found; \
 151     if ((found = rt_bdelete(NetStop, NetStart))) { \
 152         memset(found, '\0', sizeof(RT_entry)); \
 153         found->right = RT_table_freelist; \
 154         RT_table_freelist  = found; \
 155     } \
 156 }
 157
 158 /* Set/Reset and test the All zones known bit in for the entry field */
 159
 160 #define RT_ALL_ZONES_KNOWN(entry)       ((entry)->EntryState & RTE_STATE_ZKNOWN)
 161 #define RT_SET_ZONE_KNOWN(entry)        ((entry)->EntryState |= RTE_STATE_ZKNOWN)
 162 #define RT_CLR_ZONE_KNOWN(entry)        ((entry)->EntryState ^= RTE_STATE_ZKNOWN)
 163
 164 /*
 165  * check if a zone number is in a given zone map
 166  */
 167 #define ZT_ISIN_ZMAP(znum, zmap) ((zmap)[(znum-1) >> 3] & 0x80 >> (znum-1) % 8)
 168
 169 /* remove a zone from the zone bitmap, and check if the zone
 170  * is still in use by someone else.
 171  */
 172
 173 #define ZT_CLR_ZMAP(num, zmap) {                                        \
 174         if ((zmap)[(num-1) >> 3] & 0x80 >> (num-1) % 8) {       \
 175                 (zmap)[(num-1) >> 3] ^= 0x80 >> (num-1) % 8;    \
 176                 ZT_table[(num-1)].ZoneCount-- ;                         \
 177         }                                                                                               \
 178 }
 179
 180 /* set a bit in an entry bit map */
 181
 182 #define ZT_SET_ZMAP(num, zmap) {                                                \
 183         if (!zmap[(num-1) >> 3] & 0x80 >> (num-1) % 8) {        \
 184                 zmap[(num-1) >> 3] |= 0x80 >> (num-1) % 8;              \
 185                 ZT_table[(num-1)].ZoneCount++ ;                                 \
 186         }                                                                                                       \
 187 }
 188
 189 extern int regDefaultZone(at_ifaddr_t *);
 190 extern int zonename_equal(at_nvestr_t *, at_nvestr_t *);
 191
 192 extern RT_entry *RT_table_freelist;
 193 extern RT_entry RT_table_start;
 194 extern RT_entry *RT_table;
 195 extern RT_entry *rt_binsert (RT_entry *);
 196 extern RT_entry *rt_insert( at_net_al NStop, at_net_al NStart, at_net_al NxNet,
 197      at_node NxNode, u_char NtDist, u_char NtPort, u_char EntS);
 198 extern RT_entry *rt_bdelete (at_net_al NetStop, at_net_al NetStart);
 199 extern RT_entry *rt_blookup(int);
 200 extern RT_entry *rt_getNextRoute(int);
 201
 202 extern ZT_entry *ZT_table;
 203 extern short    RT_maxentry;
 204 extern short    ZT_maxentry;
 205
 206 extern volatile int RouterMix;
 207
 208 extern int zt_add_zone(char *, short);
 209 extern int zt_add_zonename(at_nvestr_t *);
 210 extern int zt_ent_zindex(u_char *);
 211 extern ZT_entryno *zt_getNextZone(int);
 212 extern void zt_remove_zones(u_char *);
 213 extern void zt_set_zmap(u_short, char *);
 214 extern void rtmp_router_input(gbuf_t *, at_ifaddr_t *);
 215
 216 #endif /* KERNEL_PRIVATE */
 217
 218 #endif /* PRIVATE */
 219 #endif /* _NETAT_ROUTING_TABLES_H_ */