KaliVeda
1.12/06
Heavy-Ion Analysis Toolkit
|
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 14 of file KV_CCIN2P3_GE.h.
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 * | GetJobName () const |
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 * | 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 |
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) |
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 TObject * | Clone (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 |
TNamed & | operator= (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 TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
virtual TObject * | FindObject (const TObject *obj) const |
virtual Option_t * | GetDrawOption () const |
virtual const char * | GetIconName () const |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
virtual Option_t * | GetOption () 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) |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (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 | 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 |
Protected Attributes inherited from KVBatchSystem | |
KVDataAnalyser * | fAnalyser |
the analyser object which requests job submission, it has all details on the job More... | |
KVString | fCurrJobName |
name of current 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 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 date. 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, 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 () |
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_GE.h>
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 23 of file KV_CCIN2P3_GE.cpp.
|
virtual |
|
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 307 of file KV_CCIN2P3_GE.cpp.
|
virtual |
Checks the job and asks for any missing parameters.
Reimplemented from KVBatchSystem.
Definition at line 134 of file KV_CCIN2P3_GE.cpp.
Definition at line 186 of file KV_CCIN2P3_GE.cpp.
Definition at line 172 of file KV_CCIN2P3_GE.cpp.
Definition at line 153 of file KV_CCIN2P3_GE.cpp.
Clear previously set parameters in order to create a new job submission command.
Reimplemented from KVBatchSystem.
Definition at line 43 of file KV_CCIN2P3_GE.cpp.
|
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 640 of file KV_CCIN2P3_GE.cpp.
returns the parameter string corresponding to the job Disk
Definition at line 223 of file KV_CCIN2P3_GE.cpp.
returns the parameter string corresponding to the job Memory
Definition at line 212 of file KV_CCIN2P3_GE.cpp.
|
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 591 of file KV_CCIN2P3_GE.cpp.
returns the parameter string corresponding to the job CPU time
Definition at line 201 of file KV_CCIN2P3_GE.cpp.
|
virtual |
Create and fill list with KVBatchJob objects describing current jobs Delete list after use
Reimplemented from KVBatchSystem.
Definition at line 367 of file KV_CCIN2P3_GE.cpp.
|
inline |
Returns number of runs per job submitted in multi jobs mode
Definition at line 55 of file KV_CCIN2P3_GE.h.
|
inline |
Definition at line 45 of file KV_CCIN2P3_GE.h.
if option="log", print infos for batch log file if option="all", print detailed info on batch system
Reimplemented from KVBatchSystem.
Definition at line 277 of file KV_CCIN2P3_GE.cpp.
Print list of owner's jobs.
Reimplemented from KVBatchSystem.
Definition at line 121 of file KV_CCIN2P3_GE.cpp.
Read any useful information on batch system from the TEnv (this method is used by KVDataAnalyser::ReadBatchEnvFile)
Reimplemented from KVBatchSystem.
Definition at line 258 of file KV_CCIN2P3_GE.cpp.
|
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 515 of file KV_CCIN2P3_GE.cpp.
|
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 350 of file KV_CCIN2P3_GE.cpp.
|
virtual |
Use the parameters in the list to set all relevant parameters for batch system.
Reimplemented from KVBatchSystem.
Definition at line 671 of file KV_CCIN2P3_GE.cpp.
Set maximum disk space used by job. Include units in string, i.e. "100M", "1G" etc. If diks="", use default value
Definition at line 105 of file KV_CCIN2P3_GE.cpp.
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_GE.cpp.
Set CPU time for batch job. SetJobTime() => use default time
Definition at line 68 of file KV_CCIN2P3_GE.cpp.
Definition at line 41 of file KV_CCIN2P3_GE.h.
Set number of runs per job submitted in multi jobs mode (default=1)
Definition at line 50 of file KV_CCIN2P3_GE.h.
void KV_CCIN2P3_GE::SetSendMailAddress | ( | const char * | ) |
set email address for notifications
Definition at line 502 of file KV_CCIN2P3_GE.cpp.
void KV_CCIN2P3_GE::SetSendMailOnJobEnd | ( | ) |
add option to send mail when job ends
Definition at line 491 of file KV_CCIN2P3_GE.cpp.
void KV_CCIN2P3_GE::SetSendMailOnJobStart | ( | ) |
add option to send mail when job starts
Definition at line 480 of file KV_CCIN2P3_GE.cpp.
Store any useful information on batch system in the TEnv (this method is used by KVDataAnalyser::WriteBatchEnvFile)
Reimplemented from KVBatchSystem.
Definition at line 236 of file KV_CCIN2P3_GE.cpp.
|
protected |
runlist for (multi job mode) job being submitted
Definition at line 20 of file KV_CCIN2P3_GE.h.
|
protected |
default job disk space (with units, e.g. "1G")
Definition at line 23 of file KV_CCIN2P3_GE.h.
|
protected |
default job memory allocation (with units, e.g. "512M")
Definition at line 22 of file KV_CCIN2P3_GE.h.
|
protected |
default job length
Definition at line 21 of file KV_CCIN2P3_GE.h.
|
protected |
Definition at line 25 of file KV_CCIN2P3_GE.h.
|
protected |
Definition at line 26 of file KV_CCIN2P3_GE.h.
|
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_GE.h.
|
protected |
number of runs per job submitted in multi job mode (default=1)
Definition at line 19 of file KV_CCIN2P3_GE.h.
|
protected |
Definition at line 24 of file KV_CCIN2P3_GE.h.