setup.py

from distutils.core import setup
from distutils.command.build_ext import build_ext
from distutils.command.install import install
from distutils.errors import DistutilsOptionError
import os
import config


# Instantiate a configurations class for this OpenMOC build
config = config.configuration()


class custom_install(install):
  """Defines the compile time options for OpenMOC.

  This class derives from the distutils.command.install class. Distutils
  provides a set of flags which may be invoked by the user at compile
  time. The custom_install class adds to that list a series of options
  which are useful in compiling a specific distribution of OpenMOC.

  To view a list of available compile time options, simply type the following
  from a console:

  python setup.py install --help

  The custom_install class extracts user-defined options from the command
  line and uses them to populate the config.configurations class. The
  configurations class then uses these options to generate a list of
  Python C/C++/CUDA extension objects which are delivered to the distutils
  setup method at the end of this script.

  Developers wishing to extend OpenMOC's functionality with new compilation
  options will need to extend this class and the configurations class.
  """

  # The user options for a customized OpenMOC build
  user_options = [
    ('cc=', None, "Compiler (gcc, icpc, or bgxlc) for main openmoc module"),
    ('fp=', None, "Floating point precision (single or double) for " + \
                  "main openmoc module"),
    ('with-cuda', None, "Build openmoc.cuda module for NVIDIA GPUs"),
    ('with-gcc', None, "Build openmoc.gnu modules using GNU compiler"),
    ('with-icpc', None, "Build openmoc.intel modules using Intel compiler"),
    ('with-bgxlc', None, "Build openmoc.bgxlc modules using IBM compiler"),
    ('with-sp', None, "Build modules with single precision"),
    ('with-dp', None, "Build modules with double precision"),
    ('debug-mode', None, "Build with debugging symbols"),
    ('with-ccache', None, "Build with ccache for rapid recompilation"),
    ('with-papi', None, 'Build modules with PAPI instrumentation'),
    ('no-numpy', None, 'Build modules without NumPy C API')
  ]

  # Include all of the default options provided by distutils for the
  # install command parent class
  user_options += install.user_options

  # Set some compile options to be boolean switches
  boolean_options = ['with-sp',
                     'with-dp',
                     'with_cuda',
                     'with-gcc',
                     'with-icpc',
                     'with-bgxlc',
                     'debug-mode',
                     'with-ccache',
                     'with-papi',
                     'no-numpy']

  # Include all of the boolean options provided by distutils for the
  # install command parent class
  boolean_options += install.boolean_options


  def initialize_options(self):
    """Set the default OpenMOC build options

    The default installation is invoked by following console command:

    python setup.py install

    This will build the main openmoc C/C++ Python extension using the
    GCC compiler with single precision. No additional modules will be
    build with Intel or IBM compilers, or with double precision.
    """

    # Run the install command parent class' initialize_options method
    install.initialize_options(self)

    # Default compiler and precision level for the main openmoc module
    self.cc = 'gcc'
    self.fp = 'single'

    # By default, do not build openmoc.gnu.single, openmoc.intel.double, etc
    # extension modules
    self.with_gcc = False
    self.with_icpc = False
    self.with_bgxlc = False
    self.with_cuda = False
    self.with_sp = False
    self.with_dp = False

    # Set defaults for each of the newly defined compile time options
    self.debug_mode = False
    self.with_ccache = False
    self.with_papi = False
    self.no_numpy = False


  def finalize_options(self):
    """Extract options from the flags invoked by the user at compile time.

    This method performs error checking of the options specified by
    the user at compile time, and initialize the config.configurations
    class instance. The method conclude with a call to the
    configurations.setup_extension_modules class method which builds
    a list of C/C++/CUDA extension modules to be passed to the distutils
    setup method at the end of this script.
    """

    # Run the install command parent class' finalize_options method
    install.finalize_options(self)

    # Set the configuration options specified to be the default
    # unless the corresponding flag was invoked by the user
    config.with_cuda = self.with_cuda
    config.debug_mode = self.debug_mode
    config.with_ccache = self.with_ccache
    config.with_papi = self.with_papi
    config.with_numpy = not self.no_numpy

    # Check that the user specified a supported C++ compiler
    if self.cc not in ['gcc', 'icpc', 'bgxlc']:
      raise DistutilsOptionError \
            ('Must supply the -cc flag with one of the supported ' +
             'C++ compilers: gcc, icpc, bgxlc')
    else:
      config.cc = self.cc

    # Check that the user specified a supported floating point precision
    if self.fp not in ['single', 'double']:
      raise DistutilsOptionError \
          ('Must supply the -cc flag with one of the supported ' +
           'floating point precision levels: single, double')
    else:
      config.fp = self.fp

    # Build the openmoc.gnu.single and/or openmoc.gnu.double
    # extension module(s)
    if self.with_gcc:
      config.cpp_compilers += ['gcc']

      # If a precision level was not specified, use the default
      if not any([self.with_sp, self.with_dp]):
        config.fp_precision += [self.fp]


    # Build the openmoc.intel.single and/or openmoc.intel.double
    # extension module(s)
    if self.with_icpc:

      config.cpp_compilers += ['icpc']

      # If a precision level was not specified, use the default
      if not any([self.with_sp, self.with_dp]):
        config.fp_precision += [self.fp]


    # Build the openmoc.bgxlc.single and/or openmoc.bgxlc.double
    # extension module(s)
    if self.with_bgxlc:
      config.cpp_compilers += ['bgxlc']

      # If a precision level was not specified, use the default
      if not any([self.with_sp, self.with_dp]):
        config.fp_precision += [self.fp]

    # If the user requested to build extra modules (ie, openmoc.gnu.single)
    # using single precision floating point
    if self.with_sp:

      # If no compiler was specified, thrown an error
      if not any([self.with_gcc, self.with_icpc, not self.with_bgxlc]):
        raise DistutilsOptionError \
            ('Must supply either with-gcc/with-icpc/with-bgxlc for ' +
             'the with-sp option')

      # Otherwise add the single precision option
      else:
        config.fp_precision += ['single']


    # If the user requested to build extra modules (ie, openmoc.gnu.single)
    # using single precision floating point
    if self.with_dp:

      # If no compiler was specified, thrown an error
      if not any([self.with_gcc, self.with_icpc, not self.with_bgxlc]):
        raise DistutilsOptionError \
            ('Must supply either with-gcc/with-icpc/with-bgxlc for ' +
             'the with-dp option')

      # Otherwise add the double precision option
      else:
        config.fp_precision += ['double']

    # Build a list of the C/C++/CUDA extension modules to be built
    # for this distribution
    config.setup_extension_modules()



