src/engine/Executor.hxx

   1 // Copyright (C) 2006-2014  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef __EXECUTOR_HXX__
  21 #define __EXECUTOR_HXX__
  22
  23 #include "YACSlibEngineExport.hxx"
  24 #include "Mutex.hxx"
  25 #include "Thread.hxx"
  26 #include "Semaphore.hxx"
  27 #include "Exception.hxx"
  28 #include "define.hxx"
  29
  30 #ifdef WIN32
  31 #include <windows.h>
  32 #pragma comment(lib,"winmm.lib")
  33 #endif
  34 #include <list>
  35 #include <vector>
  36 #include <set>
  37 #include <string>
  38 #include <fstream>
  39 #include <ctime>
  40
  41 namespace YACS
  42 {
  43   namespace ENGINE
  44   {
  45     class Scheduler;
  46     class ComposedNode;
  47     class Task;
  48
  49 /*! \brief Threaded Executor
  50  *
  51  * \ingroup Executors
  52  *
  53  *
  54  */
  55     class YACSLIBENGINE_EXPORT Executor
  56     {
  57     protected:
  58       Scheduler *_mainSched;
  59       ComposedNode *_root;
  60       int _nbOfConcurrentThreads;
  61       YACS::BASES::Mutex _mutexForNbOfConcurrentThreads;
  62       YACS::BASES::Condition _condForNewTasksToPerform;
  63       YACS::BASES::Semaphore _semForMaxThreads;
  64       YACS::BASES::Condition _condForStepByStep;
  65       YACS::BASES::Condition _condForPilot;
  66       YACS::BASES::Mutex _mutexForSchedulerUpdate;
  67       YACS::BASES::Mutex _mutexForTrace;
  68       bool _toContinue;
  69       bool _isOKToEnd;
  70       bool _stopOnErrorRequested;
  71       bool _dumpOnErrorRequested;
  72       bool _errorDetected;
  73       bool _isRunningunderExternalControl;
  74       bool _isWaitingEventsFromRunningTasks;
  75       int _numberOfRunningTasks;
  76       std::set<Task *> _runningTasks;
  77       int _numberOfEndedTasks;
  78       int _semThreadCnt;
  79       YACS::ExecutorState _executorState;
  80       YACS::ExecutionMode _execMode;
  81       std::list<std::string> _listOfBreakPoints;
  82       std::list<std::string> _listOfTasksToLoad;
  83       std::vector<Task *> _tasks;
  84       std::vector<Task *> _tasksSave;
  85       std::list< YACS::BASES::Thread * > _groupOfAllThreadsCreated;
  86       std::ofstream _trace;
  87       std::string _dumpErrorFile;
  88 #ifdef WIN32
  89           DWORD _start;
  90 #else
  91       timeval _start;
  92 #endif
  93     public:
  94       Executor();
  95       ~Executor();
  96       void RunA(Scheduler *graph,int debug=0, bool fromScratch=true);
  97       void RunW(Scheduler *graph,int debug=0, bool fromScratch=true) { RunB(graph, debug, fromScratch); }
  98       void RunB(Scheduler *graph,int debug=0, bool fromScratch=true);
  99       YACS::ExecutionMode getCurrentExecMode();
 100       YACS::ExecutorState getExecutorState();
 101       void setExecMode(YACS::ExecutionMode mode);
 102       void setListOfBreakPoints(std::list<std::string> listOfBreakPoints);
 103       std::list<std::string> getTasksToLoad();
 104       bool setStepsToExecute(std::list<std::string> listToExecute);
 105       bool resumeCurrentBreakPoint();
 106       bool isNotFinished();
 107       void stopExecution();
 108       bool saveState(const std::string& xmlFile);
 109       bool loadState();
 110       int getNbOfThreads();
 111       void displayDot(Scheduler *graph);
 112       void setStopOnError(bool dumpRequested=false, std::string xmlFile="");
 113       void unsetStopOnError();
 114       void waitPause();
 115       static int _maxThreads;
 116       static size_t _threadStackSize;
 117     protected:
 118       bool checkBreakPoints();
 119       void waitResume();
 120       void loadTask(Task *task);
 121       void launchTasks(std::vector<Task*>& tasks);
 122       void launchTask(Task *task);
 123       void wakeUp();
 124       void sleepWhileNoEventsFromAnyRunningTask();
 125       void notifyEndOfThread(YACS::BASES::Thread *thread);
 126       void traceExec(Task *task, const std::string& message, const std::string& placement);
 127       void _displayDot(Scheduler *graph);
 128       virtual void sendEvent(const std::string& event);
 129       static void FilterTasksConsideringContainers(std::vector<Task *>& tsks);
 130       static std::string ComputePlacement(Task *zeTask);
 131     protected:
 132       static void *functionForTaskExecution(void *);
 133     };
 134   }
 135 }
 136
 137 #endif