1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * OSPF Interface functions.
4 * Copyright (C) 1999, 2000 Toshiaki Takada
23 #include "ospfd/ospfd.h"
24 #include "ospfd/ospf_bfd.h"
25 #include "ospfd/ospf_spf.h"
26 #include "ospfd/ospf_interface.h"
27 #include "ospfd/ospf_ism.h"
28 #include "ospfd/ospf_asbr.h"
29 #include "ospfd/ospf_lsa.h"
30 #include "ospfd/ospf_lsdb.h"
31 #include "ospfd/ospf_neighbor.h"
32 #include "ospfd/ospf_nsm.h"
33 #include "ospfd/ospf_packet.h"
34 #include "ospfd/ospf_abr.h"
35 #include "ospfd/ospf_network.h"
36 #include "ospfd/ospf_dump.h"
37 #include "ospfd/ospf_ldp_sync.h"
38 #include "ospfd/ospf_route.h"
39 #include "ospfd/ospf_te.h"
41 DEFINE_QOBJ_TYPE(ospf_interface
);
42 DEFINE_HOOK(ospf_vl_add
, (struct ospf_vl_data
* vd
), (vd
));
43 DEFINE_HOOK(ospf_vl_delete
, (struct ospf_vl_data
* vd
), (vd
));
44 DEFINE_HOOK(ospf_if_update
, (struct interface
* ifp
), (ifp
));
45 DEFINE_HOOK(ospf_if_delete
, (struct interface
* ifp
), (ifp
));
47 int ospf_interface_neighbor_count(struct ospf_interface
*oi
)
50 struct route_node
*rn
;
51 struct ospf_neighbor
*nbr
= NULL
;
53 for (rn
= route_top(oi
->nbrs
); rn
; rn
= route_next(rn
)) {
58 /* Do not show myself. */
59 if (nbr
== oi
->nbr_self
)
61 /* Down state is not shown. */
62 if (nbr
->state
== NSM_Down
)
70 int ospf_if_get_output_cost(struct ospf_interface
*oi
)
72 /* If all else fails, use default OSPF cost */
76 /* if LDP-IGP Sync is running on interface set cost so interface
77 * is used only as last resort
79 if (ldp_sync_if_is_enabled(IF_DEF_PARAMS(oi
->ifp
)->ldp_sync_info
))
80 return (LDP_OSPF_LSINFINITY
);
82 /* ifp speed and bw can be 0 in some platforms, use ospf default bw
83 if bw is configured under interface it would be used.
85 if (!oi
->ifp
->bandwidth
&& oi
->ifp
->speed
)
88 bw
= oi
->ifp
->bandwidth
? oi
->ifp
->bandwidth
89 : OSPF_DEFAULT_BANDWIDTH
;
90 refbw
= oi
->ospf
->ref_bandwidth
;
92 /* A specified ip ospf cost overrides a calculated one. */
93 if (OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS(oi
->ifp
), output_cost_cmd
)
94 || OSPF_IF_PARAM_CONFIGURED(oi
->params
, output_cost_cmd
))
95 cost
= OSPF_IF_PARAM(oi
, output_cost_cmd
);
96 /* See if a cost can be calculated from the zebra processes
97 interface bandwidth field. */
99 cost
= (uint32_t)((double)refbw
/ (double)bw
+ (double)0.5);
102 else if (cost
> 65535)
109 void ospf_if_recalculate_output_cost(struct interface
*ifp
)
112 struct route_node
*rn
;
114 for (rn
= route_top(IF_OIFS(ifp
)); rn
; rn
= route_next(rn
)) {
115 struct ospf_interface
*oi
;
117 if ((oi
= rn
->info
) == NULL
)
120 newcost
= ospf_if_get_output_cost(oi
);
122 /* Is actual output cost changed? */
123 if (oi
->output_cost
!= newcost
) {
124 oi
->output_cost
= newcost
;
125 ospf_router_lsa_update_area(oi
->area
);
130 /* Simulate down/up on the interface. This is needed, for example, when
132 void ospf_if_reset(struct interface
*ifp
)
134 struct route_node
*rn
;
136 for (rn
= route_top(IF_OIFS(ifp
)); rn
; rn
= route_next(rn
)) {
137 struct ospf_interface
*oi
;
139 if ((oi
= rn
->info
) == NULL
)
147 void ospf_if_reset_variables(struct ospf_interface
*oi
)
149 /* Set default values. */
150 /* don't clear this flag. oi->flag = OSPF_IF_DISABLE; */
153 oi
->type
= OSPF_IFTYPE_VIRTUALLINK
;
155 /* preserve network-type */
156 if (oi
->type
!= OSPF_IFTYPE_NBMA
)
157 oi
->type
= OSPF_IFTYPE_BROADCAST
;
159 oi
->state
= ISM_Down
;
161 oi
->crypt_seqnum
= 0;
163 /* This must be short, (less than RxmtInterval)
164 - RFC 2328 Section 13.5 para 3. Set to 1 second to avoid Acks being
165 held back for too long - MAG */
169 /* lookup oi for specified prefix/ifp */
170 struct ospf_interface
*ospf_if_table_lookup(struct interface
*ifp
,
171 struct prefix
*prefix
)
174 struct route_node
*rn
;
175 struct ospf_interface
*rninfo
= NULL
;
178 p
.prefixlen
= IPV4_MAX_BITLEN
;
180 /* route_node_get implicitely locks */
181 if ((rn
= route_node_lookup(IF_OIFS(ifp
), &p
))) {
182 rninfo
= (struct ospf_interface
*)rn
->info
;
183 route_unlock_node(rn
);
189 static void ospf_add_to_if(struct interface
*ifp
, struct ospf_interface
*oi
)
191 struct route_node
*rn
;
195 p
.prefixlen
= IPV4_MAX_BITLEN
;
198 rn
= route_node_get(IF_OIFS(ifp
), &p
);
199 /* rn->info should either be NULL or equal to this oi
200 * as route_node_get may return an existing node
202 assert(!rn
->info
|| rn
->info
== oi
);
206 static void ospf_delete_from_if(struct interface
*ifp
,
207 struct ospf_interface
*oi
)
209 struct route_node
*rn
;
213 p
.prefixlen
= IPV4_MAX_BITLEN
;
215 rn
= route_node_lookup(IF_OIFS(oi
->ifp
), &p
);
219 route_unlock_node(rn
);
220 route_unlock_node(rn
);
223 struct ospf_interface
*ospf_if_new(struct ospf
*ospf
, struct interface
*ifp
,
226 struct ospf_interface
*oi
;
228 oi
= ospf_if_table_lookup(ifp
, p
);
232 oi
= XCALLOC(MTYPE_OSPF_IF
, sizeof(struct ospf_interface
));
234 oi
->obuf
= ospf_fifo_new();
236 /* Set zebra interface pointer. */
240 ospf_add_to_if(ifp
, oi
);
241 listnode_add(ospf
->oiflist
, oi
);
243 /* Initialize neighbor list. */
244 oi
->nbrs
= route_table_init();
246 /* Initialize static neighbor list. */
247 oi
->nbr_nbma
= list_new();
249 /* Initialize Link State Acknowledgment list. */
250 oi
->ls_ack
= list_new();
251 oi
->ls_ack_direct
.ls_ack
= list_new();
253 /* Set default values. */
254 ospf_if_reset_variables(oi
);
256 /* Set pseudo neighbor to Null */
259 oi
->ls_upd_queue
= route_table_init();
260 oi
->t_ls_upd_event
= NULL
;
261 oi
->t_ls_ack_direct
= NULL
;
263 oi
->crypt_seqnum
= frr_sequence32_next();
265 ospf_opaque_type9_lsa_init(oi
);
269 QOBJ_REG(oi
, ospf_interface
);
271 if (IS_DEBUG_OSPF_EVENT
)
272 zlog_debug("%s: ospf interface %s vrf %s id %u created",
273 __func__
, ifp
->name
, ospf_get_name(ospf
),
279 /* Restore an interface to its pre UP state
280 Used from ism_interface_down only */
281 void ospf_if_cleanup(struct ospf_interface
*oi
)
283 struct route_node
*rn
;
284 struct listnode
*node
, *nnode
;
285 struct ospf_neighbor
*nbr
;
286 struct ospf_nbr_nbma
*nbr_nbma
;
287 struct ospf_lsa
*lsa
;
289 /* oi->nbrs and oi->nbr_nbma should be deleted on InterfaceDown event */
290 /* delete all static neighbors attached to this interface */
291 for (ALL_LIST_ELEMENTS(oi
->nbr_nbma
, node
, nnode
, nbr_nbma
)) {
292 THREAD_OFF(nbr_nbma
->t_poll
);
295 nbr_nbma
->nbr
->nbr_nbma
= NULL
;
296 nbr_nbma
->nbr
= NULL
;
301 listnode_delete(oi
->nbr_nbma
, nbr_nbma
);
304 /* send Neighbor event KillNbr to all associated neighbors. */
305 for (rn
= route_top(oi
->nbrs
); rn
; rn
= route_next(rn
)) {
306 if ((nbr
= rn
->info
) != NULL
)
307 if (nbr
!= oi
->nbr_self
)
308 OSPF_NSM_EVENT_EXECUTE(nbr
, NSM_KillNbr
);
311 /* Cleanup Link State Acknowlegdment list. */
312 for (ALL_LIST_ELEMENTS(oi
->ls_ack
, node
, nnode
, lsa
))
313 ospf_lsa_unlock(&lsa
); /* oi->ls_ack */
314 list_delete_all_node(oi
->ls_ack
);
316 oi
->crypt_seqnum
= 0;
318 /* Empty link state update queue */
319 ospf_ls_upd_queue_empty(oi
);
321 /* Reset pseudo neighbor. */
322 ospf_nbr_self_reset(oi
, oi
->ospf
->router_id
);
325 void ospf_if_free(struct ospf_interface
*oi
)
329 ospf_fifo_free(oi
->obuf
);
331 assert(oi
->state
== ISM_Down
);
333 ospf_opaque_type9_lsa_term(oi
);
337 /* Free Pseudo Neighbour */
338 ospf_nbr_delete(oi
->nbr_self
);
340 route_table_finish(oi
->nbrs
);
341 route_table_finish(oi
->ls_upd_queue
);
343 /* Free any lists that should be freed */
344 list_delete(&oi
->nbr_nbma
);
346 list_delete(&oi
->ls_ack
);
347 list_delete(&oi
->ls_ack_direct
.ls_ack
);
349 if (IS_DEBUG_OSPF_EVENT
)
350 zlog_debug("%s: ospf interface %s vrf %s id %u deleted",
351 __func__
, oi
->ifp
->name
, oi
->ifp
->vrf
->name
,
352 oi
->ifp
->vrf
->vrf_id
);
354 ospf_delete_from_if(oi
->ifp
, oi
);
356 listnode_delete(oi
->ospf
->oiflist
, oi
);
357 listnode_delete(oi
->area
->oiflist
, oi
);
359 thread_cancel_event(master
, oi
);
361 memset(oi
, 0, sizeof(*oi
));
362 XFREE(MTYPE_OSPF_IF
, oi
);
365 int ospf_if_is_up(struct ospf_interface
*oi
)
367 return if_is_up(oi
->ifp
);
370 struct ospf_interface
*ospf_if_exists(struct ospf_interface
*oic
)
372 struct listnode
*node
;
374 struct ospf_interface
*oi
;
383 for (ALL_LIST_ELEMENTS_RO(ospf
->oiflist
, node
, oi
))
390 /* Lookup OSPF interface by router LSA posistion */
391 struct ospf_interface
*ospf_if_lookup_by_lsa_pos(struct ospf_area
*area
,
394 struct listnode
*node
;
395 struct ospf_interface
*oi
;
397 for (ALL_LIST_ELEMENTS_RO(area
->oiflist
, node
, oi
)) {
398 if (lsa_pos
>= oi
->lsa_pos_beg
&& lsa_pos
< oi
->lsa_pos_end
)
404 struct ospf_interface
*ospf_if_lookup_by_local_addr(struct ospf
*ospf
,
405 struct interface
*ifp
,
406 struct in_addr address
)
408 struct listnode
*node
;
409 struct ospf_interface
*oi
;
411 for (ALL_LIST_ELEMENTS_RO(ospf
->oiflist
, node
, oi
))
412 if (oi
->type
!= OSPF_IFTYPE_VIRTUALLINK
) {
413 if (ifp
&& oi
->ifp
!= ifp
)
416 if (IPV4_ADDR_SAME(&address
, &oi
->address
->u
.prefix4
))
423 struct ospf_interface
*ospf_if_lookup_by_prefix(struct ospf
*ospf
,
424 struct prefix_ipv4
*p
)
426 struct listnode
*node
;
427 struct ospf_interface
*oi
;
429 /* Check each Interface. */
430 for (ALL_LIST_ELEMENTS_RO(ospf
->oiflist
, node
, oi
)) {
431 if (oi
->type
!= OSPF_IFTYPE_VIRTUALLINK
) {
434 prefix_copy(&ptmp
, CONNECTED_PREFIX(oi
->connected
));
436 if (prefix_same(&ptmp
, (struct prefix
*)p
))
443 /* determine receiving interface by ifp and source address */
444 struct ospf_interface
*ospf_if_lookup_recv_if(struct ospf
*ospf
,
446 struct interface
*ifp
)
448 struct route_node
*rn
;
449 struct prefix_ipv4 addr
;
450 struct ospf_interface
*oi
, *match
, *unnumbered_match
;
452 addr
.family
= AF_INET
;
454 addr
.prefixlen
= IPV4_MAX_BITLEN
;
456 match
= unnumbered_match
= NULL
;
458 for (rn
= route_top(IF_OIFS(ifp
)); rn
; rn
= route_next(rn
)) {
461 if (!oi
) /* oi can be NULL for PtP aliases */
464 if (oi
->type
== OSPF_IFTYPE_VIRTUALLINK
)
467 if (if_is_loopback(oi
->ifp
))
470 if (CHECK_FLAG(oi
->connected
->flags
, ZEBRA_IFA_UNNUMBERED
))
471 unnumbered_match
= oi
;
472 else if (prefix_match(CONNECTED_PREFIX(oi
->connected
),
473 (struct prefix
*)&addr
)) {
474 if ((match
== NULL
) || (match
->address
->prefixlen
475 < oi
->address
->prefixlen
))
483 return unnumbered_match
;
486 void ospf_interface_fifo_flush(struct ospf_interface
*oi
)
488 struct ospf
*ospf
= oi
->ospf
;
490 ospf_fifo_flush(oi
->obuf
);
492 if (oi
->on_write_q
) {
493 listnode_delete(ospf
->oi_write_q
, oi
);
494 if (list_isempty(ospf
->oi_write_q
))
495 THREAD_OFF(ospf
->t_write
);
500 static void ospf_if_reset_stats(struct ospf_interface
*oi
)
502 oi
->hello_in
= oi
->hello_out
= 0;
503 oi
->db_desc_in
= oi
->db_desc_out
= 0;
504 oi
->ls_req_in
= oi
->ls_req_out
= 0;
505 oi
->ls_upd_in
= oi
->ls_upd_out
= 0;
506 oi
->ls_ack_in
= oi
->ls_ack_out
= 0;
509 void ospf_if_stream_unset(struct ospf_interface
*oi
)
511 /* flush the interface packet queue */
512 ospf_interface_fifo_flush(oi
);
513 /*reset protocol stats */
514 ospf_if_reset_stats(oi
);
518 static struct ospf_if_params
*ospf_new_if_params(void)
520 struct ospf_if_params
*oip
;
522 oip
= XCALLOC(MTYPE_OSPF_IF_PARAMS
, sizeof(struct ospf_if_params
));
524 UNSET_IF_PARAM(oip
, output_cost_cmd
);
525 UNSET_IF_PARAM(oip
, transmit_delay
);
526 UNSET_IF_PARAM(oip
, retransmit_interval
);
527 UNSET_IF_PARAM(oip
, passive_interface
);
528 UNSET_IF_PARAM(oip
, v_hello
);
529 UNSET_IF_PARAM(oip
, fast_hello
);
530 UNSET_IF_PARAM(oip
, v_wait
);
531 UNSET_IF_PARAM(oip
, priority
);
532 UNSET_IF_PARAM(oip
, type
);
533 UNSET_IF_PARAM(oip
, auth_simple
);
534 UNSET_IF_PARAM(oip
, auth_crypt
);
535 UNSET_IF_PARAM(oip
, auth_type
);
536 UNSET_IF_PARAM(oip
, if_area
);
538 oip
->auth_crypt
= list_new();
540 oip
->network_lsa_seqnum
= htonl(OSPF_INITIAL_SEQUENCE_NUMBER
);
541 oip
->is_v_wait_set
= false;
548 static void ospf_del_if_params(struct interface
*ifp
,
549 struct ospf_if_params
*oip
)
551 list_delete(&oip
->auth_crypt
);
552 ospf_interface_disable_bfd(ifp
, oip
);
553 ldp_sync_info_free(&(oip
->ldp_sync_info
));
554 XFREE(MTYPE_OSPF_IF_PARAMS
, oip
);
557 void ospf_free_if_params(struct interface
*ifp
, struct in_addr addr
)
559 struct ospf_if_params
*oip
;
560 struct prefix_ipv4 p
;
561 struct route_node
*rn
;
564 p
.prefixlen
= IPV4_MAX_BITLEN
;
566 rn
= route_node_lookup(IF_OIFS_PARAMS(ifp
), (struct prefix
*)&p
);
567 if (!rn
|| !rn
->info
)
571 route_unlock_node(rn
);
573 if (!OSPF_IF_PARAM_CONFIGURED(oip
, output_cost_cmd
)
574 && !OSPF_IF_PARAM_CONFIGURED(oip
, transmit_delay
)
575 && !OSPF_IF_PARAM_CONFIGURED(oip
, retransmit_interval
)
576 && !OSPF_IF_PARAM_CONFIGURED(oip
, passive_interface
)
577 && !OSPF_IF_PARAM_CONFIGURED(oip
, v_hello
)
578 && !OSPF_IF_PARAM_CONFIGURED(oip
, fast_hello
)
579 && !OSPF_IF_PARAM_CONFIGURED(oip
, v_wait
)
580 && !OSPF_IF_PARAM_CONFIGURED(oip
, priority
)
581 && !OSPF_IF_PARAM_CONFIGURED(oip
, type
)
582 && !OSPF_IF_PARAM_CONFIGURED(oip
, auth_simple
)
583 && !OSPF_IF_PARAM_CONFIGURED(oip
, auth_type
)
584 && !OSPF_IF_PARAM_CONFIGURED(oip
, if_area
)
585 && listcount(oip
->auth_crypt
) == 0) {
586 ospf_del_if_params(ifp
, oip
);
588 route_unlock_node(rn
);
592 struct ospf_if_params
*ospf_lookup_if_params(struct interface
*ifp
,
595 struct prefix_ipv4 p
;
596 struct route_node
*rn
;
599 p
.prefixlen
= IPV4_MAX_BITLEN
;
602 rn
= route_node_lookup(IF_OIFS_PARAMS(ifp
), (struct prefix
*)&p
);
605 route_unlock_node(rn
);
612 struct ospf_if_params
*ospf_get_if_params(struct interface
*ifp
,
615 struct prefix_ipv4 p
;
616 struct route_node
*rn
;
619 p
.prefixlen
= IPV4_MAX_BITLEN
;
623 rn
= route_node_get(IF_OIFS_PARAMS(ifp
), (struct prefix
*)&p
);
625 if (rn
->info
== NULL
)
626 rn
->info
= ospf_new_if_params();
628 route_unlock_node(rn
);
633 void ospf_if_update_params(struct interface
*ifp
, struct in_addr addr
)
635 struct route_node
*rn
;
636 struct ospf_interface
*oi
;
638 for (rn
= route_top(IF_OIFS(ifp
)); rn
; rn
= route_next(rn
)) {
639 if ((oi
= rn
->info
) == NULL
)
642 if (IPV4_ADDR_SAME(&oi
->address
->u
.prefix4
, &addr
))
643 oi
->params
= ospf_lookup_if_params(
644 ifp
, oi
->address
->u
.prefix4
);
648 int ospf_if_new_hook(struct interface
*ifp
)
652 ifp
->info
= XCALLOC(MTYPE_OSPF_IF_INFO
, sizeof(struct ospf_if_info
));
654 IF_OIFS(ifp
) = route_table_init();
655 IF_OIFS_PARAMS(ifp
) = route_table_init();
657 IF_DEF_PARAMS(ifp
) = ospf_new_if_params();
659 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), transmit_delay
);
660 IF_DEF_PARAMS(ifp
)->transmit_delay
= OSPF_TRANSMIT_DELAY_DEFAULT
;
662 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), retransmit_interval
);
663 IF_DEF_PARAMS(ifp
)->retransmit_interval
=
664 OSPF_RETRANSMIT_INTERVAL_DEFAULT
;
666 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), priority
);
667 IF_DEF_PARAMS(ifp
)->priority
= OSPF_ROUTER_PRIORITY_DEFAULT
;
669 IF_DEF_PARAMS(ifp
)->mtu_ignore
= OSPF_MTU_IGNORE_DEFAULT
;
671 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), v_hello
);
672 IF_DEF_PARAMS(ifp
)->v_hello
= OSPF_HELLO_INTERVAL_DEFAULT
;
674 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), fast_hello
);
675 IF_DEF_PARAMS(ifp
)->fast_hello
= OSPF_FAST_HELLO_DEFAULT
;
677 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), v_wait
);
678 IF_DEF_PARAMS(ifp
)->v_wait
= OSPF_ROUTER_DEAD_INTERVAL_DEFAULT
;
680 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), auth_simple
);
681 memset(IF_DEF_PARAMS(ifp
)->auth_simple
, 0, OSPF_AUTH_SIMPLE_SIZE
);
683 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), auth_type
);
684 IF_DEF_PARAMS(ifp
)->auth_type
= OSPF_AUTH_NOTSET
;
686 rc
= ospf_opaque_new_if(ifp
);
690 static int ospf_if_delete_hook(struct interface
*ifp
)
693 struct route_node
*rn
;
694 rc
= ospf_opaque_del_if(ifp
);
697 * This function must be called before `route_table_finish` due to
698 * BFD integration need to iterate over the interface neighbors to
699 * remove all registrations.
701 ospf_del_if_params(ifp
, IF_DEF_PARAMS(ifp
));
703 for (rn
= route_top(IF_OIFS_PARAMS(ifp
)); rn
; rn
= route_next(rn
))
705 ospf_del_if_params(ifp
, rn
->info
);
707 route_table_finish(IF_OIFS(ifp
));
708 route_table_finish(IF_OIFS_PARAMS(ifp
));
710 XFREE(MTYPE_OSPF_IF_INFO
, ifp
->info
);
715 int ospf_if_is_enable(struct ospf_interface
*oi
)
717 if (!(if_is_loopback(oi
->ifp
)))
718 if (if_is_up(oi
->ifp
))
724 void ospf_if_set_multicast(struct ospf_interface
*oi
)
726 if ((oi
->state
> ISM_Loopback
) && (oi
->type
!= OSPF_IFTYPE_LOOPBACK
)
727 && (oi
->type
!= OSPF_IFTYPE_VIRTUALLINK
)
728 && (OSPF_IF_PASSIVE_STATUS(oi
) == OSPF_IF_ACTIVE
)) {
729 /* The interface should belong to the OSPF-all-routers group. */
730 if (!OI_MEMBER_CHECK(oi
, MEMBER_ALLROUTERS
)
731 && (ospf_if_add_allspfrouters(oi
->ospf
, oi
->address
,
734 /* Set the flag only if the system call to join
736 OI_MEMBER_JOINED(oi
, MEMBER_ALLROUTERS
);
738 /* The interface should NOT belong to the OSPF-all-routers
740 if (OI_MEMBER_CHECK(oi
, MEMBER_ALLROUTERS
)) {
741 /* Only actually drop if this is the last reference */
742 if (OI_MEMBER_COUNT(oi
, MEMBER_ALLROUTERS
) == 1)
743 ospf_if_drop_allspfrouters(oi
->ospf
,
746 /* Unset the flag regardless of whether the system call
748 the group succeeded, since it's much safer to assume
750 we are not a member. */
751 OI_MEMBER_LEFT(oi
, MEMBER_ALLROUTERS
);
755 if (((oi
->type
== OSPF_IFTYPE_BROADCAST
)
756 || (oi
->type
== OSPF_IFTYPE_POINTOPOINT
))
757 && ((oi
->state
== ISM_DR
) || (oi
->state
== ISM_Backup
))
758 && (OSPF_IF_PASSIVE_STATUS(oi
) == OSPF_IF_ACTIVE
)) {
759 /* The interface should belong to the OSPF-designated-routers
761 if (!OI_MEMBER_CHECK(oi
, MEMBER_DROUTERS
)
762 && (ospf_if_add_alldrouters(oi
->ospf
, oi
->address
,
765 /* Set the flag only if the system call to join
767 OI_MEMBER_JOINED(oi
, MEMBER_DROUTERS
);
769 /* The interface should NOT belong to the
770 * OSPF-designated-routers group */
771 if (OI_MEMBER_CHECK(oi
, MEMBER_DROUTERS
)) {
772 /* drop only if last reference */
773 if (OI_MEMBER_COUNT(oi
, MEMBER_DROUTERS
) == 1)
774 ospf_if_drop_alldrouters(oi
->ospf
, oi
->address
,
777 /* Unset the flag regardless of whether the system call
779 the group succeeded, since it's much safer to assume
781 we are not a member. */
782 OI_MEMBER_LEFT(oi
, MEMBER_DROUTERS
);
787 int ospf_if_up(struct ospf_interface
*oi
)
792 if (oi
->type
== OSPF_IFTYPE_LOOPBACK
)
793 OSPF_ISM_EVENT_SCHEDULE(oi
, ISM_LoopInd
);
795 OSPF_ISM_EVENT_SCHEDULE(oi
, ISM_InterfaceUp
);
801 int ospf_if_down(struct ospf_interface
*oi
)
804 struct route_node
*rn
;
805 struct ospf_route
*or;
807 struct ospf_path
*op
;
814 /* Cease the HELPER role for all the neighbours
817 if (ospf
->is_helper_supported
) {
818 struct route_node
*rn
= NULL
;
820 if (ospf_interface_neighbor_count(oi
)) {
821 for (rn
= route_top(oi
->nbrs
); rn
;
822 rn
= route_next(rn
)) {
823 struct ospf_neighbor
*nbr
= NULL
;
830 if (OSPF_GR_IS_ACTIVE_HELPER(nbr
))
832 nbr
, OSPF_GR_HELPER_TOPO_CHG
);
837 OSPF_ISM_EVENT_EXECUTE(oi
, ISM_InterfaceDown
);
838 /* delete position in router LSA */
841 /* Shutdown packet reception and sending */
842 ospf_if_stream_unset(oi
);
844 if (!ospf
->new_table
)
846 for (rn
= route_top(ospf
->new_table
); rn
; rn
= route_next(rn
)) {
852 for (nh
= listhead(or->paths
); nh
;
853 nh
= listnextnode_unchecked(nh
)) {
854 op
= listgetdata(nh
);
855 if (op
->ifindex
== oi
->ifp
->ifindex
) {
866 /* Virtual Link related functions. */
868 struct ospf_vl_data
*ospf_vl_data_new(struct ospf_area
*area
,
869 struct in_addr vl_peer
)
871 struct ospf_vl_data
*vl_data
;
873 vl_data
= XCALLOC(MTYPE_OSPF_VL_DATA
, sizeof(struct ospf_vl_data
));
875 vl_data
->vl_peer
.s_addr
= vl_peer
.s_addr
;
876 vl_data
->vl_area_id
= area
->area_id
;
877 vl_data
->vl_area_id_fmt
= area
->area_id_fmt
;
882 void ospf_vl_data_free(struct ospf_vl_data
*vl_data
)
884 XFREE(MTYPE_OSPF_VL_DATA
, vl_data
);
887 unsigned int vlink_count
= 0;
889 struct ospf_interface
*ospf_vl_new(struct ospf
*ospf
,
890 struct ospf_vl_data
*vl_data
)
892 struct ospf_interface
*voi
;
893 struct interface
*vi
;
894 char ifname
[INTERFACE_NAMSIZ
];
895 struct ospf_area
*area
;
896 struct in_addr area_id
;
897 struct connected
*co
;
898 struct prefix_ipv4
*p
;
900 if (IS_DEBUG_OSPF_EVENT
)
901 zlog_debug("%s: (%s): Start", __func__
, ospf_get_name(ospf
));
902 if (vlink_count
== OSPF_VL_MAX_COUNT
) {
903 if (IS_DEBUG_OSPF_EVENT
)
905 "%s: Alarm: cannot create more than OSPF_MAX_VL_COUNT virtual links",
911 if (IS_DEBUG_OSPF_EVENT
)
912 zlog_debug("%s: creating pseudo zebra interface vrf id %u",
913 __func__
, ospf
->vrf_id
);
915 snprintf(ifname
, sizeof(ifname
), "VLINK%u", vlink_count
);
916 vi
= if_get_by_name(ifname
, ospf
->vrf_id
, ospf
->name
);
918 * if_get_by_name sets ZEBRA_INTERFACE_LINKDETECTION
919 * virtual links don't need this.
921 UNSET_FLAG(vi
->status
, ZEBRA_INTERFACE_LINKDETECTION
);
922 co
= connected_new();
924 listnode_add(vi
->connected
, co
);
926 p
= prefix_ipv4_new();
928 p
->prefix
.s_addr
= INADDR_ANY
;
931 co
->address
= (struct prefix
*)p
;
933 voi
= ospf_if_new(ospf
, vi
, co
->address
);
935 if (IS_DEBUG_OSPF_EVENT
)
937 "%s: Alarm: OSPF int structure is not created",
943 voi
->vl_data
= vl_data
;
944 voi
->ifp
->mtu
= OSPF_VL_MTU
;
945 voi
->type
= OSPF_IFTYPE_VIRTUALLINK
;
948 if (IS_DEBUG_OSPF_EVENT
)
949 zlog_debug("%s: Created name: %s set if->name to %s", __func__
,
952 area_id
.s_addr
= INADDR_ANY
;
953 area
= ospf_area_get(ospf
, area_id
);
956 if (IS_DEBUG_OSPF_EVENT
)
957 zlog_debug("%s: set associated area to the backbone", __func__
);
959 /* Add pseudo neighbor. */
960 ospf_nbr_self_reset(voi
, voi
->ospf
->router_id
);
962 ospf_area_add_if(voi
->area
, voi
);
964 if (IS_DEBUG_OSPF_EVENT
)
965 zlog_debug("%s: Stop", __func__
);
969 static void ospf_vl_if_delete(struct ospf_vl_data
*vl_data
)
971 struct interface
*ifp
= vl_data
->vl_oi
->ifp
;
972 struct vrf
*vrf
= ifp
->vrf
;
974 vl_data
->vl_oi
->address
->u
.prefix4
.s_addr
= INADDR_ANY
;
975 vl_data
->vl_oi
->address
->prefixlen
= 0;
976 ospf_if_free(vl_data
->vl_oi
);
978 if (!vrf_is_enabled(vrf
))
983 /* for a defined area, count the number of configured vl
985 int ospf_vl_count(struct ospf
*ospf
, struct ospf_area
*area
)
988 struct ospf_vl_data
*vl_data
;
989 struct listnode
*node
;
991 for (ALL_LIST_ELEMENTS_RO(ospf
->vlinks
, node
, vl_data
)) {
993 && !IPV4_ADDR_SAME(&vl_data
->vl_area_id
, &area
->area_id
))
1000 /* Look up vl_data for given peer, optionally qualified to be in the
1001 * specified area. NULL area returns first found..
1003 struct ospf_vl_data
*ospf_vl_lookup(struct ospf
*ospf
, struct ospf_area
*area
,
1004 struct in_addr vl_peer
)
1006 struct ospf_vl_data
*vl_data
;
1007 struct listnode
*node
;
1009 if (IS_DEBUG_OSPF_EVENT
) {
1010 zlog_debug("%s: Looking for %pI4", __func__
, &vl_peer
);
1012 zlog_debug("%s: in area %pI4", __func__
,
1016 for (ALL_LIST_ELEMENTS_RO(ospf
->vlinks
, node
, vl_data
)) {
1017 if (IS_DEBUG_OSPF_EVENT
)
1018 zlog_debug("%s: VL %s, peer %pI4", __func__
,
1019 vl_data
->vl_oi
->ifp
->name
,
1023 && !IPV4_ADDR_SAME(&vl_data
->vl_area_id
, &area
->area_id
))
1026 if (IPV4_ADDR_SAME(&vl_data
->vl_peer
, &vl_peer
))
1033 static void ospf_vl_shutdown(struct ospf_vl_data
*vl_data
)
1035 struct ospf_interface
*oi
;
1037 if ((oi
= vl_data
->vl_oi
) == NULL
)
1040 oi
->address
->u
.prefix4
.s_addr
= INADDR_ANY
;
1041 oi
->address
->prefixlen
= 0;
1043 UNSET_FLAG(oi
->ifp
->flags
, IFF_UP
);
1044 /* OSPF_ISM_EVENT_SCHEDULE (oi, ISM_InterfaceDown); */
1045 OSPF_ISM_EVENT_EXECUTE(oi
, ISM_InterfaceDown
);
1048 void ospf_vl_add(struct ospf
*ospf
, struct ospf_vl_data
*vl_data
)
1050 listnode_add(ospf
->vlinks
, vl_data
);
1051 hook_call(ospf_vl_add
, vl_data
);
1054 void ospf_vl_delete(struct ospf
*ospf
, struct ospf_vl_data
*vl_data
)
1056 ospf_vl_shutdown(vl_data
);
1057 ospf_vl_if_delete(vl_data
);
1059 hook_call(ospf_vl_delete
, vl_data
);
1060 listnode_delete(ospf
->vlinks
, vl_data
);
1062 ospf_vl_data_free(vl_data
);
1065 static int ospf_vl_set_params(struct ospf_area
*area
,
1066 struct ospf_vl_data
*vl_data
, struct vertex
*v
)
1069 struct ospf_interface
*voi
;
1070 struct listnode
*node
;
1071 struct vertex_parent
*vp
= NULL
;
1073 struct router_lsa
*rl
;
1074 struct ospf_interface
*oi
;
1076 voi
= vl_data
->vl_oi
;
1078 if (voi
->output_cost
!= v
->distance
) {
1080 voi
->output_cost
= v
->distance
;
1084 for (ALL_LIST_ELEMENTS_RO(v
->parents
, node
, vp
)) {
1085 vl_data
->nexthop
.lsa_pos
= vp
->nexthop
->lsa_pos
;
1086 vl_data
->nexthop
.router
= vp
->nexthop
->router
;
1089 * Only deal with interface data when the local
1090 * (calculating) node is the SPF root node
1092 if (!area
->spf_dry_run
) {
1093 oi
= ospf_if_lookup_by_lsa_pos(
1094 area
, vl_data
->nexthop
.lsa_pos
);
1096 if (!IPV4_ADDR_SAME(&voi
->address
->u
.prefix4
,
1097 &oi
->address
->u
.prefix4
))
1100 voi
->address
->u
.prefix4
= oi
->address
->u
.prefix4
;
1101 voi
->address
->prefixlen
= oi
->address
->prefixlen
;
1104 break; /* We take the first interface. */
1107 rl
= (struct router_lsa
*)v
->lsa
;
1109 /* use SPF determined backlink index in struct vertex
1110 * for virtual link destination address
1112 if (vp
&& vp
->backlink
>= 0) {
1113 if (!IPV4_ADDR_SAME(&vl_data
->peer_addr
,
1114 &rl
->link
[vp
->backlink
].link_data
))
1116 vl_data
->peer_addr
= rl
->link
[vp
->backlink
].link_data
;
1118 /* This is highly odd, there is no backlink index
1119 * there should be due to the ospf_spf_has_link() check
1120 * in SPF. Lets warn and try pick a link anyway.
1122 zlog_info("ospf_vl_set_params: No backlink for %s!",
1123 vl_data
->vl_oi
->ifp
->name
);
1124 for (i
= 0; i
< ntohs(rl
->links
); i
++) {
1125 switch (rl
->link
[i
].type
) {
1126 case LSA_LINK_TYPE_VIRTUALLINK
:
1127 if (IS_DEBUG_OSPF_EVENT
)
1129 "found back link through VL");
1131 case LSA_LINK_TYPE_TRANSIT
:
1132 case LSA_LINK_TYPE_POINTOPOINT
:
1133 if (!IPV4_ADDR_SAME(&vl_data
->peer_addr
,
1134 &rl
->link
[i
].link_data
))
1136 vl_data
->peer_addr
= rl
->link
[i
].link_data
;
1141 if (IS_DEBUG_OSPF_EVENT
)
1142 zlog_debug("%s: %s peer address: %pI4, cost: %d,%schanged",
1143 __func__
, vl_data
->vl_oi
->ifp
->name
,
1144 &vl_data
->peer_addr
, voi
->output_cost
,
1145 (changed
? " " : " un"));
1151 void ospf_vl_up_check(struct ospf_area
*area
, struct in_addr rid
,
1154 struct ospf
*ospf
= area
->ospf
;
1155 struct listnode
*node
;
1156 struct ospf_vl_data
*vl_data
;
1157 struct ospf_interface
*oi
;
1159 if (IS_DEBUG_OSPF_EVENT
) {
1160 zlog_debug("%s: Start", __func__
);
1161 zlog_debug("%s: Router ID is %pI4 Area is %pI4", __func__
, &rid
,
1165 for (ALL_LIST_ELEMENTS_RO(ospf
->vlinks
, node
, vl_data
)) {
1166 if (IS_DEBUG_OSPF_EVENT
) {
1167 zlog_debug("%s: considering VL, %s in area %pI4",
1168 __func__
, vl_data
->vl_oi
->ifp
->name
,
1169 &vl_data
->vl_area_id
);
1170 zlog_debug("%s: peer ID: %pI4", __func__
,
1174 if (IPV4_ADDR_SAME(&vl_data
->vl_peer
, &rid
)
1175 && IPV4_ADDR_SAME(&vl_data
->vl_area_id
, &area
->area_id
)) {
1176 oi
= vl_data
->vl_oi
;
1177 SET_FLAG(vl_data
->flags
, OSPF_VL_FLAG_APPROVED
);
1179 if (IS_DEBUG_OSPF_EVENT
)
1180 zlog_debug("%s: this VL matched", __func__
);
1182 if (oi
->state
== ISM_Down
) {
1183 if (IS_DEBUG_OSPF_EVENT
)
1185 "%s: VL is down, waking it up",
1187 SET_FLAG(oi
->ifp
->flags
, IFF_UP
);
1188 OSPF_ISM_EVENT_EXECUTE(oi
, ISM_InterfaceUp
);
1191 if (ospf_vl_set_params(area
, vl_data
, v
)) {
1192 if (IS_DEBUG_OSPF(ism
, ISM_EVENTS
))
1194 "%s: VL cost change, scheduling router lsa refresh",
1197 ospf_router_lsa_update_area(
1199 else if (IS_DEBUG_OSPF(ism
, ISM_EVENTS
))
1201 "%s: VL cost change, no backbone!",
1208 void ospf_vl_unapprove(struct ospf
*ospf
)
1210 struct listnode
*node
;
1211 struct ospf_vl_data
*vl_data
;
1213 for (ALL_LIST_ELEMENTS_RO(ospf
->vlinks
, node
, vl_data
))
1214 UNSET_FLAG(vl_data
->flags
, OSPF_VL_FLAG_APPROVED
);
1217 void ospf_vl_shut_unapproved(struct ospf
*ospf
)
1219 struct listnode
*node
, *nnode
;
1220 struct ospf_vl_data
*vl_data
;
1222 for (ALL_LIST_ELEMENTS(ospf
->vlinks
, node
, nnode
, vl_data
))
1223 if (!CHECK_FLAG(vl_data
->flags
, OSPF_VL_FLAG_APPROVED
))
1224 ospf_vl_shutdown(vl_data
);
1227 int ospf_full_virtual_nbrs(struct ospf_area
*area
)
1229 if (IS_DEBUG_OSPF_EVENT
) {
1231 "counting fully adjacent virtual neighbors in area %pI4",
1233 zlog_debug("there are %d of them", area
->full_vls
);
1236 return area
->full_vls
;
1239 int ospf_vls_in_area(struct ospf_area
*area
)
1241 struct listnode
*node
;
1242 struct ospf_vl_data
*vl_data
;
1245 for (ALL_LIST_ELEMENTS_RO(area
->ospf
->vlinks
, node
, vl_data
))
1246 if (IPV4_ADDR_SAME(&vl_data
->vl_area_id
, &area
->area_id
))
1253 struct crypt_key
*ospf_crypt_key_new(void)
1255 return XCALLOC(MTYPE_OSPF_CRYPT_KEY
, sizeof(struct crypt_key
));
1258 void ospf_crypt_key_add(struct list
*crypt
, struct crypt_key
*ck
)
1260 listnode_add(crypt
, ck
);
1263 struct crypt_key
*ospf_crypt_key_lookup(struct list
*auth_crypt
, uint8_t key_id
)
1265 struct listnode
*node
;
1266 struct crypt_key
*ck
;
1268 for (ALL_LIST_ELEMENTS_RO(auth_crypt
, node
, ck
))
1269 if (ck
->key_id
== key_id
)
1275 int ospf_crypt_key_delete(struct list
*auth_crypt
, uint8_t key_id
)
1277 struct listnode
*node
, *nnode
;
1278 struct crypt_key
*ck
;
1280 for (ALL_LIST_ELEMENTS(auth_crypt
, node
, nnode
, ck
)) {
1281 if (ck
->key_id
== key_id
) {
1282 listnode_delete(auth_crypt
, ck
);
1283 XFREE(MTYPE_OSPF_CRYPT_KEY
, ck
);
1291 uint8_t ospf_default_iftype(struct interface
*ifp
)
1293 if (if_is_pointopoint(ifp
))
1294 return OSPF_IFTYPE_POINTOPOINT
;
1295 else if (if_is_loopback(ifp
))
1296 return OSPF_IFTYPE_LOOPBACK
;
1298 return OSPF_IFTYPE_BROADCAST
;
1301 void ospf_if_interface(struct interface
*ifp
)
1303 hook_call(ospf_if_update
, ifp
);
1306 uint32_t ospf_if_count_area_params(struct interface
*ifp
)
1308 struct ospf_if_params
*params
;
1309 struct route_node
*rn
;
1312 params
= IF_DEF_PARAMS(ifp
);
1313 if (OSPF_IF_PARAM_CONFIGURED(params
, if_area
))
1316 for (rn
= route_top(IF_OIFS_PARAMS(ifp
)); rn
; rn
= route_next(rn
))
1317 if ((params
= rn
->info
)
1318 && OSPF_IF_PARAM_CONFIGURED(params
, if_area
))
1324 static int ospf_ifp_create(struct interface
*ifp
)
1326 struct ospf
*ospf
= NULL
;
1327 struct ospf_if_info
*oii
;
1329 if (IS_DEBUG_OSPF(zebra
, ZEBRA_INTERFACE
))
1331 "Zebra: interface add %s vrf %s[%u] index %d flags %llx metric %d mtu %d speed %u",
1332 ifp
->name
, ifp
->vrf
->name
, ifp
->vrf
->vrf_id
,
1333 ifp
->ifindex
, (unsigned long long)ifp
->flags
,
1334 ifp
->metric
, ifp
->mtu
, ifp
->speed
);
1339 oii
->curr_mtu
= ifp
->mtu
;
1341 if (IF_DEF_PARAMS(ifp
)
1342 && !OSPF_IF_PARAM_CONFIGURED(IF_DEF_PARAMS(ifp
), type
)) {
1343 SET_IF_PARAM(IF_DEF_PARAMS(ifp
), type
);
1344 IF_DEF_PARAMS(ifp
)->type
= ospf_default_iftype(ifp
);
1347 ospf
= ifp
->vrf
->info
;
1351 if (ospf_if_count_area_params(ifp
) > 0)
1352 ospf_interface_area_set(ospf
, ifp
);
1354 ospf_if_recalculate_output_cost(ifp
);
1356 ospf_if_update(ospf
, ifp
);
1358 if (HAS_LINK_PARAMS(ifp
))
1359 ospf_mpls_te_update_if(ifp
);
1361 hook_call(ospf_if_update
, ifp
);
1366 static int ospf_ifp_up(struct interface
*ifp
)
1368 struct ospf_interface
*oi
;
1369 struct route_node
*rn
;
1370 struct ospf_if_info
*oii
= ifp
->info
;
1372 ospf_if_recalculate_output_cost(ifp
);
1374 if (oii
&& oii
->curr_mtu
!= ifp
->mtu
) {
1375 if (IS_DEBUG_OSPF(zebra
, ZEBRA_INTERFACE
))
1377 "Zebra: Interface[%s] MTU change %u -> %u.",
1378 ifp
->name
, oii
->curr_mtu
, ifp
->mtu
);
1380 oii
->curr_mtu
= ifp
->mtu
;
1381 /* Must reset the interface (simulate down/up) when MTU
1388 if (IS_DEBUG_OSPF(zebra
, ZEBRA_INTERFACE
))
1389 zlog_debug("Zebra: Interface[%s] state change to up.",
1392 for (rn
= route_top(IF_OIFS(ifp
)); rn
; rn
= route_next(rn
)) {
1393 if ((oi
= rn
->info
) == NULL
)
1399 if (HAS_LINK_PARAMS(ifp
))
1400 ospf_mpls_te_update_if(ifp
);
1405 static int ospf_ifp_down(struct interface
*ifp
)
1407 struct ospf_interface
*oi
;
1408 struct route_node
*node
;
1410 if (IS_DEBUG_OSPF(zebra
, ZEBRA_INTERFACE
))
1411 zlog_debug("Zebra: Interface[%s] state change to down.",
1414 for (node
= route_top(IF_OIFS(ifp
)); node
; node
= route_next(node
)) {
1415 if ((oi
= node
->info
) == NULL
)
1423 static int ospf_ifp_destroy(struct interface
*ifp
)
1426 struct route_node
*rn
;
1428 if (IS_DEBUG_OSPF(zebra
, ZEBRA_INTERFACE
))
1430 "Zebra: interface delete %s vrf %s[%u] index %d flags %llx metric %d mtu %d",
1431 ifp
->name
, ifp
->vrf
->name
, ifp
->vrf
->vrf_id
,
1432 ifp
->ifindex
, (unsigned long long)ifp
->flags
,
1433 ifp
->metric
, ifp
->mtu
);
1435 hook_call(ospf_if_delete
, ifp
);
1437 ospf
= ifp
->vrf
->info
;
1439 if (ospf_if_count_area_params(ifp
) > 0)
1440 ospf_interface_area_unset(ospf
, ifp
);
1443 for (rn
= route_top(IF_OIFS(ifp
)); rn
; rn
= route_next(rn
))
1445 ospf_if_free((struct ospf_interface
*)rn
->info
);
1450 /* Resetting ospf hello timer */
1451 void ospf_reset_hello_timer(struct interface
*ifp
, struct in_addr addr
,
1454 struct route_node
*rn
;
1458 struct ospf_interface
*oi
= NULL
;
1462 p
.prefixlen
= IPV4_MAX_BITLEN
;
1464 oi
= ospf_if_table_lookup(ifp
, &p
);
1467 /* Send hello before restart the hello timer
1468 * to avoid session flaps in case of bigger
1469 * hello interval configurations.
1471 ospf_hello_send(oi
);
1473 /* Restart hello timer for this interface */
1474 THREAD_OFF(oi
->t_hello
);
1475 OSPF_HELLO_TIMER_ON(oi
);
1481 for (rn
= route_top(IF_OIFS(ifp
)); rn
; rn
= route_next(rn
)) {
1482 struct ospf_interface
*oi
= rn
->info
;
1487 /* If hello interval configured on this oi, don't restart. */
1488 if (OSPF_IF_PARAM_CONFIGURED(oi
->params
, v_hello
))
1491 /* Send hello before restart the hello timer
1492 * to avoid session flaps in case of bigger
1493 * hello interval configurations.
1495 ospf_hello_send(oi
);
1497 /* Restart the hello timer. */
1498 THREAD_OFF(oi
->t_hello
);
1499 OSPF_HELLO_TIMER_ON(oi
);
1503 void ospf_if_init(void)
1505 if_zapi_callbacks(ospf_ifp_create
, ospf_ifp_up
,
1506 ospf_ifp_down
, ospf_ifp_destroy
);
1508 /* Initialize Zebra interface data structure. */
1509 hook_register_prio(if_add
, 0, ospf_if_new_hook
);
1510 hook_register_prio(if_del
, 0, ospf_if_delete_hook
);