bin/killSalomeWithPort.py

   1 #! /usr/bin/env python
   2 #  -*- coding: iso-8859-1 -*-
   3 # Copyright (C) 2007-2016  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
  25 ## \file killSalomeWithPort.py
  26 #  Stop all %SALOME servers from given sessions by killing them
  27 #
  28 #  The sessions are indicated by their ports on the command line as in :
  29 #  \code
  30 #  killSalomeWithPort.py 2811 2815
  31 #  \endcode
  32 #
  33
  34 import os, sys, pickle, signal, commands,glob
  35 import subprocess
  36 import shlex
  37 from salome_utils import verbose
  38
  39
  40 def getPiDict(port,appname='salome',full=True,hidden=True,hostname=None):
  41     """
  42     Get file with list of SALOME processes.
  43     This file is located in the user's home directory
  44     and named .<user>_<host>_<port>_SALOME_pidict
  45     where
  46     <user> is user name
  47     <host> is host name
  48     <port> is port number
  49
  50     Parameters:
  51     - port    : port number
  52     - appname : application name (default is 'SALOME')
  53     - full    : if True, full path to the file is returned, otherwise only file name is returned
  54     - hidden  : if True, file name is prefixed with . (dot) symbol; this internal parameter is used
  55     to support compatibility with older versions of SALOME
  56     """
  57     # bug fix: ensure port is an integer
  58     # Note: this function is also called with port='#####' !!!
  59     try:
  60         port = int(port)
  61     except:
  62         pass
  63
  64     from salome_utils import generateFileName, getLogDir
  65     dir = ""
  66     if not hostname:
  67         hostname = os.getenv("NSHOST")
  68         if hostname: hostname = hostname.split(".")[0]
  69         pass
  70     if full:
  71         # full path to the pidict file is requested
  72         if hidden:
  73             # new-style dot-prefixed pidict files
  74             # are in the system-dependant temporary diretory
  75             dir = getLogDir()
  76         else:
  77             # old-style non-dot-prefixed pidict files
  78             # are in the user's home directory
  79             dir = os.getenv("HOME")
  80             pass
  81         pass
  82
  83     return generateFileName(dir,
  84                             suffix="pidict",
  85                             hidden=hidden,
  86                             with_username=True,
  87                             with_hostname=hostname or True,
  88                             with_port=port,
  89                             with_app=appname.upper())
  90
  91 def appliCleanOmniOrbConfig(port):
  92     """
  93     Remove omniorb config files related to the port in SALOME application:
  94     - ${OMNIORB_USER_PATH}/.omniORB_${USER}_${HOSTNAME}_${NSPORT}.cfg
  95     - ${OMNIORB_USER_PATH}/.omniORB_${USER}_last.cfg
  96     the last is removed only if the link points to the first file.
  97     """
  98     if verbose():
  99         print "clean OmniOrb config for port %s"%port
 100
 101     from salome_utils import generateFileName, getUserName
 102     omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
 103     if omniorbUserPath is None:
 104         #Run outside application context
 105         pass
 106     else:
 107         omniorb_config      = generateFileName(omniorbUserPath, prefix="omniORB",
 108                                                extension="cfg",
 109                                                hidden=True,
 110                                                with_username=True,
 111                                                with_hostname=True,
 112                                                with_port=port)
 113         last_running_config = generateFileName(omniorbUserPath, prefix="omniORB",
 114                                                with_username=True,
 115                                                suffix="last",
 116                                                extension="cfg",
 117                                                hidden=True)
 118         if os.access(last_running_config,os.F_OK):
 119             if not sys.platform == 'win32':
 120                 pointedPath = os.readlink(last_running_config)
 121                 if pointedPath[0] != '/':
 122                     pointedPath=os.path.join(os.path.dirname(last_running_config), pointedPath)
 123                     pass
 124                 if pointedPath == omniorb_config:
 125                     os.unlink(last_running_config)
 126                     pass
 127                 pass
 128             else:
 129                 os.remove(last_running_config)
 130                 pass
 131             pass
 132
 133         if os.access(omniorb_config,os.F_OK):
 134             os.remove(omniorb_config)
 135             pass
 136
 137         if os.path.lexists(last_running_config):return
 138
 139         #try to relink last.cfg to an existing config file if any
 140         files = glob.glob(os.path.join(omniorbUserPath,".omniORB_"+getUserName()+"_*.cfg"))
 141         current_config=None
 142         current=0
 143         for f in files:
 144           stat=os.stat(f)
 145           if stat.st_atime > current:
 146             current=stat.st_atime
 147             current_config=f
 148         if current_config:
 149           if sys.platform == "win32":
 150             import shutil
 151             shutil.copyfile(os.path.normpath(current_config), last_running_config)
 152             pass
 153           else:
 154             os.symlink(os.path.normpath(current_config), last_running_config)
 155             pass
 156           pass
 157         pass
 158     pass
 159
 160 ########## kills all salome processes with the given port ##########
 161
 162 def shutdownMyPort(port, cleanup=True):
 163     """
 164     Shutdown SALOME session running on the specified port.
 165     Parameters:
 166     - port - port number
 167     """
 168     if not port: return
 169     # bug fix: ensure port is an integer
 170     port = int(port)
 171
 172     try:
 173         from PortManager import releasePort
 174         releasePort(port)
 175     except ImportError:
 176         pass
 177
 178     from salome_utils import generateFileName
 179
 180     # set OMNIORB_CONFIG variable to the proper file
 181     omniorbUserPath = os.getenv("OMNIORB_USER_PATH")
 182     kwargs = {}
 183     if omniorbUserPath is not None:
 184         kwargs["with_username"]=True
 185     else:
 186         omniorbUserPath = os.path.realpath(os.path.expanduser('~'))
 187     omniorb_config = generateFileName(omniorbUserPath, prefix="omniORB",
 188                                       extension="cfg",
 189                                       hidden=True,
 190                                       with_hostname=True,
 191                                       with_port=port,
 192                                       **kwargs)
 193     os.environ['OMNIORB_CONFIG'] = omniorb_config
 194     os.environ['NSPORT'] = str(port)
 195
 196     # give the chance to the servers to shutdown properly
 197     try:
 198         import time
 199         from omniORB import CORBA
 200
 201         from LifeCycleCORBA import LifeCycleCORBA
 202         # shutdown all
 203         orb = CORBA.ORB_init([''], CORBA.ORB_ID)
 204         lcc = LifeCycleCORBA(orb) # see (1)
 205         print "Terminating SALOME on port %s..."%(port)
 206         lcc.shutdownServers()
 207         # give some time to shutdown to complete
 208         time.sleep(1)
 209         # shutdown omniNames
 210         if cleanup:
 211             lcc.killOmniNames()
 212             time.sleep(1)
 213             pass
 214         pass
 215     except:
 216         pass
 217     exit(0) # see (1)
 218     pass
 219 # (1) If --shutdown-servers option is set to 1, session close procedure is
 220 # called twice: first explicitely by salome command, second by automatic
 221 # atexit to handle Ctrl-C. During second call, LCC does not exist anymore and
 222 # a RuntimeError is raised; we explicitely exit this function with code 0 to
 223 # prevent parent thread from crashing.
 224
 225 def __killMyPort(port, filedict):
 226     # bug fix: ensure port is an integer
 227     if port:
 228         port = int(port)
 229
 230     try:
 231         with open(filedict, 'r') as fpid:
 232             process_ids=pickle.load(fpid)
 233             for process_id in process_ids:
 234                 for pid, cmd in process_id.items():
 235                     if verbose(): print "stop process %s : %s"% (pid, cmd[0])
 236                     try:
 237                         from salome_utils import killpid
 238                         killpid(int(pid))
 239                     except:
 240                         if verbose(): print "  ------------------ process %s : %s not found"% (pid, cmd[0])
 241                         pass
 242                     pass # for pid ...
 243                 pass # for process_id ...
 244             # end with
 245     except:
 246         print "Cannot find or open SALOME PIDs file for port", port
 247         pass
 248     os.remove(filedict)
 249     pass
 250 #
 251
 252 def __guessPiDictFilename(port):
 253     from salome_utils import getShortHostName, getHostName
 254     filedicts = [
 255         # new-style dot-prefixed pidict file
 256         getPiDict(port, hidden=True),
 257         # provide compatibility with old-style pidict file (not dot-prefixed)
 258         getPiDict(port, hidden=False),
 259         # provide compatibility with old-style pidict file (short hostname)
 260         getPiDict(port, hidden=True, hostname=getShortHostName()),
 261         # provide compatibility with old-style pidict file (not dot-prefixed, short hostname
 262         getPiDict(port, hidden=False, hostname=getShortHostName()),
 263         # provide compatibility with old-style pidict file (long hostname)
 264         getPiDict(port, hidden=True, hostname=getHostName()),
 265         # provide compatibility with old-style pidict file (not dot-prefixed, long hostname)
 266         getPiDict(port, hidden=False, hostname=getHostName())
 267         ]
 268
 269     log_msg = ""
 270     for filedict in filedicts:
 271         log_msg += "Trying %s..."%filedict
 272         if os.path.exists(filedict):
 273             log_msg += "   ... OK\n"
 274             break
 275         else:
 276             log_msg += "   ... not found\n"
 277
 278     if verbose():
 279         print log_msg
 280
 281     return filedict
 282 #
 283
 284 def killMyPort(port):
 285     """
 286     Kill SALOME session running on the specified port.
 287     Parameters:
 288     - port - port number
 289     """
 290     # bug fix: ensure port is an integer
 291     if port:
 292         port = int(port)
 293
 294     try:
 295         import PortManager # do not remove! Test for PortManager availability!
 296         filedict = getPiDict(port)
 297         if not os.path.isfile(filedict): # removed by previous call, see (1)
 298             if verbose():
 299                 print "SALOME on port %s: already removed by previous call"%port
 300             # Remove port from PortManager config file
 301             try:
 302                 from PortManager import releasePort
 303                 if verbose():
 304                     print "Removing port from PortManager configuration file"
 305                 releasePort(port)
 306             except ImportError:
 307                 pass
 308             return
 309     except:
 310         pass
 311
 312     # try to shutdown session normally
 313     import threading, time
 314     threading.Thread(target=shutdownMyPort, args=(port,True)).start()
 315     time.sleep(3) # wait a little, then kill processes (should be done if shutdown procedure hangs up)
 316
 317     try:
 318         import PortManager # do not remove! Test for PortManager availability!
 319         filedict = getPiDict(port)
 320         #filedict = __guessPiDictFilename(port)
 321         import glob
 322         all_files = glob.glob("%s*"%filedict)
 323         for f in all_files:
 324             __killMyPort(port, f)
 325     except ImportError:
 326         filedict = __guessPiDictFilename(port)
 327         __killMyPort(port, filedict)
 328     #
 329
 330     appliCleanOmniOrbConfig(port)
 331     pass
 332
 333 def cleanApplication(port):
 334     """
 335     Clean application running on the specified port.
 336     Parameters:
 337     - port - port number
 338     """
 339     # bug fix: ensure port is an integer
 340     if port:
 341         port = int(port)
 342
 343     try:
 344         filedict=getPiDict(port)
 345         os.remove(filedict)
 346     except:
 347       #import traceback
 348       #traceback.print_exc()
 349       pass
 350
 351     appliCleanOmniOrbConfig(port)
 352     pass
 353
 354 def killMyPortSpy(pid, port):
 355     dt = 1.0
 356     while 1:
 357         from salome_utils import killpid
 358         ret = killpid(int(pid), 0)
 359         if ret == 0:
 360             break
 361         elif ret < 0:
 362             return
 363         from time import sleep
 364         sleep(dt)
 365         pass
 366     filedict = getPiDict(port, hidden=True)
 367     if not os.path.exists(filedict):
 368         return
 369     try:
 370         import omniORB
 371         orb = omniORB.CORBA.ORB_init(sys.argv, omniORB.CORBA.ORB_ID)
 372         import SALOME_NamingServicePy
 373         ns = SALOME_NamingServicePy.SALOME_NamingServicePy_i(orb)
 374         import SALOME #@UnresolvedImport @UnusedImport
 375         session = ns.Resolve("/Kernel/Session")
 376         assert session
 377     except:
 378         return
 379     try:
 380         status = session.GetStatSession()
 381     except:
 382         # -- session is in naming service but has crash
 383         status = None
 384         pass
 385     if status:
 386         if not status.activeGUI:
 387             return
 388         pass
 389     killMyPort(port)
 390     return
 391
 392 if __name__ == "__main__":
 393     if len(sys.argv) < 2:
 394         print "Usage: "
 395         print "  %s <port>" % os.path.basename(sys.argv[0])
 396         print
 397         print "Kills SALOME session running on specified <port>."
 398         sys.exit(1)
 399         pass
 400     if sys.argv[1] == "--spy":
 401         if len(sys.argv) > 3:
 402             pid = sys.argv[2]
 403             port = sys.argv[3]
 404             killMyPortSpy(pid, port)
 405             pass
 406         sys.exit(0)
 407         pass
 408     try:
 409         from salomeContextUtils import setOmniOrbUserPath #@UnresolvedImport
 410         setOmniOrbUserPath()
 411     except Exception, e:
 412         print e
 413         sys.exit(1)
 414     for port in sys.argv[1:]:
 415         killMyPort(port)
 416         pass
 417     pass