blob: 5504baa6225c4dd1810e3a35846ce67ab3d1f229 [file] [log] [blame]
Andrew Scull5e1ddfa2018-08-14 10:06:54 +01001//===-- llvm/CodeGen/ParallelCG.h - Parallel code generation ----*- C++ -*-===//
2//
Andrew Walbran16937d02019-10-22 13:54:20 +01003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Andrew Scull5e1ddfa2018-08-14 10:06:54 +01006//
7//===----------------------------------------------------------------------===//
8//
9// This header declares functions that can be used for parallel code generation.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CODEGEN_PARALLELCG_H
14#define LLVM_CODEGEN_PARALLELCG_H
15
16#include "llvm/Support/CodeGen.h"
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010017#include <functional>
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020018#include <memory>
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010019
20namespace llvm {
21
22template <typename T> class ArrayRef;
23class Module;
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020024class TargetMachine;
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010025class raw_pwrite_stream;
26
27/// Split M into OSs.size() partitions, and generate code for each. Takes a
28/// factory function for the TargetMachine TMFactory. Writes OSs.size() output
29/// files to the output streams in OSs. The resulting output files if linked
30/// together are intended to be equivalent to the single output file that would
31/// have been code generated from M.
32///
33/// Writes bitcode for individual partitions into output streams in BCOSs, if
34/// BCOSs is not empty.
35///
36/// \returns M if OSs.size() == 1, otherwise returns std::unique_ptr<Module>().
37std::unique_ptr<Module>
38splitCodeGen(std::unique_ptr<Module> M, ArrayRef<raw_pwrite_stream *> OSs,
39 ArrayRef<llvm::raw_pwrite_stream *> BCOSs,
40 const std::function<std::unique_ptr<TargetMachine>()> &TMFactory,
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020041 CodeGenFileType FileType = CGFT_ObjectFile,
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010042 bool PreserveLocals = false);
43
44} // namespace llvm
45
46#endif