src/nepi/resources/linux/tunnel.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   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.
   9 #
  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.
  14 #
  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/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  20 from nepi.execution.resource import clsinit_copy, ResourceState, \
  21         reschedule_delay
  22 from nepi.resources.linux.application import LinuxApplication
  23 from nepi.util.timefuncs import tnow, tdiffsec
  24
  25 import os
  26 import time
  27
  28 state_check_delay = 0.5
  29
  30 @clsinit_copy
  31 class LinuxTunnel(LinuxApplication):
  32     _rtype = "abstract::LinuxTunnel"
  33     _help = "Constructs a tunnel between two Linux endpoints"
  34     _backend = "linux"
  35
  36     def __init__(self, ec, guid):
  37         super(LinuxTunnel, self).__init__(ec, guid)
  38         self._home = "tunnel-%s" % self.guid
  39
  40     def log_message(self, msg):
  41         return " guid %d - tunnel %s - %s - %s " % (self.guid,
  42                 self.endpoint1.node.get("hostname"),
  43                 self.endpoint2.node.get("hostname"),
  44                 msg)
  45
  46     def get_endpoints(self):
  47         """ Returns the list of RM that are endpoints to the tunnel
  48         """
  49         raise NotImplementedError
  50
  51     @property
  52     def endpoint1(self):
  53         endpoints = self.get_endpoints()
  54         if endpoints: return endpoints[0]
  55         return None
  56
  57     @property
  58     def endpoint2(self):
  59         endpoints = self.get_endpoints()
  60         if endpoints and len(endpoints) > 1: return endpoints[1]
  61         return None
  62
  63     def app_home(self, endpoint):
  64         return os.path.join(endpoint.node.exp_home, self._home)
  65
  66     def run_home(self, endpoint):
  67         return os.path.join(self.app_home(endpoint), self.ec.run_id)
  68
  69     def initiate_connection(self, endpoint, remote_endpoint):
  70         raise NotImplementedError
  71
  72     def establish_connection(self, endpoint, remote_endpoint, data):
  73         raise NotImplementedError
  74
  75     def verify_connection(self, endpoint, remote_endpoint):
  76         raise NotImplementedError
  77
  78     def terminate_connection(self, endpoint, remote_endpoint):
  79         raise NotImplementedError
  80
  81     def check_state_connection(self, endpoint, remote_endpoint):
  82         raise NotImplementedError
  83
  84     def do_provision(self):
  85         # create run dir for tunnel on each node
  86         self.endpoint1.node.mkdir(self.run_home(self.endpoint1))
  87         self.endpoint2.node.mkdir(self.run_home(self.endpoint2))
  88
  89         self.debug("Initiate the connection")
  90         # Start 2 step connection
  91         # Initiate connection from endpoint 1 to endpoint 2
  92         data1 = self.initiate_connection(self.endpoint1, self.endpoint2)
  93
  94         # Initiate connection from endpoint 2 to endpoint 1
  95         data2 = self.initiate_connection(self.endpoint2, self.endpoint1)
  96
  97         self.debug("Establish the connection")
  98         # Establish connection from endpoint 1 to endpoint 2
  99         self.establish_connection(self.endpoint1, self.endpoint2, data2)
 100
 101         # Establish connection from endpoint 2 to endpoint 1
 102         self.establish_connection(self.endpoint2, self.endpoint1, data1)
 103
 104         self.debug("Verify the connection")
 105         # check if connection was successful on both sides
 106         self.verify_connection(self.endpoint1, self.endpoint2)
 107         self.verify_connection(self.endpoint2, self.endpoint1)
 108
 109         self.info("Provisioning finished")
 110
 111         self.set_provisioned()
 112
 113     def do_deploy(self):
 114         if (not self.endpoint1 or self.endpoint1.state < ResourceState.READY) or \
 115             (not self.endpoint2 or self.endpoint2.state < ResourceState.READY):
 116             self.ec.schedule(reschedule_delay, self.deploy)
 117         else:
 118             self.do_discover()
 119             self.do_provision()
 120
 121             self.set_ready()
 122
 123     def do_start(self):
 124         if self.state == ResourceState.READY:
 125             command = self.get("command")
 126             self.info("Starting command '%s'" % command)
 127
 128             self.set_started()
 129         else:
 130             msg = " Failed to execute command '%s'" % command
 131             self.error(msg, out, err)
 132             raise RuntimeError, msg
 133
 134     def do_stop(self):
 135         """ Stops application execution
 136         """
 137
 138         if self.state == ResourceState.STARTED:
 139             self.info("Stopping tunnel")
 140
 141             self.terminate_connection(self.endpoint1, self.endpoint2)
 142             self.terminate_connection(self.endpoint2, self.endpoint1)
 143
 144             self.set_stopped()
 145
 146     @property
 147     def state(self):
 148         """ Returns the state of the application
 149         """
 150         if self._state == ResourceState.STARTED:
 151             # In order to avoid overwhelming the remote host and
 152             # the local processor with too many ssh queries, the state is only
 153             # requested every 'state_check_delay' seconds.
 154             if tdiffsec(tnow(), self._last_state_check) > state_check_delay:
 155
 156                 self.check_state_connection()
 157
 158                 self._last_state_check = tnow()
 159
 160         return self._state
 161
 162     def valid_connection(self, guid):
 163         # TODO: Validate!
 164         return True
 165