jobrunner.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          Oct 2004
________________________________________________________________________

-*/

#include "mmprocmod.h"
#include "executor.h"
#include "jobinfo.h"

class BufferStringSet;
class HostData;
class JobDescProv;
class JobIOMgr;
class StatusInfo;
namespace File { class Path; }

mExpClass(MMProc) HostNFailInfo
{ mODTextTranslationClass(HostNFailInfo);
public:
                        HostNFailInfo( const HostData& hd )
                            : hostdata_(hd)
                            , nrfailures_(0)
                            , nrsucces_(0)
                            , lastsuccess_(0)
                            , starttime_(0)
                            , inuse_(false) {}

    const HostData&     hostdata_;
    int                 nrfailures_; 
    int                 nrsucces_;
    int                 starttime_;  
    int                 lastsuccess_; 
    bool                inuse_;
};


mExpClass(MMProc) JobRunner : public Executor
{ mODTextTranslationClass(JobRunner);
public:

                                JobRunner(JobDescProv*,const char* cmd,
                                          od_ostream* logstrm=0);
                                ~JobRunner();

    const JobDescProv*          descProv() const        { return descprov_; }

    const ObjectSet<HostNFailInfo>& hostInfo() const    { return hostinfo_; }
    bool                        addHost(const HostData&);
    void                        removeHost(int);
    void                        pauseHost(int,bool);
    bool                        stopAll();
    bool                        hostFailed(int) const;
    bool                        isPaused(int) const;
    bool                        isAssigned( const JobInfo& ji ) const;

    int                         nrJobs( bool failed=false ) const
                                { return (failed ? failedjobs_ : jobinfos_)
                                         .size(); }
    const JobInfo&              jobInfo( int idx, bool failed=false ) const
                                { return *(failed ? failedjobs_ : jobinfos_)
                                         [idx]; }

    int                         jobsDone() const;
    int                         jobsInProgress() const;
    int                         jobsLeft() const
                                { return jobinfos_.size() - jobsDone(); }
    int                         totalJobs() const
                                { return jobinfos_.size()+failedjobs_.size(); }
    JobInfo*                    currentJob(const HostNFailInfo*) const;

    int                         nextStep()      { return doCycle(); }
    od_int64                    nrDone() const  { return jobsDone(); }
    od_int64                    totalNr() const { return totalJobs(); }
    uiString                    message() const;
    uiString                    nrDoneText() const;

                                // Set these before first step
    void                        setFirstPort( int n )       { firstport_ = n; }
    void                        setRshComm( const char* s ) { rshcomm_ = s; }
    void                        setProg( const char* s )    { prog_ = s; }
                                // Set this anytime
    void                        setPriority(float);

    void                        showMachStatus( BufferStringSet& ) const;
    const File::Path&           getBaseFilePath(JobInfo&, const HostData&);

    Notifier<JobRunner>         preJobStart;
    Notifier<JobRunner>         postJobStart;
    Notifier<JobRunner>         jobFailed;
    Notifier<JobRunner>         msgAvail;

    const JobInfo&              curJobInfo() const      { return *curjobinfo_; }
    IOPar&                      curJobIOPar()           { return curjobiop_; }
    const File::Path&           curJobFilePath()        { return curjobfp_; }

    const char*                 procDir() const { return procdir_.buf(); }
                                // processing directory on local machine
    uiString                    errorMsg() const;

protected:

    JobDescProv*                descprov_;
    ObjectSet<JobInfo>          jobinfos_;
    ObjectSet<HostNFailInfo>    hostinfo_;
    ObjectSet<JobInfo>          failedjobs_;
    BufferString                prog_;
    BufferString                procdir_;
    File::Path&                 curjobfp_;
    IOPar&                      curjobiop_;
    JobInfo*                    curjobinfo_;
    od_ostream*                 logstrm_;

    JobIOMgr&                   iomgr();
    JobIOMgr*                   iomgr_;

    float                       prioritylevel_;
    int                         firstport_;
    BufferString                rshcomm_;
    int                         maxhostfailures_; 
    int                         maxjobfailures_;  
    int                         maxjobhstfails_;  
    int                         starttimeout_;
    int                         failtimeout_;
    int                         wrapuptimeout_;
    int                         hosttimeout_;
    int                         startwaittime_;  
    uiString                    errmsg_;

    int                         doCycle();
    HostNFailInfo*              hostNFailInfoFor(const HostData*) const;

    void                        updateJobInfo();
    void                        handleStatusInfo( StatusInfo& );
    JobInfo*                    gtJob( int descnr );

    void                        failedJob( JobInfo&, JobInfo::State );

    enum StartRes               { Started, NotStarted, JobBad, HostBad };
    StartRes                    startJob( JobInfo& ji, HostNFailInfo& jhi );
    bool                        runJob(JobInfo&,const HostData&);


    enum AssignStat             { NotReady, BadHost, JobStarted, NoJobs };
    AssignStat                  assignJob(HostNFailInfo&);
    bool                        haveIncomplete() const;

    enum HostStat               { OK = 0, SomeFailed = 1, HostFailed = 2 };
    HostStat                    hostStatus(const HostNFailInfo*) const;

};

mGlobal(MMProc) int& MMJob_getTempFileNr();