sonic-sairedis: Add support to sonic-sairedis for gearbox phys (#632)

* builds on support for multiple switches in sonic-sairedis
* new vslib switch BCM81724 implements a virtual gearbox phy.
* support for launching second (BCM81724 is supported by its own syncd)
* simple refactoring of tests to support switches by part number, still working with
  sairedis to support multiple switch in tests so BCM81724 will be a separate pull request)
* changed example context_config.json to reflect renaming of phy REDIS tables (see sonic-swss-common
  commit 292b08a3a80b24b23663020b37e6260039a311c0)

Note that a future commit to sonic-buildimage will be required to trigger launch of physyncd
(launching is based on device config files which are currently not present in sonic-buildimage).

Testing done in multiple environments (broadcom fork and pure upstream). Example CLI output
based on changes pushed to sonic-utilities (commit a6c4456)
running in VS switch supporting BCM81724:

root@sonic:/home/admin# show gearbox interfaces  status
  PHY Id    Interface    MAC Lanes    MAC Lane Speed    PHY Lanes    PHY Lane Speed    Line Lanes    Line Lane Speed    Oper    Admin
--------  -----------  -----------  ----------------  -----------  ----------------  ------------  -----------------  ------  -------
       1    Ethernet0  25,26,27,28               10G      200,201               20G           206                40G      up       up
       1    Ethernet4  29,30,31,32               10G      202,203               20G           207                40G      up       up
       1    Ethernet8  33,34,35,36               10G      204,205               20G           208                40G      up       up

HLD is located at https://github.com/Azure/SONiC/blob/master/doc/gearbox/gearbox_mgr_design.md

Signed-off-by: syd.logan@broadcom.com

lib/src/context_config.json

