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
|
//===--- Serialization.cpp - Write Swift modules --------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#include "swift/Serialization/Serialization.h"
#include "swift/APIDigester/ModuleAnalyzerNodes.h"
#include "swift/AST/DiagnosticsFrontend.h"
#include "swift/AST/FileSystem.h"
#include "swift/Subsystems.h"
#include "swift/SymbolGraphGen/SymbolGraphGen.h"
#include "swift/SymbolGraphGen/SymbolGraphOptions.h"
#include "llvm/Support/SmallVectorMemoryBuffer.h"
#include "llvm/Support/VirtualOutputBackend.h"
using namespace swift;
static ModuleDecl *getModule(ModuleOrSourceFile DC) {
if (auto M = DC.dyn_cast<ModuleDecl *>())
return M;
return DC.get<SourceFile *>()->getParentModule();
}
static ASTContext &getContext(ModuleOrSourceFile DC) {
return getModule(DC)->getASTContext();
}
static void emitABIDescriptor(ModuleOrSourceFile DC,
const SerializationOptions &options) {
using namespace swift::ide::api;
if (!options.ABIDescriptorPath.empty()) {
if (DC.is<ModuleDecl *>()) {
auto &OutputBackend = getContext(DC).getOutputBackend();
auto ABIDesFile = OutputBackend.createFile(options.ABIDescriptorPath);
if (!ABIDesFile) {
getContext(DC).Diags.diagnose(SourceLoc(), diag::error_opening_output,
options.ABIDescriptorPath,
toString(ABIDesFile.takeError()));
return;
}
SWIFT_DEFER {
if (auto E = ABIDesFile->keep()) {
getContext(DC).Diags.diagnose(SourceLoc(), diag::error_closing_output,
options.ABIDescriptorPath,
toString(std::move(E)));
return;
}
};
dumpModuleContent(DC.get<ModuleDecl *>(), *ABIDesFile, true,
options.emptyABIDescriptor);
}
}
}
void swift::serializeToBuffers(
ModuleOrSourceFile DC, const SerializationOptions &options,
std::unique_ptr<llvm::MemoryBuffer> *moduleBuffer,
std::unique_ptr<llvm::MemoryBuffer> *moduleDocBuffer,
std::unique_ptr<llvm::MemoryBuffer> *moduleSourceInfoBuffer,
const SILModule *M) {
// Serialization output is disabled.
if (options.OutputPath.empty())
return;
{
FrontendStatsTracer tracer(getContext(DC).Stats,
"Serialization, swiftmodule, to buffer");
llvm::SmallString<1024> buf;
llvm::raw_svector_ostream stream(buf);
serialization::writeToStream(stream, DC, M, options,
/*dependency info*/ nullptr);
bool hadError = withOutputPath(
getContext(DC).Diags, getContext(DC).getOutputBackend(),
options.OutputPath, [&](raw_ostream &out) {
out << stream.str();
return false;
});
if (hadError)
return;
emitABIDescriptor(DC, options);
if (moduleBuffer)
*moduleBuffer = std::make_unique<llvm::SmallVectorMemoryBuffer>(
std::move(buf), options.OutputPath,
/*RequiresNullTerminator=*/false);
}
if (!options.DocOutputPath.empty()) {
FrontendStatsTracer tracer(getContext(DC).Stats,
"Serialization, swiftdoc, to buffer");
llvm::SmallString<1024> buf;
llvm::raw_svector_ostream stream(buf);
serialization::writeDocToStream(stream, DC, options.GroupInfoPath);
(void)withOutputPath(getContext(DC).Diags,
getContext(DC).getOutputBackend(),
options.DocOutputPath, [&](raw_ostream &out) {
out << stream.str();
return false;
});
if (moduleDocBuffer)
*moduleDocBuffer = std::make_unique<llvm::SmallVectorMemoryBuffer>(
std::move(buf), options.DocOutputPath,
/*RequiresNullTerminator=*/false);
}
if (!options.SourceInfoOutputPath.empty()) {
FrontendStatsTracer tracer(getContext(DC).Stats,
"Serialization, swiftsourceinfo, to buffer");
llvm::SmallString<1024> buf;
llvm::raw_svector_ostream stream(buf);
serialization::writeSourceInfoToStream(stream, DC);
(void)withOutputPath(
getContext(DC).Diags, getContext(DC).getOutputBackend(),
options.SourceInfoOutputPath, [&](raw_ostream &out) {
out << stream.str();
return false;
});
if (moduleSourceInfoBuffer)
*moduleSourceInfoBuffer = std::make_unique<llvm::SmallVectorMemoryBuffer>(
std::move(buf), options.SourceInfoOutputPath,
/*RequiresNullTerminator=*/false);
}
}
void swift::serialize(
ModuleOrSourceFile DC, const SerializationOptions &options,
const symbolgraphgen::SymbolGraphOptions &symbolGraphOptions,
const SILModule *M,
const fine_grained_dependencies::SourceFileDepGraph *DG) {
assert(!options.OutputPath.empty());
if (options.OutputPath == "-") {
// Special-case writing to stdout.
serialization::writeToStream(llvm::outs(), DC, M, options, DG);
assert(options.DocOutputPath.empty());
return;
}
bool hadError = withOutputPath(
getContext(DC).Diags, getContext(DC).getOutputBackend(),
options.OutputPath, [&](raw_ostream &out) {
FrontendStatsTracer tracer(getContext(DC).Stats,
"Serialization, swiftmodule");
serialization::writeToStream(out, DC, M, options, DG);
return false;
});
if (hadError)
return;
if (!options.DocOutputPath.empty()) {
(void)withOutputPath(
getContext(DC).Diags, getContext(DC).getOutputBackend(),
options.DocOutputPath, [&](raw_ostream &out) {
FrontendStatsTracer tracer(getContext(DC).Stats,
"Serialization, swiftdoc");
serialization::writeDocToStream(out, DC, options.GroupInfoPath);
return false;
});
}
if (!options.SourceInfoOutputPath.empty()) {
(void)withOutputPath(
getContext(DC).Diags, getContext(DC).getOutputBackend(),
options.SourceInfoOutputPath, [&](raw_ostream &out) {
FrontendStatsTracer tracer(getContext(DC).Stats,
"Serialization, swiftsourceinfo");
serialization::writeSourceInfoToStream(out, DC);
return false;
});
}
if (!symbolGraphOptions.OutputDir.empty()) {
if (DC.is<ModuleDecl *>()) {
auto *M = DC.get<ModuleDecl *>();
FrontendStatsTracer tracer(getContext(DC).Stats,
"Serialization, symbolgraph");
symbolgraphgen::emitSymbolGraphForModule(M, symbolGraphOptions);
}
}
emitABIDescriptor(DC, options);
}
|