Functions
def	initializeSALOME ()

def	SALOMEInitializationNeeded (func)

def	loadGraph (xmlFileName)

def	patchGraph (proc, squeezeMemory, initPorts, xmlSchema, loadStateXmlFile, reset, display)

def	prepareExecution (proc, isStop, dumpErrorFile)

def	executeGraph (executor, xmlfilename, proc, dump, finalDump, display, shutdown, CPUMemContainerTimeRes, HTopOfThisProcessFile, HTopTimeRes, HTopOfAllServersFile, HTopOfAllServersTimeRes, DirectoriesToMonitor)

def	EntryFromCoarseEntry (entry)

def	toDict (args)

def	reprAfterArgParsing (args)

def	getArgumentParser ()

def	mainRun (args, xmlFileName)

def	parseArgs ()

Variables
string	DisplayEntryInCMD = "--display"

string	VerboseEntryInCMD = "--verbose"

string	VerboseLevelEntryInCMD = "--verbose-level"

string	StopOnErrorEntryInCMD = "--stop-on-error"

string	DumpOnErrorEntryInCMD = "--dump-on-error"

string	DumpEntryInCMD = "--dump"

string	KernelTraceEntryInCMD = "--kerneltrace"

string	DumpStateEntryInCMD = "--dump-final"

string	LoadStateEntryInCMD = "--load-state"

string	SaveXMLSchemaEntryInCMD = "--save-xml-schema"

string	ShutdownEntryInCMD = "--shutdown"

string	ResetEntryInCMD = "--reset"

string	InitPortEntryInCMD = "--init-port"

string	DoNotSqueezeEntryInCMD = "--donotsqueeze"

string	IOREntryInCMD = "--ior-ns"

string	CPUTimeResOfContainerEntryInCMD = "--cpu-mem-container-time-res"

string	HTOPFileEntryInCMD = "--htop-of-yacs-engine-process-file"

string	HTOPServerFileEntryInCMD = "--htop-of-servers"

string	HTOPFileTimeResEntryInCMD = "--htop-of-yacs-engine-process-time-res"

string	HTOPServerFileTimeResEntryInCMD = "--htop-of-servers-time-res"

string	MonitoringDirsEntryInCMD = "--monitoring-dirs-content"

string	MonitoringDirsResEntryInCMD = "--monitoring-dirs-content-res"

string	MonitoringDirsTimeResEntryInCMD = "--monitoring-dirs-content-time-res"

string	ReplayOnErrorEntryInCMD = "--replay-on-error"

string	ReplayDirInCMD = "--replay-dir"

string	BigObjDirInCMD = "--bigobj-dir"

string	BigObjThresInCMD = "--bigobj-thres"

string	CustomOverridesInCMD = "--activate-custom-overrides"

string	DisplayKeyInARGS = "display"

string	VerboseKeyInARGS = "verbose"

string	VerboseLevelKeyInARGS = "verbose_level"

string	StopOnErrorKeyInARGS = "stop"

string	DumpOnErrorKeyInARGS = "dumpErrorFile"

string	DumpKeyInARGS = "dump"

string	KernelTraceKeyInARGS = "kerneltrace"

string	DumpStateKeyInARGS = "finalDump"

string	LoadStateKeyInARGS = "loadState"

string	SaveXMLSchemaKeyInARGS = "saveXMLSchema"

string	ShutdownKeyInARGS = "shutdown"

string	ResetKeyInARGS = "reset"

string	InitPortKeyInARGS = "init_port"

string	DoNotSqueezeKeyInARGS = "donotsqueeze"

string	IORKeyInARGS = "iorNS"

string	CPUTimeResOfContainerKeyInARGS = "cpu_mem_container_time_res"

string	HTOPFileKeyInARGS = "htop_of_yacs_engine_process_file"

string	HTOPServerFileKeyInARGS = "htop_of_servers"

string	HTOPFileTimeResKeyInARGS = "htop_of_yacs_engine_process_time_res"

string	HTOPServerFileTimeResKeyInARGS = "htop_of_servers_time_res"

string	MonitoringDirsInARGS = "monitoring_dirs_content"

string	MonitoringDirsResInARGS = "monitoring_dirs_content_res"

string	MonitoringDirsTimeResInARGS = "monitoring_dirs_content_time_res"

string	ReplayOnErrorEntryInARGS = "replay_on_error"

string	ReplayDirInARGS = "replay_dir"

string	BigObjDirInARGS = "bigobj_dir"

string	BigObjThresInARGS = "bigobj_thres"

string	CustomOverridesInARGS = "activate_custom_overrides"

list	KeyValnARGS

	my_runtime_yacs = None

	my_ior_ns = None

bool	my_replay_on_error = False

string	my_replay_dir = ""

	args

	xmlFileName

	_proc

	_shutdown

	_dumpFile

	_lockFile

	_dump_thread

Function Documentation

◆ EntryFromCoarseEntry()

def driver_internal.EntryFromCoarseEntry ( entry )

Definition at line 338 of file driver_internal.py.

 def EntryFromCoarseEntry( entry ):
   if entry[:2] != "--":
     raise RuntimeError("Unexpected entry")
   return entry[2:]
  

Referenced by parseArgs(), and toDict().

◆ executeGraph()

def driver_internal.executeGraph	(	executor,
		xmlfilename,
		proc,
		dump,
		finalDump,
		display,
		shutdown,
		CPUMemContainerTimeRes,
		HTopOfThisProcessFile,
		HTopTimeRes,
		HTopOfAllServersFile,
		HTopOfAllServersTimeRes,
		DirectoriesToMonitor
	)

Args:
-----

