rmagick 7.1.0 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c56286daf220fd8db82fce268ce2116705e192b643641cc88b4d7e53b6a46d1a
-  data.tar.gz: 1a060762de65e6bf6a384a7f10c3036f85d6876ec89c1be54fede6ea4f20e604
+  metadata.gz: 5ee430e845ae8794dc88e1af56d944fe511321c91eaabdda600810127f522c5e
+  data.tar.gz: b8705aec273d52d277bf4f73caeb00c78befdf803426eb14fedc3ddf0028399a
 SHA512:
-  metadata.gz: c7ebbec352d94fdeb8873353c8c13a8d3432b2f89c26c05a8520ee56353c1daedde3717429ad6ec1b9c66a9d9ca71eb51c498833ea0e7419fb572f38642d4fcd
-  data.tar.gz: c7a7941f288dd513f5ab88d009011c07575fc07e95c772fd3950db9d8828738c7ab49e6fa3484a4ead018ecbe0a002b260f4e0c670c70647aac11419465f09a5
+  metadata.gz: 48bc5436488b2b05f990e645ab294674b6d176dc584010686098b03b51cae5d67564b47d3ad5532a9001026027c1fb316f6b9b07fd7284c1825b82c5d084c365
+  data.tar.gz: 1a389dc68b01846feb575c5dcc3b42988baf99bfef0c03e7231db3d013973e1a74440dac99980295baa72efe5e1d01733a236854b43b6770aa461d7a6ed7e2e0

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project are documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## RMagick 7.1.1
+
+Bug Fixes
+
+* Fix Strings being recycled while the C pointers into them are in use (#1847)
+
 ## RMagick 7.1.0
 
 > [!IMPORTANT]

data/ext/RMagick/rmagick.h

@@ -1163,8 +1163,8 @@ extern void   rm_check_ary_len(VALUE, long);
 extern VALUE  rm_check_ary_type(VALUE ary);
 extern Image *rm_check_destroyed(VALUE);
 extern Image *rm_check_frozen(VALUE);
-extern char  *rm_str2cstr(VALUE, size_t *);
-extern char  *rm_path2cstr(VALUE, size_t *);
+extern char  *rm_str2cstr(VALUE *, size_t *);
+extern char  *rm_path2cstr(VALUE *, size_t *);
 extern int    rm_check_num2dbl(VALUE);
 extern double rm_fuzz_to_dbl(VALUE);
 extern Quantum rm_app2quantum(VALUE);

data/ext/RMagick/rmdraw.cpp

@@ -511,6 +511,8 @@ Image *str_to_image(VALUE str)
         DestroyExceptionInfo(exception);
     }
 
+    RB_GC_GUARD(str);
+
     return image;
 }
 
@@ -1617,6 +1619,7 @@ get_type_metrics(int argc, VALUE *argv, VALUE self, gvl_function_t fp)
     Image *image;
     Draw *draw;
     VALUE t;
+    VALUE text_arg = Qnil;
     TypeMetric metrics;
     char *text = NULL;
     size_t text_l;
@@ -1628,13 +1631,15 @@ get_type_metrics(int argc, VALUE *argv, VALUE self, gvl_function_t fp)
     switch (argc)
     {
         case 1:                   // use default image
-            text = rm_str2cstr(argv[0], &text_l);
+            text_arg = argv[0];
+            text = rm_str2cstr(&text_arg, &text_l);
             TypedData_Get_Struct(get_dummy_tm_img(CLASS_OF(self)), Image, &rm_image_data_type, image);
             break;
         case 2:
             t = rm_cur_image(argv[0]);
             image = rm_check_destroyed(t);
-            text = rm_str2cstr(argv[1], &text_l);
+            text_arg = argv[1];
+            text = rm_str2cstr(&text_arg, &text_l);
             break;                  // okay
         default:
             rb_raise(rb_eArgError, "wrong number of arguments (%d for 1 or 2)", argc);
@@ -1680,6 +1685,7 @@ get_type_metrics(int argc, VALUE *argv, VALUE self, gvl_function_t fp)
 #endif
 
     RB_GC_GUARD(t);
+    RB_GC_GUARD(text_arg);
 
     return Import_TypeMetric(&metrics);
 }

data/ext/RMagick/rmimage.cpp

@@ -2925,7 +2925,7 @@ set_profile(VALUE self, const char *name, VALUE profile)
 
     image = rm_check_frozen(self);
 
