[mirror_frr.git] / ospfd / ospf_interface.h

/*
 * OSPF Interface functions.
 * Copyright (C) 1999 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 _ZEBRA_OSPF_INTERFACE_H
#define _ZEBRA_OSPF_INTERFACE_H

#include "qobj.h"
#include "hook.h"
#include "ospfd/ospf_packet.h"
#include "ospfd/ospf_spf.h"

#define IF_OSPF_IF_INFO(I) ((struct ospf_if_info *)((I)->info))
#define IF_DEF_PARAMS(I) (IF_OSPF_IF_INFO (I)->def_params)
#define IF_OIFS(I)  (IF_OSPF_IF_INFO (I)->oifs)
#define IF_OIFS_PARAMS(I) (IF_OSPF_IF_INFO (I)->params)

/* Despite the name, this macro probably is for specialist use only */
#define OSPF_IF_PARAM_CONFIGURED(S, P) ((S) && (S)->P##__config)

/* Test whether an OSPF interface parameter is set, generally, given some
 * existing ospf interface
 */
#define OSPF_IF_PARAM_IS_SET(O, P)                                             \
	(OSPF_IF_PARAM_CONFIGURED((O)->params, P)                              \
	 || OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS((O)->ifp)->P))

#define OSPF_IF_PARAM(O, P)                                                    \
	(OSPF_IF_PARAM_CONFIGURED((O)->params, P)                              \
		 ? (O)->params->P                                              \
		 : IF_DEF_PARAMS((O)->ifp)->P)

#define DECLARE_IF_PARAM(T, P)                                                 \
	T P;                                                                   \
	uint8_t P##__config : 1
#define UNSET_IF_PARAM(S, P) ((S)->P##__config) = 0
#define SET_IF_PARAM(S, P) ((S)->P##__config) = 1

struct ospf_if_params {
	DECLARE_IF_PARAM(uint32_t,
			 transmit_delay); /* Interface Transmisson Delay */
	DECLARE_IF_PARAM(uint32_t,
			 output_cost_cmd); /* Command Interface Output Cost */
	DECLARE_IF_PARAM(uint32_t,
			 retransmit_interval); /* Retransmission Interval */
	DECLARE_IF_PARAM(uint8_t, passive_interface); /* OSPF Interface is
							passive: no sending or
							receiving (no need to
							join multicast groups)
							*/
	DECLARE_IF_PARAM(uint8_t, priority); /* OSPF Interface priority */
	/* Enable OSPF on this interface with area if_area */
	DECLARE_IF_PARAM(struct in_addr, if_area);
	uint32_t if_area_id_fmt;

	DECLARE_IF_PARAM(uint8_t, type); /* type of interface */
#define OSPF_IF_ACTIVE                  0
#define OSPF_IF_PASSIVE		        1

#define OSPF_IF_PASSIVE_STATUS(O)                                              \
	(OSPF_IF_PARAM_CONFIGURED((O)->params, passive_interface)              \
		 ? (O)->params->passive_interface                              \
		 : (OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS((O)->ifp),          \
					     passive_interface)                \
			    ? IF_DEF_PARAMS((O)->ifp)->passive_interface       \
			    : (O)->ospf->passive_interface_default))

	DECLARE_IF_PARAM(uint32_t, v_hello); /* Hello Interval */
	DECLARE_IF_PARAM(uint32_t, v_wait);  /* Router Dead Interval */

	/* MTU mismatch check (see RFC2328, chap 10.6) */
	DECLARE_IF_PARAM(uint8_t, mtu_ignore);

	/* Fast-Hellos */
	DECLARE_IF_PARAM(uint8_t, fast_hello);

	/* Authentication data. */
	uint8_t auth_simple[OSPF_AUTH_SIMPLE_SIZE + 1]; /* Simple password. */
	uint8_t auth_simple__config : 1;

	DECLARE_IF_PARAM(struct list *,
			 auth_crypt);     /* List of Auth cryptographic data. */
	DECLARE_IF_PARAM(int, auth_type); /* OSPF authentication type */

	/* Other, non-configuration state */
	uint32_t network_lsa_seqnum; /* Network LSA seqnum */

	/* BFD configuration */
	struct bfd_info *bfd_info;
};

