ospfd: add error codes and improve operator messaging

Convert generic zlog_err() calls to specific flog_err() calls by adding
appropriate error codes in ospfd component.

This commit adds new error codes and converts logging calls to improve
error categorization and diagnosis. Additionally, error message
formatting has been improved to ensure character length per line.

Signed-off-by: Vaideesh Ravi Shankar <[email protected]>

Author: rvaideesh

ospfd/ospf_errors.c

@@ -166,7 +166,25 @@ static struct log_ref ferr_ospf_err[] = {
 		.code = EC_OSPF_LARGE_HELLO,
 		.title = "OSPF Encountered a Large Hello",
 		.description = "OSPF attempted to send a Hello larger than MTU but did not",
-		.suggestion = "Too many neighbors configured on a single interface. Suggestion is to decrease the number of neighbors on a single interface/subnet"
+		.suggestion = "Too many neighbors configured on a single interface. Suggestion is to decrease the number of neighbors on a single interface/subnet",
+	},
+	{
+		.code = EC_OSPF_LDP_SYNC_DOWN,
+		.title = "OSPF LDP synchronization down",
+		.description = "OSPF-LDP sync detected that LDP session went down",
+		.suggestion = "Check LDP sessions and restart LDP if necessary. Verify OSPF-LDP sync configuration.",
+	},
+	{
+		.code = EC_OSPF_CONFIG_TIMEOUT,
+		.title = "OSPF configuration timeout",
+		.description = "OSPF configuration end timer expired during config application",
+		.suggestion = "Review configuration timing or increase the timeout limit.",
+	},
+	{
+		.code = EC_OSPF_SR_RI_SCOPE,
+		.title = "OSPF Segment Routing router-info scope error",
+		.description = "OSPF Segment Routing router-info LSA uses incorrect flooding scope (should be Area scope, not AS scope)",
+		.suggestion = "Change router-info flooding scope to Area flooding for Segment Routing configuration.",
 	},
 	{
 		.code = END_FERR,

ospfd/ospf_errors.h

@@ -36,6 +36,9 @@ enum ospf_log_refs {
 	EC_OSPF_PTP_NEIGHBOR,
 	EC_OSPF_LSA_SIZE,
 	EC_OSPF_LARGE_HELLO,
+	EC_OSPF_LDP_SYNC_DOWN,
+	EC_OSPF_CONFIG_TIMEOUT,
+	EC_OSPF_SR_RI_SCOPE,
 };
 
 extern void ospf_error_init(void);

ospfd/ospf_gr_helper.c

@@ -18,6 +18,7 @@
 #include "filter.h"
 #include "log.h"
 #include "jhash.h"
+#include "lib/lib_errors.h"
 
 #include "ospfd/ospfd.h"
 #include "ospfd/ospf_interface.h"
@@ -688,8 +689,8 @@ void ospf_gr_helper_exit(struct ospf_neighbor *nbr,
 	ospf->last_exit_reason = reason;
 
 	if (ospf->active_restarter_cnt <= 0) {
-		zlog_err(
-			"OSPF GR-Helper: active_restarter_cnt should be greater than zero here.");
+		flog_err(EC_LIB_DEVELOPMENT,
+			 "OSPF GR-Helper: active_restarter_cnt should be greater than zero here.");
 		return;
 	}
 	/* Decrement active Restarter count */

ospfd/ospf_ldp_sync.c

@@ -20,6 +20,7 @@
 #include <lib/json.h>
 #include "defaults.h"
 #include "ldp_sync.h"
+#include "ospfd/ospf_errors.h"
 
 #include "ospfd.h"
 #include "ospf_interface.h"
@@ -213,7 +214,7 @@ void ospf_ldp_sync_handle_client_close(struct zapi_client_close_info *info)
 	 *  set cost to LSInfinity
 	 *  send request to LDP for LDP-SYNC state for each interface
 	 */
-	zlog_err("%s: LDP down", __func__);
+	flog_err(EC_OSPF_LDP_SYNC_DOWN, "%s: LDP down", __func__);
 
 	vrf = vrf_lookup_by_id(ospf->vrf_id);
 	FOR_ALL_INTERFACES (vrf, ifp)

ospfd/ospf_lsa.c

@@ -19,6 +19,7 @@
 #include "sockunion.h" /* for inet_aton() */
 #include "checksum.h"
 #include "network.h"
+#include "lib/lib_errors.h"
 
 #include "ospfd/ospfd.h"
 #include "ospfd/ospf_interface.h"
@@ -887,7 +888,7 @@ static struct ospf_lsa *ospf_router_lsa_originate(struct ospf_area *area)
 
 	/* Create new router-LSA instance. */
 	if ((new = ospf_router_lsa_new(area)) == NULL) {
-		zlog_err("%s: ospf_router_lsa_new returned NULL", __func__);
+		flog_err(EC_LIB_DEVELOPMENT, "%s: ospf_router_lsa_new returned NULL", __func__);
 		return NULL;
 	}
 
@@ -935,7 +936,7 @@ static struct ospf_lsa *ospf_router_lsa_refresh(struct ospf_lsa *lsa)
 
 	/* Create new router-LSA instance. */
 	if ((new = ospf_router_lsa_new(area)) == NULL) {
-		zlog_err("%s: ospf_router_lsa_new returned NULL", __func__);
+		flog_err(EC_LIB_DEVELOPMENT, "%s: ospf_router_lsa_new returned NULL", __func__);
 		return NULL;
 	}
 

ospfd/ospf_main.c

@@ -176,7 +176,7 @@ FRR_DAEMON_INFO(ospfd, OSPF,
 
 static void ospf_config_finish(struct event *t)
 {
-	zlog_err("OSPF configuration end timer expired after %d seconds.",
+	flog_err(EC_OSPF_CONFIG_TIMEOUT, "OSPF configuration end timer expired after %d seconds.",
 		 OSPF_PRE_CONFIG_MAX_WAIT_SECONDS);
 }
 

ospfd/ospf_ri.c

@@ -603,10 +603,9 @@ void ospf_router_info_update_sr(bool enable, struct sr_node *srn)
 
 	/* Verify that scope is AREA */
 	if (OspfRI.scope != OSPF_OPAQUE_AREA_LSA) {
-		zlog_err(
-			"RI (%s): Router Info is %s flooding: Change scope to Area flooding for Segment Routing",
-			__func__,
-			OspfRI.scope == OSPF_OPAQUE_AREA_LSA ? "Area" : "AS");
+		flog_err(EC_OSPF_SR_RI_SCOPE,
+			 "RI (%s): Router Info is %s flooding: Change scope to Area flooding for Segment Routing",
+			 __func__, OspfRI.scope == OSPF_OPAQUE_AREA_LSA ? "Area" : "AS");
 		return;
 	}
 

ospfd/ospf_sr.c

@@ -266,7 +266,7 @@ static int sr_local_block_init(uint32_t lower_bound, uint32_t upper_bound)
 	 */
 	size = upper_bound - lower_bound + 1;
 	if (ospf_zebra_request_label_range(lower_bound, size)) {
-		zlog_err("SR: Error reserving SRLB [%u/%u] %u labels",
+		flog_err(EC_OSPF_SR_SID_OVERFLOW, "SR: Error reserving SRLB [%u/%u] %u labels",
 			 lower_bound, upper_bound, size);
 		return -1;
 	}
@@ -301,8 +301,8 @@ static int sr_global_block_init(uint32_t start, uint32_t size)
 	/* request chunk */
 	uint32_t end = start + size - 1;
 	if (ospf_zebra_request_label_range(start, size) < 0) {
-		zlog_err("SR: Error reserving SRGB [%u/%u], %u labels", start,
-			 end, size);
+		flog_err(EC_OSPF_SR_SID_OVERFLOW, "SR: Error reserving SRGB [%u/%u], %u labels",
+			 start, end, size);
 		return -1;
 	}