def customize_compiler(self):
  """Inject redefined _compile method into distutils

  This method enables us to choose compilers based on the macros defined
  in the compiler flags (ie, '-DGNU', '-DCUDA', etc), or on the
  source extension (ie, *.cpp, *.cu, etc.).

  Adapted from Robert McGibbon's CUDA distutils setup provided in open source
  form here: https://github.com/rmcgibbo/npcuda-example
  """

  # Inform the compiler it can processes .cu CUDA source files
  self.src_extensions.append('.cu')

  # Save reference to the default _compile method
  super_compile = self._compile

  # Redefine the _compile method. This gets executed for each
  # object but distutils doesn't have the ability to change compilers
  # based on source extension, so we add that functionality here
  def _compile(obj, src, ext, cc_args, extra_postargs, pp_opts):

    # If GNU is a defined macro and the source is C++, use gcc
    if '-DGNU' in pp_opts and os.path.splitext(src)[1] == '.cpp':
      if config.with_ccache:
        self.set_executable('compiler_so', 'ccache gcc')
      else:
        self.set_executable('compiler_so', 'gcc')

      postargs = config.compiler_flags['gcc']


    # If INTEL is a defined macro and the source is C++, use icpc
    elif '-DINTEL' in pp_opts and os.path.splitext(src)[1] == '.cpp':
      if config.with_ccache:
        self.set_executable('compiler_so', 'ccache icpc')
      else:
        self.set_executable('compiler_so', 'icpc')

      postargs = config.compiler_flags['icpc']

    # If BGXLC is a defined macro and the source is C++, use bgxlc
    elif '-DBGXLC' in pp_opts and os.path.splitext(src)[1] == '.cpp':
      if config.with_ccache:
        self.set_executable('compiler_so', 'bgxlc++_r')
      else:
        self.set_executable('compiler_so', 'bgxlc++_r')

      postargs = config.compiler_flags['bgxlc']


    # If CUDA is a defined macro and the source is C++, compile
    # SWIG-wrapped CUDA code with gcc
    elif '-DCUDA' in pp_opts and os.path.splitext(src)[1] == '.cpp':
      if config.with_ccache:
        self.set_executable('compiler_so', 'ccache gcc')
      else:
        self.set_executable('compiler_so', 'gcc')

      postargs = config.compiler_flags['gcc']


    # If CUDA is a defined macro and the source is CUDA, use nvcc
    elif '-DCUDA' in pp_opts and os.path.splitext(src)[1] == '.cu':
      if config.with_ccache:
        self.set_executable('compiler_so', 'ccache nvcc')
      else:
        self.set_executable('compiler_so', 'nvcc')

      postargs = config.compiler_flags['nvcc']


    # If we cannot determine how to compile this file, throw exception
    else:
      raise EnvironmentError('Unable to compile ' + str(src))

    # Now call distutils-defined _compile method
    super_compile(obj, src, ext, cc_args, postargs, pp_opts)

  # Inject our redefined _compile method into the class
  self._compile = _compile


