chiark - git - mdw - 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 "tvec.h"
  31
  32 /*----- Register definitions ----------------------------------------------*/
  33
  34 static const struct tvec_iassoc ienum_assocs[] = {
  35   { "less",            -1 },
  36   { "equal",            0 },
  37   { "greater",         +1 },
  38   { 0 }
  39 };
  40
  41 static const struct tvec_uassoc uenum_assocs[] = {
  42   { "apple",            0 },
  43   { "banana",           1 },
  44   { "clementine",       2 },
  45   { 0 }
  46 };
  47
  48 static const struct tvec_fassoc fenum_assocs[] = {
  49   { "e",                2.718281828459045 },
  50   { "pi",               3.141592653589793 },
  51   { "tau",              6.283185307179586 },
  52   { 0 }
  53 };
  54
  55 static const struct tvec_passoc penum_assocs[] = {
  56   { "alice",            &uenum_assocs[0] },
  57   { "bob",              &uenum_assocs[1] },
  58   { "carol",            &uenum_assocs[2] },
  59   { 0 }
  60 };
  61
  62 #if __STDC_VERSION__x >= 199901
  63 #  define DSGINIT(x) x
  64 #else
  65 #  define DSGINIT(x)
  66 #endif
  67
  68 static const struct tvec_floatinfo fenum_fltinfo =
  69   { TVFF_ABSDELTA, -10, +10, 1e-3 };
  70
  71 #define DEFENUM(tag, ty, slot)                                          \
  72   static const struct tvec_##slot##enuminfo slot##enum_info =           \
  73     { slot##enum_NAME, slot##enum_assocs slot##enum_ARGS };
  74 #define ienum_NAME "order"
  75 #define ienum_ARGS , &tvrange_i16
  76 #define uenum_NAME "fruit"
  77 #define uenum_ARGS , &tvrange_u16
  78 #define fenum_NAME "const"
  79 #define fenum_ARGS , &fenum_fltinfo
  80 #define penum_NAME "actor"
  81 #define penum_ARGS
  82 TVEC_MISCSLOTS(DEFENUM)
  83 #undef DEFENUM
  84
  85 static const struct tvec_flag attr_flags[] = {
  86   { "black-fg",         0x07, 0x00 },
  87   { "blue-fg",          0x07, 0x01 },
  88   { "red-fg",           0x07, 0x02 },
  89   { "magenta-fg",       0x07, 0x03 },
  90   { "green-fg",         0x07, 0x04 },
  91   { "cyan-fg",          0x07, 0x05 },
  92   { "yellow-fg",        0x07, 0x06 },
  93   { "white-fg",         0x07, 0x07 },
  94
  95   { "black-bg",         0x38, 0x00 },
  96   { "blue-bg",          0x38, 0x08 },
  97   { "red-bg",           0x38, 0x10 },
  98   { "magenta-bg",       0x38, 0x18 },
  99   { "green-bg",         0x38, 0x20 },
 100   { "cyan-bg",          0x38, 0x28 },
 101   { "yellow-bg",        0x38, 0x30 },
 102   { "white-bg",         0x38, 0x38 },
 103
 104   { "normal",           0xc0, 0x00 },
 105   { "bright",           0x40, 0x40 },
 106   { "flash",            0x80, 0x80 },
 107
 108   { 0 }
 109 };
 110
 111 static const struct tvec_flaginfo attr_info =
 112   { "attr", attr_flags, &tvrange_u16 };
 113
 114 static const struct tvec_floatinfo fltish_info =
 115   { TVFF_RELDELTA, -1.0, +1.0, 1e-6 };
 116
 117 static const struct tvec_urange range_32 = { 0, 31 };
 118
 119 #define TYPEREGS(_)                                                     \
 120   _(int,        RI,     int,                    p, &tvrange_i16)        \
 121   _(uint,       RU,     uint,                   p, &tvrange_u16)        \
 122   _(float,      RFP,    float,                  p, 0)                   \
 123   _(fltish,     RFISH,  float,                  p, &fltish_info)        \
 124   _(char,       RCH,    char,                   p, 0)                   \
 125   _(ienum,      RIE,    ienum,                  p, &ienum_info)         \
 126   _(uenum,      RUE,    uenum,                  p, &uenum_info)         \
 127   _(fenum,      RFE,    fenum,                  p, &fenum_info)         \
 128   _(penum,      RPE,    penum,                  p, &penum_info)         \
 129   _(flags,      RF,     flags,                  p, &attr_info)          \
 130   _(string,     RSTR,   string,                 p, &range_32)           \
 131   _(bytes,      RBY,    bytes,                  p, &tvrange_byte)       \
 132   _(buffer,     RBUF,   buffer,                 p, 0)
 133
 134 enum {
 135   /* Output registers, one for each register type. */
 136 #define DEFREG(name, i, ty, argslot, argval) i,
 137   TYPEREGS(DEFREG)
 138 #undef DEFREG
 139   NTY,
 140
 141   /* Outputs. */
 142   RRC = NTY,                            /* return code from deserialize */
 143   RSEROUT,                              /* serialized output */
 144
 145   NROUT,
 146
 147   /* Alternative outputs. */
 148   RVOUT = 0,                            /* output/copy value */
 149   RLEFT,                                /* size data remaining in input */
 150
 151   /* Additional inputs. */
 152   RSAB = NROUT,                         /* which register to sabotage */
 153   RV,                                   /* input value */
 154   RSER,                                 /* serialized input */
 155
 156   NREG
 157 };
 158
 159 /*----- Common execution environment --------------------------------------*/
 160
 161 struct test_context {
 162   struct tvec_state *tv;
 163   unsigned f;
 164 #define SF_SHOW 1u
 165 };
 166
 167 static int common_setup(struct tvec_state *tv,
 168                          const struct tvec_env *env, void *pctx, void *ctx)
 169 {
 170   struct test_context *tctx = ctx;
 171
 172   tctx->tv = tv;
 173   tctx->f = 0;
 174   return (0);
 175 }
 176
 177 static int common_set(struct tvec_state *tv, const char *name,
 178                       const struct tvec_env *env, void *ctx)
 179 {
 180   struct test_context *tctx = ctx;
 181   union tvec_regval rv;
 182   static const struct tvec_regdef rd =
 183     { "@show", -1, &tvty_ienum, 0, { &tvenum_bool } };
 184
 185   if (STRCMP(name, ==, "@show")) {
 186     if (tvty_ienum.parse(&rv, &rd, tv)) return (-1);
 187     if (tctx) {
 188       if (rv.i) tctx->f |= SF_SHOW;
 189       else tctx->f &= ~SF_SHOW;
 190     }
 191     return (1);
 192   } else
 193     return (0);
 194 }
 195
 196 static void common_run(struct tvec_state *tv, tvec_testfn *fn, void *ctx)
 197 {
 198   struct test_context *tctx = ctx;
 199   unsigned f = tctx->f;
 200
 201   fn(tv->in, tv->out, tctx);
 202   if (tvec_checkregs(tv)) { tvec_fail(tv, 0); f |= SF_SHOW; }
 203   if (f&SF_SHOW) tvec_mismatch(tv, TVMF_IN | TVMF_OUT);
 204 }
 205
 206 static void common_after(struct tvec_state *tv, void *ctx)
 207   { struct test_context *tctx = ctx; tctx->f = 0; }
 208
 209 static const struct tvec_env common_testenv = {
 210   sizeof(struct test_context),
 211   common_setup, common_set,
 212   0, common_run, common_after,
 213   0
 214 };
 215
 216 /*----- Single-type copy tests --------------------------------------------*/
 217
 218 static void test_copy_simple
 219   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 220   { out->v = in->v; }
 221
 222 static void test_copy_string
 223   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 224 {
 225   tvec_allocstring(&out->v, in->v.str.sz);
 226   memcpy(out->v.str.p, in->v.str.p, in->v.str.sz);
 227 }
 228
 229 static void test_copy_bytes
 230   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 231 {
 232   tvec_allocstring(&out->v, in->v.str.sz);
 233   memcpy(out->v.str.p, in->v.str.p, in->v.str.sz);
 234 }
 235
 236 #define test_copy_int test_copy_simple
 237 #define test_copy_uint test_copy_simple
 238 #define test_copy_ienum test_copy_simple
 239 #define test_copy_uenum test_copy_simple
 240 #define test_copy_fenum test_copy_simple
 241 #define test_copy_penum test_copy_simple
 242 #define test_copy_char test_copy_simple
 243 #define test_copy_flags test_copy_simple
 244 #define test_copy_float test_copy_simple
 245 #define test_copy_fltish test_copy_simple
 246 #define test_copy_buffer test_copy_bytes
 247
 248 #define COPYREG(name, i, ty, argslot, argval)                           \
 249         static DSGINIT(const) struct tvec_regdef name##_copyregs[] = {  \
 250           { #name, RVOUT, &tvty_##ty, 0, DSGINIT({ .argslot = argval }) }, \
 251           { 0 }                                                         \
 252         };
 253 TYPEREGS(COPYREG)
 254 #undef COPYREG
 255
 256 /*----- Single-type serialization tests -----------------------------------*/
 257
 258 static void setup_regdef(struct tvec_regdef *rd, unsigned i,
 259                          struct tvec_state *tv)
 260 {
 261   const struct tvec_regdef *r;
 262
 263   for (r = tv->test->regs; r->name; r++) if (r->i == i) goto found;
 264   tvec_error(tv, "internel: register definition not found"); exit(2);
 265 found:
 266   rd[0] = *r; rd[1].name = 0;
 267 }
 268
 269 static void test_single_serialize
 270   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 271 {
 272   struct test_context *tctx = ctx;
 273   struct tvec_state *tv = tctx->tv;
 274   struct tvec_regdef rd[2];
 275   dbuf b = DBUF_INIT;
 276   int rc;
 277
 278   setup_regdef(rd, RV, tv);
 279   rc = tvec_serialize(tv->in, DBUF_BUF(&b), rd, NREG,
 280                       sizeof(struct tvec_reg));
 281   out[RRC].v.i = rc;
 282   if (rc)
 283     out[RSEROUT].f &= ~TVRF_LIVE;
 284   else {
 285     tvec_allocbytes(&out[RSEROUT].v, BLEN(DBUF_BUF(&b)));
 286     memcpy(out[RSEROUT].v.bytes.p, BBASE(DBUF_BUF(&b)), BLEN(DBUF_BUF(&b)));
 287   }
 288 }
 289
 290 static void test_single_deserialize
 291   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 292 {
 293   struct test_context *tctx = ctx;
 294   struct tvec_state *tv = tctx->tv;
 295   struct tvec_regdef rd[2];
 296   buf b;
 297   int rc;
 298
 299   setup_regdef(rd, RV, tv);
 300   buf_init(&b, in[RSER].v.bytes.p, in[RSER].v.bytes.sz);
 301   rc = tvec_deserialize(tv->out, &b, rd, NREG, sizeof(struct tvec_reg));
 302   out[RRC].v.i = rc;
 303   if (rc) out[RVOUT].f &= ~TVRF_LIVE;
 304 }
 305
 306 #define SERREG(name, i, ty, argslot, argval)                            \
 307         static DSGINIT(const) struct tvec_regdef name##_serregs[] = {   \
 308           { #name, RV,  &tvty_##ty, 0, DSGINIT({ .argslot = argval }) }, \
 309           { "buf", RSEROUT, &tvty_bytes },                              \
 310           { "rc", RRC,  &tvty_int,      TVRF_OPT,       { &tvrange_int } }, \
 311           TVEC_ENDREGS                                                  \
 312         };                                                              \
 313         static DSGINIT(const) struct tvec_regdef name##_deserregs[] = { \
 314           { "buf", RSER, &tvty_bytes },                                 \
 315           { #name, RVOUT, &tvty_##ty, 0, DSGINIT({ .argslot = argval }) }, \
 316           { "left", RLEFT, &tvty_uint,  TVRF_OPT,      { &tvrange_size } }, \
 317           { "rc", RRC,  &tvty_int,      TVRF_OPT,       { &tvrange_int } }, \
 318           TVEC_ENDREGS                                                  \
 319         };
 320 TYPEREGS(SERREG)
 321 #undef SERREG
 322
 323 static int before_single_serialize(struct tvec_state *tv, void *ctx)
 324 {
 325   if (!(tv->in[RRC].f&TVRF_LIVE)) {
 326     tv->in[RRC].v.i = 0; tv->in[RRC].f |= TVRF_LIVE;
 327     tv->out[RRC].f |= TVRF_LIVE;
 328   }
 329   return (0);
 330 }
 331
 332 static int before_single_deserialize(struct tvec_state *tv, void *ctx)
 333 {
 334   if (!(tv->in[RRC].f&TVRF_LIVE)) {
 335     tv->in[RRC].v.i = 0; tv->in[RRC].f |= TVRF_LIVE;
 336     tv->out[RRC].f |= TVRF_LIVE;
 337   }
 338   if (!(tv->in[RLEFT].f&TVRF_LIVE)) {
 339     tv->in[RLEFT].v.u = 0; tv->in[RLEFT].f |= TVRF_LIVE;
 340     tv->out[RLEFT].f |= TVRF_LIVE;
 341   }
 342   return (0);
 343 }
 344
 345 static const struct tvec_env single_serialize_testenv = {
 346   sizeof(struct test_context),
 347   common_setup, common_set,
 348   before_single_serialize, common_run, common_after,
 349   0
 350 }, single_deserialize_testenv = {
 351   sizeof(struct test_context),
 352   common_setup, common_set,
 353   before_single_deserialize, common_run, common_after,
 354   0
 355 };
 356
 357 /*----- Multi-type serialization test -------------------------------------*/
 358
 359 static void test_multi_serialize
 360   (const struct tvec_reg *in, struct tvec_reg *out, void *ctx)
 361 {
 362   struct test_context *tctx = ctx;
 363   struct tvec_state *tv = tctx->tv;
 364   const struct tvec_regdef *rd;
 365   union tvec_regval *rv;
 366   dbuf b = DBUF_INIT;
 367
 368   if (tvec_serialize(tv->in, DBUF_BUF(&b), tv->test->regs,
 369                      NTY, sizeof(struct tvec_reg)))
 370     { out[RRC].v.i = -1; goto end; }
 371   tvec_allocbytes(&out[RSEROUT].v, DBLEN(&b));
 372   memcpy(out[RSEROUT].v.bytes.p, DBBASE(&b), DBLEN(&b));
 373   out[RSEROUT].f |= TVRF_LIVE;
 374   buf_flip(DBUF_BUF(&b));
 375
 376   if (tvec_deserialize(tv->out, DBUF_BUF(&b), tv->test->regs,
 377                        NTY, sizeof(struct tvec_reg)))
 378     { out[RRC].v.i = -2; goto end; }
 379   if (BLEFT(&b._b))
 380     { out[RRC].v.i = -3; goto end; }
 381
 382   if ((in[RSAB].f&TVRF_LIVE) && in[RSAB].v.i >= 0) {
 383     rd = &tv->test->regs[in[RSAB].v.i]; rv = &out[in[RSAB].v.i].v;
 384     if (rd->ty == &tvty_int || rd->ty == &tvty_ienum)
 385       rv->i ^= 1;
 386     else if (rd->ty == &tvty_uint ||
 387              rd->ty == &tvty_flags || rd->ty == &tvty_uenum)
 388       rv->u ^= 1;
 389     else if (rd->ty == &tvty_float || rd->ty == &tvty_fenum) {
 390       if (rv->f == rv->f) rv->f = -rv->f;
 391       else rv->f = 1.0;
 392     } else if (rd->ty == &tvty_penum)
 393       rv->p = rv->p
 394         ? 0
 395         : (/*unconst*/ void *)
 396         ((const struct tvec_penuminfo *)rd->arg.p)->av[0].p;
 397     else if (rd->ty == &tvty_string)
 398       { if (rv->str.sz) rv->str.p[0] ^= 1; }
 399     else if (rd->ty == &tvty_bytes)
 400       { if (rv->bytes.sz) rv->bytes.p[0] ^= 1; }
 401   }
 402
 403   out[RRC].v.i = 0;
 404 end:
 405   dbuf_destroy(&b);
 406 }
 407
 408 static const struct tvec_iassoc reg_assocs[] = {
 409   { "none",             -1 },
 410 #define DEFASSOC(name, i, ty, argslot, argval) { #name, i },
 411   TYPEREGS(DEFASSOC)
 412 #undef DEFASSOC
 413   { 0,                  0 }
 414 };
 415 static const struct tvec_ienuminfo reg_enum = { "reg", reg_assocs, 0 };
 416
 417 static DSGINIT(const) struct tvec_regdef multi_serialize_regs[] = {
 418 #define DEFREG(name, i, ty, argslot, argval)                            \
 419   { #name,      i,      &tvty_##ty,     TVRF_OPT,                       \
 420                                             DSGINIT({ .argslot = argval }) },
 421   TYPEREGS(DEFREG)
 422 #undef DEFREG
 423
 424   { "rc",       RRC,    &tvty_int,      TVRF_OPT,       { &tvrange_int } },
 425   { "serialized", RSEROUT, &tvty_bytes, TVRF_OPT },
 426   { "sabotage", RSAB,   &tvty_ienum,    TVRF_OPT,       { &reg_enum } },
 427
 428   TVEC_ENDREGS
 429 };
 430
 431 static int before_multi_serialize(struct tvec_state *tv, void *ctx)
 432 {
 433   if (!(tv->in[RRC].f&TVRF_LIVE)) {
 434     tv->in[RRC].v.i = 0; tv->in[RRC].f |= TVRF_LIVE;
 435     tv->out[RRC].f |= TVRF_LIVE;
 436   }
 437   return (0);
 438 }
 439
 440 static const struct tvec_env multi_serialize_testenv = {
 441   sizeof(struct test_context),
 442   common_setup, common_set,
 443   before_multi_serialize, common_run, common_after,
 444   0
 445 };
 446
 447 /*----- Front end ---------------------------------------------------------*/
 448
 449 static const struct tvec_test tests[] = {
 450   { "multi",    multi_serialize_regs, &multi_serialize_testenv,
 451                                                 test_multi_serialize },
 452
 453 #define DEFSINGLE(name, i, ty, argslot, argval)                         \
 454   { "copy-" #name, name##_copyregs,     &common_testenv, test_copy_##name }, \
 455   { "serialize-" #name, name##_serregs, &single_serialize_testenv, \
 456                                                 test_single_serialize }, \
 457   { "deserialize-" #name, name##_deserregs, &single_deserialize_testenv, \
 458                                                 test_single_deserialize },
 459   TYPEREGS(DEFSINGLE)
 460 #undef DEFSINGLE
 461
 462   TVEC_ENDTESTS
 463 };
 464
 465 static const struct tvec_config testconfig = {
 466   tests,
 467   NROUT, NREG, sizeof(struct tvec_reg)
 468 };
 469
 470 int main(int argc, char *argv[])
 471 {
 472 #if __STDC_VERSION__x < 199901
 473 #  define POKE(name, i, ty, argslot, argval)                            \
 474         multi_serialize_regs[i].arg.argslot = argval;                   \
 475         name##_copyregs->arg.argslot = argval;                          \
 476         name##_serregs->arg.argslot = argval;                           \
 477         name##_deserregs->arg.argslot = argval;
 478   TYPEREGS(POKE)
 479 #  undef POKE
 480 #endif
 481   return (tvec_main(argc, argv, &testconfig, 0));
 482 }
 483
 484 /*----- That's all, folks -------------------------------------------------*/