trfExitCodes.py

Go to the documentation of this file.

# Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
 

 
import signal
 
import logging
msg = logging.getLogger(__name__)
 

class trfExitCode(object):
    
    
    def __init__(self, acronymn, numcode, description, signalname = ""):
        self._acronymn = acronymn
        self._numcode = numcode
        self._description = description
        self._signalname = signalname
        
    @property
    def acronymn(self):
        return self._acronymn
    
    @property
    def numcode(self):
        return self._numcode
    
    @property
    def description(self):
        return self._description
 
    @property
    def signalname(self):
        return self._signalname
 

class trfExitCodes(object):
    
    _errorCodeList = list()
    _errorCodeList.append(trfExitCode('OK', 0, 'Successful exit'))
    _errorCodeList.append(trfExitCode('NEEDCHECK', 1, 'Job needs manual intervention'))
    _errorCodeList.append(trfExitCode('TRF_SETUP', 3, 'Transform setup error'))
    _errorCodeList.append(trfExitCode('TRF_ARG_CONV_FAIL', 4, 'Failure to convert transform arguments to correct type'))
    _errorCodeList.append(trfExitCode('TRF_ARG_OUT_OF_RANGE', 5, 'Argument out of allowed range'))
    _errorCodeList.append(trfExitCode('TRF_ARG_ERROR', 7, 'Problem with an argument given to the transform'))
    _errorCodeList.append(trfExitCode('TRF_ARG_DATASET', 8, 'Inconsistent dataset value in input file list'))
    _errorCodeList.append(trfExitCode('TRF_INPUT_FILE_ERROR', 9, 'Error found with transform input file'))
    _errorCodeList.append(trfExitCode('TRF_OUTPUT_FILE_ERROR', 11, 'Error when handling transform output file'))
    _errorCodeList.append(trfExitCode('TRF_GRAPH_ERROR', 12, 'Problem in setting up the substep graph'))
    _errorCodeList.append(trfExitCode('TRF_EXECUTION_PATH_ERROR', 13, 'Problem trying to generate requested outputs from given inputs - graph give no path to do this'))
    _errorCodeList.append(trfExitCode('TRF_KEY_ERROR', 14, 'Key error in a transform internal dictionary'))
    _errorCodeList.append(trfExitCode('TRF_NOEVENTS', 15, 'No events to be processed in the input file - skipEvents is higher than actual event number'))
    _errorCodeList.append(trfExitCode('TRF_ARG_CHOICES_FAIL', 16, 'Invalid selection in a choice restricted argument'))
    _errorCodeList.append(trfExitCode('TRF_ARG_MISSING', 17, 'Mandatory argument is missing'))
    _errorCodeList.append(trfExitCode('TRF_REDUCTION_CONFIG_ERROR', 18, 'Invalid configuration of a reduction job'))
    _errorCodeList.append(trfExitCode('TRF_GRAPH_STEERING_ERROR', 19, 'Problem when trying to apply steering to the substep graph'))
    _errorCodeList.append(trfExitCode('TRF_INTERNAL_REPORT_ERROR', 35, 'Internal error while generating transform reports'))
    _errorCodeList.append(trfExitCode('TRF_METADATA_CALL_FAIL', 36, 'Call to external metadata program failed'))
    _errorCodeList.append(trfExitCode('TRF_RUNTIME_ERROR', 37, 'General runtime error'))
    _errorCodeList.append(trfExitCode('TRF_EXEC_VALIDATION_EVENTCOUNT', 38, 'Event count validation failed'))
    _errorCodeList.append(trfExitCode('TRF_DBRELEASE_PROBLEM', 39, 'Failed to setup DBRelease properly'))
    _errorCodeList.append(trfExitCode('TRF_FILEMERGE_PROBLEM', 52, 'Problem while attempting to merge output files'))
    _errorCodeList.append(trfExitCode('TRF_EXEC', 64, 'General failure in transform substep executor'))
    _errorCodeList.append(trfExitCode('TRF_EXEC_FAIL', 65, 'Non-zero exit code from transform substep executor'))
    _errorCodeList.append(trfExitCode('TRF_EXEC_VALIDATION_FAIL', 66, 'Validation failure in transform substep executor'))
    _errorCodeList.append(trfExitCode('TRF_EXEC_TIMEOUT', 67, 'Transform substep executor timed out'))
    _errorCodeList.append(trfExitCode('TRF_EXEC_LOGERROR', 68, 'Errors found in substep executor logfile'))
    _errorCodeList.append(trfExitCode('TRF_EXEC_SETUP_FAIL', 69, 'Transform substep executor setup failed'))
    _errorCodeList.append(trfExitCode('TRF_EXEC_SETUP_WRAPPER', 70, 'Transform substep executor wrapper script problem'))
    _errorCodeList.append(trfExitCode('TRF_LOGFILE_FAIL', 71, 'Problem with substep executor logfile'))
    _errorCodeList.append(trfExitCode('TRF_AMI_ERROR' , 72, 'Problem getting AMI tag info'))
    _errorCodeList.append(trfExitCode('TRF_EXEC_RUNARGS_ERROR' , 73, 'Problem with executor runargs file'))    
    _errorCodeList.append(trfExitCode('TRF_INPUT_FILE_VALIDATION_FAIL' , 74, 'Input file failed validation'))
    _errorCodeList.append(trfExitCode('TRF_OUTPUT_FILE_VALIDATION_FAIL' , 75, 'Output file failed validation'))
    _errorCodeList.append(trfExitCode('TRF_UNEXPECTED_TRF_EXCEPTION', 250, 'Transform exception raised which the transform did not handle'))
    _errorCodeList.append(trfExitCode('TRF_UNEXPECTED_OTHER_EXCEPTION', 251, 'General exception raised which the transform did not handle'))
    _errorCodeList.append(trfExitCode('TRF_EXTERNAL', 251, 'Transform error in external call'))
    _errorCodeList.append(trfExitCode('TRF_INTERNAL', 252, 'Internal transform error'))
    _errorCodeList.append(trfExitCode('TRF_UNKNOWN', 253, 'Unknown error code'))
    
    # Add signaled exits without duplicates
    _errorCodeList.extend([trfExitCode('TRF_SIG_'+signalname, getattr(signal, signalname)+128, 'Transform received signal {0}'.format(signalname), signalname) 
                           for signalname in dir(signal) if signalname.startswith('SIG') 
                           and '_' not in signalname
                           and 'SIGIOT' not in signalname
                           and 'SIGCLD' not in signalname
                           and 'SIGPOLL' not in signalname])
 
    # Now map the entries to fast lookup dictionaries
    _nameToCodeDict = dict()
    _codeToNameDict = dict()
    _nameToDescDict = dict()
    _codeToSignalnameDict = dict()
    for error in _errorCodeList:
        _nameToCodeDict[error.acronymn] = error.numcode
        _codeToNameDict[error.numcode] = error.acronymn
        _nameToDescDict[error.acronymn] = error.description
        _codeToSignalnameDict[error.numcode] = error.signalname
    
 
    def __init__(self):
        pass    
    
    @staticmethod
    def nameToCode(name = None):
        if name in trfExitCodes._nameToCodeDict:
            return trfExitCodes._nameToCodeDict[name]
        else:
            msg.warning('Could not map exit name {0} to an exit code'.format(name))
            return trfExitCodes._nameToCodeDict['TRF_UNKNOWN']
        
    @staticmethod
    def codeToName(code = None):
        if code in trfExitCodes._codeToNameDict:
            return trfExitCodes._codeToNameDict[code]
        else:
            msg.warning('Could not map exit code {0} to an exit name'.format(code))
            return 'TRF_UNKNOWN'
 
    @staticmethod
    def nameToDesc(name = None):
        if name in trfExitCodes._nameToDescDict:
            return trfExitCodes._nameToDescDict[name]
        else:
            msg.warning('Could not map exit name {0} to a description'.format(name))
            return 'No description available'
 
    @staticmethod
    def codeToSignalname(code = None):
        if code in trfExitCodes._codeToSignalnameDict:
            return trfExitCodes._codeToSignalnameDict[code]
        else:
            # Not a signal we knew about
            return ''
 
 
trfExit = trfExitCodes()