paralleltask.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/K.Tingdahl
 Date:          13-10-1999
________________________________________________________________________

-*/

#include "basicmod.h"
#include "task.h"
#include "atomic.h"

class ParallelTaskRunner;


mExpClass(Basic) ParallelTask : public Task
{ mODTextTranslationClass(ParallelTask);
public:
    virtual             ~ParallelTask();

    bool                execute() { return executeParallel(true); }
    virtual bool        executeParallel(bool parallel);
    void                setProgressMeter(ProgressMeter*);
    od_int64            nrDone() const;

    od_int64            totalNr() const { return nrIterations(); }
    static uiString     sPosFinished()  { return tr("Positions finished"); }
    static uiString     sTrcFinished()  { return tr("Traces finished"); }

protected:

    virtual od_int64    nrIterations() const                            = 0;
    virtual int         maxNrThreads() const;
    virtual int         minThreadSize() const   { return 1; }
    virtual bool        stopAllOnFailure() const        { return true; }
                        ParallelTask(const char* nm=0);
                        ParallelTask(const ParallelTask&);
    od_int64            calculateThreadSize(od_int64 totalnr,int nrthreads,
                                            int thread) const;

    void                addToNrDone(od_int64 increment);
    void                quickAddToNrDone(od_int64 loopidx);
    void                resetNrDone();

private:
    virtual bool        doWork(od_int64 start,od_int64 stop,int threadidx) = 0;
    virtual bool        doPrepare(int nrthreads)        { return true; }
    virtual bool        doFinish(bool success)          { return success; }
    friend class                        ParallelTaskRunner;
    ProgressMeter*                      progressmeter_;
    Threads::Atomic<od_int64>           nrdone_;

private:

    od_int64                            totalnrcache_;
    od_int64                            nrdonebigchunksz_;

};


#define mDeclareParallelCalcStd(uimsg) \
    od_int64    sz_; \
    bool        reportprogress_; \
    void        setReport(bool yn)              { reportprogress_ = yn; } \
    od_int64    nrIterations() const            { return sz_; } \
    uiString    message() const         { return uimsg; } \
    uiString    nrDoneText() const              { return sPosFinished(); } \

