Merge pull request #643 from larskanis/binary-macos

Add binary gem for Macos

Author: larskanis

.github/workflows/binary-gems.yml

@@ -28,6 +28,8 @@ jobs:
           - platform: "x64-mingw32"
           - platform: "x86-mingw32"
           - platform: "x86_64-linux"
+          - platform: "x86_64-darwin"
+          - platform: "arm64-darwin"
     steps:
       - uses: actions/checkout@v4
       - name: Set up Ruby
@@ -73,6 +75,12 @@ jobs:
           - os: ubuntu-latest
             ruby: "3.2"
             platform: "x86_64-linux"
+          - os: macos-latest
+            ruby: "3.4"
+            platform: "arm64-darwin"
+          - os: macos-13
+            ruby: "3.4"
+            platform: "x86_64-darwin"
 
     runs-on: ${{ matrix.os }}
     env:

Gemfile

@@ -13,7 +13,7 @@ end
 group :test do
   gem "bundler", ">= 1.16", "< 3.0"
   gem "rake-compiler", "~> 1.0"
-  gem "rake-compiler-dock", "~> 1.8.0"
+  gem "rake-compiler-dock", "~> 1.9.1"
   gem "rspec", "~> 3.5"
   # "bigdecimal" is a gem on ruby-3.4+ and it's optional for ruby-pg.
   # Specs should succeed without it, but 4 examples are then excluded.

Rakefile

@@ -32,7 +32,7 @@ CLEAN.include "lib/*/libpq.dll"
 CLEAN.include "lib/pg_ext.*"
 CLEAN.include "lib/pg/postgresql_lib_path.rb"
 CLEAN.include "ports/*.installed"
-CLEAN.include "ports/*mingw*", "ports/*linux*"
+CLEAN.include "ports/*mingw*", "ports/*linux*", "ports/*darwin*"
 
 Bundler::GemHelper.install_tasks
 $gem_spec = Bundler.load_gemspec(GEMSPEC)
@@ -49,6 +49,8 @@ CrossLibraries = [
 	['x86-mingw32', 'mingw', 'i686-w64-mingw32'],
 	['x64-mingw32', 'mingw64', 'x86_64-w64-mingw32'],
 	['x86_64-linux', 'linux-x86_64', 'x86_64-linux-gnu'],
+	['x86_64-darwin', 'darwin64-x86_64', 'x86_64-apple-darwin'],
+	['arm64-darwin', 'darwin64-arm64', 'arm64-apple-darwin'],
 ].map do |platform, openssl_config, toolchain|
 	CrossLibrary.new platform, openssl_config, toolchain
 end
@@ -76,6 +78,7 @@ Rake::ExtensionTask.new do |ext|
 	# Add libpq.dll/.so to fat binary gemspecs
 	ext.cross_compiling do |spec|
 		spec.files << "ports/#{spec.platform.to_s}/lib/libpq-ruby-pg.so.1" if spec.platform.to_s =~ /linux/
+		spec.files << "ports/#{spec.platform.to_s}/lib/libpq-ruby-pg.1.dylib" if spec.platform.to_s =~ /darwin/
 		spec.files << "ports/#{spec.platform.to_s}/lib/libpq.dll" if spec.platform.to_s =~ /mingw|mswin/
 	end
 end
@@ -96,17 +99,33 @@ task 'gem:native:prepare' do
 	end
 end
 
+task 'install_darwin_mig', [:arch] do |t, args|
+	sh <<~EOT
+		rm -rf bootstrap_cmds &&
+		git clone --branch=cross_platform https://github.com/markmentovai/bootstrap_cmds &&
+		cd bootstrap_cmds &&
+		autoreconf --install &&
+		sh configure &&
+		make &&
+		sed -E -i 's/^cppflags=(.*)/cppflags=(\\1 "-D#{args[:arch]}" "-I\\/opt\\/osxcross\\/target\\/SDK\\/MacOSX11.1.sdk\\/usr\\/include")/' migcom.tproj/mig.sh &&
+		sudo make install
+	EOT
+end
+
 CrossLibraries.each do |xlib|
 	platform = xlib.platform
 	desc "Build fat binary gem for platform #{platform}"
 	task "gem:native:#{platform}" => ['gem:native:prepare'] do
 		RakeCompilerDock.sh <<-EOT, platform: platform
+			#{ "sudo apt-get update && sudo apt-get install -y bison flex &&" if platform =~ /darwin/ }
 			#{ # remove nm on Linux to suppress PostgreSQL's check for exit which raises thread_exit as a false positive:
 				"sudo mv `which nm` `which nm`.bak &&" if platform =~ /linux/ }
 			sudo apt-get update && sudo apt-get install -y bison flex &&
 			(cp build/gem/gem-*.pem ~/.gem/ || true) &&
 			bundle install --local &&
