forked from MikePopoloski/slang
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Lookup.cpp
2285 lines (1986 loc) · 88.6 KB
/
Lookup.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
//------------------------------------------------------------------------------
// Lookup.cpp
// Symbol lookup logic
//
// SPDX-FileCopyrightText: Michael Popoloski
// SPDX-License-Identifier: MIT
//------------------------------------------------------------------------------
#include "slang/ast/Lookup.h"
#include "slang/ast/Compilation.h"
#include "slang/ast/Scope.h"
#include "slang/ast/Symbol.h"
#include "slang/ast/symbols/BlockSymbols.h"
#include "slang/ast/symbols/ClassSymbols.h"
#include "slang/ast/symbols/CompilationUnitSymbols.h"
#include "slang/ast/symbols/CoverSymbols.h"
#include "slang/ast/symbols/InstanceSymbols.h"
#include "slang/ast/symbols/MemberSymbols.h"
#include "slang/ast/symbols/ParameterSymbols.h"
#include "slang/ast/symbols/PortSymbols.h"
#include "slang/ast/symbols/SubroutineSymbols.h"
#include "slang/ast/symbols/VariableSymbols.h"
#include "slang/ast/types/AllTypes.h"
#include "slang/diagnostics/ExpressionsDiags.h"
#include "slang/diagnostics/LookupDiags.h"
#include "slang/diagnostics/NumericDiags.h"
#include "slang/diagnostics/ParserDiags.h"
#include "slang/parsing/LexerFacts.h"
#include "slang/syntax/AllSyntax.h"
#include "slang/util/String.h"
namespace slang::ast {
using namespace parsing;
using namespace syntax;
const LookupLocation LookupLocation::max{nullptr, UINT_MAX};
const LookupLocation LookupLocation::min{nullptr, 0};
LookupLocation LookupLocation::before(const Symbol& symbol) {
return LookupLocation(symbol.getParentScope(), (uint32_t)symbol.getIndex());
}
LookupLocation LookupLocation::after(const Symbol& symbol) {
return LookupLocation(symbol.getParentScope(), (uint32_t)symbol.getIndex() + 1);
}
Diagnostic& LookupResult::addDiag(const Scope& scope, DiagCode code, SourceLocation location) {
return diagnostics.add(scope.asSymbol(), code, location);
}
Diagnostic& LookupResult::addDiag(const Scope& scope, DiagCode code, SourceRange sourceRange) {
return diagnostics.add(scope.asSymbol(), code, sourceRange);
}
bool LookupResult::hasError() const {
// We have an error if we have any diagnostics or if there was a missing explicit import.
if (!found && flags.has(LookupResultFlags::WasImported | LookupResultFlags::SuppressUndeclared))
return true;
for (auto& diag : diagnostics) {
if (diag.isError())
return true;
}
return false;
}
void LookupResult::clear() {
found = nullptr;
systemSubroutine = nullptr;
upwardCount = 0;
flags = LookupResultFlags::None;
selectors.clear();
path.clear();
diagnostics.clear();
}
void LookupResult::reportDiags(const ASTContext& context) const {
context.getCompilation().addDiagnostics(diagnostics);
}
void LookupResult::errorIfSelectors(const ASTContext& context) const {
if (selectors.empty())
return;
SourceRange range;
auto& sel = selectors[0];
if (sel.index() == 0)
range = std::get<0>(sel)->sourceRange();
else
range = std::get<1>(sel).nameRange;
context.addDiag(diag::UnexpectedSelection, range);
}
namespace {
struct NameComponents {
std::string_view text;
SourceRange range;
std::span<const ElementSelectSyntax* const> selectors;
const ParameterValueAssignmentSyntax* paramAssignments = nullptr;
NameComponents() = default;
NameComponents(const NameSyntax& name) {
switch (name.kind) {
case SyntaxKind::IdentifierName:
set(name.as<IdentifierNameSyntax>().identifier);
break;
case SyntaxKind::SystemName:
set(name.as<SystemNameSyntax>().systemIdentifier);
break;
case SyntaxKind::IdentifierSelectName: {
auto& idSelect = name.as<IdentifierSelectNameSyntax>();
set(idSelect.identifier);
selectors = idSelect.selectors;
break;
}
case SyntaxKind::ClassName: {
auto& cn = name.as<ClassNameSyntax>();
set(cn.identifier);
paramAssignments = cn.parameters;
break;
}
case SyntaxKind::UnitScope:
case SyntaxKind::RootScope:
case SyntaxKind::LocalScope:
case SyntaxKind::ThisHandle:
case SyntaxKind::SuperHandle:
case SyntaxKind::ArrayUniqueMethod:
case SyntaxKind::ArrayAndMethod:
case SyntaxKind::ArrayOrMethod:
case SyntaxKind::ArrayXorMethod:
case SyntaxKind::ConstructorName:
set(name.as<KeywordNameSyntax>().keyword);
break;
default:
SLANG_UNREACHABLE;
}
}
void set(Token id) {
text = id.valueText();
range = id.range();
}
};
struct NamePlusLoc {
NameComponents name;
SourceLocation dotLocation;
SyntaxKind kind;
};
const Symbol* unwrapTypeParam(const Scope& scope, const Symbol* symbol) {
if (symbol->kind == SymbolKind::TypeParameter) {
scope.getCompilation().noteReference(*symbol);
auto result = &symbol->as<TypeParameterSymbol>().targetType.getType();
if (result->isError())
return nullptr;
return result;
}
return symbol;
}
std::optional<bool> isClassType(const Symbol& symbol) {
if (symbol.isType()) {
auto& type = symbol.as<Type>();
if (type.isError())
return std::nullopt;
return type.isClass();
}
return symbol.kind == SymbolKind::GenericClassDef;
}
const NameSyntax* splitScopedName(const ScopedNameSyntax& syntax,
SmallVectorBase<NamePlusLoc>& nameParts, int& colonParts) {
// Split the name into easier to manage chunks. The parser will always produce a
// left-recursive name tree, so that's all we'll bother to handle.
const ScopedNameSyntax* scoped = &syntax;
while (true) {
nameParts.push_back({*scoped->right, scoped->separator.location(), scoped->right->kind});
if (scoped->separator.kind == TokenKind::Dot)
colonParts = 0;
else
colonParts++;
if (scoped->left->kind != SyntaxKind::ScopedName)
break;
scoped = &scoped->left->as<ScopedNameSyntax>();
}
return scoped->left;
}
const Symbol* getVirtualInterfaceTarget(const Type& type, const ASTContext& context,
SourceRange range) {
if (context.flags.has(ASTFlags::NonProcedural))
context.addDiag(diag::DynamicNotProcedural, range);
auto& vit = type.getCanonicalType().as<VirtualInterfaceType>();
if (vit.modport)
return vit.modport;
return &vit.iface;
}
bool isInProgram(const Symbol& symbol) {
auto curr = &symbol;
while (true) {
if (curr->kind == SymbolKind::AnonymousProgram)
return true;
if (curr->kind == SymbolKind::InstanceBody) {
return curr->as<InstanceBodySymbol>().getDefinition().definitionKind ==
DefinitionKind::Program;
}
auto scope = curr->getParentScope();
if (!scope)
return false;
curr = &scope->asSymbol();
}
}
const Symbol* getContainingPackage(const Symbol& symbol) {
auto curr = &symbol;
while (true) {
if (curr->kind == SymbolKind::Package)
return curr;
if (curr->kind == SymbolKind::InstanceBody)
return nullptr;
auto scope = curr->getParentScope();
if (!scope)
return nullptr;
curr = &scope->asSymbol();
}
}
// Returns true if the lookup was ok, or if it failed in a way that allows us to continue
// looking up in other ways. Returns false if the entire lookup has failed and should be
// aborted.
bool lookupDownward(std::span<const NamePlusLoc> nameParts, NameComponents name,
const ASTContext& context, bitmask<LookupFlags> flags, LookupResult& result) {
const Symbol* symbol = std::exchange(result.found, nullptr);
SLANG_ASSERT(symbol);
// Helper function to check whether class parameter assignments have been
// incorrectly supplied for a non-class symbol.
auto checkClassParams = [&](const NameComponents& nc) {
if (symbol && symbol->kind != SymbolKind::GenericClassDef && nc.paramAssignments) {
auto& diag = result.addDiag(*context.scope, diag::NotAGenericClass,
nc.paramAssignments->getFirstToken().location());
diag << nc.range;
diag << symbol->name;
diag.addNote(diag::NoteDeclarationHere, symbol->location);
return false;
}
return true;
};
// Loop through each dotted name component and try to find it in the preceeding scope.
bool isVirtualIface = false;
for (auto it = nameParts.rbegin(); it != nameParts.rend(); it++) {
if (!checkClassParams(name))
return false;
auto isValueLike = [&](const Symbol*& symbol) {
switch (symbol->kind) {
case SymbolKind::ConstraintBlock:
case SymbolKind::Coverpoint:
case SymbolKind::CoverCross:
case SymbolKind::Sequence:
case SymbolKind::Property:
case SymbolKind::LetDecl:
case SymbolKind::AssertionPort:
return true;
default: {
if (!symbol->isValue())
return false;
// If this is a virtual interface value we should unwrap to
// the target interface and continue the hierarchical lookup.
auto& type = symbol->as<ValueSymbol>().getType();
if (type.isVirtualInterface()) {
isVirtualIface = true;
context.getCompilation().noteReference(*symbol);
symbol = getVirtualInterfaceTarget(type, context, name.range);
return false;
}
return true;
}
}
};
// If we found a value, the remaining dots are member access expressions.
if (isValueLike(symbol)) {
result.selectors.append_range(name.selectors);
for (; it != nameParts.rend(); it++) {
auto& memberName = it->name;
result.selectors.push_back(LookupResult::MemberSelector{
memberName.text, it->dotLocation, memberName.range});
result.selectors.append_range(memberName.selectors);
if (!checkClassParams(memberName))
return false;
}
// Break out to return the symbol.
name.selectors = {};
break;
}
// This is a hierarchical lookup if we previously decided it was hierarchical, or:
// - This is not a clocking block access
// - This is not a virtual interface access (or descended from one)
// - This is not a direct interface port, package, or $unit reference
const bool isCBOrVirtualIface = symbol->kind == SymbolKind::ClockingBlock || isVirtualIface;
if (it == nameParts.rbegin()) {
if (symbol->kind != SymbolKind::InterfacePort && symbol->kind != SymbolKind::Package &&
symbol->kind != SymbolKind::CompilationUnit && !isCBOrVirtualIface) {
result.flags |= LookupResultFlags::IsHierarchical;
result.path.emplace_back(*symbol);
}
}
else if (flags.has(LookupFlags::IfacePortConn) &&
(symbol->kind == SymbolKind::GenerateBlock ||
symbol->kind == SymbolKind::GenerateBlockArray ||
symbol->kind == SymbolKind::InstanceArray)) {
SourceRange errorRange{name.range.start(), (nameParts.rend() - 1)->name.range.end()};
result.addDiag(*context.scope, diag::InvalidHierarchicalIfacePortConn, errorRange);
return false;
}
else if (!isCBOrVirtualIface) {
result.flags |= LookupResultFlags::IsHierarchical;
result.path.emplace_back(*symbol);
}
const ModportSymbol* modport = nullptr;
if (symbol->kind == SymbolKind::InterfacePort) {
auto& ifacePort = symbol->as<InterfacePortSymbol>();
std::tie(symbol, modport) = ifacePort.getConnection();
if (!symbol)
return false;
}
if ((!symbol->isScope() && symbol->kind != SymbolKind::Instance) || symbol->isType() ||
symbol->kind == SymbolKind::Checker) {
// If we found an uninstantiated def, exit silently. An appropriate error was
// already issued, so no need to pile on.
if (symbol->kind == SymbolKind::UninstantiatedDef)
return false;
symbol = unwrapTypeParam(*context.scope, symbol);
if (!symbol)
return false;
bool isType;
if (symbol->isType()) {
isType = true;
if (symbol->as<Type>().isError())
return false;
}
else {
isType = symbol->kind == SymbolKind::GenericClassDef;
}
DiagCode code;
if (isType) {
code = diag::DotOnType;
}
else if (symbol->kind == SymbolKind::Checker ||
symbol->kind == SymbolKind::CheckerInstance) {
code = diag::CheckerHierarchical;
}
else {
code = diag::NotAHierarchicalScope;
}
auto& diag = result.addDiag(*context.scope, code, it->dotLocation);
diag << name.range;
diag << it->name.range;
if (!isType)
diag << name.text;
diag.addNote(diag::NoteDeclarationHere, symbol->location);
return true;
}
if (!name.selectors.empty()) {
symbol = Lookup::selectChild(*symbol, name.selectors, context, result);
if (!symbol)
return false;
}
if (symbol->kind == SymbolKind::Instance) {
auto& body = symbol->as<InstanceSymbol>().body;
symbol = &body;
// If we had a modport restriction on an interface port lookup
// we should switch to doing the next lookup in that modport's scope.
// We need to re-lookup the modport symbol because the one we have
// is just representative; the real one depends on the result of the
// selectChild call we made above in the case of an interface array.
if (modport) {
symbol = body.find(modport->name);
SLANG_ASSERT(symbol);
}
// If we're descending into a program instance, verify that
// the original scope for the lookup is also within a program.
if (body.getDefinition().definitionKind == DefinitionKind::Program &&
!isInProgram(context.scope->asSymbol())) {
SourceRange errorRange{name.range.start(),
(nameParts.rend() - 1)->name.range.end()};
result.addDiag(*context.scope, diag::IllegalReferenceToProgramItem, errorRange);
}
}
else if (symbol->kind == SymbolKind::GenerateBlock &&
symbol->as<GenerateBlockSymbol>().isUninstantiated) {
// Don't allow lookups into uninstantiated generate blocks, but do return
// true so that the lookup can continue elsewhere.
return true;
}
name = it->name;
if (name.text.empty())
return false;
auto& scope = symbol->as<Scope>();
symbol = scope.find(name.text);
if (!symbol) {
// If we did the lookup in a modport, check to see if the symbol actually
// exists in the parent interface.
auto& prevSym = scope.asSymbol();
if (prevSym.kind != SymbolKind::Modport ||
(symbol = prevSym.getParentScope()->find(name.text)) == nullptr) {
// Check if we actually had a method prototype found here but it failed
// to resolve due to some other error, in which case we should keep quiet.
auto& nameMap = scope.getNameMap();
if (auto scopeIt = nameMap.find(name.text);
scopeIt != nameMap.end() &&
scopeIt->second->kind == SymbolKind::MethodPrototype) {
return false;
}
// Which error we report depends on whether this is an array
// (in which case the user needs to use an index expression instead
// of dot access) or just some other symbol that is missing the
// requested member.
if (prevSym.kind == SymbolKind::GenerateBlockArray ||
prevSym.kind == SymbolKind::InstanceArray) {
result.addDiag(*context.scope, diag::DotIntoInstArray, it->dotLocation);
}
else {
auto& diag = result.addDiag(*context.scope,
diag::CouldNotResolveHierarchicalPath,
it->dotLocation);
diag << name.text;
diag << name.range;
}
return true;
}
// Variables, nets, subroutines can only be accessed via the modport.
// Other symbols aren't permitted in a modport, so they are allowed
// to be accessed through it as if we had accessed the interface
// instance itself.
if (SemanticFacts::isAllowedInModport(symbol->kind) ||
symbol->kind == SymbolKind::Modport) {
// This is an error, the modport disallows access.
auto def = prevSym.getDeclaringDefinition();
SLANG_ASSERT(def);
auto& diag = result.addDiag(*context.scope, diag::InvalidModportAccess, name.range);
diag << name.text;
diag << def->name;
diag << prevSym.name;
return false;
}
}
}
if (!checkClassParams(name))
return false;
if (result.flags.has(LookupResultFlags::IsHierarchical) && symbol) {
if (VariableSymbol::isKind(symbol->kind) &&
symbol->as<VariableSymbol>().lifetime == VariableLifetime::Automatic) {
// If we found an automatic variable check that we didn't try to reference it
// hierarchically.
result.addDiag(*context.scope, diag::AutoVariableHierarchical, name.range);
return false;
}
else if (symbol->isType()) {
// Types cannot be referenced hierarchically.
result.addDiag(*context.scope, diag::TypeHierarchical, name.range);
return false;
}
result.path.emplace_back(*symbol);
}
result.found = symbol;
if (!name.selectors.empty()) {
// If this is a scope, the selectors should be an index into it.
if (result.found && result.found->isScope() && !result.found->isType())
result.found = Lookup::selectChild(*result.found, name.selectors, context, result);
else
result.selectors.append_range(name.selectors);
}
return true;
}
// Returns true if the lookup was ok, or if it failed in a way that allows us to continue
// looking up in other ways. Returns false if the entire lookup has failed and should be
// aborted.
bool lookupUpward(std::span<const NamePlusLoc> nameParts, const NameComponents& name,
const ASTContext& context, bitmask<LookupFlags> flags, LookupResult& result) {
// Upward lookups can match either a scope name, or a module definition name (on any of the
// instances). Imports are not considered.
const Symbol* firstMatch = nullptr;
auto tryMatch = [&](const Symbol& symbol) {
// Keep track of the first match we find; if it turns out we can't
// resolve all of the name parts we'll move on and try elsewhere,
// but at the end if we couldn't find a full match we'll use this to
// provide a better error.
if (!firstMatch)
firstMatch = &symbol;
result.clear();
result.found = &symbol;
return lookupDownward(nameParts, name, context, flags, result);
};
const Scope* scope = context.scope;
while (scope) {
// Search for a scope or instance target within our current scope.
auto symbol = scope->find(name.text);
if (symbol && !symbol->isValue() && !symbol->isType() &&
(symbol->isScope() || symbol->kind == SymbolKind::Instance)) {
if (!tryMatch(*symbol))
return false;
if (result.found)
return true;
}
// Advance to the next scope, skipping to the parent instance when
// we hit an instance body instead of going on to the compilation unit.
symbol = &scope->asSymbol();
if (symbol->kind != SymbolKind::InstanceBody) {
scope = symbol->getHierarchicalParent();
}
else {
auto inst = symbol->as<InstanceBodySymbol>().parentInstance;
SLANG_ASSERT(inst);
// If the instance's definition name matches our target name,
// try to match from the current instance.
scope = inst->getParentScope();
if (inst->getDefinition().name == name.text) {
if (!tryMatch(*inst))
return false;
if (result.found)
return true;
}
}
}
result.clear();
if (firstMatch) {
// If we did find a match at some point, repeat that
// lookup to provide a real error message.
result.found = firstMatch;
lookupDownward(nameParts, name, context, flags, result);
return false;
}
return true;
}
bool checkVisibility(const Symbol& symbol, const Scope& scope,
std::optional<SourceRange> sourceRange, LookupResult& result) {
// All public members and all non-class symbols are visible by default.
Visibility visibility = Lookup::getVisibility(symbol);
if (visibility == Visibility::Public)
return true;
// All non-public members can only be accessed from scopes that are within a class.
auto [lp, _] = Lookup::getContainingClass(scope);
const Symbol& targetParent = symbol.getParentScope()->asSymbol();
const Symbol* lookupParent = lp;
if (lookupParent && targetParent.kind == SymbolKind::ClassType) {
auto genericTarget = targetParent.as<ClassType>().genericClass;
if (visibility == Visibility::Local) {
// Local members can only be accessed from the declaring class,
// or from any nested classes within that class.
do {
if (lookupParent == &targetParent)
return true;
if (genericTarget && lookupParent->as<ClassType>().genericClass == genericTarget)
return true;
lookupParent = &lookupParent->getParentScope()->asSymbol();
} while (lookupParent->kind == SymbolKind::ClassType);
}
else {
// Protected members can be accessed from derived classes as well,
// in addition to nested classes within those derived classes.
auto& targetType = targetParent.as<Type>();
do {
auto& sourceType = lookupParent->as<ClassType>();
if (targetType.isAssignmentCompatible(sourceType))
return true;
if (genericTarget && sourceType.genericClass == genericTarget)
return true;
lookupParent = &lookupParent->getParentScope()->asSymbol();
} while (lookupParent->kind == SymbolKind::ClassType);
}
}
if (sourceRange) {
if (symbol.kind == SymbolKind::Subroutine &&
symbol.as<SubroutineSymbol>().flags.has(MethodFlags::Constructor)) {
auto& diag = result.addDiag(scope, diag::InvalidConstructorAccess, *sourceRange);
diag << targetParent.name;
if (visibility == Visibility::Local)
diag << LexerFacts::getTokenKindText(TokenKind::LocalKeyword);
else
diag << LexerFacts::getTokenKindText(TokenKind::ProtectedKeyword);
diag.addNote(diag::NoteDeclarationHere, symbol.location);
}
else {
auto code = visibility == Visibility::Local ? diag::LocalMemberAccess
: diag::ProtectedMemberAccess;
auto& diag = result.addDiag(scope, code, *sourceRange);
diag << symbol.name << targetParent.name;
diag.addNote(diag::NoteDeclarationHere, symbol.location);
}
}
return false;
}
bool resolveColonNames(SmallVectorBase<NamePlusLoc>& nameParts, int colonParts,
NameComponents& name, bitmask<LookupFlags> flags, LookupResult& result,
const ASTContext& context) {
// Unwrap the symbol if it's a type parameter, and bail early if it's an error type.
const Symbol* symbol = std::exchange(result.found, nullptr);
if (symbol) {
symbol = unwrapTypeParam(*context.scope, symbol);
if (!symbol)
return false;
}
auto isCovergroup = [&](const Symbol& symbol) {
switch (symbol.kind) {
case SymbolKind::Coverpoint:
case SymbolKind::CoverCross:
return true;
default:
return symbol.isType() && symbol.as<Type>().isCovergroup();
}
};
// If the prefix name resolved normally to a class object, use that. Otherwise we need
// to look for a package with the corresponding name.
bool lookForPackage = symbol == nullptr;
if (symbol) {
auto isClass = isClassType(*symbol);
if (!isClass.has_value())
return false;
lookForPackage = !isClass.value() && !isCovergroup(*symbol);
}
if (lookForPackage) {
symbol = context.getCompilation().getPackage(name.text);
if (!symbol) {
if (!context.scope->isUninstantiated()) {
result.addDiag(*context.scope, diag::UnknownClassOrPackage, name.range)
<< name.text;
}
return false;
}
}
auto validateSymbol = [&] {
// Handle generic classes and parameter assignments. If this is a generic class,
// we must have param assignments here (even if the generic class has a default
// specialization, the spec says you can't use that with colon-scoped lookup).
if (symbol->kind == SymbolKind::GenericClassDef) {
if (name.paramAssignments) {
auto& type = symbol->as<GenericClassDefSymbol>().getSpecialization(
context, *name.paramAssignments);
if (type.isError())
return false;
symbol = &type;
name.paramAssignments = nullptr;
}
else {
// The unadorned generic class name here is an error if we're outside the context
// of the class itself. If we're within the class, it refers to the "current"
// specialization, not the default specialization.
auto [parent, _] = Lookup::getContainingClass(*context.scope);
if (!parent || parent->genericClass != symbol) {
result.addDiag(*context.scope, diag::GenericClassScopeResolution, name.range);
return false;
}
symbol = parent;
}
}
else if (name.paramAssignments) {
auto& diag = result.addDiag(*context.scope, diag::NotAGenericClass, name.range);
diag << symbol->name;
diag.addNote(diag::NoteDeclarationHere, symbol->location);
return false;
}
// If this is a type alias, check its visibility.
checkVisibility(*symbol, *context.scope, name.range, result);
return true;
};
while (colonParts--) {
if (!name.selectors.empty()) {
Token first = name.selectors.front()->getFirstToken();
Token last = name.selectors.back()->getLastToken();
result.addDiag(*context.scope, diag::InvalidScopeIndexExpression,
{first.location(), last.location()});
return false;
}
auto& part = nameParts.back();
symbol = unwrapTypeParam(*context.scope, symbol);
if (!symbol)
return false;
if (symbol->kind != SymbolKind::Package) {
auto isClass = isClassType(*symbol);
if (!isClass.has_value())
return false;
if (!isClass.value() && !isCovergroup(*symbol)) {
auto& diag = result.addDiag(*context.scope, diag::NotAClass, part.dotLocation);
diag << name.range;
diag << symbol->name;
diag.addNote(diag::NoteDeclarationHere, symbol->location);
return false;
}
}
if (!validateSymbol())
return false;
name = part.name;
if (name.text.empty())
return false;
if (symbol->isType()) {
if (symbol->kind == SymbolKind::TypeAlias)
context.getCompilation().noteReference(*symbol);
symbol = &symbol->as<Type>().getCanonicalType();
}
const Symbol* savedSymbol = symbol;
if (symbol->kind == SymbolKind::Package) {
symbol = symbol->as<PackageSymbol>().findForImport(name.text);
result.flags |= LookupResultFlags::WasImported;
}
else if (symbol->kind == SymbolKind::CovergroupType) {
symbol = symbol->as<CovergroupType>().getBody().find(name.text);
}
else {
symbol = symbol->as<Scope>().find(name.text);
}
if (!symbol) {
DiagCode code = diag::UnknownClassMember;
if (savedSymbol->kind == SymbolKind::Package)
code = diag::UnknownPackageMember;
else if (savedSymbol->kind == SymbolKind::CovergroupType)
code = diag::UnknownCovergroupMember;
auto& diag = result.addDiag(*context.scope, code, part.dotLocation);
diag << name.text;
diag << name.range;
diag << savedSymbol->name;
return false;
}
nameParts.pop_back();
}
if (!validateSymbol())
return false;
// The initial symbol found cannot be resolved via a forward typedef (i.e. "incomplete")
// unless this is within a typedef declaration.
if (result.flags.has(LookupResultFlags::FromForwardTypedef) &&
!flags.has(LookupFlags::AllowIncompleteForwardTypedefs) && symbol->isType()) {
result.flags &= ~LookupResultFlags::FromForwardTypedef;
result.addDiag(*context.scope, diag::ScopeIncompleteTypedef, name.range);
}
result.found = symbol;
return lookupDownward(nameParts, name, context, flags, result);
}
void unwrapResult(const Scope& scope, std::optional<SourceRange> range, LookupResult& result,
bool unwrapGenericClasses = true) {
if (!result.found)
return;
if (result.flags.has(LookupResultFlags::IsHierarchical)) {
auto declaredType = result.found->getDeclaredType();
if (declaredType && declaredType->isEvaluating()) {
if (range) {
auto& diag = result.addDiag(scope, diag::RecursiveDefinition, *range);
diag << result.found->name;
diag.addNote(diag::NoteDeclarationHere, result.found->location);
}
result.found = nullptr;
return;
}
}
checkVisibility(*result.found, scope, range, result);
// Unwrap type parameters into their target type alias.
if (result.found->kind == SymbolKind::TypeParameter) {
scope.getCompilation().noteReference(*result.found);
result.found = &result.found->as<TypeParameterSymbol>().getTypeAlias();
result.flags |= LookupResultFlags::FromTypeParam;
}
else if (result.found->kind == SymbolKind::TypeAlias) {
scope.getCompilation().noteReference(*result.found);
}
// If the found symbol is a generic class, unwrap into
// the default specialization (if possible).
if (result.found->kind == SymbolKind::GenericClassDef && unwrapGenericClasses) {
auto& genericClass = result.found->as<GenericClassDefSymbol>();
result.found = genericClass.getDefaultSpecialization();
if (!result.found) {
if (range)
result.addDiag(scope, diag::NoDefaultSpecialization, *range) << genericClass.name;
return;
}
}
if (!range)
return;
if (result.flags.has(LookupResultFlags::WasImported)) {
// If the symbol was imported from a package, check if it is actually
// declared within an anonymous program within that package and if so,
// check whether we're allowed to reference it from our source scope.
auto parent = result.found->getParentScope();
while (parent) {
auto& parentSym = parent->asSymbol();
if (parentSym.kind == SymbolKind::Package)
break;
if (parentSym.kind == SymbolKind::AnonymousProgram) {
if (!isInProgram(scope.asSymbol())) {
auto& diag = result.addDiag(scope, diag::IllegalReferenceToProgramItem, *range);
diag.addNote(diag::NoteDeclarationHere, result.found->location);
}
break;
}
parent = parentSym.getParentScope();
}
}
else if (result.flags.has(LookupResultFlags::IsHierarchical)) {
// Hierarchical references are not allowed from within packages
// unless the target symbol is also within the same package.
auto pkg = getContainingPackage(scope.asSymbol());
if (pkg && getContainingPackage(*result.found) != pkg)
result.addDiag(scope, diag::HierarchicalFromPackage, *range);
}
else if (auto parent = result.found->getParentScope();
parent && parent->asSymbol().kind == SymbolKind::CompilationUnit) {
// Compilation unit items are not allowed to be referenced from a package.
if (getContainingPackage(scope.asSymbol())) {
auto& diag = result.addDiag(scope, diag::CompilationUnitFromPackage, *range);
diag.addNote(diag::NoteDeclarationHere, result.found->location);
}
}
}
const Symbol* findThisHandle(const Scope& scope, bitmask<LookupFlags> flags, SourceRange range,
LookupResult& result) {
if (flags.has(LookupFlags::TypeReference)) {
// type(this) is allowed to work anywhere within a class, regardless of whether
// it's a static context or not.
auto parent = &scope.asSymbol();
while (parent->kind != SymbolKind::ClassType && parent->kind != SymbolKind::InstanceBody) {
auto parentScope = parent->getParentScope();
if (!parentScope)
break;
parent = &parentScope->asSymbol();
}
if (parent->kind == SymbolKind::ClassType)
return &parent->as<ClassType>();
}
else {
// Find the parent method, if we can.
const Symbol* parent = &scope.asSymbol();
while (parent->kind == SymbolKind::StatementBlock ||
parent->kind == SymbolKind::RandSeqProduction) {
auto parentScope = parent->getParentScope();
SLANG_ASSERT(parentScope);
parent = &parentScope->asSymbol();
}
if (parent->kind == SymbolKind::Subroutine) {
auto& sub = parent->as<SubroutineSymbol>();
if (sub.thisVar)
return sub.thisVar;
}
else if (parent->kind == SymbolKind::ConstraintBlock) {
auto thisVar = parent->as<ConstraintBlockSymbol>().thisVar;
if (thisVar)
return thisVar;
}
else if (parent->kind == SymbolKind::ClassType &&
!flags.has(LookupFlags::StaticInitializer)) {
return parent->as<ClassType>().thisVar;
}
}
result.addDiag(scope, diag::InvalidThisHandle, range);
return nullptr;
}
const Symbol* findSuperHandle(const Scope& scope, bitmask<LookupFlags> flags, SourceRange range,
LookupResult& result) {
auto [parent, inStatic] = Lookup::getContainingClass(scope);
if (!parent) {
result.addDiag(scope, diag::SuperOutsideClass, range);
return nullptr;
}
if (inStatic || flags.has(LookupFlags::StaticInitializer)) {
result.addDiag(scope, diag::NonStaticClassProperty, range) << "super"sv;
return nullptr;
}
auto base = parent->getBaseClass();
if (!base && !parent->name.empty()) {
result.addDiag(scope, diag::SuperNoBase, range) << parent->name;
return nullptr;
}
return base;
}
bool withinCovergroup(const Symbol& symbol, const Scope& initialScope) {
const Scope* nextScope = &initialScope;
do {
switch (nextScope->asSymbol().kind) {
case SymbolKind::CovergroupType:
case SymbolKind::CovergroupBody:
case SymbolKind::Coverpoint:
case SymbolKind::CoverCross:
if (symbol.getParentScope() == nextScope)
return true;
nextScope = nextScope->asSymbol().getParentScope();
break;