blob: ea93896aa2d9159ef9d45cc653ce2f5947cbbd2e [file] [log] [blame]
Bob Lantzc7c05402013-12-16 21:22:12 -08001#!/usr/bin/env python
2
3"""
Bob Lantz7ead0532013-12-17 20:41:20 -08004onos.py: A basic (?) ONOS Controller() subclass for Mininet
Bob Lantzc7c05402013-12-16 21:22:12 -08005
6We implement the following classes:
7
8ONOSController: a custom Controller() subclass to start ONOS
9OVSSwitchONOS: a custom OVSSwitch() switch that connects to multiple controllers.
10
Bob Lantz63bbe4c2014-02-06 19:29:55 -080011We use single Zookeeper and Ramcloud instances for now.
Bob Lantzc7c05402013-12-16 21:22:12 -080012
13As a custom file, exports:
14
15--controller onos
16--switch ovso
17
18Usage:
19
Bob Lantz21b41f62013-12-18 18:16:38 -080020$ sudo -E ./onos.py
Bob Lantzc7c05402013-12-16 21:22:12 -080021
22This will start up a simple 2-host, 2 ONOS network
23
Bob Lantz21b41f62013-12-18 18:16:38 -080024$ sudo -E mn --custom onos.py --controller onos,2 --switch ovso
Bob Lantzc7c05402013-12-16 21:22:12 -080025"""
26
Bob Lantz63bbe4c2014-02-06 19:29:55 -080027from mininet.node import Controller, OVSSwitch, CPULimitedHost, RemoteController
Bob Lantzc7c05402013-12-16 21:22:12 -080028from mininet.net import Mininet
29from mininet.cli import CLI
Bob Lantz7ead0532013-12-17 20:41:20 -080030from mininet.topo import LinearTopo
31from mininet.log import setLogLevel, info, warn
Bob Lantz63bbe4c2014-02-06 19:29:55 -080032from mininet.util import quietRun, numCores
Bob Lantzc7c05402013-12-16 21:22:12 -080033
Bob Lantza0930822013-12-17 21:00:41 -080034# This should be cleaned up to avoid interfering with mn
Bob Lantzc7c05402013-12-16 21:22:12 -080035from shutil import copyfile
Bob Lantz21b41f62013-12-18 18:16:38 -080036from os import environ, path
Bob Lantzc7c05402013-12-16 21:22:12 -080037from functools import partial
Bob Lantza0930822013-12-17 21:00:41 -080038import time
Bob Lantz7ead0532013-12-17 20:41:20 -080039from sys import argv
Bob Lantz63bbe4c2014-02-06 19:29:55 -080040from time import sleep
Bob Lantzc7c05402013-12-16 21:22:12 -080041
42class ONOS( Controller ):
43 "Custom controller class for ONOS"
44
45 # Directories and configuration templates
46 home = environ[ 'HOME' ]
47 onosDir = home + "/ONOS"
48 zookeeperDir = home + "/zookeeper-3.4.5"
49 dirBase = '/tmp'
Bob Lantz63bbe4c2014-02-06 19:29:55 -080050 logDir = dirBase + '/onos-logs'
Bob Lantz4ed6cff2013-12-17 21:43:36 -080051 logbackFile = dirBase + '/onos-%s.logback.xml'
Bob Lantz7ead0532013-12-17 20:41:20 -080052
Bob Lantz7ead0532013-12-17 20:41:20 -080053 # Additions for reactive forwarding
54 reactiveModules = (
Jonathan Hart0961fe82014-04-03 09:56:25 -070055 'net.onrc.onos.apps.proxyarp.ProxyArpManager',
Jonathan Hart51f6f5b2014-04-03 10:32:10 -070056 'net.onrc.onos.core.main.config.DefaultConfiguration',
Jonathan Hart0961fe82014-04-03 09:56:25 -070057 'net.onrc.onos.apps.forwarding.Forwarding'
Bob Lantz7ead0532013-12-17 20:41:20 -080058 )
59
60 # Module parameters
Bob Lantzc7c05402013-12-16 21:22:12 -080061 ofbase = 6633
Bob Lantz7ead0532013-12-17 20:41:20 -080062 restbase = 8080
63 jmxbase = 7189
Naoki Shiotad8ea71a2014-04-23 17:04:51 -070064 hcbase = 5701
Bob Lantzc7c05402013-12-16 21:22:12 -080065
Bob Lantzc7c05402013-12-16 21:22:12 -080066 fc = 'net.floodlightcontroller.'
Bob Lantzc7c05402013-12-16 21:22:12 -080067
Bob Lantz21b41f62013-12-18 18:16:38 -080068 # Things that vary per ONOS id
Bob Lantz7ead0532013-12-17 20:41:20 -080069 perNodeConfigBase = {
70 fc + 'core.FloodlightProvider.openflowport': ofbase,
71 fc + 'restserver.RestApiServer.port': restbase,
72 fc + 'core.FloodlightProvider.controllerid': 0
73 }
74
Bob Lantz7ead0532013-12-17 20:41:20 -080075 proctag = 'mn-onos-id'
Bob Lantzc7c05402013-12-16 21:22:12 -080076
Bob Lantz63bbe4c2014-02-06 19:29:55 -080077 # List of scripts that we need/use
Naoki Shiotabe433a12014-04-07 12:03:49 -070078 scripts = ( 'onos.sh', 'start-rest.sh' )
Bob Lantz63bbe4c2014-02-06 19:29:55 -080079
Bob Lantz7ead0532013-12-17 20:41:20 -080080 def __init__( self, name, n=1, reactive=True, runAsRoot=False, **params):
Bob Lantzc7c05402013-12-16 21:22:12 -080081 """n: number of ONOS instances to run (1)
Bob Lantz7ead0532013-12-17 20:41:20 -080082 reactive: run in reactive mode (True)
83 runAsRoot: run ONOS as root (False)"""
Bob Lantzc7c05402013-12-16 21:22:12 -080084 self.check()
Bob Lantzc7c05402013-12-16 21:22:12 -080085 self.count = n
Bob Lantz7ead0532013-12-17 20:41:20 -080086 self.reactive = reactive
87 self.runAsRoot = runAsRoot
Bob Lantzc7c05402013-12-16 21:22:12 -080088 self.ids = range( 0, self.count )
89 Controller.__init__( self, name, **params )
Bob Lantz63bbe4c2014-02-06 19:29:55 -080090 self.proxies = []
Bob Lantzc7c05402013-12-16 21:22:12 -080091 # We don't need to run as root, and it can interfere
92 # with starting Zookeeper manually
Bob Lantz7ead0532013-12-17 20:41:20 -080093 self.user = None
94 if not self.runAsRoot:
95 try:
96 self.user = quietRun( 'who am i' ).split()[ 0 ]
97 self.sendCmd( 'su', self.user )
98 self.waiting = False
99 except:
100 warn( '__init__: failed to drop privileges\n' )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800101 self.cmd( 'mkdir -p', self.logDir )
Bob Lantzc7c05402013-12-16 21:22:12 -0800102 # Need to run commands from ONOS dir
103 self.cmd( 'cd', self.onosDir )
104 self.cmd( 'export PATH=$PATH:%s' % self.onosDir )
Bob Lantzc7c05402013-12-16 21:22:12 -0800105
106 def check( self ):
Bob Lantz21b41f62013-12-18 18:16:38 -0800107 "Set onosDir and check for ONOS prerequisites"
Bob Lantzc7c05402013-12-16 21:22:12 -0800108 if not quietRun( 'which java' ):
109 raise Exception( 'java not found -'
110 ' make sure it is installed and in $PATH' )
Bob Lantz21b41f62013-12-18 18:16:38 -0800111 if 'ONOS_HOME' in environ:
112 self.onosDir = environ[ 'ONOS_HOME' ]
113 else:
114 warn( '* $ONOS_HOME is not set - assuming %s\n' % self.onosDir )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800115 for script in self.scripts:
Bob Lantz21b41f62013-12-18 18:16:38 -0800116 script = path.join( self.onosDir, script )
117 if not path.exists( script ):
118 msg = '%s not found' % script
119 if 'ONOS_HOME' not in environ:
120 msg += ' (try setting $ONOS_HOME and/or sudo -E)'
121 raise Exception( msg )
Bob Lantz7ead0532013-12-17 20:41:20 -0800122
123 def waitNetstat( self, pid ):
124 """Wait for pid to show up in netstat
125 We assume that once a process is listening on some
126 port, it is ready to go!"""
127 while True:
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800128 output = self.cmd( 'sudo netstat -natup | grep %s/' % pid )
Bob Lantz7ead0532013-12-17 20:41:20 -0800129 if output:
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800130 break
Bob Lantz7ead0532013-12-17 20:41:20 -0800131 info( '.' )
Bob Lantza0930822013-12-17 21:00:41 -0800132 time.sleep( 1 )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800133 info( '\n* Process %d is listening\n' % pid )
Bob Lantz7ead0532013-12-17 20:41:20 -0800134
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800135 def waitStart( self, procname, pattern, maxWait=10 ):
136 "Wait for proces to start up and be visible to pgrep"
Bob Lantz21b41f62013-12-18 18:16:38 -0800137 # Check script exit code
138 exitCode = int( self.cmd( 'echo $?' ) )
139 if exitCode != 0:
140 raise Exception( '%s startup failed with code %d' %
141 ( procname, exitCode ) )
Bob Lantz7ead0532013-12-17 20:41:20 -0800142 info( '* Waiting for %s startup' % procname )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800143 while True:
144 result = self.cmd( 'pgrep -f %s' % pattern )
145 if result:
146 break
147 info( '.' )
148 sleep( 1 )
149 pid = int( result.split()[ 0 ] )
150 return pid
Bob Lantz7ead0532013-12-17 20:41:20 -0800151
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800152 def startRamcloud( self, cpu=.6 ):
153 """Start Ramcloud
154 cpu: CPU usage limit (in seconds/s)"""
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800155 # Create a cgroup so Ramcloud doesn't eat all of our CPU
156 ramcloud = CPULimitedHost( 'ramcloud', inNamespace=False, period_us=5000 )
157 ramcloud.setCPUFrac( cpu / numCores() )
Naoki Shiotaac74d912014-04-25 12:01:55 -0700158 info( '\n' )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800159 ramcloud.cmd( 'export PATH=%s:$PATH' % self.onosDir )
160 ramcloud.cmd( 'export ONOS_LOGDIR=%s' % self.logDir )
Naoki Shiotabe433a12014-04-07 12:03:49 -0700161 for daemon in 'coord', 'server':
162 ramcloud.cmd( 'onos.sh rc-%s start' % daemon )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800163 pid = self.waitStart( 'Ramcloud %s' % daemon, 'obj.master/' + daemon )
164 self.waitNetstat( pid )
Naoki Shiotabe433a12014-04-07 12:03:49 -0700165 status = self.cmd( 'onos.sh rc-%s.sh status' % daemon )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800166 if 'running' not in status:
167 raise Exception( 'Ramcloud %s startup failed: ' % daemon + status )
168 self.ramcloud = ramcloud
Bob Lantzc7c05402013-12-16 21:22:12 -0800169
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800170 def stopRamcloud( self ):
171 "Stop Ramcloud"
Naoki Shiotabe433a12014-04-07 12:03:49 -0700172 for daemon in 'coord', 'server':
Naoki Shiotaac74d912014-04-25 12:01:55 -0700173 self.ramcloud.cmd( 'onos.sh rc-%s stop' % daemon )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800174 self.ramcloud.terminate()
Bob Lantzc7c05402013-12-16 21:22:12 -0800175
176 def startZookeeper( self, initcfg=True ):
177 "Start Zookeeper"
Naoki Shiotabe433a12014-04-07 12:03:49 -0700178 self.cmd( 'onos.sh zk start' )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800179 pid = self.waitStart( 'Zookeeper', 'zookeeper' )
180 self.waitNetstat( pid )
Naoki Shiotabe433a12014-04-07 12:03:49 -0700181 status = self.cmd( 'onos.sh zk status' )
Bob Lantzc7c05402013-12-16 21:22:12 -0800182 if 'Error' in status:
183 raise Exception( 'Zookeeper startup failed: ' + status )
184
185 def stopZookeeper( self ):
186 "Stop Zookeeper"
Naoki Shiotabe433a12014-04-07 12:03:49 -0700187 self.cmd( 'onos.sh zk stop' )
Bob Lantzc7c05402013-12-16 21:22:12 -0800188
Naoki Shiotad8ea71a2014-04-23 17:04:51 -0700189 def getPropsFilename( self, id, path ):
190 return path + '/onos-%s.properties' % id
191
Bob Lantz7ead0532013-12-17 20:41:20 -0800192 def genProperties( self, id, path='/tmp' ):
Bob Lantz42543db2014-02-24 16:07:34 -0800193 "Generate ONOS properties file and return its full pathname"
194 defaultProps = self.onosDir + '/conf/onos.properties'
Naoki Shiotad8ea71a2014-04-23 17:04:51 -0700195 propsFile = self.getPropsFilename( id, path )
Bob Lantz42543db2014-02-24 16:07:34 -0800196 with open( propsFile, 'w' ) as f:
197 with open( defaultProps ) as d:
198 for line in d.readlines():
199 prop = line.split( ' ' )[ 0 ]
200 val = self.perNodeConfigBase.get( prop, None )
201 if val:
202 # Write updated property
203 f.write( '%s = %s\n' % ( prop, val + id) )
204 else:
205 # Write original property
206 f.write( line )
207 if prop == 'floodlight.modules' and ',\\' in line:
208 if self.reactive:
209 # Insert reactive modules into list
210 for module in self.reactiveModules:
211 f.write( '%s,\\\n' % module )
212 return propsFile
Bob Lantz7ead0532013-12-17 20:41:20 -0800213
Naoki Shiotad8ea71a2014-04-23 17:04:51 -0700214 def getConfsFilename( self, id, path ):
215 return path + '/onos-%s.conf' % id
216
217 def genConfig( self, id, path='/tmp' ):
218 "Generate ONOS node config file and return its full pathname"
219 confsFile = self.getConfsFilename( id, path )
220 with open( confsFile, 'w' ) as f:
221 f.write( 'host.ip = 127.0.0.1\n' )
222 f.write( 'host.backend = ramcloud\n' )
223 f.write( 'hazelcast.host.port = %s\n' % ( self.hcbase + 10 * id ) )
224 return confsFile
225
226 def setVarsGlobal( self, path='/tmp'):
227 logdir = self.logDir
228 self.cmd( 'export ONOS_LOGDIR=%s' % logdir )
229 self.cmd( 'export ZK_LOG_DIR=%s' % logdir )
230
231 def setVarsLocal( self, id, path='/tmp' ):
Bob Lantz7ead0532013-12-17 20:41:20 -0800232 """Set and return environment vars
233 id: ONOS instance number
234 propsFile: properties file name"""
Bob Lantzc7c05402013-12-16 21:22:12 -0800235 logback = self.logbackFile % id
236 jmxport = self.jmxbase + id
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800237 logdir = self.logDir
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800238 self.cmd( 'export ONOS_LOGBASE=onos-%d.`hostname`' % id)
Bob Lantzc7c05402013-12-16 21:22:12 -0800239 self.cmd( 'export ONOS_LOGBACK="%s"' % logback )
240 self.cmd( 'export JMX_PORT=%s' % jmxport )
Bob Lantz7ead0532013-12-17 20:41:20 -0800241 self.cmd( 'export JVM_OPTS="-D%s=%s"' % (
242 self.proctag, id ) )
Naoki Shiotad8ea71a2014-04-23 17:04:51 -0700243 propsFile = self.getPropsFilename( id, path )
Bob Lantz7ead0532013-12-17 20:41:20 -0800244 self.cmd( 'export ONOS_PROPS="%s"' % propsFile )
Naoki Shiotad8ea71a2014-04-23 17:04:51 -0700245 confsFile = self.getConfsFilename( id, path )
246 self.cmd( 'export ONOS_CONF="%s"' % confsFile )
247 self.cmd( 'export HC_CONF="%s/hazelcast.%s.conf"' % ( path, id ) )
Bob Lantzc7c05402013-12-16 21:22:12 -0800248
Naoki Shiotad8ea71a2014-04-23 17:04:51 -0700249 def setupONOS (self, id):
250 propsFile = self.genProperties( id )
251 confFile = self.genConfig( id )
252 self.setVarsLocal( id )
253 self.cmd( 'onos.sh setup -f' )
254
Bob Lantzc7c05402013-12-16 21:22:12 -0800255 def startONOS( self, id ):
256 """Start ONOS
Bob Lantz7ead0532013-12-17 20:41:20 -0800257 id: new instance number"""
Bob Lantza0930822013-12-17 21:00:41 -0800258 start = time.time()
Naoki Shiotad8ea71a2014-04-23 17:04:51 -0700259 self.setVarsLocal( id )
Bob Lantz7ead0532013-12-17 20:41:20 -0800260 self.stopONOS( id )
Naoki Shiotabe433a12014-04-07 12:03:49 -0700261 self.cmd( 'onos.sh core startnokill' )
Naoki Shiotaac74d912014-04-25 12:01:55 -0700262 # onos.sh waits for ONOS startup
Bob Lantza0930822013-12-17 21:00:41 -0800263 elapsed = time.time() - start
Bob Lantz7ead0532013-12-17 20:41:20 -0800264 info( '* ONOS %s started in %.2f seconds\n' % ( id, elapsed ) )
Bob Lantzc7c05402013-12-16 21:22:12 -0800265
266 def stopONOS( self, id ):
267 """Shut down ONOS
268 id: identifier for instance"""
269 pid = self.cmd( "jps -v | grep %s=%s | awk '{print $1}'" %
270 ( self.proctag, id ) ).strip()
271 if pid:
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800272 self.cmd( 'kill', pid )
Bob Lantzc7c05402013-12-16 21:22:12 -0800273
274 def start( self, *args ):
275 "Start ONOS instances"
Naoki Shiotad8ea71a2014-04-23 17:04:51 -0700276 self.setVarsGlobal()
277 # TODO: use onos-cluster.sh to setup/start/stop ONOS cluster
278 for id in self.ids:
279 info( '* Setting up ONOS %s\n' % id )
280 self.setupONOS( id )
Bob Lantzc7c05402013-12-16 21:22:12 -0800281 info( '* Starting Zookeeper\n' )
282 self.startZookeeper()
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800283 info( '* Starting Ramcloud\n' )
284 self.startRamcloud()
Bob Lantzc7c05402013-12-16 21:22:12 -0800285 for id in self.ids:
286 info( '* Starting ONOS %s\n' % id )
287 self.startONOS( id )
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800288 self.cmd( 'start-rest.sh start' )
289 # Initialize proxies for clist()
290 self.proxies = [ RemoteController( 'onos-%d' % id, port=(self.ofbase + id ) )
291 for id in range( 0, self.count ) ]
Bob Lantzc7c05402013-12-16 21:22:12 -0800292
293 def stop( self, *args ):
294 "Stop ONOS instances"
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800295 self.cmd( 'start-rest.sh stop' )
Bob Lantzc7c05402013-12-16 21:22:12 -0800296 for id in self.ids:
297 info( '* Stopping ONOS %s\n' % id )
298 self.stopONOS( id )
Bob Lantz7ead0532013-12-17 20:41:20 -0800299 info( '* Stopping Zookeeper\n' )
Bob Lantzc7c05402013-12-16 21:22:12 -0800300 self.stopZookeeper()
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800301 info( '* Stopping Ramcloud\n' )
302 self.stopRamcloud()
303 for p in self.proxies:
304 p.stop()
305 p.proxies = []
Bob Lantzc7c05402013-12-16 21:22:12 -0800306
307 def clist( self ):
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800308 "Return list of Controller proxies for this ONOS cluster"
309 return self.proxies
Bob Lantzc7c05402013-12-16 21:22:12 -0800310
311
312class OVSSwitchONOS( OVSSwitch ):
313 "OVS switch which connects to multiple controllers"
314 def start( self, controllers ):
Bob Lantzc7c05402013-12-16 21:22:12 -0800315 assert len( controllers ) == 1
316 c0 = controllers[ 0 ]
317 assert type( c0 ) == ONOS
Bob Lantz63bbe4c2014-02-06 19:29:55 -0800318 controllers = c0.clist()
319 OVSSwitch.start( self, controllers )
Bob Lantzc7c05402013-12-16 21:22:12 -0800320
321
Bob Lantz7ead0532013-12-17 20:41:20 -0800322def waitConnected( switches ):
323 "Wait until all switches connect to controllers"
Bob Lantza0930822013-12-17 21:00:41 -0800324 start = time.time()
Bob Lantz7ead0532013-12-17 20:41:20 -0800325 info( '* Waiting for switches to connect...\n' )
326 for s in switches:
327 info( s )
328 while not s.connected():
329 info( '.' )
Bob Lantza0930822013-12-17 21:00:41 -0800330 time.sleep( 1 )
Bob Lantz7ead0532013-12-17 20:41:20 -0800331 info( ' ' )
Bob Lantza0930822013-12-17 21:00:41 -0800332 elapsed = time.time() - start
Bob Lantz7ead0532013-12-17 20:41:20 -0800333 info( '\n* Connected in %.2f seconds\n' % elapsed )
334
335
Bob Lantzc7c05402013-12-16 21:22:12 -0800336controllers = { 'onos': ONOS }
337switches = { 'ovso': OVSSwitchONOS }
338
339
340if __name__ == '__main__':
Bob Lantz7ead0532013-12-17 20:41:20 -0800341 # Simple test for ONOS() controller class
Bob Lantzc7c05402013-12-16 21:22:12 -0800342 setLogLevel( 'info' )
Bob Lantz7ead0532013-12-17 20:41:20 -0800343 size = 2 if len( argv ) != 2 else int( argv[ 1 ] )
344 net = Mininet( topo=LinearTopo( size ),
Bob Lantzc7c05402013-12-16 21:22:12 -0800345 controller=partial( ONOS, n=2 ),
346 switch=OVSSwitchONOS )
347 net.start()
Bob Lantz7ead0532013-12-17 20:41:20 -0800348 waitConnected( net.switches )
Bob Lantzc7c05402013-12-16 21:22:12 -0800349 CLI( net )
350 net.stop()