blob: 2e7b6f70c3ec02257823b0f2236a3fa362ff4cab [file] [log] [blame]
Bob Lantz087b5d92016-05-06 11:39:04 -07001#!/usr/bin/python
2
3"""
4onos.py: ONOS cluster and control network in Mininet
5
6With onos.py, you can use Mininet to create a complete
7ONOS network, including an ONOS cluster with a modeled
8control network as well as the usual data nework.
9
10This is intended to be useful for distributed ONOS
11development and testing in the case that you require
12a modeled control network.
13
14Invocation (using OVS as default switch):
15
16mn --custom onos.py --controller onos,3 --topo torus,4,4
17
18Or with the user switch (or CPqD if installed):
19
20mn --custom onos.py --controller onos,3 \
21 --switch onosuser --topo torus,4,4
22
Bob Lantzbb37d872016-05-16 16:26:13 -070023Currently you meed to use a custom switch class
Bob Lantz087b5d92016-05-06 11:39:04 -070024because Mininet's Switch() class does't (yet?) handle
25controllers with multiple IP addresses directly.
26
27The classes may also be imported and used via Mininet's
28python API.
29
30Bugs/Gripes:
31- We need --switch onosuser for the user switch because
32 Switch() doesn't currently handle Controller objects
33 with multiple IP addresses.
34- ONOS startup and configuration is painful/undocumented.
35- Too many ONOS environment vars - do we need them all?
36- ONOS cluster startup is very, very slow. If Linux can
37 boot in 4 seconds, why can't ONOS?
38- It's a pain to mess with the control network from the
39 CLI
40- Setting a default controller for Mininet should be easier
41"""
42
43from mininet.node import Controller, OVSSwitch, UserSwitch
44from mininet.nodelib import LinuxBridge
45from mininet.net import Mininet
46from mininet.topo import SingleSwitchTopo, Topo
Bob Lantz64382422016-06-03 22:51:39 -070047from mininet.log import setLogLevel, info, warn, error, debug
Bob Lantz087b5d92016-05-06 11:39:04 -070048from mininet.cli import CLI
Bob Lantz64382422016-06-03 22:51:39 -070049from mininet.util import quietRun, specialClass
Bob Lantz087b5d92016-05-06 11:39:04 -070050from mininet.examples.controlnet import MininetFacade
51
52from os import environ
53from os.path import dirname, join, isfile
54from sys import argv
55from glob import glob
56import time
Bob Lantz64382422016-06-03 22:51:39 -070057from functools import partial
Bob Lantz92d8e052016-06-17 16:03:58 -070058
Bob Lantz087b5d92016-05-06 11:39:04 -070059
60### ONOS Environment
61
Bob Lantzbb37d872016-05-16 16:26:13 -070062KarafPort = 8101 # ssh port indicating karaf is running
63GUIPort = 8181 # GUI/REST port
64OpenFlowPort = 6653 # OpenFlow port
Jon Halla43d0332016-08-04 15:02:23 -070065CopycatPort = 9876 # Copycat port
Bob Lantz087b5d92016-05-06 11:39:04 -070066
67def defaultUser():
68 "Return a reasonable default user"
69 if 'SUDO_USER' in environ:
70 return environ[ 'SUDO_USER' ]
71 try:
72 user = quietRun( 'who am i' ).split()[ 0 ]
73 except:
74 user = 'nobody'
75 return user
76
Bob Lantz087b5d92016-05-06 11:39:04 -070077# Module vars, initialized below
Bob Lantz4b51d5c2016-05-27 14:47:38 -070078HOME = ONOS_ROOT = ONOS_USER = None
Lyndon Fawcettfbad2e72017-09-20 11:46:17 +000079ONOS_APPS = ONOS_WEB_USER = ONOS_WEB_PASS = ONOS_TAR = JAVA_OPTS = None
Bob Lantz087b5d92016-05-06 11:39:04 -070080
81def initONOSEnv():
82 """Initialize ONOS environment (and module) variables
83 This is ugly and painful, but they have to be set correctly
84 in order for the onos-setup-karaf script to work.
85 nodes: list of ONOS nodes
86 returns: ONOS environment variable dict"""
87 # pylint: disable=global-statement
Bob Lantz4b51d5c2016-05-27 14:47:38 -070088 global HOME, ONOS_ROOT, ONOS_USER
Bob Lantz087b5d92016-05-06 11:39:04 -070089 global ONOS_APPS, ONOS_WEB_USER, ONOS_WEB_PASS
90 env = {}
91 def sd( var, val ):
92 "Set default value for environment variable"
93 env[ var ] = environ.setdefault( var, val )
94 return env[ var ]
Bob Lantz4b51d5c2016-05-27 14:47:38 -070095 assert environ[ 'HOME' ]
Bob Lantz087b5d92016-05-06 11:39:04 -070096 HOME = sd( 'HOME', environ[ 'HOME' ] )
Bob Lantz087b5d92016-05-06 11:39:04 -070097 ONOS_ROOT = sd( 'ONOS_ROOT', join( HOME, 'onos' ) )
Bob Lantz087b5d92016-05-06 11:39:04 -070098 environ[ 'ONOS_USER' ] = defaultUser()
99 ONOS_USER = sd( 'ONOS_USER', defaultUser() )
100 ONOS_APPS = sd( 'ONOS_APPS',
101 'drivers,openflow,fwd,proxyarp,mobility' )
Lyndon Fawcettfbad2e72017-09-20 11:46:17 +0000102 JAVA_OPTS = sd( 'JAVA_OPTS', '-Xms128m -Xmx512m' )
Bob Lantz087b5d92016-05-06 11:39:04 -0700103 # ONOS_WEB_{USER,PASS} isn't respected by onos-karaf:
104 environ.update( ONOS_WEB_USER='karaf', ONOS_WEB_PASS='karaf' )
105 ONOS_WEB_USER = sd( 'ONOS_WEB_USER', 'karaf' )
106 ONOS_WEB_PASS = sd( 'ONOS_WEB_PASS', 'karaf' )
107 return env
108
109
110def updateNodeIPs( env, nodes ):
111 "Update env dict and environ with node IPs"
112 # Get rid of stale junk
113 for var in 'ONOS_NIC', 'ONOS_CELL', 'ONOS_INSTANCES':
114 env[ var ] = ''
115 for var in environ.keys():
116 if var.startswith( 'OC' ):
117 env[ var ] = ''
118 for index, node in enumerate( nodes, 1 ):
119 var = 'OC%d' % index
120 env[ var ] = node.IP()
Jon Hall25485592016-08-19 13:56:14 -0700121 if nodes:
122 env[ 'OCI' ] = env[ 'OCN' ] = env[ 'OC1' ]
Bob Lantz087b5d92016-05-06 11:39:04 -0700123 env[ 'ONOS_INSTANCES' ] = '\n'.join(
124 node.IP() for node in nodes )
125 environ.update( env )
126 return env
127
128
129tarDefaultPath = 'buck-out/gen/tools/package/onos-package/onos.tar.gz'
130
Bob Lantz1451d722016-05-17 14:40:07 -0700131def unpackONOS( destDir='/tmp', run=quietRun ):
Bob Lantz087b5d92016-05-06 11:39:04 -0700132 "Unpack ONOS and return its location"
133 global ONOS_TAR
134 environ.setdefault( 'ONOS_TAR', join( ONOS_ROOT, tarDefaultPath ) )
135 ONOS_TAR = environ[ 'ONOS_TAR' ]
136 tarPath = ONOS_TAR
137 if not isfile( tarPath ):
138 raise Exception( 'Missing ONOS tarball %s - run buck build onos?'
139 % tarPath )
140 info( '(unpacking %s)' % destDir)
Bob Lantza2ccaa52016-06-29 18:26:06 -0700141 success = '*** SUCCESS ***'
142 cmds = ( 'mkdir -p "%s" && cd "%s" && tar xzf "%s" && echo "%s"'
143 % ( destDir, destDir, tarPath, success ) )
144 result = run( cmds, shell=True, verbose=True )
145 if success not in result:
146 raise Exception( 'Failed to unpack ONOS archive %s in %s:\n%s\n' %
147 ( tarPath, destDir, result ) )
Bob Lantz1451d722016-05-17 14:40:07 -0700148 # We can use quietRun for this usually
149 tarOutput = quietRun( 'tar tzf "%s" | head -1' % tarPath, shell=True)
150 tarOutput = tarOutput.split()[ 0 ].strip()
151 assert '/' in tarOutput
152 onosDir = join( destDir, dirname( tarOutput ) )
Bob Lantz087b5d92016-05-06 11:39:04 -0700153 # Add symlink to log file
Bob Lantz1451d722016-05-17 14:40:07 -0700154 run( 'cd %s; ln -s onos*/apache* karaf;'
155 'ln -s karaf/data/log/karaf.log log' % destDir,
156 shell=True )
Bob Lantz087b5d92016-05-06 11:39:04 -0700157 return onosDir
158
159
Bob Lantz9ba19dc2016-06-13 20:22:07 -0700160def waitListening( server, port=80, callback=None, sleepSecs=.5,
161 proc='java' ):
162 "Simplified netstat version of waitListening"
163 while True:
164 lines = server.cmd( 'netstat -natp' ).strip().split( '\n' )
165 entries = [ line.split() for line in lines ]
166 portstr = ':%s' % port
167 listening = [ entry for entry in entries
168 if len( entry ) > 6 and portstr in entry[ 3 ]
169 and proc in entry[ 6 ] ]
170 if listening:
171 break
Bob Lantz64382422016-06-03 22:51:39 -0700172 info( '.' )
173 if callback:
174 callback()
175 time.sleep( sleepSecs )
Bob Lantz64382422016-06-03 22:51:39 -0700176
177
Bob Lantz087b5d92016-05-06 11:39:04 -0700178### Mininet classes
179
180def RenamedTopo( topo, *args, **kwargs ):
181 """Return specialized topo with renamed hosts
182 topo: topo class/class name to specialize
183 args, kwargs: topo args
184 sold: old switch name prefix (default 's')
185 snew: new switch name prefix
186 hold: old host name prefix (default 'h')
187 hnew: new host name prefix
188 This may be used from the mn command, e.g.
189 mn --topo renamed,single,spref=sw,hpref=host"""
190 sold = kwargs.pop( 'sold', 's' )
191 hold = kwargs.pop( 'hold', 'h' )
192 snew = kwargs.pop( 'snew', 'cs' )
193 hnew = kwargs.pop( 'hnew' ,'ch' )
194 topos = {} # TODO: use global TOPOS dict
195 if isinstance( topo, str ):
196 # Look up in topo directory - this allows us to
197 # use RenamedTopo from the command line!
198 if topo in topos:
199 topo = topos.get( topo )
200 else:
201 raise Exception( 'Unknown topo name: %s' % topo )
202 # pylint: disable=no-init
203 class RenamedTopoCls( topo ):
204 "Topo subclass with renamed nodes"
205 def addNode( self, name, *args, **kwargs ):
206 "Add a node, renaming if necessary"
207 if name.startswith( sold ):
208 name = snew + name[ len( sold ): ]
209 elif name.startswith( hold ):
210 name = hnew + name[ len( hold ): ]
211 return topo.addNode( self, name, *args, **kwargs )
212 return RenamedTopoCls( *args, **kwargs )
213
214
Bob Lantz8e576252016-08-29 14:05:59 -0700215# We accept objects that "claim" to be a particular class,
216# since the class definitions can be both execed (--custom) and
217# imported (in another custom file), which breaks isinstance().
218# In order for this to work properly, a class should not be
219# renamed so as to inappropriately omit or include the class
220# name text. Note that mininet.util.specialClass renames classes
221# by adding the specialized parameter names and values.
222
223def isONOSNode( obj ):
224 "Does obj claim to be some kind of ONOSNode?"
225 return ( isinstance( obj, ONOSNode) or
226 'ONOSNode' in type( obj ).__name__ )
227
228def isONOSCluster( obj ):
229 "Does obj claim to be some kind of ONOSCluster?"
230 return ( isinstance( obj, ONOSCluster ) or
231 'ONOSCluster' in type( obj ).__name__ )
232
233
Bob Lantz087b5d92016-05-06 11:39:04 -0700234class ONOSNode( Controller ):
235 "ONOS cluster node"
236
Bob Lantz087b5d92016-05-06 11:39:04 -0700237 def __init__( self, name, **kwargs ):
Bob Lantz64382422016-06-03 22:51:39 -0700238 "alertAction: exception|ignore|warn|exit (exception)"
Bob Lantz087b5d92016-05-06 11:39:04 -0700239 kwargs.update( inNamespace=True )
Bob Lantz64382422016-06-03 22:51:39 -0700240 self.alertAction = kwargs.pop( 'alertAction', 'exception' )
Bob Lantz087b5d92016-05-06 11:39:04 -0700241 Controller.__init__( self, name, **kwargs )
242 self.dir = '/tmp/%s' % self.name
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700243 self.client = self.dir + '/karaf/bin/client'
Bob Lantz087b5d92016-05-06 11:39:04 -0700244 self.ONOS_HOME = '/tmp'
Bob Lantz55562ea2016-06-17 18:19:03 -0700245 self.cmd( 'rm -rf', self.dir )
246 self.ONOS_HOME = unpackONOS( self.dir, run=self.ucmd )
Jon Hall25485592016-08-19 13:56:14 -0700247 self.ONOS_ROOT = ONOS_ROOT
Bob Lantz087b5d92016-05-06 11:39:04 -0700248
249 # pylint: disable=arguments-differ
250
Bob Lantz569bbec2016-06-03 18:51:16 -0700251 def start( self, env, nodes=() ):
Bob Lantz087b5d92016-05-06 11:39:04 -0700252 """Start ONOS on node
Bob Lantz569bbec2016-06-03 18:51:16 -0700253 env: environment var dict
254 nodes: all nodes in cluster"""
Bob Lantz087b5d92016-05-06 11:39:04 -0700255 env = dict( env )
Bob Lantz087b5d92016-05-06 11:39:04 -0700256 env.update( ONOS_HOME=self.ONOS_HOME )
257 self.updateEnv( env )
258 karafbin = glob( '%s/apache*/bin' % self.ONOS_HOME )[ 0 ]
259 onosbin = join( ONOS_ROOT, 'tools/test/bin' )
260 self.cmd( 'export PATH=%s:%s:$PATH' % ( onosbin, karafbin ) )
261 self.cmd( 'cd', self.ONOS_HOME )
Bob Lantz1451d722016-05-17 14:40:07 -0700262 self.ucmd( 'mkdir -p config && '
Bob Lantz569bbec2016-06-03 18:51:16 -0700263 'onos-gen-partitions config/cluster.json',
264 ' '.join( node.IP() for node in nodes ) )
Bob Lantz087b5d92016-05-06 11:39:04 -0700265 info( '(starting %s)' % self )
266 service = join( self.ONOS_HOME, 'bin/onos-service' )
Bob Lantz1451d722016-05-17 14:40:07 -0700267 self.ucmd( service, 'server 1>../onos.log 2>../onos.log'
268 ' & echo $! > onos.pid; ln -s `pwd`/onos.pid ..' )
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700269 self.onosPid = int( self.cmd( 'cat onos.pid' ).strip() )
Bob Lantz64382422016-06-03 22:51:39 -0700270 self.warningCount = 0
Bob Lantz087b5d92016-05-06 11:39:04 -0700271
272 # pylint: enable=arguments-differ
273
Carmelo Casconec52a4b12016-10-24 16:47:17 +0200274 def intfsDown( self ):
275 """Bring all interfaces down"""
276 for intf in self.intfs.values():
277 cmdOutput = intf.ifconfig( 'down' )
278 # no output indicates success
279 if cmdOutput:
280 error( "Error setting %s down: %s " % ( intf.name, cmdOutput ) )
281
282 def intfsUp( self ):
283 """Bring all interfaces up"""
284 for intf in self.intfs.values():
285 cmdOutput = intf.ifconfig( 'up' )
286 if cmdOutput:
287 error( "Error setting %s up: %s " % ( intf.name, cmdOutput ) )
288
Bob Lantz087b5d92016-05-06 11:39:04 -0700289 def stop( self ):
290 # XXX This will kill all karafs - too bad!
291 self.cmd( 'pkill -HUP -f karaf.jar && wait' )
292 self.cmd( 'rm -rf', self.dir )
293
Bob Lantz64382422016-06-03 22:51:39 -0700294 def sanityAlert( self, *args ):
295 "Alert to raise on sanityCheck failure"
296 info( '\n' )
297 if self.alertAction == 'exception':
298 raise Exception( *args )
299 if self.alertAction == 'warn':
300 warn( *args + ( '\n', ) )
301 elif self.alertAction == 'exit':
302 error( '***', *args +
303 ( '\nExiting. Run "sudo mn -c" to clean up.\n', ) )
304 exit( 1 )
305
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700306 def isRunning( self ):
307 "Is our ONOS process still running?"
Bob Lantz64382422016-06-03 22:51:39 -0700308 cmd = ( 'ps -p %d >/dev/null 2>&1 && echo "running" ||'
309 'echo "not running"' )
310 return self.cmd( cmd % self.onosPid ).strip() == 'running'
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700311
Bob Lantz64382422016-06-03 22:51:39 -0700312 def checkLog( self ):
313 "Return log file errors and warnings"
314 log = join( self.dir, 'log' )
Bob Lantzc96e2582016-06-13 18:57:04 -0700315 errors, warnings = [], []
Bob Lantz64382422016-06-03 22:51:39 -0700316 if isfile( log ):
317 lines = open( log ).read().split( '\n' )
318 errors = [ line for line in lines if 'ERROR' in line ]
319 warnings = [ line for line in lines if 'WARN'in line ]
320 return errors, warnings
321
322 def memAvailable( self ):
323 "Return available memory in KB (or -1 if we can't tell)"
324 lines = open( '/proc/meminfo' ).read().strip().split( '\n' )
325 entries = map( str.split, lines )
326 index = { entry[ 0 ]: entry for entry in entries }
327 # Check MemAvailable if present
328 default = ( None, '-1', 'kB' )
329 _name, count, unit = index.get( 'MemAvailable:', default )
330 if unit.lower() == 'kb':
331 return int( count )
332 return -1
333
334 def sanityCheck( self, lowMem=100000 ):
335 """Check whether we've quit or are running out of memory
336 lowMem: low memory threshold in KB (100000)"""
337 # Are we still running?
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700338 if not self.isRunning():
Bob Lantz64382422016-06-03 22:51:39 -0700339 self.sanityAlert( 'ONOS node %s has died' % self.name )
340 # Are there errors in the log file?
341 errors, warnings = self.checkLog()
342 if errors:
343 self.sanityAlert( 'ONOS startup errors:\n<<%s>>' %
344 '\n'.join( errors ) )
345 warningCount = len( warnings )
346 if warnings and warningCount > self.warningCount:
347 warn( '(%d warnings)' % len( warnings ) )
348 self.warningCount = warningCount
349 # Are we running out of memory?
350 mem = self.memAvailable()
351 if mem > 0 and mem < lowMem:
352 self.sanityAlert( 'Running out of memory (only %d KB available)'
353 % mem )
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700354
Bob Lantz087b5d92016-05-06 11:39:04 -0700355 def waitStarted( self ):
356 "Wait until we've really started"
357 info( '(checking: karaf' )
358 while True:
Bob Lantz1451d722016-05-17 14:40:07 -0700359 status = self.ucmd( 'karaf status' ).lower()
Bob Lantz087b5d92016-05-06 11:39:04 -0700360 if 'running' in status and 'not running' not in status:
361 break
362 info( '.' )
Bob Lantz64382422016-06-03 22:51:39 -0700363 self.sanityCheck()
Bob Lantz087b5d92016-05-06 11:39:04 -0700364 time.sleep( 1 )
365 info( ' ssh-port' )
Bob Lantz64382422016-06-03 22:51:39 -0700366 waitListening( server=self, port=KarafPort, callback=self.sanityCheck )
Carmelo Casconec3baa4c2017-11-21 00:06:11 -0800367 info( ' protocol' )
Bob Lantz087b5d92016-05-06 11:39:04 -0700368 while True:
Bob Lantz9ba19dc2016-06-13 20:22:07 -0700369 result = quietRun( '%s -h %s "apps -a"' %
Bob Lantzbb37d872016-05-16 16:26:13 -0700370 ( self.client, self.IP() ), shell=True )
Carmelo Casconec3baa4c2017-11-21 00:06:11 -0800371 if 'openflow' in result or 'p4runtime' in result:
Bob Lantz087b5d92016-05-06 11:39:04 -0700372 break
373 info( '.' )
Bob Lantz64382422016-06-03 22:51:39 -0700374 self.sanityCheck()
Bob Lantz087b5d92016-05-06 11:39:04 -0700375 time.sleep( 1 )
Jon Halla43d0332016-08-04 15:02:23 -0700376 info( ' node-status' )
377 while True:
378 result = quietRun( '%s -h %s "nodes"' %
379 ( self.client, self.IP() ), shell=True )
Carmelo Casconec3baa4c2017-11-21 00:06:11 -0800380 nodeStr = 'id=%s, address=%s:%s, state=READY' %\
Jon Halla43d0332016-08-04 15:02:23 -0700381 ( self.IP(), self.IP(), CopycatPort )
382 if nodeStr in result:
383 break
384 info( '.' )
385 self.sanityCheck()
386 time.sleep( 1 )
Bob Lantz087b5d92016-05-06 11:39:04 -0700387 info( ')\n' )
388
389 def updateEnv( self, envDict ):
390 "Update environment variables"
Bob Lantz569bbec2016-06-03 18:51:16 -0700391 cmd = ';'.join( ( 'export %s="%s"' % ( var, val )
392 if val else 'unset %s' % var )
Bob Lantz087b5d92016-05-06 11:39:04 -0700393 for var, val in envDict.iteritems() )
394 self.cmd( cmd )
395
Bob Lantz1451d722016-05-17 14:40:07 -0700396 def ucmd( self, *args, **_kwargs ):
397 "Run command as $ONOS_USER using sudo -E -u"
398 if ONOS_USER != 'root': # don't bother with sudo
399 args = [ "sudo -E -u $ONOS_USER PATH=$PATH "
400 "bash -c '%s'" % ' '.join( args ) ]
401 return self.cmd( *args )
402
Bob Lantz087b5d92016-05-06 11:39:04 -0700403
404class ONOSCluster( Controller ):
405 "ONOS Cluster"
Bob Lantz57635162016-08-29 15:13:54 -0700406 # Offset for port forwarding
407 portOffset = 0
Bob Lantz087b5d92016-05-06 11:39:04 -0700408 def __init__( self, *args, **kwargs ):
409 """name: (first parameter)
410 *args: topology class parameters
411 ipBase: IP range for ONOS nodes
Bob Lantz57635162016-08-29 15:13:54 -0700412 forward: default port forwarding list
413 portOffset: offset to port base (optional)
Bob Lantz087b5d92016-05-06 11:39:04 -0700414 topo: topology class or instance
Bob Lantz64382422016-06-03 22:51:39 -0700415 nodeOpts: ONOSNode options
Bob Lantz57635162016-08-29 15:13:54 -0700416 **kwargs: additional topology parameters
417 By default, multiple ONOSClusters will increment
418 the portOffset automatically; alternately, it can
419 be specified explicitly.
420 """
Bob Lantz087b5d92016-05-06 11:39:04 -0700421 args = list( args )
422 name = args.pop( 0 )
423 topo = kwargs.pop( 'topo', None )
Bob Lantz930138e2016-06-23 18:53:19 -0700424 self.nat = kwargs.pop( 'nat', 'nat0' )
Bob Lantz64382422016-06-03 22:51:39 -0700425 nodeOpts = kwargs.pop( 'nodeOpts', {} )
Bob Lantz57635162016-08-29 15:13:54 -0700426 self.portOffset = kwargs.pop( 'portOffset', ONOSCluster.portOffset )
Jon Hall9b238ae2016-08-09 13:47:43 -0700427 # Pass in kwargs to the ONOSNodes instead of the cluster
428 "alertAction: exception|ignore|warn|exit (exception)"
429 alertAction = kwargs.pop( 'alertAction', None )
430 if alertAction:
431 nodeOpts[ 'alertAction'] = alertAction
Bob Lantz087b5d92016-05-06 11:39:04 -0700432 # Default: single switch with 1 ONOS node
433 if not topo:
434 topo = SingleSwitchTopo
435 if not args:
436 args = ( 1, )
437 if not isinstance( topo, Topo ):
438 topo = RenamedTopo( topo, *args, hnew='onos', **kwargs )
Bob Lantzbb37d872016-05-16 16:26:13 -0700439 self.ipBase = kwargs.pop( 'ipBase', '192.168.123.0/24' )
440 self.forward = kwargs.pop( 'forward',
441 [ KarafPort, GUIPort, OpenFlowPort ] )
Bob Lantz087b5d92016-05-06 11:39:04 -0700442 super( ONOSCluster, self ).__init__( name, inNamespace=False )
443 fixIPTables()
444 self.env = initONOSEnv()
Bob Lantzbb37d872016-05-16 16:26:13 -0700445 self.net = Mininet( topo=topo, ipBase=self.ipBase,
Bob Lantz64382422016-06-03 22:51:39 -0700446 host=partial( ONOSNode, **nodeOpts ),
447 switch=LinuxBridge,
Bob Lantz087b5d92016-05-06 11:39:04 -0700448 controller=None )
Bob Lantz930138e2016-06-23 18:53:19 -0700449 if self.nat:
450 self.net.addNAT( self.nat ).configDefault()
Bob Lantz087b5d92016-05-06 11:39:04 -0700451 updateNodeIPs( self.env, self.nodes() )
452 self._remoteControllers = []
Bob Lantz57635162016-08-29 15:13:54 -0700453 # Update port offset for more ONOS clusters
454 ONOSCluster.portOffset += len( self.nodes() )
Bob Lantz087b5d92016-05-06 11:39:04 -0700455
456 def start( self ):
457 "Start up ONOS cluster"
Bob Lantz087b5d92016-05-06 11:39:04 -0700458 info( '*** ONOS_APPS = %s\n' % ONOS_APPS )
459 self.net.start()
460 for node in self.nodes():
Bob Lantz569bbec2016-06-03 18:51:16 -0700461 node.start( self.env, self.nodes() )
Bob Lantz087b5d92016-05-06 11:39:04 -0700462 info( '\n' )
Bob Lantzbb37d872016-05-16 16:26:13 -0700463 self.configPortForwarding( ports=self.forward, action='A' )
Bob Lantz087b5d92016-05-06 11:39:04 -0700464 self.waitStarted()
465 return
466
467 def waitStarted( self ):
468 "Wait until all nodes have started"
469 startTime = time.time()
470 for node in self.nodes():
471 info( node )
472 node.waitStarted()
Bob Lantzbb37d872016-05-16 16:26:13 -0700473 info( '*** Waited %.2f seconds for ONOS startup' %
474 ( time.time() - startTime ) )
Bob Lantz087b5d92016-05-06 11:39:04 -0700475
476 def stop( self ):
477 "Shut down ONOS cluster"
Bob Lantzbb37d872016-05-16 16:26:13 -0700478 self.configPortForwarding( ports=self.forward, action='D' )
Bob Lantz087b5d92016-05-06 11:39:04 -0700479 for node in self.nodes():
480 node.stop()
481 self.net.stop()
482
483 def nodes( self ):
484 "Return list of ONOS nodes"
Bob Lantz8e576252016-08-29 14:05:59 -0700485 return [ h for h in self.net.hosts if isONOSNode( h ) ]
Bob Lantz087b5d92016-05-06 11:39:04 -0700486
Bob Lantz930138e2016-06-23 18:53:19 -0700487 def configPortForwarding( self, ports=[], action='A' ):
488 """Start or stop port forwarding (any intf) for all nodes
489 ports: list of ports to forward
Bob Lantzbb37d872016-05-16 16:26:13 -0700490 action: A=add/start, D=delete/stop (default: A)"""
Bob Lantz930138e2016-06-23 18:53:19 -0700491 self.cmd( 'iptables -' + action, 'FORWARD -d', self.ipBase,
492 '-j ACCEPT' )
Bob Lantzbb37d872016-05-16 16:26:13 -0700493 for port in ports:
494 for index, node in enumerate( self.nodes() ):
Bob Lantz57635162016-08-29 15:13:54 -0700495 ip, inport = node.IP(), port + self.portOffset + index
Bob Lantzbb37d872016-05-16 16:26:13 -0700496 # Configure a destination NAT rule
Bob Lantz930138e2016-06-23 18:53:19 -0700497 self.cmd( 'iptables -t nat -' + action,
498 'PREROUTING -t nat -p tcp --dport', inport,
499 '-j DNAT --to-destination %s:%s' % ( ip, port ) )
Bob Lantzbb37d872016-05-16 16:26:13 -0700500
Bob Lantz57635162016-08-29 15:13:54 -0700501
Bob Lantz087b5d92016-05-06 11:39:04 -0700502class ONOSSwitchMixin( object ):
503 "Mixin for switches that connect to an ONOSCluster"
504 def start( self, controllers ):
505 "Connect to ONOSCluster"
506 self.controllers = controllers
507 assert ( len( controllers ) is 1 and
Bob Lantz8e576252016-08-29 14:05:59 -0700508 isONOSCluster( controllers[ 0 ] ) )
Bob Lantz087b5d92016-05-06 11:39:04 -0700509 clist = controllers[ 0 ].nodes()
510 return super( ONOSSwitchMixin, self ).start( clist )
511
512class ONOSOVSSwitch( ONOSSwitchMixin, OVSSwitch ):
513 "OVSSwitch that can connect to an ONOSCluster"
514 pass
515
516class ONOSUserSwitch( ONOSSwitchMixin, UserSwitch):
517 "UserSwitch that can connect to an ONOSCluster"
518 pass
519
520
521### Ugly utility routines
522
523def fixIPTables():
524 "Fix LinuxBridge warning"
525 for s in 'arp', 'ip', 'ip6':
526 quietRun( 'sysctl net.bridge.bridge-nf-call-%stables=0' % s )
527
528
529### Test code
530
531def test( serverCount ):
532 "Test this setup"
533 setLogLevel( 'info' )
534 net = Mininet( topo=SingleSwitchTopo( 3 ),
535 controller=[ ONOSCluster( 'c0', serverCount ) ],
536 switch=ONOSOVSSwitch )
537 net.start()
538 net.waitConnected()
539 CLI( net )
540 net.stop()
541
542
543### CLI Extensions
544
545OldCLI = CLI
546
547class ONOSCLI( OldCLI ):
548 "CLI Extensions for ONOS"
549
550 prompt = 'mininet-onos> '
551
552 def __init__( self, net, **kwargs ):
Bob Lantz503a4022016-08-29 18:08:37 -0700553 clusters = [ c.net for c in net.controllers
554 if isONOSCluster( c ) ]
555 net = MininetFacade( net, *clusters )
Bob Lantz087b5d92016-05-06 11:39:04 -0700556 OldCLI.__init__( self, net, **kwargs )
557
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700558 def onos1( self ):
559 "Helper function: return default ONOS node"
560 return self.mn.controllers[ 0 ].net.hosts[ 0 ]
561
Bob Lantz087b5d92016-05-06 11:39:04 -0700562 def do_onos( self, line ):
563 "Send command to ONOS CLI"
564 c0 = self.mn.controllers[ 0 ]
Bob Lantz8e576252016-08-29 14:05:59 -0700565 if isONOSCluster( c0 ):
Bob Lantz087b5d92016-05-06 11:39:04 -0700566 # cmdLoop strips off command name 'onos'
567 if line.startswith( ':' ):
568 line = 'onos' + line
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700569 onos1 = self.onos1().name
570 if line:
571 line = '"%s"' % line
572 cmd = '%s client -h %s %s' % ( onos1, onos1, line )
Bob Lantz087b5d92016-05-06 11:39:04 -0700573 quietRun( 'stty -echo' )
574 self.default( cmd )
575 quietRun( 'stty echo' )
576
577 def do_wait( self, line ):
578 "Wait for switches to connect"
579 self.mn.waitConnected()
580
581 def do_balance( self, line ):
582 "Balance switch mastership"
583 self.do_onos( ':balance-masters' )
584
585 def do_log( self, line ):
Bob Lantz4b51d5c2016-05-27 14:47:38 -0700586 "Run tail -f /tmp/onos1/log; press control-C to stop"
Bob Lantz9ba19dc2016-06-13 20:22:07 -0700587 self.default( '%s tail -f /tmp/%s/log' %
588 ( self.onos1(), self.onos1() ) )
Bob Lantz087b5d92016-05-06 11:39:04 -0700589
Bob Lantz64382422016-06-03 22:51:39 -0700590 def do_status( self, line ):
591 "Return status of ONOS cluster(s)"
592 for c in self.mn.controllers:
Bob Lantz8e576252016-08-29 14:05:59 -0700593 if isONOSCluster( c ):
Bob Lantz64382422016-06-03 22:51:39 -0700594 for node in c.net.hosts:
Bob Lantz8e576252016-08-29 14:05:59 -0700595 if isONOSNode( node ):
Bob Lantz64382422016-06-03 22:51:39 -0700596 errors, warnings = node.checkLog()
597 running = ( 'Running' if node.isRunning()
598 else 'Exited' )
599 status = ''
600 if errors:
601 status += '%d ERRORS ' % len( errors )
602 if warnings:
603 status += '%d warnings' % len( warnings )
604 status = status if status else 'OK'
605 info( node, '\t', running, '\t', status, '\n' )
606
Bob Lantzc96e2582016-06-13 18:57:04 -0700607 def do_arp( self, line ):
608 "Send gratuitous arps from all data network hosts"
609 startTime = time.time()
610 try:
611 count = int( line )
612 except:
613 count = 1
614 # Technically this check should be on the host
Bob Lantzc3de5152016-06-17 17:13:57 -0700615 if '-U' not in quietRun( 'arping -h', shell=True ):
616 warn( 'Please install iputils-arping.\n' )
Bob Lantzc96e2582016-06-13 18:57:04 -0700617 return
618 # This is much faster if we do it in parallel
619 for host in self.mn.net.hosts:
620 intf = host.defaultIntf()
621 # -b: keep using broadcasts; -f: quit after 1 reply
622 # -U: gratuitous ARP update
623 host.sendCmd( 'arping -bf -c', count, '-U -I',
624 intf.name, intf.IP() )
625 for host in self.mn.net.hosts:
626 # We could check the output here if desired
627 host.waitOutput()
628 info( '.' )
629 info( '\n' )
630 elapsed = time.time() - startTime
631 debug( 'Completed in %.2f seconds\n' % elapsed )
632
Carmelo Casconec52a4b12016-10-24 16:47:17 +0200633 def onosupdown( self, cmd, instance ):
634 if not instance:
635 info( 'Provide the name of an ONOS instance.\n' )
636 return
637 c0 = self.mn.controllers[ 0 ]
638 if isONOSCluster( c0 ):
639 try:
640 onos = self.mn.controllers[ 0 ].net.getNodeByName( instance )
641 if isONOSNode( onos ):
642 info('Bringing %s %s...\n' % ( instance, cmd ) )
643 if cmd == 'up':
644 onos.intfsUp()
645 else:
646 onos.intfsDown()
647 except KeyError:
648 info( 'No such ONOS instance %s.\n' % instance )
649
650 def do_onosdown( self, instance=None ):
651 """Disconnects an ONOS instance from the network"""
652 self.onosupdown( 'down', instance )
653
654 def do_onosup( self, instance=None ):
655 """"Connects an ONOS instance to the network"""
656 self.onosupdown( 'up', instance )
657
Bob Lantz64382422016-06-03 22:51:39 -0700658
659# For interactive use, exit on error
660exitOnError = dict( nodeOpts={ 'alertAction': 'exit' } )
661ONOSClusterInteractive = specialClass( ONOSCluster, defaults=exitOnError )
662
Bob Lantz087b5d92016-05-06 11:39:04 -0700663
664### Exports for bin/mn
665
666CLI = ONOSCLI
Bob Lantz64382422016-06-03 22:51:39 -0700667controllers = { 'onos': ONOSClusterInteractive,
668 'default': ONOSClusterInteractive }
Bob Lantz087b5d92016-05-06 11:39:04 -0700669
670# XXX Hack to change default controller as above doesn't work
Bob Lantz64382422016-06-03 22:51:39 -0700671findController = lambda: controllers[ 'default' ]
Bob Lantz087b5d92016-05-06 11:39:04 -0700672
673switches = { 'onos': ONOSOVSSwitch,
674 'onosovs': ONOSOVSSwitch,
675 'onosuser': ONOSUserSwitch,
676 'default': ONOSOVSSwitch }
677
Bob Lantzbb37d872016-05-16 16:26:13 -0700678# Null topology so we can control an external/hardware network
679topos = { 'none': Topo }
680
Bob Lantz087b5d92016-05-06 11:39:04 -0700681if __name__ == '__main__':
682 if len( argv ) != 2:
683 test( 3 )
684 else:
685 test( int( argv[ 1 ] ) )