3 from random import randrange
15 __author__ = "Jan Medved"
16 __copyright__ = "Copyright(c) 2014, Cisco Systems, Inc."
17 __license__ = "New-style BSD"
18 __email__ = "jmedved@cisco.com"
21 class Counter(object):
22 def __init__(self, start=0):
23 self.lock = threading.Lock()
26 def increment(self, value=1):
37 def __init__(self, verbose=False):
38 self.verbose = verbose
41 self.start = time.time()
44 def __exit__(self, *args):
45 self.end = time.time()
46 self.secs = self.end - self.start
47 self.msecs = self.secs * 1000 # millisecs
49 print("elapsed time: %f ms" % self.msecs)
52 class FlowConfigBlaster(object):
53 putheaders = {'content-type': 'application/json'}
54 getheaders = {'Accept': 'application/json'}
56 FLWURL = "restconf/config/opendaylight-inventory:nodes/node/openflow:%d/table/0/flow/%d"
57 TBLURL = "restconf/config/opendaylight-inventory:nodes/node/openflow:%d/table/0"
58 INVURL = 'restconf/operational/opendaylight-inventory:nodes'
63 # The "built-in" flow template
64 flow_mode_template = {
67 u'hard-timeout': 65000,
68 u'idle-timeout': 65000,
69 u'cookie_mask': 4294967295,
70 u'flow-name': u'FLOW-NAME-TEMPLATE',
76 u'id': u'FLOW-ID-TEMPLATE',
78 u'ipv4-destination': u'0.0.0.0/32',
104 class FcbStats(object):
106 FlowConfigBlaster Statistics: a class that stores and further processes
107 statistics collected by Blaster worker threads during their execution.
110 self.ok_rqst_rate = Counter(0.0)
111 self.total_rqst_rate = Counter(0.0)
112 self.ok_flow_rate = Counter(0.0)
113 self.total_flow_rate = Counter(0.0)
114 self.ok_rqsts = Counter(0)
115 self.total_rqsts = Counter(0)
116 self.ok_flows = Counter(0)
117 self.total_flows = Counter(0)
119 def process_stats(self, rqst_stats, flow_stats, elapsed_time):
121 Calculates the stats for RESTCONF request and flow programming
122 throughput, and aggregates statistics across all Blaster threads.
125 rqst_stats: Request statistics dictionary
126 flow_stats: Flow statistcis dictionary
127 elapsed_time: Elapsed time for the test
129 Returns: Rates (requests/sec) for successfully finished requests,
130 the total number of requests, sucessfully installed flow and
131 the total number of flows
133 ok_rqsts = rqst_stats[200] + rqst_stats[204]
134 total_rqsts = sum(rqst_stats.values())
135 ok_flows = flow_stats[200] + flow_stats[204]
136 total_flows = sum(flow_stats.values())
138 ok_rqst_rate = ok_rqsts / elapsed_time
139 total_rqst_rate = total_rqsts / elapsed_time
140 ok_flow_rate = ok_flows / elapsed_time
141 total_flow_rate = total_flows / elapsed_time
143 self.ok_rqsts.increment(ok_rqsts)
144 self.total_rqsts.increment(total_rqsts)
145 self.ok_flows.increment(ok_flows)
146 self.total_flows.increment(total_flows)
148 self.ok_rqst_rate.increment(ok_rqst_rate)
149 self.total_rqst_rate.increment(total_rqst_rate)
150 self.ok_flow_rate.increment(ok_flow_rate)
151 self.total_flow_rate.increment(total_flow_rate)
153 return ok_rqst_rate, total_rqst_rate, ok_flow_rate, total_flow_rate
155 def get_ok_rqst_rate(self):
156 return self.ok_rqst_rate.value
158 def get_total_rqst_rate(self):
159 return self.total_rqst_rate.value
161 def get_ok_flow_rate(self):
162 return self.ok_flow_rate.value
164 def get_total_flow_rate(self):
165 return self.total_flow_rate.value
167 def get_ok_rqsts(self):
168 return self.ok_rqsts.value
170 def get_total_rqsts(self):
171 return self.total_rqsts.value
173 def get_ok_flows(self):
174 return self.ok_flows.value
176 def get_total_flows(self):
177 return self.total_flows.value
179 def __init__(self, host, port, ncycles, nthreads, fpr, nnodes, nflows, startflow, auth, flow_mod_template=None):
182 self.ncycles = ncycles
183 self.nthreads = nthreads
187 self.startflow = startflow
190 if flow_mod_template:
191 self.flow_mode_template = flow_mod_template
193 self.post_url_template = 'http://%s:' + self.port + '/' + self.TBLURL
194 self.del_url_template = 'http://%s:' + self.port + '/' + self.FLWURL
196 self.stats = self.FcbStats()
197 self.total_ok_flows = 0
198 self.total_ok_rqsts = 0
200 self.ip_addr = Counter(int(netaddr.IPAddress('10.0.0.1')) + startflow)
202 self.print_lock = threading.Lock()
203 self.cond = threading.Condition()
204 self.threads_done = 0
206 for i in range(self.nthreads):
209 def get_num_nodes(self, session):
211 Determines the number of OF nodes in the connected mininet network. If
212 mininet is not connected, the default number of flows is set to 16.
213 :param session: 'requests' session which to use to query the controller
217 hosts = self.host.split(",")
219 inventory_url = 'http://' + host + ":" + self.port + '/' + self.INVURL
223 r = session.get(inventory_url, headers=self.getheaders, stream=False, timeout=self.TIMEOUT)
225 r = session.get(inventory_url, headers=self.getheaders, stream=False, auth=('admin', 'admin'),
226 timeout=self.TIMEOUT)
228 if r.status_code == 200:
230 inv = json.loads(r.content)['nodes']['node']
232 for n in range(len(inv)):
233 if re.search('openflow', inv[n]['id']) is not None:
242 def create_flow_from_template(self, flow_id, ipaddr, node_id):
244 Create a new flow instance from the flow template specified during
245 FlowConfigBlaster instantiation. Flow templates are json-compatible
246 dictionaries that MUST contain elements for flow cookie, flow name,
247 flow id and the destination IPv4 address in the flow match field.
250 flow_id: Id for the new flow to create
251 ipaddr: IP Address to put into the flow's match
252 node_id: ID of the node where to create the flow
254 Returns: The flow that gas been created from the template
257 flow = copy.deepcopy(self.flow_mode_template['flow'][0])
258 flow['cookie'] = flow_id
259 flow['flow-name'] = self.create_flow_name(flow_id)
260 flow['id'] = str(flow_id)
261 flow['match']['ipv4-destination'] = '%s/32' % str(netaddr.IPAddress(ipaddr))
264 def post_flows(self, session, node, flow_list, flow_count):
266 Performs a RESTCONF post of flows passed in the 'flow_list' parameters
267 :param session: 'requests' session on which to perform the POST
268 :param node: The ID of the openflow node to which to post the flows
269 :param flow_list: List of flows (in dictionary form) to POST
270 :param flow_count: Flow counter for round-robin host load balancing
272 :return: status code from the POST operation
274 flow_data = self.convert_to_json(flow_list, node)
276 hosts = self.host.split(",")
277 host = hosts[flow_count % len(hosts)]
278 flow_url = self.assemble_post_url(host, node)
282 r = session.post(flow_url, data=flow_data, headers=self.putheaders, stream=False, timeout=self.TIMEOUT)
284 r = session.post(flow_url, data=flow_data, headers=self.putheaders, stream=False, auth=('admin', 'admin'),
285 timeout=self.TIMEOUT)
289 def assemble_post_url(self, host, node):
291 Creates url pointing to config dataStore: /nodes/node/<node-id>/table/<table-id>
292 :param host: ip address or host name pointing to controller
293 :param node: id of node (without protocol prefix and colon)
294 :return: url suitable for sending a flow to controller via POST method
296 return self.post_url_template % (host, node)
298 def convert_to_json(self, flow_list, node_id=None):
300 Dumps flows to json form.
301 :param flow_list: list of flows in json friendly structure
302 :param node_id: node identifier of corresponding node
303 :return: string containing plain json
305 fmod = dict(self.flow_mode_template)
306 fmod['flow'] = flow_list
307 flow_data = json.dumps(fmod)
311 def add_flows(self, start_flow_id, tid):
313 Adds flows into the ODL config data store. This function is executed by
314 a worker thread (the Blaster thread). The number of flows created and
315 the batch size (i.e. how many flows will be put into a RESTCONF request)
316 are determined by control parameters initialized when FlowConfigBlaster
318 :param start_flow_id - the ID of the first flow. Each Blaster thread
319 programs a different set of flows
320 :param tid: Thread ID - used to id the Blaster thread when statistics
321 for the thread are printed out
324 rqst_stats = {200: 0, 204: 0}
325 flow_stats = {200: 0, 204: 0}
327 s = requests.Session()
329 n_nodes = self.get_num_nodes(s)
331 with self.print_lock:
332 print ' Thread %d:\n Adding %d flows on %d nodes' % (tid, self.nflows, n_nodes)
336 while nflows < self.nflows:
337 node_id = randrange(1, n_nodes + 1)
339 for i in range(self.fpr):
340 flow_id = tid * (self.ncycles * self.nflows) + nflows + start_flow_id + self.startflow
341 self.flows[tid][flow_id] = node_id
342 flow_list.append(self.create_flow_from_template(flow_id, self.ip_addr.increment(), node_id))
344 if nflows >= self.nflows:
346 nb_actions.append((s, node_id, flow_list, nflows))
349 for nb_action in nb_actions:
350 sts = self.post_flows(*nb_action)
353 flow_stats[sts] += len(nb_action[2])
356 flow_stats[sts] = len(nb_action[2])
358 ok_rps, total_rps, ok_fps, total_fps = self.stats.process_stats(rqst_stats, flow_stats, t.secs)
360 with self.print_lock:
361 print '\n Thread %d results (ADD): ' % tid
362 print ' Elapsed time: %.2fs,' % t.secs
363 print ' Requests/s: %.2f OK, %.2f Total' % (ok_rps, total_rps)
364 print ' Flows/s: %.2f OK, %.2f Total' % (ok_fps, total_fps)
365 print ' Stats ({Requests}, {Flows}): ',
368 self.threads_done += 1
373 self.cond.notifyAll()
375 def delete_flow(self, session, node, flow_id, flow_count):
377 Deletes a single flow from the ODL config data store using RESTCONF
379 session: 'requests' session on which to perform the POST
380 node: Id of the openflow node from which to delete the flow
381 flow_id: ID of the to-be-deleted flow
382 flow_count: Index of the flow being processed (for round-robin LB)
384 Returns: status code from the DELETE operation
388 hosts = self.host.split(",")
389 host = hosts[flow_count % len(hosts)]
390 flow_url = self.del_url_template % (host, node, flow_id)
394 r = session.delete(flow_url, headers=self.getheaders, timeout=self.TIMEOUT)
396 r = session.delete(flow_url, headers=self.getheaders, auth=('admin', 'admin'), timeout=self.TIMEOUT)
400 def delete_flows(self, start_flow, tid):
402 Deletes flow from the ODL config space that have been added using the
403 'add_flows()' function. This function is executed by a worker thread
404 :param start_flow - the ID of the first flow. Each Blaster thread
405 deletes a different set of flows
406 :param tid: Thread ID - used to id the Blaster thread when statistics
407 for the thread are printed out
411 rqst_stats = {200: 0, 204: 0}
413 s = requests.Session()
414 n_nodes = self.get_num_nodes(s)
416 with self.print_lock:
417 print 'Thread %d: Deleting %d flows on %d nodes' % (tid, self.nflows, n_nodes)
420 for flow in range(self.nflows):
421 flow_id = tid * (self.ncycles * self.nflows) + flow + start_flow + self.startflow
422 sts = self.delete_flow(s, self.flows[tid][flow_id], flow_id, flow)
428 ok_rps, total_rps, ok_fps, total_fps = self.stats.process_stats(rqst_stats, rqst_stats, t.secs)
430 with self.print_lock:
431 print '\n Thread %d results (DELETE): ' % tid
432 print ' Elapsed time: %.2fs,' % t.secs
433 print ' Requests/s: %.2f OK, %.2f Total' % (ok_rps, total_rps)
434 print ' Flows/s: %.2f OK, %.2f Total' % (ok_fps, total_fps)
435 print ' Stats ({Requests})',
437 self.threads_done += 1
442 self.cond.notifyAll()
444 def run_cycle(self, function):
446 Runs a flow-add or flow-delete test cycle. Each test consists of a
447 <cycles> test cycles, where <threads> worker (Blaster) threads are
448 started in each test cycle. Each Blaster thread programs <flows>
449 OpenFlow flows into the controller using the controller's RESTCONF API.
450 :param function: Add or delete, determines what test will be executed.
453 self.total_ok_flows = 0
454 self.total_ok_rqsts = 0
456 for c in range(self.ncycles):
457 self.stats = self.FcbStats()
458 with self.print_lock:
459 print '\nCycle %d:' % c
462 for i in range(self.nthreads):
463 t = threading.Thread(target=function, args=(c * self.nflows, i))
467 # Wait for all threads to finish and measure the execution time
469 for thread in threads:
472 with self.print_lock:
473 print '\n*** Test summary:'
474 print ' Elapsed time: %.2fs' % t.secs
475 print ' Peak requests/s: %.2f OK, %.2f Total' % (
476 self.stats.get_ok_rqst_rate(), self.stats.get_total_rqst_rate())
477 print ' Peak flows/s: %.2f OK, %.2f Total' % (
478 self.stats.get_ok_flow_rate(), self.stats.get_total_flow_rate())
479 print ' Avg. requests/s: %.2f OK, %.2f Total (%.2f%% of peak total)' % (
480 self.stats.get_ok_rqsts() / t.secs,
481 self.stats.get_total_rqsts() / t.secs,
482 (self.stats.get_total_rqsts() / t.secs * 100) / self.stats.get_total_rqst_rate())
483 print ' Avg. flows/s: %.2f OK, %.2f Total (%.2f%% of peak total)' % (
484 self.stats.get_ok_flows() / t.secs,
485 self.stats.get_total_flows() / t.secs,
486 (self.stats.get_total_flows() / t.secs * 100) / self.stats.get_total_flow_rate())
488 self.total_ok_flows += self.stats.get_ok_flows()
489 self.total_ok_rqsts += self.stats.get_ok_rqsts()
490 self.threads_done = 0
492 def add_blaster(self):
493 self.run_cycle(self.add_flows)
495 def delete_blaster(self):
496 self.run_cycle(self.delete_flows)
498 def get_ok_flows(self):
499 return self.total_ok_flows
501 def get_ok_rqsts(self):
502 return self.total_ok_rqsts
504 def create_flow_name(self, flow_id):
505 return 'TestFlow-%d' % flow_id
508 def get_json_from_file(filename):
510 Get a flow programming template from a file
511 :param filename: File from which to get the template
512 :return: The json flow template (string)
514 with open(filename, 'r') as f:
517 keys = ft['flow'][0].keys()
518 if (u'cookie' in keys) and (u'flow-name' in keys) and (u'id' in keys) and (u'match' in keys):
519 if u'ipv4-destination' in ft[u'flow'][0]['match'].keys():
520 print 'File "%s" ok to use as flow template' % filename
523 print 'JSON parsing of file %s failed' % filename
529 ###############################################################################
530 # This is an example of what the content of a JSON flow mode template should
531 # look like. Cut & paste to create a custom template. "id" and "ipv4-destination"
532 # MUST be unique if multiple flows will be programmed in the same test. It's
533 # also beneficial to have unique "cookie" and "flow-name" attributes for easier
534 # identification of the flow.
535 ###############################################################################
536 example_flow_mod_json = '''{
556 "hard-timeout": 65000,
563 "ipv4-destination": "10.0.0.38/32"
565 "flow-name": "TestFlow-8",
567 "cookie_mask": 4294967295,
570 "idle-timeout": 65000,
578 def create_arguments_parser():
580 Shorthand to arg parser on library level in order to access and eventually enhance in ancestors.
581 :return: argument parser supporting config blaster arguments and parameters
583 my_parser = argparse.ArgumentParser(description='Flow programming performance test: First adds and then'
584 ' deletes flows into the config tree, as specified by'
585 ' optional parameters.')
587 my_parser.add_argument('--host', default='127.0.0.1',
588 help='Host where odl controller is running (default is 127.0.0.1). '
589 'Specify a comma-separated list of hosts to perform round-robin load-balancing.')
590 my_parser.add_argument('--port', default='8181',
591 help='Port on which odl\'s RESTCONF is listening (default is 8181)')
592 my_parser.add_argument('--cycles', type=int, default=1,
593 help='Number of flow add/delete cycles; default 1. Both Flow Adds and Flow Deletes are '
594 'performed in cycles. <THREADS> worker threads are started in each cycle and the cycle '
595 'ends when all threads finish. Another cycle is started when the previous cycle '
597 my_parser.add_argument('--threads', type=int, default=1,
598 help='Number of request worker threads to start in each cycle; default=1. '
599 'Each thread will add/delete <FLOWS> flows.')
600 my_parser.add_argument('--flows', type=int, default=10,
601 help='Number of flows that will be added/deleted by each worker thread in each cycle; '
603 my_parser.add_argument('--fpr', type=int, default=1,
604 help='Flows-per-Request - number of flows (batch size) sent in each HTTP request; '
606 my_parser.add_argument('--nodes', type=int, default=16,
607 help='Number of nodes if mininet is not connected; default=16. If mininet is connected, '
608 'flows will be evenly distributed (programmed) into connected nodes.')
609 my_parser.add_argument('--delay', type=int, default=0,
610 help='Time (in seconds) to wait between the add and delete cycles; default=0')
611 my_parser.add_argument('--delete', dest='delete', action='store_true', default=True,
612 help='Delete all added flows one by one, benchmark delete '
614 my_parser.add_argument('--no-delete', dest='delete', action='store_false',
615 help='Do not perform the delete cycle.')
616 my_parser.add_argument('--auth', dest='auth', action='store_true', default=False,
617 help="Use the ODL default username/password 'admin'/'admin' to authenticate access to REST; "
618 'default: no authentication')
619 my_parser.add_argument('--startflow', type=int, default=0,
620 help='The starting Flow ID; default=0')
621 my_parser.add_argument('--file', default='',
622 help='File from which to read the JSON flow template; default: no file, use a built in '
627 if __name__ == "__main__":
628 ############################################################################
629 # This program executes the base performance test. The test adds flows into
630 # the controller's config space. This function is basically the CLI frontend
631 # to the FlowConfigBlaster class and drives its main functions: adding and
632 # deleting flows from the controller's config data store
633 ############################################################################
635 parser = create_arguments_parser()
636 in_args = parser.parse_args()
638 if in_args.file != '':
639 flow_template = get_json_from_file(in_args.file)
643 fct = FlowConfigBlaster(in_args.host, in_args.port, in_args.cycles, in_args.threads, in_args.fpr, in_args.nodes,
644 in_args.flows, in_args.startflow, in_args.auth)
646 # Run through <cycles>, where <threads> are started in each cycle and
647 # <flows> are added from each thread
650 print '\n*** Total flows added: %s' % fct.get_ok_flows()
651 print ' HTTP[OK] results: %d\n' % fct.get_ok_rqsts()
653 if in_args.delay > 0:
654 print '*** Waiting for %d seconds before the delete cycle ***\n' % in_args.delay
655 time.sleep(in_args.delay)
657 # Run through <cycles>, where <threads> are started in each cycle and
658 # <flows> previously added in an add cycle are deleted in each thread
661 print '\n*** Total flows deleted: %s' % fct.get_ok_flows()
662 print ' HTTP[OK] results: %d\n' % fct.get_ok_rqsts()