CSIT-66 Ixia Network driver

[csit.git] / resources / tools / ixnet / ixia-stateless.py

#!/usr/bin/python

# Copyright (c) 2016 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 IxNetwork Python API to control IxNetwork.

Requirements:
- IxNetwork v7.51
 - ixnetwork.py library v7.51.1014.17 in /opt/ixnet-7.51

"""

import argparse
import sys
import time

sys.path.insert(0, "/opt/ixnet-7.51/")
from IxNetwork import IxNet


class IxDriverError(Exception):
    """Ixia-driver error handling."""


def add_ports(ixnet, count):
    """Add ports to configuration.

    :param ixnet: Instance of IxNet class.
    :param count: Number of ports to add.
    :type ixnet: IxNet
    :type count: int
    :return: List of ports added to configuration.
    :rtype: list
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')
    if count <= 0 or count % 2 != 0:
        raise ValueError('Port count must be even and higher then zero')

    for _ in range(count):
        ixnet.add(ixnet.getRoot(), 'vport')

    ixnet.commit()

    return ixnet.getList(ixnet.getRoot(), 'vport')


def configure_endpoints(ixnet, topologies, args):
    """Configure endpoints with topologies.

    :param ixnet: Instance of IxNet class.
    :param topologies: List of topologies.
    :param args: Arguments from command line.
    :type ixnet: IxNet
    :type topologies: list
    :type args: ArgumentParser
    :return: Traffic items
    :rtype: list
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')
    if topologies is None:
        raise ValueError('No topologies created')

    traffic_items = []

    if args.traffic_type == 'ethernetVlan':
        path = '/deviceGroup:1/ethernet:1'
    elif args.traffic_type == 'ipv4':
        path = '/deviceGroup:1/ethernet:1/ipv4:1'
    elif args.traffic_type == 'ipv6':
        path = '/deviceGroup:1/ethernet:1/ipv6:1'
    else:
        raise ValueError('Traffic type not supported')

    if args.pairing == 'full':
        pairing = zip(topologies, topologies[1:])[::2]
    elif args.pairing == 'half':
        step = len(args.if_port)/2
        pairing = zip(topologies, topologies[step:])[::1]
    else:
        raise ValueError('Pairing type not supported')

    # Pairing endpoints and assigning them into traffic items
    for topo1, topo2 in pairing:
        src = [topo1 + path]
        dst = [topo2 + path]
        topo1_name = ixnet.getAttribute(topo1, '-name')
        topo2_name = ixnet.getAttribute(topo2, '-name')
        traffic_item = configure_traffic_item(ixnet, topo1_name, src, dst,
                                              args.frame_size, args.rate,
                                              args.rate_units,
                                              args.traffic_type)
        traffic_items.append(traffic_item)
        traffic_item = configure_traffic_item(ixnet, topo2_name, dst, src,
                                              args.frame_size, args.rate,
                                              args.rate_units,
                                              args.traffic_type)
        traffic_items.append(traffic_item)

    return traffic_items


def configure_traffic_item(ixnet, name, src_ep, dst_ep, frame_size,
                           rate, rate_units, traffic_type):
    """Create and configure traffic item.

    :param ixnet: Instance of IxNet class.
    :param name: Name of traffic profile.
    :param src_ep: Source topology endpoint.
    :param dst_ep: Destination topology endpoint.
    :param frame_size: L2 frame size.
    :param rate: Rate.
    :param rate_units: Rate type (pps, perc, bps).
    :param traffic_type: Traffic type (ipv4, ipv6, ethernetVlan).
    :type ixnet: IxNet
    :type name: str
    :type src_ep: str
    :type dst_ep: str
    :type frame_size: int
    :type rate: str
    :type rate_units: str
    :type traffic_type: str
    :return: Created traffic item string.
    :rtype: str
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')
    if traffic_type == 'ipv4':
        if frame_size < 64:
            raise ValueError('Min. frame size for traffic type is 64B')
    elif traffic_type == 'ipv6':
        if frame_size < 78:
            raise ValueError('Min. frame size for traffic type is 78B')
    elif traffic_type == 'ethernetVlan':
        if frame_size < 64:
            raise ValueError('Min. frame size for traffic type is 64B')
    else:
        raise ValueError('Traffic type not supported')

    ixnet.add(ixnet.getRoot() + '/traffic', 'trafficItem')
    ixnet.commit()
    traffic_item = ixnet.getList(ixnet.getRoot() + '/traffic',
                                 'trafficItem')[-1]
    ixnet.setMultiAttribute(traffic_item,
                            '-name', name,
                            '-trafficType', traffic_type,
                            '-allowSelfDestined', False,
                            '-trafficItemType', 'l2L3',
                            '-mergeDestinations', True,
                            '-egressEnabled', False,
                            '-srcDestMesh', 'oneToOne',
                            '-enabled', True,
                            '-routeMesh', 'oneToOne',
                            '-transmitMode', 'interleaved',
                            '-biDirectional', False,
                            '-hostsPerNetwork', 1)
    ixnet.setAttribute(traffic_item, '-trafficType', traffic_type)
    ixnet.add(traffic_item, 'endpointSet',
              '-sources', src_ep,
              '-destinations', dst_ep,
              '-name', 'endpointSet1')
    ixnet.setMultiAttribute(traffic_item + '/configElement:1/frameSize',
                            '-type', 'fixed',
                            '-fixedSize', frame_size)
    ixnet.commit()

    # Use 4 Byte Signature
    ixnet.setAttribute(ixnet.getRoot() + '/traffic', '-enableMinFrameSize',
                       True)
    ixnet.commit()

    if rate_units == 'pps':
        ixnet.setMultiAttribute(traffic_item + '/configElement:1/frameRate',
                                '-type', 'framesPerSecond',
                                '-rate', rate)
    elif rate_units == '%':
        ixnet.setMultiAttribute(traffic_item + '/configElement:1/frameRate',
                                '-type', 'percentLineRate',
                                '-rate', rate)
    elif rate_units == 'bps':
        ixnet.setMultiAttribute(traffic_item + '/configElement:1/frameRate',
                                '-type', 'bitsPerSecond',
                                '-rate', rate)
    else:
        raise ValueError('Rate type not supported')

    ixnet.setMultiAttribute(traffic_item + '/configElement:1/transmissionControl',
                            '-type', 'continuous')
    ixnet.setMultiAttribute(traffic_item + "/tracking",
                            '-trackBy', ['trackingenabled0'])
    ixnet.commit()

    # Get Full packet stack
    flow_group = ixnet.remapIds(traffic_item)[0]
    highlevel_stream = ixnet.getList(flow_group, 'highLevelStream')[0]
    traffic_stacks = ixnet.getList(highlevel_stream, 'stack')

    return traffic_item


