1 # Copyright (c) 2016-2017 Intel Corporation
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
18 from random import SystemRandom
23 from yardstick.common import exceptions as y_exc
24 from yardstick.network_services.traffic_profile.base import TrafficProfile
25 from trex_stl_lib.trex_stl_client import STLStream
26 from trex_stl_lib.trex_stl_streams import STLFlowLatencyStats
27 from trex_stl_lib.trex_stl_streams import STLTXCont
28 from trex_stl_lib.trex_stl_streams import STLProfile
29 from trex_stl_lib.trex_stl_packet_builder_scapy import STLVmWrFlowVar
30 from trex_stl_lib.trex_stl_packet_builder_scapy import STLVmFlowVarRepeatableRandom
31 from trex_stl_lib.trex_stl_packet_builder_scapy import STLVmFlowVar
32 from trex_stl_lib.trex_stl_packet_builder_scapy import STLPktBuilder
33 from trex_stl_lib.trex_stl_packet_builder_scapy import STLScVmRaw
34 from trex_stl_lib.trex_stl_packet_builder_scapy import STLVmFixIpv4
35 from trex_stl_lib import api as Pkt
46 TYPE_OF_SERVICE = 'tos'
48 LOG = logging.getLogger(__name__)
51 class TrexProfile(TrafficProfile):
52 """ This class handles Trex Traffic profile generation and execution """
55 ETHERNET: ('ether_packet', Pkt.Ether),
56 IP: ('ip_packet', Pkt.IP),
57 IPv6: ('ip6_packet', Pkt.IPv6),
58 UDP: ('udp_packet', Pkt.UDP),
61 def _general_single_action_partial(self, protocol):
67 self._set_proto_fields(protocol, **kwargs)
71 def _ethernet_range_action_partial(self, direction, _):
72 def partial(min_value, max_value, count):
73 # pylint: disable=unused-argument
74 stl_vm_flow_var = STLVmFlowVar(name="mac_{}".format(direction),
80 self.vm_flow_vars.append(stl_vm_flow_var)
81 stl_vm_wr_flow_var = STLVmWrFlowVar(
82 fv_name='mac_{}'.format(direction),
83 pkt_offset='Ether.{}'.format(direction))
84 self.vm_flow_vars.append(stl_vm_wr_flow_var)
87 def _ip_range_action_partial(self, direction, count=1):
88 # pylint: disable=unused-argument
89 def partial(min_value, max_value, count):
90 _, _, actual_count = self._count_ip(min_value, max_value)
93 elif actual_count < int(count):
96 stl_vm_flow_var = STLVmFlowVarRepeatableRandom(
97 name="ip4_{}".format(direction),
103 self.vm_flow_vars.append(stl_vm_flow_var)
104 stl_vm_wr_flow_var = STLVmWrFlowVar(
105 fv_name='ip4_{}'.format(direction),
106 pkt_offset='IP.{}'.format(direction))
107 self.vm_flow_vars.append(stl_vm_wr_flow_var)
108 stl_vm_fix_ipv4 = STLVmFixIpv4(offset="IP")
109 self.vm_flow_vars.append(stl_vm_fix_ipv4)
112 def _ip6_range_action_partial(self, direction, _):
113 def partial(min_value, max_value, count):
114 # pylint: disable=unused-argument
115 min_value, max_value, _ = self._count_ip(min_value, max_value)
116 stl_vm_flow_var = STLVmFlowVar(name="ip6_{}".format(direction),
122 self.vm_flow_vars.append(stl_vm_flow_var)
123 stl_vm_wr_flow_var = STLVmWrFlowVar(
124 fv_name='ip6_{}'.format(direction),
125 pkt_offset='IPv6.{}'.format(direction),
127 self.vm_flow_vars.append(stl_vm_wr_flow_var)
130 def _dscp_range_action_partial(self, *_):
131 def partial(min_value, max_value, count):
132 # pylint: disable=unused-argument
133 stl_vm_flow_var = STLVmFlowVar(name="dscp",
139 self.vm_flow_vars.append(stl_vm_flow_var)
140 stl_vm_wr_flow_var = STLVmWrFlowVar(fv_name='dscp',
142 self.vm_flow_vars.append(stl_vm_wr_flow_var)
145 def _udp_range_action_partial(self, field, count=1):
146 # pylint: disable=unused-argument
147 def partial(min_value, max_value, count):
148 actual_count = int(max_value) - int(min_value)
151 elif int(count) > actual_count:
154 stl_vm_flow_var = STLVmFlowVarRepeatableRandom(
155 name="port_{}".format(field),
161 self.vm_flow_vars.append(stl_vm_flow_var)
162 stl_vm_wr_flow_var = STLVmWrFlowVar(
163 fv_name='port_{}'.format(field),
164 pkt_offset=self.udp[field])
165 self.vm_flow_vars.append(stl_vm_wr_flow_var)
168 def __init__(self, yaml_data):
169 super(TrexProfile, self).__init__(yaml_data)
173 self.first_run = True
175 self.profile_data = []
182 self.ether_packet = None
183 self.ip_packet = None
184 self.ip6_packet = None
185 self.udp_packet = None
190 self.qinq_packet = None
192 self.vm_flow_vars = []
195 self._map_proto_actions = {
196 # the tuple is (single value function, range value function, if the values should be
197 # converted to integer).
198 ETHERNET: (self._general_single_action_partial(ETHERNET),
199 self._ethernet_range_action_partial,
202 IP: (self._general_single_action_partial(IP),
203 self._ip_range_action_partial,
206 IPv6: (self._general_single_action_partial(IPv6),
207 self._ip6_range_action_partial,
210 DSCP: (self._general_single_action_partial(IP),
211 self._dscp_range_action_partial,
214 UDP: (self._general_single_action_partial(UDP),
215 self._udp_range_action_partial,
220 def execute_traffic(self, traffic_generator):
221 """ Generate the stream and run traffic on the given ports """
222 raise NotImplementedError()
224 def _call_on_range(self, range, single_action, range_action, count=1, to_int=False):
225 def convert_to_int(val):
226 return int(val) if to_int else val
228 range_iter = iter(str(range).split('-'))
229 min_value = convert_to_int(next(range_iter))
231 max_value = convert_to_int(next(range_iter))
232 except StopIteration:
233 single_action(min_value)
235 range_action(min_value=min_value, max_value=max_value, count=count)
237 def _set_proto_addr(self, protocol, field, address, count=1):
238 single_action, range_action, to_int = self._map_proto_actions[protocol]
239 self._call_on_range(address,
240 single_action(field),
241 range_action(field, count),
246 def _set_proto_fields(self, protocol, **kwargs):
247 _attr_name, _class = self.PROTO_MAP[protocol]
249 if not getattr(self, _attr_name):
250 setattr(self, _attr_name, _class())
252 _attr = getattr(self, _attr_name)
253 for key, value in six.iteritems(kwargs):
254 setattr(_attr, key, value)
256 def set_svlan_cvlan(self, svlan, cvlan):
257 """ set svlan & cvlan """
259 ether_params = {'type': 0x8100}
260 self._set_proto_fields(ETHERNET, **ether_params)
261 svlans = str(svlan['id']).split('-')
262 svlan_min = int(svlans[0])
263 svlan_max = int(svlans[1]) if len(svlans) == 2 else int(svlans[0])
265 svlan = self._get_random_value(svlan_min, svlan_max)
268 cvlans = str(cvlan['id']).split('-')
269 cvlan_min = int(cvlans[0])
270 cvlan_max = int(cvlans[1]) if len(cvlans) == 2 else int(cvlans[0])
272 cvlan = self._get_random_value(cvlan_min, cvlan_max)
275 self.qinq_packet = Pkt.Dot1Q(vlan=svlan) / Pkt.Dot1Q(vlan=cvlan)
277 def set_qinq(self, qinq):
278 """ set qinq in packet """
279 self.set_svlan_cvlan(qinq['S-VLAN'], qinq['C-VLAN'])
281 def _set_outer_l2_fields(self, outer_l2):
282 """ setup outer l2 fields from traffic profile """
283 ether_params = {'type': 0x800}
284 self._set_proto_fields(ETHERNET, **ether_params)
285 if 'srcmac' in outer_l2:
286 self._set_proto_addr(ETHERNET, SRC, outer_l2['srcmac'])
287 if 'dstmac' in outer_l2:
288 self._set_proto_addr(ETHERNET, DST, outer_l2['dstmac'])
289 if 'QinQ' in outer_l2:
290 self.set_qinq(outer_l2['QinQ'])
292 def _set_outer_l3v4_fields(self, outer_l3v4):
293 """ setup outer l3v4 fields from traffic profile """
295 if 'proto' in outer_l3v4:
296 ip_params['proto'] = socket.getprotobyname(outer_l3v4['proto'])
297 if outer_l3v4['proto'] == 'tcp':
298 self.udp_packet = Pkt.TCP()
299 self.udp[DST_PORT] = 'TCP.dport'
300 self.udp[SRC_PORT] = 'TCP.sport'
301 tcp_params = {'flags': '', 'window': 0}
302 self._set_proto_fields(UDP, **tcp_params)
303 if 'ttl' in outer_l3v4:
304 ip_params['ttl'] = outer_l3v4['ttl']
305 self._set_proto_fields(IP, **ip_params)
306 if 'dscp' in outer_l3v4:
307 self._set_proto_addr(DSCP, TYPE_OF_SERVICE, outer_l3v4['dscp'])
308 if 'srcip4' in outer_l3v4:
309 self._set_proto_addr(IP, SRC, outer_l3v4['srcip4'], outer_l3v4['count'])
310 if 'dstip4' in outer_l3v4:
311 self._set_proto_addr(IP, DST, outer_l3v4['dstip4'], outer_l3v4['count'])
313 def _set_outer_l3v6_fields(self, outer_l3v6):
314 """ setup outer l3v6 fields from traffic profile """
315 ether_params = {'type': 0x86dd}
316 self._set_proto_fields(ETHERNET, **ether_params)
318 if 'proto' in outer_l3v6:
319 ip6_params['proto'] = outer_l3v6['proto']
320 if outer_l3v6['proto'] == 'tcp':
321 self.udp_packet = Pkt.TCP()
322 self.udp[DST_PORT] = 'TCP.dport'
323 self.udp[SRC_PORT] = 'TCP.sport'
324 tcp_params = {'flags': '', 'window': 0}
325 self._set_proto_fields(UDP, **tcp_params)
326 if 'ttl' in outer_l3v6:
327 ip6_params['ttl'] = outer_l3v6['ttl']
328 if 'tc' in outer_l3v6:
329 ip6_params['tc'] = outer_l3v6['tc']
330 if 'hlim' in outer_l3v6:
331 ip6_params['hlim'] = outer_l3v6['hlim']
332 self._set_proto_fields(IPv6, **ip6_params)
333 if 'srcip6' in outer_l3v6:
334 self._set_proto_addr(IPv6, SRC, outer_l3v6['srcip6'])
335 if 'dstip6' in outer_l3v6:
336 self._set_proto_addr(IPv6, DST, outer_l3v6['dstip6'])
338 def _set_outer_l4_fields(self, outer_l4):
339 """ setup outer l4 fields from traffic profile """
340 if 'srcport' in outer_l4:
341 self._set_proto_addr(UDP, SRC_PORT, outer_l4['srcport'], outer_l4['count'])
342 if 'dstport' in outer_l4:
343 self._set_proto_addr(UDP, DST_PORT, outer_l4['dstport'], outer_l4['count'])
345 def generate_imix_data(self, packet_definition):
346 """ generate packet size for a given traffic profile """
349 if not packet_definition:
351 imix = packet_definition.get('framesize')
355 imix_data[int(size[:-1])] = int(data)
356 imix_sum = sum(imix_data.values())
358 raise SystemExit("Error in IMIX data")
360 imix_data[64] = imix_data.get(64, 0) + (100 - imix_sum)
363 for size in imix_data:
364 count = int(imix_data[size])
366 avg_size += round(size * count / 100, 2)
367 pps = round(self.pps * count / 100, 0)
368 imix_count[size] = pps
369 self.rate = round(1342177280 / avg_size, 0) * 2
370 logging.debug("Imax: %s rate: %s", imix_count, self.rate)
373 def get_streams(self, profile_data):
374 """ generate trex stream
379 self.pps = self.params['traffic_profile'].get('frame_rate', 100)
380 for packet_name in profile_data:
381 outer_l2 = profile_data[packet_name].get('outer_l2')
382 imix_data = self.generate_imix_data(outer_l2)
384 imix_data = {64: self.pps}
385 self.generate_vm(profile_data[packet_name])
386 for size in imix_data:
387 self._generate_streams(size, imix_data[size])
388 self._generate_profile()
391 def generate_vm(self, packet_definition):
392 """ generate trex vm with flows setup """
393 self.ether_packet = Pkt.Ether()
394 self.ip_packet = Pkt.IP()
395 self.ip6_packet = None
396 self.udp_packet = Pkt.UDP()
397 self.udp[DST_PORT] = 'UDP.dport'
398 self.udp[SRC_PORT] = 'UDP.sport'
400 self.vm_flow_vars = []
401 outer_l2 = packet_definition.get('outer_l2', None)
402 outer_l3v4 = packet_definition.get('outer_l3v4', None)
403 outer_l3v6 = packet_definition.get('outer_l3v6', None)
404 outer_l4 = packet_definition.get('outer_l4', None)
406 self._set_outer_l2_fields(outer_l2)
408 self._set_outer_l3v4_fields(outer_l3v4)
410 self._set_outer_l3v6_fields(outer_l3v6)
412 self._set_outer_l4_fields(outer_l4)
413 self.trex_vm = STLScVmRaw(self.vm_flow_vars)
415 def generate_packets(self):
416 """ generate packets from trex TG """
417 base_pkt = self.base_pkt
418 size = self.fsize - 4
419 pad = max(0, size - len(base_pkt)) * 'x'
420 self.packets = [STLPktBuilder(pkt=base_pkt / pad,
421 vm=vm) for vm in self.vms]
423 def _create_single_packet(self, size=64):
425 ether_packet = self.ether_packet
426 ip_packet = self.ip6_packet if self.ip6_packet else self.ip_packet
427 udp_packet = self.udp_packet
429 qinq_packet = self.qinq_packet
430 base_pkt = ether_packet / qinq_packet / ip_packet / udp_packet
432 base_pkt = ether_packet / ip_packet / udp_packet
433 pad = max(0, size - len(base_pkt)) * 'x'
434 packet = STLPktBuilder(pkt=base_pkt / pad, vm=self.trex_vm)
437 def _create_single_stream(self, packet_size, pps, isg=0):
438 packet = self._create_single_packet(packet_size)
441 stl_flow = STLFlowLatencyStats(pg_id=self.pg_id)
442 stream = STLStream(isg=isg, packet=packet, mode=STLTXCont(pps=pps),
445 stream = STLStream(isg=isg, packet=packet, mode=STLTXCont(pps=pps))
448 def _generate_streams(self, packet_size, pps):
449 self.streams.append(self._create_single_stream(packet_size, pps))
451 def _generate_profile(self):
452 self.profile = STLProfile(self.streams)
455 def _count_ip(cls, start_ip, end_ip):
456 start = ipaddress.ip_address(six.u(start_ip))
457 end = ipaddress.ip_address(six.u(end_ip))
458 if start.version == 4:
459 return start, end, int(end) - int(start)
460 elif start.version == 6:
461 if int(start) > int(end):
462 raise y_exc.IPv6RangeError(start_ip=str(start),
464 _, lo1 = struct.unpack('!QQ', start.packed)
465 _, lo2 = struct.unpack('!QQ', end.packed)
466 return lo1, lo2, lo2 - lo1
469 def _get_random_value(cls, min_port, max_port):
470 cryptogen = SystemRandom()
471 return cryptogen.randrange(min_port, max_port)