2 # -*- coding: iso-8859-1 -*-
3 # Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
5 # Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
6 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
22 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
26 # \brief Module that provides services to launch SALOME
29 import sys, os, string, glob, time, pickle, re
33 from launchConfigureParser import verbose
34 from server import process_id
36 if sys.platform == "win32":
41 # -----------------------------------------------------------------------------
43 from killSalome import killAllPorts
47 kill servers from a previous SALOME exection, if needed,
48 on the CORBA port given in args of runSalome
51 from killSalomeWithPort import killMyPort
52 my_port=str(args['port'])
56 print "problem in killLocalPort()"
60 def givenPortKill(port):
62 kill servers from a previous SALOME exection, if needed,
63 on the same CORBA port
66 from killSalomeWithPort import killMyPort
71 print "problem in LocalPortKill(), killMyPort("<<port<<")"
75 def kill_salome(args):
77 Kill servers from previous SALOME executions, if needed;
78 depending on args 'killall' or 'portkill', kill all executions,
79 or only execution on the same CORBA port
84 elif args['portkill']:
85 givenPortKill(str(args['port']))
87 # -----------------------------------------------------------------------------
89 # Class definitions to launch CORBA Servers
92 class InterpServer(Server):
93 def __init__(self,args):
95 if sys.platform != "win32":
96 env_ld_library_path=['env', 'LD_LIBRARY_PATH=' + os.getenv("LD_LIBRARY_PATH")]
97 self.CMD=['xterm', '-e']+ env_ld_library_path + ['python']
99 self.CMD=['cmd', '/c', 'start cmd.exe', '/K', 'python']
104 print "INTERPSERVER::command = ", command
105 if sys.platform == "win32":
107 pid = win32pm.spawnpid( string.join(command, " "),'-nc' )
109 pid = os.spawnvp(os.P_NOWAIT, command[0], command)
110 process_id[pid]=self.CMD
115 def get_cata_path(list_modules,modules_root_dir):
116 """Build a list of catalog paths (cata_path) to initialize the ModuleCatalog server
121 for module in list_modules:
122 if modules_root_dir.has_key(module):
123 module_root_dir=modules_root_dir[module]
124 module_cata=module+"Catalog.xml"
125 cata_file=os.path.join(module_root_dir, "share",setenv.salome_subdir, "resources",module.lower(), module_cata)
127 if os.path.exists(cata_file):
128 cata_path.append(cata_file)
129 modules_cata[module]=cata_file
131 cata_file=os.path.join(module_root_dir, "share",setenv.salome_subdir, "resources", module_cata)
132 if os.path.exists(cata_file):
133 cata_path.append(cata_file)
134 modules_cata[module]=cata_file
136 for path in os.getenv("SALOME_CATALOGS_PATH","").split(SEP):
137 if os.path.exists(path):
138 for cata_file in glob.glob(os.path.join(path,"*Catalog.xml")):
139 module_name= os.path.basename(cata_file)[:-11]
140 if not modules_cata.has_key(module_name):
141 cata_path.append(cata_file)
142 modules_cata[module_name]=cata_file
148 class CatalogServer(Server):
149 def __init__(self,args):
152 self.SCMD1=['SALOME_ModuleCatalog_Server','-common']
154 home_dir=os.getenv('HOME')
155 if home_dir is not None:
156 self.SCMD2=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
158 def setpath(self,modules_list,modules_root_dir):
159 list_modules = modules_list[:]
160 list_modules.reverse()
161 if self.args["gui"] :
162 list_modules = ["KERNEL", "GUI"] + list_modules
164 list_modules = ["KERNEL"] + list_modules
166 cata_path=get_cata_path(list_modules,modules_root_dir)
168 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
172 class SalomeDSServer(Server):
173 def __init__(self,args):
176 self.CMD=['SALOMEDS_Server']
180 class ConnectionManagerServer(Server):
181 def __init__(self,args):
184 self.CMD=['SALOME_ConnectionManagerServer']
188 class RegistryServer(Server):
189 def __init__(self,args):
192 self.CMD=['SALOME_Registry_Server', '--salome_session','theSession']
196 class ContainerCPPServer(Server):
197 def __init__(self,args):
200 self.CMD=['SALOME_Container','FactoryServer']
204 class ContainerPYServer(Server):
205 def __init__(self,args):
208 if sys.platform == "win32":
209 self.CMD=[os.environ["PYTHONBIN"], '\"'+os.environ["KERNEL_ROOT_DIR"] + '/bin/salome/SALOME_ContainerPy.py'+'\"','FactoryServerPy']
211 self.CMD=['SALOME_ContainerPy.py','FactoryServerPy']
215 class LoggerServer(Server):
216 def __init__(self,args):
219 from salome_utils import generateFileName
220 if sys.platform == "win32": dirpath = os.environ["HOME"]
221 else: dirpath = "/tmp"
222 logfile = generateFileName( dirpath,
228 print "==========================================================="
229 print "Logger server: put log to the file:"
231 print "==========================================================="
232 self.CMD=['SALOME_Logger_Server', logfile]
234 pass # end of LoggerServer class
238 class SessionServer(Server):
239 def __init__(self,args,modules_list,modules_root_dir):
240 self.args = args.copy()
241 # Bug 11512 (Problems with runSalome --xterm on Mandrake and Debian Sarge)
242 #self.args['xterm']=0
245 self.SCMD1=['SALOME_Session_Server']
247 if 'registry' in self.args['embedded']:
248 self.SCMD1+=['--with','Registry',
249 '(','--salome_session','theSession',')']
250 if 'moduleCatalog' in self.args['embedded']:
251 self.SCMD1+=['--with','ModuleCatalog','(','-common']
252 home_dir=os.getenv('HOME')
253 if home_dir is not None:
254 self.SCMD2+=['-personal',os.path.join(home_dir,'Salome/resources/CatalogModulePersonnel.xml')]
256 if 'study' in self.args['embedded']:
257 self.SCMD2+=['--with','SALOMEDS','(',')']
258 if 'cppContainer' in self.args['embedded']:
259 self.SCMD2+=['--with','Container','(','FactoryServer',')']
260 if 'SalomeAppEngine' in self.args['embedded']:
261 self.SCMD2+=['--with','SalomeAppEngine','(',')']
263 if 'cppContainer' in self.args['standalone'] or 'cppContainer' in self.args['embedded']:
265 if 'pyContainer' in self.args['standalone'] or 'pyContainer' in self.args['embedded']:
269 if self.args.has_key('session_gui'):
270 session_gui = self.args['session_gui']
273 if self.args['splash']:
274 self.SCMD2+=['SPLASH']
276 if self.args['study_hdf'] is not None:
277 self.SCMD2+=['--study-hdf=%s'%self.args['study_hdf']]
281 if self.args['noexcepthandler']:
282 self.SCMD2+=['noexcepthandler']
283 if self.args.has_key('user_config'):
284 self.SCMD2+=['--resources=%s'%self.args['user_config']]
285 if self.args.has_key('modules'):
287 #keep only modules with GUI
288 for m in modules_list:
289 if os.path.exists(os.path.join(modules_root_dir[m],"share","salome","resources",m.lower(),"SalomeApp.xml")):
290 list_modules.insert(0,m)
291 self.SCMD2+=['--modules (%s)' % ":".join(list_modules)]
293 if self.args.has_key('pyscript') and len(self.args['pyscript']) > 0:
294 self.SCMD2+=['--pyscript=%s'%(",".join(self.args['pyscript']))]
296 def setpath(self,modules_list,modules_root_dir):
297 list_modules = modules_list[:]
298 list_modules.reverse()
299 if self.args["gui"] :
300 list_modules = ["KERNEL", "GUI"] + list_modules
302 list_modules = ["KERNEL"] + list_modules
304 cata_path=get_cata_path(list_modules,modules_root_dir)
306 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
307 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
308 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
310 self.CMD=self.SCMD1 + self.SCMD2
311 if self.args.has_key('test'):
312 self.CMD+=['-test'] + self.args['test']
313 elif self.args.has_key('play'):
314 self.CMD+=['-play'] + self.args['play']
316 if self.args["gdb_session"] or self.args["ddd_session"]:
317 f = open(".gdbinit4salome", "w")
319 args = " ".join(self.CMD[1:])
320 args = args.replace("(", "\(")
321 args = args.replace(")", "\)")
325 if self.args["ddd_session"]:
326 self.CMD = ["ddd", "--command=.gdbinit4salome", self.CMD[0]]
327 elif self.args["gdb_session"]:
328 self.CMD = ["xterm", "-e", "gdb", "--command=.gdbinit4salome", self.CMD[0]]
332 if self.args["valgrind_session"]:
334 val = os.getenv("VALGRIND_OPTIONS")
338 self.CMD = l + self.CMD
343 class LauncherServer(Server):
344 def __init__(self,args):
347 self.SCMD1=['SALOME_LauncherServer']
350 if 'registry' in self.args['embedded']:
351 self.SCMD1+=['--with','Registry',
352 '(','--salome_session','theSession',')']
353 if 'moduleCatalog' in self.args['embedded']:
354 self.SCMD1+=['--with','ModuleCatalog','(','-common']
355 self.SCMD2+=['-personal',
356 '${HOME}/Salome/resources/CatalogModulePersonnel.xml',')']
357 if 'study' in self.args['embedded']:
358 self.SCMD2+=['--with','SALOMEDS','(',')']
359 if 'cppContainer' in self.args['embedded']:
360 self.SCMD2+=['--with','Container','(','FactoryServer',')']
362 def setpath(self,modules_list,modules_root_dir):
363 list_modules = modules_list[:]
364 list_modules.reverse()
365 if self.args["gui"] :
366 list_modules = ["KERNEL", "GUI"] + list_modules
368 list_modules = ["KERNEL"] + list_modules
370 cata_path=get_cata_path(list_modules,modules_root_dir)
372 if (self.args["gui"]) & ('moduleCatalog' in self.args['embedded']):
373 #Use '::' instead ":" because drive path with "D:\" is invalid on windows platform
374 self.CMD=self.SCMD1 + ['"' + string.join(cata_path,'"::"') + '"'] + self.SCMD2
376 self.CMD=self.SCMD1 + self.SCMD2
378 class NotifyServer(Server):
379 def __init__(self,args,modules_root_dir):
382 self.modules_root_dir=modules_root_dir
383 myLogName = os.environ["LOGNAME"]
384 self.CMD=['notifd','-c',
385 self.modules_root_dir["KERNEL"] +'/share/salome/resources/kernel/channel.cfg',
386 '-DFactoryIORFileName=/tmp/'+myLogName+'_rdifact.ior',
387 '-DChannelIORFileName=/tmp/'+myLogName+'_rdichan.ior',
388 '-DReportLogFile=/tmp/'+myLogName+'_notifd.report',
389 '-DDebugLogFile=/tmp/'+myLogName+'_notifd.debug',
393 # -----------------------------------------------------------------------------
396 """Salome Session Graphic User Interface activation"""
400 import SALOME_ModuleCatalog
401 import SALOME_Session_idl
402 session=clt.waitNS("/Kernel/Session",SALOME.Session)
403 session.GetInterface()
405 # -----------------------------------------------------------------------------
407 def startSalome(args, modules_list, modules_root_dir):
408 """Launch all SALOME servers requested by args"""
409 init_time = os.times()
411 if verbose(): print "startSalome ", args
414 # Initialisation ORB and Naming Service
417 clt=orbmodule.client(args)
418 # Save Naming service port name into
419 # the file args["ns_port_log_file"]
420 if args.has_key('ns_port_log_file'):
421 home = os.environ['HOME']
422 appli= os.environ.get("APPLI")
423 if appli is not None:
424 home='%s/%s'%(home,appli)
426 file_name= '%s/%s'%(home, args["ns_port_log_file"])
427 f = open(file_name, "w")
428 f.write(os.environ['NSPORT'])
431 # Launch Logger Server (optional)
432 # and wait until it is registered in naming service
436 myServer=LoggerServer(args)
438 clt.waitLogger("Logger")
440 # Notify Server launch
443 if sys.platform != "win32":
444 if verbose(): print "Notify Server to launch"
446 myServer=NotifyServer(args,modules_root_dir)
449 # Launch Session Server (to show splash ASAP)
453 mySessionServ = SessionServer(args,modules_list,modules_root_dir)
454 mySessionServ.setpath(modules_list,modules_root_dir)
458 # Launch Registry Server,
459 # and wait until it is registered in naming service
462 if ('registry' not in args['embedded']) | (args["gui"] == 0) :
463 myServer=RegistryServer(args)
465 if sys.platform == "win32":
466 clt.waitNS("/Registry")
468 clt.waitNSPID("/Registry",myServer.PID)
471 # Launch Catalog Server,
472 # and wait until it is registered in naming service
475 if ('moduleCatalog' not in args['embedded']) | (args["gui"] == 0):
476 cataServer=CatalogServer(args)
477 cataServer.setpath(modules_list,modules_root_dir)
479 import SALOME_ModuleCatalog
480 if sys.platform == "win32":
481 clt.waitNS("/Kernel/ModulCatalog",SALOME_ModuleCatalog.ModuleCatalog)
483 clt.waitNSPID("/Kernel/ModulCatalog",cataServer.PID,SALOME_ModuleCatalog.ModuleCatalog)
486 # Launch SalomeDS Server,
487 # and wait until it is registered in naming service
490 #print "ARGS = ",args
491 if ('study' not in args['embedded']) | (args["gui"] == 0):
493 myServer=SalomeDSServer(args)
495 if sys.platform == "win32":
496 clt.waitNS("/myStudyManager")
498 clt.waitNSPID("/myStudyManager",myServer.PID)
501 # Launch LauncherServer
504 myCmServer = LauncherServer(args)
505 myCmServer.setpath(modules_list,modules_root_dir)
509 # Launch ConnectionManagerServer
512 myConnectionServer = ConnectionManagerServer(args)
513 myConnectionServer.run()
516 from Utils_Identity import getShortHostName
518 if os.getenv("HOSTNAME") == None:
519 if os.getenv("HOST") == None:
520 os.environ["HOSTNAME"]=getShortHostName()
522 os.environ["HOSTNAME"]=os.getenv("HOST")
524 theComputer = getShortHostName()
527 # Launch local C++ Container (FactoryServer),
528 # and wait until it is registered in naming service
531 if ('cppContainer' in args['standalone']) | (args["gui"] == 0) :
532 myServer=ContainerCPPServer(args)
534 if sys.platform == "win32":
535 clt.waitNS("/Containers/" + theComputer + "/FactoryServer")
537 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServer",myServer.PID)
540 # Launch local Python Container (FactoryServerPy),
541 # and wait until it is registered in naming service
544 if 'pyContainer' in args['standalone']:
545 myServer=ContainerPYServer(args)
547 if sys.platform == "win32":
548 clt.waitNS("/Containers/" + theComputer + "/FactoryServerPy")
550 clt.waitNSPID("/Containers/" + theComputer + "/FactoryServerPy",myServer.PID)
553 # Wait until Session Server is registered in naming service
561 import SALOME_ModuleCatalog
562 import SALOME_Session_idl
563 if sys.platform == "win32":
564 session=clt.waitNS("/Kernel/Session",SALOME.Session)
566 session=clt.waitNSPID("/Kernel/Session",mySessionServ.PID,SALOME.Session)
567 end_time = os.times()
569 print "Start SALOME, elapsed time : %5.1f seconds"% (end_time[4]
572 # ASV start GUI without Loader
574 # session.GetInterface()
577 # additionnal external python interpreters
583 nbaddi = args['interp']
586 traceback.print_exc()
587 print "-------------------------------------------------------------"
588 print "-- to get an external python interpreter:runSalome --interp=1"
589 print "-------------------------------------------------------------"
591 print "additional external python interpreters: ", nbaddi
593 for i in range(nbaddi):
595 anInterp=InterpServer(args)
598 # set PYTHONINSPECT variable (python interpreter in interactive mode)
600 os.environ["PYTHONINSPECT"]="1"
608 # -----------------------------------------------------------------------------
610 def useSalome(args, modules_list, modules_root_dir):
612 Launch all SALOME servers requested by args,
613 save list of process, give info to user,
614 show registered objects in Naming Service.
620 clt = startSalome(args, modules_list, modules_root_dir)
623 traceback.print_exc()
626 print "--- Error during Salome launch ---"
630 from addToKillList import addToKillList
631 from killSalomeWithPort import getPiDict
633 filedict = getPiDict(args['port'])
634 for pid, cmd in process_id.items():
635 addToKillList(pid, cmd, args['port'])
638 if verbose(): print """
639 Saving of the dictionary of Salome processes in %s
640 To kill SALOME processes from a console (kill all sessions from all ports):
642 To kill SALOME from the present interpreter, if it is not closed :
643 killLocalPort() --> kill this session
644 (use CORBA port from args of runSalome)
645 givenPortKill(port) --> kill a specific session with given CORBA port
646 killAllPorts() --> kill all sessions
648 runSalome, with --killall option, starts with killing
649 the processes resulting from the previous execution.
653 # Print Naming Service directory list
659 print " --- registered objects tree in Naming Service ---"
663 if not args['gui'] or not args['session_gui']:
664 if args['shutdown_servers']:
665 class __utils__(object):
666 def __init__(self, port):
668 import killSalomeWithPort
669 self.killSalomeWithPort = killSalomeWithPort
672 self.killSalomeWithPort.killMyPort(self.port)
675 args['shutdown_servers'] = __utils__(args['port'])
679 # run python scripts, passed via --execute option
681 if args.has_key('pyscript'):
682 if args.has_key('gui') and args.has_key('session_gui'):
683 if not args['gui'] or not args['session_gui']:
684 toimport = args['pyscript']
686 for srcname in toimport :
687 if srcname == 'killall':
692 if os.path.isabs(srcname):
693 if os.path.exists(srcname):
695 elif os.path.exists(srcname+".py"):
696 execScript(srcname+".py")
698 print "Can't execute file %s" % srcname
702 for path in [os.getcwd()] + sys.path:
703 if os.path.exists(os.path.join(path,srcname)):
704 execScript(os.path.join(path,srcname))
707 elif os.path.exists(os.path.join(path,srcname+".py")):
708 execScript(os.path.join(path,srcname+".py"))
713 print "Can't execute file %s" % srcname
721 def execScript(script_path):
722 print 'executing', script_path
723 sys.path.insert(0, os.path.dirname(script_path))
724 execfile(script_path,globals())
727 # -----------------------------------------------------------------------------
729 def registerEnv(args, modules_list, modules_root_dir):
731 Register args, modules_list, modules_root_dir in a file
732 for further use, when SALOME is launched embedded in an other application.
734 if sys.platform == "win32":
735 fileEnv = os.getenv('TEMP')
739 fileEnv += os.getenv('USER') + "_" + str(args['port']) \
740 + '_' + args['appname'].upper() + '_env'
741 fenv=open(fileEnv,'w')
742 pickle.dump((args, modules_list, modules_root_dir),fenv)
744 os.environ["SALOME_LAUNCH_CONFIG"] = fileEnv
746 # -----------------------------------------------------------------------------
748 def searchFreePort(args, save_config=1):
749 print "Searching for a free port for naming service:",
751 if sys.platform == "win32":
752 tmp_file = os.getenv('TEMP');
755 tmp_file = os.path.join(tmp_file, '.netstat_%s'%os.getpid())
757 ###status = os.system("netstat -ltn | grep -E :%s > /dev/null 2>&1"%(NSPORT))
758 os.system( "netstat -a -n > %s" % tmp_file );
759 f = open( tmp_file, 'r' );
760 ports = f.readlines();
762 os.remove( tmp_file );
764 def portIsUsed(port, data):
765 regObj = re.compile( ".*tcp.*:([0-9]+).*:.*listen", re.IGNORECASE );
768 p = int(regObj.match(item).group(1))
769 if p == port: return True
780 if not portIsUsed(NSPORT, ports):
781 print "%s - OK"%(NSPORT)
783 from salome_utils import generateFileName, getHostName
784 hostname = getHostName()
786 home = os.getenv("HOME")
787 appli = os.getenv("APPLI")
789 if appli is not None:
790 home = os.path.join(home, appli,"USERS")
791 kwargs["with_username"]=True
793 omniorb_config = generateFileName(home, prefix="omniORB",
800 initref = "NameService=corbaname::%s:%s"%(hostname, NSPORT)
801 from omniORB import CORBA
802 if CORBA.ORB_ID == "omniORB4":
803 orbdata.append("InitRef = %s"%(initref))
804 orbdata.append("giopMaxMsgSize = 2097152000 # 2 GBytes")
805 orbdata.append("traceLevel = 0 # critical errors only")
807 orbdata.append("ORBInitRef %s"%(initref))
808 orbdata.append("ORBgiopMaxMsgSize = 2097152000 # 2 GBytes")
809 orbdata.append("ORBtraceLevel = 0 # critical errors only")
812 f = open(omniorb_config, "w")
813 f.write("\n".join(orbdata))
816 os.environ['OMNIORB_CONFIG'] = omniorb_config
817 os.environ['NSPORT'] = "%s"%(NSPORT)
818 os.environ['NSHOST'] = "%s"%(hostname)
819 args['port'] = os.environ['NSPORT']
822 last_running_config = generateFileName(home, prefix="omniORB",
828 if sys.platform == "win32":
830 shutil.copyfile(omniorb_config, last_running_config)
833 os.remove(last_running_config)
836 os.symlink(omniorb_config, last_running_config)
845 msg += "Can't find a free port to launch omniNames\n"
846 msg += "Try to kill the running servers and then launch SALOME again.\n"
847 raise RuntimeError, msg
852 # -----------------------------------------------------------------------------
855 """Salome Launch, when embedded in other application"""
856 fileEnv = os.environ["SALOME_LAUNCH_CONFIG"]
857 fenv=open(fileEnv,'r')
858 args, modules_list, modules_root_dir = pickle.load(fenv)
861 searchFreePort(args, 0)
862 clt = useSalome(args, modules_list, modules_root_dir)
865 # -----------------------------------------------------------------------------
868 """Salome launch as a main application"""
869 from salome_utils import getHostName
870 print "runSalome running on %s" % getHostName()
871 args, modules_list, modules_root_dir = setenv.get_config()
874 if args.has_key('save_config'):
875 save_config = args['save_config']
876 searchFreePort(args, save_config)
878 setenv.set_env(args, modules_list, modules_root_dir)
879 clt = useSalome(args, modules_list, modules_root_dir)
882 # -----------------------------------------------------------------------------
884 if __name__ == "__main__":