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
159 #print("Remove {}".format(fname))
160 #print("Remove {}".format(str(GetObjectFromFile(fname)[0])))
163 with open(fname,"rb+") as f:
164 f.write( bytes( TypeCounter(cnt-1) ) )
166 def GetBigObjectOnDiskThreshold():
168 if SALOME_BIG_OBJ_ON_DISK_THRES_VAR in os.environ:
169 return int( os.environ[SALOME_BIG_OBJ_ON_DISK_THRES_VAR] )
171 return SALOME_BIG_OBJ_ON_DISK_THRES_DFT
173 def ActivateProxyMecanismOrNot( sizeInByte ):
174 thres = GetBigObjectOnDiskThreshold()
178 return sizeInByte > thres
180 def GetBigObjectDirectory():
182 if SALOME_FILE_BIG_OBJ_DIR not in os.environ:
183 raise RuntimeError("An object of size higher than limit detected and no directory specified to dump it in file !")
184 return os.path.expanduser( os.path.expandvars( os.environ[SALOME_FILE_BIG_OBJ_DIR] ) )
186 def GetBigObjectFileName():
188 Return a filename in the most secure manner (see tempfile documentation)
191 with tempfile.NamedTemporaryFile(dir=GetBigObjectDirectory(),prefix="mem_",suffix=".pckl") as f:
195 class BigObjectOnDiskBase:
196 def __init__(self, fileName, objSerialized):
198 :param fileName: the file used to dump into.
199 :param objSerialized: the object in pickeled form
200 :type objSerialized: bytes
202 self._filename = fileName
203 # attribute _destroy is here to tell client side or server side
204 # only client side can be with _destroy set to True. server side due to risk of concurrency
205 # so pickled form of self must be done with this attribute set to False.
206 self._destroy = False
207 self.__dumpIntoFile(objSerialized)
209 def getDestroyStatus(self):
214 IncrRefInFile( self._filename )
216 # should never happen !
217 RuntimeError("Invalid call to incrRef !")
221 DecrRefInFile( self._filename )
223 # should never happen !
224 RuntimeError("Invalid call to decrRef !")
226 def unlinkOnDestructor(self):
229 def doNotTouchFile(self):
231 Method called slave side. The life cycle management of file is client side not slave side.
233 self._destroy = False
237 DecrRefInFile( self._filename )
242 if os.path.exists( self._filename ):
243 DecrRefInFile( self._filename )
245 import KernelServices
246 KernelServices.GenerateViolentMemoryFaultForTestPurpose()
248 def getFileName(self):
249 return self._filename
251 def __dumpIntoFile(self, objSerialized):
252 DumpInFile( objSerialized, self._filename )
255 obj, _ = GetObjectFromFile( self._filename )
259 return float( self.get() )
262 return int( self.get() )
266 if isinstance(obj,str):
269 raise RuntimeError("Not a string")
271 class BigObjectOnDisk(BigObjectOnDiskBase):
272 def __init__(self, fileName, objSerialized):
273 BigObjectOnDiskBase.__init__(self, fileName, objSerialized)
275 class BigObjectOnDiskListElement(BigObjectOnDiskBase):
276 def __init__(self, pos, length, fileName):
277 self._filename = fileName
278 self._destroy = False
280 self._length = length
283 fullObj = BigObjectOnDiskBase.get(self)
284 return fullObj[ self._pos ]
286 def __getitem__(self, i):
290 return len(self.get())
292 class BigObjectOnDiskSequence(BigObjectOnDiskBase):
293 def __init__(self, length, fileName, objSerialized):
294 BigObjectOnDiskBase.__init__(self, fileName, objSerialized)
295 self._length = length
297 def __getitem__(self, i):
298 return BigObjectOnDiskListElement(i, self._length, self.getFileName())
303 class BigObjectOnDiskList(BigObjectOnDiskSequence):
304 def __init__(self, length, fileName, objSerialized):
305 BigObjectOnDiskSequence.__init__(self, length, fileName, objSerialized)
307 class BigObjectOnDiskTuple(BigObjectOnDiskSequence):
308 def __init__(self, length, fileName, objSerialized):
309 BigObjectOnDiskSequence.__init__(self, length, fileName, objSerialized)
311 def SpoolPickleObject( obj ):
313 pickleObjInit = pickle.dumps( obj , pickle.HIGHEST_PROTOCOL )
314 if not ActivateProxyMecanismOrNot( len(pickleObjInit) ):
317 if isinstance( obj, list):
318 proxyObj = BigObjectOnDiskList( len(obj), GetBigObjectFileName() , pickleObjInit )
319 elif isinstance( obj, tuple):
320 proxyObj = BigObjectOnDiskTuple( len(obj), GetBigObjectFileName() , pickleObjInit )
322 proxyObj = BigObjectOnDisk( GetBigObjectFileName() , pickleObjInit )
323 pickleProxy = pickle.dumps( proxyObj , pickle.HIGHEST_PROTOCOL )
326 def UnProxyObjectSimple( obj ):
328 Method to be called in Remote mode. Alterate the obj _status attribute.
329 Because the slave process does not participate in the reference counting
331 if isinstance(obj,BigObjectOnDiskBase):
334 elif isinstance( obj, list):
337 retObj.append( UnProxyObjectSimple(elt) )
342 def UnProxyObjectSimpleLocal( obj ):
344 Method to be called in Local mode. Do not alterate the PyObj counter
346 if isinstance(obj,BigObjectOnDiskBase):
348 elif isinstance( obj, list):
351 retObj.append( UnProxyObjectSimpleLocal(elt) )
356 class SeqByteReceiver:
357 # 2GB limit to trigger split into chunks
358 CHUNK_SIZE = 2000000000
359 def __init__(self,sender):
362 self._obj.UnRegister()
365 size = self._obj.getSize()
366 if size <= SeqByteReceiver.CHUNK_SIZE:
367 return self.fetchOneShot( size )
369 return self.fetchByChunks( size )
370 def fetchOneShot(self,size):
371 return self._obj.sendPart(0,size)
372 def fetchByChunks(self,size):
374 To avoid memory peak parts over 2GB are sent using EFF_CHUNK_SIZE size.
376 data_for_split_case = bytes(0)
377 EFF_CHUNK_SIZE = SeqByteReceiver.CHUNK_SIZE // 8
378 iStart = 0 ; iEnd = EFF_CHUNK_SIZE
379 while iStart!=iEnd and iEnd <= size:
380 part = self._obj.sendPart(iStart,iEnd)
381 data_for_split_case = bytes(0).join( [data_for_split_case,part] )
382 iStart = iEnd; iEnd = min(iStart + EFF_CHUNK_SIZE,size)
383 return data_for_split_case
385 class PyScriptNode_i (Engines__POA.PyScriptNode,Generic):
386 """The implementation of the PyScriptNode CORBA IDL that executes a script"""
387 def __init__(self, nodeName,code,poa,my_container):
388 """Initialize the node : compilation in the local context"""
389 Generic.__init__(self,poa)
390 self.nodeName=nodeName
392 self.my_container=my_container._container
393 linecache.cache[nodeName]=0,None,code.split('\n'),nodeName
394 self.ccode=compile(code,nodeName,'exec')
396 self.context[MY_CONTAINER_ENTRY_IN_GLBS] = self.my_container
399 # force removal of self.context. Don t know why it s not done by default
400 self.removeAllVarsInContext()
403 def getContainer(self):
404 return self.my_container
412 def defineNewCustomVar(self,varName,valueOfVar):
413 self.context[varName] = pickle.loads(valueOfVar)
416 def executeAnotherPieceOfCode(self,code):
417 """Called for initialization of container lodging self."""
419 ccode=compile(code,self.nodeName,'exec')
420 exec(ccode, self.context)
422 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode (%s) : code to be executed \"%s\"" %(self.nodeName,code),0))
424 def assignNewCompiledCode(self,codeStr):
427 self.ccode=compile(codeStr,self.nodeName,'exec')
429 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"","PyScriptNode.assignNewCompiledCode (%s) : code to be executed \"%s\"" %(self.nodeName,codeStr),0))
431 def executeSimple(self, key, val):
433 Same as execute method except that no pickelization mecanism is implied here. No output is expected
436 self.context.update({ "env" : [(k,v) for k,v in zip(key,val)]})
437 exec(self.ccode,self.context)
439 exc_typ,exc_val,exc_fr=sys.exc_info()
440 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
441 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" % (self.nodeName),0))
443 def execute(self,outargsname,argsin):
444 """Execute the script stored in attribute ccode with pickled args (argsin)"""
446 argsname,kws=pickle.loads(argsin)
447 self.context.update(kws)
448 exec(self.ccode, self.context)
450 for arg in outargsname:
451 if arg not in self.context:
452 raise KeyError("There is no variable %s in context" % arg)
453 argsout.append(self.context[arg])
454 argsout=pickle.dumps(tuple(argsout),-1)
457 exc_typ,exc_val,exc_fr=sys.exc_info()
458 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
459 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s, outargsname: %s" % (self.nodeName,outargsname),0))
461 def executeFirst(self,argsin):
462 """ Same than first part of self.execute to reduce memory peak."""
466 if True: # to force call of SeqByteReceiver's destructor
467 argsInPy = SeqByteReceiver( argsin )
468 data = argsInPy.data()
469 _,kws=pickle.loads(data)
471 # fetch real data if necessary
472 kws[elt] = UnProxyObjectSimple( kws[elt] )
473 self.context.update(kws)
475 exc_typ,exc_val,exc_fr=sys.exc_info()
476 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
477 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode:First %s" % (self.nodeName),0))
479 def executeSecond(self,outargsname):
480 """ Same than second part of self.execute to reduce memory peak."""
482 exec(self.ccode, self.context)
484 for arg in outargsname:
485 if arg not in self.context:
486 raise KeyError("There is no variable %s in context" % arg)
487 argsout.append(self.context[arg])
490 # the proxy mecanism is catched here
491 argPickle = SpoolPickleObject( arg )
492 retArg = SenderByte_i( self.poa,argPickle )
493 id_o = self.poa.activate_object(retArg)
494 retObj = self.poa.id_to_reference(id_o)
495 ret.append( retObj._narrow( SALOME.SenderByte ) )
498 exc_typ,exc_val,exc_fr=sys.exc_info()
499 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
500 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode:Second %s, outargsname: %s" % (self.nodeName,outargsname),0))
502 def listAllVarsInContext(self):
504 pat = re.compile("^__([a-z]+)__$")
505 return [elt for elt in self.context if not pat.match(elt) and elt != MY_CONTAINER_ENTRY_IN_GLBS]
507 def removeAllVarsInContext(self):
508 for elt in self.listAllVarsInContext():
509 del self.context[elt]
511 def getValueOfVarInContext(self,varName):
513 return pickle.dumps(self.context[varName],-1)
515 exc_typ,exc_val,exc_fr=sys.exc_info()
516 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
517 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
520 def assignVarInContext(self, varName, value):
522 self.context[varName][0] = pickle.loads(value)
524 exc_typ,exc_val,exc_fr=sys.exc_info()
525 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
526 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))
529 def callMethodOnVarInContext(self, varName, methodName, args):
531 return pickle.dumps( getattr(self.context[varName][0],methodName)(*pickle.loads(args)),-1 )
533 exc_typ,exc_val,exc_fr=sys.exc_info()
534 l=traceback.format_exception(exc_typ,exc_val,exc_fr)
535 raise SALOME.SALOME_Exception(SALOME.ExceptionStruct(SALOME.BAD_PARAM,"".join(l),"PyScriptNode: %s" %self.nodeName,0))