bin/killSalomeWithPort.py

   1 #! /usr/bin/env python3
   2 #  -*- coding: iso-8859-1 -*-
   3 # Copyright (C) 2007-2019  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, subprocess,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 directory
  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           from salome_utils import killOmniNames
 212           killOmniNames(port)
 213           filedict=getPiDict(port)
 214           __killMyPort(port, filedict)
 215           from PortManager import releasePort
 216           releasePort(port)
 217           time.sleep(1)
 218           pass
 219         pass
 220     except:
 221         pass
 222     sys.exit(0) # see (1)
 223     pass
 224 # (1) If --shutdown-servers option is set to 1, session close procedure is
 225 # called twice: first explicitly by salome command, second by automatic
 226 # atexit to handle Ctrl-C. During second call, LCC does not exist anymore and
 227 # a RuntimeError is raised; we explicitly exit this function with code 0 to
 228 # prevent parent thread from crashing.
 229
 230 def __killMyPort(port, filedict):
 231     # bug fix: ensure port is an integer
 232     if port:
 233         port = int(port)
 234
 235     try:
 236         with open(filedict, 'rb') as fpid:
 237             process_ids=pickle.load(fpid)
 238             for process_id in process_ids:
 239                 for pid, cmd in list(process_id.items()):
 240                     if verbose(): print("stop process %s : %s"% (pid, cmd[0]))
 241                     try:
 242                         from salome_utils import killpid
 243                         killpid(int(pid))
 244                     except:
 245                         if verbose(): print("  ------------------ process %s : %s not found"% (pid, cmd[0]))
 246                         pass
 247                     pass # for pid ...
 248                 pass # for process_id ...
 249             # end with
 250     except:
 251         print("Cannot find or open SALOME PIDs file for port", port)
 252         pass
 253     os.remove(filedict)
 254     pass
 255 #
 256
 257 def __guessPiDictFilename(port):
 258     from salome_utils import getShortHostName, getHostName
 259     filedicts = [
 260         # new-style dot-prefixed pidict file
 261         getPiDict(port, hidden=True),
 262         # provide compatibility with old-style pidict file (not dot-prefixed)
 263         getPiDict(port, hidden=False),
 264         # provide compatibility with old-style pidict file (short hostname)
 265         getPiDict(port, hidden=True, hostname=getShortHostName()),
 266         # provide compatibility with old-style pidict file (not dot-prefixed, short hostname
 267         getPiDict(port, hidden=False, hostname=getShortHostName()),
 268         # provide compatibility with old-style pidict file (long hostname)
 269         getPiDict(port, hidden=True, hostname=getHostName()),
 270         # provide compatibility with old-style pidict file (not dot-prefixed, long hostname)
 271         getPiDict(port, hidden=False, hostname=getHostName())
 272         ]
 273
 274     log_msg = ""
 275     for filedict in filedicts:
 276         log_msg += "Trying %s..."%filedict
 277         if os.path.exists(filedict):
 278             log_msg += "   ... OK\n"
 279             break
 280         else:
 281             log_msg += "   ... not found\n"
 282
 283     if verbose():
 284         print(log_msg)
 285
 286     return filedict
 287 #
 288
 289 def killMyPort(port):
 290     """
 291     Kill SALOME session running on the specified port.
 292     Parameters:
 293     - port - port number
 294     """
 295     # bug fix: ensure port is an integer
 296     if port:
 297         port = int(port)
 298
 299     try:
 300         import PortManager # do not remove! Test for PortManager availability!
 301         filedict = getPiDict(port)
 302         if not os.path.isfile(filedict): # removed by previous call, see (1)
 303             if verbose():
 304                 print("SALOME on port %s: already removed by previous call"%port)
 305             # Remove port from PortManager config file
 306             try:
 307                 from PortManager import releasePort
 308                 if verbose():
 309                     print("Removing port from PortManager configuration file")
 310                 releasePort(port)
 311             except ImportError:
 312                 pass
 313             return
 314     except:
 315         pass
 316
 317     # try to shutdown session normally
 318     import threading, time
 319     threading.Thread(target=shutdownMyPort, args=(port,True)).start()
 320     time.sleep(3) # wait a little, then kill processes (should be done if shutdown procedure hangs up)
 321
 322     try:
 323         import PortManager # do not remove! Test for PortManager availability!
 324         filedict = getPiDict(port)
 325         #filedict = __guessPiDictFilename(port)
 326         import glob
 327         all_files = glob.glob("%s*"%filedict)
 328         for f in all_files:
 329             __killMyPort(port, f)
 330     except ImportError:
 331         filedict = __guessPiDictFilename(port)
 332         __killMyPort(port, filedict)
 333     #
 334
 335     appliCleanOmniOrbConfig(port)
 336     pass
 337
 338 def cleanApplication(port):
 339     """
 340     Clean application running on the specified port.
 341     Parameters:
 342     - port - port number
 343     """
 344     # bug fix: ensure port is an integer
 345     if port:
 346         port = int(port)
 347
 348     try:
 349         filedict=getPiDict(port)
 350         os.remove(filedict)
 351     except:
 352       #import traceback
 353       #traceback.print_exc()
 354       pass
 355
 356     appliCleanOmniOrbConfig(port)
 357     pass
 358
 359 def killMyPortSpy(pid, port):
 360     dt = 1.0
 361     while 1:
 362         from salome_utils import killpid
 363         ret = killpid(int(pid), 0)
 364         if ret == 0:
 365             break
 366         elif ret < 0:
 367             return
 368         from time import sleep
 369         sleep(dt)
 370         pass
 371     filedict = getPiDict(port, hidden=True)
 372     if not os.path.exists(filedict):
 373         return
 374     try:
 375         import omniORB
 376         orb = omniORB.CORBA.ORB_init(sys.argv, omniORB.CORBA.ORB_ID)
 377         import SALOME_NamingServicePy
 378         ns = SALOME_NamingServicePy.SALOME_NamingServicePy_i(orb)
 379         import SALOME #@UnresolvedImport @UnusedImport
 380         session = ns.Resolve("/Kernel/Session")
 381         assert session
 382     except:
 383         return
 384     try:
 385         status = session.GetStatSession()
 386     except:
 387         # -- session is in naming service but has crash
 388         status = None
 389         pass
 390     if status:
 391         if not status.activeGUI:
 392             return
 393         pass
 394     killMyPort(port)
 395     return
 396
 397 if __name__ == "__main__":
 398     if len(sys.argv) < 2:
 399         print("Usage: ")
 400         print("  %s <port>" % os.path.basename(sys.argv[0]))
 401         print()
 402         print("Kills SALOME session running on specified <port>.")
 403         sys.exit(1)
 404         pass
 405     if sys.argv[1] == "--spy":
 406         if len(sys.argv) > 3:
 407             pid = sys.argv[2]
 408             port = sys.argv[3]
 409             killMyPortSpy(pid, port)
 410             pass
 411         sys.exit(0)
 412         pass
 413     try:
 414         from salomeContextUtils import setOmniOrbUserPath #@UnresolvedImport
 415         setOmniOrbUserPath()
 416     except Exception as e:
 417         print(e)
 418         sys.exit(1)
 419     for port in sys.argv[1:]:
 420         killMyPort(port)
 421         pass
 422     pass