def configure_protocols(ixnet, vports, args):
    """Create and configure topologies and protocols.

    :param ixnet: Instance of IxNet class.
    :param vports: List of ports added to configuration.
    :param args: Arguments from command line.
    :type ixnet: IxNet
    :type vports: list
    :type args: ArgumentParser
    :return: Topologies list
    :rtype: list
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')
    if vports is None:
        raise ValueError('Vports is Null')

    topologies = None

    # Add topologies
    for _ in vports:
        ixnet.add(ixnet.getRoot(), 'topology')
    ixnet.commit()

    # Get all topologies
    topologies = ixnet.getList(ixnet.getRoot(), 'topology')

    device_groups = []
    # Pair topology with vport and add device group for each
    for topology, vport in zip(topologies, vports):
        # Add ports to topologies
        ixnet.setAttribute(topology, '-vports', vport)
        # Add device groups to topologies
        ixnet.add(topology, 'deviceGroup')
        ixnet.commit()
        device_groups.append(ixnet.getList(topology, 'deviceGroup')[0])

    ethernets = []
    # Add ethernet protocol stacks to device groups
    for device_group, cnt in zip(device_groups, args.port_src_ip_cnt):
        ixnet.setAttribute(device_group, '-multiplier', cnt)
        ixnet.add(device_group, 'ethernet')
        ixnet.commit()
        ethernets.append(ixnet.getList(device_group, 'ethernet')[0])

    for i, ethernet in enumerate(ethernets):
        mac = ixnet.getAttribute(ethernet, '-mac')
        ixnet.setAttribute(mac + '/singleValue', \
            '-value', args.port_src_mac[i])

    if args.traffic_type == 'ipv4':
        ipv4s = []
        # Add ipv4 protocol stacks to device groups
        for ethernet in ethernets:
            ixnet.add(ethernet, 'ipv4')
            ixnet.commit()
            ipv4s.append(ixnet.getList(ethernet, 'ipv4')[0])

        configure_ipv4_protocol(ixnet, ipv4s, args)
    elif args.traffic_type == 'ipv6':
        ipv6s = []
        # Add ipv6 protocol stacks to device groups
        for ethernet in ethernets:
            ixnet.add(ethernet, 'ipv6')
            ixnet.commit()
            ipv6s.append(ixnet.getList(ethernet, 'ipv6')[0])

        configure_ipv6_protocol(ixnet, ipv6s, args)
    elif args.traffic_type == 'ethernetVlan':
        # TODO: fix this profile
        ipv4s = []
        # Add ipv4 protocol stacks to device groups
        for ethernet in ethernets:
            ixnet.add(ethernet, 'ipv4')
            ixnet.commit()
            ipv4s.append(ixnet.getList(ethernet, 'ipv4')[0])

        configure_ethernetVlan_protocol(ixnet, ipv4s, args)
    else:
        raise ValueError('Traffic type not supported')

    return topologies


def configure_ethernetVlan_protocol(ixnet, ipv4s, args):
    """Configure ethernet protocol.

    :param ixnet: Instance of IxNet class.
    :param ipv4s: List of ipv4 protocols.
    :param args: Args from command line.
    :type ixnet: IxNetwork
    :type ipv4s: list
    :type args: ArgumentParser
    :return: nothing
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')

    for i, ipv4 in enumerate(ipv4s):
        address = ixnet.getAttribute(ipv4, '-address')
        gatewayIp = ixnet.getAttribute(ipv4, '-gatewayIp')
        resolveGateway = ixnet.getAttribute(ipv4, '-resolveGateway')
        gatewayMac = ixnet.getAttribute(ipv4, '-manualGatewayMac')

        ixnet.setMultiAttribute(address + '/counter', \
            '-direction', 'increment', \
            '-start', args.port_src_ip[i], \
            '-step', '0.0.0.1')
        ixnet.setMultiAttribute(resolveGateway + '/singleValue', \
            '-value', 'true')

    ixnet.commit()


