.github, config: use Zig to cross compile arm64 Linux asset #460

ee7 · 2021-10-26T20:32:30Z

See:

https://ziglang.org/learn/overview/#cross-compiling-is-a-first-class-use-case
https://andrewkelley.me/post/zig-cc-powerful-drop-in-replacement-gcc-clang.html (Ctrl+f for "a programming language" to see a Nim shout-out)
https://ziglang.org/download/0.11.0/release-notes.html#Support-Table
https://www.uber.com/blog/bootstrapping-ubers-infrastructure-on-arm64-with-zig/
YouTube: The Road to Zig 1.0 - Andrew Kelley (in particular, see the part from 37:45 until 42:15).
YouTube: How Zig is used at Uber - Motiejus Jakštys (Uber uses zig cc)
YouTube: Making Uber's hermetic C++ toolchain
YouTube: Zig Roadmap 2023 - Andrew Kelley

Refs: #24
Refs: #122
Refs: #764

2023-08-15: The build workflow ran successfully and created a release which has a linux_arm64 asset.

To-do:

configlet.nimble

config.nims

ee7 · 2021-12-11T23:15:26Z

I'll defer this at least until Zig 0.9.0 is released (expected 2021-12-20 - see https://github.com/ziglang/zig/milestone/11).

ee7 · 2021-12-21T10:21:20Z

Zig 0.9.0 was released. See https://ziglang.org/download/0.9.0/release-notes.html

https://snapcraft.io/zig was also updated.

ee7 · 2022-04-15T12:51:17Z

Possible different approach for this PR: rather than using zig to build the critical release asset, use it to cross-compile some new release assets.

ErikSchierboom · 2022-04-15T13:11:37Z

Let me know when you want a review

