Detailed Description

Interface to CCIN2P3 Grid Engine batch job management system.

Created by KVClassFactory on Wed Apr 27 15:43:08 CEST 2011 Author: John Frankland

Definition at line 15 of file KV_CCIN2P3_GE.h.

#include <KV_CCIN2P3_GE.h>

Inheritance diagram for KV_CCIN2P3_GE:

[legend]

Public Member Functions
	KV_CCIN2P3_GE (const Char_t *name)

virtual	~ KV_CCIN2P3_GE ()

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

void	ChooseJobDisk (void)

void	ChooseJobMemory (void)

void	ChooseJobTime (void)

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

virtual void	GetBatchSystemParameterList (KVNameValueList &)

const Char_t *	GetJobDisk (void) const
	returns the parameter string corresponding to the job Disk More...

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...

virtual KVList *	GetListOfJobs ()

Int_t	GetRunsPerJob () const

Bool_t	MultiJobsMode () const

virtual void	Print (Option_t *="") const

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

virtual void	ReadBatchEnvFile (TEnv *)

void	Run ()

virtual void	SanitizeJobName () const

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

void	SetJobDisk (const Char_t *h="")

void	SetJobMemory (const Char_t *h="")

void	SetJobTime (const Char_t *h="")

void	SetMultiJobsMode (Bool_t on=kTRUE)

void	SetRunsPerJob (Int_t n)

void	SetSendMailAddress (const char *)
	set email address for notifications More...

void	SetSendMailOnJobEnd ()
	add option to send mail when job ends More...

void	SetSendMailOnJobStart ()
	add option to send mail when job starts More...

virtual void	WriteBatchEnvFile (TEnv *)

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

virtual	~ KVBatchSystem ()

virtual void	AlterJobs (TGWindow , TList )

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

virtual const Char_t *	GetDefaultJobOptions () const

virtual const Char_t *	GetJobName () const

virtual const Char_t *	GetJobSubCmd () const

virtual const Char_t *	GetJobSubCmdLine ()

KVNameValueList &	GetParameters ()

virtual 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...

virtual	~ KVBase ()

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

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

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

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Private Member Functions
virtual void	ChangeDefJobOpt (KVDataAnalyser *)

Private Attributes
KVString	fDefJobDisk
	default job disk space (with units, e.g. "1G") More...

KVString	fDefJobMem
	default job memory allocation (with units, e.g. "512M") More...

KVString	fDefJobTime
	default job length More...

Bool_t	fDiskSet

Bool_t	fMemSet

Bool_t	fMultiJobs
	set to kTRUE if several jobs are to be submitted for the runlist set in fAnalyser More...

Int_t	fRunsPerJob
	number of runs per job submitted in multi job mode (default=1) More...

Bool_t	fTimeSet

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

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

Static Public Member Functions inherited from KVBase
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 Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t 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="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t 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 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	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 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_GE()

KV_CCIN2P3_GE::KV_CCIN2P3_GE ( const Char_t * name )

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

Definition at line 24 of file KV_CCIN2P3_GE.cpp.

◆ ~ KV_CCIN2P3_GE()

virtual KV_CCIN2P3_GE::~ KV_CCIN2P3_GE ( )

virtual

Member Function Documentation

◆ ChangeDefJobOpt()

void KV_CCIN2P3_GE::ChangeDefJobOpt ( KVDataAnalyser * da )

privatevirtual

PRIVATE method called by SubmitTask() at moment of job submission. Depending on the current environment, the default job submission options may be changed by this method.

This method overrides and augments KVBatchSystem::ChangeDefJobOpt (which changes the options as a function of the type of analysis task). Here we add the CCIN2P3-specific case where the job is launched from a directory on the /sps/ semi-permanent storage facility, or if the data being analysed is stored in a repository on /sps/. In this case we need to add the option '-l u_sps_indra' to the 'qsub' command (if not already in the default job options)

Reimplemented from KVBatchSystem.

Definition at line 308 of file KV_CCIN2P3_GE.cpp.

◆ CheckJobParameters()

Bool_t KV_CCIN2P3_GE::CheckJobParameters ( )

virtual

Checks the job and asks for any missing parameters.

Reimplemented from KVBatchSystem.

