mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2026-01-31 01:35:20 +01:00
076a6683eb
We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done Differential Revision: https://reviews.llvm.org/D46290 llvm-svn: 331272
76 lines
2.6 KiB
C++
76 lines
2.6 KiB
C++
//===-- BitcodeWriterPass.h - Bitcode writing pass --------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
/// \file
|
|
///
|
|
/// This file provides a bitcode writing pass.
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_BITCODE_BITCODEWRITERPASS_H
|
|
#define LLVM_BITCODE_BITCODEWRITERPASS_H
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/IR/PassManager.h"
|
|
|
|
namespace llvm {
|
|
class Module;
|
|
class ModulePass;
|
|
class raw_ostream;
|
|
|
|
/// Create and return a pass that writes the module to the specified
|
|
/// ostream. Note that this pass is designed for use with the legacy pass
|
|
/// manager.
|
|
///
|
|
/// If \c ShouldPreserveUseListOrder, encode use-list order so it can be
|
|
/// reproduced when deserialized.
|
|
///
|
|
/// If \c EmitSummaryIndex, emit the summary index (currently for use in ThinLTO
|
|
/// optimization).
|
|
///
|
|
/// If \c EmitModuleHash, compute and emit the module hash in the bitcode
|
|
/// (currently for use in ThinLTO incremental build).
|
|
ModulePass *createBitcodeWriterPass(raw_ostream &Str,
|
|
bool ShouldPreserveUseListOrder = false,
|
|
bool EmitSummaryIndex = false,
|
|
bool EmitModuleHash = false);
|
|
|
|
/// Pass for writing a module of IR out to a bitcode file.
|
|
///
|
|
/// Note that this is intended for use with the new pass manager. To construct
|
|
/// a pass for the legacy pass manager, use the function above.
|
|
class BitcodeWriterPass : public PassInfoMixin<BitcodeWriterPass> {
|
|
raw_ostream &OS;
|
|
bool ShouldPreserveUseListOrder;
|
|
bool EmitSummaryIndex;
|
|
bool EmitModuleHash;
|
|
|
|
public:
|
|
/// Construct a bitcode writer pass around a particular output stream.
|
|
///
|
|
/// If \c ShouldPreserveUseListOrder, encode use-list order so it can be
|
|
/// reproduced when deserialized.
|
|
///
|
|
/// If \c EmitSummaryIndex, emit the summary index (currently
|
|
/// for use in ThinLTO optimization).
|
|
explicit BitcodeWriterPass(raw_ostream &OS,
|
|
bool ShouldPreserveUseListOrder = false,
|
|
bool EmitSummaryIndex = false,
|
|
bool EmitModuleHash = false)
|
|
: OS(OS), ShouldPreserveUseListOrder(ShouldPreserveUseListOrder),
|
|
EmitSummaryIndex(EmitSummaryIndex), EmitModuleHash(EmitModuleHash) {}
|
|
|
|
/// Run the bitcode writer pass, and output the module to the selected
|
|
/// output stream.
|
|
PreservedAnalyses run(Module &M, ModuleAnalysisManager &);
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|