From c1e2ffac831b59145b43d0ec3669ded9f190b54b Mon Sep 17 00:00:00 2001 From: Benjamin Otte Date: Thu, 11 Jan 2024 14:41:29 +0100 Subject: [PATCH 1/3] tools: Split out a function There's a function now that creates a renderer by name - and allows NULL for the default renderer --- tools/gtk-rendernode-tool-render.c | 13 +++---- tools/gtk-rendernode-tool-utils.c | 62 ++++++++++++++++++++++++++++++ tools/gtk-rendernode-tool.h | 1 + 3 files changed, 69 insertions(+), 7 deletions(-) diff --git a/tools/gtk-rendernode-tool-render.c b/tools/gtk-rendernode-tool-render.c index c8d98da3f8..28d0c37fdf 100644 --- a/tools/gtk-rendernode-tool-render.c +++ b/tools/gtk-rendernode-tool-render.c @@ -143,14 +143,13 @@ render_file (const char *filename, { GdkTexture *texture; GskRenderer *renderer; - GdkSurface *window; - if (renderer_name) - g_object_set_data_full (G_OBJECT (gdk_display_get_default ()), "gsk-renderer", - g_strdup (renderer_name), g_free); - - window = gdk_surface_new_toplevel (gdk_display_get_default ()); - renderer = gsk_renderer_new_for_surface (window); + renderer = create_renderer (renderer_name, &error); + if (renderer == NULL) + { + g_printerr (_("Failed to create renderer: %s\n"), error->message); + exit (1); + } texture = gsk_renderer_render_texture (renderer, node, NULL); diff --git a/tools/gtk-rendernode-tool-utils.c b/tools/gtk-rendernode-tool-utils.c index e91cbc3ea2..deab3e36fc 100644 --- a/tools/gtk-rendernode-tool-utils.c +++ b/tools/gtk-rendernode-tool-utils.c @@ -29,6 +29,9 @@ #include #include "gtk-rendernode-tool.h" +#ifdef GDK_WINDOWING_BROADWAY +#include +#endif static void deserialize_error_func (const GskParseLocation *start, @@ -73,3 +76,62 @@ load_node_file (const char *filename) return gsk_render_node_deserialize (bytes, deserialize_error_func, NULL); } + +/* keep in sync with gsk/gskrenderer.c */ +static GskRenderer * +get_renderer_for_name (const char *renderer_name) +{ + if (renderer_name == NULL) + return NULL; +#ifdef GDK_WINDOWING_BROADWAY + else if (g_ascii_strcasecmp (renderer_name, "broadway") == 0) + return gsk_broadway_renderer_new (); +#endif + else if (g_ascii_strcasecmp (renderer_name, "cairo") == 0) + return gsk_cairo_renderer_new (); + else if (g_ascii_strcasecmp (renderer_name, "opengl") == 0 || + g_ascii_strcasecmp (renderer_name, "gl") == 0) + return gsk_gl_renderer_new (); + else if (g_ascii_strcasecmp (renderer_name, "ngl") == 0) + return gsk_ngl_renderer_new (); +#ifdef GDK_RENDERING_VULKAN + else if (g_ascii_strcasecmp (renderer_name, "vulkan") == 0) + return gsk_vulkan_renderer_new (); +#endif + else + return NULL; +} + +GskRenderer * +create_renderer (const char *name, GError **error) +{ + GskRenderer *renderer; + + if (name == NULL) + { + /* awwwwwkward - there should be code to get the + * default renderer without a surface */ + static GdkSurface *window = NULL; + + if (window == NULL) + window = gdk_surface_new_toplevel (gdk_display_get_default ()); + return gsk_renderer_new_for_surface (window); + } + + renderer = get_renderer_for_name (name); + + if (renderer == NULL) + { + g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, + "No renderer named \"%s\"", name); + return NULL; + } + + if (!gsk_renderer_realize_for_display (renderer, gdk_display_get_default (), error)) + { + g_object_unref (renderer); + return NULL; + } + + return renderer; +} diff --git a/tools/gtk-rendernode-tool.h b/tools/gtk-rendernode-tool.h index adece50e12..27410d7619 100644 --- a/tools/gtk-rendernode-tool.h +++ b/tools/gtk-rendernode-tool.h @@ -6,3 +6,4 @@ void do_render (int *argc, const char ***argv); void do_info (int *argc, const char ***argv); GskRenderNode *load_node_file (const char *filename); +GskRenderer *create_renderer (const char *name, GError **error); From 8872e1cbb08e4c51f26d71ac902b2710e1f5ea04 Mon Sep 17 00:00:00 2001 From: Benjamin Otte Date: Sat, 13 Jan 2024 17:06:45 +0100 Subject: [PATCH 2/3] tools: Add gtk-rendernode-tool benchmark A simple tool that runs gsk_renderer_render_texture() a few times with every renderer and prints the results. --- tools/gtk-rendernode-tool-benchmark.c | 151 ++++++++++++++++++++++++++ tools/gtk-rendernode-tool.c | 3 + tools/gtk-rendernode-tool.h | 7 +- tools/meson.build | 1 + 4 files changed, 159 insertions(+), 3 deletions(-) create mode 100644 tools/gtk-rendernode-tool-benchmark.c diff --git a/tools/gtk-rendernode-tool-benchmark.c b/tools/gtk-rendernode-tool-benchmark.c new file mode 100644 index 0000000000..0574048196 --- /dev/null +++ b/tools/gtk-rendernode-tool-benchmark.c @@ -0,0 +1,151 @@ +/* Copyright 2024 Red Hat, Inc. + * + * GTK is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2 of the + * License, or (at your option) any later version. + * + * GTK 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with GTK; see the file COPYING. If not, + * see . + * + * Author: Benjamin Otte + */ + +#include "config.h" + +#include +#include +#include + +#include +#include +#include +#include +#include "gtk-rendernode-tool.h" + +static void +benchmark_node (GskRenderNode *node, + const char *renderer_name, + guint runs, + gboolean download) +{ + GError *error = NULL; + GskRenderer *renderer; + guint i; + + renderer = create_renderer (renderer_name, &error); + if (renderer == NULL) + { + g_printerr ("Could not benchmark renderer \"%s\": %s\n", renderer_name, error->message); + g_clear_error (&error); + return; + } + + for (i = 0; i < runs; i++) + { + GdkTexture *texture; + gint64 start_time, end_time, duration; + + start_time = g_get_monotonic_time (); + + texture = gsk_renderer_render_texture (renderer, node, NULL); + if (download) + { + GdkTextureDownloader *downloader; + GBytes *bytes; + gsize stride; + + downloader = gdk_texture_downloader_new (texture); + bytes = gdk_texture_downloader_download_bytes (downloader, &stride); + g_bytes_unref (bytes); + gdk_texture_downloader_free (downloader); + } + + end_time = g_get_monotonic_time (); + + duration = end_time - start_time; + g_print ("%s\t%lld.%03ds\n", + renderer_name, + (long long) duration / G_USEC_PER_SEC, + (int) ((duration * 1000 / G_USEC_PER_SEC) % 1000)); + g_object_unref (texture); + } + + gsk_renderer_unrealize (renderer); + g_object_unref (renderer); +} + +void +do_benchmark (int *argc, + const char ***argv) +{ + GOptionContext *context; + char **filenames = NULL; + char **renderers = NULL; + gboolean nodownload = FALSE; + int runs = 3; + const GOptionEntry entries[] = { + { "renderer", 0, 0, G_OPTION_ARG_STRING_ARRAY, &renderers, N_("Add renderer to benchmark"), N_("RENDERER") }, + { "runs", 0, 0, G_OPTION_ARG_INT, &runs, N_("Number of runs with each renderer"), N_("RUNS") }, + { "no-download", 0, 0, G_OPTION_ARG_NONE, &nodownload, N_("Dont download result/wait for GPU to finish"), NULL }, + { G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_FILENAME_ARRAY, &filenames, NULL, N_("FILE…") }, + { NULL, } + }; + GskRenderNode *node; + GError *error = NULL; + gsize i; + + if (gdk_display_get_default () == NULL) + { + g_printerr (_("Could not initialize windowing system\n")); + exit (1); + } + + g_set_prgname ("gtk4-rendernode-tool benchmark"); + context = g_option_context_new (NULL); + g_option_context_set_translation_domain (context, GETTEXT_PACKAGE); + g_option_context_add_main_entries (context, entries, NULL); + g_option_context_set_summary (context, _("Benchmark rendering of a .node file.")); + + if (!g_option_context_parse (context, argc, (char ***)argv, &error)) + { + g_printerr ("%s\n", error->message); + g_error_free (error); + exit (1); + } + + g_option_context_free (context); + + if (filenames == NULL) + { + g_printerr (_("No .node file specified\n")); + exit (1); + } + + if (g_strv_length (filenames) > 1) + { + g_printerr (_("Can only benchmark a single .node file\n")); + exit (1); + } + + if (renderers == NULL || renderers[0] == NULL) + renderers = g_strdupv ((char **) (const char *[]) { "gl", "ngl", "vulkan", "cairo", NULL }); + + node = load_node_file (filenames[0]); + + for (i = 0; renderers[i] != NULL; i++) + { + benchmark_node (node, renderers[i], runs, !nodownload); + } + + gsk_render_node_unref (node); + + g_strfreev (filenames); + g_strfreev (renderers); +} diff --git a/tools/gtk-rendernode-tool.c b/tools/gtk-rendernode-tool.c index f45bea6bf3..26c9d11656 100644 --- a/tools/gtk-rendernode-tool.c +++ b/tools/gtk-rendernode-tool.c @@ -38,6 +38,7 @@ usage (void) "Perform various tasks on GTK render nodes.\n" "\n" "Commands:\n" + " benchmark Benchmark rendering of a node\n" " info Provide information about the node\n" " show Show the node\n" " render Take a screenshot of the node\n" @@ -113,6 +114,8 @@ main (int argc, const char *argv[]) do_render (&argc, &argv); else if (strcmp (argv[0], "info") == 0) do_info (&argc, &argv); + else if (strcmp (argv[0], "benchmark") == 0) + do_benchmark (&argc, &argv); else usage (); diff --git a/tools/gtk-rendernode-tool.h b/tools/gtk-rendernode-tool.h index 27410d7619..1de1454314 100644 --- a/tools/gtk-rendernode-tool.h +++ b/tools/gtk-rendernode-tool.h @@ -1,9 +1,10 @@ #pragma once -void do_show (int *argc, const char ***argv); -void do_render (int *argc, const char ***argv); -void do_info (int *argc, const char ***argv); +void do_benchmark (int *argc, const char ***argv); +void do_info (int *argc, const char ***argv); +void do_show (int *argc, const char ***argv); +void do_render (int *argc, const char ***argv); GskRenderNode *load_node_file (const char *filename); GskRenderer *create_renderer (const char *name, GError **error); diff --git a/tools/meson.build b/tools/meson.build index b7b8fd4976..21abe4c139 100644 --- a/tools/meson.build +++ b/tools/meson.build @@ -41,6 +41,7 @@ gtk_tools = [ 'gtk-builder-tool-preview.c', 'fake-scope.c'], [libgtk_dep] ], ['gtk4-rendernode-tool', ['gtk-rendernode-tool.c', + 'gtk-rendernode-tool-benchmark.c', 'gtk-rendernode-tool-info.c', 'gtk-rendernode-tool-render.c', 'gtk-rendernode-tool-show.c', From 24ceb47cbc809f22059a4ef14af5aceff533c377 Mon Sep 17 00:00:00 2001 From: Benjamin Otte Date: Sat, 13 Jan 2024 17:21:44 +0100 Subject: [PATCH 3/3] tools: Add the new benchmark command to the docs --- docs/reference/gtk/gtk4-rendernode-tool.rst | 31 ++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/docs/reference/gtk/gtk4-rendernode-tool.rst b/docs/reference/gtk/gtk4-rendernode-tool.rst index a01b6b58e4..879112cde5 100644 --- a/docs/reference/gtk/gtk4-rendernode-tool.rst +++ b/docs/reference/gtk/gtk4-rendernode-tool.rst @@ -12,9 +12,10 @@ SYNOPSIS -------- | **gtk4-rendernode-tool** [OPTIONS...] | +| **gtk4-rendernode-tool** benchmark [OPTIONS...] | **gtk4-rendernode-tool** info [OPTIONS...] -| **gtk4-rendernode-tool** show [OPTIONS...] | **gtk4-rendernode-tool** render [OPTIONS...] [] +| **gtk4-rendernode-tool** show [OPTIONS...] DESCRIPTION ----------- @@ -50,3 +51,31 @@ The name of the file to write can be specified as a second FILE argument. Use the given renderer. Use ``--renderer=help`` to get a information about poassible values for the ``RENDERER``. + +Benchmark +^^^^^^^^^ + +The ``benchmark`` command benchmarks rendering of a node with the existing renderers +and prints the runtimes. + +``--renderer=RENDERER`` + + Add the given renderer. This argument can be passed multiple times to test multiple + renderers. By default, all major GTK renderers are run. + +``--runs=RUNS`` + + Number of times to render the node on each renderer. By default, this is 3 times. + Keep in mind that the first run is often used to populate caches and might be + significantly slower. + +``--no-download`` + + Do not attempt to download the result. This may cause the measurement to not include + the execution of the commands on the GPU. It can be useful to use this flag to test + command submission performance. + + + + +