With the Zig 0.9.0 release (2021-12-20), the configlet binary now has 30 KiB of bloat in the comment section, repeating the clang version many times. Before this commit: $ readelf -p .comment ./configlet String dump of section '.comment': [ 0] clang version 13.0.1 (git@github.com:ziglang/zig-bootstrap.git 74211dd7f7e7174a2027641dfcfdb3fc5df62f0c) [...] (repeat for 30 KB) [ 7969] clang version 13.0.1 (git@github.com:ziglang/zig-bootstrap.git 74211dd7f7e7174a2027641dfcfdb3fc5df62f0c) [ 79d2] Linker: LLD 13.0.1 (git@github.com:ziglang/zig-bootstrap.git 74211dd7f7e7174a2027641dfcfdb3fc5df62f0c) Binary size profile before this commit: FILE SIZE VM SIZE -------------- -------------- 75.2% 368Ki 64.5% 368Ki .text 0.0% 0 19.6% 111Ki .bss 18.2% 89.1Ki 15.6% 89.1Ki .rodata 6.2% 30.6Ki 0.0% 0 .comment 0.2% 816 0.1% 824 .data 0.1% 640 0.0% 0 [ELF Section Headers] 0.1% 392 0.1% 392 [ELF Program Headers] 0.0% 64 0.0% 64 [ELF Header] 0.0% 63 0.0% 0 .shstrtab 0.0% 8 0.0% 8 .got 0.0% 8 0.0% 8 [LOAD #1 [R]] 0.0% 4 0.0% 3 .fini 0.0% 3 0.0% 3 .init 100.0% 489Ki 100.0% 570Ki TOTAL Strip the comment section. But print it first.

With Zig 0.10.0 (2022-10-31), `zig cc` now properly uses the `--passL: -s` option that we use in `config.nims`. So we can remove the `-s` flag from our post-build hook. From the Zig 0.10.0 release notes [1]: `zig cc` is Zig's drop-in C compiler tool. Enhancements in this release: [...] - Integration with more linker args: - `--whole-archive`, `-whole-archive` - `--no-whole-archive`, `-no-whole-archive` - `-s`, `--strip-all` - `-S`, `--strip-debug` [...] [1] https://ziglang.org/download/0.10.0/release-notes.html#zig-cc

And install Zig via script, rather than snap. One benefit is that it allows us to pin a Zig version. The script is adapted from one I added to the Exercism Zig repo [1]. [1] exercism/zig@9dfb95f031b1

`strip` can't strip a non-native executable.

--os:macos produced the error: /home/runner/work/configlet/configlet/nimdir/lib/system/dyncalls.nim(198, 10) Error: no implementation for dyncalls

@m

Try to resolve error: error: LTO is not yet supported with the Mach-O object format. More details: ziglang/zig#8680 Error: execution of an external compiler program 'zigcc -c -w -ferror-limit=3 -pthread -target aarch64-macos-none -flto -Os -I/home/runner/work/configlet/configlet/nimdir/lib -I/home/runner/work/configlet/configlet/src -o /home/runner/.cache/nim/configlet_r/@m..@snimdir@slib@ssystem@sctypes.nim.c.o /home/runner/.cache/nim/configlet_r/@m..@snimdir@slib@ssystem@sctypes.nim.c' failed with exit code: 1

ee7 · 2023-08-14T20:06:57Z

I've made some good progress on this. I think I've got working cross-compilation to arm64-linux.

The build workflow ran successfully and created a release which has a linux_arm64 asset.

But cross-compiling from x86_64-Linux to arm64-macos produces the error:

CC: ../nimdir/lib/std/sysrand.nim
/home/runner/.cache/nim/configlet_r/@m..@snimdir@slib@sstd@ssysrand.nim.c:9:10: fatal error: 'Security/SecRandom.h' file not found
#include <Security/SecRandom.h>

This is a consequence of 53a75a2. I guess we can defer arm64-macos till a later PR, or either:

implement custom reading from /dev/urandom when compiling for macos.
cross-compile from x86_64-macos to arm64-macos
download the missing files like SecRandom.h

@m

Disable until we can resolve the error CC: ../nimdir/lib/std/sysrand.nim /home/runner/.cache/nim/configlet_r/@m..@snimdir@slib@sstd@ssysrand.nim.c:9:10: fatal error: 'Security/SecRandom.h' file not found which is due to a recent commit [1]. [1] 53a75a2 ("nimble, uuid: generate UUIDs via std/sysrand, not pragmagic/uuids", 2023-08-07)

ee7 · 2023-08-14T20:26:33Z

.github/bin/cross-compile

+  nimble --verbose build --cpu:"${arch}" --os:"${os}" -d:release -d:zig -d:target:"${target}"
+
+  mkdir -p "${artifacts_dir}"
+
+  local binary_name='configlet'
+
+  local artifact_file="${artifacts_dir}/${binary_name}_${build_tag}_${os}_${arch}.tar.gz"
+  tar -cvzf "${artifact_file}" "${binary_name}"
+}
+
+main() {
+  nimble --accept install --depsOnly
+
+  local targets=(
+    aarch64-linux-musl
+    # aarch64-macos-none
+  )
+
+  for target in "${targets[@]}"; do
+    cross_compile "${target}"
+  done
+
+  gh release upload "${build_tag}" "${artifacts_dir}"/*


This duplicates some logic from the existing:

.github/bin/build

.github/bin/create-artifact

.github/bin/publish-release

because they're difficult to adapt for cross-compilation with their current factoring.

I think this will be easier to clean up when we've improved the build process to resolve #551.

configlet.nimble

This probably won't work immmediately.

ErikSchierboom

This is a consequence of 53a75a2. I guess we can defer arm64-macos till a later PR, or either:

implement custom reading from /dev/urandom when compiling for macos.
cross-compile from x86_64-macos to arm64-macos
download the missing files like SecRandom.h

I'm fine with whatever works best for you. I'm also fine to do it in a follow-up PR

Our `strip` doesn't support elf64-aarch64 as a target, and `zig objcopy` doesn't have a `-R, --remove-section` option. Use llvm-strip when it's installed.

Format with shfmt -i 2 -sr -kp -ci -w ./cross-compile

ee7 commented Oct 27, 2021

View reviewed changes

configlet.nimble Outdated Show resolved Hide resolved

ee7 marked this pull request as ready for review October 27, 2021 07:34

ee7 requested a review from ErikSchierboom as a code owner October 27, 2021 07:34

ErikSchierboom approved these changes Oct 27, 2021

View reviewed changes

config.nims Outdated Show resolved Hide resolved

ee7 marked this pull request as draft December 11, 2021 23:15

ee7 force-pushed the build-use-zig branch from 3d210e7 to f59296c Compare December 18, 2021 23:18

ee7 force-pushed the build-use-zig branch from 1c5af8d to 190ebdc Compare January 27, 2022 16:34

ee7 force-pushed the build-use-zig branch from 190ebdc to 44de893 Compare February 18, 2022 11:11

ee7 force-pushed the build-use-zig branch from 44de893 to c0583f1 Compare April 10, 2022 08:46

ee7 mentioned this pull request Apr 21, 2022

build: bump Ubuntu from 20.04 to 22.04 #568

Closed

ee7 force-pushed the build-use-zig branch from c0583f1 to 800a2fa Compare August 15, 2022 08:14

ee7 force-pushed the build-use-zig branch from 800a2fa to 0ab4a12 Compare October 25, 2022 13:23

ee7 changed the title ~~build: use zig for Linux build~~ .github, config, nimble: use zig for Linux build Oct 26, 2022

ee7 force-pushed the build-use-zig branch from de53946 to 622c3da Compare November 12, 2022 11:38

ee7 force-pushed the build-use-zig branch 2 times, most recently from 49fb0bd to 85aba83 Compare August 14, 2023 08:02

ee7 added 7 commits August 14, 2023 17:50

config: support zigcc locally

0546176

.github: support zigcc in CI

4dae1da

nimble: strip zig-built binary via after build hook

bc75361

configlet: improve status message

c4cf6be

.github, config: cross-compile an arm64 asset

0fd7591

And install Zig via script, rather than snap. One benefit is that it allows us to pin a Zig version. The script is adapted from one I added to the Exercism Zig repo [1]. [1] exercism/zig@9dfb95f031b1

ee7 force-pushed the build-use-zig branch from 5835e3a to 0fd7591 Compare August 14, 2023 15:51

ee7 changed the title ~~.github, config, nimble: use zig for Linux build~~ .github, config, nimble: use zig to cross compile for arm64 Aug 14, 2023

nimble: comment-out stripping

abb70ab

`strip` can't strip a non-native executable.

ee7 added 4 commits August 14, 2023 19:07

.github(cross-compile): fix path

8df0f9b

.github(cross-compile): add arm64 macos target

f6aaed8

.github(cross-compile): try --os:macosx

d4403d3

--os:macos produced the error: /home/runner/work/configlet/configlet/nimdir/lib/system/dyncalls.nim(198, 10) Error: no implementation for dyncalls

ee7 commented Aug 14, 2023

View reviewed changes

ee7 requested a review from ErikSchierboom August 14, 2023 20:26

ee7 marked this pull request as ready for review August 14, 2023 20:27

ee7 added 3 commits August 15, 2023 08:49

.github(cross-compile): try aarch64-windows-gnu

83796fe

This probably won't work immmediately.

.github(cross-compile): comment out aarch64-windows-gnu

3f8c8df

.github(cross-compile): fix macos arm64 asset name

21bf654

ErikSchierboom approved these changes Aug 15, 2023

View reviewed changes

ee7 added 3 commits August 15, 2023 20:00

.github(cross-compile): remove some blank lines

67dbdd5

.github(cross-compile), nimble: prepare to strip with llvm-strip

eea45c8

Our `strip` doesn't support elf64-aarch64 as a target, and `zig objcopy` doesn't have a `-R, --remove-section` option. Use llvm-strip when it's installed.

.github(cross-compile): format with shfmt

3e97a25

Format with shfmt -i 2 -sr -kp -ci -w ./cross-compile

ee7 changed the title ~~.github, config, nimble: use zig to cross compile for arm64~~ .github, config: use Zig to cross compile arm64 Linux asset Aug 16, 2023

ee7 merged commit 0e8d665 into exercism:main Aug 16, 2023
6 checks passed

ee7 deleted the build-use-zig branch August 16, 2023 08:33

ee7 mentioned this pull request Aug 16, 2023

build: cross compilation script duplicates some logic #789

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

.github, config: use Zig to cross compile arm64 Linux asset #460

.github, config: use Zig to cross compile arm64 Linux asset #460

ee7 commented Oct 26, 2021 •

edited

Loading

ee7 commented Dec 11, 2021

ee7 commented Dec 21, 2021

ee7 commented Apr 15, 2022

ErikSchierboom commented Apr 15, 2022

ee7 commented Aug 14, 2023 •

edited

Loading

ee7 Aug 14, 2023

ErikSchierboom left a comment

.github, config: use Zig to cross compile arm64 Linux asset #460

.github, config: use Zig to cross compile arm64 Linux asset #460

Conversation

ee7 commented Oct 26, 2021 • edited Loading

ee7 commented Dec 11, 2021

ee7 commented Dec 21, 2021

ee7 commented Apr 15, 2022

ErikSchierboom commented Apr 15, 2022

ee7 commented Aug 14, 2023 • edited Loading

ee7 Aug 14, 2023

Choose a reason for hiding this comment

ErikSchierboom left a comment

Choose a reason for hiding this comment

ee7 commented Oct 26, 2021 •

edited

Loading

ee7 commented Aug 14, 2023 •

edited

Loading