Skip to content

Commit fb2c9d9

Browse files
ChuanqiXu9ChuanqiXu9
authored
[C++20] [Modules] Makes sure internal declaration won't be found by other TU (#123059)
Close #61427 And this is also helpful to implement #112294 partially. The implementation strategy mimics #122887. This patch split the internal declarations from the general lookup table so that other TU can't find the internal declarations.
1 parent 22637a8 commit fb2c9d9

File tree

11 files changed

+327
-115
lines changed

11 files changed

+327
-115
lines changed

‎clang/include/clang/Serialization/ASTBitCodes.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -740,6 +740,8 @@ enum ASTRecordTypes {
740740
CXX_ADDED_TEMPLATE_PARTIAL_SPECIALIZATION = 75,
741741

742742
UPDATE_MODULE_LOCAL_VISIBLE = 76,
743+
744+
UPDATE_TU_LOCAL_VISIBLE = 77,
743745
};
744746

745747
/// Record types used within a source manager block.
@@ -1340,6 +1342,10 @@ enum DeclCode {
13401342
/// only visible from DeclContext in the same module.
13411343
DECL_CONTEXT_MODULE_LOCAL_VISIBLE,
13421344

1345+
/// A record that stores the set of declarations that are only visible
1346+
/// to the TU.
1347+
DECL_CONTEXT_TU_LOCAL_VISIBLE,
1348+
13431349
/// A LabelDecl record.
13441350
DECL_LABEL,
13451351

‎clang/include/clang/Serialization/ASTReader.h‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,7 @@ class ASTReader
528528
uint64_t LexicalOffset;
529529
uint64_t VisibleOffset;
530530
uint64_t ModuleLocalOffset;
531+
uint64_t TULocalOffset;
531532
};
532533

533534
using DelayedNamespaceOffsetMapTy =
@@ -640,6 +641,9 @@ class ASTReader
640641
llvm::DenseMap<const DeclContext *,
641642
serialization::reader::ModuleLocalLookupTable>
642643
ModuleLocalLookups;
644+
llvm::DenseMap<const DeclContext *,
645+
serialization::reader::DeclContextLookupTable>
646+
TULocalLookups;
643647

644648
using SpecLookupTableTy =
645649
llvm::DenseMap<const Decl *,
@@ -670,6 +674,7 @@ class ASTReader
670674
llvm::DenseMap<GlobalDeclID, DeclContextVisibleUpdates> PendingVisibleUpdates;
671675
llvm::DenseMap<GlobalDeclID, DeclContextVisibleUpdates>
672676
PendingModuleLocalVisibleUpdates;
677+
llvm::DenseMap<GlobalDeclID, DeclContextVisibleUpdates> TULocalUpdates;
673678

674679
using SpecializationsUpdate = SmallVector<UpdateData, 1>;
675680
using SpecializationsUpdateMap =
@@ -704,11 +709,17 @@ class ASTReader
704709
llvm::BitstreamCursor &Cursor,
705710
uint64_t Offset, DeclContext *DC);
706711

712+
enum class VisibleDeclContextStorageKind {
713+
GenerallyVisible,
714+
ModuleLocalVisible,
715+
TULocalVisible,
716+
};
717+
707718
/// Read the record that describes the visible contents of a DC.
708719
bool ReadVisibleDeclContextStorage(ModuleFile &M,
709720
llvm::BitstreamCursor &Cursor,
710721
uint64_t Offset, GlobalDeclID ID,
711-
bool IsModuleLocal);
722+
VisibleDeclContextStorageKind VisibleKind);
712723

713724
bool ReadSpecializations(ModuleFile &M, llvm::BitstreamCursor &Cursor,
714725
uint64_t Offset, Decl *D, bool IsPartial);
@@ -1148,6 +1159,10 @@ class ASTReader
11481159
unsigned NumModuleLocalVisibleDeclContexts = 0,
11491160
TotalModuleLocalVisibleDeclContexts = 0;
11501161

