#include <PythonNode.hxx>

Inheritance diagram for YACS::ENGINE::PythonEntry:

Collaboration diagram for YACS::ENGINE::PythonEntry:

[legend]

Static Public Member Functions
static bool	IsProxy (PyObject *ob)

static bool	GetDestroyStatus (PyObject *ob)

static void	DoNotTouchFileIfProxy (PyObject *ob)

static void	UnlinkOnDestructorIfProxy (PyObject *ob)

static void	IfProxyDoSomething (PyObject ob, const char meth)

Static Public Attributes
static const char	SCRIPT_FOR_SIMPLE_SERIALIZATION []

Protected Member Functions
	PythonEntry ()

	~PythonEntry ()

virtual void	assignRemotePyInterpretor (Engines::PyNodeBase_var remoteInterp)=0

virtual Engines::PyNodeBase_var	retrieveDftRemotePyInterpretorIfAny (Engines::Container_ptr objContainer) const =0
	returns (if any) an object, you have to deal with (UnRegister) More...

virtual void	createRemoteAdaptedPyInterpretor (Engines::Container_ptr objContainer)=0
	returns an object, you have to deal with (UnRegister) More...

virtual Engines::PyNodeBase_var	getRemoteInterpreterHandle ()=0

virtual const char *	getSerializationScript () const =0

void	commonRemoteLoad (InlineNode *reqNode)

void	loadRemoteContainer (InlineNode *reqNode)

Engines::Container_var	loadPythonAdapter (InlineNode *reqNode, bool &isInitializeRequested)

void	loadRemoteContext (InlineNode *reqNode, Engines::Container_ptr objContainer, bool isInitializeRequested)

virtual bool	hasImposedResource () const

Static Protected Member Functions
static std::string	GetContainerLog (const std::string &mode, Container container, const Task askingTask)

Protected Attributes
PyObject *	_context

PyObject *	_pyfuncSer

PyObject *	_pyfuncUnser

PyObject *	_pyfuncSimpleSer

std::string	_imposedResource

std::string	_imposedContainer

Static Protected Attributes
static PyObject *	_pyClsBigObject = nullptr

Detailed Description

Definition at line 37 of file PythonNode.hxx.

Constructor & Destructor Documentation

◆ PythonEntry()

PythonEntry::PythonEntry ( )

protected

Definition at line 93 of file PythonNode.cxx.

                        :_context(0),_pyfuncSer(0),_pyfuncUnser(0),_pyfuncSimpleSer(0)
{
}

◆ ~PythonEntry()

PythonEntry::~PythonEntry ( )

protected

Definition at line 97 of file PythonNode.cxx.

{
  AutoGIL agil;
  DEBTRACE( "_context refcnt: " << _context->ob_refcnt );
  // not Py_XDECREF of _pyfuncUnser because it is returned by PyDict_GetItem -> borrowed
  // not Py_XDECREF of _pyfuncSer because it is returned by PyDict_GetItem -> borrowed
  Py_XDECREF(_context);
}

References _context, and DEBTRACE.

Member Function Documentation

◆ assignRemotePyInterpretor()

virtual void YACS::ENGINE::PythonEntry::assignRemotePyInterpretor ( Engines::PyNodeBase_var remoteInterp )

protectedpure virtual

Implemented in YACS::ENGINE::PythonNode, and YACS::ENGINE::PyFuncNode.

Referenced by loadPythonAdapter().

◆ commonRemoteLoad()

void PythonEntry::commonRemoteLoad ( InlineNode * reqNode )

protected

Definition at line 318 of file PythonNode.cxx.

{
  loadRemoteContainer(reqNode);
  bool isInitializeRequested;
  Engines::Container_var objContainer(loadPythonAdapter(reqNode,isInitializeRequested));
  loadRemoteContext(reqNode,objContainer,isInitializeRequested);
}

References loadPythonAdapter(), loadRemoteContainer(), and loadRemoteContext().

