1 // Copyright (C) 2006-2015 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #include "Executor.hxx"
22 #include "AutoLocker.hxx"
23 #include "Scheduler.hxx"
24 #include "Dispatcher.hxx"
25 #include "Container.hxx"
26 #include "HomogeneousPoolContainer.hxx"
27 #include "ComponentInstance.hxx"
29 #include "VisitorSaveState.hxx"
30 #include "ServiceNode.hxx"
31 #include "ComposedNode.hxx"
45 #define usleep(A) _sleep(A/1000)
46 #if !defined(S_ISCHR) || !defined(S_ISREG)
49 # define S_IFMT _S_IFMT
50 # define S_IFCHR _S_IFCHR
51 # define S_IFREG _S_IFREG
54 # define S_IFMT __S_IFMT
55 # define S_IFCHR __S_IFCHR
56 # define S_IFREG __S_IFREG
60 # define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR)
61 # define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG)
65 using namespace YACS::ENGINE;
68 using YACS::BASES::Mutex;
69 using YACS::BASES::Thread;
70 using YACS::BASES::Semaphore;
73 #include "YacsTrace.hxx"
75 int Executor::_maxThreads(50);
76 size_t Executor::_threadStackSize(1048576); // Default thread stack size is 1MB
78 Executor::Executor():_nbOfConcurrentThreads(0), _semForMaxThreads(_maxThreads),_keepGoingOnFail(false),_DPLScopeSensitive(true)
83 _stopOnErrorRequested = false;
84 _dumpOnErrorRequested = false;
85 _errorDetected = false;
86 _isRunningunderExternalControl=false;
87 _executorState = YACS::NOTYETINITIALIZED;
88 _execMode = YACS::CONTINUE;
89 _semThreadCnt = _maxThreads;
90 DEBTRACE("Executor initialized with max threads = " << _maxThreads);
95 for(list<Thread *>::iterator iter=_groupOfAllThreadsCreated.begin();iter!=_groupOfAllThreadsCreated.end();iter++)
99 //! Execute a graph waiting for completion
101 * \param graph : schema to execute
102 * \param debug : display the graph with dot if debug == 1
103 * \param fromScratch : if true the graph is reinitialized
105 * Calls Scheduler::getNextTasks and Scheduler::selectRunnableTasks to select tasks to execute
107 * Calls Executor::launchTask to execute a selected Task.
109 * Completion when graph is finished (Scheduler::isFinished)
112 void Executor::RunA(Scheduler *graph,int debug, bool fromScratch)
114 DEBTRACE("Executor::RunW debug: " << debug << " fromScratch: " << fromScratch);
116 _root = dynamic_cast<ComposedNode *>(_mainSched);
117 if (!_root) throw Exception("Executor::Run, Internal Error!");
120 if(debug>1)_displayDot(graph);
124 graph->exUpdateState();
126 if(debug>1)_displayDot(graph);
127 vector<Task *> tasks;
128 vector<Task *>::iterator iter;
130 _execMode = YACS::CONTINUE;
131 _isWaitingEventsFromRunningTasks = false;
132 _numberOfRunningTasks = 0;
133 _runningTasks.clear();
134 _numberOfEndedTasks=0;
137 sleepWhileNoEventsFromAnyRunningTask();
139 if(debug>2)_displayDot(graph);
142 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
143 tasks=graph->getNextTasks(isMore);
144 graph->selectRunnableTasks(tasks);
145 }//End of critical section
147 if(debug>2)_displayDot(graph);
149 for(iter=tasks.begin();iter!=tasks.end();iter++)
150 loadTask(*iter,this);
152 if(debug>1)_displayDot(graph);
156 if(debug>1)_displayDot(graph);
159 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
160 _toContinue=!graph->isFinished();
161 }//End of critical section
162 DEBTRACE("_toContinue: " << _toContinue);
164 if(debug>0)_displayDot(graph);
170 //! Execute a graph with breakpoints or step by step
172 * To be launch in a thread (main thread controls the progression).
173 * \param graph : schema to execute
174 * \param debug : display the graph with dot if debug >0
175 * \param fromScratch : if false, state from a previous partial exection is already loaded
177 * Calls Scheduler::getNextTasks and Scheduler::selectRunnableTasks to select tasks to execute
179 * Calls Executor::checkBreakPoints to verify if a pause is requested
181 * Calls Executor::launchTask to execute a selected Task
183 * Completion when graph is finished (Scheduler::isFinished)
185 * States of execution:
186 * - YACS::NOTYETINITIALIZED
187 * - YACS::INITIALISED
188 * - YACS::RUNNING (to next breakpoint or step)
189 * - YACS::WAITINGTASKS (a breakpoint or step as been reached, but there are still running tasks)
190 * - YACS::PAUSED (a breakpoint or step as been reached, no more running tasks)
191 * - YACS::FINISHED (no more ready tasks, nore running tasks)
192 * - YACS::STOPPED (stopped by user before end)
194 * Modes of Execution:
195 * - YACS::CONTINUE (normal run without breakpoints)
196 * - YACS::STEPBYSTEP (pause at each loop)
197 * - YACS::STOPBEFORENODES (pause when a node is reached)
199 * A breakpoint is defined by a node name. The breakpoint is reached when the node becomes ready.
200 * Step by Step means execution node by node or group of node by group of nodes.
201 * At a given step, the user decides to launch all the ready nodes or only a subset
202 * (Caution: some nodes must run in parallel).
203 * The next event (end of task) may give a new set of ready nodes, and define a new step.
205 * The graph execution may be controled by a pilot which sends requests. Requests are asynchronous.
206 * Requests are taken into account only on certain states, otherwise return the status IgnoredRequest.
207 * - Executor::getCurrentExecMode
208 * - Executor::getExecutorState
209 * - Executor::setExecMode : change the execution mode for next loop
210 * - Executor::setListOfBreakPoints : must be set before setting YACS::STOPBEFORENODES
211 * - Executor::getTasksToLoad : when paused or waiting tasks, get the list of next tasks
212 * - Executor::setStepsToExecute : define a subset of the list given by Executor::getTasksToLoad
213 * - Executor::resumeCurrentBreakPoint : when paused or waiting tasks, resumes execution
214 * - Executor::isNotFinished
215 * - Executor::stopExecution : stop execution asap, i.e. set STEPBYSTEP and wait PAUSED
216 * - Executor::saveState : dump the current state of execution in an xml file
217 * - Executor::loadState : Not yet implemented
218 * - Executor::getNbOfThreads
219 * - Executor::displayDot
220 * - Executor::setStopOnError : ask to stop execution if a node is found in ERROR state
222 * If the pilot wants to wait the state YACS::PAUSED or YACS::WAITINGTASKS, synchronisation is obtained with:
223 * - Executor::waitPause
226 * - Pilot may connect to executor during execution, or deconnect.
227 * - Several Pilots may be connected at the same time (for observation...)
231 void Executor::RunB(Scheduler *graph,int debug, bool fromScratch)
233 DEBTRACE("Executor::RunB debug: "<< graph->getName() <<" "<< debug<<" fromScratch: "<<fromScratch);
235 { // --- Critical section
236 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
238 _root = dynamic_cast<ComposedNode *>(_mainSched);
239 if (!_root) throw Exception("Executor::Run, Internal Error!");
240 _executorState = YACS::NOTYETINITIALIZED;
241 sendEvent("executor");
244 _errorDetected = false;
245 _isWaitingEventsFromRunningTasks = false;
246 _numberOfRunningTasks = 0;
247 _runningTasks.clear();
248 _numberOfEndedTasks = 0;
249 string tracefile = "traceExec_";
250 tracefile += _mainSched->getName();
251 _trace.open(tracefile.c_str());
253 _start = timeGetTime();
255 gettimeofday(&_start, NULL);
258 } // --- End of critical section
260 if (debug > 1) _displayDot(graph);
267 graph->exUpdateState();
271 DEBTRACE("exception: "<< (ex.what()));
272 _executorState = YACS::FINISHED;
273 sendEvent("executor");
277 _executorState = YACS::INITIALISED;
278 sendEvent("executor");
280 if (debug > 1) _displayDot(graph);
282 vector<Task *>::iterator iter;
287 _executorState = YACS::RUNNING;
288 sendEvent("executor");
291 DEBTRACE("--- executor main loop");
292 sleepWhileNoEventsFromAnyRunningTask();
293 DEBTRACE("--- events...");
294 if (debug > 2) _displayDot(graph);
295 { // --- Critical section
296 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
297 _tasks=graph->getNextTasks(isMore);
298 graph->selectRunnableTasks(_tasks);
299 FilterTasksConsideringContainers(_tasks);
300 numberAllTasks=_numberOfRunningTasks+_tasks.size();
301 } // --- End of critical section
302 if (debug > 2) _displayDot(graph);
303 if (_executorState == YACS::RUNNING)
305 if (checkBreakPoints()) break; // end of thread requested, OK to exit at once;
306 if (debug > 0) _displayDot(graph);
309 loadParallelTasks(_tasks,this);
310 if (debug > 1) _displayDot(graph);
315 if (debug > 1) _displayDot(graph);
316 { // --- Critical section
318 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
319 //It is possible that the graph is finished but it remains running tasks (it's an error but we must take it into account)
320 if(_numberOfRunningTasks == 0)
321 _toContinue = !graph->isFinished();
323 DEBTRACE("_numberOfRunningTasks: " << _numberOfRunningTasks);
324 DEBTRACE("_numberOfEndedTasks: " << _numberOfEndedTasks);
325 DEBTRACE("_toContinue: " << _toContinue);
326 if(_toContinue && numberAllTasks==0)
328 //Problem : no running tasks and no task to launch ??
330 std::cerr << "Problem in Executor : no running tasks and no task to launch ?? problemCount=" << problemCount << std::endl;
331 //Pause to give a chance to interrupt
333 if(problemCount > 25)
335 // Too much problems encountered : stop execution
342 _executorState = YACS::FINISHED;
343 sendEvent("executor");
344 _condForPilot.notify_all();
346 } // --- End of critical section
347 if (debug > 0) _displayDot(graph);
348 DEBTRACE("_toContinue: " << _toContinue);
351 DEBTRACE("End of main Loop");
353 { // --- Critical section
354 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
355 if ( _toContinue) // --- break while(): request to stop detected on checkBreakPoints()
357 DEBTRACE("stop requested: End soon");
358 _executorState = YACS::STOPPED;
360 sendEvent("executor");
362 } // --- End of critical section
363 if ( _dumpOnErrorRequested && _errorDetected)
365 saveState(_dumpErrorFile);
368 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForTrace);
371 DEBTRACE("End of RunB thread");
374 YACS::ExecutionMode Executor::getCurrentExecMode()
376 _isRunningunderExternalControl=true;
381 YACS::ExecutorState Executor::getExecutorState()
383 _isRunningunderExternalControl=true;
384 return _executorState;
388 bool Executor::isNotFinished()
390 _isRunningunderExternalControl=true;
394 //! ask to stop execution on the first node found in error
396 * \param dumpRequested produce a state dump when an error is found
397 * \param xmlFile name of file used for state dump
400 void Executor::setStopOnError(bool dumpRequested, std::string xmlFile)
402 { // --- Critical section
403 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
404 _dumpErrorFile=xmlFile;
405 _stopOnErrorRequested=true;
406 _dumpOnErrorRequested = dumpRequested;
407 if (dumpRequested && xmlFile.empty())
408 throw YACS::Exception("dump on error requested and no filename given for dump");
409 DEBTRACE("_dumpErrorFile " << _dumpErrorFile << " " << _dumpOnErrorRequested);
410 } // --- End of critical section
413 //! ask to do not stop execution on nodes found in error
417 void Executor::unsetStopOnError()
419 { // --- Critical section
420 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
421 _stopOnErrorRequested=false;
422 } // --- End of critical section
425 //! Dynamically set the current mode of execution
427 * The mode can be Continue, step by step, or stop before execution of a node
428 * defined in a list of breakpoints.
431 void Executor::setExecMode(YACS::ExecutionMode mode)
433 DEBTRACE("Executor::setExecMode(YACS::ExecutionMode mode) " << mode);
434 { // --- Critical section
435 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
436 _isRunningunderExternalControl=true;
438 } // --- End of critical section
441 //! wake up executor when in pause
443 * When Executor is in state paused or waiting for task completion, the thread
444 * running loop RunB waits on condition _condForStepByStep.
445 * Thread RunB is waken up.
446 * \return true when actually wakes up executor
449 bool Executor::resumeCurrentBreakPoint()
451 DEBTRACE("Executor::resumeCurrentBreakPoint()");
453 //bool doDump = false;
454 { // --- Critical section
455 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
456 _isRunningunderExternalControl=true;
457 DEBTRACE("_executorState: " << _executorState);
458 switch (_executorState)
460 case YACS::WAITINGTASKS:
463 _condForStepByStep.notify_all();
464 _executorState = YACS::RUNNING;
465 sendEvent("executor");
467 //if (_dumpOnErrorRequested && _errorDetected) doDump =true;
473 //if (_dumpOnErrorRequested && _errorDetected) doDump =true;
474 DEBTRACE("Graph Execution finished or stopped !");
479 // debug: no easy way to verify if main loop is acutally waiting on condition
483 //if (doDump) saveState(_dumpErrorFile);
484 } // --- End of critical section
489 //! define a list of nodes names as breakpoints in the graph
492 void Executor::setListOfBreakPoints(std::list<std::string> listOfBreakPoints)
494 DEBTRACE("Executor::setListOfBreakPoints(std::list<std::string> listOfBreakPoints)");
495 { // --- Critical section
496 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
497 _isRunningunderExternalControl=true;
498 _listOfBreakPoints = listOfBreakPoints;
499 } // --- End of critical section
503 //! Get the list of tasks to load, to define a subset to execute in step by step mode
505 * If the executor is not in mode YACS::WAITINGTASKS nor YACS::PAUSED, the list is empty.
506 * Use Executor::waitPause to wait.
508 std::list<std::string> Executor::getTasksToLoad()
510 DEBTRACE("Executor::getTasksToLoad()");
511 list<string> listOfNodesToLoad;
512 listOfNodesToLoad.clear();
513 { // --- Critical section
514 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
515 _isRunningunderExternalControl=true;
516 switch (_executorState)
518 case YACS::WAITINGTASKS:
521 listOfNodesToLoad = _listOfTasksToLoad;
524 case YACS::NOTYETINITIALIZED:
525 case YACS::INITIALISED:
534 } // --- End of critical section
535 return listOfNodesToLoad;
539 //! Define a subset of task to execute in step by step mode
541 * Behaviour is unpredictable if the list is not a subset of the list given by Executor::getTasksToLoad
542 * in the current step.
543 * If some nodes must run in parallel, they must stay together in the list.
546 bool Executor::setStepsToExecute(std::list<std::string> listToExecute)
548 DEBTRACE("Executor::setStepsToExecute(std::list<std::string> listToExecute)");
550 vector<Task *>::iterator iter;
551 vector<Task *> restrictedTasks;
552 { // --- Critical section
553 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
554 _isRunningunderExternalControl=true;
555 switch (_executorState)
557 case YACS::WAITINGTASKS:
560 for (iter=_tasksSave.begin(); iter!=_tasksSave.end(); iter++)
562 string readyNode = _mainSched->getTaskName(*iter);
563 if (find(listToExecute.begin(), listToExecute.end(), readyNode)
564 != listToExecute.end())
566 restrictedTasks.push_back(*iter);
567 DEBTRACE("node to execute " << readyNode);
571 for (iter=restrictedTasks.begin(); iter!=restrictedTasks.end(); iter++)
573 _tasks.push_back(*iter);
577 case YACS::NOTYETINITIALIZED:
578 case YACS::INITIALISED:
587 } // --- End of critical section
590 for (iter=restrictedTasks.begin(); iter!=restrictedTasks.end(); iter++)
592 _tasks.push_back(*iter);
594 for (iter=_tasks.begin(); iter!=_tasks.end(); iter++)
596 string readyNode = _mainSched->getTaskName(*iter);
597 DEBTRACE("selected node to execute " << readyNode);
603 //! suspend pilot execution until Executor is in pause or waiting tasks completion mode.
605 * Do nothing if execution is finished or in pause.
606 * Wait first step if Executor is running or in initialization.
609 void Executor::waitPause()
611 DEBTRACE("Executor::waitPause()" << _executorState);
612 { // --- Critical section
613 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
614 _isRunningunderExternalControl=true;
615 switch (_executorState)
620 case YACS::WAITINGTASKS:
625 case YACS::NOTYETINITIALIZED:
626 case YACS::INITIALISED:
629 _condForPilot.wait(_mutexForSchedulerUpdate); // wait until executor is PAUSED or WAITINGTASKS
633 } // --- End of critical section
637 //! stops the execution as soon as possible
639 void Executor::stopExecution()
641 setExecMode(YACS::STEPBYSTEP);
644 resumeCurrentBreakPoint();
647 //! save the current state of execution in an xml file
649 bool Executor::saveState(const std::string& xmlFile)
651 DEBTRACE("Executor::saveState() in " << xmlFile);
654 YACS::ENGINE::VisitorSaveState vst(_root);
655 vst.openFileDump(xmlFile.c_str());
660 catch(Exception& ex) {
661 std::cerr << ex.what() << std::endl;
666 //! not yet implemented
668 bool Executor::loadState()
670 DEBTRACE("Executor::loadState()");
671 _isRunningunderExternalControl=true;
676 static int isfile(const char *filename)
679 if (stat(filename, &buf) != 0)
681 if (!S_ISREG(buf.st_mode))
686 //! Display the graph state as a dot display, public method
688 void Executor::displayDot(Scheduler *graph)
690 _isRunningunderExternalControl=true;
694 //! Display the graph state as a dot display
696 * \param graph : the node to display
699 void Executor::_displayDot(Scheduler *graph)
701 std::ofstream g("titi");
702 ((ComposedNode*)graph)->writeDot(g);
704 const char displayScript[]="display.sh";
705 if(isfile(displayScript))
706 system("sh display.sh");
708 system("dot -Tpng titi|display -delay 5");
711 //! Wait reactivation in modes Step By step or with BreakPoints
713 * Check mode of execution (set by main thread):
714 * - YACS::CONTINUE : the graph execution continues.
715 * - YACS::STEPBYSTEP : wait on condition (pilot thread, Executor::resumeCurrentBreakPoint)
716 * - YACS::STOPBEFORENODES : if there are ready nodes in a list of breakpoints,
717 * wait on condition (pilot thread, Executor::resumeCurrentBreakPoint)
718 * else continue the graph execution.
719 * \return true if end of executor thread is requested
722 bool Executor::checkBreakPoints()
724 DEBTRACE("Executor::checkBreakPoints()");
725 vector<Task *>::iterator iter;
726 bool endRequested = false;
734 case YACS::STOPBEFORENODES:
737 { // --- Critical section
738 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
740 for (iter=_tasks.begin(); iter!=_tasks.end(); iter++)
742 string nodeToLoad = _mainSched->getTaskName(*iter);
743 if (find(_listOfBreakPoints.begin(), _listOfBreakPoints.end(), nodeToLoad)
744 != _listOfBreakPoints.end())
752 _listOfTasksToLoad.clear();
753 for (iter=_tasks.begin(); iter!=_tasks.end(); iter++)
755 string nodeToLoad = _mainSched->getTaskName(*iter);
756 _listOfTasksToLoad.push_back(nodeToLoad);
758 if (getNbOfThreads())
759 _executorState = YACS::WAITINGTASKS; // will be paused after completion of running tasks
761 _executorState = YACS::PAUSED;
762 sendEvent("executor");
763 _condForPilot.notify_all();
765 if (stop && !_isOKToEnd) waitResume(); // wait until pilot calls resumeCurrentBreakPoint(), mutex released during wait
766 if (_isOKToEnd) endRequested = true;
767 } // --- End of critical section
768 if (stop) DEBTRACE("wake up from waitResume");
772 case YACS::STEPBYSTEP:
774 { // --- Critical section
775 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
777 _listOfTasksToLoad.clear();
778 for (iter=_tasks.begin(); iter!=_tasks.end(); iter++)
780 string nodeToLoad = _mainSched->getTaskName(*iter);
781 _listOfTasksToLoad.push_back(nodeToLoad);
783 if (getNbOfThreads())
784 _executorState = YACS::WAITINGTASKS; // will be paused after completion of running tasks
786 _executorState = YACS::PAUSED;
787 sendEvent("executor");
788 _condForPilot.notify_all();
790 waitResume(); // wait until pilot calls resumeCurrentBreakPoint(), mutex released during wait
791 // or, if no pilot, wait until no more running tasks (stop on error)
792 if (_isOKToEnd) endRequested = true;
793 } // --- End of critical section
794 DEBTRACE("wake up from waitResume");
798 DEBTRACE("endRequested: " << endRequested);
803 //! in modes Step By step or with BreakPoint, wait until pilot resumes the execution
805 * With the condition Mutex, the mutex is released atomically during the wait.
806 * Pilot calls Executor::resumeCurrentBreakPoint to resume execution.
807 * Must be called while mutex is locked.
810 void Executor::waitResume()
812 DEBTRACE("Executor::waitResume()");
813 _condForStepByStep.wait(_mutexForSchedulerUpdate); // wait until pilot calls resumeCurrentBreakPoint()
818 //! Perform loading of a Task.
820 * \param task : Task to load
823 void Executor::loadTask(Task *task, const Executor *execInst)
825 DEBTRACE("Executor::loadTask(Task *task)");
826 if(task->getState() != YACS::TOLOAD)
828 traceExec(task, "state:TOLOAD", ComputePlacement(task));
830 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
831 _mainSched->notifyFrom(task,YACS::START,execInst);
832 }//End of critical section
835 traceExec(task, "load", ComputePlacement(task));
837 traceExec(task, "initService", ComputePlacement(task));
842 std::cerr << ex.what() << std::endl;
844 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
846 _mainSched->notifyFrom(task,YACS::ABORT,execInst);
847 traceExec(task, "state:"+Node::getStateName(task->getState()), ComputePlacement(task));
848 }//End of critical section
852 std::cerr << "Load failed" << std::endl;
854 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
856 _mainSched->notifyFrom(task,YACS::ABORT,execInst);
857 traceExec(task, "state:"+Node::getStateName(task->getState()), ComputePlacement(task));
858 }//End of critical section
869 void Executor::loadTasks(const std::vector<Task *>& tasks, const Executor *execInst)
871 for(std::vector<Task *>::const_iterator iter = _tasks.begin(); iter != _tasks.end(); iter++)
872 loadTask(*iter,execInst);
875 void Executor::loadParallelTasks(const std::vector<Task *>& tasks, const Executor *execInst)
877 std::vector<Thread> ths(tasks.size());
878 std::size_t ithread(0);
879 for(std::vector<Task *>::const_iterator iter = _tasks.begin(); iter != _tasks.end(); iter++, ithread++)
881 DEBTRACE("Executor::loadParallelTasks(Task *task)");
882 struct threadargs *args(new threadargs);
883 args->task = (*iter);
884 args->sched = _mainSched;
885 args->execInst = this;
886 ths[ithread].go(functionForTaskLoad, args, _threadStackSize);
888 for(ithread=0;ithread<tasks.size();ithread++)
892 //! Execute a list of tasks possibly connected through datastream links
894 * \param tasks : a list of tasks to execute
897 void Executor::launchTasks(const std::vector<Task *>& tasks)
899 //First phase, make datastream connections
900 for(vector<Task *>::const_iterator iter=tasks.begin();iter!=tasks.end();iter++)
902 YACS::StatesForNode state=(*iter)->getState();
903 if(state != YACS::TOLOAD && state != YACS::TORECONNECT)continue;
906 (*iter)->connectService();
907 traceExec(*iter, "connectService",ComputePlacement(*iter));
909 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
910 (*iter)->connected();
911 }//End of critical section
915 std::cerr << ex.what() << std::endl;
918 (*iter)->disconnectService();
919 traceExec(*iter, "disconnectService",ComputePlacement(*iter));
923 // Disconnect has failed
924 traceExec(*iter, "disconnectService failed, ABORT",ComputePlacement(*iter));
927 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
929 _mainSched->notifyFrom(*iter,YACS::ABORT,this);
930 }//End of critical section
934 std::cerr << "Problem in connectService" << std::endl;
937 (*iter)->disconnectService();
938 traceExec(*iter, "disconnectService",ComputePlacement(*iter));
942 // Disconnect has failed
943 traceExec(*iter, "disconnectService failed, ABORT",ComputePlacement(*iter));
946 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
948 _mainSched->notifyFrom(*iter,YACS::ABORT,this);
949 }//End of critical section
951 if((*iter)->getState() == YACS::ERROR)
953 //try to put all coupled tasks in error
954 std::set<Task*> coupledSet;
955 (*iter)->getCoupledTasks(coupledSet);
956 for (std::set<Task*>::iterator it = coupledSet.begin(); it != coupledSet.end(); ++it)
959 if(t == *iter)continue;
960 if(t->getState() == YACS::ERROR)continue;
963 t->disconnectService();
964 traceExec(t, "disconnectService",ComputePlacement(*iter));
968 // Disconnect has failed
969 traceExec(t, "disconnectService failed, ABORT",ComputePlacement(*iter));
972 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
974 _mainSched->notifyFrom(t,YACS::ABORT,this);
975 }//End of critical section
976 traceExec(t, "state:"+Node::getStateName(t->getState()),ComputePlacement(*iter));
979 traceExec(*iter, "state:"+Node::getStateName((*iter)->getState()),ComputePlacement(*iter));
982 //Second phase, execute each task in a thread
983 for(vector<Task *>::const_iterator iter=tasks.begin();iter!=tasks.end();iter++)
989 //! Execute a Task in a thread
991 * \param task : Task to execute
993 * Calls Scheduler::notifyFrom of main node (_mainSched) to notify start
995 * Calls Executor::functionForTaskExecution in Thread
998 void Executor::launchTask(Task *task)
1000 DEBTRACE("Executor::launchTask(Task *task)");
1001 struct threadargs *args;
1002 if(task->getState() != YACS::TOACTIVATE)return;
1004 DEBTRACE("before _semForMaxThreads.wait " << _semThreadCnt);
1005 if(_semThreadCnt == 0)
1007 // --- Critical section
1008 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
1009 //check if we have enough threads to run
1010 std::set<Task*> tmpSet=_runningTasks;
1011 std::set<Task*>::iterator it = tmpSet.begin();
1012 std::string status="running";
1013 std::set<Task*> coupledSet;
1014 while( it != tmpSet.end() )
1018 tt->getCoupledTasks(coupledSet);
1020 for (std::set<Task*>::iterator iter = coupledSet.begin(); iter != coupledSet.end(); ++iter)
1022 if((*iter)->getState() == YACS::TOACTIVATE)status="toactivate";
1023 tmpSet.erase(*iter);
1025 if(status=="running")break;
1026 it = tmpSet.begin();
1029 if(status=="toactivate")
1031 std::cerr << "WARNING: maybe you need more threads to run your schema (current value="<< _maxThreads << ")" << std::endl;
1032 std::cerr << "If it is the case, set the YACS_MAX_THREADS environment variable to a bigger value (export YACS_MAX_THREADS=xxx)" << std::endl;
1034 // --- End of critical section
1037 _semForMaxThreads.wait();
1040 args= new threadargs;
1042 args->sched = _mainSched;
1043 args->execInst = this;
1045 traceExec(task, "launch",ComputePlacement(task));
1047 { // --- Critical section
1048 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
1049 _numberOfRunningTasks++;
1050 _runningTasks.insert(task);
1051 task->begin(); //change state to ACTIVATED
1052 } // --- End of critical section
1053 Thread(functionForTaskExecution, args, _threadStackSize);
1056 //! wait until a running task ends
1058 void Executor::sleepWhileNoEventsFromAnyRunningTask()
1060 DEBTRACE("Executor::sleepWhileNoEventsFromAnyRunningTask()");
1061 // _semForNewTasksToPerform.wait(); //----utiliser pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
1062 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForSchedulerUpdate);
1063 if (_numberOfRunningTasks > 0 && _numberOfEndedTasks==0)
1065 _isWaitingEventsFromRunningTasks = true;
1066 _condForNewTasksToPerform.wait(_mutexForSchedulerUpdate); // mutex released during wait
1068 _numberOfEndedTasks=0;
1074 void Executor::notifyEndOfThread(YACS::BASES::Thread *thread)
1076 /*_mutexForNbOfConcurrentThreads.lock();
1077 _groupOfAllThreadsCreated.remove(thread);
1079 _mutexForNbOfConcurrentThreads.unlock();*/
1083 //! must be used protected by _mutexForSchedulerUpdate!
1085 void Executor::wakeUp()
1087 DEBTRACE("Executor::wakeUp() " << _isWaitingEventsFromRunningTasks);
1088 if (_isWaitingEventsFromRunningTasks)
1090 _isWaitingEventsFromRunningTasks = false;
1091 _condForNewTasksToPerform.notify_all();
1094 _numberOfEndedTasks++;
1097 //! number of running tasks
1099 int Executor::getNbOfThreads()
1102 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForNbOfConcurrentThreads);
1103 _isRunningunderExternalControl=true;
1104 ret = _groupOfAllThreadsCreated.size();
1109 * This thread is NOT supposed to be detached !
1111 void *Executor::functionForTaskLoad(void *arg)
1113 DEBTRACE("Executor::functionForTaskLoad(void *arg)");
1114 struct threadargs *args = (struct threadargs *) arg;
1115 Task *task=args->task;
1116 Scheduler *sched=args->sched;
1117 Executor *execInst=args->execInst;
1119 execInst->loadTask(task,execInst);// no throw of this method - all throw are catched !
1123 //! Function to perform execution of a task in a thread
1125 * \param arg : 3 elements (a Task, a Scheduler, an Executor)
1127 * Calls Task::execute
1129 * Calls Task::finished when the task is finished
1131 * Calls (notify with event YACS::FINISH) Scheduler::notifyFrom when the task is finished
1133 * Calls Executor::wakeUp and Executor::notifyEndOfThread
1136 void *Executor::functionForTaskExecution(void *arg)
1138 DEBTRACE("Executor::functionForTaskExecution(void *arg)");
1140 struct threadargs *args = (struct threadargs *) arg;
1141 Task *task=args->task;
1142 Scheduler *sched=args->sched;
1143 Executor *execInst=args->execInst;
1145 execInst->traceExec(task, "state:"+Node::getStateName(task->getState()),ComputePlacement(task));
1151 if(execInst->getDPLScopeSensitive())
1153 Node *node(dynamic_cast<Node *>(task));
1154 ComposedNode *gfn(dynamic_cast<ComposedNode *>(sched));
1155 if(node!=0 && gfn!=0)
1156 node->applyDPLScope(gfn);
1159 YACS::Event ev=YACS::FINISH;
1162 execInst->traceExec(task, "start execution",ComputePlacement(task));
1164 execInst->traceExec(task, "end execution OK",ComputePlacement(task));
1166 catch(Exception& ex)
1168 std::cerr << "YACS Exception during execute" << std::endl;
1169 std::cerr << ex.what() << std::endl;
1171 string message = "end execution ABORT, ";
1172 message += ex.what();
1173 execInst->traceExec(task, message,ComputePlacement(task));
1177 // Execution has failed
1178 std::cerr << "Execution has failed: unknown reason" << std::endl;
1180 execInst->traceExec(task, "end execution ABORT, unknown reason",ComputePlacement(task));
1186 DEBTRACE("task->disconnectService()");
1187 task->disconnectService();
1188 execInst->traceExec(task, "disconnectService",ComputePlacement(task));
1192 // Disconnect has failed
1193 std::cerr << "disconnect has failed" << std::endl;
1195 execInst->traceExec(task, "disconnectService failed, ABORT",ComputePlacement(task));
1199 std::string placement(ComputePlacement(task));
1201 // container management for HomogeneousPoolOfContainer
1203 HomogeneousPoolContainer *contC(dynamic_cast<HomogeneousPoolContainer *>(task->getContainer()));
1206 YACS::BASES::AutoLocker<Container> alckCont(contC);
1207 contC->release(task);
1210 DEBTRACE("End task->execute()");
1211 { // --- Critical section
1212 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&execInst->_mutexForSchedulerUpdate);
1215 if (ev == YACS::FINISH) task->finished();
1216 if (ev == YACS::ABORT)
1218 execInst->_errorDetected = true;
1219 if (execInst->_stopOnErrorRequested)
1221 execInst->_execMode = YACS::STEPBYSTEP;
1222 execInst->_isOKToEnd = true;
1226 execInst->traceExec(task, "state:"+Node::getStateName(task->getState()),placement);
1227 sched->notifyFrom(task,ev,execInst);
1229 catch(Exception& ex)
1231 //notify has failed : it is supposed to have set state
1232 //so no need to do anything
1233 std::cerr << "Error during notification" << std::endl;
1234 std::cerr << ex.what() << std::endl;
1238 //notify has failed : it is supposed to have set state
1239 //so no need to do anything
1240 std::cerr << "Notification failed" << std::endl;
1242 execInst->_numberOfRunningTasks--;
1243 execInst->_runningTasks.erase(task);
1244 DEBTRACE("_numberOfRunningTasks: " << execInst->_numberOfRunningTasks
1245 << " _execMode: " << execInst->_execMode
1246 << " _executorState: " << execInst->_executorState);
1247 if ((execInst->_numberOfRunningTasks == 0) && (execInst->_execMode != YACS::CONTINUE)) // no more running tasks
1249 if (execInst->_executorState == YACS::WAITINGTASKS)
1251 execInst->_executorState = YACS::PAUSED;
1252 execInst->sendEvent("executor");
1253 execInst->_condForPilot.notify_all();
1254 if (execInst->_errorDetected &&
1255 execInst->_stopOnErrorRequested &&
1256 !execInst->_isRunningunderExternalControl)
1257 execInst->_condForStepByStep.notify_all(); // exec thread may be on waitResume
1260 DEBTRACE("before _semForMaxThreads.post " << execInst->_semThreadCnt);
1261 execInst->_semForMaxThreads.post();
1262 execInst->_semThreadCnt += 1;
1263 DEBTRACE("after _semForMaxThreads.post " << execInst->_semThreadCnt);
1264 if (execInst->_executorState != YACS::PAUSED) execInst->wakeUp();
1266 } // --- End of critical section (change state)
1268 //execInst->notifyEndOfThread(0);
1273 void Executor::traceExec(Task *task, const std::string& message, const std::string& placement)
1275 string nodeName = _mainSched->getTaskName(task);
1276 Container *cont = task->getContainer();
1277 string containerName = "---";
1279 containerName = cont->getName();
1282 DWORD now = timeGetTime();
1283 double elapse = (now - _start)/1000.0;
1286 gettimeofday(&now, NULL);
1287 double elapse = (now.tv_sec - _start.tv_sec) + double(now.tv_usec - _start.tv_usec)/1000000.0;
1290 YACS::BASES::AutoLocker<YACS::BASES::Mutex> alck(&_mutexForTrace);
1291 _trace << elapse << " " << containerName << " " << placement << " " << nodeName << " " << message << endl;
1296 //! emit notification to all observers registered with the dispatcher
1298 * The dispatcher is unique and can be obtained by getDispatcher()
1300 void Executor::sendEvent(const std::string& event)
1302 Dispatcher* disp=Dispatcher::getDispatcher();
1305 disp->dispatch(_root,event);
1309 * This method takes in input a list of tasks and selects from that lists a part of it considering only the containers.
1310 * If tasks have no container instance subclass of HomogeneousPoolContainer this method will let the \a tsks untouched.
1312 * \param [in,out] tsks - list of tasks to be
1314 void Executor::FilterTasksConsideringContainers(std::vector<Task *>& tsks)
1316 std::map<HomogeneousPoolContainer *, std::vector<Task *> > m;
1317 for(std::vector<Task *>::const_iterator it=tsks.begin();it!=tsks.end();it++)
1322 Container *cont(cur->getContainer());
1325 m[(HomogeneousPoolContainer *)NULL].push_back(cur);
1328 HomogeneousPoolContainer *contC(dynamic_cast<HomogeneousPoolContainer *>(cont));
1331 m[(HomogeneousPoolContainer *)NULL].push_back(cur);
1334 m[contC].push_back(cur);
1337 std::vector<Task *> ret;
1338 for(std::map<HomogeneousPoolContainer *, std::vector<Task *> >::const_iterator it=m.begin();it!=m.end();it++)
1340 HomogeneousPoolContainer *curhpc((*it).first);
1341 const std::vector<Task *>& curtsks((*it).second);
1344 ret.insert(ret.end(),curtsks.begin(),curtsks.end());
1348 // start of critical section for container curhpc
1349 YACS::BASES::AutoLocker<Container> alckForCont(curhpc);
1350 std::vector<const Task *> vecOfTaskSharingSameHPContToBeRunSimutaneously;
1351 std::size_t sz(curhpc->getNumberOfFreePlace());
1352 std::vector<Task *>::const_iterator it2(curtsks.begin());
1353 for(std::size_t i=0;i<sz && it2!=curtsks.end();i++,it2++)
1355 vecOfTaskSharingSameHPContToBeRunSimutaneously.push_back(*it2);
1356 ret.push_back(*it2);
1358 curhpc->allocateFor(vecOfTaskSharingSameHPContToBeRunSimutaneously);
1359 //end of critical section
1366 std::string Executor::ComputePlacement(Task *zeTask)
1368 std::string placement("---");
1371 if(zeTask->getContainer())
1372 placement=zeTask->getContainer()->getFullPlacementId(zeTask);