Skip to content

Latest commit

 

History

History
111 lines (80 loc) · 6.18 KB

README.md

File metadata and controls

111 lines (80 loc) · 6.18 KB
Raw

AdHoc

An unordered set of ad hoc tests for modern Fortran compilers.

Overview

AdHoc is an open-source software project that archives ad hoc tests for modern Fortran compilers used by Sourcery Institute, Sourcery, Inc., their collaborators, sponsors, and clients. These tests emphasize support for the Fortran 2003 and 2008 standards along with features proposed for Fortran 2015 in technical specification TS 29113 Further Interoperability with C and the draft technical specification TS 18508 Additional Parallel Features in Fortran.

A primary motivation of the design of AdHoc lies in the need for tolerating compile-time errors during the building of the tests. Inspired by Test-Driven Development (TDD), it is expected that every test committed to AdHoc initially fails and that the test therefore becomes a user specificiation against which the corresponding compiler team can build. What makes AdHoc a bit unusual is that a large percentage of the failures are compile-time errors. Compilation errors complicate TDD's traditional write-build-test-refactor development cycle because most build systems halt progress when a source file fails to compile.

AdHOc addresses this scenario by delaying the test compilation to the post-build phase of the cycle. At build time, AdHoc simply builds a script for compiling and running each test. When the tests are run, source compilation failures are reported as test failures and the execution of the test suite continues onward to any subsequent tests. AdHoc uses the CMake capability for detecting compiler identity and version to determine which tests to build.

(Another use case for test-phase compilation arises when the code must be pre-processed before being passed to the compiler. This use case occurs with the compiler wrapper in OpenCoarrays, the project that spawned AdHoc.)

Compatibility

AdHoc is intended to support any modern Fortran compiler for which it is desired to gather users requirements in the form of tests. Specific support for each compiler is added as tests for that compiler are added.

Prerequisites

  • CMake 3.0 or higher (3.3.0 or higher preferred for robust detection of the compiler version)
  • A Fortran compiler.

Fortran 2003 specifies certain behavior and values that depend on the implementation of a companion C compiler. The C compiler need not be present to build AdHoc, but knowledge of which C compiler is the companion might be helpful in determining the corresponding behavior and values. In most instances, the companion C compiler is the C compiler that is part of the compiler collection that includes the Fortran compiler being used. In cases where the compiler vendor does not produce a C compiler, please refer to the vendor documentation for the identity of the companion C compiler.

## Installation ##

Download AdHoc via git or as a Zip file. From inside a bash shall, issue commands of the following form:

cd <AdHoc-source-directory>
mkdir -p build
cd build
FC=<fortran-compiler-name> cmake .. -DCMAKE_INSTALL_PREFIX=${PWD}
make
make install
ctest

AdHoc produces no executable files or libraries other than those specified in the tests. Thus, the above "make install" command simply constructs the scripts that actually compile and run the tests during the subsequent "ctest" command. The scripts write the test output back into the source tree using a name of the form <compiler-identity>-<compiler-version>.out. If you are using git, you can determine whether the compiler results differ from the previously committed result by executing "git diff", which produces no output if the contents of the test result files have not changed.

## Contributing ##

Please see the CONTRIBUTING file.

## Status ##

AdHoc currently contains tests for the Intel and GNU compilers. Consequently, these are the only compilers AdHoc recognizes at build time. Support for additional compilers will be added as tests for the corresponding compilers is added.

## Support ##

Please submit bug reports and feature requests via our Issues page.

## Acknowledgements ## Sourcery Insitute and Sourcery, Inc., gratefully acknowledge support from the following institutions:
  • The National Aeronautics and Space Administration (NASA) under subcontract from Science Systems and Applications Incorporated (SSAI).
  • Cray, Inc. for computing time via its Marketing Partner Network.
  • Portland Group for a PGI Workstation license.
  • Numerical Algorithms Group (NAG) for a NAG Fortran compiler license.
  • Intel Corp. for an Intel Parallel Studio XE license.