1162+
/// Number of TU Local decl contexts read/total
1163+
unsigned NumTULocalVisibleDeclContexts = 0,
1164+
TotalTULocalVisibleDeclContexts = 0;
1165+
11511166
/// Total size of modules, in bits, currently loaded
11521167
uint64_t TotalModulesSizeInBits = 0;
11531168

@@ -1481,6 +1496,9 @@ class ASTReader
14811496
const serialization::reader::ModuleLocalLookupTable *
14821497
getModuleLocalLookupTables(DeclContext *Primary) const;
14831498

1499+
const serialization::reader::DeclContextLookupTable *
1500+
getTULocalLookupTables(DeclContext *Primary) const;
1501+
14841502
/// Get the loaded specializations lookup tables for \p D,
14851503
/// if any.
14861504
serialization::reader::LazySpecializationInfoLookupTable *

‎clang/include/clang/Serialization/ASTWriter.h‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,9 @@ class ASTWriter : public ASTDeserializationListener,
496496
/// file.
497497
unsigned NumModuleLocalDeclContexts = 0;
498498

499+
/// The number of TULocal declcontexts written to the AST file.
500+
unsigned NumTULocalDeclContexts = 0;
501+
499502
/// A mapping from each known submodule to its ID number, which will
500503
/// be a positive integer.
501504
llvm::DenseMap<const Module *, unsigned> SubmoduleIDs;
@@ -594,12 +597,14 @@ class ASTWriter : public ASTDeserializationListener,
594597
void
595598
GenerateNameLookupTable(ASTContext &Context, const DeclContext *DC,
596599
llvm::SmallVectorImpl<char> &LookupTable,
597-
llvm::SmallVectorImpl<char> &ModuleLocalLookupTable);
600+
llvm::SmallVectorImpl<char> &ModuleLocalLookupTable,
601+
llvm::SmallVectorImpl<char> &TULocalLookupTable);
598602
uint64_t WriteDeclContextLexicalBlock(ASTContext &Context,
599603
const DeclContext *DC);
600604
void WriteDeclContextVisibleBlock(ASTContext &Context, DeclContext *DC,
601605
uint64_t &VisibleBlockOffset,
602-
uint64_t &ModuleLocalBlockOffset);
606+
uint64_t &ModuleLocalBlockOffset,
607+
uint64_t &TULocalBlockOffset);
603608
void WriteTypeDeclOffsets();
604609
void WriteFileDeclIDsMap();
605610
void WriteComments(ASTContext &Context);
@@ -633,8 +638,10 @@ class ASTWriter : public ASTDeserializationListener,
633638
unsigned DeclContextLexicalAbbrev = 0;
634639
unsigned DeclContextVisibleLookupAbbrev = 0;
635640
unsigned DeclModuleLocalVisibleLookupAbbrev = 0;
641+
unsigned DeclTULocalLookupAbbrev = 0;
636642
unsigned UpdateVisibleAbbrev = 0;
637643
unsigned ModuleLocalUpdateVisibleAbbrev = 0;
644+
unsigned TULocalUpdateVisibleAbbrev = 0;
638645
unsigned DeclRecordAbbrev = 0;
639646
unsigned DeclTypedefAbbrev = 0;
640647
unsigned DeclVarAbbrev = 0;

‎clang/lib/Serialization/ASTReader.cpp‎

Lines changed: 74 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,10 +1425,9 @@ bool ASTReader::ReadLexicalDeclContextStorage(ModuleFile &M,
14251425
return false;
14261426
}
14271427

