Compile Cargo project with zig as linker

Project description

cargo-zigbuild

🚀 Help me to become a full-time open-source developer by sponsoring me on GitHub

Compile Cargo project with zig as linker for easier cross compiling.

Installation

cargo install cargo-zigbuild

You can also install it using pip which will also install ziglang automatically:

pip install cargo-zigbuild

We also provide a Docker image which has macOS SDK pre-installed in addition to cargo-zigbuild and Rust, for example to build for x86_64 macOS:

docker run --rm -it -v $(pwd):/io -w /io messense/cargo-zigbuild \
  cargo zigbuild --release --target x86_64-apple-darwin

Usage

Install zig following the official documentation, on macOS, Windows and Linux you can also install zig from PyPI via pip3 install ziglang
Install Rust target via rustup, for example, rustup target add aarch64-unknown-linux-gnu
Run cargo zigbuild, for example, cargo zigbuild --target aarch64-unknown-linux-gnu

Specify glibc version

cargo zigbuild supports passing glibc version in --target option, for example, to compile for glibc 2.17 with the aarch64-unknown-linux-gnu target:

cargo zigbuild --target aarch64-unknown-linux-gnu.2.17

[!NOTE] There are various caveats with the glibc version targeting feature:

If you do not provide a --target, Zig is not used and the command effectively runs a regular cargo build.

If you specify an invalid glibc version, cargo zigbuild will not relay the warning emitted from zig cc about the fallback version selected.

This feature does not necessarily match the behaviour of dynamically linking to a specific version of glibc on the build host.

Version 2.32 can be specified, but runs on a host with only 2.31 available when it should instead abort with an error.

Meanwhile specifying 2.33 will correctly be detected as incompatible when run on a host with glibc 2.31.

Certain RUSTFLAGS like -C linker opt-out of using Zig, while -L path/to/files will have Zig ignore -C target-feature=+crt-static.

-C target-feature=+crt-static for statically linking to a glibc version is not supported (upstream zig cc lacks support)

macOS universal2 target

cargo zigbuild supports a special universal2-apple-darwin target for building macOS universal2 binaries/libraries on Rust 1.64.0 and later.

rustup target add x86_64-apple-darwin
rustup target add aarch64-apple-darwin
cargo zigbuild --target universal2-apple-darwin

Note

Note that Cargo --message-format option doesn't work with universal2 target currently.

Caveats

Currently only Linux, macOS and Windows gnu targets are supported, other target platforms can be added if you can make it work, pull requests are welcome.
Only current Rust stable and nightly versions are regularly tested on CI, other versions may not work.

Known upstream zig issues:

zig cc: parse -target and -mcpu/-march/-mtune flags according to clang: Some Rust targets aren't recognized by zig cc, for example armv7-unknown-linux-gnueabihf, workaround by using -mcpu=generic and explicitly passing target features in #58
ability to link against darwin frameworks (such as CoreFoundation) when cross compiling: Set the SDKROOT environment variable to a macOS SDK path to workaround it
zig misses some compiler_rt functions that may lead to undefined symbol error for certain targets. See also: zig compiler-rt status.
CPU features are not passed to clang

License

This work is released under the MIT license. A copy of the license is provided in the LICENSE file.

Project details

Release history Release notifications | RSS feed

0.19.4

Oct 28, 2024

0.19.3

Sep 24, 2024

0.19.2

Sep 18, 2024

0.19.1

Jul 9, 2024

0.19.0

Jun 20, 2024

This version

0.18.4

Apr 24, 2024

0.18.3

Jan 26, 2024

0.18.2

Jan 14, 2024

0.18.1

Dec 3, 2023

0.18.0

Nov 22, 2023

0.17.5

Nov 13, 2023

0.17.4

Oct 25, 2023

0.17.3

Sep 12, 2023

0.17.2

Sep 10, 2023

0.17.1

Aug 17, 2023

0.17.0

Jul 29, 2023

0.16.12

Jul 6, 2023

0.16.11

Jun 17, 2023

0.16.10

May 27, 2023

0.16.9

May 18, 2023

0.16.8

May 16, 2023

0.16.7

Apr 15, 2023

0.16.6

Apr 7, 2023

0.16.5

Mar 30, 2023

0.16.4

Mar 23, 2023

0.16.3

Mar 12, 2023

0.16.2

Feb 26, 2023

0.16.1

Feb 25, 2023

0.16.0

Feb 10, 2023

0.15.0

Jan 31, 2023

0.14.5

Jan 23, 2023

0.14.4

Jan 23, 2023

0.14.3

Dec 26, 2022

0.14.2

Nov 30, 2022

0.14.1

Nov 2, 2022

0.14.0

Oct 14, 2022

0.13.0

