ospfd/ospf_route.h

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * OSPF routing table.
   4  * Copyright (C) 1999, 2000 Toshiaki Takada
   5  */
   6
   7 #ifndef _ZEBRA_OSPF_ROUTE_H
   8 #define _ZEBRA_OSPF_ROUTE_H
   9
  10 #define OSPF_DESTINATION_ROUTER         1
  11 #define OSPF_DESTINATION_NETWORK        2
  12 #define OSPF_DESTINATION_DISCARD        3
  13
  14 #define OSPF_PATH_MIN                   0
  15 #define OSPF_PATH_INTRA_AREA            1
  16 #define OSPF_PATH_INTER_AREA            2
  17 #define OSPF_PATH_TYPE1_EXTERNAL        3
  18 #define OSPF_PATH_TYPE2_EXTERNAL        4
  19 #define OSPF_PATH_MAX                   5
  20
  21 /* Segment Routing information to complement ospf_path structure */
  22 struct sr_nexthop_info {
  23         /* Output label associated to this route */
  24         mpls_label_t label_out;
  25         /*
  26          * Pointer to SR Node which is the next hop for this route
  27          * or NULL if next hop is the destination of the prefix
  28          */
  29         struct sr_node *nexthop;
  30
  31         /* TI-LFA */
  32         struct mpls_label_stack *backup_label_stack;
  33         struct in_addr backup_nexthop;
  34 };
  35
  36 /* OSPF Path. */
  37 struct ospf_path {
  38         struct in_addr nexthop;
  39         struct in_addr adv_router;
  40         ifindex_t ifindex;
  41         unsigned char unnumbered;
  42         struct sr_nexthop_info srni;
  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         /* Link Sate Origin. */
  59         struct lsa_header *origin;
  60
  61         /* Associated Area. */
  62         struct in_addr area_id; /* The area the route belongs to */
  63
  64         /*  Area Type */
  65         int external_routing;
  66
  67         /* Optional Capability. */
  68         uint8_t options; /* Get from LSA header. */
  69
  70         /*  */
  71         uint8_t flags; /* From router-LSA */
  72 };
  73
  74 struct route_external {
  75         /* Link State Origin. */
  76         struct ospf_lsa *origin;
  77
  78         /* Link State Cost Type2. */
  79         uint32_t type2_cost;
  80
  81         /* Tag value. */
  82         uint32_t tag;
  83
  84         /* ASBR route. */
  85         struct ospf_route *asbr;
  86 };
  87
  88 struct ospf_route {
  89         /* Destination Type. */
  90         uint8_t type;
  91
  92         /* Destination ID. */ /* i.e. Link State ID. */
  93         struct in_addr id;
  94
  95         /* Address Mask. */
  96         struct in_addr mask; /* Only valid for networks. */
  97
  98         /* Path Type. */
  99         uint8_t path_type;
 100
 101         /* List of Paths. */
 102         struct list *paths;
 103
 104         /* Link State Cost. */
 105         uint32_t cost; /* i.e. metric. */
 106
 107         /* Route specific info. */
 108         union {
 109                 struct route_standard std;
 110                 struct route_external ext;
 111         } u;
 112
 113         bool changed;
 114 };
 115
 116 extern const char *ospf_path_type_name(int path_type);
 117 extern struct ospf_path *ospf_path_new(void);
 118 extern void ospf_path_free(struct ospf_path *);
 119 extern struct ospf_path *ospf_path_lookup(struct list *, struct ospf_path *);
 120 extern struct ospf_route *ospf_route_new(void);
 121 extern void ospf_route_free(struct ospf_route *);
 122 extern void ospf_route_delete(struct ospf *, struct route_table *);
 123 extern void ospf_route_table_free(struct route_table *);
 124
 125 extern void ospf_route_install(struct ospf *, struct route_table *);
 126 extern void ospf_route_table_dump(struct route_table *);
 127 extern void ospf_router_route_table_dump(struct route_table *rt);
 128
 129 extern void ospf_intra_add_router(struct route_table *rt, struct vertex *v,
 130                                   struct ospf_area *area, bool add_all);
 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 *, struct router_lsa_link *,
 136                                 struct vertex *, struct ospf_area *,
 137                                 int parent_is_root, int);
 138
 139 extern int ospf_route_cmp(struct ospf *, struct ospf_route *,
 140                           struct ospf_route *);
 141 extern void ospf_route_copy_nexthops(struct ospf_route *, struct list *);
 142 extern void ospf_route_copy_nexthops_from_vertex(struct ospf_area *area,
 143                                                  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 ospf *, struct route_table *,
 155                                   struct ospf_area *, struct prefix_ipv4 *,
 156                                   bool);
 157 extern void ospf_delete_discard_route(struct ospf *, struct route_table *,
 158                                       struct prefix_ipv4 *, bool);
 159 extern int ospf_route_match_same(struct route_table *, struct prefix_ipv4 *,
 160                                  struct ospf_route *);
 161
 162 #endif /* _ZEBRA_OSPF_ROUTE_H */