[201911] [Flex Counters] add CLI for PG drop packets counters (counterpoll, show/clear counters)

clear/main.py

@@ -227,6 +227,20 @@ def clear_wm_pg_shared():
     command = 'watermarkstat -c -t pg_shared'
     run_command(command)
 
+@priority_group.group()
+def drop():
+    """Clear priority-group dropped packets stats"""
+    pass
+
+@drop.command('counters')
+def clear_pg_counters():
+    """Clear priority-group dropped packets counter """
+
+    if os.geteuid() != 0 and os.environ.get("UTILITIES_UNIT_TESTING", "0") != "2":
+        exit("Root privileges are required for this operation")
+    command = 'pg-drop -c clear'
+    run_command(command)
+
 @priority_group.group(name='persistent-watermark')
 def persistent_watermark():
     """Clear queue persistent WM. One does not simply clear WM, root is required"""

counterpoll/main.py

@@ -6,6 +6,7 @@
 
 BUFFER_POOL_WATERMARK = "BUFFER_POOL_WATERMARK"
 PORT_BUFFER_DROP = "PORT_BUFFER_DROP"
+PG_DROP = "PG_DROP"
 DISABLE = "disable"
 ENABLE = "enable"
 DEFLT_60_SEC= "default (60000)"
@@ -124,6 +125,45 @@ def disable():
     port_info['FLEX_COUNTER_STATUS'] = DISABLE
     configdb.mod_entry("FLEX_COUNTER_TABLE", PORT_BUFFER_DROP, port_info)
 
+# Ingress PG drop packet stat
+@cli.group()
+@click.pass_context
+def pg_drop(ctx):
+    """  Ingress PG drop counter commands """
+    ctx.obj = swsssdk.ConfigDBConnector()
+    ctx.obj.connect()
+
+@pg_drop.command()
+@click.argument('poll_interval', type=click.IntRange(1000, 30000))
+@click.pass_context
+def interval(ctx, poll_interval):
+    """
+    Set pg_drop packets counter query interval
+    interval is between 1s and 30s.
+    """
+
+    port_info = {}
+    port_info['POLL_INTERVAL'] = poll_interval
+    ctx.obj.mod_entry("FLEX_COUNTER_TABLE", PG_DROP, port_info)
+
+@pg_drop.command()
+@click.pass_context
+def enable(ctx):
+    """ Enable pg_drop counter query """
+
+    port_info = {}
+    port_info['FLEX_COUNTER_STATUS'] = ENABLE
+    ctx.obj.mod_entry("FLEX_COUNTER_TABLE", PG_DROP, port_info)
+
+@pg_drop.command()
+@click.pass_context
+def disable(ctx):
+    """ Disable pg_drop counter query """
+
+    port_info = {}
+    port_info['FLEX_COUNTER_STATUS'] = DISABLE
+    ctx.obj.mod_entry("FLEX_COUNTER_TABLE", PG_DROP, port_info)
+
 # RIF counter commands
 @cli.group()
 def rif():
@@ -213,6 +253,7 @@ def show():
     rif_info = configdb.get_entry('FLEX_COUNTER_TABLE', 'RIF')
     queue_wm_info = configdb.get_entry('FLEX_COUNTER_TABLE', 'QUEUE_WATERMARK')
     pg_wm_info = configdb.get_entry('FLEX_COUNTER_TABLE', 'PG_WATERMARK')
+    pg_drop_info = configdb.get_entry('FLEX_COUNTER_TABLE', PG_DROP)
     buffer_pool_wm_info = configdb.get_entry('FLEX_COUNTER_TABLE', BUFFER_POOL_WATERMARK)
 
     header = ("Type", "Interval (in ms)", "Status")
@@ -229,6 +270,8 @@ def show():
         data.append(["QUEUE_WATERMARK_STAT", queue_wm_info.get("POLL_INTERVAL", DEFLT_10_SEC), queue_wm_info.get("FLEX_COUNTER_STATUS", DISABLE)])
     if pg_wm_info:
         data.append(["PG_WATERMARK_STAT", pg_wm_info.get("POLL_INTERVAL", DEFLT_10_SEC), pg_wm_info.get("FLEX_COUNTER_STATUS", DISABLE)])
