src/runtime/DistributedPythonNode.cxx

   1 // Copyright (C) 2006-2016  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #include "DistributedPythonNode.hxx"
  21 #include "RuntimeSALOME.hxx"
  22 #include "SalomeContainer.hxx"
  23 #include "PythonNode.hxx"
  24 #include "SalomeHPContainer.hxx"
  25 #include "SalomeContainerTmpForHP.hxx"
  26 #include "AutoGIL.hxx"
  27
  28 #include "PythonPorts.hxx"
  29 #include "YacsTrace.hxx"
  30 #include "PyStdout.hxx"
  31
  32 using namespace YACS::ENGINE;
  33 using namespace std;
  34
  35 const char DistributedPythonNode::KIND[]="DistPython";
  36 const char DistributedPythonNode::IMPL_NAME[]="Python";
  37 const char DistributedPythonNode::SALOME_CONTAINER_METHOD_IDL[]="createPyNode";
  38
  39 Node *DistributedPythonNode::simpleClone(ComposedNode *father, bool editionOnly) const
  40 {
  41   return new DistributedPythonNode(*this,father);
  42 }
  43
  44 DistributedPythonNode::DistributedPythonNode(const std::string& name):ServerNode(name),_context(0),_pyfuncSer(0),_pyfuncUnser(0)
  45 {
  46   initMySelf();
  47 }
  48
  49 DistributedPythonNode::DistributedPythonNode(const DistributedPythonNode& other, ComposedNode *father):ServerNode(other,father),_context(0),_pyfuncSer(0),_pyfuncUnser(0)
  50 {
  51   initMySelf();
  52 }
  53
  54 DistributedPythonNode::~DistributedPythonNode()
  55 {
  56   AutoGIL agil;
  57   Py_DECREF(_context);
  58 }
  59
  60 void DistributedPythonNode::load()
  61 {
  62   bool isContAlreadyStarted(false);
  63   if(_container)
  64     isContAlreadyStarted=_container->isAlreadyStarted(this);
  65   ServerNode::load();
  66   {
  67     AutoGIL agil;
  68     if( PyDict_SetItemString( _context, "__builtins__", getSALOMERuntime()->getBuiltins() ))
  69       {
  70         stringstream msg;
  71         msg << "Impossible to set builtins" << __FILE__ << ":" << __LINE__;
  72         _errorDetails=msg.str();
  73         throw Exception(msg.str());
  74       }
  75     const char picklizeScript[]="import pickle\ndef pickleForDistPyth2009(*args,**kws):\n  return pickle.dumps((args,kws),-1)\n\ndef unPickleForDistPyth2009(st):\n  args=pickle.loads(st)\n  return args\n";
  76     PyObject *res=PyRun_String(picklizeScript,Py_file_input,_context,_context);
  77     if(res == NULL)
  78       {
  79         _errorDetails="";
  80         PyObject* new_stderr = newPyStdOut(_errorDetails);
  81         PySys_SetObject((char*)"stderr", new_stderr);
  82         PyErr_Print();
  83         PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
  84         Py_DECREF(new_stderr);
  85         throw Exception("Error during execution");
  86         return;
  87       }
  88     Py_DECREF(res);
  89     _pyfuncSer=PyDict_GetItemString(_context,"pickleForDistPyth2009");
  90     _pyfuncUnser=PyDict_GetItemString(_context,"unPickleForDistPyth2009");
  91     if(_pyfuncSer == NULL)
  92       {
  93         _errorDetails="";
  94         PyObject* new_stderr = newPyStdOut(_errorDetails);
  95         PySys_SetObject((char*)"stderr", new_stderr);
  96         PyErr_Print();
  97         PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
  98         Py_DECREF(new_stderr);
  99         throw Exception("Error during execution");
 100       }
 101     if(_pyfuncUnser == NULL)
 102       {
 103         _errorDetails="";
 104         PyObject* new_stderr = newPyStdOut(_errorDetails);
 105         PySys_SetObject((char*)"stderr", new_stderr);
 106         PyErr_Print();
 107         PySys_SetObject((char*)"stderr", PySys_GetObject((char*)"__stderr__"));
 108         Py_DECREF(new_stderr);
 109         throw Exception("Error during execution");
 110       }
 111
 112     Engines::Container_var objContainer=Engines::Container::_nil();
 113     if(!_container)
 114       throw Exception("No container specified !");
 115     SalomeContainer *containerCast0(dynamic_cast<SalomeContainer *>(_container));
 116     SalomeHPContainerBase *containerCast1(dynamic_cast<SalomeHPContainerBase *>(_container));
 117     if(containerCast0)
 118       objContainer=containerCast0->getContainerPtr(this);
 119     else if(containerCast1)
 120       {
 121         objContainer=containerCast1->getContainerPtr(this);
 122       }
 123     else
 124       throw Exception("Unrecognized type of container ! Salome one is expected !");
 125     if(CORBA::is_nil(objContainer))
 126       throw Exception("Container corba pointer is NULL !");
 127
 128     try
 129     {
 130         if(containerCast0 || !isContAlreadyStarted)
 131           {
 132             _pynode = objContainer->createPyNode(getName().c_str(),getScript().c_str());
 133           }
 134         else
 135           {
 136             Engines::PyNode_var dftPyScript(objContainer->getDefaultPyNode(getName().c_str()));
 137             if(CORBA::is_nil(dftPyScript))
 138               _pynode = objContainer->createPyNode(getName().c_str(),getScript().c_str());
 139             else
 140               _pynode = dftPyScript;
 141           }
 142     }
 143     catch( const SALOME::SALOME_Exception& ex )
 144     {
 145         std::string msg="Exception on remote python node creation ";
 146         msg += '\n';
 147         msg += ex.details.text.in();
 148         _errorDetails=msg;
 149         throw Exception(msg);
 150     }
 151
 152     if(CORBA::is_nil(_pynode))
 153       throw Exception("In DistributedPythonNode the ref in NULL ! ");
 154
 155
 156     DEBTRACE( "---------------End PyfuncSerNode::load function---------------" );
 157   }
 158 }
 159
 160 void DistributedPythonNode::execute()
 161 {
 162   YACSTRACE(1,"+++++++++++++++++ DistributedPythonNode::execute: " << getName() << " " << getFname() << " +++++++++++++++++" );
 163   //////
 164   PyObject* ob;
 165   if(!_pyfuncSer)
 166     throw Exception("DistributedPythonNode badly loaded");
 167   Engines::pickledArgs *serializationInputCorba(0);
 168   PyObject *args(0);
 169   {
 170     AutoGIL agil;
 171
 172     DEBTRACE( "---------------DistributedPythonNode::inputs---------------" );
 173     args = PyTuple_New(getNumberOfInputPorts()) ;
 174     int pos=0;
 175     for(list<InputPort *>::iterator iter2 = _setOfInputPort.begin(); iter2 != _setOfInputPort.end(); iter2++,pos++)
 176       {
 177         InputPyPort *p=(InputPyPort *)*iter2;
 178         ob=p->getPyObj();
 179         Py_INCREF(ob);
 180         PyTuple_SetItem(args,pos,ob);
 181       }
 182     PyObject *serializationInput=PyObject_CallObject(_pyfuncSer,args);
 183     std::string serializationInputC=PyBytes_AsString(serializationInput);
 184     serializationInputCorba=new Engines::pickledArgs;
 185     int len=serializationInputC.length();
 186     serializationInputCorba->length(serializationInputC.length());
 187     for(int i=0;i<serializationInputC.length();i++)
 188       (*serializationInputCorba)[i]=serializationInputC[i];
 189     Py_DECREF(serializationInput);
 190   }
 191   //serializationInputCorba[serializationInputC.length()]='\0';
 192   DEBTRACE( "-----------------DistributedPythonNode starting remote python invocation-----------------" );
 193   Engines::pickledArgs *resultCorba;
 194   try
 195   {
 196       resultCorba=_pynode->execute(getFname().c_str(),*serializationInputCorba);
 197   }
 198   catch(...)
 199   {
 200       std::string msg="Exception on remote python invocation";
 201       _errorDetails=msg;
 202       throw Exception(msg);
 203   }
 204   DEBTRACE( "-----------------DistributedPythonNode end of remote python invocation-----------------" );
 205   //
 206   delete serializationInputCorba;
 207   char *resultCorbaC=new char[resultCorba->length()+1];
 208   resultCorbaC[resultCorba->length()]='\0';
 209   for(int i=0;i<resultCorba->length();i++)
 210     resultCorbaC[i]=(*resultCorba)[i];
 211   delete resultCorba;
 212   {
 213     AutoGIL agil;
 214     args = PyTuple_New(1);
 215     PyObject* resultPython=PyBytes_FromString(resultCorbaC);
 216     delete [] resultCorbaC;
 217     PyTuple_SetItem(args,0,resultPython);
 218     PyObject *finalResult=PyObject_CallObject(_pyfuncUnser,args);
 219     DEBTRACE( "-----------------DistributedPythonNode::outputs-----------------" );
 220     int nres=1;
 221     if(finalResult == Py_None)
 222       nres=0;
 223     else if(PyTuple_Check(finalResult))
 224       nres=PyTuple_Size(finalResult);
 225
 226     if(getNumberOfOutputPorts() != nres)
 227       {
 228         std::string msg="Number of output arguments : Mismatch between definition and execution";
 229         Py_DECREF(finalResult);
 230         _errorDetails=msg;
 231         throw Exception(msg);
 232       }
 233     try
 234     {
 235         int pos(0);
 236         for(list<OutputPort *>::iterator iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++, pos++)
 237           {
 238             OutputPyPort *p=(OutputPyPort *)*iter;
 239             DEBTRACE( "port name: " << p->getName() );
 240             DEBTRACE( "port kind: " << p->typeName() );
 241             DEBTRACE( "port pos : " << pos );
 242             if(PyTuple_Check(finalResult))ob=PyTuple_GetItem(finalResult,pos) ;
 243             else ob=finalResult;
 244             DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
 245             p->put(ob);
 246           }
 247     }
 248     catch(ConversionException& ex)
 249     {
 250         Py_DECREF(finalResult);
 251         _errorDetails=ex.what();
 252         throw;
 253     }
 254   }
 255   DEBTRACE( "++++++++++++++ End DistributedPythonNode::execute: " << getName() << " ++++++++++++++++++++" );
 256 }
 257
 258 std::string DistributedPythonNode::getEffectiveKindOfServer() const
 259 {
 260   return "Salome";
 261 }
 262
 263 std::string DistributedPythonNode::getKind() const
 264 {
 265   //! not a bug : this is to use classical python port translators.
 266   return PythonNode::KIND;
 267 }
 268
 269 ServerNode *DistributedPythonNode::createNode(const std::string& name) const
 270 {
 271   ServerNode *ret=new DistributedPythonNode(name);
 272   ret->setContainer(_container);
 273   return ret;
 274 }
 275
 276 void DistributedPythonNode::initMySelf()
 277 {
 278   _implementation = DistributedPythonNode::IMPL_NAME;
 279   AutoGIL agil;
 280   _context=PyDict_New();
 281 }
 282
 283 void DistributedPythonNode::dealException(CORBA::Exception *exc, const char *method, const char *ref)
 284 {
 285   if( exc )
 286     {
 287       DEBTRACE( "An exception was thrown!" );
 288       DEBTRACE( "The raised exception is of Type:" << exc->_name() );
 289
 290       CORBA::SystemException* sysexc;
 291       sysexc=CORBA::SystemException::_downcast(exc);
 292       if(sysexc != NULL)
 293         {
 294           // It's a SystemException
 295           DEBTRACE( "minor code: " << sysexc->minor() );
 296           DEBTRACE( "completion code: " << sysexc->completed() );
 297           std::string text="Execution problem: ";
 298           std::string excname=sysexc->_name();
 299           if(excname == "BAD_OPERATION")
 300             {
 301               text=text+"bad operation detected";
 302             }
 303           else if(excname == "MARSHAL" && sysexc->minor() == omni::MARSHAL_PassEndOfMessage)
 304             {
 305               text=text+"probably an error in arguments of service '" + method + "' from component '" +ref+ "'";
 306             }
 307           else if(excname == "COMM_FAILURE" && sysexc->minor() == omni::COMM_FAILURE_UnMarshalResults)
 308             {
 309               text=text+"probably an error in output arguments of service '" + method + "' from component '" +ref+ "'";
 310             }
 311           else if(excname == "COMM_FAILURE" && sysexc->minor() == omni::COMM_FAILURE_UnMarshalArguments)
 312             {
 313               text=text+"probably an error in input arguments of service '" + method + "' from component '" +ref+ "'";
 314             }
 315           else if(excname == "COMM_FAILURE" && sysexc->minor() == omni::COMM_FAILURE_WaitingForReply)
 316             {
 317               text=text+"probably an error in input arguments of service '" + method + "' from component '" +ref+ "'";
 318             }
 319           else
 320             {
 321               DEBTRACE(sysexc->NP_minorString() );
 322               text=text+"System Exception "+ excname;
 323             }
 324           _errorDetails=text;
 325           throw Exception(text);
 326         }
 327
 328       // Not a System Exception
 329       CORBA::UnknownUserException* userexc;
 330       userexc=CORBA::UnknownUserException::_downcast(exc);
 331       if(userexc != NULL)
 332         {
 333           CORBA::Any anyExcept = userexc->exception();
 334
 335           const SALOME::SALOME_Exception* salexc;
 336           if(anyExcept >>= salexc)
 337             {
 338               DEBTRACE("SALOME_Exception: "<< salexc->details.sourceFile);
 339               DEBTRACE("SALOME_Exception: "<<salexc->details.lineNumber);
 340               _errorDetails=salexc->details.text;
 341               throw Exception("Execution problem: Salome Exception occurred" + getErrorDetails() );
 342             }
 343           std::string msg="Execution problem: User Exception occurred";
 344           _errorDetails=msg;
 345           throw Exception(msg);
 346         }
 347       std::string msg="Execution problem";
 348       _errorDetails=msg;
 349       throw Exception(msg);
 350     }
 351 }