-			rake native:#{platform} pkg/#{$gem_spec.full_name}-#{platform}.gem MAKEOPTS=-j`nproc` RUBY_CC_VERSION=3.4.1:3.3.5:3.2.6:3.1.6:3.0.7:2.7.8
+			#{ "rake install_darwin_mig[__arm64__]" if platform =~ /arm64-darwin/ }
+			#{ "rake install_darwin_mig[__x86_64__]" if platform =~ /x86_64-darwin/ }
+			rake native:#{platform} pkg/#{$gem_spec.full_name}-#{platform}.gem MAKEOPTS=-j`nproc` RUBY_CC_VERSION=#{RakeCompilerDock.ruby_cc_version("~>2.7", "~>3.0")}
 		EOT
 	end
 	desc "Build the native binary gems"

ext/extconf.rb

@@ -69,7 +69,7 @@ class << recipe
 			def configure
 				envs = []
 				envs << "CFLAGS=-DDSO_WIN32 -DOPENSSL_THREADS" if RUBY_PLATFORM =~ /mingw|mswin/
-				envs << "CFLAGS=-fPIC -DOPENSSL_THREADS" if RUBY_PLATFORM =~ /linux/
+				envs << "CFLAGS=-fPIC -DOPENSSL_THREADS" if RUBY_PLATFORM =~ /linux|darwin/
 				execute('configure', ['env', *envs, "./Configure", openssl_platform, "threads", "-static", "CROSS_COMPILE=#{host}-", configure_prefix], altlog: "config.log")
 			end
 			def compile
@@ -85,17 +85,34 @@ def install
 		recipe.cook_and_activate
 	end
 
-	if RUBY_PLATFORM =~ /linux/
+	if RUBY_PLATFORM =~ /linux|darwin/
 		krb5_recipe = BuildRecipe.new("krb5", KRB5_VERSION, [KRB5_SOURCE_URI]).tap do |recipe|
 			class << recipe
 				def work_path
 					File.join(super, "src")
 				end
+				def configure
+					if RUBY_PLATFORM=~/darwin/
+						ENV["CC"] = host[/^.*[^\.\d]/] + "-clang"
+						ENV["CXX"] = host[/^.*[^\.\d]/] + "-c++"
+
+						# Manually set the correct values for configure checks that libkrb5 won't be
+						# able to perform because we're cross-compiling.
+						ENV["krb5_cv_attr_constructor_destructor"] = "yes"
+						ENV["ac_cv_func_regcomp"] = "yes"
+						ENV["ac_cv_printf_positional"] = "yes"
+					end
+					super
+				end
 			end
 			# We specify -fcommon to get around duplicate definition errors in recent gcc.
 			# See https://github.com/cockroachdb/cockroach/issues/49734
 			recipe.configure_options << "CFLAGS=-fcommon#{" -fPIC" if RUBY_PLATFORM =~ /linux/}"
+			recipe.configure_options << "LDFLAGS=-framework Kerberos" if RUBY_PLATFORM =~ /darwin/
 			recipe.configure_options << "--without-keyutils"
+			recipe.configure_options << "--disable-nls"
+			recipe.configure_options << "--disable-silent-rules"
+			recipe.configure_options << "--without-system-verto"
 			recipe.configure_options << "krb5_cv_attr_constructor_destructor=yes"
 			recipe.configure_options << "ac_cv_func_regcomp=yes"
 			recipe.configure_options << "ac_cv_printf_positional=yes"
@@ -104,14 +121,28 @@ def work_path
 		end
 	end
 
