1 // Copyright (C) 2006-2023 CEA, EDF
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 "PythonCppUtils.hxx"
25 #include "Container.hxx"
26 #include "SalomeContainer.hxx"
27 #include "SalomeHPContainer.hxx"
28 #include "SalomeContainerTmpForHP.hxx"
29 #include "ConversionException.hxx"
30 #include "ReceiverFactory.hxx"
31 #include "SenderByteImpl.hxx"
33 #include "PyStdout.hxx"
41 #define getpid _getpid
44 #if PY_VERSION_HEX < 0x02050000
45 typedef int Py_ssize_t;
49 #include "YacsTrace.hxx"
51 using namespace YACS::ENGINE;
54 const char PythonEntry::SCRIPT_FOR_SIMPLE_SERIALIZATION[]="import pickle\n"
55 "def pickleForVarSimplePyth2009(val):\n"
56 " return pickle.dumps(val,-1)\n"
59 PyObject *PythonEntry::_pyClsBigObject = nullptr;
61 const char PythonNode::IMPL_NAME[]="Python";
62 const char PythonNode::KIND[]="Python";
64 const char PythonNode::SCRIPT_FOR_SERIALIZATION[]="import pickle\n"
65 "def pickleForDistPyth2009(kws):\n"
66 " return pickle.dumps(((),kws),-1)\n"
68 "def unPickleForDistPyth2009(st):\n"
69 " args=pickle.loads(st)\n"
72 const char PythonNode::REMOTE_NAME[]="remote";
74 const char PythonNode::DPL_INFO_NAME[]="my_dpl_localization";
76 const char PyFuncNode::SCRIPT_FOR_SERIALIZATION[]="import pickle\n"
77 "def pickleForDistPyth2009(*args,**kws):\n"
78 " return pickle.dumps((args,kws),-1)\n"
80 "def unPickleForDistPyth2009(st):\n"
81 " args=pickle.loads(st)\n"
84 static char SCRIPT_FOR_BIGOBJECT[]="import SALOME_PyNode\n"
85 "BigObjectOnDiskBase = SALOME_PyNode.BigObjectOnDiskBase\n";
87 // pickle.load concurrency issue : see https://bugs.python.org/issue12680
88 #if PY_VERSION_HEX < 0x03070000
90 static std::mutex data_mutex;
93 PythonEntry::PythonEntry():_context(0),_pyfuncSer(0),_pyfuncUnser(0),_pyfuncSimpleSer(0)
97 PythonEntry::~PythonEntry()
100 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
101 // not Py_XDECREF of _pyfuncUnser because it is returned by PyDict_GetItem -> borrowed
102 // not Py_XDECREF of _pyfuncSer because it is returned by PyDict_GetItem -> borrowed
103 Py_XDECREF(_context);
106 void PythonEntry::loadRemoteContainer(InlineNode *reqNode)
108 DEBTRACE( "---------------PythonEntry::CommonRemoteLoad function---------------" );
109 Container *container(reqNode->getContainer());
110 bool isContAlreadyStarted(false);
115 if(hasImposedResource())
116 container->start(reqNode, _imposedResource, _imposedContainer);
119 isContAlreadyStarted=container->isAlreadyStarted(reqNode);
120 if(!isContAlreadyStarted)
121 container->start(reqNode);
126 reqNode->setErrorDetails(e.what());
132 std::string what("PythonEntry::CommonRemoteLoad : a load operation requested on \"");
133 what+=reqNode->getName(); what+="\" with no container specified.";
134 reqNode->setErrorDetails(what);
135 throw Exception(what);
139 Engines::Container_var GetContainerObj(InlineNode *reqNode, bool& isStandardCont)
141 isStandardCont = false;
142 Container *container(reqNode->getContainer());
143 Engines::Container_var objContainer(Engines::Container::_nil());
145 throw YACS::Exception("No container specified !");
146 SalomeContainer *containerCast0(dynamic_cast<SalomeContainer *>(container));
147 SalomeHPContainer *containerCast1(dynamic_cast<SalomeHPContainer *>(container));
150 isStandardCont = true;
151 objContainer=containerCast0->getContainerPtr(reqNode);
153 else if(containerCast1)
155 YACS::BASES::AutoCppPtr<SalomeContainerTmpForHP> tmpCont(SalomeContainerTmpForHP::BuildFrom(containerCast1,reqNode));
156 objContainer=tmpCont->getContainerPtr(reqNode);
159 throw YACS::Exception("Unrecognized type of container ! Salome one is expected for PythonNode/PyFuncNode !");
160 if(CORBA::is_nil(objContainer))
161 throw YACS::Exception("Container corba pointer is NULL for PythonNode !");
165 Engines::Container_var PythonEntry::loadPythonAdapter(InlineNode *reqNode, bool& isInitializeRequested)
167 bool isStandardCont(true);
168 Engines::Container_var objContainer(GetContainerObj(reqNode,isStandardCont));
169 isInitializeRequested=false;
172 Engines::PyNodeBase_var dftPyScript(retrieveDftRemotePyInterpretorIfAny(objContainer));
173 if(CORBA::is_nil(dftPyScript))
175 isInitializeRequested=!isStandardCont;
176 createRemoteAdaptedPyInterpretor(objContainer);
179 assignRemotePyInterpretor(dftPyScript);
181 catch( const SALOME::SALOME_Exception& ex )
183 std::string msg="Exception on remote python node creation ";
185 msg += ex.details.text.in();
186 reqNode->setErrorDetails(msg);
187 throw Exception(msg);
189 Engines::PyNodeBase_var pynode(getRemoteInterpreterHandle());
190 if(CORBA::is_nil(pynode))
191 throw Exception("In PythonNode the ref in NULL ! ");
195 void PythonEntry::loadRemoteContext(InlineNode *reqNode, Engines::Container_ptr objContainer, bool isInitializeRequested)
197 Container *container(reqNode->getContainer());
198 Engines::PyNodeBase_var pynode(getRemoteInterpreterHandle());
201 #if PY_VERSION_HEX < 0x03070000
202 std::unique_lock<std::mutex> lock(data_mutex);
205 const char *picklizeScript(getSerializationScript());
206 PyObject *res=PyRun_String(picklizeScript,Py_file_input,_context,_context);
207 PyObject *res2(PyRun_String(SCRIPT_FOR_SIMPLE_SERIALIZATION,Py_file_input,_context,_context));
208 if(res == NULL || res2==NULL)
210 std::string errorDetails;
211 PyObject* new_stderr = newPyStdOut(errorDetails);
212 reqNode->setErrorDetails(errorDetails);
213 PySys_SetObject((char*)"stderr", new_stderr);
215 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
216 Py_DECREF(new_stderr);
217 throw Exception("Error during load");
219 Py_DECREF(res); Py_DECREF(res2);
220 AutoPyRef res3(PyRun_String(SCRIPT_FOR_BIGOBJECT,Py_file_input,_context,_context));
221 _pyfuncSer=PyDict_GetItemString(_context,"pickleForDistPyth2009");
222 _pyfuncUnser=PyDict_GetItemString(_context,"unPickleForDistPyth2009");
223 _pyfuncSimpleSer=PyDict_GetItemString(_context,"pickleForVarSimplePyth2009");
224 if(! _pyClsBigObject )
226 _pyClsBigObject=PyDict_GetItemString(_context,"BigObjectOnDiskBase");
227 Py_INCREF(_pyClsBigObject);
229 if(_pyfuncSer == NULL)
231 std::string errorDetails;
232 PyObject *new_stderr(newPyStdOut(errorDetails));
233 reqNode->setErrorDetails(errorDetails);
234 PySys_SetObject((char*)"stderr", new_stderr);
236 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
237 Py_DECREF(new_stderr);
238 throw Exception("Error during load");
240 if(_pyfuncUnser == NULL)
242 std::string errorDetails;
243 PyObject *new_stderr(newPyStdOut(errorDetails));
244 reqNode->setErrorDetails(errorDetails);
245 PySys_SetObject((char*)"stderr", new_stderr);
247 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
248 Py_DECREF(new_stderr);
249 throw Exception("Error during load");
251 if(_pyfuncSimpleSer == NULL)
253 std::string errorDetails;
254 PyObject *new_stderr(newPyStdOut(errorDetails));
255 reqNode->setErrorDetails(errorDetails);
256 PySys_SetObject((char*)"stderr", new_stderr);
258 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
259 Py_DECREF(new_stderr);
260 throw Exception("Error during load");
263 if(isInitializeRequested)
264 {//This one is called only once at initialization in the container if an init-script is specified.
267 std::string zeInitScriptKey(container->getProperty(HomogeneousPoolContainer::INITIALIZE_SCRIPT_KEY));
268 if(!zeInitScriptKey.empty())
269 pynode->executeAnotherPieceOfCode(zeInitScriptKey.c_str());
271 catch( const SALOME::SALOME_Exception& ex )
273 std::string msg="Exception on PythonNode::loadRemote python invocation of initializisation py script !";
275 msg += ex.details.text.in();
276 reqNode->setErrorDetails(msg);
277 throw Exception(msg);
279 DEBTRACE( "---------------End PyNode::loadRemote function---------------" );
283 std::string PythonEntry::GetContainerLog(const std::string& mode, Container *container, const Task *askingTask)
291 SalomeContainer *containerCast(dynamic_cast<SalomeContainer *>(container));
292 SalomeHPContainer *objContainer2(dynamic_cast<SalomeHPContainer *>(container));
295 Engines::Container_var objContainer(containerCast->getContainerPtr(askingTask));
296 CORBA::String_var logname = objContainer->logfilename();
299 std::string::size_type pos = msg.find(":");
300 msg=msg.substr(pos+1);
302 else if(objContainer2)
304 msg="Remote PythonNode is on HP Container : no log because no info of the location by definition of HP Container !";
308 msg="Not implemented yet for container log for that type of container !";
313 msg = "Container no longer reachable";
318 void PythonEntry::commonRemoteLoad(InlineNode *reqNode)
320 loadRemoteContainer(reqNode);
321 bool isInitializeRequested;
322 Engines::Container_var objContainer(loadPythonAdapter(reqNode,isInitializeRequested));
323 loadRemoteContext(reqNode,objContainer,isInitializeRequested);
326 bool PythonEntry::hasImposedResource()const
328 return !_imposedResource.empty() && !_imposedContainer.empty();
331 bool PythonEntry::IsProxy( PyObject *ob )
335 return PyObject_IsInstance( ob, _pyClsBigObject) == 1;
338 bool PythonEntry::GetDestroyStatus( PyObject *ob )
342 if( PyObject_IsInstance( ob, _pyClsBigObject) == 1 )
344 AutoPyRef unlinkOnDestructor = PyObject_GetAttrString(ob,"getDestroyStatus");
345 AutoPyRef tmp = PyObject_CallFunctionObjArgs(unlinkOnDestructor,nullptr);
346 if( PyBool_Check(tmp.get()) )
348 return tmp.get() == Py_True;
355 void PythonEntry::IfProxyDoSomething( PyObject *ob, const char *meth )
359 if( PyObject_IsInstance( ob, _pyClsBigObject) == 1 )
361 AutoPyRef unlinkOnDestructor = PyObject_GetAttrString(ob,meth);
362 AutoPyRef tmp = PyObject_CallFunctionObjArgs(unlinkOnDestructor,nullptr);
366 void PythonEntry::DoNotTouchFileIfProxy( PyObject *ob )
368 IfProxyDoSomething(ob,"doNotTouchFile");
371 void PythonEntry::UnlinkOnDestructorIfProxy( PyObject *ob )
373 IfProxyDoSomething(ob,"unlinkOnDestructor");
376 PythonNode::PythonNode(const PythonNode& other, ComposedNode *father):InlineNode(other,father),_autoSqueeze(other._autoSqueeze)
378 _pynode = Engines::PyScriptNode::_nil();
379 _implementation=IMPL_NAME;
382 _context=PyDict_New();
383 if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
386 msg << "Impossible to set builtins" << __FILE__ << ":" << __LINE__;
387 _errorDetails=msg.str();
388 throw Exception(msg.str());
393 PythonNode::PythonNode(const std::string& name):InlineNode(name)
395 _pynode = Engines::PyScriptNode::_nil();
396 _implementation=IMPL_NAME;
399 _context=PyDict_New();
400 if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
403 msg << "Impossible to set builtins" << __FILE__ << ":" << __LINE__;
404 _errorDetails=msg.str();
405 throw Exception(msg.str());
410 PythonNode::~PythonNode()
415 void PythonNode::checkBasicConsistency() const
417 DEBTRACE("checkBasicConsistency");
418 InlineNode::checkBasicConsistency();
422 res=Py_CompileString(_script.c_str(),getName().c_str(),Py_file_input);
425 std::string error="";
426 PyObject* new_stderr = newPyStdOut(error);
427 PySys_SetObject((char*)"stderr", new_stderr);
429 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
430 Py_DECREF(new_stderr);
431 throw Exception(error);
438 void PythonNode::load()
440 DEBTRACE( "---------------PyNode::load function---------------" );
441 if(_mode==PythonNode::REMOTE_NAME)
447 void PythonNode::loadLocal()
449 DEBTRACE( "---------------PyNode::loadLocal function---------------" );
453 void PythonNode::loadRemote()
455 commonRemoteLoad(this);
458 void PythonNode::execute()
460 if(_mode==PythonNode::REMOTE_NAME)
466 void PythonNode::executeRemote()
468 DEBTRACE( "++++++++++++++ PyNode::executeRemote: " << getName() << " ++++++++++++++++++++" );
470 throw Exception("PythonNode badly loaded");
472 if(dynamic_cast<HomogeneousPoolContainer *>(getContainer()))
475 loadPythonAdapter(this,dummy);
476 _pynode->assignNewCompiledCode(getScript().c_str());
478 // not managed by unique_ptr here because destructed by the order of client.
479 SenderByteImpl *serializationInputCorba = nullptr;
480 AutoPyRef serializationInput;
482 #if PY_VERSION_HEX < 0x03070000
483 std::unique_lock<std::mutex> lock(data_mutex);
486 PyObject *args(0),*ob(0);
487 //===========================================================================
488 // Get inputs in input ports, build a Python dict and pickle it
489 //===========================================================================
491 std::list<InputPort *>::iterator iter2;
493 for(iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); ++iter2)
495 InputPyPort *p=(InputPyPort *)*iter2;
497 PyDict_SetItemString(args,p->getName().c_str(),ob);
501 PyObject_Print(args,stderr,Py_PRINT_RAW);
504 serializationInput.set(PyObject_CallFunctionObjArgs(_pyfuncSer,args,nullptr));
506 //The pickled string may contain NULL characters so use PyString_AsStringAndSize
507 char *serializationInputC(nullptr);
509 if (PyBytes_AsStringAndSize(serializationInput, &serializationInputC, &len))
510 throw Exception("DistributedPythonNode problem in python pickle");
511 // no copy here. The C byte array of Python is taken as this into CORBA sequence to avoid copy
512 serializationInputCorba = new SenderByteImpl(serializationInputC,len);
515 //get the list of output argument names
516 std::list<OutputPort *>::iterator iter;
517 Engines::listofstring myseq;
518 myseq.length(getNumberOfOutputPorts());
520 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); ++iter)
522 OutputPyPort *p=(OutputPyPort *)*iter;
523 myseq[pos]=p->getName().c_str();
524 DEBTRACE( "port name: " << p->getName() );
525 DEBTRACE( "port kind: " << p->edGetType()->kind() );
526 DEBTRACE( "port pos : " << pos );
529 //===========================================================================
530 // Execute in remote Python node
531 //===========================================================================
532 DEBTRACE( "-----------------starting remote python invocation-----------------" );
533 std::unique_ptr<SALOME::SenderByteSeq> resultCorba;
536 //pass outargsname and dict serialized
537 SALOME::SenderByte_var serializationInputRef = serializationInputCorba->_this();
538 _pynode->executeFirst(serializationInputRef);
539 //serializationInput and serializationInputCorba are no more needed for server. Release it.
540 serializationInput.set(nullptr);
541 resultCorba.reset( _pynode->executeSecond(myseq) );
543 catch( const SALOME::SALOME_Exception& ex )
545 std::ostringstream msg; msg << "Exception on remote python invocation" << std::endl << ex.details.text.in() << std::endl;
546 msg << "PyScriptNode CORBA ref : ";
548 CORBA::ORB_ptr orb(getSALOMERuntime()->getOrb());
549 if(!CORBA::is_nil(orb))
551 CORBA::String_var IOR(orb->object_to_string(_pynode));
556 _errorDetails=msg.str();
557 throw Exception(msg.str());
559 catch(CORBA::COMM_FAILURE& ex)
561 std::ostringstream msg;
562 msg << "Exception on remote python invocation." << std::endl ;
563 msg << "Caught system exception COMM_FAILURE -- unable to contact the "
564 << "object." << std::endl;
565 _errorDetails=msg.str();
566 throw Exception(msg.str());
568 catch(CORBA::SystemException& ex)
570 std::ostringstream msg;
571 msg << "Exception on remote python invocation." << std::endl ;
572 msg << "Caught a CORBA::SystemException." ;
575 CORBA::TypeCode_var tc = tmp.type();
576 const char *p = tc->name();
582 _errorDetails=msg.str();
583 throw Exception(msg.str());
585 catch(CORBA::Exception& ex)
587 std::ostringstream msg;
588 msg << "Exception on remote python invocation." << std::endl ;
589 msg << "Caught CORBA::Exception. " ;
592 CORBA::TypeCode_var tc = tmp.type();
593 const char *p = tc->name();
599 _errorDetails=msg.str();
600 throw Exception(msg.str());
602 catch(omniORB::fatalException& fe)
604 std::ostringstream msg;
605 msg << "Exception on remote python invocation." << std::endl ;
606 msg << "Caught omniORB::fatalException:" << std::endl;
607 msg << " file: " << fe.file() << std::endl;
608 msg << " line: " << fe.line() << std::endl;
609 msg << " mesg: " << fe.errmsg() << std::endl;
610 _errorDetails=msg.str();
611 throw Exception(msg.str());
613 DEBTRACE( "-----------------end of remote python invocation-----------------" );
614 //===========================================================================
615 // Get results, unpickle and put them in output ports
616 //===========================================================================
618 #if PY_VERSION_HEX < 0x03070000
619 std::unique_lock<std::mutex> lock(data_mutex);
622 DEBTRACE( "-----------------PythonNode::outputs-----------------" );
623 int nres( resultCorba->length() );
625 if(getNumberOfOutputPorts() != nres)
627 std::string msg="Number of output arguments : Mismatch between definition and execution";
629 throw Exception(msg);
634 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); ++iter)
636 OutputPyPort *p=(OutputPyPort *)*iter;
637 DEBTRACE( "port name: " << p->getName() );
638 DEBTRACE( "port kind: " << p->edGetType()->kind() );
639 DEBTRACE( "port pos : " << pos );
640 SALOME::SenderByte_var elt = (*resultCorba)[pos];
641 SeqByteReceiver recv(elt);
642 unsigned long length = 0;
643 char *resultCorbaC = recv.data(length);
645 AutoPyRef resultPython=PyMemoryView_FromMemory(resultCorbaC,length,PyBUF_READ);
646 AutoPyRef args = PyTuple_New(1);
647 PyTuple_SetItem(args,0,resultPython.retn());
648 AutoPyRef ob = PyObject_CallObject(_pyfuncUnser,args);
651 std::stringstream msg;
652 msg << "Conversion with pickle of output ports failed !";
653 msg << " : " << __FILE__ << ":" << __LINE__;
654 _errorDetails=msg.str();
655 throw YACS::ENGINE::ConversionException(msg.str());
657 UnlinkOnDestructorIfProxy(ob);
663 catch(ConversionException& ex)
665 _errorDetails=ex.what();
669 squeezeMemoryRemote();
672 if(!isUsingPythonCache())
676 Engines::Container_var cont(GetContainerObj(this,dummy));
677 cont->removePyScriptNode(getName().c_str());
679 DEBTRACE( "++++++++++++++ ENDOF PyNode::executeRemote: " << getName() << " ++++++++++++++++++++" );
681 void PythonNode::executeLocalInternal(const std::string& codeStr)
684 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
685 std::ostringstream stream;
686 stream << "/tmp/PythonNode_";
688 AutoPyRef code=Py_CompileString(codeStr.c_str(), stream.str().c_str(), Py_file_input);
692 AutoPyRef new_stderr = newPyStdOut(_errorDetails);
693 PySys_SetObject((char*)"stderr", new_stderr);
695 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
696 throw Exception("Error during execution");
699 AutoPyRef res = PyEval_EvalCode( code, _context, _context);
701 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
704 if(PyErr_Occurred ())
707 AutoPyRef new_stderr = newPyStdOut(_errorDetails);
708 PySys_SetObject((char*)"stderr", new_stderr);
709 ofstream errorfile(stream.str().c_str());
710 if (errorfile.is_open())
712 errorfile << codeStr;
716 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
717 throw Exception("Error during execution");
721 void PythonNode::executeLocal()
723 DEBTRACE( "++++++++++++++ PyNode::executeLocal: " << getName() << " ++++++++++++++++++++" );
726 std::ostringstream unpxy; unpxy << "from SALOME_PyNode import UnProxyObjectSimpleLocal" << std::endl;
727 DEBTRACE( "---------------PyNode::inputs---------------" );
728 list<InputPort *>::iterator iter2;
729 for(iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); iter2++)
731 InputPyPort *p=(InputPyPort *)*iter2;
732 DEBTRACE( "port name: " << p->getName() );
733 DEBTRACE( "port kind: " << p->edGetType()->kind() );
734 PyObject* ob=p->getPyObj();
735 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
736 unpxy << p->getName() << " = UnProxyObjectSimpleLocal( " << p->getName() << " )" << std::endl;
738 PyObject_Print(ob,stderr,Py_PRINT_RAW);
741 int ier=PyDict_SetItemString(_context,p->getName().c_str(),ob);
742 DEBTRACE( "after PyDict_SetItemString:ob refcnt: " << ob->ob_refcnt );
745 DEBTRACE( "---------------End PyNode::inputs---------------" );
748 DEBTRACE( "----------------PyNode::calculation---------------" );
750 executeLocalInternal( unpxy.str() );
752 executeLocalInternal( _script );
754 DEBTRACE( "-----------------PyNode::outputs-----------------" );
755 list<OutputPort *>::iterator iter;
758 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++)
760 OutputPyPort *p=(OutputPyPort *)*iter;
761 DEBTRACE( "port name: " << p->getName() );
762 DEBTRACE( "port kind: " << p->edGetType()->kind() );
763 PyObject *ob=PyDict_GetItemString(_context,p->getName().c_str());
766 std::string msg="Error during execution: there is no variable ";
767 msg=msg+p->getName()+" in node context";
769 throw Exception(msg);
771 DEBTRACE( "PyNode::outputs::ob refcnt: " << ob->ob_refcnt );
773 PyObject_Print(ob,stderr,Py_PRINT_RAW);
779 catch(ConversionException& ex)
781 _errorDetails=ex.what();
786 DEBTRACE( "-----------------End PyNode::outputs-----------------" );
788 DEBTRACE( "++++++++++++++ End PyNode::execute: " << getName() << " ++++++++++++++++++++" );
791 void PythonNode::squeezeMemorySafe()
794 if(_mode==PythonNode::REMOTE_NAME)
795 this->squeezeMemoryRemote();
797 this->squeezeMemory();
800 void PythonNode::squeezeMemory()
802 for(auto p : _setOfInputPort)
804 PyDict_DelItemString(_context,p->getName().c_str());
805 InputPyPort *p2(static_cast<InputPyPort *>(p));
806 if(p2->canSafelySqueezeMemory())
809 for(auto p : _setOfOutputPort)
811 PyDict_DelItemString(_context,p->getName().c_str());
812 OutputPyPort *p2(static_cast<OutputPyPort *>(p));
813 p2->putWithoutForward(Py_None);
817 void PythonNode::squeezeMemoryRemote()
819 for(auto p : _setOfInputPort)
821 InputPyPort *p2(static_cast<InputPyPort *>(p));
822 if(p2->canSafelySqueezeMemory())
825 for(auto p : _setOfOutputPort)
827 OutputPyPort *p2(static_cast<OutputPyPort *>(p));
828 p2->putWithoutForward(Py_None);
832 std::string PythonNode::getContainerLog()
834 return PythonEntry::GetContainerLog(_mode,_container,this);
837 void PythonNode::shutdown(int level)
839 DEBTRACE("PythonNode::shutdown " << level);
840 if(_mode=="local")return;
844 _container->shutdown(level);
848 void PythonNode::imposeResource(const std::string& resource_name,
849 const std::string& container_name)
851 if(!resource_name.empty() && !container_name.empty())
853 _imposedResource = resource_name;
854 _imposedContainer = container_name;
858 bool PythonNode::canAcceptImposedResource()
860 return _container != nullptr && _container->canAcceptImposedResource();
863 bool PythonNode::hasImposedResource()const
865 return PythonEntry::hasImposedResource();
868 std::string PythonNode::pythonEntryName()const
870 if(isUsingPythonCache())
871 return "DEFAULT_NAME_FOR_UNIQUE_PYTHON_NODE_ENTRY";
876 bool PythonNode::isUsingPythonCache()const
880 found = _container->isUsingPythonCache();
884 void PythonNode::freeKernelPynode()
886 if(!CORBA::is_nil(_pynode))
890 _pynode->UnRegister();
894 DEBTRACE("Trouble when pynode->UnRegister!")
896 _pynode = Engines::PyScriptNode::_nil();
900 Node *PythonNode::simpleClone(ComposedNode *father, bool editionOnly) const
902 return new PythonNode(*this,father);
905 void PythonNode::createRemoteAdaptedPyInterpretor(Engines::Container_ptr objContainer)
908 _pynode=objContainer->createPyScriptNode(pythonEntryName().c_str(),getScript().c_str());
912 Engines::PyNodeBase_var PythonNode::retrieveDftRemotePyInterpretorIfAny(Engines::Container_ptr objContainer) const
914 Engines::PyScriptNode_var ret(objContainer->getDefaultPyScriptNode(pythonEntryName().c_str()));
915 if(!CORBA::is_nil(ret))
919 return Engines::PyNodeBase::_narrow(ret);
922 void PythonNode::assignRemotePyInterpretor(Engines::PyNodeBase_var remoteInterp)
924 if(CORBA::is_nil(_pynode))
925 _pynode=Engines::PyScriptNode::_narrow(remoteInterp);
928 Engines::PyScriptNode_var tmpp(Engines::PyScriptNode::_narrow(remoteInterp));
929 if(!_pynode->_is_equivalent(tmpp))
932 _pynode=Engines::PyScriptNode::_narrow(remoteInterp);
935 _pynode->assignNewCompiledCode(getScript().c_str());
938 Engines::PyNodeBase_var PythonNode::getRemoteInterpreterHandle()
940 return Engines::PyNodeBase::_narrow(_pynode);
943 //! Create a new node of same type with a given name
944 PythonNode* PythonNode::cloneNode(const std::string& name)
946 PythonNode* n=new PythonNode(name);
947 n->setScript(_script);
948 list<InputPort *>::iterator iter;
949 for(iter = _setOfInputPort.begin(); iter != _setOfInputPort.end(); iter++)
951 InputPyPort *p=(InputPyPort *)*iter;
952 DEBTRACE( "port name: " << p->getName() );
953 DEBTRACE( "port kind: " << p->edGetType()->kind() );
954 n->edAddInputPort(p->getName(),p->edGetType());
956 list<OutputPort *>::iterator iter2;
957 for(iter2 = _setOfOutputPort.begin(); iter2 != _setOfOutputPort.end(); iter2++)
959 OutputPyPort *p=(OutputPyPort *)*iter2;
960 DEBTRACE( "port name: " << p->getName() );
961 DEBTRACE( "port kind: " << p->edGetType()->kind() );
962 n->edAddOutputPort(p->getName(),p->edGetType());
967 void PythonNode::applyDPLScope(ComposedNode *gfn)
969 std::vector< std::pair<std::string,int> > ret(getDPLScopeInfo(gfn));
976 std::size_t sz(ret.size());
978 for(std::size_t i=0;i<sz;i++)
980 const std::pair<std::string,int>& p(ret[i]);
981 PyObject *elt(PyTuple_New(2));
982 PyTuple_SetItem(elt,0,PyUnicode_FromString(p.first.c_str()));
983 PyTuple_SetItem(elt,1,PyLong_FromLong(p.second));
984 PyList_SetItem(ob,i,elt);
987 if(_mode==REMOTE_NAME)
989 Engines::pickledArgs_var serializationInputCorba(new Engines::pickledArgs);
992 PyObject *serializationInput(PyObject_CallFunctionObjArgs(_pyfuncSimpleSer,ob,NULL));
994 char *serializationInputC(0);
996 if (PyBytes_AsStringAndSize(serializationInput, &serializationInputC, &len))
997 throw Exception("DistributedPythonNode problem in python pickle");
998 serializationInputCorba->length(len);
999 for(int i=0; i < len ; i++)
1000 serializationInputCorba[i]=serializationInputC[i];
1001 Py_XDECREF(serializationInput);
1003 _pynode->defineNewCustomVar(DPL_INFO_NAME,serializationInputCorba);
1008 PyDict_SetItemString(_context,DPL_INFO_NAME,ob);
1013 PyFuncNode::PyFuncNode(const PyFuncNode& other, ComposedNode *father):InlineFuncNode(other,father),_pyfunc(0)
1015 _implementation = PythonNode::IMPL_NAME;
1018 _context=PyDict_New();
1019 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
1020 if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
1023 msg << "Not possible to set builtins" << __FILE__ << ":" << __LINE__;
1024 _errorDetails=msg.str();
1025 throw Exception(msg.str());
1030 PyFuncNode::PyFuncNode(const std::string& name): InlineFuncNode(name),_pyfunc(0)
1033 _implementation = PythonNode::IMPL_NAME;
1034 DEBTRACE( "PyFuncNode::PyFuncNode " << name );
1037 _context=PyDict_New();
1038 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
1039 if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
1042 msg << "Not possible to set builtins" << __FILE__ << ":" << __LINE__;
1043 _errorDetails=msg.str();
1044 throw Exception(msg.str());
1049 PyFuncNode::~PyFuncNode()
1051 if(!CORBA::is_nil(_pynode))
1053 _pynode->UnRegister();
1057 void PyFuncNode::init(bool start)
1059 initCommonPartWithoutStateManagement(start);
1060 if(_state == YACS::DISABLED)
1062 exDisabledState(); // to refresh propagation of DISABLED state
1065 if(start) //complete initialization
1066 setState(YACS::READY);
1067 else if(_state > YACS::LOADED)// WARNING FuncNode has internal vars (CEA usecase) ! Partial initialization (inside a loop). Exclusivity of funcNode.
1068 setState(YACS::TORECONNECT);
1071 void PyFuncNode::checkBasicConsistency() const
1073 DEBTRACE("checkBasicConsistency");
1074 InlineFuncNode::checkBasicConsistency();
1078 res=Py_CompileString(_script.c_str(),getName().c_str(),Py_file_input);
1081 std::string error="";
1082 PyObject* new_stderr = newPyStdOut(error);
1083 PySys_SetObject((char*)"stderr", new_stderr);
1085 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
1086 Py_DECREF(new_stderr);
1087 throw Exception(error);
1094 void PyFuncNode::load()
1096 DEBTRACE( "---------------PyfuncNode::load function---------------" );
1097 if(_mode==PythonNode::REMOTE_NAME)
1103 void PyFuncNode::loadRemote()
1105 commonRemoteLoad(this);
1108 void PyFuncNode::loadLocal()
1110 DEBTRACE( "---------------PyFuncNode::load function " << getName() << " ---------------" );
1111 DEBTRACE( _script );
1114 list<OutputPort *>::iterator iter;
1115 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++)
1117 OutputPyPort *p=(OutputPyPort *)*iter;
1118 DEBTRACE( "port name: " << p->getName() );
1119 DEBTRACE( "port kind: " << p->edGetType()->kind() );
1125 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
1127 std::ostringstream stream;
1128 stream << "/tmp/PythonNode_";
1131 PyObject* code=Py_CompileString(_script.c_str(), stream.str().c_str(), Py_file_input);
1135 PyObject* new_stderr = newPyStdOut(_errorDetails);
1136 PySys_SetObject((char*)"stderr", new_stderr);
1138 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
1139 Py_DECREF(new_stderr);
1140 throw Exception("Error during execution");
1142 PyObject *res = PyEval_EvalCode( code, _context, _context);
1146 DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
1147 if(PyErr_Occurred ())
1150 PyObject* new_stderr = newPyStdOut(_errorDetails);
1151 PySys_SetObject((char*)"stderr", new_stderr);
1152 ofstream errorfile(stream.str().c_str());
1153 if (errorfile.is_open())
1155 errorfile << _script;
1159 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
1160 Py_DECREF(new_stderr);
1161 throw Exception("Error during execution");
1164 _pyfunc=PyDict_GetItemString(_context,_fname.c_str());
1165 DEBTRACE( "_pyfunc refcnt: " << _pyfunc->ob_refcnt );
1169 PyObject* new_stderr = newPyStdOut(_errorDetails);
1170 PySys_SetObject((char*)"stderr", new_stderr);
1172 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
1173 Py_DECREF(new_stderr);
1174 throw Exception("Error during execution");
1176 DEBTRACE( "---------------End PyFuncNode::load function---------------" );
1180 void PyFuncNode::execute()
1182 if(_mode==PythonNode::REMOTE_NAME)
1188 void PyFuncNode::executeRemote()
1190 DEBTRACE( "++++++++++++++ PyFuncNode::executeRemote: " << getName() << " ++++++++++++++++++++" );
1192 throw Exception("DistributedPythonNode badly loaded");
1194 if(dynamic_cast<HomogeneousPoolContainer *>(getContainer()))
1197 loadPythonAdapter(this,dummy);
1198 _pynode->executeAnotherPieceOfCode(getScript().c_str());
1201 Engines::pickledArgs_var serializationInputCorba(new Engines::pickledArgs);;
1203 #if PY_VERSION_HEX < 0x03070000
1204 std::unique_lock<std::mutex> lock(data_mutex);
1208 //===========================================================================
1209 // Get inputs in input ports, build a Python tuple and pickle it
1210 //===========================================================================
1211 PyObject *args(PyTuple_New(getNumberOfInputPorts()));
1213 for(std::list<InputPort *>::iterator iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); iter2++,pos++)
1215 InputPyPort *p=(InputPyPort *)*iter2;
1218 PyTuple_SetItem(args,pos,ob);
1221 PyObject_Print(args,stderr,Py_PRINT_RAW);
1224 PyObject *serializationInput=PyObject_CallObject(_pyfuncSer,args);
1226 //The pickled string may contain NULL characters so use PyString_AsStringAndSize
1227 char *serializationInputC(0);
1229 if (PyBytes_AsStringAndSize(serializationInput, &serializationInputC, &len))
1230 throw Exception("DistributedPythonNode problem in python pickle");
1232 serializationInputCorba->length(len);
1233 for(int i=0; i < len ; i++)
1234 serializationInputCorba[i]=serializationInputC[i];
1235 Py_DECREF(serializationInput);
1238 //===========================================================================
1239 // Execute in remote Python node
1240 //===========================================================================
1241 DEBTRACE( "-----------------starting remote python invocation-----------------" );
1242 Engines::pickledArgs_var resultCorba;
1245 resultCorba=_pynode->execute(getFname().c_str(),serializationInputCorba);
1247 catch( const SALOME::SALOME_Exception& ex )
1249 std::string msg="Exception on remote python invocation";
1251 msg += ex.details.text.in();
1253 throw Exception(msg);
1255 catch(CORBA::COMM_FAILURE& ex)
1257 std::ostringstream msg;
1258 msg << "Exception on remote python invocation." << std::endl ;
1259 msg << "Caught system exception COMM_FAILURE -- unable to contact the "
1260 << "object." << std::endl;
1261 _errorDetails=msg.str();
1262 throw Exception(msg.str());
1264 catch(CORBA::SystemException& ex)
1266 std::ostringstream msg;
1267 msg << "Exception on remote python invocation." << std::endl ;
1268 msg << "Caught a CORBA::SystemException." ;
1271 CORBA::TypeCode_var tc = tmp.type();
1272 const char *p = tc->name();
1278 _errorDetails=msg.str();
1279 throw Exception(msg.str());
1281 catch(CORBA::Exception& ex)
1283 std::ostringstream msg;
1284 msg << "Exception on remote python invocation." << std::endl ;
1285 msg << "Caught CORBA::Exception. " ;
1288 CORBA::TypeCode_var tc = tmp.type();
1289 const char *p = tc->name();
1295 _errorDetails=msg.str();
1296 throw Exception(msg.str());
1298 catch(omniORB::fatalException& fe)
1300 std::ostringstream msg;
1301 msg << "Exception on remote python invocation." << std::endl ;
1302 msg << "Caught omniORB::fatalException:" << std::endl;
1303 msg << " file: " << fe.file() << std::endl;
1304 msg << " line: " << fe.line() << std::endl;
1305 msg << " mesg: " << fe.errmsg() << std::endl;
1306 _errorDetails=msg.str();
1307 throw Exception(msg.str());
1309 DEBTRACE( "-----------------end of remote python invocation-----------------" );
1310 //===========================================================================
1311 // Get results, unpickle and put them in output ports
1312 //===========================================================================
1313 char *resultCorbaC=new char[resultCorba->length()+1];
1314 resultCorbaC[resultCorba->length()]='\0';
1315 for(int i=0;i<resultCorba->length();i++)
1316 resultCorbaC[i]=resultCorba[i];
1319 #if PY_VERSION_HEX < 0x03070000
1320 std::unique_lock<std::mutex> lock(data_mutex);
1324 PyObject *resultPython(PyBytes_FromStringAndSize(resultCorbaC,resultCorba->length()));
1325 delete [] resultCorbaC;
1326 PyObject *args(PyTuple_New(1)),*ob(0);
1327 PyTuple_SetItem(args,0,resultPython);
1328 PyObject *finalResult=PyObject_CallObject(_pyfuncUnser,args);
1331 DEBTRACE( "-----------------PythonNode::outputs-----------------" );
1333 if(finalResult == Py_None)
1335 else if(PyTuple_Check(finalResult))
1336 nres=PyTuple_Size(finalResult);
1338 if(getNumberOfOutputPorts() != nres)
1340 std::string msg="Number of output arguments : Mismatch between definition and execution";
1341 Py_DECREF(finalResult);
1343 throw Exception(msg);
1349 for(std::list<OutputPort *>::iterator iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++, pos++)
1351 OutputPyPort *p=(OutputPyPort *)*iter;
1352 DEBTRACE( "port name: " << p->getName() );
1353 DEBTRACE( "port kind: " << p->edGetType()->kind() );
1354 DEBTRACE( "port pos : " << pos );
1355 if(PyTuple_Check(finalResult))
1356 ob=PyTuple_GetItem(finalResult,pos) ;
1359 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
1362 Py_DECREF(finalResult);
1364 catch(ConversionException& ex)
1366 Py_DECREF(finalResult);
1367 _errorDetails=ex.what();
1372 DEBTRACE( "++++++++++++++ ENDOF PyFuncNode::executeRemote: " << getName() << " ++++++++++++++++++++" );
1375 void PyFuncNode::executeLocal()
1377 DEBTRACE( "++++++++++++++ PyFuncNode::execute: " << getName() << " ++++++++++++++++++++" );
1381 if(!_pyfunc)throw Exception("PyFuncNode badly loaded");
1384 DEBTRACE( "---------------PyFuncNode::inputs---------------" );
1385 PyObject* args = PyTuple_New(getNumberOfInputPorts()) ;
1386 list<InputPort *>::iterator iter2;
1387 for(iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); iter2++)
1389 InputPyPort *p=(InputPyPort *)*iter2;
1390 DEBTRACE( "port name: " << p->getName() );
1391 DEBTRACE( "port kind: " << p->edGetType()->kind() );
1394 PyObject_Print(ob,stderr,Py_PRINT_RAW);
1397 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
1399 PyTuple_SetItem(args,pos,ob);
1400 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
1403 DEBTRACE( "---------------End PyFuncNode::inputs---------------" );
1405 DEBTRACE( "----------------PyFuncNode::calculation---------------" );
1407 PyObject_Print(_pyfunc,stderr,Py_PRINT_RAW);
1409 PyObject_Print(args,stderr,Py_PRINT_RAW);
1412 DEBTRACE( "_pyfunc refcnt: " << _pyfunc->ob_refcnt );
1413 PyObject* result = PyObject_CallObject( _pyfunc , args ) ;
1414 DEBTRACE( "_pyfunc refcnt: " << _pyfunc->ob_refcnt );
1421 PyObject* new_stderr = newPyStdOut(_errorDetails);
1422 PySys_SetObject((char*)"stderr", new_stderr);
1423 std::ostringstream stream;
1424 stream << "/tmp/PythonNode_";
1426 ofstream errorfile(stream.str().c_str());
1427 if (errorfile.is_open())
1429 errorfile << _script;
1433 PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
1434 Py_DECREF(new_stderr);
1435 throw Exception("Error during execution");
1437 DEBTRACE( "----------------End PyFuncNode::calculation---------------" );
1439 DEBTRACE( "-----------------PyFuncNode::outputs-----------------" );
1441 if(result == Py_None)
1443 else if(PyTuple_Check(result))
1444 nres=PyTuple_Size(result);
1446 if(getNumberOfOutputPorts() != nres)
1448 std::string msg="Number of output arguments : Mismatch between definition and execution";
1451 throw Exception(msg);
1456 PyObject_Print(result,stderr,Py_PRINT_RAW);
1459 list<OutputPort *>::iterator iter;
1462 for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++)
1464 OutputPyPort *p=(OutputPyPort *)*iter;
1465 DEBTRACE( "port name: " << p->getName() );
1466 DEBTRACE( "port kind: " << p->edGetType()->kind() );
1467 DEBTRACE( "port pos : " << pos );
1468 if(PyTuple_Check(result))ob=PyTuple_GetItem(result,pos) ;
1470 DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
1472 PyObject_Print(ob,stderr,Py_PRINT_RAW);
1479 catch(ConversionException& ex)
1482 _errorDetails=ex.what();
1485 DEBTRACE( "-----------------End PyFuncNode::outputs-----------------" );
1488 DEBTRACE( "++++++++++++++ End PyFuncNode::execute: " << getName() << " ++++++++++++++++++++" );
1491 Node *PyFuncNode::simpleClone(ComposedNode *father, bool editionOnly) const
1493 return new PyFuncNode(*this,father);
1496 void PyFuncNode::createRemoteAdaptedPyInterpretor(Engines::Container_ptr objContainer)
1498 if(!CORBA::is_nil(_pynode))
1499 _pynode->UnRegister();
1500 _pynode=objContainer->createPyNode(getName().c_str(),getScript().c_str());
1503 Engines::PyNodeBase_var PyFuncNode::retrieveDftRemotePyInterpretorIfAny(Engines::Container_ptr objContainer) const
1505 Engines::PyNode_var ret(objContainer->getDefaultPyNode(getName().c_str()));
1506 if(!CORBA::is_nil(ret))
1510 return Engines::PyNodeBase::_narrow(ret);
1513 void PyFuncNode::assignRemotePyInterpretor(Engines::PyNodeBase_var remoteInterp)
1515 if(!CORBA::is_nil(_pynode))
1517 Engines::PyNode_var tmpp(Engines::PyNode::_narrow(remoteInterp));
1518 if(_pynode->_is_equivalent(tmpp))
1521 if(!CORBA::is_nil(_pynode))
1522 _pynode->UnRegister();
1523 _pynode=Engines::PyNode::_narrow(remoteInterp);
1526 Engines::PyNodeBase_var PyFuncNode::getRemoteInterpreterHandle()
1528 return Engines::PyNodeBase::_narrow(_pynode);
1531 //! Create a new node of same type with a given name
1532 PyFuncNode* PyFuncNode::cloneNode(const std::string& name)
1534 PyFuncNode* n=new PyFuncNode(name);
1535 n->setScript(_script);
1536 n->setFname(_fname);
1537 list<InputPort *>::iterator iter;
1538 for(iter = _setOfInputPort.begin(); iter != _setOfInputPort.end(); iter++)
1540 InputPyPort *p=(InputPyPort *)*iter;
1541 n->edAddInputPort(p->getName(),p->edGetType());
1543 list<OutputPort *>::iterator iter2;
1544 for(iter2 = _setOfOutputPort.begin(); iter2 != _setOfOutputPort.end(); iter2++)
1546 OutputPyPort *p=(OutputPyPort *)*iter2;
1547 n->edAddOutputPort(p->getName(),p->edGetType());
1552 std::string PyFuncNode::getContainerLog()
1554 return PythonEntry::GetContainerLog(_mode,_container,this);
1557 void PyFuncNode::shutdown(int level)
1559 DEBTRACE("PyFuncNode::shutdown " << level);
1560 if(_mode=="local")return;
1563 if(!CORBA::is_nil(_pynode)) _pynode->UnRegister();
1564 _pynode=Engines::PyNode::_nil();
1565 _container->shutdown(level);
1569 void PyFuncNode::imposeResource(const std::string& resource_name,
1570 const std::string& container_name)
1572 if(!resource_name.empty() && !container_name.empty())
1574 _imposedResource = resource_name;
1575 _imposedContainer = container_name;
1579 bool PyFuncNode::canAcceptImposedResource()
1581 return _container != nullptr && _container->canAcceptImposedResource();
1584 bool PyFuncNode::hasImposedResource()const
1586 return PythonEntry::hasImposedResource();