85 lines
2.9 KiB
C
85 lines
2.9 KiB
C
|
//===- IRPrintingPasses.h - Passes to print out IR constructs ---*- C++ -*-===//
|
||
|
|
//
|
||
|
|
// 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
|
||
|
|
//
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
/// \file
|
||
|
|
///
|
||
|
|
/// This file defines passes to print out IR in various granularities. The
|
||
|
|
/// PrintModulePass pass simply prints out the entire module when it is
|
||
|
|
/// executed. The PrintFunctionPass class is designed to be pipelined with
|
||
|
|
/// other FunctionPass's, and prints out the functions of the module as they
|
||
|
|
/// are processed.
|
||
|
|
///
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
|
||
|
|
#ifndef LLVM_IR_IRPRINTINGPASSES_H
|
||
|
|
#define LLVM_IR_IRPRINTINGPASSES_H
|
||
|
|
|
||
|
|
#include "llvm/IR/PassManager.h"
|
||
|
|
#include <string>
|
||
|
|
|
||
|
|
namespace llvm {
|
||
|
|
class raw_ostream;
|
||
|
|
class StringRef;
|
||
|
|
|
||
|
|
/// Create and return a pass that writes the module to the specified
|
||
|
|
/// \c raw_ostream.
|
||
|
|
ModulePass *createPrintModulePass(raw_ostream &OS,
|
||
|
|
const std::string &Banner = "",
|
||
|
|
bool ShouldPreserveUseListOrder = false);
|
||
|
|
|
||
|
|
/// Create and return a pass that prints functions to the specified
|
||
|
|
/// \c raw_ostream as they are processed.
|
||
|
|
FunctionPass *createPrintFunctionPass(raw_ostream &OS,
|
||
|
|
const std::string &Banner = "");
|
||
|
|
|
||
|
|
/// Print out a name of an LLVM value without any prefixes.
|
||
|
|
///
|
||
|
|
/// The name is surrounded with ""'s and escaped if it has any special or
|
||
|
|
/// non-printable characters in it.
|
||
|
|
void printLLVMNameWithoutPrefix(raw_ostream &OS, StringRef Name);
|
||
|
|
|
||
|
|
/// Return true if a pass is for IR printing.
|
||
|
|
bool isIRPrintingPass(Pass *P);
|
||
|
|
|
||
|
|
/// Pass for printing a Module as LLVM's text IR assembly.
|
||
|
|
///
|
||
|
|
/// Note: This pass is for use with the new pass manager. Use the create...Pass
|
||
|
|
/// functions above to create passes for use with the legacy pass manager.
|
||
|
|
class PrintModulePass : public PassInfoMixin<PrintModulePass> {
|
||
|
|
raw_ostream &OS;
|
||
|
|
std::string Banner;
|
||
|
|
bool ShouldPreserveUseListOrder;
|
||
|
|
|
||
|
|
public:
|
||
|
|
PrintModulePass();
|
||
|
|
PrintModulePass(raw_ostream &OS, const std::string &Banner = "",
|
||
|
|
bool ShouldPreserveUseListOrder = false);
|
||
|
|
|
||
|
|
PreservedAnalyses run(Module &M, AnalysisManager<Module> &);
|
||
|
|
static bool isRequired() { return true; }
|
||
|
|
};
|
||
|
|
|
||
|
|
/// Pass for printing a Function as LLVM's text IR assembly.
|
||
|
|
///
|
||
|
|
/// Note: This pass is for use with the new pass manager. Use the create...Pass
|
||
|
|
/// functions above to create passes for use with the legacy pass manager.
|
||
|
|
class PrintFunctionPass : public PassInfoMixin<PrintFunctionPass> {
|
||
|
|
raw_ostream &OS;
|
||
|
|
std::string Banner;
|
||
|
|
|
||
|
|
public:
|
||
|
|
PrintFunctionPass();
|
||
|
|
PrintFunctionPass(raw_ostream &OS, const std::string &Banner = "");
|
||
|
|
|
||
|
|
PreservedAnalyses run(Function &F, AnalysisManager<Function> &);
|
||
|
|
static bool isRequired() { return true; }
|
||
|
|
};
|
||
|
|
|
||
|
|
} // namespace llvm
|
||
|
|
|
||
|
|
#endif
|