enum { MEMBER_ALLROUTERS = 0,
       MEMBER_DROUTERS,
       MEMBER_MAX,
};

struct ospf_if_info {
	struct ospf_if_params *def_params;
	struct route_table *params;
	struct route_table *oifs;
	unsigned int
		membership_counts[MEMBER_MAX]; /* multicast group refcnts */

	uint32_t curr_mtu;
};

struct ospf_interface;

struct ospf_vl_data {
	struct in_addr vl_peer;	/* Router-ID of the peer */
	struct in_addr vl_area_id;     /* Transit area */
	int vl_area_id_fmt;	    /* Area ID format */
	struct ospf_interface *vl_oi;  /* Interface data structure */
	struct vertex_nexthop nexthop; /* Nexthop router and oi to use */
	struct in_addr peer_addr;      /* Address used to reach the peer */
	uint8_t flags;
};


#define OSPF_VL_MAX_COUNT 256
#define OSPF_VL_MTU	  1500

#define OSPF_VL_FLAG_APPROVED 0x01

struct crypt_key {
	uint8_t key_id;
	uint8_t auth_key[OSPF_AUTH_MD5_SIZE + 1];
};

/* OSPF interface structure. */
struct ospf_interface {
	/* This interface's parent ospf instance. */
	struct ospf *ospf;

	/* OSPF Area. */
	struct ospf_area *area;

	/* Position range in Router LSA */
	uint16_t lsa_pos_beg; /* inclusive, >= */
	uint16_t lsa_pos_end; /* exclusive, <  */

	/* Interface data from zebra. */
	struct interface *ifp;
	struct ospf_vl_data *vl_data; /* Data for Virtual Link */

	/* Packet send buffer. */
	struct ospf_fifo *obuf; /* Output queue */

	/* OSPF Network Type. */
	uint8_t type;

	/* State of Interface State Machine. */
	uint8_t state;

	/* To which multicast groups do we currently belong? */
	uint8_t multicast_memberships;
#define OI_MEMBER_FLAG(M) (1 << (M))
#define OI_MEMBER_COUNT(O,M) (IF_OSPF_IF_INFO(oi->ifp)->membership_counts[(M)])
#define OI_MEMBER_CHECK(O, M)                                                  \
	(CHECK_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M)))
#define OI_MEMBER_JOINED(O, M)                                                 \
	do {                                                                   \
		SET_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M));       \
		IF_OSPF_IF_INFO((O)->ifp)->membership_counts[(M)]++;           \
	} while (0)
#define OI_MEMBER_LEFT(O, M)                                                   \
	do {                                                                   \
		UNSET_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M));     \
		IF_OSPF_IF_INFO((O)->ifp)->membership_counts[(M)]--;           \
	} while (0)

	struct prefix *address;      /* Interface prefix */
	struct connected *connected; /* Pointer to connected */

	/* Configured varables. */
	struct ospf_if_params *params;

	uint32_t crypt_seqnum; /* Cryptographic Sequence Number */
	uint32_t output_cost;  /* Acutual Interface Output Cost */

	/* Neighbor information. */
	struct route_table *nbrs;       /* OSPF Neighbor List */
	struct ospf_neighbor *nbr_self; /* Neighbor Self */
