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 _authorized_connections = ["PlanetlabNode", "OVSPort", "LinuxNode"]
37 def _register_attributes(cls):
38 """ Register the attributes of OVSWitch RM
41 bridge_name = Attribute("bridge_name", "Name of the switch/bridge",
42 flags = Flags.ExecReadOnly)
43 virtual_ip_pref = Attribute("virtual_ip_pref", "Virtual IP/PREFIX of the switch",
44 flags = Flags.ExecReadOnly)
45 controller_ip = Attribute("controller_ip", "IP of the controller",
46 flags = Flags.ExecReadOnly)
47 controller_port = Attribute("controller_port", "Port of the controller",
48 flags = Flags.ExecReadOnly)
50 cls._register_attribute(bridge_name)
51 cls._register_attribute(virtual_ip_pref)
52 cls._register_attribute(controller_ip)
53 cls._register_attribute(controller_port)
55 def __init__(self, ec, guid):
57 :param ec: The Experiment controller
58 :type ec: ExperimentController
59 :param guid: guid of the RM
61 :param creds: Credentials to communicate with the rm
65 super(OVSWitch, self).__init__(ec, guid)
68 self._home = "ovswitch-%s" % self.guid
69 self._checks = "ovsChecks-%s" % self.guid
73 node = self.get_connected(PlanetlabNode.rtype())
74 if node: return node[0]
79 return os.path.join(self.node.exp_home, self._home)
83 return os.path.join(self.ovs_home, self._checks)
93 # def valid_connection(self, guid):
94 # """ Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.
96 # :param guid: Guid of the current RM
101 # rm = self.ec.get_resource(guid)
102 # if rm.rtype() in self._authorized_connections:
103 # msg = "Connection between %s %s and %s %s accepted" % \
104 # (self.rtype(), self._guid, rm.rtype(), guid)
107 # msg = "Connection between %s %s and %s %s refused" % \
108 # (self.rtype(), self._guid, rm.rtype(), guid)
112 def valid_connection(self, guid):
117 # create home dir for ovs
118 self.node.mkdir(self.ovs_home)
119 # create dir for ovs checks
120 self.node.mkdir(self.ovs_checks)
122 def check_sliver_ovs(self):
123 """ Check if sliver-ovs exists. If it does not exist, we interrupt
124 the execution immediately.
126 cmd = "compgen -c | grep sliver-ovs"
129 (out,err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
130 shfile = "check_cmd.sh",
131 pidfile = "check_cmd_pidfile",
132 ecodefile = "check_cmd_exitcode",
134 stdout = "check_cmd_stdout",
135 stderr = "check_cmd_stderr")
137 (out, err), proc = self.node.check_output(self.ovs_checks, 'check_cmd_exitcode')
139 msg = "Command sliver-ovs does not exist on the VM"
141 raise RuntimeError, msg
142 msg = "Command sliver-ovs exists"
146 """ Wait until node is associated and deployed
149 if not node or node.state < ResourceState.READY:
150 self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
151 self.ec.schedule(reschedule_delay, self.deploy)
157 self.check_sliver_ovs()
163 self._state = ResourceState.FAILED
166 self._state = ResourceState.READY
168 def servers_on(self):
169 """ Start the openvswitch servers and also checking
170 if they started successfully
172 self.info("Starting the OVSWitch servers")
173 command = ("sliver-ovs start")
176 (out, err), proc = self.node.run_and_wait(command, self.ovs_checks,
177 shfile = "start_srv.sh",
178 pidfile = "start_srv_pidfile",
179 ecodefile = "start_srv_exitcode",
181 raise_on_error = True,
182 stdout = "start_srv_stdout",
183 stderr = "start_srv_stderr")
185 (out, err), proc = self.node.check_output(self.ovs_checks, 'start_srv_exitcode')
188 self.debug("Servers have not started")
189 raise RuntimeError, msg
191 cmd = "ps -A | grep ovsdb-server"
193 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_checks,
194 shfile = "status_srv.sh",
195 pidfile = "status_srv_pidfile",
196 ecodefile = "status_srv_exitcode",
198 stdout = "status_srv_stdout",
199 stderr = "status_srv_stderr")
201 # Check if the servers are running or not
202 (out, err), proc = self.node.check_output(self.ovs_checks, 'status_srv_exitcode')
204 self.debug("Servers are not running")
205 raise RuntimeError, msg
206 self.info("Servers started")
208 def del_old_br(self):
209 # TODO: Delete old bridges that might exist maybe by adding atribute
210 """ With ovs-vsctl list-br
214 def create_bridge(self):
215 """ Create the bridge/switch and we check if we have any
216 error during the SSH connection
218 # TODO: Add check for virtual_ip belonging to vsys_tag
221 if self.get("bridge_name") and self.get("virtual_ip_pref"):
222 bridge_name = self.get("bridge_name")
223 virtual_ip_pref = self.get("virtual_ip_pref")
224 self.info(" Creating the bridge %s and assigning %s" %\
225 (bridge_name, virtual_ip_pref) )
226 cmd = "sliver-ovs create-bridge '%s' '%s'" %\
227 (bridge_name, 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')
238 msg = "No such pltap netdev\novs-appctl: ovs-vswitchd: server returned an error"
239 self.debug("Check again the virtual IP")
240 raise RuntimeError, msg
241 self.info("Bridge %s created" % bridge_name)
244 msg = "No assignment in one or both attributes"
246 self.debug("Bridge name is %s and virtual_ip_pref is %s" %\
247 (self.get("bridge_name"), self.get("virtual_ip_pref")) )
248 raise AttributeError, msg
250 def assign_contr(self):
251 """ Set the controller IP
253 if self.get("controller_ip") and self.get("controller_port"):
254 controller_ip = self.get("controller_ip")
255 controller_port = self.get("controller_port")
256 self.info("Assigning the controller to the %s" % self.get("bridge_name"))
257 cmd = "ovs-vsctl set-controller %s tcp:%s:%s" %\
258 (self.get("bridge_name"), controller_ip, controller_port)
260 (out, err), proc = self.node.run(cmd, self.ovs_checks,
265 self.debug("SSH connection refusing in assign_contr")
266 raise RuntimeError, msg
267 self.info("Controller assigned")
269 def ovs_status(self):
270 """ Print the status of the created bridge
272 cmd = "sliver-ovs show | tail -n +2"
274 (out, err), proc = self.node.run_and_wait(cmd, self.ovs_home,
276 stdout = "show_stdout",
277 stderr = "show_stderr")
278 (out, err), proc = self.node.check_output(self.ovs_home, 'show_stdout')
282 """ Start the RM. It means nothing special for
288 """ Stop the RM.It means nothing
289 for ovswitch for now.
294 """ Delete the bridge and
297 # Node needs to wait until all associated RMs are released
299 from nepi.resources.planetlab.openvswitch.ovsport import OVSPort
300 rm = self.get_connected(OVSPort.rtype())
302 if rm[0].state < ResourceState.FINISHED:
303 self.ec.schedule(reschedule_delay, self.release)
306 msg = "Deleting the bridge %s" % self.get('bridge_name')
308 cmd = "sliver-ovs del-bridge %s" % self.get('bridge_name')
309 (out, err), proc = self.node.run(cmd, self.ovs_checks,
311 cmd = "sliver-ovs stop"
312 (out, err), proc = self.node.run(cmd, self.ovs_checks,
317 self.error(msg, out, err)
318 raise RuntimeError, msg
320 self._state = ResourceState.RELEASED