[GCU] Complete RDMA Platform Validation Checks

generic_config_updater/field_operation_validators.py

@@ -1,12 +1,50 @@
-from sonic_py_common import device_info
+import os
 import re
+import json
+import subprocess
+from sonic_py_common import device_info
+from .gu_common import GenericConfigUpdaterError
+
+SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
+GCU_TABLE_MOD_CONF_FILE = f"{SCRIPT_DIR}/gcu_field_operation_validators.conf.json"
+
+def get_asic_name():
+    asic = "unknown"
+
+    if device_info.get_sonic_version_info()['asic_type'] == 'cisco-8000':
+        asic = "cisco-8000"
+    elif device_info.get_sonic_version_info()['asic_type'] == 'mellanox':
+        GET_HWSKU_CMD = "sonic-cfggen -d -v DEVICE_METADATA.localhost.hwsku"
+        spc1_hwskus = [ 'ACS-MSN2700', 'ACS-MSN2740', 'ACS-MSN2100', 'ACS-MSN2410', 'ACS-MSN2010', 'Mellanox-SN2700', 'Mellanox-SN2700-D48C8' ]
+        proc = subprocess.Popen(GET_HWSKU_CMD, shell=True, universal_newlines=True, stdout=subprocess.PIPE)
+        output, err = proc.communicate()
+        hwsku = output.rstrip('\n')
+        if hwsku.lower() in [spc1_hwsku.lower() for spc1_hwsku in spc1_hwskus]:
+            asic = "spc1"
+    elif device_info.get_sonic_version_info()['asic_type'] == 'broadcom':
+        command = ["sudo", "lspci"]
+        proc = subprocess.Popen(command, universal_newlines=True, stdout=subprocess.PIPE)
+        output, err = proc.communicate()
+        if "Broadcom Limited Device b960" in output or "Broadcom Limited Broadcom BCM56960" in output:
+            asic = "th"
+        elif "Broadcom Limited Device b971" in output:
+            asic = "th2"
+        elif "Broadcom Limited Device b850" in output or "Broadcom Limited Broadcom BCM56850" in output:
+            asic = "td2"
+        elif "Broadcom Limited Device b870" in output or "Broadcom Inc. and subsidiaries Device b870" in output:
+            asic = "td3"
+
+    return asic
 
-def rdma_config_update_validator():
+def rdma_config_update_validator(path, operation):
     version_info = device_info.get_sonic_version_info()
     build_version = version_info.get('build_version')
-    asic_type = version_info.get('asic_type')
+    asic = get_asic_name()
+    path = path.lower()
 
-    if (asic_type != 'mellanox' and asic_type != 'broadcom' and asic_type != 'cisco-8000'):
+    # For paths like /BUFFER_PROFILE/pg_lossless_50000_300m_profile/xoff, remove pg_lossless_50000_300m from the path so that we can clearly determine which fields are modifiable
+    cleaned_path = "/".join([part for part in path.split("/") if not any(char.isdigit() for char in part)])
+    if asic == "unknown":
         return False
 
     version_substrings = build_version.split('.')
@@ -20,7 +58,38 @@ def rdma_config_update_validator():
     if branch_version is None:
         return False
 
-    if asic_type == 'cisco-8000':
-        return branch_version >= "20201200"
+    if os.path.exists(GCU_TABLE_MOD_CONF_FILE):
+        with open(GCU_TABLE_MOD_CONF_FILE, "r") as s:
+            gcu_field_operation_conf = json.load(s)
+    else:
+        raise GenericConfigUpdaterError("GCU table modification validators config file not found")
+
+    match = re.search(r'\/([^\/]+)(\/|$)', cleaned_path) # This matches the table name in the path, eg if path if /PFC_WD/GLOBAL, the match would be PFC_WD
+    if match is not None:
+        table = match.group(1)
+        index = cleaned_path.index(table) + len(table)
+        field = cleaned_path[index:].lstrip('/')
+    else:
+        raise GenericConfigUpdaterError("Invalid jsonpatch path: {}".format(path))
+
+    tables = gcu_field_operation_conf["tables"]
+    scenarios = tables[table]["validator_data"]["rdma_config_update_validator"]
+    scenario = None
+    for key in scenarios.keys():
+        if field in scenarios[key]["fields"]:
+            scenario = scenarios[key]
+            break
+
+    if scenario is None:
+        return False
+
+    if operation not in scenario["operations"]:
+        return False
+
+    if asic in scenario["platforms"]:
+        if branch_version < scenario["platforms"][asic]:
+            return False
     else:
-        return branch_version >= "20181100"
+        return False
+
+    return True

generic_config_updater/gcu_field_operation_validators.conf.json

@@ -10,11 +10,113 @@
         "e.g. 'show.acl.test_acl'",
         "",
         "field_operation_validators for a given table defines a list of validators that all must pass for modification to the specified field and table to be allowed",
