src/Container/SALOME_PyNode.py

   1 #  -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2022  CEA/DEN, EDF R&D, OPEN CASCADE
   3 #
   4 # This library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License, or (at your option) any later version.
   8 #
   9 # This library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with this library; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 #
  18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 #
  20
  21 #  File   : SALOME_PyNode.py
  22 #  Author : Christian CAREMOLI, EDF
  23 #  Module : SALOME
  24 #  $Header$
  25 #
  26 import sys,traceback
  27 import linecache
  28 import pickle
  29 import Engines__POA
  30 import SALOME__POA
  31 import SALOME
  32
  33 class Generic(SALOME__POA.GenericObj):
  34   """A Python implementation of the GenericObj CORBA IDL"""
  35   def __init__(self,poa):
  36     self.poa=poa
  37     self.cnt=1
  38
  39   def Register(self):
  40     #print("Register called : %d"%self.cnt)
  41     self.cnt+=1
  42
  43   def UnRegister(self):
  44     #print("UnRegister called : %d"%self.cnt)
  45     self.cnt-=1
  46     if self.cnt <= 0:
  47       oid=self.poa.servant_to_id(self)
  48       self.poa.deactivate_object(oid)
  49
  50   def Destroy(self):
  51     print("WARNING SALOME::GenericObj::Destroy() function is obsolete! Use UnRegister() instead.")
  52     self.UnRegister()
  53
  54   def __del__(self):
  55     #print("Destuctor called")
  56     pass
  57
  58 class PyNode_i (Engines__POA.PyNode,Generic):
  59   """The implementation of the PyNode CORBA IDL"""
  60   def __init__(self, nodeName,code,poa,my_container):
  61     """Initialize the node : compilation in the local context"""
  62     Generic.__init__(self,poa)
  63     self.nodeName=nodeName
  64     self.code=code
  65     self.my_container=my_container._container
  66     linecache.cache[nodeName]=0,None,code.split('\n'),nodeName
  67     ccode=compile(code,nodeName,'exec')
  68     self.context={}
  69     self.context["my_container"] = self.my_container
  70     exec(ccode, self.context)
  71
  72   def getContainer(self):
  73     return self.my_container
  74
  75   def getCode(self):
  76     return self.code
  77
  78   def getName(self):
  79     return self.nodeName
  80
  81   def defineNewCustomVar(self,varName,valueOfVar):
  82     self.context[varName] = pickle.loads(valueOfVar)
  83     pass
  84
  85   def executeAnotherPieceOfCode(self,code):
  86     """Called for initialization of container lodging self."""
  87     try:
  88       ccode=compile(code,self.nodeName,'exec')
  89       exec(ccode, self.context)
  90     except Exception:
  91       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode (%s) : code to be executed \"%s\"" %(self.nodeName,code),0))
  92
  93   def execute(self,funcName,argsin):
  94     """Execute the function funcName found in local context with pickled args (argsin)"""
  95     try:
  96       argsin,kws=pickle.loads(argsin)
  97       func=self.context[funcName]
  98       argsout=func(*argsin,**kws)
  99       argsout=pickle.dumps(argsout,-1)
 100       return argsout
 101     except Exception:
 102       exc_typ,exc_val,exc_fr=sys.exc_info()
 103       l=traceback.format_exception(exc_typ,exc_val,exc_fr)
 104       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyNode: %s, function: %s" % (self.nodeName,funcName),0))
 105
 106 class SenderByte_i(SALOME__POA.SenderByte,Generic):
 107   def __init__(self,poa,bytesToSend):
 108     Generic.__init__(self,poa)
 109     self.bytesToSend = bytesToSend
 110
 111   def getSize(self):
 112     return len(self.bytesToSend)
 113
 114   def sendPart(self,n1,n2):
 115     return self.bytesToSend[n1:n2]
 116
 117 SALOME_FILE_BIG_OBJ_DIR = "SALOME_FILE_BIG_OBJ_DIR"
 118
 119 SALOME_BIG_OBJ_ON_DISK_THRES_VAR = "SALOME_BIG_OBJ_ON_DISK_THRES"
 120
 121 # default is 50 MB
 122 SALOME_BIG_OBJ_ON_DISK_THRES_DFT = 50000000
 123
 124 def GetBigObjectOnDiskThreshold():
 125   import os
 126   if SALOME_BIG_OBJ_ON_DISK_THRES_VAR in os.environ:
 127     return int( os.environ[SALOME_BIG_OBJ_ON_DISK_THRES_VAR] )
 128   else:
 129     return SALOME_BIG_OBJ_ON_DISK_THRES_DFT
 130
 131 def GetBigObjectDirectory():
 132   import os
 133   if SALOME_FILE_BIG_OBJ_DIR not in os.environ:
 134     raise RuntimeError("An object of size higher than limit detected and no directory specified to dump it in file !")
 135   return os.environ[SALOME_FILE_BIG_OBJ_DIR]
 136
 137 def GetBigObjectFileName():
 138   """
 139   Return a filename in the most secure manner (see tempfile documentation)
 140   """
 141   import tempfile
 142   with tempfile.NamedTemporaryFile(dir=GetBigObjectDirectory(),prefix="mem_",suffix=".pckl") as f:
 143     ret = f.name
 144   return ret
 145
 146 class BigObjectOnDisk:
 147   def __init__(self, fileName, objSerialized):
 148     """
 149     :param fileName: the file used to dump into.
 150     :param objSerialized: the object in pickeled form
 151     :type objSerialized: bytes
 152     """
 153     self._filename = fileName
 154     self._destroy = False
 155     self.__dumpIntoFile(objSerialized)
 156
 157   def unlinkOnDestructor(self):
 158     self._destroy = True
 159
 160   def doNotTouchFile(self):
 161     """
 162     Method called slave side. The life cycle management of file is client side not slave side.
 163     """
 164     self._destroy = False
 165
 166   def __del__(self):
 167     if self._destroy:
 168       import os
 169       os.unlink( self._filename )
 170
 171   def getFileName(self):
 172     return self._filename
 173
 174   def __dumpIntoFile(self, objSerialized):
 175     with open(self._filename,"wb") as f:
 176       f.write(objSerialized)
 177
 178   def get(self):
 179     import pickle
 180     with open(self._filename,"rb") as f:
 181       return pickle.load(f)
 182
 183 def SpoolPickleObject( obj ):
 184   import pickle
 185   pickleObjInit = pickle.dumps( obj , pickle.HIGHEST_PROTOCOL )
 186   if len(pickleObjInit) < GetBigObjectOnDiskThreshold():
 187     return pickleObjInit
 188   else:
 189     proxyObj = BigObjectOnDisk( GetBigObjectFileName() , pickleObjInit )
 190     pickleProxy = pickle.dumps( proxyObj , pickle.HIGHEST_PROTOCOL )
 191     return pickleProxy
 192
 193 def UnProxyObject( obj ):
 194   if isinstance(obj,BigObjectOnDisk):
 195     obj.doNotTouchFile()
 196     return obj.get()
 197   else:
 198     return obj
 199
 200 class SeqByteReceiver:
 201   # 2GB limit to trigger split into chunks
 202   CHUNK_SIZE = 2000000000
 203   def __init__(self,sender):
 204     self._obj = sender
 205   def __del__(self):
 206     self._obj.UnRegister()
 207     pass
 208   def data(self):
 209     size = self._obj.getSize()
 210     if size <= SeqByteReceiver.CHUNK_SIZE:
 211       return self.fetchOneShot( size )
 212     else:
 213       return self.fetchByChunks( size )
 214   def fetchOneShot(self,size):
 215     return self._obj.sendPart(0,size)
 216   def fetchByChunks(self,size):
 217       """
 218       To avoid memory peak parts over 2GB are sent using EFF_CHUNK_SIZE size.
 219       """
 220       data_for_split_case = bytes(0)
 221       EFF_CHUNK_SIZE = SeqByteReceiver.CHUNK_SIZE // 8
 222       iStart = 0 ; iEnd = EFF_CHUNK_SIZE
 223       while iStart!=iEnd and iEnd <= size:
 224         part = self._obj.sendPart(iStart,iEnd)
 225         data_for_split_case = bytes(0).join( [data_for_split_case,part] )
 226         iStart = iEnd; iEnd = min(iStart + EFF_CHUNK_SIZE,size)
 227       return data_for_split_case
 228
 229 class PyScriptNode_i (Engines__POA.PyScriptNode,Generic):
 230   """The implementation of the PyScriptNode CORBA IDL that executes a script"""
 231   def __init__(self, nodeName,code,poa,my_container):
 232     """Initialize the node : compilation in the local context"""
 233     Generic.__init__(self,poa)
 234     self.nodeName=nodeName
 235     self.code=code
 236     self.my_container=my_container._container
 237     linecache.cache[nodeName]=0,None,code.split('\n'),nodeName
 238     self.ccode=compile(code,nodeName,'exec')
 239     self.context={}
 240     self.context["my_container"] = self.my_container
 241
 242   def getContainer(self):
 243     return self.my_container
 244
 245   def getCode(self):
 246     return self.code
 247
 248   def getName(self):
 249     return self.nodeName
 250
 251   def defineNewCustomVar(self,varName,valueOfVar):
 252     self.context[varName] = pickle.loads(valueOfVar)
 253     pass
 254
 255   def executeAnotherPieceOfCode(self,code):
 256     """Called for initialization of container lodging self."""
 257     try:
 258       ccode=compile(code,self.nodeName,'exec')
 259       exec(ccode, self.context)
 260     except Exception:
 261       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode (%s) : code to be executed \"%s\"" %(self.nodeName,code),0))
 262
 263   def assignNewCompiledCode(self,codeStr):
 264     try:
 265       self.code=codeStr
 266       self.ccode=compile(codeStr,self.nodeName,'exec')
 267     except Exception:
 268       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode.assignNewCompiledCode (%s) : code to be executed \"%s\"" %(self.nodeName,codeStr),0))
 269
 270   def execute(self,outargsname,argsin):
 271     """Execute the script stored in attribute ccode with pickled args (argsin)"""
 272     try:
 273       argsname,kws=pickle.loads(argsin)
 274       self.context.update(kws)
 275       exec(self.ccode, self.context)
 276       argsout=[]
 277       for arg in outargsname:
 278         if arg not in self.context:
 279           raise KeyError("There is no variable %s in context" % arg)
 280         argsout.append(self.context[arg])
 281       argsout=pickle.dumps(tuple(argsout),-1)
 282       return argsout
 283     except Exception:
 284       exc_typ,exc_val,exc_fr=sys.exc_info()
 285       l=traceback.format_exception(exc_typ,exc_val,exc_fr)
 286       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s, outargsname: %s" % (self.nodeName,outargsname),0))
 287
 288   def executeFirst(self,argsin):
 289     """ Same than first part of self.execute to reduce memory peak."""
 290     import time
 291     try:
 292       data = None
 293       if True: # to force call of SeqByteReceiver's destructor
 294         argsInPy = SeqByteReceiver( argsin )
 295         data = argsInPy.data()
 296       _,kws=pickle.loads(data)
 297       for elt in kws:
 298         kws[elt] = UnProxyObject( kws[elt] )
 299       self.context.update(kws)
 300     except Exception:
 301       exc_typ,exc_val,exc_fr=sys.exc_info()
 302       l=traceback.format_exception(exc_typ,exc_val,exc_fr)
 303       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode:First %s" % (self.nodeName),0))
 304
 305   def executeSecond(self,outargsname):
 306     """ Same than second part of self.execute to reduce memory peak."""
 307     try:
 308       exec(self.ccode, self.context)
 309       argsout=[]
 310       for arg in outargsname:
 311         if arg not in self.context:
 312           raise KeyError("There is no variable %s in context" % arg)
 313         argsout.append(self.context[arg])
 314       ret = [ ]
 315       for arg in argsout:
 316         argPickle = SpoolPickleObject( arg )
 317         retArg = SenderByte_i( self.poa,argPickle )
 318         id_o = self.poa.activate_object(retArg)
 319         retObj = self.poa.id_to_reference(id_o)
 320         ret.append( retObj._narrow( SALOME.SenderByte ) )
 321       return ret
 322     except Exception:
 323       exc_typ,exc_val,exc_fr=sys.exc_info()
 324       l=traceback.format_exception(exc_typ,exc_val,exc_fr)
 325       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode:Second %s, outargsname: %s" % (self.nodeName,outargsname),0))
 326
 327   def getValueOfVarInContext(self,varName):
 328     try:
 329       return pickle.dumps(self.context[varName],-1)
 330     except Exception:
 331       exc_typ,exc_val,exc_fr=sys.exc_info()
 332       l=traceback.format_exception(exc_typ,exc_val,exc_fr)
 333       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
 334     pass
 335
 336   def assignVarInContext(self, varName, value):
 337     try:
 338       self.context[varName][0] = pickle.loads(value)
 339     except Exception:
 340       exc_typ,exc_val,exc_fr=sys.exc_info()
 341       l=traceback.format_exception(exc_typ,exc_val,exc_fr)
 342       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
 343     pass
 344
 345   def callMethodOnVarInContext(self, varName, methodName, args):
 346     try:
 347       return pickle.dumps( getattr(self.context[varName][0],methodName)(*pickle.loads(args)),-1 )
 348     except Exception:
 349       exc_typ,exc_val,exc_fr=sys.exc_info()
 350       l=traceback.format_exception(exc_typ,exc_val,exc_fr)
 351       raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
 352     pass