[flang] Make ISO_Fortran_binding.h a standalone header again.

[vzakhari]

Summary

This implements the proposal from
https://discourse.llvm.org/t/adding-flang-specific-header-files-to-clang/72442/6
Since ISO_Fortran_binding.h is supposed to be included from users'
C/C++ codes, it would better have no dependencies on other header
files.

[klausler]

flang/include/flang/iso_fortran_binding_wrapper.h

1 ↗

(On Diff #552500)

Why not capitalize ISO?

24 ↗

(On Diff #552500)

Doesn't api-attrs.h need to be included before ISO_Fortran_binding.h?

[vzakhari]

flang/include/flang/iso_fortran_binding_wrapper.h

1 ↗

(On Diff #552500)

I do not have any preference here, so I followed the simplest typing pattern. I will capitalize it.

24 ↗

(On Diff #552500)

Thanks for catching! Pre-upload clang-format did this.

[PeteSteinfeld]

I agree with Peter on the naming of the file.

Otherwise, all builds and tests correctly and looks good.

flang/include/flang/iso_fortran_binding_wrapper.h

24 ↗

(On Diff #552500)

Isn't it just alphabetizing to include "ISO..." before "Run..."?

[vzakhari]

• Fixed review remarks.

flang/include/flang/iso_fortran_binding_wrapper.h

24 ↗

(On Diff #552500)

Yes, it does.

flang/include/flang/ISO_Fortran_binding.h

 #include <stddef.h>
 
 /* Standard interface to Fortran from C and C++.
  * These interfaces are named in subclause 18.5 of the Fortran 2018
  * standard, with most of the actual details being left to the
  * implementation.
  */
 
-#include "Runtime/api-attrs.h"
+#ifndef RT_API_ATTRS
+#define RT_API_ATTRS
+#endif
 
 #ifdef __cplusplus
 namespace Fortran {
 namespace ISO {
 inline namespace Fortran_2018 {
 #endif
 
 /* 18.5.4 */

flang/include/flang/ISO_Fortran_binding_wrapper.h

+/*===-- include/flang/ISO_Fortran_binding_wrapper.h ---------------*- C++ -*-===
+ *
+ * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+ * See https://llvm.org/LICENSE.txt for license information.
+ * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+ *
+ * ===-----------------------------------------------------------------------===
+ */
+
+#ifndef FORTRAN_ISO_FORTRAN_BINDING_WRAPPER_H_
+#define FORTRAN_ISO_FORTRAN_BINDING_WRAPPER_H_
+
+/* A thin wrapper around flang/include/ISO_Fortran_binding.h
+ * This header file must be included when ISO_Fortran_binding.h
+ * definitions/declarations are needed in Flang compiler/runtime
+ * sources. The inclusion of Runtime/api-attrs.h below sets up
+ * proper values for the macros used in ISO_Fortran_binding.h
+ * for the device offload builds.
+ * flang/include/ISO_Fortran_binding.h is made a standalone
+ * header file so that it can be used on its own in users'
+ * C/C++ programs.
+ */
+
+/* clang-format off */
+#include "Runtime/api-attrs.h"
+#include "ISO_Fortran_binding.h"
+/* clang-format on */
+
+#endif /* FORTRAN_ISO_FORTRAN_BINDING_WRAPPER_H_ */

flang/include/flang/Optimizer/Support/TypeCode.h

 //===-- Optimizer/Support/TypeCode.h ----------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef FORTRAN_OPTIMIZER_SUPPORT_TYPECODE_H
 #define FORTRAN_OPTIMIZER_SUPPORT_TYPECODE_H
 
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "llvm/Support/ErrorHandling.h"
 
 namespace fir {
 
 //===----------------------------------------------------------------------===//
 // Translations of category and bitwidths to the type codes defined in flang's
 // ISO_Fortran_binding.h.
 //===----------------------------------------------------------------------===//

flang/include/flang/Runtime/descriptor.h

 // to implement nontrivial dummy arguments, pointers, allocatables,
 // function results, and the special behaviors of instances of derived types.
 // This header file includes and extends the published language
 // interoperability header that is required by the Fortran 2018 standard
 // as a subset of definitions suitable for exposure to user C/C++ code.
 // User C code is welcome to depend on that ISO_Fortran_binding.h file,
 // but should never reference this internal header.
 
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/memory.h"
 #include "flang/Runtime/type-code.h"
 #include <algorithm>
 #include <cassert>
 #include <cinttypes>
 #include <cstddef>
 #include <cstdio>
 #include <cstring>

flang/include/flang/Runtime/type-code.h

 //===-- include/flang/Runtime/type-code.h -----------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef FORTRAN_RUNTIME_TYPE_CODE_H_
 #define FORTRAN_RUNTIME_TYPE_CODE_H_
 
 #include "flang/Common/Fortran.h"
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include <optional>
 #include <utility>
 
 namespace Fortran::runtime {
 
 using common::TypeCategory;
 
 class TypeCode {

flang/lib/Optimizer/CodeGen/CodeGen.cpp

 //===-- CodeGen.cpp -- bridge to lower to LLVM ----------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
 //
 //===----------------------------------------------------------------------===//
 
 #include "flang/Optimizer/CodeGen/CodeGen.h"
 
 #include "CGOps.h"
-#include "flang/ISO_Fortran_binding.h"
 #include "flang/Optimizer/Dialect/FIRAttr.h"
 #include "flang/Optimizer/Dialect/FIROps.h"
 #include "flang/Optimizer/Dialect/FIRType.h"
 #include "flang/Optimizer/Support/InternalNames.h"
 #include "flang/Optimizer/Support/TypeCode.h"
 #include "flang/Optimizer/Support/Utils.h"
 #include "flang/Semantics/runtime-type-info.h"
 #include "mlir/Conversion/ArithCommon/AttrToLLVMConverter.h"

flang/lib/Optimizer/CodeGen/DescriptorModel.h

 // This assumption that build == host == target is actually pervasive across the
 // compiler (https://llvm.org/PR52418).
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef OPTIMIZER_DESCRIPTOR_MODEL_H
 #define OPTIMIZER_DESCRIPTOR_MODEL_H
 
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/descriptor.h"
 #include "mlir/Dialect/LLVMIR/LLVMTypes.h"
 #include "mlir/IR/BuiltinTypes.h"
 #include "llvm/Support/ErrorHandling.h"
 #include <tuple>
 
 namespace fir {
 

flang/lib/Optimizer/Dialect/FIRType.cpp

 //===-- FIRType.cpp -------------------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
 //
 //===----------------------------------------------------------------------===//
 
 #include "flang/Optimizer/Dialect/FIRType.h"
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Optimizer/Dialect/FIRDialect.h"
 #include "flang/Optimizer/Dialect/Support/KindMapping.h"
 #include "flang/Tools/PointerModels.h"
 #include "mlir/IR/Builders.h"
 #include "mlir/IR/BuiltinDialect.h"
 #include "mlir/IR/Diagnostics.h"
 #include "mlir/IR/DialectImplementation.h"
 #include "llvm/ADT/SmallPtrSet.h"

flang/lib/Optimizer/Transforms/LoopVersioning.cpp

 ///
 /// TODO: Do we need some size limit where loops no longer get duplicated?
 //        Maybe some sort of cost analysis.
 /// TODO: Should some loop content - for example calls to functions and
 ///       subroutines inhibit the versioning of the loops. Plausibly, this
 ///       could be part of the cost analysis above.
 //===----------------------------------------------------------------------===//
 
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Optimizer/Builder/BoxValue.h"
 #include "flang/Optimizer/Builder/FIRBuilder.h"
 #include "flang/Optimizer/Builder/Runtime/Inquiry.h"
 #include "flang/Optimizer/Dialect/FIRDialect.h"
 #include "flang/Optimizer/Dialect/FIROps.h"
 #include "flang/Optimizer/Dialect/FIRType.h"
 #include "flang/Optimizer/Dialect/Support/FIRContext.h"
 #include "flang/Optimizer/Dialect/Support/KindMapping.h"

flang/runtime/ISO_Fortran_binding.cpp

 //===-- runtime/ISO_Fortran_binding.cpp -----------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 // Implements the required interoperability API from ISO_Fortran_binding.h
 // as specified in section 18.5.5 of Fortran 2018.
 
-#include "flang/ISO_Fortran_binding.h"
 #include "ISO_Fortran_util.h"
 #include "terminator.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/descriptor.h"
 #include "flang/Runtime/type-code.h"
 #include <cstdlib>
 
 namespace Fortran::ISO {
 extern "C" {
 
 void *CFI_address(

flang/runtime/ISO_Fortran_util.h

 //===-- runtime/ISO_Fortran_util.h ------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef FORTRAN_RUNTIME_ISO_FORTRAN_UTIL_H_
 #define FORTRAN_RUNTIME_ISO_FORTRAN_UTIL_H_
 
 // Internal utils for establishing CFI_cdesc_t descriptors.
 
 #include "terminator.h"
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/descriptor.h"
 #include "flang/Runtime/type-code.h"
 #include <cstdlib>
 
 namespace Fortran::ISO {
 static inline constexpr bool IsCharacterType(CFI_type_t ty) {
   return ty == CFI_type_char || ty == CFI_type_char16_t ||
       ty == CFI_type_char32_t;

flang/runtime/allocatable.cpp

 //===-- runtime/allocatable.cpp -------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "flang/Runtime/allocatable.h"
 #include "assign-impl.h"
 #include "derived.h"
 #include "stat.h"
 #include "terminator.h"
 #include "type-info.h"
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/assign.h"
 #include "flang/Runtime/descriptor.h"
 
 namespace Fortran::runtime {
 extern "C" {
 
 void RTNAME(AllocatableInitIntrinsic)(Descriptor &descriptor,
     TypeCategory category, int kind, int rank, int corank) {

flang/runtime/stat.h

 //===-- runtime/stat.h ------------------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 // Defines the values returned by the runtime for STAT= specifiers
 // on executable statements.
 
 #ifndef FORTRAN_RUNTIME_STAT_H_
 #define FORTRAN_RUNTIME_STAT_H_
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/magic-numbers.h"
 namespace Fortran::runtime {
 
 class Descriptor;
 class Terminator;
 
 // The value of STAT= is zero when no error condition has arisen.
 

flang/runtime/temporary-stack.cpp

 //===-- runtime/temporary-stack.cpp ---------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 // Implements std::vector like storage for a dynamically resizable number of
 // temporaries. For use in HLFIR lowering.
 
 #include "flang/Runtime/temporary-stack.h"
 #include "terminator.h"
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/assign.h"
 #include "flang/Runtime/descriptor.h"
 #include "flang/Runtime/memory.h"
 
 namespace {
 
 using namespace Fortran::runtime;
 

flang/unittests/Evaluate/ISO-Fortran-binding.cpp

 #include "testing.h"
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/descriptor.h"
 #include "llvm/Support/raw_ostream.h"
 #include <type_traits>
 
 using namespace Fortran::runtime;
 using namespace Fortran::ISO;
 
 // CFI_CDESC_T test helpers

flang/unittests/Runtime/TemporaryStack.cpp

 //===--- flang/unittests/Runtime/TemporaryStack.cpp -------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "gtest/gtest.h"
 #include "tools.h"
-#include "flang/ISO_Fortran_binding.h"
+#include "flang/ISO_Fortran_binding_wrapper.h"
 #include "flang/Runtime/allocatable.h"
 #include "flang/Runtime/cpp-type.h"
 #include "flang/Runtime/descriptor.h"
 #include "flang/Runtime/temporary-stack.h"
 #include "flang/Runtime/type-code.h"
 #include <vector>
 
 using namespace Fortran::runtime;