chore/docs: enable cgo as much as possible by mzz2017 · Pull Request #564 · daeuniverse/dae

mzz2017 · 2024-06-24T18:25:46Z

Background

根据 #557 所述，应尽量开启 CGO。对于跨平台移植性，使用 static link 来保证。因此检查 musl-gcc 和 zig 的可用性并调整 CC 进行 static link。

Checklist

The Pull Request has been fully tested
There's an entry in the CHANGELOGS
There is a user-facing docs PR against https://github.com/daeuniverse/dae

Full Changelogs

[Implement ...]

Issue Reference

Closes #557

Test Result

jschwinger233

tql! GNU/make 权威指南！

douglarek · 2024-06-27T02:26:52Z

Forgive my frankness, but this PR is adding unprecedented complexity to the build. For proprietary builds of various distributions, using CGO is a given fact. This PR wants to cover all possible CGO builds, which doesn't seem very necessary. I think it's unnecessary to make a big fuss over a rare DNS resolution issue; a document explanation or emphasis would suffice.

mzz2017 · 2024-06-27T04:09:36Z

@douglarek 从用户的角度来说，如果没有安装两个工具，行为是和之前一样的，不是强制的。只是尽量在工具存在的情况下绕过glibc进行静态编译

mzz2017 · 2024-06-27T04:17:13Z

@douglarek CGO_ENABLED=0 可能会带来其他潜在问题，另外由关闭 cgo 导致的 dns 解析失败的问题很难排查，考虑到用户的环境复杂度，使用 libc 而不是 pure go 实现将问题复杂度从用户转移给更为专业的打包者我认为是可接受的。
欢迎大家进行讨论，特别是用户和打包者等不同角色的参与。

douglarek · 2024-06-27T06:28:46Z

另外由关闭 cgo 导致的 dns 解析失败的问题很难排查

How about outputting whether a cgo is enabled in the version information? like this:

dae version 0.7.0rc1.r5.g64ebfea
go runtime go1.22.4 linux/amd64
CGO: enabled
Copyright (c) 2022-2024 @daeuniverse
License GNU AGPLv3 <https://github.com/daeuniverse/dae/blob/main/LICENSE>

if not:

dae version 0.7.0rc1.r5.g64ebfea
go runtime go1.22.4 linux/amd64
CGO: disabled (perhaps it will cause some dns issues)
Copyright (c) 2022-2024 @daeuniverse
License GNU AGPLv3 <https://github.com/daeuniverse/dae/blob/main/LICENSE>

mzz2017 · 2024-06-29T03:26:51Z

@douglarek What about the following compromise:

Only statically link in CI/Dockerfile instead of make manually
Revert related modification in Makefile
Use musl-cross for static link instead of zig cc
Give a docs to explain how to statically link

douglarek · 2024-06-29T09:32:29Z

Only statically link in CI/Dockerfile instead of make manually

I think this is quite good; the binary released by the project can make such guarantees. However, when it comes to users compiling on their own, they can decide for themselves. ~~For actual distribution packaging, relying on glibc to enable cgo is a very normal operation.~~

see: daeuniverse/dae#564

douglarek · 2024-06-29T10:19:43Z

Numb, it seems that enabling CGO on amd64 causes node domain name resolution issues.

CGO_ENABLED=1 BUILD_ARGS="-buildmode=pie -modcacherw" CFLAGS="-fno-stack-protector" make VERSION="${pkgver}"

level=info msg="Include config files: [/etc/dae/config.dae]"
level=info msg="Loading eBPF programs and maps into the kernel..."
level=info msg="The loading process takes about 120MB free memory, which will be released after loading. Insufficient memory will cause loading failure."
level=info msg="Loaded eBPF programs and maps"
level=info msg="Bind to LAN: docker0"
level=info msg="Bind to LAN: virbr0"
level=info msg="Bind to WAN: enp5s0"
level=info msg="failed to parse node: create hy2://xxx@a.b.c: lookup a.b.c: Temporary failure in name resolution"
level=info msg="Group "final" node list:"
level=info msg="        <Empty>"
level=info msg="Group "us" node list:"
level=info msg="        <Empty>"
level=info msg="Routing match set len: 26/64"

Integral-Tech · 2024-12-29T11:45:35Z

cgo_enabled.mk

+    ifdef CGO_ENABLED_NDEF
+        export CGO_ENABLED := 0
+    endif


Suggested change

ifdef CGO_ENABLED_NDEF

export CGO_ENABLED := 0

endif

export CGO_ENABLED ?= 0

Integral-Tech · 2024-12-29T11:52:00Z

cgo_enabled.mk

