# Copyright (C) 2013 INRIA
#
# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation;
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
# Julien Tribino <julien.tribino@inria.fr>
-from nepi.execution.resource import ResourceManager, clsinit, ResourceState, \
- reschedule_delay
+import os, time
+from nepi.util.timefuncs import tnow
+from nepi.execution.resource import ResourceManager, clsinit_copy, \
+ ResourceState
from nepi.execution.attribute import Attribute, Flags
-from nepi.resources.omf.node import OMFNode
-from nepi.resources.omf.omf_api import OMFAPIFactory
+from nepi.resources.omf.node import OMFNode, confirmation_counter, reschedule_check
+from nepi.resources.omf.omf_resource import ResourceGateway, OMFResource
+from nepi.resources.omf.channel import OMFChannel
+from nepi.resources.omf.omf_api_factory import OMFAPIFactory
-
-@clsinit
-class OMFWifiInterface(ResourceManager):
+@clsinit_copy
+class OMFWifiInterface(OMFResource):
"""
.. class:: Class Args :
:type ec: ExperimentController
:param guid: guid of the RM
:type guid: int
- :param creds: Credentials to communicate with the rm (XmppClient for OMF)
- :type creds: dict
-
- .. note::
-
- This class is used only by the Experiment Controller through the Resource Factory
"""
- _rtype = "OMFWifiInterface"
- _authorized_connections = ["OMFNode" , "OMFChannel"]
-
- #alias2name = dict({'w0':'wlan0', 'w1':'wlan1'})
+ _rtype = "omf::WifiInterface"
+ _authorized_connections = ["omf::Node" , "omf::Channel", "wilabt::sfa::Node"]
@classmethod
def _register_attributes(cls):
"""Register the attributes of an OMF interface
"""
- alias = Attribute("alias","Alias of the interface", default = "w0")
+ name = Attribute("name","Alias of the interface : wlan0, wlan1, ..", default = "wlan0")
mode = Attribute("mode","Mode of the interface")
- type = Attribute("type","Type of the interface")
+ hw_mode = Attribute("hw_mode","Choose between : a, b, g, n")
essid = Attribute("essid","Essid of the interface")
ip = Attribute("ip","IP of the interface")
- xmppSlice = Attribute("xmppSlice","Name of the slice", flags = Flags.Credential)
- xmppHost = Attribute("xmppHost", "Xmpp Server",flags = Flags.Credential)
- xmppPort = Attribute("xmppPort", "Xmpp Port",flags = Flags.Credential)
- xmppPassword = Attribute("xmppPassword", "Xmpp Port",flags = Flags.Credential)
- cls._register_attribute(alias)
- cls._register_attribute(xmppSlice)
- cls._register_attribute(xmppHost)
- cls._register_attribute(xmppPort)
- cls._register_attribute(xmppPassword)
+ cls._register_attribute(name)
cls._register_attribute(mode)
- cls._register_attribute(type)
+ cls._register_attribute(hw_mode)
cls._register_attribute(essid)
cls._register_attribute(ip)
"""
super(OMFWifiInterface, self).__init__(ec, guid)
+ self._conf = False
+ self.alias = None
+ self._type = None
+
+ self.create_id = None
+ self._create_cnt = 0
+ self.release_id = None
+ self._release_cnt = 0
+ self._topic_iface = None
self._omf_api = None
- self._alias = self.get('alias')
+ self._type = ""
- @property
- def exp_id(self):
- if self.ec.exp_id.startswith('exp-'):
- return None
- return self.ec.exp_id
+ # For performance tests
+ self.perf = True
+ self.begin_deploy_time = None
def valid_connection(self, guid):
- """ Check if the connection with the guid in parameter is possible. Only meaningful connections are allowed.
+ """ Check if the connection with the guid in parameter is possible.
+ Only meaningful connections are allowed.
:param guid: Guid of the current RM
:type guid: int
"""
rm = self.ec.get_resource(guid)
- if rm.rtype() in self._authorized_connections:
+ if rm.get_rtype() in self._authorized_connections:
msg = "Connection between %s %s and %s %s accepted" % \
- (self.rtype(), self._guid, rm.rtype(), guid)
+ (self.get_rtype(), self._guid, rm.get_rtype(), guid)
self.debug(msg)
return True
+
msg = "Connection between %s %s and %s %s refused" % \
- (self.rtype(), self._guid, rm.rtype(), guid)
+ (self.get_rtype(), self._guid, rm.get_rtype(), guid)
self.debug(msg)
return False
+ @property
+ def exp_id(self):
+ return self.ec.exp_id
+
@property
def node(self):
- rm_list = self.get_connected(OMFNode.rtype())
+ rm_list = self.get_connected(OMFNode.get_rtype())
if rm_list: return rm_list[0]
return None
- def deploy(self):
- """Deploy the RM. It means : Get the xmpp client and send messages using OMF 5.4 protocol to configure the interface
- It becomes DEPLOYED after sending messages to configure the interface
- """
- if not self._omf_api :
- self._omf_api = OMFAPIFactory.get_api(self.get('xmppSlice'),
- self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'), exp_id = self.exp_id)
+ @property
+ def channel(self):
+ rm_list = self.get_connected(OMFChannel.get_rtype())
+ if rm_list: return rm_list[0]
+ return None
- if not self._omf_api :
- self._state = ResourceState.FAILED
- msg = "Credentials are not initialzed. XMPP Connections impossible"
- self.error(msg)
- return
+ def configure_iface(self):
+ """ Configure the interface without the ip
- if not (self.get('mode') and self.get('type') and self.get('essid') and self.get('ip')):
- self._state = ResourceState.FAILED
- msg = "Interface's variable are not initialized"
- self.error(msg)
+ """
+ if self.node.state < ResourceState.READY:
+ self.ec.schedule(self.reschedule_delay, self.deploy)
return False
- if not self.node.get('hostname') :
- msg = "The channel is connected with an undefined node"
- self.error(msg)
+ for attrname in ["mode", "type", "essid"]:
+ if attrname == "type" :
+ attrval = self._type
+ else :
+ attrval = self.get(attrname)
+ attrname = "net/%s/%s" % (self.alias, attrname)
+ self._omf_api.configure(self.node.get('hostname'), attrname,
+ attrval)
+
+ super(OMFWifiInterface, self).do_provision()
+ return True
+
+ def configure_ip(self):
+ """ Configure the ip of the interface
+
+ .. note : The ip is separated from the others parameters to avoid
+ CELL ID shraing problem. By putting th ip at the end of the configuration,
+ each node use the same channel and can then share the same CELL ID.
+ In the second case, the channel is defined at the end and the node don't
+ share a common CELL ID and can not communicate.
+
+ """
+ if self.channel.state < ResourceState.READY:
+ self.ec.schedule(self.reschedule_delay, self.deploy)
return False
- # Just for information
- self.debug(" " + self.rtype() + " ( Guid : " + str(self._guid) +") : " + \
- self.get('mode') + " : " + self.get('type') + " : " + \
- self.get('essid') + " : " + self.get('ip'))
-
- # Check if the node is already deployed
- if self.node.state < ResourceState.READY:
- self.ec.schedule(reschedule_delay, self.deploy)
- return
+ attrval = self.get("ip")
+ if '/' in attrval:
+ attrval,mask = attrval.split('/')
+ attrname = "net/%s/%s" % (self.alias, "ip")
+ self._omf_api.configure(self.node.get('hostname'), attrname,
+ attrval)
+ return True
- try :
- for attrname in ["mode", "type", "essid", "ip"]:
- attrval = self.get(attrname)
- attrname = "net/%s/%s" % (self._alias, attrname)
- self._omf_api.configure(self.node.get('hostname'), attrname, attrval)
- except AttributeError:
- self._state = ResourceState.FAILED
- msg = "Credentials are not initialzed. XMPP Connections impossible"
- self.debug(msg)
- #raise
- super(OMFWifiInterface, self).deploy()
+ def configure_on_omf5(self):
+ """ Method to configure the wifi interface when OMF 5.4 is used.
- def start(self):
- """Start the RM. It means nothing special for an interface for now
- It becomes STARTED as soon as this method starts.
+ """
- """
+ self._type = self.get('hw_mode')
+ if self.get('name') == "wlan0" or "eth0":
+ self.alias = "w0"
+ else:
+ self.alias = "w1"
+ res = False
+ if self.state < ResourceState.PROVISIONED:
+ if self._conf == False:
+ self._conf = self.configure_iface()
+ if self._conf == True:
+ res = self.configure_ip()
+ return res
- super(OMFWifiInterface, self).start()
+ def check_deploy(self, cid):
+ """ Check, through the mail box in the parser,
+ if the confirmation of the creation has been received
- def stop(self):
- """Stop the RM. It means nothing special for an interface for now
- It becomes STOPPED as soon as this method stops
+ :param cid: the id of the original message
+ :type guid: string
"""
- super(OMFWifiInterface, self).stop()
+ uid = self._omf_api.check_mailbox("create", cid)
+ if uid :
+ return uid
+ return False
- def release(self):
- """Clean the RM at the end of the experiment and release the API
+ def do_deploy(self):
+ """ Deploy the RM. It means : Get the xmpp client and send messages
+ using OMF 5.4 or 6 protocol to configure the interface.
"""
- if self._omf_api :
- OMFAPIFactory.release_api(self.get('xmppSlice'),
- self.get('xmppHost'), self.get('xmppPort'), self.get('xmppPassword'), exp_id = self.exp_id)
+ if not self.node or self.node.state < ResourceState.READY:
+ self.debug("---- RESCHEDULING DEPLOY ---- node state %s "
+ % self.node.state )
+ self.ec.schedule(self.reschedule_delay, self.deploy)
+ return
+
+ if not self.channel or self.channel.state < ResourceState.READY:
+ self.debug("---- RESCHEDULING DEPLOY ---- channel state %s "
+ % self.channel.state )
+ self.ec.schedule(self.reschedule_delay, self.deploy)
+ return
+
+ ## For performance test
+ if self.perf:
+ self.begin_deploy_time = tnow()
+ self.perf = False
+
+ self.set('xmppUser',self.node.get('xmppUser'))
+ self.set('xmppServer',self.node.get('xmppServer'))
+ self.set('xmppPort',self.node.get('xmppPort'))
+ self.set('xmppPassword',self.node.get('xmppPassword'))
+ self.set('version',self.node.get('version'))
- super(OMFWifiInterface, self).release()
+ if not self.get('xmppServer'):
+ msg = "XmppServer is not initialzed. XMPP Connections impossible"
+ self.error(msg)
+ raise RuntimeError, msg
+
+ if not (self.get('xmppUser') or self.get('xmppPort')
+ or self.get('xmppPassword')):
+ msg = "Credentials are not all initialzed. Default values will be used"
+ self.warn(msg)
+
+ if not self._omf_api :
+ self._omf_api = OMFAPIFactory.get_api(self.get('version'),
+ self.get('xmppServer'), self.get('xmppUser'), self.get('xmppPort'),
+ self.get('xmppPassword'), exp_id = self.exp_id)
+
+ if not (self.get('name')):
+ msg = "Interface's name is not initialized"
+ self.error(msg)
+ raise RuntimeError, msg
+
+ if not (self.get('mode') and self.get('essid') \
+ and self.get('hw_mode') and self.get('ip')):
+ msg = "Interface's variable are not initialized"
+ self.error(msg)
+ raise RuntimeError, msg
+
+ if self.get('version') == "5":
+ res = self.configure_on_omf5()
+
+ else :
+ res = self.configure_on_omf6()
+
+ if res:
+ super(OMFWifiInterface, self).do_deploy()
+
+ def configure_on_omf6(self):
+ """ Method to configure the wifi interface when OMF 6 is used.
+
+ """
+ if not self.create_id :
+ props = {}
+ props['wlan:if_name'] = self.get('name')
+ props['wlan:mode'] = {
+ "mode": self.get('mode'),
+ "hw_mode" : self.get('hw_mode'),
+ "channel" : self.channel.get('channel'),
+ "essid" : self.get('essid'),
+ "ip_addr" : self.get('ip'),
+ "frequency" : self.channel.frequency,
+ "phy" : "%0%"
+ }
+ props['wlan:hrn'] = self.get('name')
+ props['wlan:type'] = "wlan"
+
+ self.create_id = os.urandom(16).encode('hex')
+ self._omf_api.frcp_create( self.create_id, self.node.get('hostname'), "wlan", props = props)
+
+ if self._create_cnt > confirmation_counter:
+ msg = "Couldn't retrieve the confirmation of the creation"
+ self.error(msg)
+ raise RuntimeError, msg
+
+ uid = self.check_deploy(self.create_id)
+ if not uid:
+ self._create_cnt +=1
+ self.ec.schedule(reschedule_check, self.deploy)
+ return False
+
+ self._topic_iface = uid
+ self._omf_api.enroll_topic(self._topic_iface)
+ return True
+
+ def check_release(self, cid):
+ """ Check, through the mail box in the parser,
+ if the confirmation of the release has been received
+
+ :param cid: the id of the original message
+ :type guid: string
+
+ """
+ res = self._omf_api.check_mailbox("release", cid)
+ if res :
+ return res
+ return False
+
+ def do_release(self):
+ """ Clean the RM at the end of the experiment and release the API
+
+ """
+ if self._omf_api:
+ if self.get('version') == "6" and self._topic_iface :
+ if not self.release_id:
+ self.release_id = os.urandom(16).encode('hex')
+ self._omf_api.frcp_release( self.release_id, self.node.get('hostname'),self._topic_iface, res_id=self._topic_iface)
+
+ if self._release_cnt < confirmation_counter:
+ cid = self.check_release(self.release_id)
+ if not cid:
+ self._release_cnt +=1
+ self.ec.schedule(reschedule_check, self.release)
+ return
+ else:
+ msg = "Couldn't retrieve the confirmation of the release"
+ self.error(msg)
+
+
+ OMFAPIFactory.release_api(self.get('version'),
+ self.get('xmppServer'), self.get('xmppUser'), self.get('xmppPort'),
+ self.get('xmppPassword'), exp_id = self.exp_id)
+
+ super(OMFWifiInterface, self).do_release()
git://git.onelab.eu / nepi.git / blobdiff