path: root/numbench/main.py

#! /usr/bin/env python2

#=====================================================
# Copyright (C) 2011 Andrea Arteaga <andyspiros@gmail.com>
#=====================================================
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#

import os, sys, signal
import benchchildren

# Set the signal handler
def close(*args):
    benchchildren.terminate()
    Print._level = 0
    Print()
    Print(80*'-')
    Print("INTERRUPT TRIGGERED")
    Print("Exiting")
    exit(0)
signal.signal(signal.SIGINT, close)


def print_usage():
    print "Usage: numbench [blas|cblas|lapack|scalapack|fftw|metis|" \
          "blas_accuracy|lapack_accuracy] file args"


def print_help():
    print "Usage: numbench module conffile [options]"
    print "       numbench [ -h | --help ]"
    print "       numbench module [ -h | --help ]"
    print
    print "Options:"
    print "   [ -h | --help ] - Display an help message"
    print
    print "Modules:"
    print "   blas - Test BLAS implementations"
    print "   cblas - Test CBLAS implementations"
    print "   lapack - Test LAPACK implementations"
    #print "   scalapack - Test the ScaLAPACK library"
    #print "   blas_accuracy - Test BLAS implementations for accuracy"
    #print "   lapack_accuracy - Test LAPACK implementations for accuracy"
    #print "   fftw - Test the FFTW library"
    #print "   metis - Test the METIS tools"
    print
    print "More information about a module is available through the command:"
    print "  numbench module --help"


def loadModule(modulename):
    tmp = __import__('numbench.modules.'+modulename, fromlist = ['Module'])
#    try:
#        tmp = __import__('numbench.modules.'+modulename, fromlist = ['Module'])
#    except ImportError as e:
#        sys.stderr.write('Module ' + modulename + ' not found')
#        exit(1)

    return tmp



## PRINT HELP IF NEEDED

# If no argument or '-h' is given, print the help
if len(sys.argv) < 3 or sys.argv[1] in ('-h', '--help'):
    print_help()
    exit(0)

# If requested, print the module help
if sys.argv[2] in ('-h', '--help'):
    tmp = loadModule(sys.argv[1])
    tmp.Module.printHelp()
    exit(0)


## BEGIN THE TRUE SCRIPT

# Import the packages
from os.path import join as pjoin
import benchconfig as cfg, benchutils as bu, confinput
from benchprint import Print
import PortageUtils as pu
import report

#from PortageUtils import \
#  normalize_cpv, install_dependencies, install_package, InstallException


# Parse the configuration file
if not os.path.exists(cfg.inputfile):
    sys.stderr.write("File not found: " + cfg.inputfile)
    print_usage()
    exit(1)
cfg.tests = confinput.parseInput(cfg.inputfile)

# Import the module
#os.chdir(cfg.scriptdir)
mod = loadModule(cfg.modulename).Module(sys.argv[3:])
cfg.mod = mod


# Write summary
Print._level = 0
Print(80*'=')
Print("The following tests will be run:")
Print("-------------------------------")
Print()
for tname, ttest in cfg.tests.items():
    Print("Test: " + tname)

    if ttest['descr'] is not None:
        Print(" - Description: " + ttest['descr'])

    Print(" - Package: " + ttest['normalizedPackage'])

    if len(ttest['dependenv']) != 0:
        Print(" - Dependencies emerge environment: " + \
          ' '.join([n+'="'+v+'"' for n,v in ttest['dependenv'].items()]))

    if len(ttest['emergeenv']) != 0:
        Print(" - Emerge environment: " + \
          ' '.join([n+'="'+v+'"' for n,v in ttest['emergeenv'].items()]))

    if len(ttest['compileenv']) != 0:
        Print(" - Suite compile-time environment: " + \
          ' '.join([n+'="'+v+'"' for n,v in ttest['compileenv'].items()]))

    if len(ttest['runenv']) != 0:
        Print(" - Suite run-time environment: " + \
          ' '.join([n+'="'+v+'"' for n,v in ttest['runenv'].items()]))

    if len(ttest['skip']) != 0:
        Print(" - Skip implementations: " + ' '.join(ttest['skip']))

    if len(ttest['requires']) != 0:
        Print(" - Pkg-config requirements substitutions:", '')
        for c_0, c_1 in ttest['requires'].items():
            Print(c_0 + ':' + c_1, '')
        Print()

    Print()
Print(80*'=')
Print()
Print("The script is located in the directory " + cfg.scriptdir)
Print("The script is run from the directory " + os.path.realpath('.'))
Print("The BTL is located in the directory " + cfg.btldir)
Print("The logs will be available in the directory " + cfg.logdir)
Print("The results will be available in the directory " + cfg.reportdir)
Print()


# Main iteration
for tn,(name,test) in enumerate(cfg.tests.items(),1):
    Print._level = 0
    Print("BEGIN TEST %i - %s" % (tn, name))

    # Emerge package
    Print.down()
    if os.path.exists(test['archive']):
        Print("Package already emerged - skipping")
        test['emergesuccess'] = True
    else:
        try:
            # Emerge dependencies
            Print("Emerging dependencies")
            pu.installDependencies(test)

            # Emerge pacakge
            Print("Emerging package %s" % test['normalizedPackage'])
            logfile = pjoin(test['logdir'], 'emerge.log')
            Print("(Run 'tail -f " + logfile + "' on another terminal "
                  "to see the progress)")
            pu.installPackage(test)
            test['emergesuccess'] = True

        except pu.InstallException as e:
            test['emergesuccess'] = False
            Print("Package %s failed to emerge" % e.package)
            Print("Error log: " + e.logfile)
            Print.up()
            print
            continue
    Print("Package emerged")

    # Find implementations
    # TODO: check for regexps
    impls = [i for i in mod.getImplementations(test) if not i in test['skip']]
    test['implementations'] = impls

    # Test every implementation
    test['results'] = {}
    if len(impls) == 0:
        Print("No implementation found")
    for impl in impls:
        # Run the test suite
        Print("Testing " + impl)
        Print.down()
        test['results'][impl] = mod.runTest(test, impl)
        Print.up()
    # All implementations tested

    Print.up()
    print


# Save the results
report.saveReport()



# TODO: reintroduce the instructions feature (and remove "exit)
exit(0)


Print._level = 0
Print()
# Print instructions
for name,test in cfg.tests.items():
    if not test['emergesuccess']:
        continue
    printstr = "Instructions for " + name + ":"
    Print(printstr)
    Print(len(printstr)*'-')
    Print.down()
    Print("# PKGDIR=" + test['pkgdir'] + " emerge -K '=" + \
          test['normalizedPackage'] + "'")
    try:
        for impl in test['implementations']:
            Print("Implementation " + impl + ":")
            Print.down()
            mod.instructionsFor(impl)
            Print.up()
    except:
        pass

    Print.up()
    Print()