[SaiInterface] Support sai_query_api_version api (#1383)

Will be needed in later consolidation code
sonic-net · May 26, 2024 · 20bcfe1 · 20bcfe1
1 parent c3ad5ce
commit 20bcfe1
Show file tree

Hide file tree

Showing 32 changed files with 302 additions and 50 deletions.
diff --git a/lib/ClientSai.cpp b/lib/ClientSai.cpp
@@ -1497,3 +1497,15 @@ sai_status_t ClientSai::logSet(
 
     return SAI_STATUS_SUCCESS;
 }
+
+sai_status_t ClientSai::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    MUTEX();
+    SWSS_LOG_ENTER();
+    REDIS_CHECK_API_INITIALIZED();
+
+    SWSS_LOG_ERROR("queryApiVersion not implemented, FIXME");
+
+    return SAI_STATUS_NOT_IMPLEMENTED;
+}
diff --git a/lib/ClientSai.h b/lib/ClientSai.h
@@ -175,6 +175,9 @@ namespace sairedis
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         private: // QUAD API helpers
 
             sai_status_t create(

diff --git a/lib/ClientServerSai.cpp b/lib/ClientServerSai.cpp
@@ -592,3 +592,13 @@ sai_status_t ClientServerSai::logSet(
 
     return m_sai->logSet(api, log_level);
 }
+
+sai_status_t ClientServerSai::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    MUTEX();
+    SWSS_LOG_ENTER();
+    REDIS_CHECK_API_INITIALIZED();
+
+    return m_sai->queryApiVersion(version);
+}
diff --git a/lib/ClientServerSai.h b/lib/ClientServerSai.h
@@ -167,6 +167,9 @@ namespace sairedis
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         private:
 
             bool m_apiInitialized;

diff --git a/lib/RedisRemoteSaiInterface.cpp b/lib/RedisRemoteSaiInterface.cpp
@@ -1854,6 +1854,27 @@ sai_status_t RedisRemoteSaiInterface::logSet(
     return SAI_STATUS_SUCCESS;
 }
 
+sai_status_t RedisRemoteSaiInterface::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    SWSS_LOG_ENTER();
+
+    if (version)
+    {
+        *version = SAI_API_VERSION;
+
+        // TODO FIXME implement proper query for syncd, currently this is not an issue since swss is not using this API
+
+        SWSS_LOG_WARN("retruning SAI API version %d with sairedis compiled SAI headers, not actual libsai.so", SAI_API_VERSION);
+
+        return SAI_STATUS_SUCCESS;
+    }
+
+    SWSS_LOG_ERROR("version parameter is NULL");
+
+    return SAI_STATUS_INVALID_PARAMETER;
+}
+
 sai_status_t RedisRemoteSaiInterface::sai_redis_notify_syncd(
         _In_ sai_object_id_t switchId,
         _In_ const sai_attribute_t *attr)

