ThinLTOBitcodeWriter.h

Go to the documentation of this file.

//===- ThinLTOBitcodeWriter.h - Bitcode writing pass for ThinLTO ----------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This pass prepares a module containing type metadata for ThinLTO by splitting
// it into regular and thin LTO parts if possible, and writing both parts to
// a multi-module bitcode file. Modules that do not contain type metadata are
// written unmodified as a single module.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_TRANSFORMS_IPO_THINLTOBITCODEWRITER_H
#define LLVM_TRANSFORMS_IPO_THINLTOBITCODEWRITER_H
 
#include "llvm/Support/Compiler.h"
#include <llvm/IR/PassManager.h>
 
namespace llvm {
class Module;
class raw_ostream;
 
class ThinLTOBitcodeWriterPass
    : public PassInfoMixin<ThinLTOBitcodeWriterPass> {
  raw_ostream &OS;
  raw_ostream *ThinLinkOS;
  const bool ShouldPreserveUseListOrder;
 
public:
  // Writes bitcode to OS. Also write thin link file to ThinLinkOS, if
  // it's not nullptr.
  ThinLTOBitcodeWriterPass(raw_ostream &OS, raw_ostream *ThinLinkOS,
                           bool ShouldPreserveUseListOrder = false)
      : OS(OS), ThinLinkOS(ThinLinkOS),
        ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {}
 
  LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
 
  static bool isRequired() { return true; }
};
 
} // namespace llvm
 
#endif