Makefile build options do not generate static binaries #94

atc0005 · 2020-10-02T23:17:33Z

I learned today that what I've been using isn't sufficient to the task:

Line 45 in 50c2fd5

    
           BUILDCMD				=	go build -mod=vendor -a -ldflags="-s -w -X $(VERSION_VAR_PKG).version=$(VERSION)"

This was the recommended set:

GOOS=linux go build -tags 'osusergo netgo'

ldflags options were not mentioned, but presumably will still be needed if we want to strip out debugging information.

Credit:

cmd/go: build: add -static flag golang/go#26492 (comment)

EDIT: See also golang/go#38789 (comment) (may be needed for CGO builds)

The text was updated successfully, but these errors were encountered:

atc0005 · 2020-10-03T09:39:39Z

diff --git a/Makefile b/Makefile
index 622cc88..d45ec58 100644
--- a/Makefile
+++ b/Makefile
@@ -42,7 +42,7 @@ VERSION                               = $(shell git describe --always --long --dirty)

 # The default `go build` process embeds debugging information. Building
 # without that debugging information reduces the binary size by around 28%.
-BUILDCMD                               =       go build -mod=vendor -a -ldflags="-s -w -X $(VERSION_VAR_PKG).version=$(VERSION)"
+BUILDCMD                               =       go build -mod=vendor -tags 'osusergo netgo' -a -ldflags="-s -w -X $(VERSION_VAR_PKG).version=$(VERSION)"
 GOCLEANCMD                             =       go clean -mod=vendor ./...
 GITCLEANCMD                            =       git clean -xfd
 CHECKSUMCMD                            =       sha256sum -b

This seems (as advertised) to produce the intended effect.

There are a ton of build options available, but I do not feel I am knowledgeable enough to pick the rights ones for all projects. For now, I'll probably want to limit the number of changes I made to just the ones here until I can learn of further issues.

I'll keep an eye on upstream issue 26492 and pivot build options across projects that I maintain accordingly.

The previous build command produces dynamic executables instead of the intended (but not well noted in the Makefile) static executables. This commit includes changes noted in upstream `golang/go` issues which appear to work as intended for others. - refs GH-94 - refs golang/go#38789 - refs golang/go#26492

atc0005 · 2020-10-03T10:40:21Z

At least for this project, setting CGO_ENABLED=0 is sufficient to generate a static binary. I suspect that won't work for the atc0005/mysql2sqlite project which currently uses a CGO-required SQLite package.

atc0005 · 2020-10-03T10:54:51Z

At least for this project, setting CGO_ENABLED=0 is sufficient to generate a static binary. I suspect that won't work for the atc0005/mysql2sqlite project which currently uses a CGO-required SQLite package.

Specifying CGO_ENABLED=0 produced failures:

WARN[0000] github.com/atc0005/mysql2sqlite/internal/dbqs.VerifyDBConn: attempt 1 of 6 to verify database connection failed: Binary was compiled with 'CGO_ENABLED=0', go-sqlite3 requires cgo to work. This is a stub

atc0005 · 2020-10-03T12:48:15Z

Using this set of options:

go build -mod=vendor -tags 'osusergo,netgo' -a -ldflags "-linkmode=external -extldflags '-static' -s -w -X $(VERSION_VAR_PKG).version=$(VERSION)"

within an Ubuntu 18.04 LTS (WSL) environment produces this output:

Building release assets for linux ...
Building check_imap_mailbox 386 binaries
# github.com/atc0005/check-mail/cmd/check_imap_mailbox
loadinternal: cannot find runtime/cgo
/usr/local/go/pkg/tool/linux_amd64/link: running gcc failed: exit status 1
/usr/bin/ld: cannot find crt1.o: No such file or directory
/usr/bin/ld: cannot find crti.o: No such file or directory
/usr/bin/ld: skipping incompatible /usr/lib/gcc/x86_64-linux-gnu/7/libgcc.a when searching for -lgcc
/usr/bin/ld: cannot find -lgcc
/usr/bin/ld: skipping incompatible /usr/lib/gcc/x86_64-linux-gnu/7/libgcc_eh.a when searching for -lgcc_eh
/usr/bin/ld: cannot find -lgcc_eh
/usr/bin/ld: skipping incompatible //usr/lib/x86_64-linux-gnu/libc.a when searching for -lc
/usr/bin/ld: cannot find -lc
collect2: error: ld returned 1 exit status