def customize_linker(self):
  """Inject redefined link method into distutils

  This method enables us to choose the linker based on the name
  of the output shared library filename (ie, _openmoc_intel_single.so)

  Adapted from Robert McGibbon's CUDA distutils setup provided in open source
  form here: https://github.com/rmcgibbo/npcuda-example
  """

  # Save references to the default link method
  super_link = self.link

  # Redefine the link method. This gets executed to link each extension
  # module. We add the functionality to choose the compiler for linking
  # based on the name of the extension module
  def link(target_desc, objects, output_filename,
           output_dir=None, libraries=None,
           library_dirs=None, runtime_library_dirs=None,
           export_symbols=None, debug=0, extra_preargs=None,
           extra_postargs=None, build_temp=None, target_lang=None):

    # If compiling different extensions of openmoc using different compilers
    # and/or floating point precision levels, we must remove autogenerated
    # files from distutils for each subsequent extension. If the user is
    # compiling multiple modules at once (ie, openmoc.gnu.single and
    # openmoc.intel.single) we have to ensure that only one of the objects
    # openmoc_gnu_single.o or openmoc_intel_single.o is specified at the
    # link stage. Unfortunately, distutils enumerates all object files
    # compiled up to this point at the final linker stage which leads to
    # 'previously defined...' errors
    for obj in objects[:]:

      if 'openmoc' in obj:

        if 'intel' in output_filename and 'intel' not in obj:
          objects = [o for o in objects if o is not obj]
        elif 'intel' not in output_filename and 'intel' in obj:
          objects = [o for o in objects if o is not obj]

        if 'gnu' in output_filename and 'gnu' not in obj:
          objects = [o for o in objects if o is not obj]
        elif 'gnu' not in output_filename and 'gnu' in obj:
          objects = [o for o in objects if o is not obj]
        if 'bgxlc' in output_filename and 'bgxlc' not in obj:
          objects = [o for o in objects if o is not obj]
        elif 'bgxlc' not in output_filename and 'bgxlc' in obj:
          objects = [o for o in objects if o is not obj]

        if 'single' in output_filename and 'single' not in obj:
          objects = [o for o in objects if o is not obj]
        elif 'single' not in output_filename and 'single' in obj:
          objects = [o for o in objects if o is not obj]

        if 'double' in output_filename and 'double' not in obj:
          objects = [o for o in objects if o is not obj]
        elif 'double' not in output_filename and 'double' in obj:
          objects = [o for o in objects if o is not obj]

    # If the linker receives -fopenmp as an option, then the objects
    # are built by a GNU compiler
    if '-fopenmp' in extra_postargs:
      self.set_executable('linker_so', 'g++')
      self.set_executable('linker_exe', 'g++')

    # If the linker receives -openmp as an option, then the objects
    # are built by a GNU compiler
    if '-openmp' in extra_postargs:
      self.set_executable('linker_so', 'icpc')
    self.set_executable('linker_exe', 'icpc')

    # If the linker receives -qmkshrobj as an option, then the objects
    # are build by an IBM compiler
    if '-qmkshrobj' in extra_postargs:
      self.set_executable('linker_so', 'bgxlc++_r')
      self.set_executable('linker_exe', 'bgxlc++_r')

    # If the filename for the extension contains cuda, use g++ to link
    if 'cuda' in output_filename:
      self.set_executable('linker_so', 'g++')
      self.set_executable('linker_exe', 'g++')

    # Now call distutils-defined link method
    super_link(target_desc, objects,
               output_filename, output_dir, libraries,
               library_dirs, runtime_library_dirs,
               export_symbols, debug, extra_preargs,
               extra_postargs, build_temp)

  # Inject our redefined link method into the class
  self.link = link


