tebako 0.8.8 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32bc84615f87ea1dba23c659ef4efe66906fd3ff2d913c5bb5710533a7f2e947
-  data.tar.gz: 4ee0c2ea6565dd76fd797df814c11c190155eeb90b3beba05e3a94183e4368a5
+  metadata.gz: 70cd276a2d74a3086661f5782913bde506b242fed8528c8f17464a532d48853a
+  data.tar.gz: 9fbc81cbba0eeaf6e031bebee172bdb7cfe95bc8bf8994c73f83f9ba65a04dfc
 SHA512:
-  metadata.gz: 7a96e28c1eed3205db11cc6dd16c91ca13a01959fb792ed5f504d057bd252e0618b1d0eb2d787ddc6a7ca6627743b8187dc6c060c6d34bcabf64343a176dcb2f
-  data.tar.gz: 5e94107188ab47055ae4dc07bd3acea650288ed4964e16a2752962bc9306c6b29ecf4303b03f74df9b01f2560110a1e6a432c8fd53bbea5fe01a5683ffdf88a6
+  metadata.gz: 9fecf0012bb0a77a3404378b5dcba60d94776a7a0ece2b207d5bf8b94e21fb59aa81f8dfb9a577b0db4e4a743f6ba40a128ee520cb91db07d303e73477b21c21
+  data.tar.gz: 00136a6bb18176f4dfa9f475aec00295b2d1c31cc2663cd99528a4d10e324048debf4346f6640742f8e8d62eb0341c4c00830cec80605155f4489142f98fbc9b

data/.clang-format

@@ -0,0 +1,4 @@
+BasedOnStyle: Chromium
+BreakBeforeBraces: Stroustrup
+SortIncludes: Never
+ColumnLimit: 120

data/CMakeLists.txt

@@ -209,7 +209,7 @@ string(CONCAT RUBY_API_VER ${RUBY_VER_BASE} ".0")
 #  list(GET LIBDWARFS_WR_VER_COMPONENTS 2 LIBDWARFS_WR_VER_PATCH)
 #  set (LIBDWARFS_WR_VER_M ${LIBDWARFS_WR_VER_MAJOR}.${LIBDWARFS_WR_VER_MINOR}.${LIBDWARFS_WR_VER_PATCH})
 #else(DWARFS_PRELOAD)
-def_ext_prj_g(DWARFS_WR "v0.5.9")
+def_ext_prj_g(DWARFS_WR "v0.7.1")
 #endif(DWARFS_PRELOAD)
 
 def_ext_prj_g(PATCHELF "65e14792061c298f1d2bc44becd48a10cbf0bc81")
@@ -436,6 +436,10 @@ else (${SETUP_MODE})
     DEPENDS ${DWARFS_WR_PRJ} ${RUBY_PRJ}
   )
 
