Merge pull request #1744 from geans-pin/common_config_improvement

Silicon config support for Broadcom yml file and property overwrite

doc/platform/common_config.md

@@ -23,6 +23,9 @@
 | Rev |     Date    |       Author       | Change Description                |
 |:---:|:-----------:|:------------------:|-----------------------------------|
 | 0.1 | 11/03/2020  | Geans Pin          | Initial version                   |
+| 0.2 | 07/13/2024. | Geans Pin.         | Updated version:  Support option of common config properties overwriting platform specific config and common config merging to yaml based platform config  
+
+
 
 # About this Manual
 We added support for a per-switching silicon common config.bcm file to assist with silicon-wide application configuration settings for all affected Broadcom platforms. The infrastructure saves development time by allowing applications to refactor common settings in a single location, and allows for platform-specific overrides. 
@@ -38,30 +41,60 @@ This document gives the details of Per-switching silicon Common config for Broad
 The functional requirements include :
 - Create the common file in the device common directory for different  BRCM switch chip family
 
-- Merge the common config from device common directory to ODM
-platform specific config. Duplicate configuration entries in the platform specific file override entries in the common config.bcm
+- Merge the common config from device common directory to ODM platform specific config. Duplicate configuration properties in the platform specific file override the properties in the common config.bcm Common config. In the Rev 0.2 feature, support Duplicate configuration properties in the High Inheritance Precedence section of common config override the properties in the platform specific config.bcm.
+
 
 - The final config.bcm merged with common config is required to be copied to a shared folder for debugging   
 
 
 ## 2 Supported Platforms
 
-Per-switching silicon Common config feature is supported on all of the Broadcom platform if the common config files are created in the device/broadcom/x86_64-broadcom_common. Following is the current supported common configuration :
+Per-switching silicon Common config feature is supported on all of the Broadcom platform if the common config files are created in the device/broadcom/x86_64-broadcom_common. Following is the current supported common configuration : In the latest 0.2 updated version, TD4, TH4, and TH5 switch silicons with yml config are supported in the common config feature.  
 
 ```
+|-- x86_64-broadcom_b27 -- broadcom-sonic-td3.config.bcm
+|-- x86_64-broadcom_b37 -- broadcom-sonic-td3.config.bcm
 |-- x86_64-broadcom_b77 -- broadcom-sonic-td3.config.bcm
+|-- x86_64-broadcom_b78 -- broadcom-sonic-td3.config.bcm
 |-- x86_64-broadcom_b85 -- broadcom-sonic-td2.config.bcm
-|-- x86_64-broadcom_b87-- broadcom-sonic-td3.config.bcm
-|-- x86_64-broadcom_b96-- broadcom-sonic-th.config.bcm
-|-- x86_64-broadcom_b97-- broadcom-sonic-th2.config.bcm
-|-- x86_64-broadcom_b98-- broadcom-sonic-th3.config.bcm
+|-- x86_64-broadcom_b88 -- broadcom-sonic-td4.config.bcm
+|-- x86_64-broadcom_b96 -- broadcom-sonic-th.config.bcm
+|-- x86_64-broadcom_b97 -- broadcom-sonic-th2.config.bcm
+|-- x86_64-broadcom_b98 -- broadcom-sonic-th3.config.bcm
+|-- x86_64-broadcom_b99 -- broadcom-sonic-th4.config.bcm
+|-- x86_64-broadcom_f90 -- broadcom-sonic-th5.config.bcm
 ```
 ## 3 Design Detail
 The main change of the design is in the SYNCD docker syncd/scripts/syncd_init_common.sh script along with common config being created in the device/broadcom/x86_64-broadcom_common/ folder. The design standardize the common file name as broadcom-sonic-{$chip_id}.config.bcm . Also, in the SYNCD docker-syncd-brcm.mk, we extern the common config directory path /usr/share/sonic/device/x86_64-broadcom_common from host to docker for script reference.
 
 The design change for syncd_init_common.sh is targeted on the config_syncd_bcm() which is only used for BRCM switch chip. In the config_syncd_bcm() function, it will load the common silicon config.bcm file by looking for a *.bcm file in the  /usr/share/sonic/device/x86_64-broadcom_common/x86_64-broadcom_{$chip_id} folder where the $chip_id is the upper 3 nibbles of the switching silicon's device ID as listed in SDK/include/soc/devids.h. Then, merge common broadcom-sonic-{$chip_name}.config.bcm file with the existing platform specific config.bcm file in which the duplicate configuration entries in the platform specific file will override entries in the common broadcom-sonic-{$chip_name}.config.bcm file. 
 
