Add early-stage optimization crate (#556)

* Add simple constant folding and folding tests
This commit is contained in:
Lachlan Sneff
2018-11-07 18:59:29 -05:00
committed by Dan Gohman
parent bdcc06eb15
commit 3409af7c07
22 changed files with 745 additions and 21 deletions

View File

@@ -25,6 +25,7 @@ cranelift-filetests = { path = "lib/filetests", version = "0.22.0" }
cranelift-module = { path = "lib/module", version = "0.22.0" } cranelift-module = { path = "lib/module", version = "0.22.0" }
cranelift-faerie = { path = "lib/faerie", version = "0.22.0" } cranelift-faerie = { path = "lib/faerie", version = "0.22.0" }
cranelift-simplejit = { path = "lib/simplejit", version = "0.22.0" } cranelift-simplejit = { path = "lib/simplejit", version = "0.22.0" }
cranelift-preopt = { path = "lib/preopt", version = "0.22.0" }
cranelift = { path = "lib/umbrella", version = "0.22.0" } cranelift = { path = "lib/umbrella", version = "0.22.0" }
filecheck = "0.4.0" filecheck = "0.4.0"
clap = "2.32.0" clap = "2.32.0"

View File

@@ -0,0 +1,54 @@
test preopt
target x86_64
function %brz_fold() -> i32 {
ebb0:
v0 = bconst.b1 false
brz v0, ebb2
jump ebb1
ebb1:
v1 = iconst.i32 42
return v1
ebb2:
v2 = iconst.i32 24
return v2
}
; sameln: function %brz_fold
; nextln: ebb0:
; nextln: v0 = bconst.b1 false
; nextln: jump ebb2
; nextln:
; nextln: ebb1:
; nextln: v1 = iconst.i32 42
; nextln: return v1
; nextln:
; nextln: ebb2:
; nextln: v2 = iconst.i32 24
; nextln: return v2
; nextln: }
function %brnz_fold() -> i32 {
ebb0:
v0 = bconst.b1 true
brnz v0, ebb2
jump ebb1
ebb1:
v1 = iconst.i32 42
return v1
ebb2:
v2 = iconst.i32 24
return v2
}
; sameln: function %brnz_fold
; nextln: ebb0:
; nextln: v0 = bconst.b1 true
; nextln: jump ebb2
; nextln:
; nextln: ebb1:
; nextln: v1 = iconst.i32 42
; nextln: return v1
; nextln:
; nextln: ebb2:
; nextln: v2 = iconst.i32 24
; nextln: return v2
; nextln: }

View File

@@ -0,0 +1,36 @@
test preopt
target x86_64
function %iadd_fold() -> i32 {
ebb0:
v0 = iconst.i32 37
v1 = iconst.i32 5
v2 = iadd v0, v1
v3 = iconst.i32 8
v4 = iadd v2, v3
return v4
}
; sameln: function %iadd_fold
; nextln: ebb0:
; nextln: v0 = iconst.i32 37
; nextln: v1 = iconst.i32 5
; nextln: v2 = iconst.i32 42
; nextln: v3 = iconst.i32 8
; nextln: v4 = iconst.i32 50
; nextln: return v4
; nextln: }
function %isub_fold() -> i32 {
ebb0:
v0 = iconst.i32 42
v1 = iconst.i32 1
v2 = isub v0, v1
return v2
}
; sameln: function %isub_fold
; nextln: ebb0:
; nextln: v0 = iconst.i32 42
; nextln: v1 = iconst.i32 1
; nextln: v2 = iconst.i32 41
; nextln: return v2
; nextln: }

View File

@@ -1,4 +1,4 @@
test preopt test simple_preopt
target i686 baseline target i686 baseline
; Cases where the denominator is created by an iconst ; Cases where the denominator is created by an iconst

View File

@@ -1,4 +1,4 @@
test preopt test simple_preopt
target i686 baseline target i686 baseline
; -------- U32 -------- ; -------- U32 --------

View File

