KaliVeda  1.13/01
Heavy-Ion Analysis Toolkit
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KV_CCIN2P3_Slurm Class Reference

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 15 of file KV_CCIN2P3_Slurm.h.

Public Member Functions

 KV_CCIN2P3_Slurm (const Char_t *name)
 
virtual ~ KV_CCIN2P3_Slurm ()
 
virtual Bool_t CheckJobParameters ()
 Checks the job and asks for any missing parameters. More...
 
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_tGetJobMemory (void) const
 returns the parameter string corresponding to the job Memory More...
 
const Char_tGetJobName () const
 
const Char_tGetJobTime (void) const
 returns the parameter string corresponding to the job CPU time More...
 
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 SetJobMemory (const Char_t *h="")
 
void SetJobTime (const Char_t *h="")
 
void SetMultiJobsMode (Bool_t on=kTRUE)
 
void SetRunsPerJob (Int_t n)
 
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_tGetDefaultJobOptions () const
 
virtual const Char_tGetJobSubCmd () const
 
virtual const Char_tGetJobSubCmdLine ()
 
virtual KVListGetListOfJobs ()
 
KVNameValueListGetParameters ()
 
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_tGetLabel () const
 
UInt_t GetNumber () const
 
UInt_t GetNumberOfObjects () const
 
virtual TObjectGetObject () const
 
virtual const Char_tGetType () 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 ()
 
KVBaseoperator= (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)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 
virtual TObjectClone (const char *newname="") const
 
virtual Int_t Compare (const TObject *obj) const
 
virtual void FillBuffer (char *&buffer)
 
virtual const char * GetName () const
 
virtual const char * GetTitle () const
 
virtual ULong_t Hash () const
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 
TNamedoperator= (const TNamed &rhs)
 
virtual void SetName (const char *name)
 
virtual void SetNameTitle (const char *name, const char *title)
 
virtual void SetTitle (const char *title="")
 
virtual Int_t Sizeof () const
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 
virtual ~TObject ()
 
void AbstractMethod (const char *method) const
 
virtual void AppendPad (Option_t *option="")
 
virtual void Browse (TBrowser *b)
 
ULong_t CheckedHash ()
 
virtual const char * ClassName () const
 
virtual void Delete (Option_t *option="")
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 
virtual void Draw (Option_t *option="")
 
virtual void DrawClass () const
 
virtual TObjectDrawClone (Option_t *option="") const
 
virtual void Dump () const
 
virtual void Error (const char *method, const char *msgfmt,...) const
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 
virtual TObjectFindObject (const char *name) const
 
virtual TObjectFindObject (const TObject *obj) const
 
virtual Option_tGetDrawOption () const
 
virtual const char * GetIconName () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 
virtual Bool_t HandleTimer (TTimer *timer)
 
Bool_t HasInconsistentHash () const
 
virtual void Info (const char *method, const char *msgfmt,...) const
 
virtual Bool_t InheritsFrom (const char *classname) const
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 
virtual void Inspect () const
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 
virtual Bool_t IsFolder () const
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 
virtual Bool_t Notify ()
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 
void operator delete (void *ptr)
 
void operator delete[] (void *ptr)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 
virtual void Paint (Option_t *option="")
 
virtual void Pop ()
 
virtual Int_t Read (const char *name)
 
virtual void RecursiveRemove (TObject *obj)
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 
virtual void SetDrawOption (Option_t *option="")
 
virtual void SetUniqueID (UInt_t uid)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 

Protected Member Functions

virtual void ChangeDefJobOpt (KVDataAnalyser *)
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 
void MakeZombie ()
 

Protected Attributes

KVNumberList fCurrJobRunList
 runlist for (multi job mode) job being submitted More...
 
KVString fDefJobMem
 default job memory allocation (with units, e.g. "512M") More...
 
KVString fDefJobTime
 default job length More...
 
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
 
- Protected Attributes inherited from KVBatchSystem
KVDataAnalyserfAnalyser
 the analyser object which requests job submission, it has all details on the job More...
 
KVString fCurrJobName
 name of current job being submitted More...
 
KVNumberList fCurrJobRunList
 runlist for (multi job mode) job being submitted More...
 
