summaryrefslogtreecommitdiffstats
path: root/flang/lib/Lower/OpenMP/Clauses.h
blob: 1d1a112aac3be6f995f9ea16ee27d7a3e1c6aa49 (plain)
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
//===-- Clauses.h -- OpenMP clause handling -------------------------------===//
//
// 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_LOWER_OPENMP_CLAUSES_H
#define FORTRAN_LOWER_OPENMP_CLAUSES_H

#include "ClauseT.h"

#include "flang/Evaluate/expression.h"
#include "flang/Parser/parse-tree.h"
#include "flang/Semantics/expression.h"
#include "flang/Semantics/semantics.h"
#include "flang/Semantics/symbol.h"

#include "llvm/ADT/STLExtras.h"

#include <optional>
#include <type_traits>
#include <utility>

namespace Fortran::lower::omp {
using namespace Fortran;
using SomeType = evaluate::SomeType;
using SomeExpr = semantics::SomeExpr;
using MaybeExpr = semantics::MaybeExpr;

using SymIdent = semantics::Symbol *;
using SymReference = SomeExpr;

template <typename T>
using List = tomp::ListT<T>;
} // namespace Fortran::lower::omp

namespace tomp {
template <>
struct ObjectT<Fortran::lower::omp::SymIdent,
               Fortran::lower::omp::SymReference> {
  using IdType = Fortran::lower::omp::SymIdent;
  using ExprType = Fortran::lower::omp::SymReference;

  const IdType &id() const { return symbol; }
  const std::optional<ExprType> &ref() const { return designator; }

  IdType symbol;
  std::optional<ExprType> designator;
};
} // namespace tomp

