[trim]: Add Packet Trimming Asym DSCP CLI (#3971)

Signed-off-by: Nazarii Hnydyn <[email protected]>

<!--
 Please make sure you've read and understood our contributing guidelines:
 https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md

 failure_prs.log skip_prs.log Make sure all your commits include a signature generated with `git commit -s` **

 If this is a bug fix, make sure your description includes "closes #xxxx",
 "fixes #xxxx" or "resolves #xxxx" so that GitHub automatically closes the related
 issue when the PR is merged.

 If you are adding/modifying/removing any command or utility script, please also
 make sure to add/modify/remove any unit tests from the tests
 directory as appropriate.

 If you are modifying or removing an existing 'show', 'config' or 'sonic-clear'
 subcommand, or you are adding a new subcommand, please make sure you also
 update the Command Line Reference Guide (doc/Command-Reference.md) to reflect
 your changes.

 Please provide the following information:
-->

**HLD:** sonic-net/SONiC#1988

#### What I did
* Implemented CLI for Packet Trimming Asymmetric DSCP feature

#### How I did it
* Integrated Packet Trimming Asymmetric DSCP interface into `config` and `show` CLI root

#### How to verify it
1. Run Packet Trimming CLI UTs

#### Previous command output (if the output of a command-line utility has changed)
```
admin@sonic:/home/admin# show switch-trimming global
+-----------------------------+---------+
| Configuration | Value |
+=============================+=========+
| Packet trimming size | 256 |
+-----------------------------+---------+
| Packet trimming DSCP value | 25 |
+-----------------------------+---------+
| Packet trimming queue index | 5 |
+-----------------------------+---------+
```

#### New command output (if the output of a command-line utility has changed)
```
admin@sonic:/home/admin# show switch-trimming global
+-----------------------------+---------+
| Configuration | Value |
+=============================+=========+
| Packet trimming size | 256 |
+-----------------------------+---------+
| Packet trimming DSCP value | from-tc |
+-----------------------------+---------+
| Packet trimming TC value | 10 |
+-----------------------------+---------+
| Packet trimming queue index | 5 |
+-----------------------------+---------+
```

#### A picture of a cute animal (not mandatory but encouraged)
```
 .---. .-----------
 / \ __ / ------
 / / \( )/ -----
 ////// ' \/ ` ---
 //// / // : : ---
 // / / /` '--
// //..\\
 ====UU====UU====
 '//||\\`
 ''``
```

Author: mssonicbld

config/plugins/sonic-trimming.py

@@ -10,12 +10,20 @@
     CFG_SWITCH_TRIMMING,
     STATE_SWITCH_CAPABILITY,
     STATE_CAP_TRIMMING_CAPABLE_KEY,
+    STATE_CAP_DSCP_MODE_KEY,
+    STATE_CAP_DSCP_MODE_DSCP_VALUE,
+    STATE_CAP_DSCP_MODE_FROM_TC,
     STATE_CAP_QUEUE_MODE_KEY,
     STATE_CAP_QUEUE_MODE_DYNAMIC,
     STATE_CAP_QUEUE_MODE_STATIC,
+    STATE_CAP_TC_NUM_KEY,
+    STATE_CAP_QUEUE_NUM_KEY,
+    CFG_TRIM_DSCP_VALUE_FROM_TC,
     CFG_TRIM_QUEUE_INDEX_DYNAMIC,
     CFG_TRIM_KEY,
     STATE_CAP_KEY,
+    DSCP_MIN,
+    DSCP_MAX,
     UINT32_MAX,
     UINT8_MAX,
     SYSLOG_IDENTIFIER,
@@ -32,6 +40,14 @@
 # Validators ----------------------------------------------------------------------------------------------------------
 #
 
+def generic_validator(ctx, db):
+    """ Generic configuration validator """
+    entry = db.get_all(db.STATE_DB, "{}|{}".format(STATE_SWITCH_CAPABILITY, STATE_CAP_KEY))
+    value = entry.get(STATE_CAP_TRIMMING_CAPABLE_KEY, "false")
+
+    if value != "true":
+        ctx.fail("Failed to configure switch trimming: operation is not supported")
+
 
 class SizeTypeValidator(click.ParamType):
     """ Size option validator """
@@ -44,10 +60,68 @@ def convert(self, value, param, ctx):
 
 class DscpTypeValidator(click.ParamType):
     """ Dscp option validator """
+    name = "text"
+
+    def get_metavar(self, param):
+        db = get_db(click.get_current_context())
+
+        entry = db.get_all(db.STATE_DB, "{}|{}".format(STATE_SWITCH_CAPABILITY, STATE_CAP_KEY))
+        entry.setdefault(STATE_CAP_DSCP_MODE_KEY, "N/A")
+
+        cap_list = entry[STATE_CAP_DSCP_MODE_KEY].split(',')
+
+        if cap_list.count(STATE_CAP_DSCP_MODE_FROM_TC) == len(cap_list):
+            return "from-tc"
+        elif cap_list.count(STATE_CAP_DSCP_MODE_DSCP_VALUE) == len(cap_list):
+            return "INTEGER"
+
+        return "[INTEGER|from-tc]"
+
+    def convert(self, value, param, ctx):
+        db = get_db(ctx)
+
+        entry = db.get_all(db.STATE_DB, "{}|{}".format(STATE_SWITCH_CAPABILITY, STATE_CAP_KEY))
+        entry.setdefault(STATE_CAP_DSCP_MODE_KEY, "N/A")
+
+        if not entry[STATE_CAP_DSCP_MODE_KEY]:
+            raise click.UsageError("Failed to configure {}: no dscp resolution mode capabilities".format(
+                param.get_error_hint(ctx)), ctx
+            )
+
+        verify_cap = True
+
+        if entry[STATE_CAP_DSCP_MODE_KEY] == "N/A":
+            verify_cap = False
+
+        cap_list = entry[STATE_CAP_DSCP_MODE_KEY].split(',')
+
+        if value == CFG_TRIM_DSCP_VALUE_FROM_TC:
+            if verify_cap and (STATE_CAP_DSCP_MODE_FROM_TC not in cap_list):
+                self.fail("asymmetric dscp resolution mode is not supported", param, ctx)
+        else:
+            if verify_cap and (STATE_CAP_DSCP_MODE_DSCP_VALUE not in cap_list):
+                self.fail("symmetric dscp resolution mode is not supported", param, ctx)
+
+            click.IntRange(DSCP_MIN, DSCP_MAX).convert(value, param, ctx)
+
+        return value
+
+
+class TcTypeValidator(click.ParamType):
+    """ Tc option validator """
     name = "integer"
 
     def convert(self, value, param, ctx):
-        click.IntRange(0, UINT8_MAX).convert(value, param, ctx)
+        db = get_db(ctx)
+
+        entry = db.get_all(db.STATE_DB, "{}|{}".format(STATE_SWITCH_CAPABILITY, STATE_CAP_KEY))
+        entry.setdefault(STATE_CAP_TC_NUM_KEY, "N/A")
+
+        if entry[STATE_CAP_TC_NUM_KEY] == "N/A":
+            click.IntRange(0, UINT8_MAX).convert(value, param, ctx)
+        else:
+            click.IntRange(0, int(entry[STATE_CAP_TC_NUM_KEY])-1).convert(value, param, ctx)
+
         return value
 
 
@@ -74,14 +148,8 @@ def convert(self, value, param, ctx):
         db = get_db(ctx)
 
         entry = db.get_all(db.STATE_DB, "{}|{}".format(STATE_SWITCH_CAPABILITY, STATE_CAP_KEY))
-
-        entry.setdefault(STATE_CAP_TRIMMING_CAPABLE_KEY, "false")
         entry.setdefault(STATE_CAP_QUEUE_MODE_KEY, "N/A")
-
-        if entry[STATE_CAP_TRIMMING_CAPABLE_KEY] == "false":
-            raise click.UsageError("Failed to configure {}: operation is not supported".format(
-                param.get_error_hint(ctx)), ctx
-            )
+        entry.setdefault(STATE_CAP_QUEUE_NUM_KEY, "N/A")
 
         if not entry[STATE_CAP_QUEUE_MODE_KEY]:
             raise click.UsageError("Failed to configure {}: no queue resolution mode capabilities".format(
@@ -102,7 +170,10 @@ def convert(self, value, param, ctx):
             if verify_cap and (STATE_CAP_QUEUE_MODE_STATIC not in cap_list):
                 self.fail("static queue resolution mode is not supported", param, ctx)
 
-            click.IntRange(0, UINT8_MAX).convert(value, param, ctx)
+            if entry[STATE_CAP_QUEUE_NUM_KEY] == "N/A":
+                click.IntRange(0, UINT8_MAX).convert(value, param, ctx)
+            else:
+                click.IntRange(0, int(entry[STATE_CAP_QUEUE_NUM_KEY])-1).convert(value, param, ctx)
 
         return value
 
@@ -176,33 +247,41 @@ def SWITCH_TRIMMING():
 @click.option(
     "-s", "--size", "size",
     help="Configures size (in bytes) to trim eligible packet",
-    type=SizeTypeValidator(),
+    type=SizeTypeValidator()
 )
 @click.option(
     "-d", "--dscp", "dscp",
     help="Configures DSCP value assigned to a packet after trimming",
-    type=DscpTypeValidator(),
+    type=DscpTypeValidator()
+)
+@click.option(
+    "-t", "--tc", "tc",
+    help="Configures TC value assigned to a packet after trimming",
+    type=TcTypeValidator()
 )
 @click.option(
     "-q", "--queue", "queue",
     help="Configures queue index to use for transmission of a packet after trimming",
-    type=QueueTypeValidator(),
+    type=QueueTypeValidator()
 )
 @clicommon.pass_db
 @click.pass_context
-def SWITCH_TRIMMING_GLOBAL(ctx, db, size, dscp, queue):
+def SWITCH_TRIMMING_GLOBAL(ctx, db, size, dscp, tc, queue):
     """ Configure switch trimming global """
 
-    if not (size or dscp or queue):
+    if not (size or dscp or tc or queue):
         raise click.UsageError("Failed to configure switch trimming global: no options are provided", ctx)
 
+    generic_validator(ctx, db.db)
+
     table = CFG_SWITCH_TRIMMING
     key = CFG_TRIM_KEY
 
     data = {
         "size": size,
         "dscp_value": dscp,
-        "queue_index": queue,
+        "tc_value": tc,
+        "queue_index": queue
     }
 
     try:

doc/Command-Reference.md

@@ -9166,19 +9166,22 @@ This command displays switch trimming global configuration.
   ```bash
   admin@sonic:~$ show switch-trimming global
   +-----------------------------+---------+
-  | Configuration               |   Value |
+  | Configuration               | Value   |
   +=============================+=========+
-  | Packet trimming size        |     200 |
+  | Packet trimming size        | 200     |
   +-----------------------------+---------+
-  | Packet trimming DSCP value  |      20 |
+  | Packet trimming DSCP value  | 20      |
   +-----------------------------+---------+
-  | Packet trimming queue index |       2 |
+  | Packet trimming TC value    | N/A     |
+  +-----------------------------+---------+
+  | Packet trimming queue index | 2       |
   +-----------------------------+---------+
 
   admin@sonic:~$ show switch-trimming global --json
   {
       "size": "200",
       "dscp_value": "20",
+      "tc_value": "N/A",
       "queue_index": "2"
   }
   ```
@@ -9199,22 +9202,21 @@ This command is used to manage switch trimming global configuration.
 - Options:
   - _-s,--size_: size (in bytes) to trim eligible packet
   - _-d,--dscp_: dscp value assigned to a packet after trimming
+  - _-t,--tc_: tc value assigned to a packet after trimming
   - _-q,--queue_: queue index to use for transmission of a packet after trimming
 
 - Examples:
   ```bash
-  admin@sonic:~$ config switch-trimming global \
-  --size '128' \
-  --dscp '48' \
-  --queue '6'
+  admin@sonic:~$ config switch-trimming global --size '128' --dscp '48' --queue '6'
+  admin@sonic:~$ config switch-trimming global --size '128' --dscp '48' --queue 'dynamic'
+  admin@sonic:~$ config switch-trimming global --size '128' --dscp 'from-tc' --tc '6' --queue '6'
+  admin@sonic:~$ config switch-trimming global --size '128' --dscp 'from-tc' --tc '6' --queue 'dynamic'
   ```
 
 - Note:
   - At least one option must be provided
+  - When `--dscp` value is set to `from-tc`, the `--tc` value is used for mapping to DSCP
   - When `--queue` value is set to `dynamic`, the `--dscp` value is used for mapping to the queue
-  ```bash
-  admin@sonic:~$ config switch-trimming global --queue dynamic
-  ```
 
 Go Back To [Beginning of the document](#) or [Beginning of this section](#packet-trimming)
 

show/plugins/sonic-trimming.py

@@ -9,7 +9,7 @@
 
 from utilities_common.switch_trimming import (
     CFG_SWITCH_TRIMMING,
-    CFG_TRIM_KEY
+    CFG_TRIM_KEY,
 )
 
 
@@ -81,6 +81,7 @@ def SWITCH_TRIMMING_GLOBAL(ctx, db, json_format):
         json_dict = {
             "size": entry.get("size", "N/A"),
             "dscp_value": entry.get("dscp_value", "N/A"),
+            "tc_value": entry.get("tc_value", "N/A"),
             "queue_index": entry.get("queue_index", "N/A")
         }
         click.echo(json.dumps(json_dict, indent=4))
@@ -110,6 +111,18 @@ def SWITCH_TRIMMING_GLOBAL(ctx, db, json_format):
     ]
     body.append(row)
 
+    row = [
+        "Packet trimming TC value",
+        format_attr_value(
+            entry,
+            {
+                'name': 'tc_value',
+                'is-leaf-list': False
+            }
+        )
+    ]
+    body.append(row)
+
     row = [
         "Packet trimming queue index",
         format_attr_value(

tests/trimming_input/assert_show_output.py

@@ -14,32 +14,38 @@
 +-----------------------------+---------+
 | Packet trimming DSCP value  | 20      |
 +-----------------------------+---------+
+| Packet trimming TC value    | N/A     |
++-----------------------------+---------+
 | Packet trimming queue index | N/A     |
 +-----------------------------+---------+
 """
 show_trim_partial_json = """\
 {
     "size": "200",
     "dscp_value": "20",
+    "tc_value": "N/A",
     "queue_index": "N/A"
 }
 """
 
-show_trim_queue_static = """\
+show_trim_dscp_asymmetric = """\
 +-----------------------------+---------+
-| Configuration               |   Value |
+| Configuration               | Value   |
 +=============================+=========+
-| Packet trimming size        |     200 |
+| Packet trimming size        | 200     |
 +-----------------------------+---------+
-| Packet trimming DSCP value  |      20 |
+| Packet trimming DSCP value  | from-tc |
 +-----------------------------+---------+
-| Packet trimming queue index |       2 |
+| Packet trimming TC value    | 2       |
++-----------------------------+---------+
+| Packet trimming queue index | 2       |
 +-----------------------------+---------+
 """
-show_trim_queue_static_json = """\
+show_trim_dscp_asymmetric_json = """\
 {
     "size": "200",
-    "dscp_value": "20",
+    "dscp_value": "from-tc",
+    "tc_value": "2",
     "queue_index": "2"
 }
 """
@@ -52,13 +58,16 @@
 +-----------------------------+---------+
 | Packet trimming DSCP value  | 20      |
 +-----------------------------+---------+
+| Packet trimming TC value    | N/A     |
++-----------------------------+---------+
 | Packet trimming queue index | dynamic |
 +-----------------------------+---------+
 """
 show_trim_queue_dynamic_json = """\
 {
     "size": "200",
     "dscp_value": "20",
+    "tc_value": "N/A",
     "queue_index": "dynamic"
 }
 """

…ming_input/mock_config/queue_static.json …g_input/mock_config/dscp_asymmetric.jsontests/trimming_input/mock_config/queue_static.json renamed to tests/trimming_input/mock_config/dscp_asymmetric.json tests/trimming_input/mock_config/queue_static.json renamed to tests/trimming_input/mock_config/dscp_asymmetric.json

@@ -1,7 +1,8 @@
 {
     "SWITCH_TRIMMING|GLOBAL": {
         "size": "200",
-        "dscp_value": "20",
+        "dscp_value": "from-tc",
+        "tc_value": "2",
         "queue_index": "2"
     }
 }

tests/trimming_input/mock_state/all.json

@@ -1,6 +1,9 @@
 {
     "SWITCH_CAPABILITY|switch": {
         "SWITCH_TRIMMING_CAPABLE": "true",
-        "SWITCH|PACKET_TRIMMING_QUEUE_RESOLUTION_MODE": "STATIC,DYNAMIC"
+        "SWITCH|PACKET_TRIMMING_DSCP_RESOLUTION_MODE": "DSCP_VALUE,FROM_TC",
+        "SWITCH|PACKET_TRIMMING_QUEUE_RESOLUTION_MODE": "STATIC,DYNAMIC",
+        "SWITCH|NUMBER_OF_TRAFFIC_CLASSES": "16",
+        "SWITCH|NUMBER_OF_UNICAST_QUEUES": "8"
     }
 }

tests/trimming_input/mock_state/dscp_asymmetric.json

@@ -0,0 +1,9 @@
+{
+    "SWITCH_CAPABILITY|switch": {
+        "SWITCH_TRIMMING_CAPABLE": "true",
+        "SWITCH|PACKET_TRIMMING_DSCP_RESOLUTION_MODE": "FROM_TC",
+        "SWITCH|PACKET_TRIMMING_QUEUE_RESOLUTION_MODE": "STATIC,DYNAMIC",
+        "SWITCH|NUMBER_OF_TRAFFIC_CLASSES": "16",
+        "SWITCH|NUMBER_OF_UNICAST_QUEUES": "8"
+    }
+}

tests/trimming_input/mock_state/dscp_symmetric.json

@@ -0,0 +1,9 @@
+{
+    "SWITCH_CAPABILITY|switch": {
+        "SWITCH_TRIMMING_CAPABLE": "true",
+        "SWITCH|PACKET_TRIMMING_DSCP_RESOLUTION_MODE": "DSCP_VALUE",
+        "SWITCH|PACKET_TRIMMING_QUEUE_RESOLUTION_MODE": "STATIC,DYNAMIC",
+        "SWITCH|NUMBER_OF_TRAFFIC_CLASSES": "16",
+        "SWITCH|NUMBER_OF_UNICAST_QUEUES": "8"
+    }
+}

tests/trimming_input/mock_state/no_capabilities.json

@@ -1,6 +1,9 @@
 {
     "SWITCH_CAPABILITY|switch": {
         "SWITCH_TRIMMING_CAPABLE": "true",
-        "SWITCH|PACKET_TRIMMING_QUEUE_RESOLUTION_MODE": ""
+        "SWITCH|PACKET_TRIMMING_DSCP_RESOLUTION_MODE": "",
+        "SWITCH|PACKET_TRIMMING_QUEUE_RESOLUTION_MODE": "",
+        "SWITCH|NUMBER_OF_TRAFFIC_CLASSES": "N/A",
+        "SWITCH|NUMBER_OF_UNICAST_QUEUES": "N/A"
     }
 }

tests/trimming_input/mock_state/not_supported.json

@@ -1,6 +1,9 @@
 {
     "SWITCH_CAPABILITY|switch": {
         "SWITCH_TRIMMING_CAPABLE": "false",
-        "SWITCH|PACKET_TRIMMING_QUEUE_RESOLUTION_MODE": ""
+        "SWITCH|PACKET_TRIMMING_DSCP_RESOLUTION_MODE": "",
+        "SWITCH|PACKET_TRIMMING_QUEUE_RESOLUTION_MODE": "",
+        "SWITCH|NUMBER_OF_TRAFFIC_CLASSES": "N/A",
+        "SWITCH|NUMBER_OF_UNICAST_QUEUES": "N/A"
     }
 }