1//===- tools/dsymutil/SwiftModule.cpp -------------------------------------===//
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//===----------------------------------------------------------------------===//
8
9#include "llvm/Bitstream/BitstreamReader.h"
10
11namespace {
12// Copied from swift/lib/Serialization/ModuleFormat.h
13constexpr unsigned char SWIFTMODULE_SIGNATURE[] = {0xE2, 0x9C, 0xA8, 0x0E};
14constexpr uint16_t expectedMajorVersion = 0;
15constexpr unsigned MODULE_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID;
16constexpr unsigned CONTROL_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID + 1;
17constexpr unsigned METADATA = 1;
18constexpr unsigned OPTIONS_BLOCK_ID = llvm::bitc::FIRST_APPLICATION_BLOCKID + 8;
19constexpr unsigned IS_BUILT_FROM_INTERFACE = 11;
20
21llvm::Error checkModuleSignature(llvm::BitstreamCursor &cursor,
22 llvm::ArrayRef<unsigned char> signature) {
23 for (unsigned char byte : signature) {
24 if (cursor.AtEndOfStream())
25 return llvm::createStringError(Fmt: "malformed bitstream");
26 llvm::Expected<llvm::SimpleBitstreamCursor::word_t> maybeRead =
27 cursor.Read(NumBits: 8);
28 if (!maybeRead)
29 return maybeRead.takeError();
30 if (maybeRead.get() != byte)
31 return llvm::createStringError(Fmt: "malformed bitstream");
32 }
33 return llvm::Error::success();
34}
35
36llvm::Error enterTopLevelModuleBlock(llvm::BitstreamCursor &cursor,
37 unsigned ID) {
38 llvm::Expected<llvm::BitstreamEntry> maybeNext = cursor.advance();
39 if (!maybeNext)
40 return maybeNext.takeError();
41 llvm::BitstreamEntry next = maybeNext.get();
42
43 if (next.Kind != llvm::BitstreamEntry::SubBlock)
44 return llvm::createStringError(Fmt: "malformed bitstream");
45
46 if (next.ID == llvm::bitc::BLOCKINFO_BLOCK_ID) {
47 if (cursor.SkipBlock())
48 return llvm::createStringError(Fmt: "malformed bitstream");
49 return enterTopLevelModuleBlock(cursor, ID);
50 }
51
52 if (next.ID != ID)
53 return llvm::createStringError(Fmt: "malformed bitstream");
54
55 if (llvm::Error Err = cursor.EnterSubBlock(BlockID: ID))
56 return Err;
57
58 return llvm::Error::success();
59}
60
61llvm::Expected<bool>
62readOptionsBlock(llvm::BitstreamCursor &cursor,
63 llvm::SmallVectorImpl<uint64_t> &scratch) {
64 bool is_built_from_interface = false;
65 while (!cursor.AtEndOfStream()) {
66 llvm::Expected<llvm::BitstreamEntry> maybeEntry = cursor.advance();
67 if (!maybeEntry)
68 return maybeEntry.takeError();
69
70 llvm::BitstreamEntry entry = maybeEntry.get();
71 if (entry.Kind == llvm::BitstreamEntry::EndBlock)
72 break;
73
74 if (entry.Kind == llvm::BitstreamEntry::Error)
75 return llvm::createStringError(Fmt: "malformed bitstream");
76
77 if (entry.Kind == llvm::BitstreamEntry::SubBlock) {
78 if (cursor.SkipBlock())
79 return llvm::createStringError(Fmt: "malformed bitstream");
80 continue;
81 }
82
83 scratch.clear();
84 llvm::StringRef blobData;
85 llvm::Expected<unsigned> maybeKind =
86 cursor.readRecord(AbbrevID: entry.ID, Vals&: scratch, Blob: &blobData);
87 if (!maybeKind)
88 return maybeKind.takeError();
89 unsigned kind = maybeKind.get();
90 switch (kind) {
91 case IS_BUILT_FROM_INTERFACE:
92 is_built_from_interface = true;
93 continue;
94 default:
95 continue;
96 }
97 }
98 return is_built_from_interface;
99}
100
101llvm::Expected<bool>
102parseControlBlock(llvm::BitstreamCursor &cursor,
103 llvm::SmallVectorImpl<uint64_t> &scratch) {
104 // The control block is malformed until we've at least read a major version
105 // number.
106 bool versionSeen = false;
107
108 while (!cursor.AtEndOfStream()) {
109 llvm::Expected<llvm::BitstreamEntry> maybeEntry = cursor.advance();
110 if (!maybeEntry)
111 return maybeEntry.takeError();
112
113 llvm::BitstreamEntry entry = maybeEntry.get();
114 if (entry.Kind == llvm::BitstreamEntry::EndBlock)
115 break;
116
117 if (entry.Kind == llvm::BitstreamEntry::Error)
118 return llvm::createStringError(Fmt: "malformed bitstream");
119
120 if (entry.Kind == llvm::BitstreamEntry::SubBlock) {
121 if (entry.ID == OPTIONS_BLOCK_ID) {
122 if (llvm::Error Err = cursor.EnterSubBlock(BlockID: OPTIONS_BLOCK_ID))
123 return Err;
124
125 return readOptionsBlock(cursor, scratch);
126 } else {
127 // Unknown metadata sub-block, possibly for use by a future version of
128 // the module format.
129 if (cursor.SkipBlock())
130 return llvm::createStringError(Fmt: "malformed bitstream");
131 }
132 continue;
133 }
134
135 scratch.clear();
136 llvm::StringRef blobData;
137 llvm::Expected<unsigned> maybeKind =
138 cursor.readRecord(AbbrevID: entry.ID, Vals&: scratch, Blob: &blobData);
139 if (!maybeKind)
140 return maybeKind.takeError();
141
142 unsigned kind = maybeKind.get();
143 if (kind == METADATA) {
144 if (versionSeen)
145 return llvm::createStringError(Fmt: "multiple metadata blocks");
146
147 uint16_t versionMajor = scratch[0];
148 if (versionMajor != expectedMajorVersion)
149 return llvm::createStringError(Fmt: "unsupported module version");
150
151 versionSeen = true;
152 }
153 }
154 return llvm::createStringError(Fmt: "could not find control block");
155}
156
157} // namespace
158
159llvm::Expected<bool> IsBuiltFromSwiftInterface(llvm::StringRef data) {
160 llvm::BitstreamCursor cursor(data);
161 if (llvm::Error Err = checkModuleSignature(cursor, signature: SWIFTMODULE_SIGNATURE))
162 return llvm::joinErrors(
163 E1: llvm::createStringError(Fmt: "could not check signature"), E2: std::move(Err));
164 if (llvm::Error Err = enterTopLevelModuleBlock(cursor, ID: MODULE_BLOCK_ID))
165 return llvm::joinErrors(
166 E1: llvm::createStringError(Fmt: "could not enter top level block"),
167 E2: std::move(Err));
168
169 llvm::BitstreamEntry topLevelEntry;
170 llvm::SmallVector<uint64_t, 32> scratch;
171
172 while (!cursor.AtEndOfStream()) {
173 llvm::Expected<llvm::BitstreamEntry> maybeEntry =
174 cursor.advance(Flags: llvm::BitstreamCursor::AF_DontPopBlockAtEnd);
175 if (!maybeEntry)
176 return maybeEntry.takeError();
177
178 topLevelEntry = maybeEntry.get();
179 if (topLevelEntry.Kind != llvm::BitstreamEntry::SubBlock)
180 break;
181
182 if (topLevelEntry.ID == CONTROL_BLOCK_ID) {
183 if (llvm::Error Err = cursor.EnterSubBlock(BlockID: CONTROL_BLOCK_ID))
184 return Err;
185 return parseControlBlock(cursor, scratch);
186 }
187 }
188 return llvm::createStringError(Fmt: "no control block found");
189}
190