7dc5dc986a
## Purpose This patch is one in a series of code-mods that annotate LLVM’s public interface for export. This patch annotates the `llvm/IR`, `llvm/IRPrinter`, and `llvm/IRReader` libraries. These annotations currently have no meaningful impact on the LLVM build; however, they are a prerequisite to support an LLVM Windows DLL (shared library) build. ## Background This effort is tracked in #109483. Additional context is provided in [this discourse](https://discourse.llvm.org/t/psa-annotating-llvm-public-interface/85307), and documentation for `LLVM_ABI` and related annotations is found in the LLVM repo [here](https://github.com/llvm/llvm-project/blob/main/llvm/docs/InterfaceExportAnnotations.rst). The bulk of these changes were generated automatically using the [Interface Definition Scanner (IDS)](https://github.com/compnerd/ids) tool, followed formatting with `git clang-format`. The following manual adjustments were also applied after running IDS on Linux: - Add `#include "llvm/Support/Compiler.h"` to files where it was not auto-added by IDS due to no pre-existing block of include statements. - Add `LLVM_ABI_FRIEND` to friend member functions declared with `LLVM_ABI` - Add `LLVM_TEMPLATE_ABI` and `LLVM_EXPORT_TEMPLATE` to exported instantiated templates - Add `LLVM_ABI` to a subset of private class methods and fields that require export - Add `LLVM_ABI` to a small number of symbols that require export but are not declared in headers - Reorder `LLVM_ABI` with `[[deprecated]]` and `[[nodiscard]]` attributes. ## Validation Local builds and tests to validate cross-platform compatibility. This included llvm, clang, and lldb on the following configurations: - Windows with MSVC - Windows with Clang - Linux with GCC - Linux with Clang - Darwin with Clang
137 lines
4.3 KiB
C++
137 lines
4.3 KiB
C++
//===--- IRPrintingPasses.cpp - Module and Function printing passes -------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// PrintModulePass and PrintFunctionPass implementations for the legacy pass
|
|
// manager.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/IR/IRPrintingPasses.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/IR/Function.h"
|
|
#include "llvm/IR/Module.h"
|
|
#include "llvm/IR/PrintPasses.h"
|
|
#include "llvm/InitializePasses.h"
|
|
#include "llvm/Pass.h"
|
|
#include "llvm/Support/Compiler.h"
|
|
#include "llvm/Support/Debug.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
|
|
using namespace llvm;
|
|
|
|
LLVM_ABI extern cl::opt<bool> UseNewDbgInfoFormat;
|
|
|
|
namespace {
|
|
|
|
class PrintModulePassWrapper : public ModulePass {
|
|
raw_ostream &OS;
|
|
std::string Banner;
|
|
bool ShouldPreserveUseListOrder;
|
|
|
|
public:
|
|
static char ID;
|
|
PrintModulePassWrapper() : ModulePass(ID), OS(dbgs()) {}
|
|
PrintModulePassWrapper(raw_ostream &OS, const std::string &Banner,
|
|
bool ShouldPreserveUseListOrder)
|
|
: ModulePass(ID), OS(OS), Banner(Banner),
|
|
ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {}
|
|
|
|
bool runOnModule(Module &M) override {
|
|
ScopedDbgInfoFormatSetter FormatSetter(M, UseNewDbgInfoFormat);
|
|
// Remove intrinsic declarations when printing in the new format.
|
|
// TODO: Move this into Module::setIsNewDbgInfoFormat when we're ready to
|
|
// update test output.
|
|
if (UseNewDbgInfoFormat)
|
|
M.removeDebugIntrinsicDeclarations();
|
|
|
|
if (llvm::isFunctionInPrintList("*")) {
|
|
if (!Banner.empty())
|
|
OS << Banner << "\n";
|
|
M.print(OS, nullptr, ShouldPreserveUseListOrder);
|
|
} else {
|
|
bool BannerPrinted = false;
|
|
for (const auto &F : M.functions()) {
|
|
if (llvm::isFunctionInPrintList(F.getName())) {
|
|
if (!BannerPrinted && !Banner.empty()) {
|
|
OS << Banner << "\n";
|
|
BannerPrinted = true;
|
|
}
|
|
F.print(OS);
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
|
AU.setPreservesAll();
|
|
}
|
|
|
|
StringRef getPassName() const override { return "Print Module IR"; }
|
|
};
|
|
|
|
class PrintFunctionPassWrapper : public FunctionPass {
|
|
raw_ostream &OS;
|
|
std::string Banner;
|
|
|
|
public:
|
|
static char ID;
|
|
PrintFunctionPassWrapper() : FunctionPass(ID), OS(dbgs()) {}
|
|
PrintFunctionPassWrapper(raw_ostream &OS, const std::string &Banner)
|
|
: FunctionPass(ID), OS(OS), Banner(Banner) {}
|
|
|
|
// This pass just prints a banner followed by the function as it's processed.
|
|
bool runOnFunction(Function &F) override {
|
|
ScopedDbgInfoFormatSetter FormatSetter(F, UseNewDbgInfoFormat);
|
|
|
|
if (isFunctionInPrintList(F.getName())) {
|
|
if (forcePrintModuleIR())
|
|
OS << Banner << " (function: " << F.getName() << ")\n"
|
|
<< *F.getParent();
|
|
else
|
|
OS << Banner << '\n' << static_cast<Value &>(F);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void getAnalysisUsage(AnalysisUsage &AU) const override {
|
|
AU.setPreservesAll();
|
|
}
|
|
|
|
StringRef getPassName() const override { return "Print Function IR"; }
|
|
};
|
|
|
|
} // namespace
|
|
|
|
char PrintModulePassWrapper::ID = 0;
|
|
INITIALIZE_PASS(PrintModulePassWrapper, "print-module",
|
|
"Print module to stderr", false, true)
|
|
char PrintFunctionPassWrapper::ID = 0;
|
|
INITIALIZE_PASS(PrintFunctionPassWrapper, "print-function",
|
|
"Print function to stderr", false, true)
|
|
|
|
ModulePass *llvm::createPrintModulePass(llvm::raw_ostream &OS,
|
|
const std::string &Banner,
|
|
bool ShouldPreserveUseListOrder) {
|
|
return new PrintModulePassWrapper(OS, Banner, ShouldPreserveUseListOrder);
|
|
}
|
|
|
|
FunctionPass *llvm::createPrintFunctionPass(llvm::raw_ostream &OS,
|
|
const std::string &Banner) {
|
|
return new PrintFunctionPassWrapper(OS, Banner);
|
|
}
|
|
|
|
bool llvm::isIRPrintingPass(Pass *P) {
|
|
const char *PID = (const char *)P->getPassID();
|
|
|
|
return (PID == &PrintModulePassWrapper::ID) ||
|
|
(PID == &PrintFunctionPassWrapper::ID);
|
|
}
|