aboutsummaryrefslogtreecommitdiffstats
path: root/slang_rs_export_foreach.h
blob: 581d8a1df571797e82e6d23496da49063a786118 (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
/*
 * Copyright 2011-2012, The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_  // NOLINT
#define _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_

#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/raw_ostream.h"

#include "clang/AST/Decl.h"

#include "slang_assert.h"
#include "slang_rs_context.h"
#include "slang_rs_exportable.h"
#include "slang_rs_export_type.h"

namespace clang {
  class FunctionDecl;
}  // namespace clang

namespace slang {

// Base class for reflecting control-side forEach (currently for root()
// functions that fit appropriate criteria)
class RSExportForEach : public RSExportable {
 public:

  typedef llvm::SmallVectorImpl<const clang::ParmVarDecl*> InVec;
  typedef llvm::SmallVectorImpl<const RSExportType*> InTypeVec;

  typedef InVec::const_iterator InIter;
  typedef InTypeVec::const_iterator InTypeIter;

 private:
  std::string mName;
  RSExportRecordType *mParamPacketType;
  llvm::SmallVector<const RSExportType*, 16> mInTypes;
  RSExportType *mOutType;
  size_t numParams;

  unsigned int mSignatureMetadata;

  llvm::SmallVector<const clang::ParmVarDecl*, 16> mIns;
  const clang::ParmVarDecl *mOut;
  const clang::ParmVarDecl *mUsrData;

  // Accumulator for metadata bits corresponding to special parameters.
  unsigned int mSpecialParameterSignatureMetadata;

  clang::QualType mResultType;  // return type (if present).
  bool mHasReturnType;  // does this kernel have a return type?
  bool mIsKernelStyle;  // is this a pass-by-value kernel?

  bool mDummyRoot;

  // TODO(all): Add support for LOD/face when we have them
  RSExportForEach(RSContext *Context, const llvm::StringRef &Name)
    : RSExportable(Context, RSExportable::EX_FOREACH),
      mName(Name.data(), Name.size()), mParamPacketType(nullptr),
      mOutType(nullptr), numParams(0), mSignatureMetadata(0),
      mOut(nullptr), mUsrData(nullptr), mSpecialParameterSignatureMetadata(0),
      mResultType(clang::QualType()), mHasReturnType(false),
      mIsKernelStyle(false), mDummyRoot(false) {
  }

  bool validateAndConstructParams(RSContext *Context,
                                  const clang::FunctionDecl *FD);

  bool validateAndConstructOldStyleParams(RSContext *Context,
                                          const clang::FunctionDecl *FD);

  bool validateAndConstructKernelParams(RSContext *Context,
                                        const clang::FunctionDecl *FD);

  bool processSpecialParameters(RSContext *Context,
                                const clang::FunctionDecl *FD,
                                size_t *IndexOfFirstSpecialParameter);

  bool setSignatureMetadata(RSContext *Context,
                            const clang::FunctionDecl *FD);
 public:
  static RSExportForEach *Create(RSContext *Context,
                                 const clang::FunctionDecl *FD);

  static RSExportForEach *CreateDummyRoot(RSContext *Context);

  inline const std::string &getName() const {
    return mName;
  }

  inline size_t getNumParameters() const {
    return numParams;
  }

  inline bool hasIns() const {
    return (!mIns.empty());
  }

  inline bool hasOut() const {
    return (mOut != nullptr);
  }

  inline bool hasUsrData() const {
    return (mUsrData != nullptr);
  }

  inline bool hasReturn() const {
    return mHasReturnType;
  }

  inline const InVec& getIns() const {
    return mIns;
  }

  inline const InTypeVec& getInTypes() const {
    return mInTypes;
  }

  inline const RSExportType *getOutType() const {
    return mOutType;
  }

  inline const RSExportRecordType *getParamPacketType() const {
    return mParamPacketType;
  }

  inline unsigned int getSignatureMetadata() const {
    return mSignatureMetadata;
  }

  inline bool isDummyRoot() const {
    return mDummyRoot;
  }

  typedef RSExportRecordType::const_field_iterator const_param_iterator;

  inline const_param_iterator params_begin() const {
    slangAssert((mParamPacketType != nullptr) &&
                "Get parameter from export foreach having no parameter!");
    return mParamPacketType->fields_begin();
  }

  inline const_param_iterator params_end() const {
    slangAssert((mParamPacketType != nullptr) &&
                "Get parameter from export foreach having no parameter!");
    return mParamPacketType->fields_end();
  }

  inline static bool isInitRSFunc(const clang::FunctionDecl *FD) {
    if (!FD) {
      return false;
    }
    const llvm::StringRef Name = FD->getName();
    static llvm::StringRef FuncInit("init");
    return Name.equals(FuncInit);
  }

  inline static bool isRootRSFunc(const clang::FunctionDecl *FD) {
    if (!FD) {
      return false;
    }
    const llvm::StringRef Name = FD->getName();
    static llvm::StringRef FuncRoot("root");
    return Name.equals(FuncRoot);
  }

  inline static bool isDtorRSFunc(const clang::FunctionDecl *FD) {
    if (!FD) {
      return false;
    }
    const llvm::StringRef Name = FD->getName();
    static llvm::StringRef FuncDtor(".rs.dtor");
    return Name.equals(FuncDtor);
  }

  static bool isGraphicsRootRSFunc(unsigned int targetAPI,
                                   const clang::FunctionDecl *FD);

  static bool isRSForEachFunc(unsigned int targetAPI, slang::RSContext *Context,
                              const clang::FunctionDecl *FD);

  inline static bool isSpecialRSFunc(unsigned int targetAPI,
                                     const clang::FunctionDecl *FD) {
    return isGraphicsRootRSFunc(targetAPI, FD) || isInitRSFunc(FD) ||
           isDtorRSFunc(FD);
  }

  static bool validateSpecialFuncDecl(unsigned int targetAPI,
                                      slang::RSContext *Context,
                                      const clang::FunctionDecl *FD);
};  // RSExportForEach

}  // namespace slang

#endif  // _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_  NOLINT