vtune_athena Namespace Reference

Functions
	checkAthenaSetup ()
	Check Athena Setup.
	checkVTuneSetup ()
	Check VTune Setup.
	generateJOFragment (fileName, firstEvent, lastEvent)
	AutoGen a jobOptions fragment.
	main ()
	Main Function.

Variables
str	fmt = '%(asctime)s :: %(levelname)-8s :: %(message)s'
str	datefmt = '%m/%d/%Y %H:%M'
	logger = logging.getLogger(__name__)
	level
	format
	filename
	filemode
	console = logging.StreamHandler()
	formatter = logging.Formatter(fmt,datefmt=datefmt)

Function Documentation

checkAthenaSetup()

vtune_athena.checkAthenaSetup

(

)

Check Athena Setup.

Definition at line 26 of file vtune_athena.py.

def checkAthenaSetup():
    try:
      a = subprocess.check_output(['athena','--version'])
      logger.debug('Athena version information \n %s',a)
    except Exception:
      logger.fatal('Athena is not setup!')
      sys.exit(-1)
 

checkVTuneSetup()

vtune_athena.checkVTuneSetup

(

)

Check VTune Setup.

Definition at line 37 of file vtune_athena.py.

def checkVTuneSetup():
    try:
      a = subprocess.check_output(['vtune','--version'])
      logger.debug('VTune version information \n %s',a)
    except Exception:
      logger.fatal('VTune is not setup!')
      sys.exit(-1)
 

generateJOFragment()

vtune_athena.generateJOFragment	(		fileName,
			firstEvent,
			lastEvent )

AutoGen a jobOptions fragment.

Definition at line 48 of file vtune_athena.py.

def generateJOFragment(fileName,firstEvent,lastEvent):
    logger.info('Creating jOptions fragment %s', fileName)
    with open('{}'.format(fileName),'w') as f:
       f.write('# Auto generated jobOptions fragment to setup Athena VTune profiler')
       f.write('\ninclude(\'PerfMonVTune/VTuneProfileEventLoop_preInclude.py\')')
       f.write('\n\nfrom AthenaCommon.AppMgr import ServiceMgr')
       f.write('\nServiceMgr.VTuneProfilerService.ResumeEvent = {}'.format(firstEvent))
       f.write('\nServiceMgr.VTuneProfilerService.PauseEvent  = {}'.format(lastEvent))
 

main()

vtune_athena.main

(

)

Main Function.

Main function that parses user inputs, prepares and runs the tests 

Definition at line 60 of file vtune_athena.py.

def main():
    ''' Main function that parses user inputs, prepares and runs the tests '''
 
    from optparse import OptionParser
    parser=OptionParser(usage='%prog [options]',
                        version='%prog 0.1.0')
 
    parser.add_option('--log-level',
                      type='choice',
                      action='store',
                      dest='logLevel',
                      choices=['critical','error','warning','info','debug'],
                      default='info',
                      help='Logging level (default: info)')
 
    parser.add_option('--collect',
                      type='choice',
                      action='store',
                      dest='collect',
                      choices=['hotspots','threading','memory-consumption',
                               'hpc-performance','memory-access','cpugpu-concurrency',
                               'gpu-hotspots','gpu-profiling','graphics-rendering',
                               'fpga-interaction','io','system-overview'],
                      default='hotspots',
                      help='Run the specified analysis type and collect data into a result (default: hotspots)')
 
    parser.add_option('--strategy',
                      type='string',
                      dest='strategy',
                      default=':trace:trace',
                      help='Run the specified strategy and collect data into a result. (default: :trace:trace)')
 
    parser.add_option('--tf',
                      type='string',
                      dest='tf',
                      default='',
                      help='Run the specified transformation command and collect data into a result.')
 
    parser.add_option('--resumeEvent',
                      type='int',
                      dest='start',
                      default=0,
                      help='Start the profiling from the specified event (default: 0).')
 
    parser.add_option('--pauseEvent',
                      type='int',
                      dest='stop',
                      default=-1,
                      help='Start the profiling at the specified event (default: -1).')
 
    (options,args) = parser.parse_args()
 
    logger.info(76*'-')
 
    # Set logging level
    logger.setLevel(options.logLevel.upper())
 
    # Check the Athena and VTune setups
    checkAthenaSetup()
    checkVTuneSetup()
 
    # Perpare the JO fragment
    joFragment = 'PerfMonVTune_autoSetup.py'
    generateJOFragment(joFragment, options.start, options.stop)
 
    # Prepare the transformation command to execute
    if not options.tf:
        logger.fatal('The transformation command is empty, quitting...')
        sys.exit(-1)
 
    args = options.tf.split()
    if 'preInclude' in args:
        index = args.index('--preInclude')
        args.insert(index+1,joFragment)
    else:
        args.extend(['--preInclude',joFragment])
 
    # Run the command
    cmd = ( 'vtune' +
            ' -collect '  + options.collect  +
            ' -strategy ' + options.strategy +
            ' -start-paused -- ' )
    cmd += ' '.join(args)
 
    logger.info('Running the full command "{}"'.format(cmd))
    subprocess.call(cmd,shell=True)
 
    logger.info('All done...')
    logger.info(76*'-')
 

Variable Documentation

console

vtune_athena.console = logging.StreamHandler()

Definition at line 18 of file vtune_athena.py.

datefmt

vtune_athena.datefmt = '%m/%d/%Y %H:%M'

Definition at line 11 of file vtune_athena.py.

filemode

vtune_athena.filemode

Definition at line 17 of file vtune_athena.py.

filename

vtune_athena.filename

Definition at line 16 of file vtune_athena.py.

fmt

str vtune_athena.fmt = '%(asctime)s :: %(levelname)-8s :: %(message)s'

Definition at line 10 of file vtune_athena.py.

format

vtune_athena.format

Definition at line 14 of file vtune_athena.py.

formatter

vtune_athena.formatter = logging.Formatter(fmt,datefmt=datefmt)

Definition at line 19 of file vtune_athena.py.

level

vtune_athena.level

Definition at line 13 of file vtune_athena.py.

logger

vtune_athena.logger = logging.getLogger(__name__)

Definition at line 12 of file vtune_athena.py.