#define mDefParallelCalcNoPars(clss,uimsg) \
        class clss : public ParallelTask \
        { mODTextTranslationClass(clss); \
        public: \
            mDeclareParallelCalcStd(uimsg); \
            clss( od_int64 _sz_ ) : sz_(_sz_), reportprogress_(true)    {} \

#define mDefParallelCalc1Par(clss,uimsg,T1,v1) \
        class clss : public ParallelTask \
        { mODTextTranslationClass(clss); \
        public: \
            mDeclareParallelCalcStd(uimsg); \
            T1          v1##_; \
            clss( od_int64 _sz_, T1 _##v1##_ ) \
                : sz_(_sz_), reportprogress_(true), v1##_(_##v1##_)     {} \

#define mDefParallelCalc2Pars(clss,uimsg,T1,v1,T2,v2) \
        class clss : public ParallelTask \
        { mODTextTranslationClass(clss); \
        public: \
            mDeclareParallelCalcStd(uimsg); \
            T1 v1##_; T2 v2##_; \
            clss( od_int64 _sz_, T1 _##v1##_, T2 _##v2##_ ) \
                : sz_(_sz_), reportprogress_(true) \
                , v1##_(_##v1##_), v2##_(_##v2##_)                      {} \

#define mDefParallelCalc3Pars(clss,uimsg,T1,v1,T2,v2,T3,v3) \
        class clss : public ParallelTask \
        { mODTextTranslationClass(clss); \
        public: \
            mDeclareParallelCalcStd(uimsg); \
            T1 v1##_; T2 v2##_; T3 v3##_; \
            clss( od_int64 _sz_, \
                    T1 _##v1##_, T2 _##v2##_, T3 _##v3##_ ) \
                : sz_(_sz_), reportprogress_(true) \
                , v1##_(_##v1##_), v2##_(_##v2##_) , v3##_(_##v3##_)    {} \

#define mDefParallelCalc4Pars(clss,uimsg,T1,v1,T2,v2,T3,v3,T4,v4) \
        class clss : public ParallelTask \
        { mODTextTranslationClass(clss); \
        public: \
            mDeclareParallelCalcStd(uimsg); \
            T1 v1##_; T2 v2##_; T3 v3##_; T4 v4##_; \
            clss( od_int64 _sz_, \
                    T1 _##v1##_, T2 _##v2##_, T3 _##v3##_, T4 _##v4##_ ) \
                : sz_(_sz_), reportprogress_(true) \
                , v1##_(_##v1##_), v2##_(_##v2##_) \
                , v3##_(_##v3##_), v4##_(_##v4##_)                      {} \


#define mDefParallelCalc5Pars(clss,uimsg,T1,v1,T2,v2,T3,v3,T4,v4,T5,v5) \
        class clss : public ParallelTask \
        { mODTextTranslationClass(clss); \
        public: \
            mDeclareParallelCalcStd(uimsg); \
            T1 v1##_; T2 v2##_; T3 v3##_; T4 v4##_; T5 v5##_;\
            clss( od_int64 _sz_, T1 _##v1##_, T2 _##v2##_, T3 _##v3##_, \
                                 T4 _##v4##_, T5 _##v5##_ ) \
                : sz_(_sz_), reportprogress_(true) \
                , v1##_(_##v1##_), v2##_(_##v2##_) \
                , v3##_(_##v3##_), v4##_(_##v4##_), v5##_(_##v5##_)     {} \

#define mDefParallelCalc6Pars(clss,uimsg,T1,v1,T2,v2,T3,v3,T4,v4,T5,v5,T6,v6) \
        class clss : public ParallelTask \
        { mODTextTranslationClass(clss); \
        public: \
            mDeclareParallelCalcStd(uimsg); \
            T1 v1##_; T2 v2##_; T3 v3##_; T4 v4##_; T5 v5##_; T6 v6##_;\
            clss( od_int64 _sz_, T1 _##v1##_, T2 _##v2##_, T3 _##v3##_, \
                                 T4 _##v4##_, T5 _##v5##_, T6 _##v6##_ ) \
                : sz_(_sz_), reportprogress_(true) \
                , v1##_(_##v1##_), v2##_(_##v2##_) \
                , v3##_(_##v3##_), v4##_(_##v4##_) \
                , v5##_(_##v5##_), v6##_(_##v6##_)                      {} \

#define mDefParallelCalc7Pars(clss,uimsg,T1,v1,T2,v2,T3,v3,T4,v4,T5,v5, \
                              T6,v6,T7,v7) \
        class clss : public ParallelTask \
        { mODTextTranslationClass(clss); \
        public: \
            mDeclareParallelCalcStd(uimsg); \
            T1 v1##_; T2 v2##_; T3 v3##_; T4 v4##_; \
            T5 v5##_; T6 v6##_; T7 v7##_; \
            clss( od_int64 _sz_, T1 _##v1##_, T2 _##v2##_, T3 _##v3##_, \
                    T4 _##v4##_, T5 _##v5##_, T6 _##v6##_, T7 _##v7##_ ) \
                : sz_(_sz_), reportprogress_(true) \
                , v1##_(_##v1##_), v2##_(_##v2##_) \
                , v3##_(_##v3##_), v4##_(_##v4##_) \
                , v5##_(_##v5##_), v6##_(_##v6##_), v7##_(_##v7##_)    {} \

#define mDefParallelCalcBody(preop,impl,postop) \
            bool doWork( od_int64 start, od_int64 stop, int ) \
            { \
                preop; \
                for ( od_int64 idx=start; idx<=stop; idx++ ) \
                    { impl; if ( reportprogress_ ) quickAddToNrDone(idx); } \
                postop; \
                return true; \
            } \
        };