@@ -21,10 +21,10 @@
         {
             "guid" : 1,
             "name" : "syncd1",
-            "dbAsic" : "ASIC_DB2",
-            "dbCounters" : "COUNTERS_DB2",
-            "dbFlex": "FLEX_COUNTER_DB2",
-            "dbState" : "STATE_DB2",
+            "dbAsic" : "GB_ASIC_DB",
+            "dbCounters" : "GB_COUNTERS_DB",
+            "dbFlex": "GB_FLEX_COUNTER_DB",
+            "dbState" : "STATE_DB",
             "switches": [
                 {
                     "index" : 0,

lib/src/sai_redis_switch.cpp

@@ -1,5 +1,29 @@
 #include "sai_redis.h"
 
+sai_status_t redis_switch_mdio_read(
+        _In_ sai_object_id_t switch_id,
+        _In_ uint32_t device_addr,
+        _In_ uint32_t start_reg_addr,
+        _In_ uint32_t number_of_registers,
+        _Out_ uint32_t *reg_val)
+{
+    SWSS_LOG_ENTER();
+
+    return SAI_STATUS_NOT_IMPLEMENTED;
+}
+
+sai_status_t redis_switch_mdio_write(
+        _In_ sai_object_id_t switch_id,
+        _In_ uint32_t device_addr,
+        _In_ uint32_t start_reg_addr,
+        _In_ uint32_t number_of_registers,
+        _In_ const uint32_t *reg_val)
+{
+    SWSS_LOG_ENTER();
+
+    return SAI_STATUS_NOT_IMPLEMENTED;
+}
+
 REDIS_GENERIC_QUAD(SWITCH,switch);
 REDIS_GENERIC_STATS(SWITCH,switch);
 

syncd/SaiSwitch.cpp

@@ -59,13 +59,19 @@ SaiSwitch::SaiSwitch(
 
     helperInternalOids();
 
-    helperCheckLaneMap();
+    if (getSwitchType() == SAI_SWITCH_TYPE_NPU) 
+    {
+        helperCheckLaneMap();
+    }
 
     helperLoadColdVids();
 
     helperPopulateWarmBootVids();
 
-    saiGetMacAddress(m_default_mac_address);
+    if (getSwitchType() == SAI_SWITCH_TYPE_NPU) 
+    {
+        saiGetMacAddress(m_default_mac_address);
+    }
 
     if (warmBoot)
     {
@@ -131,6 +137,26 @@ void SaiSwitch::getDefaultMacAddress(
     memcpy(mac, m_default_mac_address, sizeof(sai_mac_t));
 }
 
+sai_switch_type_t SaiSwitch::getSwitchType() const
+{
+    SWSS_LOG_ENTER();
+
+    sai_attribute_t attr;
+
+    attr.id = SAI_SWITCH_ATTR_TYPE;
+
+    sai_status_t status = m_vendorSai->get(SAI_OBJECT_TYPE_SWITCH, m_switch_rid, 1, &attr);
+
+    if (status != SAI_STATUS_SUCCESS)
+    {
+        SWSS_LOG_THROW("failed to get switch type");
+    }
+
+    SWSS_LOG_ERROR("switch type: '%s'", (attr.value.s32 == SAI_SWITCH_TYPE_NPU ? "SAI_SWITCH_TYPE_NPU" : "SAI_SWITCH_TYPE_PHY"));
+
+    return (sai_switch_type_t) attr.value.s32;
+}
+
 #define MAX_HARDWARE_INFO_LENGTH 0x1000
 
 std::string SaiSwitch::saiGetHardwareInfo() const
@@ -885,7 +911,7 @@ void SaiSwitch::helperPopulateWarmBootVids()
     {
         sai_object_id_t vid = m_translator->translateRidToVid(rid, m_switch_vid);
 
-       m_warmBootDiscoveredVids.insert(vid);
+        m_warmBootDiscoveredVids.insert(vid);
     }
 }
 

syncd/SaiSwitch.h

@@ -41,6 +41,7 @@ namespace syncd
             sai_object_id_t getVid() const;
             sai_object_id_t getRid() const;
 
+            sai_switch_type_t getSwitchType() const;
             std::string getHardwareInfo() const;
 
             std::unordered_map<sai_object_id_t, sai_object_id_t> getVidToRidMap() const;

syncd/scripts/physyncd_start.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+#
+# Script to start syncd using supervisord
+#
+
+exec "/usr/bin/physyncd_startup.py"
+

syncd/scripts/physyncd_startup.py

@@ -0,0 +1,48 @@
+#!/usr/bin/python
+
+'''
+Copyright 2019 Broadcom. The term "Broadcom" refers to Broadcom Inc.
+and/or its subsidiaries.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+  '''
+import os
+import json
+import subprocess
+
+
+def physyncd_enable(gearbox_config):
+    i = 1
+    for phy in gearbox_config['phys']:
+        subprocess.Popen(["/bin/bash", "-c",  "/bin/bash -c {}".format('"exec /usr/bin/syncd -p /etc/sai.d/pai.profile -x /usr/share/sonic/hwsku/context_config.json -g {}"'.format(i))], close_fds=True)
+        i += 1
+
+def main():
+
+    # Only privileged users can execute this command
+    if os.geteuid() != 0:
+        sys.exit("Root privileges required for this operation")
+
+    """ Loads json file """
+    try:
+        with open('/usr/share/sonic/hwsku/gearbox_config.json') as file_object:
+            gearbox_config=json.load(file_object)
+    except:
+        sys.exit("No external PHY / gearbox supported on this platform, existing physycd application")
+
+    physyncd_enable(gearbox_config)
+
+
+if __name__== "__main__":
+    main()
+

tests/Makefile.am

@@ -19,4 +19,4 @@ if SAITHRIFT
 vssyncd_LDADD += -lrpcserver -lthrift
 endif
 
-TESTS = aspellcheck.pl conflictnames.pl swsslogentercheck.sh brcm.pl mlnx.pl
+TESTS = aspellcheck.pl conflictnames.pl swsslogentercheck.sh BCM56850.pl MLNX2700.pl

vslib/inc/SwitchBCM81724.h

@@ -0,0 +1,104 @@
+/*
+                                                                            
+  Copyright 2019 Broadcom. The term Broadcom refers to Broadcom Inc. and/or 
+  its subsidiaries.                                                         
+                                                                            
+  Licensed under the Apache License, Version 2.0 (the "License");           
+  you may not use this file except in compliance with the License.          
+  You may obtain a copy of the License at                                   
+                                                                            
+     http://www.apache.org/licenses/LICENSE-2.0                             
+                                                                            
+  Unless required by applicable law or agreed to in writing, software       
+  distributed under the License is distributed on an "AS IS" BASIS,         
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+  See the License for the specific language governing permissions and       
+  limitations under the License.                                            
+
+*/
+
+#pragma once
+
+#include "SwitchStateBase.h"
+
+namespace saivs
+{
+    class SwitchBCM81724:
+        public SwitchStateBase
+    {
+        public:
+
+            SwitchBCM81724(
+                    _In_ sai_object_id_t switch_id,
+                    _In_ std::shared_ptr<RealObjectIdManager> manager,
+                    _In_ std::shared_ptr<SwitchConfig> config);
+
+            SwitchBCM81724(
+                    _In_ sai_object_id_t switch_id,
+                    _In_ std::shared_ptr<RealObjectIdManager> manager,
+                    _In_ std::shared_ptr<SwitchConfig> config,
+                    _In_ std::shared_ptr<WarmBootState> warmBootState);
+
+            virtual ~SwitchBCM81724();
+
+        protected:
+
+            virtual sai_status_t create_port_dependencies(_In_ sai_object_id_t port_id) override;
+
+            virtual sai_status_t create_qos_queues_per_port(_In_ sai_object_id_t port_id) override;
+
+            virtual sai_status_t create_qos_queues() override;
+
+            virtual sai_status_t set_switch_mac_address() override;
+
+            virtual sai_status_t create_default_vlan() override;
+
+            virtual sai_status_t create_default_1q_bridge() override;
+
+            virtual sai_status_t create_default_virtual_router() override;
+
+            virtual sai_status_t create_default_stp_instance() override;
+
+            virtual sai_status_t create_default_trap_group() override;
+
+            virtual sai_status_t create_ingress_priority_groups_per_port(
+                    _In_ sai_object_id_t port_id) override;
+
+            virtual sai_status_t create_ingress_priority_groups() override;
+
+            virtual sai_status_t create_vlan_members() override;
+
+            virtual sai_status_t create_bridge_ports() override;
+
+            virtual sai_status_t set_acl_entry_min_prio() override;
+
+            virtual sai_status_t set_acl_capabilities() override;
+
+            virtual sai_status_t set_maximum_number_of_childs_per_scheduler_group() override;
+
+            virtual sai_status_t set_number_of_ecmp_groups() override; 
+
+            virtual sai_status_t create_cpu_port();
+
+            virtual sai_status_t create_ports();
+
+       protected : // refresh
+
+            virtual sai_status_t refresh_port_list(
+                    _In_ const sai_attr_metadata_t *meta) override;
+
+            virtual sai_status_t refresh_bridge_port_list(
+                    _In_ const sai_attr_metadata_t *meta,
+                    _In_ sai_object_id_t bridge_id) override;
+
+            virtual sai_status_t refresh_vlan_member_list(
+                    _In_ const sai_attr_metadata_t *meta,
+                    _In_ sai_object_id_t vlan_id) override;
+
+        protected:
+
+            virtual sai_status_t refresh_read_only( _In_ const sai_attr_metadata_t *meta, _In_ sai_object_id_t object_id) override;
+            virtual sai_status_t set_switch_default_attributes();
+            virtual sai_status_t initialize_default_objects() override;
+    };
+}

vslib/inc/SwitchConfig.h

@@ -6,6 +6,10 @@
 #include <string>
 #include <memory>
 
+extern "C" {
+#include "sai.h"     // for sai_switch_type_t
+}
+
 namespace saivs
 {
     typedef enum _sai_vs_switch_type_t
@@ -14,6 +18,8 @@ namespace saivs
 
         SAI_VS_SWITCH_TYPE_BCM56850,
 
+        SAI_VS_SWITCH_TYPE_BCM81724,
+
         SAI_VS_SWITCH_TYPE_MLNX2700,
 
     } sai_vs_switch_type_t;
@@ -38,6 +44,10 @@ namespace saivs
 
         public:
 
+            static bool parseSaiSwitchType(
+                    _In_ const char* saiSwitchTypeStr,
+                    _Out_ sai_switch_type_t& saiSwitchType);
+
             static bool parseSwitchType(
                     _In_ const char* switchTypeStr,
                     _Out_ sai_vs_switch_type_t& switchType);
@@ -51,6 +61,8 @@ namespace saivs
 
         public:
 
+            sai_switch_type_t m_saiSwitchType;
+
             sai_vs_switch_type_t m_switchType;
 
             sai_vs_boot_type_t m_bootType;

vslib/inc/saivs.h

@@ -5,6 +5,10 @@ extern "C" {
 }
 
 #define SAI_KEY_VS_SWITCH_TYPE              "SAI_VS_SWITCH_TYPE"
+#define SAI_KEY_VS_SAI_SWITCH_TYPE          "SAI_VS_SAI_SWITCH_TYPE"
+
+#define SAI_VALUE_SAI_SWITCH_TYPE_NPU       "SAI_SWITCH_TYPE_NPU"
+#define SAI_VALUE_SAI_SWITCH_TYPE_PHY       "SAI_SWITCH_TYPE_PHY"
 
 /**
  * @def SAI_KEY_VS_INTERFACE_LANE_MAP_FILE
@@ -31,6 +35,7 @@ extern "C" {
 #define SAI_KEY_VS_HOSTIF_USE_TAP_DEVICE      "SAI_VS_HOSTIF_USE_TAP_DEVICE"
 
 #define SAI_VALUE_VS_SWITCH_TYPE_BCM56850     "SAI_VS_SWITCH_TYPE_BCM56850"
+#define SAI_VALUE_VS_SWITCH_TYPE_BCM81724     "SAI_VS_SWITCH_TYPE_BCM81724"
 #define SAI_VALUE_VS_SWITCH_TYPE_MLNX2700     "SAI_VS_SWITCH_TYPE_MLNX2700"
 
 /*

vslib/src/Makefile.am

@@ -45,6 +45,7 @@ libSaiVS_a_SOURCES = \
 					  SelectableFd.cpp \
 					  SwitchState.cpp \
 					  SwitchBCM56850.cpp \
+					  SwitchBCM81724.cpp \
 					  SwitchMLNX2700.cpp
 
 libsaivs_la_SOURCES = \

vslib/src/Sai.cpp

@@ -94,6 +94,19 @@ sai_status_t Sai::initialize(
         return SAI_STATUS_FAILURE;
     }
 
+    auto sai_switch_type = service_method_table->profile_get_value(0, SAI_KEY_VS_SAI_SWITCH_TYPE);
+    sai_switch_type_t saiSwitchType;
+
+    if (sai_switch_type == NULL)
+    {
+        SWSS_LOG_NOTICE("failed to obtain service method table value: %s", SAI_KEY_VS_SAI_SWITCH_TYPE);
+        saiSwitchType = SAI_SWITCH_TYPE_NPU;
+    } 
+    else if (!SwitchConfig::parseSaiSwitchType(sai_switch_type, saiSwitchType))
+    {
+        return SAI_STATUS_FAILURE;
+    }
+
     auto *laneMapFile = service_method_table->profile_get_value(0, SAI_KEY_VS_INTERFACE_LANE_MAP_FILE);
 
     m_laneMapContainer = LaneMapFileParser::parseLaneMapFile(laneMapFile);
@@ -128,6 +141,7 @@ sai_status_t Sai::initialize(
 
     auto sc = std::make_shared<SwitchConfig>();
 
+    sc->m_saiSwitchType = saiSwitchType;
     sc->m_switchType = switchType;
     sc->m_bootType = bootType;
     sc->m_switchIndex = 0;
@@ -161,7 +175,10 @@ sai_status_t Sai::initialize(
 
     startUnittestThread();
 
-    startFdbAgingThread();
+    if (saiSwitchType == SAI_SWITCH_TYPE_NPU) 
+    {
+        startFdbAgingThread();
+    }
 
     m_apiInitialized = true;