#define DR(I)			((I)->nbr_self->d_router)
#define BDR(I)			((I)->nbr_self->bd_router)
#define OPTIONS(I)		((I)->nbr_self->options)
#define PRIORITY(I)		((I)->nbr_self->priority)

	/* List of configured NBMA neighbor. */
	struct list *nbr_nbma;

	/* self-originated LSAs. */
	struct ospf_lsa *network_lsa_self; /* network-LSA. */
	struct list *opaque_lsa_self;      /* Type-9 Opaque-LSAs */

	struct route_table *ls_upd_queue;

	struct list *ls_ack; /* Link State Acknowledgment list. */

	struct {
		struct list *ls_ack;
		struct in_addr dst;
	} ls_ack_direct;

	/* Timer values. */
	uint32_t v_ls_ack; /* Delayed Link State Acknowledgment */

	/* Threads. */
	struct thread *t_hello;		  /* timer */
	struct thread *t_wait;		  /* timer */
	struct thread *t_ls_ack;	  /* timer */
	struct thread *t_ls_ack_direct;   /* event */
	struct thread *t_ls_upd_event;    /* event */
	struct thread *t_opaque_lsa_self; /* Type-9 Opaque-LSAs */

	int on_write_q;

	/* Statistics fields. */
	uint32_t hello_in;     /* Hello message input count. */
	uint32_t hello_out;    /* Hello message output count. */
	uint32_t db_desc_in;   /* database desc. message input count. */
	uint32_t db_desc_out;  /* database desc. message output count. */
	uint32_t ls_req_in;    /* LS request message input count. */
	uint32_t ls_req_out;   /* LS request message output count. */
	uint32_t ls_upd_in;    /* LS update message input count. */
	uint32_t ls_upd_out;   /* LS update message output count. */
	uint32_t ls_ack_in;    /* LS Ack message input count. */
	uint32_t ls_ack_out;   /* LS Ack message output count. */
	uint32_t discarded;    /* discarded input count by error. */
	uint32_t state_change; /* Number of status change. */

	uint32_t full_nbrs;

	QOBJ_FIELDS
};
DECLARE_QOBJ_TYPE(ospf_interface)

/* Prototypes. */
extern char *ospf_if_name(struct ospf_interface *);
extern struct ospf_interface *ospf_if_new(struct ospf *, struct interface *,
					  struct prefix *);
extern void ospf_if_cleanup(struct ospf_interface *);
extern void ospf_if_free(struct ospf_interface *);
extern int ospf_if_up(struct ospf_interface *);
extern int ospf_if_down(struct ospf_interface *);

extern int ospf_if_is_up(struct ospf_interface *);
extern struct ospf_interface *ospf_if_exists(struct ospf_interface *);
extern struct ospf_interface *ospf_if_lookup_by_lsa_pos(struct ospf_area *,
							int);
extern struct ospf_interface *
ospf_if_lookup_by_local_addr(struct ospf *, struct interface *, struct in_addr);
extern struct ospf_interface *ospf_if_lookup_by_prefix(struct ospf *,
						       struct prefix_ipv4 *);
extern struct ospf_interface *ospf_if_table_lookup(struct interface *,
						   struct prefix *);
extern struct ospf_interface *ospf_if_addr_local(struct in_addr);
extern struct ospf_interface *
ospf_if_lookup_recv_if(struct ospf *, struct in_addr, struct interface *);
extern struct ospf_interface *ospf_if_is_configured(struct ospf *,
						    struct in_addr *);

extern struct ospf_if_params *ospf_lookup_if_params(struct interface *,
						    struct in_addr);
extern struct ospf_if_params *ospf_get_if_params(struct interface *,
						 struct in_addr);
extern void ospf_del_if_params(struct ospf_if_params *);
extern void ospf_free_if_params(struct interface *, struct in_addr);
extern void ospf_if_update_params(struct interface *, struct in_addr);

extern int ospf_if_new_hook(struct interface *);
extern void ospf_if_init(void);
extern void ospf_if_stream_unset(struct ospf_interface *);
extern void ospf_if_reset_variables(struct ospf_interface *);
extern int ospf_if_is_enable(struct ospf_interface *);
extern int ospf_if_get_output_cost(struct ospf_interface *);
extern void ospf_if_recalculate_output_cost(struct interface *);

/* Simulate down/up on the interface. */
extern void ospf_if_reset(struct interface *);

