glib/tests/hash.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  * Copyright (C) 1999 The Free Software Foundation
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 /*
  22  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  23  * file for a list of people on the GLib Team.  See the ChangeLog
  24  * files for a list of changes.  These files are distributed with
  25  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  26  */
  27
  28 #undef G_DISABLE_ASSERT
  29 #undef G_LOG_DOMAIN
  30
  31 #ifdef HAVE_CONFIG_H
  32 #  include <config.h>
  33 #endif
  34
  35 #if STDC_HEADERS
  36 #include <stdio.h>
  37 #include <string.h>
  38 #include <stdlib.h>
  39 #endif
  40
  41 #include <glib.h>
  42
  43
  44
  45 int array[10000];
  46
  47 static void
  48 fill_hash_table_and_array (GHashTable *hash_table)
  49 {
  50   int i;
  51
  52   for (i = 0; i < 10000; i++)
  53     {
  54       array[i] = i;
  55       g_hash_table_insert (hash_table, &array[i], &array[i]);
  56     }
  57 }
  58
  59 static void
  60 init_result_array (int result_array[10000])
  61 {
  62   int i;
  63
  64   for (i = 0; i < 10000; i++)
  65     result_array[i] = -1;
  66 }
  67
  68 static void
  69 verify_result_array (int array[10000])
  70 {
  71   int i;
  72
  73   for (i = 0; i < 10000; i++)
  74     g_assert (array[i] == i);
  75 }
  76
  77 static void
  78 handle_pair (gpointer key, gpointer value, int result_array[10000])
  79 {
  80   int n;
  81
  82   g_assert (key == value);
  83
  84   n = *((int *) value);
  85
  86   g_assert (n >= 0 && n < 10000);
  87   g_assert (result_array[n] == -1);
  88
  89   result_array[n] = n;
  90 }
  91
  92 static gboolean
  93 my_hash_callback_remove (gpointer key,
  94                          gpointer value,
  95                          gpointer user_data)
  96 {
  97   int *d = value;
  98
  99   if ((*d) % 2)
 100     return TRUE;
 101
 102   return FALSE;
 103 }
 104
 105 static void
 106 my_hash_callback_remove_test (gpointer key,
 107                               gpointer value,
 108                               gpointer user_data)
 109 {
 110   int *d = value;
 111
 112   if ((*d) % 2)
 113     g_assert_not_reached ();
 114 }
 115
 116 static void
 117 my_hash_callback (gpointer key,
 118                   gpointer value,
 119                   gpointer user_data)
 120 {
 121   handle_pair (key, value, user_data);
 122 }
 123
 124 static guint
 125 my_hash (gconstpointer key)
 126 {
 127   return (guint) *((const gint*) key);
 128 }
 129
 130 static gboolean
 131 my_hash_equal (gconstpointer a,
 132                gconstpointer b)
 133 {
 134   return *((const gint*) a) == *((const gint*) b);
 135 }
 136
 137
 138
 139 /*
 140  * This is a simplified version of the pathalias hashing function.
 141  * Thanks to Steve Belovin and Peter Honeyman
 142  *
 143  * hash a string into a long int.  31 bit crc (from andrew appel).
 144  * the crc table is computed at run time by crcinit() -- we could
 145  * precompute, but it takes 1 clock tick on a 750.
 146  *
 147  * This fast table calculation works only if POLY is a prime polynomial
 148  * in the field of integers modulo 2.  Since the coefficients of a
 149  * 32-bit polynomial won't fit in a 32-bit word, the high-order bit is
 150  * implicit.  IT MUST ALSO BE THE CASE that the coefficients of orders
 151  * 31 down to 25 are zero.  Happily, we have candidates, from
 152  * E. J.  Watson, "Primitive Polynomials (Mod 2)", Math. Comp. 16 (1962):
 153  *      x^32 + x^7 + x^5 + x^3 + x^2 + x^1 + x^0
 154  *      x^31 + x^3 + x^0
 155  *
 156  * We reverse the bits to get:
 157  *      111101010000000000000000000000001 but drop the last 1
 158  *         f   5   0   0   0   0   0   0
 159  *      010010000000000000000000000000001 ditto, for 31-bit crc
 160  *         4   8   0   0   0   0   0   0
 161  */
 162
 163 #define POLY 0x48000000L        /* 31-bit polynomial (avoids sign problems) */
 164
 165 static guint CrcTable[128];
 166
 167 /*
 168  - crcinit - initialize tables for hash function
 169  */
 170 static void crcinit(void)
 171 {
 172   int i, j;
 173   guint sum;
 174
 175   for (i = 0; i < 128; ++i)
 176     {
 177       sum = 0L;
 178       for (j = 7 - 1; j >= 0; --j)
 179         if (i & (1 << j))
 180           sum ^= POLY >> j;
 181       CrcTable[i] = sum;
 182     }
 183 }
 184
 185 /*
 186  - hash - Honeyman's nice hashing function
 187  */
 188 static guint
 189 honeyman_hash (gconstpointer key)
 190 {
 191   const gchar *name = (const gchar *) key;
 192   gint size;
 193   guint sum = 0;
 194
 195   g_assert (name != NULL);
 196   g_assert (*name != 0);
 197
 198   size = strlen (name);
 199
 200   while (size--)
 201     sum = (sum >> 7) ^ CrcTable[(sum ^ (*name++)) & 0x7f];
 202
 203   return sum;
 204 }
 205
 206
 207 static gboolean
 208 second_hash_cmp (gconstpointer a, gconstpointer b)
 209 {
 210   return strcmp (a, b) == 0;
 211 }
 212
 213
 214
 215 static guint
 216 one_hash (gconstpointer key)
 217 {
 218   return 1;
 219 }
 220
 221
 222 static void
 223 not_even_foreach (gpointer key,
 224                   gpointer value,
 225                   gpointer user_data)
 226 {
 227   const char *_key = (const char *) key;
 228   const char *_value = (const char *) value;
 229   int i;
 230   char val [20];
 231
 232   g_assert (_key != NULL);
 233   g_assert (*_key != 0);
 234   g_assert (_value != NULL);
 235   g_assert (*_value != 0);
 236
 237   i = atoi (_key);
 238
 239   sprintf (val, "%d value", i);
 240   g_assert (strcmp (_value, val) == 0);
 241
 242   g_assert ((i % 2) != 0);
 243   g_assert (i != 3);
 244 }
 245
 246
 247 static gboolean
 248 remove_even_foreach (gpointer key,
 249                      gpointer value,
 250                      gpointer user_data)
 251 {
 252   const char *_key = (const char *) key;
 253   const char *_value = (const char *) value;
 254   int i;
 255   char val [20];
 256
 257   g_assert (_key != NULL);
 258   g_assert (*_key != 0);
 259   g_assert (_value != NULL);
 260   g_assert (*_value != 0);
 261
 262   i = atoi (_key);
 263
 264   sprintf (val, "%d value", i);
 265   g_assert (strcmp (_value, val) == 0);
 266
 267   return ((i % 2) == 0) ? TRUE : FALSE;
 268 }
 269
 270
 271
 272
 273 static void
 274 second_hash_test (gconstpointer d)
 275 {
 276   gboolean simple_hash = GPOINTER_TO_INT (d);
 277
 278   int       i;
 279   char      key[20] = "", val[20]="", *v, *orig_key, *orig_val;
 280   GHashTable     *h;
 281   gboolean found;
 282
 283   crcinit ();
 284
 285   h = g_hash_table_new_full (simple_hash ? one_hash : honeyman_hash,
 286                              second_hash_cmp,
 287                              g_free, g_free);
 288   g_assert (h != NULL);
 289   for (i = 0; i < 20; i++)
 290     {
 291       sprintf (key, "%d", i);
 292       g_assert (atoi (key) == i);
 293
 294       sprintf (val, "%d value", i);
 295       g_assert (atoi (val) == i);
 296
 297       g_hash_table_insert (h, g_strdup (key), g_strdup (val));
 298     }
 299
 300   g_assert (g_hash_table_size (h) == 20);
 301
 302   for (i = 0; i < 20; i++)
 303     {
 304       sprintf (key, "%d", i);
 305       g_assert (atoi(key) == i);
 306
 307       v = (char *) g_hash_table_lookup (h, key);
 308
 309       g_assert (v != NULL);
 310       g_assert (*v != 0);
 311       g_assert (atoi (v) == i);
 312     }
 313
 314   sprintf (key, "%d", 3);
 315   g_hash_table_remove (h, key);
 316   g_assert (g_hash_table_size (h) == 19);
 317   g_hash_table_foreach_remove (h, remove_even_foreach, NULL);
 318   g_assert (g_hash_table_size (h) == 9);
 319   g_hash_table_foreach (h, not_even_foreach, NULL);
 320
 321   for (i = 0; i < 20; i++)
 322     {
 323       sprintf (key, "%d", i);
 324       g_assert (atoi(key) == i);
 325
 326       sprintf (val, "%d value", i);
 327       g_assert (atoi (val) == i);
 328
 329       orig_key = orig_val = NULL;
 330       found = g_hash_table_lookup_extended (h, key,
 331                                             (gpointer)&orig_key,
 332                                             (gpointer)&orig_val);
 333       if ((i % 2) == 0 || i == 3)
 334         {
 335           g_assert (!found);
 336           continue;
 337         }
 338
 339       g_assert (found);
 340
 341       g_assert (orig_key != NULL);
 342       g_assert (strcmp (key, orig_key) == 0);
 343
 344       g_assert (orig_val != NULL);
 345       g_assert (strcmp (val, orig_val) == 0);
 346     }
 347
 348   g_hash_table_destroy (h);
 349 }
 350
 351 static gboolean
 352 find_first (gpointer key,
 353             gpointer value,
 354             gpointer user_data)
 355 {
 356   gint *v = value;
 357   gint *test = user_data;
 358   return (*v == *test);
 359 }
 360
 361
 362 static void
 363 direct_hash_test (void)
 364 {
 365   gint       i, rc;
 366   GHashTable     *h;
 367
 368   h = g_hash_table_new (NULL, NULL);
 369   g_assert (h != NULL);
 370   for (i = 1; i <= 20; i++)
 371     g_hash_table_insert (h, GINT_TO_POINTER (i),
 372                          GINT_TO_POINTER (i + 42));
 373
 374   g_assert (g_hash_table_size (h) == 20);
 375
 376   for (i = 1; i <= 20; i++)
 377     {
 378       rc = GPOINTER_TO_INT (g_hash_table_lookup (h, GINT_TO_POINTER (i)));
 379
 380       g_assert (rc != 0);
 381       g_assert ((rc - 42) == i);
 382     }
 383
 384   g_hash_table_destroy (h);
 385 }
 386
 387 static void
 388 int64_hash_test (void)
 389 {
 390   gint       i, rc;
 391   GHashTable     *h;
 392   gint64     values[20];
 393   gint64 key;
 394
 395   h = g_hash_table_new (g_int64_hash, g_int64_equal);
 396   g_assert (h != NULL);
 397   for (i = 0; i < 20; i++)
 398     {
 399       values[i] = i + 42;
 400       g_hash_table_insert (h, &values[i], GINT_TO_POINTER (i + 42));
 401     }
 402
 403   g_assert (g_hash_table_size (h) == 20);
 404
 405   for (i = 0; i < 20; i++)
 406     {
 407       key = i + 42;
 408       rc = GPOINTER_TO_INT (g_hash_table_lookup (h, &key));
 409
 410       g_assert_cmpint (rc, ==, i + 42);
 411     }
 412
 413   g_hash_table_destroy (h);
 414 }
 415
 416 static void
 417 double_hash_test (void)
 418 {
 419   gint       i, rc;
 420   GHashTable     *h;
 421   gdouble values[20];
 422   gdouble key;
 423
 424   h = g_hash_table_new (g_double_hash, g_double_equal);
 425   g_assert (h != NULL);
 426   for (i = 0; i < 20; i++)
 427     {
 428       values[i] = i + 42.5;
 429       g_hash_table_insert (h, &values[i], GINT_TO_POINTER (i + 42));
 430     }
 431
 432   g_assert (g_hash_table_size (h) == 20);
 433
 434   for (i = 0; i < 20; i++)
 435     {
 436       key = i + 42.5;
 437       rc = GPOINTER_TO_INT (g_hash_table_lookup (h, &key));
 438
 439       g_assert_cmpint (rc, ==, i + 42);
 440     }
 441
 442   g_hash_table_destroy (h);
 443 }
 444
 445 static void
 446 string_free (gpointer data)
 447 {
 448   GString *s = data;
 449
 450   g_string_free (s, TRUE);
 451 }
 452
 453 static void
 454 string_hash_test (void)
 455 {
 456   gint       i, rc;
 457   GHashTable     *h;
 458   GString *s;
 459
 460   h = g_hash_table_new_full ((GHashFunc)g_string_hash, (GEqualFunc)g_string_equal, string_free, NULL);
 461   g_assert (h != NULL);
 462   for (i = 0; i < 20; i++)
 463     {
 464       s = g_string_new ("");
 465       g_string_append_printf (s, "%d", i + 42);
 466       g_string_append_c (s, '.');
 467       g_string_prepend_unichar (s, 0x2301);
 468       g_hash_table_insert (h, s, GINT_TO_POINTER (i + 42));
 469     }
 470
 471   g_assert (g_hash_table_size (h) == 20);
 472
 473   s = g_string_new ("");
 474   for (i = 0; i < 20; i++)
 475     {
 476       g_string_assign (s, "");
 477       g_string_append_printf (s, "%d", i + 42);
 478       g_string_append_c (s, '.');
 479       g_string_prepend_unichar (s, 0x2301);
 480       rc = GPOINTER_TO_INT (g_hash_table_lookup (h, s));
 481
 482       g_assert_cmpint (rc, ==, i + 42);
 483     }
 484
 485   g_string_free (s, TRUE);
 486   g_hash_table_destroy (h);
 487 }
 488
 489 static void
 490 test_hash_misc (void)
 491 {
 492   GHashTable *hash_table;
 493   gint i;
 494   gint value = 120;
 495   gint *pvalue;
 496   GList *keys, *values;
 497   gint keys_len, values_len;
 498   GHashTableIter iter;
 499   gpointer ikey, ivalue;
 500   int result_array[10000];
 501
 502   hash_table = g_hash_table_new (my_hash, my_hash_equal);
 503   fill_hash_table_and_array (hash_table);
 504   pvalue = g_hash_table_find (hash_table, find_first, &value);
 505   if (!pvalue || *pvalue != value)
 506     g_assert_not_reached();
 507
 508   keys = g_hash_table_get_keys (hash_table);
 509   if (!keys)
 510     g_assert_not_reached ();
 511
 512   values = g_hash_table_get_values (hash_table);
 513   if (!values)
 514     g_assert_not_reached ();
 515
 516   keys_len = g_list_length (keys);
 517   values_len = g_list_length (values);
 518   if (values_len != keys_len &&  keys_len != g_hash_table_size (hash_table))
 519     g_assert_not_reached ();
 520
 521   g_list_free (keys);
 522   g_list_free (values);
 523
 524   init_result_array (result_array);
 525   g_hash_table_iter_init (&iter, hash_table);
 526   for (i = 0; i < 10000; i++)
 527     {
 528       g_assert (g_hash_table_iter_next (&iter, &ikey, &ivalue));
 529
 530       handle_pair (ikey, ivalue, result_array);
 531
 532       if (i % 2)
 533         g_hash_table_iter_remove (&iter);
 534     }
 535   g_assert (! g_hash_table_iter_next (&iter, &ikey, &ivalue));
 536   g_assert (g_hash_table_size (hash_table) == 5000);
 537   verify_result_array (result_array);
 538
 539   fill_hash_table_and_array (hash_table);
 540
 541   init_result_array (result_array);
 542   g_hash_table_foreach (hash_table, my_hash_callback, result_array);
 543   verify_result_array (result_array);
 544
 545   for (i = 0; i < 10000; i++)
 546     g_hash_table_remove (hash_table, &array[i]);
 547
 548   fill_hash_table_and_array (hash_table);
 549
 550   if (g_hash_table_foreach_remove (hash_table, my_hash_callback_remove, NULL) != 5000 ||
 551       g_hash_table_size (hash_table) != 5000)
 552     g_assert_not_reached();
 553
 554   g_hash_table_foreach (hash_table, my_hash_callback_remove_test, NULL);
 555   g_hash_table_destroy (hash_table);
 556 }
 557
 558 static gint destroy_counter;
 559
 560 static void
 561 value_destroy (gpointer value)
 562 {
 563   destroy_counter++;
 564 }
 565
 566 static void
 567 test_hash_ref (void)
 568 {
 569   GHashTable *h;
 570   GHashTableIter iter;
 571   gchar *key, *value;
 572   gboolean abc_seen = FALSE;
 573   gboolean cde_seen = FALSE;
 574   gboolean xyz_seen = FALSE;
 575
 576   h = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, value_destroy);
 577   g_hash_table_insert (h, "abc", "ABC");
 578   g_hash_table_insert (h, "cde", "CDE");
 579   g_hash_table_insert (h, "xyz", "XYZ");
 580
 581   g_assert_cmpint (g_hash_table_size (h), == , 3);
 582
 583   g_hash_table_iter_init (&iter, h);
 584
 585   while (g_hash_table_iter_next (&iter, (gpointer*)&key, (gpointer*)&value))
 586     {
 587       if (strcmp (key, "abc") == 0)
 588         {
 589           g_assert_cmpstr (value, ==, "ABC");
 590           abc_seen = TRUE;
 591           g_hash_table_iter_steal (&iter);
 592         }
 593       else if (strcmp (key, "cde") == 0)
 594         {
 595           g_assert_cmpstr (value, ==, "CDE");
 596           cde_seen = TRUE;
 597         }
 598       else if (strcmp (key, "xyz") == 0)
 599         {
 600           g_assert_cmpstr (value, ==, "XYZ");
 601           xyz_seen = TRUE;
 602         }
 603     }
 604   g_assert_cmpint (destroy_counter, ==, 0);
 605
 606   g_assert (g_hash_table_iter_get_hash_table (&iter) == h);
 607   g_assert (abc_seen && cde_seen && xyz_seen);
 608   g_assert_cmpint (g_hash_table_size (h), == , 2);
 609
 610   g_hash_table_ref (h);
 611   g_hash_table_destroy (h);
 612   g_assert_cmpint (g_hash_table_size (h), == , 0);
 613   g_assert_cmpint (destroy_counter, ==, 2);
 614   g_hash_table_insert (h, "uvw", "UVW");
 615   g_hash_table_unref (h);
 616   g_assert_cmpint (destroy_counter, ==, 3);
 617 }
 618
 619 static guint
 620 null_safe_str_hash (gconstpointer key)
 621 {
 622   if (key == NULL)
 623     return 0;
 624   else
 625     return g_str_hash (key);
 626 }
 627
 628 static gboolean
 629 null_safe_str_equal (gconstpointer a, gconstpointer b)
 630 {
 631   return g_strcmp0 (a, b) == 0;
 632 }
 633
 634 static void
 635 test_lookup_null_key (void)
 636 {
 637   GHashTable *h;
 638   gboolean res;
 639   gpointer key;
 640   gpointer value;
 641
 642   g_test_bug ("642944");
 643
 644   h = g_hash_table_new (null_safe_str_hash, null_safe_str_equal);
 645   g_hash_table_insert (h, "abc", "ABC");
 646
 647   res = g_hash_table_lookup_extended (h, NULL, &key, &value);
 648   g_assert (!res);
 649
 650   g_hash_table_insert (h, NULL, "NULL");
 651
 652   res = g_hash_table_lookup_extended (h, NULL, &key, &value);
 653   g_assert (res);
 654   g_assert_cmpstr (value, ==, "NULL");
 655
 656   g_hash_table_unref (h);
 657 }
 658
 659 static gint destroy_key_counter;
 660
 661 static void
 662 key_destroy (gpointer key)
 663 {
 664   destroy_key_counter++;
 665 }
 666
 667 static void
 668 test_remove_all (void)
 669 {
 670   GHashTable *h;
 671
 672   h = g_hash_table_new_full (g_str_hash, g_str_equal, key_destroy, value_destroy);
 673   g_hash_table_insert (h, "abc", "ABC");
 674   g_hash_table_insert (h, "cde", "CDE");
 675   g_hash_table_insert (h, "xyz", "XYZ");
 676
 677   destroy_counter = 0;
 678   destroy_key_counter = 0;
 679
 680   g_hash_table_steal_all (h);
 681   g_assert_cmpint (destroy_counter, ==, 0);
 682   g_assert_cmpint (destroy_key_counter, ==, 0);
 683
 684   g_hash_table_insert (h, "abc", "ABC");
 685   g_hash_table_insert (h, "cde", "CDE");
 686   g_hash_table_insert (h, "xyz", "XYZ");
 687
 688   g_hash_table_remove_all (h);
 689   g_assert_cmpint (destroy_counter, ==, 3);
 690   g_assert_cmpint (destroy_key_counter, ==, 3);
 691
 692   g_hash_table_unref (h);
 693 }
 694
 695 int
 696 main (int argc, char *argv[])
 697 {
 698   g_test_init (&argc, &argv, NULL);
 699
 700   g_test_bug_base ("http://bugzilla.gnome.org/");
 701
 702   g_test_add_func ("/hash/misc", test_hash_misc);
 703   g_test_add_data_func ("/hash/one", GINT_TO_POINTER (TRUE), second_hash_test);
 704   g_test_add_data_func ("/hash/honeyman", GINT_TO_POINTER (FALSE), second_hash_test);
 705   g_test_add_func ("/hash/direct", direct_hash_test);
 706   g_test_add_func ("/hash/int64", int64_hash_test);
 707   g_test_add_func ("/hash/double", double_hash_test);
 708   g_test_add_func ("/hash/string", string_hash_test);
 709   g_test_add_func ("/hash/ref", test_hash_ref);
 710   g_test_add_func ("/hash/remove-all", test_remove_all);
 711
 712   /* tests for individual bugs */
 713   g_test_add_func ("/hash/lookup-null-key", test_lookup_null_key);
 714
 715   return g_test_run ();
 716
 717 }