+    if pg_drop_info:
+        data.append(['PG_DROP_STAT', pg_drop_info.get("POLL_INTERVAL", DEFLT_10_SEC), pg_drop_info.get("FLEX_COUNTER_STATUS", DISABLE)])
     if buffer_pool_wm_info:
         data.append(["BUFFER_POOL_WATERMARK_STAT", buffer_pool_wm_info.get("POLL_INTERVAL", DEFLT_10_SEC), buffer_pool_wm_info.get("FLEX_COUNTER_STATUS", DISABLE)])
 

doc/Command-Reference.md

@@ -4465,11 +4465,14 @@ This command displays the user watermark for the queues (Egress shared pool occu
 
 **show priority-group**
 
-This command displays the user watermark or persistent-watermark for the Ingress "headroom" or "shared pool occupancy" per priority-group for  all ports
+This command displays:
+1) The user watermark or persistent-watermark for the Ingress "headroom" or "shared pool occupancy" per priority-group for all ports.
+2) Dropped packets per priority-group for all ports
 
 - Usage:
   ```
   show priority-group (watermark | persistent-watermark) (headroom | shared)
+  show priority-group drop counters
   ```
 
 - Example:
@@ -4499,6 +4502,18 @@ This command displays the user watermark or persistent-watermark for the Ingress
   admin@sonic:~$ show priority-group persistent-watermark headroom
   ```
 
+- Example (Ingress dropped packets per PG):
+  ```
+  admin@sonic:~$ show priority-group drop counters
+  Ingress PG dropped packets:
+        Port    PG0    PG1    PG2    PG3    PG4    PG5    PG6    PG7
+  -----------  -----  -----  -----  -----  -----  -----  -----  -----
+    Ethernet0      0      0      0      0      0      0      0      0
+    Ethernet4      0      0      0      0      0      0      0      0
+    Ethernet8      0      0      0      0      0      0      0      0
+   Ethernet12      0      0      0      0      0      0      0      0
+  ```
+
 In addition to user watermark("show queue|priority-group watermark ..."), a persistent watermark is available.
 It hold values independently of user watermark. This way user can use "user watermark" for debugging, clear it, etc, but the "persistent watermark" will not be affected.
 
@@ -4528,7 +4543,7 @@ This command displays the user persistet-watermark for the queues (Egress shared
   admin@sonic:~$ show queue persistent-watermark multicast
   ```
 