Referenced by YACS::ENGINE::PythonNode::loadRemote(), and YACS::ENGINE::PyFuncNode::loadRemote().

◆ createRemoteAdaptedPyInterpretor()

virtual void YACS::ENGINE::PythonEntry::createRemoteAdaptedPyInterpretor ( Engines::Container_ptr objContainer )

protectedpure virtual

returns an object, you have to deal with (UnRegister)

Implemented in YACS::ENGINE::PythonNode, and YACS::ENGINE::PyFuncNode.

Referenced by loadPythonAdapter().

◆ DoNotTouchFileIfProxy()

void PythonEntry::DoNotTouchFileIfProxy ( PyObject * ob )

static

Definition at line 408 of file PythonNode.cxx.

{
  IfProxyDoSomething(ob,"doNotTouchFile");
}

References IfProxyDoSomething().

Referenced by YACS::ENGINE::convertToYacsObjref< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert().

◆ GetContainerLog()

std::string PythonEntry::GetContainerLog	(	const std::string &	mode,
		Container *	container,
		const Task *	askingTask
	)

staticprotected

Definition at line 283 of file PythonNode.cxx.

{
  if(mode=="local")
    return "";
 
  std::string msg;
  try
  {
      SalomeContainer *containerCast(dynamic_cast<SalomeContainer *>(container));
      SalomeHPContainer *objContainer2(dynamic_cast<SalomeHPContainer *>(container));
      if(containerCast)
        {
          Engines::Container_var objContainer(containerCast->getContainerPtr(askingTask));
          CORBA::String_var logname = objContainer->logfilename();
          DEBTRACE(logname);
          msg=logname;
          std::string::size_type pos = msg.find(":");
          msg=msg.substr(pos+1);
        }
      else if(objContainer2)
        {
          msg="Remote PythonNode is on HP Container : no log because no info of the location by definition of HP Container !";
        }
      else
        {
          msg="Not implemented yet for container log for that type of container !";
        }
  }
  catch(...)
  {
      msg = "Container no longer reachable";
  }
  return msg;
}

References DEBTRACE, and YACS::ENGINE::SalomeContainer::getContainerPtr().

Referenced by YACS::ENGINE::PythonNode::getContainerLog(), and YACS::ENGINE::PyFuncNode::getContainerLog().

◆ GetDestroyStatus()

bool PythonEntry::GetDestroyStatus ( PyObject * ob )

static

return true only if ob is a proxy and destroy flag set to true

Definition at line 355 of file PythonNode.cxx.

{
  if(!_pyClsBigObject)
    return false;
  if( PyObject_IsInstance( ob, _pyClsBigObject) == 1 )
  {
    AutoPyRef unlinkOnDestructor = PyObject_GetAttrString(ob,"getDestroyStatus");
    AutoPyRef tmp = PyObject_CallFunctionObjArgs(unlinkOnDestructor,nullptr);
    if( PyBool_Check(tmp.get()) )
    {
      return tmp.get() == Py_True;
    }
    return false;
  }
  else
  {
    if( PyList_Check( ob ) )
    {
      auto sz = PyList_Size( ob );
      for( auto i = 0 ; i < sz ; ++i )
      {
        PyObject *elt = PyList_GetItem( ob, i );
        if( PythonEntry::GetDestroyStatus(elt) )
          return true;
      }
    }
  }
  return false;
}

References _pyClsBigObject, GetDestroyStatus(), and yacsorb.CORBAEngineTest::i.

Referenced by YACS::ENGINE::convertToYacsObjref< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), and GetDestroyStatus().

◆ getRemoteInterpreterHandle()

virtual Engines::PyNodeBase_var YACS::ENGINE::PythonEntry::getRemoteInterpreterHandle ( )

protectedpure virtual

Implemented in YACS::ENGINE::PythonNode, and YACS::ENGINE::PyFuncNode.

Referenced by loadPythonAdapter(), and loadRemoteContext().

◆ getSerializationScript()

virtual const char * YACS::ENGINE::PythonEntry::getSerializationScript ( ) const

