Add 'flight-data-recorder' utility.

This is a simple variation on cairo-trace that wraps records the last 16
contexts by wrapping the target surface inside a tee surface, along with a
meta/recording surface. Then on receipt of a SIGUSR1, those last 16
contexts are played via a script-surface into /tmp/fdr.trace.

Mostly proof-of-concept, it seems to be causing a number of rendering
glitches whilst testing with firefox -- otherwise, it seems to works.

2 files changed, 317 insertions, 0 deletions

diff --git a/util/cairo-fdr/Makefile.am b/util/cairo-fdr/Makefile.am
new file mode 100644
index 000000000..5cd5798e1
--- /dev/null
+++ b/util/cairo-fdr/Makefile.am
@@ -0,0 +1,13 @@
+cairolibdir = $(libdir)/cairo
+
+#bin_SCRIPTS = cairo-fdr
+cairolib_LTLIBRARIES = cairo-fdr.la
+
+AM_CPPFLAGS = -I$(top_srcdir)/src \
+	      -I$(top_builddir)/src
+
+cairo_fdr_la_SOURCES = fdr.c
+cairo_fdr_la_CPPFLAGS = $(AM_CPPFLAGS)
+cairo_fdr_la_CFLAGS = $(CAIRO_CFLAGS)
+cairo_fdr_la_LDFLAGS = -module -no-undefined
+cairo_fdr_la_LIBADD = -ldl
diff --git a/util/cairo-fdr/fdr.c b/util/cairo-fdr/fdr.c
new file mode 100644
index 000000000..467547313
--- /dev/null
+++ b/util/cairo-fdr/fdr.c
@@ -0,0 +1,304 @@
+/* cairo-fdr - a 'flight data recorder', a black box, for cairo
+ *
+ * Copyright © 2009 Chris Wilson
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#define _GNU_SOURCE
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <cairo.h>
+#include <cairo-script.h>
+#include <stdlib.h>
+#include <assert.h>
+#include <signal.h>
+
+#include <dlfcn.h>
+
+static void *_dlhandle = RTLD_NEXT;
+#define DLCALL(name, args...) ({ \
+    static typeof (&name) name##_real; \
+    if (name##_real == NULL) { \
+	name##_real = dlsym (_dlhandle, #name); \
+	if (name##_real == NULL && _dlhandle == RTLD_NEXT) { \
+	    _dlhandle = dlopen ("libcairo.so", RTLD_LAZY); \
+	    name##_real = dlsym (_dlhandle, #name); \
+	    assert (name##_real != NULL); \
+	} \
+    } \
+    (*name##_real) (args);  \
+})
+
+#define RINGBUFFER_SIZE 16
+static cairo_surface_t *fdr_ringbuffer[RINGBUFFER_SIZE];
+static int fdr_position;
+static int fdr_dump;
+
+static const cairo_user_data_key_t fdr_key;
+
+static void
+fdr_replay_to_script (cairo_surface_t *meta, cairo_script_context_t *ctx)
+{
+    if (meta != NULL) {
+	DLCALL (cairo_script_context_write_comment, ctx, "--- fdr ---", -1);
+	DLCALL (cairo_script_from_meta_surface, ctx, meta);
+    }
+}
+
+static void
+fdr_dump_ringbuffer (void)
+{
+    cairo_script_context_t *ctx;
+    int n;
+
+    ctx = DLCALL (cairo_script_context_create, "/tmp/fdr.trace");
+
+    for (n = fdr_position; n < RINGBUFFER_SIZE; n++)
+	fdr_replay_to_script (fdr_ringbuffer[n], ctx);
+
+    for (n = 0; n < fdr_position; n++)
+	fdr_replay_to_script (fdr_ringbuffer[n], ctx);
+
+    DLCALL (cairo_script_context_destroy, ctx);
+}
+
+static void
+fdr_sighandler (int sig)
+{
+    fdr_dump = 1;
+}
+
+static void
+fdr_atexit (void)
+{
+    if (fdr_dump)
+	fdr_dump_ringbuffer ();
+}
+
+static void
+fdr_pending_signals (void)
+{
+    static int initialized;
+
+    if (! initialized) {
+	initialized = 1;
+
+	signal (SIGUSR1, fdr_sighandler);
+	atexit (fdr_atexit);
+    }
+
+    if (fdr_dump) {
+	fdr_dump_ringbuffer ();
+	fdr_dump = 0;
+    }
+}
+
+static void
+fdr_get_extents (cairo_surface_t *surface,
+		 cairo_rectangle_t *extents)
+{
+    cairo_t *cr;
+
+    cr = DLCALL (cairo_create, surface);
+    DLCALL (cairo_clip_extents, cr,
+	    &extents->x, &extents->y, &extents->width, &extents->height);
+    DLCALL (cairo_destroy, cr);
+
+    extents->width -= extents->x;
+    extents->height -= extents->y;
+}
+
+static void
+fdr_surface_destroy (void *surface)
+{
+    DLCALL (cairo_surface_destroy, surface);
+}
+
+static void
+fdr_surface_reference (void *surface)
+{
+    DLCALL (cairo_surface_reference, surface);
+}
+
+static cairo_surface_t *
+fdr_surface_get_tee (cairo_surface_t *surface)
+{
+    return DLCALL (cairo_surface_get_user_data, surface, &fdr_key);
+}
+
+static cairo_surface_t *
+fdr_tee_surface_index (cairo_surface_t *surface, int index)
+{
+    return DLCALL (cairo_tee_surface_index, surface, index);
+}
+
+cairo_t *
+cairo_create (cairo_surface_t *surface)
+{
+    cairo_surface_t *record, *tee;
+
+    fdr_pending_signals ();
+
+    tee = fdr_surface_get_tee (surface);
+    if (tee == NULL) {
+	cairo_rectangle_t extents;
+	cairo_content_t content;
+
+	fdr_get_extents (surface, &extents);
+	content = DLCALL (cairo_surface_get_content, surface);
+
+	tee = DLCALL (cairo_tee_surface_create, surface);
+	record = DLCALL (cairo_meta_surface_create, content, &extents);
+	DLCALL (cairo_tee_surface_append, tee, record);
+
+	DLCALL (cairo_surface_set_user_data, surface,
+		&fdr_key, tee, fdr_surface_destroy);
+    } else {
+	int n;
+
+	record = fdr_tee_surface_index (tee, 1);
+
+	/* update the position of the recording surface in the ringbuffer */
+	for (n = 0; n < RINGBUFFER_SIZE; n++) {
+	    if (record == fdr_ringbuffer[n]) {
+		fdr_ringbuffer[n] = NULL;
+		break;
+	    }
+	}
+    }
+
+    fdr_surface_destroy (fdr_ringbuffer[fdr_position]);
+    fdr_ringbuffer[fdr_position] = record;
+    fdr_position = (fdr_position + 1) % RINGBUFFER_SIZE;
+
+    return DLCALL (cairo_create, tee);
+}
+
+static void
+fdr_remove_tee (cairo_surface_t *surface)
+{
+    fdr_surface_reference (surface);
+    DLCALL (cairo_surface_set_user_data, surface, &fdr_key, NULL, NULL);
+    fdr_surface_destroy (surface);
+}
+
+void
+cairo_destroy (cairo_t *cr)
+{
+    cairo_surface_t *tee;
+
+    tee = DLCALL (cairo_get_target, cr);
+    DLCALL (cairo_destroy, cr);
+
+    if (DLCALL (cairo_surface_get_reference_count, tee) == 1)
+	fdr_remove_tee (fdr_tee_surface_index (tee, 0));
+}
+
+void
+cairo_pattern_destroy (cairo_pattern_t *pattern)
+{
+    if (DLCALL (cairo_pattern_get_type, pattern) == CAIRO_PATTERN_TYPE_SURFACE) {
+	cairo_surface_t *surface;
+
+	if (DLCALL (cairo_pattern_get_surface, pattern, &surface) == CAIRO_STATUS_SUCCESS &&
+	    DLCALL (cairo_surface_get_type, surface) == CAIRO_SURFACE_TYPE_TEE &&
+	    DLCALL (cairo_surface_get_reference_count, surface) == 2)
+	{
+	    fdr_remove_tee (fdr_tee_surface_index (surface, 0));
+	}
+    }
+
+    DLCALL (cairo_pattern_destroy, pattern);
+}
+
+cairo_surface_t *
+cairo_get_target (cairo_t *cr)
+{
+    cairo_surface_t *tee;
+
+    tee = DLCALL (cairo_get_target, cr);
+    return fdr_tee_surface_index (tee, 0);
+}
+
+cairo_surface_t *
+cairo_get_group_target (cairo_t *cr)
+{
+    cairo_surface_t *tee;
+
+    tee = DLCALL (cairo_get_group_target, cr);
+    return fdr_tee_surface_index (tee, 0);
+}
+
+cairo_pattern_t *
+cairo_pattern_create_for_surface (cairo_surface_t *surface)
+{
+    cairo_surface_t *tee;
+
+    tee = fdr_surface_get_tee (surface);
+    if (tee != NULL)
+	surface = tee;
+
+    return DLCALL (cairo_pattern_create_for_surface, surface);
+}
+
+cairo_status_t
+cairo_pattern_get_surface (cairo_pattern_t *pattern,
+			   cairo_surface_t **surface)
+{
+    cairo_status_t status;
+    cairo_surface_t *tee;
+
+    status = DLCALL (cairo_pattern_get_surface, pattern, surface);
+    if (status != CAIRO_STATUS_SUCCESS)
+	return status;
+
+    tee = fdr_surface_get_tee (*surface);
+    if (tee != NULL)
+	*surface = tee;
+
+    return CAIRO_STATUS_SUCCESS;
+}
+
+void
+cairo_set_source_surface (cairo_t *cr,
+			  cairo_surface_t *surface,
+			  double x, double y)
+{
+    cairo_surface_t *tee;
+
+    tee = fdr_surface_get_tee (surface);
+    if (tee != NULL)
+	surface = tee;
+
+    DLCALL (cairo_set_source_surface, cr, surface, x, y);
+}
+
+cairo_surface_t *
+cairo_surface_create_similar (cairo_surface_t *surface,
+			      cairo_content_t content,
+			      int width, int height)
+{
+    cairo_surface_t *tee;
+
+    tee = fdr_surface_get_tee (surface);
+    if (tee != NULL)
+	surface = tee;
+
+    return DLCALL (cairo_surface_create_similar,
+		   surface, content, width, height);
+}