diff --git a/lib/RedisRemoteSaiInterface.h b/lib/RedisRemoteSaiInterface.h
@@ -186,6 +186,9 @@ namespace sairedis
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         public: // notify syncd
 
             virtual sai_status_t notifySyncd(

diff --git a/lib/Sai.cpp b/lib/Sai.cpp
@@ -700,6 +700,31 @@ sai_status_t Sai::logSet(
     return SAI_STATUS_SUCCESS;
 }
 
+sai_status_t Sai::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    MUTEX();
+    SWSS_LOG_ENTER();
+    REDIS_CHECK_API_INITIALIZED();
+
+    // TODO we should use specific context, but we don't know which one since
+    // there is no object ID parameter, we can use default context or cast
+    // version as context id same as passed in SAI_REDIS_SWITCH_ATTR_CONTEXT
+    // currently we will return just first context on context map, since
+    // user maybe not aware of trick with casting context
+
+    for (auto&kvp: m_contextMap)
+    {
+        SWSS_LOG_WARN("using first context");
+
+        return kvp.second->m_meta->queryApiVersion(version);
+    }
+
+    SWSS_LOG_ERROR("context map is empty");
+
+    return SAI_STATUS_FAILURE;
+}
+
 /*
  * NOTE: Notifications during switch create and switch remove.
  *

diff --git a/lib/Sai.h b/lib/Sai.h
@@ -176,6 +176,9 @@ namespace sairedis
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         private:
 
             sai_switch_notifications_t handle_notification(

diff --git a/lib/ServerSai.cpp b/lib/ServerSai.cpp
@@ -613,6 +613,16 @@ sai_status_t ServerSai::logSet(
     return m_sai->logSet(api, log_level);
 }
 
+sai_status_t ServerSai::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    MUTEX();
+    SWSS_LOG_ENTER();
+    REDIS_CHECK_API_INITIALIZED();
+
+    return m_sai->queryApiVersion(version);
+}
+
 void ServerSai::serverThreadFunction()
 {
     SWSS_LOG_ENTER();

diff --git a/lib/ServerSai.h b/lib/ServerSai.h
@@ -172,6 +172,9 @@ namespace sairedis
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         private:
 
             void serverThreadFunction();

diff --git a/lib/sai_redis_interfacequery.cpp b/lib/sai_redis_interfacequery.cpp
@@ -261,20 +261,7 @@ sai_status_t sai_query_api_version(
 {
     SWSS_LOG_ENTER();
 
-    if (version)
-    {
-        *version = SAI_API_VERSION;
-
-        // TODO FIXME implement proper query for syncd, currently this is not an issue since swss is not using this API
-
-        SWSS_LOG_WARN("retruning SAI API version %d with sairedis compiled SAI headers, not actual libsai.so", SAI_API_VERSION);
-
-        return SAI_STATUS_SUCCESS;
-    }
-
-    SWSS_LOG_ERROR("version parameter is NULL");
-
-    return SAI_STATUS_INVALID_PARAMETER;
+    return redis_sai->queryApiVersion(version);
 }
 
 sai_status_t sai_bulk_object_get_stats(

diff --git a/meta/DummySaiInterface.cpp b/meta/DummySaiInterface.cpp
@@ -418,3 +418,20 @@ sai_status_t DummySaiInterface::logSet(
 
     return m_status;
 }
+
+sai_status_t DummySaiInterface::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    SWSS_LOG_ENTER();
+
+    if (version)
+    {
+        *version = SAI_API_VERSION;
+
+        return m_status;
+    }
+
+    SWSS_LOG_ERROR("version parameter is NULL");
+
+    return m_status;
+}
diff --git a/meta/DummySaiInterface.h b/meta/DummySaiInterface.h
@@ -204,6 +204,9 @@ namespace saimeta
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         protected:
 
             sai_status_t m_status;

diff --git a/meta/Meta.cpp b/meta/Meta.cpp
@@ -1377,6 +1377,16 @@ sai_status_t Meta::logSet(
     return m_implementation->logSet(api, log_level);
 }
 
+sai_status_t Meta::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    SWSS_LOG_ENTER();
+
+    PARAMETER_CHECK_IF_NOT_NULL(version);
+
+    return m_implementation->queryApiVersion(version);
+}
+
 void Meta::clean_after_switch_remove(
         _In_ sai_object_id_t switchId)
 {

diff --git a/meta/Meta.h b/meta/Meta.h
@@ -183,6 +183,9 @@ namespace saimeta
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         public:
 
             void meta_init_db();

diff --git a/meta/SaiInterface.h b/meta/SaiInterface.h
@@ -317,6 +317,9 @@ namespace sairedis
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) = 0;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) = 0;
+
         public: // non SAI API
 
             virtual sai_log_level_t logGet(

diff --git a/proxylib/Sai.cpp b/proxylib/Sai.cpp
@@ -558,6 +558,29 @@ sai_status_t Sai::logSet(
     return SAI_STATUS_SUCCESS;
 }
 
+sai_status_t Sai::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    SWSS_LOG_ENTER();
+
+    // TODO this should be forwarded to SaiInterface object
+
+    if (version)
+    {
+        *version = SAI_API_VERSION;
+
+        // TODO FIXME implement proper query for syncd, currently this is not an issue since swss is not using this API
+
+        SWSS_LOG_WARN("retruning SAI API version %d with saiproxy compiled SAI headers, not actual libsai.so", SAI_API_VERSION);
+
+        return SAI_STATUS_SUCCESS;
+    }
+
+    SWSS_LOG_ERROR("version parameter is NULL");
+
+    return SAI_STATUS_INVALID_PARAMETER;
+}
+
 //sai_switch_notifications_t Sai::handle_notification(
 //        _In_ std::shared_ptr<Notification> notification)
 //{

diff --git a/proxylib/Sai.h b/proxylib/Sai.h
@@ -174,6 +174,9 @@ namespace saiproxy
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         private:
 
             sai_switch_notifications_t handle_notification(

diff --git a/proxylib/sai_proxy_interfacequery.cpp b/proxylib/sai_proxy_interfacequery.cpp
@@ -269,22 +269,7 @@ sai_status_t sai_query_api_version(
 {
     SWSS_LOG_ENTER();
 
-    // TODO this should be forwarded to SaiInterface object
-
-    if (version)
-    {
-        *version = SAI_API_VERSION;
-
-        // TODO FIXME implement proper query for syncd, currently this is not an issue since swss is not using this API
-
-        SWSS_LOG_WARN("retruning SAI API version %d with saiproxy compiled SAI headers, not actual libsai.so", SAI_API_VERSION);
-
-        return SAI_STATUS_SUCCESS;
-    }
-
-    SWSS_LOG_ERROR("version parameter is NULL");
-
-    return SAI_STATUS_INVALID_PARAMETER;
+    return proxy_sai->queryApiVersion(version);
 }
 
 sai_status_t sai_bulk_object_get_stats(

diff --git a/syncd/VendorSai.cpp b/syncd/VendorSai.cpp
@@ -93,6 +93,23 @@ sai_status_t VendorSai::initialize(
         return SAI_STATUS_INVALID_PARAMETER;
     }
 
+    memcpy(&m_service_method_table, service_method_table, sizeof(m_service_method_table));
+
+    auto status = m_globalApis.api_initialize(flags, service_method_table);
+
+    if (status == SAI_STATUS_SUCCESS)
+    {
+        memset(&m_apis, 0, sizeof(m_apis));
+
+        int failed = sai_metadata_apis_query(m_globalApis.api_query, &m_apis);
+
+        if (failed > 0)
+        {
+            SWSS_LOG_NOTICE("sai_api_query failed for %d apis", failed);
+        }
+
+    }
+
     sai_api_version_t version{};
 
     auto api_status = m_globalApis.query_api_version(&version);
@@ -120,23 +137,7 @@ sai_status_t VendorSai::initialize(
         return SAI_STATUS_FAILURE;
     }
 
-    memcpy(&m_service_method_table, service_method_table, sizeof(m_service_method_table));
-
-    auto status = m_globalApis.api_initialize(flags, service_method_table);
-
-    if (status == SAI_STATUS_SUCCESS)
-    {
-        memset(&m_apis, 0, sizeof(m_apis));
-
-        int failed = sai_metadata_apis_query(m_globalApis.api_query, &m_apis);
-
-        if (failed > 0)
-        {
-            SWSS_LOG_NOTICE("sai_api_query failed for %d apis", failed);
-        }
-
-        m_apiInitialized = true;
-    }
+    m_apiInitialized = true;
 
     return status;
 }
@@ -1686,6 +1687,14 @@ sai_status_t VendorSai::logSet(
     return m_globalApis.log_set(api, log_level);
 }
 
+sai_status_t VendorSai::queryApiVersion(
+        _Out_ sai_api_version_t *version)
+{
+    SWSS_LOG_ENTER();
+
+    return m_globalApis.query_api_version(version);
+}
+
 sai_log_level_t VendorSai::logGet(
         _In_ sai_api_t api)
 {

diff --git a/syncd/VendorSai.h b/syncd/VendorSai.h
@@ -202,6 +202,9 @@ namespace syncd
                     _In_ sai_api_t api,
                     _In_ sai_log_level_t log_level) override;
 
+            virtual sai_status_t queryApiVersion(
+                    _Out_ sai_api_version_t *version) override;
+
         public: // extra API
 
             virtual sai_log_level_t logGet(

diff --git a/unittest/lib/Makefile.am b/unittest/lib/Makefile.am
@@ -22,7 +22,8 @@ tests_SOURCES = \
 				TestServerConfig.cpp \
 				TestRedisVidIndexGenerator.cpp \
 				TestRecorder.cpp \
-				TestRedisChannel.cpp
+				TestRedisChannel.cpp \
+				TestSai.cpp
 
 tests_CXXFLAGS = $(DBGFLAGS) $(AM_CXXFLAGS) $(CXXFLAGS_COMMON)
 tests_LDADD = $(LDADD_GTEST) $(top_srcdir)/lib/libSaiRedis.a -lhiredis -lswsscommon -lpthread -L$(top_srcdir)/meta/.libs -lsaimetadata -lsaimeta -lzmq $(CODE_COVERAGE_LIBS)