-Since the platform specific config.bcm is read only in docker, the design copies the platform specific config.bcm and sai.profile to /tmp for handling common config merge process. The /tmp/sai.profile will be modified to point to the merged config.bcm under/tmp directory. The following switch initialization will reference to the new merged config.bcm pointed by updated sai.profile from the /tmp directory.
+In the updated 0.2 version, the script will check the platform specific config file. If it is yml based, it will merge common broadcom-sonic-{$chip_name}.config.bcm file with the existing platform specific config.yml file. 
+
+In order to support common config overwriting the platform config feature in updated version 0.2. We propose a option for supporting properties of common config overwriting to the Platform config. The properties of common config in the High Inheritance Precedence section have the high priority than the platform specific config that will merge and overwrite the platform config. However, the properties of common config in the Low Inheritance Precedence section have the low priority than the platofrm specific config that will not merge and overwrite to the platform config if duplication properties present.  As the following example, the properties of common config in the High Inheritance Precedence section will overwirte the platform specifc config during the merged process.However, the properties in the Low Inheritance Precedence section will not.
+
+```
+/device/broadcom/x86_64-broadcom_common/x86_64-broadcom_b27/broadcom-sonic-td3.config.bcm
+[Low Inheritance Precedence]
+mem_cache_enable=1
+sai_create_dflt_trap=1
+sai_default_tc_to_pg_map=1
+qos_map_dot1p_nonsharable_mode=1
+
+
+[High Inheritance Precedence]
+l3_mem_entries=16384
+lpm_scaling_enable=0
+l3_alpm_enable=0
+```
+
+Since the platform specific config.bcm is read only in docker, the design copies the platform specific config.bcm or config.yml and sai.profile to /tmp for handling common config merge process. The /tmp/sai.profile will be modified to point to the merged config.bcm or config.yml under /tmp directory. The following switch initialization will reference to the new merged config.bcm or config.yml pointed by updated sai.profile from the /tmp directory.
+
+The design will also copy the merged config.bcm or config.yml and sai.profile to /var/run/ share folder for debugging and testing purpose
+
+## 3.1 How to enable the common config feature in Platform
+By default, the common config feature is disabled. The feature can be enabled by creating a dummy
+common_config_support file in the BSP /usr/share/sonic/platform folder. 
 
 
 ## 4 Serviceability and DEBUG
@@ -77,7 +110,7 @@ Nov  3 09:19:25.373964 2020 sonic INFO syncd#supervisord: syncd Merging
 /tmp/td3-ix8a-bwde-48x25G+8x100G.config.bcm
 ```
 ### 4.2 Debug logs
-The finial config.bcm and sai.profile will copy to the shared folder /var/run/sswsyncd/ in the syncd docker for 'show tech' debugging purpose. Developer can check the final config.bcm file for debugging from the show tech dump /sai/xxx.config.bcm.
+The finial config.bcm or config.yml and sai.profile will copy to the shared folder /var/run/sswsyncd/ in the syncd docker for 'show tech' debugging purpose. Developer can check the final config.bcm or conifg.yml file for debugging from the show tech dump /sai/xxx.config.bcm.
 
 ### Examples:
 - Issue 'show tech'
@@ -100,8 +133,18 @@ sai_eapp_config_file=/etc/broadcom/eapps_cfg.json
 NA
 ## 6 Unit Test
 - Check the system status to make sure syncd initial success
-- Check the syslog to make sure the common config merged to
-   config.bcm successfully
-- Check the final merged config.bcm dump from show tech dump 
+- Check the syslog to make sure the common config merged to config.bcm and config.yml successfully
+- Check the final merged config.bcm or config.yml dump from show tech dump 
+- Check the if syncd service is running well without seeing any SAI crash
+  Running sudo systemctl status syncd to check the syncd service status
+  Check the if any syncd SAI related Error from syslog
+- Enable PDE in config/rules and Run the PDE test_sai.py to make sure baseline SAI initial 
+  can pass. Go into pde docker and run pde-test -v test_sai.py
+  test_sai.py::test_for_switch_port_enumeration PASSED                     [ 68%]
+  test_sai.py::test_for_switch_port_loopback PASSED                        [ 69%]
+  test_sai.py::test_for_switch_port_traffic PASSED                         [ 70%]
+- Go into the syncd docker to run the UT and make sure it's PASS
+  syncd/scripts/brcm_common_config_ut.sh
+  PASS: Checking Common config merged Success