protectedpure virtual

Implemented in YACS::ENGINE::PythonNode, and YACS::ENGINE::PyFuncNode.

Referenced by loadRemoteContext().

◆ hasImposedResource()

bool PythonEntry::hasImposedResource ( ) const

protectedvirtual

Reimplemented in YACS::ENGINE::PythonNode, and YACS::ENGINE::PyFuncNode.

Definition at line 326 of file PythonNode.cxx.

{
  return !_imposedResource.empty() && !_imposedContainer.empty();
}

References _imposedContainer, and _imposedResource.

Referenced by YACS::ENGINE::PythonNode::hasImposedResource(), YACS::ENGINE::PyFuncNode::hasImposedResource(), and loadRemoteContainer().

◆ IfProxyDoSomething()

void PythonEntry::IfProxyDoSomething	(	PyObject *	ob,
		const char *	meth
	)

static

Definition at line 385 of file PythonNode.cxx.

{
  if(!_pyClsBigObject)
    return ;
  if( PyObject_IsInstance( ob, _pyClsBigObject) == 1 )
  {
    AutoPyRef unlinkOnDestructor = PyObject_GetAttrString(ob,meth);
    AutoPyRef tmp = PyObject_CallFunctionObjArgs(unlinkOnDestructor,nullptr);
  }
  else
  {
    if( PyList_Check( ob ) )
    {
      auto sz = PyList_Size( ob );
      for( auto i = 0 ; i < sz ; ++i )
      {
        PyObject *elt = PyList_GetItem( ob, i );
        PythonEntry::IfProxyDoSomething( elt, meth );
      }
    }
  }
}

References _pyClsBigObject, yacsorb.CORBAEngineTest::i, and IfProxyDoSomething().

Referenced by YACS::ENGINE::convertToYacsObjref< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertToYacsSequence< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), DoNotTouchFileIfProxy(), IfProxyDoSomething(), and UnlinkOnDestructorIfProxy().

◆ IsProxy()

bool PythonEntry::IsProxy ( PyObject * ob )

static

Definition at line 331 of file PythonNode.cxx.

{
  if(!_pyClsBigObject)
    return false;
  if( PyObject_IsInstance( ob, _pyClsBigObject) == 1 )
  {
    return true;
  }
  else
  {
    if( PyList_Check( ob ) )
    {
      auto sz = PyList_Size( ob );
      for( auto i = 0 ; i < sz ; ++i )
      {
        PyObject *elt = PyList_GetItem( ob, i );
        if( PythonEntry::IsProxy(elt) )
          return true;
      }
    }
  }
  return false;
}

References _pyClsBigObject, yacsorb.CORBAEngineTest::i, and IsProxy().

Referenced by YACS::ENGINE::convertToYacsSequence< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertFromYacsObjref< PYTHONImpl, PyObject * >::convert(), and IsProxy().

◆ loadPythonAdapter()

Engines::Container_var PythonEntry::loadPythonAdapter	(	InlineNode *	reqNode,
		bool &	isInitializeRequested
	)

protected

Definition at line 165 of file PythonNode.cxx.

{
  bool isStandardCont(true);
  Engines::Container_var objContainer(GetContainerObj(reqNode,isStandardCont));
  isInitializeRequested=false;
  try
  {
    Engines::PyNodeBase_var dftPyScript(retrieveDftRemotePyInterpretorIfAny(objContainer));
    if(CORBA::is_nil(dftPyScript))
    {
      isInitializeRequested=!isStandardCont;
      createRemoteAdaptedPyInterpretor(objContainer);
    }
    else
      assignRemotePyInterpretor(dftPyScript);
  }
  catch( const SALOME::SALOME_Exception& ex )
  {
      std::string msg="Exception on remote python node creation ";
      msg += '\n';
      msg += ex.details.text.in();
      reqNode->setErrorDetails(msg);
      throw Exception(msg);
  }
  Engines::PyNodeBase_var pynode(getRemoteInterpreterHandle());
  if(CORBA::is_nil(pynode))
    throw Exception("In PythonNode the ref in NULL ! ");
  return objContainer;
}

