clang 19.0.0git
TestModuleFileExtension.cpp
Go to the documentation of this file.
1//===-- TestModuleFileExtension.cpp - Module Extension Tester -------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
11#include "llvm/ADT/Hashing.h"
12#include "llvm/Bitstream/BitstreamWriter.h"
13#include "llvm/Support/raw_ostream.h"
14#include <cstdio>
15using namespace clang;
16using namespace clang::serialization;
17
19
20TestModuleFileExtension::Writer::~Writer() { }
21
22void TestModuleFileExtension::Writer::writeExtensionContents(
23 Sema &SemaRef,
24 llvm::BitstreamWriter &Stream) {
25 using namespace llvm;
26
27 // Write an abbreviation for this record.
28 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
29 Abv->Add(BitCodeAbbrevOp(FIRST_EXTENSION_RECORD_ID));
30 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of characters
31 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // message
32 auto Abbrev = Stream.EmitAbbrev(std::move(Abv));
33
34 // Write a message into the extension block.
35 SmallString<64> Message;
36 {
37 auto Ext = static_cast<TestModuleFileExtension *>(getExtension());
38 raw_svector_ostream OS(Message);
39 OS << "Hello from " << Ext->BlockName << " v" << Ext->MajorVersion << "."
40 << Ext->MinorVersion;
41 }
42 uint64_t Record[] = {FIRST_EXTENSION_RECORD_ID, Message.size()};
43 Stream.EmitRecordWithBlob(Abbrev, Record, Message);
44}
45
46TestModuleFileExtension::Reader::Reader(ModuleFileExtension *Ext,
47 const llvm::BitstreamCursor &InStream)
48 : ModuleFileExtensionReader(Ext), Stream(InStream)
49{
50 // Read the extension block.
52 while (true) {
54 Stream.advanceSkippingSubblocks();
55 if (!MaybeEntry)
56 (void)MaybeEntry.takeError();
57 llvm::BitstreamEntry Entry = MaybeEntry.get();
58
59 switch (Entry.Kind) {
60 case llvm::BitstreamEntry::SubBlock:
61 case llvm::BitstreamEntry::EndBlock:
62 case llvm::BitstreamEntry::Error:
63 return;
64
65 case llvm::BitstreamEntry::Record:
66 break;
67 }
68
69 Record.clear();
70 StringRef Blob;
71 Expected<unsigned> MaybeRecCode =
72 Stream.readRecord(Entry.ID, Record, &Blob);
73 if (!MaybeRecCode)
74 fprintf(stderr, "Failed reading rec code: %s\n",
75 toString(MaybeRecCode.takeError()).c_str());
76 switch (MaybeRecCode.get()) {
78 StringRef Message = Blob.substr(0, Record[0]);
79 fprintf(stderr, "Read extension block message: %s\n",
80 Message.str().c_str());
81 break;
82 }
83 }
84 }
85}
86
87TestModuleFileExtension::Reader::~Reader() { }
88
90
93 return { BlockName, MajorVersion, MinorVersion, UserInfo };
94}
95
97 ExtensionHashBuilder &HBuilder) const {
98 if (Hashed) {
99 HBuilder.add(BlockName);
100 HBuilder.add(MajorVersion);
101 HBuilder.add(MinorVersion);
102 HBuilder.add(UserInfo);
103 }
104}
105
106std::unique_ptr<ModuleFileExtensionWriter>
108 return std::unique_ptr<ModuleFileExtensionWriter>(new Writer(this));
109}
110
111std::unique_ptr<ModuleFileExtensionReader>
113 const ModuleFileExtensionMetadata &Metadata,
115 const llvm::BitstreamCursor &Stream)
116{
117 assert(Metadata.BlockName == BlockName && "Wrong block name");
118 if (std::make_pair(Metadata.MajorVersion, Metadata.MinorVersion) !=
119 std::make_pair(MajorVersion, MinorVersion)) {
120 Reader.getDiags().Report(Mod.ImportLoc,
121 diag::err_test_module_file_extension_version)
122 << BlockName << Metadata.MajorVersion << Metadata.MinorVersion
123 << MajorVersion << MinorVersion;
124 return nullptr;
125 }
126
127 return std::unique_ptr<ModuleFileExtensionReader>(
128 new TestModuleFileExtension::Reader(this, Stream));
129}
130
131std::string TestModuleFileExtension::str() const {
132 std::string Buffer;
133 llvm::raw_string_ostream OS(Buffer);
134 OS << BlockName << ":" << MajorVersion << ":" << MinorVersion << ":" << Hashed
135 << ":" << UserInfo;
136 return Buffer;
137}
llvm::MachO::Record Record
Definition: MachO.h:31
static std::string toString(const clang::SanitizerSet &Sanitizers)
Produce a string containing comma-separated names of sanitizers in Sanitizers set.
Reads an AST files chain containing the contents of a translation unit.
Definition: ASTReader.h:366
DiagnosticsEngine & getDiags() const
Definition: ASTReader.h:1600
Writes an AST file containing the contents of a translation unit.
Definition: ASTWriter.h:89
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
Definition: Diagnostic.h:1547
Abstract base class that reads a module file extension block from a module file.
An abstract superclass that describes a custom extension to the module/precompiled header file format...
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:478
A module file extension used for testing purposes.
ModuleFileExtensionMetadata getExtensionMetadata() const override
std::unique_ptr< ModuleFileExtensionWriter > createExtensionWriter(ASTWriter &Writer) override
void hashExtension(ExtensionHashBuilder &HBuilder) const override
std::unique_ptr< ModuleFileExtensionReader > createExtensionReader(const ModuleFileExtensionMetadata &Metadata, ASTReader &Reader, serialization::ModuleFile &Mod, const llvm::BitstreamCursor &Stream) override
Information about a module that has been loaded by the ASTReader.
Definition: ModuleFile.h:124
SourceLocation ImportLoc
The source location where this module was first imported.
Definition: ModuleFile.h:233
@ FIRST_EXTENSION_RECORD_ID
The first record ID allocated to the extensions themselves.
Definition: ASTBitCodes.h:411
The JSON file list parser is used to communicate input to InstallAPI.
unsigned long uint64_t
Diagnostic wrappers for TextAPI types for error reporting.
Definition: Dominators.h:30
Metadata for a module file extension.
unsigned MajorVersion
The major version of the extension data.
std::string BlockName
The name used to identify this particular extension block within the resulting module file.
unsigned MinorVersion
The minor version of the extension data.