[mirror_frr.git] / ospfd / ospf_neighbor.c

/*
 * OSPF Neighbor functions.
 * Copyright (C) 1999, 2000 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
 */

#include <zebra.h>

#include "linklist.h"
#include "prefix.h"
#include "memory.h"
#include "command.h"
#include "thread.h"
#include "stream.h"
#include "table.h"
#include "log.h"
#include "json.h"

#include "ospfd/ospfd.h"
#include "ospfd/ospf_interface.h"
#include "ospfd/ospf_asbr.h"
#include "ospfd/ospf_lsa.h"
#include "ospfd/ospf_lsdb.h"
#include "ospfd/ospf_neighbor.h"
#include "ospfd/ospf_nsm.h"
#include "ospfd/ospf_packet.h"
#include "ospfd/ospf_network.h"
#include "ospfd/ospf_flood.h"
#include "ospfd/ospf_dump.h"
#include "ospfd/ospf_bfd.h"

/* Fill in the the 'key' as appropriate to retrieve the entry for nbr
 * from the ospf_interface's nbrs table. Indexed by interface address
 * for all cases except Virtual-link and PointToPoint interfaces, where
 * neighbours are indexed by router-ID instead.
 */
static void ospf_nbr_key(struct ospf_interface *oi, struct ospf_neighbor *nbr,
			 struct prefix *key)
{
	key->family = AF_INET;
	key->prefixlen = IPV4_MAX_BITLEN;

	/* vlinks are indexed by router-id */
	if (oi->type == OSPF_IFTYPE_VIRTUALLINK
	    || oi->type == OSPF_IFTYPE_POINTOPOINT)
		key->u.prefix4 = nbr->router_id;
	else
		key->u.prefix4 = nbr->src;
	return;
}

struct ospf_neighbor *ospf_nbr_new(struct ospf_interface *oi)
{
	struct ospf_neighbor *nbr;

	/* Allcate new neighbor. */
	nbr = XCALLOC(MTYPE_OSPF_NEIGHBOR, sizeof(struct ospf_neighbor));

	/* Relate neighbor to the interface. */
	nbr->oi = oi;

	/* Set default values. */
	nbr->state = NSM_Down;

	/* Set inheritance values. */
	nbr->v_inactivity = OSPF_IF_PARAM(oi, v_wait);
	nbr->v_db_desc = OSPF_IF_PARAM(oi, retransmit_interval);
	nbr->v_ls_req = OSPF_IF_PARAM(oi, retransmit_interval);
	nbr->v_ls_upd = OSPF_IF_PARAM(oi, retransmit_interval);
	nbr->priority = -1;

	/* DD flags. */
	nbr->dd_flags = OSPF_DD_FLAG_MS | OSPF_DD_FLAG_M | OSPF_DD_FLAG_I;

	/* Last received and sent DD. */
	nbr->last_send = NULL;

	nbr->nbr_nbma = NULL;

	ospf_lsdb_init(&nbr->db_sum);
	ospf_lsdb_init(&nbr->ls_rxmt);
	ospf_lsdb_init(&nbr->ls_req);

	nbr->crypt_seqnum = 0;

	ospf_bfd_info_nbr_create(oi, nbr);
	return nbr;
}

void ospf_nbr_free(struct ospf_neighbor *nbr)
{
	/* Free DB summary list. */
	if (ospf_db_summary_count(nbr))
		ospf_db_summary_clear(nbr);
	/* ospf_db_summary_delete_all (nbr); */

	/* Free ls request list. */
	if (ospf_ls_request_count(nbr))
		ospf_ls_request_delete_all(nbr);

	/* Free retransmit list. */
	if (ospf_ls_retransmit_count(nbr))
		ospf_ls_retransmit_clear(nbr);

	/* Cleanup LSDBs. */
	ospf_lsdb_cleanup(&nbr->db_sum);
	ospf_lsdb_cleanup(&nbr->ls_req);
	ospf_lsdb_cleanup(&nbr->ls_rxmt);

	/* Clear last send packet. */
	if (nbr->last_send)
		ospf_packet_free(nbr->last_send);

	if (nbr->nbr_nbma) {
		nbr->nbr_nbma->nbr = NULL;
		nbr->nbr_nbma = NULL;
	}

	/* Cancel all timers. */
	OSPF_NSM_TIMER_OFF(nbr->t_inactivity);
	OSPF_NSM_TIMER_OFF(nbr->t_db_desc);
	OSPF_NSM_TIMER_OFF(nbr->t_ls_req);
	OSPF_NSM_TIMER_OFF(nbr->t_ls_upd);

	/* Cancel all events. */ /* Thread lookup cost would be negligible. */
	thread_cancel_event(master, nbr);

	ospf_bfd_info_free(&nbr->bfd_info);

	nbr->oi = NULL;
	XFREE(MTYPE_OSPF_NEIGHBOR, nbr);
}

