Create Switch and SwitchContainer classes (#549)

kcudnik · web-flow · commit 851350627f42 · 2019-12-16T18:20:37.000+01:00
* Add Switch class

* Add SwitchContainer class

* Start using switch container in sairedis

* Add remove switch from container
diff --git a/lib/inc/Switch.h b/lib/inc/Switch.h
@@ -0,0 +1,51 @@
+#pragma once
+
+extern "C" {
+#include "saimetadata.h"
+}
+
+namespace sairedis
+{
+    class Switch
+    {
+        public:
+
+            Switch(
+                    _In_ sai_object_id_t switchId);
+
+            Switch(
+                    _In_ sai_object_id_t switchId,
+                    _In_ uint32_t attrCount,
+                    _In_ const sai_attribute_t *attrList);
+
+            virtual ~Switch() = default;
+
+        public:
+
+            void clearNotificationsPointers();
+
+            /**
+             * @brief Update switch notifications from attribute list.
+             *
+             * A list of attributes which was passed to create switch API.
+             */
+            void updateNotifications(
+                    _In_ uint32_t attrCount,
+                    _In_ const sai_attribute_t *attrList);
+
+            const sai_switch_notifications_t& getSwitchNotifications() const;
+
+            sai_object_id_t getSwitchId() const;
+
+        private:
+
+            sai_object_id_t m_switchId;
+
+            /**
+             * @brief Notifications pointers holder.
+             *
+             * Each switch instance can have it's own notifications defined.
+             */
+            sai_switch_notifications_t m_switchNotifications;
+    };
+}
diff --git a/lib/inc/SwitchContainer.h b/lib/inc/SwitchContainer.h
@@ -0,0 +1,68 @@
+#pragma once
+
+#include "Switch.h"
+
+#include <memory>
+#include <map>
+
+namespace sairedis
+{
+    class SwitchContainer
+    {
+        public:
+
+            SwitchContainer() = default;
+
+            virtual ~SwitchContainer() = default;
+
+        public:
+
+            /**
+             * @brief Insert switch to container.
+             *
+             * Throws when switch already exists in container.
+             */
+            void insert(
+                    _In_ std::shared_ptr<Switch> sw);
+
+            /**
+             * @brief Remove switch from container.
+             *
+             * Throws when switch is not present in container.
+             */
+            void removeSwitch(
+                    _In_ sai_object_id_t switchId);
+
+            /**
+             * @brief Remove switch from container.
+             *
+             * Throws when switch is not present in container.
+             */
+            void removeSwitch(
+                    _In_ std::shared_ptr<Switch> sw);
+
+            /**
+             * @brief Get switch from the container.
+             *
+             * If switch is not present in container returns NULL pointer.
+             */
+            std::shared_ptr<Switch> getSwitch(
+                    _In_ sai_object_id_t switchId) const;
+
+            /**
+             * @brief Removes all switches from container.
+             */
+            void clear();
+
+            /**
+             * @brief Check whether switch is in the container.
+             */
+            bool contains(
+                    _In_ sai_object_id_t switchId) const;
+
+        private:
+
+            std::map<sai_object_id_t, std::shared_ptr<Switch>> m_switchMap;
+
+    };
+};
diff --git a/lib/inc/sai_redis.h b/lib/inc/sai_redis.h
@@ -25,6 +25,8 @@ extern "C" {
 #include "swss/logger.h"
 #include "meta/sai_meta.h"
 
+#include "SwitchContainer.h"
+
 /*
  * Switch index is encoded on 1 byte so we can have
  * max 0x100 switches at the same time.
@@ -36,12 +38,6 @@ void redis_clear_switch_ids();
 void redis_free_virtual_object_id(
         _In_ sai_object_id_t object_id);
 
-void clear_notifications();
-
-void check_notifications_pointers(
-        _In_ uint32_t attr_count,
-        _In_ const sai_attribute_t *attr_list);
-
 // if we don't receive response from syncd in 60 seconds
 // there is something wrong and we should fail
 #define GET_RESPONSE_TIMEOUT (60*1000)
@@ -73,6 +69,8 @@ extern std::shared_ptr<swss::ConsumerTable>         g_redisGetConsumer;
 extern std::shared_ptr<swss::NotificationConsumer>  g_redisNotifications;
 extern std::shared_ptr<swss::RedisClient>           g_redisClient;
 
+extern std::shared_ptr<sairedis::SwitchContainer>   g_switchContainer;
+
 extern const sai_acl_api_t              redis_acl_api;
 extern const sai_bfd_api_t              redis_bfd_api;
 extern const sai_bmtor_api_t            redis_bmtor_api;
diff --git a/lib/src/Makefile.am b/lib/src/Makefile.am
@@ -58,7 +58,9 @@ libsairedis_la_SOURCES = \
 						 sai_redis_generic_stats.cpp \
 						 sai_redis_notifications.cpp \
 						 sai_redis_record.cpp \
-						 Globals.cpp
+						 Globals.cpp \
+						 Switch.cpp \
+						 SwitchContainer.cpp
 
 libsairedis_la_CPPFLAGS = $(DBGFLAGS) $(AM_CPPFLAGS) $(CFLAGS_COMMON)
 libsairedis_la_LIBADD = -lhiredis -lswsscommon
diff --git a/lib/src/Switch.cpp b/lib/src/Switch.cpp
@@ -0,0 +1,116 @@
+#include "Switch.h"
+
+#include "swss/logger.h"
+
+#include <cstring>
+
+using namespace sairedis;
+
+Switch::Switch(
+        _In_ sai_object_id_t switchId):
+    m_switchId(switchId)
+{
+    SWSS_LOG_ENTER();
+
+    if (switchId == SAI_NULL_OBJECT_ID)
+    {
+        SWSS_LOG_THROW("switch id can't be NULL");
+    }
+
+    clearNotificationsPointers();
+}
+
+Switch::Switch(
+        _In_ sai_object_id_t switchId,
+        _In_ uint32_t attrCount,
+        _In_ const sai_attribute_t *attrList):
+    Switch(switchId)
+{
+    SWSS_LOG_ENTER();
+
+    updateNotifications(attrCount, attrList);
+}
+
+void Switch::clearNotificationsPointers()
+{
+    SWSS_LOG_ENTER();
+
+    memset(&m_switchNotifications, 0, sizeof(m_switchNotifications));
+}
+
+sai_object_id_t Switch::getSwitchId() const
+{
+    SWSS_LOG_ENTER();
+
+    return m_switchId;
+}
+
+void Switch::updateNotifications(
+        _In_ uint32_t attrCount,
+        _In_ const sai_attribute_t *attrList)
+{
+    SWSS_LOG_ENTER();
+
+    /*
+     * This function should only be called on CREATE/SET
+     * api when object is SWITCH.
+     */
+
+    for (uint32_t index = 0; index < attrCount; ++index)
+    {
+        auto &attr = attrList[index];
+
+        auto meta = sai_metadata_get_attr_metadata(SAI_OBJECT_TYPE_SWITCH, attr.id);
+
+        if (meta == NULL)
+            SWSS_LOG_THROW("failed to find metadata for switch attr %d", attr.id);
+
+        if (meta->attrvaluetype != SAI_ATTR_VALUE_TYPE_POINTER)
+            continue;
+
+        switch (attr.id)
+        {
+            case SAI_SWITCH_ATTR_SWITCH_STATE_CHANGE_NOTIFY:
+                m_switchNotifications.on_switch_state_change = 
+                    (sai_switch_state_change_notification_fn)attr.value.ptr;
+                break;
+
+            case SAI_SWITCH_ATTR_SHUTDOWN_REQUEST_NOTIFY:
+                m_switchNotifications.on_switch_shutdown_request = 
+                    (sai_switch_shutdown_request_notification_fn)attr.value.ptr;
+                break;
+
+            case SAI_SWITCH_ATTR_FDB_EVENT_NOTIFY:
+                m_switchNotifications.on_fdb_event = 
+                    (sai_fdb_event_notification_fn)attr.value.ptr;
+                break;
+
+            case SAI_SWITCH_ATTR_PORT_STATE_CHANGE_NOTIFY:
+                m_switchNotifications.on_port_state_change = 
+                    (sai_port_state_change_notification_fn)attr.value.ptr;
+                break;
+
+            case SAI_SWITCH_ATTR_PACKET_EVENT_NOTIFY:
+                m_switchNotifications.on_packet_event = 
+                    (sai_packet_event_notification_fn)attr.value.ptr;
+                break;
+
+            case SAI_SWITCH_ATTR_QUEUE_PFC_DEADLOCK_NOTIFY:
+                m_switchNotifications.on_queue_pfc_deadlock = 
+                    (sai_queue_pfc_deadlock_notification_fn)attr.value.ptr;
+                break;
+
+            default:
+                SWSS_LOG_ERROR("pointer for %s is not handled, FIXME!", meta->attridname);
+                break;
+        }
+    }
+}
+
+const sai_switch_notifications_t& Switch::getSwitchNotifications() const
+{
+    SWSS_LOG_ENTER();
+
+    return m_switchNotifications;
+}
+
diff --git a/lib/src/SwitchContainer.cpp b/lib/src/SwitchContainer.cpp
@@ -0,0 +1,74 @@
+#include "SwitchContainer.h"
+
+#include "swss/logger.h"
+#include "meta/sai_serialize.h"
+
+using namespace sairedis;
+
+void SwitchContainer::insert(
+        _In_ std::shared_ptr<Switch> sw)
+{
+    SWSS_LOG_ENTER();
+
+    auto switchId = sw->getSwitchId();
+
+    if (m_switchMap.find(switchId) != m_switchMap.end())
+    {
+        SWSS_LOG_THROW("switch %s already exist in container",
+                sai_serialize_object_id(switchId).c_str());
+    }
+
+    m_switchMap[switchId] = sw;
+}
+
+void SwitchContainer::removeSwitch(
+        _In_ sai_object_id_t switchId)
+{
+    SWSS_LOG_ENTER();
+
+    auto it = m_switchMap.find(switchId);
+
+    if (it == m_switchMap.end())
+    {
+        SWSS_LOG_THROW("switch %s not present in container",
+                sai_serialize_object_id(switchId).c_str());
+    }
+
+    m_switchMap.erase(it);
+}
+
+void SwitchContainer::removeSwitch(
+        _In_ std::shared_ptr<Switch> sw)
+{
+    SWSS_LOG_ENTER();
+
+    removeSwitch(sw->getSwitchId());
+}
+
+std::shared_ptr<Switch> SwitchContainer::getSwitch(
+        _In_ sai_object_id_t switchId) const
+{
+    SWSS_LOG_ENTER();
+
+    auto it = m_switchMap.find(switchId);
+
+    if (it == m_switchMap.end())
+        return nullptr;
+
+    return it->second;
+}
+
+void SwitchContainer::clear()
+{
+    SWSS_LOG_ENTER();
+
+    m_switchMap.clear();
+}
+
+bool SwitchContainer::contains(
+        _In_ sai_object_id_t switchId) const
+{
+    SWSS_LOG_ENTER();
+
+    return m_switchMap.find(switchId) != m_switchMap.end();
+}
diff --git a/lib/src/sai_redis_generic_create.cpp b/lib/src/sai_redis_generic_create.cpp
@@ -77,6 +77,7 @@ sai_object_id_t redis_create_switch_virtual_object_id()
     return redis_construct_object_id(SAI_OBJECT_TYPE_SWITCH, index, index);
 }
 
