Skip to content

Commit

Permalink
[SYCL] Fix accessor to subset of buffer indexing (compiler part)
Browse files Browse the repository at this point in the history 
To get correct offset in subscript operator we should use range of
original buffer. To keep accessor functionality like "get_range" and "get_count"
spec conformant we should use accessor's own range.
Introduced AccessRange and MemRange to accessor implemetation. This
fields can be initialized through __init method.

Signed-off-by: Vladimir Lazarev <[email protected]>
Signed-off-by: Mariya Podchishchaeva <[email protected]>
  • Loading branch information
@Fznamznon @vladimirlaz
Fznamznon authored and vladimirlaz committed Mar 22, 2019
1 parent 873ad55 commit 7edf29c
Show file tree
Hide file tree
Showing 7 changed files with 109 additions and 80 deletions.
112 changes: 66 additions & 46 deletions clang/lib/Sema/SemaSYCL.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@
#include "clang/AST/QualTypeNames.h"
#include "clang/AST/RecordLayout.h"
#include "clang/AST/RecursiveASTVisitor.h"
#include "clang/Analysis/CallGraph.h"
#include "clang/Sema/Sema.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/raw_ostream.h"
#include "clang/Analysis/CallGraph.h"

#include <array>

Expand Down Expand Up @@ -95,17 +95,17 @@ class MarkDeviceFunction : public RecursiveASTVisitor<MarkDeviceFunction> {
// all functions used by kernel have already been parsed and have
// definitions.
if (RecursiveSet.count(Callee)) {
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict) <<
KernelCallRecursiveFunction;
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict)
<< KernelCallRecursiveFunction;
SemaRef.Diag(Callee->getSourceRange().getBegin(),
diag::note_sycl_recursive_function_declared_here)
<< KernelCallRecursiveFunction;
diag::note_sycl_recursive_function_declared_here)
<< KernelCallRecursiveFunction;
}

if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(Callee))
if (Method->isVirtual())
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict) <<
KernelCallVirtualFunction;
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict)
<< KernelCallVirtualFunction;

CheckSYCLType(Callee->getReturnType(), Callee->getSourceRange());

Expand All @@ -116,8 +116,8 @@ class MarkDeviceFunction : public RecursiveASTVisitor<MarkDeviceFunction> {
}
}
} else if (!SemaRef.getLangOpts().SYCLAllowFuncPtr)
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict) <<
KernelCallFunctionPointer;
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict)
<< KernelCallFunctionPointer;
return true;
}

Expand Down Expand Up @@ -178,8 +178,8 @@ class MarkDeviceFunction : public RecursiveASTVisitor<MarkDeviceFunction> {
if (VarDecl *VD = dyn_cast<VarDecl>(E->getMemberDecl())) {
bool IsConst = VD->getType().getNonReferenceType().isConstQualified();
if (VD->isStaticDataMember() && !IsConst)
SemaRef.Diag(E->getExprLoc(), diag::err_sycl_restrict) <<
KernelNonConstStaticDataVariable;
SemaRef.Diag(E->getExprLoc(), diag::err_sycl_restrict)
<< KernelNonConstStaticDataVariable;
}
return true;
}
Expand All @@ -190,24 +190,24 @@ class MarkDeviceFunction : public RecursiveASTVisitor<MarkDeviceFunction> {
bool IsConst = VD->getType().getNonReferenceType().isConstQualified();
if (!IsConst && VD->hasGlobalStorage() && !VD->isStaticLocal() &&
!VD->isStaticDataMember() && !isa<ParmVarDecl>(VD))
SemaRef.Diag(E->getLocation(), diag::err_sycl_restrict) <<
KernelGlobalVariable;
SemaRef.Diag(E->getLocation(), diag::err_sycl_restrict)
<< KernelGlobalVariable;
}
return true;
}

