ospfd/ospf_spf.h

   1 /*
   2  * OSPF calculation.
   3  * Copyright (C) 1999 Kunihiro Ishiguro
   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 _QUAGGA_OSPF_SPF_H
  23 #define _QUAGGA_OSPF_SPF_H
  24
  25 #include "typesafe.h"
  26
  27 /* values for vertex->type */
  28 #define OSPF_VERTEX_ROUTER  1  /* for a Router-LSA */
  29 #define OSPF_VERTEX_NETWORK 2  /* for a Network-LSA */
  30
  31 /* values for vertex->flags */
  32 #define OSPF_VERTEX_PROCESSED      0x01
  33
  34 /* The "root" is the node running the SPF calculation */
  35
  36 PREDECL_SKIPLIST_NONUNIQ(vertex_pqueue);
  37 /* A router or network in an area */
  38 struct vertex {
  39         struct vertex_pqueue_item pqi;
  40         uint8_t flags;
  41         uint8_t type;           /* copied from LSA header */
  42         struct in_addr id;      /* copied from LSA header */
  43         struct ospf_lsa *lsa_p;
  44         struct lsa_header *lsa; /* Router or Network LSA */
  45         uint32_t distance;      /* from root to this vertex */
  46         struct list *parents;   /* list of parents in SPF tree */
  47         struct list *children;  /* list of children in SPF tree*/
  48 };
  49
  50 struct vertex_nexthop {
  51         struct in_addr router;     /* router address to send to */
  52         int lsa_pos; /* LSA position for resolving the interface */
  53 };
  54
  55 struct vertex_parent {
  56         struct vertex_nexthop *nexthop; /* nexthop taken on the root node */
  57         struct vertex_nexthop *local_nexthop; /* local nexthop of the parent */
  58         struct vertex *parent;                /* parent vertex */
  59         int backlink; /* index back to parent for router-lsa's */
  60 };
  61
  62 /* What triggered the SPF ? */
  63 typedef enum {
  64         SPF_FLAG_ROUTER_LSA_INSTALL = 1,
  65         SPF_FLAG_NETWORK_LSA_INSTALL,
  66         SPF_FLAG_SUMMARY_LSA_INSTALL,
  67         SPF_FLAG_ASBR_SUMMARY_LSA_INSTALL,
  68         SPF_FLAG_MAXAGE,
  69         SPF_FLAG_ABR_STATUS_CHANGE,
  70         SPF_FLAG_ASBR_STATUS_CHANGE,
  71         SPF_FLAG_CONFIG_CHANGE,
  72         SPF_FLAG_GR_FINISH,
  73 } ospf_spf_reason_t;
  74
  75 extern void ospf_spf_calculate_schedule(struct ospf *, ospf_spf_reason_t);
  76 extern void ospf_spf_calculate(struct ospf_area *area,
  77                                struct ospf_lsa *root_lsa,
  78                                struct route_table *new_table,
  79                                struct route_table *new_rtrs, bool is_dry_run,
  80                                bool is_root_node);
  81 extern void ospf_spf_calculate_area(struct ospf *ospf, struct ospf_area *area,
  82                                     struct route_table *new_table,
  83                                     struct route_table *new_rtrs);
  84 extern void ospf_spf_calculate_areas(struct ospf *ospf,
  85                                      struct route_table *new_table,
  86                                      struct route_table *new_rtrs);
  87 extern void ospf_rtrs_free(struct route_table *);
  88 extern void ospf_spf_cleanup(struct vertex *spf, struct list *vertex_list);
  89 extern void ospf_spf_copy(struct vertex *vertex, struct list *vertex_list);
  90 extern void ospf_spf_remove_resource(struct vertex *vertex,
  91                                      struct list *vertex_list,
  92                                      struct protected_resource *resource);
  93 extern struct vertex *ospf_spf_vertex_find(struct in_addr id,
  94                                            struct list *vertex_list);
  95 extern struct vertex *ospf_spf_vertex_by_nexthop(struct vertex *root,
  96                                                  struct in_addr *nexthop);
  97 extern struct vertex_parent *ospf_spf_vertex_parent_find(struct in_addr id,
  98                                                          struct vertex *vertex);
  99 extern int vertex_parent_cmp(void *aa, void *bb);
 100
 101 extern void ospf_spf_print(struct vty *vty, struct vertex *v, int i);
 102 extern void ospf_restart_spf(struct ospf *ospf);
 103 /* void ospf_spf_calculate_timer_add (); */
 104 #endif /* _QUAGGA_OSPF_SPF_H */