extern struct ospf_interface *ospf_vl_new(struct ospf *, struct ospf_vl_data *);
extern struct ospf_vl_data *ospf_vl_data_new(struct ospf_area *,
					     struct in_addr);
extern struct ospf_vl_data *ospf_vl_lookup(struct ospf *, struct ospf_area *,
					   struct in_addr);
extern int ospf_vl_count(struct ospf *ospf, struct ospf_area *area);
extern void ospf_vl_data_free(struct ospf_vl_data *);
extern void ospf_vl_add(struct ospf *, struct ospf_vl_data *);
extern void ospf_vl_delete(struct ospf *, struct ospf_vl_data *);
extern void ospf_vl_up_check(struct ospf_area *, struct in_addr,
			     struct vertex *);
extern void ospf_vl_unapprove(struct ospf *);
extern void ospf_vl_shut_unapproved(struct ospf *);
extern int ospf_full_virtual_nbrs(struct ospf_area *);
extern int ospf_vls_in_area(struct ospf_area *);

extern struct crypt_key *ospf_crypt_key_lookup(struct list *, uint8_t);
extern struct crypt_key *ospf_crypt_key_new(void);
extern void ospf_crypt_key_add(struct list *, struct crypt_key *);
extern int ospf_crypt_key_delete(struct list *, uint8_t);
extern uint8_t ospf_default_iftype(struct interface *ifp);
extern int ospf_interface_neighbor_count(struct ospf_interface *oi);

/* Set all multicast memberships appropriately based on the type and
   state of the interface. */
extern void ospf_if_set_multicast(struct ospf_interface *);

extern void ospf_if_interface(struct interface *ifp);

DECLARE_HOOK(ospf_vl_add, (struct ospf_vl_data * vd), (vd))
DECLARE_HOOK(ospf_vl_delete, (struct ospf_vl_data * vd), (vd))

DECLARE_HOOK(ospf_if_update, (struct interface * ifp), (ifp))
DECLARE_HOOK(ospf_if_delete, (struct interface * ifp), (ifp))

#endif /* _ZEBRA_OSPF_INTERFACE_H */
Commit	Line	Data
718e3744	1	/*
	2	* OSPF Interface functions.
	3	* Copyright (C) 1999 Toshiaki Takada
	4	*
	5	* This file is part of GNU Zebra.
896014f4	6	*
718e3744	7	* GNU Zebra is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published
	9	* by the Free Software Foundation; either version 2, or (at your
	10	* option) any 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	*/
	21
	22	#ifndef _ZEBRA_OSPF_INTERFACE_H
	23	#define _ZEBRA_OSPF_INTERFACE_H
	24
ae19c240	25	#include "qobj.h"
3012671f	26	#include "hook.h"
6c835671	27	#include "ospfd/ospf_packet.h"
9c27ef9b	28	#include "ospfd/ospf_spf.h"
718e3744	29
	30	#define IF_OSPF_IF_INFO(I) ((struct ospf_if_info *)((I)->info))
	31	#define IF_DEF_PARAMS(I) (IF_OSPF_IF_INFO (I)->def_params)
	32	#define IF_OIFS(I) (IF_OSPF_IF_INFO (I)->oifs)
	33	#define IF_OIFS_PARAMS(I) (IF_OSPF_IF_INFO (I)->params)
52c62ab8 JAG	34
52c62ab8 JAG	35	/* Despite the name, this macro probably is for specialist use only */
718e3744	36	#define OSPF_IF_PARAM_CONFIGURED(S, P) ((S) && (S)->P##__config)
52c62ab8 JAG	37
	38	/* Test whether an OSPF interface parameter is set, generally, given some
	39	* existing ospf interface
	40	*/
d62a17ae	41	#define OSPF_IF_PARAM_IS_SET(O, P) \
	42	(OSPF_IF_PARAM_CONFIGURED((O)->params, P) \
	43	\|\| OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS((O)->ifp)->P))
52c62ab8	44
d62a17ae	45	#define OSPF_IF_PARAM(O, P) \
	46	(OSPF_IF_PARAM_CONFIGURED((O)->params, P) \
	47	? (O)->params->P \
	48	: IF_DEF_PARAMS((O)->ifp)->P)