/* Delete specified OSPF neighbor from interface. */
void ospf_nbr_delete(struct ospf_neighbor *nbr)
{
	struct ospf_interface *oi;
	struct route_node *rn;
	struct prefix p;

	oi = nbr->oi;

	/* get appropriate prefix 'key' */
	ospf_nbr_key(oi, nbr, &p);

	rn = route_node_lookup(oi->nbrs, &p);
	if (rn) {
		/* If lookup for a NBR succeeds, the leaf route_node could
		 * only exist because there is (or was) a nbr there.
		 * If the nbr was deleted, the leaf route_node should have
		 * lost its last refcount too, and be deleted.
		 * Therefore a looked-up leaf route_node in nbrs table
		 * should never have NULL info.
		 */
		assert(rn->info);

		if (rn->info) {
			rn->info = NULL;
			route_unlock_node(rn);
		} else
			zlog_info("Can't find neighbor %s in the interface %s",
				  inet_ntoa(nbr->src), IF_NAME(oi));

		route_unlock_node(rn);
	} else {
		/*
		 * This neighbor was not found, but before we move on and
		 * free the neighbor structre, make sure that it was not
		 * indexed incorrectly and ended up in the "worng" place
		 */

		/* Reverse the lookup rules */
		if (oi->type == OSPF_IFTYPE_VIRTUALLINK
		    || oi->type == OSPF_IFTYPE_POINTOPOINT)
			p.u.prefix4 = nbr->src;
		else
			p.u.prefix4 = nbr->router_id;

		rn = route_node_lookup(oi->nbrs, &p);
		if (rn) {
			/* We found the neighbor!
			 * Now make sure it is not the exact same neighbor
			 * structure that we are about to free
			 */
			if (nbr == rn->info) {
				/* Same neighbor, drop the reference to it */
				rn->info = NULL;
				route_unlock_node(rn);
			}
			route_unlock_node(rn);
		}
	}

	/* Free ospf_neighbor structure. */
	ospf_nbr_free(nbr);
}

/* Check myself is in the neighbor list. */
int ospf_nbr_bidirectional(struct in_addr *router_id, struct in_addr *neighbors,
			   int size)
{
	int i;
	int max;

	max = size / sizeof(struct in_addr);

	for (i = 0; i < max; i++)
		if (IPV4_ADDR_SAME(router_id, &neighbors[i]))
			return 1;

	return 0;
}

/* reset nbr_self */
void ospf_nbr_self_reset(struct ospf_interface *oi, struct in_addr router_id)
{
	if (oi->nbr_self)
		ospf_nbr_delete(oi->nbr_self);

	oi->nbr_self = ospf_nbr_new(oi);
	ospf_nbr_add_self(oi, router_id);
}

/* Add self to nbr list. */
void ospf_nbr_add_self(struct ospf_interface *oi, struct in_addr router_id)
{
	struct prefix p;
	struct route_node *rn;

	if (!oi->nbr_self)
		oi->nbr_self = ospf_nbr_new(oi);

	/* Initial state */
	oi->nbr_self->address = *oi->address;
	oi->nbr_self->priority = OSPF_IF_PARAM(oi, priority);
	oi->nbr_self->router_id = router_id;
	oi->nbr_self->src = oi->address->u.prefix4;
	oi->nbr_self->state = NSM_TwoWay;

	switch (oi->area->external_routing) {
	case OSPF_AREA_DEFAULT:
		SET_FLAG(oi->nbr_self->options, OSPF_OPTION_E);
		break;
	case OSPF_AREA_STUB:
		UNSET_FLAG(oi->nbr_self->options, OSPF_OPTION_E);
		break;
	case OSPF_AREA_NSSA:
		UNSET_FLAG(oi->nbr_self->options, OSPF_OPTION_E);
		SET_FLAG(oi->nbr_self->options, OSPF_OPTION_NP);
		break;
	}

	/* Add nbr_self to nbrs table */
	ospf_nbr_key(oi, oi->nbr_self, &p);

	rn = route_node_get(oi->nbrs, &p);
	if (rn->info) {
		/* There is already pseudo neighbor. */
		if (IS_DEBUG_OSPF_EVENT)
			zlog_debug(
				"router_id %s already present in neighbor table. node refcount %u",
				inet_ntoa(router_id), rn->lock);
		route_unlock_node(rn);
	} else
		rn->info = oi->nbr_self;
}

/* Get neighbor count by status.
   Specify status = 0, get all neighbor other than myself. */