@@ -1,4 +1,4 @@
test preopt test simple_preopt
target i686 baseline target i686 baseline
; -------- U32 -------- ; -------- U32 --------

View File

@@ -1,4 +1,4 @@
test preopt test simple_preopt
target i686 baseline target i686 baseline
; -------- U32 -------- ; -------- U32 --------

View File

@@ -1,4 +1,4 @@
test preopt test simple_preopt
target i686 baseline target i686 baseline
; -------- U32 -------- ; -------- U32 --------

View File

@@ -1,4 +1,4 @@
test preopt test simple_preopt
target i686 target i686
function %iadd_imm(i32) -> i32 { function %iadd_imm(i32) -> i32 {

View File

@@ -22,11 +22,11 @@ use licm::do_licm;
use loop_analysis::LoopAnalysis; use loop_analysis::LoopAnalysis;
use nan_canonicalization::do_nan_canonicalization; use nan_canonicalization::do_nan_canonicalization;
use postopt::do_postopt; use postopt::do_postopt;
use preopt::do_preopt;
use regalloc; use regalloc;
use result::CodegenResult; use result::CodegenResult;
use settings::{FlagsOrIsa, OptLevel}; use settings::{FlagsOrIsa, OptLevel};
use simple_gvn::do_simple_gvn; use simple_gvn::do_simple_gvn;
use simple_preopt::do_preopt;
use std::vec::Vec; use std::vec::Vec;
use timing; use timing;
use unreachable_code::eliminate_unreachable_code; use unreachable_code::eliminate_unreachable_code;

View File

@@ -104,12 +104,12 @@ mod nan_canonicalization;
mod partition_slice; mod partition_slice;
mod postopt; mod postopt;
mod predicates; mod predicates;
mod preopt;
mod ref_slice; mod ref_slice;
mod regalloc; mod regalloc;
mod result; mod result;
mod scoped_hash_map; mod scoped_hash_map;
mod simple_gvn; mod simple_gvn;
mod simple_preopt;
mod stack_layout; mod stack_layout;
mod topo_order; mod topo_order;
mod unreachable_code; mod unreachable_code;

View File

@@ -124,7 +124,7 @@ mod details {
} }
/// Accumulated timing information for a single pass. /// Accumulated timing information for a single pass.
#[derive(Default)] #[derive(Default, Copy, Clone)]
struct PassTime { struct PassTime {
/// Total time spent running this pass including children. /// Total time spent running this pass including children.
total: Duration, total: Duration,
@@ -134,17 +134,24 @@ mod details {
} }
/// Accumulated timing for all passes. /// Accumulated timing for all passes.
#[derive(Default)]
pub struct PassTimes { pub struct PassTimes {
pass: [PassTime; NUM_PASSES], pass: [PassTime; NUM_PASSES],
} }
impl Default for PassTimes {
fn default() -> Self {
PassTimes {
pass: [Default::default(); NUM_PASSES],
}
}
}
impl fmt::Display for PassTimes { impl fmt::Display for PassTimes {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
writeln!(f, "======== ======== ==================================")?; writeln!(f, "======== ======== ==================================")?;
writeln!(f, " Total Self Pass")?; writeln!(f, " Total Self Pass")?;
writeln!(f, "-------- -------- ----------------------------------")?; writeln!(f, "-------- -------- ----------------------------------")?;
for (time, desc) in self.pass.iter().zip(&DESCRIPTIONS) { for (time, desc) in self.pass.iter().zip(&DESCRIPTIONS[..]) {
// Omit passes that haven't run. // Omit passes that haven't run.
if time.total == Duration::default() { if time.total == Duration::default() {
continue; continue;
@@ -212,7 +219,7 @@ mod details {
/// Add `timings` to the accumulated timings for the current thread. /// Add `timings` to the accumulated timings for the current thread.
pub fn add_to_current(times: &PassTimes) { pub fn add_to_current(times: &PassTimes) {
PASS_TIME.with(|rc| { PASS_TIME.with(|rc| {
for (a, b) in rc.borrow_mut().pass.iter_mut().zip(&times.pass) { for (a, b) in rc.borrow_mut().pass.iter_mut().zip(&times.pass[..]) {
a.total += b.total; a.total += b.total;
a.child += b.child; a.child += b.child;
} }

View File

@@ -11,6 +11,7 @@ publish = false
[dependencies] [dependencies]
cranelift-codegen = { path = "../codegen", version = "0.22.0", features = ["testing_hooks"] } cranelift-codegen = { path = "../codegen", version = "0.22.0", features = ["testing_hooks"] }
cranelift-reader = { path = "../reader", version = "0.22.0" } cranelift-reader = { path = "../reader", version = "0.22.0" }
cranelift-preopt = { path = "../preopt", version = "0.22.0" }
file-per-thread-logger = "0.1.1" file-per-thread-logger = "0.1.1"
filecheck = "0.4.0" filecheck = "0.4.0"
num_cpus = "1.8.0" num_cpus = "1.8.0"

View File

@@ -24,6 +24,7 @@
)] )]
extern crate cranelift_codegen; extern crate cranelift_codegen;
extern crate cranelift_preopt;
extern crate cranelift_reader; extern crate cranelift_reader;
extern crate file_per_thread_logger; extern crate file_per_thread_logger;
extern crate filecheck; extern crate filecheck;
@@ -56,6 +57,7 @@ mod test_print_cfg;
mod test_regalloc; mod test_regalloc;
mod test_shrink; mod test_shrink;
mod test_simple_gvn; mod test_simple_gvn;
mod test_simple_preopt;
mod test_verifier; mod test_verifier;
/// The result of running the test in a file. /// The result of running the test in a file.
@@ -127,12 +129,13 @@ fn new_subtest(parsed: &TestCommand) -> subtest::SubtestResult<Box<subtest::SubT
"legalizer" => test_legalizer::subtest(parsed), "legalizer" => test_legalizer::subtest(parsed),
"licm" => test_licm::subtest(parsed), "licm" => test_licm::subtest(parsed),
"postopt" => test_postopt::subtest(parsed), "postopt" => test_postopt::subtest(parsed),
"preopt" => test_preopt::subtest(parsed), "simple_preopt" => test_simple_preopt::subtest(parsed),
"print-cfg" => test_print_cfg::subtest(parsed), "print-cfg" => test_print_cfg::subtest(parsed),
"regalloc" => test_regalloc::subtest(parsed), "regalloc" => test_regalloc::subtest(parsed),
"shrink" => test_shrink::subtest(parsed), "shrink" => test_shrink::subtest(parsed),
"simple-gvn" => test_simple_gvn::subtest(parsed), "simple-gvn" => test_simple_gvn::subtest(parsed),
"verifier" => test_verifier::subtest(parsed), "verifier" => test_verifier::subtest(parsed),
"preopt" => test_preopt::subtest(parsed),
_ => Err(format!("unknown test command '{}'", parsed.command)), _ => Err(format!("unknown test command '{}'", parsed.command)),
} }
} }

View File

@@ -1,10 +1,14 @@
//! Test command for testing the preopt pass. //! Test command for testing the constant folding pass.
//!
//! The `dce` test command runs each function through the constant folding pass after ensuring
//! that all instructions are legal for the target.
//! //!
//! The resulting function is sent to `filecheck`. //! The resulting function is sent to `filecheck`.
use cranelift_codegen; use cranelift_codegen;
use cranelift_codegen::ir::Function; use cranelift_codegen::ir::Function;
use cranelift_codegen::print_errors::pretty_error; use cranelift_codegen::print_errors::pretty_error;
use cranelift_preopt::optimize;
use cranelift_reader::TestCommand; use cranelift_reader::TestCommand;
use std::borrow::Cow; use std::borrow::Cow;
use subtest::{run_filecheck, Context, SubTest, SubtestResult}; use subtest::{run_filecheck, Context, SubTest, SubtestResult};
@@ -29,16 +33,18 @@ impl SubTest for TestPreopt {
true true
} }
fn run(&self, func: Cow<Function>, context: &Context) -> SubtestResult<()> { fn needs_isa(&self) -> bool {
let mut comp_ctx = cranelift_codegen::Context::for_function(func.into_owned()); true
let isa = context.isa.expect("preopt needs an ISA"); }
comp_ctx.flowgraph(); fn run(&self, func: Cow<Function>, context: &Context) -> SubtestResult<()> {
comp_ctx let isa = context.isa.expect("compile needs an ISA");
.preopt(isa) let mut comp_ctx = cranelift_codegen::Context::for_function(func.into_owned());
optimize(&mut comp_ctx, isa)
.map_err(|e| pretty_error(&comp_ctx.func, context.isa, Into::into(e)))?; .map_err(|e| pretty_error(&comp_ctx.func, context.isa, Into::into(e)))?;
let text = &comp_ctx.func.display(isa).to_string(); let text = comp_ctx.func.display(context.isa).to_string();
run_filecheck(&text, context) run_filecheck(&text, context)
} }
} }

View File

@@ -0,0 +1,44 @@
//! Test command for testing the preopt pass.
//!
//! The resulting function is sent to `filecheck`.
use cranelift_codegen;
use cranelift_codegen::ir::Function;
use cranelift_codegen::print_errors::pretty_error;
use cranelift_reader::TestCommand;
use std::borrow::Cow;
use subtest::{run_filecheck, Context, SubTest, SubtestResult};
struct TestSimplePreopt;
pub fn subtest(parsed: &TestCommand) -> SubtestResult<Box<SubTest>> {
assert_eq!(parsed.command, "simple_preopt");
if !parsed.options.is_empty() {
Err(format!("No options allowed on {}", parsed))
} else {
Ok(Box::new(TestSimplePreopt))
}
}
impl SubTest for TestSimplePreopt {
fn name(&self) -> &'static str {
"simple_preopt"
}
fn is_mutating(&self) -> bool {
true
}
fn run(&self, func: Cow<Function>, context: &Context) -> SubtestResult<()> {
let mut comp_ctx = cranelift_codegen::Context::for_function(func.into_owned());
let isa = context.isa.expect("preopt needs an ISA");
comp_ctx.flowgraph();
comp_ctx
.preopt(isa)
.map_err(|e| pretty_error(&comp_ctx.func, context.isa, Into::into(e)))?;
let text = &comp_ctx.func.display(isa).to_string();
run_filecheck(&text, context)
}
}

27
lib/preopt/Cargo.toml Normal file
View File

@@ -0,0 +1,27 @@
[package]
authors = ["The Cranelift Project Developers"]
name = "cranelift-preopt"
version = "0.22.0"
description = "Support for optimizations in Cranelift"
license = "Apache-2.0 WITH LLVM-exception"
documentation = "https://cranelift.readthedocs.io/"
repository = "https://github.com/CraneStation/cranelift"
categories = ["no_std"]
readme = "README.md"
keywords = ["optimize", "compile", "compiler", "jit"]
[dependencies]
cranelift-codegen = { path = "../codegen", version = "0.22.0", default-features = false }
cranelift-entity = { path = "../entity", version = "0.22.0", default-features = false }
# This is commented out because it doesn't build on Rust 1.25.0, which
# cranelift currently supports.
# rustc_apfloat = { version = "0.1.2", default-features = false }
[features]
default = ["std"]
std = ["cranelift-codegen/std", "cranelift-entity/std"]
core = ["cranelift-codegen/core"]
[badges]
maintenance = { status = "experimental" }
travis-ci = { repository = "CraneStation/cranelift" }

219
lib/preopt/LICENSE Normal file
View File

@@ -0,0 +1,219 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
--- LLVM Exceptions to the Apache 2.0 License ----
As an exception, if, as a result of your compiling your source code, portions
of this Software are embedded into an Object form of such source code, you
may redistribute such embedded portions in such Object form without complying
with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
In addition, if you combine or link compiled forms of this Software with
software that is licensed under the GPLv2 ("Combined Software") and if a
court of competent jurisdiction determines that the patent provision (Section
3), the indemnity provision (Section 9) or other Section of the License
conflicts with the conditions of the GPLv2, you may retroactively and
prospectively choose to deem waived or otherwise exclude such Section(s) of
the License, but only in their entirety and only with respect to the Combined
Software.

1
lib/preopt/README.md Normal file
View File

@@ -0,0 +1 @@
This crate performes early-stage optimizations on [Cranelift](https://crates.io/crates/cranelift) IR.

View File

@@ -0,0 +1,254 @@
//! Fold operations on constants at compile time.
use cranelift_codegen::{
cursor::{Cursor, FuncCursor},
ir::{self, InstBuilder},
};
// use rustc_apfloat::{
// ieee::{Double, Single},
// Float,
// };
enum ConstImm {
Bool(bool),
I64(i64),
Ieee32(f32), // Ieee32 and Ieee64 will be replaced with `Single` and `Double` from the rust_apfloat library eventually.
Ieee64(f64),
}
impl ConstImm {
fn unwrap_i64(self) -> i64 {
if let ConstImm::I64(imm) = self {
imm
} else {
panic!("self did not contain an `i64`.")
}
}
fn evaluate_truthiness(self) -> bool {
match self {
ConstImm::Bool(b) => b,
ConstImm::I64(imm) => imm != 0,
_ => panic!(
"Only a `ConstImm::Bool` and `ConstImm::I64` can be evaluated for \"truthiness\""
),
}
}
}
/// Fold operations on constants.
///
/// It's important to note that this will not remove unused constants. It's
/// assumed that the DCE pass will take care of them.
pub fn fold_constants(func: &mut ir::Function) {
let mut pos = FuncCursor::new(func);
while let Some(_ebb) = pos.next_ebb() {
while let Some(inst) = pos.next_inst() {
use self::ir::InstructionData::*;
match pos.func.dfg[inst] {
Binary { opcode, args } => {
fold_binary(&mut pos.func.dfg, inst, opcode, args);
}
Unary { opcode, arg } => {
fold_unary(&mut pos.func.dfg, inst, opcode, arg);
}
Branch {
opcode,
args: _,
destination: _,
} => {
fold_branch(&mut pos, inst, opcode);
}
_ => {}
}
}
}
}
fn resolve_value_to_imm(dfg: &ir::DataFlowGraph, value: ir::Value) -> Option<ConstImm> {
let original = dfg.resolve_aliases(value);
let inst = dfg.value_def(original).unwrap_inst();
use self::ir::{InstructionData::*, Opcode::*};
match dfg[inst] {
UnaryImm {
opcode: Iconst,
imm,
} => Some(ConstImm::I64(imm.into())),
UnaryIeee32 {
opcode: F32const,
imm,
} => {
// See https://doc.rust-lang.org/std/primitive.f32.html#method.from_bits for caveats.
let ieee_f32 = f32::from_bits(imm.bits());
Some(ConstImm::Ieee32(ieee_f32))
}
UnaryIeee64 {
opcode: F64const,
imm,
} => {
// See https://doc.rust-lang.org/std/primitive.f32.html#method.from_bits for caveats.
let ieee_f64 = f64::from_bits(imm.bits());
Some(ConstImm::Ieee64(ieee_f64))
}
UnaryBool {
opcode: Bconst,
imm,
} => Some(ConstImm::Bool(imm)),
_ => None,
}
}
fn evaluate_binary(opcode: ir::Opcode, imm0: ConstImm, imm1: ConstImm) -> Option<ConstImm> {
use std::num::Wrapping;
match opcode {
ir::Opcode::Iadd => {
let imm0 = Wrapping(imm0.unwrap_i64());
let imm1 = Wrapping(imm1.unwrap_i64());
Some(ConstImm::I64((imm0 + imm1).0))
}
ir::Opcode::Isub => {
let imm0 = Wrapping(imm0.unwrap_i64());
let imm1 = Wrapping(imm1.unwrap_i64());
Some(ConstImm::I64((imm0 - imm1).0))
}
ir::Opcode::Imul => {
let imm0 = Wrapping(imm0.unwrap_i64());
let imm1 = Wrapping(imm1.unwrap_i64());
Some(ConstImm::I64((imm0 * imm1).0))
}
ir::Opcode::Udiv => {
let imm0 = Wrapping(imm0.unwrap_i64());
let imm1 = Wrapping(imm1.unwrap_i64());
if imm1.0 == 0 {
panic!("Cannot divide by a zero.")
}
Some(ConstImm::I64((imm0 / imm1).0))
}
ir::Opcode::Fadd => match (imm0, imm1) {
(ConstImm::Ieee32(imm0), ConstImm::Ieee32(imm1)) => Some(ConstImm::Ieee32(imm0 + imm1)),
(ConstImm::Ieee64(imm0), ConstImm::Ieee64(imm1)) => Some(ConstImm::Ieee64(imm0 + imm1)),
_ => unreachable!(),
},
ir::Opcode::Fsub => match (imm0, imm1) {
(ConstImm::Ieee32(imm0), ConstImm::Ieee32(imm1)) => Some(ConstImm::Ieee32(imm0 - imm1)),
(ConstImm::Ieee64(imm0), ConstImm::Ieee64(imm1)) => Some(ConstImm::Ieee64(imm0 - imm1)),
_ => unreachable!(),
},
ir::Opcode::Fmul => match (imm0, imm1) {
(ConstImm::Ieee32(imm0), ConstImm::Ieee32(imm1)) => Some(ConstImm::Ieee32(imm0 * imm1)),
(ConstImm::Ieee64(imm0), ConstImm::Ieee64(imm1)) => Some(ConstImm::Ieee64(imm0 * imm1)),
_ => unreachable!(),
},
ir::Opcode::Fdiv => match (imm0, imm1) {
(ConstImm::Ieee32(imm0), ConstImm::Ieee32(imm1)) => Some(ConstImm::Ieee32(imm0 / imm1)),
(ConstImm::Ieee64(imm0), ConstImm::Ieee64(imm1)) => Some(ConstImm::Ieee64(imm0 / imm1)),
_ => unreachable!(),
},
_ => None,
}
}
fn evaluate_unary(opcode: ir::Opcode, imm: ConstImm) -> Option<ConstImm> {
match opcode {
ir::Opcode::Fneg => match imm {
ConstImm::Ieee32(imm) => Some(ConstImm::Ieee32(-imm)),
ConstImm::Ieee64(imm) => Some(ConstImm::Ieee64(-imm)),
_ => unreachable!(),
},
ir::Opcode::Fabs => match imm {
ConstImm::Ieee32(imm) => Some(ConstImm::Ieee32(imm.abs())),
ConstImm::Ieee64(imm) => Some(ConstImm::Ieee64(imm.abs())),
_ => unreachable!(),
},
_ => None,
}
}
fn replace_inst(dfg: &mut ir::DataFlowGraph, inst: ir::Inst, const_imm: ConstImm) {
use self::ConstImm::*;
match const_imm {
I64(imm) => {
let typevar = dfg.ctrl_typevar(inst);
dfg.replace(inst).iconst(typevar, imm);
}
Ieee32(imm) => {
dfg.replace(inst)
.f32const(ir::immediates::Ieee32::with_bits(imm.to_bits()));
}
Ieee64(imm) => {
dfg.replace(inst)
.f64const(ir::immediates::Ieee64::with_bits(imm.to_bits()));
}
Bool(imm) => {
let typevar = dfg.ctrl_typevar(inst);
dfg.replace(inst).bconst(typevar, imm);
}
}
}
/// Fold a binary instruction.
fn fold_binary(
dfg: &mut ir::DataFlowGraph,
inst: ir::Inst,
opcode: ir::Opcode,
args: [ir::Value; 2],
) {
let (imm0, imm1) = if let (Some(imm0), Some(imm1)) = (
resolve_value_to_imm(dfg, args[0]),
resolve_value_to_imm(dfg, args[1]),
) {
(imm0, imm1)
} else {
return;
};
if let Some(const_imm) = evaluate_binary(opcode, imm0, imm1) {
replace_inst(dfg, inst, const_imm);
}
}
/// Fold a unary instruction.
fn fold_unary(dfg: &mut ir::DataFlowGraph, inst: ir::Inst, opcode: ir::Opcode, arg: ir::Value) {
let imm = if let Some(imm) = resolve_value_to_imm(dfg, arg) {
imm
} else {
return;
};
if let Some(const_imm) = evaluate_unary(opcode, imm) {
replace_inst(dfg, inst, const_imm);
}
}
fn fold_branch(pos: &mut FuncCursor, inst: ir::Inst, opcode: ir::Opcode) {
let (cond, ebb, args) = {
let values = pos.func.dfg.inst_args(inst);
let inst_data = &pos.func.dfg[inst];
(
resolve_value_to_imm(&pos.func.dfg, values[0]).unwrap(),
inst_data.branch_destination().unwrap(),
values[1..].to_vec(),
)
};
let truthiness = cond.evaluate_truthiness();
let branch_if_zero = match opcode {
ir::Opcode::Brz => true,
ir::Opcode::Brnz => false,
_ => unreachable!(),
};
if (branch_if_zero && !truthiness) || (!branch_if_zero && truthiness) {
pos.func.dfg.replace(inst).jump(ebb, &args);
// remove the rest of the ebb to avoid verifier errors
while let Some(next_inst) = pos.func.layout.next_inst(inst) {
pos.func.layout.remove_inst(next_inst);
}
} else {
pos.remove_inst_and_step_back();
}
}

71
lib/preopt/src/lib.rs Normal file
View File

@@ -0,0 +1,71 @@
//! Performes early-stage optimizations on Cranelift IR.
#![deny(
missing_docs,
trivial_numeric_casts,
unused_extern_crates,
unstable_features
)]
#![warn(unused_import_braces)]
#![cfg_attr(
feature = "clippy",
plugin(clippy(conf_file = "../../clippy.toml"))
)]
#![cfg_attr(
feature = "cargo-clippy",
allow(new_without_default, new_without_default_derive)
)]
#![cfg_attr(
feature = "cargo-clippy",
warn(
float_arithmetic,
mut_mut,
nonminimal_bool,
option_map_unwrap_or,
option_map_unwrap_or_else,
print_stdout,
unicode_not_nfc,
use_self
)
)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(not(feature = "std"), alloc)]
#[cfg(not(feature = "std"))]
extern crate alloc;
extern crate cranelift_codegen;
// extern crate rustc_apfloat;
mod constant_folding;
use cranelift_codegen::{isa::TargetIsa, settings::FlagsOrIsa, CodegenResult, Context};
/// Optimize the function with available optimizations.
///
/// Since this can be resource intensive (and code-size inflating),
/// it is separated from `Context::compile` to allow DCE to remove it
/// if it's not used.
pub fn optimize(ctx: &mut Context, isa: &TargetIsa) -> CodegenResult<()> {
ctx.verify_if(isa)?;
fold_constants(ctx, isa)?;
Ok(())
}
/// Fold constants
pub fn fold_constants<'a, FOI>(ctx: &mut Context, fisa: FOI) -> CodegenResult<()>
where
FOI: Into<FlagsOrIsa<'a>>,
{
constant_folding::fold_constants(&mut ctx.func);
ctx.verify_if(fisa)?;
Ok(())
}
/// This replaces `std` in builds with `core`.
#[cfg(not(feature = "std"))]
mod std {
pub use alloc::{boxed, slice, string, vec};
pub use core::*;
}