References assignRemotePyInterpretor(), createRemoteAdaptedPyInterpretor(), testCppPluginInvokation::ex, GetContainerObj(), getRemoteInterpreterHandle(), retrieveDftRemotePyInterpretorIfAny(), and YACS::ENGINE::Node::setErrorDetails().

Referenced by commonRemoteLoad(), YACS::ENGINE::PythonNode::executeRemote(), and YACS::ENGINE::PyFuncNode::executeRemote().

◆ loadRemoteContainer()

void PythonEntry::loadRemoteContainer ( InlineNode * reqNode )

protected

Definition at line 106 of file PythonNode.cxx.

{
  DEBTRACE( "---------------PythonEntry::CommonRemoteLoad function---------------" );
  Container *container(reqNode->getContainer());
  bool isContAlreadyStarted(false);
  if(container)
    {
      try
      {
        if(hasImposedResource())
          container->start(reqNode, _imposedResource, _imposedContainer);
        else
        {
          isContAlreadyStarted=container->isAlreadyStarted(reqNode);
          if(!isContAlreadyStarted)
            container->start(reqNode);
        }
      }
      catch(Exception& e)
      {
          reqNode->setErrorDetails(e.what());
          throw e;
      }
    }
  else
    {
      std::string what("PythonEntry::CommonRemoteLoad : a load operation requested on \"");
      what+=reqNode->getName(); what+="\" with no container specified.";
      reqNode->setErrorDetails(what);
      throw Exception(what);
    }
}

References _imposedContainer, _imposedResource, DEBTRACE, YACS::ENGINE::InlineNode::getContainer(), YACS::ENGINE::Node::getName(), hasImposedResource(), YACS::ENGINE::Container::isAlreadyStarted(), YACS::ENGINE::Node::setErrorDetails(), YACS::ENGINE::Container::start(), and YACS::Exception::what().

Referenced by commonRemoteLoad().

◆ loadRemoteContext()

void PythonEntry::loadRemoteContext	(	InlineNode *	reqNode,
		Engines::Container_ptr	objContainer,
		bool	isInitializeRequested
	)

protected

Definition at line 195 of file PythonNode.cxx.