executor (pilot.ExecutorSwig) : Executor in charge of evaluation.
proc ( SALOMERuntime.SalomeProc ) : YACS Proc instance to be evaluated
xmlfilename (string)
dump (int) : time interval between 2 dump state
finalDump ( string ) : filename containing final result of graph, if any.
display (int) :
shutdown (int) : shutdown level
CPUMemContainerTimeRes (int) : time in second between two measures of CPU/Mem in container processes
HTopOfThisProcessFile (str) : file name (if not empty) containing the result of measure of current process
HTopTimeRes (int) : time in second between two measures of CPU/Mem of current process
HTopOfAllServersFile (str) : file name (if not empty) containing the result of measure of all servers
HTopOfAllServersTimeRes (int) : time in second between two measures of CPU/Mem of any of server

Definition at line 236 of file driver_internal.py.

                  HTopOfAllServersFile, HTopOfAllServersTimeRes, DirectoriesToMonitor):
   """
   Args:
   -----
  
   executor (pilot.ExecutorSwig) : Executor in charge of evaluation.
   proc ( SALOMERuntime.SalomeProc ) : YACS Proc instance to be evaluated
   xmlfilename (string)
   dump (int) : time interval between 2 dump state
   finalDump ( string ) : filename containing final result of graph, if any.
   display (int) :
   shutdown (int) : shutdown level
   CPUMemContainerTimeRes (int) : time in second between two measures of CPU/Mem in container processes
   HTopOfThisProcessFile (str) : file name (if not empty) containing the result of measure of current process
   HTopTimeRes (int) : time in second between two measures of CPU/Mem of current process
   HTopOfAllServersFile (str) : file name (if not empty) containing the result of measure of all servers
   HTopOfAllServersTimeRes (int) : time in second between two measures of CPU/Mem of any of server
   """
   import SALOMERuntime
   import pilot
   import os
   import contextlib
  
   class AutoShutdown:
     def __init__(self, proc, shutdown):
       self._proc = proc
       self._shutdown = shutdown
     def __enter__(self):
       pass
     
     def __exit__(self,exctype, exc, tb):
       if my_replay_on_error:
         listOfGrps = []
         for cont in salome.get_all_containers():
           listOfGrps += cont.getAllLogFileNameGroups()
         print("{} {} {}".format( 100*"=", "List of replay sessions of failing usecases" , 100*"="))
         for igrp,grp in enumerate(listOfGrps):
           print("{} : {}".format("Group {}".format(igrp)," ".join(grp)))
         print(300*"=")
       #
       if self._shutdown < 999:
         self._proc.shutdown(self._shutdown)
       salome.dsm.shutdownScopes()
       my_runtime_yacs.fini( False )
  
   class AutoDumpThread:
     def __init__(self, proc, dump, xmlfilename):
       self._dumpFile = "dumpState_{}".format( os.path.basename(xmlfilename) )
       self._lockFile = "{}.lock".format( os.path.splitext( os.path.basename(xmlfilename) )[0] )
     def __enter__(self):
       logging.info(f"Ready to launch thread of state dump with  dumpFile = {self._dumpFile}  lockFile = {self._lockFile}")
       self._dump_thread = SALOMERuntime.ThreadDumpState(proc,dump,self._dumpFile,self._lockFile)
       self._dump_thread.start()
     def __exit__(self,exctype, exc, tb):
       self._dump_thread.join()
   
   def MonitoringDirectories( DirectoriesToMonitor ):
     import SALOME_PyNode
     if len( DirectoriesToMonitor ) > 0:
       return [ SALOME_PyNode.GenericPythonMonitoringLauncherCtxMgr( SALOME_PyNode.FileSystemMonitoring(timeRes*1000,zeDir,zeDirRes) ) for zeDir,zeDirRes,timeRes in DirectoriesToMonitor ]
     else:
       return [ ]
  
   def MonitoringThisProcess(HTopOfThisProcessFile,HTopTimeRes):
     import SALOME_PyNode
     if HTopOfThisProcessFile:
       return [ SALOME_PyNode.GenericPythonMonitoringLauncherCtxMgr( SALOME_PyNode.CPUMemoryMonitoring(1000*HTopTimeRes,HTopOfThisProcessFile) ) ]
     else:
       return [ ]
     
   def MonitoringAllKernelServers(HTopOfAllServersFile, HTopOfAllServersTimeRes):
     if HTopOfAllServersFile:
       return [ salome.LogManagerLaunchMonitoringFileCtxMgr( 1000*HTopOfAllServersTimeRes, HTopOfAllServersFile ) ]
     else:
       return [ ]
   #
   salome.cm.SetDeltaTimeBetweenCPUMemMeasureInMilliSecond( 1000*CPUMemContainerTimeRes )
   # Start part of context manager instances
   ctxManagers = [ AutoShutdown(proc,shutdown) ] # the first one must be this one. Because orb.shutdown must be called last !
   #
   ctxManagers += MonitoringDirectories( DirectoriesToMonitor ) + MonitoringThisProcess(HTopOfThisProcessFile, HTopTimeRes) + MonitoringAllKernelServers(HTopOfAllServersFile, HTopOfAllServersTimeRes)
   #
   if dump != 0:
     ctxManagers += [ AutoDumpThread(proc,dump,xmlfilename) ]
   # end of part of context managers
   with contextlib.ExitStack() as stack:
     for mgr in ctxManagers:
       stack.enter_context(mgr)
     executor.RunPy(proc,display,isPyThread=True,fromscratch=True) # same as RunW but releasing GIL
   #
   if proc.getEffectiveState() != pilot.DONE:
     raise RuntimeError( proc.getErrorReport() )
   #
   if display > 0:
       proc.writeDotInFile("titi")
   #
   if finalDump:
     logging.info(f"Final dump requested : {finalDump}")
     SALOMERuntime.schemaSaveStateUnsafe( proc, finalDump )
  