int ospf_nbr_count(struct ospf_interface *oi, int state)
{
	struct ospf_neighbor *nbr;
	struct route_node *rn;
	int count = 0;

	for (rn = route_top(oi->nbrs); rn; rn = route_next(rn))
		if ((nbr = rn->info))
			if (!IPV4_ADDR_SAME(&nbr->router_id,
					    &oi->ospf->router_id))
				if (state == 0 || nbr->state == state)
					count++;

	return count;
}

int ospf_nbr_count_opaque_capable(struct ospf_interface *oi)
{
	struct ospf_neighbor *nbr;
	struct route_node *rn;
	int count = 0;

	for (rn = route_top(oi->nbrs); rn; rn = route_next(rn))
		if ((nbr = rn->info))
			if (!IPV4_ADDR_SAME(&nbr->router_id,
					    &oi->ospf->router_id))
				if (nbr->state == NSM_Full)
					if (CHECK_FLAG(nbr->options,
						       OSPF_OPTION_O))
						count++;

	return count;
}

/* lookup nbr by address - use this only if you know you must
 * otherwise use the ospf_nbr_lookup() wrapper, which deals
 * with virtual link and PointToPoint neighbours
 */
struct ospf_neighbor *ospf_nbr_lookup_by_addr(struct route_table *nbrs,
					      struct in_addr *addr)
{
	struct prefix p;
	struct route_node *rn;
	struct ospf_neighbor *nbr;

	p.family = AF_INET;
	p.prefixlen = IPV4_MAX_BITLEN;
	p.u.prefix4 = *addr;

	rn = route_node_lookup(nbrs, &p);
	if (!rn)
		return NULL;

	/* See comment in ospf_nbr_delete */
	assert(rn->info);

	if (rn->info == NULL) {
		route_unlock_node(rn);
		return NULL;
	}

	nbr = (struct ospf_neighbor *)rn->info;
	route_unlock_node(rn);

	return nbr;
}

struct ospf_neighbor *ospf_nbr_lookup_by_routerid(struct route_table *nbrs,
						  struct in_addr *id)
{
	struct route_node *rn;
	struct ospf_neighbor *nbr;

	for (rn = route_top(nbrs); rn; rn = route_next(rn))
		if ((nbr = rn->info) != NULL)
			if (IPV4_ADDR_SAME(&nbr->router_id, id)) {
				route_unlock_node(rn);
				return nbr;
			}

	return NULL;
}

void ospf_renegotiate_optional_capabilities(struct ospf *top)
{
	struct listnode *node;
	struct ospf_interface *oi;
	struct route_table *nbrs;
	struct route_node *rn;
	struct ospf_neighbor *nbr;

	/* At first, flush self-originated LSAs from routing domain. */
	ospf_flush_self_originated_lsas_now(top);

	/* Revert all neighbor status to ExStart. */
	for (ALL_LIST_ELEMENTS_RO(top->oiflist, node, oi)) {
		if ((nbrs = oi->nbrs) == NULL)
			continue;

		for (rn = route_top(nbrs); rn; rn = route_next(rn)) {
			if ((nbr = rn->info) == NULL || nbr == oi->nbr_self)
				continue;

			if (nbr->state < NSM_ExStart)
				continue;

			if (IS_DEBUG_OSPF_EVENT)
				zlog_debug(
					"Renegotiate optional capabilities with neighbor(%s)",
					inet_ntoa(nbr->router_id));

			OSPF_NSM_EVENT_SCHEDULE(nbr, NSM_SeqNumberMismatch);
		}
	}

	return;
}


struct ospf_neighbor *ospf_nbr_lookup(struct ospf_interface *oi, struct ip *iph,
				      struct ospf_header *ospfh)
{
	struct in_addr srcaddr = iph->ip_src;

	if (oi->type == OSPF_IFTYPE_VIRTUALLINK
	    || oi->type == OSPF_IFTYPE_POINTOPOINT)
		return (ospf_nbr_lookup_by_routerid(oi->nbrs,
						    &ospfh->router_id));
	else
		return (ospf_nbr_lookup_by_addr(oi->nbrs, &srcaddr));
}

static struct ospf_neighbor *ospf_nbr_add(struct ospf_interface *oi,
					  struct ospf_header *ospfh,
					  struct prefix *p)
{
	struct ospf_neighbor *nbr;

	nbr = ospf_nbr_new(oi);
	nbr->state = NSM_Down;
	nbr->src = p->u.prefix4;
	memcpy(&nbr->address, p, sizeof(struct prefix));

