Add GridTools legacy support (#10)

Provides API compatibility with GridTools 1.x, should be removed once GridTools 2.x is released.

- wrappers for all GT_/gt_ prefixed functions/structs/macros
- function duplication for ADL mechanism in fortran_array_adapter

Author: havogt

CMakeLists.txt

@@ -9,6 +9,9 @@ include(CTest)
 set(REQUIRED_BOOST_VERSION 1.58)
 find_package(Boost ${REQUIRED_BOOST_VERSION} REQUIRED)
 
+option(CPP_BINDGEN_GT_LEGACY "Enables the legacy mode for API compatibility with GridTools 1.x" OFF)
+mark_as_advanced(CPP_BINDGEN_GT_LEGACY)
+
 # if used via FetchContent/add_subdirectory() we need to make the add_bindings_library() available here
 include(${CMAKE_CURRENT_LIST_DIR}/cmake/bindings.cmake)
 

cmake/cpp_bindgen.cmake.in

@@ -26,22 +26,28 @@
 #  - <library_name>_c the C-bindings with <library_name> linked to it
 #  - <library_name>_fortran the Fortran-bindings with <library_name> linked to it
 
+include_guard()
+
 option(GT_ENABLE_BINDINGS_GENERATION "If turned off, bindings will not be generated." ON)
 
 # variables are unset after use for scoping, they need to be redefined in the macros
 set(__C_BINDINGS_SOURCE_DIR @__C_BINDINGS_SOURCE_DIR@)
 set(__C_BINDINGS_INCLUDE_DIR @__C_BINDINGS_INCLUDE_DIR@)
 
+add_library(cpp_bindgen_interface INTERFACE)
+target_include_directories(cpp_bindgen_interface INTERFACE ${__C_BINDINGS_INCLUDE_DIR})
+target_compile_features(cpp_bindgen_interface INTERFACE cxx_std_11)
+if(CPP_BINDGEN_GT_LEGACY)
+    target_compile_definitions(cpp_bindgen_interface INTERFACE CPP_BINDGEN_GT_LEGACY)
+endif()
+
 add_library(cpp_bindgen_generator ${__C_BINDINGS_SOURCE_DIR}/cpp_bindgen/generator.cpp)
 # PUBLIC to make export.hpp available in the sources passed to add_bindings_library()
-target_include_directories(cpp_bindgen_generator PUBLIC ${__C_BINDINGS_INCLUDE_DIR})
-target_compile_features(cpp_bindgen_generator PUBLIC cxx_std_11)
 target_link_libraries(cpp_bindgen_generator PUBLIC Boost::boost)
+target_link_libraries(cpp_bindgen_generator PUBLIC cpp_bindgen_interface)
 
 add_library(c_bindings_handle ${__C_BINDINGS_SOURCE_DIR}/cpp_bindgen/handle.cpp)
-target_include_directories(c_bindings_handle PRIVATE ${__C_BINDINGS_INCLUDE_DIR})
-target_compile_features(c_bindings_handle PRIVATE cxx_std_11)
-target_link_libraries(cpp_bindgen_generator PRIVATE Boost::boost) #TODO make an interface target for options
+target_link_libraries(c_bindings_handle PUBLIC cpp_bindgen_interface)
 
 unset(__C_BINDINGS_SOURCE_DIR)
 unset(__C_BINDINGS_INCLUDE_DIR)
@@ -55,19 +61,21 @@ unset(__C_BINDINGS_INCLUDE_DIR)
 # be created by a call to cpp_bindgen_enable_fortran_library().
 function(cpp_bindgen_enable_fortran_library target_name)
     set(__C_BINDINGS_SOURCE_DIR @__C_BINDINGS_SOURCE_DIR@)
+    set(__C_BINDINGS_CMAKE_DIR @__C_BINDINGS_CMAKE_DIR@)
 
     if(CMAKE_Fortran_COMPILER_LOADED)
         if(NOT TARGET fortran_bindings_handle)
             add_library(fortran_bindings_handle ${__C_BINDINGS_SOURCE_DIR}/cpp_bindgen/array_descriptor.f90 ${__C_BINDINGS_SOURCE_DIR}/cpp_bindgen/handle.f90)
             target_link_libraries(fortran_bindings_handle PUBLIC c_bindings_handle)
             target_include_directories(fortran_bindings_handle PUBLIC ${CMAKE_CURRENT_BINARY_DIR})
+            include(${__C_BINDINGS_CMAKE_DIR}/fortran_helpers.cmake)
+            gen_enable_fortran_preprocessing_on_target(fortran_bindings_handle)
         endif()
         if(NOT TARGET ${target_name}_fortran)
             set_source_files_properties(GT_${${target_name}_fortran_bindings_path} PROPERTIES GENERATED TRUE)
             add_library(${target_name}_fortran EXCLUDE_FROM_ALL ${GT_${target_name}_fortran_bindings_path})
             target_link_libraries(${target_name}_fortran PUBLIC ${target_name})
             target_link_libraries(${target_name}_fortran PUBLIC fortran_bindings_handle)
-            target_include_directories(${target_name}_fortran PUBLIC ${CMAKE_CURRENT_BINARY_DIR})
             add_dependencies(${target_name}_fortran ${target_name}_declarations)
         endif()
     elseif(NOT ${ARGN}) # internal: the second (optional) parameter can be used to surpress this fatal error
@@ -136,14 +144,16 @@ function(cpp_bindgen_add_library target_name)
             message(FATAL_ERROR "Cross-compilation for bindings is enabled: no bindings will be generated, but "
                 "${bindings_c_decl_filename} and/or "
                 "${bindings_fortran_decl_filename} "
-                "are missing. Generate the bindings and consider making them part of your repository.") 
+                "are missing. Generate the bindings and consider making them part of your repository.")
         endif()
     endif()
 
     # bindings c library
     add_library(${target_name}_c INTERFACE)
     target_link_libraries(${target_name}_c INTERFACE ${target_name})
     target_link_libraries(${target_name}_c INTERFACE c_bindings_handle)