Makefile:184: recipe for target 'linux' failed
make: *** [linux] Error 2

Running sudo apt-get install gcc-multilib and then re-running the Makefile build succeeded, somewhat?

$ make clean && make linux && file release_assets/*/*-linux-amd64
Removing object files and cached files ...
Removing any existing release assets
Building release assets for linux ...
Building check_imap_mailbox 386 binaries
# github.com/atc0005/check-mail/cmd/check_imap_mailbox
loadinternal: cannot find runtime/cgo
Building check_imap_mailbox amd64 binaries
# github.com/atc0005/check-mail/cmd/check_imap_mailbox
loadinternal: cannot find runtime/cgo
Generating check_imap_mailbox checksum files
Completed build tasks for linux
release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-amd64: ELF 64-bit LSB executable, x86-64, version 1 (GNU/Linux), statically linked, for GNU/Linux 3.2.0, BuildID[sha1]=5ed02616b8d173f94b435db5418f77c1ed3beb71, stripped

atc0005 · 2020-10-03T12:50:28Z

Setting CGO_ENABLED=1 did not appear to make a difference.

atc0005 · 2020-10-03T12:59:38Z

$ make clean && CGO_ENABLED=1 make linux && file release_assets/*/*-linux-{386,amd64}
Removing object files and cached files ...
Removing any existing release assets
removed 'release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-amd64'
removed 'release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-386'
removed 'release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-amd64.sha256'
removed 'release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-386.sha256'
Building release assets for linux ...
Building check_imap_mailbox 386 binaries
# github.com/atc0005/check-mail/cmd/check_imap_mailbox
loadinternal: cannot find runtime/cgo
Building check_imap_mailbox amd64 binaries
# github.com/atc0005/check-mail/cmd/check_imap_mailbox
loadinternal: cannot find runtime/cgo
Generating check_imap_mailbox checksum files
Completed build tasks for linux
release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-386:   ELF 32-bit LSB executable, Intel 80386, version 1 (GNU/Linux), statically linked, for GNU/Linux 3.2.0, BuildID[sha1]=d34d60c6d2461ba5a2edd873fd500d0bc426045a, stripped
release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-amd64: ELF 64-bit LSB executable, x86-64, version 1 (GNU/Linux), statically linked, for GNU/Linux 3.2.0, BuildID[sha1]=5ed02616b8d173f94b435db5418f77c1ed3beb71, stripped

atc0005 · 2020-10-03T13:17:18Z

Attempting to run the binary fails spectacularly:

$ release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-amd64 --help
Trace/breakpoint trap (core dumped)

Dropping back to this build command works:

go build -mod=vendor -tags 'osusergo,netgo' -a -ldflags "-extldflags '-static' -s -w -X $(VERSION_VAR_PKG).version=$(VERSION)"

and seems to produce the intended effect:

release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-386:   ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV), statically linked, stripped
release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-amd64: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, stripped

atc0005 · 2020-10-03T13:19:40Z

Dropping back to this build command works:

go build -mod=vendor -tags 'osusergo,netgo' -a -ldflags "-extldflags '-static' -s -w -X $(VERSION_VAR_PKG).version=$(VERSION)"

and seems to produce the intended effect

This is useful; I ended up submitting this as GH-95 a few hours ago.

For the time being this may have to be the "fix" until I learn a better way. I've already spent far too long on this one item.

atc0005 · 2020-10-03T13:23:02Z

Attempting to run the binary fails spectacularly:

$ release_assets/check_imap_mailbox/check_imap_mailbox-v0.2.4-17-g43a5535-dirty-linux-amd64 --help
Trace/breakpoint trap (core dumped)

