bootsnap 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e46c28f258eb76b8c90fa22a7fa2c83887695b7c12d3aff8dbbefda5051dca87
-  data.tar.gz: 33aaa301627c53d2f4db1b8e98db0b2f52dc8d20aa533c8de8dc9448bf0c0b8e
+  metadata.gz: 6227028d2a559d0e5129ef91915f65a064082b2e1326517dd67da2f11d91d194
+  data.tar.gz: 1c7cbf82581f9162601a7723812201d240661c0d3477373b820cf7e942b9d416
 SHA512:
-  metadata.gz: 77f885b700f2d249da6afd6ed4a70e4b37bf27303ddabefdfbed915fea6e61587d3e0fa56ee5159a95416072d58d4994498ee29bf69a3ab70c3b9e98471c3a0a
-  data.tar.gz: 7044ce0c6a30d7312d947da11b20755dbd496ee7b5f460293bf9188c83493ac951e6e683f75009b17860c45a7ff31e3264abffd69dcaf5a0e8c6b759b7631332
+  metadata.gz: 385183b9de17b6f72634b7307fdfc5481108afc06554b48bb2dede97e51ba4275d076357934d338286fceb3a221f1468ec2ea10e2f0f869de5a7b5b97fc444a8
+  data.tar.gz: c74bb8bdfe0e6f3615bbc4a6ea4f7c5a7a1d8589a3469da964c25b44451fbb3f54f10521b8549dc6ac400d7fb17ba4a686b5b289115e8b3bac81d7a5449e3c0b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Unreleased
 
+# 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

@@ -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/lib/bootsnap/compile_cache/iseq.rb

@@ -172,11 +172,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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootsnap
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Burke Libbey