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 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.maxint
  31         self.max_usec = 0
  32         self.avg_usec = 0
  33         if latency_list:
  34             for lat in latency_list:
  35                 if lat.available():
  36                     self.min_usec = min(self.min_usec, lat.min_usec)
  37                     self.max_usec = max(self.max_usec, lat.max_usec)
  38                     self.avg_usec += lat.avg_usec
  39             # round to nearest usec
  40             self.avg_usec = int(round(float(self.avg_usec) / len(latency_list)))
  41
  42     def available(self):
  43         """Return True if latency information is available."""
  44         return self.min_usec != sys.maxint
  45
  46
  47 class TrafficGeneratorException(Exception):
  48     """Exception for traffic generator."""
  49
  50     pass
  51
  52
  53 class AbstractTrafficGenerator(object):
  54
  55     def __init__(self, traffic_client):
  56         self.traffic_client = traffic_client
  57         self.generator_config = traffic_client.generator_config
  58         self.config = traffic_client.config
  59
  60     @abc.abstractmethod
  61     def get_version(self):
  62         # Must be implemented by sub classes
  63         return None
  64
  65     @abc.abstractmethod
  66     def connect(self):
  67         # Must be implemented by sub classes
  68         return None
  69
  70     @abc.abstractmethod
  71     def create_traffic(self, l2frame_size, rates, bidirectional, latency=True, e2e=False):
  72         # Must be implemented by sub classes
  73         return None
  74
  75     def modify_rate(self, rate, reverse):
  76         """Change the rate per port.
  77
  78         rate: new rate in % (0 to 100)
  79         reverse: 0 for port 0, 1 for port 1
  80         """
  81         port_index = int(reverse)
  82         port = self.port_handle[port_index]
  83         self.rates[port_index] = traffic_utils.to_rate_str(rate)
  84         LOG.info('Modified traffic stream for port %s, new rate=%s.', port, self.rates[port_index])
  85
  86     @abc.abstractmethod
  87     def get_stats(self):
  88         # Must be implemented by sub classes
  89         return None
  90
  91     @abc.abstractmethod
  92     def start_traffic(self):
  93         # Must be implemented by sub classes
  94         return None
  95
  96     @abc.abstractmethod
  97     def stop_traffic(self):
  98         # Must be implemented by sub classes
  99         return None
 100
 101     @abc.abstractmethod
 102     def cleanup(self):
 103         """Cleanup the traffic generator."""
 104         return None
 105
 106     def clear_streamblock(self):
 107         """Clear all streams from the traffic generator."""
 108         pass
 109
 110     @abc.abstractmethod
 111     def resolve_arp(self):
 112         """Resolve all configured remote IP addresses.
 113
 114         return: None if ARP failed to resolve for all IP addresses
 115                 else a dict of list of dest macs indexed by port#
 116                 the dest macs in the list are indexed by the chain id
 117         """
 118         pass
 119
 120     @abc.abstractmethod
 121     def get_macs(self):
 122         """Return the local port MAC addresses.
 123
 124         return: a list of MAC addresses indexed by the port#
 125         """
 126         pass
 127
 128     @abc.abstractmethod
 129     def get_port_speed_gbps(self):
 130         """Return the local port speeds.
 131
 132         return: a list of speed in Gbps indexed by the port#
 133         """
 134         pass