+	# We build a libpq library file which static links OpenSSL and krb5.
+	# Our builtin libpq is referenced in different ways depending on the OS:
+	# - Window: Add the ports directory at runtime per RubyInstaller::Runtime.add_dll_directory
+	#     The file is called "libpq.dll"
+	# - Linux: Add a rpath to pg_ext.so which references the ports directory.
+	#     The file is called "libpq-ruby-pg.so.1" to avoid loading of system libpq by accident.
+	# - Macos: Add a reference with relative path in pg_ext.so to the ports directory.
+	#     The file is called "libpq-ruby-pg.1.dylib" to avoid loading of other libpq by accident.
+	libpq_orig, libpq_rubypg = case RUBY_PLATFORM
+	when /linux/ then ["libpq.so.5", "libpq-ruby-pg.so.1"]
+	when /darwin/ then ["libpq.5.dylib", "libpq-ruby-pg.1.dylib"]
+	# when /mingw/ then ["libpq.dll", "libpq.dll"] # renaming not needed
+	end
+
 	postgresql_recipe = BuildRecipe.new("postgresql", POSTGRESQL_VERSION, [POSTGRESQL_SOURCE_URI]).tap do |recipe|
 		class << recipe
 			def configure_defaults
 				[
 					"--target=#{host}",
 					"--host=#{host}",
 					'--with-openssl',
-					*(RUBY_PLATFORM=~/linux/ ? ['--with-gssapi'] : []),
+					*(RUBY_PLATFORM=~/linux|darwin/ ? ['--with-gssapi'] : []),
 					'--without-zlib',
 					'--without-icu',
 					'--without-readline',
@@ -127,24 +158,24 @@ def install
 		end
 
 		recipe.host = toolchain
-		recipe.configure_options << "CFLAGS=#{" -fPIC" if RUBY_PLATFORM =~ /linux/}"
-		recipe.configure_options << "LDFLAGS=-L#{openssl_recipe.path}/lib -L#{openssl_recipe.path}/lib64 -L#{openssl_recipe.path}/lib-arm64 #{"-Wl,-soname,libpq-ruby-pg.so.1 -lgssapi_krb5 -lkrb5 -lk5crypto -lkrb5support" if RUBY_PLATFORM =~ /linux/}"
+		recipe.configure_options << "CFLAGS=#{" -fPIC" if RUBY_PLATFORM =~ /linux|darwin/}"
+		recipe.configure_options << "LDFLAGS=-L#{openssl_recipe.path}/lib -L#{openssl_recipe.path}/lib64 -L#{openssl_recipe.path}/lib-arm64 #{"-Wl,-soname,#{libpq_rubypg} -lgssapi_krb5 -lkrb5 -lk5crypto -lkrb5support" if RUBY_PLATFORM =~ /linux/} #{"-Wl,-install_name,@loader_path/../../ports/#{gem_platform}/lib/#{libpq_rubypg} -lgssapi_krb5 -lkrb5 -lk5crypto -lkrb5support -lresolv -framework Kerberos" if RUBY_PLATFORM =~ /darwin/}"
 		recipe.configure_options << "LIBS=-lkrb5 -lcom_err -lk5crypto -lkrb5support -lresolv" if RUBY_PLATFORM =~ /linux/
 		recipe.configure_options << "LIBS=-lssl -lwsock32 -lgdi32 -lws2_32 -lcrypt32" if RUBY_PLATFORM =~ /mingw|mswin/
 		recipe.configure_options << "CPPFLAGS=-I#{openssl_recipe.path}/include"
 		recipe.cook_and_activate
 	end
 
 	# Use our own library name for libpq to avoid loading of system libpq by accident.
-	FileUtils.ln_sf File.join(postgresql_recipe.port_path, "lib/libpq.so.5"),
-			File.join(postgresql_recipe.port_path, "lib/libpq-ruby-pg.so.1")
+	FileUtils.ln_sf File.join(postgresql_recipe.port_path, "lib/#{libpq_orig}"),
+			File.join(postgresql_recipe.port_path, "lib/#{libpq_rubypg}")
 	# Avoid dependency to external libgcc.dll on x86-mingw32
-	$LDFLAGS << " -static-libgcc"
+	$LDFLAGS << " -static-libgcc" if RUBY_PLATFORM =~ /mingw|mswin/
 	# Avoid: "libpq.so: undefined reference to `dlopen'" in cross-ruby-2.7.8
-	$LDFLAGS << " -Wl,--no-as-needed" if RUBY_PLATFORM !~ /aarch64/
-	# Find libpq in the ports directory coming from lib/3.3
+	$LDFLAGS << " -Wl,--no-as-needed" if RUBY_PLATFORM !~ /aarch64|arm64|darwin/
+	# Find libpq in the ports directory coming from lib/3.x
 	# It is shared between all compiled ruby versions.
-	$LDFLAGS << " '-Wl,-rpath=$$ORIGIN/../../ports/#{gem_platform}/lib'"
+	$LDFLAGS << " '-Wl,-rpath=$$ORIGIN/../../ports/#{gem_platform}/lib'" if RUBY_PLATFORM =~ /linux/
 	# Don't use pg_config for cross build, but --with-pg-* path options
 	dir_config('pg', "#{postgresql_recipe.path}/include", "#{postgresql_recipe.path}/lib")
 

ports/patches/krb5/1.21.3/0001-Allow-static-linking-krb5-library.patch

@@ -0,0 +1,30 @@
+From e82c1b395162ea71279ea2170259383082e41ab0 Mon Sep 17 00:00:00 2001
+From: Lars Kanis <lars@greiz-reinsdorf.de>
+Date: Sat, 12 Jul 2025 10:55:17 +0200
+Subject: [PATCH] Allow static linking krb5 library
+
+Otherwise it fails with:
+  Undefined symbols for architecture arm64:
+    "_krb5int_c_mit_des_zeroblock", referenced from:
+      _krb5int_des3_cbc_encrypt in libk5crypto.a(d3_aead.o)
+      _krb5int_des3_cbc_decrypt in libk5crypto.a(d3_aead.o)
+---
+ src/lib/crypto/builtin/des/des_int.h | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+diff --git a/src/lib/crypto/builtin/des/des_int.h b/src/lib/crypto/builtin/des/des_int.h
+index 46fed7dbd..114e48ebd 100644
+--- a/lib/crypto/builtin/des/des_int.h
++++ b/lib/crypto/builtin/des/des_int.h
+@@ -159,7 +159,7 @@ mit_des_cbc_encrypt(const mit_des_cblock *in, mit_des_cblock *out,
+                     const mit_des_cblock ivec, int enc);
+ 
+ #define mit_des_zeroblock krb5int_c_mit_des_zeroblock
+-extern const mit_des_cblock mit_des_zeroblock;
++const mit_des_cblock mit_des_zeroblock;
+ 
+ /* fin_rndkey.c */
+ krb5_error_code mit_des_finish_random_key(const krb5_encrypt_block *,
+-- 
+2.43.0
+