llvm-project/flang
peter klausler 3b63571425 [flang] Use hash table for UnitMap, avoid C++ STL binary dependence
Scan FORMAT strings locally to avoid C++ binary runtime dependence when computing deepest parenthesis nesting

Remove a dependency on ostream from runtime

Remove remaining direct external references from runtime to C++ library binaries

Remove runtime dependences on lib/common

SetPos() and SetRec()

Instantiate templates for input

Begin input; rearrange locking, deal with CLOSE races

View()

Update error message in test to agree with compiler change

First cut at real input

More robust I/O runtime error handling

Debugging of REAL input

Add iostat.{h,cpp}

Rename runtime/numeric-* to runtime/edit-*

Move templates around, templatize integer output editing

Move LOGICAL and CHARACTER output from io-api.cpp to edit-output.cpp

Change pointer argument to reference

More list-directed input

Complex list-directed input

Use enum class Direction rather than bool for templates

Catch up with changes to master

Undo reformatting of Lower code

Use record number instead of subscripts for internal unit

Unformatted sequential backspace

Testing and debugging

Dodge bogus GCC warning

Add <cstddef> for std::size_t to fix CI build

Address review comments

Original-commit: flang-compiler/f18@50406b3496
Reviewed-on: https://github.com/flang-compiler/f18/pull/1053
2020-03-11 13:23:39 -07:00
..
documentation [flang] Use hash table for UnitMap, avoid C++ STL binary dependence 2020-03-11 13:23:39 -07:00
include [flang] Use hash table for UnitMap, avoid C++ STL binary dependence 2020-03-11 13:23:39 -07:00
lib [flang] Use hash table for UnitMap, avoid C++ STL binary dependence 2020-03-11 13:23:39 -07:00
module [flang] Repair C_LOC 2020-03-11 11:00:36 -07:00
runtime [flang] Use hash table for UnitMap, avoid C++ STL binary dependence 2020-03-11 13:23:39 -07:00
test [flang] Use hash table for UnitMap, avoid C++ STL binary dependence 2020-03-11 13:23:39 -07:00
test-lit [flang] Change README to refer to LLVM_BUILD_DIR. (flang-compiler/f18#1033) 2020-03-05 07:12:06 -08:00
tools [flang] Replace module writer posix file handling with llvm file handling. (flang-compiler/f18#993) 2020-02-25 07:59:50 -08:00
.clang-format [flang] Moved public headers to include/flang (flang-compiler/f18#943) 2020-01-27 12:57:59 -08:00
.drone.star [flang] Remove clang from LLVM drone builds until needed to fasten builds 2020-02-26 06:16:22 -08:00
.gitignore [flang] Do not remove things from .gitignore 2019-07-23 14:57:46 -07:00
CMakeLists.txt [flang] Link against zlib when LLVM does. 2020-03-02 14:19:10 +00:00
LICENSE.txt [flang] Flang relicensing changes for LLVM Apache 2.0 license 2019-12-23 10:26:16 -08:00
README.md [flang] Change README to refer to LLVM_BUILD_DIR. (flang-compiler/f18#1033) 2020-03-05 07:12:06 -08:00
flatten.cpp [flang] Add script to flatten git history for llvm monorepo submission (flang-compiler/f18#854) 2020-02-26 11:50:43 -08:00

README.md

F18

F18 is a ground-up implementation of a Fortran front end written in modern C++. F18, when combined with LLVM, is intended to replace the Flang compiler.

Flang is a Fortran compiler targeting LLVM. Visit the Flang wiki for more information about Flang.

Getting Started

Read more about f18 in the documentation directory. Start with the compiler overview.

To better understand Fortran as a language and the specific grammar accepted by f18, read Fortran For C Programmers and f18's specifications of the Fortran grammar and the OpenMP grammar.

Treatment of language extensions is covered in this document.

To understand the compilers handling of intrinsics, see the discussion of intrinsics.

To understand how an f18 program communicates with libraries at runtime, see the discussion of runtime descriptors.

If you're interested in contributing to the compiler, read the style guide and also review how f18 uses modern C++ features.

Building F18

Get the Source Code

cd where/you/want/the/source
git clone https://github.com/flang-compiler/f18.git

Supported C++ compilers

F18 is written in C++17.

The code has been compiled and tested with GCC versions 7.2.0, 7.3.0, 8.1.0, and 8.2.0.

The code has been compiled and tested with clang version 7.0 and 8.0 using either GNU's libstdc++ or LLVM's libc++.

LLVM dependency

F18 uses components from LLVM.

The instructions to build LLVM can be found at https://llvm.org/docs/GettingStarted.html.

We highly recommend using the same compiler to compile both llvm and f18.

The f18 CMakeList.txt file uses the variable LLVM_DIR to find the installed components.

To get the correct LLVM libraries included in your f18 build, define LLVM_DIR on the cmake command line.

LLVM=<LLVM_BUILD_DIR>/lib/cmake/llvm cmake -DLLVM_DIR=$LLVM ...

where LLVM_BUILD_DIR is the top-level directory where LLVM was built.

Building f18 with GCC

By default, cmake will search for g++ on your PATH. The g++ version must be one of the supported versions in order to build f18.

Or, cmake will use the variable CXX to find the C++ compiler. CXX should include the full path to the compiler or a name that will be found on your PATH, e.g. g++-7.2, assuming g++-7.2 is on your PATH.

export CXX=g++-7.2

or

CXX=/opt/gcc-7.2/bin/g++-7.2 cmake ...

There's a third option! The CMakeList.txt file uses the variable GCC as the path to the bin directory containing the C++ compiler.

GCC can be defined on the cmake command line where <GCC_DIRECTORY> is the path to a GCC installation with bin, lib, etc:

cmake -DGCC=<GCC_DIRECTORY> ...

Building f18 with clang

To build f18 with clang, cmake needs to know how to find clang++ and the GCC library and tools that were used to build clang++.

The CMakeList.txt file expects either CXX or BUILD_WITH_CLANG to be set.

CXX should include the full path to clang++ or clang++ should be found on your PATH.

export CXX=clang++

BUILD_WITH_CLANG can be defined on the cmake command line where <CLANG_DIRECTORY> is the path to a clang installation with bin, lib, etc:

cmake -DBUILD_WITH_CLANG=<CLANG_DIRECTORY>

Or GCC can be defined on the f18 cmake command line where <GCC_DIRECTORY> is the path to a GCC installation with bin, lib, etc:

cmake -DGCC=<GCC_DIRECTORY> ...

To use f18 after it is built, the environment variables PATH and LD_LIBRARY_PATH must be set to use GCC and its associated libraries.

Installation Directory

To specify a custom install location, add -DCMAKE_INSTALL_PREFIX=<INSTALL_PREFIX> to the cmake command where <INSTALL_PREFIX> is the path where f18 should be installed.

Build Types

To create a debug build, add -DCMAKE_BUILD_TYPE=Debug to the cmake command. Debug builds execute slowly.

To create a release build, add -DCMAKE_BUILD_TYPE=Release to the cmake command. Release builds execute quickly.

Build F18

cd ~/f18/build
cmake -DLLVM_DIR=$LLVM ~/f18/src
make

How to Run the Regression Tests

To run all tests:

cd ~/f18/build
cmake -DLLVM_DIR=$LLVM ~/f18/src
make check-all

To run individual regression tests llvm-lit needs to know the lit configuration for f18. The parameters in charge of this are: flang_site_config and flang_config. And they can be set as shown bellow:

<path-to-llvm-lit>/llvm-lit \
 --param flang_site_config=<path-to-f18-build>/test-lit/lit.site.cfg.py \
 --param flang_config=<path-to-f18-build>/test-lit/lit.cfg.py \
  <path-to-fortran-test>