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, ResourceState
23 from nepi.execution.attribute import Attribute, Flags
24 from nepi.resources.planetlab.node import PlanetlabNode
25 from nepi.resources.linux.application import LinuxApplication
28 reschedule_delay = "0.5s"
31 class OVSWitch(LinuxApplication):
34 _help = "Runs an OpenVSwitch on a PlanetLab host"
35 _backend = "planetlab"
37 _authorized_connections = ["PlanetlabNode", "OVSPort", "LinuxNode"]
40 def _register_attributes(cls):
41 """ Register the attributes of OVSWitch RM
44 bridge_name = Attribute("bridge_name", "Name of the switch/bridge",
45 flags = Flags.ExecReadOnly)
46 virtual_ip_pref = Attribute("virtual_ip_pref", "Virtual IP/PREFIX of the switch",
47 flags = Flags.ExecReadOnly)
48 controller_ip = Attribute("controller_ip", "IP of the controller",
49 flags = Flags.ExecReadOnly)
50 controller_port = Attribute("controller_port", "Port of the controller",
51 flags = Flags.ExecReadOnly)
53 cls._register_attribute(bridge_name)
54 cls._register_attribute(virtual_ip_pref)
55 cls._register_attribute(controller_ip)
56 cls._register_attribute(controller_port)
58 def __init__(self, ec, guid):
60 :param ec: The Experiment controller
61 :type ec: ExperimentController
62 :param guid: guid of the RM
66 super(OVSWitch, self).__init__(ec, guid)
69 self._home = "ovswitch-%s" % self.guid
70 self._checks = "ovsChecks-%s" % self.guid
74 node = self.get_connected(PlanetlabNode.rtype())
75 if node: return node[0]
80 return os.path.join(self.node.exp_home, self._home)
84 return os.path.join(self.ovs_home, self._checks)
94 # def valid_connection(self, guid):
95 # """ Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.
97 # :param guid: Guid of the current RM
102 # rm = self.ec.get_resource(guid)
103 # if rm.rtype() in self._authorized_connections:
104 # msg = "Connection between %s %s and %s %s accepted" % \
105 # (self.rtype(), self._guid, rm.rtype(), guid)
108 # msg = "Connection between %s %s and %s %s refused" % \
109 # (self.rtype(), self._guid, rm.rtype(), guid)
113 def valid_connection(self, guid):
118 # create home dir for ovs
119 self.node.mkdir(self.ovs_home)
120 # create dir for ovs checks
121 self.node.mkdir(self.ovs_checks)
123 def check_sliver_ovs(self):
124 """ Check if sliver-ovs exists. If it does not exist, we interrupt
125 the execution immediately.
127 cmd = "compgen -c | grep sliver-ovs"
130 (out,err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
131 shfile = "check_cmd.sh",
132 pidfile = "check_cmd_pidfile",
133 ecodefile = "check_cmd_exitcode",
135 stdout = "check_cmd_stdout",
136 stderr = "check_cmd_stderr")
138 (out, err), proc = self.node.check_output(self.ovs_checks, 'check_cmd_exitcode')
140 msg = "Command sliver-ovs does not exist on the VM"
142 raise RuntimeError, msg
143 msg = "Command sliver-ovs exists"
147 """ Wait until node is associated and deployed
150 if not node or node.state < ResourceState.READY:
151 self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
152 self.ec.schedule(reschedule_delay, self.deploy)
158 self.check_sliver_ovs()
164 self._state = ResourceState.FAILED
167 self._state = ResourceState.READY
169 def servers_on(self):
170 """ Start the openvswitch servers and also checking
171 if they started successfully
173 self.info("Starting the OVSWitch servers")
174 command = ("sliver-ovs start")
177 (out, err), proc = self.node.run_and_wait(command, self.ovs_checks,
178 shfile = "start_srv.sh",
179 pidfile = "start_srv_pidfile",
180 ecodefile = "start_srv_exitcode",
182 raise_on_error = True,
183 stdout = "start_srv_stdout",
184 stderr = "start_srv_stderr")
186 (out, err), proc = self.node.check_output(self.ovs_checks, 'start_srv_exitcode')
189 self.debug("Servers have not started")
190 raise RuntimeError, msg
192 cmd = "ps -A | grep ovsdb-server"
194 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
195 shfile = "status_srv.sh",
196 pidfile = "status_srv_pidfile",
197 ecodefile = "status_srv_exitcode",
199 stdout = "status_srv_stdout",
200 stderr = "status_srv_stderr")
202 # Check if the servers are running or not
203 (out, err), proc = self.node.check_output(self.ovs_checks, 'status_srv_exitcode')
205 self.debug("Servers are not running")
206 raise RuntimeError, msg
207 self.info("Servers started")
209 def del_old_br(self):
210 # TODO: Delete old bridges that might exist maybe by adding atribute
211 """ With ovs-vsctl list-br
215 def create_bridge(self):
216 """ Create the bridge/switch and we check if we have any
217 error during the SSH connection
219 # TODO: Add check for virtual_ip belonging to vsys_tag
222 if self.get("bridge_name") and self.get("virtual_ip_pref"):
223 bridge_name = self.get("bridge_name")
224 virtual_ip_pref = self.get("virtual_ip_pref")
225 self.info(" Creating the bridge %s and assigning %s" %\
226 (bridge_name, virtual_ip_pref) )
227 cmd = "sliver-ovs create-bridge '%s' '%s'" %\
228 (bridge_name, virtual_ip_pref)
230 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
231 shfile = "create_br.sh",
232 pidfile = "create_br_pidfile",
233 ecodefile = "create_br_exitcode",
235 stdout = "create_br_stdout",
236 stderr = "create_br_stderr")
237 (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"
240 self.debug("Check again the virtual IP")
241 raise RuntimeError, msg
242 self.info("Bridge %s created" % bridge_name)
245 msg = "No assignment in one or both attributes"
247 self.debug("Bridge name is %s and virtual_ip_pref is %s" %\
248 (self.get("bridge_name"), self.get("virtual_ip_pref")) )
249 raise AttributeError, msg
251 def assign_contr(self):
252 """ Set the controller IP
254 if self.get("controller_ip") and self.get("controller_port"):
255 controller_ip = self.get("controller_ip")
256 controller_port = self.get("controller_port")
257 self.info("Assigning the controller to the %s" % self.get("bridge_name"))
258 cmd = "ovs-vsctl set-controller %s tcp:%s:%s" %\
259 (self.get("bridge_name"), controller_ip, controller_port)
261 (out, err), proc = self.node.run(cmd, self.ovs_checks,
266 self.debug("SSH connection refusing in assign_contr")
267 raise RuntimeError, msg
268 self.info("Controller assigned")
270 def ovs_status(self):
271 """ Print the status of the created bridge
273 cmd = "sliver-ovs show | tail -n +2"
275 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_home,
277 stdout = "show_stdout",
278 stderr = "show_stderr")
279 (out, err), proc = self.node.check_output(self.ovs_home, 'show_stdout')
283 """ Start the RM. It means nothing special for
289 """ Stop the RM.It means nothing
290 for ovswitch for now.
295 """ Delete the bridge and
298 # Node needs to wait until all associated RMs are released
300 from nepi.resources.planetlab.openvswitch.ovsport import OVSPort
301 rm = self.get_connected(OVSPort.rtype())
303 if rm[0].state < ResourceState.FINISHED:
304 self.ec.schedule(reschedule_delay, self.release)
307 msg = "Deleting the bridge %s" % self.get('bridge_name')
309 cmd = "sliver-ovs del-bridge %s" % self.get('bridge_name')
310 (out, err), proc = self.node.run(cmd, self.ovs_checks,
312 cmd = "sliver-ovs stop"
313 (out, err), proc = self.node.run(cmd, self.ovs_checks,
318 self.error(msg, out, err)
319 raise RuntimeError, msg
321 self._state = ResourceState.RELEASED