1428-
bool ASTReader::ReadVisibleDeclContextStorage(ModuleFile &M,
1429-
BitstreamCursor &Cursor,
1430-
uint64_t Offset, GlobalDeclID ID,
1431-
bool IsModuleLocal) {
1428+
bool ASTReader::ReadVisibleDeclContextStorage(
1429+
ModuleFile &M, BitstreamCursor &Cursor, uint64_t Offset, GlobalDeclID ID,
1430+
ASTReader::VisibleDeclContextStorageKind VisibleKind) {
14321431
assert(Offset != 0);
14331432

14341433
SavedStreamPosition SavedPosition(Cursor);
@@ -1452,22 +1451,42 @@ bool ASTReader::ReadVisibleDeclContextStorage(ModuleFile &M,
14521451
return true;
14531452
}
14541453
unsigned RecCode = MaybeRecCode.get();
1455-
if (!IsModuleLocal && RecCode != DECL_CONTEXT_VISIBLE) {
1456-
Error("Expected visible lookup table block");
1457-
return true;
1458-
}
1459-
if (IsModuleLocal && RecCode != DECL_CONTEXT_MODULE_LOCAL_VISIBLE) {
1460-
Error("Expected module local visible lookup table block");
1461-
return true;
1454+
switch (VisibleKind) {
1455+
case VisibleDeclContextStorageKind::GenerallyVisible:
1456+
if (RecCode != DECL_CONTEXT_VISIBLE) {
1457+
Error("Expected visible lookup table block");
1458+
return true;
1459+
}
1460+
break;
1461+
case VisibleDeclContextStorageKind::ModuleLocalVisible:
1462+
if (RecCode != DECL_CONTEXT_MODULE_LOCAL_VISIBLE) {
1463+
Error("Expected module local visible lookup table block");
1464+
return true;
1465+
}
1466+
break;
1467+
case VisibleDeclContextStorageKind::TULocalVisible:
1468+
if (RecCode != DECL_CONTEXT_TU_LOCAL_VISIBLE) {
1469+
Error("Expected TU local lookup table block");
1470+
return true;
1471+
}
1472+
break;
14621473
}
14631474

14641475
// We can't safely determine the primary context yet, so delay attaching the
14651476
// lookup table until we're done with recursive deserialization.
14661477
auto *Data = (const unsigned char*)Blob.data();
1467-
if (!IsModuleLocal)
1478+
switch (VisibleKind) {
1479+
case VisibleDeclContextStorageKind::GenerallyVisible:
14681480
PendingVisibleUpdates[ID].push_back(UpdateData{&M, Data});
1469-
else
1481+
break;
1482+
case VisibleDeclContextStorageKind::ModuleLocalVisible:
14701483
PendingModuleLocalVisibleUpdates[ID].push_back(UpdateData{&M, Data});
1484+
break;
1485+
case VisibleDeclContextStorageKind::TULocalVisible:
1486+
if (M.Kind == MK_MainFile)
1487+
TULocalUpdates[ID].push_back(UpdateData{&M, Data});
1488+
break;
1489+
}
14711490
return false;
14721491
}
14731492

@@ -3613,6 +3632,21 @@ llvm::Error ASTReader::ReadASTBlock(ModuleFile &F,
36133632
break;
36143633
}
36153634

3635+
case UPDATE_TU_LOCAL_VISIBLE: {
3636+
if (F.Kind != MK_MainFile)
3637+
break;
3638+
unsigned Idx = 0;
3639+
GlobalDeclID ID = ReadDeclID(F, Record, Idx);
3640+
auto *Data = (const unsigned char *)Blob.data();
3641+
TULocalUpdates[ID].push_back(UpdateData{&F, Data});
3642+
// If we've already loaded the decl, perform the updates when we finish
3643+
// loading this block.
3644+
if (Decl *D = GetExistingDecl(ID))
3645+
PendingUpdateRecords.push_back(
3646+
PendingUpdateRecord(ID, D, /*JustLoaded=*/false));
3647+
break;
3648+
}
3649+
36163650
case CXX_ADDED_TEMPLATE_SPECIALIZATION: {
36173651
unsigned Idx = 0;
36183652
GlobalDeclID ID = ReadDeclID(F, Record, Idx);
@@ -3717,6 +3751,7 @@ llvm::Error ASTReader::ReadASTBlock(ModuleFile &F,
37173751
TotalLexicalDeclContexts += Record[2];
37183752
TotalVisibleDeclContexts += Record[3];
37193753
TotalModuleLocalVisibleDeclContexts += Record[4];
3754+
TotalTULocalVisibleDeclContexts += Record[5];
37203755
break;
37213756

37223757
case UNUSED_FILESCOPED_DECLS:
@@ -4002,7 +4037,7 @@ llvm::Error ASTReader::ReadASTBlock(ModuleFile &F,
40024037
break;
40034038

40044039
case DELAYED_NAMESPACE_LEXICAL_VISIBLE_RECORD: {
4005-
if (Record.size() % 4 != 0)
4040+
if (Record.size() % 5 != 0)
40064041
return llvm::createStringError(
40074042
std::errc::illegal_byte_sequence,
40084043
"invalid DELAYED_NAMESPACE_LEXICAL_VISIBLE_RECORD block in AST "
@@ -4021,9 +4056,12 @@ llvm::Error ASTReader::ReadASTBlock(ModuleFile &F,
40214056
uint64_t LocalModuleLocalOffset = Record[I++];
40224057
uint64_t ModuleLocalOffset =
40234058
LocalModuleLocalOffset ? BaseOffset + LocalModuleLocalOffset : 0;
4059+
uint64_t TULocalLocalOffset = Record[I++];
4060+
uint64_t TULocalOffset =
4061+
TULocalLocalOffset ? BaseOffset + TULocalLocalOffset : 0;
40244062

40254063
DelayedNamespaceOffsetMap[ID] = {LexicalOffset, VisibleOffset,
4026-
ModuleLocalOffset};
4064+
ModuleLocalOffset, TULocalOffset};
40274065

40284066
assert(!GetExistingDecl(ID) &&
40294067
"We shouldn't load the namespace in the front of delayed "
@@ -8473,6 +8511,15 @@ bool ASTReader::FindExternalVisibleDeclsByName(const DeclContext *DC,
84738511
}
84748512
}
84758513

8514+
if (auto It = TULocalLookups.find(DC); It != TULocalLookups.end()) {
8515+
++NumTULocalVisibleDeclContexts;
8516+
for (GlobalDeclID ID : It->second.Table.find(Name)) {
8517+
NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
8518+
if (ND->getDeclName() == Name && Found.insert(ND).second)
8519+
Decls.push_back(ND);
8520+
}
8521+
}
8522+
84768523
SetExternalVisibleDeclsForName(DC, Name, Decls);
84778524
return !Decls.empty();
84788525
}
@@ -8500,6 +8547,7 @@ void ASTReader::completeVisibleDeclsMap(const DeclContext *DC) {
85008547

85018548
findAll(Lookups, NumVisibleDeclContextsRead);
85028549
findAll(ModuleLocalLookups, NumModuleLocalVisibleDeclContexts);
8550+
findAll(TULocalLookups, NumTULocalVisibleDeclContexts);
85038551

85048552
for (DeclsMap::iterator I = Decls.begin(), E = Decls.end(); I != E; ++I) {
85058553
SetExternalVisibleDeclsForName(DC, I->first, I->second);
@@ -8519,6 +8567,12 @@ ASTReader::getModuleLocalLookupTables(DeclContext *Primary) const {
85198567
return I == ModuleLocalLookups.end() ? nullptr : &I->second;
85208568
}
85218569

8570+
const serialization::reader::DeclContextLookupTable *
8571+
ASTReader::getTULocalLookupTables(DeclContext *Primary) const {
8572+
auto I = TULocalLookups.find(Primary);
8573+
return I == TULocalLookups.end() ? nullptr : &I->second;
8574+
}
8575+
85228576
serialization::reader::LazySpecializationInfoLookupTable *
85238577
ASTReader::getLoadedSpecializationsLookupTables(const Decl *D, bool IsPartial) {
85248578
assert(D->isCanonicalDecl());
@@ -8634,6 +8688,11 @@ void ASTReader::PrintStats() {
86348688
NumModuleLocalVisibleDeclContexts, TotalModuleLocalVisibleDeclContexts,
86358689
((float)NumModuleLocalVisibleDeclContexts /
86368690
TotalModuleLocalVisibleDeclContexts * 100));
8691+
if (TotalTULocalVisibleDeclContexts)
8692+
std::fprintf(stderr, " %u/%u visible declcontexts in GMF read (%f%%)\n",
8693+
NumTULocalVisibleDeclContexts, TotalTULocalVisibleDeclContexts,
8694+
((float)NumTULocalVisibleDeclContexts /
8695+
TotalTULocalVisibleDeclContexts * 100));
86378696
if (TotalNumMethodPoolEntries)
86388697
std::fprintf(stderr, " %u/%u method pool entries read (%f%%)\n",
86398698
NumMethodPoolEntriesRead, TotalNumMethodPoolEntries,

‎clang/lib/Serialization/ASTReaderDecl.cpp‎

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,8 @@ class ASTDeclReader : public DeclVisitor<ASTDeclReader, void> {
414414
void VisitLifetimeExtendedTemporaryDecl(LifetimeExtendedTemporaryDecl *D);
415415

416416
void VisitDeclContext(DeclContext *DC, uint64_t &LexicalOffset,
417-
uint64_t &VisibleOffset, uint64_t &ModuleLocalOffset);
417+
uint64_t &VisibleOffset, uint64_t &ModuleLocalOffset,
418+
uint64_t &TULocalOffset);
418419

419420
template <typename T>
420421
RedeclarableResult VisitRedeclarable(Redeclarable<T> *D);
@@ -1859,7 +1860,9 @@ void ASTDeclReader::VisitHLSLBufferDecl(HLSLBufferDecl *D) {
18591860
uint64_t LexicalOffset = 0;
18601861
uint64_t VisibleOffset = 0;
18611862
uint64_t ModuleLocalOffset = 0;
1862-
VisitDeclContext(D, LexicalOffset, VisibleOffset, ModuleLocalOffset);
1863+
uint64_t TULocalOffset = 0;
1864+
VisitDeclContext(D, LexicalOffset, VisibleOffset, ModuleLocalOffset,
1865+
TULocalOffset);
18631866
D->IsCBuffer = Record.readBool();
18641867
D->KwLoc = readSourceLocation();
18651868
D->LBraceLoc = readSourceLocation();
@@ -2770,10 +2773,12 @@ void ASTDeclReader::VisitLifetimeExtendedTemporaryDecl(
27702773

27712774
void ASTDeclReader::VisitDeclContext(DeclContext *DC, uint64_t &LexicalOffset,
27722775
uint64_t &VisibleOffset,
2773-
uint64_t &ModuleLocalOffset) {
2776+
uint64_t &ModuleLocalOffset,
2777+
uint64_t &TULocalOffset) {
27742778
LexicalOffset = ReadLocalOffset();
27752779
VisibleOffset = ReadLocalOffset();
27762780
ModuleLocalOffset = ReadLocalOffset();
2781+
TULocalOffset = ReadLocalOffset();
27772782
}
27782783

27792784
template <typename T>
@@ -3903,6 +3908,7 @@ Decl *ASTReader::ReadDeclRecord(GlobalDeclID ID) {
39033908
case DECL_CONTEXT_LEXICAL:
39043909
case DECL_CONTEXT_VISIBLE:
39053910
case DECL_CONTEXT_MODULE_LOCAL_VISIBLE:
3911+
case DECL_CONTEXT_TU_LOCAL_VISIBLE:
39063912
case DECL_SPECIALIZATIONS:
39073913
case DECL_PARTIAL_SPECIALIZATIONS:
39083914
llvm_unreachable("Record cannot be de-serialized with readDeclRecord");
@@ -4213,9 +4219,10 @@ Decl *ASTReader::ReadDeclRecord(GlobalDeclID ID) {
42134219
uint64_t LexicalOffset = 0;
42144220
uint64_t VisibleOffset = 0;
42154221
uint64_t ModuleLocalOffset = 0;
4222+
uint64_t TULocalOffset = 0;
42164223

4217-
Reader.VisitDeclContext(DC, LexicalOffset, VisibleOffset,
4218-
ModuleLocalOffset);
4224+
Reader.VisitDeclContext(DC, LexicalOffset, VisibleOffset, ModuleLocalOffset,
4225+
TULocalOffset);
42194226

42204227
// Get the lexical and visible block for the delayed namespace.
42214228
// It is sufficient to judge if ID is in DelayedNamespaceOffsetMap.
@@ -4227,18 +4234,24 @@ Decl *ASTReader::ReadDeclRecord(GlobalDeclID ID) {
42274234
LexicalOffset = Iter->second.LexicalOffset;
42284235
VisibleOffset = Iter->second.VisibleOffset;
42294236
ModuleLocalOffset = Iter->second.ModuleLocalOffset;
4237+
TULocalOffset = Iter->second.TULocalOffset;
42304238
}
42314239

42324240
if (LexicalOffset &&
42334241
ReadLexicalDeclContextStorage(*Loc.F, DeclsCursor, LexicalOffset, DC))
42344242
return nullptr;
4235-
if (VisibleOffset &&
4236-
ReadVisibleDeclContextStorage(*Loc.F, DeclsCursor, VisibleOffset, ID,
4237-
/*IsModuleLocal=*/false))
4243+
if (VisibleOffset && ReadVisibleDeclContextStorage(
4244+
*Loc.F, DeclsCursor, VisibleOffset, ID,
4245+
VisibleDeclContextStorageKind::GenerallyVisible))
42384246
return nullptr;
42394247
if (ModuleLocalOffset &&
4240-
ReadVisibleDeclContextStorage(*Loc.F, DeclsCursor, ModuleLocalOffset,
4241-
ID, /*IsModuleLocal=*/true))
4248+
ReadVisibleDeclContextStorage(
4249+
*Loc.F, DeclsCursor, ModuleLocalOffset, ID,
4250+
VisibleDeclContextStorageKind::ModuleLocalVisible))
4251+
return nullptr;
4252+
if (TULocalOffset && ReadVisibleDeclContextStorage(
4253+
*Loc.F, DeclsCursor, TULocalOffset, ID,
4254+
VisibleDeclContextStorageKind::TULocalVisible))
42424255
return nullptr;
42434256
}
42444257
assert(Record.getIdx() == Record.size());
@@ -4404,6 +4417,18 @@ void ASTReader::loadDeclUpdateRecords(PendingUpdateRecord &Record) {
44044417
DC->setHasExternalVisibleStorage(true);
44054418
}
44064419

4420+
if (auto I = TULocalUpdates.find(ID); I != TULocalUpdates.end()) {
4421+
auto Updates = std::move(I->second);
4422+
TULocalUpdates.erase(I);
4423+
4424+
auto *DC = cast<DeclContext>(D)->getPrimaryContext();
4425+
for (const auto &Update : Updates)
4426+
TULocalLookups[DC].Table.add(
4427+
Update.Mod, Update.Data,
4428+
reader::ASTDeclContextNameLookupTrait(*this, *Update.Mod));
4429+
DC->setHasExternalVisibleStorage(true);
4430+
}
4431+
44074432
// Load any pending related decls.
44084433
if (D->isCanonicalDecl()) {
44094434
if (auto IT = RelatedDeclsMap.find(ID); IT != RelatedDeclsMap.end()) {

0 commit comments

Comments
 (0)