Detailed Description

Interface to CCIN2P3 Grid Engine batch job management system.

Created by KVClassFactory on Mon Jan 24 16:54:04 2022 Author: John Frankland,,,

Definition at line 16 of file KV_CCIN2P3_Slurm.h.

#include <KV_CCIN2P3_Slurm.h>

Inheritance diagram for KV_CCIN2P3_Slurm:

[legend]

Public Member Functions
	KV_CCIN2P3_Slurm (const Char_t *name)

Bool_t	CheckJobParameters () override
	Checks the job and asks for any missing parameters. More...

void	ChooseJobMemory (void)

void	ChooseJobTime (void)

void	Clear (Option_t *opt="") override
	Clear previously set parameters in order to create a new job submission command. More...

void	GetBatchSystemParameterList (KVNameValueList &) override

const Char_t *	GetJobMemory (void) const
	returns the parameter string corresponding to the job Memory More...

const Char_t *	GetJobTime (void) const
	returns the parameter string corresponding to the job CPU time More...

Int_t	GetRunsPerJob () const

Bool_t	MultiJobsMode () const override

void	Print (Option_t *="") const override

void	PrintJobs (Option_t *opt="") override
	Print list of owner's jobs. More...

void	ReadBatchEnvFile (TEnv *) override

void	Run () override

void	SanitizeJobName () const override

void	SetBatchSystemParameters (const KVNameValueList &) override
	Use the parameters in the list to set all relevant parameters for batch system. More...

void	SetJobMemory (const Char_t *h="")

void	SetJobTime (const Char_t *h="")

void	SetMultiJobsMode (Bool_t on=kTRUE)

void	SetRunsPerJob (Int_t n)

void	WriteBatchEnvFile (TEnv *) override

Public Member Functions inherited from KVBatchSystem
	KVBatchSystem (const Char_t *name)

virtual	~KVBatchSystem ()
	Destructor. More...

virtual void	AlterJobs (TGWindow , TList )

void	cd ()
	Make this the default batch system. More...

void	Clear (Option_t *opt="") override

virtual const Char_t *	GetDefaultJobOptions () const

virtual const Char_t *	GetJobName () const

virtual const Char_t *	GetJobSubCmd () const

virtual const Char_t *	GetJobSubCmdLine ()

virtual KVList *	GetListOfJobs ()

KVNameValueList &	GetParameters ()

void	Print (Option_t *="") const override

void	SetAnalyser (KVDataAnalyser *da)

virtual void	SetDefaultJobOptions (const Char_t *opt)

virtual void	SetJobName (const Char_t *name)

virtual void	SetJobScript (const Char_t *path)

virtual void	SubmitJob ()

virtual void	SubmitTask (KVDataAnalyser *da)

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor. More...

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type. More...

	KVBase (const KVBase &)
	copy ctor More...

void	Clear (Option_t *opt="") override
	Clear object properties : name, type/title, number, label. More...

void	Copy (TObject &) const override
	Make a copy of this object. More...

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

Bool_t	IsCalled (const Char_t *name, bool case_insensitive=false) const

Bool_t	IsLabelled (const Char_t *l, bool case_insensitive=false) const

Bool_t	IsType (const Char_t *typ, bool case_insensitive=false) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator More...

void	Print (Option_t *option="") const override

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

enum class	GetX_status { ok , above_maximum , below_minimum , at_maximum , at_minimum }

Static Public Member Functions inherited from KVBatchSystem
static KVBatchSystem *	GetBatchSystem (const Char_t *plugin)

Static Public Member Functions inherited from KVBase
static std::optional< TString >	AbsoluteUnixPath (const TString &)

static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values. More...

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const KVString &class_name, KVString &imp_file, KVString &dec_file, const KVString &dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

template<typename ValType >
static ValType	GetDataSetEnv (const KVString &dataset, const KVString &type, const ValType &defval={})

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date. More...

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build. More...

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time. More...

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build. More...

static int	GetKVMajorVersion ()

static int	GetKVMinorVersion ()

static int	GetKVPatchVersion ()

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build. More...

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string. More...

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources. More...

static const Char_t *	gitCommit ()
	Returns last git commit of sources. More...

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsEnvInit ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc. More...

static Double_t	ProtectedGetX (const TF1 &func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})

