portsyncd: Adding ConfigDone notification in portsyncd (#17)

As most of the applications depend on port initialization, we add
a 'ConfigDone' notification in portsyncd after finishing reading
the file 'port_config.ini'. Before orchagent receives this notification,
all other tasks from other applications are stored without actually
being executed. Only when the orchagent get this notification will all
other tasks been executed.

Signed-off-by: Shuotian Cheng <shuche@microsoft.com>

orchagent/intfsorch.cpp

@@ -25,6 +25,9 @@ void IntfsOrch::doTask(Consumer &consumer)
     if (consumer.m_toSync.empty())
         return;
 
+    if (!m_portsOrch->isInitDone())
+        return;
+
     auto it = consumer.m_toSync.begin();
     while (it != consumer.m_toSync.end())
     {

orchagent/neighorch.cpp

@@ -12,6 +12,9 @@ void NeighOrch::doTask(Consumer &consumer)
     if (consumer.m_toSync.empty())
         return;
 
+    if (!m_portsOrch->isInitDone())
+        return;
+
     auto it = consumer.m_toSync.begin();
     while (it != consumer.m_toSync.end())
     {

orchagent/portsorch.cpp

@@ -142,6 +142,11 @@ PortsOrch::PortsOrch(DBConnector *db, string tableName) :
     }
 }
 
+bool PortsOrch::isInitDone()
+{
+    return m_initDone;
+}
+
 bool PortsOrch::getPort(string alias, Port &p)
 {
     if (m_portList.find(alias) == m_portList.end())
@@ -182,6 +187,25 @@ void PortsOrch::doTask(Consumer &consumer)
         string alias = kfvKey(t);
         string op = kfvOp(t);
 
+        /* Get notification from application */
+        /* portsyncd application:
+         * When portsorch receives 'ConfigDone' message, it indicates port initialization
+         * procedure is done. Before port initialization procedure, none of other tasks
+         * are executed.
+         */
+        if (alias == "ConfigDone")
+        {
+            /* portsyncd restarting case:
+             * When portsyncd restarts, duplicate notifications may be received.
+             */
+            if (m_initDone)
+                return;
+
+            m_initDone = true;
+            SWSS_LOG_INFO("Get ConfigDone notification from portsyncd.\n");
+            return;
+        }
+
         if (op == "SET")
         {
             set<int> lane_set;

orchagent/portsorch.h

@@ -13,11 +13,14 @@ class PortsOrch : public Orch
 public:
     PortsOrch(DBConnector *db, string tableName);
 
+    bool isInitDone();
+
     bool getPort(string alias, Port &p);
 
     bool setPortAdminStatus(sai_object_id_t id, bool up);
 
 private:
+    bool m_initDone = false;
     sai_object_id_t m_cpuPort;
 
     sai_uint32_t m_portCount;

orchagent/routeorch.cpp

@@ -14,6 +14,9 @@ void RouteOrch::doTask(Consumer& consumer)
     if (consumer.m_toSync.empty())
         return;
 
+    if (!m_portsOrch->isInitDone())
+        return;
+
     auto it = consumer.m_toSync.begin();
     while (it != consumer.m_toSync.end())
     {

portsyncd/portsyncd.cpp

@@ -29,7 +29,7 @@ int main(int argc, char **argv)
     int opt;
     string port_config_file = DEFAULT_PORT_CONFIG_FILE;
 
-    while ((opt = getopt(argc, argv, "f:")) != -1 )
+    while ((opt = getopt(argc, argv, "f:h")) != -1 )
     {
         switch (opt)
         {
@@ -56,6 +56,8 @@ int main(int argc, char **argv)
         return EXIT_FAILURE;
     }
 
+    cout << "Read port configuration file..." << endl;
+
     string line;
     while (getline(infile, line))
     {
@@ -73,6 +75,17 @@ int main(int argc, char **argv)
         p.set(alias, attrs);
     }
 
+    infile.close();
+
+    /*
+     * After finishing reading port configuration file, this daemon shall send
+     * out a signal to orchagent indicating port initialization procedure is
+     * done and other application could start syncing.
+     */
+    FieldValueTuple finish_notice("lanes", "0");
+    vector<FieldValueTuple> attrs = { finish_notice };
+    p.set("ConfigDone", attrs);
+
     LinkSync sync(&db);
     NetDispatcher::getInstance().registerMessageHandler(RTM_NEWLINK, &sync);
     NetDispatcher::getInstance().registerMessageHandler(RTM_DELLINK, &sync);
@@ -85,7 +98,7 @@ int main(int argc, char **argv)
             Select s;
 
             netlink.registerGroup(RTNLGRP_LINK);
-            cout << "Listens to link messages..." << endl;
+            cout << "Listen to link messages..." << endl;
             netlink.dumpRequest(RTM_GETLINK);
 
             s.addSelectable(&netlink);