fix 'exit' bug in config file processing, et al. (backport #13763)

lib/mgmt_be_client.c

@@ -21,7 +21,7 @@
 #include "lib/mgmt_be_client_clippy.c"
 
 #define MGMTD_BE_CLIENT_DBG(fmt, ...)                                          \
-	DEBUGD(&mgmt_dbg_be_client, "BE-CLIENT: %s:" fmt, __func__,            \
+	DEBUGD(&mgmt_dbg_be_client, "BE-CLIENT: %s: " fmt, __func__,           \
 	       ##__VA_ARGS__)
 #define MGMTD_BE_CLIENT_ERR(fmt, ...)                                          \
 	zlog_err("BE-CLIENT: %s: ERROR: " fmt, __func__, ##__VA_ARGS__)

lib/mgmt_fe_client.c

@@ -124,18 +124,15 @@ static int mgmt_fe_send_session_req(struct mgmt_fe_client *client,
 {
 	Mgmtd__FeMessage fe_msg;
 	Mgmtd__FeSessionReq sess_req;
-	bool scok;
 
 	mgmtd__fe_session_req__init(&sess_req);
 	sess_req.create = create;
 	if (create) {
 		sess_req.id_case = MGMTD__FE_SESSION_REQ__ID_CLIENT_CONN_ID;
 		sess_req.client_conn_id = session->client_id;
-		scok = true;
 	} else {
 		sess_req.id_case = MGMTD__FE_SESSION_REQ__ID_SESSION_ID;
 		sess_req.session_id = session->session_id;
-		scok = false;
 	}
 
 	mgmtd__fe_message__init(&fe_msg);
@@ -146,7 +143,7 @@ static int mgmt_fe_send_session_req(struct mgmt_fe_client *client,
 		"Sending SESSION_REQ %s message for client-id %" PRIu64,
 		create ? "create" : "destroy", session->client_id);
 
-	return mgmt_fe_client_send_msg(client, &fe_msg, scok);
+	return mgmt_fe_client_send_msg(client, &fe_msg, true);
 }
 
 int mgmt_fe_send_lockds_req(struct mgmt_fe_client *client, uint64_t session_id,

lib/mgmt_fe_client.h

@@ -120,7 +120,7 @@ struct mgmt_fe_client_cbs {
 extern struct debug mgmt_dbg_fe_client;
 
 #define MGMTD_FE_CLIENT_DBG(fmt, ...)                                          \
-	DEBUGD(&mgmt_dbg_fe_client, "FE-CLIENT: %s:" fmt, __func__,            \
+	DEBUGD(&mgmt_dbg_fe_client, "FE-CLIENT: %s: " fmt, __func__,           \
 	       ##__VA_ARGS__)
 #define MGMTD_FE_CLIENT_ERR(fmt, ...)                                          \
 	zlog_err("FE-CLIENT: %s: ERROR: " fmt, __func__, ##__VA_ARGS__)

lib/vty.c

@@ -2423,6 +2423,14 @@ void vty_close(struct vty *vty)
 
 	vty->status = VTY_CLOSE;
 
+	/*
+	 * If we reach here with pending config to commit we will be losing it
+	 * so warn the user.
+	 */
+	if (vty->mgmt_num_pending_setcfg)
+		MGMTD_FE_CLIENT_ERR(
+			"vty closed, uncommitted config will be lost.");
+
 	if (mgmt_fe_client && vty->mgmt_session_id) {
 		MGMTD_FE_CLIENT_DBG("closing vty session");
 		mgmt_fe_destroy_client_session(mgmt_fe_client,
@@ -3445,7 +3453,9 @@ static void vty_mgmt_session_notify(struct mgmt_fe_client *client,
 		vty->mgmt_session_id = session_id;
 	} else {
 		vty->mgmt_session_id = 0;
-		vty_close(vty);
+		/* We may come here by way of vty_close() and short-circuits */
+		if (vty->status != VTY_CLOSE)
+			vty_close(vty);
 	}
 }
 

mgmtd/mgmt_be_adapter.c

@@ -20,7 +20,7 @@
 #include "mgmtd/mgmt_be_adapter.h"
 
 #define MGMTD_BE_ADAPTER_DBG(fmt, ...)                                         \
-	DEBUGD(&mgmt_debug_be, "BE-ADAPTER: %s:" fmt, __func__, ##__VA_ARGS__)
+	DEBUGD(&mgmt_debug_be, "BE-ADAPTER: %s: " fmt, __func__, ##__VA_ARGS__)
 #define MGMTD_BE_ADAPTER_ERR(fmt, ...)                                         \
 	zlog_err("BE-ADAPTER: %s: ERROR: " fmt, __func__, ##__VA_ARGS__)
 

mgmtd/mgmt_ds.c

@@ -16,7 +16,7 @@
 #include "libyang/libyang.h"
 
 #define MGMTD_DS_DBG(fmt, ...)                                                 \
-	DEBUGD(&mgmt_debug_ds, "%s:" fmt, __func__, ##__VA_ARGS__)
+	DEBUGD(&mgmt_debug_ds, "DS: %s: " fmt, __func__, ##__VA_ARGS__)
 #define MGMTD_DS_ERR(fmt, ...)                                                 \
 	zlog_err("%s: ERROR: " fmt, __func__, ##__VA_ARGS__)
 

mgmtd/mgmt_fe_adapter.c

@@ -21,7 +21,7 @@
 #include "mgmtd/mgmt_fe_adapter.h"
 
 #define MGMTD_FE_ADAPTER_DBG(fmt, ...)                                         \
-	DEBUGD(&mgmt_debug_fe, "FE-ADAPTER: %s:" fmt, __func__, ##__VA_ARGS__)
+	DEBUGD(&mgmt_debug_fe, "FE-ADAPTER: %s: " fmt, __func__, ##__VA_ARGS__)
 #define MGMTD_FE_ADAPTER_ERR(fmt, ...)                                         \
 	zlog_err("FE-ADAPTER: %s: ERROR: " fmt, __func__, ##__VA_ARGS__)
 

mgmtd/mgmt_txn.c

@@ -15,7 +15,7 @@
 #include "mgmtd/mgmt_txn.h"
 
 #define MGMTD_TXN_DBG(fmt, ...)                                                \
-	DEBUGD(&mgmt_debug_txn, "%s:" fmt, __func__, ##__VA_ARGS__)
+	DEBUGD(&mgmt_debug_txn, "TXN: %s: " fmt, __func__, ##__VA_ARGS__)
 #define MGMTD_TXN_ERR(fmt, ...)                                                \
 	zlog_err("%s: ERROR: " fmt, __func__, ##__VA_ARGS__)
 
@@ -2618,26 +2618,6 @@ int mgmt_txn_notify_be_cfg_apply_reply(uint64_t txn_id, bool success,
 	return 0;
 }
 
-int mgmt_txn_send_commit_config_reply(uint64_t txn_id,
-				       enum mgmt_result result,
-				       const char *error_if_any)
-{
-	struct mgmt_txn_ctx *txn;
-
-	txn = mgmt_txn_id2ctx(txn_id);
-	if (!txn)
-		return -1;
-
-	if (!txn->commit_cfg_req) {
-		MGMTD_TXN_ERR("NO commit in-progress txn-id: %" PRIu64
-			      " session-id: %" PRIu64,
-			      txn->txn_id, txn->session_id);
-		return -1;
-	}
-
-	return mgmt_txn_send_commit_cfg_reply(txn, result, error_if_any);
-}
-
 int mgmt_txn_send_get_config_req(uint64_t txn_id, uint64_t req_id,
 				  Mgmtd__DatastoreId ds_id,
 				  struct mgmt_ds_ctx *ds_ctx,

mgmtd/mgmt_txn.h

@@ -176,10 +176,6 @@ extern int mgmt_txn_send_commit_config_req(uint64_t txn_id, uint64_t req_id,
 					    bool validate_only, bool abort,
 					    bool implicit);
 
-extern int mgmt_txn_send_commit_config_reply(uint64_t txn_id,
-					      enum mgmt_result result,
-					      const char *error_if_any);
-
 /*
  * Send get-config request to be processed later in transaction.
  *

staticd/static_main.c

@@ -56,11 +56,11 @@ struct event_loop *master;
 struct mgmt_be_client *mgmt_be_client;
 
 static struct frr_daemon_info staticd_di;
+
 /* SIGHUP handler. */
 static void sighup(void)
 {
-	zlog_info("SIGHUP received");
-	vty_read_config(NULL, staticd_di.config_file, config_default);
+	zlog_info("SIGHUP received and ignored");
 }
 
 /* SIGINT / SIGTERM handler. */

tests/topotests/mgmt_config/r1/early-end-zebra.conf

@@ -0,0 +1,6 @@
+allow-external-route-update
+end
+ip multicast rpf-lookup-mode urib-only
+end
+ip table range 2 3
+end

tests/topotests/mgmt_config/r1/early-end.conf

@@ -0,0 +1,8 @@
+ip route 15.1.0.0/24 101.0.0.2
+end
+ip route 15.2.0.0/24 101.0.0.2
+end
+ip route 15.3.0.0/24 101.0.0.2
+end
+ip route 15.4.0.0/24 101.0.0.2
+end

tests/topotests/mgmt_config/r1/early-end2-zebra.conf

@@ -0,0 +1,7 @@
+conf t
+allow-external-route-update
+end
+ip multicast rpf-lookup-mode urib-only
+end
+ip table range 2 3
+end

tests/topotests/mgmt_config/r1/early-end2.conf

@@ -0,0 +1,9 @@
+conf t
+ip route 16.1.0.0/24 101.0.0.2
+end
+ip route 16.2.0.0/24 101.0.0.2
+end
+ip route 16.3.0.0/24 101.0.0.2
+end
+ip route 16.4.0.0/24 101.0.0.2
+end

tests/topotests/mgmt_config/r1/early-exit-zebra.conf

@@ -0,0 +1,6 @@
+allow-external-route-update
+exit
+ip multicast rpf-lookup-mode urib-only
+exit
+ip table range 2 3
+exit

tests/topotests/mgmt_config/r1/early-exit.conf

@@ -0,0 +1,8 @@
+ip route 13.1.0.0/24 101.0.0.2
+exit
+ip route 13.2.0.0/24 101.0.0.2
+exit
+ip route 13.3.0.0/24 101.0.0.2
+exit
+ip route 13.4.0.0/24 101.0.0.2
+exit

tests/topotests/mgmt_config/r1/early-exit2-zebra.conf

@@ -0,0 +1,7 @@
+conf t
+allow-external-route-update
+exit
+ip multicast rpf-lookup-mode urib-only
+exit
+ip table range 2 3
+exit

tests/topotests/mgmt_config/r1/early-exit2.conf

@@ -0,0 +1,9 @@
+conf t
+ip route 14.1.0.0/24 101.0.0.2
+exit
+ip route 14.2.0.0/24 101.0.0.2
+exit
+ip route 14.3.0.0/24 101.0.0.2
+exit
+ip route 14.4.0.0/24 101.0.0.2
+exit

tests/topotests/mgmt_config/r1/mgmtd.conf

@@ -0,0 +1,11 @@
+debug northbound notifications
+debug northbound libyang
+debug northbound events
+debug northbound callbacks
+debug mgmt backend datastore frontend transaction
+debug mgmt client backend
+debug mgmt client frontend
+
+ip route 12.0.0.0/24 101.0.0.2
+
+ipv6 route 2012::/48 2101::2

tests/topotests/mgmt_config/r1/normal-exit.conf

@@ -0,0 +1,8 @@
+ip route 13.1.0.0/24 101.0.0.2
+exit
+ip route 13.2.0.0/24 101.0.0.2
+exit
+ip route 13.3.0.0/24 101.0.0.2
+exit
+ip route 13.4.0.0/24 101.0.0.2
+exit

tests/topotests/mgmt_config/r1/one-exit-zebra.conf

@@ -0,0 +1,3 @@
+allow-external-route-update
+exit
+ip multicast rpf-lookup-mode urib-only

tests/topotests/mgmt_config/r1/one-exit.conf

@@ -0,0 +1,3 @@
+ip route 20.1.0.0/24 101.0.0.2
+exit
+ip route 20.2.0.0/24 101.0.0.2

tests/topotests/mgmt_config/r1/one-exit2-zebra.conf

@@ -0,0 +1,4 @@
+conf t
+allow-external-route-update
+exit
+ip multicast rpf-lookup-mode urib-only

tests/topotests/mgmt_config/r1/one-exit2.conf

@@ -0,0 +1,4 @@
+conf t
+ip route 21.1.0.0/24 101.0.0.2
+exit
+ip route 21.2.0.0/24 101.0.0.2

tests/topotests/mgmt_config/r1/zebra.conf

@@ -0,0 +1,7 @@
+log timestamp precision 6
+log file frr-r1.log debug
+
+interface r1-eth0
+  ip address 101.0.0.1/24
+  ipv6 address 2101::1/64
+exit