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 /* A nexthop taken on the root node to get to this (parent) vertex */
  51 struct vertex_nexthop {
  52         struct ospf_interface *oi; /* output intf on root node */
  53         struct in_addr router;     /* router address to send to */
  54 };
  55
  56 struct vertex_parent {
  57         struct vertex_nexthop
  58                 *nexthop;      /* link to nexthop info for this parent */
  59         struct vertex *parent; /* parent vertex */
  60         int backlink;     /* index back to parent for router-lsa's */
  61 };
  62
  63 /* What triggered the SPF ? */
  64 typedef enum {
  65         SPF_FLAG_ROUTER_LSA_INSTALL = 1,
  66         SPF_FLAG_NETWORK_LSA_INSTALL,
  67         SPF_FLAG_SUMMARY_LSA_INSTALL,
  68         SPF_FLAG_ASBR_SUMMARY_LSA_INSTALL,
  69         SPF_FLAG_MAXAGE,
  70         SPF_FLAG_ABR_STATUS_CHANGE,
  71         SPF_FLAG_ASBR_STATUS_CHANGE,
  72         SPF_FLAG_CONFIG_CHANGE,
  73 } ospf_spf_reason_t;
  74
  75 extern void ospf_spf_calculate_schedule(struct ospf *, ospf_spf_reason_t);
  76 extern void ospf_rtrs_free(struct route_table *);
  77
  78 /* void ospf_spf_calculate_timer_add (); */
  79 #endif /* _QUAGGA_OSPF_SPF_H */