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"
60 #include "ospfd/ospf_errors.h"
62 /* Store Router Information PCE TLV and SubTLV in network byte order. */
63 struct ospf_pce_info
{
65 struct ri_tlv_pce pce_header
;
66 struct ri_pce_subtlv_address pce_address
;
67 struct ri_pce_subtlv_path_scope pce_scope
;
68 struct list
*pce_domain
;
69 struct list
*pce_neighbor
;
70 struct ri_pce_subtlv_cap_flag pce_cap_flag
;
74 * Store Router Information Segment Routing TLV and SubTLV
75 * in network byte order
77 struct ospf_ri_sr_info
{
79 /* Algorithms supported by the node */
80 struct ri_sr_tlv_sr_algorithm algo
;
82 * Segment Routing Global Block i.e. label range
83 * Only one range supported in this code
85 struct ri_sr_tlv_sid_label_range range
;
86 /* Maximum SID Depth supported by the node */
87 struct ri_sr_tlv_node_msd msd
;
90 /* Following structure are internal use only. */
91 struct ospf_router_info
{
97 /* Flags to manage this router information. */
98 #define RIFLG_LSA_ENGAGED 0x1
99 #define RIFLG_LSA_FORCED_REFRESH 0x2
102 /* area pointer if flooding is Type 10 Null if flooding is AS scope */
103 struct ospf_area
*area
;
104 struct in_addr area_id
;
106 /* Store Router Information Capabilities LSA */
107 struct ri_tlv_router_cap router_cap
;
109 /* Store PCE capability LSA */
110 struct ospf_pce_info pce_info
;
112 /* Store SR capability LSA */
113 struct ospf_ri_sr_info sr_info
;
117 * Global variable to manage Opaque-LSA/Router Information on this node.
118 * Note that all parameter values are stored in network byte order.
120 static struct ospf_router_info OspfRI
;
122 /*------------------------------------------------------------------------------*
123 * Followings are initialize/terminate functions for Router Information
125 *------------------------------------------------------------------------------*/
127 static void ospf_router_info_ism_change(struct ospf_interface
*oi
,
129 static void ospf_router_info_nsm_change(struct ospf_neighbor
*nbr
,
131 static void ospf_router_info_config_write_router(struct vty
*vty
);
132 static void ospf_router_info_show_info(struct vty
*vty
, struct ospf_lsa
*lsa
);
133 static int ospf_router_info_lsa_originate(void *arg
);
134 static struct ospf_lsa
*ospf_router_info_lsa_refresh(struct ospf_lsa
*lsa
);
135 static void ospf_router_info_lsa_schedule(enum lsa_opcode opcode
);
136 static void ospf_router_info_register_vty(void);
137 static int ospf_router_info_lsa_update(struct ospf_lsa
*lsa
);
138 static void del_pce_info(void *val
);
140 int ospf_router_info_init(void)
143 zlog_info("RI -> Initialize Router Information");
145 memset(&OspfRI
, 0, sizeof(struct ospf_router_info
));
146 OspfRI
.enabled
= false;
147 OspfRI
.registered
= 0;
148 OspfRI
.scope
= OSPF_OPAQUE_AS_LSA
;
149 OspfRI
.area_id
.s_addr
= 0;
152 /* Initialize pce domain and neighbor list */
153 OspfRI
.pce_info
.enabled
= false;
154 OspfRI
.pce_info
.pce_domain
= list_new();
155 OspfRI
.pce_info
.pce_domain
->del
= del_pce_info
;
156 OspfRI
.pce_info
.pce_neighbor
= list_new();
157 OspfRI
.pce_info
.pce_neighbor
->del
= del_pce_info
;
159 /* Initialize Segment Routing information structure */
160 OspfRI
.sr_info
.enabled
= false;
162 ospf_router_info_register_vty();
167 static int ospf_router_info_register(uint8_t scope
)
171 if (OspfRI
.registered
)
174 zlog_info("RI -> Register Router Information with scope %s(%d)",
175 scope
== OSPF_OPAQUE_AREA_LSA
? "Area" : "AS", scope
);
176 rc
= ospf_register_opaque_functab(
177 scope
, OPAQUE_TYPE_ROUTER_INFORMATION_LSA
,
178 NULL
, /* new interface */
179 NULL
, /* del interface */
180 ospf_router_info_ism_change
, ospf_router_info_nsm_change
,
181 ospf_router_info_config_write_router
,
182 NULL
, /* Config. write interface */
183 NULL
, /* Config. write debug */
184 ospf_router_info_show_info
, ospf_router_info_lsa_originate
,
185 ospf_router_info_lsa_refresh
, ospf_router_info_lsa_update
,
186 NULL
); /* del_lsa_hook */
190 OSPF_WARN_OPAQUE_REGISTRATION
,
191 "ospf_router_info_init: Failed to register functions");
195 OspfRI
.registered
= 1;
196 OspfRI
.scope
= scope
;
200 static int ospf_router_info_unregister()
203 if ((OspfRI
.scope
!= OSPF_OPAQUE_AS_LSA
)
204 && (OspfRI
.scope
!= OSPF_OPAQUE_AREA_LSA
)) {
205 assert("Unable to unregister Router Info functions: Wrong scope!"
210 ospf_delete_opaque_functab(OspfRI
.scope
,
211 OPAQUE_TYPE_ROUTER_INFORMATION_LSA
);
213 OspfRI
.registered
= 0;
217 void ospf_router_info_term(void)
220 list_delete_and_null(&OspfRI
.pce_info
.pce_domain
);
221 list_delete_and_null(&OspfRI
.pce_info
.pce_neighbor
);
223 OspfRI
.enabled
= false;
225 ospf_router_info_unregister();
230 void ospf_router_info_finish(void)
232 list_delete_all_node(OspfRI
.pce_info
.pce_domain
);
233 list_delete_all_node(OspfRI
.pce_info
.pce_neighbor
);
235 OspfRI
.enabled
= false;
238 static void del_pce_info(void *val
)
240 XFREE(MTYPE_OSPF_PCE_PARAMS
, val
);
244 /* Catch RI LSA flooding Scope for ospf_ext.[h,c] code */
245 struct scope_info
ospf_router_info_get_flooding_scope(void)
247 struct scope_info flooding_scope
;
249 if (OspfRI
.scope
== OSPF_OPAQUE_AS_LSA
) {
250 flooding_scope
.scope
= OSPF_OPAQUE_AS_LSA
;
251 flooding_scope
.area_id
.s_addr
= 0;
252 return flooding_scope
;
254 flooding_scope
.scope
= OSPF_OPAQUE_AREA_LSA
;
255 flooding_scope
.area_id
.s_addr
= OspfRI
.area_id
.s_addr
;
256 return flooding_scope
;
259 /*------------------------------------------------------------------------*
260 * Followings are control functions for ROUTER INFORMATION parameters
262 *------------------------------------------------------------------------*/
264 static void set_router_info_capabilities(struct ri_tlv_router_cap
*ric
,
267 ric
->header
.type
= htons(RI_TLV_CAPABILITIES
);
268 ric
->header
.length
= htons(RI_TLV_LENGTH
);
269 ric
->value
= htonl(cap
);
273 static int set_pce_header(struct ospf_pce_info
*pce
)
276 struct listnode
*node
;
277 struct ri_pce_subtlv_domain
*domain
;
278 struct ri_pce_subtlv_neighbor
*neighbor
;
281 if (ntohs(pce
->pce_address
.header
.type
) != 0)
282 length
+= TLV_SIZE(&pce
->pce_address
.header
);
285 if (ntohs(pce
->pce_scope
.header
.type
) != 0)
286 length
+= TLV_SIZE(&pce
->pce_scope
.header
);
289 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, domain
)) {
290 if (ntohs(domain
->header
.type
) != 0)
291 length
+= TLV_SIZE(&domain
->header
);
295 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, neighbor
)) {
296 if (ntohs(neighbor
->header
.type
) != 0)
297 length
+= TLV_SIZE(&neighbor
->header
);
300 /* PCE Capabilities */
301 if (ntohs(pce
->pce_cap_flag
.header
.type
) != 0)
302 length
+= TLV_SIZE(&pce
->pce_cap_flag
.header
);
305 pce
->pce_header
.header
.type
= htons(RI_TLV_PCE
);
306 pce
->pce_header
.header
.length
= htons(length
);
309 pce
->pce_header
.header
.type
= 0;
310 pce
->pce_header
.header
.length
= 0;
311 pce
->enabled
= false;
317 static void set_pce_address(struct in_addr ipv4
, struct ospf_pce_info
*pce
)
320 /* Enable PCE Info */
321 pce
->pce_header
.header
.type
= htons(RI_TLV_PCE
);
322 /* Set PCE Address */
323 pce
->pce_address
.header
.type
= htons(RI_PCE_SUBTLV_ADDRESS
);
324 pce
->pce_address
.header
.length
= htons(PCE_ADDRESS_LENGTH_IPV4
);
325 pce
->pce_address
.address
.type
= htons(PCE_ADDRESS_TYPE_IPV4
);
326 pce
->pce_address
.address
.value
= ipv4
;
331 static void set_pce_path_scope(uint32_t scope
, struct ospf_pce_info
*pce
)
335 pce
->pce_scope
.header
.type
= htons(RI_PCE_SUBTLV_PATH_SCOPE
);
336 pce
->pce_scope
.header
.length
= htons(RI_TLV_LENGTH
);
337 pce
->pce_scope
.value
= htonl(scope
);
342 static void set_pce_domain(uint16_t type
, uint32_t domain
,
343 struct ospf_pce_info
*pce
)
346 struct ri_pce_subtlv_domain
*new;
348 /* Create new domain info */
349 new = XCALLOC(MTYPE_OSPF_PCE_PARAMS
,
350 sizeof(struct ri_pce_subtlv_domain
));
352 new->header
.type
= htons(RI_PCE_SUBTLV_DOMAIN
);
353 new->header
.length
= htons(PCE_ADDRESS_LENGTH_IPV4
);
354 new->type
= htons(type
);
355 new->value
= htonl(domain
);
357 /* Add new domain to the list */
358 listnode_add(pce
->pce_domain
, new);
363 static void unset_pce_domain(uint16_t type
, uint32_t domain
,
364 struct ospf_pce_info
*pce
)
366 struct listnode
*node
;
367 struct ri_pce_subtlv_domain
*old
= NULL
;
370 /* Search the corresponding node */
371 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, old
)) {
372 if ((old
->type
== htons(type
))
373 && (old
->value
== htonl(domain
))) {
379 /* if found remove it */
381 listnode_delete(pce
->pce_domain
, old
);
383 /* Avoid misjudgement in the next lookup. */
384 if (listcount(pce
->pce_domain
) == 0)
385 pce
->pce_domain
->head
= pce
->pce_domain
->tail
= NULL
;
387 /* Finally free the old domain */
388 XFREE(MTYPE_OSPF_PCE_PARAMS
, old
);
392 static void set_pce_neighbor(uint16_t type
, uint32_t domain
,
393 struct ospf_pce_info
*pce
)
396 struct ri_pce_subtlv_neighbor
*new;
398 /* Create new neighbor info */
399 new = XCALLOC(MTYPE_OSPF_PCE_PARAMS
,
400 sizeof(struct ri_pce_subtlv_neighbor
));
402 new->header
.type
= htons(RI_PCE_SUBTLV_NEIGHBOR
);
403 new->header
.length
= htons(PCE_ADDRESS_LENGTH_IPV4
);
404 new->type
= htons(type
);
405 new->value
= htonl(domain
);
407 /* Add new domain to the list */
408 listnode_add(pce
->pce_neighbor
, new);
413 static void unset_pce_neighbor(uint16_t type
, uint32_t domain
,
414 struct ospf_pce_info
*pce
)
416 struct listnode
*node
;
417 struct ri_pce_subtlv_neighbor
*old
= NULL
;
420 /* Search the corresponding node */
421 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, old
)) {
422 if ((old
->type
== htons(type
))
423 && (old
->value
== htonl(domain
))) {
429 /* if found remove it */
431 listnode_delete(pce
->pce_neighbor
, old
);
433 /* Avoid misjudgement in the next lookup. */
434 if (listcount(pce
->pce_neighbor
) == 0)
435 pce
->pce_neighbor
->head
= pce
->pce_neighbor
->tail
=
438 /* Finally free the old domain */
439 XFREE(MTYPE_OSPF_PCE_PARAMS
, old
);
443 static void set_pce_cap_flag(uint32_t cap
, struct ospf_pce_info
*pce
)
446 /* Set PCE Capabilities flag */
447 pce
->pce_cap_flag
.header
.type
= htons(RI_PCE_SUBTLV_CAP_FLAG
);
448 pce
->pce_cap_flag
.header
.length
= htons(RI_TLV_LENGTH
);
449 pce
->pce_cap_flag
.value
= htonl(cap
);
454 /* Segment Routing TLV setter */
456 /* Algorithm SubTLV - section 3.1 */
457 static void set_sr_algorithm(uint8_t algo
)
460 OspfRI
.sr_info
.algo
.value
[0] = algo
;
461 for (int i
= 1; i
< ALGORITHM_COUNT
; i
++)
462 OspfRI
.sr_info
.algo
.value
[i
] = SR_ALGORITHM_UNSET
;
464 /* Set TLV type and length == only 1 Algorithm */
465 TLV_TYPE(OspfRI
.sr_info
.algo
) = htons(RI_SR_TLV_SR_ALGORITHM
);
466 TLV_LEN(OspfRI
.sr_info
.algo
) = htons(sizeof(uint8_t));
469 /* unset Aglogithm SubTLV */
470 static void unset_sr_algorithm(uint8_t algo
)
473 for (int i
= 0; i
< ALGORITHM_COUNT
; i
++)
474 OspfRI
.sr_info
.algo
.value
[i
] = SR_ALGORITHM_UNSET
;
476 /* Unset TLV type and length */
477 TLV_TYPE(OspfRI
.sr_info
.algo
) = htons(0);
478 TLV_LEN(OspfRI
.sr_info
.algo
) = htons(0);
481 /* Segment Routing Global Block SubTLV - section 3.2 */
482 static void set_sr_sid_label_range(struct sr_srgb srgb
)
485 TLV_TYPE(OspfRI
.sr_info
.range
) = htons(RI_SR_TLV_SID_LABEL_RANGE
);
486 TLV_LEN(OspfRI
.sr_info
.range
) =
487 htons(SUBTLV_SID_LABEL_SIZE
+ sizeof(uint32_t));
489 OspfRI
.sr_info
.range
.size
= htonl(SET_RANGE_SIZE(srgb
.range_size
));
490 /* Set Lower bound label SubTLV */
491 TLV_TYPE(OspfRI
.sr_info
.range
.lower
) = htons(SUBTLV_SID_LABEL
);
492 TLV_LEN(OspfRI
.sr_info
.range
.lower
) = htons(SID_RANGE_LABEL_LENGTH
);
493 OspfRI
.sr_info
.range
.lower
.value
= htonl(SET_LABEL(srgb
.lower_bound
));
496 /* Unset this SRGB SubTLV */
497 static void unset_sr_sid_label_range(void)
500 TLV_TYPE(OspfRI
.sr_info
.range
) = htons(0);
501 TLV_LEN(OspfRI
.sr_info
.range
) = htons(0);
502 TLV_TYPE(OspfRI
.sr_info
.range
.lower
) = htons(0);
503 TLV_LEN(OspfRI
.sr_info
.range
.lower
) = htons(0);
506 /* Set Maximum Stack Depth for this router */
507 static void set_sr_node_msd(uint8_t msd
)
509 TLV_TYPE(OspfRI
.sr_info
.msd
) = htons(RI_SR_TLV_NODE_MSD
);
510 TLV_LEN(OspfRI
.sr_info
.msd
) = htons(sizeof(uint32_t));
511 OspfRI
.sr_info
.msd
.value
= msd
;
514 /* Unset this router MSD */
515 static void unset_sr_node_msd(void)
517 TLV_TYPE(OspfRI
.sr_info
.msd
) = htons(0);
518 TLV_LEN(OspfRI
.sr_info
.msd
) = htons(0);
521 static void unset_param(void *tlv_buffer
)
523 struct tlv_header
*tlv
= (struct tlv_header
*)tlv_buffer
;
526 /* Fill the Value to 0 */
527 memset(TLV_DATA(tlv_buffer
), 0, TLV_BODY_SIZE(tlv
));
533 static void initialize_params(struct ospf_router_info
*ori
)
539 * Initialize default Router Information Capabilities.
543 set_router_info_capabilities(&ori
->router_cap
, cap
);
545 /* If Area address is not null and exist, retrieve corresponding
547 top
= ospf_lookup_by_vrf_id(VRF_DEFAULT
);
548 zlog_info("RI-> Initialize Router Info for %s scope within area %s",
549 OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
? "Area" : "AS",
550 inet_ntoa(OspfRI
.area_id
));
552 /* Try to get the Area context at this step. Do it latter if not
554 if ((OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
) && (OspfRI
.area
== NULL
))
555 OspfRI
.area
= ospf_area_lookup_by_area_id(top
, OspfRI
.area_id
);
558 * Initialize default PCE Information values
560 /* PCE address == OSPF Router ID */
561 set_pce_address(top
->router_id
, &ori
->pce_info
);
564 cap
= 7; /* Set L, R and Rd bits to one = intra & inter-area path
566 set_pce_path_scope(cap
, &ori
->pce_info
);
568 /* PCE Capabilities */
569 cap
= PCE_CAP_BIDIRECTIONAL
| PCE_CAP_DIVERSE_PATH
| PCE_CAP_OBJECTIVES
570 | PCE_CAP_ADDITIVE
| PCE_CAP_MULTIPLE_REQ
;
571 set_pce_cap_flag(cap
, &ori
->pce_info
);
576 static int is_mandated_params_set(struct ospf_router_info ori
)
580 if (ntohs(ori
.router_cap
.header
.type
) == 0)
583 if ((ntohs(ori
.pce_info
.pce_header
.header
.type
) == RI_TLV_PCE
)
584 && (ntohs(ori
.pce_info
.pce_address
.header
.type
) == 0)
585 && (ntohs(ori
.pce_info
.pce_cap_flag
.header
.type
) == 0))
588 if ((ori
.sr_info
.enabled
) && (ntohs(TLV_TYPE(ori
.sr_info
.algo
)) == 0)
589 && (ntohs(TLV_TYPE(ori
.sr_info
.range
)) == 0))
598 * Used by Segment Routing to set new TLVs and Sub-TLVs values
600 * @param enable To activate or not Segment Routing router Information flooding
601 * @param size Size of Label Range i.e. SRGB size
602 * @param lower Lower bound of the Label Range i.e. SRGB first label
603 * @param msd Maximum label Stack Depth suported by the router
607 void ospf_router_info_update_sr(bool enable
, struct sr_srgb srgb
, uint8_t msd
)
610 /* First activate and initialize Router Information is necessary */
611 if (!OspfRI
.enabled
) {
612 OspfRI
.enabled
= true;
613 initialize_params(&OspfRI
);
616 if (IS_DEBUG_OSPF_SR
)
617 zlog_debug("RI-> %s Routing Information for Segment Routing",
618 enable
? "Enable" : "Disable");
620 /* Unset or Set SR parameters */
622 unset_sr_algorithm(SR_ALGORITHM_SPF
);
623 unset_sr_sid_label_range();
625 OspfRI
.sr_info
.enabled
= false;
627 // Only SR_ALGORITHM_SPF is supported
628 set_sr_algorithm(SR_ALGORITHM_SPF
);
629 set_sr_sid_label_range(srgb
);
631 set_sr_node_msd(msd
);
634 OspfRI
.sr_info
.enabled
= true;
637 /* Refresh if already engaged or originate RI LSA */
638 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
639 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
641 ospf_router_info_lsa_schedule(REORIGINATE_THIS_LSA
);
644 /*------------------------------------------------------------------------*
645 * Followings are callback functions against generic Opaque-LSAs handling.
646 *------------------------------------------------------------------------*/
647 static void ospf_router_info_ism_change(struct ospf_interface
*oi
,
650 /* So far, nothing to do here. */
654 static void ospf_router_info_nsm_change(struct ospf_neighbor
*nbr
,
657 /* So far, nothing to do here. */
661 /*------------------------------------------------------------------------*
662 * Followings are OSPF protocol processing functions for ROUTER INFORMATION
663 *------------------------------------------------------------------------*/
665 static void build_tlv_header(struct stream
*s
, struct tlv_header
*tlvh
)
668 stream_put(s
, tlvh
, sizeof(struct tlv_header
));
672 static void build_tlv(struct stream
*s
, struct tlv_header
*tlvh
)
675 if (ntohs(tlvh
->type
) != 0) {
676 build_tlv_header(s
, tlvh
);
677 stream_put(s
, TLV_DATA(tlvh
), TLV_BODY_SIZE(tlvh
));
682 static void ospf_router_info_lsa_body_set(struct stream
*s
)
685 struct listnode
*node
;
686 struct ri_pce_subtlv_domain
*domain
;
687 struct ri_pce_subtlv_neighbor
*neighbor
;
689 /* Build Router Information TLV */
690 build_tlv(s
, &OspfRI
.router_cap
.header
);
692 /* Build Segment Routing TLVs if enabled */
693 if (OspfRI
.sr_info
.enabled
) {
694 /* Build Algorithm TLV */
695 build_tlv(s
, &TLV_HDR(OspfRI
.sr_info
.algo
));
697 build_tlv(s
, &TLV_HDR(OspfRI
.sr_info
.range
));
699 build_tlv(s
, &TLV_HDR(OspfRI
.sr_info
.msd
));
702 /* Add RI PCE TLV if it is set */
703 if (OspfRI
.pce_info
.enabled
) {
705 /* Compute PCE Info header first */
706 set_pce_header(&OspfRI
.pce_info
);
709 build_tlv_header(s
, &OspfRI
.pce_info
.pce_header
.header
);
711 /* Build PCE address sub-tlv */
712 build_tlv(s
, &OspfRI
.pce_info
.pce_address
.header
);
714 /* Build PCE path scope sub-tlv */
715 build_tlv(s
, &OspfRI
.pce_info
.pce_scope
.header
);
717 /* Build PCE domain sub-tlv */
718 for (ALL_LIST_ELEMENTS_RO(OspfRI
.pce_info
.pce_domain
, node
,
720 build_tlv(s
, &domain
->header
);
722 /* Build PCE neighbor sub-tlv */
723 for (ALL_LIST_ELEMENTS_RO(OspfRI
.pce_info
.pce_neighbor
, node
,
725 build_tlv(s
, &neighbor
->header
);
727 /* Build PCE cap flag sub-tlv */
728 build_tlv(s
, &OspfRI
.pce_info
.pce_cap_flag
.header
);
734 /* Create new opaque-LSA. */
735 static struct ospf_lsa
*ospf_router_info_lsa_new()
739 struct lsa_header
*lsah
;
740 struct ospf_lsa
*new = NULL
;
741 uint8_t options
, lsa_type
;
742 struct in_addr lsa_id
;
746 /* Create a stream for LSA. */
747 s
= stream_new(OSPF_MAX_LSA_SIZE
);
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 new = ospf_lsa_new_and_data(length
);
780 new->area
= OspfRI
.area
; /* Area must be null if the Opaque type is AS
781 scope, fulfill otherwise */
783 if (new->area
&& new->area
->ospf
)
784 new->vrf_id
= new->area
->ospf
->vrf_id
;
786 new->vrf_id
= VRF_DEFAULT
;
788 SET_FLAG(new->flags
, OSPF_LSA_SELF
);
789 memcpy(new->data
, lsah
, length
);
795 static int ospf_router_info_lsa_originate1(void *arg
)
797 struct ospf_lsa
*new;
799 struct ospf_area
*area
;
801 vrf_id_t vrf_id
= VRF_DEFAULT
;
803 /* First check if the area is known if flooding scope is Area */
804 if (OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
) {
805 area
= (struct ospf_area
*)arg
;
806 if (area
->area_id
.s_addr
!= OspfRI
.area_id
.s_addr
) {
808 "RI -> This is not the Router Information Area. Stop processing");
813 vrf_id
= area
->ospf
->vrf_id
;
816 /* Create new Opaque-LSA/ROUTER INFORMATION instance. */
817 new = ospf_router_info_lsa_new();
818 new->vrf_id
= vrf_id
;
821 top
= ospf_lookup_by_vrf_id(vrf_id
);
823 zlog_debug("%s: ospf instance not found for vrf id %u",
824 __PRETTY_FUNCTION__
, vrf_id
);
825 ospf_lsa_unlock(&new);
829 /* Install this LSA into LSDB. */
830 if (ospf_lsa_install(top
, NULL
/*oi */, new) == NULL
) {
832 OSPF_WARN_LSA_INSTALL_FAILURE
,
833 "ospf_router_info_lsa_originate1: ospf_lsa_install() ?");
834 ospf_lsa_unlock(&new);
838 /* Now this Router Info parameter entry has associated LSA. */
839 SET_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
);
841 /* Update new LSA origination count. */
842 top
->lsa_originate_count
++;
844 /* Flood new LSA through AS. */
845 if (OspfRI
.scope
== OSPF_OPAQUE_AS_LSA
)
846 ospf_flood_through_as(top
, NULL
/*nbr */, new);
848 ospf_flood_through_area(OspfRI
.area
, NULL
/*nbr */, new);
850 if (IS_DEBUG_OSPF(lsa
, LSA_GENERATE
)) {
852 "LSA[Type%d:%s]: Originate Opaque-LSA/ROUTER INFORMATION",
853 new->data
->type
, inet_ntoa(new->data
->id
));
854 ospf_lsa_header_dump(new->data
);
861 static int ospf_router_info_lsa_originate(void *arg
)
866 if (!OspfRI
.enabled
) {
868 "ospf_router_info_lsa_originate: ROUTER INFORMATION is disabled now.");
869 rc
= 0; /* This is not an error case. */
873 /* Check if Router Information LSA is already engaged */
874 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
)) {
875 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_FORCED_REFRESH
)) {
876 UNSET_FLAG(OspfRI
.flags
, RIFLG_LSA_FORCED_REFRESH
);
877 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
880 if (!is_mandated_params_set(OspfRI
))
883 "ospf_router_info_lsa_originate: lacks mandated ROUTER INFORMATION parameters");
885 /* Ok, let's try to originate an LSA */
886 if (ospf_router_info_lsa_originate1(arg
) != 0)
894 static struct ospf_lsa
*ospf_router_info_lsa_refresh(struct ospf_lsa
*lsa
)
896 struct ospf_lsa
*new = NULL
;
899 if (!OspfRI
.enabled
) {
901 * This LSA must have flushed before due to ROUTER INFORMATION
903 * It seems a slip among routers in the routing domain.
906 "ospf_router_info_lsa_refresh: ROUTER INFORMATION is disabled now.");
908 htons(OSPF_LSA_MAXAGE
); /* Flush it anyway. */
911 /* Verify that the Router Information ID is supported */
912 if (GET_OPAQUE_ID(ntohl(lsa
->data
->id
.s_addr
)) != 0) {
915 "ospf_router_info_lsa_refresh: Unsupported Router Information ID");
919 /* If the lsa's age reached to MaxAge, start flushing procedure. */
920 if (IS_LSA_MAXAGE(lsa
)) {
921 UNSET_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
);
922 ospf_opaque_lsa_flush_schedule(lsa
);
926 /* Create new Opaque-LSA/ROUTER INFORMATION instance. */
927 new = ospf_router_info_lsa_new();
928 new->data
->ls_seqnum
= lsa_seqnum_increment(lsa
);
929 new->vrf_id
= lsa
->vrf_id
;
931 /* Install this LSA into LSDB. */
932 /* Given "lsa" will be freed in the next function. */
933 top
= ospf_lookup_by_vrf_id(lsa
->vrf_id
);
934 if (ospf_lsa_install(top
, NULL
/*oi */, new) == NULL
) {
935 flog_warn(OSPF_WARN_LSA_INSTALL_FAILURE
,
936 "ospf_router_info_lsa_refresh: ospf_lsa_install() ?");
937 ospf_lsa_unlock(&new);
941 /* Flood updated LSA through AS or AREA depending of OspfRI.scope. */
942 if (OspfRI
.scope
== OSPF_OPAQUE_AS_LSA
)
943 ospf_flood_through_as(top
, NULL
/*nbr */, new);
945 ospf_flood_through_area(OspfRI
.area
, NULL
/*nbr */, new);
948 if (IS_DEBUG_OSPF(lsa
, LSA_GENERATE
)) {
950 "LSA[Type%d:%s]: Refresh Opaque-LSA/ROUTER INFORMATION",
951 new->data
->type
, inet_ntoa(new->data
->id
));
952 ospf_lsa_header_dump(new->data
);
958 static void ospf_router_info_lsa_schedule(enum lsa_opcode opcode
)
961 struct lsa_header lsah
;
965 memset(&lsa
, 0, sizeof(lsa
));
966 memset(&lsah
, 0, sizeof(lsah
));
968 zlog_debug("RI-> LSA schedule %s%s%s",
969 opcode
== REORIGINATE_THIS_LSA
? "Re-Originate" : "",
970 opcode
== REFRESH_THIS_LSA
? "Refresh" : "",
971 opcode
== FLUSH_THIS_LSA
? "Flush" : "");
973 /* Check LSA flags state coherence */
974 if (!CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
)
975 && (opcode
!= REORIGINATE_THIS_LSA
))
978 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
)
979 && (opcode
== REORIGINATE_THIS_LSA
))
980 opcode
= REFRESH_THIS_LSA
;
982 top
= ospf_lookup_by_vrf_id(VRF_DEFAULT
);
983 if ((OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
) && (OspfRI
.area
== NULL
)) {
986 "ospf_router_info_lsa_schedule(): Router Info is Area scope flooding but area is not set");
987 OspfRI
.area
= ospf_area_lookup_by_area_id(top
, OspfRI
.area_id
);
989 lsa
.area
= OspfRI
.area
;
991 lsah
.type
= OspfRI
.scope
;
993 /* LSA ID is set to 0 for the Router Information. See RFC 4970 */
994 tmp
= SET_OPAQUE_LSID(OPAQUE_TYPE_ROUTER_INFORMATION_LSA
, 0);
995 lsah
.id
.s_addr
= htonl(tmp
);
998 case REORIGINATE_THIS_LSA
:
999 if (OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
)
1000 ospf_opaque_lsa_reoriginate_schedule(
1001 (void *)OspfRI
.area
, OSPF_OPAQUE_AREA_LSA
,
1002 OPAQUE_TYPE_ROUTER_INFORMATION_LSA
);
1004 ospf_opaque_lsa_reoriginate_schedule(
1005 (void *)top
, OSPF_OPAQUE_AS_LSA
,
1006 OPAQUE_TYPE_ROUTER_INFORMATION_LSA
);
1008 case REFRESH_THIS_LSA
:
1009 ospf_opaque_lsa_refresh_schedule(&lsa
);
1011 case FLUSH_THIS_LSA
:
1012 UNSET_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
);
1013 ospf_opaque_lsa_flush_schedule(&lsa
);
1020 /* Callback to handle Segment Routing information */
1021 static int ospf_router_info_lsa_update(struct ospf_lsa
*lsa
)
1026 flog_warn(OSPF_WARN_LSA
, "OSPF-RI (%s): Abort! LSA is NULL",
1031 /* Process only Opaque LSA */
1032 if ((lsa
->data
->type
!= OSPF_OPAQUE_AREA_LSA
)
1033 && (lsa
->data
->type
!= OSPF_OPAQUE_AS_LSA
))
1036 /* Process only Router Information LSA */
1037 if (GET_OPAQUE_TYPE(ntohl(lsa
->data
->id
.s_addr
))
1038 != OPAQUE_TYPE_ROUTER_INFORMATION_LSA
)
1041 /* Check if it is not my LSA */
1042 if (IS_LSA_SELF(lsa
))
1045 /* Check if Router Info & Segment Routing are enable */
1046 if (!OspfRI
.enabled
|| !OspfRI
.sr_info
.enabled
)
1049 /* Call Segment Routing LSA update or deletion */
1050 if (!IS_LSA_MAXAGE(lsa
))
1051 ospf_sr_ri_lsa_update(lsa
);
1053 ospf_sr_ri_lsa_delete(lsa
);
1058 /*------------------------------------------------------------------------*
1059 * Followings are vty session control functions.
1060 *------------------------------------------------------------------------*/
1062 static uint16_t show_vty_router_cap(struct vty
*vty
, struct tlv_header
*tlvh
)
1064 struct ri_tlv_router_cap
*top
= (struct ri_tlv_router_cap
*)tlvh
;
1067 vty_out(vty
, " Router Capabilities: 0x%x\n",
1070 zlog_debug(" Router Capabilities: 0x%x", ntohl(top
->value
));
1072 return TLV_SIZE(tlvh
);
1075 static uint16_t show_vty_pce_subtlv_address(struct vty
*vty
,
1076 struct tlv_header
*tlvh
)
1078 struct ri_pce_subtlv_address
*top
=
1079 (struct ri_pce_subtlv_address
*)tlvh
;
1081 if (ntohs(top
->address
.type
) == PCE_ADDRESS_TYPE_IPV4
) {
1083 vty_out(vty
, " PCE Address: %s\n",
1084 inet_ntoa(top
->address
.value
));
1086 zlog_debug(" PCE Address: %s",
1087 inet_ntoa(top
->address
.value
));
1089 /* TODO: Add support to IPv6 with inet_ntop() */
1091 vty_out(vty
, " PCE Address: 0x%x\n",
1092 ntohl(top
->address
.value
.s_addr
));
1094 zlog_debug(" PCE Address: 0x%x",
1095 ntohl(top
->address
.value
.s_addr
));
1098 return TLV_SIZE(tlvh
);
1101 static uint16_t show_vty_pce_subtlv_path_scope(struct vty
*vty
,
1102 struct tlv_header
*tlvh
)
1104 struct ri_pce_subtlv_path_scope
*top
=
1105 (struct ri_pce_subtlv_path_scope
*)tlvh
;
1108 vty_out(vty
, " PCE Path Scope: 0x%x\n", ntohl(top
->value
));
1110 zlog_debug(" PCE Path Scope: 0x%x", ntohl(top
->value
));
1112 return TLV_SIZE(tlvh
);
1115 static uint16_t show_vty_pce_subtlv_domain(struct vty
*vty
,
1116 struct tlv_header
*tlvh
)
1118 struct ri_pce_subtlv_domain
*top
= (struct ri_pce_subtlv_domain
*)tlvh
;
1121 if (ntohs(top
->type
) == PCE_DOMAIN_TYPE_AREA
) {
1122 tmp
.s_addr
= top
->value
;
1124 vty_out(vty
, " PCE domain Area: %s\n", inet_ntoa(tmp
));
1126 zlog_debug(" PCE domain Area: %s", inet_ntoa(tmp
));
1129 vty_out(vty
, " PCE domain AS: %d\n",
1132 zlog_debug(" PCE domain AS: %d", ntohl(top
->value
));
1134 return TLV_SIZE(tlvh
);
1137 static uint16_t show_vty_pce_subtlv_neighbor(struct vty
*vty
,
1138 struct tlv_header
*tlvh
)
1141 struct ri_pce_subtlv_neighbor
*top
=
1142 (struct ri_pce_subtlv_neighbor
*)tlvh
;
1145 if (ntohs(top
->type
) == PCE_DOMAIN_TYPE_AREA
) {
1146 tmp
.s_addr
= top
->value
;
1148 vty_out(vty
, " PCE neighbor Area: %s\n",
1151 zlog_debug(" PCE neighbor Area: %s", inet_ntoa(tmp
));
1154 vty_out(vty
, " PCE neighbor AS: %d\n",
1157 zlog_debug(" PCE neighbor AS: %d",
1160 return TLV_SIZE(tlvh
);
1163 static uint16_t show_vty_pce_subtlv_cap_flag(struct vty
*vty
,
1164 struct tlv_header
*tlvh
)
1166 struct ri_pce_subtlv_cap_flag
*top
=
1167 (struct ri_pce_subtlv_cap_flag
*)tlvh
;
1170 vty_out(vty
, " PCE Capabilities Flag: 0x%x\n",
1173 zlog_debug(" PCE Capabilities Flag: 0x%x",
1176 return TLV_SIZE(tlvh
);
1179 static uint16_t show_vty_unknown_tlv(struct vty
*vty
, struct tlv_header
*tlvh
)
1182 vty_out(vty
, " Unknown TLV: [type(0x%x), length(0x%x)]\n",
1183 ntohs(tlvh
->type
), ntohs(tlvh
->length
));
1185 zlog_debug(" Unknown TLV: [type(0x%x), length(0x%x)]",
1186 ntohs(tlvh
->type
), ntohs(tlvh
->length
));
1188 return TLV_SIZE(tlvh
);
1191 static uint16_t show_vty_pce_info(struct vty
*vty
, struct tlv_header
*ri
,
1194 struct tlv_header
*tlvh
;
1197 for (tlvh
= ri
; sum
< total
; tlvh
= TLV_HDR_NEXT(tlvh
)) {
1198 switch (ntohs(tlvh
->type
)) {
1199 case RI_PCE_SUBTLV_ADDRESS
:
1200 sum
+= show_vty_pce_subtlv_address(vty
, tlvh
);
1202 case RI_PCE_SUBTLV_PATH_SCOPE
:
1203 sum
+= show_vty_pce_subtlv_path_scope(vty
, tlvh
);
1205 case RI_PCE_SUBTLV_DOMAIN
:
1206 sum
+= show_vty_pce_subtlv_domain(vty
, tlvh
);
1208 case RI_PCE_SUBTLV_NEIGHBOR
:
1209 sum
+= show_vty_pce_subtlv_neighbor(vty
, tlvh
);
1211 case RI_PCE_SUBTLV_CAP_FLAG
:
1212 sum
+= show_vty_pce_subtlv_cap_flag(vty
, tlvh
);
1215 sum
+= show_vty_unknown_tlv(vty
, tlvh
);
1222 /* Display Segment Routing Algorithm TLV information */
1223 static uint16_t show_vty_sr_algorithm(struct vty
*vty
, struct tlv_header
*tlvh
)
1225 struct ri_sr_tlv_sr_algorithm
*algo
=
1226 (struct ri_sr_tlv_sr_algorithm
*)tlvh
;
1230 vty_out(vty
, " Segment Routing Algorithm TLV:\n");
1231 for (i
= 0; i
< ntohs(algo
->header
.length
); i
++) {
1232 switch (algo
->value
[i
]) {
1234 vty_out(vty
, " Algorithm %d: SPF\n", i
);
1237 vty_out(vty
, " Algorithm %d: Strict SPF\n",
1242 " Algorithm %d: Unknown value %d\n", i
,
1250 zlog_debug(" Segment Routing Algorithm TLV:\n");
1251 for (i
= 0; i
< ntohs(algo
->header
.length
); i
++)
1252 switch (algo
->value
[i
]) {
1254 zlog_debug(" Algorithm %d: SPF\n", i
);
1257 zlog_debug(" Algorithm %d: Strict SPF\n", i
);
1261 " Algorithm %d: Unknown value %d\n",
1267 return TLV_SIZE(tlvh
);
1270 /* Display Segment Routing SID/Label Range TLV information */
1271 static uint16_t show_vty_sr_range(struct vty
*vty
, struct tlv_header
*tlvh
)
1273 struct ri_sr_tlv_sid_label_range
*range
=
1274 (struct ri_sr_tlv_sid_label_range
*)tlvh
;
1278 " Segment Routing Range TLV:\n"
1279 " Range Size = %d\n"
1280 " SID Label = %d\n\n",
1281 GET_RANGE_SIZE(ntohl(range
->size
)),
1282 GET_LABEL(ntohl(range
->lower
.value
)));
1285 " Segment Routing Range TLV:\n"
1286 " Range Size = %d\n"
1287 " SID Label = %d\n\n",
1288 GET_RANGE_SIZE(ntohl(range
->size
)),
1289 GET_LABEL(ntohl(range
->lower
.value
)));
1292 return TLV_SIZE(tlvh
);
1295 /* Display Segment Routing Maximum Stack Depth TLV information */
1296 static uint16_t show_vty_sr_msd(struct vty
*vty
, struct tlv_header
*tlvh
)
1298 struct ri_sr_tlv_node_msd
*msd
= (struct ri_sr_tlv_node_msd
*)tlvh
;
1302 " Segment Routing MSD TLV:\n"
1303 " Node Maximum Stack Depth = %d\n",
1307 " Segment Routing MSD TLV:\n"
1308 " Node Maximum Stack Depth = %d\n",
1312 return TLV_SIZE(tlvh
);
1315 static void ospf_router_info_show_info(struct vty
*vty
, struct ospf_lsa
*lsa
)
1317 struct lsa_header
*lsah
= (struct lsa_header
*)lsa
->data
;
1318 struct tlv_header
*tlvh
;
1319 uint16_t length
= 0, sum
= 0;
1321 /* Initialize TLV browsing */
1322 length
= ntohs(lsah
->length
) - OSPF_LSA_HEADER_SIZE
;
1324 for (tlvh
= TLV_HDR_TOP(lsah
); sum
< length
;
1325 tlvh
= TLV_HDR_NEXT(tlvh
)) {
1326 switch (ntohs(tlvh
->type
)) {
1327 case RI_TLV_CAPABILITIES
:
1328 sum
+= show_vty_router_cap(vty
, tlvh
);
1332 sum
+= TLV_HDR_SIZE
;
1333 sum
+= show_vty_pce_info(vty
, tlvh
, length
- sum
);
1335 case RI_SR_TLV_SR_ALGORITHM
:
1336 sum
+= show_vty_sr_algorithm(vty
, tlvh
);
1338 case RI_SR_TLV_SID_LABEL_RANGE
:
1339 sum
+= show_vty_sr_range(vty
, tlvh
);
1341 case RI_SR_TLV_NODE_MSD
:
1342 sum
+= show_vty_sr_msd(vty
, tlvh
);
1346 sum
+= show_vty_unknown_tlv(vty
, tlvh
);
1354 static void ospf_router_info_config_write_router(struct vty
*vty
)
1356 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1357 struct listnode
*node
;
1358 struct ri_pce_subtlv_domain
*domain
;
1359 struct ri_pce_subtlv_neighbor
*neighbor
;
1362 if (!OspfRI
.enabled
)
1365 if (OspfRI
.scope
== OSPF_OPAQUE_AS_LSA
)
1366 vty_out(vty
, " router-info as\n");
1368 vty_out(vty
, " router-info area %s\n",
1369 inet_ntoa(OspfRI
.area_id
));
1371 if (OspfRI
.pce_info
.enabled
) {
1373 if (pce
->pce_address
.header
.type
!= 0)
1374 vty_out(vty
, " pce address %s\n",
1375 inet_ntoa(pce
->pce_address
.address
.value
));
1377 if (pce
->pce_cap_flag
.header
.type
!= 0)
1378 vty_out(vty
, " pce flag 0x%x\n",
1379 ntohl(pce
->pce_cap_flag
.value
));
1381 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, domain
)) {
1382 if (domain
->header
.type
!= 0) {
1383 if (domain
->type
== PCE_DOMAIN_TYPE_AREA
) {
1384 tmp
.s_addr
= domain
->value
;
1385 vty_out(vty
, " pce domain area %s\n",
1388 vty_out(vty
, " pce domain as %d\n",
1389 ntohl(domain
->value
));
1394 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, neighbor
)) {
1395 if (neighbor
->header
.type
!= 0) {
1396 if (neighbor
->type
== PCE_DOMAIN_TYPE_AREA
) {
1397 tmp
.s_addr
= neighbor
->value
;
1398 vty_out(vty
, " pce neighbor area %s\n",
1401 vty_out(vty
, " pce neighbor as %d\n",
1402 ntohl(neighbor
->value
));
1407 if (pce
->pce_scope
.header
.type
!= 0)
1408 vty_out(vty
, " pce scope 0x%x\n",
1409 ntohl(OspfRI
.pce_info
.pce_scope
.value
));
1414 /*------------------------------------------------------------------------*
1415 * Followings are vty command functions.
1416 *------------------------------------------------------------------------*/
1419 router_info_area_cmd
,
1420 "router-info <as|area A.B.C.D>",
1422 "Enable the Router Information functionality with AS flooding scope\n"
1423 "Enable the Router Information functionality with Area flooding scope\n"
1424 "OSPF area ID in IP format\n")
1427 char *area
= (argc
== 3) ? argv
[idx_ipv4
]->arg
: NULL
;
1434 /* Check and get Area value if present */
1436 if (!inet_aton(area
, &OspfRI
.area_id
)) {
1437 vty_out(vty
, "%% specified Area ID %s is invalid\n",
1439 return CMD_WARNING_CONFIG_FAILED
;
1441 scope
= OSPF_OPAQUE_AREA_LSA
;
1443 OspfRI
.area_id
.s_addr
= 0;
1444 scope
= OSPF_OPAQUE_AS_LSA
;
1447 /* First start to register Router Information callbacks */
1448 if ((ospf_router_info_register(scope
)) != 0) {
1450 "%% Unable to register Router Information callbacks.");
1453 "Unable to register Router Information callbacks. Abort!");
1454 return CMD_WARNING_CONFIG_FAILED
;
1457 OspfRI
.enabled
= true;
1459 if (IS_DEBUG_OSPF_EVENT
)
1460 zlog_debug("RI-> Router Information (%s flooding): OFF -> ON",
1461 OspfRI
.scope
== OSPF_OPAQUE_AREA_LSA
? "Area"
1465 * Following code is intended to handle two cases;
1467 * 1) Router Information was disabled at startup time, but now become
1469 * 2) Router Information was once enabled then disabled, and now enabled
1473 initialize_params(&OspfRI
);
1475 /* Refresh RI LSA if already engaged */
1476 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
)) {
1477 zlog_debug("RI-> Refresh LSA following configuration");
1478 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1480 zlog_debug("RI-> Initial origination following configuration");
1481 ospf_router_info_lsa_schedule(REORIGINATE_THIS_LSA
);
1487 DEFUN (no_router_info
,
1491 "Disable the Router Information functionality\n")
1494 if (!OspfRI
.enabled
)
1497 if (IS_DEBUG_OSPF_EVENT
)
1498 zlog_debug("RI-> Router Information: ON -> OFF");
1500 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1501 ospf_router_info_lsa_schedule(FLUSH_THIS_LSA
);
1503 OspfRI
.enabled
= false;
1508 static int ospf_ri_enabled(struct vty
*vty
)
1514 vty_out(vty
, "%% OSPF RI is not turned on\n");
1521 "pce address A.B.C.D",
1523 "Stable IP address of the PCE\n"
1524 "PCE address in IPv4 address format\n")
1527 struct in_addr value
;
1528 struct ospf_pce_info
*pi
= &OspfRI
.pce_info
;
1530 if (!ospf_ri_enabled(vty
))
1531 return CMD_WARNING_CONFIG_FAILED
;
1533 if (!inet_aton(argv
[idx_ipv4
]->arg
, &value
)) {
1534 vty_out(vty
, "Please specify PCE Address by A.B.C.D\n");
1535 return CMD_WARNING_CONFIG_FAILED
;
1538 if (ntohs(pi
->pce_address
.header
.type
) == 0
1539 || ntohl(pi
->pce_address
.address
.value
.s_addr
)
1540 != ntohl(value
.s_addr
)) {
1542 set_pce_address(value
, pi
);
1544 /* Refresh RI LSA if already engaged */
1545 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1546 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1552 DEFUN (no_pce_address
,
1554 "no pce address [A.B.C.D]",
1557 "Disable PCE address\n"
1558 "PCE address in IPv4 address format\n")
1561 unset_param(&OspfRI
.pce_info
.pce_address
);
1563 /* Refresh RI LSA if already engaged */
1564 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1565 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1570 DEFUN (pce_path_scope
,
1572 "pce scope BITPATTERN",
1574 "Path scope visibilities of the PCE for path computation\n"
1575 "32-bit Hexadecimal value\n")
1577 int idx_bitpattern
= 2;
1579 struct ospf_pce_info
*pi
= &OspfRI
.pce_info
;
1581 if (!ospf_ri_enabled(vty
))
1582 return CMD_WARNING_CONFIG_FAILED
;
1584 if (sscanf(argv
[idx_bitpattern
]->arg
, "0x%x", &scope
) != 1) {
1585 vty_out(vty
, "pce_path_scope: fscanf: %s\n",
1586 safe_strerror(errno
));
1587 return CMD_WARNING_CONFIG_FAILED
;
1590 if (ntohl(pi
->pce_scope
.header
.type
) == 0
1591 || scope
!= pi
->pce_scope
.value
) {
1592 set_pce_path_scope(scope
, pi
);
1594 /* Refresh RI LSA if already engaged */
1595 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1596 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1602 DEFUN (no_pce_path_scope
,
1603 no_pce_path_scope_cmd
,
1604 "no pce scope [BITPATTERN]",
1607 "Disable PCE path scope\n"
1608 "32-bit Hexadecimal value\n")
1611 unset_param(&OspfRI
.pce_info
.pce_address
);
1613 /* Refresh RI LSA if already engaged */
1614 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1615 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1622 "pce domain as (0-65535)",
1624 "Configure PCE domain AS number\n"
1625 "AS number where the PCE as visibilities for path computation\n"
1626 "AS number in decimal <0-65535>\n")
1631 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1632 struct listnode
*node
;
1633 struct ri_pce_subtlv_domain
*domain
;
1635 if (!ospf_ri_enabled(vty
))
1636 return CMD_WARNING_CONFIG_FAILED
;
1638 if (sscanf(argv
[idx_number
]->arg
, "%" SCNu32
, &as
) != 1) {
1639 vty_out(vty
, "pce_domain: fscanf: %s\n", safe_strerror(errno
));
1640 return CMD_WARNING_CONFIG_FAILED
;
1643 /* Check if the domain is not already in the domain list */
1644 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, domain
)) {
1645 if (ntohl(domain
->header
.type
) == 0 && as
== domain
->value
)
1649 /* Create new domain if not found */
1650 set_pce_domain(PCE_DOMAIN_TYPE_AS
, as
, pce
);
1652 /* Refresh RI LSA if already engaged */
1653 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1654 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1659 DEFUN (no_pce_domain
,
1661 "no pce domain as (0-65535)",
1664 "Disable PCE domain AS number\n"
1665 "AS number where the PCE as visibilities for path computation\n"
1666 "AS number in decimal <0-65535>\n")
1671 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1673 if (sscanf(argv
[idx_number
]->arg
, "%" SCNu32
, &as
) != 1) {
1674 vty_out(vty
, "no_pce_domain: fscanf: %s\n",
1675 safe_strerror(errno
));
1676 return CMD_WARNING_CONFIG_FAILED
;
1679 /* Unset corresponding PCE domain */
1680 unset_pce_domain(PCE_DOMAIN_TYPE_AS
, as
, pce
);
1682 /* Refresh RI LSA if already engaged */
1683 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1684 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1689 DEFUN (pce_neigbhor
,
1691 "pce neighbor as (0-65535)",
1693 "Configure PCE neighbor domain AS number\n"
1694 "AS number of PCE neighbors\n"
1695 "AS number in decimal <0-65535>\n")
1700 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1701 struct listnode
*node
;
1702 struct ri_pce_subtlv_neighbor
*neighbor
;
1704 if (!ospf_ri_enabled(vty
))
1705 return CMD_WARNING_CONFIG_FAILED
;
1707 if (sscanf(argv
[idx_number
]->arg
, "%" SCNu32
, &as
) != 1) {
1708 vty_out(vty
, "pce_neighbor: fscanf: %s\n",
1709 safe_strerror(errno
));
1710 return CMD_WARNING_CONFIG_FAILED
;
1713 /* Check if the domain is not already in the domain list */
1714 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, neighbor
)) {
1715 if (ntohl(neighbor
->header
.type
) == 0 && as
== neighbor
->value
)
1719 /* Create new domain if not found */
1720 set_pce_neighbor(PCE_DOMAIN_TYPE_AS
, as
, pce
);
1722 /* Refresh RI LSA if already engaged */
1723 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1724 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1729 DEFUN (no_pce_neighbor
,
1730 no_pce_neighbor_cmd
,
1731 "no pce neighbor as (0-65535)",
1734 "Disable PCE neighbor AS number\n"
1735 "AS number of PCE neighbor\n"
1736 "AS number in decimal <0-65535>\n")
1741 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1743 if (sscanf(argv
[idx_number
]->arg
, "%" SCNu32
, &as
) != 1) {
1744 vty_out(vty
, "no_pce_neighbor: fscanf: %s\n",
1745 safe_strerror(errno
));
1746 return CMD_WARNING_CONFIG_FAILED
;
1749 /* Unset corresponding PCE domain */
1750 unset_pce_neighbor(PCE_DOMAIN_TYPE_AS
, as
, pce
);
1752 /* Refresh RI LSA if already engaged */
1753 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1754 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1759 DEFUN (pce_cap_flag
,
1761 "pce flag BITPATTERN",
1763 "Capabilities of the PCE for path computation\n"
1764 "32-bit Hexadecimal value\n")
1766 int idx_bitpattern
= 2;
1769 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1771 if (!ospf_ri_enabled(vty
))
1772 return CMD_WARNING_CONFIG_FAILED
;
1774 if (sscanf(argv
[idx_bitpattern
]->arg
, "0x%x", &cap
) != 1) {
1775 vty_out(vty
, "pce_cap_flag: fscanf: %s\n",
1776 safe_strerror(errno
));
1777 return CMD_WARNING_CONFIG_FAILED
;
1780 if (ntohl(pce
->pce_cap_flag
.header
.type
) == 0
1781 || cap
!= pce
->pce_cap_flag
.value
) {
1782 set_pce_cap_flag(cap
, pce
);
1784 /* Refresh RI LSA if already engaged */
1785 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1786 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1792 DEFUN (no_pce_cap_flag
,
1793 no_pce_cap_flag_cmd
,
1797 "Disable PCE capabilities\n")
1800 unset_param(&OspfRI
.pce_info
.pce_cap_flag
);
1802 /* Refresh RI LSA if already engaged */
1803 if (CHECK_FLAG(OspfRI
.flags
, RIFLG_LSA_ENGAGED
))
1804 ospf_router_info_lsa_schedule(REFRESH_THIS_LSA
);
1809 DEFUN (show_ip_ospf_router_info
,
1810 show_ip_ospf_router_info_cmd
,
1811 "show ip ospf router-info",
1815 "Router Information\n")
1818 if (OspfRI
.enabled
) {
1819 vty_out(vty
, "--- Router Information parameters ---\n");
1820 show_vty_router_cap(vty
, &OspfRI
.router_cap
.header
);
1824 " Router Information is disabled on this router\n");
1829 DEFUN (show_ip_opsf_router_info_pce
,
1830 show_ip_ospf_router_info_pce_cmd
,
1831 "show ip ospf router-info pce",
1835 "Router Information\n"
1836 "PCE information\n")
1839 struct ospf_pce_info
*pce
= &OspfRI
.pce_info
;
1840 struct listnode
*node
;
1841 struct ri_pce_subtlv_domain
*domain
;
1842 struct ri_pce_subtlv_neighbor
*neighbor
;
1844 if ((OspfRI
.enabled
) && (OspfRI
.pce_info
.enabled
)) {
1845 vty_out(vty
, "--- PCE parameters ---\n");
1847 if (pce
->pce_address
.header
.type
!= 0)
1848 show_vty_pce_subtlv_address(vty
,
1849 &pce
->pce_address
.header
);
1851 if (pce
->pce_scope
.header
.type
!= 0)
1852 show_vty_pce_subtlv_path_scope(vty
,
1853 &pce
->pce_scope
.header
);
1855 for (ALL_LIST_ELEMENTS_RO(pce
->pce_domain
, node
, domain
)) {
1856 if (domain
->header
.type
!= 0)
1857 show_vty_pce_subtlv_domain(vty
,
1861 for (ALL_LIST_ELEMENTS_RO(pce
->pce_neighbor
, node
, neighbor
)) {
1862 if (neighbor
->header
.type
!= 0)
1863 show_vty_pce_subtlv_neighbor(vty
,
1867 if (pce
->pce_cap_flag
.header
.type
!= 0)
1868 show_vty_pce_subtlv_cap_flag(vty
,
1869 &pce
->pce_cap_flag
.header
);
1872 vty_out(vty
, " PCE info is disabled on this router\n");
1878 /* Install new CLI commands */
1879 static void ospf_router_info_register_vty(void)
1881 install_element(VIEW_NODE
, &show_ip_ospf_router_info_cmd
);
1882 install_element(VIEW_NODE
, &show_ip_ospf_router_info_pce_cmd
);
1884 install_element(OSPF_NODE
, &router_info_area_cmd
);
1885 install_element(OSPF_NODE
, &no_router_info_cmd
);
1886 install_element(OSPF_NODE
, &pce_address_cmd
);
1887 install_element(OSPF_NODE
, &no_pce_address_cmd
);
1888 install_element(OSPF_NODE
, &pce_path_scope_cmd
);
1889 install_element(OSPF_NODE
, &no_pce_path_scope_cmd
);
1890 install_element(OSPF_NODE
, &pce_domain_cmd
);
1891 install_element(OSPF_NODE
, &no_pce_domain_cmd
);
1892 install_element(OSPF_NODE
, &pce_neighbor_cmd
);
1893 install_element(OSPF_NODE
, &no_pce_neighbor_cmd
);
1894 install_element(OSPF_NODE
, &pce_cap_flag_cmd
);
1895 install_element(OSPF_NODE
, &no_pce_cap_flag_cmd
);