Definition at line 135 of file KV_CCIN2P3_GE.cpp.

◆ ChooseJobDisk()

void KV_CCIN2P3_GE::ChooseJobDisk ( void )

Definition at line 187 of file KV_CCIN2P3_GE.cpp.

◆ ChooseJobMemory()

void KV_CCIN2P3_GE::ChooseJobMemory ( void )

Definition at line 173 of file KV_CCIN2P3_GE.cpp.

◆ ChooseJobTime()

void KV_CCIN2P3_GE::ChooseJobTime ( void )

Definition at line 154 of file KV_CCIN2P3_GE.cpp.

◆ Clear()

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

virtual

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

Reimplemented from KVBatchSystem.

Definition at line 44 of file KV_CCIN2P3_GE.cpp.

◆ GetBatchSystemParameterList()

void KV_CCIN2P3_GE::GetBatchSystemParameterList ( KVNameValueList & nl )

virtual

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

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

Reimplemented from KVBatchSystem.

Definition at line 594 of file KV_CCIN2P3_GE.cpp.

◆ GetJobDisk()

const Char_t * KV_CCIN2P3_GE::GetJobDisk ( void ) const

returns the parameter string corresponding to the job Disk

Definition at line 224 of file KV_CCIN2P3_GE.cpp.

◆ GetJobMemory()

const Char_t * KV_CCIN2P3_GE::GetJobMemory ( void ) const

returns the parameter string corresponding to the job Memory

Definition at line 213 of file KV_CCIN2P3_GE.cpp.

◆ GetJobTime()

const Char_t * KV_CCIN2P3_GE::GetJobTime ( void ) const

returns the parameter string corresponding to the job CPU time

Definition at line 202 of file KV_CCIN2P3_GE.cpp.

◆ GetListOfJobs()

KVList * KV_CCIN2P3_GE::GetListOfJobs ( )

virtual

Create and fill list with KVBatchJob objects describing current jobs Delete list after use

Reimplemented from KVBatchSystem.

Definition at line 368 of file KV_CCIN2P3_GE.cpp.

◆ GetRunsPerJob()

Int_t KV_CCIN2P3_GE::GetRunsPerJob ( ) const

inline

Returns number of runs per job submitted in multi jobs mode

Definition at line 55 of file KV_CCIN2P3_GE.h.

◆ MultiJobsMode()

Bool_t KV_CCIN2P3_GE::MultiJobsMode ( ) const

inlinevirtual

Reimplemented from KVBatchSystem.

Definition at line 45 of file KV_CCIN2P3_GE.h.

◆ Print()

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

virtual

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

Reimplemented from KVBatchSystem.

Definition at line 278 of file KV_CCIN2P3_GE.cpp.

◆ PrintJobs()

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

virtual

Print list of owner's jobs.

Reimplemented from KVBatchSystem.

Definition at line 122 of file KV_CCIN2P3_GE.cpp.

◆ ReadBatchEnvFile()

void KV_CCIN2P3_GE::ReadBatchEnvFile ( TEnv * env )

virtual

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

Reimplemented from KVBatchSystem.

Definition at line 259 of file KV_CCIN2P3_GE.cpp.

◆ Run()

void KV_CCIN2P3_GE::Run ( )

virtual

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 516 of file KV_CCIN2P3_GE.cpp.

◆ SanitizeJobName()

void KV_CCIN2P3_GE::SanitizeJobName ( ) const

virtual

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 351 of file KV_CCIN2P3_GE.cpp.

◆ SetBatchSystemParameters()

void KV_CCIN2P3_GE::SetBatchSystemParameters ( const KVNameValueList & nl )

virtual

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

Reimplemented from KVBatchSystem.

Definition at line 625 of file KV_CCIN2P3_GE.cpp.

◆ SetJobDisk()

void KV_CCIN2P3_GE::SetJobDisk ( const Char_t * diks = "" )

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

Definition at line 106 of file KV_CCIN2P3_GE.cpp.

◆ SetJobMemory()

void KV_CCIN2P3_GE::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 88 of file KV_CCIN2P3_GE.cpp.

◆ SetJobTime()

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

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

Definition at line 69 of file KV_CCIN2P3_GE.cpp.