	nbr->nbr_nbma = NULL;
	if (oi->type == OSPF_IFTYPE_NBMA) {
		struct ospf_nbr_nbma *nbr_nbma;
		struct listnode *node;

		for (ALL_LIST_ELEMENTS_RO(oi->nbr_nbma, node, nbr_nbma)) {
			if (IPV4_ADDR_SAME(&nbr_nbma->addr, &nbr->src)) {
				nbr_nbma->nbr = nbr;
				nbr->nbr_nbma = nbr_nbma;

				if (nbr_nbma->t_poll)
					OSPF_POLL_TIMER_OFF(nbr_nbma->t_poll);

				nbr->state_change = nbr_nbma->state_change + 1;
			}
		}
	}

	/* New nbr, save the crypto sequence number if necessary */
	if (ntohs(ospfh->auth_type) == OSPF_AUTH_CRYPTOGRAPHIC)
		nbr->crypt_seqnum = ospfh->u.crypt.crypt_seqnum;

	if (IS_DEBUG_OSPF_EVENT)
		zlog_debug("NSM[%s:%s]: start", IF_NAME(oi),
			   inet_ntoa(nbr->router_id));

	return nbr;
}

struct ospf_neighbor *ospf_nbr_get(struct ospf_interface *oi,
				   struct ospf_header *ospfh, struct ip *iph,
				   struct prefix *p)
{
	struct route_node *rn;
	struct prefix key;
	struct ospf_neighbor *nbr;

	key.family = AF_INET;
	key.prefixlen = IPV4_MAX_BITLEN;

	if (oi->type == OSPF_IFTYPE_VIRTUALLINK
	    || oi->type == OSPF_IFTYPE_POINTOPOINT)
		key.u.prefix4 = ospfh->router_id; /* index vlink and ptp nbrs by
						     router-id */
	else
		key.u.prefix4 = iph->ip_src;

	rn = route_node_get(oi->nbrs, &key);
	if (rn->info) {
		route_unlock_node(rn);
		nbr = rn->info;

		if (oi->type == OSPF_IFTYPE_NBMA && nbr->state == NSM_Attempt) {
			nbr->src = iph->ip_src;
			memcpy(&nbr->address, p, sizeof(struct prefix));
		}
	} else {
		rn->info = nbr = ospf_nbr_add(oi, ospfh, p);
	}

	nbr->router_id = ospfh->router_id;

	return nbr;
}
Commit	Line	Data
2d59836a	1	/*
	2	* OSPF Neighbor functions.
	3	* Copyright (C) 1999, 2000 Toshiaki Takada
	4	*
	5	* This file is part of GNU Zebra.
896014f4	6	*
2d59836a	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
2d59836a	20	*/
	21
	22	#include <zebra.h>
	23
	24	#include "linklist.h"
	25	#include "prefix.h"
	26	#include "memory.h"
	27	#include "command.h"
	28	#include "thread.h"
	29	#include "stream.h"
	30	#include "table.h"
	31	#include "log.h"
68fe91d6	32	#include "json.h"
2d59836a	33
	34	#include "ospfd/ospfd.h"
	35	#include "ospfd/ospf_interface.h"
	36	#include "ospfd/ospf_asbr.h"
	37	#include "ospfd/ospf_lsa.h"
	38	#include "ospfd/ospf_lsdb.h"
	39	#include "ospfd/ospf_neighbor.h"
	40	#include "ospfd/ospf_nsm.h"
	41	#include "ospfd/ospf_packet.h"
	42	#include "ospfd/ospf_network.h"
	43	#include "ospfd/ospf_flood.h"
	44	#include "ospfd/ospf_dump.h"
