bootsnap 1.25.0 → 1.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e46c28f258eb76b8c90fa22a7fa2c83887695b7c12d3aff8dbbefda5051dca87
-  data.tar.gz: 33aaa301627c53d2f4db1b8e98db0b2f52dc8d20aa533c8de8dc9448bf0c0b8e
+  metadata.gz: 60ae2eb0837949aa24f9b7a0f26091e3dbfc0254824da896199c376cf5040701
+  data.tar.gz: e443d064c6dcfbf2dd9265b54fbf65972154f5104c8f675f1595baa04eb78aae
 SHA512:
-  metadata.gz: 77f885b700f2d249da6afd6ed4a70e4b37bf27303ddabefdfbed915fea6e61587d3e0fa56ee5159a95416072d58d4994498ee29bf69a3ab70c3b9e98471c3a0a
-  data.tar.gz: 7044ce0c6a30d7312d947da11b20755dbd496ee7b5f460293bf9188c83493ac951e6e683f75009b17860c45a7ff31e3264abffd69dcaf5a0e8c6b759b7631332
+  metadata.gz: d216ef8ec68ba89acdff4fb8c40288feb4f1363705d39b10c25172e0d426cf53609404c73d761ada31f7c1ad880da6bc247d637bb6cb2e4393699de287c88c62
+  data.tar.gz: 5dffa5c439dfbb15e020f2704f2400b44f8c0dfe5c14afbae18d68f7f1cc33f06cb6fce6ccb315ffd32b309b460e955e247af399d4ba2712fd48dd5e40ab1add

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Unreleased
 
+# 1.26.1
+
+* Fix `Bootsnap.enable_frozen_string_literal(app_only: true)` raising `NameError` when the compile cache is disabled.
+  App files are now compiled with frozen string literals on every load, without caching.
+
+* Avoid transcoding Ruby source when the Prism workaround runs with a default internal encoding.
+
+* Better detect support for fast path scanning. Fix compilation on Illumos.
+
+# 1.26.0
+
+* Handle top level `Coverage` constant being defined, but without it being the true stdlib `coverage` module.
+* Fix `bootsnap precompile` that could generate a corrupted cache entry if an already cached YAML file was modified
+  without changing its size.
+* Workaround a potential Ruby SEGV if `Bootsnap.instrumentation` raised an error.
+
 # 1.25.0
 
 * Improve YAML parsing cache to more efficiently handle `Time`, `Date` and `DateTime`.

data/ext/bootsnap/bootsnap.c

@@ -149,7 +149,7 @@ bs_rb_get_path(VALUE self, VALUE fname)
     return rb_get_path(fname);
 }
 
-#ifdef HAVE_FSTATAT
+#if defined(HAVE_FSTATAT) && defined(HAVE_STRUCT_DIRENT_D_TYPE)
 
 RBIMPL_ATTR_NORETURN()
 static void
@@ -275,7 +275,7 @@ Init_bootsnap(void)
 
   rb_define_singleton_method(rb_mBootsnap, "rb_get_path", bs_rb_get_path, 1);
 
-#ifdef HAVE_FSTATAT
+#if defined(HAVE_FSTATAT) && defined(HAVE_STRUCT_DIRENT_D_TYPE)
   VALUE rb_mBootsnap_LoadPathCache = rb_define_module_under(rb_mBootsnap, "LoadPathCache");
   VALUE rb_mBootsnap_LoadPathCache_Native = rb_define_module_under(rb_mBootsnap_LoadPathCache, "Native");
 
@@ -318,7 +318,13 @@ static inline void
 bs_instrumentation(VALUE event, VALUE path)
 {
     if (RB_UNLIKELY(instrumentation_enabled)) {
+       // If the funcall raises and rescues an error we will lose the errinfo
+       // that exists now so we save it before and restore it after.
+       VALUE saved_errinfo = rb_errinfo();
        rb_funcall(rb_mBootsnap, instrumentation_method, 2, event, path);
+       // If the ruby code in instrumentation_method raised we won't reach this point.
+       // If it didn't raise it _might_ have rescued so we should restore errinfo.
+       rb_set_errinfo(saved_errinfo);
     }
 }
 
@@ -456,11 +462,34 @@ static int cache_key_equal_slow_path(struct bs_cache_key *current_key,
   return current_key->digest == cached_key->digest;
 }
 