def configure_ipv4_protocol(ixnet, ipv4s, args):
    """Configure ipv4 protocol.

    :param ixnet: Instance of IxNet class.
    :param ipv4s: List of ipv4 protocols.
    :param args: Args from command line.
    :type ixnet: IxNetwork
    :type ipv4s: list
    :type args: ArgumentParser
    :return: nothing
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')

    for i, ipv4 in enumerate(ipv4s):
        address = ixnet.getAttribute(ipv4, '-address')
        gatewayIp = ixnet.getAttribute(ipv4, '-gatewayIp')
        resolveGateway = ixnet.getAttribute(ipv4, '-resolveGateway')
        gatewayMac = ixnet.getAttribute(ipv4, '-manualGatewayMac')

        ixnet.setMultiAttribute(address + '/counter', \
            '-direction', 'increment', \
            '-start', args.port_src_ip[i], \
            '-step', '0.0.0.1')
        ixnet.setMultiAttribute(gatewayIp + '/singleValue', \
            '-value', args.port_gw_ip[i])
        ixnet.setMultiAttribute(resolveGateway + '/singleValue', \
            '-value', 'false')
        ixnet.setMultiAttribute(gatewayMac + '/singleValue', \
            '-value', args.port_gw_mac[i])

    ixnet.commit()


def configure_ipv6_protocol(ixnet, ipv6s, args):
    """Configure ipv6 protocol.

    :param ixnet: Instance of IxNet class.
    :param ipv6s: List of ipv6 protocols.
    :param args: Args from command line.
    :type ixnet: IxNetwork
    :type ipv6s: list
    :type args: ArgumentParser
    :return: nothing
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')

    for i, ipv6 in enumerate(ipv6s):
        address = ixnet.getAttribute(ipv6, '-address')
        gatewayIp = ixnet.getAttribute(ipv6, '-gatewayIp')
        resolveGateway = ixnet.getAttribute(ipv6, '-resolveGateway')
        gatewayMac = ixnet.getAttribute(ipv6, '-manualGatewayMac')

        ixnet.setMultiAttribute(address + '/counter', \
            '-direction', 'increment', \
            '-start', args.port_src_ip[i], \
            '-step', '::1')
        ixnet.setMultiAttribute(gatewayIp + '/singleValue', \
            '-value', args.port_gw_ip[i])
        ixnet.setMultiAttribute(resolveGateway + '/singleValue', \
            '-value', 'false')
        ixnet.setMultiAttribute(gatewayMac + '/singleValue', \
            '-value', args.port_gw_mac[i])

    ixnet.commit()


