[mirror_frr.git] / lib / libospf.h

/*
 * Defines and structures common to OSPFv2 and OSPFv3
 * Copyright (C) 1998, 99, 2000 Kunihiro Ishiguro, Toshiaki Takada
 *
 * 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 _LIBOSPFD_H
#define _LIBOSPFD_H

#ifdef __cplusplus
extern "C" {
#endif

/* IP precedence. */
#ifndef IPTOS_PREC_INTERNETCONTROL
#define IPTOS_PREC_INTERNETCONTROL	0xC0
#endif /* IPTOS_PREC_INTERNETCONTROL */

/* Default protocol, port number. */
#ifndef IPPROTO_OSPFIGP
#define IPPROTO_OSPFIGP         89
#endif /* IPPROTO_OSPFIGP */

/* Architectural Constants */
#ifdef DEBUG
#define OSPF_LS_REFRESH_TIME                   120
#else
#define OSPF_LS_REFRESH_TIME                  1800
#endif
#define OSPF_MIN_LS_INTERVAL                  5000     /* msec */
#define OSPF_MIN_LS_ARRIVAL                   1000     /* in milliseconds */
#define OSPF_LSA_INITIAL_AGE                     0	/* useful for debug */
#define OSPF_LSA_MAXAGE                       3600
#define OSPF_CHECK_AGE                         300
#define OSPF_LSA_MAXAGE_DIFF                   900
#define OSPF_LS_INFINITY                  0xffffff
#define OSPF_DEFAULT_DESTINATION        0x00000000      /* 0.0.0.0 */
#define OSPF_INITIAL_SEQUENCE_NUMBER    0x80000001U
#define OSPF_MAX_SEQUENCE_NUMBER        0x7fffffffU
#define OSPF_INVALID_SEQUENCE_NUMBER 0x80000000U

/* OSPF Interface Types */
#define OSPF_IFTYPE_NONE		0
#define OSPF_IFTYPE_POINTOPOINT		1
#define OSPF_IFTYPE_BROADCAST		2
#define OSPF_IFTYPE_NBMA		3
#define OSPF_IFTYPE_POINTOMULTIPOINT	4
#define OSPF_IFTYPE_VIRTUALLINK		5
#define OSPF_IFTYPE_LOOPBACK            6
#define OSPF_IFTYPE_MAX			7

/* OSPF interface default values. */
#define OSPF_OUTPUT_COST_DEFAULT           10
#define OSPF_OUTPUT_COST_INFINITE	   UINT16_MAX
#define OSPF_ROUTER_DEAD_INTERVAL_DEFAULT  40
#define OSPF_ROUTER_DEAD_INTERVAL_MINIMAL   1
#define OSPF_HELLO_INTERVAL_DEFAULT        10
#define OSPF_ROUTER_PRIORITY_DEFAULT        1
#define OSPF_RETRANSMIT_INTERVAL_DEFAULT    5
#define OSPF_TRANSMIT_DELAY_DEFAULT         1
#define OSPF_DEFAULT_BANDWIDTH		 10000	/* Mbps */

#define OSPF_DEFAULT_REF_BANDWIDTH	100000  /* Mbps */

#define OSPF_POLL_INTERVAL_DEFAULT         60
#define OSPF_NEIGHBOR_PRIORITY_DEFAULT      0

#define OSPF_MTU_IGNORE_DEFAULT             0
#define OSPF_FAST_HELLO_DEFAULT             0

#define OSPF_AREA_BACKBONE              0x00000000      /* 0.0.0.0 */
#define OSPF_AREA_RANGE_COST_UNSPEC	-1U

#define OSPF_AREA_DEFAULT       0
#define OSPF_AREA_STUB          1
#define OSPF_AREA_NSSA          2
#define OSPF_AREA_TYPE_MAX	3

/* SPF Throttling timer values. */
#define OSPF_SPF_DELAY_DEFAULT              0
#define OSPF_SPF_HOLDTIME_DEFAULT           50
#define OSPF_SPF_MAX_HOLDTIME_DEFAULT	    5000

#define OSPF_LSA_MAXAGE_CHECK_INTERVAL		30
#define OSPF_LSA_MAXAGE_REMOVE_DELAY_DEFAULT	60

#ifdef __cplusplus
}
#endif

#endif /* _LIBOSPFD_H */
Commit	Line	Data
8551e6da DD	1	/*
	2	* Defines and structures common to OSPFv2 and OSPFv3
	3	* Copyright (C) 1998, 99, 2000 Kunihiro Ishiguro, Toshiaki Takada
	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
8551e6da DD	20	*/
	21
	22	#ifndef _LIBOSPFD_H
	23	#define _LIBOSPFD_H
	24