KVString fDefOpt
 default options for job submission command More...
 
KVString fJobName
 base job name More...
 
KVString fJobScript
 full path of shell script to be executed by batch system More...
 
KVString fJobSubCmd
 shell command for submitting job More...
 
KVNameValueList fParList
 list of parameters/switches to be passed on job submission command line More...
 
- Protected Attributes inherited from KVBase
TString fLabel
 label for the object More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TObject
 kOnlyPrepStep
 

Additional Inherited Members

- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 
- Public Types inherited from TObject
enum  EDeprecatedStatusBits
 
enum  EStatusBits
 
- Static Public Member Functions inherited from KVBatchSystem
static KVBatchSystemGetBatchSystem (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_tFindFile (const Char_t *search, TString &wfil)
 
static const Char_tGetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetDATABASEFilePath ()
 
static const Char_tGetDATADIRFilePath (const Char_t *namefile="")
 
static Bool_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval)
 
static const Char_tGetDataSetEnv (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_tGetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.) More...
 
static const Char_tGetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetKVBuildDate ()
 Returns KaliVeda build date. More...
 
static const Char_tGetKVBuildDir ()
 Returns top-level directory used for build. More...
 
static const Char_tGetKVBuildTime ()
 Returns KaliVeda build time. More...
 
static const Char_tGetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...) More...
 
static const Char_tGetKVBuildUser ()
 Returns username of person who performed build. More...
 
static const Char_tGetKVSourceDir ()
 Returns top-level directory of source tree used for build. More...
 
static const Char_tGetKVVersion ()
 Returns KaliVeda version string. More...
 
static const Char_tGetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetListOfPlugins (const Char_t *base)
 
static const Char_tGetListOfPluginURIs (const Char_t *base)
 
static const Char_tGetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_tGetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_tgitBranch ()
 Returns git branch of sources. More...
 
static const Char_tgitCommit ()
 Returns last git commit of sources. More...
 
static void InitEnvironment ()
 
static bool is_gnuinstall ()
 
static Bool_t IsThisAPlugin (const TString &uri, TString &base)
 
static TPluginHandlerLoadPlugin (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_tWorkingDirectory ()
 
- Static Public Member Functions inherited from TObject
static Longptr_t GetDtorOnly ()
 
static Bool_t GetObjectStat ()
 
static void SetDtorOnly (void *obj)
 
static void SetObjectStat (Bool_t stat)
 
- Public Attributes inherited from TObject
 kBitMask
 
 kCanDelete
 
 kCannotPick
 
 kHasUUID
 
 kInconsistent
 
 kInvalidObject
 
 kIsOnHeap
 
 kIsReferenced
 
 kMustCleanup
 
 kNoContextMenu
 
 kNotDeleted
 
 kObjInCanvas
 
 kOverwrite
 
 kSingleKey
 
 kWriteDelete
 
 kZombie
 

#include <KV_CCIN2P3_Slurm.h>

Inheritance diagram for KV_CCIN2P3_Slurm:
Inheritance graph
[legend]

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 23 of file KV_CCIN2P3_Slurm.cpp.

◆ ~ KV_CCIN2P3_Slurm()

virtual KV_CCIN2P3_Slurm::~ KV_CCIN2P3_Slurm ( )
virtual

Member Function Documentation

◆ ChangeDefJobOpt()

void KV_CCIN2P3_Slurm::ChangeDefJobOpt ( KVDataAnalyser da)
protectedvirtual

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 257 of file KV_CCIN2P3_Slurm.cpp.

◆ CheckJobParameters()

Bool_t KV_CCIN2P3_Slurm::CheckJobParameters ( )
virtual

Checks the job and asks for any missing parameters.

Reimplemented from KVBatchSystem.

Definition at line 116 of file KV_CCIN2P3_Slurm.cpp.

◆ ChooseJobMemory()

void KV_CCIN2P3_Slurm::ChooseJobMemory ( void  )

Definition at line 151 of file KV_CCIN2P3_Slurm.cpp.

◆ ChooseJobTime()

void KV_CCIN2P3_Slurm::ChooseJobTime ( void  )

Definition at line 133 of file KV_CCIN2P3_Slurm.cpp.

◆ Clear()

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

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

Reimplemented from KVBatchSystem.

Definition at line 42 of file KV_CCIN2P3_Slurm.cpp.

◆ GetBatchSystemParameterList()

void KV_CCIN2P3_Slurm::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] MultiJobsMode [bool] RunsPerJob [int] EMailOnStart [bool] EMailOnEnd [bool] EMailAddress [string]

