File: generator.hpp

package info (click to toggle)
gridtools 2.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 21,728 kB
  • sloc: cpp: 45,263; python: 9,383; javascript: 8,445; ansic: 2,564; sh: 509; f90: 370; makefile: 216
file content (483 lines) | stat: -rw-r--r-- 21,515 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
/*
 * 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

#include <cassert>
#include <cstring>
#include <functional>
#include <map>
#include <ostream>
#include <sstream>
#include <string>
#include <vector>

#include <boost/preprocessor.hpp>
#include <boost/type_index.hpp>

#include "common/disjunction.hpp"
#include "common/for_each.hpp"
#include "common/function_traits.hpp"

#include "function_wrapper.hpp"

namespace cpp_bindgen {

    std::string wrap_line(const std::string &line, const std::string &prefix);

    namespace _impl {

        struct c_string_less {
            bool operator()(char const *lhs, char const *rhs) const { return strcmp(lhs, rhs) < 0; }
        };

        class entities {
            using generator_t = std::function<void(std::ostream &, char const *)>;
            std::map<char const *, generator_t, c_string_less> m_generators;

          public:
            void add(char const *name, generator_t generator);
            friend std::ostream &operator<<(std::ostream &strm, entities const &obj);
        };

        template <class>
        entities &get_entities() {
            static entities obj;
            return obj;
        }

        template <class T, class = void>
        struct recursive_remove_cv : std::remove_cv<T> {};

        template <class T>
        struct recursive_remove_cv<T, typename std::enable_if<std::is_pointer<T>::value>::type> {
            using type = typename recursive_remove_cv<typename std::remove_pointer<T>::type>::type *;
        };

        struct get_c_type_name_f {
            template <class T>
            std::string operator()() const {
                return boost::typeindex::type_id<typename recursive_remove_cv<T>::type>().pretty_name();
            }
        };

        template <class T>
        std::string get_c_type_name() {
            return boost::typeindex::type_id<typename recursive_remove_cv<T>::type>().pretty_name();
        }

        template <class TypeToStr, class Fun>
        struct for_each_param_helper_f {
            TypeToStr m_type_to_str;
            Fun m_fun;
            int &m_count;

            template <class T>
            void operator()() const {
                m_fun(m_type_to_str.template operator()<T>(), m_count);
                ++m_count;
            }
        };

        template <class Signature,
            class TypeToStr,
            class Fun,
            class Params = typename function_traits::parameter_types<Signature>::type>
        void for_each_param(TypeToStr &&type_to_str, Fun &&fun) {
            int count = 0;
            for_each_type<Params>(for_each_param_helper_f<TypeToStr, Fun>{
                std::forward<TypeToStr>(type_to_str), std::forward<Fun>(fun), count});
        };

        template <class CSignature>
        std::ostream &write_c_binding(std::ostream &strm, char const *name) {
            strm << get_c_type_name<typename function_traits::result_type<CSignature>::type>() << " " << name << "(";
            for_each_param<CSignature>(get_c_type_name_f{}, [&](const std::string &type_name, int i) {
                if (i)
                    strm << ", ";
                strm << type_name;
            });
            return strm << ");\n";
        }

        template <class>
        struct fortran_kind_name {
            static char const value[];
        };

        template <>
        char const fortran_kind_name<bool>::value[];
        template <>
        char const fortran_kind_name<int>::value[];
        template <>
        char const fortran_kind_name<short>::value[];
        template <>
        char const fortran_kind_name<long>::value[];
        template <>
        char const fortran_kind_name<long long>::value[];
        template <>
        char const fortran_kind_name<float>::value[];
        template <>
        char const fortran_kind_name<double>::value[];
        template <>
        char const fortran_kind_name<long double>::value[];
        template <>
        char const fortran_kind_name<signed char>::value[];

        template <class T,
            typename std::enable_if<std::is_same<typename std::decay<T>::type, bool>::value, int>::type = 0>
        std::string fortran_type_name() {
            using decayed_t = typename std::decay<T>::type;
            return std::string("logical(") + fortran_kind_name<decayed_t>::value + ")";
        }
        template <class T,
            typename std::enable_if<std::is_integral<T>::value &&
                                        !std::is_same<typename std::decay<T>::type, bool>::value,
                int>::type = 0>
        std::string fortran_type_name() {
            using signed_decayed_t = typename std::make_signed<typename std::decay<T>::type>::type;
            return std::string("integer(") + fortran_kind_name<signed_decayed_t>::value + ")";
        }

        template <class T, typename std::enable_if<std::is_floating_point<T>::value, int>::type = 0>
        std::string fortran_type_name() {
            using decayed_t = typename std::decay<T>::type;
            return std::string("real(") + fortran_kind_name<decayed_t>::value + ")";
        }

        template <class T, typename std::enable_if<std::is_pointer<T>::value, int>::type = 0>
        std::string fortran_type_name() {
            return "type(c_ptr)";
        }

        template <class T,
            typename std::enable_if<!std::is_pointer<T>::value && !std::is_integral<T>::value &&
                                        !std::is_floating_point<T>::value,
                int>::type = 0>
        std::string fortran_type_name() {
            assert("Unsupported fortran type." && false);
            return "";
        }

        template <class T, typename std::enable_if<std::is_void<T>::value, int>::type = 0>
        std::string fortran_function_specifier() {
            return "subroutine";
        }

        template <class T, typename std::enable_if<!std::is_void<T>::value, int>::type = 0>
        std::string fortran_function_specifier() {
            return "function";
        }

        template <class T, typename std::enable_if<std::is_void<T>::value, int>::type = 0>
        std::string fortran_return_type() {
            return fortran_function_specifier<T>();
        }

        template <class T, typename std::enable_if<!std::is_void<T>::value, int>::type = 0>
        std::string fortran_return_type() {
            return fortran_type_name<T>() + " " + fortran_function_specifier<T>();
        }

        std::string fortran_array_element_type_name(bindgen_fortran_array_kind kind);

        struct ignore_type_f {
            template <class T>
            std::string operator()() const {
                return "";
            }
        };

        struct fortran_param_type_from_c_f {

            template <class CType,
                typename std::enable_if<std::is_same<CType, bindgen_fortran_array_descriptor *>::value, int>::type = 0>
            std::string operator()() const {
                return "type(bindgen_fortran_array_descriptor)";
            }

            template <class CType,
                typename std::enable_if<!std::is_same<CType, bindgen_fortran_array_descriptor *>::value &&
                                            (!std::is_pointer<CType>::value ||
                                                std::is_class<typename std::remove_pointer<CType>::type>::value),
                    int>::type = 0>
            std::string operator()() const {
                return fortran_type_name<CType>() + ", value";
            }

            template <class CType,
                typename std::enable_if<std::is_pointer<CType>::value &&
                                            std::is_arithmetic<typename std::remove_pointer<CType>::type>::value,
                    int>::type = 0>
            std::string operator()() const {
                return fortran_type_name<typename std::remove_pointer<CType>::type>() + ", dimension(*)";
            }
            template <class CType,
                typename std::enable_if<std::is_pointer<CType>::value &&
                                            !std::is_arithmetic<typename std::remove_pointer<CType>::type>::value &&
                                            !std::is_class<typename std::remove_pointer<CType>::type>::value,
                    int>::type = 0>
            std::string operator()() const {
                return "type(c_ptr)";
            }
        };
        struct fortran_param_type_from_cpp_f {

            template <class CppType,
                class CType = param_converted_to_c_t<CppType>,
                typename std::enable_if<std::is_same<CType, bindgen_fortran_array_descriptor *>::value &&
                                            is_fortran_array_wrappable<CppType>::value,
                    int>::type = 0>
            std::string operator()() const {
                static const bindgen_fortran_array_descriptor meta =
                    get_fortran_view_meta((add_pointer_t<CppType>){nullptr});
                std::string dimensions = "dimension(";
                for (int i = 0; i < meta.rank; ++i) {
                    if (i)
                        dimensions += ",";
                    dimensions += ":";
                }
                dimensions += ")";
                return fortran_array_element_type_name(meta.type) + ", " + dimensions;
            }

            template <class CppType,
                class CType = param_converted_to_c_t<CppType>,
                typename std::enable_if<!std::is_same<CType, bindgen_fortran_array_descriptor *>::value ||
                                            !is_fortran_array_wrappable<CppType>::value,
                    int>::type = 0>
            std::string operator()() const {
                return fortran_param_type_from_c_f{}.template operator()<CType>();
            }
        };

        template <typename>
        struct has_array_descriptor_helper;
        template <typename... Parameters>
        struct has_array_descriptor_helper<std::tuple<Parameters...>>
            : disjunction<std::is_same<Parameters, bindgen_fortran_array_descriptor *>...>::type {};

        template <typename CSignature>
        struct has_array_descriptor
            : has_array_descriptor_helper<typename function_traits::parameter_types<CSignature>::type> {};

        /**
         * @brief This function writes the `interface`-section of the fortran-code.
         * @param strm Stream, where the output will be written to
         * @param c_name The name of the function in the c-header
         * @param fortran_name The name of the function in the c-bindings of the module.
         */
        template <class CSignature>
        std::ostream &write_fortran_binding(std::ostream &strm, char const *c_name, char const *fortran_name) {
            std::stringstream tmp_strm;
            tmp_strm << fortran_return_type<typename function_traits::result_type<CSignature>::type>() << " "
                     << fortran_name << "(";
            for_each_param<CSignature>(ignore_type_f{}, [&](const std::string &, int i) {
                if (i)
                    tmp_strm << ", ";
                tmp_strm << "arg" << i;
            });
            tmp_strm << ")";
            if (strcmp(c_name, fortran_name) == 0)
                tmp_strm << " bind(c)";
            else
                tmp_strm << " bind(c, name=\"" << c_name << "\")";
            strm << wrap_line(tmp_strm.str(), "    ");
            strm << "      use iso_c_binding\n";
            if (has_array_descriptor<CSignature>::value)
                strm << "      use bindgen_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 "
                        << fortran_function_specifier<typename function_traits::result_type<CSignature>::type>() + "\n";
        }

        struct cpp_type_descriptor_f {
            template <class CppType,
                class CType = param_converted_to_c_t<CppType>,
                typename std::enable_if<std::is_same<CType, bindgen_fortran_array_descriptor *>::value &&
                                            is_fortran_array_wrappable<CppType>::value,
                    int>::type = 0>
            bindgen_fortran_array_descriptor const *operator()() const {
                static const bindgen_fortran_array_descriptor meta =
                    get_fortran_view_meta((add_pointer_t<CppType>){nullptr});
                return &meta;
            }
            template <class CppType,
                class CType = param_converted_to_c_t<CppType>,
                typename std::enable_if<!std::is_same<CType, bindgen_fortran_array_descriptor *>::value ||
                                            !is_fortran_array_wrappable<CppType>::value,
                    int>::type = 0>
            bindgen_fortran_array_descriptor const *operator()() const {
                return nullptr;
            }
        };
        /**
         * @brief This function writes the `contains`-section of the fortran-code.
         * @param strm Stream, where the output will be written to
         * @param fortran_cbindings_name The name of the function in the c-bindings-part of the module.
         * @param fortran_name The name of the function in the fortran-part of the module.
         */
        template <class CppSignature>
        std::ostream &write_fortran_wrapper(
            std::ostream &strm, char const *fortran_cbindings_name, const char *fortran_name) {
            using CSignature = wrapped_t<CppSignature>;

            std::stringstream tmp_strm;
            tmp_strm << fortran_return_type<typename function_traits::result_type<CSignature>::type>() << " "
                     << fortran_name << "(";
            for_each_param<CSignature>(ignore_type_f{}, [&](const std::string &, int i) {
                if (i)
                    tmp_strm << ", ";
                tmp_strm << "arg" << i;
            });
            tmp_strm << ")";
            strm << wrap_line(tmp_strm.str(), "    ");

            strm << "      use iso_c_binding\n";
            if (has_array_descriptor<CSignature>::value) {
                strm << "      use bindgen_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";
            });

            for_each_param<CppSignature>(
                cpp_type_descriptor_f{}, [&](bindgen_fortran_array_descriptor const *meta, int i) {
                    if (meta) {
                        const auto desc_name = "descriptor" + std::to_string(i);
                        strm << "      type(bindgen_fortran_array_descriptor) :: " + desc_name + "\n";
                    }
                });
            strm << "\n";

            for_each_param<CppSignature>(
                cpp_type_descriptor_f{}, [&](bindgen_fortran_array_descriptor const *meta, int i) {
                    if (meta) {
                        const auto var_name = "arg" + std::to_string(i);
                        const auto desc_name = "descriptor" + std::to_string(i);
                        std::string c_loc = "c_loc(" + var_name + "(";
                        for (int i = 0; i < meta->rank; ++i) {
                            if (i)
                                c_loc += ",";
                            c_loc += "lbound(" + var_name + ", " + std::to_string(i + 1) + ")";
                        }
                        c_loc += "))";
                        if (meta->is_acc_present)
                            strm << "      !$acc data present(" << var_name << ")\n" //
                                 << "      !$acc host_data use_device(" << var_name << ")\n";

                        strm << "      " << desc_name << "%rank = " << meta->rank << "\n"                 //
                             << "      " << desc_name << "%type = " << meta->type << "\n"                 //
                             << "      " << desc_name << "%dims = reshape(shape(" << var_name << "), &\n" //
                             << "        shape(" << desc_name << "%dims), (/0/))\n"                       //
                             << "      " << desc_name << "%data = " << c_loc << "\n";
                        if (meta->is_acc_present)
                            strm << "      !$acc end host_data\n" //
                                 << "      !$acc end data\n";
                        strm << "\n";
                    }
                });

            tmp_strm.str("");
            if (std::is_void<typename function_traits::result_type<CSignature>::type>::value) {
                tmp_strm << "call " << fortran_cbindings_name << "(";
            } else {
                tmp_strm << fortran_name << " = " << fortran_cbindings_name << "(";
            }
            for_each_param<CppSignature>(
                cpp_type_descriptor_f{}, [&](bindgen_fortran_array_descriptor const *meta, int i) {
                    if (i)
                        tmp_strm << ", ";
                    if (meta) {
                        const auto desc_name = "descriptor" + std::to_string(i);
                        tmp_strm << desc_name;
                    } else {
                        tmp_strm << "arg" << i;
                    }
                });
            tmp_strm << ")";
            strm << wrap_line(tmp_strm.str(), "      ");

            return strm << "    end "
                        << fortran_function_specifier<typename function_traits::result_type<CSignature>::type>() + "\n";
        }

        struct c_bindings_traits {
            template <class CSignature>
            static void generate_entity(std::ostream &strm, char const *c_name) {
                write_c_binding<CSignature>(strm, c_name);
            }
        };

        struct fortran_bindings_traits {
            template <class CSignature>
            static void generate_entity(std::ostream &strm, char const *c_name, char const *fortran_name) {
                write_fortran_binding<CSignature>(strm, c_name, fortran_name);
            }
        };

        struct fortran_wrapper_traits {
            template <class CppSignature>
            static void generate_entity(
                std::ostream &strm, char const *fortran_cbindings_name, const char *fortran_name) {
                write_fortran_wrapper<CppSignature>(strm, fortran_cbindings_name, fortran_name);
            }
        };

        template <class Traits, class Signature, class... Params>
        void add_entity(const char *name, Params &&... params) {
            get_entities<Traits>().add(name,
                std::bind(Traits::template generate_entity<Signature>,
                    std::placeholders::_1,
                    std::forward<Params>(params)...));
        }

        template <class CSignature>
        struct registrar_simple {
            registrar_simple(char const *name) {
                add_entity<_impl::c_bindings_traits, CSignature>(name, name);
                add_entity<_impl::fortran_bindings_traits, CSignature>(name, name, name);
            }
        };
        template <class CppSignature>
        struct registrar_wrapped {
            registrar_wrapped(char const *c_name, char const *fortran_cbindings_name, char const *fortran_name) {
                using CSignature = wrapped_t<CppSignature>;
                add_entity<_impl::c_bindings_traits, CSignature>(c_name, c_name);
                add_entity<_impl::fortran_bindings_traits, CSignature>(c_name, c_name, fortran_cbindings_name);
                add_entity<_impl::fortran_wrapper_traits, CppSignature>(c_name, fortran_cbindings_name, fortran_name);
            }
        };

        struct fortran_generic_registrar {
            fortran_generic_registrar(char const *generic_name, char const *concrete_name);
        };
    } // namespace _impl

    /// Outputs the content of the C compatible header with the declarations added by BINDGEN_ADD_GENERATED_DECLARATION
    void generate_c_interface(std::ostream &strm);

    /// Outputs the content of the Fortran module with the declarations added by BINDGEN_ADD_GENERATED_DECLARATION
    void generate_fortran_interface(std::ostream &strm, std::string const &module_name);
} // namespace cpp_bindgen

/**
 *  Registers the function that for declaration generations.
 *  Users should not use these directly.
 */
#define BINDGEN_ADD_GENERATED_DECLARATION(csignature, name) \
    static ::cpp_bindgen::_impl::registrar_simple<csignature> generated_declaration_registrar_##name(#name)
#define BINDGEN_ADD_GENERATED_DECLARATION_WRAPPED(cppsignature, name)                                    \
    static ::cpp_bindgen::_impl::registrar_wrapped<cppsignature> generated_declaration_registrar_##name( \
        #name, BOOST_PP_STRINGIZE(BOOST_PP_CAT(name, _impl)), #name)

#define BINDGEN_ADD_GENERIC_DECLARATION(generic_name, concrete_name)                                                   \
    static ::cpp_bindgen::_impl::fortran_generic_registrar fortran_generic_registrar_##generic_name##_##concrete_name( \
        #generic_name, #concrete_name)