Add runtime detection of V8 memory cage #3384

lovell · lovell · commit 584807b4f5e1 · 2022-12-14T16:06:04.000Z
When using the V8 memory cage, Buffers cannot be wrapped and then
later freed via a callback. When the cage is detected via a throw,
instead fall back to copying Buffer contents to V8 memory.

This approach will be used by Electron 21+ and you should expect
reduced performance and increased memory consumption/fragmentation.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -9,6 +9,9 @@ Requires libvips v8.13.3
 * Add experimental support for JPEG-XL images. Requires libvips compiled with libjxl.
   [#2731](https://github.com/lovell/sharp/issues/2731)
 
+* Add runtime detection of V8 memory cage, ensures compatibility with Electron 21 onwards.
+  [#3384](https://github.com/lovell/sharp/issues/3384)
+
 * Expose `interFrameMaxError` and `interPaletteMaxError` GIF optimisation properties.
   [#3401](https://github.com/lovell/sharp/issues/3401)
 
diff --git a/src/common.cc b/src/common.cc
@@ -76,6 +76,14 @@ namespace sharp {
     }
     return vector;
   }
+  Napi::Buffer<char> NewOrCopyBuffer(Napi::Env env, char* data, size_t len) {
+    try {
+      return Napi::Buffer<char>::New(env, data, len, FreeCallback);
+    } catch (Napi::Error const &err) {}
+    Napi::Buffer<char> buf = Napi::Buffer<char>::Copy(env, data, len);
+    FreeCallback(nullptr, data);
+    return buf;
+  }
 
   // Create an InputDescriptor instance from a Napi::Object describing an input image
   InputDescriptor* CreateInputDescriptor(Napi::Object input) {
diff --git a/src/common.h b/src/common.h
@@ -133,6 +133,7 @@ namespace sharp {
     return static_cast<T>(
       vips_enum_from_nick(nullptr, type, AttrAsStr(obj, attr).data()));
   }
+  Napi::Buffer<char> NewOrCopyBuffer(Napi::Env env, char* data, size_t len);
 
   // Create an InputDescriptor instance from a Napi::Object describing an input image
   InputDescriptor* CreateInputDescriptor(Napi::Object input);
diff --git a/src/metadata.cc b/src/metadata.cc
@@ -235,20 +235,20 @@ class MetadataWorker : public Napi::AsyncWorker {
         info.Set("orientation", baton->orientation);
       }
       if (baton->exifLength > 0) {
-        info.Set("exif", Napi::Buffer<char>::New(env, baton->exif, baton->exifLength, sharp::FreeCallback));
+        info.Set("exif", sharp::NewOrCopyBuffer(env, baton->exif, baton->exifLength));
       }
       if (baton->iccLength > 0) {
-        info.Set("icc", Napi::Buffer<char>::New(env, baton->icc, baton->iccLength, sharp::FreeCallback));
+        info.Set("icc", sharp::NewOrCopyBuffer(env, baton->icc, baton->iccLength));
       }
       if (baton->iptcLength > 0) {
-        info.Set("iptc", Napi::Buffer<char>::New(env, baton->iptc, baton->iptcLength, sharp::FreeCallback));
+        info.Set("iptc", sharp::NewOrCopyBuffer(env, baton->iptc, baton->iptcLength));
       }
       if (baton->xmpLength > 0) {
-        info.Set("xmp", Napi::Buffer<char>::New(env, baton->xmp, baton->xmpLength, sharp::FreeCallback));
+        info.Set("xmp", sharp::NewOrCopyBuffer(env, baton->xmp, baton->xmpLength));
       }
       if (baton->tifftagPhotoshopLength > 0) {
         info.Set("tifftagPhotoshop",
-          Napi::Buffer<char>::New(env, baton->tifftagPhotoshop, baton->tifftagPhotoshopLength, sharp::FreeCallback));
+          sharp::NewOrCopyBuffer(env, baton->tifftagPhotoshop, baton->tifftagPhotoshopLength));
       }
       Callback().MakeCallback(Receiver().Value(), { env.Null(), info });
     } else {
diff --git a/src/pipeline.cc b/src/pipeline.cc
@@ -1206,8 +1206,8 @@ class PipelineWorker : public Napi::AsyncWorker {
         // Add buffer size to info
         info.Set("size", static_cast<uint32_t>(baton->bufferOutLength));
         // Pass ownership of output data to Buffer instance
-        Napi::Buffer<char> data = Napi::Buffer<char>::New(env, static_cast<char*>(baton->bufferOut),
-          baton->bufferOutLength, sharp::FreeCallback);
+        Napi::Buffer<char> data = sharp::NewOrCopyBuffer(env, static_cast<char*>(baton->bufferOut),
+          baton->bufferOutLength);
         Callback().MakeCallback(Receiver().Value(), { env.Null(), data, info });
       } else {
         // Add file size to info

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,14 @@ namespace sharp {`
`76`	`76`	`}`
`77`	`77`	`return vector;`
`78`	`78`	`}`
	`79`	`+ Napi::Buffer<char> NewOrCopyBuffer(Napi::Env env, char* data, size_t len) {`
	`80`	`+ try {`
	`81`	`+ return Napi::Buffer<char>::New(env, data, len, FreeCallback);`
	`82`	`+ } catch (Napi::Error const &err) {}`
	`83`	`+ Napi::Buffer<char> buf = Napi::Buffer<char>::Copy(env, data, len);`
	`84`	`+ FreeCallback(nullptr, data);`
	`85`	`+ return buf;`
	`86`	`+ }`
`79`	`87`
`80`	`88`	`// Create an InputDescriptor instance from a Napi::Object describing an input image`
`81`	`89`	`InputDescriptor* CreateInputDescriptor(Napi::Object input) {`
Original file line number	Diff line number	Diff line change
`@@ -133,6 +133,7 @@ namespace sharp {`
`133`	`133`	`return static_cast<T>(`
`134`	`134`	`vips_enum_from_nick(nullptr, type, AttrAsStr(obj, attr).data()));`
`135`	`135`	`}`
	`136`	`+ Napi::Buffer<char> NewOrCopyBuffer(Napi::Env env, char* data, size_t len);`
`136`	`137`
`137`	`138`	`// Create an InputDescriptor instance from a Napi::Object describing an input image`
`138`	`139`	`InputDescriptor* CreateInputDescriptor(Napi::Object input);`
Original file line number	Diff line number	Diff line change
`@@ -235,20 +235,20 @@ class MetadataWorker : public Napi::AsyncWorker {`
`235`	`235`	`info.Set("orientation", baton->orientation);`
`236`	`236`	`}`
`237`	`237`	`if (baton->exifLength > 0) {`
`238`		`- info.Set("exif", Napi::Buffer<char>::New(env, baton->exif, baton->exifLength, sharp::FreeCallback));`
	`238`	`+ info.Set("exif", sharp::NewOrCopyBuffer(env, baton->exif, baton->exifLength));`
`239`	`239`	`}`
`240`	`240`	`if (baton->iccLength > 0) {`
`241`		`- info.Set("icc", Napi::Buffer<char>::New(env, baton->icc, baton->iccLength, sharp::FreeCallback));`
	`241`	`+ info.Set("icc", sharp::NewOrCopyBuffer(env, baton->icc, baton->iccLength));`
`242`	`242`	`}`
`243`	`243`	`if (baton->iptcLength > 0) {`
`244`		`- info.Set("iptc", Napi::Buffer<char>::New(env, baton->iptc, baton->iptcLength, sharp::FreeCallback));`
	`244`	`+ info.Set("iptc", sharp::NewOrCopyBuffer(env, baton->iptc, baton->iptcLength));`
`245`	`245`	`}`
`246`	`246`	`if (baton->xmpLength > 0) {`
`247`		`- info.Set("xmp", Napi::Buffer<char>::New(env, baton->xmp, baton->xmpLength, sharp::FreeCallback));`
	`247`	`+ info.Set("xmp", sharp::NewOrCopyBuffer(env, baton->xmp, baton->xmpLength));`
`248`	`248`	`}`
`249`	`249`	`if (baton->tifftagPhotoshopLength > 0) {`
`250`	`250`	`info.Set("tifftagPhotoshop",`
`251`		`- Napi::Buffer<char>::New(env, baton->tifftagPhotoshop, baton->tifftagPhotoshopLength, sharp::FreeCallback));`
	`251`	`+ sharp::NewOrCopyBuffer(env, baton->tifftagPhotoshop, baton->tifftagPhotoshopLength));`
`252`	`252`	`}`
`253`	`253`	`Callback().MakeCallback(Receiver().Value(), { env.Null(), info });`
`254`	`254`	`} else {`