2 * OSPF version 2 Neighbor State Machine
3 * From RFC2328 [OSPF Version 2]
4 * Copyright (C) 1999, 2000 Toshiaki Takada
6 * This file is part of GNU Zebra.
8 * GNU Zebra is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2, or (at your option) any
13 * GNU Zebra is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; see the file COPYING; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
37 #include "ospfd/ospfd.h"
38 #include "ospfd/ospf_interface.h"
39 #include "ospfd/ospf_ism.h"
40 #include "ospfd/ospf_asbr.h"
41 #include "ospfd/ospf_lsa.h"
42 #include "ospfd/ospf_lsdb.h"
43 #include "ospfd/ospf_neighbor.h"
44 #include "ospfd/ospf_nsm.h"
45 #include "ospfd/ospf_network.h"
46 #include "ospfd/ospf_packet.h"
47 #include "ospfd/ospf_dump.h"
48 #include "ospfd/ospf_flood.h"
49 #include "ospfd/ospf_abr.h"
50 #include "ospfd/ospf_bfd.h"
51 #include "ospfd/ospf_errors.h"
53 DEFINE_HOOK(ospf_nsm_change
,
54 (struct ospf_neighbor
* on
, int state
, int oldstate
),
55 (on
, state
, oldstate
))
57 static void nsm_clear_adj(struct ospf_neighbor
*);
59 /* OSPF NSM Timer functions. */
60 static int ospf_inactivity_timer(struct thread
*thread
)
62 struct ospf_neighbor
*nbr
;
64 nbr
= THREAD_ARG(thread
);
65 nbr
->t_inactivity
= NULL
;
67 if (IS_DEBUG_OSPF(nsm
, NSM_TIMERS
))
68 zlog_debug("NSM[%s:%s:%s]: Timer (Inactivity timer expire)",
69 IF_NAME(nbr
->oi
), inet_ntoa(nbr
->router_id
),
70 ospf_get_name(nbr
->oi
->ospf
));
72 OSPF_NSM_EVENT_SCHEDULE(nbr
, NSM_InactivityTimer
);
77 static int ospf_db_desc_timer(struct thread
*thread
)
79 struct ospf_neighbor
*nbr
;
81 nbr
= THREAD_ARG(thread
);
82 nbr
->t_db_desc
= NULL
;
84 if (IS_DEBUG_OSPF(nsm
, NSM_TIMERS
))
85 zlog_debug("NSM[%s:%s:%s]: Timer (DD Retransmit timer expire)",
86 IF_NAME(nbr
->oi
), inet_ntoa(nbr
->src
),
87 ospf_get_name(nbr
->oi
->ospf
));
89 /* resent last send DD packet. */
90 assert(nbr
->last_send
);
91 ospf_db_desc_resend(nbr
);
93 /* DD Retransmit timer set. */
94 OSPF_NSM_TIMER_ON(nbr
->t_db_desc
, ospf_db_desc_timer
, nbr
->v_db_desc
);
99 /* Hook function called after ospf NSM event is occurred.
101 * Set/clear any timers whose condition is implicit to the neighbour
102 * state. There may be other timers which are set/unset according to other
105 * We rely on this function to properly clear timers in lower states,
106 * particularly before deleting a neighbour.
108 static void nsm_timer_set(struct ospf_neighbor
*nbr
)
110 switch (nbr
->state
) {
113 OSPF_NSM_TIMER_OFF(nbr
->t_inactivity
);
114 OSPF_NSM_TIMER_OFF(nbr
->t_hello_reply
);
119 OSPF_NSM_TIMER_OFF(nbr
->t_db_desc
);
120 OSPF_NSM_TIMER_OFF(nbr
->t_ls_upd
);
121 OSPF_NSM_TIMER_OFF(nbr
->t_ls_req
);
124 OSPF_NSM_TIMER_ON(nbr
->t_db_desc
, ospf_db_desc_timer
,
126 OSPF_NSM_TIMER_OFF(nbr
->t_ls_upd
);
127 OSPF_NSM_TIMER_OFF(nbr
->t_ls_req
);
130 OSPF_NSM_TIMER_ON(nbr
->t_ls_upd
, ospf_ls_upd_timer
,
132 if (!IS_SET_DD_MS(nbr
->dd_flags
))
133 OSPF_NSM_TIMER_OFF(nbr
->t_db_desc
);
138 OSPF_NSM_TIMER_OFF(nbr
->t_db_desc
);
143 /* 10.4 of RFC2328, indicate whether an adjacency is appropriate with
144 * the given neighbour
146 static int nsm_should_adj(struct ospf_neighbor
*nbr
)
148 struct ospf_interface
*oi
= nbr
->oi
;
150 /* These network types must always form adjacencies. */
151 if (oi
->type
== OSPF_IFTYPE_POINTOPOINT
152 || oi
->type
== OSPF_IFTYPE_POINTOMULTIPOINT
153 || oi
->type
== OSPF_IFTYPE_VIRTUALLINK
154 /* Router itself is the DRouter or the BDRouter. */
155 || IPV4_ADDR_SAME(&oi
->address
->u
.prefix4
, &DR(oi
))
156 || IPV4_ADDR_SAME(&oi
->address
->u
.prefix4
, &BDR(oi
))
157 /* Neighboring Router is the DRouter or the BDRouter. */
158 || IPV4_ADDR_SAME(&nbr
->address
.u
.prefix4
, &DR(oi
))
159 || IPV4_ADDR_SAME(&nbr
->address
.u
.prefix4
, &BDR(oi
)))
165 /* OSPF NSM functions. */
166 static int nsm_packet_received(struct ospf_neighbor
*nbr
)
168 /* Start or Restart Inactivity Timer. */
169 OSPF_NSM_TIMER_OFF(nbr
->t_inactivity
);
171 OSPF_NSM_TIMER_ON(nbr
->t_inactivity
, ospf_inactivity_timer
,
174 if (nbr
->oi
->type
== OSPF_IFTYPE_NBMA
&& nbr
->nbr_nbma
)
175 OSPF_POLL_TIMER_OFF(nbr
->nbr_nbma
->t_poll
);
177 /* Send proactive ARP requests */
178 if (nbr
->state
< NSM_Exchange
)
179 ospf_proactively_arp(nbr
);
184 static int nsm_start(struct ospf_neighbor
*nbr
)
187 OSPF_POLL_TIMER_OFF(nbr
->nbr_nbma
->t_poll
);
189 OSPF_NSM_TIMER_OFF(nbr
->t_inactivity
);
191 OSPF_NSM_TIMER_ON(nbr
->t_inactivity
, ospf_inactivity_timer
,
194 /* Send proactive ARP requests */
195 ospf_proactively_arp(nbr
);
200 static int nsm_twoway_received(struct ospf_neighbor
*nbr
)
202 int adj
= nsm_should_adj(nbr
);
204 /* Send proactive ARP requests */
206 ospf_proactively_arp(nbr
);
208 return (adj
? NSM_ExStart
: NSM_TwoWay
);
211 int ospf_db_summary_count(struct ospf_neighbor
*nbr
)
213 return ospf_lsdb_count_all(&nbr
->db_sum
);
216 int ospf_db_summary_isempty(struct ospf_neighbor
*nbr
)
218 return ospf_lsdb_isempty(&nbr
->db_sum
);
221 static int ospf_db_summary_add(struct ospf_neighbor
*nbr
, struct ospf_lsa
*lsa
)
223 switch (lsa
->data
->type
) {
224 case OSPF_OPAQUE_LINK_LSA
:
225 /* Exclude type-9 LSAs that does not have the same "oi" with
227 if (ospf_if_exists(lsa
->oi
) != nbr
->oi
)
230 case OSPF_OPAQUE_AREA_LSA
:
232 * It is assured by the caller function "nsm_negotiation_done()"
233 * that every given LSA belongs to the same area with "nbr".
236 case OSPF_OPAQUE_AS_LSA
:
241 /* Stay away from any Local Translated Type-7 LSAs */
242 if (CHECK_FLAG(lsa
->flags
, OSPF_LSA_LOCAL_XLT
))
245 if (IS_LSA_MAXAGE(lsa
))
246 ospf_ls_retransmit_add(nbr
, lsa
);
248 ospf_lsdb_add(&nbr
->db_sum
, lsa
);
253 void ospf_db_summary_clear(struct ospf_neighbor
*nbr
)
255 struct ospf_lsdb
*lsdb
;
259 for (i
= OSPF_MIN_LSA
; i
< OSPF_MAX_LSA
; i
++) {
260 struct route_table
*table
= lsdb
->type
[i
].db
;
261 struct route_node
*rn
;
263 for (rn
= route_top(table
); rn
; rn
= route_next(rn
))
265 ospf_lsdb_delete(&nbr
->db_sum
, rn
->info
);
270 /* The area link state database consists of the router-LSAs,
271 network-LSAs and summary-LSAs contained in the area structure,
272 along with the AS-external-LSAs contained in the global structure.
273 AS-external-LSAs are omitted from a virtual neighbor's Database
274 summary list. AS-external-LSAs are omitted from the Database
275 summary list if the area has been configured as a stub. */
276 static int nsm_negotiation_done(struct ospf_neighbor
*nbr
)
278 struct ospf_area
*area
= nbr
->oi
->area
;
279 struct ospf_lsa
*lsa
;
280 struct route_node
*rn
;
282 /* Send proactive ARP requests */
283 ospf_proactively_arp(nbr
);
285 LSDB_LOOP (ROUTER_LSDB(area
), rn
, lsa
)
286 ospf_db_summary_add(nbr
, lsa
);
287 LSDB_LOOP (NETWORK_LSDB(area
), rn
, lsa
)
288 ospf_db_summary_add(nbr
, lsa
);
289 LSDB_LOOP (SUMMARY_LSDB(area
), rn
, lsa
)
290 ospf_db_summary_add(nbr
, lsa
);
291 LSDB_LOOP (ASBR_SUMMARY_LSDB(area
), rn
, lsa
)
292 ospf_db_summary_add(nbr
, lsa
);
294 /* Process only if the neighbor is opaque capable. */
295 if (CHECK_FLAG(nbr
->options
, OSPF_OPTION_O
)) {
296 LSDB_LOOP (OPAQUE_LINK_LSDB(area
), rn
, lsa
)
297 ospf_db_summary_add(nbr
, lsa
);
298 LSDB_LOOP (OPAQUE_AREA_LSDB(area
), rn
, lsa
)
299 ospf_db_summary_add(nbr
, lsa
);
302 if (CHECK_FLAG(nbr
->options
, OSPF_OPTION_NP
)) {
303 LSDB_LOOP (NSSA_LSDB(area
), rn
, lsa
)
304 ospf_db_summary_add(nbr
, lsa
);
307 if (nbr
->oi
->type
!= OSPF_IFTYPE_VIRTUALLINK
308 && area
->external_routing
== OSPF_AREA_DEFAULT
)
309 LSDB_LOOP (EXTERNAL_LSDB(nbr
->oi
->ospf
), rn
, lsa
)
310 ospf_db_summary_add(nbr
, lsa
);
312 if (CHECK_FLAG(nbr
->options
, OSPF_OPTION_O
)
313 && (nbr
->oi
->type
!= OSPF_IFTYPE_VIRTUALLINK
314 && area
->external_routing
== OSPF_AREA_DEFAULT
))
315 LSDB_LOOP (OPAQUE_AS_LSDB(nbr
->oi
->ospf
), rn
, lsa
)
316 ospf_db_summary_add(nbr
, lsa
);
321 static int nsm_exchange_done(struct ospf_neighbor
*nbr
)
323 if (ospf_ls_request_isempty(nbr
))
326 /* Send Link State Request. */
327 if (nbr
->t_ls_req
== NULL
)
328 ospf_ls_req_send(nbr
);
333 static int nsm_adj_ok(struct ospf_neighbor
*nbr
)
335 int next_state
= nbr
->state
;
336 int adj
= nsm_should_adj(nbr
);
338 if (nbr
->state
== NSM_TwoWay
&& adj
== 1) {
339 next_state
= NSM_ExStart
;
341 /* Send proactive ARP requests */
342 ospf_proactively_arp(nbr
);
343 } else if (nbr
->state
>= NSM_ExStart
&& adj
== 0)
344 next_state
= NSM_TwoWay
;
349 /* Clear adjacency related state for a neighbour, intended where nbr
350 * transitions from > ExStart (i.e. a Full or forming adjacency)
353 static void nsm_clear_adj(struct ospf_neighbor
*nbr
)
355 /* Clear Database Summary list. */
356 if (!ospf_db_summary_isempty(nbr
))
357 ospf_db_summary_clear(nbr
);
359 /* Clear Link State Request list. */
360 if (!ospf_ls_request_isempty(nbr
))
361 ospf_ls_request_delete_all(nbr
);
363 /* Clear Link State Retransmission list. */
364 if (!ospf_ls_retransmit_isempty(nbr
))
365 ospf_ls_retransmit_clear(nbr
);
367 if (CHECK_FLAG(nbr
->options
, OSPF_OPTION_O
))
368 UNSET_FLAG(nbr
->options
, OSPF_OPTION_O
);
371 static int nsm_kill_nbr(struct ospf_neighbor
*nbr
)
373 /* killing nbr_self is invalid */
374 if (nbr
== nbr
->oi
->nbr_self
) {
375 assert(nbr
!= nbr
->oi
->nbr_self
);
379 if (nbr
->oi
->type
== OSPF_IFTYPE_NBMA
&& nbr
->nbr_nbma
!= NULL
) {
380 struct ospf_nbr_nbma
*nbr_nbma
= nbr
->nbr_nbma
;
382 nbr_nbma
->nbr
= NULL
;
383 nbr_nbma
->state_change
= nbr
->state_change
;
385 nbr
->nbr_nbma
= NULL
;
387 OSPF_POLL_TIMER_ON(nbr_nbma
->t_poll
, ospf_poll_timer
,
390 if (IS_DEBUG_OSPF(nsm
, NSM_EVENTS
))
392 "NSM[%s:%s:%s]: Down (PollIntervalTimer scheduled)",
394 inet_ntoa(nbr
->address
.u
.prefix4
),
395 ospf_get_name(nbr
->oi
->ospf
));
401 /* Neighbor State Machine */
403 int (*func
)(struct ospf_neighbor
*);
405 } NSM
[OSPF_NSM_STATE_MAX
][OSPF_NSM_EVENT_MAX
] = {
407 /* DependUpon: dummy state. */
408 {NULL
, NSM_DependUpon
}, /* NoEvent */
409 {NULL
, NSM_DependUpon
}, /* PacketReceived */
410 {NULL
, NSM_DependUpon
}, /* Start */
411 {NULL
, NSM_DependUpon
}, /* 2-WayReceived */
412 {NULL
, NSM_DependUpon
}, /* NegotiationDone */
413 {NULL
, NSM_DependUpon
}, /* ExchangeDone */
414 {NULL
, NSM_DependUpon
}, /* BadLSReq */
415 {NULL
, NSM_DependUpon
}, /* LoadingDone */
416 {NULL
, NSM_DependUpon
}, /* AdjOK? */
417 {NULL
, NSM_DependUpon
}, /* SeqNumberMismatch */
418 {NULL
, NSM_DependUpon
}, /* 1-WayReceived */
419 {NULL
, NSM_DependUpon
}, /* KillNbr */
420 {NULL
, NSM_DependUpon
}, /* InactivityTimer */
421 {NULL
, NSM_DependUpon
}, /* LLDown */
424 /* Deleted: dummy state. */
425 {NULL
, NSM_Deleted
}, /* NoEvent */
426 {NULL
, NSM_Deleted
}, /* PacketReceived */
427 {NULL
, NSM_Deleted
}, /* Start */
428 {NULL
, NSM_Deleted
}, /* 2-WayReceived */
429 {NULL
, NSM_Deleted
}, /* NegotiationDone */
430 {NULL
, NSM_Deleted
}, /* ExchangeDone */
431 {NULL
, NSM_Deleted
}, /* BadLSReq */
432 {NULL
, NSM_Deleted
}, /* LoadingDone */
433 {NULL
, NSM_Deleted
}, /* AdjOK? */
434 {NULL
, NSM_Deleted
}, /* SeqNumberMismatch */
435 {NULL
, NSM_Deleted
}, /* 1-WayReceived */
436 {NULL
, NSM_Deleted
}, /* KillNbr */
437 {NULL
, NSM_Deleted
}, /* InactivityTimer */
438 {NULL
, NSM_Deleted
}, /* LLDown */
442 {NULL
, NSM_DependUpon
}, /* NoEvent */
443 {nsm_packet_received
, NSM_Init
}, /* PacketReceived */
444 {nsm_start
, NSM_Attempt
}, /* Start */
445 {NULL
, NSM_Down
}, /* 2-WayReceived */
446 {NULL
, NSM_Down
}, /* NegotiationDone */
447 {NULL
, NSM_Down
}, /* ExchangeDone */
448 {NULL
, NSM_Down
}, /* BadLSReq */
449 {NULL
, NSM_Down
}, /* LoadingDone */
450 {NULL
, NSM_Down
}, /* AdjOK? */
451 {NULL
, NSM_Down
}, /* SeqNumberMismatch */
452 {NULL
, NSM_Down
}, /* 1-WayReceived */
453 {nsm_kill_nbr
, NSM_Deleted
}, /* KillNbr */
454 {nsm_kill_nbr
, NSM_Deleted
}, /* InactivityTimer */
455 {nsm_kill_nbr
, NSM_Deleted
}, /* LLDown */
459 {NULL
, NSM_DependUpon
}, /* NoEvent */
460 {nsm_packet_received
, NSM_Init
}, /* PacketReceived */
461 {NULL
, NSM_Attempt
}, /* Start */
462 {NULL
, NSM_Attempt
}, /* 2-WayReceived */
463 {NULL
, NSM_Attempt
}, /* NegotiationDone */
464 {NULL
, NSM_Attempt
}, /* ExchangeDone */
465 {NULL
, NSM_Attempt
}, /* BadLSReq */
466 {NULL
, NSM_Attempt
}, /* LoadingDone */
467 {NULL
, NSM_Attempt
}, /* AdjOK? */
468 {NULL
, NSM_Attempt
}, /* SeqNumberMismatch */
469 {NULL
, NSM_Attempt
}, /* 1-WayReceived */
470 {nsm_kill_nbr
, NSM_Deleted
}, /* KillNbr */
471 {nsm_kill_nbr
, NSM_Deleted
}, /* InactivityTimer */
472 {nsm_kill_nbr
, NSM_Deleted
}, /* LLDown */
476 {NULL
, NSM_DependUpon
}, /* NoEvent */
477 {nsm_packet_received
, NSM_Init
}, /* PacketReceived */
478 {NULL
, NSM_Init
}, /* Start */
479 {nsm_twoway_received
, NSM_DependUpon
}, /* 2-WayReceived */
480 {NULL
, NSM_Init
}, /* NegotiationDone */
481 {NULL
, NSM_Init
}, /* ExchangeDone */
482 {NULL
, NSM_Init
}, /* BadLSReq */
483 {NULL
, NSM_Init
}, /* LoadingDone */
484 {NULL
, NSM_Init
}, /* AdjOK? */
485 {NULL
, NSM_Init
}, /* SeqNumberMismatch */
486 {NULL
, NSM_Init
}, /* 1-WayReceived */
487 {nsm_kill_nbr
, NSM_Deleted
}, /* KillNbr */
488 {nsm_kill_nbr
, NSM_Deleted
}, /* InactivityTimer */
489 {nsm_kill_nbr
, NSM_Deleted
}, /* LLDown */
493 {NULL
, NSM_DependUpon
}, /* NoEvent */
494 {nsm_packet_received
, NSM_TwoWay
}, /* HelloReceived */
495 {NULL
, NSM_TwoWay
}, /* Start */
496 {NULL
, NSM_TwoWay
}, /* 2-WayReceived */
497 {NULL
, NSM_TwoWay
}, /* NegotiationDone */
498 {NULL
, NSM_TwoWay
}, /* ExchangeDone */
499 {NULL
, NSM_TwoWay
}, /* BadLSReq */
500 {NULL
, NSM_TwoWay
}, /* LoadingDone */
501 {nsm_adj_ok
, NSM_DependUpon
}, /* AdjOK? */
502 {NULL
, NSM_TwoWay
}, /* SeqNumberMismatch */
503 {NULL
, NSM_Init
}, /* 1-WayReceived */
504 {nsm_kill_nbr
, NSM_Deleted
}, /* KillNbr */
505 {nsm_kill_nbr
, NSM_Deleted
}, /* InactivityTimer */
506 {nsm_kill_nbr
, NSM_Deleted
}, /* LLDown */
510 {NULL
, NSM_DependUpon
}, /* NoEvent */
511 {nsm_packet_received
, NSM_ExStart
}, /* PacaketReceived */
512 {NULL
, NSM_ExStart
}, /* Start */
513 {NULL
, NSM_ExStart
}, /* 2-WayReceived */
514 {nsm_negotiation_done
, NSM_Exchange
}, /* NegotiationDone */
515 {NULL
, NSM_ExStart
}, /* ExchangeDone */
516 {NULL
, NSM_ExStart
}, /* BadLSReq */
517 {NULL
, NSM_ExStart
}, /* LoadingDone */
518 {nsm_adj_ok
, NSM_DependUpon
}, /* AdjOK? */
519 {NULL
, NSM_ExStart
}, /* SeqNumberMismatch */
520 {NULL
, NSM_Init
}, /* 1-WayReceived */
521 {nsm_kill_nbr
, NSM_Deleted
}, /* KillNbr */
522 {nsm_kill_nbr
, NSM_Deleted
}, /* InactivityTimer */
523 {nsm_kill_nbr
, NSM_Deleted
}, /* LLDown */
527 {NULL
, NSM_DependUpon
}, /* NoEvent */
528 {nsm_packet_received
, NSM_Exchange
}, /* PacketReceived */
529 {NULL
, NSM_Exchange
}, /* Start */
530 {NULL
, NSM_Exchange
}, /* 2-WayReceived */
531 {NULL
, NSM_Exchange
}, /* NegotiationDone */
532 {nsm_exchange_done
, NSM_DependUpon
}, /* ExchangeDone */
533 {NULL
, NSM_ExStart
}, /* BadLSReq */
534 {NULL
, NSM_Exchange
}, /* LoadingDone */
535 {nsm_adj_ok
, NSM_DependUpon
}, /* AdjOK? */
536 {NULL
, NSM_ExStart
}, /* SeqNumberMismatch */
537 {NULL
, NSM_Init
}, /* 1-WayReceived */
538 {nsm_kill_nbr
, NSM_Deleted
}, /* KillNbr */
539 {nsm_kill_nbr
, NSM_Deleted
}, /* InactivityTimer */
540 {nsm_kill_nbr
, NSM_Deleted
}, /* LLDown */
544 {NULL
, NSM_DependUpon
}, /* NoEvent */
545 {nsm_packet_received
, NSM_Loading
}, /* PacketReceived */
546 {NULL
, NSM_Loading
}, /* Start */
547 {NULL
, NSM_Loading
}, /* 2-WayReceived */
548 {NULL
, NSM_Loading
}, /* NegotiationDone */
549 {NULL
, NSM_Loading
}, /* ExchangeDone */
550 {NULL
, NSM_ExStart
}, /* BadLSReq */
551 {NULL
, NSM_Full
}, /* LoadingDone */
552 {nsm_adj_ok
, NSM_DependUpon
}, /* AdjOK? */
553 {NULL
, NSM_ExStart
}, /* SeqNumberMismatch */
554 {NULL
, NSM_Init
}, /* 1-WayReceived */
555 {nsm_kill_nbr
, NSM_Deleted
}, /* KillNbr */
556 {nsm_kill_nbr
, NSM_Deleted
}, /* InactivityTimer */
557 {nsm_kill_nbr
, NSM_Deleted
}, /* LLDown */
561 {NULL
, NSM_DependUpon
}, /* NoEvent */
562 {nsm_packet_received
, NSM_Full
}, /* PacketReceived */
563 {NULL
, NSM_Full
}, /* Start */
564 {NULL
, NSM_Full
}, /* 2-WayReceived */
565 {NULL
, NSM_Full
}, /* NegotiationDone */
566 {NULL
, NSM_Full
}, /* ExchangeDone */
567 {NULL
, NSM_ExStart
}, /* BadLSReq */
568 {NULL
, NSM_Full
}, /* LoadingDone */
569 {nsm_adj_ok
, NSM_DependUpon
}, /* AdjOK? */
570 {NULL
, NSM_ExStart
}, /* SeqNumberMismatch */
571 {NULL
, NSM_Init
}, /* 1-WayReceived */
572 {nsm_kill_nbr
, NSM_Deleted
}, /* KillNbr */
573 {nsm_kill_nbr
, NSM_Deleted
}, /* InactivityTimer */
574 {nsm_kill_nbr
, NSM_Deleted
}, /* LLDown */
578 static const char *ospf_nsm_event_str
[] = {
579 "NoEvent", "PacketReceived", "Start",
580 "2-WayReceived", "NegotiationDone", "ExchangeDone",
581 "BadLSReq", "LoadingDone", "AdjOK?",
582 "SeqNumberMismatch", "1-WayReceived", "KillNbr",
583 "InactivityTimer", "LLDown",
586 static void nsm_notice_state_change(struct ospf_neighbor
*nbr
, int next_state
,
589 /* Logging change of status. */
590 if (IS_DEBUG_OSPF(nsm
, NSM_STATUS
))
591 zlog_debug("NSM[%s:%s:%s]: State change %s -> %s (%s)",
592 IF_NAME(nbr
->oi
), inet_ntoa(nbr
->router_id
),
593 ospf_get_name(nbr
->oi
->ospf
),
594 lookup_msg(ospf_nsm_state_msg
, nbr
->state
, NULL
),
595 lookup_msg(ospf_nsm_state_msg
, next_state
, NULL
),
596 ospf_nsm_event_str
[event
]);
598 /* Optionally notify about adjacency changes */
599 if (CHECK_FLAG(nbr
->oi
->ospf
->config
, OSPF_LOG_ADJACENCY_CHANGES
)
600 && (CHECK_FLAG(nbr
->oi
->ospf
->config
, OSPF_LOG_ADJACENCY_DETAIL
)
601 || (next_state
== NSM_Full
) || (next_state
< nbr
->state
)))
602 zlog_notice("AdjChg: Nbr %s(%s) on %s: %s -> %s (%s)",
603 inet_ntoa(nbr
->router_id
),
604 ospf_get_name(nbr
->oi
->ospf
), IF_NAME(nbr
->oi
),
605 lookup_msg(ospf_nsm_state_msg
, nbr
->state
, NULL
),
606 lookup_msg(ospf_nsm_state_msg
, next_state
, NULL
),
607 ospf_nsm_event_str
[event
]);
610 if (next_state
> nbr
->state
)
611 monotime(&nbr
->ts_last_progress
);
612 else /* regression in NSM */
614 monotime(&nbr
->ts_last_regress
);
615 nbr
->last_regress_str
= ospf_nsm_event_str
[event
];
619 static void nsm_change_state(struct ospf_neighbor
*nbr
, int state
)
621 struct ospf_interface
*oi
= nbr
->oi
;
622 struct ospf_area
*vl_area
= NULL
;
625 /* Preserve old status. */
626 old_state
= nbr
->state
;
628 /* Change to new status. */
634 if (oi
->type
== OSPF_IFTYPE_VIRTUALLINK
)
635 vl_area
= ospf_area_lookup_by_area_id(oi
->ospf
,
636 oi
->vl_data
->vl_area_id
);
638 /* Generate NeighborChange ISM event.
640 * In response to NeighborChange, DR election is rerun. The information
641 * from the election process is required by the router-lsa construction.
643 * Therefore, trigger the event prior to refreshing the LSAs. */
648 if ((old_state
< NSM_TwoWay
&& state
>= NSM_TwoWay
)
649 || (old_state
>= NSM_TwoWay
&& state
< NSM_TwoWay
))
650 OSPF_ISM_EVENT_EXECUTE(oi
, ISM_NeighborChange
);
653 /* ISM_PointToPoint -> ISM_Down, ISM_Loopback -> ISM_Down, etc.
658 /* One of the neighboring routers changes to/from the FULL state. */
659 if ((old_state
!= NSM_Full
&& state
== NSM_Full
)
660 || (old_state
== NSM_Full
&& state
!= NSM_Full
)) {
661 if (state
== NSM_Full
) {
663 oi
->area
->full_nbrs
++;
665 ospf_check_abr_status(oi
->ospf
);
667 if (oi
->type
== OSPF_IFTYPE_VIRTUALLINK
&& vl_area
)
668 if (++vl_area
->full_vls
== 1)
669 ospf_schedule_abr_task(oi
->ospf
);
672 oi
->area
->full_nbrs
--;
674 ospf_check_abr_status(oi
->ospf
);
676 if (oi
->type
== OSPF_IFTYPE_VIRTUALLINK
&& vl_area
)
677 if (vl_area
->full_vls
> 0)
678 if (--vl_area
->full_vls
== 0)
679 ospf_schedule_abr_task(
683 if (CHECK_FLAG(oi
->ospf
->config
, OSPF_LOG_ADJACENCY_DETAIL
))
685 "%s:[%s:%s], %s -> %s): "
686 "scheduling new router-LSA origination",
687 __PRETTY_FUNCTION__
, inet_ntoa(nbr
->router_id
),
688 ospf_get_name(oi
->ospf
),
689 lookup_msg(ospf_nsm_state_msg
, old_state
, NULL
),
690 lookup_msg(ospf_nsm_state_msg
, state
, NULL
));
692 ospf_router_lsa_update_area(oi
->area
);
694 if (oi
->type
== OSPF_IFTYPE_VIRTUALLINK
) {
695 vl_area
= ospf_area_lookup_by_area_id(
696 oi
->ospf
, oi
->vl_data
->vl_area_id
);
699 ospf_router_lsa_update_area(vl_area
);
702 /* Originate network-LSA. */
703 if (oi
->state
== ISM_DR
) {
704 if (oi
->network_lsa_self
&& oi
->full_nbrs
== 0) {
705 ospf_lsa_flush_area(oi
->network_lsa_self
,
707 ospf_lsa_unlock(&oi
->network_lsa_self
);
708 oi
->network_lsa_self
= NULL
;
710 ospf_network_lsa_update(oi
);
714 ospf_opaque_nsm_change(nbr
, old_state
);
716 /* State changes from > ExStart to <= ExStart should clear any Exchange
717 * or Full/LSA Update related lists and state.
718 * Potential causal events: BadLSReq, SeqNumberMismatch, AdjOK?
720 if ((old_state
> NSM_ExStart
) && (state
<= NSM_ExStart
))
723 /* Start DD exchange protocol */
724 if (state
== NSM_ExStart
) {
725 if (nbr
->dd_seqnum
== 0)
726 nbr
->dd_seqnum
= (uint32_t)random();
731 OSPF_DD_FLAG_I
| OSPF_DD_FLAG_M
| OSPF_DD_FLAG_MS
;
732 if (CHECK_FLAG(oi
->ospf
->config
, OSPF_LOG_ADJACENCY_DETAIL
))
734 "%s: Intializing [DD]: %s with seqnum:%x , flags:%x",
735 (oi
->ospf
->name
) ? oi
->ospf
->name
737 inet_ntoa(nbr
->router_id
), nbr
->dd_seqnum
,
739 ospf_db_desc_send(nbr
);
742 /* clear cryptographic sequence number */
743 if (state
== NSM_Down
)
744 nbr
->crypt_seqnum
= 0;
746 ospf_bfd_trigger_event(nbr
, old_state
, state
);
748 /* Preserve old status? */
751 /* Execute NSM event process. */
752 int ospf_nsm_event(struct thread
*thread
)
756 struct ospf_neighbor
*nbr
;
758 nbr
= THREAD_ARG(thread
);
759 event
= THREAD_VAL(thread
);
761 if (IS_DEBUG_OSPF(nsm
, NSM_EVENTS
))
762 zlog_debug("NSM[%s:%s:%s]: %s (%s)", IF_NAME(nbr
->oi
),
763 inet_ntoa(nbr
->router_id
),
764 ospf_get_name(nbr
->oi
->ospf
),
765 lookup_msg(ospf_nsm_state_msg
, nbr
->state
, NULL
),
766 ospf_nsm_event_str
[event
]);
768 next_state
= NSM
[nbr
->state
][event
].next_state
;
771 if (NSM
[nbr
->state
][event
].func
!= NULL
) {
772 int func_state
= (*(NSM
[nbr
->state
][event
].func
))(nbr
);
774 if (NSM
[nbr
->state
][event
].next_state
== NSM_DependUpon
)
775 next_state
= func_state
;
776 else if (func_state
) {
777 /* There's a mismatch between the FSM tables and what an
779 * action/state-change function returned. State changes
781 * do not have conditional/DependUpon next-states should
783 * try set next_state.
786 EC_OSPF_FSM_INVALID_STATE
,
787 "NSM[%s:%s:%s]: %s (%s): "
788 "Warning: action tried to change next_state to %s",
789 IF_NAME(nbr
->oi
), inet_ntoa(nbr
->router_id
),
790 ospf_get_name(nbr
->oi
->ospf
),
791 lookup_msg(ospf_nsm_state_msg
, nbr
->state
,
793 ospf_nsm_event_str
[event
],
794 lookup_msg(ospf_nsm_state_msg
, func_state
,
799 assert(next_state
!= NSM_DependUpon
);
801 /* If state is changed. */
802 if (next_state
!= nbr
->state
) {
803 int old_state
= nbr
->state
;
805 nsm_notice_state_change(nbr
, next_state
, event
);
806 nsm_change_state(nbr
, next_state
);
808 hook_call(ospf_nsm_change
, nbr
, next_state
, old_state
);
811 /* Make sure timer is set. */
814 /* When event is NSM_KillNbr, InactivityTimer or LLDown, the neighbor
817 * Rather than encode knowledge here of which events lead to NBR
818 * delete, we take our cue from the NSM table, via the dummy
819 * 'Deleted' neighbour state.
821 if (nbr
->state
== NSM_Deleted
)
822 ospf_nbr_delete(nbr
);
827 /* Check loading state. */
828 void ospf_check_nbr_loading(struct ospf_neighbor
*nbr
)
830 if (nbr
->state
== NSM_Loading
) {
831 if (ospf_ls_request_isempty(nbr
))
832 OSPF_NSM_EVENT_SCHEDULE(nbr
, NSM_LoadingDone
);
833 else if (nbr
->ls_req_last
== NULL
)
834 ospf_ls_req_event(nbr
);