mdw@git.distorted.org.uk Git - mLib/blob - test/t/tvec-test.c

   1 /* -*-c-*-
   2  *
   3  * Test the test-vector framework
   4  *
   5  * (c) 2023 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the mLib utilities library.
  11  *
  12  * mLib is free software: you can redistribute it and/or modify it under
  13  * the terms of the GNU Library General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or (at
  15  * your option) any later version.
  16  *
  17  * mLib is distributed in the hope that it will be useful, but WITHOUT
  18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  20  * License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with mLib.  If not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  25  * USA.
  26  */
  27
  28 /*----- Header files ------------------------------------------------------*/
  29
  30 #include "tv.h"
  31 #include "tvec.h"
  32
  33 #include <sys/select.h>
  34 #include <sys/time.h>
  35
  36 /*----- Register definitions ----------------------------------------------*/
  37
  38 static const struct tvec_iassoc ienum_assocs[] = {
  39   { "less",            -1 },
  40   { "equal",            0 },
  41   { "greater",         +1 },
  42   { 0 }
  43 };
  44
  45 static const struct tvec_uassoc uenum_assocs[] = {
  46   { "apple",            0 },
  47   { "banana",           1 },
  48   { "clementine",       2 },
  49   { 0 }
  50 };
  51
  52 static const struct tvec_fassoc fenum_assocs[] = {
  53   { "e",                2.718281828459045 },
  54   { "pi",               3.141592653589793 },
  55   { "tau",              6.283185307179586 },
  56   { 0 }
  57 };
  58
  59 static const struct tvec_passoc penum_assocs[] = {
  60   { "alice",            &uenum_assocs[0] },
  61   { "bob",              &uenum_assocs[1] },
  62   { "carol",            &uenum_assocs[2] },
  63   { 0 }
  64 };
  65
  66 #if __STDC_VERSION__x >= 199901
  67 #  define DSGINIT(x) x
  68 #else
  69 #  define DSGINIT(x)
  70 #endif
  71
  72 static const struct tvec_floatinfo fenum_fltinfo =
  73   { TVFF_ABSDELTA, -10, +10, 1e-3 };
  74
  75 #define DEFENUM(tag, ty, slot)                                          \
  76   static const struct tvec_##slot##enuminfo slot##enum_info =           \
  77     { slot##enum_NAME, slot##enum_assocs slot##enum_ARGS };
  78 #define ienum_NAME "order"
  79 #define ienum_ARGS , &tvrange_i16
  80 #define uenum_NAME "fruit"
  81 #define uenum_ARGS , &tvrange_u16
  82 #define fenum_NAME "const"
  83 #define fenum_ARGS , &fenum_fltinfo
  84 #define penum_NAME "actor"
  85 #define penum_ARGS
  86 TVEC_MISCSLOTS(DEFENUM)
  87 #undef DEFENUM
  88
  89 static const struct tvec_flag attr_flags[] = {
  90   { "black-fg",         0x07, 0x00 },
  91   { "blue-fg",          0x07, 0x01 },
  92   { "red-fg",           0x07, 0x02 },
  93   { "magenta-fg",       0x07, 0x03 },
  94   { "green-fg",         0x07, 0x04 },
  95   { "cyan-fg",          0x07, 0x05 },
  96   { "yellow-fg",        0x07, 0x06 },
  97   { "white-fg",         0x07, 0x07 },
  98
  99   { "black-bg",         0x38, 0x00 },
 100   { "blue-bg",          0x38, 0x08 },
 101   { "red-bg",           0x38, 0x10 },
 102   { "magenta-bg",       0x38, 0x18 },
 103   { "green-bg",         0x38, 0x20 },
 104   { "cyan-bg",          0x38, 0x28 },
 105   { "yellow-bg",        0x38, 0x30 },
 106   { "white-bg",         0x38, 0x38 },
 107
 108   { "normal",           0xc0, 0x00 },
 109   { "bright",           0x40, 0x40 },
 110   { "flash",            0x80, 0x80 },
 111
 112   { 0 }
 113 };
 114
 115 static const struct tvec_flaginfo attr_info =
 116   { "attr", attr_flags, &tvrange_u16 };
 117
 118 static const struct tvec_floatinfo fltish_info =
 119   { TVFF_RELDELTA, -1.0, +1.0, 1e-6 };
 120
 121 static const struct tvec_urange range_32 = { 0, 31 };
 122
 123 #define TYPEREGS(_)                                                     \
 124   _(int,        RI,     int,                    p, &tvrange_i16)        \
 125   _(uint,       RU,     uint,                   p, &tvrange_u16)        \
 126   _(float,      RFP,    float,                  p, 0)                   \
 127   _(fltish,     RFISH,  float,                  p, &fltish_info)        \
 128   _(char,       RCH,    char,                   p, 0)                   \
 129   _(ienum,      RIE,    ienum,                  p, &ienum_info)         \
 130   _(uenum,      RUE,    uenum,                  p, &uenum_info)         \
 131   _(fenum,      RFE,    fenum,                  p, &fenum_info)         \
 132   _(penum,      RPE,    penum,                  p, &penum_info)         \
 133   _(flags,      RF,     flags,                  p, &attr_info)          \
 134   _(text,       RTXT,   text,                   p, &range_32)           \
 135   _(bytes,      RBY,    bytes,                  p, &tvrange_byte)       \
 136   _(buffer,     RBUF,   buffer,                 p, 0)
 137
 138 enum {
 139   /* Output registers, one for each register type. */
 140 #define DEFREG(name, i, ty, argslot, argval) i,
 141   TYPEREGS(DEFREG)
 142 #undef DEFREG
 143   NTY,
 144
 145   /* Outputs. */
 146   RRC = NTY,                            /* return code from deserialize */
 147   RSEROUT,                              /* serialized output */
 148
 149   NROUT,
 150
 151   /* Alternative outputs. */
 152   RVOUT = 0,                            /* output/copy value */
 153   RLEFT,                                /* size data remaining in input */
 154
 155   /* Additional inputs. */
 156   RSAB = NROUT,                         /* which register to sabotage */
 157   RV,                                   /* input value */
 158   RSER,                                 /* serialized input */
 159
 160   NREG
 161 };
 162
 163 /*----- Common execution environment --------------------------------------*/
 164
 165 struct test_context {
 166   struct tvec_state *tv;
 167   unsigned f;
 168 #define SF_SHOW 1u
 169 };
 170
 171 static void common_setup(struct tvec_state *tv,
 172                          const struct tvec_env *env, void *pctx, void *ctx)
 173 {
 174   struct test_context *tctx = ctx;
 175
 176   tctx->tv = tv;
 177   tctx->f = 0;
 178 }
 179
 180 static int common_setvar(struct tvec_state *tv, const char *var,
 181                          const union tvec_regval *rv, void *ctx)
 182 {
 183   struct test_context *tctx = ctx;
 184
 185   if (STRCMP(var, ==, "@show")) {
 186     if (rv->i) tctx->f |= SF_SHOW;
 187   } else assert(!"unknown var");
 188   return (0);
 189 }
 190
 191 static const struct tvec_vardef show_var =
 192   { sizeof(struct tvec_reg), common_setvar,
 193     { "@show", &tvty_ienum, -1, 0, { &tvenum_bool } } };
 194
 195 static const struct tvec_vardef *common_findvar
 196   (struct tvec_state *tv, const char *var, void **ctx_out, void *ctx)
 197 {
 198   if (STRCMP(var, ==, "@show")) { *ctx_out = ctx; return (&show_var); }
 199   return (0);
 200 }
 201
 202 static void common_run(struct tvec_state *tv, tvec_testfn *fn, void *ctx)
 203 {
 204   struct test_context *tctx = ctx;
 205   unsigned f = tctx->f;
 206
 207   fn(tv->in, tv->out, tctx);
 208   if (tvec_checkregs(tv)) { tvec_fail(tv, 0); f |= SF_SHOW; }
 209   if (f&SF_SHOW) tvec_mismatch(tv, TVMF_IN | TVMF_OUT);
 210 }
 211
 212 static void common_after(struct tvec_state *tv, void *ctx)
 213   { struct test_context *tctx = ctx; tctx->f = 0; }
 214
 215 static const struct tvec_env common_testenv = {
 216   sizeof(struct test_context),
 217   common_setup, common_findvar,
 218   0, common_run, common_after,
 219   0
 220 };
 221
 222 /*----- Single-type copy tests --------------------------------------------*/
 223
 224 static void test_copy_simple
 225   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 226   { out->v = in->v; }
 227
 228 static void test_copy_text
 229   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 230 {
 231   tvec_alloctext(&out->v, in->v.text.sz);
 232   memcpy(out->v.text.p, in->v.text.p, in->v.text.sz);
 233 }
 234
 235 static void test_copy_bytes
 236   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 237 {
 238   tvec_allocbytes(&out->v, in->v.bytes.sz);
 239   memcpy(out->v.bytes.p, in->v.bytes.p, in->v.bytes.sz);
 240 }
 241
 242 static void test_copy_buffer
 243   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 244   { tvec_initbuffer(&out->v, &in->v, in->v.buf.sz); }
 245
 246 #define test_copy_int test_copy_simple
 247 #define test_copy_uint test_copy_simple
 248 #define test_copy_ienum test_copy_simple
 249 #define test_copy_uenum test_copy_simple
 250 #define test_copy_fenum test_copy_simple
 251 #define test_copy_penum test_copy_simple
 252 #define test_copy_char test_copy_simple
 253 #define test_copy_flags test_copy_simple
 254 #define test_copy_float test_copy_simple
 255 #define test_copy_fltish test_copy_simple
 256
 257 #define COPYREG(name, i, ty, argslot, argval)                           \
 258         static DSGINIT(const) struct tvec_regdef name##_copyregs[] = {  \
 259           { #name, &tvty_##ty, RVOUT, 0, DSGINIT({ .argslot = argval }) }, \
 260           { 0 }                                                         \
 261         };
 262 TYPEREGS(COPYREG)
 263 #undef COPYREG
 264
 265 /*----- Single-type serialization tests -----------------------------------*/
 266
 267 static void setup_regdef(struct tvec_regdef *rd, unsigned i,
 268                          struct tvec_state *tv)
 269 {
 270   const struct tvec_regdef *r;
 271
 272   for (r = tv->test->regs; r->name; r++) if (r->i == i) goto found;
 273   tvec_error(tv, "internel: register definition not found"); exit(2);
 274 found:
 275   rd[0] = *r; rd[1].name = 0;
 276 }
 277
 278 static void test_single_serialize
 279   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 280 {
 281   struct test_context *tctx = ctx;
 282   struct tvec_state *tv = tctx->tv;
 283   struct tvec_regdef rd[2];
 284   dbuf b = DBUF_INIT;
 285   int rc;
 286
 287   setup_regdef(rd, RV, tv);
 288   rc = tvec_serialize(tv->in, DBUF_BUF(&b), rd, NREG,
 289                       sizeof(struct tvec_reg));
 290   out[RRC].v.i = rc;
 291   if (rc)
 292     out[RSEROUT].f &= ~TVRF_LIVE;
 293   else {
 294     tvec_allocbytes(&out[RSEROUT].v, BLEN(DBUF_BUF(&b)));
 295     memcpy(out[RSEROUT].v.bytes.p, BBASE(DBUF_BUF(&b)), BLEN(DBUF_BUF(&b)));
 296   }
 297 }
 298
 299 static void test_single_deserialize
 300   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 301 {
 302   struct test_context *tctx = ctx;
 303   struct tvec_state *tv = tctx->tv;
 304   struct tvec_regdef rd[2];
 305   buf b;
 306   int rc;
 307
 308   setup_regdef(rd, RV, tv);
 309   buf_init(&b, in[RSER].v.bytes.p, in[RSER].v.bytes.sz);
 310   rc = tvec_deserialize(tv->out, &b, rd, NREG, sizeof(struct tvec_reg));
 311   out[RRC].v.i = rc;
 312   if (rc) out[RVOUT].f &= ~TVRF_LIVE;
 313 }
 314
 315 #define SERREG(name, i, ty, argslot, argval)                            \
 316         static DSGINIT(const) struct tvec_regdef name##_serregs[] = {   \
 317           { #name,      &tvty_##ty,     RV,     0,                      \
 318                                       DSGINIT({ .argslot = argval }) }, \
 319           { "buf",      &tvty_bytes,    RSEROUT, 0 },                   \
 320           { "rc",       &tvty_int,      RRC,    TVRF_OPT,               \
 321                                                     { &tvrange_int } }, \
 322           TVEC_ENDREGS                                                  \
 323         };                                                              \
 324         static DSGINIT(const) struct tvec_regdef name##_deserregs[] = { \
 325           { "buf",      &tvty_bytes,    RSER,   0 },                    \
 326           { #name,      &tvty_##ty,     RVOUT,  0,                      \
 327                                       DSGINIT({ .argslot = argval }) }, \
 328           { "left",     &tvty_uint,     RLEFT,  TVRF_OPT,               \
 329                                                    { &tvrange_size } }, \
 330           { "rc",       &tvty_int,      RRC,    TVRF_OPT,               \
 331                                                     { &tvrange_int } }, \
 332           TVEC_ENDREGS                                                  \
 333         };
 334 TYPEREGS(SERREG)
 335 #undef SERREG
 336
 337 static void before_single_serialize(struct tvec_state *tv, void *ctx)
 338 {
 339   if (!(tv->in[RRC].f&TVRF_LIVE)) {
 340     tv->in[RRC].v.i = 0; tv->in[RRC].f |= TVRF_LIVE;
 341     tv->out[RRC].f |= TVRF_LIVE;
 342   }
 343 }
 344
 345 static void before_single_deserialize(struct tvec_state *tv, void *ctx)
 346 {
 347   if (!(tv->in[RRC].f&TVRF_LIVE)) {
 348     tv->in[RRC].v.i = 0; tv->in[RRC].f |= TVRF_LIVE;
 349     tv->out[RRC].f |= TVRF_LIVE;
 350   }
 351   if (!(tv->in[RLEFT].f&TVRF_LIVE)) {
 352     tv->in[RLEFT].v.u = 0; tv->in[RLEFT].f |= TVRF_LIVE;
 353     tv->out[RLEFT].f |= TVRF_LIVE;
 354   }
 355 }
 356
 357 static const struct tvec_env single_serialize_testenv = {
 358   sizeof(struct test_context),
 359   common_setup, common_findvar,
 360   before_single_serialize, common_run, common_after,
 361   0
 362 }, single_deserialize_testenv = {
 363   sizeof(struct test_context),
 364   common_setup, common_findvar,
 365   before_single_deserialize, common_run, common_after,
 366   0
 367 };
 368
 369 /*----- Multi-type serialization test -------------------------------------*/
 370
 371 static void test_multi_serialize
 372   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 373 {
 374   struct test_context *tctx = ctx;
 375   struct tvec_state *tv = tctx->tv;
 376   const struct tvec_regdef *rd;
 377   union tvec_regval *rv;
 378   dbuf b = DBUF_INIT;
 379
 380   if (tvec_serialize(tv->in, DBUF_BUF(&b), tv->test->regs,
 381                      NTY, sizeof(struct tvec_reg)))
 382     { out[RRC].v.i = -1; goto end; }
 383   tvec_allocbytes(&out[RSEROUT].v, DBLEN(&b));
 384   memcpy(out[RSEROUT].v.bytes.p, DBBASE(&b), DBLEN(&b));
 385   out[RSEROUT].f |= TVRF_LIVE;
 386   buf_flip(DBUF_BUF(&b));
 387
 388   if (tvec_deserialize(tv->out, DBUF_BUF(&b), tv->test->regs,
 389                        NTY, sizeof(struct tvec_reg)))
 390     { out[RRC].v.i = -2; goto end; }
 391   if (BLEFT(&b._b))
 392     { out[RRC].v.i = -3; goto end; }
 393
 394   if ((in[RSAB].f&TVRF_LIVE) && in[RSAB].v.i >= 0) {
 395     rd = &tv->test->regs[in[RSAB].v.i]; rv = &out[in[RSAB].v.i].v;
 396     if (rd->ty == &tvty_int || rd->ty == &tvty_ienum)
 397       rv->i ^= 1;
 398     else if (rd->ty == &tvty_uint ||
 399              rd->ty == &tvty_flags || rd->ty == &tvty_uenum)
 400       rv->u ^= 1;
 401     else if (rd->ty == &tvty_float || rd->ty == &tvty_fenum) {
 402       if (rv->f == rv->f) rv->f = -rv->f;
 403       else rv->f = 1.0;
 404     } else if (rd->ty == &tvty_penum)
 405       rv->p = rv->p
 406         ? 0
 407         : (/*unconst*/ void *)
 408         ((const struct tvec_penuminfo *)rd->arg.p)->av[0].p;
 409     else if (rd->ty == &tvty_text)
 410       { if (rv->text.sz) rv->text.p[0] ^= 1; }
 411     else if (rd->ty == &tvty_bytes)
 412       { if (rv->bytes.sz) rv->bytes.p[0] ^= 1; }
 413   }
 414
 415   out[RRC].v.i = 0;
 416 end:
 417   dbuf_destroy(&b);
 418 }
 419
 420 static const struct tvec_iassoc reg_assocs[] = {
 421   { "none",             -1 },
 422 #define DEFASSOC(name, i, ty, argslot, argval) { #name, i },
 423   TYPEREGS(DEFASSOC)
 424 #undef DEFASSOC
 425   { 0,                  0 }
 426 };
 427 static const struct tvec_ienuminfo reg_enum = { "reg", reg_assocs, 0 };
 428
 429 static DSGINIT(const) struct tvec_regdef multi_serialize_regs[] = {
 430 #define DEFREG(name, i, ty, argslot, argval)                            \
 431   { #name,      &tvty_##ty,     i,      TVRF_OPT,                       \
 432                                       DSGINIT({ .argslot = argval }) },
 433   TYPEREGS(DEFREG)
 434 #undef DEFREG
 435
 436   { "rc",       &tvty_int,      RRC,    TVRF_OPT,       { &tvrange_int } },
 437   { "serialized", &tvty_bytes,  RSEROUT, TVRF_OPT },
 438   { "sabotage", &tvty_ienum,    RSAB,   TVRF_OPT,       { &reg_enum } },
 439
 440   TVEC_ENDREGS
 441 };
 442
 443 static void before_multi_serialize(struct tvec_state *tv, void *ctx)
 444 {
 445   if (!(tv->in[RRC].f&TVRF_LIVE)) {
 446     tv->in[RRC].v.i = 0; tv->in[RRC].f |= TVRF_LIVE;
 447     tv->out[RRC].f |= TVRF_LIVE;
 448   }
 449 }
 450
 451 static const struct tvec_env multi_serialize_testenv = {
 452   sizeof(struct test_context),
 453   common_setup, common_findvar,
 454   before_multi_serialize, common_run, common_after,
 455   0
 456 };
 457
 458 /*----- Crash test --------------------------------------------------------*/
 459
 460 static void test_crash(const struct tvec_reg *in, struct tvec_reg *out,
 461                        void *ctx)
 462 {
 463   out[RVOUT].v.u = in[RV].v.u;
 464   if (in[RSAB].v.i) abort();
 465 }
 466
 467 static const struct tvec_remotefork crash_testenv =
 468   { TVEC_REMOTEFORK(0, 0) };
 469
 470 static const struct tvec_regdef crash_regs[] = {
 471   { "crash",    &tvty_ienum,    RSAB,   0,              { &tvenum_bool } },
 472   { "x",        &tvty_uint,     RV,     0,              { &tvrange_uint } },
 473   { "z",        &tvty_uint,     RVOUT,  0,              { &tvrange_uint } },
 474   TVEC_ENDREGS
 475 };
 476
 477 /*----- Sleep test --------------------------------------------------------*/
 478
 479 static void test_sleep(const struct tvec_reg *in, struct tvec_reg *out,
 480                        void *ctx)
 481 {
 482   struct timeval now, when, tv;
 483   int rc;
 484
 485   rc = gettimeofday(&now, 0); assert(!rc);
 486   tv.tv_sec = in[RV].v.f; tv.tv_usec = 1e6*(in[RV].v.f - tv.tv_sec);
 487
 488   TV_ADD(&when, &now, &tv);
 489   for (;;) {
 490     rc = select(0, 0, 0, 0, &tv); assert(!rc);
 491     rc = gettimeofday(&now, 0); assert(!rc);
 492     if (TV_CMP(&now, >=, &when)) break;
 493     TV_SUB(&tv, &when, &now);
 494   }
 495   out[RVOUT].v.f = in[RV].v.f;
 496 }
 497
 498 static const struct tvec_timeoutenv sleep_subenv =
 499   { TVEC_TIMEOUTINIT(ITIMER_REAL, 0.25) };
 500 static const struct tvec_remotefork sleep_testenv =
 501   { TVEC_REMOTEFORK(&sleep_subenv._env, 0) };
 502
 503 static const struct tvec_regdef sleep_regs[] = {
 504   { "time",     &tvty_duration, RV,     0,              { &tvflt_nonneg } },
 505   { "z",        &tvty_float,    RVOUT,  0,              { &tvflt_nonneg } },
 506   TVEC_ENDREGS
 507 };
 508
 509 /*----- Front end ---------------------------------------------------------*/
 510
 511 static const struct tvec_test tests[] = {
 512   { "multi",    multi_serialize_regs, &multi_serialize_testenv,
 513                                                 test_multi_serialize },
 514
 515 #define DEFSINGLE(name, i, ty, argslot, argval)                         \
 516   { "copy-" #name, name##_copyregs,     &common_testenv, test_copy_##name }, \
 517   { "serialize-" #name, name##_serregs, &single_serialize_testenv, \
 518                                                 test_single_serialize }, \
 519   { "deserialize-" #name, name##_deserregs, &single_deserialize_testenv, \
 520                                                 test_single_deserialize },
 521   TYPEREGS(DEFSINGLE)
 522 #undef DEFSINGLE
 523
 524   { "crash",    crash_regs,     &crash_testenv._env, test_crash },
 525   { "sleep",    sleep_regs,     &sleep_testenv._env, test_sleep },
 526
 527   TVEC_ENDTESTS
 528 };
 529
 530 static const struct tvec_config testconfig = {
 531   tests,
 532   NROUT, NREG, sizeof(struct tvec_reg)
 533 };
 534
 535 int main(int argc, char *argv[])
 536 {
 537 #if __STDC_VERSION__x < 199901
 538 #  define POKE(name, i, ty, argslot, argval)                            \
 539         multi_serialize_regs[i].arg.argslot = argval;                   \
 540         name##_copyregs->arg.argslot = argval;                          \
 541         name##_serregs->arg.argslot = argval;                           \
 542         name##_deserregs->arg.argslot = argval;
 543   TYPEREGS(POKE)
 544 #  undef POKE
 545 #endif
 546   return (tvec_main(argc, argv, &testconfig, 0));
 547 }
 548
 549 /*----- That's all, folks -------------------------------------------------*/