Skip to content

Commit 57ccaef

Browse files
cfallincfallin
authored
Merge pull request bytecodealliance#1 from cfallin/initial-regalloc
Initial implementation of regalloc2.
2 parents 4184199 + 6f0893d commit 57ccaef

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+12133
-0
lines changed

‎.empty

Whitespace-only changes.

‎.github/workflows/rust.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Derived from regalloc.rs' GitHub CI config file.
2+
3+
name: Rust
4+
5+
on:
6+
push:
7+
branches: [ main ]
8+
pull_request:
9+
branches: [ main ]
10+
11+
jobs:
12+
# Lint code with rustfmt, report an error if it needs to be run.
13+
lint:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Install rustfmt
18+
run: rustup component add rustfmt
19+
- name: Run rustfmt and check there's no difference
20+
run: cargo fmt --all -- --check
21+
22+
# Make sure the code compiles and that all the tests pass.
23+
build:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- uses: actions/checkout@v2
27+
- name: Build
28+
run: cargo build
29+
- name: Run tests
30+
run: cargo test --all --verbose
31+
32+
# Lint dependency graph for security advisories, duplicate versions, and
33+
# incompatible licences.
34+
cargo_deny:
35+
name: Cargo deny
36+
runs-on: ubuntu-latest
37+
steps:
38+
- uses: actions/checkout@v2
39+
with:
40+
submodules: true
41+
- run: |
42+
set -e
43+
curl -L https://github.com/EmbarkStudios/cargo-deny/releases/download/0.8.5/cargo-deny-0.8.5-x86_64-unknown-linux-musl.tar.gz | tar xzf -
44+
mv cargo-deny-*-x86_64-unknown-linux-musl/cargo-deny cargo-deny
45+
echo `pwd` >> $GITHUB_PATH
46+
- run: cargo deny check
47+
48+
# Builds the fuzz targets.
49+
fuzz:
50+
runs-on: ubuntu-latest
51+
steps:
52+
- uses: actions/checkout@v2
53+
- name: Install nightly
54+
run: rustup toolchain install nightly
55+
- name: Install cargo-fuzz
56+
run: cargo +nightly install cargo-fuzz
57+
- name: Build ssagen fuzzing target
58+
run: cargo +nightly fuzz build ssagen
59+
- name: Build moves fuzzing target
60+
run: cargo +nightly fuzz build moves
61+
- name: Build ion fuzzing target
62+
run: cargo +nightly fuzz build ion
63+
- name: Build and smoke-test ion_checker fuzzing target
64+
run: cargo +nightly fuzz run ion_checker ./fuzz/smoketest/ion_checker.bin

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Cargo.lock
2+
target/
3+
.*.swp
4+
*~

‎Cargo.toml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
[package]
2+
name = "regalloc2"
3+
version = "0.0.1"
4+
authors = ["Chris Fallin <[email protected]>", "Mozilla SpiderMonkey Developers"]
5+
edition = "2018"
6+
license = "Apache-2.0 WITH LLVM-exception AND MPL-2.0"
7+
description = "Backtracking register allocator inspired from IonMonkey"
8+
repository = "https://github.com/bytecodealliance/regalloc2"
9+
10+
[dependencies]
11+
log = { version = "0.4.8", default-features = false }
12+
smallvec = "1.6.1"
13+
fxhash = "0.2.1"
14+
15+
# The below are only needed for fuzzing.
16+
# Keep this in sync with libfuzzer_sys's crate version:
17+
arbitrary = { version = "^0.4.6", optional = true }
18+
19+
[profile.release]
20+
debug = true
21+
22+
[features]
23+
default = []
24+
fuzzing = ["arbitrary"]

‎LICENSE

+220
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
203+
204+
205+
--- LLVM Exceptions to the Apache 2.0 License ----
206+
207+
As an exception, if, as a result of your compiling your source code, portions
208+
of this Software are embedded into an Object form of such source code, you
209+
may redistribute such embedded portions in such Object form without complying
210+
with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
211+
212+
In addition, if you combine or link compiled forms of this Software with
213+
software that is licensed under the GPLv2 ("Combined Software") and if a
214+
court of competent jurisdiction determines that the patent provision (Section
215+
3), the indemnity provision (Section 9) or other Section of the License
216+
conflicts with the conditions of the GPLv2, you may retroactively and
217+
prospectively choose to deem waived or otherwise exclude such Section(s) of
218+
the License, but only in their entirety and only with respect to the Combined
219+
Software.
220+

‎README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## regalloc2: another register allocator
2+
3+
This is a register allocator that started life as, and is about 50%
4+
still, a port of IonMonkey's backtracking register allocator to
5+
Rust. In many regards, it has been generalized, optimized, and
6+
improved since the initial port, and now supports both SSA and non-SSA
7+
use-cases.
8+
9+
In addition, it contains substantial amounts of testing infrastructure
10+
(fuzzing harnesses and checkers) that does not exist in the original
11+
IonMonkey allocator.
12+
13+
See the [design overview](doc/DESIGN.md) for (much!) more detail on
14+
how the allocator works.
15+
16+
## License
17+
18+
Unless otherwise specified, code in this crate is licensed under the Apache 2.0
19+
License with LLVM Exception. This license text can be found in the file
20+
`LICENSE`.
21+
22+
Files in the `src/ion/` directory are directly ported from original C++ code in
23+
IonMonkey, a part of the Firefox codebase. Parts of `src/lib.rs` are also
24+
definitions that are directly translated from this original code. As a result,
25+
these files are derivative works and are covered by the Mozilla Public License
26+
(MPL) 2.0, as described in license headers in those files. Please see the
27+
notices in relevant files for links to the original IonMonkey source files from
28+
which they have been translated/derived. The MPL text can be found in
29+
`src/ion/LICENSE`.
30+
31+
Parts of the code are derived from regalloc.rs: in particular,
32+
`src/checker.rs` and `src/domtree.rs`. This crate has the same license
33+
as regalloc.rs, so the license on these files does not differ.

0 commit comments

Comments
 (0)