nfvbench/traffic_gen/dummy.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 from traffic_base import AbstractTrafficGenerator
  16 import traffic_utils as utils
  17
  18
  19 class DummyTG(AbstractTrafficGenerator):
  20     """Experimental dummy traffic generator.
  21
  22     This traffic generator will pretend to generate traffic and return fake data.
  23     Useful for unit testing without actually generating any traffic.
  24     """
  25
  26     def __init__(self, config):
  27         AbstractTrafficGenerator.__init__(self, config)
  28         self.port_handle = []
  29         self.rates = []
  30         self.l2_frame_size = 0
  31         self.duration_sec = self.config.duration_sec
  32         self.intf_speed = config.generator_config.intf_speed
  33         self.set_response_curve()
  34
  35     def get_version(self):
  36         return "0.1"
  37
  38     def init(self):
  39         pass
  40
  41     def get_tx_pps_dropped_pps(self, tx_rate):
  42         '''Get actual tx packets based on requested tx rate
  43
  44         :param tx_rate: requested TX rate with unit ('40%', '1Mbps', '1000pps')
  45
  46         :return: the actual TX pps and the dropped pps corresponding to the requested TX rate
  47         '''
  48         dr, tx = self.__get_dr_actual_tx(tx_rate)
  49         actual_tx_bps = utils.load_to_bps(tx, self.intf_speed)
  50         avg_packet_size = utils.get_average_packet_size(self.l2_frame_size)
  51         tx_packets = utils.bps_to_pps(actual_tx_bps, avg_packet_size)
  52
  53         dropped = tx_packets * dr / 100
  54         # print '===get_tx_pkts_dropped_pkts req tex=', tx_rate, 'dr=', dr,
  55         # 'actual tx rate=', tx, 'actual tx pkts=', tx_packets, 'dropped=', dropped
  56         return int(tx_packets), int(dropped)
  57
  58     def set_response_curve(self, lr_dr=0, ndr=100, max_actual_tx=100, max_11_tx=100):
  59         '''Set traffic gen response characteristics
  60
  61         Specifies the drop rate curve and the actual TX curve
  62         :param float lr_dr: The actual drop rate at TX line rate (in %, 0..100)
  63         :param float ndr: The true NDR  (0 packet drop) in % (0..100) of line rate"
  64         :param float max_actual_tx: highest actual TX when requested TX is 100%
  65         :param float max_11_tx: highest requested TX that results in same actual TX
  66         '''
  67         self.target_ndr = ndr
  68         if ndr < 100:
  69             self.dr_slope = float(lr_dr) / (100 - ndr)
  70         else:
  71             self.dr_slope = 0
  72         self.max_11_tx = max_11_tx
  73         self.max_actual_tx = max_actual_tx
  74         if max_11_tx < 100:
  75             self.tx_slope = float(max_actual_tx - max_11_tx) / (100 - max_11_tx)
  76         else:
  77             self.tx_slope = 0
  78
  79     def __get_dr_actual_tx(self, requested_tx_rate):
  80         '''Get drop rate at given requested tx rate
  81         :param float requested_tx_rate: requested tx rate in % (0..100)
  82         :return: the drop rate and actual tx rate at that requested_tx_rate in % (0..100)
  83         '''
  84         if requested_tx_rate <= self.max_11_tx:
  85             actual_tx = requested_tx_rate
  86         else:
  87             actual_tx = self.max_11_tx + (requested_tx_rate - self.max_11_tx) * self.tx_slope
  88         if actual_tx <= self.target_ndr:
  89             dr = 0.0
  90         else:
  91             dr = (actual_tx - self.target_ndr) * self.dr_slope
  92         return dr, actual_tx
  93
  94     def connect(self):
  95         ports = list(self.config.generator_config.ports)
  96         self.port_handle = ports
  97
  98     def is_arp_successful(self):
  99         return True
 100
 101     def config_interface(self):
 102         pass
 103
 104     def create_traffic(self, l2frame_size, rates, bidirectional, latency=True):
 105         self.rates = [utils.to_rate_str(rate) for rate in rates]
 106         self.l2_frame_size = l2frame_size
 107
 108     def clear_streamblock(self):
 109         pass
 110
 111     def get_stats(self):
 112         '''Get stats from current run.
 113
 114         The binary search mainly looks at 2 results to make the decision:
 115             actual tx packets
 116             actual rx dropped packets
 117         From the Requested TX rate - we get the Actual TX rate and the RX drop rate
 118         From the Run duration and actual TX rate - we get the actual total tx packets
 119         From the Actual tx packets and RX drop rate - we get the RX dropped packets
 120         '''
 121         result = {}
 122         total_tx_pps = 0
 123
 124         # use dummy values for all other result field as the goal is to
 125         # test the ndr/pdr convergence code
 126         for idx, ph in enumerate(self.port_handle):
 127             requested_tx_rate = utils.get_load_from_rate(self.rates[idx])
 128             tx_pps, dropped_pps = self.get_tx_pps_dropped_pps(requested_tx_rate)
 129
 130             # total packets sent per direction - used by binary search
 131             total_pkts = tx_pps * self.duration_sec
 132             dropped_pkts = dropped_pps * self.duration_sec
 133             _, tx_pkt_rate = self.__get_dr_actual_tx(requested_tx_rate)
 134             result[ph] = {
 135                 'tx': {
 136                     'total_pkts': total_pkts,
 137                     'total_pkt_bytes': 100000,
 138                     'pkt_rate': tx_pkt_rate,
 139                     'pkt_bit_rate': 1000000
 140                 },
 141                 'rx': {
 142                     # total packets received
 143                     'total_pkts': total_pkts - dropped_pkts,
 144                     'total_pkt_bytes': 100000,
 145                     'pkt_rate': 100,
 146                     'pkt_bit_rate': 1000000,
 147                     'dropped_pkts': dropped_pkts
 148                 }
 149             }
 150             result[ph]['rx']['max_delay_usec'] = 10.0
 151             result[ph]['rx']['min_delay_usec'] = 1.0
 152             result[ph]['rx']['avg_delay_usec'] = 2.0
 153             total_tx_pps += tx_pps
 154         # actual total tx rate in pps
 155         result['total_tx_rate'] = total_tx_pps
 156         return result
 157
 158     def get_macs(self):
 159         return ['00.00.00.00.00.01', '00.00.00.00.00.02']
 160
 161     def clear_stats(self):
 162         pass
 163
 164     def start_traffic(self):
 165         pass
 166
 167     def stop_traffic(self):
 168         pass
 169
 170     def cleanup(self):
 171         pass
 172
 173     def set_mode(self):
 174         pass
 175
 176     def resolve_arp(self):
 177         return True