+static ssize_t
+resumable_write(int fd, const void *buf, size_t count)
+{
+  size_t total_written = 0;
+  const char *ptr = buf;
+
+  while (count > 0) {
+    ssize_t res = write(fd, ptr, count);
+
+    if (res < 0) {
+      if (errno == EINTR) {
+        continue; // Interrupted by signal, try again
+      }
+      return -1; // Real error
+    }
+
+    ptr += res;
+    count -= res;
+    total_written += res;
+  }
+  return total_written;
+}
+
 static int update_cache_key(struct bs_cache_key *current_key, struct bs_cache_key *old_key, int cache_fd, const char ** errno_provenance)
 {
   old_key->mtime = current_key->mtime;
   lseek(cache_fd, 0, SEEK_SET);
-  ssize_t nwrite = write(cache_fd, old_key, KEY_SIZE);
+  ssize_t nwrite = resumable_write(cache_fd, old_key, KEY_SIZE);
   if (nwrite < 0) {
       *errno_provenance = "update_cache_key:write";
       return -1;
@@ -725,6 +754,17 @@ mkpath(char * file_path, mode_t mode)
   return 0;
 }
 
+static int
+bs_fchmod(int fd, const char *path, mode_t mode)
+{
+#ifdef _WIN32
+  setmode(fd, O_BINARY);
+  return chmod(path, mode);
+#else
+  return fchmod(fd, mode);
+#endif
+}
+
 /*
  * Write a cache header/key and a compiled artifact to a given cache path by
  * writing to a tmpfile and then renaming the tmpfile over top of the final
@@ -738,13 +778,18 @@ atomic_write_cache_file(char * path, struct bs_cache_key * key, VALUE data, cons
   int fd, ret, attempt;
   ssize_t nwrite;
 
+  uint64_t data_size = RSTRING_LEN(data);
+  if (data_size > (uint32_t)-1) {
+    return 0; // Don't cache.
+  }
+
   for (attempt = 0; attempt < MAX_CREATE_TEMPFILE_ATTEMPT; ++attempt) {
     tmp_path = strncpy(template, path, MAX_CACHEPATH_SIZE);
     strcat(tmp_path, ".tmp.XXXXXX");
 
     // mkstemp modifies the template to be the actual created path
     fd = mkstemp(tmp_path);
-    if (fd > 0) break;
+    if (fd >= 0) break;
 
     if (attempt == 0 && mkpath(tmp_path, 0775) < 0) {
       *errno_provenance = "bs_fetch:atomic_write_cache_file:mkpath";
@@ -756,50 +801,42 @@ atomic_write_cache_file(char * path, struct bs_cache_key * key, VALUE data, cons
     return -1;
   }
 
-  if (chmod(tmp_path, 0644) < 0) {
+  if (bs_fchmod(fd, tmp_path, 0644 & ~current_umask) < 0) {
+    close(fd);
     *errno_provenance = "bs_fetch:atomic_write_cache_file:chmod";
     return -1;
   }
 
-  #ifdef _WIN32
-  setmode(fd, O_BINARY);
-  #endif
-
-  uint64_t data_size = RSTRING_LEN(data);
-  if (data_size > (uint32_t)-1) {
-    return 0; // Don't cache.
-  }
-
   key->data_size = (uint32_t)data_size;
-  nwrite = write(fd, key, KEY_SIZE);
+  nwrite = resumable_write(fd, key, KEY_SIZE);
   if (nwrite < 0) {
+    close(fd);
     *errno_provenance = "bs_fetch:atomic_write_cache_file:write";
     return -1;
   }
   if (nwrite != KEY_SIZE) {
+    close(fd);
     *errno_provenance = "bs_fetch:atomic_write_cache_file:keysize";
     errno = EIO; /* Lies but whatever */
     return -1;
   }
 
-  nwrite = write(fd, RSTRING_PTR(data), RSTRING_LEN(data));
+  nwrite = resumable_write(fd, RSTRING_PTR(data), RSTRING_LEN(data));
   if (nwrite < 0) return -1;
   if (nwrite != RSTRING_LEN(data)) {
+    close(fd);
     *errno_provenance = "bs_fetch:atomic_write_cache_file:writelength";
     errno = EIO; /* Lies but whatever */
     return -1;
   }
 
   close(fd);
+
   ret = rename(tmp_path, path);
   if (ret < 0) {
     *errno_provenance = "bs_fetch:atomic_write_cache_file:rename";
     return -1;
   }
-  ret = chmod(path, 0664 & ~current_umask);
-  if (ret < 0) {
-    *errno_provenance = "bs_fetch:atomic_write_cache_file:chmod";
-  }
   return ret;
 }
 
@@ -1105,7 +1142,7 @@ bs_precompile(char * path, VALUE path_v, char * cache_path, VALUE handler)
   /* Cache is stale, invalid, or missing. Regenerate and write it out. */
 
   /* Read the contents of the source file into a buffer */