This might be due to the WSL environment.

golang/go#14795

Either way, not worth fighting with right now.

The previous build command produces dynamic executables instead of the intended (but not well noted in the Makefile) static executables. This commit includes changes noted in upstream `golang/go` issues which appear to work as intended for others. I also include doc comments and reference links describing the use of the updated build options list and some problems that I encountered during testing of `linkmode=external`. - refs GH-94 - refs golang/go 38789 - refs golang/go 26492

atc0005 · 2020-10-06T12:10:43Z

Dropping back to this build command works:
go build -mod=vendor -tags 'osusergo,netgo' -a -ldflags "-extldflags '-static' -s -w -X $(VERSION_VAR_PKG).version=$(VERSION)"
and seems to produce the intended effect

This is useful; I ended up submitting this as GH-95 a few hours ago.

For the time being this may have to be the "fix" until I learn a better way. I've already spent far too long on this one item.

Update:

I'm still digging into whether glibc is actually compiled into the static binary and how I would identify/confirm that. atc0005/mysql2sqlite#48 is tracking some of the research.

It appears that the static binaries do not contain glibc if you could the omission of (GNU/Linux), statically linked, for GNU/Linux 3.2.0 from the file output as such an indication (I still don't know).

FWIW:

https://play.golang.org/p/rr0hjBBDqhy

As far as I can tell, the v0.2.5 release provided binaries that are *not* statically linked against glibc and thus would not be held to LGPL license requirements. AFAICT. Update Makefile to disable use of cgo for binary generation in an effort to avoid potential inclusion in the future. This is likely *not* the last time I'll need to update the Makefile build options for static binary generation, but hopefully this will do for now. refs #94 refs atc0005/mysql2sqlite#48

The previous build command produces dynamic executables instead of the intended (but not well noted in the Makefile) static executables. This commit includes changes noted in upstream `golang/go` issues which appear to work as intended for others. I also include doc comments and reference links describing the use of the updated build options list and some problems that I encountered during testing of `linkmode=external`. - refs GH-92 - refs atc0005/check-mail#94 - refs atc0005/check-mail#95 - refs atc0005/check-mail#101 - refs golang/go 38789 - refs golang/go 26492

atc0005 added bug Something isn't working builds labels Oct 2, 2020

atc0005 added this to the v0.2.5 milestone Oct 2, 2020

atc0005 self-assigned this Oct 2, 2020

atc0005 added this to TODO in Update static binary generation in Go project Makefiles via automation Oct 2, 2020

atc0005 changed the title ~~Update Makefile build options to generate static binaries~~ Makefile build options do not generate static binaries Oct 3, 2020

atc0005 changed the title ~~Makefile build options do not generate static binaries~~ Makefile build options does not generate static binaries Oct 3, 2020

atc0005 mentioned this issue Oct 3, 2020

Fix Makefile build cmd to create static binaries #95

Merged

atc0005 closed this as completed in #95 Oct 3, 2020

Update static binary generation in Go project Makefiles automation moved this from TODO to Done Oct 3, 2020

atc0005 changed the title ~~Makefile build options does not generate static binaries~~ Makefile build options do not generate static binaries Oct 3, 2020

atc0005 mentioned this issue Oct 6, 2020

Explicitly disable use of cgo #101

Merged

atc0005 added the license label Oct 6, 2020

This was referenced Oct 7, 2020

Fix Makefile build cmd to create static binaries atc0005/check-cert#96

Merged

Add images for building static, cgo-enabled projects atc0005/go-ci#85

Closed

Go | Docker | Build static binary using musl C library atc0005/notes#35

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Makefile build options do not generate static binaries #94

Makefile build options do not generate static binaries #94

atc0005 commented Oct 2, 2020 •

edited

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 6, 2020

Makefile build options do not generate static binaries #94

Makefile build options do not generate static binaries #94

Comments

atc0005 commented Oct 2, 2020 • edited

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 3, 2020

atc0005 commented Oct 6, 2020

atc0005 commented Oct 2, 2020 •

edited