def assign_physical_interfaces(ixnet, ixinterfaces):
    """Assign physical interfaces on chassis.

    :param ixnet: Instance of IxNet class.
    :param ixinterfaces: List of physical interfaces (chassis/card/port).
    :type ixnet: IxNet
    :type ixinterfaces: list
    :return: nothing
    """

    vports = ixnet.getList(ixnet.getRoot(), 'vport')
    assign_ifs = ixnet.execute('assignPorts', ixinterfaces, [],
                               ixnet.getList("/", "vport"), True)
    if assign_ifs != vports:
        raise IxDriverError("Assigning ports failed: {}".format(assign_ifs))


def apply_traffic(ixnet, traffic_items):
    """Generate, apply all traffic items.

    :param ixnet: Instance of IxNet class.
    :param traffic_items: List of traffic items.
    :type ixnet: IxNet
    :type traffic_items: list
    :return: nothing
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')
    if traffic_items is None:
        raise ValueError('No traffic items')

    for traffic_item in traffic_items:
        ixnet.execute('generate', traffic_item)

    ixnet.execute('apply', ixnet.getRoot() + '/traffic')


def start_traffic(ixnet):
    """Start traffic on all traffic items.

    :param ixnet: Instance of IxNet class.
    :type ixnet: IxNet
    :return: nothing
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')

    ixnet.execute('start', ixnet.getRoot() + '/traffic')