bool VisitCXXNewExpr(CXXNewExpr *E) {
// Memory storage allocation is not allowed in kernels.
// All memory allocation for the device is done on
// the host using accessor classes. Consequently, the default
// allocation operator new overloads that allocate
// storage are disallowed in a SYCL kernel. The placement
// new operator and any user-defined overloads that
// do not allocate storage are permitted.
// Memory storage allocation is not allowed in kernels.
// All memory allocation for the device is done on
// the host using accessor classes. Consequently, the default
// allocation operator new overloads that allocate
// storage are disallowed in a SYCL kernel. The placement
// new operator and any user-defined overloads that
// do not allocate storage are permitted.
if (FunctionDecl *FD = E->getOperatorNew()) {
if (FD->isReplaceableGlobalAllocationFunction()) {
SemaRef.Diag(E->getExprLoc(), diag::err_sycl_restrict) <<
KernelAllocateStorage;
SemaRef.Diag(E->getExprLoc(), diag::err_sycl_restrict)
<< KernelAllocateStorage;
} else if (FunctionDecl *Def = FD->getDefinition()) {
if (!Def->hasAttr<SYCLDeviceAttr>()) {
Def->addAttr(SYCLDeviceAttr::CreateImplicit(SemaRef.Context));
Expand All @@ -219,26 +219,26 @@ class MarkDeviceFunction : public RecursiveASTVisitor<MarkDeviceFunction> {
}

bool VisitCXXThrowExpr(CXXThrowExpr *E) {
SemaRef.Diag(E->getExprLoc(), diag::err_sycl_restrict) <<
KernelUseExceptions;
SemaRef.Diag(E->getExprLoc(), diag::err_sycl_restrict)
<< KernelUseExceptions;
return true;
}

bool VisitCXXCatchStmt(CXXCatchStmt *S) {
SemaRef.Diag(S->getBeginLoc(), diag::err_sycl_restrict) <<
KernelUseExceptions;
SemaRef.Diag(S->getBeginLoc(), diag::err_sycl_restrict)
<< KernelUseExceptions;
return true;
}

bool VisitCXXTryStmt(CXXTryStmt *S) {
SemaRef.Diag(S->getBeginLoc(), diag::err_sycl_restrict) <<
KernelUseExceptions;
SemaRef.Diag(S->getBeginLoc(), diag::err_sycl_restrict)
<< KernelUseExceptions;
return true;
}

bool VisitSEHTryStmt(SEHTryStmt *S) {
SemaRef.Diag(S->getBeginLoc(), diag::err_sycl_restrict) <<
KernelUseExceptions;
SemaRef.Diag(S->getBeginLoc(), diag::err_sycl_restrict)
<< KernelUseExceptions;
return true;
}

Expand Down Expand Up @@ -291,8 +291,8 @@ class MarkDeviceFunction : public RecursiveASTVisitor<MarkDeviceFunction> {
}
}
}
private:

private:
bool CheckSYCLType(QualType Ty, SourceRange Loc) {
if (Ty->isVariableArrayType()) {
SemaRef.Diag(Loc.getBegin(), diag::err_vla_unsupported);
Expand All @@ -306,7 +306,7 @@ class MarkDeviceFunction : public RecursiveASTVisitor<MarkDeviceFunction> {
// FIXME: this seems like a temporary fix for SYCL programs
// that pre-declare, use, but not define OclCXX classes,
// which are later translated into SPIRV types.
if(!CRD->hasDefinition())
if (!CRD->hasDefinition())
return true;

if (CRD->isPolymorphic()) {
Expand Down Expand Up @@ -450,9 +450,10 @@ CreateSYCLKernelBody(Sema &S, FunctionDecl *KernelCallerFunc, DeclContext *DC) {
QualType FieldType = Field->getType();
CXXRecordDecl *CRD = FieldType->getAsCXXRecordDecl();
if (CRD && Util::isSyclAccessorType(FieldType)) {
// Since this is an accessor next 3 TargetFuncParams including current
// should be set in __init method: _ValueType*, range<int>, id<int>
const size_t NumParams = 3;
// Since this is an accessor next 4 TargetFuncParams including current
// should be set in __init method: _ValueType*, range<int>, range<int>,
// id<int>
const size_t NumParams = 4;
llvm::SmallVector<DeclRefExpr *, NumParams> ParamDREs(NumParams);
auto TFP = TargetFuncParam;
for (size_t I = 0; I < NumParams; ++TFP, ++I) {
Expand Down Expand Up @@ -495,7 +496,7 @@ CreateSYCLKernelBody(Sema &S, FunctionDecl *KernelCallerFunc, DeclContext *DC) {
ExprValueKind VK = Expr::getValueKindForType(ResultTy);
ResultTy = ResultTy.getNonLValueExprType(S.Context);

// __init needs three parameter
// __init needs four parameter
auto ParamItr = InitMethod->param_begin();
// kernel_parameters
llvm::SmallVector<Expr *, NumParams> ParamStmts;
Expand All @@ -505,7 +506,10 @@ CreateSYCLKernelBody(Sema &S, FunctionDecl *KernelCallerFunc, DeclContext *DC) {
S, ((*ParamItr++))->getOriginalType(), ParamDREs[1]));
ParamStmts.push_back(getExprForRangeOrOffset(
S, ((*ParamItr++))->getOriginalType(), ParamDREs[2]));
// kernel_obj.accessor.__init(_ValueType*, range<int>, id<int>)
ParamStmts.push_back(getExprForRangeOrOffset(
S, ((*ParamItr++))->getOriginalType(), ParamDREs[3]));
// kernel_obj.accessor.__init(_ValueType*, range<int>, range<int>,
// id<int>)
CXXMemberCallExpr *Call = CXXMemberCallExpr::Create(
S.Context, ME, ParamStmts, ResultTy, VK, SourceLocation());
BodyStmts.push_back(Call);
Expand Down Expand Up @@ -643,10 +647,17 @@ static void buildArgTys(ASTContext &Context, CXXRecordDecl *KernelObj,

CreateAndAddPrmDsc(Fld, PointerType);

FieldDecl *RangeFld = getFieldDeclByName(RecordDecl, {"__impl", "Range"});
assert(RangeFld &&
"The accessor must contain the Range from the __impl field");
CreateAndAddPrmDsc(RangeFld, RangeFld->getType());
FieldDecl *AccessRangeFld =
getFieldDeclByName(RecordDecl, {"__impl", "AccessRange"});
assert(AccessRangeFld &&
"The accessor must contain the AccessRange from the __impl field");
CreateAndAddPrmDsc(AccessRangeFld, AccessRangeFld->getType());

FieldDecl *MemRangeFld =
getFieldDeclByName(RecordDecl, {"__impl", "MemRange"});
assert(MemRangeFld &&
"The accessor must contain the MemRange from the __impl field");
CreateAndAddPrmDsc(MemRangeFld, MemRangeFld->getType());

FieldDecl *OffsetFld =
getFieldDeclByName(RecordDecl, {"__impl", "Offset"});
Expand Down Expand Up @@ -705,13 +716,22 @@ static void populateIntHeader(SYCLIntegrationHeader &H, const StringRef Name,
const auto *AccTmplTy = cast<ClassTemplateSpecializationDecl>(AccTy);
H.addParamDesc(SYCLIntegrationHeader::kind_accessor,
getAccessTarget(AccTmplTy), Offset);
// ... second descriptor (translated to range kernel parameter):
FieldDecl *RngFld =
getFieldDeclByName(AccTy, {"__impl", "Range"}, &Offset);
uint64_t Sz = Ctx.getTypeSizeInChars(RngFld->getType()).getQuantity();
// ... second descriptor (translated to access range kernel parameter):
FieldDecl *AccessRngFld =
getFieldDeclByName(AccTy, {"__impl", "AccessRange"}, &Offset);
uint64_t Sz =
Ctx.getTypeSizeInChars(AccessRngFld->getType()).getQuantity();
H.addParamDesc(SYCLIntegrationHeader::kind_std_layout,
static_cast<unsigned>(Sz), static_cast<unsigned>(Offset));
// ... third descriptor (translated to mem range kernel parameter):
// Get offset in bytes
Offset = Layout.getFieldOffset(Fld->getFieldIndex()) / 8;
FieldDecl *MemRngFld =
getFieldDeclByName(AccTy, {"__impl", "MemRange"}, &Offset);
Sz = Ctx.getTypeSizeInChars(MemRngFld->getType()).getQuantity();
H.addParamDesc(SYCLIntegrationHeader::kind_std_layout,
static_cast<unsigned>(Sz), static_cast<unsigned>(Offset));
// ... third descriptor (translated to id kernel parameter):
// ... fourth descriptor (translated to id kernel parameter):
// Get offset in bytes
Offset = Layout.getFieldOffset(Fld->getFieldIndex()) / 8;
FieldDecl *OffstFld =
Expand Down
51 changes: 28 additions & 23 deletions clang/test/CodeGenSYCL/Inputs/sycl.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,11 @@ class property_list {
template <typename... propertyTN>
property_list(propertyTN... props) {}

template <typename propertyT> bool has_property() const { return true; }
template <typename propertyT>
bool has_property() const { return true; }

template <typename propertyT> propertyT get_property() const {
template <typename propertyT>
propertyT get_property() const {
return propertyT{};
}

Expand All @@ -77,12 +79,14 @@ class property_list {

template <int dim>
struct id {
template<typename ...T> id(T...args) {} // fake constructor
template <typename... T>
id(T... args) {} // fake constructor
};

template <int dim>
struct range {
template<typename ...T> range(T...args) {} // fake constructor
template <typename... T>
range(T... args) {} // fake constructor
};

template <int dim>
Expand All @@ -91,35 +95,36 @@ struct nd_range {

template <int dim>
struct _ImplT {
range<dim> Range;
id<dim> Offset;
range<dim> AccessRange;
range<dim> MemRange;
id<dim> Offset;
};

template <typename dataT, int dimensions, access::mode accessmode,
access::target accessTarget = access::target::global_buffer,
access::placeholder isPlaceholder = access::placeholder::false_t>
class accessor {

public:

void __init(__global dataT *Ptr, range<dimensions> Range,
id<dimensions> Offset) {
}
void use(void) const {}
template <typename ...T> void use(T...args) { }
template <typename ...T> void use(T...args) const { }
_ImplT<dimensions> __impl;
access::target accessTarget = access::target::global_buffer,
access::placeholder isPlaceholder = access::placeholder::false_t>
class accessor {

public:
void __init(__global dataT *Ptr, range<dimensions> AccessRange,
range<dimensions> MemRange, id<dimensions> Offset) {}
void use(void) const {}
template <typename... T>
void use(T... args) {}
template <typename... T>
void use(T... args) const {}
_ImplT<dimensions> __impl;
};

class kernel {};
class context {};
class device {};
class event{};
class event {};

class queue {
public:
template <typename T> event submit(T cgf) { return event{}; }
template <typename T>
event submit(T cgf) { return event{}; }

void wait() {}
void wait_and_throw() {}
Expand Down Expand Up @@ -177,7 +182,8 @@ class buffer {
using const_reference = const value_type &;
using allocator_type = AllocatorT;

template <typename ...ParamTypes> buffer(ParamTypes...args) {} // fake constructor
template <typename... ParamTypes>
buffer(ParamTypes... args) {} // fake constructor

buffer(const range<dimensions> &bufferRange,
const property_list &propList = {}) {}
Expand Down Expand Up @@ -221,4 +227,3 @@ class buffer {

} // namespace sycl
} // namespace cl

6 changes: 5 additions & 1 deletion clang/test/CodeGenSYCL/integration_header.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,25 @@
// CHECK-NEXT: { kernel_param_kind_t::kind_accessor, 2014, 4 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 4 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 5 },
// CHECK-NEXT: { kernel_param_kind_t::kind_accessor, 2016, 6 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 6 },
// CHECK-NEXT: { kernel_param_kind_t::kind_accessor, 2016, 7 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 7 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 8 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 9 },
// CHECK-EMPTY:
// CHECK-NEXT: //--- _ZTSN16second_namespace13second_kernelIcEE
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 4, 0 },
// CHECK-NEXT: { kernel_param_kind_t::kind_accessor, 2016, 4 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 4 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 5 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 6 },
// CHECK-EMPTY:
// CHECK-NEXT: //--- _ZTS12third_kernelILi1Ei5pointIZ4mainE1XEE
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 4, 0 },
// CHECK-NEXT: { kernel_param_kind_t::kind_accessor, 2016, 4 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 4 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 5 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 6 },
// CHECK-EMPTY:
// CHECK-NEXT: };
//
Expand Down
1 change: 1 addition & 0 deletions clang/test/CodeGenSYCL/struct_kernel_param.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
// CHECK-NEXT: { kernel_param_kind_t::kind_accessor, 2014, 0 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 0 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 1 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 1, 2 },
// CHECK-NEXT: { kernel_param_kind_t::kind_std_layout, 24, 4 },
// CHECK-EMPTY:
// CHECK-NEXT:};
Expand Down
9 changes: 4 additions & 5 deletions clang/test/SemaSYCL/Inputs/sycl.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ struct id {

template <int dim>
struct _ImplT {
range<dim> Range;
range<dim> AccessRange;
range<dim> MemRange;
id<dim> Offset;
};

Expand All @@ -63,10 +64,8 @@ class accessor {
public:
void use(void) const {}
void use(void*) const {}
void __init(__global dataT *Ptr, range<dimensions> Range,
id<dimensions> Offset) {
}

void __init(__global dataT *Ptr, range<dimensions> AccessRange,
range<dimensions> MemRange, id<dimensions> Offset) {}

_ImplT<dimensions> __impl;
};
Expand Down
Loading

0 comments on commit 7edf29c

Please sign in to comment.