68fe91d6	45	#include "ospfd/ospf_bfd.h"
2d59836a	46
478aab98 PJ	47	/* Fill in the the 'key' as appropriate to retrieve the entry for nbr
478aab98 PJ	48	* from the ospf_interface's nbrs table. Indexed by interface address
0ab4a2d6 JT	49	* for all cases except Virtual-link and PointToPoint interfaces, where
0ab4a2d6 JT	50	* neighbours are indexed by router-ID instead.
478aab98	51	*/
d62a17ae	52	static void ospf_nbr_key(struct ospf_interface oi, struct ospf_neighbor nbr,
d62a17ae	53	struct prefix *key)
478aab98	54	{
d62a17ae	55	key->family = AF_INET;
	56	key->prefixlen = IPV4_MAX_BITLEN;
	57
	58	/* vlinks are indexed by router-id */
	59	if (oi->type == OSPF_IFTYPE_VIRTUALLINK
	60	\|\| oi->type == OSPF_IFTYPE_POINTOPOINT)
	61	key->u.prefix4 = nbr->router_id;
	62	else
	63	key->u.prefix4 = nbr->src;
	64	return;
478aab98 PJ	65	}
478aab98 PJ	66
d62a17ae	67	struct ospf_neighbor ospf_nbr_new(struct ospf_interface oi)
2d59836a	68	{
d62a17ae	69	struct ospf_neighbor *nbr;
2d59836a	70
d62a17ae	71	/* Allcate new neighbor. */
d62a17ae	72	nbr = XCALLOC(MTYPE_OSPF_NEIGHBOR, sizeof(struct ospf_neighbor));
2d59836a	73
d62a17ae	74	/* Relate neighbor to the interface. */
d62a17ae	75	nbr->oi = oi;
2d59836a	76
d62a17ae	77	/* Set default values. */
d62a17ae	78	nbr->state = NSM_Down;
2d59836a	79
d62a17ae	80	/* Set inheritance values. */
	81	nbr->v_inactivity = OSPF_IF_PARAM(oi, v_wait);
	82	nbr->v_db_desc = OSPF_IF_PARAM(oi, retransmit_interval);
	83	nbr->v_ls_req = OSPF_IF_PARAM(oi, retransmit_interval);
	84	nbr->v_ls_upd = OSPF_IF_PARAM(oi, retransmit_interval);
	85	nbr->priority = -1;
2d59836a	86
d62a17ae	87	/* DD flags. */
d62a17ae	88	nbr->dd_flags = OSPF_DD_FLAG_MS \| OSPF_DD_FLAG_M \| OSPF_DD_FLAG_I;
2d59836a	89
d62a17ae	90	/* Last received and sent DD. */
d62a17ae	91	nbr->last_send = NULL;
2d59836a	92
d62a17ae	93	nbr->nbr_nbma = NULL;
2d59836a	94
d62a17ae	95	ospf_lsdb_init(&nbr->db_sum);
	96	ospf_lsdb_init(&nbr->ls_rxmt);
	97	ospf_lsdb_init(&nbr->ls_req);
2d59836a	98
d62a17ae	99	nbr->crypt_seqnum = 0;
2d59836a	100
d62a17ae	101	ospf_bfd_info_nbr_create(oi, nbr);
d62a17ae	102	return nbr;
2d59836a	103	}
2d59836a	104
d62a17ae	105	void ospf_nbr_free(struct ospf_neighbor *nbr)
2d59836a	106	{
d62a17ae	107	/* Free DB summary list. */
	108	if (ospf_db_summary_count(nbr))
	109	ospf_db_summary_clear(nbr);
	110	/* ospf_db_summary_delete_all (nbr); */
	111
	112	/* Free ls request list. */
	113	if (ospf_ls_request_count(nbr))
	114	ospf_ls_request_delete_all(nbr);
	115
	116	/* Free retransmit list. */
	117	if (ospf_ls_retransmit_count(nbr))
	118	ospf_ls_retransmit_clear(nbr);
	119
	120	/* Cleanup LSDBs. */
	121	ospf_lsdb_cleanup(&nbr->db_sum);
	122	ospf_lsdb_cleanup(&nbr->ls_req);
	123	ospf_lsdb_cleanup(&nbr->ls_rxmt);
	124
	125	/* Clear last send packet. */
	126	if (nbr->last_send)
	127	ospf_packet_free(nbr->last_send);
	128
	129	if (nbr->nbr_nbma) {
	130	nbr->nbr_nbma->nbr = NULL;
	131	nbr->nbr_nbma = NULL;
	132	}
	133
	134	/* Cancel all timers. */
	135	OSPF_NSM_TIMER_OFF(nbr->t_inactivity);
	136	OSPF_NSM_TIMER_OFF(nbr->t_db_desc);
	137	OSPF_NSM_TIMER_OFF(nbr->t_ls_req);
	138	OSPF_NSM_TIMER_OFF(nbr->t_ls_upd);
	139
	140	/* Cancel all events. / / Thread lookup cost would be negligible. */
	141	thread_cancel_event(master, nbr);
	142
	143	ospf_bfd_info_free(&nbr->bfd_info);
45559c4d DS	144
45559c4d DS	145	nbr->oi = NULL;
d62a17ae	146	XFREE(MTYPE_OSPF_NEIGHBOR, nbr);
2d59836a	147	}
	148
	149	/* Delete specified OSPF neighbor from interface. */
