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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
import argparse
from collections import namedtuple
import sys
import re
import os
ArgumentPack = namedtuple('ArgumentPack', ['name_or_flags', 'options'])
ArgumentGroup = namedtuple('ArgumentGroup', ['type', 'args', 'options'])
# list of available parsing options
MULTIPLIER = 1
MULTIPLIER_STRICT = 2
PORT_LIST = 3
ALL_PORTS = 4
PORT_LIST_WITH_ALL = 5
FILE_PATH = 6
FILE_FROM_DB = 7
SERVER_IP = 8
STREAM_FROM_PATH_OR_FILE = 9
DURATION = 10
FORCE = 11
DRY_RUN = 12
XTERM = 13
TOTAL = 14
FULL_OUTPUT = 15
IPG = 16
SPEEDUP = 17
COUNT = 18
GLOBAL_STATS = 50
PORT_STATS = 51
PORT_STATUS = 52
STATS_MASK = 53
STREAMS_MASK = 60
# ALL_STREAMS = 61
# STREAM_LIST_WITH_ALL = 62
# list of ArgumentGroup types
MUTEX = 1
def check_negative(value):
ivalue = int(value)
if ivalue < 0:
raise argparse.ArgumentTypeError("non positive value provided: '{0}'".format(value))
return ivalue
def match_time_unit(val):
'''match some val against time shortcut inputs '''
match = re.match("^(\d+(\.\d+)?)([m|h]?)$", val)
if match:
digit = float(match.group(1))
unit = match.group(3)
if not unit:
return digit
elif unit == 'm':
return digit*60
else:
return digit*60*60
else:
raise argparse.ArgumentTypeError("Duration should be passed in the following format: \n"
"-d 100 : in sec \n"
"-d 10m : in min \n"
"-d 1h : in hours")
match_multiplier_help = """Multiplier should be passed in the following format:
[number][<empty> | bps | kbps | mbps | gbps | pps | kpps | mpps | %% ].
no suffix will provide an absoulute factor and percentage
will provide a percentage of the line rate. examples
'-m 10', '-m 10kbps', '-m 10mpps', '-m 23%%'
'-m 23%%' : is 23%% L1 bandwidth
'-m 23mbps' : is 23mbps in L2 bandwidth (including FCS+4)
"""
# decodes multiplier
# if allow_update - no +/- is allowed
# divide states between how many entities the
# value should be divided
def decode_multiplier(val, allow_update = False, divide_count = 1):
# must be string
if not isinstance(val, str):
return None
# do we allow updates ? +/-
if not allow_update:
match = re.match("^(\d+(\.\d+)?)(bps|kbps|mbps|gbps|pps|kpps|mpps|%?)$", val)
op = None
else:
match = re.match("^(\d+(\.\d+)?)(bps|kbps|mbps|gbps|pps|kpps|mpps|%?)([\+\-])?$", val)
if match:
op = match.group(4)
else:
op = None
result = {}
if match:
value = float(match.group(1))
unit = match.group(3)
# raw type (factor)
if not unit:
result['type'] = 'raw'
result['value'] = value
elif unit == 'bps':
result['type'] = 'bps'
result['value'] = value
elif unit == 'kbps':
result['type'] = 'bps'
result['value'] = value * 1000
elif unit == 'mbps':
result['type'] = 'bps'
result['value'] = value * 1000 * 1000
elif unit == 'gbps':
result['type'] = 'bps'
result['value'] = value * 1000 * 1000 * 1000
elif unit == 'pps':
result['type'] = 'pps'
result['value'] = value
elif unit == "kpps":
result['type'] = 'pps'
result['value'] = value * 1000
elif unit == "mpps":
result['type'] = 'pps'
result['value'] = value * 1000 * 1000
elif unit == "%":
result['type'] = 'percentage'
result['value'] = value
if op == "+":
result['op'] = "add"
elif op == "-":
result['op'] = "sub"
else:
result['op'] = "abs"
if result['op'] != 'percentage':
result['value'] = result['value'] / divide_count
return result
else:
return None
def match_multiplier(val):
'''match some val against multiplier shortcut inputs '''
result = decode_multiplier(val, allow_update = True)
if not result:
raise argparse.ArgumentTypeError(match_multiplier_help)
return val
def match_multiplier_strict(val):
'''match some val against multiplier shortcut inputs '''
result = decode_multiplier(val, allow_update = False)
if not result:
raise argparse.ArgumentTypeError(match_multiplier_help)
return val
def is_valid_file(filename):
if not os.path.isfile(filename):
raise argparse.ArgumentTypeError("The file '%s' does not exist" % filename)
return filename
OPTIONS_DB = {MULTIPLIER: ArgumentPack(['-m', '--multiplier'],
{'help': match_multiplier_help,
'dest': "mult",
'default': "1",
'type': match_multiplier}),
MULTIPLIER_STRICT: ArgumentPack(['-m', '--multiplier'],
{'help': match_multiplier_help,
'dest': "mult",
'default': "1",
'type': match_multiplier_strict}),
TOTAL: ArgumentPack(['-t', '--total'],
{'help': "traffic will be divided between all ports specified",
'dest': "total",
'default': False,
'action': "store_true"}),
IPG: ArgumentPack(['-i', '--ipg'],
{'help': "IPG value in usec between packets. default will be from the pcap",
'dest': "ipg_usec",
'default': None,
'type': float}),
SPEEDUP: ArgumentPack(['-s', '--speedup'],
{'help': "Factor to accelerate the injection. effectively means IPG = IPG / SPEEDUP",
'dest': "speedup",
'default': 1.0,
'type': float}),
COUNT: ArgumentPack(['-n', '--count'],
{'help': "How many times to perform action [default is 1, 0 means forever]",
'dest': "count",
'default': 1,
'type': int}),
PORT_LIST: ArgumentPack(['--port'],
{"nargs": '+',
'dest':'ports',
'metavar': 'PORTS',
'type': int,
'help': "A list of ports on which to apply the command",
'default': []}),
ALL_PORTS: ArgumentPack(['-a'],
{"action": "store_true",
"dest": "all_ports",
'help': "Set this flag to apply the command on all available ports",
'default': False},),
DURATION: ArgumentPack(['-d'],
{'action': "store",
'metavar': 'TIME',
'dest': 'duration',
'type': match_time_unit,
'default': -1.0,
'help': "Set duration time for job."}),
FORCE: ArgumentPack(['--force'],
{"action": "store_true",
'default': False,
'help': "Set if you want to stop active ports before appyling command."}),
FILE_PATH: ArgumentPack(['-f'],
{'metavar': 'FILE',
'dest': 'file',
'nargs': 1,
'required': True,
'type': is_valid_file,
'help': "File path to load"}),
FILE_FROM_DB: ArgumentPack(['--db'],
{'metavar': 'LOADED_STREAM_PACK',
'help': "A stream pack which already loaded into console cache."}),
SERVER_IP: ArgumentPack(['--server'],
{'metavar': 'SERVER',
'help': "server IP"}),
DRY_RUN: ArgumentPack(['-n', '--dry'],
{'action': 'store_true',
'dest': 'dry',
'default': False,
'help': "Dry run - no traffic will be injected"}),
XTERM: ArgumentPack(['-x', '--xterm'],
{'action': 'store_true',
'dest': 'xterm',
'default': False,
'help': "Starts TUI in xterm window"}),
FULL_OUTPUT: ArgumentPack(['--full'],
{'action': 'store_true',
'help': "Prompt full info in a JSON format"}),
GLOBAL_STATS: ArgumentPack(['-g'],
{'action': 'store_true',
'help': "Fetch only global statistics"}),
PORT_STATS: ArgumentPack(['-p'],
{'action': 'store_true',
'help': "Fetch only port statistics"}),
PORT_STATUS: ArgumentPack(['--ps'],
{'action': 'store_true',
'help': "Fetch only port status data"}),
STREAMS_MASK: ArgumentPack(['--streams'],
{"nargs": '+',
'dest':'streams',
'metavar': 'STREAMS',
'type': int,
'help': "A list of stream IDs to query about. Default: analyze all streams",
'default': []}),
# advanced options
PORT_LIST_WITH_ALL: ArgumentGroup(MUTEX, [PORT_LIST,
ALL_PORTS],
{'required': False}),
STREAM_FROM_PATH_OR_FILE: ArgumentGroup(MUTEX, [FILE_PATH,
FILE_FROM_DB],
{'required': True}),
STATS_MASK: ArgumentGroup(MUTEX, [GLOBAL_STATS,
PORT_STATS,
PORT_STATUS],
{})
}
class CCmdArgParser(argparse.ArgumentParser):
def __init__(self, stateless_client, *args, **kwargs):
super(CCmdArgParser, self).__init__(*args, **kwargs)
self.stateless_client = stateless_client
def parse_args(self, args=None, namespace=None):
try:
opts = super(CCmdArgParser, self).parse_args(args, namespace)
if opts is None:
return None
# if all ports are marked or
if (getattr(opts, "all_ports", None) == True) or (getattr(opts, "ports", None) == []):
opts.ports = self.stateless_client.get_all_ports()
# so maybe we have ports configured
elif getattr(opts, "ports", None):
for port in opts.ports:
if not self.stateless_client._validate_port_list([port]):
self.error("port id '{0}' is not a valid port id\n".format(port))
return opts
except SystemExit:
# recover from system exit scenarios, such as "help", or bad arguments.
return None
def get_flags (opt):
return OPTIONS_DB[opt].name_or_flags
def gen_parser(stateless_client, op_name, description, *args):
parser = CCmdArgParser(stateless_client, prog=op_name, conflict_handler='resolve',
description=description)
for param in args:
try:
if isinstance(param, int):
argument = OPTIONS_DB[param]
else:
argument = param
if isinstance(argument, ArgumentGroup):
if argument.type == MUTEX:
# handle as mutually exclusive group
group = parser.add_mutually_exclusive_group(**argument.options)
for sub_argument in argument.args:
group.add_argument(*OPTIONS_DB[sub_argument].name_or_flags,
**OPTIONS_DB[sub_argument].options)
else:
# ignore invalid objects
continue
elif isinstance(argument, ArgumentPack):
parser.add_argument(*argument.name_or_flags,
**argument.options)
else:
# ignore invalid objects
continue
except KeyError as e:
cause = e.args[0]
raise KeyError("The attribute '{0}' is missing as a field of the {1} option.\n".format(cause, param))
return parser
if __name__ == "__main__":
pass
|