-    profile_blob = rm_str2cstr(profile, &profile_length);
+    profile_blob = rm_str2cstr(&profile, &profile_length);
 
     exception = AcquireExceptionInfo();
     m = GetMagickInfo(name, exception);
@@ -3002,6 +3002,8 @@ set_profile(VALUE self, const char *name, VALUE profile)
     rm_check_image_exception(image, RetainOnError);
 #endif
 
+    RB_GC_GUARD(profile);
+
     return self;
 }
 
@@ -4372,7 +4374,7 @@ Image_constitute(VALUE klass ATTRIBUTE_UNUSED, VALUE width_arg, VALUE height_arg
 
     width = NUM2LONG(width_arg);
     height = NUM2LONG(height_arg);
-    map = rm_str2cstr(map_arg, &map_l);
+    map = rm_str2cstr(&map_arg, &map_l);
 
     npixels = width * height * map_l;
     if (RARRAY_LEN(pixels_arg) != npixels)
@@ -4495,6 +4497,7 @@ Image_constitute(VALUE klass ATTRIBUTE_UNUSED, VALUE width_arg, VALUE height_arg
     RB_GC_GUARD(pixel);
     RB_GC_GUARD(pixel0);
     RB_GC_GUARD(pixel_class);
+    RB_GC_GUARD(map_arg);
 
     return rm_image_new(new_image);
 }
@@ -5252,6 +5255,8 @@ Image_decipher(VALUE self, VALUE passphrase)
 
     DestroyExceptionInfo(exception);
 
+    RB_GC_GUARD(passphrase);
+
     return rm_image_new(new_image);
 }
 
@@ -5753,7 +5758,7 @@ Image_dispatch(int argc, VALUE *argv, VALUE self)
     y       = NUM2LONG(argv[1]);
     columns = NUM2ULONG(argv[2]);
     rows    = NUM2ULONG(argv[3]);
-    map     = rm_str2cstr(argv[4], &mapL);
+    map     = rm_str2cstr(&argv[4], &mapL);
     if (argc == 6)
     {
         stg_type = RTEST(argv[5]) ? DoublePixel : QuantumPixel;
@@ -5803,6 +5808,7 @@ Image_dispatch(int argc, VALUE *argv, VALUE self)
     xfree((void *)pixels.v);
 
     RB_GC_GUARD(pixels_ary);
+    RB_GC_GUARD(argv[4]);
 
     return pixels_ary;
 }
@@ -6381,6 +6387,8 @@ Image_encipher(VALUE self, VALUE passphrase)
 
     DestroyExceptionInfo(exception);
 
+    RB_GC_GUARD(passphrase);
+
     return rm_image_new(new_image);
 }
 
@@ -7350,7 +7358,7 @@ Image_from_blob(VALUE klass ATTRIBUTE_UNUSED, VALUE blob_arg)
     void *blob;
     size_t length;
 
-    blob = (void *) rm_str2cstr(blob_arg, &length);
+    blob = (void *) rm_str2cstr(&blob_arg, &length);
 
     // Get a new Info object - run the parm block if supplied
     info_obj = rm_info_new();
@@ -7368,6 +7376,7 @@ Image_from_blob(VALUE klass ATTRIBUTE_UNUSED, VALUE blob_arg)
     rm_sync_image_options(images, info);
 
     RB_GC_GUARD(info_obj);
+    RB_GC_GUARD(blob_arg);
 
     return array_from_images(images);
 }
@@ -8155,7 +8164,7 @@ Image_import_pixels(int argc, VALUE *argv, VALUE self)
     // binary pixel data.
     if (rb_respond_to(pixel_arg, rb_intern("to_str")))
     {
-        buffer = (void *)rm_str2cstr(pixel_arg, &buffer_l);
+        buffer = (void *)rm_str2cstr(&pixel_arg, &buffer_l);
         switch (stg_type)
         {
             case CharPixel:
@@ -8956,7 +8965,7 @@ Image__load(VALUE klass ATTRIBUTE_UNUSED, VALUE str)
     char *blob;
     size_t length;
 
-    blob = rm_str2cstr(str, &length);
+    blob = rm_str2cstr(&str, &length);
 
     // Must be at least as big as the 1st 4 fields in DumpedImage
     if (length <= (long)(sizeof(DumpedImage)-MaxTextExtent))
@@ -9006,6 +9015,8 @@ Image__load(VALUE klass ATTRIBUTE_UNUSED, VALUE str)
     rm_check_exception(exception, image, DestroyOnError);
     DestroyExceptionInfo(exception);
 
+    RB_GC_GUARD(str);
+
     return rm_image_new(image);
 }
 
@@ -9169,6 +9180,9 @@ Image_marshal_load(VALUE self, VALUE ary)
     UPDATE_DATA_PTR(self, new_image);
     rm_image_destroy(image);
 
+    RB_GC_GUARD(filename);
+    RB_GC_GUARD(blob);
+
     return self;
 }
 