d62a17ae	150	void ospf_nbr_delete(struct ospf_neighbor *nbr)
2d59836a	151	{
d62a17ae	152	struct ospf_interface *oi;
	153	struct route_node *rn;
	154	struct prefix p;
	155
	156	oi = nbr->oi;
	157
	158	/* get appropriate prefix 'key' */
	159	ospf_nbr_key(oi, nbr, &p);
	160
	161	rn = route_node_lookup(oi->nbrs, &p);
	162	if (rn) {
	163	/* If lookup for a NBR succeeds, the leaf route_node could
	164	* only exist because there is (or was) a nbr there.
	165	* If the nbr was deleted, the leaf route_node should have
	166	* lost its last refcount too, and be deleted.
	167	* Therefore a looked-up leaf route_node in nbrs table
	168	* should never have NULL info.
	169	*/
	170	assert(rn->info);
	171
	172	if (rn->info) {
	173	rn->info = NULL;
	174	route_unlock_node(rn);
	175	} else
	176	zlog_info("Can't find neighbor %s in the interface %s",
	177	inet_ntoa(nbr->src), IF_NAME(oi));
	178
	179	route_unlock_node(rn);
	180	} else {
	181	/*
	182	* This neighbor was not found, but before we move on and
	183	* free the neighbor structre, make sure that it was not
	184	* indexed incorrectly and ended up in the "worng" place
	185	*/
	186
	187	/* Reverse the lookup rules */
	188	if (oi->type == OSPF_IFTYPE_VIRTUALLINK
	189	\|\| oi->type == OSPF_IFTYPE_POINTOPOINT)
	190	p.u.prefix4 = nbr->src;
	191	else
	192	p.u.prefix4 = nbr->router_id;
	193
	194	rn = route_node_lookup(oi->nbrs, &p);
	195	if (rn) {
	196	/* We found the neighbor!
	197	* Now make sure it is not the exact same neighbor
	198	* structure that we are about to free
	199	*/
	200	if (nbr == rn->info) {
	201	/* Same neighbor, drop the reference to it */
	202	rn->info = NULL;
	203	route_unlock_node(rn);
	204	}
	205	route_unlock_node(rn);
	206	}
2d59836a	207	}
2d59836a	208
d62a17ae	209	/* Free ospf_neighbor structure. */
d62a17ae	210	ospf_nbr_free(nbr);
2d59836a	211	}
	212
	213	/* Check myself is in the neighbor list. */
d62a17ae	214	int ospf_nbr_bidirectional(struct in_addr router_id, struct in_addr neighbors,
d62a17ae	215	int size)
2d59836a	216	{
d62a17ae	217	int i;
d62a17ae	218	int max;
2d59836a	219
d62a17ae	220	max = size / sizeof(struct in_addr);
2d59836a	221
d62a17ae	222	for (i = 0; i < max; i++)
	223	if (IPV4_ADDR_SAME(router_id, &neighbors[i]))
	224	return 1;
2d59836a	225
d62a17ae	226	return 0;
2d59836a	227	}
2d59836a	228
cdd0c849	229	/* reset nbr_self */
d62a17ae	230	void ospf_nbr_self_reset(struct ospf_interface *oi, struct in_addr router_id)
cdd0c849	231	{
d62a17ae	232	if (oi->nbr_self)
d62a17ae	233	ospf_nbr_delete(oi->nbr_self);
ecea0cb0	234
d62a17ae	235	oi->nbr_self = ospf_nbr_new(oi);
d62a17ae	236	ospf_nbr_add_self(oi, router_id);
cdd0c849 PJ	237	}
cdd0c849 PJ	238
2d59836a	239	/* Add self to nbr list. */
d62a17ae	240	void ospf_nbr_add_self(struct ospf_interface *oi, struct in_addr router_id)
2d59836a	241	{
d62a17ae	242	struct prefix p;
	243	struct route_node *rn;
	244
	245	if (!oi->nbr_self)
	246	oi->nbr_self = ospf_nbr_new(oi);
	247
	248	/* Initial state */
	249	oi->nbr_self->address = *oi->address;
	250	oi->nbr_self->priority = OSPF_IF_PARAM(oi, priority);
	251	oi->nbr_self->router_id = router_id;
	252	oi->nbr_self->src = oi->address->u.prefix4;
	253	oi->nbr_self->state = NSM_TwoWay;
	254
	255	switch (oi->area->external_routing) {
	256	case OSPF_AREA_DEFAULT:
	257	SET_FLAG(oi->nbr_self->options, OSPF_OPTION_E);
	258	break;
	259	case OSPF_AREA_STUB:
	260	UNSET_FLAG(oi->nbr_self->options, OSPF_OPTION_E);
	261	break;
	262	case OSPF_AREA_NSSA:
	263	UNSET_FLAG(oi->nbr_self->options, OSPF_OPTION_E);
	264	SET_FLAG(oi->nbr_self->options, OSPF_OPTION_NP);
	265	break;
	266	}
	267
	268	/* Add nbr_self to nbrs table */
	269	ospf_nbr_key(oi, oi->nbr_self, &p);
	270
	271	rn = route_node_get(oi->nbrs, &p);
	272	if (rn->info) {
	273	/* There is already pseudo neighbor. */
ed59abd5 DS	274	if (IS_DEBUG_OSPF_EVENT)
ed59abd5 DS	275	zlog_debug(
ade6974d QY	276	"router_id %s already present in neighbor table. node refcount %u",
ade6974d QY	277	inet_ntoa(router_id), rn->lock);
d62a17ae	278	route_unlock_node(rn);
	279	} else
	280	rn->info = oi->nbr_self;
2d59836a	281	}
	282
	283	/* Get neighbor count by status.
	284	Specify status = 0, get all neighbor other than myself. */
