1 /*
2  * OSPF Neighbor functions.
3  * Copyright (C) 1999, 2000 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
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  *
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 _ZEBRA_OSPF_NEIGHBOR_H
23 #define _ZEBRA_OSPF_NEIGHBOR_H
24 
25 #include <ospfd/ospf_packet.h>
26 
27 /* Neighbor Data Structure */
28 struct ospf_neighbor {
29 	/* This neighbor's parent ospf interface. */
30 	struct ospf_interface *oi;
31 
32 	/* OSPF neighbor Information */
33 	uint8_t state;      /* NSM status. */
34 	uint8_t dd_flags;   /* DD bit flags. */
35 	uint32_t dd_seqnum; /* DD Sequence Number. */
36 
37 	/* Neighbor Information from Hello. */
38 	struct prefix address; /* Neighbor Interface Address. */
39 
40 	struct in_addr src;       /* Src address. */
41 	struct in_addr router_id; /* Router ID. */
42 	uint8_t options;	  /* Options. */
43 	int priority;		  /* Router Priority. */
44 	struct in_addr d_router;  /* Designated Router. */
45 	struct in_addr bd_router; /* Backup Designated Router. */
46 
47 	/* Last sent Database Description packet. */
48 	struct ospf_packet *last_send;
49 	/* Timestemp when last Database Description packet was sent */
50 	struct timeval last_send_ts;
51 
52 	/* Last received Databse Description packet. */
53 	struct {
54 		uint8_t options;
55 		uint8_t flags;
56 		uint32_t dd_seqnum;
57 	} last_recv;
58 
59 	/* LSA data. */
60 	struct ospf_lsdb ls_rxmt;
61 	struct ospf_lsdb db_sum;
62 	struct ospf_lsdb ls_req;
63 	struct ospf_lsa *ls_req_last;
64 
65 	uint32_t crypt_seqnum; /* Cryptographic Sequence Number. */
66 
67 	/* Timer values. */
68 	uint32_t v_inactivity;
69 	uint32_t v_db_desc;
70 	uint32_t v_ls_req;
71 	uint32_t v_ls_upd;
72 
73 	/* Threads. */
74 	struct thread *t_inactivity;
75 	struct thread *t_db_desc;
76 	struct thread *t_ls_req;
77 	struct thread *t_ls_upd;
78 	struct thread *t_hello_reply;
79 
80 	/* NBMA configured neighbour */
81 	struct ospf_nbr_nbma *nbr_nbma;
82 
83 	/* Statistics */
84 	struct timeval ts_last_progress; /* last advance of NSM            */
85 	struct timeval ts_last_regress;  /* last regressive NSM change     */
86 	const char *last_regress_str;    /* Event which last regressed NSM */
87 	uint32_t state_change;		 /* NSM state change counter       */
88 
89 	/* BFD information */
90 	void *bfd_info;
91 };
92 
93 /* Macros. */
94 #define NBR_IS_DR(n)	IPV4_ADDR_SAME (&n->address.u.prefix4, &n->d_router)
95 #define NBR_IS_BDR(n)   IPV4_ADDR_SAME (&n->address.u.prefix4, &n->bd_router)
96 
97 /* Prototypes. */
98 extern struct ospf_neighbor *ospf_nbr_new(struct ospf_interface *);
99 extern void ospf_nbr_free(struct ospf_neighbor *);
100 extern void ospf_nbr_delete(struct ospf_neighbor *);
101 extern int ospf_nbr_bidirectional(struct in_addr *, struct in_addr *, int);
102 extern void ospf_nbr_self_reset(struct ospf_interface *, struct in_addr);
103 extern void ospf_nbr_add_self(struct ospf_interface *, struct in_addr);
104 extern int ospf_nbr_count(struct ospf_interface *, int);
105 extern int ospf_nbr_count_opaque_capable(struct ospf_interface *);
106 extern struct ospf_neighbor *ospf_nbr_get(struct ospf_interface *,
107 					  struct ospf_header *, struct ip *,
108 					  struct prefix *);
109 extern struct ospf_neighbor *ospf_nbr_lookup(struct ospf_interface *,
110 					     struct ip *, struct ospf_header *);
111 extern struct ospf_neighbor *ospf_nbr_lookup_by_addr(struct route_table *,
112 						     struct in_addr *);
113 extern struct ospf_neighbor *ospf_nbr_lookup_by_routerid(struct route_table *,
114 							 struct in_addr *);
115 extern void ospf_renegotiate_optional_capabilities(struct ospf *top);
116 
117 #endif /* _ZEBRA_OSPF_NEIGHBOR_H */
118