718e3744	49
d7c0a89a QY	50	#define DECLARE_IF_PARAM(T, P) \
	51	T P; \
	52	uint8_t P##__config : 1
718e3744	53	#define UNSET_IF_PARAM(S, P) ((S)->P##__config) = 0
	54	#define SET_IF_PARAM(S, P) ((S)->P##__config) = 1
	55
d62a17ae	56	struct ospf_if_params {
d7c0a89a	57	DECLARE_IF_PARAM(uint32_t,
d62a17ae	58	transmit_delay); /* Interface Transmisson Delay */
d7c0a89a	59	DECLARE_IF_PARAM(uint32_t,
d62a17ae	60	output_cost_cmd); /* Command Interface Output Cost */
d7c0a89a	61	DECLARE_IF_PARAM(uint32_t,
d62a17ae	62	retransmit_interval); /* Retransmission Interval */
d7c0a89a	63	DECLARE_IF_PARAM(uint8_t, passive_interface); /* OSPF Interface is
d62a17ae	64	passive: no sending or
	65	receiving (no need to
	66	join multicast groups)
	67	*/
d7c0a89a	68	DECLARE_IF_PARAM(uint8_t, priority); /* OSPF Interface priority */
d62a17ae	69	/* Enable OSPF on this interface with area if_area */
d62a17ae	70	DECLARE_IF_PARAM(struct in_addr, if_area);
d7c0a89a	71	uint32_t if_area_id_fmt;
5ed0add5	72
d7c0a89a	73	DECLARE_IF_PARAM(uint8_t, type); /* type of interface */
718e3744	74	#define OSPF_IF_ACTIVE 0
718e3744	75	#define OSPF_IF_PASSIVE 1
7ffa8fa2	76
d62a17ae	77	#define OSPF_IF_PASSIVE_STATUS(O) \
	78	(OSPF_IF_PARAM_CONFIGURED((O)->params, passive_interface) \
	79	? (O)->params->passive_interface \
	80	: (OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS((O)->ifp), \
	81	passive_interface) \
	82	? IF_DEF_PARAMS((O)->ifp)->passive_interface \
	83	: (O)->ospf->passive_interface_default))
	84
d7c0a89a QY	85	DECLARE_IF_PARAM(uint32_t, v_hello); /* Hello Interval */
d7c0a89a QY	86	DECLARE_IF_PARAM(uint32_t, v_wait); /* Router Dead Interval */
d62a17ae	87
d62a17ae	88	/* MTU mismatch check (see RFC2328, chap 10.6) */
d7c0a89a	89	DECLARE_IF_PARAM(uint8_t, mtu_ignore);
d62a17ae	90
d62a17ae	91	/* Fast-Hellos */
d7c0a89a	92	DECLARE_IF_PARAM(uint8_t, fast_hello);
d62a17ae	93
d62a17ae	94	/* Authentication data. */
d7c0a89a QY	95	uint8_t auth_simple[OSPF_AUTH_SIMPLE_SIZE + 1]; /* Simple password. */
d7c0a89a QY	96	uint8_t auth_simple__config : 1;
d62a17ae	97
	98	DECLARE_IF_PARAM(struct list *,
	99	auth_crypt); /* List of Auth cryptographic data. */
	100	DECLARE_IF_PARAM(int, auth_type); /* OSPF authentication type */
	101
	102	/* Other, non-configuration state */
d7c0a89a	103	uint32_t network_lsa_seqnum; /* Network LSA seqnum */
d62a17ae	104
	105	/* BFD configuration */
	106	struct bfd_info *bfd_info;
