[mirror_frr.git] / ospfd / ospf_spf.h

/*
 * OSPF calculation.
 * Copyright (C) 1999 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _QUAGGA_OSPF_SPF_H
#define _QUAGGA_OSPF_SPF_H

#include "typesafe.h"

/* values for vertex->type */
#define OSPF_VERTEX_ROUTER  1  /* for a Router-LSA */
#define OSPF_VERTEX_NETWORK 2  /* for a Network-LSA */

/* values for vertex->flags */
#define OSPF_VERTEX_PROCESSED      0x01

/* The "root" is the node running the SPF calculation */

PREDECL_SKIPLIST_NONUNIQ(vertex_pqueue)
/* A router or network in an area */
struct vertex {
	struct vertex_pqueue_item pqi;
	uint8_t flags;
	uint8_t type;		/* copied from LSA header */
	struct in_addr id;      /* copied from LSA header */
	struct ospf_lsa *lsa_p;
	struct lsa_header *lsa; /* Router or Network LSA */
	uint32_t distance;      /* from root to this vertex */
	struct list *parents;   /* list of parents in SPF tree */
	struct list *children;  /* list of children in SPF tree*/
};

/* A nexthop taken on the root node to get to this (parent) vertex */
struct vertex_nexthop {
	struct ospf_interface *oi; /* output intf on root node */
	struct in_addr router;     /* router address to send to */
};

struct vertex_parent {
	struct vertex_nexthop
		*nexthop;      /* link to nexthop info for this parent */
	struct vertex *parent; /* parent vertex */
	int backlink;	  /* index back to parent for router-lsa's */
};

/* What triggered the SPF ? */
typedef enum {
	SPF_FLAG_ROUTER_LSA_INSTALL = 1,
	SPF_FLAG_NETWORK_LSA_INSTALL,
	SPF_FLAG_SUMMARY_LSA_INSTALL,
	SPF_FLAG_ASBR_SUMMARY_LSA_INSTALL,
	SPF_FLAG_MAXAGE,
	SPF_FLAG_ABR_STATUS_CHANGE,
	SPF_FLAG_ASBR_STATUS_CHANGE,
	SPF_FLAG_CONFIG_CHANGE,
} ospf_spf_reason_t;

extern void ospf_spf_calculate_schedule(struct ospf *, ospf_spf_reason_t);
extern void ospf_rtrs_free(struct route_table *);

/* void ospf_spf_calculate_timer_add (); */
#endif /* _QUAGGA_OSPF_SPF_H */
Commit	Line	Data
718e3744	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	*
896014f4 DL	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
718e3744	20	*/
718e3744	21
9c27ef9b PJ	22	#ifndef _QUAGGA_OSPF_SPF_H
	23	#define _QUAGGA_OSPF_SPF_H
	24
c971918a DL	25	#include "typesafe.h"
c971918a DL	26
630e4807	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 */
718e3744	30
630e4807	31	/* values for vertex->flags */
718e3744	32	#define OSPF_VERTEX_PROCESSED 0x01
718e3744	33
630e4807	34	/* The "root" is the node running the SPF calculation */
718e3744	35
c971918a	36	PREDECL_SKIPLIST_NONUNIQ(vertex_pqueue)
630e4807	37	/* A router or network in an area */
d62a17ae	38	struct vertex {
c971918a	39	struct vertex_pqueue_item pqi;
d7c0a89a QY	40	uint8_t flags;
d7c0a89a QY	41	uint8_t type; /* copied from LSA header */
d62a17ae	42	struct in_addr id; /* copied from LSA header */
c971918a	43	struct ospf_lsa *lsa_p;
d62a17ae	44	struct lsa_header lsa; / Router or Network LSA */
d7c0a89a	45	uint32_t distance; /* from root to this vertex */
d62a17ae	46	struct list parents; / list of parents in SPF tree */
d62a17ae	47	struct list children; / list of children in SPF tree*/
718e3744	48	};
718e3744	49
630e4807	50	/* A nexthop taken on the root node to get to this (parent) vertex */
d62a17ae	51	struct vertex_nexthop {
	52	struct ospf_interface oi; / output intf on root node */
	53	struct in_addr router; /* router address to send to */
eb3da6df	54	};
eb3da6df	55
d62a17ae	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 */
718e3744	61	};
718e3744	62
d3a9c768 PJ	63	/* What triggered the SPF ? */
d3a9c768 PJ	64	typedef enum {
d62a17ae	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,
d3a9c768 PJ	73	} ospf_spf_reason_t;
d3a9c768 PJ	74
d62a17ae	75	extern void ospf_spf_calculate_schedule(struct ospf *, ospf_spf_reason_t);
d62a17ae	76	extern void ospf_rtrs_free(struct route_table *);
718e3744	77
718e3744	78	/* void ospf_spf_calculate_timer_add (); */
9c27ef9b	79	#endif /* _QUAGGA_OSPF_SPF_H */