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 OVSSwitch(LinuxApplication):
34 .. class:: Class Args :
36 :param ec: The Experiment controller
37 :type ec: ExperimentController
38 :param guid: guid of the RM
44 _help = "Runs an OpenVSwitch on a PlanetLab host"
45 _backend = "planetlab"
47 _authorized_connections = ["PlanetlabNode", "OVSPort", "LinuxNode"]
50 def _register_attributes(cls):
51 """ Register the attributes of OVSSwitch RM
54 bridge_name = Attribute("bridge_name", "Name of the switch/bridge",
55 flags = Flags.ExecReadOnly)
56 virtual_ip_pref = Attribute("virtual_ip_pref", "Virtual IP/PREFIX of the switch",
57 flags = Flags.ExecReadOnly)
58 controller_ip = Attribute("controller_ip", "IP of the controller",
59 flags = Flags.ExecReadOnly)
60 controller_port = Attribute("controller_port", "Port of the controller",
61 flags = Flags.ExecReadOnly)
63 cls._register_attribute(bridge_name)
64 cls._register_attribute(virtual_ip_pref)
65 cls._register_attribute(controller_ip)
66 cls._register_attribute(controller_port)
68 def __init__(self, ec, guid):
70 :param ec: The Experiment controller
71 :type ec: ExperimentController
72 :param guid: guid of the RM
76 super(OVSSwitch, self).__init__(ec, guid)
77 self._home = "ovsswitch-%s" % self.guid
78 self._checks = "ovsChecks-%s" % self.guid
82 """ Node wthat run the switch
84 node = self.get_connected(PlanetlabNode.get_rtype())
85 if node: return node[0]
88 def log_message(self, msg):
89 return " guid %d - OVSSwitch - %s " % (self.guid, msg)
93 return os.path.join(self.node.exp_home, self._home)
97 return os.path.join(self.ovs_home, self._checks)
99 def valid_connection(self, guid):
100 """ Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.
102 :param guid: Guid of the current RM
107 rm = self.ec.get_resource(guid)
108 if rm.get_rtype() in self._authorized_connections:
109 msg = "Connection between %s %s and %s %s accepted" % \
110 (self.get_rtype(), self._guid, rm.get_rtype(), guid)
113 msg = "Connection between %s %s and %s %s refused" % \
114 (self.get_rtype(), self._guid, rm.get_rtype(), guid)
118 def do_provision(self):
119 """ Create the different OVS folder.
122 # create home dir for ovs
123 self.node.mkdir(self.ovs_home)
124 # create dir for ovs checks
125 self.node.mkdir(self.ovs_checks)
127 super(OVSSwitch, self).do_provision()
130 """ Deploy the OVS Switch : Turn on the server, create the bridges
131 and assign the controller
134 if not self.node or self.node.state < ResourceState.READY:
135 self.ec.schedule(reschedule_delay, self.deploy)
141 self.check_sliver_ovs()
144 self.assign_controller()
147 super(OVSSwitch, self).do_deploy()
149 def check_sliver_ovs(self):
150 """ Check if sliver-ovs exists. If it does not exist, the execution is stopped
153 cmd = "compgen -c | grep sliver-ovs"
156 (out,err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
157 shfile = "check_cmd.sh",
158 pidfile = "check_cmd_pidfile",
159 ecodefile = "check_cmd_exitcode",
161 stdout = "check_cmd_stdout",
162 stderr = "check_cmd_stderr")
164 (out, err), proc = self.node.check_output(self.ovs_checks, 'check_cmd_exitcode')
167 msg = "Command sliver-ovs does not exist on the VM"
169 raise RuntimeError, msg
171 msg = "Command sliver-ovs exists"
174 def servers_on(self):
175 """ Start the openvswitch servers and check it
179 command = "sliver-ovs start"
181 (out, err), proc = self.node.run_and_wait(command, self.ovs_checks,
182 shfile = "start_srv.sh",
183 pidfile = "start_srv_pidfile",
184 ecodefile = "start_srv_exitcode",
186 raise_on_error = True,
187 stdout = "start_srv_stdout",
188 stderr = "start_srv_stderr")
189 (out, err), proc = self.node.check_output(self.ovs_checks, 'start_srv_exitcode')
192 self.error("Servers have not started")
193 raise RuntimeError, msg
195 # Check if the servers are running or not
196 cmd = "ps -A | grep ovsdb-server"
198 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
199 shfile = "status_srv.sh",
200 pidfile = "status_srv_pidfile",
201 ecodefile = "status_srv_exitcode",
203 stdout = "status_srv_stdout",
204 stderr = "status_srv_stderr")
205 (out, err), proc = self.node.check_output(self.ovs_checks, 'status_srv_exitcode')
208 msg = "Servers are not running"
210 raise RuntimeError, msg
212 self.info("Server OVS Started Correctly")
214 def create_bridge(self):
215 """ Create the bridge/switch and check error during SSH connection
217 # TODO: Check if previous bridge exist and delete them. Use ovs-vsctl list-br
218 # TODO: Add check for virtual_ip belonging to vsys_tag
221 if not (self.get("bridge_name") and self.get("virtual_ip_pref")):
222 msg = "No assignment in one or both attributes"
224 raise AttributeError, msg
226 cmd = "sliver-ovs create-bridge '%s' '%s'" %\
227 (self.get("bridge_name"), self.get("virtual_ip_pref"))
229 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
230 shfile = "create_br.sh",
231 pidfile = "create_br_pidfile",
232 ecodefile = "create_br_exitcode",
234 stdout = "create_br_stdout",
235 stderr = "create_br_stderr")
236 (out, err), proc = self.node.check_output(self.ovs_checks, 'create_br_exitcode')
239 msg = "No such pltap netdev\novs-appctl: ovs-vswitchd: server returned an error"
241 raise RuntimeError, msg
243 self.info(" Bridge %s Created and Assigned to %s" %\
244 (self.get("bridge_name"), self.get("virtual_ip_pref")) )
247 def assign_controller(self):
248 """ Set the controller IP
251 if not (self.get("controller_ip") and self.get("controller_port")):
252 msg = "No assignment in one or both attributes"
254 raise AttributeError, msg
256 cmd = "ovs-vsctl set-controller %s tcp:%s:%s" %\
257 (self.get("bridge_name"), self.get("controller_ip"), self.get("controller_port"))
259 (out, err), proc = self.node.run(cmd, self.ovs_checks,
265 msg = "SSH connection in the method assign_controller"
267 raise RuntimeError, msg
269 self.info("Controller assigned to the bridge %s" % self.get("bridge_name"))
271 def ovs_status(self):
272 """ Print the status of the bridge
275 cmd = "sliver-ovs show | tail -n +2"
277 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_home,
279 stdout = "show_stdout",
280 stderr = "show_stderr")
281 (out, err), proc = self.node.check_output(self.ovs_home, 'show_stdout')
284 msg = "Error when checking the status of the OpenVswitch"
286 raise RuntimeError, msg
290 def do_release(self):
291 """ Delete the bridge and close the server.
293 .. note : It need to wait for the others RM (OVSPort and OVSTunnel)
294 to be released before releasing itself
298 from nepi.resources.planetlab.openvswitch.ovsport import OVSPort
299 rm = self.get_connected(OVSPort.get_rtype())
301 if rm[0].state < ResourceState.RELEASED:
302 self.ec.schedule(reschedule_delay, self.release)
305 cmd = "sliver-ovs del-bridge %s" % self.get('bridge_name')
306 (out, err), proc = self.node.run(cmd, self.ovs_checks,
309 cmd = "sliver-ovs stop"
310 (out, err), proc = self.node.run(cmd, self.ovs_checks,
313 msg = "Deleting the bridge %s" % self.get('bridge_name')
317 self.error(msg, out, err)
318 raise RuntimeError, msg
320 super(OVSSwitch, self).do_release()