Oct 9, 2022

0.12.3

Sep 15, 2022

0.12.2

Sep 11, 2022

0.12.1

Sep 11, 2022

0.12.0

Aug 7, 2022

0.12.0b3 pre-release

Aug 6, 2022

0.12.0b2 pre-release

Aug 6, 2022

0.12.0b1 pre-release

Aug 6, 2022

0.11.3

Jul 26, 2022

0.11.2

Jul 22, 2022

0.11.1

Jul 5, 2022

0.11.0

Jun 30, 2022

0.10.3

Jun 26, 2022

0.10.2

Jun 20, 2022

0.10.2b1 pre-release

Jun 20, 2022

0.10.1

Jun 18, 2022

0.9.0

May 31, 2022

0.8.8

May 26, 2022

0.8.7

May 3, 2022

0.8.6

Apr 27, 2022

0.8.5

Apr 24, 2022

0.8.4

Apr 12, 2022

0.8.3

Apr 10, 2022

0.8.2

Apr 9, 2022

0.8.1

Apr 2, 2022

0.8.0

Apr 2, 2022

0.7.2

Apr 1, 2022

0.7.1

Mar 31, 2022

0.7.0

Mar 24, 2022

0.6.8

Mar 23, 2022

0.6.7

Mar 20, 2022

0.6.6

Mar 10, 2022

0.6.5

Mar 10, 2022

0.6.4

Mar 7, 2022

0.6.3

Mar 3, 2022

0.6.2

Mar 2, 2022

0.6.1

Feb 26, 2022

0.6.0

Feb 26, 2022

0.5.5

Feb 24, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

cargo_zigbuild-0.18.4-py3-none-win_arm64.whl (888.4 kB view details)

Uploaded Apr 24, 2024 Python 3 Windows ARM64

cargo_zigbuild-0.18.4-py3-none-win_amd64.whl (902.2 kB view details)

Uploaded Apr 24, 2024 Python 3 Windows x86-64

cargo_zigbuild-0.18.4-py3-none-win32.whl (833.0 kB view details)

Uploaded Apr 24, 2024 Python 3 Windows x86

cargo_zigbuild-0.18.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (928.1 kB view details)

Uploaded Apr 24, 2024 Python 3 manylinux: glibc 2.17+ ARMv7l

cargo_zigbuild-0.18.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (982.0 kB view details)

Uploaded Apr 24, 2024 Python 3 manylinux: glibc 2.17+ ARM64

cargo_zigbuild-0.18.4-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl (1.0 MB view details)

Uploaded Apr 24, 2024 Python 3 manylinux: glibc 2.5+ x86-64

cargo_zigbuild-0.18.4-py3-none-manylinux_2_5_i686.manylinux1_i686.whl (1.1 MB view details)

Uploaded Apr 24, 2024 Python 3 manylinux: glibc 2.5+ i686

cargo_zigbuild-0.18.4-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl (1.9 MB view details)

Uploaded Apr 24, 2024 Python 3 macOS 10.12+ universal2 (ARM64, x86-64) macOS 10.12+ x86-64 macOS 11.0+ ARM64

File details

Details for the file cargo_zigbuild-0.18.4-py3-none-win_arm64.whl.

File metadata

Download URL: cargo_zigbuild-0.18.4-py3-none-win_arm64.whl
Upload date: Apr 24, 2024
Size: 888.4 kB
Tags: Python 3, Windows ARM64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.5.1

File hashes

Hashes for cargo_zigbuild-0.18.4-py3-none-win_arm64.whl
Algorithm	Hash digest
SHA256	`12fa2c181c18be7fbfcac59ea779910beefb47dcfbfe125410a0521a6497d943`
MD5	`ed8f6afed66ef5ef1b55d83bebf069d8`
BLAKE2b-256	`de98a485ea2a1096f36770ff2f90fd8206379918093c6541913629e740132c87`

See more details on using hashes here.

File details

Details for the file cargo_zigbuild-0.18.4-py3-none-win_amd64.whl.

File metadata

Download URL: cargo_zigbuild-0.18.4-py3-none-win_amd64.whl
Upload date: Apr 24, 2024
Size: 902.2 kB
Tags: Python 3, Windows x86-64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.5.1

File hashes

Hashes for cargo_zigbuild-0.18.4-py3-none-win_amd64.whl
Algorithm	Hash digest
SHA256	`bdab564f6625566f681706c34ed7578afb14affd27243f609cb3da4abb72c7de`
MD5	`80d8ecc0dc5a093b012488da778234bb`
BLAKE2b-256	`55aec930af36a752fecec8e236c430643935dbc288a08418e7f6665b56add936`

See more details on using hashes here.

File details

Details for the file cargo_zigbuild-0.18.4-py3-none-win32.whl.