@@ -11624,7 +11638,7 @@ rd_image(VALUE klass ATTRIBUTE_UNUSED, VALUE file, gvl_function_t fp)
         // Convert arg to string. If an exception occurs raise an error condition.
         file = rb_rescue(RESCUE_FUNC(rb_String), file, RESCUE_EXCEPTION_HANDLER_FUNC(file_arg_rescue), file);
 
-        filename = rm_path2cstr(file, &filename_l);
+        filename = rm_path2cstr(&file, &filename_l);
         filename_l = min(filename_l, MaxTextExtent-1);
         if (filename_l == 0)
         {
@@ -11771,7 +11785,7 @@ Image_read_inline(VALUE self ATTRIBUTE_UNUSED, VALUE content)
     size_t blob_l;
     ExceptionInfo *exception;
 
-    image_data = rm_str2cstr(content, &image_data_l);
+    image_data = rm_str2cstr(&content, &image_data_l);
 
     // Search for a comma. If found, we'll set the start of the
     // image data just following the comma. Otherwise we'll assume
@@ -11813,6 +11827,7 @@ Image_read_inline(VALUE self ATTRIBUTE_UNUSED, VALUE content)
     rm_sync_image_options(images, info);
 
     RB_GC_GUARD(info_obj);
+    RB_GC_GUARD(content);
 
     return array_from_images(images);
 }