-  if ((input_data = bs_read_contents(current_fd, current_key.size, &errno_provenance)) == Qfalse) goto fail;
+  if (input_data == Qfalse && (input_data = bs_read_contents(current_fd, current_key.size, &errno_provenance)) == Qfalse) goto fail;
 
   /* Try to compile the input_data using input_to_storage(input_data) */
   exception_tag = bs_input_to_storage(handler, Qnil, input_data, path_v, &storage_data);

data/ext/bootsnap/extconf.rb

@@ -5,6 +5,7 @@ require "mkmf"
 if %w[ruby truffleruby].include?(RUBY_ENGINE)
   have_func "fdatasync", "unistd.h"
   have_func "fstatat", "sys/stat.h"
+  have_struct_member "struct dirent", "d_type", "dirent.h"
 
   unless RUBY_PLATFORM.match?(/mswin|mingw|cygwin/)
     append_cppflags ["-D_GNU_SOURCE"] # Needed of O_NOATIME

data/lib/bootsnap/compile_cache/iseq.rb

@@ -11,7 +11,7 @@ module Bootsnap
         attr_accessor :compiler_selector, :default_compiler
 
         def cache_dir=(cache_dir)
-          @cache_dir = cache_dir.end_with?("/") ? "#{cache_dir}iseq" : "#{cache_dir}-iseq"
+          @cache_dir = cache_dir && (cache_dir.end_with?("/") ? "#{cache_dir}iseq" : "#{cache_dir}-iseq")
         end
 
         def supported?
@@ -72,7 +72,8 @@ module Bootsnap
 
               if has_ruby_bug_22023_bis
                 def compile_file_prism(path, options = nil)
-                  compile_prism(::File.read(path, encoding: Encoding::UTF_8), path, path, nil, options)
+                  source = ::File.read(path, external_encoding: Encoding::UTF_8, internal_encoding: nil)
+                  compile_prism(source, path, path, nil, options)
                 end
               end
             end
@@ -151,13 +152,17 @@ module Bootsnap
             return nil
           end
 
-          Bootsnap::CompileCache::Native.fetch(
-            cache_dir,
-            compiler.namespace,
-            path.to_s,
-            compiler,
-            nil,
-          )
+          if cache_dir
+            Bootsnap::CompileCache::Native.fetch(
+              cache_dir,
+              compiler.namespace,
+              path.to_s,
+              compiler,
+              nil,
+            )
+          else
+            compiler.input_to_output(nil, path.to_s, nil)
+          end
         end
 
         def self.precompile(path)
@@ -172,11 +177,11 @@ module Bootsnap
 
         if RUBY_VERSION < "3.1."
           def self.coverage_on?
-            defined?(Coverage) && Coverage.running?
+            defined?(Coverage.running?) && Coverage.running?
           end
         else
           def self.coverage_on?
-            defined?(Coverage) && Coverage.state != :idle
+            defined?(Coverage.state) && Coverage.state != :idle
           end
         end
 

data/lib/bootsnap/compile_cache.rb

@@ -16,7 +16,6 @@ module Bootsnap
 
       if iseq
         if supported?
-          require_relative "compile_cache/iseq"
           Bootsnap::CompileCache::ISeq.install!(cache_dir)
         elsif $VERBOSE
           warn("[bootsnap/setup] bytecode caching is not supported on this implementation of Ruby")
@@ -45,3 +44,8 @@ module Bootsnap
     end
   end
 end
+
+if RUBY_ENGINE != "jruby"
+  require_relative "compile_cache/iseq"
+  Bootsnap::CompileCache::ISeq.install!(nil)
+end

data/lib/bootsnap/load_path_cache/store.rb

@@ -72,7 +72,7 @@ module Bootsnap
 
       def load_data
         @data = begin
-          data = File.open(@store_path, encoding: Encoding::BINARY) do |io|
+          data = File.open(@store_path, binmode: true, encoding: Encoding::BINARY) do |io|
             MessagePack.load(io, freeze: true)
           end
           if data.is_a?(Hash) && data[VERSION_KEY] == CURRENT_VERSION
@@ -100,7 +100,7 @@ module Bootsnap
         exclusive_write = File::Constants::CREAT | File::Constants::EXCL | File::Constants::WRONLY
         # `encoding:` looks redundant wrt `binwrite`, but necessary on windows
         # because binary is part of mode.
-        File.open(tmp, mode: exclusive_write, encoding: Encoding::BINARY) do |io|
+        File.open(tmp, mode: exclusive_write, binmode: true, encoding: Encoding::BINARY) do |io|
           MessagePack.dump(@data, io)
         end
         File.rename(tmp, @store_path)

data/lib/bootsnap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bootsnap
-  VERSION = "1.25.0"
+  VERSION = "1.26.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.1
 platform: ruby
 authors:
 - Burke Libbey
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Boot large ruby/rails apps faster
 test_files: []