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     Py_ssize_t len = PyBytes_Size(serializationInput);
 184     char* serializationInputC = PyBytes_AsString(serializationInput);
 185     //int ret = PyBytes_AsStringAndSize(serializationInput, &serializationInputC, &len);
 186     serializationInputCorba=new Engines::pickledArgs;
 187     serializationInputCorba->length(len+1);
 188     for(int i=0;i<len+1;i++)
 189       (*serializationInputCorba)[i]=serializationInputC[i];
 190     Py_DECREF(serializationInput);
 191   }
 192   //serializationInputCorba[serializationInputC.length()]='\0';
 193   DEBTRACE( "-----------------DistributedPythonNode starting remote python invocation-----------------" );
 194   Engines::pickledArgs *resultCorba;
 195   try
 196   {
 197       resultCorba=_pynode->execute(getFname().c_str(),*serializationInputCorba);
 198   }
 199   catch(...)
 200   {
 201       std::string msg="Exception on remote python invocation";
 202       _errorDetails=msg;
 203       throw Exception(msg);
 204   }
 205   DEBTRACE( "-----------------DistributedPythonNode end of remote python invocation-----------------" );
 206   //
 207   delete serializationInputCorba;
 208   char *resultCorbaC=new char[resultCorba->length()+1];
 209   resultCorbaC[resultCorba->length()]='\0';
 210   for(int i=0;i<resultCorba->length();i++)
 211     resultCorbaC[i]=(*resultCorba)[i];
 212   int lenResCorba=resultCorba->length();
 213   delete resultCorba;
 214   {
 215     AutoGIL agil;
 216     args = PyTuple_New(1);
 217     //PyObject* resultPython=PyBytes_FromString(resultCorbaC);
 218     PyObject* resultPython=PyBytes_FromStringAndSize(resultCorbaC,lenResCorba);
 219     delete [] resultCorbaC;
 220     PyTuple_SetItem(args,0,resultPython);
 221     PyObject *finalResult=PyObject_CallObject(_pyfuncUnser,args);
 222     DEBTRACE( "-----------------DistributedPythonNode::outputs-----------------" );
 223     if(finalResult == NULL)
 224       {
 225         std::stringstream msg;
 226         msg << "Conversion with pickle of output ports failed !";
 227         msg << " : " << __FILE__ << ":" << __LINE__;
 228         _errorDetails=msg.str();
 229         throw YACS::ENGINE::ConversionException(msg.str());
 230       }
 231     int nres=1;
 232     if(finalResult == Py_None)
 233       nres=0;
 234     else if(PyTuple_Check(finalResult))
 235       nres=PyTuple_Size(finalResult);
 236
 237     if(getNumberOfOutputPorts() != nres)
 238       {
 239         std::string msg="Number of output arguments : Mismatch between definition and execution";
 240         Py_DECREF(finalResult);
 241         _errorDetails=msg;
 242         throw Exception(msg);
 243       }
 244     try
 245     {
 246         int pos(0);
 247         for(list<OutputPort *>::iterator iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++, pos++)
 248           {
 249             OutputPyPort *p=(OutputPyPort *)*iter;
 250             DEBTRACE( "port name: " << p->getName() );
 251             DEBTRACE( "port kind: " << p->typeName() );
 252             DEBTRACE( "port pos : " << pos );
 253             if(PyTuple_Check(finalResult))ob=PyTuple_GetItem(finalResult,pos) ;
 254             else ob=finalResult;
 255             DEBTRACE( "ob refcnt: " << ob->ob_refcnt );
 256             p->put(ob);
 257           }
 258     }
 259     catch(ConversionException& ex)
 260     {
 261         Py_DECREF(finalResult);
 262         _errorDetails=ex.what();
 263         throw;
 264     }
 265   }
 266   DEBTRACE( "++++++++++++++ End DistributedPythonNode::execute: " << getName() << " ++++++++++++++++++++" );
 267 }
 268
 269 std::string DistributedPythonNode::getEffectiveKindOfServer() const
 270 {
 271   return "Salome";
 272 }
 273
 274 std::string DistributedPythonNode::getKind() const
 275 {
 276   //! not a bug : this is to use classical python port translators.
 277   return PythonNode::KIND;
 278 }
 279
 280 ServerNode *DistributedPythonNode::createNode(const std::string& name) const
 281 {
 282   ServerNode *ret=new DistributedPythonNode(name);
 283   ret->setContainer(_container);
 284   return ret;
 285 }
 286
 287 void DistributedPythonNode::initMySelf()
 288 {
 289   _implementation = DistributedPythonNode::IMPL_NAME;
 290   AutoGIL agil;
 291   _context=PyDict_New();
 292 }
 293
 294 void DistributedPythonNode::dealException(CORBA::Exception *exc, const char *method, const char *ref)
 295 {
 296   if( exc )
 297     {
 298       DEBTRACE( "An exception was thrown!" );
 299       DEBTRACE( "The raised exception is of Type:" << exc->_name() );
 300
 301       CORBA::SystemException* sysexc;
 302       sysexc=CORBA::SystemException::_downcast(exc);
 303       if(sysexc != NULL)
 304         {
 305           // It's a SystemException
 306           DEBTRACE( "minor code: " << sysexc->minor() );
 307           DEBTRACE( "completion code: " << sysexc->completed() );
 308           std::string text="Execution problem: ";
 309           std::string excname=sysexc->_name();
 310           if(excname == "BAD_OPERATION")
 311             {
 312               text=text+"bad operation detected";
 313             }
 314           else if(excname == "MARSHAL" && sysexc->minor() == omni::MARSHAL_PassEndOfMessage)
 315             {
 316               text=text+"probably an error in arguments of service '" + method + "' from component '" +ref+ "'";
 317             }
 318           else if(excname == "COMM_FAILURE" && sysexc->minor() == omni::COMM_FAILURE_UnMarshalResults)
 319             {
 320               text=text+"probably an error in output arguments of service '" + method + "' from component '" +ref+ "'";
 321             }
 322           else if(excname == "COMM_FAILURE" && sysexc->minor() == omni::COMM_FAILURE_UnMarshalArguments)
 323             {
 324               text=text+"probably an error in input arguments of service '" + method + "' from component '" +ref+ "'";
 325             }
 326           else if(excname == "COMM_FAILURE" && sysexc->minor() == omni::COMM_FAILURE_WaitingForReply)
 327             {
 328               text=text+"probably an error in input arguments of service '" + method + "' from component '" +ref+ "'";
 329             }
 330           else
 331             {
 332               DEBTRACE(sysexc->NP_minorString() );
 333               text=text+"System Exception "+ excname;
 334             }
 335           _errorDetails=text;
 336           throw Exception(text);
 337         }
 338
 339       // Not a System Exception
 340       CORBA::UnknownUserException* userexc;
 341       userexc=CORBA::UnknownUserException::_downcast(exc);
 342       if(userexc != NULL)
 343         {
 344           CORBA::Any anyExcept = userexc->exception();
 345
 346           const SALOME::SALOME_Exception* salexc;
 347           if(anyExcept >>= salexc)
 348             {
 349               DEBTRACE("SALOME_Exception: "<< salexc->details.sourceFile);
 350               DEBTRACE("SALOME_Exception: "<<salexc->details.lineNumber);
 351               _errorDetails=salexc->details.text;
 352               throw Exception("Execution problem: Salome Exception occurred" + getErrorDetails() );
 353             }
 354           std::string msg="Execution problem: User Exception occurred";
 355           _errorDetails=msg;
 356           throw Exception(msg);
 357         }
 358       std::string msg="Execution problem";
 359       _errorDetails=msg;
 360       throw Exception(msg);
 361     }
 362 }