Referenced by mainRun().

◆ getArgumentParser()

def driver_internal.getArgumentParser ( )

Definition at line 358 of file driver_internal.py.

 def getArgumentParser():
   import KernelBasis
   import argparse
   parser = argparse.ArgumentParser()
   parser.add_argument('xmlfilename',help = "XML file containing YACS schema to be executed")
   parser.add_argument("-d", DisplayEntryInCMD, dest = DisplayKeyInARGS, type=int, const=1, nargs='?', default=0, help="Display dot files: 0=never to 3=very often")
   parser.add_argument("-v", VerboseEntryInCMD, dest = VerboseKeyInARGS,help="Produce verbose output", action='store_true')
   parser.add_argument("-vl", VerboseLevelEntryInCMD, dest = VerboseLevelKeyInARGS, type=str, choices=["ERROR", "WARNING", "INFO", "DEBUG"], default="INFO", help="Specifies level of verbosity")
   parser.add_argument("-s",StopOnErrorEntryInCMD,dest=StopOnErrorKeyInARGS,help="Stop on first error", action='store_true')
   parser.add_argument("-e",DumpOnErrorEntryInCMD,dest=DumpOnErrorKeyInARGS, type=str, const='dumpErrorState.xml', default="", nargs='?', help="Stop on first error and dump state")
   parser.add_argument("-g",DumpEntryInCMD,dest=DumpKeyInARGS, type=int, const=60, default=0, nargs='?', help="dump state")
   parser.add_argument("-kt", KernelTraceEntryInCMD, dest = KernelTraceKeyInARGS,help="Produce verbose of SALOME/KERNEL", action='store_true')
   parser.add_argument("-f",DumpStateEntryInCMD, dest =DumpStateKeyInARGS, type=str, const='finalDumpState.xml', default="", nargs='?', help="dump final state")
   parser.add_argument("-l",LoadStateEntryInCMD, dest=LoadStateKeyInARGS, type=str, default="", help="Load State from a previous partial execution")
   parser.add_argument("-x",SaveXMLSchemaEntryInCMD, dest=SaveXMLSchemaKeyInARGS, type=str, const="saveSchema.xml", nargs='?', default="", help = "dump xml schema")
   parser.add_argument("-t",ShutdownEntryInCMD, dest = ShutdownKeyInARGS, type=int , default=3, help="Shutdown the schema: 0=no shutdown to 3=full shutdown")
   parser.add_argument("-r",ResetEntryInCMD, dest = ResetKeyInARGS, type=int , default = 0, help="Reset the schema before execution: 0=nothing, 1=reset error nodes to ready state")
   parser.add_argument("-i",InitPortEntryInCMD, dest = InitPortKeyInARGS, type=str, default =[], action='append', help="Initialisation value of a port, specified as bloc.node.port=value. For multiple settings use comma.")
   parser.add_argument("-z",DoNotSqueezeEntryInCMD, dest = DoNotSqueezeKeyInARGS, help = "Desactivate squeeze memory optimization.", action='store_true')
   parser.add_argument(CPUTimeResOfContainerEntryInCMD, dest = CPUTimeResOfContainerKeyInARGS, type=int, default = 10, help="Time in second between two measures of CPU/Mem in container processes")
   parser.add_argument(HTOPFileEntryInCMD, dest = HTOPFileKeyInARGS, type=str, default ="", help="File name (if not empty) containing the result of measure of current process")
   parser.add_argument(HTOPFileTimeResEntryInCMD, dest = HTOPFileTimeResKeyInARGS, type=int, default = 60, help="Time in second between between two measures of CPU/Mem of current process")
   parser.add_argument(HTOPServerFileEntryInCMD, dest = HTOPServerFileKeyInARGS, type=str, default ="", help="File name (if not empty) containing the result of measure of all server processes")
   parser.add_argument(HTOPServerFileTimeResEntryInCMD, dest = HTOPServerFileTimeResKeyInARGS, type=int, default = 30, help="Time in second between between two measures of CPU/Mem of any server process")
   parser.add_argument(MonitoringDirsEntryInCMD, dest = MonitoringDirsInARGS, nargs='+', type=str, default =[], help="List of directories to be monitored")
   parser.add_argument(MonitoringDirsResEntryInCMD, dest = MonitoringDirsResInARGS, nargs='+', type=str, default =[], help=f"List of files with result of monitoring of directories to be monitored (see {MonitoringDirsInARGS}). The size of lists are expected to be the same.")
   parser.add_argument(MonitoringDirsTimeResEntryInCMD, dest = MonitoringDirsTimeResInARGS, nargs='+', type=int, default =[], help=f"List of time resolution (in second) of monitoring of directories to be monitored (see {MonitoringDirsInARGS}). The size of lists are expected to be the same.")
   parser.add_argument("-w",ReplayOnErrorEntryInCMD,dest=ReplayOnErrorEntryInARGS,help="Mode of execution of YACS where all python execution are wrapped into a subprocess to be able to resist against failure (such as SIGSEV)", action='store_true')
   parser.add_argument(ReplayDirInCMD, dest=ReplayDirInARGS, type=str, default ="", help="Directory storing replay scenarii if any (see replay-on-error option.")
   parser.add_argument(BigObjDirInCMD, dest=BigObjDirInARGS, type=str, default ="", help="Directory storing big obj files exchanged between YACS python nodes.")
   parser.add_argument(BigObjThresInCMD, dest=BigObjThresInARGS, type=int, default = KernelBasis.GetBigObjOnDiskThreshold(), help="Objects whose size exceeds this threshold in bytes will be written inside directory")
   parser.add_argument(CustomOverridesInCMD, dest=CustomOverridesInARGS, help="Activate custom overrides. These overrides are incarnated by yacs_driver_overrides module that is expected to loadable in current application.", action='store_true')
   parser.add_argument(IOREntryInCMD, dest = IORKeyInARGS, type=str, default ="", help="file inside which the ior of NS will be stored")
   parser.add_argument("--options_from_json", dest = "options_from_json", type=str, default ="", help="Json file of options. If defined options in json will override those specified in command line.")
   return parser
  

