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 version 2 as
7 # published by the Free Software Foundation;
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
18 # Julien Tribino <julien.tribino@inria.fr>
20 from nepi.util.timefuncs import tnow
21 from nepi.execution.resource import ResourceManager, clsinit_copy, \
23 from nepi.execution.attribute import Attribute, Flags
25 from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
26 from nepi.resources.omf.omf_api_factory import OMFAPIFactory
30 class OMFChannel(OMFResource):
32 .. class:: Class Args :
34 :param ec: The Experiment controller
35 :type ec: ExperimentController
36 :param guid: guid of the RM
38 :param creds: Credentials to communicate with the rm (XmppClient for OMF)
42 _rtype = "omf::Channel"
43 _authorized_connections = ["omf::WifiInterface", "omf::Node"]
45 ChannelToFreq = dict({
62 def _register_attributes(cls):
63 """Register the attributes of an OMF channel
66 channel = Attribute("channel", "Name of the application")
67 cls._register_attribute(channel)
69 def __init__(self, ec, guid):
71 :param ec: The Experiment controller
72 :type ec: ExperimentController
73 :param guid: guid of the RM
77 super(OMFChannel, self).__init__(ec, guid)
79 self._nodes_guid = list()
84 # For performance tests
86 self.begin_deploy_time = None
93 def valid_connection(self, guid):
94 """ Check if the connection with the guid in parameter is possible.
95 Only meaningful connections are allowed.
97 :param guid: Guid of the current RM
102 rm = self.ec.get_resource(guid)
103 if rm.get_rtype() in self._authorized_connections:
104 msg = "Connection between %s %s and %s %s accepted" % (
105 self.get_rtype(), self._guid, rm.get_rtype(), guid)
108 msg = "Connection between %s %s and %s %s refused" % (
109 self.get_rtype(), self._guid, rm.get_rtype(), guid)
113 def _get_target(self, conn_set):
115 Get the couples (host, interface) that uses this channel
117 :param conn_set: Connections of the current Guid
120 :return: self._nodes_guid
125 rm_iface = self.ec.get_resource(elt)
126 for conn in rm_iface.connections:
127 rm_node = self.ec.get_resource(conn)
128 if rm_node.get_rtype() == "omf::Node" and rm_node.get('hostname'):
129 if rm_iface.state < ResourceState.PROVISIONED or \
130 rm_node.state < ResourceState.READY:
132 couple = [rm_node.get('hostname'), rm_iface.alias]
136 def get_frequency(self, channel):
137 """ Returns the frequency of a specific channel number
140 return OMFChannel.ChannelToFreq[channel]
143 """ Deploy the RM. It means : Get the xmpp client and send messages
144 using OMF 5.4 or 6 protocol to configure the channel.
148 ## For performance test
150 self.begin_deploy_time = tnow()
153 if not self.get('channel'):
154 msg = "Channel's value is not initialized"
156 raise RuntimeError(msg)
158 if self.get('version') == "6":
159 self.frequency = self.get_frequency(self.get('channel'))
160 super(OMFChannel, self).do_deploy()
163 if not self.get('xmppServer'):
164 msg = "XmppServer is not initialzed. XMPP Connections impossible"
166 raise RuntimeError(msg)
168 if not (self.get('xmppUser') or self.get('xmppPort')
169 or self.get('xmppPassword')):
170 msg = "Credentials are not all initialzed. Default values will be used"
173 if not self._omf_api :
174 self._omf_api = OMFAPIFactory.get_api(self.get('version'),
175 self.get('xmppServer'), self.get('xmppUser'), self.get('xmppPort'),
176 self.get('xmppPassword'), exp_id = self.exp_id)
178 self._nodes_guid = self._get_target(self._connections)
180 if self._nodes_guid == "reschedule" :
181 self.ec.schedule("1s", self.deploy)
183 for couple in self._nodes_guid:
184 attrval = self.get('channel')
185 attrname = "net/%s/%s" % (couple[1], 'channel')
186 self._omf_api.configure(couple[0], attrname, attrval)
188 super(OMFChannel, self).do_deploy()
190 def do_release(self):
191 """ Clean the RM at the end of the experiment and release the API
195 OMFAPIFactory.release_api(self.get('version'),
196 self.get('xmppServer'), self.get('xmppUser'), self.get('xmppPort'),
197 self.get('xmppPassword'), exp_id = self.exp_id)
199 super(OMFChannel, self).do_release()