slang_rs_export_foreach.h revision 50cab07b24f9d85899e697cac88a05cb8347fe74
15baf6324a97430016026419deaef246ad75430fcStephen Hines/* 29999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines * Copyright 2011-2012, The Android Open Source Project 35baf6324a97430016026419deaef246ad75430fcStephen Hines * 45baf6324a97430016026419deaef246ad75430fcStephen Hines * Licensed under the Apache License, Version 2.0 (the "License"); 55baf6324a97430016026419deaef246ad75430fcStephen Hines * you may not use this file except in compliance with the License. 65baf6324a97430016026419deaef246ad75430fcStephen Hines * You may obtain a copy of the License at 75baf6324a97430016026419deaef246ad75430fcStephen Hines * 85baf6324a97430016026419deaef246ad75430fcStephen Hines * http://www.apache.org/licenses/LICENSE-2.0 95baf6324a97430016026419deaef246ad75430fcStephen Hines * 105baf6324a97430016026419deaef246ad75430fcStephen Hines * Unless required by applicable law or agreed to in writing, software 115baf6324a97430016026419deaef246ad75430fcStephen Hines * distributed under the License is distributed on an "AS IS" BASIS, 125baf6324a97430016026419deaef246ad75430fcStephen Hines * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 135baf6324a97430016026419deaef246ad75430fcStephen Hines * See the License for the specific language governing permissions and 145baf6324a97430016026419deaef246ad75430fcStephen Hines * limitations under the License. 155baf6324a97430016026419deaef246ad75430fcStephen Hines */ 165baf6324a97430016026419deaef246ad75430fcStephen Hines 17593a894650e81be54173106ec266f0311cebebd3Stephen Hines#ifndef _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_ // NOLINT 18593a894650e81be54173106ec266f0311cebebd3Stephen Hines#define _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_ 195baf6324a97430016026419deaef246ad75430fcStephen Hines 205baf6324a97430016026419deaef246ad75430fcStephen Hines#include "llvm/ADT/StringRef.h" 215baf6324a97430016026419deaef246ad75430fcStephen Hines#include "llvm/Support/raw_ostream.h" 225baf6324a97430016026419deaef246ad75430fcStephen Hines 235baf6324a97430016026419deaef246ad75430fcStephen Hines#include "clang/AST/Decl.h" 245baf6324a97430016026419deaef246ad75430fcStephen Hines 255baf6324a97430016026419deaef246ad75430fcStephen Hines#include "slang_assert.h" 265baf6324a97430016026419deaef246ad75430fcStephen Hines#include "slang_rs_context.h" 27593a894650e81be54173106ec266f0311cebebd3Stephen Hines#include "slang_rs_exportable.h" 28593a894650e81be54173106ec266f0311cebebd3Stephen Hines#include "slang_rs_export_type.h" 295baf6324a97430016026419deaef246ad75430fcStephen Hines 305baf6324a97430016026419deaef246ad75430fcStephen Hinesnamespace clang { 315baf6324a97430016026419deaef246ad75430fcStephen Hines class FunctionDecl; 325baf6324a97430016026419deaef246ad75430fcStephen Hines} // namespace clang 335baf6324a97430016026419deaef246ad75430fcStephen Hines 345baf6324a97430016026419deaef246ad75430fcStephen Hinesnamespace slang { 355baf6324a97430016026419deaef246ad75430fcStephen Hines 36593a894650e81be54173106ec266f0311cebebd3Stephen Hines// Base class for reflecting control-side forEach (currently for root() 37593a894650e81be54173106ec266f0311cebebd3Stephen Hines// functions that fit appropriate criteria) 38593a894650e81be54173106ec266f0311cebebd3Stephen Hinesclass RSExportForEach : public RSExportable { 395baf6324a97430016026419deaef246ad75430fcStephen Hines private: 405baf6324a97430016026419deaef246ad75430fcStephen Hines std::string mName; 41593a894650e81be54173106ec266f0311cebebd3Stephen Hines RSExportRecordType *mParamPacketType; 42b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines RSExportType *mInType; 43b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines RSExportType *mOutType; 44593a894650e81be54173106ec266f0311cebebd3Stephen Hines size_t numParams; 455baf6324a97430016026419deaef246ad75430fcStephen Hines 467b51b55e4467605a599e868a0dde7cb95c5ab76eStephen Hines unsigned int mSignatureMetadata; 474ccf75e55fe460a8daa49247d7e5a797329c71a6Stephen Hines 48b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mIn; 49b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mOut; 50b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mUsrData; 51b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mX; 52b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::ParmVarDecl *mY; 53b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 549ca96e70657cf5437a294213f56ba4768dc08ad2Stephen Hines clang::QualType mResultType; // return type (if present). 550f2a2397df53a1bb74609abe3c27719bc7e3c328Jean-Luc Brouillet bool mHasReturnType; // does this kernel have a return type? 560f2a2397df53a1bb74609abe3c27719bc7e3c328Jean-Luc Brouillet bool mIsKernelStyle; // is this a pass-by-value kernel? 579ca96e70657cf5437a294213f56ba4768dc08ad2Stephen Hines 58c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines bool mDummyRoot; 59c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines 60b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines // TODO(all): Add support for LOD/face when we have them 61c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines RSExportForEach(RSContext *Context, const llvm::StringRef &Name) 62593a894650e81be54173106ec266f0311cebebd3Stephen Hines : RSExportable(Context, RSExportable::EX_FOREACH), 63b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines mName(Name.data(), Name.size()), mParamPacketType(NULL), mInType(NULL), 647b51b55e4467605a599e868a0dde7cb95c5ab76eStephen Hines mOutType(NULL), numParams(0), mSignatureMetadata(0), 6550cab07b24f9d85899e697cac88a05cb8347fe74Narayan Kamath mIn(NULL), mOut(NULL), mUsrData(NULL), mX(NULL), mY(NULL), 6650cab07b24f9d85899e697cac88a05cb8347fe74Narayan Kamath mResultType(clang::QualType()), mHasReturnType(false), 670f2a2397df53a1bb74609abe3c27719bc7e3c328Jean-Luc Brouillet mIsKernelStyle(false), mDummyRoot(false) { 685baf6324a97430016026419deaef246ad75430fcStephen Hines return; 695baf6324a97430016026419deaef246ad75430fcStephen Hines } 705baf6324a97430016026419deaef246ad75430fcStephen Hines 71b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines bool validateAndConstructParams(RSContext *Context, 72b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines const clang::FunctionDecl *FD); 73b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 740f2a2397df53a1bb74609abe3c27719bc7e3c328Jean-Luc Brouillet bool validateAndConstructOldStyleParams(RSContext *Context, 7542f81b2b44205f421c6bd4727ce8c25b0effcb55Jean-Luc Brouillet const clang::FunctionDecl *FD); 760f2a2397df53a1bb74609abe3c27719bc7e3c328Jean-Luc Brouillet 779ca96e70657cf5437a294213f56ba4768dc08ad2Stephen Hines bool validateAndConstructKernelParams(RSContext *Context, 789ca96e70657cf5437a294213f56ba4768dc08ad2Stephen Hines const clang::FunctionDecl *FD); 799ca96e70657cf5437a294213f56ba4768dc08ad2Stephen Hines 8042f81b2b44205f421c6bd4727ce8c25b0effcb55Jean-Luc Brouillet bool validateIterationParameters(RSContext *Context, 8142f81b2b44205f421c6bd4727ce8c25b0effcb55Jean-Luc Brouillet const clang::FunctionDecl *FD, 8242f81b2b44205f421c6bd4727ce8c25b0effcb55Jean-Luc Brouillet size_t *IndexOfFirstIterator); 8342f81b2b44205f421c6bd4727ce8c25b0effcb55Jean-Luc Brouillet 840f2a2397df53a1bb74609abe3c27719bc7e3c328Jean-Luc Brouillet bool setSignatureMetadata(RSContext *Context, 850f2a2397df53a1bb74609abe3c27719bc7e3c328Jean-Luc Brouillet const clang::FunctionDecl *FD); 865baf6324a97430016026419deaef246ad75430fcStephen Hines public: 87593a894650e81be54173106ec266f0311cebebd3Stephen Hines static RSExportForEach *Create(RSContext *Context, 88593a894650e81be54173106ec266f0311cebebd3Stephen Hines const clang::FunctionDecl *FD); 89593a894650e81be54173106ec266f0311cebebd3Stephen Hines 90c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines static RSExportForEach *CreateDummyRoot(RSContext *Context); 91c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines 92593a894650e81be54173106ec266f0311cebebd3Stephen Hines inline const std::string &getName() const { 93593a894650e81be54173106ec266f0311cebebd3Stephen Hines return mName; 94593a894650e81be54173106ec266f0311cebebd3Stephen Hines } 95593a894650e81be54173106ec266f0311cebebd3Stephen Hines 96593a894650e81be54173106ec266f0311cebebd3Stephen Hines inline size_t getNumParameters() const { 97593a894650e81be54173106ec266f0311cebebd3Stephen Hines return numParams; 98593a894650e81be54173106ec266f0311cebebd3Stephen Hines } 99593a894650e81be54173106ec266f0311cebebd3Stephen Hines 100b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline bool hasIn() const { 101b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return (mIn != NULL); 102b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 103b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 104b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline bool hasOut() const { 105b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return (mOut != NULL); 106b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 107b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 108b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline bool hasUsrData() const { 109b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return (mUsrData != NULL); 110b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 111b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 1129ca96e70657cf5437a294213f56ba4768dc08ad2Stephen Hines inline bool hasReturn() const { 1130f2a2397df53a1bb74609abe3c27719bc7e3c328Jean-Luc Brouillet return mHasReturnType; 1149ca96e70657cf5437a294213f56ba4768dc08ad2Stephen Hines } 1159ca96e70657cf5437a294213f56ba4768dc08ad2Stephen Hines 116b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline const RSExportType *getInType() const { 117b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return mInType; 118b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 119b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 120b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline const RSExportType *getOutType() const { 121b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return mOutType; 122b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 123b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 124b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines inline const RSExportRecordType *getParamPacketType() const { 125b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines return mParamPacketType; 126b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines } 127593a894650e81be54173106ec266f0311cebebd3Stephen Hines 1287b51b55e4467605a599e868a0dde7cb95c5ab76eStephen Hines inline unsigned int getSignatureMetadata() const { 1297b51b55e4467605a599e868a0dde7cb95c5ab76eStephen Hines return mSignatureMetadata; 1304ccf75e55fe460a8daa49247d7e5a797329c71a6Stephen Hines } 1314ccf75e55fe460a8daa49247d7e5a797329c71a6Stephen Hines 132c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines inline bool isDummyRoot() const { 133c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines return mDummyRoot; 134c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines } 135c17e198ffcd37bfc57e3add1f6eee952ae2a2eabStephen Hines 136593a894650e81be54173106ec266f0311cebebd3Stephen Hines typedef RSExportRecordType::const_field_iterator const_param_iterator; 1375baf6324a97430016026419deaef246ad75430fcStephen Hines 138593a894650e81be54173106ec266f0311cebebd3Stephen Hines inline const_param_iterator params_begin() const { 139593a894650e81be54173106ec266f0311cebebd3Stephen Hines slangAssert((mParamPacketType != NULL) && 140593a894650e81be54173106ec266f0311cebebd3Stephen Hines "Get parameter from export foreach having no parameter!"); 141593a894650e81be54173106ec266f0311cebebd3Stephen Hines return mParamPacketType->fields_begin(); 142593a894650e81be54173106ec266f0311cebebd3Stephen Hines } 143b5a89fbfcba6d8817c1c3700ed78bd6482cf1a5dStephen Hines 144593a894650e81be54173106ec266f0311cebebd3Stephen Hines inline const_param_iterator params_end() const { 145593a894650e81be54173106ec266f0311cebebd3Stephen Hines slangAssert((mParamPacketType != NULL) && 146593a894650e81be54173106ec266f0311cebebd3Stephen Hines "Get parameter from export foreach having no parameter!"); 147593a894650e81be54173106ec266f0311cebebd3Stephen Hines return mParamPacketType->fields_end(); 1485baf6324a97430016026419deaef246ad75430fcStephen Hines } 1495baf6324a97430016026419deaef246ad75430fcStephen Hines 1505baf6324a97430016026419deaef246ad75430fcStephen Hines inline static bool isInitRSFunc(const clang::FunctionDecl *FD) { 1515baf6324a97430016026419deaef246ad75430fcStephen Hines if (!FD) { 1525baf6324a97430016026419deaef246ad75430fcStephen Hines return false; 1535baf6324a97430016026419deaef246ad75430fcStephen Hines } 1545baf6324a97430016026419deaef246ad75430fcStephen Hines const llvm::StringRef Name = FD->getName(); 1555baf6324a97430016026419deaef246ad75430fcStephen Hines static llvm::StringRef FuncInit("init"); 1565baf6324a97430016026419deaef246ad75430fcStephen Hines return Name.equals(FuncInit); 1575baf6324a97430016026419deaef246ad75430fcStephen Hines } 1585baf6324a97430016026419deaef246ad75430fcStephen Hines 1595baf6324a97430016026419deaef246ad75430fcStephen Hines inline static bool isRootRSFunc(const clang::FunctionDecl *FD) { 1605baf6324a97430016026419deaef246ad75430fcStephen Hines if (!FD) { 1615baf6324a97430016026419deaef246ad75430fcStephen Hines return false; 1625baf6324a97430016026419deaef246ad75430fcStephen Hines } 1635baf6324a97430016026419deaef246ad75430fcStephen Hines const llvm::StringRef Name = FD->getName(); 1645baf6324a97430016026419deaef246ad75430fcStephen Hines static llvm::StringRef FuncRoot("root"); 1655baf6324a97430016026419deaef246ad75430fcStephen Hines return Name.equals(FuncRoot); 1665baf6324a97430016026419deaef246ad75430fcStephen Hines } 1675baf6324a97430016026419deaef246ad75430fcStephen Hines 168688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines inline static bool isDtorRSFunc(const clang::FunctionDecl *FD) { 169688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines if (!FD) { 170688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines return false; 171688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines } 172688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines const llvm::StringRef Name = FD->getName(); 173688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines static llvm::StringRef FuncDtor(".rs.dtor"); 174688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines return Name.equals(FuncDtor); 175688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines } 176688e64b2d56e4218c680b9d6523c5de672f55757Stephen Hines 1779999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines static bool isGraphicsRootRSFunc(int targetAPI, 1789999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines const clang::FunctionDecl *FD); 1799999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines 180d3f7527b105d21f1c69d3473eb88a762f2c3ab5aJean-Luc Brouillet static bool isRSForEachFunc(int targetAPI, slang::RSContext *Context, 181089cde338148fbb75825aea4539ccdae8211ffefStephen Hines const clang::FunctionDecl *FD); 182593a894650e81be54173106ec266f0311cebebd3Stephen Hines 1839999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines inline static bool isSpecialRSFunc(int targetAPI, 1849999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines const clang::FunctionDecl *FD) { 1859999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines return isGraphicsRootRSFunc(targetAPI, FD) || isInitRSFunc(FD) || 1869999ec3aa0c4d7a6befd3a300dc07f0cea91cb6cStephen Hines isDtorRSFunc(FD); 1875baf6324a97430016026419deaef246ad75430fcStephen Hines } 1885baf6324a97430016026419deaef246ad75430fcStephen Hines 189f736d5a12269e7e74740b130cdca98d9839b31e6Stephen Hines static bool validateSpecialFuncDecl(int targetAPI, 190d3f7527b105d21f1c69d3473eb88a762f2c3ab5aJean-Luc Brouillet slang::RSContext *Context, 1915baf6324a97430016026419deaef246ad75430fcStephen Hines const clang::FunctionDecl *FD); 192593a894650e81be54173106ec266f0311cebebd3Stephen Hines}; // RSExportForEach 1935baf6324a97430016026419deaef246ad75430fcStephen Hines 1945baf6324a97430016026419deaef246ad75430fcStephen Hines} // namespace slang 1955baf6324a97430016026419deaef246ad75430fcStephen Hines 196593a894650e81be54173106ec266f0311cebebd3Stephen Hines#endif // _FRAMEWORKS_COMPILE_SLANG_SLANG_RS_EXPORT_FOREACH_H_ NOLINT 197