diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..c2306ff --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,44 @@ +# Overview + +_Provide an overview of this change. Describe the intent of this change, and how it implements that intent._ + +_Example: This PR accomplishes X by doing Y._ + +## Acceptance criteria + +_If this PR is successful, what impact does it have on the user experience?_ + +_Example: When users do X, Y should now happen._ + +## Testing plan + +_How did you validate that this PR works? What literal steps did you take when manually checking that your code works?_ + +_Example:_ + +1. _Set up test case X._ +2. _Run command Y. Make sure Z happens._ + +_This section should list concrete steps that a reviewer can sanity check and repeat on their own machine (and provide any needed test cases)._ + +## Metrics + +_How are we monitoring this change?_ + +## Risks + +_Highlight any areas that you're unsure of, want feedback on, or want reviewers to pay particular attention to._ + +_Example: I'm not sure I did X correctly, can reviewers please double-check that for me?_ + +## References + +_Add links to any referenced GitHub issues, Zendesk tickets, Jira tickets, Slack threads, etc._ + +_Example:_ + +- _[ANE-123](https://fossa.atlassian.net/browse/ANE-123): Implement X._ + +## Checklist + +- [ ] I added tests for this PR's change (or explained in the PR description why tests don't make sense). diff --git a/.github/workflows/check-dependencies.yml b/.github/workflows/check-dependencies.yml new file mode 100644 index 0000000..bfc2c1a --- /dev/null +++ b/.github/workflows/check-dependencies.yml @@ -0,0 +1,18 @@ +name: dependencies +on: push + +jobs: + check-fossa: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - run: "curl -H 'Cache-Control: no-cache' https://raw.githubusercontent.com/fossas/fossa-cli/master/install-latest.sh | bash" + + - run: fossa analyze --only-target cargo . + env: + FOSSA_API_KEY: ${{ secrets.FOSSA_API_KEY }} + + - run: fossa test + env: + FOSSA_API_KEY: ${{ secrets.FOSSA_API_KEY }} diff --git a/.github/workflows/check-dynamic.yml b/.github/workflows/check-dynamic.yml new file mode 100644 index 0000000..463c834 --- /dev/null +++ b/.github/workflows/check-dynamic.yml @@ -0,0 +1,62 @@ +name: dynamic + +on: pull_request + +jobs: + # Note: this builds on Windows using the MinGW toolchain, to enable cross compilation. + # If interoperability with Windows debugging tools or binaries (e.g. dlls) is important, + # the repo should probably run a dedicated Windows runner and use `x86_64-pc-windows-msvc`. + check-build: + strategy: + matrix: + target: [x86_64-unknown-linux-gnu, x86_64-pc-windows-gnu, aarch64-unknown-linux-gnu] + + runs-on: ubuntu-latest + name: check-build / ${{ matrix.target }} + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - uses: taiki-e/install-action@cross + - uses: Swatinem/rust-cache@v1.3.0 + with: + key: ${{ matrix.target }} + + - run: cross build --all-targets --target ${{ matrix.target }} + + # We can't easily cross compile to macOS, since Cross doesn't ship a docker image for this target. + check-build-macos: + strategy: + matrix: + target: [x86_64-apple-darwin, aarch64-apple-darwin] + + runs-on: macos-latest + name: check-build / ${{ matrix.target }} + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - uses: Swatinem/rust-cache@v1.3.0 + with: + key: ${{ matrix.target }} + + - run: rustup target add ${{ matrix.target }} + - run: cargo build --all-targets --target ${{ matrix.target }} + + # Unfortunately, while we can cross compile, we can't easily run tests cross platform. + # Cross _can_ run them, but runs through qemu. + # This makes things very slow at best, and buggy at worst. + check-test: + strategy: + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + + runs-on: ${{ matrix.os }} + name: check-test / ${{ matrix.os }} + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + - uses: taiki-e/install-action@nextest + - uses: Swatinem/rust-cache@v1.3.0 + + - run: cargo check --release --all --bins --examples --tests + - run: cargo nextest run --all-targets + - run: cargo test --doc diff --git a/.github/workflows/check-static.yml b/.github/workflows/check-static.yml new file mode 100644 index 0000000..87aec52 --- /dev/null +++ b/.github/workflows/check-static.yml @@ -0,0 +1,13 @@ +name: static + +on: pull_request + +jobs: + check-static: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + + - run: cargo fmt --all -- --check + - run: cargo clippy --all-features --all --tests -- -D clippy::all diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..196e176 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +# Generated by Cargo +# will have compiled files and executables +debug/ +target/ + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html +Cargo.lock + +# These are backup files generated by rustfmt +**/*.rs.bk + +# MSVC Windows builds of rustc generate these, which store debugging information +*.pdb + + +# Added by cargo + +/target diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..6d0dc2f --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,17 @@ +{ + "cSpell.words": [ + "aarch", + "clippy", + "CODEOWNER", + "CODEOWNERS", + "doctest", + "doctests", + "dtolnay", + "libc", + "msvc", + "nextest", + "rustup", + "Swatinem", + "taiki" + ] +} diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..6184e61 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,8 @@ +[package] +name = "template-rust" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..14e2f77 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9cbcc40 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# template-rust + +Template repository for a Rust project. + +TODOs for a new project: +- [ ] Change the license if MPL2 is not appropriate for the project. Make sure to do this before adding any code. +- [ ] Set [CODEOWNERS] to the team that owns the repository. +- [ ] Create an API user in [FOSSA] and store it as a secret named `FOSSA_API_KEY`. + - Consider naming it with the pattern `ci-{REPO_NAME}`. For example, `ci-template-rust`. +- [ ] Update repository permissions as appropriate. Generally, the CODEOWNER team is set as admin. +- [ ] Update branch protection rules as appropriate. +- [ ] Update repository features and settings. Recommended defaults: + - [ ] Turn off all features (Wikis, Issues, Sponsorships, Discussions, Projects); FOSSA uses other systems for these. + - [ ] Only allow squash merging. + - [ ] Always suggest updating PR branches. + - [ ] Allow auto-merge. + - [ ] Automatically delete head branches. + +Then just edit the included Rust project, or remove it and `cargo init` your project, and get going! + +[codeowners]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners +[fossa]: https://app.fossa.com + +# recommendations + +- Prefer [cross compilation](./docs/dev/reference/cross-compile.md) over running workflows in distinct runners when possible. +- If publishing a Linux binary, consider providing two: one that [statically links libc](./docs/dev/reference/static-binary.md), and one that doesn't. +- If publishing a macOS binary, consider providing two: one for [Intel and one for M-series CPUs](./docs/dev/reference/macos-arch.md). diff --git a/docs/dev/reference/cross-compile.md b/docs/dev/reference/cross-compile.md new file mode 100644 index 0000000..5079d7e --- /dev/null +++ b/docs/dev/reference/cross-compile.md @@ -0,0 +1,64 @@ +# Reference: Cross compilation + +You're working with a macOS or Linux system, and everything is going great. + +Satisfied with your work, you push a PR, and sit back to get a cup of coff- +wait, what's that Windows build issue? + +``` +error[E0793]: reference to packed field is unaligned + --> C:\Users\runneradmin\.cargo\registry\src\index.crates.io-6f17d22bba15001f\ntapi-0.3.7\src\ntexapi.rs:2783:52 + | +2783 | *tick_count.QuadPart_mut() = read_volatile(&(*USER_SHARED_DATA).u.TickCountQuad); + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + | + = note: fields of packed structs are not properly aligned, and creating a misaligned reference is undefined behavior (even if that reference is never dereferenced) + = help: copy the field contents to a local variable, or replace the reference with a raw pointer and use `read_unaligned`/`write_unaligned` (loads and stores via `*p` must be properly aligned even when using raw pointers) +``` + +You then spend several PR cycles trying to get this to be fixed, each time with a delay +(and a bunch of wasteful parallel CI jobs running, whose results you don't care about). + +Wouldn't it be better if instead, you could just build for Windows locally? + +## The better way + +You can! ✨ + +Steps: + +1. Install [`cross`](https://github.com/cross-rs/cross): `cargo binstall cross` +1. `cross build --target x86_64-pc-windows-gnu` + +Now your build still fails but at least your testing loop is faster 🥲 + +## Cross version compile + +You can also do this across versions: + +``` +; rustup install 1.68 +; rustup run 1.68 cross build --target x86_64-pc-windows-gnu +``` + +## Native cross compilation + +`cross` uses Docker to do its thing. + +If you don't like that, you can cross compile by installing dependencies yourself, +assuming that's supported without emulation: + +1. Install the `mingw-64` package. + - On macOS, that's `brew install mingw-w64` + - On Debian/Ubuntu, that's `sudo apt-get install mingw-w64` + - On Arch, that's `sudo pacman -S mingw-w64`, install all +1. `rustup target add x86_64-pc-windows-gnu` +1. `cargo build --target x86_64-pc-windows-gnu` + +And that still works across versions: + +``` +; rustup install 1.68 +; rustup target add x86_64-pc-windows-gnu --toolchain 1.68 +; rustup run 1.68 cargo build --target x86_64-pc-windows-gnu +``` diff --git a/docs/dev/reference/macos-arch.md b/docs/dev/reference/macos-arch.md new file mode 100644 index 0000000..bc387d9 --- /dev/null +++ b/docs/dev/reference/macos-arch.md @@ -0,0 +1,16 @@ +# Reference: macOS binaries + +Apple computers come in two flavors: Intel based and M-series based. + +These correspond to two CPU architectures: +- M-series: `aarch64` +- Intel: `x86_64` + +To build both, perform these steps in CI: +```shell +cross build --target=aarch64-apple-darwin --release +cross build --target=x86_64-apple-darwin --release +``` + +These steps may be done manually as well without using `cross`, if desired. +See [native cross compilation](./cross-compile.md#native-cross-compilation) for more information. diff --git a/docs/dev/reference/static-binary.md b/docs/dev/reference/static-binary.md new file mode 100644 index 0000000..c27fdf5 --- /dev/null +++ b/docs/dev/reference/static-binary.md @@ -0,0 +1,180 @@ +# Reference: Static binary + +Use `musl` with the `jemalloc` allocator to statically link libc. + +Recommendations: +- Publish two binaries for Linux, one which statically links libc and one which does not. +- Do not attempt to statically link libc on Windows or macOS; their syscalls change between versions. + +FFI libraries are linked depending on cargo link arguments, regardless of whether libc is linked +statically or dynamically. To ensure a fully static binary, ensure your libraries all use +the correct cargo arguments. + +Native Rust libraries are always linked statically. + +## Why `musl`? + +Rust, as we all know, links statically! + +... Except that really only applies to _crates_. When we start talking about FFI, +Rust programs _can_ link with C FFI statically, or they can do it dynamically. + +And what about the core runtime, like the allocator? By default, Rust programs +dynamically link to the system `libc`, like any C program would! + +``` +❯ cargo build --release +❯ ldd target/release/broker + linux-vdso.so.1 (0x00007ffc763fe000) + libbz2.so.1.0 => /usr/lib/libbz2.so.1.0 (0x00007effa5181000) + libgcc_s.so.1 => /usr/lib/libgcc_s.so.1 (0x00007effa515c000) + libm.so.6 => /usr/lib/libm.so.6 (0x00007effa4313000) + libc.so.6 => /usr/lib/libc.so.6 (0x00007effa4129000) + /lib64/ld-linux-x86-64.so.2 => /usr/lib64/ld-linux-x86-64.so.2 (0x00007effa51a5000) +``` + +Usually this is fine, and even preferred. It lets system operators choose which +version of `libc` to use, and additionally reduces the size of the binary. +Unfortunately this can cause problems: + +``` +❯ docker run -it --rm roboxes/rhel8 +❯ sudo docker cp target/release/broker 0fd8973ab69c:/root/broker +[root@0fd8973ab69c ~]# ln -s /usr/lib64/libbz2.so.1 /usr/lib64/libbz2.so.1.0 +[root@0fd8973ab69c ~]# ./broker --version +./broker: /lib64/libm.so.6: version `GLIBC_2.29' not found (required by ./broker) +./broker: /lib64/libc.so.6: version `GLIBC_2.32' not found (required by ./broker) +./broker: /lib64/libc.so.6: version `GLIBC_2.29' not found (required by ./broker) +./broker: /lib64/libc.so.6: version `GLIBC_2.33' not found (required by ./broker) +./broker: /lib64/libc.so.6: version `GLIBC_2.34' not found (required by ./broker) +[root@0fd8973ab69c ~]# ldd --version +ldd (GNU libc) 2.28 +``` + +If we build against `musl` instead, we can avoid this issue: + +``` +❯ cross build --target=x86_64-unknown-linux-musl --features jemalloc --release +❯ ldd target/x86_64-unknown-linux-musl/release/broker + statically linked +``` + +And now when we run it in a system with an older `libc`, it works: + +``` +❯ docker run -it --rm roboxes/rhel8 +❯ sudo docker cp target/x86_64-unknown-linux-musl/release/broker 0fd8973ab69c:/root/broker +[root@0fd8973ab69c ~]# ./broker --version +broker 0.2.1 +``` + +We also get static linking of our other dependencies for free, +no more need to mess around with e.g. `libbz2`: + +``` +[root@0fd8973ab69c ~]# rm /usr/lib64/libbz2.so.1.0 +rm: remove symbolic link '/usr/lib64/libbz2.so.1.0'? y +[root@0fd8973ab69c ~]# ./broker --version +broker 0.2.1 +``` + +## Why `jemalloc`? + +We created a benchmark to demonstrate the performance of a Rust program using `musl`. + +Benchmark system information: +``` +❯ macchina -o kernel -o processor -o memory + + .--. Kernel - 6.3.1-arch1-1 + |o_o | CPU - 13th Gen Intel® Core™ i5-13600KF (20) + |\_/ | Memory - 6.3 GB/65.7 GB + // \ \ + (| | ) + /'\_ _/`\ + \___)=(___/ +``` + +### `libc` with native allocator + +This is considered the baseline. + +``` +❯ cargo bench +Running benches/allocations.rs (target/release/deps/allocations-16d4c626ab524c6e) +single thread time: [5.3980 ms 5.4019 ms 5.4057 ms] + change: [+0.6054% +0.7436% +0.8604%] (p = 0.00 < 0.05) + Change within noise threshold. +Found 3 outliers among 100 measurements (3.00%) + 3 (3.00%) high mild + +multi thread time: [9.7086 ms 10.202 ms 10.725 ms] + change: [-13.696% -7.7467% -0.9965%] (p = 0.02 < 0.05) + Change within noise threshold. +Found 2 outliers among 100 measurements (2.00%) + 2 (2.00%) high mild +``` + +### `libc` with `jemalloc` + +This is just for completion. + +``` +❯ cargo bench --features jemalloc +Running benches/allocations.rs (target/release/deps/allocations-c9acb5c19d58ded6) +single thread time: [5.6920 ms 5.6939 ms 5.6960 ms] + change: [+5.3211% +5.4061% +5.4884%] (p = 0.00 < 0.05) + Performance has regressed. +Found 3 outliers among 100 measurements (3.00%) + 2 (2.00%) low mild + 1 (1.00%) high severe + +multi thread time: [10.329 ms 10.757 ms 11.213 ms] + change: [-1.0523% +5.4362% +12.550%] (p = 0.11 > 0.05) + No change in performance detected. +Found 4 outliers among 100 measurements (4.00%) + 4 (4.00%) high mild +``` + +### `musl` with native allocator + +This is wildly slower than the baseline; this is why we use `jemalloc`. + +``` +❯ cross bench --target=x86_64-unknown-linux-musl +Running benches/allocations.rs (/target/x86_64-unknown-linux-musl/release/deps/allocations-7754353e43941b3f) +single thread time: [7.7555 ms 7.7674 ms 7.7898 ms] + change: [+44.223% +44.499% +44.930%] (p = 0.00 < 0.05) + Performance has regressed. +Found 11 outliers among 100 measurements (11.00%) + 8 (8.00%) high mild + 3 (3.00%) high severe + +Benchmarking multi thread: Warming up for 3.0000 s +Warning: Unable to complete 100 samples in 5.0s. You may wish to increase target time to 7.8s, or reduce sample count to 60. +multi thread time: [74.947 ms 75.424 ms 75.896 ms] + change: [+567.90% +597.89% +628.02%] (p = 0.00 < 0.05) + Performance has regressed. +``` + +### `musl` with `jemalloc` + +Here we see that `musl`, even with `jemalloc`, has a performance penalty but it's no longer a _597%_ increase to runtime. +This is an acceptable tradeoff for static linux binaries. + +``` +❯ cross bench --target=x86_64-unknown-linux-musl --features jemalloc +Running benches/allocations.rs (/target/x86_64-unknown-linux-musl/release/deps/allocations-ea9fccec62e130b2) +single thread time: [7.3118 ms 7.3198 ms 7.3328 ms] + change: [+36.207% +36.436% +36.724%] (p = 0.00 < 0.05) + Performance has regressed. +Found 4 outliers among 100 measurements (4.00%) + 2 (2.00%) high mild + 2 (2.00%) high severe + +multi thread time: [12.961 ms 13.526 ms 14.122 ms] + change: [+21.107% +27.603% +35.021%] (p = 0.00 < 0.05) + Performance has regressed. +Found 2 outliers among 100 measurements (2.00%) + 2 (2.00%) high mild +``` diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..4ee70a2 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,5 @@ +#[cfg(test)] +mod tests { + #[test] + fn lib_works() {} +} diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..ae16713 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,9 @@ +fn main() { + println!("Hello, world!"); +} + +#[cfg(test)] +mod tests { + #[test] + fn bin_works() {} +}