Merge branch 'master' into pdfload-add-page-box

jcupitt · web-flow · commit e1c2bf933e15 · 2025-07-11T11:46:37.000+01:00
diff --git a/ChangeLog b/ChangeLog
@@ -4,6 +4,9 @@ master
   using libraw [lxsameer]
 - add magickload_source: load from a source with imagemagick
 - pdfload: control region to be rendered via `page_box` [lovell]
+- add vips__worker_exit(): enables fast threadpool shutdown
+- larger mmap windows on 64-bit machines improve random access mode for many
+  file formats
 
 7/7/25 8.17.1
 
diff --git a/libvips/conversion/subsample.c b/libvips/conversion/subsample.c
@@ -53,6 +53,7 @@
 #include <stdlib.h>
 
 #include <vips/vips.h>
+#include <vips/internal.h>
 
 #include "pconversion.h"
 
@@ -102,7 +103,10 @@ vips_subsample_line_gen(VipsRegion *out_region,
 		VipsPel *q = VIPS_REGION_ADDR(out_region, le, y);
 		VipsPel *p;
 
-		/* Loop across the region, in owidth sized pieces.
+		if (vips__worker_exit())
+			return 0;
+
+		/* Loop across the region, in owidth-sized pieces.
 		 */
 		for (x = le; x < ri; x += owidth) {
 			/* How many pixels do we make this time?
@@ -165,20 +169,17 @@ vips_subsample_point_gen(VipsRegion *out_region,
 		VipsPel *q = VIPS_REGION_ADDR(out_region, le, y);
 		VipsPel *p;
 
-		/* Loop across the region, in owidth sized pieces.
-		 */
+		if (vips__worker_exit())
+			return 0;
+
 		for (x = le; x < ri; x++) {
-			/* Ask for input.
-			 */
 			s.left = x * subsample->xfac;
 			s.top = y * subsample->yfac;
 			s.width = 1;
 			s.height = 1;
 			if (vips_region_prepare(ir, &s))
 				return -1;
 
-			/* Append new pels to output.
-			 */
 			p = VIPS_REGION_ADDR(ir, s.left, s.top);
 			for (k = 0; k < ps; k++)
 				q[k] = p[k];
diff --git a/libvips/foreign/foreign.c b/libvips/foreign/foreign.c
@@ -357,19 +357,19 @@ static GQuark vips__foreign_load_operation = 0;
  *
  * Some hints about the image loader.
  *
- * [flags@Vips.ForeignFlags.PARTIAL] means that the image can be read directly from the
- * file without needing to be unpacked to a temporary image first.
+ * [flags@Vips.ForeignFlags.PARTIAL] means that the image can be read directly
+ * from the file without needing to be unpacked to a temporary image first.
  *
- * [flags@Vips.ForeignFlags.SEQUENTIAL] means that the loader supports lazy reading, but
- * only top-to-bottom (sequential) access. Formats like PNG can read sets of
- * scanlines, for example, but only in order.
+ * [flags@Vips.ForeignFlags.SEQUENTIAL] means that the loader supports lazy
+ * reading, but only top-to-bottom (sequential) access. Formats like PNG can
+ * read sets of scanlines, for example, but only in order.
  *
  * If neither PARTIAL or SEQUENTIAL is set, the loader only supports whole
  * image read. Setting both PARTIAL and SEQUENTIAL is an error.
  *
- * [flags@Vips.ForeignFlags.BIGENDIAN] means that image pixels are most-significant byte
- * first. Depending on the native byte order of the host machine, you may
- * need to swap bytes. See [method@Image.copy].
+ * [flags@Vips.ForeignFlags.BIGENDIAN] means that image pixels are
+ * most-significant byte first. Depending on the native byte order of the
+ * host machine, you may need to swap bytes. See [method@Image.copy].
  */
 
 G_DEFINE_ABSTRACT_TYPE(VipsForeign, vips_foreign, VIPS_TYPE_OPERATION);
diff --git a/libvips/include/vips/internal.h b/libvips/include/vips/internal.h
@@ -166,6 +166,7 @@ void vips_threadset_free(VipsThreadset *set);
 
 VIPS_API void vips__worker_lock(GMutex *mutex);
 VIPS_API void vips__worker_cond_wait(GCond *cond, GMutex *mutex);
+gboolean vips__worker_exit(void);
 
 void vips__cache_init(void);
 
diff --git a/libvips/include/vips/private.h b/libvips/include/vips/private.h
@@ -44,16 +44,6 @@ extern "C" {
 
 #define VIPS_SPARE (8)
 
-/* Private to iofuncs: the minimum number of scanlines we add above and below
- * the window as a margin for slop.
- */
-#define VIPS__WINDOW_MARGIN_PIXELS (128)
-
-/* Private to iofuncs: add at least this many bytes above and below the window.
- * There's no point mapping just a few KB of a small image.
- */
-#define VIPS__WINDOW_MARGIN_BYTES (1024 * 1024 * 10)
-
 /* sizeof() a VIPS header on disc.
  */
 #define VIPS_SIZEOF_HEADER (64)
diff --git a/libvips/include/vips/threadpool.h b/libvips/include/vips/threadpool.h
@@ -96,7 +96,6 @@ typedef struct _VipsThreadState {
 	 * debugging race conditions.
 	 */
 	gboolean stall;
-
 } VipsThreadState;
 
 typedef struct _VipsThreadStateClass {
diff --git a/libvips/iofuncs/image.c b/libvips/iofuncs/image.c
@@ -832,9 +832,6 @@ vips_image_build(VipsObject *object)
 	 */
 	switch (mode[0]) {
 	case 'v':
-		/* Used by 'r' for native open of vips, see below. Also by
-		 * vips_image_rewind_output().
-		 */
 		if (vips_image_open_input(image))
 			return -1;
 
@@ -857,8 +854,7 @@ vips_image_build(VipsObject *object)
 				/* Open the image in t, then byteswap to this
 				 * image.
 				 */
-				if (!(t = vips_image_new_mode(filename,
-						  "v")))
+				if (!(t = vips_image_new_mode(filename, "v")))
 					return -1;
 
 				if (vips_byteswap(t, &t2, NULL)) {
@@ -918,9 +914,8 @@ vips_image_build(VipsObject *object)
 			image->dtype = VIPS_IMAGE_OPENOUT;
 		else {
 			image->dtype = VIPS_IMAGE_PARTIAL;
-			g_signal_connect(image, "written",
-				G_CALLBACK(vips_image_save_cb),
-				NULL);
+			g_signal_connect(image,
+				"written", G_CALLBACK(vips_image_save_cb), NULL);
 		}
 	} break;
 
@@ -958,17 +953,15 @@ vips_image_build(VipsObject *object)
 			image->sizeof_header;
 		if (image->file_length < sizeof_image) {
 			vips_error("VipsImage",
-				_("unable to open \"%s\", file too short"),
-				image->filename);
+				_("unable to open \"%s\", file too short"), image->filename);
 			return -1;
 		}
 
 		/* Just weird. Only print a warning for this, since we should
 		 * still be able to process it without coredumps.
 		 */
 		if (image->file_length > sizeof_image)
-			g_warning("%s is longer than expected",
-				image->filename);
+			g_warning("%s is longer than expected", image->filename);
 		break;
 
 	case 'm':
@@ -986,7 +979,6 @@ vips_image_build(VipsObject *object)
 
 	default:
 		vips_error("VipsImage", _("bad mode \"%s\""), mode);
-
 		return -1;
 	}
 
@@ -1759,8 +1751,8 @@ vips_image_new_mode(const char *filename, const char *mode)
 /**
  * vips_image_new_memory: (skip)
  *
- * [ctor@Image.new_memory] creates a new [class@Image] which, when written to, will
- * create a memory image.
+ * [ctor@Image.new_memory] creates a new [class@Image] which, when written to,
+ * will create a memory image.
  *
  * ::: seealso
  *     [ctor@Image.new].
@@ -3309,8 +3301,7 @@ vips_image_rewind_output(VipsImage *image)
 		NULL);
 	if (vips_object_build(VIPS_OBJECT(image))) {
 		vips_error("VipsImage",
-			_("auto-rewind for %s failed"),
-			image->filename);
+			_("auto-rewind for %s failed"), image->filename);
 		return -1;
 	}
 
@@ -3657,8 +3648,7 @@ vips_image_pio_input(VipsImage *image)
 		/* Should have been written to.
 		 */
 		if (!image->data) {
-			vips_error("vips_image_pio_input",
-				"%s", _("no image data"));
+			vips_error("vips_image_pio_input", "%s", _("no image data"));
 			return -1;
 		}
 
@@ -3683,7 +3673,6 @@ vips_image_pio_input(VipsImage *image)
 		break;
 
 	case VIPS_IMAGE_OPENOUT:
-
 		/* Free any resources the image holds and reset to a base
 		 * state.
 		 */
@@ -3693,8 +3682,7 @@ vips_image_pio_input(VipsImage *image)
 		break;
 
 	default:
-		vips_error("vips_image_pio_input",
-			"%s", _("image not readable"));
+		vips_error("vips_image_pio_input", "%s", _("image not readable"));
 		return -1;
 	}
 
diff --git a/libvips/iofuncs/sinkscreen.c b/libvips/iofuncs/sinkscreen.c
@@ -115,10 +115,10 @@ typedef struct _Render {
 
 	/* Parameters.
 	 */
-	VipsImage *in;	 /* Image we render */
-	VipsImage *out;	 /* Write tiles here on demand */
-	VipsImage *mask; /* Set valid pixels here */
-	int tile_width;	 /* Tile size */
+	VipsImage *in;			/* Image we render */
+	VipsImage *out;			/* Write tiles here on demand */
+	VipsImage *mask;		/* Set valid pixels here */
+	int tile_width;			/* Tile size */
 	int tile_height;
 	int max_tiles;		   /* Maximum number of tiles */
 	int priority;		   /* Larger numbers done sooner */
@@ -139,9 +139,9 @@ typedef struct _Render {
 
 	/* Tile cache.
 	 */
-	GSList *all; /* All our tiles */
-	int ntiles;	 /* Number of tiles */
-	int ticks;	 /* Inc. on each access ... used for LRU */
+	GSList *all;			/* All our tiles */
+	int ntiles;				/* Number of tiles */
+	int ticks;				/* Inc. on each access ... used for LRU */
 
 	/* List of dirty tiles. Most recent at the front.
 	 */
@@ -194,6 +194,18 @@ static VipsSemaphore n_render_dirty_sem;
  */
 static gboolean render_reschedule = FALSE;
 
+/* Set this GPrivate to link a thread back to its Render struct.
+ */
+static GPrivate render_worker_key;
+
+gboolean
+vips__worker_exit(void)
+{
+	Render *render = (Render *) g_private_get(&render_worker_key);
+
+	return render && render->shutdown;
+}
+
 static void
 render_thread_state_class_init(RenderThreadStateClass *class)
 {
@@ -269,6 +281,7 @@ render_free(Render *render)
 
 #ifdef VIPS_DEBUG_AMBER
 	render_num_renders -= 1;
+	printf("%d active renders\n", render_num_renders);
 #endif /*VIPS_DEBUG_AMBER*/
 
 	return 0;
@@ -295,7 +308,7 @@ render_ref(Render *render)
 static int
 render_unref(Render *render)
 {
-	int kill;
+	gboolean kill;
 
 #if GLIB_CHECK_VERSION(2, 58, 0)
 	g_assert(!g_atomic_ref_count_compare(&render->ref_count, 0));
@@ -426,10 +439,16 @@ render_work(VipsThreadState *state, void *a)
 	VIPS_DEBUG_MSG("calculating tile %p %dx%d\n",
 		tile, tile->area.left, tile->area.top);
 
+	/* vips__worker_exit() uses this to find the render to check for
+	 * shutdown.
+	 */
+	g_private_set(&render_worker_key, render);
+
 	if (vips_region_prepare_to(state->reg, tile->region,
 			&tile->area, tile->area.left, tile->area.top)) {
 		VIPS_DEBUG_MSG_RED("render_work: vips_region_prepare_to() failed: %s\n",
 			vips_error_buffer());
+		g_private_set(&render_worker_key, NULL);
 		return -1;
 	}
 	tile->painted = TRUE;
@@ -438,6 +457,8 @@ render_work(VipsThreadState *state, void *a)
 		render->notify)
 		render->notify(render->out, &tile->area, render->a);
 
+	g_private_set(&render_worker_key, NULL);
+
 	return 0;
 }
 
@@ -620,6 +641,7 @@ render_new(VipsImage *in, VipsImage *out, VipsImage *mask,
 
 #ifdef VIPS_DEBUG_AMBER
 	render_num_renders += 1;
+	printf("%d active renders\n", render_num_renders);
 #endif /*VIPS_DEBUG_AMBER*/
 
 	return render;
@@ -1094,6 +1116,11 @@ render_work_private(void *data, void *null)
 
 	Render *render = (Render *) data;
 
+	/* vips__worker_exit() uses this to find the render to check for
+	 * shutdown.
+	 */
+	g_private_set(&render_worker_key, render);
+
 	// this will quit on ->shutdown == TRUE
 	if (vips_threadpool_run(render->in,
 			render_thread_state_new,
@@ -1103,6 +1130,8 @@ render_work_private(void *data, void *null)
 			render))
 		VIPS_DEBUG_MSG_RED("render_work_private: threadpool_run failed\n");
 
+	g_private_set(&render_worker_key, NULL);
+
 	render_unref(render);
 
 	VIPS_DEBUG_MSG_AMBER("render_work_private: stop\n");
@@ -1144,11 +1173,11 @@ vips__sink_screen_once(void *data)
  * uchar image and has 255 for pixels which are currently in cache and 0
  * for uncalculated pixels.
  *
- * Renders with a positive priority are assumed to be large, gh-priority,
+ * Renders with a positive priority are assumed to be large, high-priority,
  * foreground images. Although there can be many of these, only one is ever
  * active, to avoid overcommitting threads.
  *
- * Renders with a negative priority are assumed to be small, thumbnail images
+ * Renders with a negative priority are assumed to be small, thumbnail images,
  * consisting of a single tile. Single tile images are effectively
  * single-threaded, so all these renders are evaluated together.
  *
diff --git a/libvips/iofuncs/threadpool.c b/libvips/iofuncs/threadpool.c
@@ -379,8 +379,6 @@ vips_thread_main_loop(void *a, void *b)
 	VipsWorker *worker = (VipsWorker *) a;
 	VipsThreadpool *pool = worker->pool;
 
-	g_assert(pool == worker->pool);
-
 	VIPS_GATE_START("vips_thread_main_loop: thread");
 
 	g_private_set(&worker_key, worker);
@@ -481,9 +479,6 @@ vips_threadpool_wait(VipsThreadpool *pool)
 static void
 vips_threadpool_free(VipsThreadpool *pool)
 {
-	VIPS_DEBUG_MSG("vips_threadpool_free: \"%s\" (%p)\n",
-		pool->im->filename, pool);
-
 	vips_threadpool_wait(pool);
 
 	g_mutex_clear(&pool->allocate_lock);
@@ -532,9 +527,6 @@ vips_threadpool_new(VipsImage *im)
 	 */
 	pool->max_workers = vips_image_get_concurrency(im, pool->max_workers);
 
-	VIPS_DEBUG_MSG("vips_threadpool_new: \"%s\" (%p), with %d threads\n",
-		im->filename, pool, pool->max_workers);
-
 	return pool;
 }
 
diff --git a/libvips/iofuncs/vips.c b/libvips/iofuncs/vips.c
diff --git a/libvips/iofuncs/window.c b/libvips/iofuncs/window.c

Original file line number	Diff line number	Diff line change
`@@ -357,19 +357,19 @@ static GQuark vips__foreign_load_operation = 0;`
`357`	`357`	`*`
`358`	`358`	`* Some hints about the image loader.`
`359`	`359`	`*`
`360`		`- * [flags@Vips.ForeignFlags.PARTIAL] means that the image can be read directly from the`
`361`		`- * file without needing to be unpacked to a temporary image first.`
	`360`	`+ * [flags@Vips.ForeignFlags.PARTIAL] means that the image can be read directly`
	`361`	`+ * from the file without needing to be unpacked to a temporary image first.`
`362`	`362`	`*`
`363`		`- * [flags@Vips.ForeignFlags.SEQUENTIAL] means that the loader supports lazy reading, but`
`364`		`- * only top-to-bottom (sequential) access. Formats like PNG can read sets of`
`365`		`- * scanlines, for example, but only in order.`
	`363`	`+ * [flags@Vips.ForeignFlags.SEQUENTIAL] means that the loader supports lazy`
	`364`	`+ * reading, but only top-to-bottom (sequential) access. Formats like PNG can`
	`365`	`+ * read sets of scanlines, for example, but only in order.`
`366`	`366`	`*`
`367`	`367`	`* If neither PARTIAL or SEQUENTIAL is set, the loader only supports whole`
`368`	`368`	`* image read. Setting both PARTIAL and SEQUENTIAL is an error.`
`369`	`369`	`*`
`370`		`- * [flags@Vips.ForeignFlags.BIGENDIAN] means that image pixels are most-significant byte`
`371`		`- * first. Depending on the native byte order of the host machine, you may`
`372`		`- * need to swap bytes. See [method@Image.copy].`
	`370`	`+ * [flags@Vips.ForeignFlags.BIGENDIAN] means that image pixels are`
	`371`	`+ * most-significant byte first. Depending on the native byte order of the`
	`372`	`+ * host machine, you may need to swap bytes. See [method@Image.copy].`
`373`	`373`	`*/`
`374`	`374`
`375`	`375`	`G_DEFINE_ABSTRACT_TYPE(VipsForeign, vips_foreign, VIPS_TYPE_OPERATION);`