d62a17ae	285	int ospf_nbr_count(struct ospf_interface *oi, int state)
2d59836a	286	{
d62a17ae	287	struct ospf_neighbor *nbr;
	288	struct route_node *rn;
	289	int count = 0;
	290
	291	for (rn = route_top(oi->nbrs); rn; rn = route_next(rn))
	292	if ((nbr = rn->info))
	293	if (!IPV4_ADDR_SAME(&nbr->router_id,
	294	&oi->ospf->router_id))
	295	if (state == 0 \|\| nbr->state == state)
	296	count++;
	297
	298	return count;
2d59836a	299	}
2d59836a	300
d62a17ae	301	int ospf_nbr_count_opaque_capable(struct ospf_interface *oi)
2d59836a	302	{
d62a17ae	303	struct ospf_neighbor *nbr;
	304	struct route_node *rn;
	305	int count = 0;
	306
	307	for (rn = route_top(oi->nbrs); rn; rn = route_next(rn))
	308	if ((nbr = rn->info))
	309	if (!IPV4_ADDR_SAME(&nbr->router_id,
	310	&oi->ospf->router_id))
	311	if (nbr->state == NSM_Full)
	312	if (CHECK_FLAG(nbr->options,
	313	OSPF_OPTION_O))
	314	count++;
	315
	316	return count;
2d59836a	317	}
2d59836a	318
d3f0d621	319	/* lookup nbr by address - use this only if you know you must
0ab4a2d6 JT	320	* otherwise use the ospf_nbr_lookup() wrapper, which deals
0ab4a2d6 JT	321	* with virtual link and PointToPoint neighbours
d3f0d621	322	*/
d62a17ae	323	struct ospf_neighbor ospf_nbr_lookup_by_addr(struct route_table nbrs,
	324	struct in_addr *addr)
	325	{
	326	struct prefix p;
	327	struct route_node *rn;
	328	struct ospf_neighbor *nbr;
	329
	330	p.family = AF_INET;
	331	p.prefixlen = IPV4_MAX_BITLEN;
	332	p.u.prefix4 = *addr;
	333
	334	rn = route_node_lookup(nbrs, &p);
	335	if (!rn)
	336	return NULL;
	337
	338	/* See comment in ospf_nbr_delete */
	339	assert(rn->info);
	340
	341	if (rn->info == NULL) {
	342	route_unlock_node(rn);
	343	return NULL;
	344	}
	345
	346	nbr = (struct ospf_neighbor *)rn->info;
	347	route_unlock_node(rn);
	348
	349	return nbr;
	350	}
	351
	352	struct ospf_neighbor ospf_nbr_lookup_by_routerid(struct route_table nbrs,
	353	struct in_addr *id)
2d59836a	354	{
d62a17ae	355	struct route_node *rn;
	356	struct ospf_neighbor *nbr;
	357
	358	for (rn = route_top(nbrs); rn; rn = route_next(rn))
	359	if ((nbr = rn->info) != NULL)
	360	if (IPV4_ADDR_SAME(&nbr->router_id, id)) {
	361	route_unlock_node(rn);
	362	return nbr;
	363	}
	364
	365	return NULL;
2d59836a	366	}
2d59836a	367
d62a17ae	368	void ospf_renegotiate_optional_capabilities(struct ospf *top)
2d59836a	369	{
d62a17ae	370	struct listnode *node;
	371	struct ospf_interface *oi;
	372	struct route_table *nbrs;
	373	struct route_node *rn;
	374	struct ospf_neighbor *nbr;
	375
	376	/* At first, flush self-originated LSAs from routing domain. */
	377	ospf_flush_self_originated_lsas_now(top);
	378
	379	/* Revert all neighbor status to ExStart. */
	380	for (ALL_LIST_ELEMENTS_RO(top->oiflist, node, oi)) {
	381	if ((nbrs = oi->nbrs) == NULL)
	382	continue;
	383
	384	for (rn = route_top(nbrs); rn; rn = route_next(rn)) {
	385	if ((nbr = rn->info) == NULL \|\| nbr == oi->nbr_self)
	386	continue;
	387
	388	if (nbr->state < NSM_ExStart)
	389	continue;
	390
	391	if (IS_DEBUG_OSPF_EVENT)
	392	zlog_debug(
	393	"Renegotiate optional capabilities with neighbor(%s)",
	394	inet_ntoa(nbr->router_id));
	395
	396	OSPF_NSM_EVENT_SCHEDULE(nbr, NSM_SeqNumberMismatch);
	397	}
2d59836a	398	}
2d59836a	399
d62a17ae	400	return;
2d59836a	401	}
2d59836a	402
d62a17ae	403
	404	struct ospf_neighbor ospf_nbr_lookup(struct ospf_interface oi, struct ip *iph,
	405	struct ospf_header *ospfh)
