Hash :
e120807b
Author :
Date :
2025-01-29T15:35:22
Update license notices to SDPX short identifiers + update LICENSE Fix #628. Signed-off-by: Ran Benita <ran@unusedvar.com>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
/*
* Copyright © 2024 Pierre Le Marre <dev@wismill.eu>
* SPDX-License-Identifier: MIT
*/
#include "config.h"
#include <fcntl.h>
#include <time.h>
#include <getopt.h>
#include "xkbcommon/xkbcommon.h"
#include "utils.h"
#include "bench.h"
#define DEFAULT_ITERATIONS 3000
#define DEFAULT_STDEV 0.05
static void
usage(char **argv)
{
printf("Usage: %s [OPTIONS]\n"
"\n"
"Benchmark compilation of the given RMLVO\n"
"\n"
"Options:\n"
" --help\n"
" Print this help and exit\n"
" --iter\n"
" Exact number of iterations to run\n"
" --stdev\n"
" Minimal relative standard deviation (percentage) to reach.\n"
" (default: %f)\n"
"Note: --iter and --stdev are mutually exclusive.\n"
"\n"
"XKB-specific options:\n"
" --rules <rules>\n"
" The XKB ruleset (default: '%s')\n"
" --model <model>\n"
" The XKB model (default: '%s')\n"
" --layout <layout>\n"
" The XKB layout (default: '%s')\n"
" --variant <variant>\n"
" The XKB layout variant (default: '%s')\n"
" --options <options>\n"
" The XKB options (default: '%s')\n"
"\n",
argv[0], DEFAULT_STDEV * 100, DEFAULT_XKB_RULES,
DEFAULT_XKB_MODEL, DEFAULT_XKB_LAYOUT,
DEFAULT_XKB_VARIANT ? DEFAULT_XKB_VARIANT : "<none>",
DEFAULT_XKB_OPTIONS ? DEFAULT_XKB_OPTIONS : "<none>");
}
int
main(int argc, char **argv)
{
struct xkb_context *context;
struct bench bench;
struct bench_time elapsed;
struct estimate est;
bool explicit_iterations = false;
int ret = 0;
struct xkb_rule_names rmlvo = {
.rules = DEFAULT_XKB_RULES,
.model = DEFAULT_XKB_MODEL,
/* layout and variant are tied together, so we either get user-supplied for
* both or default for both, see below */
.layout = NULL,
.variant = NULL,
.options = DEFAULT_XKB_OPTIONS,
};
unsigned int max_iterations = DEFAULT_ITERATIONS;
double stdev = DEFAULT_STDEV;
enum options {
OPT_RULES,
OPT_MODEL,
OPT_LAYOUT,
OPT_VARIANT,
OPT_OPTION,
OPT_ITERATIONS,
OPT_STDEV,
};
static struct option opts[] = {
{"help", no_argument, 0, 'h'},
{"rules", required_argument, 0, OPT_RULES},
{"model", required_argument, 0, OPT_MODEL},
{"layout", required_argument, 0, OPT_LAYOUT},
{"variant", required_argument, 0, OPT_VARIANT},
{"options", required_argument, 0, OPT_OPTION},
{"iter", required_argument, 0, OPT_ITERATIONS},
{"stdev", required_argument, 0, OPT_STDEV},
{0, 0, 0, 0},
};
while (1) {
int c;
int option_index = 0;
c = getopt_long(argc, argv, "h", opts, &option_index);
if (c == -1)
break;
switch (c) {
case 'h':
usage(argv);
exit(EXIT_SUCCESS);
case OPT_RULES:
rmlvo.rules = optarg;
break;
case OPT_MODEL:
rmlvo.model = optarg;
break;
case OPT_LAYOUT:
rmlvo.layout = optarg;
break;
case OPT_VARIANT:
rmlvo.variant = optarg;
break;
case OPT_OPTION:
rmlvo.options = optarg;
break;
case OPT_ITERATIONS:
if (max_iterations == 0) {
usage(argv);
exit(EXIT_INVALID_USAGE);
}
{
const int max_iterations_raw = atoi(optarg);
if (max_iterations_raw <= 0)
max_iterations = DEFAULT_ITERATIONS;
else
max_iterations = (unsigned int) max_iterations_raw;
}
explicit_iterations = true;
break;
case OPT_STDEV:
if (explicit_iterations) {
usage(argv);
exit(EXIT_INVALID_USAGE);
}
stdev = atof(optarg) / 100;
if (stdev <= 0)
stdev = DEFAULT_STDEV;
max_iterations = 0;
break;
default:
usage(argv);
exit(EXIT_INVALID_USAGE);
}
}
/* Now fill in the layout */
if (!rmlvo.layout || !*rmlvo.layout) {
if (rmlvo.variant && *rmlvo.variant) {
fprintf(stderr, "Error: a variant requires a layout\n");
return EXIT_INVALID_USAGE;
}
rmlvo.layout = DEFAULT_XKB_LAYOUT;
rmlvo.variant = DEFAULT_XKB_VARIANT;
}
context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
if (!context)
exit(1);
struct xkb_keymap *keymap;
keymap = xkb_keymap_new_from_names(context, &rmlvo, XKB_KEYMAP_COMPILE_NO_FLAGS);
if (!keymap) {
fprintf(stderr, "ERROR: Cannot compile keymap.\n");
goto keymap_error;
exit(EXIT_FAILURE);
}
#ifndef KEYMAP_DUMP
char *keymap_str = xkb_keymap_get_as_string(keymap, XKB_KEYMAP_FORMAT_TEXT_V1);
xkb_keymap_unref(keymap);
#endif
/* Suspend stdout and stderr outputs */
fflush(stdout);
int stdout_old = dup(STDOUT_FILENO);
int stdout_new = open("/dev/null", O_WRONLY);
if (stdout_old == -1 || stdout_new == -1 ||
dup2(stdout_new, STDOUT_FILENO) == -1) {
perror("Stdout error");
exit(EXIT_FAILURE);
}
close(stdout_new);
fflush(stderr);
int stderr_old = dup(STDERR_FILENO);
int stderr_new = open("/dev/null", O_WRONLY);
if (stderr_old == -1 || stderr_new == -1 ||
dup2(stderr_new, STDERR_FILENO) == -1) {
perror("Stderr error");
exit(EXIT_FAILURE);
}
close(stderr_new);
if (explicit_iterations) {
stdev = 0;
bench_start2(&bench);
for (unsigned int i = 0; i < max_iterations; i++) {
#ifndef KEYMAP_DUMP
keymap = xkb_keymap_new_from_string(
context, keymap_str,
XKB_KEYMAP_FORMAT_TEXT_V1, XKB_KEYMAP_COMPILE_NO_FLAGS);
assert(keymap);
xkb_keymap_unref(keymap);
#else
char *s = xkb_keymap_get_as_string(keymap, XKB_KEYMAP_USE_ORIGINAL_FORMAT);
assert(s);
free(s);
#endif
}
bench_stop2(&bench);
bench_elapsed(&bench, &elapsed);
est.elapsed = (bench_time_elapsed_nanoseconds(&elapsed)) / max_iterations;
est.stdev = 0;
} else {
bench_start2(&bench);
#ifndef KEYMAP_DUMP
BENCH(stdev, max_iterations, elapsed, est,
keymap = xkb_keymap_new_from_string(
context, keymap_str,
XKB_KEYMAP_FORMAT_TEXT_V1, XKB_KEYMAP_COMPILE_NO_FLAGS);
assert(keymap);
xkb_keymap_unref(keymap);
);
#else
BENCH(stdev, max_iterations, elapsed, est,
char *s = xkb_keymap_get_as_string(
keymap, XKB_KEYMAP_USE_ORIGINAL_FORMAT);
assert(s);
free(s);
);
#endif
bench_stop2(&bench);
}
/* Restore stdout and stderr outputs */
fflush(stdout);
dup2(stdout_old, STDOUT_FILENO);
close(stdout_old);
fflush(stderr);
dup2(stderr_old, STDERR_FILENO);
close(stderr_old);
#ifndef KEYMAP_DUMP
free(keymap_str);
#else
xkb_keymap_unref(keymap);
#endif
struct bench_time total_elapsed;
bench_elapsed(&bench, &total_elapsed);
if (explicit_iterations) {
fprintf(stderr,
"mean: %lld µs; compiled %u keymaps in %ld.%06lds\n",
est.elapsed / 1000, max_iterations,
total_elapsed.seconds, total_elapsed.nanoseconds / 1000);
} else {
fprintf(stderr,
"mean: %lld µs; stdev: %Lf%% (target: %f%%); "
"last run: compiled %u keymaps in %ld.%06lds; "
"total time: %ld.%06lds\n", est.elapsed / 1000,
(long double) est.stdev * 100.0 / (long double) est.elapsed,
stdev * 100,
max_iterations, elapsed.seconds, elapsed.nanoseconds / 1000,
total_elapsed.seconds, total_elapsed.nanoseconds / 1000);
}
keymap_error:
xkb_context_unref(context);
return ret;
}