2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 INRIA
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19 # Alexandros Kouvakas <alexandros.kouvakas@inria.fr>
22 from nepi.execution.resource import ResourceManager, clsinit_copy, \
24 from nepi.execution.attribute import Attribute, Flags
25 from nepi.resources.planetlab.node import PlanetlabNode
26 from nepi.resources.linux.application import LinuxApplication
29 reschedule_delay = "0.5s"
32 class OVSWitch(LinuxApplication):
35 _help = "Runs an OpenVSwitch on a PlanetLab host"
36 _backend = "planetlab"
38 _authorized_connections = ["PlanetlabNode", "OVSPort", "LinuxNode"]
41 def _register_attributes(cls):
42 """ Register the attributes of OVSWitch RM
45 bridge_name = Attribute("bridge_name", "Name of the switch/bridge",
46 flags = Flags.ExecReadOnly)
47 virtual_ip_pref = Attribute("virtual_ip_pref", "Virtual IP/PREFIX of the switch",
48 flags = Flags.ExecReadOnly)
49 controller_ip = Attribute("controller_ip", "IP of the controller",
50 flags = Flags.ExecReadOnly)
51 controller_port = Attribute("controller_port", "Port of the controller",
52 flags = Flags.ExecReadOnly)
54 cls._register_attribute(bridge_name)
55 cls._register_attribute(virtual_ip_pref)
56 cls._register_attribute(controller_ip)
57 cls._register_attribute(controller_port)
59 def __init__(self, ec, guid):
61 :param ec: The Experiment controller
62 :type ec: ExperimentController
63 :param guid: guid of the RM
67 super(OVSWitch, self).__init__(ec, guid)
70 self._home = "ovswitch-%s" % self.guid
71 self._checks = "ovsChecks-%s" % self.guid
75 node = self.get_connected(PlanetlabNode.rtype())
76 if node: return node[0]
81 return os.path.join(self.node.exp_home, self._home)
85 return os.path.join(self.ovs_home, self._checks)
95 # def valid_connection(self, guid):
96 # """ Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.
98 # :param guid: Guid of the current RM
103 # rm = self.ec.get_resource(guid)
104 # if rm.rtype() in self._authorized_connections:
105 # msg = "Connection between %s %s and %s %s accepted" % \
106 # (self.rtype(), self._guid, rm.rtype(), guid)
109 # msg = "Connection between %s %s and %s %s refused" % \
110 # (self.rtype(), self._guid, rm.rtype(), guid)
114 def valid_connection(self, guid):
118 def do_provision(self):
119 # create home dir for ovs
120 self.node.mkdir(self.ovs_home)
121 # create dir for ovs checks
122 self.node.mkdir(self.ovs_checks)
124 super(OVSWitch, self).do_provision()
126 def check_sliver_ovs(self):
127 """ Check if sliver-ovs exists. If it does not exist, we interrupt
128 the execution immediately.
130 cmd = "compgen -c | grep sliver-ovs"
133 (out,err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
134 shfile = "check_cmd.sh",
135 pidfile = "check_cmd_pidfile",
136 ecodefile = "check_cmd_exitcode",
138 stdout = "check_cmd_stdout",
139 stderr = "check_cmd_stderr")
141 (out, err), proc = self.node.check_output(self.ovs_checks, 'check_cmd_exitcode')
144 msg = "Command sliver-ovs does not exist on the VM"
146 raise RuntimeError, msg
148 msg = "Command sliver-ovs exists"
152 """ Wait until node is associated and deployed
155 if not node or node.state < ResourceState.READY:
156 #self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
157 self.ec.schedule(reschedule_delay, self.deploy)
162 self.check_sliver_ovs()
165 self.assign_controller()
168 super(OVSWitch, self).do_deploy()
170 def servers_on(self):
171 """ Start the openvswitch servers and also checking
172 if they started successfully
174 self.info("Starting the OVSWitch servers")
175 command = ("sliver-ovs start")
178 (out, err), proc = self.node.run_and_wait(command, self.ovs_checks,
179 shfile = "start_srv.sh",
180 pidfile = "start_srv_pidfile",
181 ecodefile = "start_srv_exitcode",
183 raise_on_error = True,
184 stdout = "start_srv_stdout",
185 stderr = "start_srv_stderr")
187 (out, err), proc = self.node.check_output(self.ovs_checks, 'start_srv_exitcode')
190 self.debug("Servers have not started")
191 raise RuntimeError, msg
193 cmd = "ps -A | grep ovsdb-server"
195 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
196 shfile = "status_srv.sh",
197 pidfile = "status_srv_pidfile",
198 ecodefile = "status_srv_exitcode",
200 stdout = "status_srv_stdout",
201 stderr = "status_srv_stderr")
203 # Check if the servers are running or not
204 (out, err), proc = self.node.check_output(self.ovs_checks, 'status_srv_exitcode')
207 self.debug("Servers are not running")
208 raise RuntimeError, msg
210 self.info("Servers started")
212 def del_old_br(self):
213 # TODO: Delete old bridges that might exist maybe by adding atribute
214 """ With ovs-vsctl list-br
218 def create_bridge(self):
219 """ Create the bridge/switch and we check if we have any
220 error during the SSH connection
222 # TODO: Add check for virtual_ip belonging to vsys_tag
225 if not (self.get("bridge_name") and self.get("virtual_ip_pref")):
226 msg = "No assignment in one or both attributes"
228 self.debug("Bridge name is %s and virtual_ip_pref is %s" %\
229 (self.get("bridge_name"), self.get("virtual_ip_pref")) )
230 raise AttributeError, msg
232 bridge_name = self.get("bridge_name")
233 virtual_ip_pref = self.get("virtual_ip_pref")
234 self.info(" Creating the bridge %s and assigning %s" %\
235 (bridge_name, virtual_ip_pref) )
236 cmd = "sliver-ovs create-bridge '%s' '%s'" %\
237 (bridge_name, virtual_ip_pref)
239 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
240 shfile = "create_br.sh",
241 pidfile = "create_br_pidfile",
242 ecodefile = "create_br_exitcode",
244 stdout = "create_br_stdout",
245 stderr = "create_br_stderr")
247 (out, err), proc = self.node.check_output(self.ovs_checks, 'create_br_exitcode')
249 msg = "No such pltap netdev\novs-appctl: ovs-vswitchd: server returned an error"
250 self.debug("Check again the virtual IP")
251 raise RuntimeError, msg
253 self.info("Bridge %s created" % bridge_name)
256 def assign_controller(self):
257 """ Set the controller IP
259 if self.get("controller_ip") and self.get("controller_port"):
260 controller_ip = self.get("controller_ip")
261 controller_port = self.get("controller_port")
262 self.info("Assigning the controller to the %s" % self.get("bridge_name"))
263 cmd = "ovs-vsctl set-controller %s tcp:%s:%s" %\
264 (self.get("bridge_name"), controller_ip, controller_port)
266 (out, err), proc = self.node.run(cmd, self.ovs_checks,
271 self.debug("SSH connection refusing in assign_contr")
272 raise RuntimeError, msg
273 self.info("Controller assigned")
275 def ovs_status(self):
276 """ Print the status of the created bridge
278 cmd = "sliver-ovs show | tail -n +2"
280 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_home,
282 stdout = "show_stdout",
283 stderr = "show_stderr")
284 (out, err), proc = self.node.check_output(self.ovs_home, 'show_stdout')
287 def do_release(self):
288 """ Delete the bridge and
291 # Node needs to wait until all associated RMs are released
293 from nepi.resources.planetlab.openvswitch.ovsport import OVSPort
294 rm = self.get_connected(OVSPort.rtype())
296 if rm[0].state < ResourceState.FINISHED:
297 self.ec.schedule(reschedule_delay, self.release)
300 msg = "Deleting the bridge %s" % self.get('bridge_name')
302 cmd = "sliver-ovs del-bridge %s" % self.get('bridge_name')
303 (out, err), proc = self.node.run(cmd, self.ovs_checks,
305 cmd = "sliver-ovs stop"
306 (out, err), proc = self.node.run(cmd, self.ovs_checks,
310 self.error(msg, out, err)
311 raise RuntimeError, msg
313 super(OVSWitch, self).do_release()