Create NSF notification manager api

Author: mint570

common/warm_restart.cpp

@@ -6,6 +6,9 @@
 
 namespace swss {
 
+const std::string WarmStart::kNsfManagerNotificationChannel =
+    "NSF_MANAGER_COMMON_NOTIFICATION_CHANNEL";
+
 const WarmStart::WarmStartStateNameMap* WarmStart::warmStartStateNameMap()
 {
     static const auto* const warmStartStateNameMap =
@@ -35,6 +38,28 @@ const WarmStart::DataCheckStateNameMap* WarmStart::dataCheckStateNameMap()
     return dataCheckStateNameMap;
 }
 
+const WarmStart::WarmBootNotificationNameMap* WarmStart::warmBootNotificationNameMap()
+{
+    static const auto* const  warmBootNotificationNameMap =
+        new WarmBootNotificationNameMap({
+          {WarmBootNotification::kFreeze,         "freeze"},
+          {WarmBootNotification::kUnfreeze,       "unfreeze"},
+          {WarmBootNotification::kCheckpoint,     "checkpoint"},
+        });
+    return warmBootNotificationNameMap;
+}
+
+const WarmStart::WarmBootNotificationReverseMap* WarmStart::warmBootNotificationReverseMap()
+{
+    static const auto* const  warmBootNotificationReverseMap =
+        new WarmBootNotificationReverseMap({
+          {"freeze",     WarmBootNotification::kFreeze},
+          {"unfreeze",   WarmBootNotification::kUnfreeze},
+          {"checkpoint", WarmBootNotification::kCheckpoint},
+        });
+    return warmBootNotificationReverseMap;
+}
+
 WarmStart &WarmStart::getInstance(void)
 {
     static WarmStart m_warmStart;
@@ -300,4 +325,4 @@ WarmStart::DataCheckState WarmStart::getDataCheckState(const std::string &app_na
     return state;
 }
 
-}
+} // namespace swss

common/warm_restart.h

@@ -13,6 +13,8 @@ namespace swss {
 class WarmStart
 {
 public:
+    static const std::string kNsfManagerNotificationChannel;
+
     enum WarmStartState
     {
         INITIALIZED,
@@ -40,12 +42,24 @@ class WarmStart
         STAGE_RESTORE,
     };
 
+    enum class WarmBootNotification {
+        kFreeze,
+        kUnfreeze,
+        kCheckpoint,
+    };
+
     typedef std::map<WarmStartState, std::string>  WarmStartStateNameMap;
     static const WarmStartStateNameMap* warmStartStateNameMap();
 
     typedef std::map<DataCheckState, std::string>  DataCheckStateNameMap;
     static const DataCheckStateNameMap* dataCheckStateNameMap();
 
+    typedef std::map<WarmBootNotification, std::string>  WarmBootNotificationNameMap;
+    static const WarmBootNotificationNameMap* warmBootNotificationNameMap();
+
+    typedef std::map<std::string, WarmBootNotification>  WarmBootNotificationReverseMap;
+    static const WarmBootNotificationReverseMap* warmBootNotificationReverseMap();
+
     static WarmStart &getInstance(void);
 
     static void initialize(const std::string &app_name,
@@ -75,7 +89,7 @@ class WarmStart
                                   DataCheckState state);
 
     static DataCheckState getDataCheckState(const std::string &app_name,
-                                                       DataCheckStage stage);
+                                            DataCheckStage stage);
 private:
     std::shared_ptr<swss::DBConnector>   m_stateDb;
     std::shared_ptr<swss::DBConnector>   m_cfgDb;

tests/warm_restart_ut.cpp

@@ -1,8 +1,8 @@
 #include <iostream>
 #include "gtest/gtest.h"
 #include "common/dbconnector.h"
-#include "common/table.h"
 #include "common/schema.h"
+#include "common/table.h"
 #include "common/warm_restart.h"
 
 using namespace std;
@@ -278,3 +278,20 @@ TEST(WarmRestart, set_get_DataCheckState)
     state = WarmStart::getDataCheckState(testAppName, WarmStart::STAGE_RESTORE);
     EXPECT_EQ(state, WarmStart::CHECK_FAILED);
 }
+
+TEST(WarmRestart, testNotificationMaps)
+{
+    WarmStart::WarmBootNotification warmBootNotifications[] =
+        {
+            WarmStart::WarmBootNotification::kFreeze,
+            WarmStart::WarmBootNotification::kUnfreeze,
+            WarmStart::WarmBootNotification::kCheckpoint,
+        };
+
+    for (const auto &currNotification : warmBootNotifications) {
+        std::string type = WarmStart::warmBootNotificationNameMap()->at(currNotification);
+        WarmStart::WarmBootNotification notification;
+        notification = WarmStart::warmBootNotificationReverseMap()->at(type);
+        EXPECT_EQ(notification, currNotification);
+    }
+}