fix: remove ICU runtime dependency from release binaries (#3066)

The gms_pure_go build tag already tells go-mysql-server to use Go's
stdlib regex instead of ICU-backed go-icu-regex. However, .buildflags
and the Makefile were unconditionally injecting ICU linker flags
(including -licui18n -licuuc -licudata on Linux), which re-introduced
the ICU shared-library dependency at link time.

This caused release binaries to require a specific ICU version
(e.g., libicui18n.so.74), making them non-portable across Linux distros
with different ICU versions.

Changes:
- .buildflags: Remove ICU flag injection; only export CGO_ENABLED=1
- Makefile: Replace ICU4C detection block with BUILD_TAGS := gms_pure_go;
  use the tag for all platforms (not just Windows)
- scripts/verify-cgo.sh: Add readelf check to fail if ICU shared-library
  dependency is present in ELF binaries
- scripts/install.sh: Add -tags gms_pure_go to build_from_source()

CGO remains enabled for embedded Dolt support. Only the ICU regex
backend is swapped for Go's stdlib regex, which is sufficient since
bd does not use SQL REGEXP functions.

Amp-Thread-ID: https://ampcode.com/threads/T-019d6450-7b10-77ee-b3d0-58e9474e61da

Co-authored-by: Amp <amp@ampcode.com>
This commit is contained in:
matt wilkie 2026-04-07 09:48:44 -07:00 • committed by GitHub
commit 7916e029bc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 27 additions and 31 deletions

View file

@ -1,14 +1,9 @@
# This file is sourced by scripts to provide standard build flags
# Mirrors Makefile CGO configuration for consistency
# This file is sourced by scripts to provide standard build flags.
# Mirrors Makefile CGO configuration for consistency.
#
# NOTE: ICU flags are NOT set here. The gms_pure_go build tag (used by
# goreleaser and `make build`) tells go-mysql-server to use Go's stdlib
# regex, eliminating the ICU runtime dependency. Only test scripts that
# explicitly need ICU (test-cgo.sh) should set ICU flags.
export CGO_ENABLED=1
# ICU configuration (Homebrew or system)
ICU_PREFIX=$(brew --prefix icu4c 2>/dev/null || true)
if [ -n "$ICU_PREFIX" ]; then
export CGO_CFLAGS="-I${ICU_PREFIX}/include"
export CGO_LDFLAGS="-L${ICU_PREFIX}/lib"
else
export CGO_CFLAGS="-I/usr/include"
export CGO_LDFLAGS="-L/usr/lib/x86_64-linux-gnu -licui18n -licuuc -licudata"
fi

View file

@ -40,30 +40,19 @@ ifneq ($(GO_VERSION),)
export GOTOOLCHAIN := go$(GO_VERSION)
endif
# ICU4C is keg-only in Homebrew (not symlinked into the prefix).
# Dolt's go-icu-regex dependency needs these paths to compile and link.
# This handles both macOS (brew --prefix icu4c) and Linux/Linuxbrew.
# On Windows, ICU is not needed (pure-Go regex via gms_pure_go + regex_windows.go).
ifneq ($(OS),Windows_NT)
ICU_PREFIX := $(shell brew --prefix icu4c 2>/dev/null)
ifneq ($(ICU_PREFIX),)
export CGO_CFLAGS += -I$(ICU_PREFIX)/include
export CGO_CPPFLAGS += -I$(ICU_PREFIX)/include
export CGO_LDFLAGS += -L$(ICU_PREFIX)/lib
# Linuxbrew gcc doesn't install a 'c++' symlink; point CGO at g++
ifeq ($(shell uname),Linux)
export CXX ?= g++
endif
endif
endif
# gms_pure_go tells go-mysql-server to use Go's stdlib regex instead of
# ICU-backed go-icu-regex. This eliminates the ICU shared-library runtime
# dependency, making release binaries portable across Linux distros.
# ICU flags are only needed for test-cgo.sh (which exercises the ICU path).
BUILD_TAGS := gms_pure_go
# Build the bd binary
build:
@echo "Building bd..."
ifeq ($(OS),Windows_NT)
go build -tags gms_pure_go -ldflags="-X main.Build=$(GIT_BUILD)" -o $(BUILD_DIR)/bd.exe ./cmd/bd
go build -tags "$(BUILD_TAGS)" -ldflags="-X main.Build=$(GIT_BUILD)" -o $(BUILD_DIR)/bd.exe ./cmd/bd
else
go build -ldflags="-X main.Build=$(GIT_BUILD)" -o $(BUILD_DIR)/bd ./cmd/bd
go build -tags "$(BUILD_TAGS)" -ldflags="-X main.Build=$(GIT_BUILD)" -o $(BUILD_DIR)/bd ./cmd/bd
ifeq ($(shell uname),Darwin)
@codesign -s - -f $(BUILD_DIR)/bd 2>/dev/null || true
@echo "Signed bd for macOS"

View file

@ -542,7 +542,7 @@ build_from_source() {
cd beads
log_info "Building binary..."
if CGO_ENABLED=1 go build -o bd ./cmd/bd; then
if CGO_ENABLED=1 go build -tags gms_pure_go -o bd ./cmd/bd; then
if ! verify_binary_has_cgo "./bd" "source build"; then
cd - > /dev/null || cd "$HOME"
rm -rf "$tmp_dir"

View file

@ -27,4 +27,16 @@ if strings "$binary_path" | awk '/^build[[:space:]]+CGO_ENABLED=0$/ { found=1 }
exit 1
fi
# On Linux (ELF binaries), verify no ICU shared-library dependency.
# The gms_pure_go build tag should eliminate this; if it appears, the build
# environment leaked ICU flags onto the link line.
if command -v readelf >/dev/null 2>&1; then
if readelf -d "$binary_path" 2>/dev/null | grep -qi 'libicu'; then
echo "ERROR: $binary_path has unexpected ICU runtime dependency" >&2
readelf -d "$binary_path" | grep -i 'libicu' >&2
echo "Ensure the binary is built with -tags gms_pure_go and without ICU CGO_LDFLAGS" >&2
exit 1
fi
fi
echo "OK: $binary_path has CGO support"