2 * This is an implementation of RFC4970 Router Information
3 * with support of RFC5088 PCE Capabilites announcement
5 * Module name: Router Information
6 * Author: Olivier Dugeon <olivier.dugeon@orange.com>
7 * Copyright (C) 2012 - 2017 Orange Labs http://www.orange.com/
9 * This file is part of GNU Quagga.
11 * GNU Zebra is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2, or (at your option) any
16 * GNU Quagga is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; see the file COPYING; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
40 #include "sockunion.h" /* for inet_aton() */
43 #include "ospfd/ospfd.h"
44 #include "ospfd/ospf_interface.h"
45 #include "ospfd/ospf_ism.h"
46 #include "ospfd/ospf_asbr.h"
47 #include "ospfd/ospf_lsa.h"
48 #include "ospfd/ospf_lsdb.h"
49 #include "ospfd/ospf_neighbor.h"
50 #include "ospfd/ospf_nsm.h"
51 #include "ospfd/ospf_flood.h"
52 #include "ospfd/ospf_packet.h"
53 #include "ospfd/ospf_spf.h"
54 #include "ospfd/ospf_dump.h"
55 #include "ospfd/ospf_route.h"
56 #include "ospfd/ospf_ase.h"
57 #include "ospfd/ospf_zebra.h"
58 #include "ospfd/ospf_sr.h"
59 #include "ospfd/ospf_ri.h"
61 /* Store Router Information PCE TLV and SubTLV in network byte order. */
62 struct ospf_pce_info
{
64 struct ri_tlv_pce pce_header
;
65 struct ri_pce_subtlv_address pce_address
;
66 struct ri_pce_subtlv_path_scope pce_scope
;
67 struct list
*pce_domain
;
68 struct list
*pce_neighbor
;
69 struct ri_pce_subtlv_cap_flag pce_cap_flag
;
73 * Store Router Information Segment Routing TLV and SubTLV
74 * in network byte order
76 struct ospf_ri_sr_info
{
78 /* Algorithms supported by the node */
79 struct ri_sr_tlv_sr_algorithm algo
;
81 * Segment Routing Global Block i.e. label range
82 * Only one range supported in this code
84 struct ri_sr_tlv_sid_label_range range
;
85 /* Maximum SID Depth supported by the node */
86 struct ri_sr_tlv_node_msd msd
;
89 /* Following structure are internal use only. */
90 struct ospf_router_info
{
96 /* Flags to manage this router information. */
97 #define RIFLG_LSA_ENGAGED 0x1
98 #define RIFLG_LSA_FORCED_REFRESH 0x2
101 /* area pointer if flooding is Type 10 Null if flooding is AS scope */
102 struct ospf_area
*area
;
103 struct in_addr area_id
;
105 /* Store Router Information Capabilities LSA */
106 struct ri_tlv_router_cap router_cap
;
108 /* Store PCE capability LSA */
109 struct ospf_pce_info pce_info
;
111 /* Store SR capability LSA */
112 struct ospf_ri_sr_info sr_info
;
116 * Global variable to manage Opaque-LSA/Router Information on this node.
117 * Note that all parameter values are stored in network byte order.
119 static struct ospf_router_info OspfRI
;
121 /*------------------------------------------------------------------------------*
122 * Followings are initialize/terminate functions for Router Information
124 *------------------------------------------------------------------------------*/
126 static void ospf_router_info_ism_change(struct ospf_interface
*oi
,
128 static void ospf_router_info_nsm_change(struct ospf_neighbor
*nbr
,
130 static void ospf_router_info_config_write_router(struct vty
*vty
);
131 static void ospf_router_info_show_info(struct vty
*vty
, struct ospf_lsa
*lsa
);
132 static int ospf_router_info_lsa_originate(void *arg
);
133 static struct ospf_lsa
*ospf_router_info_lsa_refresh(struct ospf_lsa
*lsa
);
134 static void ospf_router_info_lsa_schedule(enum lsa_opcode opcode
);
135 static void ospf_router_info_register_vty(void);
136 static int ospf_router_info_lsa_update(struct ospf_lsa
*lsa
);
137 static void del_pce_info(void *val
);
139 int ospf_router_info_init(void)
142 zlog_info("RI -> Initialize Router Information");
144 memset(&OspfRI
, 0, sizeof(struct ospf_router_info
));
145 OspfRI
.enabled
= false;
146 OspfRI
.registered
= 0;
147 OspfRI
.scope
= OSPF_OPAQUE_AS_LSA
;
148 OspfRI
.area_id
.s_addr
= 0;
151 /* Initialize pce domain and neighbor list */
152 OspfRI
.pce_info
.enabled
= false;
153 OspfRI
.pce_info
.pce_domain
= list_new();
154 OspfRI
.pce_info
.pce_domain
->del
= del_pce_info
;
155 OspfRI
.pce_info
.pce_neighbor
= list_new();
156 OspfRI
.pce_info
.pce_neighbor
->del
= del_pce_info
;
158 /* Initialize Segment Routing information structure */
159 OspfRI
.sr_info
.enabled
= false;
161 ospf_router_info_register_vty();
166 static int ospf_router_info_register(uint8_t scope
)
170 if (OspfRI
.registered
)
173 zlog_info("RI -> Register Router Information with scope %s(%d)",
174 scope
== OSPF_OPAQUE_AREA_LSA
? "Area" : "AS", scope
);
175 rc
= ospf_register_opaque_functab(
176 scope
, OPAQUE_TYPE_ROUTER_INFORMATION_LSA
,
177 NULL
, /* new interface */
178 NULL
, /* del interface */
179 ospf_router_info_ism_change
, ospf_router_info_nsm_change
,
180 ospf_router_info_config_write_router
,
181 NULL
, /* Config. write interface */
182 NULL
, /* Config. write debug */
183 ospf_router_info_show_info
, ospf_router_info_lsa_originate
,
184 ospf_router_info_lsa_refresh
, ospf_router_info_lsa_update
,
185 NULL
); /* del_lsa_hook */
189 "ospf_router_info_init: Failed to register functions");
193 OspfRI
.registered
= 1;
194 OspfRI
.scope
= scope
;
198 static int ospf_router_info_unregister()
201 if ((OspfRI
.scope
!= OSPF_OPAQUE_AS_LSA
)
202 && (OspfRI
.scope
!= OSPF_OPAQUE_AREA_LSA
)) {
204 "Unable to unregister Router Info functions: Wrong scope!");
208 ospf_delete_opaque_functab(OspfRI
.scope
,
209 OPAQUE_TYPE_ROUTER_INFORMATION_LSA
);
211 OspfRI
.registered
= 0;
215 void ospf_router_info_term(void)
218 list_delete_and_null(&OspfRI
.pce_info
.pce_domain
);
219 list_delete_and_null(&OspfRI
.pce_info
.pce_neighbor
);
221 OspfRI
.enabled
= false;
223 ospf_router_info_unregister();
228 void ospf_router_info_finish(void)
230 list_delete_all_node(OspfRI
.pce_info
.pce_domain
);
231 list_delete_all_node(OspfRI
.pce_info
.pce_neighbor
);
233 OspfRI
.enabled
= false;
236 static void del_pce_info(void *val
)
238 XFREE(MTYPE_OSPF_PCE_PARAMS
, val
);
242 /* Catch RI LSA flooding Scope for ospf_ext.[h,c] code */
243 struct scope_info
ospf_router_info_get_flooding_scope(void)
245 struct scope_info flooding_scope
;
247 if (OspfRI
.scope
== OSPF_OPAQUE_AS_LSA
) {
248 flooding_scope
.scope
= OSPF_OPAQUE_AS_LSA
;
249 flooding_scope
.area_id
.s_addr
= 0;
250 return flooding_scope
;
252 flooding_scope
.scope
= OSPF_OPAQUE_AREA_LSA
;
253 flooding_scope
.area_id
.s_addr
= OspfRI
.area_id
.s_addr
;
254 return flooding_scope
;
257 /*------------------------------------------------------------------------*
258 * Followings are control functions for ROUTER INFORMATION parameters
260 *------------------------------------------------------------------------*/
262 static void set_router_info_capabilities(struct ri_tlv_router_cap
*ric
,
265 ric
->header
.type
= htons(RI_TLV_CAPABILITIES
);
266 ric
->header
.length
= htons(RI_TLV_LENGTH
);
267 ric
->value
= htonl(cap
);
271 static int set_pce_header(struct ospf_pce_info
*pce
)
274 struct listnode
*node
;
275 struct ri_pce_subtlv_domain
*domain
;
276 struct ri_pce_subtlv_neighbor
*neighbor
;
279 if (ntohs(pce
->pce_address
.header
.type
) != 0)
280 length
+= TLV_SIZE(&pce
->pce_address
.header
);
283 if (ntohs(pce
->pce_scope
.header
.type
) != 0)
284 length
+= TLV_SIZE(&pce
->pce_scope
.header
);
287 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, domain
)) {
288 if (ntohs(domain
->header
.type
) != 0)
289 length
+= TLV_SIZE(&domain
->header
);
293 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, neighbor
)) {
294 if (ntohs(neighbor
->header
.type
) != 0)
295 length
+= TLV_SIZE(&neighbor
->header
);
298 /* PCE Capabilities */
299 if (ntohs(pce
->pce_cap_flag
.header
.type
) != 0)
300 length
+= TLV_SIZE(&pce
->pce_cap_flag
.header
);
303 pce
->pce_header
.header
.type
= htons(RI_TLV_PCE
);
304 pce
->pce_header
.header
.length
= htons(length
);
307 pce
->pce_header
.header
.type
= 0;
308 pce
->pce_header
.header
.length
= 0;
309 pce
->enabled
= false;
315 static void set_pce_address(struct in_addr ipv4
, struct ospf_pce_info
*pce
)
318 /* Enable PCE Info */
319 pce
->pce_header
.header
.type
= htons(RI_TLV_PCE
);
320 /* Set PCE Address */
321 pce
->pce_address
.header
.type
= htons(RI_PCE_SUBTLV_ADDRESS
);
322 pce
->pce_address
.header
.length
= htons(PCE_ADDRESS_LENGTH_IPV4
);
323 pce
->pce_address
.address
.type
= htons(PCE_ADDRESS_TYPE_IPV4
);
324 pce
->pce_address
.address
.value
= ipv4
;
329 static void set_pce_path_scope(uint32_t scope
, struct ospf_pce_info
*pce
)
333 pce
->pce_scope
.header
.type
= htons(RI_PCE_SUBTLV_PATH_SCOPE
);
334 pce
->pce_scope
.header
.length
= htons(RI_TLV_LENGTH
);
335 pce
->pce_scope
.value
= htonl(scope
);
340 static void set_pce_domain(uint16_t type
, uint32_t domain
,
341 struct ospf_pce_info
*pce
)
344 struct ri_pce_subtlv_domain
*new;
346 /* Create new domain info */
347 new = XCALLOC(MTYPE_OSPF_PCE_PARAMS
,
348 sizeof(struct ri_pce_subtlv_domain
));
350 new->header
.type
= htons(RI_PCE_SUBTLV_DOMAIN
);
351 new->header
.length
= htons(PCE_ADDRESS_LENGTH_IPV4
);
352 new->type
= htons(type
);
353 new->value
= htonl(domain
);
355 /* Add new domain to the list */
356 listnode_add(pce
->pce_domain
, new);
361 static void unset_pce_domain(uint16_t type
, uint32_t domain
,
362 struct ospf_pce_info
*pce
)
364 struct listnode
*node
;
365 struct ri_pce_subtlv_domain
*old
= NULL
;
368 /* Search the corresponding node */
369 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, old
)) {
370 if ((old
->type
== htons(type
))
371 && (old
->value
== htonl(domain
))) {
377 /* if found remove it */
379 listnode_delete(pce
->pce_domain
, old
);
381 /* Avoid misjudgement in the next lookup. */
382 if (listcount(pce
->pce_domain
) == 0)
383 pce
->pce_domain
->head
= pce
->pce_domain
->tail
= NULL
;
385 /* Finally free the old domain */
386 XFREE(MTYPE_OSPF_PCE_PARAMS
, old
);
390 static void set_pce_neighbor(uint16_t type
, uint32_t domain
,
391 struct ospf_pce_info
*pce
)
394 struct ri_pce_subtlv_neighbor
*new;
396 /* Create new neighbor info */
397 new = XCALLOC(MTYPE_OSPF_PCE_PARAMS
,
398 sizeof(struct ri_pce_subtlv_neighbor
));
400 new->header
.type
= htons(RI_PCE_SUBTLV_NEIGHBOR
);
401 new->header
.length
= htons(PCE_ADDRESS_LENGTH_IPV4
);
402 new->type
= htons(type
);
403 new->value
= htonl(domain
);
405 /* Add new domain to the list */
406 listnode_add(pce
->pce_neighbor
, new);
411 static void unset_pce_neighbor(uint16_t type
, uint32_t domain
,
412 struct ospf_pce_info
*pce
)
414 struct listnode
*node
;
415 struct ri_pce_subtlv_neighbor
*old
= NULL
;
418 /* Search the corresponding node */
419 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, old
)) {
420 if ((old
->type
== htons(type
))
421 && (old
->value
== htonl(domain
))) {
427 /* if found remove it */
429 listnode_delete(pce
->pce_neighbor
, old
);
431 /* Avoid misjudgement in the next lookup. */
432 if (listcount(pce
->pce_neighbor
) == 0)
433 pce
->pce_neighbor
->head
= pce
->pce_neighbor
->tail
=
436 /* Finally free the old domain */
437 XFREE(MTYPE_OSPF_PCE_PARAMS
, old
);
441 static void set_pce_cap_flag(uint32_t cap
, struct ospf_pce_info
*pce
)
444 /* Set PCE Capabilities flag */
445 pce
->pce_cap_flag
.header
.type
= htons(RI_PCE_SUBTLV_CAP_FLAG
);
446 pce
->pce_cap_flag
.header
.length
= htons(RI_TLV_LENGTH
);
447 pce
->pce_cap_flag
.value
= htonl(cap
);
452 /* Segment Routing TLV setter */
454 /* Algorithm SubTLV - section 3.1 */
455 static void set_sr_algorithm(uint8_t algo
)
458 OspfRI
.sr_info
.algo
.value
[0] = algo
;
459 for (int i
= 1; i
< ALGORITHM_COUNT
; i
++)
460 OspfRI
.sr_info
.algo
.value
[i
] = SR_ALGORITHM_UNSET
;
462 /* Set TLV type and length == only 1 Algorithm */
463 TLV_TYPE(OspfRI
.sr_info
.algo
) = htons(RI_SR_TLV_SR_ALGORITHM
);
464 TLV_LEN(OspfRI
.sr_info
.algo
) = htons(sizeof(uint8_t));
467 /* unset Aglogithm SubTLV */
468 static void unset_sr_algorithm(uint8_t algo
)
471 for (int i
= 0; i
< ALGORITHM_COUNT
; i
++)
472 OspfRI
.sr_info
.algo
.value
[i
] = SR_ALGORITHM_UNSET
;
474 /* Unset TLV type and length */
475 TLV_TYPE(OspfRI
.sr_info
.algo
) = htons(0);
476 TLV_LEN(OspfRI
.sr_info
.algo
) = htons(0);
479 /* Segment Routing Global Block SubTLV - section 3.2 */
480 static void set_sr_sid_label_range(struct sr_srgb srgb
)
483 TLV_TYPE(OspfRI
.sr_info
.range
) = htons(RI_SR_TLV_SID_LABEL_RANGE
);
484 TLV_LEN(OspfRI
.sr_info
.range
) =
485 htons(SUBTLV_SID_LABEL_SIZE
+ sizeof(uint32_t));
487 OspfRI
.sr_info
.range
.size
= htonl(SET_RANGE_SIZE(srgb
.range_size
));
488 /* Set Lower bound label SubTLV */
489 TLV_TYPE(OspfRI
.sr_info
.range
.lower
) = htons(SUBTLV_SID_LABEL
);
490 TLV_LEN(OspfRI
.sr_info
.range
.lower
) = htons(SID_RANGE_LABEL_LENGTH
);
491 OspfRI
.sr_info
.range
.lower
.value
= htonl(SET_LABEL(srgb
.lower_bound
));
494 /* Unset this SRGB SubTLV */
495 static void unset_sr_sid_label_range(void)
498 TLV_TYPE(OspfRI
.sr_info
.range
) = htons(0);
499 TLV_LEN(OspfRI
.sr_info
.range
) = htons(0);
500 TLV_TYPE(OspfRI
.sr_info
.range
.lower
) = htons(0);
501 TLV_LEN(OspfRI
.sr_info
.range
.lower
) = htons(0);
504 /* Set Maximum Stack Depth for this router */
505 static void set_sr_node_msd(uint8_t msd
)
507 TLV_TYPE(OspfRI
.sr_info
.msd
) = htons(RI_SR_TLV_NODE_MSD
);
508 TLV_LEN(OspfRI
.sr_info
.msd
) = htons(sizeof(uint32_t));
509 OspfRI
.sr_info
.msd
.value
= msd
;
512 /* Unset this router MSD */
513 static void unset_sr_node_msd(void)
515 TLV_TYPE(OspfRI
.sr_info
.msd
) = htons(0);
516 TLV_LEN(OspfRI
.sr_info
.msd
) = htons(0);
519 static void unset_param(void *tlv_buffer
)
521 struct tlv_header
*tlv
= (struct tlv_header
*)tlv_buffer
;
524 /* Fill the Value to 0 */
525 memset(TLV_DATA(tlv_buffer
), 0, TLV_BODY_SIZE(tlv
));
531 static void initialize_params(struct ospf_router_info
*ori
)
537 * Initialize default Router Information Capabilities.
541 set_router_info_capabilities(&ori
->router_cap
, cap
);
543 /* If Area address is not null and exist, retrieve corresponding
545 top
= ospf_lookup_by_vrf_id(VRF_DEFAULT
);
546 zlog_info("RI-> Initialize Router Info for %s scope within area %s",
547 OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
? "Area" : "AS",
548 inet_ntoa(OspfRI
.area_id
));
550 /* Try to get the Area context at this step. Do it latter if not
552 if ((OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
) && (OspfRI
.area
== NULL
))
553 OspfRI
.area
= ospf_area_lookup_by_area_id(top
, OspfRI
.area_id
);
556 * Initialize default PCE Information values
558 /* PCE address == OSPF Router ID */
559 set_pce_address(top
->router_id
, &ori
->pce_info
);
562 cap
= 7; /* Set L, R and Rd bits to one = intra & inter-area path
564 set_pce_path_scope(cap
, &ori
->pce_info
);
566 /* PCE Capabilities */
567 cap
= PCE_CAP_BIDIRECTIONAL
| PCE_CAP_DIVERSE_PATH
| PCE_CAP_OBJECTIVES
568 | PCE_CAP_ADDITIVE
| PCE_CAP_MULTIPLE_REQ
;
569 set_pce_cap_flag(cap
, &ori
->pce_info
);
574 static int is_mandated_params_set(struct ospf_router_info ori
)
578 if (ntohs(ori
.router_cap
.header
.type
) == 0)
581 if ((ntohs(ori
.pce_info
.pce_header
.header
.type
) == RI_TLV_PCE
)
582 && (ntohs(ori
.pce_info
.pce_address
.header
.type
) == 0)
583 && (ntohs(ori
.pce_info
.pce_cap_flag
.header
.type
) == 0))
586 if ((ori
.sr_info
.enabled
) && (ntohs(TLV_TYPE(ori
.sr_info
.algo
)) == 0)
587 && (ntohs(TLV_TYPE(ori
.sr_info
.range
)) == 0))
596 * Used by Segment Routing to set new TLVs and Sub-TLVs values
598 * @param enable To activate or not Segment Routing router Information flooding
599 * @param size Size of Label Range i.e. SRGB size
600 * @param lower Lower bound of the Label Range i.e. SRGB first label
601 * @param msd Maximum label Stack Depth suported by the router
605 void ospf_router_info_update_sr(bool enable
, struct sr_srgb srgb
, uint8_t msd
)
608 /* First activate and initialize Router Information is necessary */
609 if (!OspfRI
.enabled
) {
610 OspfRI
.enabled
= true;
611 initialize_params(&OspfRI
);
614 if (IS_DEBUG_OSPF_SR
)
615 zlog_debug("RI-> %s Routing Information for Segment Routing",
616 enable
? "Enable" : "Disable");
618 /* Unset or Set SR parameters */
620 unset_sr_algorithm(SR_ALGORITHM_SPF
);
621 unset_sr_sid_label_range();
623 OspfRI
.sr_info
.enabled
= false;
625 // Only SR_ALGORITHM_SPF is supported
626 set_sr_algorithm(SR_ALGORITHM_SPF
);
627 set_sr_sid_label_range(srgb
);
629 set_sr_node_msd(msd
);
632 OspfRI
.sr_info
.enabled
= true;
635 /* Refresh if already engaged or originate RI LSA */
636 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
637 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
639 ospf_router_info_lsa_schedule(REORIGINATE_THIS_LSA
);
642 /*------------------------------------------------------------------------*
643 * Followings are callback functions against generic Opaque-LSAs handling.
644 *------------------------------------------------------------------------*/
645 static void ospf_router_info_ism_change(struct ospf_interface
*oi
,
648 /* So far, nothing to do here. */
652 static void ospf_router_info_nsm_change(struct ospf_neighbor
*nbr
,
655 /* So far, nothing to do here. */
659 /*------------------------------------------------------------------------*
660 * Followings are OSPF protocol processing functions for ROUTER INFORMATION
661 *------------------------------------------------------------------------*/
663 static void build_tlv_header(struct stream
*s
, struct tlv_header
*tlvh
)
666 stream_put(s
, tlvh
, sizeof(struct tlv_header
));
670 static void build_tlv(struct stream
*s
, struct tlv_header
*tlvh
)
673 if (ntohs(tlvh
->type
) != 0) {
674 build_tlv_header(s
, tlvh
);
675 stream_put(s
, TLV_DATA(tlvh
), TLV_BODY_SIZE(tlvh
));
680 static void ospf_router_info_lsa_body_set(struct stream
*s
)
683 struct listnode
*node
;
684 struct ri_pce_subtlv_domain
*domain
;
685 struct ri_pce_subtlv_neighbor
*neighbor
;
687 /* Build Router Information TLV */
688 build_tlv(s
, &OspfRI
.router_cap
.header
);
690 /* Build Segment Routing TLVs if enabled */
691 if (OspfRI
.sr_info
.enabled
) {
692 /* Build Algorithm TLV */
693 build_tlv(s
, &TLV_HDR(OspfRI
.sr_info
.algo
));
695 build_tlv(s
, &TLV_HDR(OspfRI
.sr_info
.range
));
697 build_tlv(s
, &TLV_HDR(OspfRI
.sr_info
.msd
));
700 /* Add RI PCE TLV if it is set */
701 if (OspfRI
.pce_info
.enabled
) {
703 /* Compute PCE Info header first */
704 set_pce_header(&OspfRI
.pce_info
);
707 build_tlv_header(s
, &OspfRI
.pce_info
.pce_header
.header
);
709 /* Build PCE address sub-tlv */
710 build_tlv(s
, &OspfRI
.pce_info
.pce_address
.header
);
712 /* Build PCE path scope sub-tlv */
713 build_tlv(s
, &OspfRI
.pce_info
.pce_scope
.header
);
715 /* Build PCE domain sub-tlv */
716 for (ALL_LIST_ELEMENTS_RO(OspfRI
.pce_info
.pce_domain
, node
,
718 build_tlv(s
, &domain
->header
);
720 /* Build PCE neighbor sub-tlv */
721 for (ALL_LIST_ELEMENTS_RO(OspfRI
.pce_info
.pce_neighbor
, node
,
723 build_tlv(s
, &neighbor
->header
);
725 /* Build PCE cap flag sub-tlv */
726 build_tlv(s
, &OspfRI
.pce_info
.pce_cap_flag
.header
);
732 /* Create new opaque-LSA. */
733 static struct ospf_lsa
*ospf_router_info_lsa_new()
737 struct lsa_header
*lsah
;
738 struct ospf_lsa
*new = NULL
;
739 uint8_t options
, lsa_type
;
740 struct in_addr lsa_id
;
744 /* Create a stream for LSA. */
745 if ((s
= stream_new(OSPF_MAX_LSA_SIZE
)) == NULL
) {
746 zlog_warn("ospf_router_info_lsa_new: stream_new() ?");
749 lsah
= (struct lsa_header
*)STREAM_DATA(s
);
751 options
= OSPF_OPTION_E
; /* Enable AS external as we flood RI with
753 options
|= OSPF_OPTION_O
; /* Don't forget this :-) */
755 lsa_type
= OspfRI
.scope
;
756 /* LSA ID == 0 for Router Information see RFC 4970 */
757 tmp
= SET_OPAQUE_LSID(OPAQUE_TYPE_ROUTER_INFORMATION_LSA
, 0);
758 lsa_id
.s_addr
= htonl(tmp
);
760 if (IS_DEBUG_OSPF(lsa
, LSA_GENERATE
))
762 "LSA[Type%d:%s]: Create an Opaque-LSA/ROUTER INFORMATION instance",
763 lsa_type
, inet_ntoa(lsa_id
));
765 top
= ospf_lookup_by_vrf_id(VRF_DEFAULT
);
767 /* Set opaque-LSA header fields. */
768 lsa_header_set(s
, options
, lsa_type
, lsa_id
, top
->router_id
);
770 /* Set opaque-LSA body fields. */
771 ospf_router_info_lsa_body_set(s
);
774 length
= stream_get_endp(s
);
775 lsah
->length
= htons(length
);
777 /* Now, create an OSPF LSA instance. */
778 if ((new = ospf_lsa_new()) == NULL
) {
779 zlog_warn("ospf_router_info_lsa_new: ospf_lsa_new() ?");
783 if ((new->data
= ospf_lsa_data_new(length
)) == NULL
) {
784 zlog_warn("ospf_router_info_lsa_new: ospf_lsa_data_new() ?");
785 ospf_lsa_unlock(&new);
791 new->area
= OspfRI
.area
; /* Area must be null if the Opaque type is AS
792 scope, fulfill otherwise */
794 if (new->area
&& new->area
->ospf
)
795 new->vrf_id
= new->area
->ospf
->vrf_id
;
797 new->vrf_id
= VRF_DEFAULT
;
799 SET_FLAG(new->flags
, OSPF_LSA_SELF
);
800 memcpy(new->data
, lsah
, length
);
806 static int ospf_router_info_lsa_originate1(void *arg
)
808 struct ospf_lsa
*new;
810 struct ospf_area
*area
;
812 vrf_id_t vrf_id
= VRF_DEFAULT
;
814 /* First check if the area is known if flooding scope is Area */
815 if (OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
) {
816 area
= (struct ospf_area
*)arg
;
817 if (area
->area_id
.s_addr
!= OspfRI
.area_id
.s_addr
) {
819 "RI -> This is not the Router Information Area. Stop processing");
824 vrf_id
= area
->ospf
->vrf_id
;
827 /* Create new Opaque-LSA/ROUTER INFORMATION instance. */
828 if ((new = ospf_router_info_lsa_new()) == NULL
) {
830 "ospf_router_info_lsa_originate1: ospf_router_info_lsa_new() ?");
833 new->vrf_id
= vrf_id
;
836 top
= ospf_lookup_by_vrf_id(vrf_id
);
838 zlog_debug("%s: ospf instance not found for vrf id %u",
839 __PRETTY_FUNCTION__
, vrf_id
);
840 ospf_lsa_unlock(&new);
844 /* Install this LSA into LSDB. */
845 if (ospf_lsa_install(top
, NULL
/*oi */, new) == NULL
) {
847 "ospf_router_info_lsa_originate1: ospf_lsa_install() ?");
848 ospf_lsa_unlock(&new);
852 /* Now this Router Info parameter entry has associated LSA. */
853 SET_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
);
855 /* Update new LSA origination count. */
856 top
->lsa_originate_count
++;
858 /* Flood new LSA through AS. */
859 if (OspfRI
.scope
== OSPF_OPAQUE_AS_LSA
)
860 ospf_flood_through_as(top
, NULL
/*nbr */, new);
862 ospf_flood_through_area(OspfRI
.area
, NULL
/*nbr */, new);
864 if (IS_DEBUG_OSPF(lsa
, LSA_GENERATE
)) {
866 "LSA[Type%d:%s]: Originate Opaque-LSA/ROUTER INFORMATION",
867 new->data
->type
, inet_ntoa(new->data
->id
));
868 ospf_lsa_header_dump(new->data
);
875 static int ospf_router_info_lsa_originate(void *arg
)
880 if (!OspfRI
.enabled
) {
882 "ospf_router_info_lsa_originate: ROUTER INFORMATION is disabled now.");
883 rc
= 0; /* This is not an error case. */
887 /* Check if Router Information LSA is already engaged */
888 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
)) {
889 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_FORCED_REFRESH
)) {
890 UNSET_FLAG(OspfRI
.flags
, RIFLG_LSA_FORCED_REFRESH
);
891 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
894 if (!is_mandated_params_set(OspfRI
))
896 "ospf_router_info_lsa_originate: lacks mandated ROUTER INFORMATION parameters");
898 /* Ok, let's try to originate an LSA */
899 if (ospf_router_info_lsa_originate1(arg
) != 0)
907 static struct ospf_lsa
*ospf_router_info_lsa_refresh(struct ospf_lsa
*lsa
)
909 struct ospf_lsa
*new = NULL
;
912 if (!OspfRI
.enabled
) {
914 * This LSA must have flushed before due to ROUTER INFORMATION
916 * It seems a slip among routers in the routing domain.
919 "ospf_router_info_lsa_refresh: ROUTER INFORMATION is disabled now.");
921 htons(OSPF_LSA_MAXAGE
); /* Flush it anyway. */
924 /* Verify that the Router Information ID is supported */
925 if (GET_OPAQUE_ID(ntohl(lsa
->data
->id
.s_addr
)) != 0) {
927 "ospf_router_info_lsa_refresh: Unsupported Router Information ID");
931 /* If the lsa's age reached to MaxAge, start flushing procedure. */
932 if (IS_LSA_MAXAGE(lsa
)) {
933 UNSET_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
);
934 ospf_opaque_lsa_flush_schedule(lsa
);
938 /* Create new Opaque-LSA/ROUTER INFORMATION instance. */
939 if ((new = ospf_router_info_lsa_new()) == NULL
) {
941 "ospf_router_info_lsa_refresh: ospf_router_info_lsa_new() ?");
944 new->data
->ls_seqnum
= lsa_seqnum_increment(lsa
);
945 new->vrf_id
= lsa
->vrf_id
;
947 /* Install this LSA into LSDB. */
948 /* Given "lsa" will be freed in the next function. */
949 top
= ospf_lookup_by_vrf_id(lsa
->vrf_id
);
950 if (ospf_lsa_install(top
, NULL
/*oi */, new) == NULL
) {
951 zlog_warn("ospf_router_info_lsa_refresh: ospf_lsa_install() ?");
952 ospf_lsa_unlock(&new);
956 /* Flood updated LSA through AS or AREA depending of OspfRI.scope. */
957 if (OspfRI
.scope
== OSPF_OPAQUE_AS_LSA
)
958 ospf_flood_through_as(top
, NULL
/*nbr */, new);
960 ospf_flood_through_area(OspfRI
.area
, NULL
/*nbr */, new);
963 if (IS_DEBUG_OSPF(lsa
, LSA_GENERATE
)) {
965 "LSA[Type%d:%s]: Refresh Opaque-LSA/ROUTER INFORMATION",
966 new->data
->type
, inet_ntoa(new->data
->id
));
967 ospf_lsa_header_dump(new->data
);
973 static void ospf_router_info_lsa_schedule(enum lsa_opcode opcode
)
976 struct lsa_header lsah
;
980 memset(&lsa
, 0, sizeof(lsa
));
981 memset(&lsah
, 0, sizeof(lsah
));
983 zlog_debug("RI-> LSA schedule %s%s%s",
984 opcode
== REORIGINATE_THIS_LSA
? "Re-Originate" : "",
985 opcode
== REFRESH_THIS_LSA
? "Refresh" : "",
986 opcode
== FLUSH_THIS_LSA
? "Flush" : "");
988 /* Check LSA flags state coherence */
989 if (!CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
)
990 && (opcode
!= REORIGINATE_THIS_LSA
))
993 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
)
994 && (opcode
== REORIGINATE_THIS_LSA
))
995 opcode
= REFRESH_THIS_LSA
;
997 top
= ospf_lookup_by_vrf_id(VRF_DEFAULT
);
998 if ((OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
) && (OspfRI
.area
== NULL
)) {
1000 "ospf_router_info_lsa_schedule(): Router Info is Area scope flooding but area is not set");
1001 OspfRI
.area
= ospf_area_lookup_by_area_id(top
, OspfRI
.area_id
);
1003 lsa
.area
= OspfRI
.area
;
1005 lsah
.type
= OspfRI
.scope
;
1007 /* LSA ID is set to 0 for the Router Information. See RFC 4970 */
1008 tmp
= SET_OPAQUE_LSID(OPAQUE_TYPE_ROUTER_INFORMATION_LSA
, 0);
1009 lsah
.id
.s_addr
= htonl(tmp
);
1012 case REORIGINATE_THIS_LSA
:
1013 if (OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
)
1014 ospf_opaque_lsa_reoriginate_schedule(
1015 (void *)OspfRI
.area
, OSPF_OPAQUE_AREA_LSA
,
1016 OPAQUE_TYPE_ROUTER_INFORMATION_LSA
);
1018 ospf_opaque_lsa_reoriginate_schedule(
1019 (void *)top
, OSPF_OPAQUE_AS_LSA
,
1020 OPAQUE_TYPE_ROUTER_INFORMATION_LSA
);
1022 case REFRESH_THIS_LSA
:
1023 ospf_opaque_lsa_refresh_schedule(&lsa
);
1025 case FLUSH_THIS_LSA
:
1026 UNSET_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
);
1027 ospf_opaque_lsa_flush_schedule(&lsa
);
1030 zlog_warn("ospf_router_info_lsa_schedule: Unknown opcode (%u)",
1038 /* Callback to handle Segment Routing information */
1039 static int ospf_router_info_lsa_update(struct ospf_lsa
*lsa
)
1044 zlog_warn("OSPF-RI (%s): Abort! LSA is NULL", __func__
);
1048 /* Process only Opaque LSA */
1049 if ((lsa
->data
->type
!= OSPF_OPAQUE_AREA_LSA
)
1050 && (lsa
->data
->type
!= OSPF_OPAQUE_AS_LSA
))
1053 /* Process only Router Information LSA */
1054 if (GET_OPAQUE_TYPE(ntohl(lsa
->data
->id
.s_addr
))
1055 != OPAQUE_TYPE_ROUTER_INFORMATION_LSA
)
1058 /* Check if it is not my LSA */
1059 if (IS_LSA_SELF(lsa
))
1062 /* Check if Router Info & Segment Routing are enable */
1063 if (!OspfRI
.enabled
|| !OspfRI
.sr_info
.enabled
)
1066 /* Call Segment Routing LSA update or deletion */
1067 if (!IS_LSA_MAXAGE(lsa
))
1068 ospf_sr_ri_lsa_update(lsa
);
1070 ospf_sr_ri_lsa_delete(lsa
);
1075 /*------------------------------------------------------------------------*
1076 * Followings are vty session control functions.
1077 *------------------------------------------------------------------------*/
1079 static uint16_t show_vty_router_cap(struct vty
*vty
, struct tlv_header
*tlvh
)
1081 struct ri_tlv_router_cap
*top
= (struct ri_tlv_router_cap
*)tlvh
;
1084 vty_out(vty
, " Router Capabilities: 0x%x\n",
1087 zlog_debug(" Router Capabilities: 0x%x", ntohl(top
->value
));
1089 return TLV_SIZE(tlvh
);
1092 static uint16_t show_vty_pce_subtlv_address(struct vty
*vty
,
1093 struct tlv_header
*tlvh
)
1095 struct ri_pce_subtlv_address
*top
=
1096 (struct ri_pce_subtlv_address
*)tlvh
;
1098 if (ntohs(top
->address
.type
) == PCE_ADDRESS_TYPE_IPV4
) {
1100 vty_out(vty
, " PCE Address: %s\n",
1101 inet_ntoa(top
->address
.value
));
1103 zlog_debug(" PCE Address: %s",
1104 inet_ntoa(top
->address
.value
));
1106 /* TODO: Add support to IPv6 with inet_ntop() */
1108 vty_out(vty
, " PCE Address: 0x%x\n",
1109 ntohl(top
->address
.value
.s_addr
));
1111 zlog_debug(" PCE Address: 0x%x",
1112 ntohl(top
->address
.value
.s_addr
));
1115 return TLV_SIZE(tlvh
);
1118 static uint16_t show_vty_pce_subtlv_path_scope(struct vty
*vty
,
1119 struct tlv_header
*tlvh
)
1121 struct ri_pce_subtlv_path_scope
*top
=
1122 (struct ri_pce_subtlv_path_scope
*)tlvh
;
1125 vty_out(vty
, " PCE Path Scope: 0x%x\n", ntohl(top
->value
));
1127 zlog_debug(" PCE Path Scope: 0x%x", ntohl(top
->value
));
1129 return TLV_SIZE(tlvh
);
1132 static uint16_t show_vty_pce_subtlv_domain(struct vty
*vty
,
1133 struct tlv_header
*tlvh
)
1135 struct ri_pce_subtlv_domain
*top
= (struct ri_pce_subtlv_domain
*)tlvh
;
1138 if (ntohs(top
->type
) == PCE_DOMAIN_TYPE_AREA
) {
1139 tmp
.s_addr
= top
->value
;
1141 vty_out(vty
, " PCE domain Area: %s\n", inet_ntoa(tmp
));
1143 zlog_debug(" PCE domain Area: %s", inet_ntoa(tmp
));
1146 vty_out(vty
, " PCE domain AS: %d\n",
1149 zlog_debug(" PCE domain AS: %d", ntohl(top
->value
));
1151 return TLV_SIZE(tlvh
);
1154 static uint16_t show_vty_pce_subtlv_neighbor(struct vty
*vty
,
1155 struct tlv_header
*tlvh
)
1158 struct ri_pce_subtlv_neighbor
*top
=
1159 (struct ri_pce_subtlv_neighbor
*)tlvh
;
1162 if (ntohs(top
->type
) == PCE_DOMAIN_TYPE_AREA
) {
1163 tmp
.s_addr
= top
->value
;
1165 vty_out(vty
, " PCE neighbor Area: %s\n",
1168 zlog_debug(" PCE neighbor Area: %s", inet_ntoa(tmp
));
1171 vty_out(vty
, " PCE neighbor AS: %d\n",
1174 zlog_debug(" PCE neighbor AS: %d",
1177 return TLV_SIZE(tlvh
);
1180 static uint16_t show_vty_pce_subtlv_cap_flag(struct vty
*vty
,
1181 struct tlv_header
*tlvh
)
1183 struct ri_pce_subtlv_cap_flag
*top
=
1184 (struct ri_pce_subtlv_cap_flag
*)tlvh
;
1187 vty_out(vty
, " PCE Capabilities Flag: 0x%x\n",
1190 zlog_debug(" PCE Capabilities Flag: 0x%x",
1193 return TLV_SIZE(tlvh
);
1196 static uint16_t show_vty_unknown_tlv(struct vty
*vty
, struct tlv_header
*tlvh
)
1199 vty_out(vty
, " Unknown TLV: [type(0x%x), length(0x%x)]\n",
1200 ntohs(tlvh
->type
), ntohs(tlvh
->length
));
1202 zlog_debug(" Unknown TLV: [type(0x%x), length(0x%x)]",
1203 ntohs(tlvh
->type
), ntohs(tlvh
->length
));
1205 return TLV_SIZE(tlvh
);
1208 static uint16_t show_vty_pce_info(struct vty
*vty
, struct tlv_header
*ri
,
1211 struct tlv_header
*tlvh
;
1214 for (tlvh
= ri
; sum
< total
; tlvh
= TLV_HDR_NEXT(tlvh
)) {
1215 switch (ntohs(tlvh
->type
)) {
1216 case RI_PCE_SUBTLV_ADDRESS
:
1217 sum
+= show_vty_pce_subtlv_address(vty
, tlvh
);
1219 case RI_PCE_SUBTLV_PATH_SCOPE
:
1220 sum
+= show_vty_pce_subtlv_path_scope(vty
, tlvh
);
1222 case RI_PCE_SUBTLV_DOMAIN
:
1223 sum
+= show_vty_pce_subtlv_domain(vty
, tlvh
);
1225 case RI_PCE_SUBTLV_NEIGHBOR
:
1226 sum
+= show_vty_pce_subtlv_neighbor(vty
, tlvh
);
1228 case RI_PCE_SUBTLV_CAP_FLAG
:
1229 sum
+= show_vty_pce_subtlv_cap_flag(vty
, tlvh
);
1232 sum
+= show_vty_unknown_tlv(vty
, tlvh
);
1239 /* Display Segment Routing Algorithm TLV information */
1240 static uint16_t show_vty_sr_algorithm(struct vty
*vty
, struct tlv_header
*tlvh
)
1242 struct ri_sr_tlv_sr_algorithm
*algo
=
1243 (struct ri_sr_tlv_sr_algorithm
*)tlvh
;
1247 vty_out(vty
, " Segment Routing Algorithm TLV:\n");
1248 for (i
= 0; i
< ntohs(algo
->header
.length
); i
++) {
1249 switch (algo
->value
[i
]) {
1251 vty_out(vty
, " Algorithm %d: SPF\n", i
);
1254 vty_out(vty
, " Algorithm %d: Strict SPF\n",
1259 " Algorithm %d: Unknown value %d\n", i
,
1267 zlog_debug(" Segment Routing Algorithm TLV:\n");
1268 for (i
= 0; i
< ntohs(algo
->header
.length
); i
++)
1269 switch (algo
->value
[i
]) {
1271 zlog_debug(" Algorithm %d: SPF\n", i
);
1274 zlog_debug(" Algorithm %d: Strict SPF\n", i
);
1278 " Algorithm %d: Unknown value %d\n",
1284 return TLV_SIZE(tlvh
);
1287 /* Display Segment Routing SID/Label Range TLV information */
1288 static uint16_t show_vty_sr_range(struct vty
*vty
, struct tlv_header
*tlvh
)
1290 struct ri_sr_tlv_sid_label_range
*range
=
1291 (struct ri_sr_tlv_sid_label_range
*)tlvh
;
1295 " Segment Routing Range TLV:\n"
1296 " Range Size = %d\n"
1297 " SID Label = %d\n\n",
1298 GET_RANGE_SIZE(ntohl(range
->size
)),
1299 GET_LABEL(ntohl(range
->lower
.value
)));
1302 " Segment Routing Range TLV:\n"
1303 " Range Size = %d\n"
1304 " SID Label = %d\n\n",
1305 GET_RANGE_SIZE(ntohl(range
->size
)),
1306 GET_LABEL(ntohl(range
->lower
.value
)));
1309 return TLV_SIZE(tlvh
);
1312 /* Display Segment Routing Maximum Stack Depth TLV information */
1313 static uint16_t show_vty_sr_msd(struct vty
*vty
, struct tlv_header
*tlvh
)
1315 struct ri_sr_tlv_node_msd
*msd
= (struct ri_sr_tlv_node_msd
*)tlvh
;
1319 " Segment Routing MSD TLV:\n"
1320 " Node Maximum Stack Depth = %d\n",
1324 " Segment Routing MSD TLV:\n"
1325 " Node Maximum Stack Depth = %d\n",
1329 return TLV_SIZE(tlvh
);
1332 static void ospf_router_info_show_info(struct vty
*vty
, struct ospf_lsa
*lsa
)
1334 struct lsa_header
*lsah
= (struct lsa_header
*)lsa
->data
;
1335 struct tlv_header
*tlvh
;
1336 uint16_t length
= 0, sum
= 0;
1338 /* Initialize TLV browsing */
1339 length
= ntohs(lsah
->length
) - OSPF_LSA_HEADER_SIZE
;
1341 for (tlvh
= TLV_HDR_TOP(lsah
); sum
< length
;
1342 tlvh
= TLV_HDR_NEXT(tlvh
)) {
1343 switch (ntohs(tlvh
->type
)) {
1344 case RI_TLV_CAPABILITIES
:
1345 sum
+= show_vty_router_cap(vty
, tlvh
);
1349 sum
+= TLV_HDR_SIZE
;
1350 sum
+= show_vty_pce_info(vty
, tlvh
, length
- sum
);
1352 case RI_SR_TLV_SR_ALGORITHM
:
1353 sum
+= show_vty_sr_algorithm(vty
, tlvh
);
1355 case RI_SR_TLV_SID_LABEL_RANGE
:
1356 sum
+= show_vty_sr_range(vty
, tlvh
);
1358 case RI_SR_TLV_NODE_MSD
:
1359 sum
+= show_vty_sr_msd(vty
, tlvh
);
1363 sum
+= show_vty_unknown_tlv(vty
, tlvh
);
1371 static void ospf_router_info_config_write_router(struct vty
*vty
)
1373 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1374 struct listnode
*node
;
1375 struct ri_pce_subtlv_domain
*domain
;
1376 struct ri_pce_subtlv_neighbor
*neighbor
;
1379 if (!OspfRI
.enabled
)
1382 if (OspfRI
.scope
== OSPF_OPAQUE_AS_LSA
)
1383 vty_out(vty
, " router-info as\n");
1385 vty_out(vty
, " router-info area %s\n",
1386 inet_ntoa(OspfRI
.area_id
));
1388 if (OspfRI
.pce_info
.enabled
) {
1390 if (pce
->pce_address
.header
.type
!= 0)
1391 vty_out(vty
, " pce address %s\n",
1392 inet_ntoa(pce
->pce_address
.address
.value
));
1394 if (pce
->pce_cap_flag
.header
.type
!= 0)
1395 vty_out(vty
, " pce flag 0x%x\n",
1396 ntohl(pce
->pce_cap_flag
.value
));
1398 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, domain
)) {
1399 if (domain
->header
.type
!= 0) {
1400 if (domain
->type
== PCE_DOMAIN_TYPE_AREA
) {
1401 tmp
.s_addr
= domain
->value
;
1402 vty_out(vty
, " pce domain area %s\n",
1405 vty_out(vty
, " pce domain as %d\n",
1406 ntohl(domain
->value
));
1411 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, neighbor
)) {
1412 if (neighbor
->header
.type
!= 0) {
1413 if (neighbor
->type
== PCE_DOMAIN_TYPE_AREA
) {
1414 tmp
.s_addr
= neighbor
->value
;
1415 vty_out(vty
, " pce neighbor area %s\n",
1418 vty_out(vty
, " pce neighbor as %d\n",
1419 ntohl(neighbor
->value
));
1424 if (pce
->pce_scope
.header
.type
!= 0)
1425 vty_out(vty
, " pce scope 0x%x\n",
1426 ntohl(OspfRI
.pce_info
.pce_scope
.value
));
1431 /*------------------------------------------------------------------------*
1432 * Followings are vty command functions.
1433 *------------------------------------------------------------------------*/
1436 router_info_area_cmd
,
1437 "router-info <as|area A.B.C.D>",
1439 "Enable the Router Information functionality with AS flooding scope\n"
1440 "Enable the Router Information functionality with Area flooding scope\n"
1441 "OSPF area ID in IP format\n")
1444 char *area
= (argc
== 3) ? argv
[idx_ipv4
]->arg
: NULL
;
1451 /* Check and get Area value if present */
1453 if (!inet_aton(area
, &OspfRI
.area_id
)) {
1454 vty_out(vty
, "%% specified Area ID %s is invalid\n",
1456 return CMD_WARNING_CONFIG_FAILED
;
1458 scope
= OSPF_OPAQUE_AREA_LSA
;
1460 OspfRI
.area_id
.s_addr
= 0;
1461 scope
= OSPF_OPAQUE_AS_LSA
;
1464 /* First start to register Router Information callbacks */
1465 if ((ospf_router_info_register(scope
)) != 0) {
1467 "Unable to register Router Information callbacks. Abort!");
1468 return CMD_WARNING_CONFIG_FAILED
;
1471 OspfRI
.enabled
= true;
1473 if (IS_DEBUG_OSPF_EVENT
)
1474 zlog_debug("RI-> Router Information (%s flooding): OFF -> ON",
1475 OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
? "Area"
1479 * Following code is intended to handle two cases;
1481 * 1) Router Information was disabled at startup time, but now become
1483 * 2) Router Information was once enabled then disabled, and now enabled
1487 initialize_params(&OspfRI
);
1489 /* Refresh RI LSA if already engaged */
1490 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
)) {
1491 zlog_debug("RI-> Refresh LSA following configuration");
1492 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1494 zlog_debug("RI-> Initial origination following configuration");
1495 ospf_router_info_lsa_schedule(REORIGINATE_THIS_LSA
);
1501 DEFUN (no_router_info
,
1505 "Disable the Router Information functionality\n")
1508 if (!OspfRI
.enabled
)
1511 if (IS_DEBUG_OSPF_EVENT
)
1512 zlog_debug("RI-> Router Information: ON -> OFF");
1514 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1515 ospf_router_info_lsa_schedule(FLUSH_THIS_LSA
);
1517 OspfRI
.enabled
= false;
1522 static int ospf_ri_enabled(struct vty
*vty
)
1528 vty_out(vty
, "%% OSPF RI is not turned on\n");
1535 "pce address A.B.C.D",
1537 "Stable IP address of the PCE\n"
1538 "PCE address in IPv4 address format\n")
1541 struct in_addr value
;
1542 struct ospf_pce_info
*pi
= &OspfRI
.pce_info
;
1544 if (!ospf_ri_enabled(vty
))
1545 return CMD_WARNING_CONFIG_FAILED
;
1547 if (!inet_aton(argv
[idx_ipv4
]->arg
, &value
)) {
1548 vty_out(vty
, "Please specify PCE Address by A.B.C.D\n");
1549 return CMD_WARNING_CONFIG_FAILED
;
1552 if (ntohs(pi
->pce_address
.header
.type
) == 0
1553 || ntohl(pi
->pce_address
.address
.value
.s_addr
)
1554 != ntohl(value
.s_addr
)) {
1556 set_pce_address(value
, pi
);
1558 /* Refresh RI LSA if already engaged */
1559 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1560 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1566 DEFUN (no_pce_address
,
1568 "no pce address [A.B.C.D]",
1571 "Disable PCE address\n"
1572 "PCE address in IPv4 address format\n")
1575 unset_param(&OspfRI
.pce_info
.pce_address
);
1577 /* Refresh RI LSA if already engaged */
1578 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1579 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1584 DEFUN (pce_path_scope
,
1586 "pce scope BITPATTERN",
1588 "Path scope visibilities of the PCE for path computation\n"
1589 "32-bit Hexadecimal value\n")
1591 int idx_bitpattern
= 2;
1593 struct ospf_pce_info
*pi
= &OspfRI
.pce_info
;
1595 if (!ospf_ri_enabled(vty
))
1596 return CMD_WARNING_CONFIG_FAILED
;
1598 if (sscanf(argv
[idx_bitpattern
]->arg
, "0x%x", &scope
) != 1) {
1599 vty_out(vty
, "pce_path_scope: fscanf: %s\n",
1600 safe_strerror(errno
));
1601 return CMD_WARNING_CONFIG_FAILED
;
1604 if (ntohl(pi
->pce_scope
.header
.type
) == 0
1605 || scope
!= pi
->pce_scope
.value
) {
1606 set_pce_path_scope(scope
, pi
);
1608 /* Refresh RI LSA if already engaged */
1609 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1610 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1616 DEFUN (no_pce_path_scope
,
1617 no_pce_path_scope_cmd
,
1618 "no pce scope [BITPATTERN]",
1621 "Disable PCE path scope\n"
1622 "32-bit Hexadecimal value\n")
1625 unset_param(&OspfRI
.pce_info
.pce_address
);
1627 /* Refresh RI LSA if already engaged */
1628 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1629 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1636 "pce domain as (0-65535)",
1638 "Configure PCE domain AS number\n"
1639 "AS number where the PCE as visibilities for path computation\n"
1640 "AS number in decimal <0-65535>\n")
1645 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1646 struct listnode
*node
;
1647 struct ri_pce_subtlv_domain
*domain
;
1649 if (!ospf_ri_enabled(vty
))
1650 return CMD_WARNING_CONFIG_FAILED
;
1652 if (sscanf(argv
[idx_number
]->arg
, "%" SCNu32
, &as
) != 1) {
1653 vty_out(vty
, "pce_domain: fscanf: %s\n", safe_strerror(errno
));
1654 return CMD_WARNING_CONFIG_FAILED
;
1657 /* Check if the domain is not already in the domain list */
1658 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, domain
)) {
1659 if (ntohl(domain
->header
.type
) == 0 && as
== domain
->value
)
1663 /* Create new domain if not found */
1664 set_pce_domain(PCE_DOMAIN_TYPE_AS
, as
, pce
);
1666 /* Refresh RI LSA if already engaged */
1667 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1668 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1673 DEFUN (no_pce_domain
,
1675 "no pce domain as (0-65535)",
1678 "Disable PCE domain AS number\n"
1679 "AS number where the PCE as visibilities for path computation\n"
1680 "AS number in decimal <0-65535>\n")
1685 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1687 if (sscanf(argv
[idx_number
]->arg
, "%" SCNu32
, &as
) != 1) {
1688 vty_out(vty
, "no_pce_domain: fscanf: %s\n",
1689 safe_strerror(errno
));
1690 return CMD_WARNING_CONFIG_FAILED
;
1693 /* Unset corresponding PCE domain */
1694 unset_pce_domain(PCE_DOMAIN_TYPE_AS
, as
, pce
);
1696 /* Refresh RI LSA if already engaged */
1697 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1698 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1703 DEFUN (pce_neigbhor
,
1705 "pce neighbor as (0-65535)",
1707 "Configure PCE neighbor domain AS number\n"
1708 "AS number of PCE neighbors\n"
1709 "AS number in decimal <0-65535>\n")
1714 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1715 struct listnode
*node
;
1716 struct ri_pce_subtlv_neighbor
*neighbor
;
1718 if (!ospf_ri_enabled(vty
))
1719 return CMD_WARNING_CONFIG_FAILED
;
1721 if (sscanf(argv
[idx_number
]->arg
, "%" SCNu32
, &as
) != 1) {
1722 vty_out(vty
, "pce_neighbor: fscanf: %s\n",
1723 safe_strerror(errno
));
1724 return CMD_WARNING_CONFIG_FAILED
;
1727 /* Check if the domain is not already in the domain list */
1728 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, neighbor
)) {
1729 if (ntohl(neighbor
->header
.type
) == 0 && as
== neighbor
->value
)
1733 /* Create new domain if not found */
1734 set_pce_neighbor(PCE_DOMAIN_TYPE_AS
, as
, pce
);
1736 /* Refresh RI LSA if already engaged */
1737 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1738 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1743 DEFUN (no_pce_neighbor
,
1744 no_pce_neighbor_cmd
,
1745 "no pce neighbor as (0-65535)",
1748 "Disable PCE neighbor AS number\n"
1749 "AS number of PCE neighbor\n"
1750 "AS number in decimal <0-65535>\n")
1755 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1757 if (sscanf(argv
[idx_number
]->arg
, "%" SCNu32
, &as
) != 1) {
1758 vty_out(vty
, "no_pce_neighbor: fscanf: %s\n",
1759 safe_strerror(errno
));
1760 return CMD_WARNING_CONFIG_FAILED
;
1763 /* Unset corresponding PCE domain */
1764 unset_pce_neighbor(PCE_DOMAIN_TYPE_AS
, as
, pce
);
1766 /* Refresh RI LSA if already engaged */
1767 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1768 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1773 DEFUN (pce_cap_flag
,
1775 "pce flag BITPATTERN",
1777 "Capabilities of the PCE for path computation\n"
1778 "32-bit Hexadecimal value\n")
1780 int idx_bitpattern
= 2;
1783 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1785 if (!ospf_ri_enabled(vty
))
1786 return CMD_WARNING_CONFIG_FAILED
;
1788 if (sscanf(argv
[idx_bitpattern
]->arg
, "0x%x", &cap
) != 1) {
1789 vty_out(vty
, "pce_cap_flag: fscanf: %s\n",
1790 safe_strerror(errno
));
1791 return CMD_WARNING_CONFIG_FAILED
;
1794 if (ntohl(pce
->pce_cap_flag
.header
.type
) == 0
1795 || cap
!= pce
->pce_cap_flag
.value
) {
1796 set_pce_cap_flag(cap
, pce
);
1798 /* Refresh RI LSA if already engaged */
1799 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1800 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1806 DEFUN (no_pce_cap_flag
,
1807 no_pce_cap_flag_cmd
,
1811 "Disable PCE capabilities\n")
1814 unset_param(&OspfRI
.pce_info
.pce_cap_flag
);
1816 /* Refresh RI LSA if already engaged */
1817 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1818 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1823 DEFUN (show_ip_ospf_router_info
,
1824 show_ip_ospf_router_info_cmd
,
1825 "show ip ospf router-info",
1829 "Router Information\n")
1832 if (OspfRI
.enabled
) {
1833 vty_out(vty
, "--- Router Information parameters ---\n");
1834 show_vty_router_cap(vty
, &OspfRI
.router_cap
.header
);
1838 " Router Information is disabled on this router\n");
1843 DEFUN (show_ip_opsf_router_info_pce
,
1844 show_ip_ospf_router_info_pce_cmd
,
1845 "show ip ospf router-info pce",
1849 "Router Information\n"
1850 "PCE information\n")
1853 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1854 struct listnode
*node
;
1855 struct ri_pce_subtlv_domain
*domain
;
1856 struct ri_pce_subtlv_neighbor
*neighbor
;
1858 if ((OspfRI
.enabled
) && (OspfRI
.pce_info
.enabled
)) {
1859 vty_out(vty
, "--- PCE parameters ---\n");
1861 if (pce
->pce_address
.header
.type
!= 0)
1862 show_vty_pce_subtlv_address(vty
,
1863 &pce
->pce_address
.header
);
1865 if (pce
->pce_scope
.header
.type
!= 0)
1866 show_vty_pce_subtlv_path_scope(vty
,
1867 &pce
->pce_scope
.header
);
1869 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, domain
)) {
1870 if (domain
->header
.type
!= 0)
1871 show_vty_pce_subtlv_domain(vty
,
1875 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, neighbor
)) {
1876 if (neighbor
->header
.type
!= 0)
1877 show_vty_pce_subtlv_neighbor(vty
,
1881 if (pce
->pce_cap_flag
.header
.type
!= 0)
1882 show_vty_pce_subtlv_cap_flag(vty
,
1883 &pce
->pce_cap_flag
.header
);
1886 vty_out(vty
, " PCE info is disabled on this router\n");
1892 /* Install new CLI commands */
1893 static void ospf_router_info_register_vty(void)
1895 install_element(VIEW_NODE
, &show_ip_ospf_router_info_cmd
);
1896 install_element(VIEW_NODE
, &show_ip_ospf_router_info_pce_cmd
);
1898 install_element(OSPF_NODE
, &router_info_area_cmd
);
1899 install_element(OSPF_NODE
, &no_router_info_cmd
);
1900 install_element(OSPF_NODE
, &pce_address_cmd
);
1901 install_element(OSPF_NODE
, &no_pce_address_cmd
);
1902 install_element(OSPF_NODE
, &pce_path_scope_cmd
);
1903 install_element(OSPF_NODE
, &no_pce_path_scope_cmd
);
1904 install_element(OSPF_NODE
, &pce_domain_cmd
);
1905 install_element(OSPF_NODE
, &no_pce_domain_cmd
);
1906 install_element(OSPF_NODE
, &pce_neighbor_cmd
);
1907 install_element(OSPF_NODE
, &no_pce_neighbor_cmd
);
1908 install_element(OSPF_NODE
, &pce_cap_flag_cmd
);
1909 install_element(OSPF_NODE
, &no_pce_cap_flag_cmd
);