GPL/tools/trex/trex_stl_stop.py

   1 #!/usr/bin/python3
   2
   3 # Copyright (c) 2020 Cisco and/or its affiliates.
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 """This script uses T-REX stateless API to drive t-rex instance.
  17
  18 Requirements:
  19 - T-REX: https://github.com/cisco-system-traffic-generator/trex-core
  20  - compiled and running T-REX process (eg. ./t-rex-64 -i)
  21  - trex.stl.api library
  22 - Script must be executed on a node with T-REX instance
  23
  24 Functionality:
  25 1. Stop any running traffic
  26 2. Optionally restore reference counter values.
  27 3. Return conter differences.
  28 """
  29
  30 import argparse
  31 import json
  32 import sys
  33
  34 from collections import OrderedDict  # Needed to parse xstats representation.
  35
  36 sys.path.insert(
  37     0, u"/opt/trex-core-2.82/scripts/automation/trex_control_plane/interactive/"
  38 )
  39 from trex.stl.api import *
  40
  41
  42 def main():
  43     """Stop traffic if any is running. Report xstats."""
  44     parser = argparse.ArgumentParser()
  45     parser.add_argument(
  46         u"--xstat0", type=str, default=u"",
  47         help=u"Reference xstat object if any."
  48     )
  49     parser.add_argument(
  50         u"--xstat1", type=str, default=u"",
  51         help=u"Reference xstat object if any."
  52     )
  53     args = parser.parse_args()
  54
  55     client = STLClient()
  56     try:
  57         # connect to server
  58         client.connect()
  59
  60         client.acquire(force=True)
  61         # TODO: Support unidirection.
  62         client.stop(ports=[0, 1])
  63
  64         # Read the stats after the test,
  65         # we need to update values before the last trial started.
  66         if args.xstat0:
  67             snapshot = eval(args.xstat0)
  68             client.ports[0].get_xstats().reference_stats = snapshot
  69         if args.xstat1:
  70             snapshot = eval(args.xstat1)
  71             client.ports[1].get_xstats().reference_stats = snapshot
  72         # Now we can call the official method to get differences.
  73         xstats0 = client.get_xstats(0)
  74         xstats1 = client.get_xstats(1)
  75
  76     # If STLError happens, let the script fail with stack trace.
  77     finally:
  78         client.disconnect()
  79
  80     print(u"##### statistics port 0 #####")
  81     print(json.dumps(xstats0, indent=4, separators=(u",", u": ")))
  82     print(u"##### statistics port 1 #####")
  83     print(json.dumps(xstats1, indent=4, separators=(u",", u": ")))
  84
  85     tx_0, rx_0 = xstats0[u"tx_good_packets"], xstats0[u"rx_good_packets"]
  86     tx_1, rx_1 = xstats1[u"tx_good_packets"], xstats1[u"rx_good_packets"]
  87     lost_a, lost_b = tx_0 - rx_1, tx_1 - rx_0
  88
  89     print(f"\npackets lost from 0 --> 1:   {lost_a} pkts")
  90     print(f"packets lost from 1 --> 0:   {lost_b} pkts")
  91
  92     total_rcvd, total_sent = rx_0 + rx_1, tx_0 + tx_1
  93     total_lost = total_sent - total_rcvd
  94     print(
  95         f"rate='unknown'; "
  96         f"total_received={total_rcvd}; "
  97         f"total_sent={total_sent}; "
  98         f"frame_loss={total_lost}; "
  99         f"target_duration='manual'; "
 100         f"approximated_duration='manual'; "
 101         f"approximated_rate='unknown'; "
 102         f"latency_stream_0(usec)=-1/-1/-1; "
 103         f"latency_stream_1(usec)=-1/-1/-1; "
 104     )
 105
 106
 107 if __name__ == u"__main__":
 108     main()