Reimplemented from KVBatchSystem.

Definition at line 437 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 177 of file KV_CCIN2P3_Slurm.cpp.

◆ GetJobName()

const Char_t * KV_CCIN2P3_Slurm::GetJobName ( ) const
virtual

Returns name of batch job, either during submission of batch jobs or when an analysis task is running in batch mode (access through gBatchSystem global pointer).

In multi-job mode, the job name is generated from the base name set by SetJobName() plus the extension "_Rxxxx-yyyy" with "xxxx" and "yyyy" the number of the first and last run which will be analysed by the current job.

Depending on the batch system, some sanitization of the jobname may be required e.g. to remove "illegal" characters from the jobname. This is done by SanitizeJobName() before the jobname is returned.

Reimplemented from KVBatchSystem.

Definition at line 390 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 166 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 52 of file KV_CCIN2P3_Slurm.h.

◆ MultiJobsMode()

Bool_t KV_CCIN2P3_Slurm::MultiJobsMode ( ) const
inlinevirtual

Reimplemented from KVBatchSystem.

Definition at line 42 of file KV_CCIN2P3_Slurm.h.

◆ Print()

void KV_CCIN2P3_Slurm::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 229 of file KV_CCIN2P3_Slurm.cpp.

◆ PrintJobs()

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

Print list of owner's jobs.

Reimplemented from KVBatchSystem.

Definition at line 103 of file KV_CCIN2P3_Slurm.cpp.

◆ ReadBatchEnvFile()

void KV_CCIN2P3_Slurm::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 211 of file KV_CCIN2P3_Slurm.cpp.

◆ Run()

void KV_CCIN2P3_Slurm::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 316 of file KV_CCIN2P3_Slurm.cpp.

◆ SanitizeJobName()

void KV_CCIN2P3_Slurm::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 298 of file KV_CCIN2P3_Slurm.cpp.

◆ SetBatchSystemParameters()

void KV_CCIN2P3_Slurm::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 463 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 87 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 67 of file KV_CCIN2P3_Slurm.cpp.

◆ SetMultiJobsMode()

void KV_CCIN2P3_Slurm::SetMultiJobsMode ( Bool_t  on = kTRUE)
inline

Definition at line 38 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 47 of file KV_CCIN2P3_Slurm.h.

◆ WriteBatchEnvFile()

void KV_CCIN2P3_Slurm::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 190 of file KV_CCIN2P3_Slurm.cpp.

Member Data Documentation

◆ fCurrJobRunList

KVNumberList KV_CCIN2P3_Slurm::fCurrJobRunList
protected

runlist for (multi job mode) job being submitted

Definition at line 20 of file KV_CCIN2P3_Slurm.h.

◆ fDefJobMem

KVString KV_CCIN2P3_Slurm::fDefJobMem
protected

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

Definition at line 22 of file KV_CCIN2P3_Slurm.h.

◆ fDefJobTime

KVString KV_CCIN2P3_Slurm::fDefJobTime
protected

default job length

Definition at line 21 of file KV_CCIN2P3_Slurm.h.

◆ fMemSet

Bool_t KV_CCIN2P3_Slurm::fMemSet
protected

Definition at line 24 of file KV_CCIN2P3_Slurm.h.

◆ fMultiJobs

Bool_t KV_CCIN2P3_Slurm::fMultiJobs
protected

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

Definition at line 18 of file KV_CCIN2P3_Slurm.h.

◆ fRunsPerJob

Int_t KV_CCIN2P3_Slurm::fRunsPerJob
protected

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

Definition at line 19 of file KV_CCIN2P3_Slurm.h.

◆ fTimeSet

Bool_t KV_CCIN2P3_Slurm::fTimeSet
protected

Definition at line 23 of file KV_CCIN2P3_Slurm.h.


The documentation for this class was generated from the following files: