python.trfEnv.environmentUpdate Class Reference

Class holding the update to an environment that will be passed on to an executor. More...

Inheritance diagram for python.trfEnv.environmentUpdate:

Collaboration diagram for python.trfEnv.environmentUpdate:

Public Member Functions
def	__init__ (self)
def	setStandardEnvironment (self, argdict, name='all', substep='')
	Setup the standard execution environment according to the switches in the transform configuration. More...
def	probeIMFSettings (self, argdict, name='all', substep='')
	Add the libimf maths library to the setup. More...
def	probeTcmallocSettings (self, argdict, name='all', substep='')
	Add TCMALLOC to the setup. More...
def	probeOtherSettings (self, argdict, name='all', substep='')
	Add other settings. More...
def	value (self, key)
	Return the value for a key, string converted. More...
def	values (self)
	Return a list of KEY=VALUE pairs for this environment. More...
def	len (self)
	Count the number of environment items that need to be updated. More...

Private Member Functions
def	_addIMFSettings (self)

Private Attributes
	_envdict

Detailed Description

Class holding the update to an environment that will be passed on to an executor.

Definition at line 15 of file trfEnv.py.

Constructor & Destructor Documentation

__init__()

def python.trfEnv.environmentUpdate.__init__

(

self

)

Definition at line 17 of file trfEnv.py.

    def __init__(self):
        self._envdict = {}
        

Member Function Documentation

_addIMFSettings()

def python.trfEnv.environmentUpdate._addIMFSettings (   self )

private

Definition at line 42 of file trfEnv.py.

    def _addIMFSettings(self):
        if 'ATLASMKLLIBDIR_PRELOAD' not in os.environ:
                msg.warning('"ATLASMKLLIBDIR_PRELOAD" not found in the current environment'
                            ' - no setup of MKL is possible')
                return
        
        if 'ATLASMKLLIBDIR_PRELOAD' in os.environ:
            if "LD_PRELOAD" not in self._envdict:
                self._envdict["LD_PRELOAD"] = pathVar("LD_PRELOAD")
            self._envdict["LD_PRELOAD"].add(path.join("$ATLASMKLLIBDIR_PRELOAD", "libimf.so"))
            self._envdict["LD_PRELOAD"].add(path.join("$ATLASMKLLIBDIR_PRELOAD", "libintlc.so.5"))
 
 

len()

def python.trfEnv.environmentUpdate.len

(

self

)

Count the number of environment items that need to be updated.

Definition at line 100 of file trfEnv.py.

    def len(self):
        return len(self._envdict)
    
        

probeIMFSettings()

def python.trfEnv.environmentUpdate.probeIMFSettings	(		self,
			argdict,
			name = 'all',
			substep = ''
	)

Add the libimf maths library to the setup.

Definition at line 28 of file trfEnv.py.

    def probeIMFSettings(self, argdict, name='all', substep=''):
        # If imf=True/False then follow its lead, but otherwise try to detect the release
        # and enable if we have a release >= 17.7
        if 'imf' in argdict:
            if argdict['imf'].returnMyValue(name=name, substep=substep) is False:
                msg.info('Skipping inclusion of imf libraries: --imf is set to False')
            else:
                msg.info('Enabling inclusion of imf libraries: --imf is set to True')
                self._addIMFSettings()
            return
 
        self._addIMFSettings()
 
 

probeOtherSettings()

def python.trfEnv.environmentUpdate.probeOtherSettings	(		self,
			argdict,
			name = 'all',
			substep = ''
	)

Add other settings.

Definition at line 74 of file trfEnv.py.

    def probeOtherSettings(self, argdict, name='all', substep=''):
        if 'env' not in argdict:
            return
        
        myEnv = argdict['env'].returnMyValue(name=name, substep=substep)
        if myEnv is None:
            return
        
        for setting in myEnv:
            try:
                k, v = setting.split('=', 1)
                self._envdict[k] = v
            except ValueError:
                msg.warning('Environment setting "{0}" seems to be invalid (must be KEY=VALUE)')
                

probeTcmallocSettings()

def python.trfEnv.environmentUpdate.probeTcmallocSettings	(		self,
			argdict,
			name = 'all',
			substep = ''
	)

Add TCMALLOC to the setup.

Definition at line 56 of file trfEnv.py.

    def probeTcmallocSettings(self, argdict, name='all', substep=''):
        # We only do this if  tcmalloc=True in atgdict
        if 'tcmalloc' not in argdict or argdict['tcmalloc'].returnMyValue(name=name, substep=substep) is False:
            msg.info('Skipping inclusion of tcmalloc')
            return
    
        if 'TCMALLOCDIR' not in os.environ:
            msg.warning('"TCMALLOCDIR" not found in the current environment'
                        ' - no setup of tcmalloc is possible')
            return
 
        # For now we support the minimal version (it's the default)
        if "LD_PRELOAD" not in self._envdict:
            self._envdict["LD_PRELOAD"] = pathVar("LD_PRELOAD")
        self._envdict["LD_PRELOAD"].add(path.join("$TCMALLOCDIR", "libtcmalloc_minimal.so"))
    
 

setStandardEnvironment()

def python.trfEnv.environmentUpdate.setStandardEnvironment	(		self,
			argdict,
			name = 'all',
			substep = ''
	)

Setup the standard execution environment according to the switches in the transform configuration.

Definition at line 22 of file trfEnv.py.

    def setStandardEnvironment(self, argdict, name='all', substep=''):
        self.probeIMFSettings(argdict, name=name, substep=substep)
        self.probeTcmallocSettings(argdict, name=name, substep=substep)
        self.probeOtherSettings(argdict, name=name, substep=substep)
        

value()

def python.trfEnv.environmentUpdate.value	(		self,
			key
	)

Return the value for a key, string converted.

Definition at line 90 of file trfEnv.py.

    def value(self, key):
        return str(self._envdict[key])
                

values()

def python.trfEnv.environmentUpdate.values

(

self

)

Return a list of KEY=VALUE pairs for this environment.

Definition at line 95 of file trfEnv.py.

    def values(self):
        return [ "{0}={1}".format(k, v) for k, v in self._envdict.items() ]
    

Member Data Documentation

_envdict

python.trfEnv.environmentUpdate._envdict

private

Definition at line 18 of file trfEnv.py.

---

The documentation for this class was generated from the following file:

• trfEnv.py