1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
#!/router/bin/python
import external_packages
from client_utils.packet_builder import CTRexPktBuilder
from collections import OrderedDict, namedtuple
from client_utils.yaml_utils import *
import dpkt
import struct
import copy
import os
StreamPack = namedtuple('StreamPack', ['stream_id', 'stream'])
class CStreamList(object):
def __init__(self):
self.streams_list = OrderedDict()
self.yaml_loader = CTRexYAMLLoader(os.path.join(os.path.dirname(os.path.realpath(__file__)),
"rpc_defaults.yaml"))
def generate_numbered_name (self, name):
prefix = name.rstrip('01234567890')
suffix = name[len(prefix):]
if suffix == "":
n = "_1"
else:
n = int(suffix) + 1
return prefix + str(n)
def append_stream(self, name, stream_obj):
assert isinstance(stream_obj, CStream)
# if name exists simply add numbered suffix to it
while name in self.streams_list:
name = self.generate_numbered_name(name)
self.streams_list[name]=stream_obj
return name
def remove_stream(self, name):
popped = self.streams_list.pop(name)
if popped:
for stream_name, stream in self.streams_list.items():
if stream.next_stream_id == name:
stream.next_stream_id = -1
try:
rx_stats_stream = getattr(stream.rx_stats, "stream_id")
if rx_stats_stream == name:
# if a referenced stream of rx_stats object deleted, revert to rx stats of current stream
setattr(stream.rx_stats, "stream_id", stream_name)
except AttributeError as e:
continue #
return popped
def export_to_yaml(self, file_path):
raise NotImplementedError("export_to_yaml method is not implemented, yet")
def load_yaml(self, file_path, multiplier=1):
# clear all existing streams linked to this object
self.streams_list.clear()
streams_data = load_yaml_to_obj(file_path)
assert isinstance(streams_data, list)
new_streams_data = []
for stream in streams_data:
stream_name = stream.get("name")
raw_stream = stream.get("stream")
if not stream_name or not raw_stream:
raise ValueError("Provided stream is not according to convention."
"Each stream must be provided as two keys: 'name' and 'stream'. "
"Provided item was:\n {stream}".format(stream))
new_stream_data = self.yaml_loader.validate_yaml(raw_stream,
"stream",
multiplier= multiplier)
new_streams_data.append(new_stream_data)
new_stream_obj = CStream()
new_stream_obj.load_data(**new_stream_data)
self.append_stream(stream_name, new_stream_obj)
return new_streams_data
def compile_streams(self):
# first, assign an id to each stream
stream_ids = {}
for idx, stream_name in enumerate(self.streams_list):
stream_ids[stream_name] = idx
# next, iterate over the streams and transform them from working with names to ids.
# with that build a new dict with old stream_name as the key, and StreamPack as the stored value
compiled_streams = {}
for stream_name, stream in self.streams_list.items():
tmp_stream = CStreamList._compile_single_stream(stream_name, stream, stream_ids)
compiled_streams[stream_name] = StreamPack(stream_ids.get(stream_name),
tmp_stream)
return compiled_streams
@staticmethod
def _compile_single_stream(stream_name, stream, id_dict):
# copy the old stream to temporary one, no change to class attributes
tmp_stream = copy.copy(stream)
next_stream_id = id_dict.get(getattr(tmp_stream, "next_stream_id"), -1)
try:
rx_stats_stream_id = id_dict.get(getattr(tmp_stream.rx_stats, "stream_id"),
id_dict.get(stream_name))
except AttributeError as e:
rx_stats_stream_id = id_dict.get(stream_name)
# assign resolved values to stream object
tmp_stream.next_stream_id = next_stream_id
tmp_stream.rx_stats.stream_id = rx_stats_stream_id
return tmp_stream
class CRxStats(object):
FIELDS = ["seq_enabled", "latency_enabled", "stream_id"]
def __init__(self, enabled=False, **kwargs):
self.enabled = bool(enabled)
for field in CRxStats.FIELDS:
setattr(self, field, kwargs.get(field, False))
def dump(self):
if self.enabled:
dump = {"enabled": True}
dump.update({k: getattr(self, k)
for k in CRxStats.FIELDS}
)
return dump
else:
return {"enabled": False}
class CTxMode(object):
"""docstring for CTxMode"""
GENERAL_FIELDS = ["type", "pps"]
FIELDS = {"continuous": [],
"single_burst": ["total_pkts"],
"multi_burst": ["pkts_per_burst", "ibg", "count"]}
def __init__(self, type, pps=0, **kwargs):
self._MODES = CTxMode.FIELDS.keys()
self.type = type
self.pps = pps
for field in CTxMode.FIELDS.get(self.type):
setattr(self, field, kwargs.get(field, 0))
@property
def type(self):
return self._type
@type.setter
def type(self, type):
if type not in self._MODES:
raise ValueError("Unknown TX mode ('{0}')has been initialized.".format(type))
self._type = type
self._reset_fields()
def dump(self):
dump = ({k: getattr(self, k)
for k in CTxMode.GENERAL_FIELDS
})
dump.update({k: getattr(self, k)
for k in CTxMode.FIELDS.get(self.type)
})
return dump
def _reset_fields(self):
for field in CTxMode.FIELDS.get(self.type):
setattr(self, field, 0)
class CStream(object):
"""docstring for CStream"""
FIELDS = ["enabled", "self_start", "next_stream_id", "isg", "mode", "rx_stats", "packet", "vm"]
def __init__(self):
self.is_loaded = False
self._is_compiled = False
for field in CStream.FIELDS:
setattr(self, field, None)
def load_data(self, **kwargs):
try:
for k in CStream.FIELDS:
if k == "rx_stats":
rx_stats_data = kwargs[k]
if isinstance(rx_stats_data, dict):
setattr(self, k, CRxStats(**rx_stats_data))
elif isinstance(rx_stats_data, CRxStats):
setattr(self, k, rx_stats_data)
elif k == "mode":
tx_mode = kwargs[k]
if isinstance(tx_mode, dict):
setattr(self, k, CTxMode(**tx_mode))
elif isinstance(tx_mode, CTxMode):
setattr(self, k, tx_mode)
elif k == "packet":
if isinstance(kwargs[k], CTRexPktBuilder):
if "vm" not in kwargs:
self.load_packet_obj(kwargs[k])
break # vm field check is skipped
else:
raise ValueError("When providing packet object with a CTRexPktBuilder, vm parameter "
"should not be supplied")
else:
binary = kwargs[k]["binary"]
if isinstance(binary, list):
setattr(self, k, kwargs[k])
elif isinstance(binary, str) and binary.endswith(".pcap"):
self.load_packet_from_pcap(binary, kwargs[k]["meta"])
else:
raise ValueError("Packet binary attribute has been loaded with unsupported value."
"Supported values are reference to pcap file with SINGLE packet, "
"or a list of unsigned-byte integers")
else:
setattr(self, k, kwargs[k])
self.is_loaded = True
except KeyError as e:
cause = e.args[0]
raise KeyError("The attribute '{0}' is missing as a field of the CStream object.\n"
"Loaded data must contain all of the following fields: {1}".format(cause, CStream.FIELDS))
def load_packet_obj(self, packet_obj):
assert isinstance(packet_obj, CTRexPktBuilder)
self.packet = packet_obj.dump_pkt()
self.vm = packet_obj.get_vm_data()
def load_packet_from_pcap(self, pcap_path, metadata=''):
with open(pcap_path, 'r') as f:
pcap = dpkt.pcap.Reader(f)
first_packet = True
for _, buf in pcap:
# this is an iterator, can't evaluate the number of files in advance
if first_packet:
self.packet = {"binary": [struct.unpack('B', buf[i:i+1])[0] # represent data as list of 0-255 ints
for i in range(0, len(buf))],
"meta": metadata} # meta data continues without a change.
first_packet = False
else:
raise ValueError("Provided pcap file contains more than single packet.")
# arrive here ONLY if pcap contained SINGLE packet
return
def dump(self):
if self.is_loaded:
dump = {}
for key in CStream.FIELDS:
try:
dump[key] = getattr(self, key).dump() # use dump() method of compound object, such TxMode
except AttributeError:
dump[key] = getattr(self, key)
return dump
else:
raise RuntimeError("CStream object isn't loaded with data. Use 'load_data' method.")
if __name__ == "__main__":
pass
|