1 //! Cranelift code generation library. 2 #![deny(missing_docs)] 3 // Display feature requirements in the documentation when building on docs.rs 4 #![cfg_attr(docsrs, feature(doc_auto_cfg))] 5 #![no_std] 6 // Various bits and pieces of this crate might only be used for one platform or 7 // another, but it's not really too useful to learn about that all the time. On 8 // CI we build at least one version of this crate with `--features all-arch` 9 // which means we'll always detect truly dead code, otherwise if this is only 10 // built for one platform we don't have to worry too much about trimming 11 // everything down. 12 #![cfg_attr(not(feature = "all-arch"), allow(dead_code))] 13 #![expect(clippy::allow_attributes_without_reason, reason = "crate not migrated")] 14 15 #[allow(unused_imports)] // #[macro_use] is required for no_std 16 #[macro_use] 17 extern crate alloc; 18 19 #[cfg(feature = "std")] 20 #[macro_use] 21 extern crate std; 22 23 #[cfg(not(feature = "std"))] 24 use hashbrown::{HashMap, hash_map}; 25 #[cfg(feature = "std")] 26 use std::collections::{HashMap, hash_map}; 27 28 pub use crate::context::Context; 29 pub use crate::value_label::{LabelValueLoc, ValueLabelsRanges, ValueLocRange}; 30 pub use crate::verifier::verify_function; 31 pub use crate::write::write_function; 32 33 pub use cranelift_bforest as bforest; 34 pub use cranelift_bitset as bitset; 35 pub use cranelift_control as control; 36 pub use cranelift_entity as entity; 37 #[cfg(feature = "unwind")] 38 pub use gimli; 39 40 #[macro_use] 41 mod machinst; 42 43 pub mod binemit; 44 pub mod cfg_printer; 45 pub mod cursor; 46 pub mod data_value; 47 pub mod dbg; 48 pub mod dominator_tree; 49 pub mod flowgraph; 50 pub mod ir; 51 pub mod isa; 52 pub mod loop_analysis; 53 pub mod print_errors; 54 pub mod settings; 55 pub mod timing; 56 pub mod traversals; 57 pub mod verifier; 58 pub mod write; 59 60 pub use crate::entity::packed_option; 61 pub use crate::machinst::buffer::{ 62 FinalizedMachCallSite, FinalizedMachReloc, FinalizedRelocTarget, MachCallSite, MachSrcLoc, 63 MachTextSectionBuilder, MachTrap, OpenPatchRegion, PatchRegion, 64 }; 65 pub use crate::machinst::{ 66 CallInfo, CompiledCode, Final, MachBuffer, MachBufferFinalized, MachInst, MachInstEmit, 67 MachInstEmitState, MachLabel, RealReg, Reg, RelocDistance, TextSectionBuilder, VCodeConstant, 68 VCodeConstantData, VCodeConstants, VCodeInst, Writable, 69 }; 70 71 mod alias_analysis; 72 mod constant_hash; 73 mod context; 74 mod ctxhash; 75 mod egraph; 76 mod inst_predicates; 77 mod isle_prelude; 78 mod legalizer; 79 mod nan_canonicalization; 80 mod opts; 81 mod ranges; 82 mod remove_constant_phis; 83 mod result; 84 mod scoped_hash_map; 85 mod take_and_replace; 86 mod unreachable_code; 87 mod value_label; 88 89 #[cfg(feature = "souper-harvest")] 90 mod souper_harvest; 91 92 pub use crate::result::{CodegenError, CodegenResult, CompileError}; 93 pub use crate::take_and_replace::TakeAndReplace; 94 95 #[cfg(feature = "incremental-cache")] 96 pub mod incremental_cache; 97 98 /// Even when trace logging is disabled, the trace macro has a significant performance cost so we 99 /// disable it by default. 100 #[macro_export] 101 macro_rules! trace { 102 ($($tt:tt)*) => { 103 if cfg!(any(feature = "trace-log", debug_assertions)) { 104 ::log::trace!($($tt)*); 105 } 106 }; 107 } 108 109 /// Dynamic check for whether trace logging is enabled. 110 #[macro_export] 111 macro_rules! trace_log_enabled { 112 () => { 113 cfg!(any(feature = "trace-log", debug_assertions)) 114 && ::log::log_enabled!(::log::Level::Trace) 115 }; 116 } 117 118 include!(concat!(env!("OUT_DIR"), "/version.rs")); 119