tebako 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebe002df1e8e8daadd33a026a9c6025942fbfd862a3db0c3ef1c65ffefa4b631
-  data.tar.gz: d814f2f7c57f01d497472afb7262f7ae635af13f16e107eaa3794dd180474309
+  metadata.gz: 17722a182f3df63283d1b99ede4bb8a3bae7a864eb001412165cbf7e43d2c4d5
+  data.tar.gz: '029dd9ec847efd8f0002b148e4db1496d6a09c005879b52ae88f088e6333e1ba'
 SHA512:
-  metadata.gz: c2e39d4b7869385b5ef17ed3e6233ea83040f18b8b791a8ac195c3a4c94846954e4a7a1ef64e6a176fd4f4c335cd81c234446b41602e8dcd45e03fdde137cf83
-  data.tar.gz: e97d5ffc1d62860a623d3a342a7258f43bbfd9922cb341a26cc6ffcdeda8d5efac2aafa1e67d6e0d8e5e1d7edf6860b5a91df7d739f6e38aa192fa3bc342addc
+  metadata.gz: 4425672dd1e610017539d3c329ab476e6f5080a91b81f9afda7c0aabeb82f6b83fdf29b4e5e1ff9b604c7eb1d20b61b029442ab902736680c33b32ba7c66fb9c
+  data.tar.gz: 5144425b8ebe468462352db8da92c2ea6483a365bd88e7dd992d3d09dbac1bb0f4f57865e1e298adcc8e66ff3a90f4e21f85b9ffba6ff624fca42a05a1c5f85f

data/CMakeLists.txt

@@ -113,6 +113,7 @@ else(OSTYPE_RES EQUAL 0)
   message(FATAL_ERROR "Failed to detect OSTYPE: ${OSTYPE_TXT}")
 endif(OSTYPE_RES EQUAL 0)
 
+set(IS_GNU OFF)
 set(IS_MUSL OFF)
 set(IS_MSYS OFF)
 set(IS_DARWIN OFF)
@@ -121,8 +122,18 @@ set(RUBY_WITHOUT_EXT "dbm,win32,win32ole,-test-/*")
 set(RUBY_NAME "ruby")
 set(EXE_SUFFIX "")
 set(DWARFS_PRELOAD OFF)
-
-if("${OSTYPE_TXT}" MATCHES "^linux-musl.*")
+set(WITH_PATCHELF OFF)
+
+if("${OSTYPE_TXT}" MATCHES "^linux-gnu.*")
+  set(IS_GNU ON)
+  if(REMOVE_GLIBC_PRIVATE)
+    if (CMAKE_C_COMPILER_ID STREQUAL "GNU")
+      set(WITH_PATCHELF ON)
+    else()
+      message(WARNING "Elf file patching is supported for GNU toolchain only. 'patchelf' setting ignored")
+    endif()
+  endif(REMOVE_GLIBC_PRIVATE)
+elseif("${OSTYPE_TXT}" MATCHES "^linux-musl.*")
   set(IS_MUSL ON)
 elseif("${OSTYPE_TXT}" MATCHES "^msys*")
   set(IS_MSYS ON)
@@ -180,9 +191,7 @@ set(DATA_RES_DIR  ${CMAKE_CURRENT_SOURCE_DIR}/resources)
 # External projects
 
 if ("-${RUBY_VER}" STREQUAL "-" OR "-${RUBY_HASH}" STREQUAL "-")
-  set(RUBY_VER "3.1.4")
-  set(RUBY_HASH "a3d55879a0dfab1d7141fdf10d22a07dbf8e5cdc4415da1bde06127d5cc3c7b6")
-  message(STATUS "Using default Ruby version ${RUBY_VER}")
+  message(FATAL_ERROR "Ruby version is not specified")
 endif()
 
 set(RUBY_NAME ruby)
@@ -207,6 +216,8 @@ string(CONCAT RUBY_API_VER ${RUBY_VER_BASE} ".0")
 def_ext_prj_g(DWARFS_WR "v0.5.9")
 #endif(DWARFS_PRELOAD)
 
+def_ext_prj_g(PATCHELF "master")
+
 set(LIBYAML_RUBY_OPTION "")
 if(${RUBY_VER} VERSION_LESS "3.2.0")
   set(LIBYAML_RUBY_OPTION "--enable-bundled-libyaml")
