aboutsummaryrefslogtreecommitdiffstats
path: root/resources/tools/trex/trex_stateless_stop.py
blob: b8b0212635d5d76e19d3a4fed8b3e480ef7b6f4f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
#!/usr/bin/python3

# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""This script uses T-REX stateless API to drive t-rex instance.

Requirements:
- T-REX: https://github.com/cisco-system-traffic-generator/trex-core
 - compiled and running T-REX process (eg. ./t-rex-64 -i)
 - trex.stl.api library
- Script must be executed on a node with T-REX instance

Functionality:
1. Stop any running traffic
2. Optionally restore reference counter values.
3. Return conter differences.
"""

import argparse
from collections import OrderedDict  # Needed to parse xstats representation.
import sys
import json

sys.path.insert(0, "/opt/trex-core-2.54/scripts/automation/"+\
                   "trex_control_plane/interactive/")
from trex.stl.api import *


def main():
    """Stop traffic if any is running. Report xstats."""
    parser = argparse.ArgumentParser()
    parser.add_argument(
        "--xstat0", type=str, default="", help="Reference xstat object if any.")
    parser.add_argument(
        "--xstat1", type=str, default="", help="Reference xstat object if any.")
    args = parser.parse_args()

    client = STLClient()
    try:
        # connect to server
        client.connect()

        client.acquire(force=True)
        # TODO: Support unidirection.
        client.stop(ports=[0, 1])

        # Read the stats after the test,
        # we need to update values before the last trial started.
        if args.xstat0:
            snapshot = eval(args.xstat0)
            client.ports[0].get_xstats().reference_stats = snapshot
        if args.xstat1:
            snapshot = eval(args.xstat1)
            client.ports[1].get_xstats().reference_stats = snapshot
        # Now we can call the official method to get differences.
        xstats0 = client.get_xstats(0)
        xstats1 = client.get_xstats(1)

    # If STLError happens, let the script fail with stack trace.
    finally:
        client.disconnect()

    print("##### statistics port 0 #####")
    print(json.dumps(xstats0, indent=4, separators=(',', ': ')))
    print("##### statistics port 1 #####")
    print(json.dumps(xstats1, indent=4, separators=(',', ': ')))

    tx_0, rx_0 = xstats0["tx_good_packets"], xstats0["rx_good_packets"]
    tx_1, rx_1 = xstats1["tx_good_packets"], xstats1["rx_good_packets"]
    lost_a, lost_b = tx_0 - rx_1, tx_1 - rx_0

    print("\npackets lost from 0 --> 1:   {0} pkts".format(lost_a))
    print("packets lost from 1 --> 0:   {0} pkts".format(lost_b))

    total_rcvd, total_sent = rx_0 + rx_1, tx_0 + tx_1
    total_lost = total_sent - total_rcvd
    # TODO: Add latency.
    print(
        "rate='unknown', totalReceived={rec}, totalSent={sen}, frameLoss={los},"
        " latencyStream0(usec)=-1/-1/-1, latencyStream1(usec)=-1/-1/-1,"
        " targetDuration='manual'".format(
            rec=total_rcvd, sen=total_sent, los=total_lost))

if __name__ == "__main__":
    main()