commit | 4c300e0e77f643ea48458fad524875df7ac8964e | [log] [tgz] |
---|---|---|
author | abidh <haqadeer@amd.com> | Thu Apr 11 17:53:25 2024 +0100 |
committer | Copybara-Service <copybara-worker@google.com> | Thu Apr 11 09:59:47 2024 -0700 |
tree | 74a496df2f109c91681b382f48b55f27f9153f19 | |
parent | 0b777a4abe862bc60c38ed6702615676c8bc1144 [diff] |
[flang] Add design document for debug info generation. (#86939) This document discusses some options where the debug metadata can be generated. It also goes through various language constructs and explains how the debug metadata will look like for that construct and how we can extract that information. The real point of discussion is how and where to extract the information about various language features to generate the debug metadata. The structure of the metadata itself is mostly settled as that is dictated by the DWARF and structure of LLVM IR metadata. The classic flang and gfortran generate quite similar DWARF for the various language constructs. This document is based on what Kiran posted in https://reviews.llvm.org/D138534. --------- Co-authored-by: Tom Eccles <t@freedommail.info> Co-authored-by: Kiran Chandramohan <kiranchandramohan@gmail.com> GitOrigin-RevId: 357f6c7826437f6527db6f99f756a34fb5e0f716
Flang is a ground-up implementation of a Fortran front end written in modern C++. It started off as the f18 project (https://github.com/flang-compiler/f18) with an aim to replace the previous flang project (https://github.com/flang-compiler/flang) and address its various deficiencies. F18 was subsequently accepted into the LLVM project and rechristened as Flang.
Please note that flang is not ready yet for production usage.
Read more about flang in the docs directory. Start with the compiler overview.
To better understand Fortran as a language and the specific grammar accepted by flang, read Fortran For C Programmers and flang'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 a flang 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 flang uses modern C++ features.
If you are interested in writing new documentation, follow LLVM's Markdown style guide.
Consult the Getting Started with Flang for information on building and running flang.