718e3744	107	};
718e3744	108
d62a17ae	109	enum { MEMBER_ALLROUTERS = 0,
	110	MEMBER_DROUTERS,
	111	MEMBER_MAX,
429ac78c PJ	112	};
429ac78c PJ	113
d62a17ae	114	struct ospf_if_info {
	115	struct ospf_if_params *def_params;
	116	struct route_table *params;
	117	struct route_table *oifs;
	118	unsigned int
	119	membership_counts[MEMBER_MAX]; /* multicast group refcnts */
85d25587 DS	120
85d25587 DS	121	uint32_t curr_mtu;
718e3744	122	};
	123
	124	struct ospf_interface;
	125
d62a17ae	126	struct ospf_vl_data {
	127	struct in_addr vl_peer; /* Router-ID of the peer */
	128	struct in_addr vl_area_id; /* Transit area */
	129	int vl_area_id_fmt; /* Area ID format */
	130	struct ospf_interface vl_oi; / Interface data structure */
	131	struct vertex_nexthop nexthop; /* Nexthop router and oi to use */
	132	struct in_addr peer_addr; /* Address used to reach the peer */
d7c0a89a	133	uint8_t flags;
718e3744	134	};
	135
	136
	137	#define OSPF_VL_MAX_COUNT 256
	138	#define OSPF_VL_MTU 1500
	139
	140	#define OSPF_VL_FLAG_APPROVED 0x01
	141
d62a17ae	142	struct crypt_key {
d7c0a89a QY	143	uint8_t key_id;
d7c0a89a QY	144	uint8_t auth_key[OSPF_AUTH_MD5_SIZE + 1];
718e3744	145	};
	146
	147	/* OSPF interface structure. */
d62a17ae	148	struct ospf_interface {
	149	/* This interface's parent ospf instance. */
	150	struct ospf *ospf;
718e3744	151
d62a17ae	152	/* OSPF Area. */
d62a17ae	153	struct ospf_area *area;
718e3744	154
d62a17ae	155	/* Position range in Router LSA */
	156	uint16_t lsa_pos_beg; /* inclusive, >= */
	157	uint16_t lsa_pos_end; /* exclusive, < */
c81ee5c9	158
d62a17ae	159	/* Interface data from zebra. */
	160	struct interface *ifp;
	161	struct ospf_vl_data vl_data; / Data for Virtual Link */
718e3744	162
d62a17ae	163	/* Packet send buffer. */
d62a17ae	164	struct ospf_fifo obuf; / Output queue */
718e3744	165
d62a17ae	166	/* OSPF Network Type. */
d7c0a89a	167	uint8_t type;
718e3744	168
d62a17ae	169	/* State of Interface State Machine. */
d7c0a89a	170	uint8_t state;
d62a17ae	171
d62a17ae	172	/* To which multicast groups do we currently belong? */
d7c0a89a	173	uint8_t multicast_memberships;
429ac78c PJ	174	#define OI_MEMBER_FLAG(M) (1 << (M))
429ac78c PJ	175	#define OI_MEMBER_COUNT(O,M) (IF_OSPF_IF_INFO(oi->ifp)->membership_counts[(M)])
d62a17ae	176	#define OI_MEMBER_CHECK(O, M) \
	177	(CHECK_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M)))
	178	#define OI_MEMBER_JOINED(O, M) \
	179	do { \
	180	SET_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M)); \
	181	IF_OSPF_IF_INFO((O)->ifp)->membership_counts[(M)]++; \
	182	} while (0)
	183	#define OI_MEMBER_LEFT(O, M) \
	184	do { \
	185	UNSET_FLAG((O)->multicast_memberships, OI_MEMBER_FLAG(M)); \
	186	IF_OSPF_IF_INFO((O)->ifp)->membership_counts[(M)]--; \
	187	} while (0)
	188
	189	struct prefix address; / Interface prefix */
	190	struct connected connected; / Pointer to connected */
	191
	192	/* Configured varables. */
	193	struct ospf_if_params *params;
	194
d7c0a89a QY	195	uint32_t crypt_seqnum; /* Cryptographic Sequence Number */
d7c0a89a QY	196	uint32_t output_cost; /* Acutual Interface Output Cost */
d62a17ae	197
	198	/* Neighbor information. */
	199	struct route_table nbrs; / OSPF Neighbor List */
	200	struct ospf_neighbor nbr_self; / Neighbor Self */