File metadata

Download URL: cargo_zigbuild-0.18.4-py3-none-win32.whl
Upload date: Apr 24, 2024
Size: 833.0 kB
Tags: Python 3, Windows x86
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.5.1

File hashes

Hashes for cargo_zigbuild-0.18.4-py3-none-win32.whl
Algorithm	Hash digest
SHA256	`4e5079021df7139a23e7405bd023ee3c9b0030520d80705c4d7c1ec1e9f22118`
MD5	`5c1c170ccdf92cc5ca7dd873df97b51e`
BLAKE2b-256	`15ad255f18930b2ae699aa9d03c7c9e1659dc7af664ed909d0b3324e44bf421a`

See more details on using hashes here.

File details

Details for the file cargo_zigbuild-0.18.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl.

File metadata

Download URL: cargo_zigbuild-0.18.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Upload date: Apr 24, 2024
Size: 928.1 kB
Tags: Python 3, manylinux: glibc 2.17+ ARMv7l
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.5.1

File hashes

Hashes for cargo_zigbuild-0.18.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm	Hash digest
SHA256	`766a36b8bdd54e2c7232fddda31c203c74601540d56acf3b9d443cd94a47dd53`
MD5	`3d289dffa0f1a2e9af9a42a40fca579d`
BLAKE2b-256	`b7dc8ed1c0e9c996926e0713bf7dcec6a981fba2079c1c45c1434ebbdda60cfc`

See more details on using hashes here.

File details

Details for the file cargo_zigbuild-0.18.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

Download URL: cargo_zigbuild-0.18.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Upload date: Apr 24, 2024
Size: 982.0 kB
Tags: Python 3, manylinux: glibc 2.17+ ARM64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.5.1

File hashes

Hashes for cargo_zigbuild-0.18.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm	Hash digest
SHA256	`cc9b0b2919e2c7e972d5dcdac4eaec7bf0c37e1d00caefe5cf75cf1d26fc824e`
MD5	`7d9bdd3b1f52404f131ce9ca7597f356`
BLAKE2b-256	`de9901f32961ec723776ddcdf966ad12d601af0b1eaec5dff4a23d8c9ff88517`

See more details on using hashes here.

File details

Details for the file cargo_zigbuild-0.18.4-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl.

File metadata

Download URL: cargo_zigbuild-0.18.4-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl
Upload date: Apr 24, 2024
Size: 1.0 MB
Tags: Python 3, manylinux: glibc 2.5+ x86-64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.5.1

File hashes

Hashes for cargo_zigbuild-0.18.4-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl
Algorithm	Hash digest
SHA256	`5d5ba79436bbac60955f2c773ba6790c1f602a3876e292c2d4634e308a0fc3d8`
MD5	`bfa6068045e17d1e8e3a354c207c3a25`
BLAKE2b-256	`67aa448bb07c4e82414cd9f444a0e3ea1d30d70beb3f451c11519c22b6aa4284`

See more details on using hashes here.

File details

Details for the file cargo_zigbuild-0.18.4-py3-none-manylinux_2_5_i686.manylinux1_i686.whl.

File metadata

Download URL: cargo_zigbuild-0.18.4-py3-none-manylinux_2_5_i686.manylinux1_i686.whl
Upload date: Apr 24, 2024
Size: 1.1 MB
Tags: Python 3, manylinux: glibc 2.5+ i686
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.5.1

File hashes

Hashes for cargo_zigbuild-0.18.4-py3-none-manylinux_2_5_i686.manylinux1_i686.whl
Algorithm	Hash digest
SHA256	`a762f957b2e3fd5537ed3395aaae31361171ab3532e9a59466d4807ae77c2aea`
MD5	`aea6bfd0e356b89efb19aab385bd85cc`
BLAKE2b-256	`775c14e41c064dd716a3a8d816fbe262ccaa7bf7522e185b02beb9fe9bc38b31`

See more details on using hashes here.

File details

Details for the file cargo_zigbuild-0.18.4-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl.

File metadata

Download URL: cargo_zigbuild-0.18.4-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Upload date: Apr 24, 2024
Size: 1.9 MB
Tags: Python 3, macOS 10.12+ universal2 (ARM64, x86-64), macOS 10.12+ x86-64, macOS 11.0+ ARM64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.5.1

File hashes

Hashes for cargo_zigbuild-0.18.4-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm	Hash digest
SHA256	`f976ca4c8b89aa2fe1938ec0c518f19660eccf8071ca61a48639422a4db82e09`
MD5	`9cd2c6f5c1ae3251e01eb07ac57a4aa3`
BLAKE2b-256	`101c74d180285919c690683f729e99a0d68e2e8da3e3cfae286a0ccace79fc32`