ospf6d/ospf6_route.h

   1 /*
   2  * Copyright (C) 2003 Yasuhiro Ohara
   3  *
   4  * This file is part of GNU Zebra.
   5  *
   6  * GNU Zebra is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2, or (at your option) any
   9  * later version.
  10  *
  11  * GNU Zebra is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; see the file COPYING; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef OSPF6_ROUTE_H
  22 #define OSPF6_ROUTE_H
  23
  24 #include "command.h"
  25
  26 #define OSPF6_MULTI_PATH_LIMIT    4
  27
  28 /* Debug option */
  29 extern unsigned char conf_debug_ospf6_route;
  30 #define OSPF6_DEBUG_ROUTE_TABLE   0x01
  31 #define OSPF6_DEBUG_ROUTE_INTRA   0x02
  32 #define OSPF6_DEBUG_ROUTE_INTER   0x04
  33 #define OSPF6_DEBUG_ROUTE_MEMORY  0x80
  34 #define OSPF6_DEBUG_ROUTE_ON(level) \
  35   (conf_debug_ospf6_route |= (level))
  36 #define OSPF6_DEBUG_ROUTE_OFF(level) \
  37   (conf_debug_ospf6_route &= ~(level))
  38 #define IS_OSPF6_DEBUG_ROUTE(e) \
  39   (conf_debug_ospf6_route & OSPF6_DEBUG_ROUTE_ ## e)
  40
  41 /* Nexthop */
  42 struct ospf6_nexthop
  43 {
  44   /* Interface index */
  45   ifindex_t ifindex;
  46
  47   /* IP address, if any */
  48   struct in6_addr address;
  49 };
  50
  51 #define ospf6_nexthop_is_set(x)                                \
  52   ((x)->ifindex || ! IN6_IS_ADDR_UNSPECIFIED (&(x)->address))
  53 #define ospf6_nexthop_is_same(a,b)                             \
  54   ((a)->ifindex == (b)->ifindex &&                            \
  55    IN6_ARE_ADDR_EQUAL (&(a)->address, &(b)->address))
  56 #define ospf6_nexthop_clear(x)                                \
  57   do {                                                        \
  58     (x)->ifindex = 0;                                         \
  59     memset (&(x)->address, 0, sizeof (struct in6_addr));      \
  60   } while (0)
  61 #define ospf6_nexthop_copy(a, b)                              \
  62   do {                                                        \
  63     (a)->ifindex = (b)->ifindex;                              \
  64     memcpy (&(a)->address, &(b)->address,                     \
  65             sizeof (struct in6_addr));                        \
  66   } while (0)
  67
  68 /* Path */
  69 struct ospf6_ls_origin
  70 {
  71   u_int16_t type;
  72   u_int32_t id;
  73   u_int32_t adv_router;
  74 };
  75
  76 struct ospf6_path
  77 {
  78   /* Link State Origin */
  79   struct ospf6_ls_origin origin;
  80
  81   /* Router bits */
  82   u_char router_bits;
  83
  84   /* Optional Capabilities */
  85   u_char options[3];
  86
  87   /* Prefix Options */
  88   u_char prefix_options;
  89
  90   /* Associated Area */
  91   u_int32_t area_id;
  92
  93   /* Path-type */
  94   u_char type;
  95   u_char subtype; /* only used for redistribute i.e ZEBRA_ROUTE_XXX */
  96
  97   /* Cost */
  98   u_int8_t metric_type;
  99   u_int32_t cost;
 100   union {
 101     u_int32_t cost_e2;
 102     u_int32_t cost_config;
 103   } u;
 104   u_int32_t tag;
 105 };
 106
 107 #define OSPF6_PATH_TYPE_NONE         0
 108 #define OSPF6_PATH_TYPE_INTRA        1
 109 #define OSPF6_PATH_TYPE_INTER        2
 110 #define OSPF6_PATH_TYPE_EXTERNAL1    3
 111 #define OSPF6_PATH_TYPE_EXTERNAL2    4
 112 #define OSPF6_PATH_TYPE_REDISTRIBUTE 5
 113 #define OSPF6_PATH_TYPE_MAX          6
 114
 115 #define OSPF6_PATH_SUBTYPE_DEFAULT_RT   1
 116
 117 #define OSPF6_PATH_COST_IS_CONFIGURED(path) (path.u.cost_config != OSPF_AREA_RANGE_COST_UNSPEC)
 118
 119 #include "prefix.h"
 120 #include "table.h"
 121 #include "bitfield.h"
 122
 123 struct ospf6_route
 124 {
 125   struct route_node *rnode;
 126   struct ospf6_route_table *table;
 127   struct ospf6_route *prev;
 128   struct ospf6_route *next;
 129
 130   unsigned int lock;
 131
 132   /* Destination Type */
 133   u_char type;
 134
 135   /* XXX: It would likely be better to use separate struct in_addr's
 136    * for the advertising router-ID and prefix IDs, instead of stuffing them
 137    * into one. See also XXX below.
 138    */
 139   /* Destination ID */
 140   struct prefix prefix;
 141
 142   /* Time */
 143   struct timeval installed;
 144   struct timeval changed;
 145
 146   /* flag */
 147   u_char flag;
 148
 149   /* route option */
 150   void *route_option;
 151
 152   /* link state id for advertising */
 153   u_int32_t linkstate_id;
 154
 155   /* path */
 156   struct ospf6_path path;
 157
 158   /* nexthop */
 159   struct list *nh_list;
 160
 161 };
 162
 163 #define OSPF6_DEST_TYPE_NONE       0
 164 #define OSPF6_DEST_TYPE_ROUTER     1
 165 #define OSPF6_DEST_TYPE_NETWORK    2
 166 #define OSPF6_DEST_TYPE_DISCARD    3
 167 #define OSPF6_DEST_TYPE_LINKSTATE  4
 168 #define OSPF6_DEST_TYPE_RANGE      5
 169 #define OSPF6_DEST_TYPE_MAX        6
 170
 171 #define OSPF6_ROUTE_CHANGE           0x01
 172 #define OSPF6_ROUTE_ADD              0x02
 173 #define OSPF6_ROUTE_REMOVE           0x04
 174 #define OSPF6_ROUTE_BEST             0x08
 175 #define OSPF6_ROUTE_ACTIVE_SUMMARY   0x10
 176 #define OSPF6_ROUTE_DO_NOT_ADVERTISE 0x20
 177 #define OSPF6_ROUTE_WAS_REMOVED      0x40
 178 #define OSPF6_ROUTE_BLACKHOLE_ADDED  0x80
 179
 180 struct ospf6_route_table
 181 {
 182   int scope_type;
 183   int table_type;
 184   void *scope;
 185
 186   /* patricia tree */
 187   struct route_table *table;
 188
 189   u_int32_t count;
 190
 191   bitfield_t idspace;
 192
 193   /* hooks */
 194   void (*hook_add) (struct ospf6_route *);
 195   void (*hook_change) (struct ospf6_route *);
 196   void (*hook_remove) (struct ospf6_route *);
 197 };
 198
 199 #define OSPF6_SCOPE_TYPE_NONE      0
 200 #define OSPF6_SCOPE_TYPE_GLOBAL    1
 201 #define OSPF6_SCOPE_TYPE_AREA      2
 202 #define OSPF6_SCOPE_TYPE_INTERFACE 3
 203
 204 #define OSPF6_TABLE_TYPE_NONE              0
 205 #define OSPF6_TABLE_TYPE_ROUTES            1
 206 #define OSPF6_TABLE_TYPE_BORDER_ROUTERS    2
 207 #define OSPF6_TABLE_TYPE_CONNECTED_ROUTES  3
 208 #define OSPF6_TABLE_TYPE_EXTERNAL_ROUTES   4
 209 #define OSPF6_TABLE_TYPE_SPF_RESULTS       5
 210 #define OSPF6_TABLE_TYPE_PREFIX_RANGES     6
 211 #define OSPF6_TABLE_TYPE_SUMMARY_PREFIXES  7
 212 #define OSPF6_TABLE_TYPE_SUMMARY_ROUTERS   8
 213
 214 #define OSPF6_ROUTE_TABLE_CREATE(s, t) \
 215   ospf6_route_table_create (OSPF6_SCOPE_TYPE_ ## s, \
 216                             OSPF6_TABLE_TYPE_ ## t)
 217
 218 extern const char *ospf6_dest_type_str[OSPF6_DEST_TYPE_MAX];
 219 extern const char *ospf6_dest_type_substr[OSPF6_DEST_TYPE_MAX];
 220 #define OSPF6_DEST_TYPE_NAME(x)                       \
 221   (0 < (x) && (x) < OSPF6_DEST_TYPE_MAX ?             \
 222    ospf6_dest_type_str[(x)] : ospf6_dest_type_str[0])
 223 #define OSPF6_DEST_TYPE_SUBSTR(x)                           \
 224   (0 < (x) && (x) < OSPF6_DEST_TYPE_MAX ?                   \
 225    ospf6_dest_type_substr[(x)] : ospf6_dest_type_substr[0])
 226
 227 extern const char *ospf6_path_type_str[OSPF6_PATH_TYPE_MAX];
 228 extern const char *ospf6_path_type_substr[OSPF6_PATH_TYPE_MAX];
 229 #define OSPF6_PATH_TYPE_NAME(x)                       \
 230   (0 < (x) && (x) < OSPF6_PATH_TYPE_MAX ?             \
 231    ospf6_path_type_str[(x)] : ospf6_path_type_str[0])
 232 #define OSPF6_PATH_TYPE_SUBSTR(x)                           \
 233   (0 < (x) && (x) < OSPF6_PATH_TYPE_MAX ?                   \
 234    ospf6_path_type_substr[(x)] : ospf6_path_type_substr[0])
 235
 236 #define OSPF6_ROUTE_ADDRESS_STR "Display the route bestmatches the address\n"
 237 #define OSPF6_ROUTE_PREFIX_STR  "Display the route\n"
 238 #define OSPF6_ROUTE_MATCH_STR   "Display the route matches the prefix\n"
 239
 240 #define ospf6_route_is_prefix(p, r) \
 241   (memcmp (p, &(r)->prefix, sizeof (struct prefix)) == 0)
 242 #define ospf6_route_is_same(ra, rb) \
 243   (prefix_same (&(ra)->prefix, &(rb)->prefix))
 244 #define ospf6_route_is_same_origin(ra, rb) \
 245   ((ra)->path.area_id == (rb)->path.area_id && \
 246    memcmp (&(ra)->path.origin, &(rb)->path.origin, \
 247            sizeof (struct ospf6_ls_origin)) == 0)
 248 #define ospf6_route_is_identical(ra, rb) \
 249   ((ra)->type == (rb)->type && \
 250    memcmp (&(ra)->prefix, &(rb)->prefix, sizeof (struct prefix)) == 0 && \
 251    memcmp (&(ra)->path, &(rb)->path, sizeof (struct ospf6_path)) == 0 && \
 252    ospf6_route_cmp_nexthops (ra, rb) == 0)
 253
 254 #define ospf6_route_is_best(r) (CHECK_FLAG ((r)->flag, OSPF6_ROUTE_BEST))
 255
 256 #define ospf6_linkstate_prefix_adv_router(x) \
 257   ((x)->u.lp.id.s_addr)
 258 #define ospf6_linkstate_prefix_id(x) \
 259   ((x)->u.lp.adv_router.s_addr)
 260
 261 #define ADV_ROUTER_IN_PREFIX(x) \
 262   ((x)->u.lp.id.s_addr)
 263
 264 /* Function prototype */
 265 extern void ospf6_linkstate_prefix (u_int32_t adv_router, u_int32_t id,
 266                                     struct prefix *prefix);
 267 extern void ospf6_linkstate_prefix2str (struct prefix *prefix, char *buf,
 268                                         int size);
 269
 270 extern struct ospf6_nexthop *ospf6_nexthop_create (void);
 271 extern void ospf6_nexthop_delete (struct ospf6_nexthop *nh);
 272 extern void ospf6_free_nexthops (struct list *nh_list);
 273 extern void ospf6_clear_nexthops (struct list *nh_list);
 274 extern int ospf6_num_nexthops (struct list *nh_list);
 275 extern void ospf6_copy_nexthops (struct list *dst, struct list *src);
 276 extern void ospf6_merge_nexthops (struct list *dst, struct list *src);
 277 extern void ospf6_add_nexthop (struct list *nh_list, int ifindex,
 278                                struct in6_addr *addr);
 279 extern int ospf6_num_nexthops (struct list *nh_list);
 280 extern int ospf6_route_cmp_nexthops (struct ospf6_route *a,
 281                                      struct ospf6_route *b);
 282 extern void ospf6_route_zebra_copy_nexthops (struct ospf6_route *route,
 283                                              ifindex_t *ifindices,
 284                                              struct in6_addr **addr,
 285                                              int entries);
 286 extern int ospf6_route_get_first_nh_index (struct ospf6_route *route);
 287
 288 /* Hide abstraction of nexthop implementation in route from outsiders */
 289 #define ospf6_route_copy_nexthops(dst, src) ospf6_copy_nexthops(dst->nh_list, src->nh_list)
 290 #define ospf6_route_merge_nexthops(dst, src) ospf6_merge_nexthops(dst->nh_list, src->nh_list)
 291 #define ospf6_route_num_nexthops(route) ospf6_num_nexthops(route->nh_list)
 292 #define ospf6_route_add_nexthop(route, ifindex, addr) \
 293   ospf6_add_nexthop(route->nh_list, ifindex, addr)
 294
 295 extern struct ospf6_route *ospf6_route_create (void);
 296 extern void ospf6_route_delete (struct ospf6_route *);
 297 extern struct ospf6_route *ospf6_route_copy (struct ospf6_route *route);
 298 extern int ospf6_route_cmp (struct ospf6_route *ra, struct ospf6_route *rb);
 299
 300 extern void ospf6_route_lock (struct ospf6_route *route);
 301 extern void ospf6_route_unlock (struct ospf6_route *route);
 302
 303 extern struct ospf6_route *ospf6_route_lookup (struct prefix *prefix,
 304                                                struct ospf6_route_table *table);
 305 extern struct ospf6_route *ospf6_route_lookup_identical (struct ospf6_route *route,
 306                                             struct ospf6_route_table *table);
 307 extern struct ospf6_route *ospf6_route_lookup_bestmatch (struct prefix *prefix,
 308                                               struct ospf6_route_table *table);
 309
 310 extern struct ospf6_route *ospf6_route_add (struct ospf6_route *route,
 311                                             struct ospf6_route_table *table);
 312 extern void ospf6_route_remove (struct ospf6_route *route,
 313                                 struct ospf6_route_table *table);
 314
 315 extern struct ospf6_route *ospf6_route_head (struct ospf6_route_table *table);
 316 extern struct ospf6_route *ospf6_route_next (struct ospf6_route *route);
 317 extern struct ospf6_route *ospf6_route_best_next (struct ospf6_route *route);
 318
 319 extern struct ospf6_route *ospf6_route_match_head (struct prefix *prefix,
 320                                             struct ospf6_route_table *table);
 321 extern struct ospf6_route *ospf6_route_match_next (struct prefix *prefix,
 322                                             struct ospf6_route *route);
 323
 324 extern void ospf6_route_remove_all (struct ospf6_route_table *);
 325 extern struct ospf6_route_table *ospf6_route_table_create (int s, int t);
 326 extern void ospf6_route_table_delete (struct ospf6_route_table *);
 327 extern void ospf6_route_dump (struct ospf6_route_table *table);
 328
 329
 330 extern void ospf6_route_show (struct vty *vty, struct ospf6_route *route);
 331 extern void ospf6_route_show_detail (struct vty *vty, struct ospf6_route *route);
 332
 333 extern int ospf6_route_table_show (struct vty *, int, int, struct cmd_token **,
 334                                    struct ospf6_route_table *);
 335 extern int ospf6_linkstate_table_show (struct vty *vty, int idx_ipv4, int argc,
 336                                        struct cmd_token **argv,
 337                                        struct ospf6_route_table *table);
 338
 339 extern void ospf6_brouter_show_header (struct vty *vty);
 340 extern void ospf6_brouter_show (struct vty *vty, struct ospf6_route *route);
 341
 342 extern int config_write_ospf6_debug_route (struct vty *vty);
 343 extern void install_element_ospf6_debug_route (void);
 344 extern void ospf6_route_init (void);
 345 extern void ospf6_clean (void);
 346
 347 #endif /* OSPF6_ROUTE_H */
 348