rustc_codegen_ssa/traits/
write.rs

1use rustc_ast::expand::autodiff_attrs::AutoDiffItem;
2use rustc_errors::{DiagCtxtHandle, FatalError};
3use rustc_middle::dep_graph::WorkProduct;
4
5use crate::back::lto::{LtoModuleCodegen, SerializedModule, ThinModule};
6use crate::back::write::{CodegenContext, FatLtoInput, ModuleConfig};
7use crate::{CompiledModule, ModuleCodegen};
8
9pub trait WriteBackendMethods: 'static + Sized + Clone {
10    type Module: Send + Sync;
11    type TargetMachine;
12    type TargetMachineError;
13    type ModuleBuffer: ModuleBufferMethods;
14    type ThinData: Send + Sync;
15    type ThinBuffer: ThinBufferMethods;
16
17    /// Merge all modules into main_module and returning it
18    fn run_link(
19        cgcx: &CodegenContext<Self>,
20        dcx: DiagCtxtHandle<'_>,
21        modules: Vec<ModuleCodegen<Self::Module>>,
22    ) -> Result<ModuleCodegen<Self::Module>, FatalError>;
23    /// Performs fat LTO by merging all modules into a single one and returning it
24    /// for further optimization.
25    fn run_fat_lto(
26        cgcx: &CodegenContext<Self>,
27        modules: Vec<FatLtoInput<Self>>,
28        cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
29    ) -> Result<LtoModuleCodegen<Self>, FatalError>;
30    /// Performs thin LTO by performing necessary global analysis and returning two
31    /// lists, one of the modules that need optimization and another for modules that
32    /// can simply be copied over from the incr. comp. cache.
33    fn run_thin_lto(
34        cgcx: &CodegenContext<Self>,
35        modules: Vec<(String, Self::ThinBuffer)>,
36        cached_modules: Vec<(SerializedModule<Self::ModuleBuffer>, WorkProduct)>,
37    ) -> Result<(Vec<LtoModuleCodegen<Self>>, Vec<WorkProduct>), FatalError>;
38    fn print_pass_timings(&self);
39    fn print_statistics(&self);
40    unsafe fn optimize(
41        cgcx: &CodegenContext<Self>,
42        dcx: DiagCtxtHandle<'_>,
43        module: &ModuleCodegen<Self::Module>,
44        config: &ModuleConfig,
45    ) -> Result<(), FatalError>;
46    fn optimize_fat(
47        cgcx: &CodegenContext<Self>,
48        llmod: &mut ModuleCodegen<Self::Module>,
49    ) -> Result<(), FatalError>;
50    unsafe fn optimize_thin(
51        cgcx: &CodegenContext<Self>,
52        thin: ThinModule<Self>,
53    ) -> Result<ModuleCodegen<Self::Module>, FatalError>;
54    unsafe fn codegen(
55        cgcx: &CodegenContext<Self>,
56        dcx: DiagCtxtHandle<'_>,
57        module: ModuleCodegen<Self::Module>,
58        config: &ModuleConfig,
59    ) -> Result<CompiledModule, FatalError>;
60    fn prepare_thin(
61        module: ModuleCodegen<Self::Module>,
62        want_summary: bool,
63    ) -> (String, Self::ThinBuffer);
64    fn serialize_module(module: ModuleCodegen<Self::Module>) -> (String, Self::ModuleBuffer);
65    fn autodiff(
66        cgcx: &CodegenContext<Self>,
67        module: &ModuleCodegen<Self::Module>,
68        diff_fncs: Vec<AutoDiffItem>,
69        config: &ModuleConfig,
70    ) -> Result<(), FatalError>;
71}
72
73pub trait ThinBufferMethods: Send + Sync {
74    fn data(&self) -> &[u8];
75    fn thin_link_data(&self) -> &[u8];
76}
77
78pub trait ModuleBufferMethods: Send + Sync {
79    fn data(&self) -> &[u8];
80}