{
  Container *container(reqNode->getContainer());
  Engines::PyNodeBase_var pynode(getRemoteInterpreterHandle());
  {
#if PY_VERSION_HEX < 0x03070000
    std::unique_lock<std::mutex> lock(data_mutex);
#endif
    AutoGIL agil;
    const char *picklizeScript(getSerializationScript());
    PyObject *res=PyRun_String(picklizeScript,Py_file_input,_context,_context);
    PyObject *res2(PyRun_String(SCRIPT_FOR_SIMPLE_SERIALIZATION,Py_file_input,_context,_context));
    if(res == NULL || res2==NULL)
      {
        std::string errorDetails;
        PyObject* new_stderr = newPyStdOut(errorDetails);
        reqNode->setErrorDetails(errorDetails);
        PySys_SetObject((char*)"stderr", new_stderr);
        PyErr_Print();
        PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
        Py_DECREF(new_stderr);
        throw Exception("Error during load");
      }
    Py_DECREF(res); Py_DECREF(res2);
    AutoPyRef res3(PyRun_String(SCRIPT_FOR_BIGOBJECT,Py_file_input,_context,_context));
    _pyfuncSer=PyDict_GetItemString(_context,"pickleForDistPyth2009");
    _pyfuncUnser=PyDict_GetItemString(_context,"unPickleForDistPyth2009");
    _pyfuncSimpleSer=PyDict_GetItemString(_context,"pickleForVarSimplePyth2009");
    if(! _pyClsBigObject )
    {
      _pyClsBigObject=PyDict_GetItemString(_context,"BigObjectOnDiskBase");
      Py_INCREF(_pyClsBigObject);
    }
    if(_pyfuncSer == NULL)
      {
        std::string errorDetails;
        PyObject *new_stderr(newPyStdOut(errorDetails));
        reqNode->setErrorDetails(errorDetails);
        PySys_SetObject((char*)"stderr", new_stderr);
        PyErr_Print();
        PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
        Py_DECREF(new_stderr);
        throw Exception("Error during load");
      }
    if(_pyfuncUnser == NULL)
      {
        std::string errorDetails;
        PyObject *new_stderr(newPyStdOut(errorDetails));
        reqNode->setErrorDetails(errorDetails);
        PySys_SetObject((char*)"stderr", new_stderr);
        PyErr_Print();
        PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
        Py_DECREF(new_stderr);
        throw Exception("Error during load");
      }
    if(_pyfuncSimpleSer == NULL)
      {
        std::string errorDetails;
        PyObject *new_stderr(newPyStdOut(errorDetails));
        reqNode->setErrorDetails(errorDetails);
        PySys_SetObject((char*)"stderr", new_stderr);
        PyErr_Print();
        PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
        Py_DECREF(new_stderr);
        throw Exception("Error during load");
      }
  }
  if(isInitializeRequested)
    {//This one is called only once at initialization in the container if an init-script is specified.
      try
      {
          std::string zeInitScriptKey(container->getProperty(HomogeneousPoolContainer::INITIALIZE_SCRIPT_KEY));
          if(!zeInitScriptKey.empty())
            pynode->executeAnotherPieceOfCode(zeInitScriptKey.c_str());
      }
      catch( const SALOME::SALOME_Exception& ex )
      {
          std::string msg="Exception on PythonNode::loadRemote python invocation of initializisation py script !";
          msg += '\n';
          msg += ex.details.text.in();
          reqNode->setErrorDetails(msg);
          throw Exception(msg);
      }
      DEBTRACE( "---------------End PyNode::loadRemote function---------------" );
    }
}

References _context, _pyClsBigObject, _pyfuncSer, _pyfuncSimpleSer, _pyfuncUnser, data_mutex, DEBTRACE, testCppPluginInvokation::ex, YACS::ENGINE::InlineNode::getContainer(), YACS::ENGINE::Container::getProperty(), getRemoteInterpreterHandle(), getSerializationScript(), YACS::ENGINE::HomogeneousPoolContainer::INITIALIZE_SCRIPT_KEY, YACS::ENGINE::newPyStdOut(), SCRIPT_FOR_BIGOBJECT, SCRIPT_FOR_SIMPLE_SERIALIZATION, and YACS::ENGINE::Node::setErrorDetails().

Referenced by commonRemoteLoad().

◆ retrieveDftRemotePyInterpretorIfAny()

virtual Engines::PyNodeBase_var YACS::ENGINE::PythonEntry::retrieveDftRemotePyInterpretorIfAny ( Engines::Container_ptr objContainer ) const

protectedpure virtual

returns (if any) an object, you have to deal with (UnRegister)

Implemented in YACS::ENGINE::PythonNode, and YACS::ENGINE::PyFuncNode.

Referenced by loadPythonAdapter().

◆ UnlinkOnDestructorIfProxy()

void PythonEntry::UnlinkOnDestructorIfProxy ( PyObject * ob )

static

Definition at line 413 of file PythonNode.cxx.

{
  IfProxyDoSomething(ob,"unlinkOnDestructor");
}

References IfProxyDoSomething().

Referenced by YACS::ENGINE::convertToYacsObjref< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertToYacsSequence< PYTHONImpl, PyObject *, void *, IMPLOUT, TOUT >::convert(), YACS::ENGINE::convertFromYacsObjref< PYTHONImpl, PyObject * >::convert(), and YACS::ENGINE::PythonNode::executeRemote().

Member Data Documentation

◆ _context

PyObject* YACS::ENGINE::PythonEntry::_context

protected

Definition at line 64 of file PythonNode.hxx.

