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 /* values for vertex->type */
  26 #define OSPF_VERTEX_ROUTER  1  /* for a Router-LSA */
  27 #define OSPF_VERTEX_NETWORK 2  /* for a Network-LSA */
  28
  29 /* values for vertex->flags */
  30 #define OSPF_VERTEX_PROCESSED      0x01
  31
  32 /* The "root" is the node running the SPF calculation */
  33
  34 /* A router or network in an area */
  35 struct vertex
  36 {
  37   u_char flags;
  38   u_char type;          /* copied from LSA header */
  39   struct in_addr id;    /* copied from LSA header */
  40   struct lsa_header *lsa; /* Router or Network LSA */
  41   int *stat;            /* Link to LSA status. */
  42   u_int32_t distance;   /* from root to this vertex */
  43   struct list *parents;         /* list of parents in SPF tree */
  44   struct list *children;        /* list of children in SPF tree*/
  45 };
  46
  47 /* A nexthop taken on the root node to get to this (parent) vertex */
  48 struct vertex_nexthop
  49 {
  50   struct ospf_interface *oi;    /* output intf on root node */
  51   struct in_addr router;        /* router address to send to */
  52 };
  53
  54 struct vertex_parent
  55 {
  56   struct vertex_nexthop *nexthop; /* link to nexthop info for this parent */
  57   struct vertex *parent;        /* parent vertex */
  58   int backlink;                 /* index back to parent for router-lsa's */
  59 };
  60
  61 /* What triggered the SPF ? */
  62 typedef enum {
  63   SPF_FLAG_ROUTER_LSA_INSTALL = 1,
  64   SPF_FLAG_NETWORK_LSA_INSTALL,
  65   SPF_FLAG_SUMMARY_LSA_INSTALL,
  66   SPF_FLAG_ASBR_SUMMARY_LSA_INSTALL,
  67   SPF_FLAG_MAXAGE,
  68   SPF_FLAG_ABR_STATUS_CHANGE,
  69   SPF_FLAG_ASBR_STATUS_CHANGE,
  70   SPF_FLAG_CONFIG_CHANGE,
  71 } ospf_spf_reason_t;
  72
  73 extern void ospf_spf_calculate_schedule (struct ospf *, ospf_spf_reason_t);
  74 extern void ospf_rtrs_free (struct route_table *);
  75
  76 /* void ospf_spf_calculate_timer_add (); */
  77 #endif /* _QUAGGA_OSPF_SPF_H */