2d59836a	406	{
9e030550 MS	407	struct in_addr srcaddr = iph->ip_src;
9e030550 MS	408
d62a17ae	409	if (oi->type == OSPF_IFTYPE_VIRTUALLINK
	410	\|\| oi->type == OSPF_IFTYPE_POINTOPOINT)
	411	return (ospf_nbr_lookup_by_routerid(oi->nbrs,
	412	&ospfh->router_id));
	413	else
9e030550	414	return (ospf_nbr_lookup_by_addr(oi->nbrs, &srcaddr));
d62a17ae	415	}
2d59836a	416
d62a17ae	417	static struct ospf_neighbor ospf_nbr_add(struct ospf_interface oi,
	418	struct ospf_header *ospfh,
	419	struct prefix *p)
	420	{
	421	struct ospf_neighbor *nbr;
2d59836a	422
d62a17ae	423	nbr = ospf_nbr_new(oi);
	424	nbr->state = NSM_Down;
	425	nbr->src = p->u.prefix4;
	426	memcpy(&nbr->address, p, sizeof(struct prefix));
2d59836a	427
d62a17ae	428	nbr->nbr_nbma = NULL;
	429	if (oi->type == OSPF_IFTYPE_NBMA) {
	430	struct ospf_nbr_nbma *nbr_nbma;
	431	struct listnode *node;
2d59836a	432
d62a17ae	433	for (ALL_LIST_ELEMENTS_RO(oi->nbr_nbma, node, nbr_nbma)) {
	434	if (IPV4_ADDR_SAME(&nbr_nbma->addr, &nbr->src)) {
	435	nbr_nbma->nbr = nbr;
	436	nbr->nbr_nbma = nbr_nbma;
2d59836a	437
d62a17ae	438	if (nbr_nbma->t_poll)
d62a17ae	439	OSPF_POLL_TIMER_OFF(nbr_nbma->t_poll);
2d59836a	440
d62a17ae	441	nbr->state_change = nbr_nbma->state_change + 1;
	442	}
	443	}
	444	}
2d59836a	445
d62a17ae	446	/* New nbr, save the crypto sequence number if necessary */
	447	if (ntohs(ospfh->auth_type) == OSPF_AUTH_CRYPTOGRAPHIC)
	448	nbr->crypt_seqnum = ospfh->u.crypt.crypt_seqnum;
d3f0d621	449
d62a17ae	450	if (IS_DEBUG_OSPF_EVENT)
45559c4d	451	zlog_debug("NSM[%s:%s]: start", IF_NAME(oi),
d62a17ae	452	inet_ntoa(nbr->router_id));
d3f0d621	453
d62a17ae	454	return nbr;
d3f0d621	455	}
d3f0d621	456
d62a17ae	457	struct ospf_neighbor ospf_nbr_get(struct ospf_interface oi,
	458	struct ospf_header ospfh, struct ip iph,
	459	struct prefix *p)
d3f0d621	460	{
d62a17ae	461	struct route_node *rn;
	462	struct prefix key;
	463	struct ospf_neighbor *nbr;
	464
	465	key.family = AF_INET;
	466	key.prefixlen = IPV4_MAX_BITLEN;
	467
	468	if (oi->type == OSPF_IFTYPE_VIRTUALLINK
	469	\|\| oi->type == OSPF_IFTYPE_POINTOPOINT)
996c9314 LB	470	key.u.prefix4 = ospfh->router_id; /* index vlink and ptp nbrs by
996c9314 LB	471	router-id */
d62a17ae	472	else
	473	key.u.prefix4 = iph->ip_src;
	474
	475	rn = route_node_get(oi->nbrs, &key);
	476	if (rn->info) {
	477	route_unlock_node(rn);
	478	nbr = rn->info;
	479
	480	if (oi->type == OSPF_IFTYPE_NBMA && nbr->state == NSM_Attempt) {
	481	nbr->src = iph->ip_src;
	482	memcpy(&nbr->address, p, sizeof(struct prefix));
	483	}
	484	} else {
	485	rn->info = nbr = ospf_nbr_add(oi, ospfh, p);
	486	}
d3f0d621	487
d62a17ae	488	nbr->router_id = ospfh->router_id;
	489
	490	return nbr;
d3f0d621	491	}