@@ -12350,7 +12365,7 @@ rotate(int bang, int argc, VALUE *argv, VALUE self)
     switch (argc)
     {
         case 2:
-            arrow = rm_str2cstr(argv[1], &arrow_l);
+            arrow = rm_str2cstr(&argv[1], &arrow_l);
             if (arrow_l != 1 || (*arrow != '<' && *arrow != '>'))
             {
                 rb_raise(rb_eArgError, "second argument must be '<' or '>', '%s' given", arrow);
@@ -15913,7 +15928,7 @@ void add_format_prefix(Info *info, VALUE file)
     }
     file = rb_rescue(RESCUE_FUNC(rb_String), file, RESCUE_EXCEPTION_HANDLER_FUNC(file_arg_rescue), file);
 
-    filename = rm_path2cstr(file, &filename_l);
+    filename = rm_path2cstr(&file, &filename_l);
 
     if (*info->magick == '\0')
     {

data/ext/RMagick/rminfo.cpp

@@ -269,8 +269,8 @@ Info_aref(int argc, VALUE *argv, VALUE self)
     switch (argc)
     {
         case 2:
-            format_p = rm_str2cstr(argv[0], &format_l);
-            key_p = rm_str2cstr(argv[1], &key_l);
+            format_p = rm_str2cstr(&argv[0], &format_l);
+            key_p = rm_str2cstr(&argv[1], &key_l);
             if (format_l > MAX_FORMAT_LEN || format_l + key_l > MaxTextExtent-1)
             {
                 rb_raise(rb_eArgError, "can't reference %.60s:%.1024s - too long", format_p, key_p);
@@ -333,8 +333,8 @@ Info_aset(int argc, VALUE *argv, VALUE self)
     switch (argc)
     {
         case 3:
-            format_p = rm_str2cstr(argv[0], &format_l);
-            key_p = rm_str2cstr(argv[1], &key_l);
+            format_p = rm_str2cstr(&argv[0], &format_l);
+            key_p = rm_str2cstr(&argv[1], &key_l);
 
             if (format_l > MAX_FORMAT_LEN || format_l+key_l > MaxTextExtent-1)
             {
@@ -707,8 +707,8 @@ Info_define(int argc, VALUE *argv, VALUE self)
             fmt_arg = rb_String(argv[2]);
             value = (const char *)StringValueCStr(fmt_arg);
         case 2:
-            key = rm_str2cstr(argv[1], &key_l);
-            format = rm_str2cstr(argv[0], &format_l);
+            key = rm_str2cstr(&argv[1], &key_l);
+            format = rm_str2cstr(&argv[0], &format_l);
             break;
         default:
             rb_raise(rb_eArgError, "wrong number of arguments (%d for 2 or 3)", argc);
@@ -1850,7 +1850,7 @@ Info_sampling_factor_eq(VALUE self, VALUE sampling_factor)
 
     if (!NIL_P(sampling_factor))
     {
-        sampling_factor_p = rm_str2cstr(sampling_factor, &sampling_factor_len);
+        sampling_factor_p = rm_str2cstr(&sampling_factor, &sampling_factor_len);
     }
 
     if (info->sampling_factor)
@@ -2187,8 +2187,8 @@ Info_undefine(VALUE self, VALUE format, VALUE key)
     size_t format_l, key_l;
     char fkey[MaxTextExtent];
 
-    format_p = rm_str2cstr(format, &format_l);
-    key_p = rm_str2cstr(key, &key_l);
+    format_p = rm_str2cstr(&format, &format_l);
+    key_p = rm_str2cstr(&key, &key_l);
 
     if (format_l > MAX_FORMAT_LEN || format_l + key_l > MaxTextExtent)
     {

data/ext/RMagick/rmkinfo.cpp

@@ -188,8 +188,13 @@ KernelInfo_scale(VALUE self, VALUE scale, VALUE flags)
 VALUE
 KernelInfo_scale_geometry(VALUE self, VALUE geometry)
 {
-    GVL_STRUCT_TYPE(ScaleGeometryKernelInfo) args = { get_kernel_info(self), StringValueCStr(geometry) };
+    char *geom = StringValueCStr(geometry);
+
+    GVL_STRUCT_TYPE(ScaleGeometryKernelInfo) args = { get_kernel_info(self), geom };
     CALL_FUNC_WITHOUT_GVL(GVL_FUNC(ScaleGeometryKernelInfo), &args);
+
+    RB_GC_GUARD(geometry);
+
     return Qnil;
 }
 

data/ext/RMagick/rmutil.cpp

@@ -320,21 +320,34 @@ rm_no_freeze(VALUE obj)
 /**
  * Supply our own version of the "obsolete" rb_str2cstr.
  *
+ * The argument is taken by reference because StringValue may replace it. When
+ * the argument is not a String but responds to #to_str, StringValue converts
+ * it and the String it produces is referenced by nothing but the variable it
+ * is stored in. Writing that String back into the caller's variable is what
+ * keeps it - and therefore the buffer the returned pointer addresses - alive
+ * for as long as the caller can see it. Taking the argument by value would
+ * leave the String unreferenced the moment this function returns, and the GC
+ * would be free to recycle it out from under the pointer.
+ *
+ * Callers must still RB_GC_GUARD the variable after their last use of the
+ * pointer whenever the GC can run in between - that is, whenever they release
+ * the GVL or call into Ruby.
+ *
  * No Ruby usage (internal function)
  *
- * @param str the Ruby string
+ * @param str pointer to the Ruby string, updated in place if it is converted
  * @param len pointer to a size_t in which to store the number of characters
  * @return a C string version of str
  */
 char *
-rm_str2cstr(VALUE str, size_t *len)
+rm_str2cstr(VALUE *str, size_t *len)
 {
-    StringValue(str);
+    StringValue(*str);
     if (len)
     {
-        *len = (size_t)RSTRING_LEN(str);
+        *len = (size_t)RSTRING_LEN(*str);
     }
-    return RSTRING_PTR(str);
+    return RSTRING_PTR(*str);
 }
 
 
@@ -350,19 +363,20 @@ rm_str2cstr(VALUE str, size_t *len)
  *
  * No Ruby usage (internal function)
  *
- * @param str the Ruby string
+ * @param str pointer to the Ruby string, updated in place if it is converted
  * @param len pointer to a size_t in which to store the number of characters
  * @return a C string version of str
  * @throw ArgumentError if str contains a NUL byte
+ * @see rm_str2cstr for why the argument is taken by reference
  */
 char *
-rm_path2cstr(VALUE str, size_t *len)
+rm_path2cstr(VALUE *str, size_t *len)
 {
-    char *path = StringValueCStr(str);
+    char *path = StringValueCStr(*str);
 
     if (len)
     {
-        *len = (size_t)RSTRING_LEN(str);
+        *len = (size_t)RSTRING_LEN(*str);
     }
     return path;
 }

data/lib/rmagick/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Magick
-  VERSION = '7.1.0'
+  VERSION = '7.1.1'
   MIN_RUBY_VERSION = '3.2.0'
   MIN_IM6_VERSION = '6.9.0'
   MIN_IM7_VERSION = '7.1.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rmagick
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.1.1
 platform: ruby
 authors:
 - Tim Hunter