static Double_t	ProtectedGetX (const TF1 *func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Constructor & Destructor Documentation

◆ KV_CCIN2P3_Slurm()

KV_CCIN2P3_Slurm::KV_CCIN2P3_Slurm ( const Char_t * name )

Default constructor Sets default job time, memory and disk space as defined in $KVROOT/KVFiles/.kvrootrc

Definition at line 21 of file KV_CCIN2P3_Slurm.cpp.

Member Function Documentation

◆ CheckJobParameters()

Bool_t KV_CCIN2P3_Slurm::CheckJobParameters ( )

overridevirtual

Checks the job and asks for any missing parameters.

Reimplemented from KVBatchSystem.

Definition at line 104 of file KV_CCIN2P3_Slurm.cpp.

◆ ChooseJobMemory()

void KV_CCIN2P3_Slurm::ChooseJobMemory ( void )

Definition at line 140 of file KV_CCIN2P3_Slurm.cpp.

◆ ChooseJobTime()

void KV_CCIN2P3_Slurm::ChooseJobTime ( void )

Definition at line 121 of file KV_CCIN2P3_Slurm.cpp.

◆ Clear()

void KV_CCIN2P3_Slurm::Clear ( Option_t * opt = "" )

override

Clear previously set parameters in order to create a new job submission command.

Definition at line 40 of file KV_CCIN2P3_Slurm.cpp.

◆ GetBatchSystemParameterList()

void KV_CCIN2P3_Slurm::GetBatchSystemParameterList ( KVNameValueList & nl )

overridevirtual

Fill the list with all relevant parameters for batch system, set to their default values.

Parameters defined here are: JobTime [string] JobMemory [string] MultiJobsMode [bool] RunsPerJob [int] EMailOnStart [bool] EMailOnEnd [bool] EMailAddress [string]

Reimplemented from KVBatchSystem.

Definition at line 397 of file KV_CCIN2P3_Slurm.cpp.

◆ GetJobMemory()

const Char_t * KV_CCIN2P3_Slurm::GetJobMemory ( void ) const

returns the parameter string corresponding to the job Memory

Definition at line 166 of file KV_CCIN2P3_Slurm.cpp.

◆ GetJobTime()

const Char_t * KV_CCIN2P3_Slurm::GetJobTime ( void ) const

returns the parameter string corresponding to the job CPU time

Definition at line 155 of file KV_CCIN2P3_Slurm.cpp.

◆ GetRunsPerJob()

Int_t KV_CCIN2P3_Slurm::GetRunsPerJob ( ) const

inline

Returns number of runs per job submitted in multi jobs mode

Definition at line 51 of file KV_CCIN2P3_Slurm.h.

◆ MultiJobsMode()

Bool_t KV_CCIN2P3_Slurm::MultiJobsMode ( ) const

inlineoverridevirtual

Reimplemented from KVBatchSystem.

Definition at line 41 of file KV_CCIN2P3_Slurm.h.

◆ Print()

void KV_CCIN2P3_Slurm::Print ( Option_t * option = "" ) const

override

if option="log", print infos for batch log file if option="all", print detailed info on batch system

Definition at line 218 of file KV_CCIN2P3_Slurm.cpp.

◆ PrintJobs()

void KV_CCIN2P3_Slurm::PrintJobs ( Option_t * opt = "" )

overridevirtual

Print list of owner's jobs.

Reimplemented from KVBatchSystem.

Definition at line 91 of file KV_CCIN2P3_Slurm.cpp.

◆ ReadBatchEnvFile()

void KV_CCIN2P3_Slurm::ReadBatchEnvFile ( TEnv * env )

overridevirtual

Read any useful information on batch system from the TEnv (this method is used by KVDataAnalyser::ReadBatchEnvFile)

Reimplemented from KVBatchSystem.

Definition at line 200 of file KV_CCIN2P3_Slurm.cpp.

◆ Run()

void KV_CCIN2P3_Slurm::Run ( )

overridevirtual

Processes the job requests for the batch system. In normal mode, this submits one job for the data analyser fAnalyser In multijobs mode, this submits one job for each run in the runlist associated to fAnalyser

Reimplemented from KVBatchSystem.

Definition at line 311 of file KV_CCIN2P3_Slurm.cpp.

◆ SanitizeJobName()

void KV_CCIN2P3_Slurm::SanitizeJobName ( ) const

overridevirtual

Batch-system dependent sanitization of jobnames Grid Engine does not allow: : Any such character appearing in the current jobname will be replaced with '_'

Reimplemented from KVBatchSystem.

Definition at line 293 of file KV_CCIN2P3_Slurm.cpp.

◆ SetBatchSystemParameters()

void KV_CCIN2P3_Slurm::SetBatchSystemParameters ( const KVNameValueList & nl )

overridevirtual

Use the parameters in the list to set all relevant parameters for batch system.

Reimplemented from KVBatchSystem.

Definition at line 423 of file KV_CCIN2P3_Slurm.cpp.

◆ SetJobMemory()

void KV_CCIN2P3_Slurm::SetJobMemory ( const Char_t * mem = "" )

Set maximum memory used by job. Include units in string, i.e. "100M", "1G" etc. If mem="", use default value

Definition at line 75 of file KV_CCIN2P3_Slurm.cpp.

◆ SetJobTime()

void KV_CCIN2P3_Slurm::SetJobTime ( const Char_t * time = "" )

Set CPU time for batch job. SetJobTime() => use default time

Definition at line 55 of file KV_CCIN2P3_Slurm.cpp.

◆ SetMultiJobsMode()

void KV_CCIN2P3_Slurm::SetMultiJobsMode ( Bool_t on = kTRUE )

inline

Definition at line 37 of file KV_CCIN2P3_Slurm.h.

◆ SetRunsPerJob()

void KV_CCIN2P3_Slurm::SetRunsPerJob ( Int_t n )

inline

Set number of runs per job submitted in multi jobs mode (default=1)

Definition at line 46 of file KV_CCIN2P3_Slurm.h.

◆ WriteBatchEnvFile()

void KV_CCIN2P3_Slurm::WriteBatchEnvFile ( TEnv * env )

overridevirtual

Store any useful information on batch system in the TEnv (this method is used by KVDataAnalyser::WriteBatchEnvFile)

Reimplemented from KVBatchSystem.

Definition at line 179 of file KV_CCIN2P3_Slurm.cpp.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ KV_CCIN2P3_Slurm()

Member Function Documentation

◆ CheckJobParameters()

◆ ChooseJobMemory()

◆ ChooseJobTime()

◆ Clear()

◆ GetBatchSystemParameterList()

◆ GetJobMemory()

◆ GetJobTime()

◆ GetRunsPerJob()

◆ MultiJobsMode()

◆ Print()

◆ PrintJobs()

◆ ReadBatchEnvFile()

◆ Run()

◆ SanitizeJobName()

◆ SetBatchSystemParameters()

◆ SetJobMemory()

◆ SetJobTime()

◆ SetMultiJobsMode()

◆ SetRunsPerJob()

◆ WriteBatchEnvFile()