+// TODO must be protected using api MUTEX (but first remove usage from metadata) - use std::function
 sai_object_type_t sai_object_type_query(
         _In_ sai_object_id_t object_id)
 {
@@ -104,6 +105,7 @@ sai_object_type_t sai_object_type_query(
     return ot;
 }
 
+// TODO must be protected using api MUTEX (but first remove usage from metadata) - use std::function
 sai_object_id_t sai_switch_id_query(
         _In_ sai_object_id_t oid)
 {
diff --git a/lib/src/sai_redis_interfacequery.cpp b/lib/src/sai_redis_interfacequery.cpp
diff --git a/lib/src/sai_redis_notifications.cpp b/lib/src/sai_redis_notifications.cpp
diff --git a/lib/src/sai_redis_switch.cpp b/lib/src/sai_redis_switch.cpp

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,7 @@ sai_object_id_t redis_create_switch_virtual_object_id()`
`77`	`77`	`return redis_construct_object_id(SAI_OBJECT_TYPE_SWITCH, index, index);`
`78`	`78`	`}`
`79`	`79`
	`80`	`+// TODO must be protected using api MUTEX (but first remove usage from metadata) - use std::function`
`80`	`81`	`sai_object_type_t sai_object_type_query(`
`81`	`82`	`_In_ sai_object_id_t object_id)`
`82`	`83`	`{`
`@@ -104,6 +105,7 @@ sai_object_type_t sai_object_type_query(`
`104`	`105`	`return ot;`
`105`	`106`	`}`
`106`	`107`
	`108`	`+// TODO must be protected using api MUTEX (but first remove usage from metadata) - use std::function`
`107`	`109`	`sai_object_id_t sai_switch_id_query(`
`108`	`110`	`_In_ sai_object_id_t oid)`
`109`	`111`	`{`