1 # -*- coding: iso-8859-1 -*-
2 # Copyright (C) 2007-2023 CEA, EDF, OPEN CASCADE
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.
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.
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
18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 # File : SALOME_PyNode.py
22 # Author : Christian CAREMOLI, EDF
33 MY_CONTAINER_ENTRY_IN_GLBS = "my_container"
35 class Generic(SALOME__POA.GenericObj):
36 """A Python implementation of the GenericObj CORBA IDL"""
37 def __init__(self,poa):
42 #print("Register called : %d"%self.cnt)
46 #print("UnRegister called : %d"%self.cnt)
49 oid=self.poa.servant_to_id(self)
50 self.poa.deactivate_object(oid)
53 print("WARNING SALOME::GenericObj::Destroy() function is obsolete! Use UnRegister() instead.")
57 #print("Destuctor called")
60 class PyNode_i (Engines__POA.PyNode,Generic):
61 """The implementation of the PyNode CORBA IDL"""
62 def __init__(self, nodeName,code,poa,my_container):
63 """Initialize the node : compilation in the local context"""
64 Generic.__init__(self,poa)
65 self.nodeName=nodeName
67 self.my_container=my_container._container
68 linecache.cache[nodeName]=0,None,code.split('\n'),nodeName
69 ccode=compile(code,nodeName,'exec')
71 self.context[MY_CONTAINER_ENTRY_IN_GLBS] = self.my_container
72 exec(ccode, self.context)
74 def getContainer(self):
75 return self.my_container
83 def defineNewCustomVar(self,varName,valueOfVar):
84 self.context[varName] = pickle.loads(valueOfVar)
87 def executeAnotherPieceOfCode(self,code):
88 """Called for initialization of container lodging self."""
90 ccode=compile(code,self.nodeName,'exec')
91 exec(ccode, self.context)
93 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode (%s) : code to be executed \"%s\"" %(self.nodeName,code),0))
95 def execute(self,funcName,argsin):
96 """Execute the function funcName found in local context with pickled args (argsin)"""
98 argsin,kws=pickle.loads(argsin)
99 func=self.context[funcName]
100 argsout=func(*argsin,**kws)
101 argsout=pickle.dumps(argsout,-1)
104 exc_typ,exc_val,exc_fr=sys.exc_info()
105 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
106 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyNode: %s, function: %s" % (self.nodeName,funcName),0))
108 class SenderByte_i(SALOME__POA.SenderByte,Generic):
109 def __init__(self,poa,bytesToSend):
110 Generic.__init__(self,poa)
111 self.bytesToSend = bytesToSend
114 return len(self.bytesToSend)
116 def sendPart(self,n1,n2):
117 return self.bytesToSend[n1:n2]
119 SALOME_FILE_BIG_OBJ_DIR = "SALOME_FILE_BIG_OBJ_DIR"
121 SALOME_BIG_OBJ_ON_DISK_THRES_VAR = "SALOME_BIG_OBJ_ON_DISK_THRES"
124 SALOME_BIG_OBJ_ON_DISK_THRES_DFT = 50000000
126 from ctypes import c_int
130 return len( bytes(TypeCounter(0) ) )
132 def GetObjectFromFile(fname):
133 with open(fname,"rb") as f:
134 cntb = f.read( GetSizeOfTCnt() )
135 cnt = TypeCounter.from_buffer_copy( cntb ).value
139 def DumpInFile(obj,fname):
140 with open(fname,"wb") as f:
141 f.write( bytes( TypeCounter(1) ) )
144 def IncrRefInFile(fname):
145 with open(fname,"rb") as f:
146 cntb = f.read( GetSizeOfTCnt() )
147 cnt = TypeCounter.from_buffer_copy( cntb ).value
148 with open(fname,"rb+") as f:
149 f.write( bytes( TypeCounter(cnt+1) ) )
151 def DecrRefInFile(fname):
153 with open(fname,"rb") as f:
154 cntb = f.read( GetSizeOfTCnt() )
155 cnt = TypeCounter.from_buffer_copy( cntb ).value
160 with open(fname,"rb+") as f:
161 f.write( bytes( TypeCounter(cnt-1) ) )
163 def GetBigObjectOnDiskThreshold():
165 if SALOME_BIG_OBJ_ON_DISK_THRES_VAR in os.environ:
166 return int( os.environ[SALOME_BIG_OBJ_ON_DISK_THRES_VAR] )
168 return SALOME_BIG_OBJ_ON_DISK_THRES_DFT
170 def ActivateProxyMecanismOrNot( sizeInByte ):
171 thres = GetBigObjectOnDiskThreshold()
175 return sizeInByte > thres
177 def GetBigObjectDirectory():
179 if SALOME_FILE_BIG_OBJ_DIR not in os.environ:
180 raise RuntimeError("An object of size higher than limit detected and no directory specified to dump it in file !")
181 return os.path.expanduser( os.path.expandvars( os.environ[SALOME_FILE_BIG_OBJ_DIR] ) )
183 def GetBigObjectFileName():
185 Return a filename in the most secure manner (see tempfile documentation)
188 with tempfile.NamedTemporaryFile(dir=GetBigObjectDirectory(),prefix="mem_",suffix=".pckl") as f:
192 class BigObjectOnDiskBase:
193 def __init__(self, fileName, objSerialized):
195 :param fileName: the file used to dump into.
196 :param objSerialized: the object in pickeled form
197 :type objSerialized: bytes
199 self._filename = fileName
200 # attribute _destroy is here to tell client side or server side
201 # only client side can be with _destroy set to True. server side due to risk of concurrency
202 # so pickled form of self must be done with this attribute set to False.
203 self._destroy = False
204 self.__dumpIntoFile(objSerialized)
206 def getDestroyStatus(self):
211 IncrRefInFile( self._filename )
213 # should never happen !
214 RuntimeError("Invalid call to incrRef !")
218 DecrRefInFile( self._filename )
220 # should never happen !
221 RuntimeError("Invalid call to decrRef !")
223 def unlinkOnDestructor(self):
226 def doNotTouchFile(self):
228 Method called slave side. The life cycle management of file is client side not slave side.
230 self._destroy = False
234 DecrRefInFile( self._filename )
236 def getFileName(self):
237 return self._filename
239 def __dumpIntoFile(self, objSerialized):
240 DumpInFile( objSerialized, self._filename )
243 obj, _ = GetObjectFromFile( self._filename )
247 return float( self.get() )
250 return int( self.get() )
254 if isinstance(obj,str):
257 raise RuntimeError("Not a string")
259 class BigObjectOnDisk(BigObjectOnDiskBase):
260 def __init__(self, fileName, objSerialized):
261 BigObjectOnDiskBase.__init__(self, fileName, objSerialized)
263 class BigObjectOnDiskListElement(BigObjectOnDiskBase):
264 def __init__(self, pos, length, fileName):
265 self._filename = fileName
266 self._destroy = False
268 self._length = length
271 fullObj = BigObjectOnDiskBase.get(self)
272 return fullObj[ self._pos ]
274 def __getitem__(self, i):
278 return len(self.get())
280 class BigObjectOnDiskSequence(BigObjectOnDiskBase):
281 def __init__(self, length, fileName, objSerialized):
282 BigObjectOnDiskBase.__init__(self, fileName, objSerialized)
283 self._length = length
285 def __getitem__(self, i):
286 return BigObjectOnDiskListElement(i, self._length, self.getFileName())
291 class BigObjectOnDiskList(BigObjectOnDiskSequence):
292 def __init__(self, length, fileName, objSerialized):
293 BigObjectOnDiskSequence.__init__(self, length, fileName, objSerialized)
295 class BigObjectOnDiskTuple(BigObjectOnDiskSequence):
296 def __init__(self, length, fileName, objSerialized):
297 BigObjectOnDiskSequence.__init__(self, length, fileName, objSerialized)
299 def SpoolPickleObject( obj ):
301 pickleObjInit = pickle.dumps( obj , pickle.HIGHEST_PROTOCOL )
302 if not ActivateProxyMecanismOrNot( len(pickleObjInit) ):
305 if isinstance( obj, list):
306 proxyObj = BigObjectOnDiskList( len(obj), GetBigObjectFileName() , pickleObjInit )
307 elif isinstance( obj, tuple):
308 proxyObj = BigObjectOnDiskTuple( len(obj), GetBigObjectFileName() , pickleObjInit )
310 proxyObj = BigObjectOnDisk( GetBigObjectFileName() , pickleObjInit )
311 pickleProxy = pickle.dumps( proxyObj , pickle.HIGHEST_PROTOCOL )
314 def UnProxyObjectSimple( obj ):
316 Method to be called in Remote mode. Alterate the obj _status attribute.
317 Because the slave process does not participate in the reference counting
319 if isinstance(obj,BigObjectOnDiskBase):
322 elif isinstance( obj, list):
325 retObj.append( UnProxyObjectSimple(elt) )
330 def UnProxyObjectSimpleLocal( obj ):
332 Method to be called in Local mode. Do not alterate the PyObj counter
334 if isinstance(obj,BigObjectOnDiskBase):
336 elif isinstance( obj, list):
339 retObj.append( UnProxyObjectSimpleLocal(elt) )
344 class SeqByteReceiver:
345 # 2GB limit to trigger split into chunks
346 CHUNK_SIZE = 2000000000
347 def __init__(self,sender):
350 self._obj.UnRegister()
353 size = self._obj.getSize()
354 if size <= SeqByteReceiver.CHUNK_SIZE:
355 return self.fetchOneShot( size )
357 return self.fetchByChunks( size )
358 def fetchOneShot(self,size):
359 return self._obj.sendPart(0,size)
360 def fetchByChunks(self,size):
362 To avoid memory peak parts over 2GB are sent using EFF_CHUNK_SIZE size.
364 data_for_split_case = bytes(0)
365 EFF_CHUNK_SIZE = SeqByteReceiver.CHUNK_SIZE // 8
366 iStart = 0 ; iEnd = EFF_CHUNK_SIZE
367 while iStart!=iEnd and iEnd <= size:
368 part = self._obj.sendPart(iStart,iEnd)
369 data_for_split_case = bytes(0).join( [data_for_split_case,part] )
370 iStart = iEnd; iEnd = min(iStart + EFF_CHUNK_SIZE,size)
371 return data_for_split_case
373 class PyScriptNode_i (Engines__POA.PyScriptNode,Generic):
374 """The implementation of the PyScriptNode CORBA IDL that executes a script"""
375 def __init__(self, nodeName,code,poa,my_container):
376 """Initialize the node : compilation in the local context"""
377 Generic.__init__(self,poa)
378 self.nodeName=nodeName
380 self.my_container=my_container._container
381 linecache.cache[nodeName]=0,None,code.split('\n'),nodeName
382 self.ccode=compile(code,nodeName,'exec')
384 self.context[MY_CONTAINER_ENTRY_IN_GLBS] = self.my_container
387 # force removal of self.context. Don t know why it s not done by default
388 self.removeAllVarsInContext()
391 def getContainer(self):
392 return self.my_container
400 def defineNewCustomVar(self,varName,valueOfVar):
401 self.context[varName] = pickle.loads(valueOfVar)
404 def executeAnotherPieceOfCode(self,code):
405 """Called for initialization of container lodging self."""
407 ccode=compile(code,self.nodeName,'exec')
408 exec(ccode, self.context)
410 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode (%s) : code to be executed \"%s\"" %(self.nodeName,code),0))
412 def assignNewCompiledCode(self,codeStr):
415 self.ccode=compile(codeStr,self.nodeName,'exec')
417 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode.assignNewCompiledCode (%s) : code to be executed \"%s\"" %(self.nodeName,codeStr),0))
419 def execute(self,outargsname,argsin):
420 """Execute the script stored in attribute ccode with pickled args (argsin)"""
422 argsname,kws=pickle.loads(argsin)
423 self.context.update(kws)
424 exec(self.ccode, self.context)
426 for arg in outargsname:
427 if arg not in self.context:
428 raise KeyError("There is no variable %s in context" % arg)
429 argsout.append(self.context[arg])
430 argsout=pickle.dumps(tuple(argsout),-1)
433 exc_typ,exc_val,exc_fr=sys.exc_info()
434 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
435 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s, outargsname: %s" % (self.nodeName,outargsname),0))
437 def executeFirst(self,argsin):
438 """ Same than first part of self.execute to reduce memory peak."""
442 if True: # to force call of SeqByteReceiver's destructor
443 argsInPy = SeqByteReceiver( argsin )
444 data = argsInPy.data()
445 _,kws=pickle.loads(data)
447 # fetch real data if necessary
448 kws[elt] = UnProxyObjectSimple( kws[elt] )
449 self.context.update(kws)
451 exc_typ,exc_val,exc_fr=sys.exc_info()
452 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
453 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode:First %s" % (self.nodeName),0))
455 def executeSecond(self,outargsname):
456 """ Same than second part of self.execute to reduce memory peak."""
458 exec(self.ccode, self.context)
460 for arg in outargsname:
461 if arg not in self.context:
462 raise KeyError("There is no variable %s in context" % arg)
463 argsout.append(self.context[arg])
466 # the proxy mecanism is catched here
467 argPickle = SpoolPickleObject( arg )
468 retArg = SenderByte_i( self.poa,argPickle )
469 id_o = self.poa.activate_object(retArg)
470 retObj = self.poa.id_to_reference(id_o)
471 ret.append( retObj._narrow( SALOME.SenderByte ) )
474 exc_typ,exc_val,exc_fr=sys.exc_info()
475 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
476 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode:Second %s, outargsname: %s" % (self.nodeName,outargsname),0))
478 def listAllVarsInContext(self):
480 pat = re.compile("^__([a-z]+)__$")
481 return [elt for elt in self.context if not pat.match(elt) and elt != MY_CONTAINER_ENTRY_IN_GLBS]
483 def removeAllVarsInContext(self):
484 for elt in self.listAllVarsInContext():
485 del self.context[elt]
487 def getValueOfVarInContext(self,varName):
489 return pickle.dumps(self.context[varName],-1)
491 exc_typ,exc_val,exc_fr=sys.exc_info()
492 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
493 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
496 def assignVarInContext(self, varName, value):
498 self.context[varName][0] = pickle.loads(value)
500 exc_typ,exc_val,exc_fr=sys.exc_info()
501 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
502 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
505 def callMethodOnVarInContext(self, varName, methodName, args):
507 return pickle.dumps( getattr(self.context[varName][0],methodName)(*pickle.loads(args)),-1 )
509 exc_typ,exc_val,exc_fr=sys.exc_info()
510 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
511 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))