/
SemaSYCL.cpp
5620 lines (4898 loc) · 214 KB
/
SemaSYCL.cpp
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===- SemaSYCL.cpp - Semantic Analysis for SYCL constructs ---------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
// This implements Semantic Analysis for SYCL constructs.
//===----------------------------------------------------------------------===//
#include "TreeTransform.h"
#include "clang/AST/AST.h"
#include "clang/AST/Mangle.h"
#include "clang/AST/QualTypeNames.h"
#include "clang/AST/RecordLayout.h"
#include "clang/AST/RecursiveASTVisitor.h"
#include "clang/AST/TemplateArgumentVisitor.h"
#include "clang/AST/TypeVisitor.h"
#include "clang/Analysis/CallGraph.h"
#include "clang/Basic/Attributes.h"
#include "clang/Basic/Builtins.h"
#include "clang/Basic/Diagnostic.h"
#include "clang/Basic/Version.h"
#include "clang/Sema/Initialization.h"
#include "clang/Sema/Sema.h"
#include "llvm/ADT/APSInt.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 <array>
#include <functional>
#include <initializer_list>
using namespace clang;
using namespace std::placeholders;
using KernelParamKind = SYCLIntegrationHeader::kernel_param_kind_t;
enum target {
global_buffer = 2014,
constant_buffer,
local,
image,
host_buffer,
host_image,
image_array
};
using ParamDesc = std::tuple<QualType, IdentifierInfo *, TypeSourceInfo *>;
enum KernelInvocationKind {
InvokeUnknown,
InvokeSingleTask,
InvokeParallelFor,
InvokeParallelForWorkGroup
};
static constexpr llvm::StringLiteral InitMethodName = "__init";
static constexpr llvm::StringLiteral InitESIMDMethodName = "__init_esimd";
static constexpr llvm::StringLiteral InitSpecConstantsBuffer =
"__init_specialization_constants_buffer";
static constexpr llvm::StringLiteral FinalizeMethodName = "__finalize";
static constexpr llvm::StringLiteral LibstdcxxFailedAssertion =
"__failed_assertion";
constexpr unsigned MaxKernelArgsSize = 2048;
static bool isSyclType(QualType Ty, SYCLTypeAttr::SYCLType TypeName) {
const auto *RD = Ty->getAsCXXRecordDecl();
if (!RD)
return false;
if (const auto *Attr = RD->getAttr<SYCLTypeAttr>())
return Attr->getType() == TypeName;
if (const auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(RD))
if (CXXRecordDecl *TemplateDecl =
CTSD->getSpecializedTemplate()->getTemplatedDecl())
if (const auto *Attr = TemplateDecl->getAttr<SYCLTypeAttr>())
return Attr->getType() == TypeName;
return false;
}
static bool isSyclAccessorType(QualType Ty) {
return isSyclType(Ty, SYCLTypeAttr::accessor) ||
isSyclType(Ty, SYCLTypeAttr::local_accessor);
}
// FIXME: Accessor property lists should be modified to use compile-time
// properties. Once implemented, this function (and possibly all/most code
// in SemaSYCL.cpp handling no_alias and buffer_location property) can be
// removed.
static bool isAccessorPropertyType(QualType Ty,
SYCLTypeAttr::SYCLType TypeName) {
if (const auto *RD = Ty->getAsCXXRecordDecl())
if (const auto *Parent = dyn_cast<CXXRecordDecl>(RD->getParent()))
if (const auto *Attr = Parent->getAttr<SYCLTypeAttr>())
return Attr->getType() == TypeName;
return false;
}
static bool isSyclSpecialType(QualType Ty, Sema &S) {
return S.isTypeDecoratedWithDeclAttribute<SYCLSpecialClassAttr>(Ty);
}
ExprResult Sema::ActOnSYCLBuiltinNumFieldsExpr(ParsedType PT) {
TypeSourceInfo *TInfo = nullptr;
QualType QT = GetTypeFromParser(PT, &TInfo);
assert(TInfo && "couldn't get type info from a type from the parser?");
SourceLocation TypeLoc = TInfo->getTypeLoc().getBeginLoc();
return BuildSYCLBuiltinNumFieldsExpr(TypeLoc, QT);
}
ExprResult Sema::BuildSYCLBuiltinNumFieldsExpr(SourceLocation Loc,
QualType SourceTy) {
if (!SourceTy->isDependentType()) {
if (RequireCompleteType(Loc, SourceTy,
diag::err_sycl_type_trait_requires_complete_type,
/*__builtin_num_fields*/ 0))
return ExprError();
if (!SourceTy->isRecordType()) {
Diag(Loc, diag::err_sycl_type_trait_requires_record_type)
<< /*__builtin_num_fields*/ 0;
return ExprError();
}
}
return new (Context)
SYCLBuiltinNumFieldsExpr(Loc, SourceTy, Context.getSizeType());
}
ExprResult Sema::ActOnSYCLBuiltinFieldTypeExpr(ParsedType PT, Expr *Idx) {
TypeSourceInfo *TInfo = nullptr;
QualType QT = GetTypeFromParser(PT, &TInfo);
assert(TInfo && "couldn't get type info from a type from the parser?");
SourceLocation TypeLoc = TInfo->getTypeLoc().getBeginLoc();
return BuildSYCLBuiltinFieldTypeExpr(TypeLoc, QT, Idx);
}
ExprResult Sema::BuildSYCLBuiltinFieldTypeExpr(SourceLocation Loc,
QualType SourceTy, Expr *Idx) {
// If the expression appears in an evaluated context, we want to give an
// error so that users don't attempt to use the value of this expression.
if (!isUnevaluatedContext()) {
Diag(Loc, diag::err_sycl_builtin_type_trait_evaluated)
<< /*__builtin_field_type*/ 0;
return ExprError();
}
// We may not be able to calculate the field type (the source type may be a
// dependent type), so use the source type as a basic fallback. This will
// ensure that the AST node will have a dependent type that gets resolved
// later to the real type.
QualType FieldTy = SourceTy;
ExprValueKind ValueKind = VK_PRValue;
if (!SourceTy->isDependentType()) {
if (RequireCompleteType(Loc, SourceTy,
diag::err_sycl_type_trait_requires_complete_type,
/*__builtin_field_type*/ 1))
return ExprError();
if (!SourceTy->isRecordType()) {
Diag(Loc, diag::err_sycl_type_trait_requires_record_type)
<< /*__builtin_field_type*/ 1;
return ExprError();
}
if (!Idx->isValueDependent()) {
Optional<llvm::APSInt> IdxVal = Idx->getIntegerConstantExpr(Context);
if (IdxVal) {
RecordDecl *RD = SourceTy->getAsRecordDecl();
assert(RD && "Record type but no record decl?");
int64_t Index = IdxVal->getExtValue();
if (Index < 0) {
Diag(Idx->getExprLoc(),
diag::err_sycl_type_trait_requires_nonnegative_index)
<< /*fields*/ 0;
return ExprError();
}
// Ensure that the index is within range.
int64_t NumFields = std::distance(RD->field_begin(), RD->field_end());
if (Index >= NumFields) {
Diag(Idx->getExprLoc(),
diag::err_sycl_builtin_type_trait_index_out_of_range)
<< toString(*IdxVal, 10) << SourceTy << /*fields*/ 0;
return ExprError();
}
const FieldDecl *FD = *std::next(RD->field_begin(), Index);
FieldTy = FD->getType();
// If the field type was a reference type, adjust it now.
if (FieldTy->isLValueReferenceType()) {
ValueKind = VK_LValue;
FieldTy = FieldTy.getNonReferenceType();
} else if (FieldTy->isRValueReferenceType()) {
ValueKind = VK_XValue;
FieldTy = FieldTy.getNonReferenceType();
}
}
}
}
return new (Context)
SYCLBuiltinFieldTypeExpr(Loc, SourceTy, Idx, FieldTy, ValueKind);
}
ExprResult Sema::ActOnSYCLBuiltinNumBasesExpr(ParsedType PT) {
TypeSourceInfo *TInfo = nullptr;
QualType QT = GetTypeFromParser(PT, &TInfo);
assert(TInfo && "couldn't get type info from a type from the parser?");
SourceLocation TypeLoc = TInfo->getTypeLoc().getBeginLoc();
return BuildSYCLBuiltinNumBasesExpr(TypeLoc, QT);
}
ExprResult Sema::BuildSYCLBuiltinNumBasesExpr(SourceLocation Loc,
QualType SourceTy) {
if (!SourceTy->isDependentType()) {
if (RequireCompleteType(Loc, SourceTy,
diag::err_sycl_type_trait_requires_complete_type,
/*__builtin_num_bases*/ 2))
return ExprError();
if (!SourceTy->isRecordType()) {
Diag(Loc, diag::err_sycl_type_trait_requires_record_type)
<< /*__builtin_num_bases*/ 2;
return ExprError();
}
}
return new (Context)
SYCLBuiltinNumBasesExpr(Loc, SourceTy, Context.getSizeType());
}
ExprResult Sema::ActOnSYCLBuiltinBaseTypeExpr(ParsedType PT, Expr *Idx) {
TypeSourceInfo *TInfo = nullptr;
QualType QT = GetTypeFromParser(PT, &TInfo);
assert(TInfo && "couldn't get type info from a type from the parser?");
SourceLocation TypeLoc = TInfo->getTypeLoc().getBeginLoc();
return BuildSYCLBuiltinBaseTypeExpr(TypeLoc, QT, Idx);
}
ExprResult Sema::BuildSYCLBuiltinBaseTypeExpr(SourceLocation Loc,
QualType SourceTy, Expr *Idx) {
// If the expression appears in an evaluated context, we want to give an
// error so that users don't attempt to use the value of this expression.
if (!isUnevaluatedContext()) {
Diag(Loc, diag::err_sycl_builtin_type_trait_evaluated)
<< /*__builtin_base_type*/ 1;
return ExprError();
}
// We may not be able to calculate the base type (the source type may be a
// dependent type), so use the source type as a basic fallback. This will
// ensure that the AST node will have a dependent type that gets resolved
// later to the real type.
QualType BaseTy = SourceTy;
if (!SourceTy->isDependentType()) {
if (RequireCompleteType(Loc, SourceTy,
diag::err_sycl_type_trait_requires_complete_type,
/*__builtin_base_type*/ 3))
return ExprError();
if (!SourceTy->isRecordType()) {
Diag(Loc, diag::err_sycl_type_trait_requires_record_type)
<< /*__builtin_base_type*/ 3;
return ExprError();
}
if (!Idx->isValueDependent()) {
Optional<llvm::APSInt> IdxVal = Idx->getIntegerConstantExpr(Context);
if (IdxVal) {
CXXRecordDecl *RD = SourceTy->getAsCXXRecordDecl();
assert(RD && "Record type but no record decl?");
int64_t Index = IdxVal->getExtValue();
if (Index < 0) {
Diag(Idx->getExprLoc(),
diag::err_sycl_type_trait_requires_nonnegative_index)
<< /*bases*/ 1;
return ExprError();
}
// Ensure that the index is within range.
if (Index >= RD->getNumBases()) {
Diag(Idx->getExprLoc(),
diag::err_sycl_builtin_type_trait_index_out_of_range)
<< toString(*IdxVal, 10) << SourceTy << /*bases*/ 1;
return ExprError();
}
const CXXBaseSpecifier &Spec = *std::next(RD->bases_begin(), Index);
BaseTy = Spec.getType();
}
}
}
return new (Context) SYCLBuiltinBaseTypeExpr(Loc, SourceTy, Idx, BaseTy);
}
// This information is from Section 4.13 of the SYCL spec
// https://www.khronos.org/registry/SYCL/specs/sycl-1.2.1.pdf
// This function returns false if the math lib function
// corresponding to the input builtin is not supported
// for SYCL
static bool IsSyclMathFunc(unsigned BuiltinID) {
switch (BuiltinID) {
case Builtin::BIlround:
case Builtin::BI__builtin_lround:
case Builtin::BIceill:
case Builtin::BI__builtin_ceill:
case Builtin::BIcopysignl:
case Builtin::BI__builtin_copysignl:
case Builtin::BIcosl:
case Builtin::BI__builtin_cosl:
case Builtin::BIexpl:
case Builtin::BI__builtin_expl:
case Builtin::BIexp2l:
case Builtin::BI__builtin_exp2l:
case Builtin::BIfabsl:
case Builtin::BI__builtin_fabsl:
case Builtin::BIfloorl:
case Builtin::BI__builtin_floorl:
case Builtin::BIfmal:
case Builtin::BI__builtin_fmal:
case Builtin::BIfmaxl:
case Builtin::BI__builtin_fmaxl:
case Builtin::BIfminl:
case Builtin::BI__builtin_fminl:
case Builtin::BIfmodl:
case Builtin::BI__builtin_fmodl:
case Builtin::BIlogl:
case Builtin::BI__builtin_logl:
case Builtin::BIlog10l:
case Builtin::BI__builtin_log10l:
case Builtin::BIlog2l:
case Builtin::BI__builtin_log2l:
case Builtin::BIpowl:
case Builtin::BI__builtin_powl:
case Builtin::BIrintl:
case Builtin::BI__builtin_rintl:
case Builtin::BIroundl:
case Builtin::BI__builtin_roundl:
case Builtin::BIsinl:
case Builtin::BI__builtin_sinl:
case Builtin::BIsqrtl:
case Builtin::BI__builtin_sqrtl:
case Builtin::BItruncl:
case Builtin::BI__builtin_truncl:
case Builtin::BIlroundl:
case Builtin::BI__builtin_lroundl:
case Builtin::BIlroundf:
case Builtin::BI__builtin_lroundf:
return false;
default:
break;
}
return true;
}
bool Sema::isDeclAllowedInSYCLDeviceCode(const Decl *D) {
if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
const IdentifierInfo *II = FD->getIdentifier();
// Allow __builtin_assume_aligned and __builtin_printf to be called from
// within device code.
if (FD->getBuiltinID() &&
(FD->getBuiltinID() == Builtin::BI__builtin_assume_aligned ||
FD->getBuiltinID() == Builtin::BI__builtin_printf))
return true;
// Allow to use `::printf` only for CUDA.
if (Context.getTargetInfo().getTriple().isNVPTX()) {
if (FD->getBuiltinID() == Builtin::BIprintf)
return true;
}
const DeclContext *DC = FD->getDeclContext();
if (II && II->isStr("__spirv_ocl_printf") &&
!FD->isDefined() &&
FD->getLanguageLinkage() == CXXLanguageLinkage &&
DC->getEnclosingNamespaceContext()->isTranslationUnit())
return true;
}
return false;
}
static bool isZeroSizedArray(Sema &SemaRef, QualType Ty) {
if (const auto *CAT = SemaRef.getASTContext().getAsConstantArrayType(Ty))
return CAT->getSize() == 0;
return false;
}
static void checkSYCLType(Sema &S, QualType Ty, SourceRange Loc,
llvm::DenseSet<QualType> Visited,
SourceRange UsedAtLoc = SourceRange()) {
// Not all variable types are supported inside SYCL kernels,
// for example the quad type __float128 will cause errors in the
// SPIR-V translation phase.
// Here we check any potentially unsupported declaration and issue
// a deferred diagnostic, which will be emitted iff the declaration
// is discovered to reside in kernel code.
// The optional UsedAtLoc param is used when the SYCL usage is at a
// different location than the variable declaration and we need to
// inform the user of both, e.g. struct member usage vs declaration.
bool Emitting = false;
//--- check types ---
// zero length arrays
if (isZeroSizedArray(S, Ty)) {
S.SYCLDiagIfDeviceCode(Loc.getBegin(), diag::err_typecheck_zero_array_size)
<< 1;
Emitting = true;
}
// variable length arrays
if (Ty->isVariableArrayType()) {
S.SYCLDiagIfDeviceCode(Loc.getBegin(), diag::err_vla_unsupported) << 0;
Emitting = true;
}
// Sub-reference array or pointer, then proceed with that type.
while (Ty->isAnyPointerType() || Ty->isArrayType())
Ty = QualType{Ty->getPointeeOrArrayElementType(), 0};
// __int128, __int128_t, __uint128_t, long double, __float128
if (Ty->isSpecificBuiltinType(BuiltinType::Int128) ||
Ty->isSpecificBuiltinType(BuiltinType::UInt128) ||
Ty->isSpecificBuiltinType(BuiltinType::LongDouble) ||
(Ty->isSpecificBuiltinType(BuiltinType::Float128) &&
!S.Context.getTargetInfo().hasFloat128Type())) {
S.SYCLDiagIfDeviceCode(Loc.getBegin(), diag::err_type_unsupported)
<< Ty.getUnqualifiedType().getCanonicalType();
Emitting = true;
}
if (Emitting && UsedAtLoc.isValid())
S.SYCLDiagIfDeviceCode(UsedAtLoc.getBegin(), diag::note_used_here);
//--- now recurse ---
// Pointers complicate recursion. Add this type to Visited.
// If already there, bail out.
if (!Visited.insert(Ty).second)
return;
if (const auto *ATy = dyn_cast<AttributedType>(Ty))
return checkSYCLType(S, ATy->getModifiedType(), Loc, Visited);
if (const auto *RD = Ty->getAsRecordDecl()) {
for (const auto &Field : RD->fields())
checkSYCLType(S, Field->getType(), Field->getSourceRange(), Visited, Loc);
} else if (const auto *FPTy = dyn_cast<FunctionProtoType>(Ty)) {
for (const auto &ParamTy : FPTy->param_types())
checkSYCLType(S, ParamTy, Loc, Visited);
checkSYCLType(S, FPTy->getReturnType(), Loc, Visited);
}
}
void Sema::checkSYCLDeviceVarDecl(VarDecl *Var) {
assert(getLangOpts().SYCLIsDevice &&
"Should only be called during SYCL compilation");
QualType Ty = Var->getType();
SourceRange Loc = Var->getLocation();
llvm::DenseSet<QualType> Visited;
checkSYCLType(*this, Ty, Loc, Visited);
}
// Tests whether given function is a lambda function or '()' operator used as
// SYCL kernel body function (e.g. in parallel_for).
// NOTE: This is incomplete implemenation. See TODO in the FE TODO list for the
// ESIMD extension.
static bool isSYCLKernelBodyFunction(FunctionDecl *FD) {
return FD->getOverloadedOperator() == OO_Call;
}
static bool isSYCLUndefinedAllowed(const FunctionDecl *Callee,
const SourceManager &SrcMgr) {
if (!Callee)
return false;
// The check below requires declaration name, make sure we have it.
if (!Callee->getIdentifier())
return false;
// libstdc++-11 introduced an undefined function "void __failed_assertion()"
// which may lead to SemaSYCL check failure. However, this undefined function
// is used to trigger some compilation error when the check fails at compile
// time and will be ignored when the check succeeds. We allow calls to this
// function to support some important std functions in SYCL device.
return (Callee->getName() == LibstdcxxFailedAssertion) &&
Callee->getNumParams() == 0 && Callee->getReturnType()->isVoidType() &&
SrcMgr.isInSystemHeader(Callee->getLocation());
}
// Helper function to report conflicting function attributes.
// F - the function, A1 - function attribute, A2 - the attribute it conflicts
// with.
static void reportConflictingAttrs(Sema &S, FunctionDecl *F, const Attr *A1,
const Attr *A2) {
S.Diag(F->getLocation(), diag::err_conflicting_sycl_kernel_attributes);
S.Diag(A1->getLocation(), diag::note_conflicting_attribute);
S.Diag(A2->getLocation(), diag::note_conflicting_attribute);
F->setInvalidDecl();
}
/// Returns the signed constant integer value represented by given expression
static int64_t getIntExprValue(const Expr *E, ASTContext &Ctx) {
return E->getIntegerConstantExpr(Ctx)->getSExtValue();
}
// Collect function attributes related to SYCL.
static void collectSYCLAttributes(Sema &S, FunctionDecl *FD,
llvm::SmallVectorImpl<Attr *> &Attrs,
bool DirectlyCalled) {
if (!FD->hasAttrs())
return;
// In SYCL 1.2.1 mode, the attributes are propagated from the function they
// are applied to onto the kernel which calls the function.
// In SYCL 2020 mode, the attributes are not propagated to the kernel.
if (DirectlyCalled || S.getASTContext().getLangOpts().getSYCLVersion() <
LangOptions::SYCL_2020) {
llvm::copy_if(FD->getAttrs(), std::back_inserter(Attrs), [](Attr *A) {
// FIXME: Make this list self-adapt as new SYCL attributes are added.
return isa<IntelReqdSubGroupSizeAttr, IntelNamedSubGroupSizeAttr,
SYCLReqdWorkGroupSizeAttr, WorkGroupSizeHintAttr,
SYCLIntelKernelArgsRestrictAttr, SYCLIntelNumSimdWorkItemsAttr,
SYCLIntelSchedulerTargetFmaxMhzAttr,
SYCLIntelMaxWorkGroupSizeAttr, SYCLIntelMaxGlobalWorkDimAttr,
SYCLIntelNoGlobalWorkOffsetAttr, SYCLSimdAttr>(A);
});
}
// Attributes that should not be propagated from device functions to a kernel.
if (DirectlyCalled) {
llvm::copy_if(FD->getAttrs(), std::back_inserter(Attrs), [](Attr *A) {
return isa<SYCLIntelLoopFuseAttr, SYCLIntelMaxConcurrencyAttr,
SYCLIntelDisableLoopPipeliningAttr,
SYCLIntelInitiationIntervalAttr,
SYCLIntelUseStallEnableClustersAttr, SYCLDeviceHasAttr,
SYCLAddIRAttributesFunctionAttr>(A);
});
}
}
class DiagDeviceFunction : public RecursiveASTVisitor<DiagDeviceFunction> {
Sema &SemaRef;
const llvm::SmallPtrSetImpl<const FunctionDecl *> &RecursiveFuncs;
public:
DiagDeviceFunction(
Sema &S,
const llvm::SmallPtrSetImpl<const FunctionDecl *> &RecursiveFuncs)
: RecursiveASTVisitor(), SemaRef(S), RecursiveFuncs(RecursiveFuncs) {}
void CheckBody(Stmt *ToBeDiagnosed) { TraverseStmt(ToBeDiagnosed); }
bool VisitCallExpr(CallExpr *e) {
if (FunctionDecl *Callee = e->getDirectCallee()) {
Callee = Callee->getCanonicalDecl();
assert(Callee && "Device function canonical decl must be available");
// Remember that all SYCL kernel functions have deferred
// instantiation as template functions. It means that
// all functions used by kernel have already been parsed and have
// definitions.
if (RecursiveFuncs.count(Callee)) {
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict)
<< Sema::KernelCallRecursiveFunction;
SemaRef.Diag(Callee->getSourceRange().getBegin(),
diag::note_sycl_recursive_function_declared_here)
<< Sema::KernelCallRecursiveFunction;
}
if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(Callee))
if (Method->isVirtual() &&
!SemaRef.getLangOpts().SYCLAllowVirtualFunctions)
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict)
<< Sema::KernelCallVirtualFunction;
if (auto const *FD = dyn_cast<FunctionDecl>(Callee)) {
// FIXME: We need check all target specified attributes for error if
// that function with attribute can not be called from sycl kernel. The
// info is in ParsedAttr. We don't have to map from Attr to ParsedAttr
// currently. Erich is currently working on that in LLVM, once that is
// committed we need to change this".
if (FD->hasAttr<DLLImportAttr>()) {
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict)
<< Sema::KernelCallDllimportFunction;
SemaRef.Diag(FD->getLocation(), diag::note_callee_decl) << FD;
}
}
// Specifically check if the math library function corresponding to this
// builtin is supported for SYCL
unsigned BuiltinID = Callee->getBuiltinID();
if (BuiltinID && !IsSyclMathFunc(BuiltinID)) {
StringRef Name = SemaRef.Context.BuiltinInfo.getName(BuiltinID);
SemaRef.Diag(e->getExprLoc(), diag::err_builtin_target_unsupported)
<< Name << "SYCL device";
}
} else if (!SemaRef.getLangOpts().SYCLAllowFuncPtr &&
!e->isTypeDependent() &&
!isa<CXXPseudoDestructorExpr>(e->getCallee())) {
bool MaybeConstantExpr = false;
Expr *NonDirectCallee = e->getCallee();
if (!NonDirectCallee->isValueDependent())
MaybeConstantExpr =
NonDirectCallee->isCXX11ConstantExpr(SemaRef.getASTContext());
if (!MaybeConstantExpr)
SemaRef.Diag(e->getExprLoc(), diag::err_sycl_restrict)
<< Sema::KernelCallFunctionPointer;
}
return true;
}
bool VisitCXXTypeidExpr(CXXTypeidExpr *E) {
SemaRef.Diag(E->getExprLoc(), diag::err_sycl_restrict) << Sema::KernelRTTI;
return true;
}
bool VisitCXXDynamicCastExpr(const CXXDynamicCastExpr *E) {
SemaRef.Diag(E->getExprLoc(), diag::err_sycl_restrict) << Sema::KernelRTTI;
return true;
}
// Skip checking rules on variables initialized during constant evaluation.
bool TraverseVarDecl(VarDecl *VD) {
if (VD->isConstexpr())
return true;
return RecursiveASTVisitor::TraverseVarDecl(VD);
}
// Skip checking rules on template arguments, since these are constant
// expressions.
bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc) {
return true;
}
// Skip checking the static assert, both components are required to be
// constant expressions.
bool TraverseStaticAssertDecl(StaticAssertDecl *D) { return true; }
// Make sure we skip the condition of the case, since that is a constant
// expression.
bool TraverseCaseStmt(CaseStmt *S) {
return TraverseStmt(S->getSubStmt());
}
// Skip checking the size expr, since a constant array type loc's size expr is
// a constant expression.
bool TraverseConstantArrayTypeLoc(const ConstantArrayTypeLoc &ArrLoc) {
return true;
}
bool TraverseIfStmt(IfStmt *S) {
if (llvm::Optional<Stmt *> ActiveStmt =
S->getNondiscardedCase(SemaRef.Context)) {
if (*ActiveStmt)
return TraverseStmt(*ActiveStmt);
return true;
}
return RecursiveASTVisitor::TraverseIfStmt(S);
}
};
// This type manages the list of device functions and recursive functions, as
// well as an entry point for attribute collection, for the translation unit
// during MarkDevices. On construction, this type makes sure that all of the
// root-device functions, (that is, those marked with SYCL_EXTERNAL) are
// collected. On destruction, it manages and runs the diagnostics required.
// When processing individual kernel/external functions, the
// SingleDeviceFunctionTracker type updates this type.
class DeviceFunctionTracker {
friend class SingleDeviceFunctionTracker;
CallGraph CG;
Sema &SemaRef;
// The list of functions used on the device, kept so we can diagnose on them
// later.
llvm::SmallPtrSet<FunctionDecl *, 16> DeviceFunctions;
llvm::SmallPtrSet<const FunctionDecl *, 16> RecursiveFunctions;
void CollectSyclExternalFuncs() {
for (CallGraphNode::CallRecord Record : CG.getRoot()->callees())
if (auto *FD = dyn_cast<FunctionDecl>(Record.Callee->getDecl()))
if (FD->hasBody() && FD->hasAttr<SYCLDeviceAttr>())
SemaRef.addSyclDeviceDecl(FD);
}
CallGraphNode *getNodeForKernel(FunctionDecl *Kernel) {
assert(CG.getNode(Kernel) && "No call graph entry for a kernel?");
return CG.getNode(Kernel);
}
void AddSingleFunction(
const llvm::SmallPtrSetImpl<FunctionDecl *> &DevFuncs,
const llvm::SmallPtrSetImpl<const FunctionDecl *> &Recursive) {
DeviceFunctions.insert(DevFuncs.begin(), DevFuncs.end());
RecursiveFunctions.insert(Recursive.begin(), Recursive.end());
}
public:
DeviceFunctionTracker(Sema &S) : SemaRef(S) {
CG.setSkipConstantExpressions(S.Context);
CG.addToCallGraph(S.getASTContext().getTranslationUnitDecl());
CollectSyclExternalFuncs();
}
~DeviceFunctionTracker() {
DiagDeviceFunction Diagnoser{SemaRef, RecursiveFunctions};
for (const FunctionDecl *FD : DeviceFunctions)
if (const FunctionDecl *Def = FD->getDefinition())
Diagnoser.CheckBody(Def->getBody());
}
};
// This type does the heavy lifting for the management of device functions,
// recursive function detection, and attribute collection for a single
// kernel/external function. It walks the callgraph to find all functions that
// are called, marks the recursive-functions, and figures out the list of
// attributes that apply to this kernel.
//
// Upon destruction, this type updates the DeviceFunctionTracker.
class SingleDeviceFunctionTracker {
DeviceFunctionTracker &Parent;
FunctionDecl *SYCLKernel = nullptr;
FunctionDecl *KernelBody = nullptr;
llvm::SmallPtrSet<FunctionDecl *, 16> DeviceFunctions;
llvm::SmallPtrSet<const FunctionDecl *, 16> RecursiveFunctions;
llvm::SmallVector<Attr *> CollectedAttributes;
FunctionDecl *GetFDFromNode(CallGraphNode *Node) {
FunctionDecl *FD = Node->getDecl()->getAsFunction();
if (!FD)
return nullptr;
return FD->getMostRecentDecl();
}
void VisitCallNode(CallGraphNode *Node, FunctionDecl *CurrentDecl,
llvm::SmallVectorImpl<FunctionDecl *> &CallStack) {
// If this isn't a function, I don't think there is anything we can do here.
if (!CurrentDecl)
return;
// Determine if this is a recursive function. If so, we're done.
if (llvm::is_contained(CallStack, CurrentDecl)) {
RecursiveFunctions.insert(CurrentDecl->getCanonicalDecl());
return;
}
// If this is a routine that is not defined and it does not have either
// a SYCLKernel or SYCLDevice attribute on it, add it to the set of
// routines potentially reachable on device. This is to diagnose such
// cases later in finalizeSYCLDeviceAnalysis().
if (!CurrentDecl->isDefined() && !CurrentDecl->hasAttr<SYCLKernelAttr>() &&
!CurrentDecl->hasAttr<SYCLDeviceAttr>())
Parent.SemaRef.addFDToReachableFromSyclDevice(CurrentDecl,
CallStack.back());
// We previously thought we could skip this function if we'd seen it before,
// but if we haven't seen it before in this call graph, we can end up
// missing a recursive call. SO, we have to revisit call-graphs we've
// already seen, just in case it ALSO has recursion. For example:
// void recurse1();
// void recurse2() { recurse1(); }
// void recurse1() { recurse2(); }
// void CallerInKernel() { recurse1(); recurse2(); }
// When checking 'recurse1', we'd have ended up 'visiting' recurse2 without
// realizing it was recursive, since we never went into the
// child-of-its-child, since THAT was recursive and exited early out of
// necessity.
// Then when we go to visit the kernel's call to recurse2, we would
// immediately escape not noticing it was recursive. SO, we have to do a
// little extra work in this case, and make sure we visit the entire call
// graph.
DeviceFunctions.insert(CurrentDecl);
// Collect attributes for functions that aren't the root kernel.
if (!CallStack.empty()) {
bool DirectlyCalled = CallStack.size() == 1;
collectSYCLAttributes(Parent.SemaRef, CurrentDecl, CollectedAttributes,
DirectlyCalled);
}
// Calculate the kernel body. Note the 'isSYCLKernelBodyFunction' only
// tests that it is operator(), so hopefully this doesn't get us too many
// false-positives.
if (isSYCLKernelBodyFunction(CurrentDecl)) {
// This is a direct callee of the kernel.
if (CallStack.size() == 1 &&
CallStack.back()->hasAttr<SYCLKernelAttr>()) {
assert(!KernelBody && "inconsistent call graph - only one kernel body "
"function can be called");
KernelBody = CurrentDecl;
} else if (CallStack.size() == 2 && KernelBody == CallStack.back()) {
// To implement rounding-up of a parallel-for range the
// SYCL header implementation modifies the kernel call like this:
// auto Wrapper = [=](TransformedArgType Arg) {
// if (Arg[0] >= NumWorkItems[0])
// return;
// Arg.set_allowed_range(NumWorkItems);
// KernelFunc(Arg);
// };
//
// This transformation leads to a condition where a kernel body
// function becomes callable from a new kernel body function.
// Hence this test.
// FIXME: We need to be more selective here, this can be hit by simply
// having a kernel lambda with a lambda call inside of it.
KernelBody = CurrentDecl;
}
}
// Recurse.
CallStack.push_back(CurrentDecl);
llvm::SmallPtrSet<FunctionDecl *, 16> SeenCallees;
for (CallGraphNode *CI : Node->callees()) {
FunctionDecl *CurFD = GetFDFromNode(CI);
// Make sure we only visit each callee 1x from this function to avoid very
// time consuming template recursion cases.
if (!llvm::is_contained(SeenCallees, CurFD)) {
VisitCallNode(CI, CurFD, CallStack);
SeenCallees.insert(CurFD);
}
}
CallStack.pop_back();
}
// Function to walk the call graph and identify the important information.
void Init() {
CallGraphNode *KernelNode = Parent.getNodeForKernel(SYCLKernel);
llvm::SmallVector<FunctionDecl *> CallStack;
VisitCallNode(KernelNode, GetFDFromNode(KernelNode), CallStack);
// Always inline the KernelBody in the kernel entry point. For ESIMD
// inlining is handled later down the pipeline.
if (KernelBody &&
Parent.SemaRef.getLangOpts().SYCLForceInlineKernelLambda &&
!KernelBody->hasAttr<NoInlineAttr>() &&
!KernelBody->hasAttr<AlwaysInlineAttr>() &&
!KernelBody->hasAttr<SYCLSimdAttr>()) {
KernelBody->addAttr(AlwaysInlineAttr::CreateImplicit(
KernelBody->getASTContext(), {}, AttributeCommonInfo::AS_Keyword,
AlwaysInlineAttr::Keyword_forceinline));
}
}
public:
SingleDeviceFunctionTracker(DeviceFunctionTracker &P, Decl *Kernel)
: Parent(P), SYCLKernel(Kernel->getAsFunction()) {
Init();
}
FunctionDecl *GetSYCLKernel() { return SYCLKernel; }
FunctionDecl *GetKernelBody() { return KernelBody; }
llvm::SmallVectorImpl<Attr *> &GetCollectedAttributes() {
return CollectedAttributes;
}
llvm::SmallPtrSetImpl<FunctionDecl *> &GetDeviceFunctions() {
return DeviceFunctions;
}
~SingleDeviceFunctionTracker() {
Parent.AddSingleFunction(DeviceFunctions, RecursiveFunctions);
}
};
class KernelBodyTransform : public TreeTransform<KernelBodyTransform> {
public:
KernelBodyTransform(std::pair<DeclaratorDecl *, DeclaratorDecl *> &MPair,
Sema &S)
: TreeTransform<KernelBodyTransform>(S), MappingPair(MPair), SemaRef(S) {}
bool AlwaysRebuild() { return true; }
ExprResult TransformDeclRefExpr(DeclRefExpr *DRE) {
auto Ref = dyn_cast<DeclaratorDecl>(DRE->getDecl());
if (Ref && Ref == MappingPair.first) {
auto NewDecl = MappingPair.second;
return DeclRefExpr::Create(
SemaRef.getASTContext(), DRE->getQualifierLoc(),
DRE->getTemplateKeywordLoc(), NewDecl, false, DRE->getNameInfo(),
NewDecl->getType(), DRE->getValueKind());
}
return DRE;
}
private:
std::pair<DeclaratorDecl *, DeclaratorDecl *> MappingPair;
Sema &SemaRef;
};
class MarkWIScopeFnVisitor : public RecursiveASTVisitor<MarkWIScopeFnVisitor> {
public:
MarkWIScopeFnVisitor(ASTContext &Ctx) : Ctx(Ctx) {}
bool VisitCXXMemberCallExpr(CXXMemberCallExpr *Call) {
FunctionDecl *Callee = Call->getDirectCallee();
if (!Callee)
// not a direct call - continue search
return true;
QualType Ty = Ctx.getRecordType(Call->getRecordDecl());
if (!isSyclType(Ty, SYCLTypeAttr::group))
// not a member of sycl::group - continue search
return true;
auto Name = Callee->getName();
if (((Name != "parallel_for_work_item") && (Name != "wait_for")) ||
Callee->hasAttr<SYCLScopeAttr>())
return true;
// it is a call to sycl::group::parallel_for_work_item/wait_for -
// mark the callee
Callee->addAttr(
SYCLScopeAttr::CreateImplicit(Ctx, SYCLScopeAttr::Level::WorkItem));
// continue search as there can be other PFWI or wait_for calls
return true;
}
private:
ASTContext &Ctx;
};
static bool isSYCLPrivateMemoryVar(VarDecl *VD) {
return isSyclType(VD->getType(), SYCLTypeAttr::private_memory);
}
static void addScopeAttrToLocalVars(CXXMethodDecl &F) {
for (Decl *D : F.decls()) {
VarDecl *VD = dyn_cast<VarDecl>(D);
if (!VD || isa<ParmVarDecl>(VD) ||
VD->getStorageDuration() != StorageDuration::SD_Automatic)
continue;
// Local variables of private_memory type in the WG scope still have WI
// scope, all the rest - WG scope. Simple logic
// "if no scope than it is WG scope" won't work, because compiler may add
// locals not declared in user code (lambda object parameter, byval
// arguments) which will result in alloca w/o any attribute, so need WI
// scope too.
SYCLScopeAttr::Level L = isSYCLPrivateMemoryVar(VD)
? SYCLScopeAttr::Level::WorkItem
: SYCLScopeAttr::Level::WorkGroup;
VD->addAttr(SYCLScopeAttr::CreateImplicit(F.getASTContext(), L));
}
}
/// Return method by name
static CXXMethodDecl *getMethodByName(const CXXRecordDecl *CRD,
StringRef MethodName) {
CXXMethodDecl *Method;
auto It = std::find_if(CRD->methods().begin(), CRD->methods().end(),
[MethodName](const CXXMethodDecl *Method) {
return Method->getNameAsString() == MethodName;
});
Method = (It != CRD->methods().end()) ? *It : nullptr;
return Method;
}
static KernelInvocationKind
getKernelInvocationKind(FunctionDecl *KernelCallerFunc) {
return llvm::StringSwitch<KernelInvocationKind>(KernelCallerFunc->getName())
.Case("kernel_single_task", InvokeSingleTask)
.Case("kernel_parallel_for", InvokeParallelFor)
.Case("kernel_parallel_for_work_group", InvokeParallelForWorkGroup)
.Default(InvokeUnknown);
}
// The SYCL kernel's 'object type' used for diagnostics and naming/mangling is
// the first parameter to a function template using the sycl_kernel
// attribute. In SYCL 1.2.1, this was passed by value,
// and in SYCL 2020, it is passed by reference.
static QualType GetSYCLKernelObjectType(const FunctionDecl *KernelCaller) {
assert(KernelCaller->getNumParams() > 0 && "Insufficient kernel parameters");
QualType KernelParamTy = KernelCaller->getParamDecl(0)->getType();
// SYCL 2020 kernels are passed by reference.
if (KernelParamTy->isReferenceType())
KernelParamTy = KernelParamTy->getPointeeType();
// SYCL 1.2.1
return KernelParamTy.getUnqualifiedType();
}
static CXXMethodDecl *getOperatorParens(const CXXRecordDecl *Rec) {
for (auto *MD : Rec->methods()) {
if (MD->getOverloadedOperator() == OO_Call)
return MD;
}
return nullptr;
}