blob: 67b3a5ce4a094a29e1d95bfd164c84f95ed9cad7 [file] [log] [blame]
* 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
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#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 {
typedef llvm::SmallVectorImpl<const clang::ParmVarDecl*> InVec;
typedef llvm::SmallVectorImpl<const RSExportType*> InTypeVec;
typedef InVec::const_iterator InIter;
typedef InTypeVec::const_iterator InTypeIter;
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.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);
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();
static bool isRSForEachFunc(unsigned int targetAPI,
const clang::FunctionDecl *FD);
static unsigned getNumInputs(unsigned int targetAPI,
const clang::FunctionDecl *FD);
}; // RSExportForEach
} // namespace slang