nfvbench/traffic_gen/traffic_base.py

   1 # Copyright 2016 Cisco Systems, Inc.  All rights reserved.
   2 #
   3 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   4 #    not use this file except in compliance with the License. You may obtain
   5 #    a copy of the License at
   6 #
   7 #         http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #    Unless required by applicable law or agreed to in writing, software
  10 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  11 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12 #    License for the specific language governing permissions and limitations
  13 #    under the License.
  14
  15 import abc
  16 import sys
  17
  18 from nfvbench.log import LOG
  19 from . import traffic_utils
  20
  21
  22 class Latency(object):
  23     """A class to hold latency data."""
  24
  25     def __init__(self, latency_list=None):
  26         """Create a latency instance.
  27
  28         latency_list: aggregate all latency values from list if not None
  29         """
  30         self.min_usec = sys.maxsize
  31         self.max_usec = 0
  32         self.avg_usec = 0
  33         self.hdrh = None
  34         if latency_list:
  35             for lat in latency_list:
  36                 if lat.available():
  37                     self.min_usec = min(self.min_usec, lat.min_usec)
  38                     self.max_usec = max(self.max_usec, lat.max_usec)
  39                     self.avg_usec += lat.avg_usec
  40             # round to nearest usec
  41             self.avg_usec = int(round(float(self.avg_usec) / len(latency_list)))
  42
  43     def available(self):
  44         """Return True if latency information is available."""
  45         return self.min_usec != sys.maxsize
  46
  47
  48 class TrafficGeneratorException(Exception):
  49     """Exception for traffic generator."""
  50
  51 class AbstractTrafficGenerator(object):
  52
  53     def __init__(self, traffic_client):
  54         self.traffic_client = traffic_client
  55         self.generator_config = traffic_client.generator_config
  56         self.config = traffic_client.config
  57
  58     @abc.abstractmethod
  59     def get_version(self):
  60         # Must be implemented by sub classes
  61         return None
  62
  63     @abc.abstractmethod
  64     def connect(self):
  65         # Must be implemented by sub classes
  66         return None
  67
  68     @abc.abstractmethod
  69     def create_traffic(self, l2frame_size, rates, bidirectional, latency=True, e2e=False):
  70         # Must be implemented by sub classes
  71         return None
  72
  73     def modify_rate(self, rate, reverse):
  74         """Change the rate per port.
  75
  76         rate: new rate in % (0 to 100)
  77         reverse: 0 for port 0, 1 for port 1
  78         """
  79         port_index = int(reverse)
  80         port = self.port_handle[port_index]
  81         self.rates[port_index] = traffic_utils.to_rate_str(rate)
  82         LOG.info('Modified traffic stream for port %s, new rate=%s.', port, self.rates[port_index])
  83
  84     @abc.abstractmethod
  85     def get_stats(self):
  86         # Must be implemented by sub classes
  87         return None
  88
  89     @abc.abstractmethod
  90     def start_traffic(self):
  91         # Must be implemented by sub classes
  92         return None
  93
  94     @abc.abstractmethod
  95     def stop_traffic(self):
  96         # Must be implemented by sub classes
  97         return None
  98
  99     @abc.abstractmethod
 100     def cleanup(self):
 101         """Cleanup the traffic generator."""
 102         return None
 103
 104     def clear_streamblock(self):
 105         """Clear all streams from the traffic generator."""
 106
 107     @abc.abstractmethod
 108     def resolve_arp(self):
 109         """Resolve all configured remote IP addresses.
 110
 111         return: None if ARP failed to resolve for all IP addresses
 112                 else a dict of list of dest macs indexed by port#
 113                 the dest macs in the list are indexed by the chain id
 114         """
 115
 116     @abc.abstractmethod
 117     def get_macs(self):
 118         """Return the local port MAC addresses.
 119
 120         return: a list of MAC addresses indexed by the port#
 121         """
 122
 123     @abc.abstractmethod
 124     def get_port_speed_gbps(self):
 125         """Return the local port speeds.
 126
 127         return: a list of speed in Gbps indexed by the port#
 128         """