718e3744	201	#define DR(I) ((I)->nbr_self->d_router)
	202	#define BDR(I) ((I)->nbr_self->bd_router)
	203	#define OPTIONS(I) ((I)->nbr_self->options)
	204	#define PRIORITY(I) ((I)->nbr_self->priority)
	205
d62a17ae	206	/* List of configured NBMA neighbor. */
	207	struct list *nbr_nbma;
	208
	209	/* self-originated LSAs. */
	210	struct ospf_lsa network_lsa_self; / network-LSA. */
	211	struct list opaque_lsa_self; / Type-9 Opaque-LSAs */
	212
	213	struct route_table *ls_upd_queue;
	214
	215	struct list ls_ack; / Link State Acknowledgment list. */
	216
	217	struct {
	218	struct list *ls_ack;
	219	struct in_addr dst;
	220	} ls_ack_direct;
	221
	222	/* Timer values. */
d7c0a89a	223	uint32_t v_ls_ack; /* Delayed Link State Acknowledgment */
d62a17ae	224
	225	/* Threads. */
	226	struct thread t_hello; / timer */
	227	struct thread t_wait; / timer */
	228	struct thread t_ls_ack; / timer */
	229	struct thread t_ls_ack_direct; / event */
	230	struct thread t_ls_upd_event; / event */
	231	struct thread t_opaque_lsa_self; / Type-9 Opaque-LSAs */
	232
	233	int on_write_q;
	234
	235	/* Statistics fields. */
d7c0a89a QY	236	uint32_t hello_in; /* Hello message input count. */
	237	uint32_t hello_out; /* Hello message output count. */
	238	uint32_t db_desc_in; /* database desc. message input count. */
	239	uint32_t db_desc_out; /* database desc. message output count. */
	240	uint32_t ls_req_in; /* LS request message input count. */
	241	uint32_t ls_req_out; /* LS request message output count. */
	242	uint32_t ls_upd_in; /* LS update message input count. */
	243	uint32_t ls_upd_out; /* LS update message output count. */
	244	uint32_t ls_ack_in; /* LS Ack message input count. */
	245	uint32_t ls_ack_out; /* LS Ack message output count. */
	246	uint32_t discarded; /* discarded input count by error. */
	247	uint32_t state_change; /* Number of status change. */
	248
	249	uint32_t full_nbrs;
d62a17ae	250
d62a17ae	251	QOBJ_FIELDS
718e3744	252	};
ae19c240	253	DECLARE_QOBJ_TYPE(ospf_interface)
718e3744	254
718e3744	255	/* Prototypes. */
d62a17ae	256	extern char ospf_if_name(struct ospf_interface );
	257	extern struct ospf_interface ospf_if_new(struct ospf , struct interface *,
	258	struct prefix *);
	259	extern void ospf_if_cleanup(struct ospf_interface *);
	260	extern void ospf_if_free(struct ospf_interface *);
	261	extern int ospf_if_up(struct ospf_interface *);
	262	extern int ospf_if_down(struct ospf_interface *);
	263
	264	extern int ospf_if_is_up(struct ospf_interface *);
	265	extern struct ospf_interface ospf_if_exists(struct ospf_interface );
	266	extern struct ospf_interface ospf_if_lookup_by_lsa_pos(struct ospf_area ,
	267	int);
	268	extern struct ospf_interface *
	269	ospf_if_lookup_by_local_addr(struct ospf , struct interface , struct in_addr);
	270	extern struct ospf_interface ospf_if_lookup_by_prefix(struct ospf ,
	271	struct prefix_ipv4 *);
	272	extern struct ospf_interface ospf_if_table_lookup(struct interface ,
	273	struct prefix *);
	274	extern struct ospf_interface *ospf_if_addr_local(struct in_addr);
	275	extern struct ospf_interface *
	276	ospf_if_lookup_recv_if(struct ospf , struct in_addr, struct interface );
	277	extern struct ospf_interface ospf_if_is_configured(struct ospf ,
	278	struct in_addr *);
	279
	280	extern struct ospf_if_params ospf_lookup_if_params(struct interface ,
	281	struct in_addr);
	282	extern struct ospf_if_params ospf_get_if_params(struct interface ,
	283	struct in_addr);
	284	extern void ospf_del_if_params(struct ospf_if_params *);
	285	extern void ospf_free_if_params(struct interface *, struct in_addr);
	286	extern void ospf_if_update_params(struct interface *, struct in_addr);
	287
	288	extern int ospf_if_new_hook(struct interface *);
	289	extern void ospf_if_init(void);
