1 // Copyright (C) 2006-2013 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.
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
21 #include "InputPort.hxx"
22 #include "OutputPort.hxx"
23 #include "InputDataStreamPort.hxx"
24 #include "OutputDataStreamPort.hxx"
25 #include "LinkInfo.hxx"
26 #include "Runtime.hxx"
27 #include "Visitor.hxx"
32 #include "YacsTrace.hxx"
34 using namespace YACS::ENGINE;
37 InputPort4DF2DS::InputPort4DF2DS(DFToDSForLoop *node, TypeCode* type):
38 InputPort("", node, type),
39 DataPort("", node, type),
44 void InputPort4DF2DS::getAllRepresentants(std::set<InPort *>& repr) const
46 set<InPort *> s=_node->getOutputDataStreamPort("")->edSetInPort();
47 repr.insert(s.begin(),s.end());
50 void *InputPort4DF2DS::get() const throw(YACS::Exception)
54 std::string what="InputPort4DF2DS::get : no value currently in input whith name \""; what+=_name; what+="\"";
55 throw Exception(what);
60 void InputPort4DF2DS::exRestoreInit()
70 void InputPort4DF2DS::exSaveInit()
73 _initValue->decrRef();
75 _initValue->incrRef();
78 void InputPort4DF2DS::put(const void *data) throw(ConversionException)
83 InputPort *InputPort4DF2DS::clone(Node *newHelder) const
85 throw Exception("InputPort4DF2DS::clone : internal error");
88 void InputPort4DF2DS::put(Any *data)
96 InputPort4DF2DS::~InputPort4DF2DS()
102 DFToDSForLoop::DFToDSForLoop(Loop *loop, const std::string& name, TypeCode* type):ElementaryNode(""),_nbOfTimeUsed(1)
104 _name="DF2DS For "; _name+=loop->getName(); _name+=" representing port "; _name+=name;
106 _setOfInputPort.push_back(new InputPort4DF2DS(this,type));
107 _setOfOutputDataStreamPort.push_back(new OutputDataStreamPort("",this,Loop::MappingDF2DS(type)));
110 DFToDSForLoop::~DFToDSForLoop()
112 edDisconnectAllLinksWithMe();
115 void DFToDSForLoop::getReadyTasks(std::vector<Task *>& tasks)
119 InputPort *DFToDSForLoop::getInputPort(const std::string& name) const throw(YACS::Exception)
122 return Node::getInputPort(name);
124 catch(Exception& e) {}
126 list<InputPort *>::const_iterator it =_setOfInputPort.begin();
130 OutputDataStreamPort *DFToDSForLoop::getOutputDataStreamPort(const std::string& name) const throw(YACS::Exception)
132 list<OutputDataStreamPort *>::const_iterator it =_setOfOutputDataStreamPort.begin();
136 void DFToDSForLoop::load()
140 void DFToDSForLoop::execute()
145 Node *DFToDSForLoop::simpleClone(ComposedNode *father, bool editionOnly) const
147 throw Exception("DFToDSForLoop::simpleClone : Internal error");
150 OutputPort4DS2DF::OutputPort4DS2DF(DSToDFForLoop *node, TypeCode *type):
151 OutputPort("", node, type),
152 DataPort("", node, type),
157 void OutputPort4DS2DF::getAllRepresented(std::set<OutPort *>& represented) const
159 set<OutPort *> setO=_node->getInputDataStreamPort("")->edSetOutPort();
160 for(set<OutPort *>::iterator iter=setO.begin();iter!=setO.end();iter++)
161 (*iter)->getAllRepresented(represented);
164 void OutputPort4DS2DF::put(const void *data) throw(ConversionException)
167 OutputPort::put(data);
170 OutputPort *OutputPort4DS2DF::clone(Node *newHelder) const
172 throw Exception("OutputPort4DS2DF::clone : Internal error");
175 void OutputPort4DS2DF::put(Any *data)
183 OutputPort4DS2DF::~OutputPort4DS2DF()
189 InputDataStreamPort4DS2DF::InputDataStreamPort4DS2DF(DSToDFForLoop *node, TypeCode* type):
190 InputDataStreamPort("", node, type),
191 DataPort("", node, type),
196 void InputDataStreamPort4DS2DF::getAllRepresentants(std::set<InPort *>& repr) const
198 set<InPort *> s=_node->getOutputPort("")->edSetInPort();
199 repr.insert(s.begin(),s.end());
202 DSToDFForLoop::DSToDFForLoop(Loop *loop, const std::string& name, TypeCode* type):ElementaryNode(""),_nbOfTimeUsed(1)
204 _name="DS2DF For "; _name+=loop->getName(); _name+=" representing port "; _name+=name;
206 _setOfOutputPort.push_back(new OutputPort4DS2DF(this,type));
207 _setOfInputDataStreamPort.push_back(new InputDataStreamPort4DS2DF(this,type));
210 Node *DSToDFForLoop::simpleClone(ComposedNode *father, bool editionOnly) const
212 throw Exception("DSToDFForLoop::simpleClone : Internal error");
215 DSToDFForLoop::~DSToDFForLoop()
217 edDisconnectAllLinksWithMe();
220 void DSToDFForLoop::getReadyTasks(std::vector<Task *>& tasks)
224 OutputPort *DSToDFForLoop::getOutputPort(const std::string& name) const throw(YACS::Exception)
226 list<OutputPort *>::const_iterator it = _setOfOutputPort.begin();
230 InputDataStreamPort *DSToDFForLoop::getInputDataStreamPort(const std::string& name) const throw(YACS::Exception)
232 list<InputDataStreamPort *>::const_iterator it = _setOfInputDataStreamPort.begin();
236 void DSToDFForLoop::load()
240 void DSToDFForLoop::execute()
245 FakeNodeForLoop::FakeNodeForLoop(Loop *loop, bool normalFinish, bool internalError):ElementaryNode("thisIsAFakeNode"),
247 _normalFinish(normalFinish),
248 _internalError(internalError)
250 setState(YACS::TOACTIVATE);
251 _father=_loop->getFather();
254 FakeNodeForLoop::FakeNodeForLoop(const FakeNodeForLoop& other):ElementaryNode(other),_loop(0),
255 _normalFinish(false),_internalError(true)
259 Node *FakeNodeForLoop::simpleClone(ComposedNode *father, bool editionOnly) const
261 return new FakeNodeForLoop(*this);
264 void FakeNodeForLoop::exForwardFailed()
266 _loop->exForwardFailed();
269 void FakeNodeForLoop::exForwardFinished()
271 _loop->exForwardFinished();
274 void FakeNodeForLoop::execute()
277 throw Exception("");//only to trigger ABORT on Executor
280 void FakeNodeForLoop::aborted()
283 _loop->setState(YACS::INTERNALERR);
285 _loop->setState(YACS::ERROR);
288 void FakeNodeForLoop::finished()
290 _loop->setState(YACS::DONE);
293 Loop::Loop(const Loop& other, ComposedNode *father, bool editionOnly):StaticDefinedComposedNode(other,father),_nbOfTurns(0),_nodeForNullTurnOfLoops(0),_node(0)
296 _node=other._node->simpleClone(this,editionOnly);
299 Loop::Loop(const std::string& name):StaticDefinedComposedNode(name),_node(0),_nbOfTurns(0),_nodeForNullTurnOfLoops(0)
306 if(_nodeForNullTurnOfLoops)delete _nodeForNullTurnOfLoops;
307 for(set<DSToDFForLoop *>::iterator iter1=_inputsTraducer.begin();iter1!=_inputsTraducer.end();iter1++)
309 for(set<DFToDSForLoop *>::iterator iter2=_outputsTraducer.begin();iter2!=_outputsTraducer.end();iter2++)
313 void Loop::init(bool start)
315 StaticDefinedComposedNode::init(start);
318 _node->init(start); // if start is true, refresh the internal node
320 throw Exception("Loop::initLoop : no nodes specifies to be repeated ");
321 delete _nodeForNullTurnOfLoops;
322 _nodeForNullTurnOfLoops=0;
325 Node *Loop::edSetNode(Node *node)
333 string what = "Loop::edSetNode: node "; what += node->getName(); what += " is not orphan ! ";
334 throw Exception(what);
337 checkNoCrossHierachyWith(node);
338 StaticDefinedComposedNode::edRemoveChild(_node);
342 //set _modified flag so that edUpdateState() can refresh state
347 bool Loop::edAddChild(Node *node) throw(YACS::Exception)
349 return edSetNode(node);
352 Node *Loop::edRemoveNode()
354 StaticDefinedComposedNode::edRemoveChild(_node);
361 //! Collect all the child nodes that are ready
363 * \param tasks : vector of tasks to collect ready nodes
365 void Loop::getReadyTasks(std::vector<Task *>& tasks)
370 * To change the way ComposedNode state is handled, uncomment the following line
371 * see Bloc::getReadyTasks
373 if(_state==YACS::TOACTIVATE) setState(YACS::ACTIVATED);
374 if(_state==YACS::TOACTIVATE || _state==YACS::ACTIVATED)
375 if(_nodeForNullTurnOfLoops)
376 _nodeForNullTurnOfLoops->getReadyTasks(tasks);
379 _node->getReadyTasks(tasks);
380 for(set<DSToDFForLoop *>::iterator iter1=_inputsTraducer.begin();iter1!=_inputsTraducer.end();iter1++)
381 (*iter1)->getReadyTasks(tasks);
382 for(set<DFToDSForLoop *>::iterator iter2=_outputsTraducer.begin();iter2!=_outputsTraducer.end();iter2++)
383 (*iter2)->getReadyTasks(tasks);
387 void Loop::edRemoveChild(Node *node) throw(YACS::Exception)
389 StaticDefinedComposedNode::edRemoveChild(node);
395 void Loop::selectRunnableTasks(std::vector<Task *>& tasks)
399 std::list<Node *> Loop::edGetDirectDescendants() const
403 ret.push_back(_node);
407 std::list<InputPort *> Loop::getSetOfInputPort() const
409 list<InputPort *> ret=StaticDefinedComposedNode::getSetOfInputPort();
410 ret.push_back(getDecisionPort());
414 int Loop::getNumberOfInputPorts() const
416 return StaticDefinedComposedNode::getNumberOfInputPorts()+1;
419 Node *Loop::getChildByShortName(const std::string& name) const throw(YACS::Exception)
422 if(name==_node->getName())
424 string what("node "); what+= name ; what+=" is not a child of loop node "; what += getName();
425 throw Exception(what);
428 TypeCode* Loop::MappingDF2DS(TypeCode* type) throw(YACS::Exception)
433 TypeCode* Loop::MappingDS2DF(TypeCode* type) throw(YACS::Exception)
438 void Loop::buildDelegateOf(InPort * & port, OutPort *initialStart, const std::list<ComposedNode *>& pointsOfView)
440 string typeOfPortInstance=port->getNameOfTypeOfCurrentInstance();
441 if(typeOfPortInstance!=InputPort::NAME ||
442 (typeOfPortInstance == InputPort::NAME &&
443 initialStart->getNameOfTypeOfCurrentInstance()== OutputPort::NAME &&
444 !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
446 InputPort *portCasted=(InputPort *)port;
447 set<DSToDFForLoop*>::iterator iter;
448 //Determinig if a DSToDFForLoop node has already been created for delegation of 'port'
449 for(iter=_inputsTraducer.begin();iter!=_inputsTraducer.end();iter++)
450 if((*iter)->getOutputPort("")->isAlreadyInSet(portCasted))
452 if(iter==_inputsTraducer.end())
453 {//first time that 'port' is delegated on higher level
454 pair<set<DSToDFForLoop*>::iterator, bool> iter2=_inputsTraducer.insert(new DSToDFForLoop(this,portCasted->getName(),Loop::MappingDF2DS(portCasted->edGetType())));
456 (*iter)->getOutputPort("")->addInPort(portCasted);
459 (*iter)->loopHasOneMoreRef();
460 port=(*iter)->getInputDataStreamPort("");
463 void Loop::buildDelegateOf(std::pair<OutPort *, OutPort *>& port, InPort *finalTarget, const std::list<ComposedNode *>& pointsOfView)
465 string typeOfPortInstance=(port.first)->getNameOfTypeOfCurrentInstance();
466 if(typeOfPortInstance!=OutputPort::NAME ||
467 ( typeOfPortInstance == OutputPort::NAME &&
468 finalTarget->getNameOfTypeOfCurrentInstance()== InputPort::NAME &&
469 !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
471 OutPort *portCasted=port.first;
472 set<DFToDSForLoop*>::iterator iter;
473 //Determinig if a DFToDSForLoop node has already been created for delegation of 'port'
474 for(iter=_outputsTraducer.begin();iter!=_outputsTraducer.end();iter++)
475 if(portCasted->isAlreadyLinkedWith((*iter)->getInputPort("")))
478 if(iter==_outputsTraducer.end())
479 {//first time that 'port' is delegated on higher level
480 //_outputsTraducer.insert(new DFToDSForLoop(this,portCasted->getName(),portCasted->edGetType()));
481 kl=new DFToDSForLoop(this,portCasted->getName(),portCasted->edGetType());
482 pair<set<DFToDSForLoop*>::iterator, bool> iter2=_outputsTraducer.insert(kl);
484 portCasted->addInPort((*iter)->getInputPort(""));
489 kl->loopHasOneMoreRef();
491 edAddLink(isInMyDescendance((port.first)->getNode())->getOutGate(),kl->getInGate());
492 port.first=(*iter)->getOutputDataStreamPort("");
495 void Loop::getDelegateOf(InPort * & port, OutPort *initialStart, const std::list<ComposedNode *>& pointsOfView) throw(YACS::Exception)
497 string typeOfPortInstance=port->getNameOfTypeOfCurrentInstance();
498 if(typeOfPortInstance!=InputPort::NAME ||
499 (typeOfPortInstance == InputPort::NAME &&
500 initialStart->getNameOfTypeOfCurrentInstance()== OutputPort::NAME &&
501 !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
503 InputPort *portCasted=(InputPort *)port;
504 set<DSToDFForLoop*>::iterator iter;
505 for(iter=_inputsTraducer.begin();iter!=_inputsTraducer.end();iter++)
506 if((*iter)->getOutputPort("")->isAlreadyInSet(portCasted))
508 if(iter==_inputsTraducer.end())
510 string what("Loop::getDelegateOf : Port with name "); what+=portCasted->getName(); what+=" not exported by loop "; what+=_name;
511 throw Exception(what);
514 port=(*iter)->getInputDataStreamPort("");
517 void Loop::getDelegateOf(std::pair<OutPort *, OutPort *>& port, InPort *finalTarget,
518 const std::list<ComposedNode *>& pointsOfView) throw(YACS::Exception)
520 string typeOfPortInstance=(port.first)->getNameOfTypeOfCurrentInstance();
521 if(typeOfPortInstance!=OutputPort::NAME ||
522 ( typeOfPortInstance == OutputPort::NAME &&
523 finalTarget->getNameOfTypeOfCurrentInstance()== InputPort::NAME &&
524 !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
526 OutPort *portCasted=port.first;
527 set<DFToDSForLoop*>::iterator iter;
528 for(iter=_outputsTraducer.begin();iter!=_outputsTraducer.end();iter++)
529 if(portCasted->isAlreadyLinkedWith((*iter)->getInputPort("")))
531 if(iter==_outputsTraducer.end())
533 string what("Loop::getDelegateOf : Port with name "); what+=portCasted->getName(); what+=" not exported by loop "; what+=_name;
534 throw Exception(what);
537 port.first=(*iter)->getOutputDataStreamPort("");
540 void Loop::releaseDelegateOf(InPort * & port, OutPort *initialStart, const std::list<ComposedNode *>& pointsOfView) throw(YACS::Exception)
542 string typeOfPortInstance=port->getNameOfTypeOfCurrentInstance();
543 if(typeOfPortInstance!=InputPort::NAME ||
544 ( typeOfPortInstance == InputPort::NAME &&
545 initialStart->getNameOfTypeOfCurrentInstance()== OutputPort::NAME &&
546 !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
548 InputPort *portCasted=(InputPort *)port;
549 set<DSToDFForLoop*>::iterator iter;
550 for(iter=_inputsTraducer.begin();iter!=_inputsTraducer.end();iter++)
551 if((*iter)->getOutputPort("")->isAlreadyInSet(portCasted))
553 if(iter==_inputsTraducer.end())
555 string what("Loop::releaseDelegateOf Port with name "); what+=portCasted->getName(); what+=" not exported by loop "; what+=_name;
556 throw Exception(what);
560 port=(*iter)->getInputDataStreamPort("");
561 if((*iter)->loopHasOneLessRef())
563 (*iter)->getOutputPort("")->removeInPort(portCasted,false);
565 _inputsTraducer.erase(iter);
570 void Loop::releaseDelegateOf(OutPort *portDwn, OutPort *portUp, InPort *finalTarget, const std::list<ComposedNode *>& pointsOfView) throw(YACS::Exception)
574 set<DFToDSForLoop*>::iterator iter;
575 for(iter=_outputsTraducer.begin();iter!=_outputsTraducer.end();iter++)
576 if((*iter)->getOutputDataStreamPort("")==portUp)
578 if((*iter)->loopHasOneLessRef())
580 portDwn->removeInPort((*iter)->getInputPort(""),false);
582 _outputsTraducer.erase(iter);
586 void Loop::checkNoCyclePassingThrough(Node *node) throw(YACS::Exception)
588 //throw Exception("Loop::checkNoCyclePassingThrough : Internal error occured");
591 void Loop::checkCFLinks(const std::list<OutPort *>& starts, InputPort *end, unsigned char& alreadyFed, bool direction, LinkInfo& info) const
593 Node *nodeEnd=end->getNode();
595 {//In this case 'end' port is a special port of this (for exemple ForLoop::_nbOfTimesPort)
596 //ASSERT(!direction) see Loop::checkControlDependancy (bw only)
597 solveObviousOrDelegateCFLinks(starts,end,alreadyFed,direction,info);
600 StaticDefinedComposedNode::checkCFLinks(starts,end,alreadyFed,direction,info);
604 * \note : States if a DF port must be considered on an upper level in hierarchy as a DS port or not from 'pointsOfView' observers.
606 * - True : a traduction DF->DS has to be done
607 * - False : no traduction needed
609 bool Loop::isNecessaryToBuildSpecificDelegateDF2DS(const std::list<ComposedNode *>& pointsOfView)
612 for(list<ComposedNode *>::const_iterator iter=pointsOfView.begin();iter!=pointsOfView.end() && !ret;iter++)
613 ret=(*iter)->isRepeatedUnpredictablySeveralTimes();
617 //! Connect an OutPort to an InPort and add control link if necessary
619 * Connect the ports with a data link (edAddLink)
620 * In a Loop don't add control flow link : use this only to add data back links
622 * \param start : the OutPort to connect
623 * \param end : the InPort to connect
624 * \return true if a new link has been created, false otherwise.
626 bool Loop::edAddDFLink(OutPort *start, InPort *end) throw(YACS::Exception)
628 return edAddLink(start,end);
631 //! Dump the node state to a stream
633 * \param os : the output stream
635 void Loop::writeDot(std::ostream &os) const
637 os << " subgraph cluster_" << getId() << " {\n" ;
638 //only one node in a loop
642 os << getId() << " -> " << _node->getId() << ";\n";
645 os << getId() << "[fillcolor=\"" ;
646 YACS::StatesForNode state=getEffectiveState();
647 os << getColorState(state);
648 os << "\" label=\"" << "Loop:" ;
649 os << getQualifiedName() <<"\"];\n";
653 void Loop::accept(Visitor *visitor)
655 visitor->visitLoop(this);
658 void Loop::checkControlDependancy(OutPort *start, InPort *end, bool cross,
659 std::map < ComposedNode *, std::list < OutPort * >, SortHierarc >& fw,
660 std::vector<OutPort *>& fwCross,
661 std::map< ComposedNode *, std::list < OutPort *>, SortHierarc >& bw,
662 LinkInfo& info) const
664 //First testing if end==getDecisionPort. This is the only case possible in theory.
665 if(end!=getDecisionPort())
666 return StaticDefinedComposedNode::checkControlDependancy(start,end,cross,fw,fwCross,bw,info);
668 throw Exception("Internal error occured - cross type link detected on decision port of a loop. Forbidden !");
669 fw[(ComposedNode *)this].push_back(start);
672 void Loop::checkBasicConsistency() const throw(YACS::Exception)
674 DEBTRACE("Loop::checkBasicConsistency");
675 ComposedNode::checkBasicConsistency();
677 throw Exception("For a loop, internal node is mandatory");
681 * For use only when loading a previously saved execution
684 void YACS::ENGINE::NbDoneLoader(Loop* node, int val)
686 node->_nbOfTurns = val;