@@ -266,6 +277,7 @@ message(STATUS "Target local directory: ${TLD}")
 message(STATUS "Target Gem directory:: ${TGD}")
 message(STATUS "FS_MOUNT_POINT: ${FS_MOUNT_POINT}")
 message(STATUS "Building for Win32 Ruby (RB_W32): ${RB_W32}")
+message(STATUS "Removing GLIBC_PRIVATE reference: ${WITH_PATCHELF}")
 
 # ...................................................................
 # Other options
@@ -307,7 +319,7 @@ if(DWARFS_PRELOAD)
   )
 else(DWARFS_PRELOAD)
   ExternalProject_Add(${DWARFS_WR_PRJ}
-      PREFIX ${DEPS}
+     PREFIX ${DEPS}
      GIT_REPOSITORY https://github.com/tamatebako/libdwarfs.git
      GIT_TAG ${DWARFS_WR_TAG}
      SOURCE_DIR ${DWARFS_WR_SOURCE_DIR}
@@ -328,6 +340,22 @@ else(DWARFS_PRELOAD)
   )
 endif(DWARFS_PRELOAD)
 
+if(IS_GNU)
+  ExternalProject_Add(${PATCHELF_PRJ}
+    PREFIX ${DEPS}
+    GIT_REPOSITORY https://github.com/chitao1234/patchelf.git
+    GIT_TAG ${PATCHELF_WR_TAG}
+    SOURCE_DIR ${PATCHELF_SOURCE_DIR}
+    BINARY_DIR ${PATCHELF_BINARY_DIR}
+    UPDATE_COMMAND ""
+    CONFIGURE_COMMAND ${CMAKE_COMMAND} -E chdir ${PATCHELF_SOURCE_DIR} ./bootstrap.sh
+              COMMAND ${PATCHELF_SOURCE_DIR}/configure
+                  --srcdir=${PATCHELF_SOURCE_DIR}
+                  --prefix=${DEPS}
+    TEST_COMMAND ""
+  )
+endif(IS_GNU)
+
 # ...................................................................
 # Ruby
 