+    ifeq ($(CGO_ENABLED),0)
+        ifdef GOARCH_NDEF
+            ifeq ($(CC),cc)
+                ifneq ($(shell which musl-gcc),)


Using command -v is better than which when checking the existence of executable, as it is a UNIX-compatible built-in command.
Reference: https://stackoverflow.com/questions/592620/how-can-i-check-if-a-program-exists-from-a-bash-script

Suggested change

ifneq ($(shell which musl-gcc),)

ifneq ($(shell command -v musl-gcc),)

Integral-Tech · 2024-12-29T11:52:27Z

cgo_enabled.mk

+            ifeq ($(CC),cc)
+                ifneq ($(shell which musl-gcc),)
+                    export CC := musl-gcc
+                else ifneq ($(shell which zig),)


Suggested change

else ifneq ($(shell which zig),)

else ifneq ($(shell command -v zig),)

Integral-Tech · 2024-12-29T11:52:51Z

cgo_enabled.mk

+                    $(info ! CGO_ENABLED=0 is not recommended. Please consider to install musl-gcc for static link instead. See https://github.com/daeuniverse/dae/issues/557)
+                endif
+            endif
+        else ifneq ($(shell which zig),)


Suggested change

else ifneq ($(shell which zig),)

else ifneq ($(shell command -v zig),)

command -v 在 /bin/sh 能用吗

@mzz2017 I can confirm command -v works in sh.

st0nie · 2025-01-14T16:08:16Z

Numb, it seems that enabling CGO on amd64 causes node domain name resolution issues.

reproduced on my machine

mzz2017 added 6 commits June 25, 2024 00:38

chore: enable CGO and static link

70c62d6

chore: rework Dockerfile

2b9a405

chore: support cross compilation

c2b5acb

chore: setup zig

2ff3c10

chore: fix KEEP_CGO_ENVS

201dd45

chore: abuse spaces for cgo_enabled.mk

1a6ea54

mzz2017 requested review from a team as code owners June 24, 2024 18:25

dae-prow bot assigned mzz2017 Jun 24, 2024

dae-prow bot added the chore label Jun 24, 2024

mzz2017 added 2 commits June 25, 2024 02:26

fix typo

c3b69c7

Update Makefile

4539f38

mzz2017 added the documentation Improvements or additions to documentation label Jun 25, 2024

mzz2017 changed the title ~~chore: enable cgo as much as possible~~ chore/docs: enable cgo as much as possible Jun 25, 2024

jschwinger233 approved these changes Jun 25, 2024

View reviewed changes

archlinux-github pushed a commit to archlinux/aur that referenced this pull request Jun 29, 2024

chore: ignore local environment to enable cgo

ede8058

see: daeuniverse/dae#564

mzz2017 marked this pull request as draft June 30, 2024 11:27

Integral-Tech reviewed Dec 29, 2024

View reviewed changes

daeuniverse deleted a comment from mzz2017 Dec 29, 2024

	ifneq ($(shell which musl-gcc),)
	ifneq ($(shell command -v musl-gcc),)

	else ifneq ($(shell which zig),)
	else ifneq ($(shell command -v zig),)

Conversation

mzz2017 commented Jun 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Background

Checklist

Full Changelogs

Issue Reference

Test Result

Uh oh!

jschwinger233 left a comment

Choose a reason for hiding this comment

Uh oh!

douglarek commented Jun 27, 2024

Uh oh!

mzz2017 commented Jun 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mzz2017 commented Jun 27, 2024

Uh oh!

douglarek commented Jun 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mzz2017 commented Jun 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

douglarek commented Jun 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

douglarek commented Jun 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Integral-Tech Dec 29, 2024

Choose a reason for hiding this comment

Uh oh!

Integral-Tech Dec 29, 2024

Choose a reason for hiding this comment

Uh oh!

Integral-Tech Dec 29, 2024

Choose a reason for hiding this comment

Uh oh!

Integral-Tech Dec 29, 2024

Choose a reason for hiding this comment

Uh oh!

mzz2017 Dec 29, 2024

Choose a reason for hiding this comment

Uh oh!

Integral-Tech Dec 29, 2024

Choose a reason for hiding this comment

Uh oh!

st0nie commented Jan 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mzz2017 commented Jun 24, 2024 •

edited

Loading

mzz2017 commented Jun 27, 2024 •

edited

Loading

douglarek commented Jun 27, 2024 •

edited

Loading

mzz2017 commented Jun 29, 2024 •

edited

Loading

douglarek commented Jun 29, 2024 •

edited

Loading

douglarek commented Jun 29, 2024 •

edited

Loading