def stop_traffic(ixnet):
    """Stop traffic on all traffic items.

    :param ixnet: Instance of IxNet class.
    :type ixnet: IxNet
    :return: nothing
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')

    ixnet.execute('stop', ixnet.getRoot() + '/traffic')


def process_statistics(ixnet):
    """Process the statistics.

    :param ixnet: Instance of IxNet class.
    :type ixnet: IxNet
    :return: nothing
    """

    if ixnet is None:
        raise ValueError('No Ixnet instance')

    viewName = "Traffic Item Statistics"
    views = ixnet.getList('/statistics', 'view')
    viewObj = ''
    editedViewName = '::ixNet::OBJ-/statistics/view:\"' + viewName + '\"'
    for view in views:
        if editedViewName == view:
            viewObj = view
            break

    txFrames = ixnet.execute('getColumnValues', viewObj, 'Tx Frames')
    rxFrames = ixnet.execute('getColumnValues', viewObj, 'Rx Frames')
    loss = ixnet.execute('getColumnValues', viewObj, 'Loss %')
    delta = ixnet.execute('getColumnValues', viewObj, 'Frames Delta')
    SFavg = ixnet.execute('getColumnValues', viewObj,
                          'Store-Forward Avg Latency (ns)')
    SFmin = ixnet.execute('getColumnValues', viewObj,
                          'Store-Forward Min Latency (ns)')
    SFmax = ixnet.execute('getColumnValues', viewObj,
                          'Store-Forward Max Latency (ns)')

    print txFrames, rxFrames, loss, delta, SFavg, SFmin, SFmax


def print_error(msg):
    """Print error message on stderr.

    :param msg: Error message to print.
    :type msg: string
    :return: nothing
    """

    sys.stderr.write(msg+'\n')


def parse_args():
    """Parse arguments from cmd line.add_ports

    :return: Parsed arguments.
    :rtype ArgumentParser
    """

    parser = argparse.ArgumentParser()
    parser.add_argument("-i", "--ixia_server", required=True,
                        help="IxNetwork TCL server")
    parser.add_argument("-p", "--ixia_port", required=True, type=int,
                        help="IxNetwork TCL port")
    parser.add_argument("-d", "--duration", required=True, type=int,
                        help="Duration of traffic run in seconds")
    parser.add_argument("-s", "--frame_size", required=True, type=int,
                        help="Size of a Frame without padding and IPG")
    parser.add_argument("-r", "--rate", required=True,
                        help="Traffic rate with")
    parser.add_argument("-u", "--rate_units", required=True,
                        choices=['pps', 'perc', 'bps'],
                        help="Traffic rate units")
    parser.add_argument("-t", "--traffic_type", required=True,
                        choices=['ipv4', 'ipv6', 'ethernetVlan'],
                        help="Traffic type")
    parser.add_argument("--async", action="store_true",
                        default=False,
                        help="Non-blocking call of the script")
    parser.add_argument("-w", "--warmup_time", type=int,
                        default=0,
                        help="Traffic warmup time in seconds, 0 = disable")
    parser.add_argument("-x", "--pairing", choices=['full', 'half'],
                        default='full',
                        help="Pairing of ports e.g. (1,2)(3,4) or (1,3)(2,4)")

    parser.add_argument('--if_chassis', nargs='+', default=[],
                        required=True,
                        help='Add Ixia chassis to a list')
    parser.add_argument('--if_card', nargs='+', default=[],
                        required=True, type=int,
                        help='Add Ixia card to a list')
    parser.add_argument('--if_port', nargs='+', default=[],
                        required=True, type=int,
                        help='Add Ixia port to a list')
    parser.add_argument('--port_src_mac', nargs='+', default=[],
                        required=True,
                        help='Add port source mac address to a list')
    parser.add_argument('--port_src_mac_cnt', nargs='+', default=[],
                        type=int,
                        help='Add port source mac address count to a list')
    parser.add_argument('--port_src_ip', nargs='+', default=[],
                        required=True,
                        help='Add port source IP address to a list')
    parser.add_argument('--port_src_ip_cnt', nargs='+', default=[],
                        required=True, type=int,
                        help='Add port source IP address count to a list')
    parser.add_argument('--port_gw_ip', nargs='+', default=[],
                        help='Add port gateway IP address to a list')
    parser.add_argument('--port_gw_mac', nargs='+', default=[],
                        help='Add port gateway mac address to a list')

    return parser.parse_args()


def main():
    """Main function."""

    # Parse comand line arguments
    args = parse_args()

    ix_interfaces = []
    for chassis, card, port in zip(args.if_chassis,
                                   args.if_card,
                                   args.if_port):
        ix_interfaces.append((chassis, card, port))

    try:
        # Create IXIA instance
        ixnet = IxNet()

        # Debuging mode
        ixnet.setDebug(True)

        # Conntect to IxServer
        ixnet.connect(args.ixia_server, '-port', args.ixia_port, '-version',
                      '7.40')

        # Create blank configuration
        ixnet.execute('newConfig')

        # Add interfaces to config
        vports = add_ports(ixnet, len(ix_interfaces))

        # Configure protocols
        topologies = configure_protocols(ixnet, vports, args)

        # Create traffic items
        traffic_items = configure_endpoints(ixnet, topologies, args)

        # Assign physical interfaces on chassis
        assign_physical_interfaces(ixnet, ix_interfaces)

        # Generate and apply traffic
        apply_traffic(ixnet, traffic_items)

        if args.warmup_time > 0:
            # Start traffic
            start_traffic(ixnet)
            # Wait for warmup time
            time.sleep(args.warmup_time)
            # Stop traffic
            stop_traffic(ixnet)
            # Wait for incomming packets
            time.sleep(10)

        # Start traffic
        start_traffic(ixnet)

        if not args.async:
            # Wait for duration time
            time.sleep(args.duration)
            # Stop traffic
            stop_traffic(ixnet)
            # Wait for incomming packets
            time.sleep(10)

            process_statistics(ixnet)
    except Exception as ex_error:
        print_error(str(ex_error))
        sys.exit(1)

    finally:
        ixnet.disconnect()


if __name__ == "__main__":
    sys.exit(main())