src/SALOMESDS/SALOMESDS_DataScopeServer.hxx

   1 // Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
   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 // Author : Anthony GEAY (EDF R&D)
  20
  21 #ifndef __SALOMESDS_DATASCOPEERVER_HXX__
  22 #define __SALOMESDS_DATASCOPEERVER_HXX__
  23
  24 #include "SALOMEconfig.h"
  25 #include CORBA_SERVER_HEADER(SALOME_SDS)
  26
  27 #include "SALOMESDS_RequestSwitcher.hxx"
  28 #include "SALOMESDS_RefCountServ.hxx"
  29 #include "SALOMESDS_AutoRefCountPtr.hxx"
  30 #include "SALOMESDS_BasicDataServer.hxx"
  31 #include "SALOMESDS_Auto.hxx"
  32 #include "SALOMESDS_Defines.hxx"
  33 #include "SALOME_CPythonHelper.hxx"
  34
  35 #include <Python.h>
  36
  37 #include <string>
  38 #include <vector>
  39 #include <list>
  40
  41 namespace SALOMESDS
  42 {
  43   class SALOMESDS_EXPORT DataScopeKiller : public POA_SALOME::DataScopeKiller
  44   {
  45   public:
  46     DataScopeKiller(CORBA::ORB_ptr orb):_orb(CORBA::ORB::_duplicate(orb)) { }
  47     void shutdown();
  48   private:
  49     CORBA::ORB_var _orb;
  50   };
  51
  52   class DataScopeServerTransaction;
  53
  54   /*!
  55    * Servant activated by a specific POA (single thread) having itself its specific POA_manager.
  56    * This class is able to hold/active the default POA_manager shared by other POA than this.
  57    */
  58   class SALOMESDS_EXPORT RequestSwitcher : public RequestSwitcherBase, public virtual POA_SALOME::RequestSwitcher
  59   {
  60   public:
  61     RequestSwitcher(CORBA::ORB_ptr orb, DataScopeServerTransaction *ds);
  62     SALOME::StringVec *listVars();
  63     SALOME::ByteVec *fetchSerializedContent(const char *varName);
  64     void fetchAndGetAccessOfVar(const char *varName, CORBA::String_out access, SALOME::ByteVec_out data);
  65   private:
  66     //! handle on its creator to give access to services when _poa_manager_under_control is in hold mode.
  67     DataScopeServerTransaction *_ds;
  68   };
  69
  70   class KeyWaiter;
  71   class PickelizedPyObjServer;
  72
  73   class SALOMESDS_EXPORT DataScopeServerBase : public virtual POA_SALOME::DataScopeServerBase, public POAHolder
  74   {
  75   public:
  76     DataScopeServerBase(const SALOME_CPythonHelper *pyHelper, CORBA::ORB_ptr orb, SALOME::DataScopeKiller_var killer, const std::string& scopeName);
  77     DataScopeServerBase(const DataScopeServerBase& other);
  78   public: // remote access methods
  79     void ping();
  80     char *getScopeName();
  81     SALOME::StringVec *listVars();
  82     CORBA::Boolean existVar(const char *varName);
  83     SALOME::BasicDataServer_ptr retrieveVarInternal(const char *varName);
  84     void deleteVar(const char *varName);
  85     CORBA::Boolean shutdownIfNotHostedByDSM(SALOME::DataScopeKiller_out killer);
  86     SALOME::ByteVec *fetchSerializedContent(const char *varName);
  87     SALOME::SeqOfByteVec *getAllKeysOfVarWithTypeDict(const char *varName);
  88     SALOME::ByteVec *getValueOfVarWithTypeDict(const char *varName, const SALOME::ByteVec& constKey);
  89     void takeANap(CORBA::Double napDurationInSec);
  90   public:
  91     ~DataScopeServerBase();
  92     BasicDataServer *retrieveVarInternal2(const std::string& varName);
  93     void registerToSalomePiDict() const;
  94     void setPOA(PortableServer::POA_var poa);
  95     void registerInNS(SALOME::DataScopeServerBase_ptr ptr);
  96     PyObject *getGlobals() const { return _pyHelper->getGlobals(); }
  97     PyObject *getLocals() const { return _pyHelper->getLocals(); }
  98     PyObject *getPickler() const { return _pyHelper->getPickler(); }
  99     PortableServer::POA_var getPOA() const { return _poa; }
 100     CORBA::ORB_var getORB() { return _orb; }
 101     std::string getScopeNameCpp() const { return _name; }
 102     static std::string BuildTmpVarNameFrom(const std::string& varName);
 103   public:
 104     std::vector< std::string> getAllVarNames() const;
 105     bool isExistingVar(const std::string& varName) const;
 106     void checkNotAlreadyExistingVar(const std::string& varName) const;
 107     void checkExistingVar(const std::string& varName) const;
 108     PickelizedPyObjServer *checkVarExistingAndDict(const std::string& varName);
 109   public:
 110     void moveStatusOfVarFromRdWrToRdOnly(const std::string& varName);
 111     void moveStatusOfVarFromRdOnlyToRdWr(const std::string& varName);
 112     void moveStatusOfVarFromRdExtOrRdExtInitToRdExtInit(const std::string& varName);
 113     void moveStatusOfVarFromRdExtOrRdExtInitToRdExt(const std::string& varName);
 114   protected:
 115     std::list< std::pair< SALOME::BasicDataServer_var, BasicDataServer * > >::const_iterator retrieveVarInternal3(const std::string& varName) const;
 116     std::list< std::pair< SALOME::BasicDataServer_var, BasicDataServer * > >::iterator retrieveVarInternal4(const std::string& varName);
 117   protected:
 118     const SALOME_CPythonHelper *_pyHelper = nullptr;
 119     PortableServer::POA_var _poa;
 120     CORBA::ORB_var _orb;
 121     std::string _name;
 122     std::list< std::pair< SALOME::BasicDataServer_var, BasicDataServer * > > _vars;
 123     SALOME::DataScopeKiller_var _killer;
 124     static std::size_t COUNTER;
 125   };
 126
 127   class SALOMESDS_EXPORT DataScopeServer : public DataScopeServerBase, public virtual POA_SALOME::DataScopeServer
 128   {
 129   public:
 130     DataScopeServer(const SALOME_CPythonHelper *pyHelper, CORBA::ORB_ptr orb, SALOME::DataScopeKiller_var killer, const std::string& scopeName);
 131     DataScopeServer(const DataScopeServer& other);
 132     SALOME::BasicDataServer_ptr retrieveVar(const char *varName) { return retrieveVarInternal(varName); }
 133     SALOME::PickelizedPyObjRdOnlyServer_ptr createRdOnlyVar(const char *varName, const SALOME::ByteVec& constValue);
 134     SALOME::PickelizedPyObjRdExtServer_ptr createRdExtVar(const char *varName, const SALOME::ByteVec& constValue);
 135     SALOME::PickelizedPyObjRdWrServer_ptr createRdWrVar(const char *typeName, const char *varName);
 136     ~DataScopeServer();
 137   };
 138
 139   class SALOMESDS_EXPORT DataScopeServerTransaction : public DataScopeServerBase, public virtual POA_SALOME::DataScopeServerTransaction
 140   {
 141   public://not remotely callable
 142     DataScopeServerTransaction(const SALOME_CPythonHelper *pyHelper, CORBA::ORB_ptr orb, SALOME::DataScopeKiller_var killer, const std::string& scopeName);
 143     DataScopeServerTransaction(const DataScopeServerTransaction& other);
 144     ~DataScopeServerTransaction();
 145     void createRdOnlyVarInternal(const std::string& varName, const SALOME::ByteVec& constValue);
 146     void createRdExtVarInternal(const std::string& varName, const SALOME::ByteVec& constValue);
 147     void createRdExtVarFreeStyleInternal(const std::string& varName, const SALOME::ByteVec& constValue, std::string&& compareFuncContent, SALOME::AutoPyRef&& compareFunc);
 148     void createRdExtInitVarInternal(const std::string& varName, const SALOME::ByteVec& constValue);
 149     void createRdWrVarInternal(const std::string& varName, const SALOME::ByteVec& constValue);
 150     PortableServer::POA_var getPOA4KeyWaiter() const { return _poa_for_key_waiter; }
 151     void addWaitKey(KeyWaiter *kw);
 152     void pingKey(PyObject *keyObj);
 153     void notifyKey(const std::string& varName, PyObject *keyObj, PyObject *valueObj);
 154     SALOME::ByteVec *waitForMonoThrRev(SALOME::KeyWaiter_ptr kw);
 155     SALOME::ByteVec *waitForAndKill(SALOME::KeyWaiter_ptr kw);
 156   public://remotely callable
 157     char *getAccessOfVar(const char *varName);
 158     void fetchAndGetAccessOfVar(const char *varName, CORBA::String_out access, SALOME::ByteVec_out data);
 159     SALOME::Transaction_ptr createRdOnlyVarTransac(const char *varName, const SALOME::ByteVec& constValue);
 160     SALOME::Transaction_ptr createRdExtVarTransac(const char *varName, const SALOME::ByteVec& constValue);
 161     SALOME::Transaction_ptr createRdExtVarFreeStyleTransac(const char *varName, const SALOME::ByteVec& constValue, const char *compareFuncContent);
 162     SALOME::Transaction_ptr createRdExtInitVarTransac(const char *varName, const SALOME::ByteVec& constValue);
 163     SALOME::Transaction_ptr createRdWrVarTransac(const char *varName, const SALOME::ByteVec& constValue);
 164     SALOME::Transaction_ptr addKeyValueInVarHard(const char *varName, const SALOME::ByteVec& key, const SALOME::ByteVec& value);
 165     SALOME::Transaction_ptr addKeyValueInVarErrorIfAlreadyExisting(const char *varName, const SALOME::ByteVec& key, const SALOME::ByteVec& value);
 166     SALOME::TransactionMultiKeyAddSession_ptr addMultiKeyValueSession(const char *varName);
 167     SALOME::Transaction_ptr removeKeyInVarErrorIfNotAlreadyExisting(const char *varName, const SALOME::ByteVec& key);
 168     SALOME::TransactionRdWrAccess_ptr createWorkingVarTransac(const char *varName, const SALOME::ByteVec& constValue);
 169     SALOME::Transaction_ptr killVarTransac(const char *varName);
 170     SALOME::KeyWaiter_ptr waitForKeyInVar(const char *varName, const SALOME::ByteVec& keyVal);
 171     SALOME::KeyWaiter_ptr waitForKeyInVarAndKillIt(const char *varName, const SALOME::ByteVec& keyVal, SALOME::Transaction_out transac);
 172     void atomicApply(const SALOME::ListOfTransaction& transactions);
 173     SALOME::RequestSwitcher_ptr getRequestSwitcher();
 174   private:
 175     PortableServer::POA_var _poa_for_key_waiter;
 176     std::list< KeyWaiter * > _waiting_keys;
 177     AutoServantPtr<RequestSwitcher> _rs;
 178   };
 179 }
 180
 181 #endif