Merge "docs: Update E release notes"
[vswitchperf.git] / core / traffic_controller_rfc2889.py
1 # Copyright 2016-2017 Spirent Communications, Intel Corporation.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain 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,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 """RFC2889 Traffic Controller implementation.
15 """
16 from core.traffic_controller import TrafficController
17 from core.results.results import IResults
18 from conf import settings
19
20
21 class TrafficControllerRFC2889(TrafficController, IResults):
22     """Traffic controller for RFC2889 traffic
23
24     Used to setup and control a traffic generator for an RFC2889 deployment
25     traffic scenario.
26     """
27
28     def __init__(self, traffic_gen_class):
29         """Initialise the trafficgen and store.
30
31         :param traffic_gen_class: The traffic generator class to be used.
32         """
33         super(TrafficControllerRFC2889, self).__init__(traffic_gen_class)
34         self._type = 'rfc2889'
35         self._trials = int(settings.getValue('TRAFFICGEN_RFC2889_TRIALS'))
36
37     def send_traffic(self, traffic):
38         """See TrafficController for description
39         """
40         if not self.traffic_required():
41             return
42         self._logger.debug('send_traffic with ' +
43                            str(self._traffic_gen_class))
44
45         # update type with detailed traffic value
46         self._type = traffic['traffic_type']
47
48         for packet_size in self._packet_sizes:
49             # Merge framesize with the default traffic definition
50             if 'l2' in traffic:
51                 traffic['l2'] = dict(traffic['l2'],
52                                      **{'framesize': packet_size})
53             else:
54                 traffic['l2'] = {'framesize': packet_size}
55
56             if traffic['traffic_type'] == 'rfc2889_caching':
57                 result = self._traffic_gen_class.send_rfc2889_caching(
58                     traffic, tests=self._trials, duration=self._duration)
59             elif traffic['traffic_type'] == 'rfc2889_learning':
60                 result = self._traffic_gen_class.send_rfc2889_learning(
61                     traffic, tests=self._trials, duration=self._duration)
62             elif traffic['traffic_type'] == 'rfc2889_forwarding':
63                 result = self._traffic_gen_class.send_rfc2889_forwarding(
64                     traffic, tests=self._trials, duration=self._duration)
65
66             result = self._append_results(result, packet_size)
67             self._results.append(result)
68
69     def send_traffic_async(self, traffic, function):
70         """See TrafficController for description
71         """
72         if not self.traffic_required():
73             return
74         self._logger.debug('send_traffic_async with ' +
75                            str(self._traffic_gen_class))
76
77         # update type with detailed traffic value
78         self._type = traffic['traffic_type']
79
80         for packet_size in self._packet_sizes:
81             traffic['l2'] = {'framesize': packet_size}
82             self._traffic_gen_class.start_rfc2889_forwarding(
83                 traffic,
84                 trials=self._trials,
85                 duration=self._duration)
86             self._traffic_started = True
87             if len(function['args']) > 0:
88                 function['function'](function['args'])
89             else:
90                 function['function']()
91             result = self._traffic_gen_class.wait_rfc2889_forwarding(
92                 traffic, trials=self._trials, duration=self._duration)
93             result = self._append_results(result, packet_size)
94             self._results.append(result)