+        "",
+        "validator_data provides data relevant to each validator",
         ""
     ],
     "tables": {
-        "PFC_WD": {
-            "field_operation_validators": [ "generic_config_updater.field_operation_validators.rdma_config_update_validator" ]
+        "pfc_wd": {
+            "field_operation_validators": [ "generic_config_updater.field_operation_validators.rdma_config_update_validator" ],
+            "validator_data": {
+                "rdma_config_update_validator": {
+                    "PFCWD enable/disable": {
+                        "fields": [
+                            "restoration_time",
+                            "detection_time",
+                            "action"
+                        ],
+                        "operations": ["remove", "add", "replace"],
+                        "platforms": {
+                            "spc1": "20181100",
+                            "td2": "20181100",
+                            "th": "20181100",
+                            "th2": "20181100",
+                            "td3": "20181100",
+                            "cisco-8000": "20201200"
+                        }
+                    }
+                }
+            }
+        },
+        "buffer_pool": {
+            "field_operation_validators": [ "generic_config_updater.field_operation_validators.rdma_config_update_validator" ],
+            "validator_data": {
+                "rdma_config_update_validator": {
+                    "Shared/headroom pool size changes": {
+                        "fields": [
+                            "ingress_lossless_pool/xoff",
+                            "ingress_lossless_pool/size",
+                            "egress_lossy_pool/size"
+                        ],
+                        "operations": ["replace"],
+                        "platforms": {
+                            "spc1": "20191100",
+                            "td2": "",
+                            "th": "20221100",
+                            "th2": "20221100",
+                            "td3": "20221100",
+                            "cisco-8000": ""
+                        }
+                    }
+                }
+            }
+        },
+        "buffer_profile": {
+            "field_operation_validators": [ "generic_config_updater.field_operation_validators.rdma_config_update_validator" ],
+            "validator_data": {
+                "rdma_config_update_validator": {
+                    "Dynamic threshold tuning": {
+                        "fields": [
+                            "dynamic_th"
+                        ],
+                        "operations": ["replace"],
+                        "platforms": {
+                            "spc1": "20181100",
+                            "td2": "20181100",
+                            "th": "20181100",
+                            "th2": "20181100",
+                            "td3": "20201200",
+                            "cisco-8000": ""
+                        }
+                    },
+                    "PG headroom modification": {
+                        "fields": [
+                            "xoff"
+                        ],
+                        "operations": ["replace"],
+                        "platforms": {
+                            "spc1": "20191100",
+                            "td2": "",
+                            "th": "20221100",
+                            "th2": "20221100",
+                            "td3": "20221100",
+                            "cisco-8000": ""
+                        }
+                    }
+                }
+            }
+        },
+        "wred_profile": {
+            "field_operation_validators": [ "generic_config_updater.field_operation_validators.rdma_config_update_validator" ],
+            "validator_data": {
+                "rdma_config_update_validator": {
+                    "ECN tuning": {
+                        "fields": [
+                            "azure_lossless/green_min_threshold",
+                            "azure_lossless/green_max_threshold"
+                        ],
+                        "operations": ["replace"],
+                        "platforms": {
+                            "spc1": "20181100",
+                            "td2": "20181100",
+                            "th": "20181100",
+                            "th2": "20181100",
+                            "td3": "20201200",
+                            "cisco-8000": ""
+                        }
+                    }
+                }
+            }
         }
     }
 }

generic_config_updater/gu_common.py

@@ -166,15 +166,15 @@ def validate_field_operation(self, old_config, target_config):
                 if any(op['op'] == operation and field == op['path'] for op in patch):
                     raise IllegalPatchOperationError("Given patch operation is invalid. Operation: {} is illegal on field: {}".format(operation, field))
 
-        def _invoke_validating_function(cmd):
+        def _invoke_validating_function(cmd, path, operation):
             # cmd is in the format as <package/module name>.<method name>
             method_name = cmd.split(".")[-1]
             module_name = ".".join(cmd.split(".")[0:-1])
             if module_name != "generic_config_updater.field_operation_validators" or "validator" not in method_name:
                 raise GenericConfigUpdaterError("Attempting to call invalid method {} in module {}. Module must be generic_config_updater.field_operation_validators, and method must be a defined validator".format(method_name, module_name))
             module = importlib.import_module(module_name, package=None)
             method_to_call = getattr(module, method_name)
-            return method_to_call()
+            return method_to_call(path, operation)
 
         if os.path.exists(GCU_FIELD_OP_CONF_FILE):
             with open(GCU_FIELD_OP_CONF_FILE, "r") as s:
@@ -184,17 +184,18 @@ def _invoke_validating_function(cmd):
 
         for element in patch:
             path = element["path"]
+            operation = element["op"]
             match = re.search(r'\/([^\/]+)(\/|$)', path) # This matches the table name in the path, eg if path if /PFC_WD/GLOBAL, the match would be PFC_WD
             if match is not None:
-                table = match.group(1)
+                table = match.group(1).lower()
             else:
                 raise GenericConfigUpdaterError("Invalid jsonpatch path: {}".format(path))
             validating_functions= set()
             tables = gcu_field_operation_conf["tables"]
             validating_functions.update(tables.get(table, {}).get("field_operation_validators", []))
 
             for function in validating_functions:
-                if not _invoke_validating_function(function):
+                if not _invoke_validating_function(function, path, operation):
                     raise IllegalPatchOperationError("Modification of {} table is illegal- validating function {} returned False".format(table, function))