@@ -396,6 +424,11 @@ ExternalProject_Add(${RUBY_PRJ}
 
 add_dependencies(${RUBY_PRJ} ${DWARFS_WR_PRJ} ${LIBDWARFS_WR_PRJ})
 
+if(IS_GNU)
+  add_dependencies(${RUBY_PRJ} ${PATCHELF_PRJ})
+endif(IS_GNU)
+
+
 if (${SETUP_MODE})
   add_custom_target(setup
     ${CMAKE_COMMAND} -E echo "Tebako setup has completed"
@@ -488,16 +521,13 @@ else (${SETUP_MODE})
     ${DEPS_INCLUDE_DIR}/tebako/tebako-version.h
   )
 
-  #et_target_properties(tebako-fs PROPERTIES POSITION_INDEPENDENT_CODE ON)
-  #target_compile_options(tebako-fs PRIVATE -fPIE)
-
   if(${RUBY_VER} VERSION_LESS "3.3.0" AND "${OSTYPE_TXT}" MATCHES "^msys*")
     target_compile_definitions(tebako-fs PUBLIC RB_W32_PRE_33)
   endif(${RUBY_VER} VERSION_LESS "3.3.0" AND "${OSTYPE_TXT}" MATCHES "^msys*")
 
   add_dependencies(tebako-fs packaged_filesystem)
 
-  add_custom_target(tebako COMMAND ruby ${EXE}/tebako-packager finalize ${OSTYPE_TXT} ${RUBY_SOURCE_DIR} ${APP_NAME} ${RUBY_VER})
+  add_custom_target(tebako COMMAND ruby ${EXE}/tebako-packager finalize ${OSTYPE_TXT} ${RUBY_SOURCE_DIR} ${APP_NAME} ${RUBY_VER} ${DEPS_BIN_DIR}/patchelf ${WITH_PATCHELF})
   add_dependencies(tebako setup tebako-fs)
 
 endif(${SETUP_MODE})

data/README.adoc

@@ -657,6 +657,7 @@ tebako press \
   [-l|--log-level=<error|warn|debug|trace>] \
   [-c|--cwd=<package current working directory>]
   [-D|--devmode] \
+  [-P|--patchelf] \
   [-t|--tebafile=<path-to-tebafile>]
 ----
 
@@ -689,12 +690,17 @@ If not provided, the application will start within the current folder of the hos
 This option is required because it is not possible to change the directory to a memfs folder until the package is started, as opposed to any host folder
 that can be set as the current directory before Tebako package invocation.  Tebako saves original working directory in a global Ruby variable `$tebako_original_pwd`.
 
+`devmode`:: flag that activates development mode, in which Tebako's cache and
+packaging consistency checks are relaxed.
+
+`patchelf`::
+flag that removal a reference to GLIBC_PRIVATE version of libpthread from tebako package. This allows Linux Gnu packages to run against versions of
+libpthread that differ from the version used for packaging. For example, package created at Ubuntu 20 system can be used on Ubuntu 22. This option works on Gnu Linux with
+Gnu toolchain only (not for LLVM/clang). The feature is exeprimental, we may consider other approach in the future.
+
 `tebafile`::
 the tebako configuration file (optional, defaults to `$PWD/.tebako.yml`).
 Please refer to the separate section below for tebafile description.
-
-`devmode`:: flag that activates development mode, in which Tebako's cache and
-packaging consistency checks are relaxed.
 +
 NOTES:
   * Development mode is *not intended for production use* and should only be used during development.

data/exe/tebako-packager

@@ -105,12 +105,15 @@ begin
     #       ARGV[2] -- RUBY_SOURCE_DIR
     #       ARGV[3] -- APP_NAME
     #       ARGV[4] -- RUBY_VER
-    unless ARGV.length == 5
+    #       ARGV[5] -- patchelf executable
+    #       ARGV[6] -- WITH_PATHELF
+    unless ARGV.length == 7
       raise Tebako::Error,
-            "tebako-packager finalize command expects 5 arguments, #{ARGV.length} has been provided."
+            "tebako-packager finalize command expects 7 arguments, #{ARGV.length} has been provided."
     end
     ruby_ver = Tebako::RubyVersion.new(ARGV[4])
-    Tebako::Packager.finalize(ARGV[1], ARGV[2], ARGV[3], ruby_ver)
+    with_patchelf = ARGV[6].casecmp("ON").zero? || ARGV[6].casecmp("YES").zero?
+    Tebako::Packager.finalize(ARGV[1], ARGV[2], ARGV[3], ruby_ver, with_patchelf ? ARGV[5] : nil)
   else
     raise Tebako::Error, "tebako-packager cannot process #{ARGV[0]} command"
   end

data/lib/tebako/build_helpers.rb

@@ -39,7 +39,7 @@ module Tebako
           out, st = Open3.capture2e("nproc", "--all")
         end
 
-        if st.exitstatus.zero?
+        if !st.signaled? && st.exitstatus.zero?
           out.strip.to_i
         else
           4
@@ -49,7 +49,7 @@ module Tebako
       def run_with_capture(args)
         puts "   ... @ #{args.join(" ")}"
         out, st = Open3.capture2e(*args)
-        raise Tebako::Error, "Failed to run #{args.join(" ")} (#{st}):\n #{out}" unless st.exitstatus.zero?
+        raise Tebako::Error, "Failed to run #{args.join(" ")} (#{st}):\n #{out}" if st.signaled? || !st.exitstatus.zero?
 
         out
       end

data/lib/tebako/cli.rb

@@ -46,7 +46,7 @@ module Tebako
     package_name "Tebako"
     class_option :prefix, type: :string, aliases: "-p", required: false,
                           desc: "A path to tebako packaging environment, '~/.tebako' ('$HOME/.tebako') by default"
-    class_option :devmode, type: :boolean, aliases: "-D", required: false,
+    class_option :devmode, type: :boolean, aliases: "-D",
                            desc: "Developer mode, please do not use if unsure"
     class_option :tebafile, type: :string, aliases: "-t", required: false,
                             desc: "tebako configuration file 'tebafile', '$PWD/.tebako.yml' by default"
@@ -75,7 +75,13 @@ module Tebako
 
     CWD_DESCRIPTION = <<~DESC
       Current working directory for packaged application. This directory shall be specified relative to root.
-      #{" " * 62}# If this parameter is not set, the application will start in the current directory of the host file system.
+      #{" " * 65}# If this parameter is not set, the application will start in the current directory of the host file system.
+    DESC
+
+    RGP_DESCRIPTION = <<~DESC
+      Activates removal a reference to GLIBC_PRIVATE version of libpthread from tebako package. This allows Linux Gnu packages to run against versions of
+      #{" " * 65}# libpthread that differ from the version used for packaging. For example, package created at Ubuntu 20 system can be used on Ubuntu 22. This option works on Gnu Linux with
+      #{" " * 65}# Gnu toolchain only (not for LLVM/clang). The feature is exeprimental, we may consider other approach in the future.
     DESC
 
     desc "press", "Press tebako image"
@@ -91,6 +97,8 @@ module Tebako
     method_option :Ruby, type: :string, aliases: "-R", required: false,
                          enum: Tebako::CliRubies::RUBY_VERSIONS.keys,
                          desc: "Tebako package Ruby version, #{Tebako::CliRubies::DEFAULT_RUBY_VERSION} by default"
+    method_option :patchelf, aliases: "-P", type: :boolean,
+                             desc: RGP_DESCRIPTION
     def press
       version_cache_check unless options[:devmode]
 

data/lib/tebako/cli_helpers.rb

@@ -56,7 +56,7 @@ module Tebako
       @cfg_options ||=
         "-DCMAKE_BUILD_TYPE=Release -DRUBY_VER:STRING=\"#{ruby_ver}\" -DRUBY_HASH:STRING=\"#{ruby_hash}\" " \
         "-DDEPS:STRING=\"#{deps}\" -G \"#{m_files}\" -B \"#{output_folder}\" -S \"#{source}\" " \
-        "-DTEBAKO_VERSION:STRING=\"#{Tebako::VERSION}\""
+        "-DREMOVE_GLIBC_PRIVATE=#{remove_glibc_private} -DTEBAKO_VERSION:STRING=\"#{Tebako::VERSION}\""
     end
 
     def clean_cache
@@ -174,6 +174,10 @@ module Tebako
                    end
     end
 
+    def remove_glibc_private
+      @remove_glibc_private ||= options["patchelf"] ? "ON" : "OFF"
+    end
+
     def handle_nil_prefix
       env_prefix = ENV.fetch("TEBAKO_PREFIX", nil)
       if env_prefix.nil?

data/lib/tebako/packager.rb

@@ -71,8 +71,7 @@ module Tebako
         puts "   ... creating Windows import library"
         params = ["dlltool", "-d", def_fname(src_dir, app_name), "-D", out_fname(app_name),
                   "--output-lib", lib_fname(package_src_dir, ruby_ver)]
-        out, st = Open3.capture2e(*params)
-        raise Tebako::Error, "Failed to create import library:\n #{out}" unless st.exitstatus.zero?
+        BuildHelpers.run_with_capture(params)
       end
 
       # Deploy
@@ -85,18 +84,16 @@ module Tebako
         Tebako::Stripper.strip(os_type, target_dir)
       end
 
-      def finalize(os_type, src_dir, app_name, ruby_ver)
+      def finalize(os_type, src_dir, app_name, ruby_ver, patchelf)
         RubyBuilder.new(ruby_ver, src_dir).final_build
         exe_suffix = Packager::PatchHelpers.exe_suffix(os_type)
         src_name = File.join(src_dir, "ruby#{exe_suffix}")
-        package_name = "#{app_name}#{exe_suffix}"
-        # [TODO] On MSys strip sometimes creates a broken executable
-        # https://github.com/tamatebako/tebako/issues/172
-        if Packager::PatchHelpers.msys?(os_type)
-          FileUtils.cp(src_name, package_name)
-        else
-          Tebako::Stripper.strip_file(src_name, package_name)
+        unless patchelf.nil?
+          params = [patchelf, "--remove-needed-version", "libpthread.so.0", "GLIBC_PRIVATE", src_name]
+          BuildHelpers.run_with_capture(params)
         end
+        package_name = "#{app_name}#{exe_suffix}"
+        strip_or_copy(os_type, src_name, package_name)
         puts "Created tebako package at \"#{package_name}\""
       end
 
@@ -199,6 +196,16 @@ module Tebako
         end
         ruby_version
       end
+
+      def strip_or_copy(os_type, src_name, package_name)
+        # [TODO] On MSys strip sometimes creates a broken executable
+        # https://github.com/tamatebako/tebako/issues/172
+        if Packager::PatchHelpers.msys?(os_type)
+          FileUtils.cp(src_name, package_name)
+        else
+          Tebako::Stripper.strip_file(src_name, package_name)
+        end
+      end
     end
   end
 end

data/lib/tebako/version.rb

@@ -26,5 +26,5 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 module Tebako
-  VERSION = "0.8.5"
+  VERSION = "0.8.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tebako
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-31 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor