bin/PortManager.py

   1 #!/usr/bin/env python
   2 #  -*- coding: iso-8859-1 -*-
   3 # Copyright (C) 2007-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   4 #
   5 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   7 #
   8 # This library is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU Lesser General Public
  10 # License as published by the Free Software Foundation; either
  11 # version 2.1 of the License, or (at your option) any later version.
  12 #
  13 # This library is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # Lesser General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Lesser General Public
  19 # License along with this library; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21 #
  22 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  23 #
  24 import os
  25 import sys
  26
  27 try:
  28   import cPickle as pickle #@UnusedImport
  29 except:
  30   import pickle #@Reimport
  31
  32 import logging
  33 def createLogger():
  34   logger = logging.getLogger(__name__)
  35 #  logger.setLevel(logging.DEBUG)
  36   logger.setLevel(logging.INFO)
  37   ch = logging.StreamHandler()
  38   ch.setLevel(logging.DEBUG)
  39   formatter = logging.Formatter("%(levelname)s:%(threadName)s:%(message)s")
  40   ch.setFormatter(formatter)
  41   logger.addHandler(ch)
  42   return logger
  43 #
  44 logger = createLogger()
  45
  46 #------------------------------------
  47 # A file locker (Linux only)
  48 def __acquire_lock(lock):
  49   if sys.platform == "win32":
  50     import msvcrt
  51     # lock 1 byte: file is supposed to be zero-byte long
  52     msvcrt.locking(lock.fileno(), msvcrt.LK_LOCK, 1)
  53   else:
  54     import fcntl
  55     fcntl.flock(lock, fcntl.LOCK_EX)
  56 #
  57 def __release_lock(lock):
  58   if sys.platform == "win32":
  59     import msvcrt
  60     msvcrt.locking(lock.fileno(), msvcrt.LK_UNLCK, 1)
  61   else:
  62     import fcntl
  63     fcntl.flock(lock, fcntl.LOCK_UN)
  64 #
  65
  66 def _getConfigurationFilename():
  67   omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
  68
  69   from salome_utils import generateFileName
  70   portmanager_config = generateFileName(omniorbUserPath,
  71                                         prefix="omniORB",
  72                                         suffix="PortManager",
  73                                         extension="cfg",
  74                                         hidden=True)
  75   import tempfile
  76   temp = tempfile.NamedTemporaryFile()
  77   lock_file = os.path.join(os.path.dirname(temp.name), ".omniORB_PortManager.lock")
  78   temp.close()
  79
  80   return (portmanager_config, lock_file)
  81 #
  82
  83 def __isPortUsed(port, busy_ports):
  84   return (port in busy_ports) or __isNetworkConnectionActiveOnPort(port)
  85 #
  86
  87 def __isNetworkConnectionActiveOnPort(port):
  88   # :NOTE: Under windows:
  89   #        netstat options -l and -t are unavailable
  90   #        grep command is unavailable
  91   from subprocess import Popen, PIPE
  92   stdout, _ = Popen(['netstat','-an'], stdout=PIPE).communicate()
  93   import StringIO
  94   buf = StringIO.StringIO(stdout)
  95   ports = buf.readlines()
  96   # search for TCP - LISTEN connections
  97   import re
  98   regObj = re.compile( ".*tcp.*:([0-9]+).*:.*listen", re.IGNORECASE );
  99   for item in ports:
 100     try:
 101       p = int(regObj.match(item).group(1))
 102       if p == port: return True
 103     except:
 104       pass
 105 #
 106
 107 def getPort(preferedPort=None):
 108   logger.debug("GET PORT")
 109
 110   config_file, lock_file = _getConfigurationFilename()
 111   oldmask = os.umask(0)
 112   with open(lock_file, 'w') as lock:
 113     # acquire lock
 114     __acquire_lock(lock)
 115
 116     # read config
 117     config = {'busy_ports':[]}
 118     logger.debug("read configuration file")
 119     try:
 120       with open(config_file, 'r') as f:
 121         config = pickle.load(f)
 122     except:
 123       logger.info("Problem loading PortManager file: %s"%config_file)
 124       # In this case config dictionary is reset
 125
 126     logger.debug("load busy_ports: %s"%str(config["busy_ports"]))
 127
 128     # append port
 129     busy_ports = config["busy_ports"]
 130     port = preferedPort
 131     if not port or __isPortUsed(port, busy_ports):
 132       port = 2810
 133       while __isPortUsed(port, busy_ports):
 134         if port == 2810+100:
 135           msg  = "\n"
 136           msg += "Can't find a free port to launch omniNames\n"
 137           msg += "Try to kill the running servers and then launch SALOME again.\n"
 138           raise RuntimeError, msg
 139         logger.debug("Port %s seems to be busy"%str(port))
 140         if not port in config["busy_ports"]:
 141           config["busy_ports"].append(port)
 142         port = port + 1
 143     logger.debug("found free port: %s"%str(port))
 144     config["busy_ports"].append(port)
 145
 146     # write config
 147     logger.debug("write busy_ports: %s"%str(config["busy_ports"]))
 148     try:
 149       with open(config_file, 'w') as f:
 150         pickle.dump(config, f)
 151     except IOError:
 152       pass
 153
 154     # release lock
 155     __release_lock(lock)
 156   #
 157
 158   os.umask(oldmask)
 159   logger.debug("get port: %s"%str(port))
 160   return port
 161 #
 162
 163 def releasePort(port):
 164   port = int(port)
 165   logger.debug("RELEASE PORT (%s)"%port)
 166
 167   config_file, lock_file = _getConfigurationFilename()
 168   with open(lock_file, 'w') as lock:
 169     # acquire lock
 170     __acquire_lock(lock)
 171
 172     # read config
 173     config = {'busy_ports':[]}
 174     logger.debug("read configuration file")
 175     try:
 176       with open(config_file, 'r') as f:
 177         config = pickle.load(f)
 178     except IOError: # empty file
 179       pass
 180
 181     logger.debug("load busy_ports: %s"%str(config["busy_ports"]))
 182
 183     # remove port from list
 184     busy_ports = config["busy_ports"]
 185
 186     if port in busy_ports:
 187       busy_ports.remove(port)
 188       config["busy_ports"] = busy_ports
 189
 190     # write config
 191     logger.debug("write busy_ports: %s"%str(config["busy_ports"]))
 192     try:
 193       with open(config_file, 'w') as f:
 194         pickle.dump(config, f)
 195     except IOError:
 196       pass
 197
 198     # release lock
 199     __release_lock(lock)
 200
 201     logger.debug("released port port: %s"%str(port))
 202 #
 203
 204 def getBusyPorts():
 205   config_file, lock_file = _getConfigurationFilename()
 206   with open(lock_file, 'w') as lock:
 207     # acquire lock
 208     __acquire_lock(lock)
 209
 210     # read config
 211     config = {'busy_ports':[]}
 212     logger.debug("read configuration file")
 213     try:
 214       with open(config_file, 'r') as f:
 215         config = pickle.load(f)
 216     except IOError: # empty file
 217       pass
 218
 219     logger.debug("load busy_ports: %s"%str(config["busy_ports"]))
 220
 221     busy_ports = config["busy_ports"]
 222     # release lock
 223     __release_lock(lock)
 224
 225     return busy_ports
 226 #