1 // Copyright (C) 2006-2020 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 "RuntimeSALOME.hxx"
21 #include "PythonNode.hxx"
22 #include "PythonPorts.hxx"
23 #include "TypeCode.hxx"
24 #include "AutoGIL.hxx"
25 #include "Container.hxx"
26 #include "SalomeContainer.hxx"
27 #include "SalomeHPContainer.hxx"
28 #include "SalomeContainerTmpForHP.hxx"
29 #include "ConversionException.hxx"
31 #include "PyStdout.hxx"
39 #define getpid _getpid
42 #if PY_VERSION_HEX < 0x02050000
43 typedef int Py_ssize_t;
47 #include "YacsTrace.hxx"
49 using namespace YACS::ENGINE;
52 const char PythonEntry::SCRIPT_FOR_SIMPLE_SERIALIZATION[]="import pickle\n"
53 "def pickleForVarSimplePyth2009(val):\n"
54 " return pickle.dumps(val,-1)\n"
57 const char PythonNode::IMPL_NAME[]="Python";
58 const char PythonNode::KIND[]="Python";
60 const char PythonNode::SCRIPT_FOR_SERIALIZATION[]="import pickle\n"
61 "def pickleForDistPyth2009(kws):\n"
62 " return pickle.dumps(((),kws),-1)\n"
64 "def unPickleForDistPyth2009(st):\n"
65 " args=pickle.loads(st)\n"
68 const char PythonNode::REMOTE_NAME[]="remote";
70 const char PythonNode::DPL_INFO_NAME[]="my_dpl_localization";
72 const char PyFuncNode::SCRIPT_FOR_SERIALIZATION[]="import pickle\n"
73 "def pickleForDistPyth2009(*args,**kws):\n"
74 " return pickle.dumps((args,kws),-1)\n"
76 "def unPickleForDistPyth2009(st):\n"
77 " args=pickle.loads(st)\n"
81 PythonEntry::PythonEntry():_context(0),_pyfuncSer(0),_pyfuncUnser(0),_pyfuncSimpleSer(0)
85 PythonEntry::~PythonEntry()
88 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
89 // not Py_XDECREF of _pyfuncUnser because it is returned by PyDict_GetItem -> borrowed
90 // not Py_XDECREF of _pyfuncSer because it is returned by PyDict_GetItem -> borrowed
94 void PythonEntry::commonRemoteLoadPart1(InlineNode *reqNode)
96 DEBTRACE( "---------------PythonEntry::CommonRemoteLoad function---------------" );
97 Container *container(reqNode->getContainer());
98 bool isContAlreadyStarted(false);
101 isContAlreadyStarted=container->isAlreadyStarted(reqNode);
102 if(!isContAlreadyStarted)
106 container->start(reqNode);
110 reqNode->setErrorDetails(e.what());
117 std::string what("PythonEntry::CommonRemoteLoad : a load operation requested on \"");
118 what+=reqNode->getName(); what+="\" with no container specified.";
119 reqNode->setErrorDetails(what);
120 throw Exception(what);
124 Engines::Container_var GetContainerObj(InlineNode *reqNode, bool& isStandardCont)
126 isStandardCont = false;
127 Container *container(reqNode->getContainer());
128 Engines::Container_var objContainer(Engines::Container::_nil());
130 throw YACS::Exception("No container specified !");
131 SalomeContainer *containerCast0(dynamic_cast<SalomeContainer *>(container));
132 SalomeHPContainerBase *containerCast1(dynamic_cast<SalomeHPContainerBase *>(container));
135 isStandardCont = true;
136 objContainer=containerCast0->getContainerPtr(reqNode);
138 else if(containerCast1)
140 objContainer=containerCast1->getContainerPtr(reqNode);
143 throw YACS::Exception("Unrecognized type of container ! Salome one is expected for PythonNode/PyFuncNode !");
144 if(CORBA::is_nil(objContainer))
145 throw YACS::Exception("Container corba pointer is NULL for PythonNode !");
149 Engines::Container_var PythonEntry::commonRemoteLoadPart2(InlineNode *reqNode, bool& isInitializeRequested)
151 bool isStandardCont(true);
152 Engines::Container_var objContainer(GetContainerObj(reqNode,isStandardCont));
153 isInitializeRequested=false;
158 createRemoteAdaptedPyInterpretor(objContainer);
162 Engines::PyNodeBase_var dftPyScript(retrieveDftRemotePyInterpretorIfAny(objContainer));
163 if(CORBA::is_nil(dftPyScript))
165 isInitializeRequested=true;
166 createRemoteAdaptedPyInterpretor(objContainer);
169 assignRemotePyInterpretor(dftPyScript);
172 catch( const SALOME::SALOME_Exception& ex )
174 std::string msg="Exception on remote python node creation ";
176 msg += ex.details.text.in();
177 reqNode->setErrorDetails(msg);
178 throw Exception(msg);
180 Engines::PyNodeBase_var pynode(getRemoteInterpreterHandle());
181 if(CORBA::is_nil(pynode))
182 throw Exception("In PythonNode the ref in NULL ! ");
186 void PythonEntry::commonRemoteLoadPart3(InlineNode *reqNode, Engines::Container_ptr objContainer, bool isInitializeRequested)
188 Container *container(reqNode->getContainer());
189 Engines::PyNodeBase_var pynode(getRemoteInterpreterHandle());
193 const char *picklizeScript(getSerializationScript());
194 PyObject *res=PyRun_String(picklizeScript,Py_file_input,_context,_context);
195 PyObject *res2(PyRun_String(SCRIPT_FOR_SIMPLE_SERIALIZATION,Py_file_input,_context,_context));
196 if(res == NULL || res2==NULL)
198 std::string errorDetails;
199 PyObject* new_stderr = newPyStdOut(errorDetails);
200 reqNode->setErrorDetails(errorDetails);
201 PySys_SetObject((char*)"stderr", new_stderr);
203 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
204 Py_DECREF(new_stderr);
205 throw Exception("Error during load");
207 Py_DECREF(res); Py_DECREF(res2);
208 _pyfuncSer=PyDict_GetItemString(_context,"pickleForDistPyth2009");
209 _pyfuncUnser=PyDict_GetItemString(_context,"unPickleForDistPyth2009");
210 _pyfuncSimpleSer=PyDict_GetItemString(_context,"pickleForVarSimplePyth2009");
211 if(_pyfuncSer == NULL)
213 std::string errorDetails;
214 PyObject *new_stderr(newPyStdOut(errorDetails));
215 reqNode->setErrorDetails(errorDetails);
216 PySys_SetObject((char*)"stderr", new_stderr);
218 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
219 Py_DECREF(new_stderr);
220 throw Exception("Error during load");
222 if(_pyfuncUnser == NULL)
224 std::string errorDetails;
225 PyObject *new_stderr(newPyStdOut(errorDetails));
226 reqNode->setErrorDetails(errorDetails);
227 PySys_SetObject((char*)"stderr", new_stderr);
229 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
230 Py_DECREF(new_stderr);
231 throw Exception("Error during load");
233 if(_pyfuncSimpleSer == NULL)
235 std::string errorDetails;
236 PyObject *new_stderr(newPyStdOut(errorDetails));
237 reqNode->setErrorDetails(errorDetails);
238 PySys_SetObject((char*)"stderr", new_stderr);
240 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
241 Py_DECREF(new_stderr);
242 throw Exception("Error during load");
245 if(isInitializeRequested)
246 {//This one is called only once at initialization in the container if an init-script is specified.
249 std::string zeInitScriptKey(container->getProperty(HomogeneousPoolContainer::INITIALIZE_SCRIPT_KEY));
250 if(!zeInitScriptKey.empty())
251 pynode->executeAnotherPieceOfCode(zeInitScriptKey.c_str());
253 catch( const SALOME::SALOME_Exception& ex )
255 std::string msg="Exception on PythonNode::loadRemote python invocation of initializisation py script !";
257 msg += ex.details.text.in();
258 reqNode->setErrorDetails(msg);
259 throw Exception(msg);
261 DEBTRACE( "---------------End PyNode::loadRemote function---------------" );
265 std::string PythonEntry::GetContainerLog(const std::string& mode, Container *container, const Task *askingTask)
273 SalomeContainer *containerCast(dynamic_cast<SalomeContainer *>(container));
274 SalomeHPContainer *objContainer2(dynamic_cast<SalomeHPContainer *>(container));
277 Engines::Container_var objContainer(containerCast->getContainerPtr(askingTask));
278 CORBA::String_var logname = objContainer->logfilename();
281 std::string::size_type pos = msg.find(":");
282 msg=msg.substr(pos+1);
284 else if(objContainer2)
286 msg="Remote PythonNode is on HP Container : no log because no info of the location by definition of HP Container !";
290 msg="Not implemented yet for container log for that type of container !";
295 msg = "Container no longer reachable";
300 void PythonEntry::commonRemoteLoad(InlineNode *reqNode)
302 commonRemoteLoadPart1(reqNode);
303 bool isInitializeRequested;
304 Engines::Container_var objContainer(commonRemoteLoadPart2(reqNode,isInitializeRequested));
305 commonRemoteLoadPart3(reqNode,objContainer,isInitializeRequested);
308 PythonNode::PythonNode(const PythonNode& other, ComposedNode *father):InlineNode(other,father),_autoSqueeze(other._autoSqueeze)
310 _implementation=IMPL_NAME;
313 _context=PyDict_New();
314 if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
317 msg << "Impossible to set builtins" << __FILE__ << ":" << __LINE__;
318 _errorDetails=msg.str();
319 throw Exception(msg.str());
324 PythonNode::PythonNode(const std::string& name):InlineNode(name)
326 _implementation=IMPL_NAME;
329 _context=PyDict_New();
330 if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
333 msg << "Impossible to set builtins" << __FILE__ << ":" << __LINE__;
334 _errorDetails=msg.str();
335 throw Exception(msg.str());
340 PythonNode::~PythonNode()
342 if(!CORBA::is_nil(_pynode))
344 _pynode->UnRegister();
348 void PythonNode::checkBasicConsistency() const throw(YACS::Exception)
350 DEBTRACE("checkBasicConsistency");
351 InlineNode::checkBasicConsistency();
355 res=Py_CompileString(_script.c_str(),getName().c_str(),Py_file_input);
358 std::string error="";
359 PyObject* new_stderr = newPyStdOut(error);
360 PySys_SetObject((char*)"stderr", new_stderr);
362 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
363 Py_DECREF(new_stderr);
364 throw Exception(error);
371 void PythonNode::load()
373 DEBTRACE( "---------------PyNode::load function---------------" );
374 if(_mode==PythonNode::REMOTE_NAME)
380 void PythonNode::loadLocal()
382 DEBTRACE( "---------------PyNode::loadLocal function---------------" );
386 void PythonNode::loadRemote()
388 commonRemoteLoad(this);
391 void PythonNode::execute()
393 if(_mode==PythonNode::REMOTE_NAME)
399 void PythonNode::executeRemote()
401 DEBTRACE( "++++++++++++++ PyNode::executeRemote: " << getName() << " ++++++++++++++++++++" );
403 throw Exception("DistributedPythonNode badly loaded");
405 if(dynamic_cast<HomogeneousPoolContainer *>(getContainer()))
408 commonRemoteLoadPart2(this,dummy);
409 _pynode->assignNewCompiledCode(getScript().c_str());
412 std::unique_ptr<Engines::pickledArgs> serializationInputCorba(new Engines::pickledArgs);
413 AutoPyRef serializationInput;
416 PyObject *args(0),*ob(0);
417 //===========================================================================
418 // Get inputs in input ports, build a Python dict and pickle it
419 //===========================================================================
421 std::list<InputPort *>::iterator iter2;
423 for(iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); ++iter2)
425 InputPyPort *p=(InputPyPort *)*iter2;
427 PyDict_SetItemString(args,p->getName().c_str(),ob);
431 PyObject_Print(args,stderr,Py_PRINT_RAW);
434 serializationInput.set(PyObject_CallFunctionObjArgs(_pyfuncSer,args,nullptr));
436 //The pickled string may contain NULL characters so use PyString_AsStringAndSize
437 char *serializationInputC(0);
439 if (PyBytes_AsStringAndSize(serializationInput, &serializationInputC, &len))
440 throw Exception("DistributedPythonNode problem in python pickle");
441 // no copy here. The C byte array of Python is taken as this into CORBA sequence to avoid copy
442 serializationInputCorba.reset(new Engines::pickledArgs(len,len,reinterpret_cast<CORBA::Octet *>(serializationInputC),0));
445 //get the list of output argument names
446 std::list<OutputPort *>::iterator iter;
447 Engines::listofstring myseq;
448 myseq.length(getNumberOfOutputPorts());
450 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); ++iter)
452 OutputPyPort *p=(OutputPyPort *)*iter;
453 myseq[pos]=p->getName().c_str();
454 DEBTRACE( "port name: " << p->getName() );
455 DEBTRACE( "port kind: " << p->edGetType()->kind() );
456 DEBTRACE( "port pos : " << pos );
459 //===========================================================================
460 // Execute in remote Python node
461 //===========================================================================
462 DEBTRACE( "-----------------starting remote python invocation-----------------" );
463 std::unique_ptr<Engines::pickledArgs> resultCorba;
466 //pass outargsname and dict serialized
467 _pynode->executeFirst(*(serializationInputCorba.get()));
468 //serializationInput and serializationInputCorba are no more needed for server. Release it.
469 serializationInputCorba.reset(nullptr); serializationInput.set(nullptr);
470 resultCorba.reset(_pynode->executeSecond(myseq));
472 catch( const SALOME::SALOME_Exception& ex )
474 std::ostringstream msg; msg << "Exception on remote python invocation" << std::endl << ex.details.text.in() << std::endl;
475 msg << "PyScriptNode CORBA ref : ";
477 CORBA::ORB_ptr orb(getSALOMERuntime()->getOrb());
478 if(!CORBA::is_nil(orb))
480 CORBA::String_var IOR(orb->object_to_string(_pynode));
485 _errorDetails=msg.str();
486 throw Exception(msg.str());
488 if(!CORBA::is_nil(_pynode))
490 _pynode->UnRegister();
492 _pynode = Engines::PyScriptNode::_nil();
495 Engines::Container_var cont(GetContainerObj(this,dummy));
496 cont->removePyScriptNode(getName().c_str());
497 DEBTRACE( "-----------------end of remote python invocation-----------------" );
498 //===========================================================================
499 // Get results, unpickle and put them in output ports
500 //===========================================================================
501 auto length(resultCorba->length());
502 char *resultCorbaC(reinterpret_cast<char *>(resultCorba->get_buffer()));
505 PyObject *args(0),*ob(0);
506 PyObject* resultPython=PyMemoryView_FromMemory(resultCorbaC,length,PyBUF_READ);
507 args = PyTuple_New(1);
508 PyTuple_SetItem(args,0,resultPython);
509 PyObject *finalResult=PyObject_CallObject(_pyfuncUnser,args);
510 resultCorba.reset(nullptr);
513 if (finalResult == NULL)
515 std::stringstream msg;
516 msg << "Conversion with pickle of output ports failed !";
517 msg << " : " << __FILE__ << ":" << __LINE__;
518 _errorDetails=msg.str();
519 throw YACS::ENGINE::ConversionException(msg.str());
522 DEBTRACE( "-----------------PythonNode::outputs-----------------" );
524 if(finalResult == Py_None)
526 else if(PyTuple_Check(finalResult))
527 nres=PyTuple_Size(finalResult);
529 if(getNumberOfOutputPorts() != nres)
531 std::string msg="Number of output arguments : Mismatch between definition and execution";
532 Py_DECREF(finalResult);
534 throw Exception(msg);
540 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); ++iter)
542 OutputPyPort *p=(OutputPyPort *)*iter;
543 DEBTRACE( "port name: " << p->getName() );
544 DEBTRACE( "port kind: " << p->edGetType()->kind() );
545 DEBTRACE( "port pos : " << pos );
546 if(PyTuple_Check(finalResult))
547 ob=PyTuple_GetItem(finalResult,pos) ;
550 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
554 Py_DECREF(finalResult);
556 catch(ConversionException& ex)
558 Py_DECREF(finalResult);
559 _errorDetails=ex.what();
563 squeezeMemoryRemote();
565 DEBTRACE( "++++++++++++++ ENDOF PyNode::executeRemote: " << getName() << " ++++++++++++++++++++" );
568 void PythonNode::executeLocal()
570 DEBTRACE( "++++++++++++++ PyNode::executeLocal: " << getName() << " ++++++++++++++++++++" );
574 DEBTRACE( "---------------PyNode::inputs---------------" );
575 list<InputPort *>::iterator iter2;
576 for(iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); iter2++)
578 InputPyPort *p=(InputPyPort *)*iter2;
579 DEBTRACE( "port name: " << p->getName() );
580 DEBTRACE( "port kind: " << p->edGetType()->kind() );
581 PyObject* ob=p->getPyObj();
582 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
584 PyObject_Print(ob,stderr,Py_PRINT_RAW);
587 int ier=PyDict_SetItemString(_context,p->getName().c_str(),ob);
588 DEBTRACE( "after PyDict_SetItemString:ob refcnt: " << ob->ob_refcnt );
591 DEBTRACE( "---------------End PyNode::inputs---------------" );
594 DEBTRACE( "----------------PyNode::calculation---------------" );
596 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
598 std::ostringstream stream;
599 stream << "/tmp/PythonNode_";
602 PyObject* code=Py_CompileString(_script.c_str(), stream.str().c_str(), Py_file_input);
606 PyObject* new_stderr = newPyStdOut(_errorDetails);
607 PySys_SetObject((char*)"stderr", new_stderr);
609 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
610 Py_DECREF(new_stderr);
611 throw Exception("Error during execution");
613 PyObject *res = PyEval_EvalCode( code, _context, _context);
617 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
620 if(PyErr_Occurred ())
623 PyObject* new_stderr = newPyStdOut(_errorDetails);
624 PySys_SetObject((char*)"stderr", new_stderr);
625 ofstream errorfile(stream.str().c_str());
626 if (errorfile.is_open())
628 errorfile << _script;
632 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
633 Py_DECREF(new_stderr);
634 throw Exception("Error during execution");
637 DEBTRACE( "-----------------PyNode::outputs-----------------" );
638 list<OutputPort *>::iterator iter;
641 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++)
643 OutputPyPort *p=(OutputPyPort *)*iter;
644 DEBTRACE( "port name: " << p->getName() );
645 DEBTRACE( "port kind: " << p->edGetType()->kind() );
646 PyObject *ob=PyDict_GetItemString(_context,p->getName().c_str());
649 std::string msg="Error during execution: there is no variable ";
650 msg=msg+p->getName()+" in node context";
652 throw Exception(msg);
654 DEBTRACE( "PyNode::outputs::ob refcnt: " << ob->ob_refcnt );
656 PyObject_Print(ob,stderr,Py_PRINT_RAW);
662 catch(ConversionException& ex)
664 _errorDetails=ex.what();
669 DEBTRACE( "-----------------End PyNode::outputs-----------------" );
671 DEBTRACE( "++++++++++++++ End PyNode::execute: " << getName() << " ++++++++++++++++++++" );
674 void PythonNode::squeezeMemorySafe()
677 if(_mode==PythonNode::REMOTE_NAME)
678 this->squeezeMemoryRemote();
680 this->squeezeMemory();
683 void PythonNode::squeezeMemory()
685 for(auto p : _setOfInputPort)
687 PyDict_DelItemString(_context,p->getName().c_str());
688 InputPyPort *p2(static_cast<InputPyPort *>(p));
689 if(p2->canSafelySqueezeMemory())
692 for(auto p : _setOfOutputPort)
694 PyDict_DelItemString(_context,p->getName().c_str());
695 OutputPyPort *p2(static_cast<OutputPyPort *>(p));
696 p2->putWithoutForward(Py_None);
700 void PythonNode::squeezeMemoryRemote()
702 for(auto p : _setOfInputPort)
704 InputPyPort *p2(static_cast<InputPyPort *>(p));
705 if(p2->canSafelySqueezeMemory())
708 for(auto p : _setOfOutputPort)
710 OutputPyPort *p2(static_cast<OutputPyPort *>(p));
711 p2->putWithoutForward(Py_None);
715 std::string PythonNode::getContainerLog()
717 return PythonEntry::GetContainerLog(_mode,_container,this);
720 void PythonNode::shutdown(int level)
722 DEBTRACE("PythonNode::shutdown " << level);
723 if(_mode=="local")return;
726 if(!CORBA::is_nil(_pynode)) _pynode->UnRegister();
727 _pynode=Engines::PyScriptNode::_nil();
728 _container->shutdown(level);
732 Node *PythonNode::simpleClone(ComposedNode *father, bool editionOnly) const
734 return new PythonNode(*this,father);
737 void PythonNode::createRemoteAdaptedPyInterpretor(Engines::Container_ptr objContainer)
739 if(!CORBA::is_nil(_pynode))
740 _pynode->UnRegister();
741 _pynode=objContainer->createPyScriptNode(getName().c_str(),getScript().c_str());
745 Engines::PyNodeBase_var PythonNode::retrieveDftRemotePyInterpretorIfAny(Engines::Container_ptr objContainer) const
747 Engines::PyScriptNode_var ret(objContainer->getDefaultPyScriptNode(getName().c_str()));
748 if(!CORBA::is_nil(ret))
752 return Engines::PyNodeBase::_narrow(ret);
755 void PythonNode::assignRemotePyInterpretor(Engines::PyNodeBase_var remoteInterp)
757 if(!CORBA::is_nil(_pynode))
759 Engines::PyScriptNode_var tmpp(Engines::PyScriptNode::_narrow(remoteInterp));
760 if(_pynode->_is_equivalent(tmpp))
762 _pynode->UnRegister();
766 if(!CORBA::is_nil(_pynode))
767 _pynode->UnRegister();
768 _pynode=Engines::PyScriptNode::_narrow(remoteInterp);
771 Engines::PyNodeBase_var PythonNode::getRemoteInterpreterHandle()
773 return Engines::PyNodeBase::_narrow(_pynode);
776 //! Create a new node of same type with a given name
777 PythonNode* PythonNode::cloneNode(const std::string& name)
779 PythonNode* n=new PythonNode(name);
780 n->setScript(_script);
781 list<InputPort *>::iterator iter;
782 for(iter = _setOfInputPort.begin(); iter != _setOfInputPort.end(); iter++)
784 InputPyPort *p=(InputPyPort *)*iter;
785 DEBTRACE( "port name: " << p->getName() );
786 DEBTRACE( "port kind: " << p->edGetType()->kind() );
787 n->edAddInputPort(p->getName(),p->edGetType());
789 list<OutputPort *>::iterator iter2;
790 for(iter2 = _setOfOutputPort.begin(); iter2 != _setOfOutputPort.end(); iter2++)
792 OutputPyPort *p=(OutputPyPort *)*iter2;
793 DEBTRACE( "port name: " << p->getName() );
794 DEBTRACE( "port kind: " << p->edGetType()->kind() );
795 n->edAddOutputPort(p->getName(),p->edGetType());
800 void PythonNode::applyDPLScope(ComposedNode *gfn)
802 std::vector< std::pair<std::string,int> > ret(getDPLScopeInfo(gfn));
809 std::size_t sz(ret.size());
811 for(std::size_t i=0;i<sz;i++)
813 const std::pair<std::string,int>& p(ret[i]);
814 PyObject *elt(PyTuple_New(2));
815 PyTuple_SetItem(elt,0,PyUnicode_FromString(p.first.c_str()));
816 PyTuple_SetItem(elt,1,PyLong_FromLong(p.second));
817 PyList_SetItem(ob,i,elt);
820 if(_mode==REMOTE_NAME)
822 Engines::pickledArgs_var serializationInputCorba(new Engines::pickledArgs);
825 PyObject *serializationInput(PyObject_CallFunctionObjArgs(_pyfuncSimpleSer,ob,NULL));
827 char *serializationInputC(0);
829 if (PyBytes_AsStringAndSize(serializationInput, &serializationInputC, &len))
830 throw Exception("DistributedPythonNode problem in python pickle");
831 serializationInputCorba->length(len);
832 for(int i=0; i < len ; i++)
833 serializationInputCorba[i]=serializationInputC[i];
834 Py_XDECREF(serializationInput);
836 _pynode->defineNewCustomVar(DPL_INFO_NAME,serializationInputCorba);
841 PyDict_SetItemString(_context,DPL_INFO_NAME,ob);
846 PyFuncNode::PyFuncNode(const PyFuncNode& other, ComposedNode *father):InlineFuncNode(other,father),_pyfunc(0)
848 _implementation = PythonNode::IMPL_NAME;
851 _context=PyDict_New();
852 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
853 if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
856 msg << "Not possible to set builtins" << __FILE__ << ":" << __LINE__;
857 _errorDetails=msg.str();
858 throw Exception(msg.str());
863 PyFuncNode::PyFuncNode(const std::string& name): InlineFuncNode(name),_pyfunc(0)
866 _implementation = PythonNode::IMPL_NAME;
867 DEBTRACE( "PyFuncNode::PyFuncNode " << name );
870 _context=PyDict_New();
871 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
872 if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
875 msg << "Not possible to set builtins" << __FILE__ << ":" << __LINE__;
876 _errorDetails=msg.str();
877 throw Exception(msg.str());
882 PyFuncNode::~PyFuncNode()
884 if(!CORBA::is_nil(_pynode))
886 _pynode->UnRegister();
890 void PyFuncNode::init(bool start)
892 initCommonPartWithoutStateManagement(start);
893 if(_state == YACS::DISABLED)
895 exDisabledState(); // to refresh propagation of DISABLED state
898 if(start) //complete initialization
899 setState(YACS::READY);
900 else if(_state > YACS::LOADED)// WARNING FuncNode has internal vars (CEA usecase) ! Partial initialization (inside a loop). Exclusivity of funcNode.
901 setState(YACS::TORECONNECT);
904 void PyFuncNode::checkBasicConsistency() const throw(YACS::Exception)
906 DEBTRACE("checkBasicConsistency");
907 InlineFuncNode::checkBasicConsistency();
911 res=Py_CompileString(_script.c_str(),getName().c_str(),Py_file_input);
914 std::string error="";
915 PyObject* new_stderr = newPyStdOut(error);
916 PySys_SetObject((char*)"stderr", new_stderr);
918 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
919 Py_DECREF(new_stderr);
920 throw Exception(error);
927 void PyFuncNode::load()
929 DEBTRACE( "---------------PyfuncNode::load function---------------" );
930 if(_mode==PythonNode::REMOTE_NAME)
936 void PyFuncNode::loadRemote()
938 commonRemoteLoad(this);
941 void PyFuncNode::loadLocal()
943 DEBTRACE( "---------------PyFuncNode::load function " << getName() << " ---------------" );
947 list<OutputPort *>::iterator iter;
948 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++)
950 OutputPyPort *p=(OutputPyPort *)*iter;
951 DEBTRACE( "port name: " << p->getName() );
952 DEBTRACE( "port kind: " << p->edGetType()->kind() );
958 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
960 std::ostringstream stream;
961 stream << "/tmp/PythonNode_";
964 PyObject* code=Py_CompileString(_script.c_str(), stream.str().c_str(), Py_file_input);
968 PyObject* new_stderr = newPyStdOut(_errorDetails);
969 PySys_SetObject((char*)"stderr", new_stderr);
971 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
972 Py_DECREF(new_stderr);
973 throw Exception("Error during execution");
975 PyObject *res = PyEval_EvalCode( code, _context, _context);
979 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
980 if(PyErr_Occurred ())
983 PyObject* new_stderr = newPyStdOut(_errorDetails);
984 PySys_SetObject((char*)"stderr", new_stderr);
985 ofstream errorfile(stream.str().c_str());
986 if (errorfile.is_open())
988 errorfile << _script;
992 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
993 Py_DECREF(new_stderr);
994 throw Exception("Error during execution");
997 _pyfunc=PyDict_GetItemString(_context,_fname.c_str());
998 DEBTRACE( "_pyfunc refcnt: " << _pyfunc->ob_refcnt );
1002 PyObject* new_stderr = newPyStdOut(_errorDetails);
1003 PySys_SetObject((char*)"stderr", new_stderr);
1005 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
1006 Py_DECREF(new_stderr);
1007 throw Exception("Error during execution");
1009 DEBTRACE( "---------------End PyFuncNode::load function---------------" );
1013 void PyFuncNode::execute()
1015 if(_mode==PythonNode::REMOTE_NAME)
1021 void PyFuncNode::executeRemote()
1023 DEBTRACE( "++++++++++++++ PyFuncNode::executeRemote: " << getName() << " ++++++++++++++++++++" );
1025 throw Exception("DistributedPythonNode badly loaded");
1027 if(dynamic_cast<HomogeneousPoolContainer *>(getContainer()))
1030 commonRemoteLoadPart2(this,dummy);
1031 _pynode->executeAnotherPieceOfCode(getScript().c_str());
1034 Engines::pickledArgs_var serializationInputCorba(new Engines::pickledArgs);;
1038 //===========================================================================
1039 // Get inputs in input ports, build a Python tuple and pickle it
1040 //===========================================================================
1041 PyObject *args(PyTuple_New(getNumberOfInputPorts()));
1043 for(std::list<InputPort *>::iterator iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); iter2++,pos++)
1045 InputPyPort *p=(InputPyPort *)*iter2;
1048 PyTuple_SetItem(args,pos,ob);
1051 PyObject_Print(args,stderr,Py_PRINT_RAW);
1054 PyObject *serializationInput=PyObject_CallObject(_pyfuncSer,args);
1056 //The pickled string may contain NULL characters so use PyString_AsStringAndSize
1057 char *serializationInputC(0);
1059 if (PyBytes_AsStringAndSize(serializationInput, &serializationInputC, &len))
1060 throw Exception("DistributedPythonNode problem in python pickle");
1062 serializationInputCorba->length(len);
1063 for(int i=0; i < len ; i++)
1064 serializationInputCorba[i]=serializationInputC[i];
1065 Py_DECREF(serializationInput);
1068 //===========================================================================
1069 // Execute in remote Python node
1070 //===========================================================================
1071 DEBTRACE( "-----------------starting remote python invocation-----------------" );
1072 Engines::pickledArgs_var resultCorba;
1075 resultCorba=_pynode->execute(getFname().c_str(),serializationInputCorba);
1077 catch( const SALOME::SALOME_Exception& ex )
1079 std::string msg="Exception on remote python invocation";
1081 msg += ex.details.text.in();
1083 throw Exception(msg);
1085 DEBTRACE( "-----------------end of remote python invocation-----------------" );
1086 //===========================================================================
1087 // Get results, unpickle and put them in output ports
1088 //===========================================================================
1089 char *resultCorbaC=new char[resultCorba->length()+1];
1090 resultCorbaC[resultCorba->length()]='\0';
1091 for(int i=0;i<resultCorba->length();i++)
1092 resultCorbaC[i]=resultCorba[i];
1097 PyObject *resultPython(PyBytes_FromStringAndSize(resultCorbaC,resultCorba->length()));
1098 delete [] resultCorbaC;
1099 PyObject *args(PyTuple_New(1)),*ob(0);
1100 PyTuple_SetItem(args,0,resultPython);
1101 PyObject *finalResult=PyObject_CallObject(_pyfuncUnser,args);
1104 DEBTRACE( "-----------------PythonNode::outputs-----------------" );
1106 if(finalResult == Py_None)
1108 else if(PyTuple_Check(finalResult))
1109 nres=PyTuple_Size(finalResult);
1111 if(getNumberOfOutputPorts() != nres)
1113 std::string msg="Number of output arguments : Mismatch between definition and execution";
1114 Py_DECREF(finalResult);
1116 throw Exception(msg);
1122 for(std::list<OutputPort *>::iterator iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++, pos++)
1124 OutputPyPort *p=(OutputPyPort *)*iter;
1125 DEBTRACE( "port name: " << p->getName() );
1126 DEBTRACE( "port kind: " << p->edGetType()->kind() );
1127 DEBTRACE( "port pos : " << pos );
1128 if(PyTuple_Check(finalResult))
1129 ob=PyTuple_GetItem(finalResult,pos) ;
1132 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
1135 Py_DECREF(finalResult);
1137 catch(ConversionException& ex)
1139 Py_DECREF(finalResult);
1140 _errorDetails=ex.what();
1145 DEBTRACE( "++++++++++++++ ENDOF PyFuncNode::executeRemote: " << getName() << " ++++++++++++++++++++" );
1148 void PyFuncNode::executeLocal()
1150 DEBTRACE( "++++++++++++++ PyFuncNode::execute: " << getName() << " ++++++++++++++++++++" );
1154 if(!_pyfunc)throw Exception("PyFuncNode badly loaded");
1157 DEBTRACE( "---------------PyFuncNode::inputs---------------" );
1158 PyObject* args = PyTuple_New(getNumberOfInputPorts()) ;
1159 list<InputPort *>::iterator iter2;
1160 for(iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); iter2++)
1162 InputPyPort *p=(InputPyPort *)*iter2;
1163 DEBTRACE( "port name: " << p->getName() );
1164 DEBTRACE( "port kind: " << p->edGetType()->kind() );
1167 PyObject_Print(ob,stderr,Py_PRINT_RAW);
1170 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
1172 PyTuple_SetItem(args,pos,ob);
1173 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
1176 DEBTRACE( "---------------End PyFuncNode::inputs---------------" );
1178 DEBTRACE( "----------------PyFuncNode::calculation---------------" );
1180 PyObject_Print(_pyfunc,stderr,Py_PRINT_RAW);
1182 PyObject_Print(args,stderr,Py_PRINT_RAW);
1185 DEBTRACE( "_pyfunc refcnt: " << _pyfunc->ob_refcnt );
1186 PyObject* result = PyObject_CallObject( _pyfunc , args ) ;
1187 DEBTRACE( "_pyfunc refcnt: " << _pyfunc->ob_refcnt );
1194 PyObject* new_stderr = newPyStdOut(_errorDetails);
1195 PySys_SetObject((char*)"stderr", new_stderr);
1196 std::ostringstream stream;
1197 stream << "/tmp/PythonNode_";
1199 ofstream errorfile(stream.str().c_str());
1200 if (errorfile.is_open())
1202 errorfile << _script;
1206 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
1207 Py_DECREF(new_stderr);
1208 throw Exception("Error during execution");
1210 DEBTRACE( "----------------End PyFuncNode::calculation---------------" );
1212 DEBTRACE( "-----------------PyFuncNode::outputs-----------------" );
1214 if(result == Py_None)
1216 else if(PyTuple_Check(result))
1217 nres=PyTuple_Size(result);
1219 if(getNumberOfOutputPorts() != nres)
1221 std::string msg="Number of output arguments : Mismatch between definition and execution";
1224 throw Exception(msg);
1229 PyObject_Print(result,stderr,Py_PRINT_RAW);
1232 list<OutputPort *>::iterator iter;
1235 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++)
1237 OutputPyPort *p=(OutputPyPort *)*iter;
1238 DEBTRACE( "port name: " << p->getName() );
1239 DEBTRACE( "port kind: " << p->edGetType()->kind() );
1240 DEBTRACE( "port pos : " << pos );
1241 if(PyTuple_Check(result))ob=PyTuple_GetItem(result,pos) ;
1243 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
1245 PyObject_Print(ob,stderr,Py_PRINT_RAW);
1252 catch(ConversionException& ex)
1255 _errorDetails=ex.what();
1258 DEBTRACE( "-----------------End PyFuncNode::outputs-----------------" );
1261 DEBTRACE( "++++++++++++++ End PyFuncNode::execute: " << getName() << " ++++++++++++++++++++" );
1264 Node *PyFuncNode::simpleClone(ComposedNode *father, bool editionOnly) const
1266 return new PyFuncNode(*this,father);
1269 void PyFuncNode::createRemoteAdaptedPyInterpretor(Engines::Container_ptr objContainer)
1271 if(!CORBA::is_nil(_pynode))
1272 _pynode->UnRegister();
1273 _pynode=objContainer->createPyNode(getName().c_str(),getScript().c_str());
1276 Engines::PyNodeBase_var PyFuncNode::retrieveDftRemotePyInterpretorIfAny(Engines::Container_ptr objContainer) const
1278 Engines::PyNode_var ret(objContainer->getDefaultPyNode(getName().c_str()));
1279 if(!CORBA::is_nil(ret))
1283 return Engines::PyNodeBase::_narrow(ret);
1286 void PyFuncNode::assignRemotePyInterpretor(Engines::PyNodeBase_var remoteInterp)
1288 if(!CORBA::is_nil(_pynode))
1290 Engines::PyNode_var tmpp(Engines::PyNode::_narrow(remoteInterp));
1291 if(_pynode->_is_equivalent(tmpp))
1294 if(!CORBA::is_nil(_pynode))
1295 _pynode->UnRegister();
1296 _pynode=Engines::PyNode::_narrow(remoteInterp);
1299 Engines::PyNodeBase_var PyFuncNode::getRemoteInterpreterHandle()
1301 return Engines::PyNodeBase::_narrow(_pynode);
1304 //! Create a new node of same type with a given name
1305 PyFuncNode* PyFuncNode::cloneNode(const std::string& name)
1307 PyFuncNode* n=new PyFuncNode(name);
1308 n->setScript(_script);
1309 n->setFname(_fname);
1310 list<InputPort *>::iterator iter;
1311 for(iter = _setOfInputPort.begin(); iter != _setOfInputPort.end(); iter++)
1313 InputPyPort *p=(InputPyPort *)*iter;
1314 n->edAddInputPort(p->getName(),p->edGetType());
1316 list<OutputPort *>::iterator iter2;
1317 for(iter2 = _setOfOutputPort.begin(); iter2 != _setOfOutputPort.end(); iter2++)
1319 OutputPyPort *p=(OutputPyPort *)*iter2;
1320 n->edAddOutputPort(p->getName(),p->edGetType());
1325 std::string PyFuncNode::getContainerLog()
1327 return PythonEntry::GetContainerLog(_mode,_container,this);
1330 void PyFuncNode::shutdown(int level)
1332 DEBTRACE("PyFuncNode::shutdown " << level);
1333 if(_mode=="local")return;
1336 if(!CORBA::is_nil(_pynode)) _pynode->UnRegister();
1337 _pynode=Engines::PyNode::_nil();
1338 _container->shutdown(level);