Referenced by parseArgs().

◆ initializeSALOME()

def driver_internal.initializeSALOME ( )

Definition at line 119 of file driver_internal.py.

 def initializeSALOME():
   import SALOMERuntime
   import KernelBasis
   global my_runtime_yacs,my_ior_ns,my_runtime_yacs
   if my_runtime_yacs:
     return
   salome.salome_init()
   if my_replay_on_error:
     KernelBasis.SetPyExecutionMode("OutOfProcessWithReplay")
     KernelBasis.SetDirectoryForReplayFiles( my_replay_dir )
   if my_ior_ns:
     salome.naming_service.DumpIORInFile( my_ior_ns )
   flags = SALOMERuntime.RuntimeSALOME.UsePython + SALOMERuntime.RuntimeSALOME.UseCorba + SALOMERuntime.RuntimeSALOME.UseXml + SALOMERuntime.RuntimeSALOME.UseCpp + SALOMERuntime.RuntimeSALOME.UseSalome
   SALOMERuntime.RuntimeSALOME.setRuntime( flags )
   my_runtime_yacs = SALOMERuntime.getSALOMERuntime()
   anIOR = salome.orb.object_to_string ( salome.modulcat )
   aCatalog = my_runtime_yacs.loadCatalog( "session", anIOR )
   my_runtime_yacs.addCatalog( aCatalog )
  

Referenced by SALOMEInitializationNeeded().

◆ loadGraph()

def driver_internal.loadGraph ( xmlFileName )

Args:
-----
xmlFileName : XML file containing YACS schema

Returns
-------

SALOMERuntime.SalomeProc : YACS graph instance

Definition at line 145 of file driver_internal.py.

 def loadGraph( xmlFileName ):
   """
   Args:
   -----
   xmlFileName : XML file containing YACS schema
  
   Returns
   -------
  
   SALOMERuntime.SalomeProc : YACS graph instance
   """
   import loader
   l=loader.YACSLoader()
   p=l.load( xmlFileName )
   return p
  

Referenced by mainRun().

◆ mainRun()

def driver_internal.mainRun	(	args,
		xmlFileName
	)

Args:
-----

args (dict) : options for treatment

Definition at line 394 of file driver_internal.py.

 def mainRun( args, xmlFileName):
   """
   Args:
   -----
  
   args (dict) : options for treatment
  
   """
   global my_ior_ns,my_replay_on_error,my_replay_dir
   from salome_utils import positionVerbosityOfLoggerRegardingState,setVerboseLevel,setVerbose,KernelLogLevelToLogging
   #
   iorNS = args[IORKeyInARGS]
   #
   if iorNS:
     my_ior_ns = iorNS
   #
   if args[ReplayOnErrorEntryInARGS]:
     my_replay_on_error = True
     my_replay_dir = args[ReplayDirInARGS]
   #
   if args[VerboseKeyInARGS]:
     setVerbose( args[ KernelTraceKeyInARGS ] )
     setVerboseLevel( KernelLogLevelToLogging[ args[VerboseLevelKeyInARGS] ] )
     positionVerbosityOfLoggerRegardingState()
     logging.info( reprAfterArgParsing(args) )
   #
   proc = loadGraph( xmlFileName )
   # work around a bug in Executor::Run when there are no tasks to launch.
   if len(proc.getChildren()) == 0 :
     return
   #
   patchGraph( proc, not args[DoNotSqueezeKeyInARGS], args[InitPortKeyInARGS], args[SaveXMLSchemaKeyInARGS], args[LoadStateKeyInARGS], args[ResetKeyInARGS], args[DisplayKeyInARGS])
   executor = prepareExecution( proc, args[StopOnErrorKeyInARGS], args[DumpOnErrorKeyInARGS])
   # proxy parameters management
   if args[ BigObjDirInARGS ]:
     salome.cm.SetBigObjOnDiskDirectory( args[ BigObjDirInARGS ] )
   salome.cm.SetBigObjOnDiskThreshold( args[ BigObjThresInARGS ] )
   # overrides
   if args[ CustomOverridesInARGS ]:
     try:
       import yacs_driver_overrides
       import pylauncher
       allresources = pylauncher.RetrieveRMCppSingleton()# pylauncher.ResourcesManager_cpp singleton representing all resources (pylauncher.ResourceDefinition_cpp) devoted for the computation.
       yacs_driver_overrides.customize( salome.cm, allresources )
     except:
       raise RuntimeError("Overrides have be requested to be triggered by the user but module is not available")
   #
   executeGraph( executor, xmlFileName, proc, args[DumpKeyInARGS], args[DumpStateKeyInARGS], args[DisplayKeyInARGS], args[ShutdownKeyInARGS], args[CPUTimeResOfContainerKeyInARGS],
                args[HTOPFileKeyInARGS], args[HTOPFileTimeResKeyInARGS],
                args[HTOPServerFileKeyInARGS], args[HTOPServerFileTimeResKeyInARGS], [(dirToMonitor,resFile,timeRes) for dirToMonitor,resFile,timeRes in zip(args[MonitoringDirsInARGS],args[MonitoringDirsResInARGS],args[MonitoringDirsTimeResInARGS])] )
  