d62a17ae	290	extern void ospf_if_stream_unset(struct ospf_interface *);
	291	extern void ospf_if_reset_variables(struct ospf_interface *);
	292	extern int ospf_if_is_enable(struct ospf_interface *);
	293	extern int ospf_if_get_output_cost(struct ospf_interface *);
	294	extern void ospf_if_recalculate_output_cost(struct interface *);
718e3744	295
a608bbf2	296	/* Simulate down/up on the interface. */
d62a17ae	297	extern void ospf_if_reset(struct interface *);
	298
	299	extern struct ospf_interface ospf_vl_new(struct ospf , struct ospf_vl_data *);
	300	extern struct ospf_vl_data ospf_vl_data_new(struct ospf_area ,
	301	struct in_addr);
	302	extern struct ospf_vl_data ospf_vl_lookup(struct ospf , struct ospf_area *,
	303	struct in_addr);
19ce7d5e	304	extern int ospf_vl_count(struct ospf ospf, struct ospf_area area);
d62a17ae	305	extern void ospf_vl_data_free(struct ospf_vl_data *);
	306	extern void ospf_vl_add(struct ospf , struct ospf_vl_data );
	307	extern void ospf_vl_delete(struct ospf , struct ospf_vl_data );
	308	extern void ospf_vl_up_check(struct ospf_area *, struct in_addr,
	309	struct vertex *);
	310	extern void ospf_vl_unapprove(struct ospf *);
	311	extern void ospf_vl_shut_unapproved(struct ospf *);
	312	extern int ospf_full_virtual_nbrs(struct ospf_area *);
	313	extern int ospf_vls_in_area(struct ospf_area *);
	314
d7c0a89a	315	extern struct crypt_key ospf_crypt_key_lookup(struct list , uint8_t);
d62a17ae	316	extern struct crypt_key *ospf_crypt_key_new(void);
d62a17ae	317	extern void ospf_crypt_key_add(struct list , struct crypt_key );
d7c0a89a QY	318	extern int ospf_crypt_key_delete(struct list *, uint8_t);
d7c0a89a QY	319	extern uint8_t ospf_default_iftype(struct interface *ifp);
2bc7673f	320	extern int ospf_interface_neighbor_count(struct ospf_interface *oi);
bc18d616	321
ba6454ec	322	/* Set all multicast memberships appropriately based on the type and
ba6454ec	323	state of the interface. */
d62a17ae	324	extern void ospf_if_set_multicast(struct ospf_interface *);
ba6454ec	325
ef7bd2a3 DS	326	extern void ospf_if_interface(struct interface *ifp);
ef7bd2a3 DS	327
d62a17ae	328	DECLARE_HOOK(ospf_vl_add, (struct ospf_vl_data * vd), (vd))
d62a17ae	329	DECLARE_HOOK(ospf_vl_delete, (struct ospf_vl_data * vd), (vd))
3012671f	330
ef7bd2a3	331	DECLARE_HOOK(ospf_if_update, (struct interface * ifp), (ifp))
3c3c3252 DS	332	DECLARE_HOOK(ospf_if_delete, (struct interface * ifp), (ifp))
3c3c3252 DS	333
718e3744	334	#endif /* _ZEBRA_OSPF_INTERFACE_H */