python.trfMTTools Namespace Reference

Functions
def	detectAthenaMTThreads (argdict={}, currentSubstep='', legacyThreadingRelease=False)
	Detect if AthenaMT has been requested. More...

Variables
	__version__
	msg

Function Documentation

detectAthenaMTThreads()

def python.trfMTTools.detectAthenaMTThreads	(		argdict = {},
			currentSubstep = '',
			legacyThreadingRelease = False
	)

Detect if AthenaMT has been requested.

Parameters

argdict

Argument dictionary, used to access athenaopts for the job

Returns

Two integers with the number of threads and number of concurrent events, N.B. 0 means non-MT serial mode

Definition at line 23 of file trfMTTools.py.

def detectAthenaMTThreads(argdict = {}, currentSubstep = '', legacyThreadingRelease = False):
    athenaMTThreads = 0
    athenaConcurrentEvents = 0
    currentSubstep = commonExecutorStepName(currentSubstep)
 
    if legacyThreadingRelease:
        return athenaMTThreads, athenaConcurrentEvents
 
    # Try and detect if any AthenaMT has been enabled 
    try:
        if 'athenaopts' in argdict:
            for substep in argdict['athenaopts'].value:
                if substep == 'all' or substep == currentSubstep:
                    threadArg = [opt.replace("--threads=", "") for opt in argdict['athenaopts'].value[substep] if '--threads' in opt]
                    if len(threadArg) == 0:
                        athenaMTThreads = 0
                    elif len(threadArg) == 1:
                        if 'multithreaded' in argdict and substep == 'all':
                            raise ValueError("Detected conflicting methods to configure AthenaMT: --multithreaded and --threads=N (via athenaopts). Only one method must be used")
                        athenaMTThreads = int(threadArg[0])
                        if athenaMTThreads < -1:
                            raise ValueError("--threads was set to a value less than -1")
                    else:
                        raise ValueError("--threads was set more than once in 'athenaopts'")
                    if athenaMTThreads > 0:
                        msg.info('AthenaMT detected from "threads" setting with {0} threads for substep {1}'.format(athenaMTThreads,substep))
 
                    concurrentEventsArg = [opt.replace("--concurrent-events=", "") for opt in argdict['athenaopts'].value[substep] if '--concurrent-events' in opt]
                    if len(concurrentEventsArg) == 1:
                        athenaConcurrentEvents = int(concurrentEventsArg[0])
                        if athenaConcurrentEvents < -1:
                            raise ValueError("--concurrent-events was set to a value less than -1")
                        msg.info('Custom concurrent event setting read from "concurrent-events" with {0} events for substep {1}'.format(athenaConcurrentEvents,substep))
                    else:
                        athenaConcurrentEvents = athenaMTThreads
        if (athenaMTThreads == 0 and
            'ATHENA_CORE_NUMBER' in os.environ and
            'multithreaded' in argdict and argdict['multithreaded'].value):
            athenaMTThreads = int(os.environ['ATHENA_CORE_NUMBER'])
            if athenaMTThreads < -1:
                raise ValueError("ATHENA_CORE_NUMBER value was less than -1")
            msg.info('AthenaMT detected from ATHENA_CORE_NUMBER with {0} threads'.format(athenaMTThreads))
            athenaConcurrentEvents = athenaMTThreads
    except ValueError as errMsg:
        myError = 'Problem discovering AthenaMT setup: {0}'.format(errMsg)
        raise trfExceptions.TransformExecutionException(trfExit.nameToCode('TRF_EXEC_SETUP_FAIL'), myError)
 
    return athenaMTThreads, athenaConcurrentEvents

Variable Documentation

__version__

python.trfMTTools.__version__

private

Definition at line 8 of file trfMTTools.py.

msg

python.trfMTTools.msg

Definition at line 13 of file trfMTTools.py.