lib/sorter/sort-test.c

   1 /*
   2  *      UCW Library -- Testing the Sorter
   3  *
   4  *      (c) 2007 Martin Mares <mj@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 #include "lib/lib.h"
  11 #include "lib/getopt.h"
  12 #include "lib/conf.h"
  13 #include "lib/fastbuf.h"
  14 #include "lib/ff-binary.h"
  15 #include "lib/hashfunc.h"
  16 #include "lib/md5.h"
  17
  18 #include <stdlib.h>
  19 #include <stdio.h>
  20 #include <string.h>
  21 #include <fcntl.h>
  22 #include <unistd.h>
  23
  24 /*** Time measurement ***/
  25
  26 static timestamp_t timer;
  27 static uns test_id;
  28
  29 static void
  30 start(void)
  31 {
  32   sync();
  33   init_timer(&timer);
  34 }
  35
  36 static void
  37 stop(void)
  38 {
  39   sync();
  40   msg(L_INFO, "Test %d took %.3fs", test_id, get_timer(&timer) / 1000.);
  41 }
  42
  43 /*** Simple 4-byte integer keys ***/
  44
  45 struct key1 {
  46   u32 x;
  47 };
  48
  49 #define SORT_KEY_REGULAR struct key1
  50 #define SORT_PREFIX(x) s1_##x
  51 #define SORT_INPUT_FB
  52 #define SORT_OUTPUT_FB
  53 #define SORT_UNIQUE
  54 #define SORT_INT(k) (k).x
  55 #define SORT_DELETE_INPUT 0
  56
  57 #include "lib/sorter/sorter.h"
  58
  59 static void
  60 test_int(int mode, u64 size)
  61 {
  62   uns N = size ? nextprime(MIN(size/4, 0xffff0000)) : 0;
  63   uns K = N/4*3;
  64   msg(L_INFO, ">>> Integers (%s, N=%u)", ((char *[]) { "increasing", "decreasing", "random" })[mode], N);
  65
  66   struct fastbuf *f = bopen_tmp(65536);
  67   for (uns i=0; i<N; i++)
  68     bputl(f, (mode==0) ? i : (mode==1) ? N-1-i : ((u64)i * K + 17) % N);
  69   brewind(f);
  70
  71   start();
  72   f = s1_sort(f, NULL, N-1);
  73   stop();
  74
  75   SORT_XTRACE(2, "Verifying");
  76   for (uns i=0; i<N; i++)
  77     {
  78       uns j = bgetl(f);
  79       if (i != j)
  80         die("Discrepancy: %u instead of %u", j, i);
  81     }
  82   bclose(f);
  83 }
  84
  85 /*** Integers with merging, but no data ***/
  86
  87 struct key2 {
  88   u32 x;
  89   u32 cnt;
  90 };
  91
  92 static inline void s2_write_merged(struct fastbuf *f, struct key2 **k, void **d UNUSED, uns n, void *buf UNUSED)
  93 {
  94   for (uns i=1; i<n; i++)
  95     k[0]->cnt += k[i]->cnt;
  96   bwrite(f, k[0], sizeof(struct key2));
  97 }
  98
  99 #define SORT_KEY_REGULAR struct key2
 100 #define SORT_PREFIX(x) s2_##x
 101 #define SORT_INPUT_FB
 102 #define SORT_OUTPUT_FB
 103 #define SORT_UNIFY
 104 #define SORT_INT(k) (k).x
 105
 106 #include "lib/sorter/sorter.h"
 107
 108 static void
 109 test_counted(int mode, u64 size)
 110 {
 111   u64 items = size / sizeof(struct key2);
 112   uns mult = 2;
 113   while (items/(2*mult) > 0xffff0000)
 114     mult++;
 115   uns N = items ? nextprime(items/(2*mult)) : 0;
 116   uns K = N/4*3;
 117   msg(L_INFO, ">>> Counted integers (%s, N=%u, mult=%u)", ((char *[]) { "increasing", "decreasing", "random" })[mode], N, mult);
 118
 119   struct fastbuf *f = bopen_tmp(65536);
 120   for (uns m=0; m<mult; m++)
 121     for (uns i=0; i<N; i++)
 122       for (uns j=0; j<2; j++)
 123         {
 124           bputl(f, (mode==0) ? (i%N) : (mode==1) ? N-1-(i%N) : ((u64)i * K + 17) % N);
 125           bputl(f, 1);
 126         }
 127   brewind(f);
 128
 129   start();
 130   f = s2_sort(f, NULL, N-1);
 131   stop();
 132
 133   SORT_XTRACE(2, "Verifying");
 134   for (uns i=0; i<N; i++)
 135     {
 136       uns j = bgetl(f);
 137       if (i != j)
 138         die("Discrepancy: %u instead of %u", j, i);
 139       uns k = bgetl(f);
 140       if (k != 2*mult)
 141         die("Discrepancy: %u has count %u instead of %u", j, k, 2*mult);
 142     }
 143   bclose(f);
 144 }
 145
 146 /*** Longer records with hashes (similar to Shepherd's index records) ***/
 147
 148 struct key3 {
 149   u32 hash[4];
 150   u32 i;
 151   u32 payload[3];
 152 };
 153
 154 static inline int s3_compare(struct key3 *x, struct key3 *y)
 155 {
 156   COMPARE(x->hash[0], y->hash[0]);
 157   COMPARE(x->hash[1], y->hash[1]);
 158   COMPARE(x->hash[2], y->hash[2]);
 159   COMPARE(x->hash[3], y->hash[3]);
 160   return 0;
 161 }
 162
 163 static inline uns s3_hash(struct key3 *x)
 164 {
 165   return x->hash[0];
 166 }
 167
 168 #define SORT_KEY_REGULAR struct key3
 169 #define SORT_PREFIX(x) s3_##x
 170 #define SORT_INPUT_FB
 171 #define SORT_OUTPUT_FB
 172 #define SORT_HASH_BITS 32
 173
 174 #include "lib/sorter/sorter.h"
 175
 176 static void
 177 gen_hash_key(int mode, struct key3 *k, uns i)
 178 {
 179   k->i = i;
 180   k->payload[0] = 7*i + 13;
 181   k->payload[1] = 13*i + 19;
 182   k->payload[2] = 19*i + 7;
 183   switch (mode)
 184     {
 185     case 0:
 186       k->hash[0] = i;
 187       k->hash[1] = k->payload[0];
 188       k->hash[2] = k->payload[1];
 189       k->hash[3] = k->payload[2];
 190       break;
 191     case 1:
 192       k->hash[0] = ~i;
 193       k->hash[1] = k->payload[0];
 194       k->hash[2] = k->payload[1];
 195       k->hash[3] = k->payload[2];
 196       break;
 197     default: ;
 198       struct MD5Context ctx;
 199       MD5Init(&ctx);
 200       MD5Update(&ctx, (byte*) &k->i, 4);
 201       MD5Final((byte*) &k->hash, &ctx);
 202       break;
 203     }
 204 }
 205
 206 static void
 207 test_hashes(int mode, u64 size)
 208 {
 209   uns N = MIN(size / sizeof(struct key3), 0xffffffff);
 210   msg(L_INFO, ">>> Hashes (%s, N=%u)", ((char *[]) { "increasing", "decreasing", "random" })[mode], N);
 211   struct key3 k, lastk;
 212
 213   struct fastbuf *f = bopen_tmp(65536);
 214   uns hash_sum = 0;
 215   for (uns i=0; i<N; i++)
 216     {
 217       gen_hash_key(mode, &k, i);
 218       hash_sum += k.hash[3];
 219       bwrite(f, &k, sizeof(k));
 220     }
 221   brewind(f);
 222
 223   start();
 224   f = s3_sort(f, NULL);
 225   stop();
 226
 227   SORT_XTRACE(2, "Verifying");
 228   for (uns i=0; i<N; i++)
 229     {
 230       int ok = breadb(f, &k, sizeof(k));
 231       ASSERT(ok);
 232       if (i && s3_compare(&k, &lastk) <= 0)
 233         ASSERT(0);
 234       gen_hash_key(mode, &lastk, k.i);
 235       if (memcmp(&k, &lastk, sizeof(k)))
 236         ASSERT(0);
 237       hash_sum -= k.hash[3];
 238     }
 239   ASSERT(!hash_sum);
 240   bclose(f);
 241 }
 242
 243 /*** Variable-length records (strings) with and without var-length data ***/
 244
 245 #define KEY4_MAX 256
 246
 247 struct key4 {
 248   uns len;
 249   byte s[KEY4_MAX];
 250 };
 251
 252 static inline int s4_compare(struct key4 *x, struct key4 *y)
 253 {
 254   uns l = MIN(x->len, y->len);
 255   int c = memcmp(x->s, y->s, l);
 256   if (c)
 257     return c;
 258   COMPARE(x->len, y->len);
 259   return 0;
 260 }
 261
 262 static inline int s4_read_key(struct fastbuf *f, struct key4 *x)
 263 {
 264   x->len = bgetl(f);
 265   if (x->len == 0xffffffff)
 266     return 0;
 267   ASSERT(x->len < KEY4_MAX);
 268   breadb(f, x->s, x->len);
 269   return 1;
 270 }
 271
 272 static inline void s4_write_key(struct fastbuf *f, struct key4 *x)
 273 {
 274   ASSERT(x->len < KEY4_MAX);
 275   bputl(f, x->len);
 276   bwrite(f, x->s, x->len);
 277 }
 278
 279 #define SORT_KEY struct key4
 280 #define SORT_PREFIX(x) s4_##x
 281 #define SORT_KEY_SIZE(x) (sizeof(struct key4) - KEY4_MAX + (x).len)
 282 #define SORT_INPUT_FB
 283 #define SORT_OUTPUT_FB
 284
 285 #include "lib/sorter/sorter.h"
 286
 287 #define s4b_compare s4_compare
 288 #define s4b_read_key s4_read_key
 289 #define s4b_write_key s4_write_key
 290
 291 static inline uns s4_data_size(struct key4 *x)
 292 {
 293   return x->len ? (x->s[0] ^ 0xad) : 0;
 294 }
 295
 296 #define SORT_KEY struct key4
 297 #define SORT_PREFIX(x) s4b_##x
 298 #define SORT_KEY_SIZE(x) (sizeof(struct key4) - KEY4_MAX + (x).len)
 299 #define SORT_DATA_SIZE(x) s4_data_size(&(x))
 300 #define SORT_INPUT_FB
 301 #define SORT_OUTPUT_FB
 302
 303 #include "lib/sorter/sorter.h"
 304
 305 static void
 306 gen_key4(struct key4 *k)
 307 {
 308   k->len = random_max(KEY4_MAX);
 309   for (uns i=0; i<k->len; i++)
 310     k->s[i] = random();
 311 }
 312
 313 static void
 314 gen_data4(byte *buf, uns len, uns h)
 315 {
 316   while (len--)
 317     {
 318       *buf++ = h >> 24;
 319       h = h*259309 + 17;
 320     }
 321 }
 322
 323 static void
 324 test_strings(uns mode, u64 size)
 325 {
 326   uns avg_item_size = KEY4_MAX/2 + 4 + (mode ? 128 : 0);
 327   uns N = MIN(size / avg_item_size, 0xffffffff);
 328   msg(L_INFO, ">>> Strings %s(N=%u)", (mode ? "with data " : ""), N);
 329   srand(1);
 330
 331   struct key4 k, lastk;
 332   byte buf[256], buf2[256];
 333   uns sum = 0;
 334
 335   struct fastbuf *f = bopen_tmp(65536);
 336   for (uns i=0; i<N; i++)
 337     {
 338       gen_key4(&k);
 339       s4_write_key(f, &k);
 340       uns h = hash_block(k.s, k.len);
 341       sum += h;
 342       if (mode)
 343         {
 344           gen_data4(buf, s4_data_size(&k), h);
 345           bwrite(f, buf, s4_data_size(&k));
 346         }
 347     }
 348   brewind(f);
 349
 350   start();
 351   f = (mode ? s4b_sort : s4_sort)(f, NULL);
 352   stop();
 353
 354   SORT_XTRACE(2, "Verifying");
 355   for (uns i=0; i<N; i++)
 356     {
 357       int ok = s4_read_key(f, &k);
 358       ASSERT(ok);
 359       uns h = hash_block(k.s, k.len);
 360       if (mode && s4_data_size(&k))
 361         {
 362           ok = breadb(f, buf, s4_data_size(&k));
 363           ASSERT(ok);
 364           gen_data4(buf2, s4_data_size(&k), h);
 365           ASSERT(!memcmp(buf, buf2, s4_data_size(&k)));
 366         }
 367       if (i && s4_compare(&k, &lastk) < 0)
 368         ASSERT(0);
 369       sum -= h;
 370       lastk = k;
 371     }
 372   ASSERT(!sum);
 373   bclose(f);
 374 }
 375
 376 /*** Graph-like structure with custom presorting ***/
 377
 378 struct key5 {
 379   u32 x;
 380   u32 cnt;
 381 };
 382
 383 static uns s5_N, s5_K, s5_L, s5_i, s5_j;
 384
 385 struct s5_pair {
 386   uns x, y;
 387 };
 388
 389 static int s5_gen(struct s5_pair *p)
 390 {
 391   if (s5_j >= s5_N)
 392     {
 393       if (s5_i >= s5_N-1)
 394         return 0;
 395       s5_j = 0;
 396       s5_i++;
 397     }
 398   p->x = ((u64)s5_j * s5_K) % s5_N;
 399   p->y = ((u64)(s5_i + s5_j) * s5_L) % s5_N;
 400   s5_j++;
 401   return 1;
 402 }
 403
 404 #define ASORT_PREFIX(x) s5m_##x
 405 #define ASORT_KEY_TYPE u32
 406 #define ASORT_ELT(i) ary[i]
 407 #define ASORT_EXTRA_ARGS , u32 *ary
 408 #include "lib/arraysort.h"
 409
 410 static void s5_write_merged(struct fastbuf *f, struct key5 **keys, void **data, uns n, void *buf)
 411 {
 412   u32 *a = buf;
 413   uns m = 0;
 414   for (uns i=0; i<n; i++)
 415     {
 416       memcpy(&a[m], data[i], 4*keys[i]->cnt);
 417       m += keys[i]->cnt;
 418     }
 419   s5m_sort(m, a);
 420   keys[0]->cnt = m;
 421   bwrite(f, keys[0], sizeof(struct key5));
 422   bwrite(f, a, 4*m);
 423 }
 424
 425 static void s5_copy_merged(struct key5 **keys, struct fastbuf **data, uns n, struct fastbuf *dest)
 426 {
 427   u32 k[n];
 428   uns m = 0;
 429   for (uns i=0; i<n; i++)
 430     {
 431       k[i] = bgetl(data[i]);
 432       m += keys[i]->cnt;
 433     }
 434   struct key5 key = { .x = keys[0]->x, .cnt = m };
 435   bwrite(dest, &key, sizeof(key));
 436   while (key.cnt--)
 437     {
 438       uns b = 0;
 439       for (uns i=1; i<n; i++)
 440         if (k[i] < k[b])
 441           b = i;
 442       bputl(dest, k[b]);
 443       if (--keys[b]->cnt)
 444         k[b] = bgetl(data[b]);
 445       else
 446         k[b] = ~0U;
 447     }
 448 }
 449
 450 static inline int s5p_lt(struct s5_pair x, struct s5_pair y)
 451 {
 452   COMPARE_LT(x.x, y.x);
 453   COMPARE_LT(x.y, y.y);
 454   return 0;
 455 }
 456
 457 #define ASORT_PREFIX(x) s5p_##x
 458 #define ASORT_KEY_TYPE struct s5_pair
 459 #define ASORT_LT(x,y) s5p_lt(x,y)
 460 #include "lib/sorter/array.h"
 461
 462 static int s5_presort(struct fastbuf *dest, void *buf, size_t bufsize)
 463 {
 464   uns max = MIN(bufsize/sizeof(struct s5_pair), 0xffffffff);
 465   struct s5_pair *a = buf;
 466   uns n = 0;
 467   while (n<max && s5_gen(&a[n]))
 468     n++;
 469   if (!n)
 470     return 0;
 471   s5p_sort(a, n);
 472   uns i = 0;
 473   while (i < n)
 474     {
 475       uns j = i;
 476       while (i < n && a[i].x == a[j].x)
 477         i++;
 478       struct key5 k = { .x = a[j].x, .cnt = i-j };
 479       bwrite(dest, &k, sizeof(k));
 480       while (j < i)
 481         bputl(dest, a[j++].y);
 482     }
 483   return 1;
 484 }
 485
 486 #define SORT_KEY_REGULAR struct key5
 487 #define SORT_PREFIX(x) s5_##x
 488 #define SORT_DATA_SIZE(k) (4*(k).cnt)
 489 #define SORT_UNIFY
 490 #define SORT_UNIFY_WORKSPACE(k) SORT_DATA_SIZE(k)
 491 #define SORT_INPUT_PRESORT
 492 #define SORT_OUTPUT_THIS_FB
 493 #define SORT_INT(k) (k).x
 494
 495 #include "lib/sorter/sorter.h"
 496
 497 #define SORT_KEY_REGULAR struct key5
 498 #define SORT_PREFIX(x) s5b_##x
 499 #define SORT_DATA_SIZE(k) (4*(k).cnt)
 500 #define SORT_UNIFY
 501 #define SORT_UNIFY_WORKSPACE(k) SORT_DATA_SIZE(k)
 502 #define SORT_INPUT_FB
 503 #define SORT_OUTPUT_THIS_FB
 504 #define SORT_INT(k) (k).x
 505 #define s5b_write_merged s5_write_merged
 506 #define s5b_copy_merged s5_copy_merged
 507
 508 #include "lib/sorter/sorter.h"
 509
 510 static void
 511 test_graph(uns mode, u64 size)
 512 {
 513   uns N = 3;
 514   while ((u64)N*(N+2)*4 < size)
 515     N = nextprime(N);
 516   msg(L_INFO, ">>> Graph%s (N=%u)", (mode ? "" : " with custom presorting"), N);
 517   s5_N = N;
 518   s5_K = N/4*3;
 519   s5_L = N/3*2;
 520   s5_i = s5_j = 0;
 521
 522   struct fastbuf *in = NULL;
 523   if (mode)
 524     {
 525       struct s5_pair p;
 526       in = bopen_tmp(65536);
 527       while (s5_gen(&p))
 528         {
 529           struct key5 k = { .x = p.x, .cnt = 1 };
 530           bwrite(in, &k, sizeof(k));
 531           bputl(in, p.y);
 532         }
 533       brewind(in);
 534     }
 535
 536   start();
 537   struct fastbuf *f = bopen_tmp(65536);
 538   bputl(f, 0xfeedcafe);
 539   struct fastbuf *g = (mode ? s5b_sort(in, f, s5_N-1) : s5_sort(NULL, f, s5_N-1));
 540   ASSERT(f == g);
 541   stop();
 542
 543   SORT_XTRACE(2, "Verifying");
 544   uns c = bgetl(f);
 545   ASSERT(c == 0xfeedcafe);
 546   for (uns i=0; i<N; i++)
 547     {
 548       struct key5 k;
 549       int ok = breadb(f, &k, sizeof(k));
 550       ASSERT(ok);
 551       ASSERT(k.x == i);
 552       ASSERT(k.cnt == N);
 553       for (uns j=0; j<N; j++)
 554         {
 555           uns y = bgetl(f);
 556           ASSERT(y == j);
 557         }
 558     }
 559   bclose(f);
 560 }
 561
 562 /*** Simple 8-byte integer keys ***/
 563
 564 struct key6 {
 565   u64 x;
 566 };
 567
 568 #define SORT_KEY_REGULAR struct key6
 569 #define SORT_PREFIX(x) s6_##x
 570 #define SORT_INPUT_FB
 571 #define SORT_OUTPUT_FB
 572 #define SORT_UNIQUE
 573 #define SORT_INT64(k) (k).x
 574
 575 #include "lib/sorter/sorter.h"
 576
 577 static void
 578 test_int64(int mode, u64 size)
 579 {
 580   u64 N = size ? nextprime(MIN(size/8, 0xffff0000)) : 0;
 581   u64 K = N/4*3;
 582   msg(L_INFO, ">>> 64-bit integers (%s, N=%llu)", ((char *[]) { "increasing", "decreasing", "random" })[mode], (long long)N);
 583
 584   struct fastbuf *f = bopen_tmp(65536);
 585   for (u64 i=0; i<N; i++)
 586     bputq(f, 777777*((mode==0) ? i : (mode==1) ? N-1-i : ((u64)i * K + 17) % N));
 587   brewind(f);
 588
 589   start();
 590   f = s6_sort(f, NULL, 777777*(N-1));
 591   stop();
 592
 593   SORT_XTRACE(2, "Verifying");
 594   for (u64 i=0; i<N; i++)
 595     {
 596       u64 j = bgetq(f);
 597       if (777777*i != j)
 598         die("Discrepancy: %llu instead of %llu", (long long)j, 777777*(long long)i);
 599     }
 600   bclose(f);
 601 }
 602
 603 /*** Main ***/
 604
 605 static void
 606 run_test(uns i, u64 size)
 607 {
 608   test_id = i;
 609   switch (i)
 610     {
 611     case 0:
 612       test_int(0, size); break;
 613     case 1:
 614       test_int(1, size); break;
 615     case 2:
 616       test_int(2, size); break;
 617     case 3:
 618       test_counted(0, size); break;
 619     case 4:
 620       test_counted(1, size); break;
 621     case 5:
 622       test_counted(2, size); break;
 623     case 6:
 624       test_hashes(0, size); break;
 625     case 7:
 626       test_hashes(1, size); break;
 627     case 8:
 628       test_hashes(2, size); break;
 629     case 9:
 630       test_strings(0, size); break;
 631     case 10:
 632       test_strings(1, size); break;
 633     case 11:
 634       test_graph(0, size); break;
 635     case 12:
 636       test_graph(1, size); break;
 637     case 13:
 638       test_int64(0, size); break;
 639     case 14:
 640       test_int64(1, size); break;
 641     case 15:
 642       test_int64(2, size); break;
 643 #define TMAX 16
 644     }
 645 }
 646
 647 int
 648 main(int argc, char **argv)
 649 {
 650   log_init(NULL);
 651   int c;
 652   u64 size = 10000000;
 653   uns t = ~0;
 654
 655   while ((c = cf_getopt(argc, argv, CF_SHORT_OPTS "d:s:t:v", CF_NO_LONG_OPTS, NULL)) >= 0)
 656     switch (c)
 657       {
 658       case 'd':
 659         sorter_debug = atol(optarg);
 660         break;
 661       case 's':
 662         if (cf_parse_u64(optarg, &size))
 663           goto usage;
 664         break;
 665       case 't':
 666         t = atol(optarg);
 667         if (t >= TMAX)
 668           goto usage;
 669         break;
 670       case 'v':
 671         sorter_trace++;
 672         break;
 673       default:
 674       usage:
 675         fputs("Usage: sort-test [-v] [-d <debug>] [-s <size>] [-t <test>]\n", stderr);
 676         exit(1);
 677       }
 678   if (optind != argc)
 679     goto usage;
 680
 681   if (t != ~0U)
 682     run_test(t, size);
 683   else
 684     for (uns i=0; i<TMAX; i++)
 685       run_test(i, size);
 686
 687   return 0;
 688 }