ospfd/ospf_route.h

   1 /*
   2  * OSPF routing table.
   3  * Copyright (C) 1999, 2000 Toshiaki Takada
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2, or (at your option) any
  10  * later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_OSPF_ROUTE_H
  23 #define _ZEBRA_OSPF_ROUTE_H
  24
  25 #define OSPF_DESTINATION_ROUTER         1
  26 #define OSPF_DESTINATION_NETWORK        2
  27 #define OSPF_DESTINATION_DISCARD        3
  28
  29 #define OSPF_PATH_MIN                   0
  30 #define OSPF_PATH_INTRA_AREA            1
  31 #define OSPF_PATH_INTER_AREA            2
  32 #define OSPF_PATH_TYPE1_EXTERNAL        3
  33 #define OSPF_PATH_TYPE2_EXTERNAL        4
  34 #define OSPF_PATH_MAX                   5
  35
  36 /* OSPF Path. */
  37 struct ospf_path
  38 {
  39   struct in_addr nexthop;
  40   struct in_addr adv_router;
  41   ifindex_t ifindex;
  42   unsigned char unnumbered;
  43 };
  44
  45 /* Below is the structure linked to every
  46    route node. Note that for Network routing
  47    entries a single ospf_route is kept, while
  48    for ABRs and ASBRs (Router routing entries),
  49    we link an instance of ospf_router_route
  50    where a list of paths is maintained, so
  51
  52    nr->info is a (struct ospf_route *) for OSPF_DESTINATION_NETWORK
  53    but
  54    nr->info is a (struct ospf_router_route *) for OSPF_DESTINATION_ROUTER
  55 */
  56
  57 struct route_standard
  58 {
  59   /* Link Sate Origin. */
  60   struct lsa_header *origin;
  61
  62   /* Associated Area. */
  63   struct in_addr area_id;       /* The area the route belongs to */
  64
  65   /*  Area Type */
  66   int external_routing;
  67
  68   /* Optional Capability. */
  69   u_char options;               /* Get from LSA header. */
  70
  71   /*  */
  72   u_char flags;                 /* From router-LSA */
  73 };
  74
  75 struct route_external
  76 {
  77   /* Link State Origin. */
  78   struct ospf_lsa *origin;
  79
  80   /* Link State Cost Type2. */
  81   u_int32_t type2_cost;
  82
  83   /* Tag value. */
  84   u_int32_t tag;
  85
  86   /* ASBR route. */
  87   struct ospf_route *asbr;
  88 };
  89
  90 struct ospf_route
  91 {
  92   /* Destination Type. */
  93   u_char type;
  94
  95   /* Destination ID. */         /* i.e. Link State ID. */
  96   struct in_addr id;
  97
  98   /* Address Mask. */
  99   struct in_addr mask;          /* Only valid for networks. */
 100
 101   /* Path Type. */
 102   u_char path_type;
 103
 104   /* List of Paths. */
 105   struct list *paths;
 106
 107   /* Link State Cost. */
 108   u_int32_t cost;               /* i.e. metric. */
 109
 110   /* Route specific info. */
 111   union
 112   {
 113     struct route_standard std;
 114     struct route_external ext;
 115   } u;
 116 };
 117
 118 extern struct ospf_path *ospf_path_new (void);
 119 extern void ospf_path_free (struct ospf_path *);
 120 extern struct ospf_path *ospf_path_lookup (struct list *, struct ospf_path *);
 121 extern struct ospf_route *ospf_route_new (void);
 122 extern void ospf_route_free (struct ospf_route *);
 123 extern void ospf_route_delete (struct route_table *);
 124 extern void ospf_route_table_free (struct route_table *);
 125
 126 extern void ospf_route_install (struct ospf *, struct route_table *);
 127 extern void ospf_route_table_dump (struct route_table *);
 128
 129 extern void ospf_intra_add_router (struct route_table *, struct vertex *,
 130                                    struct ospf_area *);
 131
 132 extern void ospf_intra_add_transit (struct route_table *, struct vertex *,
 133                                     struct ospf_area *);
 134
 135 extern void ospf_intra_add_stub (struct route_table *,
 136                                  struct router_lsa_link *, struct vertex *,
 137                                  struct ospf_area *,
 138                                  int parent_is_root, int);
 139
 140 extern int ospf_route_cmp (struct ospf *, struct ospf_route *,
 141                            struct ospf_route *);
 142 extern void ospf_route_copy_nexthops (struct ospf_route *, struct list *);
 143 extern void ospf_route_copy_nexthops_from_vertex (struct ospf_route *,
 144                                                   struct vertex *);
 145
 146 extern void ospf_route_subst (struct route_node *, struct ospf_route *,
 147                               struct ospf_route *);
 148 extern void ospf_route_add (struct route_table *, struct prefix_ipv4 *,
 149                             struct ospf_route *, struct ospf_route *);
 150
 151 extern void ospf_route_subst_nexthops (struct ospf_route *, struct list *);
 152 extern void ospf_prune_unreachable_networks (struct route_table *);
 153 extern void ospf_prune_unreachable_routers (struct route_table *);
 154 extern int ospf_add_discard_route (struct route_table *, struct ospf_area *,
 155                                    struct prefix_ipv4 *);
 156 extern void ospf_delete_discard_route (struct route_table *, struct prefix_ipv4 *);
 157 extern int ospf_route_match_same (struct route_table *, struct prefix_ipv4 *,
 158                                   struct ospf_route *);
 159
 160 #endif /* _ZEBRA_OSPF_ROUTE_H */