Skip to content

Commit 798c15d

Browse files
ZuseZ4Lorenz Schmidt
ZuseZ4
and
Lorenz Schmidt
authored
Merge rust build system (rust-lang#519)
* [gsoc] result. Helper tool for building rustc/llvm/enzyme/clang in the required configuration. * Updating to Rust 1.55 and Enzyme 0.0.18 * Updating to Rust 1.56 and Enzyme 0.0.20 * running cargo-fmt and updating README to latest Rust release * applying clippy lints * Refactoring and update to latest enzyme/rustc * Use base path instead of build * Remove reqwest dependency * remove unnecessary default-features * Add LLVM header requirements to README * switch from config to cache dir for build data * Use LLVM header from rustc * Add requried curl features * Support for Enzyme fork * building enzyme from main enzyme github * Moving to Rust 1.57 * updating to enzyme 0.0.24 release * Create LICENSE-APACHE * Create LICENSE-MIT * Update README.md * Update README.md * testing a binary as compile-manager * using .env() to handle build flag * fixing typo * testing cargo-something convention * reorder code layout * Adjust readme to latest changes * fetching target at compile, not runtime * Adding documentation * Updating toml file to prepare for release * updating main to use enum instead of string * lookup target at compile, not run-time * adjustments for release under enzyme name * Add missing dependencies * Adjust version The empty readme used to block enzyme on crates.io was marked as version 0.1.0, so we have to update the minor version instead of starting with a patch version. * crates.io only allows 5 keywords, so removing one * Make code directly copy-able * Required for nightly cargo (due to -Zbuild-std) * Bump to new Enzyme release * make building enzyme a one-liner * Bump to Enzyme 0.0.25, Re-use artifacts if possible * bump to 0.3, due to enzyme 0.0.25 * moving to enzyme 0.0.26 * allow specification of io paths for generate_api * Update releases, allow custom builds * nicer arg parsing * update links and comments * re-license to be compatibel with the LLVM Project * wip * large refactor * adjust version numbers * minor fixes * unpack into right directory * improve handling of generated bindings * more checkfiles to reduce repeating tasks * swap paths for github downloads * improving docs/readme * Update repository path * removed Allowlist to reduce maintenance costs. Co-authored-by: Lorenz Schmidt <[email protected]>
1 parent c6cbf4e commit 798c15d

14 files changed

+1084
-0
lines changed

‎.packaging/rust/.gitignore

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Generated by Cargo
2+
# will have compiled files and executables
3+
debug/
4+
target/
5+
6+
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
7+
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
8+
Cargo.lock
9+
10+
# These are backup files generated by rustfmt
11+
**/*.rs.bk

‎.packaging/rust/Cargo.toml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
[package]
2+
name = "enzyme"
3+
version = "0.4.0"
4+
edition = "2021"
5+
license = "Apache-2.0 WITH LLVM-Exceptions"
6+
authors = [
7+
"Manuel Drehwald",
8+
"Lorenz Schmidt"
9+
]
10+
repository = "https://github.com/EnzymeAD/Enzyme"
11+
keywords = ["enzyme", "auto-diff", "llvm", "machine-learning", "scientific-computing"]
12+
categories = ["development-tools::cargo-plugins", "mathematics", "science", "simulation"]
13+
readme = "README.md"
14+
documentation = "https://docs.rs/enzyme/"
15+
homepage = "https://enzyme.mit.edu"
16+
description = "A helper crate to simplify experimenting with Enzyme."
17+
18+
19+
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
20+
21+
[[bin]]
22+
name = "enzyme-install"
23+
path = "src/bin/main.rs"
24+
25+
[[bin]]
26+
name = "cargo-enzyme"
27+
path = "src/bin/run.rs"
28+
29+
[dependencies]
30+
clap = { version = "3.1", features = ["default", "derive"] }
31+
bindgen = { version = "0.58", default-features = false }
32+
dirs = { version = "3.0", default-features = false }
33+
curl = "0.4"
34+
tar = { version = "0.4", default-features = false }
35+
flate2 = "1.0"

‎.packaging/rust/LICENSE

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

‎.packaging/rust/README.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Enzyme build helper
2+
3+
## Goal
4+
5+
This repository will build enzyme/llvm/clang/rustc in the right configuration such that you can use it in combination with [oxide-enzyme](https://github.com/rust-ml/oxide-enzyme).
6+
7+
## Requirements
8+
9+
- git
10+
- ninja
11+
- cmake
12+
- libssl-dev
13+
- libclang-dev
14+
- Rust (rustup) with an installed nightly toolchain
15+
- ~10GB free storage in $HOME/.cache
16+
17+
## Usage
18+
19+
Build LLVM, the Rust toolchain and Enzyme with
20+
21+
```sh
22+
cargo install enzyme && enzyme-install --rust-stable --enzyme-stable
23+
```
24+
25+
Depending on your CPU this might take a few hours.
26+
The build process will run enzyme tests, so your last output should look similar to these lines:
27+
28+
Testing Time: 0.63s
29+
Passed : 576
30+
Expectedly Failed: 5
31+
32+
## Release schedule:
33+
We will automatically release a new version of this crate every time either a new Rust, or Enzyme version is published.
34+
If you want to experiment with upcomming or local changes you can also use --enzyme-head or --enzyme-local \<Path\> (same goes for the Rust flag).
35+
36+
## Extras
37+
- Q: It fails some (all) tests or the build breaks even earlier. Help?
38+
- A: Sorry. Please create a github issue with relevant information (OS, error message) [here](https://github.com/EnzymeAD/Enzyme/issues) or open a topic on our [Discourse](https://discourse.llvm.org/c/projects-that-want-to-become-official-llvm-projects/enzyme/45).
39+
As an alternative you can also ping us on [Discord](https://discord.gg/MGBqckV7Zb).
40+
&nbsp;
41+
- Q: How often do I have to run this? It takes quite a while..
42+
- A: We are aware of this and working on offering pre-build versions.
43+
44+
License
45+
=======
46+
47+
Dual-licensed to be compatible with the Rust project.
48+
49+
Licensed under the Apache License, Version 2.0
50+
http://www.apache.org/licenses/LICENSE-2.0 or the MIT license
51+
http://opensource.org/licenses/MIT, at your
52+
option. This file may not be copied, modified, or distributed
53+
except according to those terms.

‎.packaging/rust/build.rs

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
fn main() {
2+
println!(
3+
"cargo:rustc-env=TARGET={}",
4+
std::env::var("TARGET").unwrap()
5+
);
6+
}

‎.packaging/rust/src/bin/main.rs

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
use enzyme::Cli;
2+
3+
fn main() {
4+
let args = Cli::parse();
5+
match setup(args) {
6+
Ok(_) => (),
7+
Err(e) => panic!("failed due to: {}", e),
8+
}
9+
}
10+
11+
fn setup(args: Cli) -> Result<(), String> {
12+
enzyme::download(args.clone())?;
13+
enzyme::build(args.clone())?;
14+
enzyme::generate_bindings(args)?;
15+
Ok(())
16+
}

0 commit comments

Comments
 (0)