keysyms: Add benchmark for case mapping functions

bench/keysym-case-mappings.c

@@ -0,0 +1,90 @@
+/*
+ * Copyright © 2023 Pierre Le Marre
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+#include "config.h"
+
+#include <time.h>
+#include <stdbool.h>
+
+#include "xkbcommon/xkbcommon.h"
+#include "src/keysym.h"
+
+#include "../test/test.h"
+#include "bench.h"
+
+#define BENCHMARK_ITERATIONS 300
+
+typedef uint32_t (*CaseMappingFunc)(xkb_keysym_t ks);
+typedef bool (*CaseTestFunc)(xkb_keysym_t ks);
+struct TestedFunction {
+    union {
+        struct {
+            CaseMappingFunc toLower;
+            CaseMappingFunc toUpper;
+        };
+        struct {
+            CaseTestFunc isLower;
+            CaseTestFunc isUpper;
+        };
+    };
+    const char *name;
+};
+
+static const struct TestedFunction functions[] = {
+    { {.toLower = xkb_keysym_to_lower, .toUpper = xkb_keysym_to_upper},
+      "to_lower & to_upper" },
+    { {.isLower = xkb_keysym_is_lower, .isUpper = xkb_keysym_is_upper},
+      "is_lower & is_upper" },
+};
+
+int
+main(void)
+{
+    struct bench bench;
+
+    for (size_t f = 0; f < ARRAY_SIZE(functions); f++) {
+        for (int explicit = 1; explicit >= 0; explicit--) {
+            fprintf(stderr, "Benchmarking %s...\n", functions[f].name);
+            bench_start(&bench);
+            for (int i = 0; i < BENCHMARK_ITERATIONS; i++) {
+                struct xkb_keysym_iterator *iter = xkb_keysym_iterator_new(explicit);
+                while (xkb_keysym_iterator_next(iter)) {
+                    xkb_keysym_t ks = xkb_keysym_iterator_get_keysym(iter);
+                    functions[f].toLower(ks);
+                    functions[f].toUpper(ks);
+                }
+                iter = xkb_keysym_iterator_unref(iter);
+            }
+            bench_stop(&bench);
+
+            char *elapsed = bench_elapsed_str(&bench);
+            fprintf(stderr,
+                    "Applied %d times \"%s\" to %s assigned keysyms in %ss\n",
+                    BENCHMARK_ITERATIONS, functions[f].name, explicit ? "explicitly" : "all", elapsed);
+            free(elapsed);
+        }
+    }
+
+
+    return 0;
+}

meson.build

@@ -846,6 +846,15 @@ benchmark(
     executable('bench-key-proc', 'bench/key-proc.c', dependencies: test_dep),
     env: bench_env,
 )
+benchmark(
+    'keysym-case-mappings',
+    executable(
+        'bench-keysym-case-mappings',
+        'bench/keysym-case-mappings.c',
+        dependencies: test_dep,
+        c_args: ['-DENABLE_PRIVATE_APIS'],
+    ),
+)
 benchmark(
     'rules',
     executable('bench-rules', 'bench/rules.c', dependencies: test_dep),