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