pintos-os.org Git - pspp/blob - tests/libpspp/range-set-test.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2007, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 /* This is a test program for the routines defined in
  18    range-set.c.  This test program aims to be as comprehensive as
  19    possible.  With -DNDEBUG, "gcov -b" should report 100%
  20    coverage of lines and branches in range-set.c routines.
  21    (Without -DNDEBUG, branches caused by failed assertions will
  22    not be taken.)  "valgrind --leak-check=yes
  23    --show-reachable=yes" should give a clean report, both with
  24    and without -DNDEBUG. */
  25
  26 #ifdef HAVE_CONFIG_H
  27 #include <config.h>
  28 #endif
  29
  30 #include <libpspp/range-set.h>
  31
  32 #include <assert.h>
  33 #include <limits.h>
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37
  38 #include <libpspp/compiler.h>
  39 #include <libpspp/pool.h>
  40
  41 #include "xalloc.h"
  42 \f
  43 /* Exit with a failure code.
  44    (Place a breakpoint on this function while debugging.) */
  45 static void
  46 check_die (void)
  47 {
  48   exit (EXIT_FAILURE);
  49 }
  50
  51 /* If OK is not true, prints a message about failure on the
  52    current source file and the given LINE and terminates. */
  53 static void
  54 check_func (bool ok, int line)
  55 {
  56   if (!ok)
  57     {
  58       fprintf (stderr, "%s:%d: check failed\n", __FILE__, line);
  59       check_die ();
  60     }
  61 }
  62
  63 /* Verifies that EXPR evaluates to true.
  64    If not, prints a message citing the calling line number and
  65    terminates. */
  66 #define check(EXPR) check_func ((EXPR), __LINE__)
  67 \f
  68 /* A contiguous region. */
  69 struct region
  70   {
  71     unsigned long int start;    /* Start of region. */
  72     unsigned long int end;      /* One past the end. */
  73   };
  74
  75 /* Number of bits in an unsigned int. */
  76 #define UINT_BIT (CHAR_BIT * sizeof (unsigned int))
  77
  78 /* Returns the number of contiguous 1-bits in X starting from bit
  79    0.
  80    This implementation is designed to be obviously correct, not
  81    to be efficient. */
  82 static int
  83 count_one_bits (unsigned long int x)
  84 {
  85   int count = 0;
  86   while (x & 1)
  87     {
  88       count++;
  89       x >>= 1;
  90     }
  91   return count;
  92 }
  93
  94 /* Searches the bits in PATTERN from right to left starting from
  95    bit OFFSET for one or more 1-bits.  If any are found, sets
  96    *START to the bit index of the first and *WIDTH to the number
  97    of contiguous 1-bits and returns true.  Otherwise, returns
  98    false.
  99    This implementation is designed to be obviously correct, not
 100    to be efficient. */
 101 static bool
 102 next_region (unsigned int pattern, unsigned int offset,
 103              unsigned long int *start, unsigned long int *width)
 104 {
 105   unsigned int i;
 106
 107   assert (offset <= UINT_BIT);
 108   for (i = offset; i < UINT_BIT; i++)
 109     if (pattern & (1u << i))
 110       {
 111         *start = i;
 112         *width = count_one_bits (pattern >> i);
 113         return true;
 114       }
 115   return false;
 116 }
 117
 118 /* Searches the bits in PATTERN from left to right starting from
 119    just beyond bit OFFSET for one or more 1-bits.  If any are
 120    found, sets *START to the bit index of the first and *WIDTH to
 121    the number of contiguous 1-bits and returns true.  Otherwise,
 122    returns false.
 123    This implementation is designed to be obviously correct, not
 124    to be efficient. */
 125 static bool
 126 prev_region (unsigned int pattern, unsigned int offset,
 127              unsigned long int *start, unsigned long int *width)
 128 {
 129   unsigned int i;
 130
 131   assert (offset <= UINT_BIT);
 132   for (i = offset; i-- > 0; )
 133     if (pattern & (1u << i))
 134       {
 135         *start = i;
 136         *width = 1;
 137         while (i-- > 0 && pattern & (1u << i))
 138           {
 139             ++*width;
 140             --*start;
 141           }
 142         return true;
 143       }
 144   return false;
 145 }
 146
 147 /* Searches the bits in PATTERN from right to left starting from
 148    bit OFFSET.  Returns the bit index of the first 1-bit found,
 149    or ULONG_MAX if none is found. */
 150 static unsigned long int
 151 next_1bit (unsigned int pattern, unsigned int offset)
 152 {
 153   for (; offset < UINT_BIT; offset++)
 154     if (pattern & (1u << offset))
 155       return offset;
 156   return ULONG_MAX;
 157 }
 158
 159 /* Prints the regions in RS to stdout. */
 160 static void UNUSED
 161 print_regions (const struct range_set *rs)
 162 {
 163   const struct range_set_node *node;
 164
 165   printf ("result:");
 166   RANGE_SET_FOR_EACH (node, rs)
 167     printf (" (%lu,%lu)",
 168             range_set_node_get_start (node), range_set_node_get_end (node));
 169   printf ("\n");
 170 }
 171
 172 /* Checks that the regions in RS match the bits in PATTERN. */
 173 static void
 174 check_pattern (const struct range_set *rs, unsigned int pattern)
 175 {
 176   const struct range_set_node *node;
 177   unsigned long int start, width;
 178   unsigned long int s1, s2;
 179   int i;
 180
 181   for (node = rand () % 2 ? range_set_first (rs) : range_set_next (rs, NULL),
 182          start = width = 0;
 183        next_region (pattern, start + width, &start, &width);
 184        node = range_set_next (rs, node))
 185     {
 186       check (node != NULL);
 187       check (range_set_node_get_start (node) == start);
 188       check (range_set_node_get_end (node) == start + width);
 189       check (range_set_node_get_width (node) == width);
 190     }
 191   check (node == NULL);
 192
 193   for (node = rand () % 2 ? range_set_last (rs) : range_set_prev (rs, NULL),
 194          start = UINT_BIT;
 195        prev_region (pattern, start, &start, &width);
 196        node = range_set_prev (rs, node))
 197     {
 198       check (node != NULL);
 199       check (range_set_node_get_start (node) == start);
 200       check (range_set_node_get_end (node) == start + width);
 201       check (range_set_node_get_width (node) == width);
 202     }
 203   check (node == NULL);
 204
 205   /* Scan from all possible positions, resetting the cache each
 206      time, to ensure that we get the correct answers without
 207      caching. */
 208   for (start = 0; start <= 32; start++)
 209     {
 210       struct range_set *nonconst_rs = CONST_CAST (struct range_set *, rs);
 211       nonconst_rs->cache_end = 0;
 212       s1 = range_set_scan (rs, start);
 213       s2 = next_1bit (pattern, start);
 214       check (s1 == s2);
 215     }
 216
 217   /* Scan in forward order to exercise expected cache behavior. */
 218   for (s1 = range_set_scan (rs, 0), s2 = next_1bit (pattern, 0); ;
 219        s1 = range_set_scan (rs, s1 + 1), s2 = next_1bit (pattern, s2 + 1))
 220     {
 221       check (s1 == s2);
 222       if (s1 == ULONG_MAX)
 223         break;
 224     }
 225
 226   /* Scan in random order to frustrate cache. */
 227   for (i = 0; i < 32; i++)
 228     {
 229       start = rand () % 32;
 230       s1 = range_set_scan (rs, start);
 231       s2 = next_1bit (pattern, start);
 232       check (s1 == s2);
 233     }
 234
 235   /* Test range_set_scan() with negative cache. */
 236   check (!range_set_contains (rs, 999));
 237   check (range_set_scan (rs, 1111) == ULONG_MAX);
 238
 239   for (i = 0; i < UINT_BIT; i++)
 240     check (range_set_contains (rs, i) == ((pattern & (1u << i)) != 0));
 241   check (!range_set_contains (rs,
 242                               UINT_BIT + rand () % (ULONG_MAX - UINT_BIT)));
 243
 244   check (range_set_is_empty (rs) == (pattern == 0));
 245 }
 246
 247 /* Creates and returns a range set that contains regions for the
 248    bits set in PATTERN. */
 249 static struct range_set *
 250 make_pattern (unsigned int pattern)
 251 {
 252   unsigned long int start = 0;
 253   unsigned long int width = 0;
 254   struct range_set *rs = range_set_create_pool (NULL);
 255   while (next_region (pattern, start + width, &start, &width))
 256     range_set_set1 (rs, start, width);
 257   check_pattern (rs, pattern);
 258   return rs;
 259 }
 260
 261 /* Returns an unsigned int with bits OFS...OFS+CNT (exclusive)
 262    set to 1, other bits set to 0. */
 263 static unsigned int
 264 bit_range (unsigned int ofs, unsigned int cnt)
 265 {
 266   assert (ofs < UINT_BIT);
 267   assert (cnt <= UINT_BIT);
 268   assert (ofs + cnt <= UINT_BIT);
 269
 270   return cnt < UINT_BIT ? ((1u << cnt) - 1) << ofs : UINT_MAX;
 271 }
 272 \f
 273 /* Tests inserting all possible patterns into all possible range
 274    sets (up to a small maximum number of bits). */
 275 static void
 276 test_insert (void)
 277 {
 278   const int positions = 9;
 279   unsigned int init_pat;
 280   int i, j;
 281
 282   for (init_pat = 0; init_pat < (1u << positions); init_pat++)
 283     for (i = 0; i < positions + 1; i++)
 284       for (j = i; j <= positions + 1; j++)
 285         {
 286           struct range_set *rs, *rs2;
 287           unsigned int final_pat;
 288
 289           rs = make_pattern (init_pat);
 290           range_set_set1 (rs, i, j - i);
 291           final_pat = init_pat | bit_range (i, j - i);
 292           check_pattern (rs, final_pat);
 293           rs2 = range_set_clone (rs, NULL);
 294           check_pattern (rs2, final_pat);
 295           range_set_destroy (rs);
 296           range_set_destroy (rs2);
 297         }
 298 }
 299
 300 /* Tests deleting all possible patterns from all possible range
 301    sets (up to a small maximum number of bits). */
 302 static void
 303 test_delete (void)
 304 {
 305   const int positions = 9;
 306   unsigned int init_pat;
 307   int i, j;
 308
 309   for (init_pat = 0; init_pat < (1u << positions); init_pat++)
 310     for (i = 0; i < positions + 1; i++)
 311       for (j = i; j <= positions + 1; j++)
 312         {
 313           struct range_set *rs;
 314           unsigned int final_pat;
 315
 316           rs = make_pattern (init_pat);
 317           range_set_set0 (rs, i, j - i);
 318           final_pat = init_pat & ~bit_range (i, j - i);
 319           check_pattern (rs, final_pat);
 320           range_set_destroy (rs);
 321         }
 322 }
 323
 324 /* Tests all possible allocation in all possible range sets (up
 325    to a small maximum number of bits). */
 326 static void
 327 test_allocate (void)
 328 {
 329   const int positions = 9;
 330   unsigned int init_pat;
 331   int request;
 332
 333   for (init_pat = 0; init_pat < (1u << positions); init_pat++)
 334     for (request = 1; request <= positions + 1; request++)
 335       {
 336         struct range_set *rs;
 337         unsigned long int start, width, expect_start, expect_width;
 338         bool success, expect_success;
 339         unsigned int final_pat;
 340         int i;
 341
 342         /* Figure out expected results. */
 343         expect_success = false;
 344         expect_start = expect_width = 0;
 345         final_pat = init_pat;
 346         for (i = 0; i < positions; i++)
 347           if (init_pat & (1u << i))
 348             {
 349               expect_success = true;
 350               expect_start = i;
 351               expect_width = count_one_bits (init_pat >> i);
 352               if (expect_width > request)
 353                 expect_width = request;
 354               final_pat &= ~bit_range (expect_start, expect_width);
 355               break;
 356             }
 357
 358         /* Test. */
 359         rs = make_pattern (init_pat);
 360         success = range_set_allocate (rs, request, &start, &width);
 361         check_pattern (rs, final_pat);
 362         range_set_destroy (rs);
 363
 364         /* Check results. */
 365         check (success == expect_success);
 366         if (expect_success)
 367           {
 368             check (start == expect_start);
 369             check (width == expect_width);
 370           }
 371       }
 372 }
 373
 374 /* Tests all possible full allocations in all possible range sets
 375    (up to a small maximum number of bits). */
 376 static void
 377 test_allocate_fully (void)
 378 {
 379   const int positions = 9;
 380   unsigned int init_pat;
 381   int request;
 382
 383   for (init_pat = 0; init_pat < (1u << positions); init_pat++)
 384     for (request = 1; request <= positions + 1; request++)
 385       {
 386         struct range_set *rs;
 387         unsigned long int start, expect_start;
 388         bool success, expect_success;
 389         unsigned int final_pat;
 390         int i;
 391
 392         /* Figure out expected results. */
 393         expect_success = false;
 394         expect_start = 0;
 395         final_pat = init_pat;
 396         for (i = 0; i < positions - request + 1; i++)
 397           {
 398             int j;
 399
 400             final_pat = init_pat;
 401             for (j = i; j < i + request; j++)
 402               {
 403                 if (!(init_pat & (1u << j)))
 404                   goto next;
 405                 final_pat &= ~(1u << j);
 406               }
 407
 408             expect_success = true;
 409             expect_start = i;
 410             break;
 411           next:
 412             final_pat = init_pat;
 413           }
 414
 415         /* Test. */
 416         rs = make_pattern (init_pat);
 417         success = range_set_allocate_fully (rs, request, &start);
 418         check_pattern (rs, final_pat);
 419         range_set_destroy (rs);
 420
 421         /* Check results. */
 422         check (success == expect_success);
 423         if (expect_success)
 424           check (start == expect_start);
 425       }
 426 }
 427
 428 /* Tests freeing a range set through a pool. */
 429 static void
 430 test_pool (void)
 431 {
 432   struct pool *pool;
 433   struct range_set *rs;
 434
 435   /* Destroy the range set, then the pool.
 436      Makes sure that this doesn't cause a double-free. */
 437   pool = pool_create ();
 438   rs = range_set_create_pool (pool);
 439   range_set_set1 (rs, 1, 10);
 440   range_set_destroy (rs);
 441   pool_destroy (pool);
 442
 443   /* Just destroy the pool.
 444      Makes sure that this doesn't cause a leak. */
 445   pool = pool_create ();
 446   rs = range_set_create_pool (pool);
 447   range_set_set1 (rs, 1, 10);
 448   pool_destroy (pool);
 449 }
 450
 451 /* Tests range_set_destroy(NULL). */
 452 static void
 453 test_destroy_null (void)
 454 {
 455   range_set_destroy (NULL);
 456 }
 457 \f
 458 /* Main program. */
 459
 460 struct test
 461   {
 462     const char *name;
 463     const char *description;
 464     void (*function) (void);
 465   };
 466
 467 static const struct test tests[] =
 468   {
 469     {
 470       "insert",
 471       "insert",
 472       test_insert
 473     },
 474     {
 475       "delete",
 476       "delete",
 477       test_delete
 478     },
 479     {
 480       "allocate",
 481       "allocate",
 482       test_allocate
 483     },
 484     {
 485       "allocate-fully",
 486       "allocate_fully",
 487       test_allocate_fully
 488     },
 489     {
 490       "pool",
 491       "pool",
 492       test_pool
 493     },
 494     {
 495       "destroy-null",
 496       "destroy null",
 497       test_destroy_null
 498     },
 499   };
 500
 501 enum { N_TESTS = sizeof tests / sizeof *tests };
 502
 503 int
 504 main (int argc, char *argv[])
 505 {
 506   int i;
 507
 508   if (argc != 2)
 509     {
 510       fprintf (stderr, "exactly one argument required; use --help for help\n");
 511       return EXIT_FAILURE;
 512     }
 513   else if (!strcmp (argv[1], "--help"))
 514     {
 515       printf ("%s: test range set library\n"
 516               "usage: %s TEST-NAME\n"
 517               "where TEST-NAME is one of the following:\n",
 518               argv[0], argv[0]);
 519       for (i = 0; i < N_TESTS; i++)
 520         printf ("  %s\n    %s\n", tests[i].name, tests[i].description);
 521       return 0;
 522     }
 523   else
 524     {
 525       for (i = 0; i < N_TESTS; i++)
 526         if (!strcmp (argv[1], tests[i].name))
 527           {
 528             tests[i].function ();
 529             return 0;
 530           }
 531
 532       fprintf (stderr, "unknown test %s; use --help for help\n", argv[1]);
 533       return EXIT_FAILURE;
 534     }
 535 }