+    target_link_libraries(${target_name}_c INTERFACE cpp_bindgen_interface)
+
     add_dependencies(${target_name}_c ${target_name}_declarations)
 
     # bindings Fortran library

cmake/export.cmake

@@ -33,7 +33,7 @@ install(
     ${CMAKE_CURRENT_BINARY_DIR}/cpp_bindgen-config-version.cmake
     DESTINATION lib/cmake
     )
-    
+
 set(__C_BINDINGS_CMAKE_DIR "\${cpp_bindgen_MODULE_PATH}")  #TODO refactor the variable names cpp_bindgen_MODULE_PATH, etc.
 set(__C_BINDINGS_SOURCE_DIR "\${cpp_bindgen_SOURCES_PATH}")
 set(__C_BINDINGS_INCLUDE_DIR "\${cpp_bindgen_INCLUDE_PATH}")
@@ -46,6 +46,7 @@ unset(__C_BINDINGS_INCLUDE_DIR)
 
 set(CMAKE_SOURCES
     "${PROJECT_SOURCE_DIR}/cmake/cpp_bindgen_generate.cmake"
+    "${PROJECT_SOURCE_DIR}/cmake/fortran_helpers.cmake"
     "${PROJECT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/build-install/lib/cmake/cpp_bindgen.cmake"
     )
 set(CBINDINGS_SOURCES

cmake/fortran_helpers.cmake

@@ -0,0 +1,19 @@
+function(gen_enable_fortran_openacc_on_target target)
+    # TODO check if find_package(OpenACC) solves this problem
+    if(CMAKE_Fortran_COMPILER_ID STREQUAL "Cray")
+        target_compile_options(${target} PRIVATE $<$<COMPILE_LANGUAGE:Fortran>:-h acc>)
+    elseif(CMAKE_Fortran_COMPILER_ID STREQUAL "GNU")
+        target_compile_options(${target} PRIVATE $<$<COMPILE_LANGUAGE:Fortran>:-fopenacc>)
+        set_target_properties(${target} PROPERTIES APPEND_STRING PROPERTY LINK_FLAGS -fopenacc)
+    else()
+        message(FATAL_ERROR "OpenACC is not configured for this compiler.")
+    endif()
+endfunction()
+
+function(gen_enable_fortran_preprocessing_on_target target)
+    if (CMAKE_Fortran_COMPILER_ID STREQUAL "Cray")
+        target_compile_options(${target} PRIVATE $<$<COMPILE_LANGUAGE:Fortran>:-eF>)
+    else()
+        target_compile_options(${target} PRIVATE $<$<COMPILE_LANGUAGE:Fortran>:-cpp>)
+    endif()
+endfunction()

include/cpp_bindgen/array_descriptor.h

@@ -21,7 +21,19 @@ enum gen_fortran_array_kind {
     gen_fk_Float,
     gen_fk_Double,
     gen_fk_LongDouble,
-    gen_fk_SignedChar
+    gen_fk_SignedChar,
+
+#ifdef CPP_BINDGEN_GT_LEGACY // remove once GT is at v2.0
+    gt_fk_Bool = gen_fk_Bool,
+    gt_fk_Int = gen_fk_Int,
+    gt_fk_Short = gen_fk_Int,
+    gt_fk_Long = gen_fk_Long,
+    gt_fk_LongLong = gen_fk_LongLong,
+    gt_fk_Float = gen_fk_Float,
+    gt_fk_Double = gen_fk_Double,
+    gt_fk_LongDouble = gen_fk_LongDouble,
+    gt_fk_SignedChar = gen_fk_SignedChar
+#endif
 };
 typedef enum gen_fortran_array_kind gen_fortran_array_kind;
 
@@ -34,3 +46,7 @@ struct gen_fortran_array_descriptor {
     // TODO: add support for strides, bounds end type gen_fortran_array_descriptor
 };
 typedef struct gen_fortran_array_descriptor gen_fortran_array_descriptor;
+
+#ifdef CPP_BINDGEN_GT_LEGACY // remove once GT is at v2.0
+typedef struct gen_fortran_array_descriptor gt_fortran_array_descriptor;
+#endif

include/cpp_bindgen/export_gt_legacy.hpp

@@ -0,0 +1,65 @@
+/*
+ * GridTools
+ *
+ * Copyright (c) 2014-2019, ETH Zurich
+ * All rights reserved.
+ *
+ * Please, refer to the LICENSE file in the root directory.
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+#pragma once
+// remove this file once GT is at v2.0
+
+#warning "The use of this header is deprecated, use #include <cpp_bindgen/export.hpp>"
+
+#include <cpp_bindgen/export.hpp>
+
+#define GT_EXPORT_BINDING_WITH_SIGNATURE(...) GEN_EXPORT_BINDING_WITH_SIGNATURE(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED(__VA_ARGS__)
+#define GT_EXPORT_BINDING(...) GEN_EXPORT_BINDING(__VA_ARGS__)
+#define GT_EXPORT_GENERIC_BINDING(...) GEN_EXPORT_GENERIC_BINDING(__VA_ARGS__)
+#define GT_EXPORT_GENERIC_BINDING_WRAPPED(...) GEN_EXPORT_GENERIC_BINDING_WRAPPED(__VA_ARGS__)
+
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_0(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_0(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_1(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_1(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_2(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_2(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_3(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_3(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_4(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_4(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_5(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_5(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_6(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_6(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_7(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_7(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_8(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_8(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_9(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_9(__VA_ARGS__)
+
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_0(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_0(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_1(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_1(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_2(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_2(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_3(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_3(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_4(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_4(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_5(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_5(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_6(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_6(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_7(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_7(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_8(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_8(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_9(...) GEN_EXPORT_BINDING_WITH_SIGNATURE_WRAPPED_9(__VA_ARGS__)
+
+#define GT_EXPORT_BINDING_0(...) GEN_EXPORT_BINDING_0(__VA_ARGS__)
+#define GT_EXPORT_BINDING_1(...) GEN_EXPORT_BINDING_1(__VA_ARGS__)
+#define GT_EXPORT_BINDING_2(...) GEN_EXPORT_BINDING_2(__VA_ARGS__)
+#define GT_EXPORT_BINDING_3(...) GEN_EXPORT_BINDING_3(__VA_ARGS__)
+#define GT_EXPORT_BINDING_4(...) GEN_EXPORT_BINDING_4(__VA_ARGS__)
+#define GT_EXPORT_BINDING_5(...) GEN_EXPORT_BINDING_5(__VA_ARGS__)
+#define GT_EXPORT_BINDING_6(...) GEN_EXPORT_BINDING_6(__VA_ARGS__)
+#define GT_EXPORT_BINDING_7(...) GEN_EXPORT_BINDING_7(__VA_ARGS__)
+#define GT_EXPORT_BINDING_8(...) GEN_EXPORT_BINDING_8(__VA_ARGS__)
+#define GT_EXPORT_BINDING_9(...) GEN_EXPORT_BINDING_9(__VA_ARGS__)
+
+#define GT_EXPORT_BINDING_WRAPPED_0(...) GEN_EXPORT_BINDING_WRAPPED_0(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_1(...) GEN_EXPORT_BINDING_WRAPPED_1(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_2(...) GEN_EXPORT_BINDING_WRAPPED_2(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_3(...) GEN_EXPORT_BINDING_WRAPPED_3(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_4(...) GEN_EXPORT_BINDING_WRAPPED_4(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_5(...) GEN_EXPORT_BINDING_WRAPPED_5(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_6(...) GEN_EXPORT_BINDING_WRAPPED_6(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_7(...) GEN_EXPORT_BINDING_WRAPPED_7(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_8(...) GEN_EXPORT_BINDING_WRAPPED_8(__VA_ARGS__)
+#define GT_EXPORT_BINDING_WRAPPED_9(...) GEN_EXPORT_BINDING_WRAPPED_9(__VA_ARGS__)

include/cpp_bindgen/fortran_array_view.hpp

@@ -92,6 +92,21 @@ namespace cpp_bindgen {
 
             return descriptor;
         }
+
+#ifdef CPP_BINDGEN_GT_LEGACY // remove once GT is at v2.0
+        template <class T>
+        enable_if_t<(T::gt_view_rank::value > 0) && std::is_arithmetic<typename T::gt_view_element_type>::value &&
+                        (T::gt_is_acc_present::value == T::gt_is_acc_present::value),
+            gen_fortran_array_descriptor>
+        get_fortran_view_meta(T *) {
+            gen_fortran_array_descriptor descriptor;
+            descriptor.type = fortran_array_element_kind<typename T::gt_view_element_type>::value;
+            descriptor.rank = T::gt_view_rank::value;
+            descriptor.is_acc_present = T::gt_is_acc_present::value;
+
+            return descriptor;
+        }
+#endif
     } // namespace get_fortran_view_meta_impl
     using get_fortran_view_meta_impl::get_fortran_view_meta;
     /**
@@ -151,6 +166,14 @@ namespace cpp_bindgen {
                                      std::declval<gen_fortran_array_descriptor *>(), std::declval<T *>())),
             T>::value>> : std::true_type {};
 
+#ifdef CPP_BINDGEN_GT_LEGACY // remove once GT is at v2.0
+    template <class T>
+    struct is_fortran_array_convertible<T,
+        enable_if_t<std::is_same<decltype(gt_make_fortran_array_view(
+                                     std::declval<gen_fortran_array_descriptor *>(), std::declval<T *>())),
+            T>::value>> : std::true_type {};
+#endif
+
     /**
      * @brief A type is fortran_array_bindable if it is fortran_array_convertible
      *
@@ -206,4 +229,32 @@ namespace cpp_bindgen {
     make_fortran_array_view(gen_fortran_array_descriptor *descriptor) {
         return gen_make_fortran_array_view(descriptor, (T *){nullptr});
     }
+
+#ifdef CPP_BINDGEN_GT_LEGACY // remove once GT is at v2.0
+    template <class T>
+    enable_if_t<std::is_same<decltype(gt_make_fortran_array_view(
+                                 std::declval<gen_fortran_array_descriptor *>(), std::declval<T *>())),
+                    T>::value,
+        T>
+    make_fortran_array_view(gen_fortran_array_descriptor *descriptor) {
+        return gt_make_fortran_array_view(descriptor, (T *){nullptr});
+    }
+#endif
 } // namespace cpp_bindgen
+
+#ifdef CPP_BINDGEN_GT_LEGACY // remove once GT is at v2.0
+namespace gridtools {
+    namespace c_bindings {
+        // TODO comment
+
+        using cpp_bindgen::fortran_array_element_kind;
+        using cpp_bindgen::is_fortran_array_bindable;
+        using cpp_bindgen::is_fortran_array_convertible;
+        using cpp_bindgen::is_fortran_array_view_inspectable;
+        using cpp_bindgen::is_fortran_array_wrappable;
+
+        using cpp_bindgen::make_fortran_array_view;
+        using cpp_bindgen::get_fortran_view_meta_impl::get_fortran_view_meta;
+    } // namespace c_bindings
+} // namespace gridtools
+#endif

include/cpp_bindgen/generator.hpp

@@ -290,7 +290,7 @@ namespace cpp_bindgen {
             strm << wrap_line(tmp_strm.str(), "    ");
             strm << "      use iso_c_binding\n";
             if (has_array_descriptor<CSignature>::value)
-                strm << "      use array_descriptor\n";
+                strm << "      use gen_array_descriptor\n";
             for_each_param<CSignature>(fortran_param_type_from_c_f{},
                 [&](const std::string &type_name, int i) { strm << "      " << type_name << " :: arg" << i << "\n"; });
             return strm << "    end "
@@ -341,7 +341,7 @@ namespace cpp_bindgen {
 
             strm << "      use iso_c_binding\n";
             if (has_array_descriptor<CSignature>::value) {
-                strm << "      use array_descriptor\n";
+                strm << "      use gen_array_descriptor\n";
             }
             for_each_param<CppSignature>(fortran_param_type_from_cpp_f{}, [&](const std::string &type_name, int i) {
                 strm << "      " << type_name << ", target :: arg" << i << "\n";

include/cpp_bindgen/handle.h

@@ -14,10 +14,17 @@ struct gen_handle;
 #ifdef __cplusplus
 
 extern "C" void gen_release(gen_handle const *);
+#ifdef CPP_BINDGEN_GT_LEGACY // remove once GT is at v2.0
+extern "C" void gt_release(gen_handle const *);
+#endif
 
 #else
 
 typedef struct gen_handle gen_handle;
 void gen_release(gen_handle *);
+#ifdef CPP_BINDGEN_GT_LEGACY // remove once GT is at v2.0
+typedef struct gen_handle gt_handle;
+void gt_release(gen_handle *);
+#endif
 
 #endif

jenkins/build.sh

@@ -56,3 +56,9 @@ cmake ..
 nice make -j8
 ./driver
 
+# test gt legacy mode
+cd ${cwd}
+mkdir -p build_legacy && cd build_legacy
+cmake .. -DCMAKE_INSTALL_PREFIX=${cwd}/install -DCPP_BINDGEN_GT_LEGACY=ON
+nice make -j8 install
+ctest .