+  set(CMAKE_CXX_STANDARD      20)
+  set(CMAKE_CXX_STANDARD_REQUIRED ON)
+  set(CMAKE_CXX_EXTENSIONS   OFF)
+
   file(GLOB GEMSPECS LIST_DIRECTORIES false ${FS_ROOT}/*.gemspec)
   file(GLOB GEMFILES LIST_DIRECTORIES false ${FS_ROOT}/Gemfile)
   file(GLOB GEMS     LIST_DIRECTORIES false ${FS_ROOT}/*.gem)

data/README.adoc

@@ -662,7 +662,7 @@ $ pacman -S git tar bison flex toolchain make cmake
 
 
 
-== Usage
+== Packaging
 
 === Tebako root folder (aka prefix) selection
 
@@ -932,39 +932,6 @@ options:
 
 Please note that the options provided on the command line have preference over tebafile settings.
 
-=== Image extraction
-
-Tebako provides an option to an extract its DwarFS filesystem from a package to
-a local folder for verification or execution.
-
-[source,sh]
-----
-$ <tebako-packaged-executable> --tebako-extract [<root folder for extracted filesystem>]
-----
-
-Where,
-
-`<root folder for extracted filesystem>`::
-The root folder for the extracted filesystem (optional, defaults to `source_filesystem`)
-
-[example]
-====
-Extracting Tebako content from the `metanorma` package:
-
-[source,sh]
-----
-metanorma --tebako-extract temp-image
-----
-====
-
-The `--tebako-extract` option actually runs the following Ruby script:
-
-[source,ruby]
-----
-require 'fileutils'
-FileUtils.copy_entry '<in-memory filesystem root>', ARGV[2] || 'source_filesystem'
-----
-
 === Exit codes
 
 The Tebako CLI exits with different exit codes to indicate the status of the
@@ -1080,9 +1047,110 @@ Here is a summary of the scenarios:
 
 |===
 
-
 These scenarios determine how the project is packaged and where the entry point is located within the packaged filesystem.
 
+== Run-time options
+
+Generally Tebako package passes command line options to the packaged application
+
+[example]
+====
+For example, if the package was created with the following command
+
+[source,sh]
+----
+tebako press \
+  --root='~/projects/myproject' \
+  --entry=start.rb \
+  --output=/temp/myproject.tebako
+----
+running
+
+[source,sh]
+----
+/temp/myproject.tebako --option --parameter value
+----
+
+will be translated by Tebako bootstrap code to
+
+[source,sh]
+----
+myproject --option --parameter value
+----
+====
+
+However there are several command-line parameters that are intercepted processed by Tebako bootstrap code as follows
+
+=== Image extraction (--tebako-extract option)
+
+Tebako provides an option to an extract its DwarFS filesystem from a package to
+a local folder for verification or execution.
+
+[source,sh]
+----
+$ <tebako-packaged-executable> --tebako-extract [<root folder for extracted filesystem>]
+----
+
+Where,
+
+`<root folder for extracted filesystem>`::
+The root folder for the extracted filesystem (optional, defaults to `source_filesystem`)
+
+[example]
+====
+Extracting Tebako content from the `metanorma` package:
+
+[source,sh]
+----
+metanorma --tebako-extract temp-image
+----
+====
+
+The `--tebako-extract` option actually runs the following Ruby script:
+
+[source,ruby]
+----
+require 'fileutils'
+FileUtils.copy_entry '<in-memory filesystem root>', ARGV[2] || 'source_filesystem'
+----
+
+=== Mounting Host Folder to Tebako Memfs (`--tebako-mount` option)
+
+Some programs unconditionally use folders located under the application root, and when processed by Tebako
+or similar tools, these folders are included in the packaging.
+
+For example, there is no configuration option to change where Rails expects the `tmp` folder to be.
+The location is hardcoded in multiple places within the Rails codebase, residing under the application root,
+and as a result, it gets included in the read-only Tebako memfs. Although patches have been proposed
+(e.g., https://github.com/rails/rails/issues/39583), there is currently no way to change the paths for
+temporary files, caches, and sockets.
+
+To address this limitation in Rails and similar issues in other applications, Tebako provides an option
+to mount a host folder to the memfs tree.
+
+When using Tebako, consider the packaging scenario mentioned above, as it defines the layout of the application
+tree. The `--tebako-extract` option may be useful for understanding the placement of files and folders.
+
+[example]
+====
+The following command starts a `rails.tebako` package with `$PWD/tmp` mounted as `local/tmp` in the memfs.
+Any remaining command-line parameters are passed to the application.
+[source,sh]
+----
+rails.tebako --tebako-mount local/tmp:$PWD/tmp server
+----
+====
+
+The `--tebako-mount` option has the following syntax:
+[source,sh]
+----
+--tebako-mount <memfs path>:<host path>
+----
+
+The `--tebako-mount` option can be repeated multiple times to mount more than one object. The `memfs path`
+is relative to the memfs root, and it is recommended to use absolute paths for host objects. Both directories
+and files can be mounted in this way. Tebako allows overlaying existing memfs objects, so there are no significant
+limitations.
 
 == Trivia: origin of name
 

data/common.env

@@ -1,5 +1,5 @@
 BUILD_TYPE=Release
 DEPS=deps
 INCBIN_TAG=348e36b
-DWARFS_WR_TAG=v0.5.9
+DWARFS_WR_TAG=v0.7.1
 RUBY_VER=3.2.5

data/lib/tebako/packager/patch_libraries.rb

@@ -48,8 +48,10 @@ module Tebako
         DARWIN_DEP_LIBS_2 = ["glog",  "gflags", "brotlienc",       "brotlidec",    "brotlicommon", "fmt"].freeze
         # rubocop:enable Style/WordArray
 
+        LIBTEBAKOFS = "-Wl,--push-state,--whole-archive -l:libtebako-fs.a -Wl,--pop-state"
+
         COMMON_LINUX_LIBRARIES = [
-          "-l:libdwarfs-wr.a",    "-l:libtebako-fs.a",          "-l:libdwarfs.a",             "LIBCOMPRESSION",
+          LIBTEBAKOFS,            "-l:libdwarfs-wr.a",          "-l:libdwarfs.a",             "LIBCOMPRESSION",
           "-l:libfolly.a",        "-l:libfsst.a",               "-l:libmetadata_thrift.a",    "-l:libthrift_light.a",
           "-l:libxxhash.a",       "-l:libfmt.a",                "-l:libdouble-conversion.a",  "-l:libglog.a",
           "-l:libgflags.a",       "-l:libevent.a"
@@ -80,7 +82,7 @@ module Tebako
         MSYS_LIBRARIES = [
           "-l:liblz4.a",             "-l:libz.a",             "-l:libzstd.a",            "-l:liblzma.a",
           "-l:libncurses.a",         "-l:libunwind.a",        "-l:liblzma.a",            "-l:libiberty.a",
-          "LIBYAML",                 "-l:libffi.a",           "-l:libboost_system-mt.a", "-l:libboost_chrono-mt.a",
+          "LIBYAML",                 "-l:libffi.a", "-l:libboost_chrono-mt.a", # "-l:libboost_system-mt.a",
           "-l:libstdc++.a",          "-l:libdl.a",            "-static-libgcc",          "-static-libstdc++",
           "-l:libssl.a",             "-l:libcrypto.a",        "-l:libz.a",               "-l:libwinpthread.a",
           "-lcrypt32",               "-lshlwapi",             "-lwsock32",               "-liphlpapi",

data/lib/tebako/version.rb

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

data/src/tebako-main.cpp

@@ -35,146 +35,114 @@
 #include <sys/stat.h>
 #include <fcntl.h>
 
-
 #include <string>
 #include <cstdint>
+#include <vector>
+#include <stdexcept>
+#include <tuple>
 
 #ifdef _WIN32
- #include <winsock2.h>
- #include <windows.h>
+#include <winsock2.h>
+#include <windows.h>
 #endif
 
-
 #include <tebako/tebako-config.h>
 #include <tebako/tebako-io.h>
 
 #include <tebako/tebako-version.h>
 #include <tebako/tebako-main.h>
 #include <tebako/tebako-fs.h>
+#include <tebako/tebako-cmdline-helpers.h>
 
 static int running_miniruby = 0;
 
-extern "C" int tebako_main(int* argc, char*** argv) {
-	int ret = -1, fsret = -1;
-	char** new_argv = NULL;
-	char* argv_memory = NULL;
-
-	if (strstr((*argv)[0], "miniruby") != NULL) {
-// Ruby build script is designed in such a way that this patch is also applied towards miniruby
-// Just pass through in such case
-		ret = 0;
-		running_miniruby = -1;
-	}
-	else {
-		try {
-			fsret = load_fs(&gfsData[0],
-				gfsSize,
-				tebako::fs_log_level,
-				NULL	/* cachesize*/,
-				NULL	/* workers */,
-				NULL	/* mlock */,
-				NULL	/* decompress_ratio*/,
-				NULL    /* image_offset */
-			);
-
-			if (fsret == 0) {
-				if ((*argc > 1) && strcmp((*argv)[1], "--tebako-extract")==0) {
-				// ruby -e "require 'fileutils'; FileUtils.copy_entry '<tebako::fs_mount_point>',argv[2] || 'source_filesystem'"
-					std::string dest = std::string(((*argc) < 3 ? "source_filesystem" : (*argv)[2]));
-					std::string cmd = std::string("require 'fileutils'; FileUtils.copy_entry '") + (tebako::fs_mount_point) + "', '" + dest + "'";
-					printf("Extracting tebako image to '%s' \n", dest.c_str());
-					size_t new_argv_size = 3 + cmd.size() + 1 + strlen((*argv)[0]) + 1;
-					char** new_argv = new char* [3];
-					char* argv_memory = new char[new_argv_size];
-					if (new_argv != NULL && argv_memory != NULL) {
-						strcpy(argv_memory, (*argv)[0]);
-						new_argv[0] = argv_memory;
-						argv_memory += (strlen((*argv)[0]) + 1);
-						strcpy(argv_memory, "-e");
-						new_argv[1] = argv_memory;
-						argv_memory += 3;
-						strcpy(argv_memory, cmd.c_str());
-						new_argv[2] = argv_memory;
-						ret = 0;
-						*argv = new_argv;
-						(*argc) = 3;
-					}
-				}
-				else {
-					size_t new_argv_size = strlen(tebako::fs_mount_point) + strlen(tebako::fs_entry_point) + 1;
-					for (int i = 0; i < (*argc); i++) {
-						new_argv_size += (strlen((*argv)[i]) + 1);
-					}
-					/* argv memory should be adjacent */
-					char** new_argv = new char* [(*argc) + 1];
-					char* argv_memory = new char[new_argv_size];
-					if (new_argv != NULL && argv_memory != NULL) {
-						memcpy(argv_memory, (*argv)[0], strlen((*argv)[0]) + 1);
-						new_argv[0] = argv_memory;
-						argv_memory += (strlen((*argv)[0]) + 1);
-						memcpy(argv_memory, tebako::fs_mount_point, strlen(tebako::fs_mount_point));
-						new_argv[1] = argv_memory;
-						argv_memory += strlen(tebako::fs_mount_point);
-						memcpy(argv_memory, tebako::fs_entry_point, strlen(tebako::fs_entry_point) + 1);
-						argv_memory += (strlen(tebako::fs_entry_point) + 1);
-						for (int i = 1; i < (*argc); i++) {
-							memcpy(argv_memory, (*argv)[i], strlen((*argv)[i]) + 1);
-							new_argv[i+1] = argv_memory;
-							argv_memory += (strlen((*argv)[i]) + 1);
-						}
-						*argv = new_argv;
-						(*argc) += 1;
-						ret = 0;
-					}
-				}
-			    atexit(drop_fs);
-			}
-		}
-		catch (...) {
-
-		}
-
-		if (!tebako_is_running_miniruby()) {
-        	if (getcwd(tebako::original_cwd, sizeof(tebako::original_cwd)) == NULL) {
-            	printf("Failed to get current directory: %s\n", strerror(errno));
-            	return -1;
-        	}
-
-			if (tebako::needs_cwd) {
-				if (tebako_chdir(tebako::package_cwd) != 0) {
-					printf("Failed to chdir to '%s' : %s\n", tebako::package_cwd, strerror(errno));
-					ret = -1;
-				}
-			}
-		}
-
-		if (ret != 0) {
-			try {
-				printf("Tebako initialization failed\n");
-				if (new_argv) delete new_argv;
-				if (argv_memory) delete argv_memory;
-				if (fsret == 0) {
-					drop_fs();
-				}
-			}
-			catch (...) {
-				// Nested error, no recovery :(
-			}
-		}
-	}
-	return ret;
+extern "C" int tebako_main(int* argc, char*** argv)
+{
+  int ret = -1, fsret = -1;
+  char** new_argv = nullptr;
+  char* argv_memory = nullptr;
+
+  if (strstr((*argv)[0], "miniruby") != nullptr) {
+    // Ruby build script is designed in such a way that this patch is also applied towards miniruby
+    // Just pass through in such case
+    ret = 0;
+    running_miniruby = -1;
+  }
+  else {
+    try {
+      fsret = load_fs(&gfsData[0], gfsSize, tebako::fs_log_level, nullptr /* cachesize*/, nullptr /* workers */,
+                      nullptr /* mlock */, nullptr /* decompress_ratio*/, nullptr /* image_offset */
+      );
+
+      if (fsret == 0) {
+        if ((*argc > 1) && strcmp((*argv)[1], "--tebako-extract") == 0) {
+          ret = tebako::build_arguments_for_extract(argc, argv, tebako::fs_mount_point);
+        }
+        else {
+          auto [mountpoints, parsed_argv] = tebako::parse_arguments(*argc, *argv);
+          // for (auto& mp : mountpoints) {
+          // printf("Mountpoint: %s\n", mp.c_str());
+          // }
+          tebako::process_mountpoints(mountpoints);
+          std::tie(*argc, *argv) = tebako::build_arguments(parsed_argv, tebako::fs_mount_point, tebako::fs_entry_point);
+          ret = 0;
+        }
+      }
+      atexit(drop_fs);
+    }
+
+    catch (std::exception e) {
+      printf("Failed to process command line: %s\n", e.what());
+    }
+
+    if (getcwd(tebako::original_cwd, sizeof(tebako::original_cwd)) == nullptr) {
+      printf("Failed to get current directory: %s\n", strerror(errno));
+      ret = -1;
+    }
+
+    if (tebako::needs_cwd) {
+      if (tebako_chdir(tebako::package_cwd) != 0) {
+        printf("Failed to chdir to '%s' : %s\n", tebako::package_cwd, strerror(errno));
+        ret = -1;
+      }
+    }
+  }
+
+  if (ret != 0) {
+    try {
+      printf("Tebako initialization failed\n");
+      if (new_argv) {
+        delete new_argv;
+        new_argv = nullptr;
+      }
+      if (argv_memory) {
+        delete argv_memory;
+        argv_memory = nullptr;
+      }
+      if (fsret == 0) {
+        drop_fs();
+      }
+    }
+    catch (...) {
+      // Nested error, no recovery :(
+    }
+  }
+  return ret;
 }
 
-extern "C" const char* tebako_mount_point(void) {
-	return tebako::fs_mount_point;
+extern "C" const char* tebako_mount_point(void)
+{
+  return tebako::fs_mount_point;
 }
 
-extern "C" const char* tebako_original_pwd(void) {
-	return tebako::original_cwd;
+extern "C" const char* tebako_original_pwd(void)
+{
+  return tebako::original_cwd;
 }
 
-extern "C" int tebako_is_running_miniruby(void) {
-	return running_miniruby;
+extern "C" int tebako_is_running_miniruby(void)
+{
+  return running_miniruby;
 }
 
 #ifdef RB_W32_PRE_33

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tebako
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.9.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -148,6 +148,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".clang-format"
 - CMakeLists.txt
 - Gemfile
 - README.adoc