References executeGraph(), loadGraph(), patchGraph(), prepareExecution(), and reprAfterArgParsing().

◆ parseArgs()

def driver_internal.parseArgs ( )

Returns
-------

- args (dict) : dictionnary containing all args taken into account. If json, the params in json will override entries
- xmlFileName (str) : XML YACS schema

Definition at line 445 of file driver_internal.py.

 def parseArgs():
   """
   Returns
   -------
  
   - args (dict) : dictionnary containing all args taken into account. If json, the params in json will override entries
   - xmlFileName (str) : XML YACS schema
   
   """
   import json
   parser = getArgumentParser()
   args = parser.parse_args()
   iorNS = args.iorNS
   xmlFileName = args.xmlfilename
   optionFromJSon = args.options_from_json
   args = toDict( args )
   if optionFromJSon:
     # in case of Json overrides 
     with open( optionFromJSon ) as f:
       opts_from_json = json.load( f )
     for k,v in opts_from_json.items():
       if k != EntryFromCoarseEntry(IOREntryInCMD) or v:# for IOR if v is null -> do not override
         args[k] = v
   # change key of args from entryCMD to KeyInARGS
   args = {key:args[EntryFromCoarseEntry(entry)] for entry,key in KeyValnARGS}
   return args, xmlFileName
  

References EntryFromCoarseEntry(), getArgumentParser(), and toDict().

◆ patchGraph()

def driver_internal.patchGraph	(	proc,
		squeezeMemory,
		initPorts,
		xmlSchema,
		loadStateXmlFile,
		reset,
		display
	)

Args:
-----

proc ( SALOMERuntime.SalomeProc ) : YACS Proc instance to be evaluated
squeezeMemory ( bool ) : squeezememory to be activated
initPorts (list<string>) : list of bloc.node.port=value.
xmlSchema (string) :
loadStateXmlFile (string) : file if any of state to be loaded inside proc
reset (int) : 
display (int) :

Definition at line 161 of file driver_internal.py.

 def patchGraph( proc, squeezeMemory, initPorts, xmlSchema, loadStateXmlFile, reset, display):
   """
   Args:
   -----
  
   proc ( SALOMERuntime.SalomeProc ) : YACS Proc instance to be evaluated
   squeezeMemory ( bool ) : squeezememory to be activated
   initPorts (list<string>) : list of bloc.node.port=value.
   xmlSchema (string) :
   loadStateXmlFile (string) : file if any of state to be loaded inside proc
   reset (int) : 
   display (int) :
   """
   import SALOMERuntime
   import loader
   import pilot
   def parse_init_port(input):
     """
     Returns
     -------
     node, port, value
     """
     node_port, value = input.split("=")
     nodePortSpl = node_port.split(".")
     port = nodePortSpl[-1]
     node = ".".join( nodePortSpl[:-1] )
     return node,port,value
       
   if squeezeMemory:
     logging.info("SqueezeMemory requested -> update proc")
     allNodes = proc.getAllRecursiveNodes()
     for node in allNodes:
       if isinstance(node,SALOMERuntime.PythonNode):
         node.setSqueezeStatus( True )
   #
   for initPort in initPorts:
       node,port,value = parse_init_port(initPort)
       init_state = proc.setInPortValue(node, port, value)
       if init_state != value:
         raise RuntimeError(f"Error on initialization of {initPort}")
   #
   if xmlSchema:
     SALOMERuntime.VisitorSaveSalomeSchemaUnsafe(proc,xmlSchema)
     pass
   #
   info = pilot.LinkInfo( pilot.LinkInfo.ALL_DONT_STOP )
   proc.checkConsistency(info)
   if info.areWarningsOrErrors():
     raise RuntimeError( info.getGlobalRepr() )
   #
   if loadStateXmlFile:
     loader.loadState( proc, loadStateXmlFile )
     if reset > 0:
       proc.resetState(reset)
       proc.exUpdateState()
   #
   if display > 0:
       proc.writeDotInFile("toto")
          
 @SALOMEInitializationNeeded

References parse_init_port().

Referenced by mainRun().

◆ prepareExecution()

def driver_internal.prepareExecution	(	proc,
		isStop,
		dumpErrorFile
	)

Returns
-------

pilot.ExecutorSwig : Instance of executor

Definition at line 221 of file driver_internal.py.

 def prepareExecution(proc, isStop, dumpErrorFile):
   """
   Returns
   -------
  
   pilot.ExecutorSwig : Instance of executor
   """
   import pilot
   ex=pilot.ExecutorSwig()
   if isStop:
     logging.info(f"Stop has been activated with {dumpErrorFile}")
     ex.setStopOnError( dumpErrorFile!="", dumpErrorFile )
   return ex
  
 @SALOMEInitializationNeeded

Referenced by mainRun().

◆ reprAfterArgParsing()

def driver_internal.reprAfterArgParsing ( args )

Args:
-----

args (argparse.Namespace) : instance after parsing

Definition at line 349 of file driver_internal.py.

 def reprAfterArgParsing( args ):
   """
   Args:
   -----
  
   args (argparse.Namespace) : instance after parsing
   """
   return "\n".join( [ f"{EntryFromCoarseEntry(entry)} : {args[key]}" for entry,key in KeyValnARGS ] )
  

Referenced by mainRun().

◆ SALOMEInitializationNeeded()

def driver_internal.SALOMEInitializationNeeded ( func )

Definition at line 138 of file driver_internal.py.

 def SALOMEInitializationNeeded(func):
   def decaratedFunc(*args,**kwargs):
     initializeSALOME()
     return func(*args,**kwargs)
   return decaratedFunc
  
 @SALOMEInitializationNeeded

References initializeSALOME().

◆ toDict()

def driver_internal.toDict ( args )

Convert argparse.Namespace to dict

Definition at line 343 of file driver_internal.py.

 def toDict( args ):
   """
   Convert argparse.Namespace to dict
   """
   return {EntryFromCoarseEntry(entry):getattr(args,key) for entry,key in KeyValnARGS}
  

References EntryFromCoarseEntry().

Referenced by parseArgs().

Variable Documentation

◆ _dump_thread

driver_internal._dump_thread

private

Definition at line 289 of file driver_internal.py.

◆ _dumpFile

driver_internal._dumpFile

private

Definition at line 285 of file driver_internal.py.

◆ _lockFile

driver_internal._lockFile

private

Definition at line 286 of file driver_internal.py.

◆ _proc

driver_internal._proc

private

Definition at line 263 of file driver_internal.py.

Referenced by Proc_i.getIds(), YACS::ENGINE::Container.getProc(), YACS::HMI::GuiContext.getProc(), YACS::HMI::GuiExecutor.GuiExecutor(), Proc_i.Proc_i(), YACS::HMI::GuiExecutor.registerStatusObservers(), Proc_i.RunW(), YACS::ENGINE::Container.setProc(), and YACS::HMI::GuiExecutor.updateSchema().

◆ _shutdown

driver_internal._shutdown

private

Definition at line 264 of file driver_internal.py.

◆ args

◆ BigObjDirInARGS

string driver_internal.BigObjDirInARGS = "bigobj_dir"

Definition at line 78 of file driver_internal.py.

◆ BigObjDirInCMD

string driver_internal.BigObjDirInCMD = "--bigobj-dir"

Definition at line 49 of file driver_internal.py.

◆ BigObjThresInARGS

string driver_internal.BigObjThresInARGS = "bigobj_thres"

Definition at line 79 of file driver_internal.py.

◆ BigObjThresInCMD

string driver_internal.BigObjThresInCMD = "--bigobj-thres"

Definition at line 50 of file driver_internal.py.

◆ CPUTimeResOfContainerEntryInCMD

string driver_internal.CPUTimeResOfContainerEntryInCMD = "--cpu-mem-container-time-res"

Definition at line 39 of file driver_internal.py.

◆ CPUTimeResOfContainerKeyInARGS

string driver_internal.CPUTimeResOfContainerKeyInARGS = "cpu_mem_container_time_res"

Definition at line 68 of file driver_internal.py.

◆ CustomOverridesInARGS

string driver_internal.CustomOverridesInARGS = "activate_custom_overrides"

Definition at line 80 of file driver_internal.py.

◆ CustomOverridesInCMD

string driver_internal.CustomOverridesInCMD = "--activate-custom-overrides"

Definition at line 51 of file driver_internal.py.

◆ DisplayEntryInCMD

string driver_internal.DisplayEntryInCMD = "--display"

Definition at line 24 of file driver_internal.py.

◆ DisplayKeyInARGS

string driver_internal.DisplayKeyInARGS = "display"

Definition at line 53 of file driver_internal.py.

◆ DoNotSqueezeEntryInCMD

string driver_internal.DoNotSqueezeEntryInCMD = "--donotsqueeze"

Definition at line 37 of file driver_internal.py.

◆ DoNotSqueezeKeyInARGS

string driver_internal.DoNotSqueezeKeyInARGS = "donotsqueeze"

Definition at line 66 of file driver_internal.py.

◆ DumpEntryInCMD

string driver_internal.DumpEntryInCMD = "--dump"

Definition at line 29 of file driver_internal.py.

◆ DumpKeyInARGS

string driver_internal.DumpKeyInARGS = "dump"

Definition at line 58 of file driver_internal.py.

◆ DumpOnErrorEntryInCMD

string driver_internal.DumpOnErrorEntryInCMD = "--dump-on-error"

Definition at line 28 of file driver_internal.py.

◆ DumpOnErrorKeyInARGS

string driver_internal.DumpOnErrorKeyInARGS = "dumpErrorFile"

Definition at line 57 of file driver_internal.py.

◆ DumpStateEntryInCMD

string driver_internal.DumpStateEntryInCMD = "--dump-final"

Definition at line 31 of file driver_internal.py.

◆ DumpStateKeyInARGS

string driver_internal.DumpStateKeyInARGS = "finalDump"

Definition at line 60 of file driver_internal.py.

◆ HTOPFileEntryInCMD

string driver_internal.HTOPFileEntryInCMD = "--htop-of-yacs-engine-process-file"

Definition at line 40 of file driver_internal.py.

◆ HTOPFileKeyInARGS

string driver_internal.HTOPFileKeyInARGS = "htop_of_yacs_engine_process_file"

Definition at line 69 of file driver_internal.py.

◆ HTOPFileTimeResEntryInCMD

string driver_internal.HTOPFileTimeResEntryInCMD = "--htop-of-yacs-engine-process-time-res"

Definition at line 42 of file driver_internal.py.

◆ HTOPFileTimeResKeyInARGS

string driver_internal.HTOPFileTimeResKeyInARGS = "htop_of_yacs_engine_process_time_res"

Definition at line 71 of file driver_internal.py.

◆ HTOPServerFileEntryInCMD

string driver_internal.HTOPServerFileEntryInCMD = "--htop-of-servers"

Definition at line 41 of file driver_internal.py.

◆ HTOPServerFileKeyInARGS

string driver_internal.HTOPServerFileKeyInARGS = "htop_of_servers"

Definition at line 70 of file driver_internal.py.

◆ HTOPServerFileTimeResEntryInCMD

string driver_internal.HTOPServerFileTimeResEntryInCMD = "--htop-of-servers-time-res"

Definition at line 43 of file driver_internal.py.

◆ HTOPServerFileTimeResKeyInARGS

string driver_internal.HTOPServerFileTimeResKeyInARGS = "htop_of_servers_time_res"

Definition at line 72 of file driver_internal.py.

◆ InitPortEntryInCMD

string driver_internal.InitPortEntryInCMD = "--init-port"

Definition at line 36 of file driver_internal.py.

◆ InitPortKeyInARGS

string driver_internal.InitPortKeyInARGS = "init_port"

Definition at line 65 of file driver_internal.py.

◆ IOREntryInCMD

string driver_internal.IOREntryInCMD = "--ior-ns"

Definition at line 38 of file driver_internal.py.

◆ IORKeyInARGS

string driver_internal.IORKeyInARGS = "iorNS"

Definition at line 67 of file driver_internal.py.

◆ KernelTraceEntryInCMD

string driver_internal.KernelTraceEntryInCMD = "--kerneltrace"

Definition at line 30 of file driver_internal.py.

◆ KernelTraceKeyInARGS

string driver_internal.KernelTraceKeyInARGS = "kerneltrace"

Definition at line 59 of file driver_internal.py.

◆ KeyValnARGS

list driver_internal.KeyValnARGS

Initial value:

 =  [(DisplayEntryInCMD,DisplayKeyInARGS),
                (VerboseEntryInCMD,VerboseKeyInARGS),
                (VerboseLevelEntryInCMD,VerboseLevelKeyInARGS),
                (StopOnErrorEntryInCMD,StopOnErrorKeyInARGS),
                (DumpOnErrorEntryInCMD,DumpOnErrorKeyInARGS),
                (DumpEntryInCMD,DumpKeyInARGS),
                (KernelTraceEntryInCMD,KernelTraceKeyInARGS),
                (DumpStateEntryInCMD,DumpStateKeyInARGS),
                (LoadStateEntryInCMD,LoadStateKeyInARGS),
                (SaveXMLSchemaEntryInCMD,SaveXMLSchemaKeyInARGS),
                (ShutdownEntryInCMD,ShutdownKeyInARGS),
                (ResetEntryInCMD,ResetKeyInARGS),
                (InitPortEntryInCMD,InitPortKeyInARGS),
                (DoNotSqueezeEntryInCMD,DoNotSqueezeKeyInARGS),
                (CPUTimeResOfContainerEntryInCMD,CPUTimeResOfContainerKeyInARGS),
                (HTOPFileEntryInCMD,HTOPFileKeyInARGS),
                (HTOPFileTimeResEntryInCMD,HTOPFileTimeResKeyInARGS),
                (HTOPServerFileEntryInCMD,HTOPServerFileKeyInARGS),
                (HTOPServerFileTimeResEntryInCMD,HTOPServerFileTimeResKeyInARGS),
                (MonitoringDirsEntryInCMD,MonitoringDirsInARGS),
                (MonitoringDirsResEntryInCMD,MonitoringDirsResInARGS),
                (MonitoringDirsTimeResEntryInCMD,MonitoringDirsTimeResInARGS),
                (ReplayOnErrorEntryInCMD,ReplayOnErrorEntryInARGS),
                (ReplayDirInCMD,ReplayDirInARGS),
                (BigObjDirInCMD,BigObjDirInARGS),
                (BigObjThresInCMD,BigObjThresInARGS),
                (CustomOverridesInCMD,CustomOverridesInARGS),
                (IOREntryInCMD,IORKeyInARGS)]

Definition at line 82 of file driver_internal.py.

◆ LoadStateEntryInCMD

string driver_internal.LoadStateEntryInCMD = "--load-state"

Definition at line 32 of file driver_internal.py.

◆ LoadStateKeyInARGS

string driver_internal.LoadStateKeyInARGS = "loadState"

Definition at line 61 of file driver_internal.py.

◆ MonitoringDirsEntryInCMD

string driver_internal.MonitoringDirsEntryInCMD = "--monitoring-dirs-content"

Definition at line 44 of file driver_internal.py.

◆ MonitoringDirsInARGS

string driver_internal.MonitoringDirsInARGS = "monitoring_dirs_content"

Definition at line 73 of file driver_internal.py.

◆ MonitoringDirsResEntryInCMD

string driver_internal.MonitoringDirsResEntryInCMD = "--monitoring-dirs-content-res"

Definition at line 45 of file driver_internal.py.

◆ MonitoringDirsResInARGS

string driver_internal.MonitoringDirsResInARGS = "monitoring_dirs_content_res"

Definition at line 74 of file driver_internal.py.

◆ MonitoringDirsTimeResEntryInCMD

string driver_internal.MonitoringDirsTimeResEntryInCMD = "--monitoring-dirs-content-time-res"

Definition at line 46 of file driver_internal.py.

◆ MonitoringDirsTimeResInARGS

string driver_internal.MonitoringDirsTimeResInARGS = "monitoring_dirs_content_time_res"

Definition at line 75 of file driver_internal.py.

◆ my_ior_ns

driver_internal.my_ior_ns = None

Definition at line 113 of file driver_internal.py.

◆ my_replay_dir

string driver_internal.my_replay_dir = ""

Definition at line 117 of file driver_internal.py.

◆ my_replay_on_error

bool driver_internal.my_replay_on_error = False

Definition at line 115 of file driver_internal.py.

◆ my_runtime_yacs

driver_internal.my_runtime_yacs = None

Definition at line 111 of file driver_internal.py.

◆ ReplayDirInARGS

string driver_internal.ReplayDirInARGS = "replay_dir"

Definition at line 77 of file driver_internal.py.

◆ ReplayDirInCMD

string driver_internal.ReplayDirInCMD = "--replay-dir"

Definition at line 48 of file driver_internal.py.

◆ ReplayOnErrorEntryInARGS

string driver_internal.ReplayOnErrorEntryInARGS = "replay_on_error"

Definition at line 76 of file driver_internal.py.

◆ ReplayOnErrorEntryInCMD

string driver_internal.ReplayOnErrorEntryInCMD = "--replay-on-error"

Definition at line 47 of file driver_internal.py.

◆ ResetEntryInCMD

string driver_internal.ResetEntryInCMD = "--reset"

Definition at line 35 of file driver_internal.py.

◆ ResetKeyInARGS

string driver_internal.ResetKeyInARGS = "reset"

Definition at line 64 of file driver_internal.py.

◆ SaveXMLSchemaEntryInCMD

string driver_internal.SaveXMLSchemaEntryInCMD = "--save-xml-schema"

Definition at line 33 of file driver_internal.py.

◆ SaveXMLSchemaKeyInARGS

string driver_internal.SaveXMLSchemaKeyInARGS = "saveXMLSchema"

Definition at line 62 of file driver_internal.py.

◆ ShutdownEntryInCMD

string driver_internal.ShutdownEntryInCMD = "--shutdown"

Definition at line 34 of file driver_internal.py.

◆ ShutdownKeyInARGS

string driver_internal.ShutdownKeyInARGS = "shutdown"

Definition at line 63 of file driver_internal.py.

◆ StopOnErrorEntryInCMD

string driver_internal.StopOnErrorEntryInCMD = "--stop-on-error"

Definition at line 27 of file driver_internal.py.

◆ StopOnErrorKeyInARGS

string driver_internal.StopOnErrorKeyInARGS = "stop"

Definition at line 56 of file driver_internal.py.

◆ VerboseEntryInCMD

string driver_internal.VerboseEntryInCMD = "--verbose"

Definition at line 25 of file driver_internal.py.

◆ VerboseKeyInARGS

string driver_internal.VerboseKeyInARGS = "verbose"

Definition at line 54 of file driver_internal.py.

◆ VerboseLevelEntryInCMD

string driver_internal.VerboseLevelEntryInCMD = "--verbose-level"

Definition at line 26 of file driver_internal.py.

◆ VerboseLevelKeyInARGS

string driver_internal.VerboseLevelKeyInARGS = "verbose_level"

Definition at line 55 of file driver_internal.py.

◆ xmlFileName

driver_internal.xmlFileName

Definition at line 473 of file driver_internal.py.

Functions

Variables

Function Documentation

◆ EntryFromCoarseEntry()

◆ executeGraph()

◆ getArgumentParser()

◆ initializeSALOME()

◆ loadGraph()

◆ mainRun()

◆ parseArgs()

◆ patchGraph()

◆ prepareExecution()

◆ reprAfterArgParsing()

◆ SALOMEInitializationNeeded()

◆ toDict()

Variable Documentation

◆ _dump_thread

◆ _dumpFile

◆ _lockFile

◆ _proc

◆ _shutdown

◆ args

◆ BigObjDirInARGS

◆ BigObjDirInCMD

◆ BigObjThresInARGS

◆ BigObjThresInCMD

◆ CPUTimeResOfContainerEntryInCMD

◆ CPUTimeResOfContainerKeyInARGS

◆ CustomOverridesInARGS

◆ CustomOverridesInCMD

◆ DisplayEntryInCMD

◆ DisplayKeyInARGS

◆ DoNotSqueezeEntryInCMD

◆ DoNotSqueezeKeyInARGS

◆ DumpEntryInCMD

◆ DumpKeyInARGS

◆ DumpOnErrorEntryInCMD

◆ DumpOnErrorKeyInARGS

◆ DumpStateEntryInCMD

◆ DumpStateKeyInARGS

◆ HTOPFileEntryInCMD

◆ HTOPFileKeyInARGS

◆ HTOPFileTimeResEntryInCMD

◆ HTOPFileTimeResKeyInARGS

◆ HTOPServerFileEntryInCMD

◆ HTOPServerFileKeyInARGS

◆ HTOPServerFileTimeResEntryInCMD

◆ HTOPServerFileTimeResKeyInARGS

◆ InitPortEntryInCMD

◆ InitPortKeyInARGS

◆ IOREntryInCMD

◆ IORKeyInARGS

◆ KernelTraceEntryInCMD

◆ KernelTraceKeyInARGS

◆ KeyValnARGS

◆ LoadStateEntryInCMD

◆ LoadStateKeyInARGS

◆ MonitoringDirsEntryInCMD

◆ MonitoringDirsInARGS

◆ MonitoringDirsResEntryInCMD

◆ MonitoringDirsResInARGS

◆ MonitoringDirsTimeResEntryInCMD

◆ MonitoringDirsTimeResInARGS

◆ my_ior_ns

◆ my_replay_dir

◆ my_replay_on_error

◆ my_runtime_yacs

◆ ReplayDirInARGS

◆ ReplayDirInCMD

◆ ReplayOnErrorEntryInARGS

◆ ReplayOnErrorEntryInCMD

◆ ResetEntryInCMD

◆ ResetKeyInARGS

◆ SaveXMLSchemaEntryInCMD

◆ SaveXMLSchemaKeyInARGS

◆ ShutdownEntryInCMD

◆ ShutdownKeyInARGS

◆ StopOnErrorEntryInCMD

◆ StopOnErrorKeyInARGS

◆ VerboseEntryInCMD