5e244469 RW	25	#ifdef __cplusplus
	26	extern "C" {
	27	#endif
	28
8551e6da DD	29	/* IP precedence. */
	30	#ifndef IPTOS_PREC_INTERNETCONTROL
	31	#define IPTOS_PREC_INTERNETCONTROL 0xC0
	32	#endif /* IPTOS_PREC_INTERNETCONTROL */
	33
	34	/* Default protocol, port number. */
	35	#ifndef IPPROTO_OSPFIGP
	36	#define IPPROTO_OSPFIGP 89
	37	#endif /* IPPROTO_OSPFIGP */
	38
214d8a60	39	/* Architectural Constants */
8551e6da	40	#ifdef DEBUG
ea4ecfb3	41	#define OSPF_LS_REFRESH_TIME 120
8551e6da DD	42	#else
	43	#define OSPF_LS_REFRESH_TIME 1800
	44	#endif
ac7424f9	45	#define OSPF_MIN_LS_INTERVAL 5000 /* msec */
b6927875	46	#define OSPF_MIN_LS_ARRIVAL 1000 /* in milliseconds */
8551e6da DD	47	#define OSPF_LSA_INITIAL_AGE 0 /* useful for debug */
	48	#define OSPF_LSA_MAXAGE 3600
	49	#define OSPF_CHECK_AGE 300
	50	#define OSPF_LSA_MAXAGE_DIFF 900
	51	#define OSPF_LS_INFINITY 0xffffff
	52	#define OSPF_DEFAULT_DESTINATION 0x00000000 /* 0.0.0.0 */
24873f0c DS	53	#define OSPF_INITIAL_SEQUENCE_NUMBER 0x80000001U
24873f0c DS	54	#define OSPF_MAX_SEQUENCE_NUMBER 0x7fffffffU
ca5997cd	55	#define OSPF_INVALID_SEQUENCE_NUMBER 0x80000000U
8551e6da	56
c5926a92 DD	57	/* OSPF Interface Types */
	58	#define OSPF_IFTYPE_NONE 0
	59	#define OSPF_IFTYPE_POINTOPOINT 1
	60	#define OSPF_IFTYPE_BROADCAST 2
	61	#define OSPF_IFTYPE_NBMA 3
	62	#define OSPF_IFTYPE_POINTOMULTIPOINT 4
	63	#define OSPF_IFTYPE_VIRTUALLINK 5
	64	#define OSPF_IFTYPE_LOOPBACK 6
	65	#define OSPF_IFTYPE_MAX 7
	66
8551e6da DD	67	/* OSPF interface default values. */
	68	#define OSPF_OUTPUT_COST_DEFAULT 10
	69	#define OSPF_OUTPUT_COST_INFINITE UINT16_MAX
	70	#define OSPF_ROUTER_DEAD_INTERVAL_DEFAULT 40
	71	#define OSPF_ROUTER_DEAD_INTERVAL_MINIMAL 1
	72	#define OSPF_HELLO_INTERVAL_DEFAULT 10
	73	#define OSPF_ROUTER_PRIORITY_DEFAULT 1
	74	#define OSPF_RETRANSMIT_INTERVAL_DEFAULT 5
	75	#define OSPF_TRANSMIT_DELAY_DEFAULT 1
70bd3c43	76	#define OSPF_DEFAULT_BANDWIDTH 10000 /* Mbps */
8551e6da	77
70bd3c43	78	#define OSPF_DEFAULT_REF_BANDWIDTH 100000 /* Mbps */
8551e6da DD	79
	80	#define OSPF_POLL_INTERVAL_DEFAULT 60
	81	#define OSPF_NEIGHBOR_PRIORITY_DEFAULT 0
	82
	83	#define OSPF_MTU_IGNORE_DEFAULT 0
	84	#define OSPF_FAST_HELLO_DEFAULT 0
	85
	86	#define OSPF_AREA_BACKBONE 0x00000000 /* 0.0.0.0 */
c3c0ac83	87	#define OSPF_AREA_RANGE_COST_UNSPEC -1U
8551e6da	88
ca1f4309 DS	89	#define OSPF_AREA_DEFAULT 0
	90	#define OSPF_AREA_STUB 1
	91	#define OSPF_AREA_NSSA 2
	92	#define OSPF_AREA_TYPE_MAX 3
	93
8551e6da	94	/* SPF Throttling timer values. */
ce2fa071 DW	95	#define OSPF_SPF_DELAY_DEFAULT 0
	96	#define OSPF_SPF_HOLDTIME_DEFAULT 50
	97	#define OSPF_SPF_MAX_HOLDTIME_DEFAULT 5000
8551e6da DD	98
8551e6da DD	99	#define OSPF_LSA_MAXAGE_CHECK_INTERVAL 30
2449fcd6	100	#define OSPF_LSA_MAXAGE_REMOVE_DELAY_DEFAULT 60
8551e6da	101
5e244469 RW	102	#ifdef __cplusplus
	103	}
	104	#endif
	105
8551e6da	106	#endif /* _LIBOSPFD_H */