-- NOTE: Both "user watermark" and "persistent watermark" can be cleared by user:
+- NOTE: "user watermark", "persistent watermark" and "ingress dropped packets" can be cleared by user:
 
   ```
   root@sonic:~# sonic-clear queue persistent-watermark unicast

scripts/pg-drop

@@ -0,0 +1,250 @@
+#!/usr/bin/python
+
+#####################################################################
+#
+# pg-drop is a tool for show/clear ingress pg dropped packet stats.
+#
+#####################################################################
+import pickle
+import argparse
+import os
+import sys
+from collections import OrderedDict
+
+from natsort import natsorted
+from tabulate import tabulate
+
+# mock the redis for unit test purposes #
+try:
+    if os.environ["UTILITIES_UNIT_TESTING"] == "2":
+        modules_path = os.path.join(os.path.dirname(__file__), "..")
+        tests_path = os.path.join(modules_path, "sonic-utilities-tests")
+        sys.path.insert(0, modules_path)
+        sys.path.insert(0, tests_path)
+        import mock_tables.dbconnector
+
+except KeyError:
+    pass
+
+from swsssdk import SonicV2Connector
+
+STATUS_NA = 'N/A'
+
+COUNTER_TABLE_PREFIX = "COUNTERS:"
+
+COUNTERS_PORT_NAME_MAP = "COUNTERS_PORT_NAME_MAP"
+COUNTERS_PG_NAME_MAP = "COUNTERS_PG_NAME_MAP"
+COUNTERS_PG_PORT_MAP = "COUNTERS_PG_PORT_MAP"
+COUNTERS_PG_INDEX_MAP = "COUNTERS_PG_INDEX_MAP"
+
+def get_dropstat_dir():
+    dropstat_dir_prefix = '/tmp/dropstat'
+    return "{}-{}/".format(dropstat_dir_prefix, os.getuid())
+
+class PgDropStat(object):
+
+    def __init__(self):
+        self.counters_db = SonicV2Connector(host='127.0.0.1')
+        self.counters_db.connect(self.counters_db.COUNTERS_DB)
+
+        dropstat_dir = get_dropstat_dir()
+        self.port_drop_stats_file = os.path.join(dropstat_dir, 'pg_drop_stats')
+
+        def get_port_id(oid):
+            """
+                Get port ID using object ID
+            """
+            port_id = self.counters_db.get(self.counters_db.COUNTERS_DB, COUNTERS_PG_PORT_MAP, oid)
+            if port_id is None:
+                print "Port is not available for oid '{}'".format(oid), sys.stderr
+                sys.exit(1)
+            return port_id
+
+        # Get all ports
+        self.counter_port_name_map = self.counters_db.get_all(self.counters_db.COUNTERS_DB, COUNTERS_PORT_NAME_MAP)
+        if self.counter_port_name_map is None:
+            print "COUNTERS_PORT_NAME_MAP is empty!", sys.stderr
+            sys.exit(1)
+
+        self.port_pg_map = {}
+        self.port_name_map = {}
+
+        for port in self.counter_port_name_map:
+            self.port_pg_map[port] = {}
+            self.port_name_map[self.counter_port_name_map[port]] = port
+
+        # Get PGs for each port
+        counter_pg_name_map = self.counters_db.get_all(self.counters_db.COUNTERS_DB, COUNTERS_PG_NAME_MAP)
+        if counter_pg_name_map is None:
+            print "COUNTERS_PG_NAME_MAP is empty!", sys.stderr
+            sys.exit(1)
+
+        for pg in counter_pg_name_map:
+            port = self.port_name_map[get_port_id(counter_pg_name_map[pg])]
+            self.port_pg_map[port][pg] = counter_pg_name_map[pg]
+
+        self.pg_drop_types = {
+            "pg_drop"       : {"message" : "Ingress PG dropped packets:",
+                               "obj_map" : self.port_pg_map,
+                               "idx_func": self.get_pg_index,
+                               "counter_name" : "SAI_INGRESS_PRIORITY_GROUP_STAT_DROPPED_PACKETS",
+                               "header_prefix": "PG"},
+        }
+
+    def get_pg_index(self, oid):
+        """
+            return PG index (0-7)
+
+            oid - object ID for entry in redis
+        """
+        pg_index = self.counters_db.get(self.counters_db.COUNTERS_DB, COUNTERS_PG_INDEX_MAP, oid)
+        if pg_index is None:
+            print "Priority group index is not available for oid '{}'".format(table_id), sys.stderr
+            sys.exit(1)
+        return pg_index
+
+    def build_header(self, pg_drop_type):
+        """
+            Construct header for table with PG counters
+        """
+        if pg_drop_type is None:
+            print "Header info is not available!", sys.stderr
+            sys.exit(1)
+
+        self.header_list = ['Port']
+        header_map = pg_drop_type["obj_map"]
+        single_key = list(header_map.keys())[0]
+        header_len = len(header_map[single_key])
+        min_idx = sys.maxsize
+
+        for name, counter_oid in header_map[single_key].items():
+            curr_idx = int(pg_drop_type["idx_func"](counter_oid))
+            min_idx = min(min_idx, curr_idx)
+
+        self.min_idx = min_idx
+        self.header_list += ["{}{}".format(pg_drop_type["header_prefix"], idx) for idx in range(self.min_idx, self.min_idx + header_len)]
+
+    def get_counters(self, table_prefix, port_obj, idx_func, counter_name):
+        """
+            Get the counters of a specific table.
+        """
+        port_drop_ckpt = {}
+        # Grab the latest clear checkpoint, if it exists
+        if os.path.isfile(self.port_drop_stats_file):
+            port_drop_ckpt = pickle.load(open(self.port_drop_stats_file, 'rb'))
+
+        # Header list contains the port name followed by the PGs. Fields is used to populate the pg values
+        fields = ["0"]* (len(self.header_list) - 1)
+
+        for name, obj_id in port_obj.items():
+            full_table_id = table_prefix + obj_id
+            old_collected_data = port_drop_ckpt.get(name,{})[full_table_id] if len(port_drop_ckpt) > 0 else 0
+            idx = int(idx_func(obj_id))
+            pos = idx - self.min_idx
+            counter_data = self.counters_db.get(self.counters_db.COUNTERS_DB, full_table_id, counter_name)
+            if counter_data is None:
+                fields[pos] = STATUS_NA
+            elif fields[pos] != STATUS_NA:
+                fields[pos] = str(int(counter_data) -  old_collected_data)
+        return fields
+
+    def print_all_stat(self, table_prefix, key):
+        """
+            Print table that show stats per PG
+        """
+        table = []
+        type = self.pg_drop_types[key]
+        self.build_header(type)
+        # Get stat for each port
+        for port in natsorted(self.counter_port_name_map):
+            row_data = list()
+            data = self.get_counters(table_prefix, type["obj_map"][port], type["idx_func"], type["counter_name"])
+            row_data.append(port)
+            row_data.extend(data)
+            table.append(tuple(row_data))
+
+        print type["message"]
+        print tabulate(table, self.header_list, tablefmt='simple', stralign='right')
+
+    def get_counts(self, counters, oid):
+            """
+                Get the PG drop counts for an individual counter.
+            """
+            counts = {}
+            table_id = COUNTER_TABLE_PREFIX + oid
+            for counter in counters:
+                counter_data = self.counters_db.get(self.counters_db.COUNTERS_DB, table_id, counter)
+                if counter_data is None:
+                    counts[table_id] = 0
+                else:
+                    counts[table_id] = int(counter_data)
+            return counts
+
+    def get_counts_table(self, counters, object_table):
+        """
+            Returns a dictionary containing a mapping from an object (like a port)
+            to its PG drop counts. Counts are contained in a dictionary that maps
+            counter oid to its counts.
+        """
+        counter_object_name_map = self.counters_db.get_all(self.counters_db.COUNTERS_DB, object_table)
+        current_stat_dict = OrderedDict()
+
+        if counter_object_name_map is None:
+            return current_stat_dict
+
+        for obj in natsorted(counter_object_name_map):
+            current_stat_dict[obj] = self.get_counts(counters, counter_object_name_map[obj])
+        return current_stat_dict
+
+    def clear_drop_counts(self):
+        """
+            Clears the current PG drop counter.
+        """
+
+        counter_pg_drop_array = [ "SAI_INGRESS_PRIORITY_GROUP_STAT_DROPPED_PACKETS"]
+        try:
+            pickle.dump(self.get_counts_table(
+                counter_pg_drop_array,
+                COUNTERS_PG_NAME_MAP),
+                open(self.port_drop_stats_file, 'wb+'))
+        except IOError as e:
+            print e
+            sys.exit(e.errno)
+        print "Cleared PG drop counter"
+
+def main():
+    parser = argparse.ArgumentParser(description='Display PG drop counter',
+                                     formatter_class=argparse.RawTextHelpFormatter,
+                                     epilog="""
+Examples:
+pg-drop -c show
+pg-drop -c clear
+""")
+
+    parser.add_argument('-c', '--command', type=str, help='Desired action to perform')
+
+    args = parser.parse_args()
+    command = args.command
+
+    dropstat_dir = get_dropstat_dir()
+    # Create the directory to hold clear results
+    if not os.path.exists(dropstat_dir):
+        try:
+            os.makedirs(dropstat_dir)
+        except IOError as e:
+            print e
+            sys.exit(e.errno)
+
+    pgdropstat = PgDropStat()
+
+    if command == 'clear':
+        pgdropstat.clear_drop_counts()
+    elif command == 'show':
+        pgdropstat.print_all_stat(COUNTER_TABLE_PREFIX, "pg_drop" )
+    else:
+        print "Command not recognized"
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()

setup.py

@@ -109,6 +109,7 @@
         'scripts/nbrshow',
         'scripts/neighbor_advertiser',
         'scripts/pcmping',
+        'scripts/pg-drop',
         'scripts/port2alias',
         'scripts/portconfig',
         'scripts/portstat',