Referenced by YACS::ENGINE::PythonNode::applyDPLScope(), YACS::ENGINE::PythonNode::executeLocal(), YACS::ENGINE::PythonNode::executeLocalInternal(), YACS::ENGINE::PyFuncNode::loadLocal(), loadRemoteContext(), YACS::ENGINE::PyFuncNode::PyFuncNode(), YACS::ENGINE::PythonNode::PythonNode(), YACS::ENGINE::PythonNode::squeezeMemory(), and ~PythonEntry().

◆ _imposedContainer

std::string YACS::ENGINE::PythonEntry::_imposedContainer

protected

Definition at line 70 of file PythonNode.hxx.

Referenced by hasImposedResource(), YACS::ENGINE::PythonNode::imposeResource(), YACS::ENGINE::PyFuncNode::imposeResource(), and loadRemoteContainer().

◆ _imposedResource

std::string YACS::ENGINE::PythonEntry::_imposedResource

protected

Definition at line 69 of file PythonNode.hxx.

Referenced by hasImposedResource(), YACS::ENGINE::PythonNode::imposeResource(), YACS::ENGINE::PyFuncNode::imposeResource(), and loadRemoteContainer().

◆ _pyClsBigObject

PyObject * PythonEntry::_pyClsBigObject = nullptr

staticprotected

Definition at line 68 of file PythonNode.hxx.

Referenced by GetDestroyStatus(), IfProxyDoSomething(), IsProxy(), and loadRemoteContext().

◆ _pyfuncSer

PyObject* YACS::ENGINE::PythonEntry::_pyfuncSer

protected

Definition at line 65 of file PythonNode.hxx.

Referenced by YACS::ENGINE::PythonNode::executeRemote(), YACS::ENGINE::PyFuncNode::executeRemote(), and loadRemoteContext().

◆ _pyfuncSimpleSer

PyObject* YACS::ENGINE::PythonEntry::_pyfuncSimpleSer

protected

Definition at line 67 of file PythonNode.hxx.

Referenced by YACS::ENGINE::PythonNode::applyDPLScope(), and loadRemoteContext().

◆ _pyfuncUnser

PyObject* YACS::ENGINE::PythonEntry::_pyfuncUnser

protected

Definition at line 66 of file PythonNode.hxx.

Referenced by YACS::ENGINE::PythonNode::executeRemote(), YACS::ENGINE::PyFuncNode::executeRemote(), and loadRemoteContext().

◆ SCRIPT_FOR_SIMPLE_SERIALIZATION

const char PythonEntry::SCRIPT_FOR_SIMPLE_SERIALIZATION

static

Initial value:

="import pickle\n"
    "def pickleForVarSimplePyth2009(val):\n"
    "  return pickle.dumps(val,-1)\n"
    "\n"

Definition at line 72 of file PythonNode.hxx.

Referenced by loadRemoteContext().

The documentation for this class was generated from the following files:

src/runtime/PythonNode.hxx
src/runtime/PythonNode.cxx

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PythonEntry()

◆ ~PythonEntry()

Member Function Documentation

◆ assignRemotePyInterpretor()

◆ commonRemoteLoad()

◆ createRemoteAdaptedPyInterpretor()

◆ DoNotTouchFileIfProxy()

◆ GetContainerLog()

◆ GetDestroyStatus()

◆ getRemoteInterpreterHandle()

◆ getSerializationScript()

◆ hasImposedResource()

◆ IfProxyDoSomething()

◆ IsProxy()

◆ loadPythonAdapter()

◆ loadRemoteContainer()

◆ loadRemoteContext()

◆ retrieveDftRemotePyInterpretorIfAny()

◆ UnlinkOnDestructorIfProxy()

Member Data Documentation

◆ _context

◆ _imposedContainer

◆ _imposedResource

◆ _pyClsBigObject

◆ _pyfuncSer

◆ _pyfuncSimpleSer

◆ _pyfuncUnser

◆ SCRIPT_FOR_SIMPLE_SERIALIZATION