◆ SetMultiJobsMode()

void KV_CCIN2P3_GE::SetMultiJobsMode ( Bool_t on = kTRUE )

inline

Definition at line 41 of file KV_CCIN2P3_GE.h.

◆ SetRunsPerJob()

void KV_CCIN2P3_GE::SetRunsPerJob ( Int_t n )

inline

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

Definition at line 50 of file KV_CCIN2P3_GE.h.

◆ SetSendMailAddress()

void KV_CCIN2P3_GE::SetSendMailAddress ( const char * email )

set email address for notifications

Definition at line 503 of file KV_CCIN2P3_GE.cpp.

◆ SetSendMailOnJobEnd()

void KV_CCIN2P3_GE::SetSendMailOnJobEnd ( )

add option to send mail when job ends

Definition at line 492 of file KV_CCIN2P3_GE.cpp.

◆ SetSendMailOnJobStart()

void KV_CCIN2P3_GE::SetSendMailOnJobStart ( )

add option to send mail when job starts

Definition at line 481 of file KV_CCIN2P3_GE.cpp.

◆ WriteBatchEnvFile()

void KV_CCIN2P3_GE::WriteBatchEnvFile ( TEnv * env )

virtual

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

Reimplemented from KVBatchSystem.

Definition at line 237 of file KV_CCIN2P3_GE.cpp.

Member Data Documentation

◆ fDefJobDisk

KVString KV_CCIN2P3_GE::fDefJobDisk

private

default job disk space (with units, e.g. "1G")

Definition at line 23 of file KV_CCIN2P3_GE.h.

◆ fDefJobMem

KVString KV_CCIN2P3_GE::fDefJobMem

private

default job memory allocation (with units, e.g. "512M")

Definition at line 22 of file KV_CCIN2P3_GE.h.

◆ fDefJobTime

KVString KV_CCIN2P3_GE::fDefJobTime

private

default job length

Definition at line 21 of file KV_CCIN2P3_GE.h.

◆ fDiskSet

Bool_t KV_CCIN2P3_GE::fDiskSet

private

Definition at line 25 of file KV_CCIN2P3_GE.h.

◆ fMemSet

Bool_t KV_CCIN2P3_GE::fMemSet

private

Definition at line 26 of file KV_CCIN2P3_GE.h.

◆ fMultiJobs

Bool_t KV_CCIN2P3_GE::fMultiJobs

private

set to kTRUE if several jobs are to be submitted for the runlist set in fAnalyser

Definition at line 19 of file KV_CCIN2P3_GE.h.

◆ fRunsPerJob

Int_t KV_CCIN2P3_GE::fRunsPerJob

private

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

Definition at line 20 of file KV_CCIN2P3_GE.h.

◆ fTimeSet

Bool_t KV_CCIN2P3_GE::fTimeSet

private

Definition at line 24 of file KV_CCIN2P3_GE.h.

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KV_CCIN2P3_GE()

◆ ~ KV_CCIN2P3_GE()

Member Function Documentation

◆ ChangeDefJobOpt()

◆ CheckJobParameters()

◆ ChooseJobDisk()

◆ ChooseJobMemory()

◆ ChooseJobTime()

◆ Clear()

◆ GetBatchSystemParameterList()

◆ GetJobDisk()

◆ GetJobMemory()

◆ GetJobTime()

◆ GetListOfJobs()

◆ GetRunsPerJob()

◆ MultiJobsMode()

◆ Print()

◆ PrintJobs()

◆ ReadBatchEnvFile()

◆ Run()

◆ SanitizeJobName()

◆ SetBatchSystemParameters()

◆ SetJobDisk()

◆ SetJobMemory()

◆ SetJobTime()

◆ SetMultiJobsMode()

◆ SetRunsPerJob()

◆ SetSendMailAddress()

◆ SetSendMailOnJobEnd()

◆ SetSendMailOnJobStart()

◆ WriteBatchEnvFile()

Member Data Documentation

◆ fDefJobDisk

◆ fDefJobMem

◆ fDefJobTime

◆ fDiskSet

◆ fMemSet

◆ fMultiJobs

◆ fRunsPerJob

◆ fTimeSet