# Run the customize_compiler to inject redefined and customized _compile and
# link methods into distutils
class custom_build_ext(build_ext):
  """Customizes distutils to work with different compiler types

  This class derives from the distutils.command.build_ext command class.
  It extends build_ex by creates customized compile and link methods
  which can accommodate different compiler types and options.
  """

  def build_extensions(self):
    customize_compiler(self.compiler)
    customize_linker(self.compiler)

    os.system('swig -python -c++ -keyword -o ' + \
                'openmoc/openmoc_wrap.cpp openmoc/openmoc.i')

    if 'gcc' in config.cpp_compilers and 'single' in config.fp_precision:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/gnu/single/openmoc_gnu_single_wrap.cpp ' + \
                  'openmoc/gnu/single/openmoc_gnu_single.i')

    if 'gcc' in config.cpp_compilers and 'double' in config.fp_precision:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/gnu/double/openmoc_gnu_double_wrap.cpp ' + \
                  'openmoc/gnu/double/openmoc_gnu_double.i')

    if 'icpc' in config.cpp_compilers and 'single' in config.fp_precision:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/intel/single/openmoc_intel_single_wrap.cpp ' + \
                  'openmoc/intel/single/openmoc_intel_single.i')

    if 'icpc' in config.cpp_compilers and 'double' in config.fp_precision:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/intel/double/openmoc_intel_double_wrap.cpp ' + \
                  'openmoc/intel/double/openmoc_intel_double.i')

    if 'bgxlc' in config.cpp_compilers and 'single' in config.fp_precision:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/bgq/single/openmoc_bgq_single_wrap.cpp ' + \
                  'openmoc/bgq/single/openmoc_bgq_single.i')

    if 'bgxlc' in config.cpp_compilers and 'double' in config.fp_precision:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/bgq/double/openmoc_bgq_double_wrap.cpp ' + \
                  'openmoc/bgq/double/openmoc_bgq_double.i')

    if 'nvcc' in config.cpp_compilers:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/cuda/openmoc_cuda_wrap.cpp ' + \
                  'openmoc/cuda/openmoc_cuda.i')

    if 'nvcc' in config.cpp_compilers and 'single' in config.fp_precision:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/cuda/single/openmoc_cuda_single_wrap.cpp ' + \
                  'openmoc/cuda/single/openmoc_cuda_single.i')

    if 'nvcc' in config.cpp_compilers and 'double' in config.fp_precision:
      os.system('swig -python -c++ -keyword -o ' + \
                  'openmoc/cuda/double/openmoc_cuda_double_wrap.cpp ' + \
                  'openmoc/cuda/double/openmoc_cuda_double.i')

    build_ext.build_extensions(self)


# Run the distutils setup method for the complete build
setup(name = 'openmoc',
      version = '0.1',
      description = 'An open source method of characteristics code for ' + \
                    'solving the 2D neutron distribution in nuclear reactors',
      author = 'Will Boyd',
      author_email = 'wboyd@mit.edu',
      url = 'https://github.com/mit-crpg/OpenMOC',

      # Set the C/C++/CUDA extension modules built in setup_extension_modules()
      # in config.py based on the user-defined flags at compile time
      ext_modules = config.extensions,

      # Extract all of the Python packages for OpenMOC
      # (ie, openmoc.log, openmoc.materialize, etc)
      packages = config.packages,

      # Inject our custom compiler and linker triggers
      cmdclass={ 'build_ext': custom_build_ext,
                 'install': custom_install}
)