namespace Fortran::lower::omp {

using Object = tomp::ObjectT<SymIdent, SymReference>;
using ObjectList = tomp::ObjectListT<SymIdent, SymReference>;

Object makeObject(const parser::OmpObject &object,
                  semantics::SemanticsContext &semaCtx);
Object makeObject(const parser::Name &name,
                  semantics::SemanticsContext &semaCtx);
Object makeObject(const parser::Designator &dsg,
                  semantics::SemanticsContext &semaCtx);
Object makeObject(const parser::StructureComponent &comp,
                  semantics::SemanticsContext &semaCtx);

inline auto makeObjectFn(semantics::SemanticsContext &semaCtx) {
  return [&](auto &&s) { return makeObject(s, semaCtx); };
}

template <typename T>
SomeExpr makeExpr(T &&pftExpr, semantics::SemanticsContext &semaCtx) {
  auto maybeExpr = evaluate::ExpressionAnalyzer(semaCtx).Analyze(pftExpr);
  assert(maybeExpr);
  return std::move(*maybeExpr);
}

inline auto makeExprFn(semantics::SemanticsContext &semaCtx) {
  return [&](auto &&s) { return makeExpr(s, semaCtx); };
}

template <
    typename ContainerTy, typename FunctionTy,
    typename ElemTy = typename llvm::remove_cvref_t<ContainerTy>::value_type,
    typename ResultTy = std::invoke_result_t<FunctionTy, ElemTy>>
List<ResultTy> makeList(ContainerTy &&container, FunctionTy &&func) {
  List<ResultTy> v;
  llvm::transform(container, std::back_inserter(v), func);
  return v;
}

inline ObjectList makeList(const parser::OmpObjectList &objects,
                           semantics::SemanticsContext &semaCtx) {
  return makeList(objects.v, makeObjectFn(semaCtx));
}

template <typename FuncTy, typename ElemTy,
          typename ResultTy = std::invoke_result_t<FuncTy, ElemTy>>
std::optional<ResultTy> maybeApply(FuncTy &&func,
                                   const std::optional<ElemTy> &inp) {
  if (!inp)
    return std::nullopt;
  return std::move(func(*inp));
}

std::optional<Object>
getBaseObject(const Object &object,
              Fortran::semantics::SemanticsContext &semaCtx);

namespace clause {
#ifdef EMPTY_CLASS
#undef EMPTY_CLASS
#endif
#define EMPTY_CLASS(cls)                                                       \
  using cls = tomp::clause::cls##T<SymIdent, SymReference>

#ifdef WRAPPER_CLASS
#undef WRAPPER_CLASS
#endif
#define WRAPPER_CLASS(cls, content)                                            \
  [[maybe_unused]] extern int xyzzy_semicolon_absorber
#define GEN_FLANG_CLAUSE_PARSER_CLASSES
#include "llvm/Frontend/OpenMP/OMP.inc"
#undef EMPTY_CLASS
#undef WRAPPER_CLASS

using DefinedOperator = tomp::clause::DefinedOperatorT<SymIdent, SymReference>;
using ProcedureDesignator =
    tomp::clause::ProcedureDesignatorT<SymIdent, SymReference>;
using ReductionOperator =
    tomp::clause::ReductionOperatorT<SymIdent, SymReference>;

// "Requires" clauses are handled early on, and the aggregated information
// is stored in the Symbol details of modules, programs, and subprograms.
// These clauses are still handled here to cover all alternatives in the
// main clause variant.

using Aligned = tomp::clause::AlignedT<SymIdent, SymReference>;
using Allocate = tomp::clause::AllocateT<SymIdent, SymReference>;
using Allocator = tomp::clause::AllocatorT<SymIdent, SymReference>;
using AtomicDefaultMemOrder =
    tomp::clause::AtomicDefaultMemOrderT<SymIdent, SymReference>;
using Collapse = tomp::clause::CollapseT<SymIdent, SymReference>;
using Copyin = tomp::clause::CopyinT<SymIdent, SymReference>;
using Copyprivate = tomp::clause::CopyprivateT<SymIdent, SymReference>;
using Defaultmap = tomp::clause::DefaultmapT<SymIdent, SymReference>;
using Default = tomp::clause::DefaultT<SymIdent, SymReference>;
using Depend = tomp::clause::DependT<SymIdent, SymReference>;
using Device = tomp::clause::DeviceT<SymIdent, SymReference>;
using DeviceType = tomp::clause::DeviceTypeT<SymIdent, SymReference>;
using DistSchedule = tomp::clause::DistScheduleT<SymIdent, SymReference>;
using Enter = tomp::clause::EnterT<SymIdent, SymReference>;
using Filter = tomp::clause::FilterT<SymIdent, SymReference>;
using Final = tomp::clause::FinalT<SymIdent, SymReference>;
using Firstprivate = tomp::clause::FirstprivateT<SymIdent, SymReference>;
using From = tomp::clause::FromT<SymIdent, SymReference>;
using Grainsize = tomp::clause::GrainsizeT<SymIdent, SymReference>;
using HasDeviceAddr = tomp::clause::HasDeviceAddrT<SymIdent, SymReference>;
using Hint = tomp::clause::HintT<SymIdent, SymReference>;
using If = tomp::clause::IfT<SymIdent, SymReference>;
using InReduction = tomp::clause::InReductionT<SymIdent, SymReference>;
using IsDevicePtr = tomp::clause::IsDevicePtrT<SymIdent, SymReference>;
using Lastprivate = tomp::clause::LastprivateT<SymIdent, SymReference>;
using Linear = tomp::clause::LinearT<SymIdent, SymReference>;
using Link = tomp::clause::LinkT<SymIdent, SymReference>;
using Map = tomp::clause::MapT<SymIdent, SymReference>;
using Nocontext = tomp::clause::NocontextT<SymIdent, SymReference>;
using Nontemporal = tomp::clause::NontemporalT<SymIdent, SymReference>;
using Novariants = tomp::clause::NovariantsT<SymIdent, SymReference>;
using NumTasks = tomp::clause::NumTasksT<SymIdent, SymReference>;
using NumTeams = tomp::clause::NumTeamsT<SymIdent, SymReference>;
using NumThreads = tomp::clause::NumThreadsT<SymIdent, SymReference>;
using OmpxDynCgroupMem =
    tomp::clause::OmpxDynCgroupMemT<SymIdent, SymReference>;
using Ordered = tomp::clause::OrderedT<SymIdent, SymReference>;
using Order = tomp::clause::OrderT<SymIdent, SymReference>;
using Partial = tomp::clause::PartialT<SymIdent, SymReference>;
using Priority = tomp::clause::PriorityT<SymIdent, SymReference>;
using Private = tomp::clause::PrivateT<SymIdent, SymReference>;
using ProcBind = tomp::clause::ProcBindT<SymIdent, SymReference>;
using Reduction = tomp::clause::ReductionT<SymIdent, SymReference>;
using Safelen = tomp::clause::SafelenT<SymIdent, SymReference>;
using Schedule = tomp::clause::ScheduleT<SymIdent, SymReference>;
using Shared = tomp::clause::SharedT<SymIdent, SymReference>;
using Simdlen = tomp::clause::SimdlenT<SymIdent, SymReference>;
using Sizes = tomp::clause::SizesT<SymIdent, SymReference>;
using TaskReduction = tomp::clause::TaskReductionT<SymIdent, SymReference>;
using ThreadLimit = tomp::clause::ThreadLimitT<SymIdent, SymReference>;
using To = tomp::clause::ToT<SymIdent, SymReference>;
using Uniform = tomp::clause::UniformT<SymIdent, SymReference>;
using UseDeviceAddr = tomp::clause::UseDeviceAddrT<SymIdent, SymReference>;
using UseDevicePtr = tomp::clause::UseDevicePtrT<SymIdent, SymReference>;
} // namespace clause

struct Clause : public tomp::ClauseT<SymIdent, SymReference> {
  parser::CharBlock source;
};

template <typename Specific>
Clause makeClause(llvm::omp::Clause id, Specific &&specific,
                  parser::CharBlock source = {}) {
  return Clause{{id, specific}, source};
}

Clause makeClause(const Fortran::parser::OmpClause &cls,
                  semantics::SemanticsContext &semaCtx);

List<Clause> makeList(const parser::OmpClauseList &clauses,
                      semantics::SemanticsContext &semaCtx);
} // namespace Fortran::lower::omp

#endif // FORTRAN_LOWER_OPENMP_CLAUSES_H