tests/benchmark/test_urcu_hash.h

   1 // SPDX-FileCopyrightText: 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   2 //
   3 // SPDX-License-Identifier: GPL-2.0-or-later
   4
   5 #ifndef _TEST_URCU_HASH_H
   6 #define _TEST_URCU_HASH_H
   7
   8 /*
   9  * Userspace RCU library - test program
  10  */
  11
  12 #include <stdio.h>
  13 #include <pthread.h>
  14 #include <stdlib.h>
  15 #include <string.h>
  16 #include <sys/types.h>
  17 #include <sys/wait.h>
  18 #include <unistd.h>
  19 #include <stdio.h>
  20 #include <errno.h>
  21 #include <signal.h>
  22
  23 #include <urcu/assert.h>
  24 #include <urcu/tls-compat.h>
  25 #include <compat-rand.h>
  26 #include "thread-id.h"
  27 #include "../common/debug-yield.h"
  28
  29 #define DEFAULT_HASH_SIZE       32
  30 #define DEFAULT_MIN_ALLOC_SIZE  1
  31 #define DEFAULT_RAND_POOL       1000000
  32
  33 /*
  34  * Note: the hash seed should be a random value for hash tables
  35  * targeting production environments to provide protection against
  36  * denial of service attacks. We keep it a static value within this test
  37  * program to compare identical benchmark runs.
  38  */
  39 #define TEST_HASH_SEED  0x42UL
  40
  41 /* hardcoded number of CPUs */
  42 #define NR_CPUS 16384
  43
  44 #ifdef POISON_FREE
  45 #define poison_free(ptr)                                \
  46         do {                                            \
  47                 memset(ptr, 0x42, sizeof(*(ptr)));      \
  48                 free(ptr);                              \
  49         } while (0)
  50 #else
  51 #define poison_free(ptr)        free(ptr)
  52 #endif
  53
  54 #ifndef DYNAMIC_LINK_TEST
  55 #define _LGPL_SOURCE
  56 #else
  57 #define debug_yield_read()
  58 #endif
  59 #include <urcu-qsbr.h>
  60 #include <urcu/rculfhash.h>
  61 #include <urcu-call-rcu.h>
  62
  63 struct wr_count {
  64         unsigned long update_ops;
  65         unsigned long add;
  66         unsigned long add_exist;
  67         unsigned long remove;
  68 };
  69
  70 extern DECLARE_URCU_TLS(unsigned int, rand_lookup);
  71 extern DECLARE_URCU_TLS(unsigned long, nr_add);
  72 extern DECLARE_URCU_TLS(unsigned long, nr_addexist);
  73 extern DECLARE_URCU_TLS(unsigned long, nr_del);
  74 extern DECLARE_URCU_TLS(unsigned long, nr_delnoent);
  75 extern DECLARE_URCU_TLS(unsigned long, lookup_fail);
  76 extern DECLARE_URCU_TLS(unsigned long, lookup_ok);
  77
  78 extern struct cds_lfht *test_ht;
  79
  80 struct test_data {
  81         int a;
  82         int b;
  83 };
  84
  85 struct lfht_test_node {
  86         struct cds_lfht_node node;
  87         void *key;
  88         unsigned int key_len;
  89         /* cache-cold for iteration */
  90         struct rcu_head head;
  91 };
  92
  93 static inline struct lfht_test_node *
  94 to_test_node(struct cds_lfht_node *node)
  95 {
  96         return caa_container_of(node, struct lfht_test_node, node);
  97 }
  98
  99 static inline
 100 void lfht_test_node_init(struct lfht_test_node *node, void *key,
 101                         size_t key_len)
 102 {
 103         cds_lfht_node_init(&node->node);
 104         node->key = key;
 105         node->key_len = key_len;
 106 }
 107
 108 static inline struct lfht_test_node *
 109 cds_lfht_iter_get_test_node(struct cds_lfht_iter *iter)
 110 {
 111         return to_test_node(cds_lfht_iter_get_node(iter));
 112 }
 113
 114 extern unsigned long wdelay;
 115
 116 extern unsigned long duration;
 117
 118 /* read-side C.S. duration, in loops */
 119 extern unsigned long rduration;
 120
 121 extern unsigned long init_hash_size;
 122 extern unsigned long min_hash_alloc_size;
 123 extern unsigned long max_hash_buckets_size;
 124 extern unsigned long init_populate;
 125 extern int opt_auto_resize;
 126 extern int add_only, add_unique, add_replace;
 127 extern const struct cds_lfht_mm_type *memory_backend;
 128
 129 extern unsigned long init_pool_offset, lookup_pool_offset, write_pool_offset;
 130 extern unsigned long init_pool_size,
 131         lookup_pool_size,
 132         write_pool_size;
 133 extern int validate_lookup;
 134
 135 extern unsigned long nr_hash_chains;
 136
 137 extern int count_pipe[2];
 138
 139 static inline void loop_sleep(unsigned long loops)
 140 {
 141         while (loops-- != 0)
 142                 caa_cpu_relax();
 143 }
 144
 145 extern int verbose_mode;
 146
 147 #define printf_verbose(fmt, args...)            \
 148         do {                                    \
 149                 if (verbose_mode)               \
 150                         printf(fmt, ## args);   \
 151         } while (0)
 152
 153 extern unsigned int cpu_affinities[NR_CPUS];
 154 extern unsigned int next_aff;
 155 extern int use_affinity;
 156
 157 extern pthread_mutex_t affinity_mutex;
 158
 159 void set_affinity(void);
 160
 161 extern DECLARE_URCU_TLS(unsigned long long, nr_writes);
 162 extern DECLARE_URCU_TLS(unsigned long long, nr_reads);
 163
 164 extern unsigned int nr_readers;
 165 extern unsigned int nr_writers;
 166
 167 void rcu_copy_mutex_lock(void);
 168 void rcu_copy_mutex_unlock(void);
 169
 170 /*
 171  * Hash function
 172  * Source: http://burtleburtle.net/bob/c/lookup3.c
 173  * Originally Public Domain
 174  */
 175
 176 #define rot(x, k) (((x) << (k)) | ((x) >> (32 - (k))))
 177
 178 #define mix(a, b, c) \
 179 do { \
 180         a -= c; a ^= rot(c,  4); c += b; \
 181         b -= a; b ^= rot(a,  6); a += c; \
 182         c -= b; c ^= rot(b,  8); b += a; \
 183         a -= c; a ^= rot(c, 16); c += b; \
 184         b -= a; b ^= rot(a, 19); a += c; \
 185         c -= b; c ^= rot(b,  4); b += a; \
 186 } while (0)
 187
 188 #define final(a, b, c) \
 189 { \
 190         c ^= b; c -= rot(b, 14); \
 191         a ^= c; a -= rot(c, 11); \
 192         b ^= a; b -= rot(a, 25); \
 193         c ^= b; c -= rot(b, 16); \
 194         a ^= c; a -= rot(c,  4);\
 195         b ^= a; b -= rot(a, 14); \
 196         c ^= b; c -= rot(b, 24); \
 197 }
 198
 199 static inline __attribute__((unused))
 200 uint32_t hash_u32(
 201         const uint32_t *k,      /* the key, an array of uint32_t values */
 202         size_t length,          /* the length of the key, in uint32_ts */
 203         uint32_t initval)       /* the previous hash, or an arbitrary value */
 204 {
 205         uint32_t a, b, c;
 206
 207         /* Set up the internal state */
 208         a = b = c = 0xdeadbeef + (((uint32_t) length) << 2) + initval;
 209
 210         /*----------------------------------------- handle most of the key */
 211         while (length > 3) {
 212                 a += k[0];
 213                 b += k[1];
 214                 c += k[2];
 215                 mix(a, b, c);
 216                 length -= 3;
 217                 k += 3;
 218         }
 219
 220         /*----------------------------------- handle the last 3 uint32_t's */
 221         switch (length) {       /* all the case statements fall through */
 222         case 3: c += k[2]; /* fall through */
 223         case 2: b += k[1]; /* fall through */
 224         case 1: a += k[0];
 225                 final(a, b, c);
 226                 /* fall through */
 227         case 0:                 /* case 0: nothing left to add */
 228                 break;
 229         }
 230         /*---------------------------------------------- report the result */
 231         return c;
 232 }
 233
 234 static inline
 235 void hashword2(
 236         const uint32_t *k,      /* the key, an array of uint32_t values */
 237         size_t length,          /* the length of the key, in uint32_ts */
 238         uint32_t *pc,           /* IN: seed OUT: primary hash value */
 239         uint32_t *pb)           /* IN: more seed OUT: secondary hash value */
 240 {
 241         uint32_t a, b, c;
 242
 243         /* Set up the internal state */
 244         a = b = c = 0xdeadbeef + ((uint32_t) (length << 2)) + *pc;
 245         c += *pb;
 246
 247         /*----------------------------------------- handle most of the key */
 248         while (length > 3) {
 249                 a += k[0];
 250                 b += k[1];
 251                 c += k[2];
 252                 mix(a, b, c);
 253                 length -= 3;
 254                 k += 3;
 255         }
 256
 257         /*----------------------------------- handle the last 3 uint32_t's */
 258         switch (length) {       /* all the case statements fall through */
 259         case 3: c += k[2]; /* fall through */
 260         case 2: b += k[1]; /* fall through */
 261         case 1: a += k[0];
 262                 final(a, b, c);
 263                 /* fall through */
 264         case 0:                 /* case 0: nothing left to add */
 265                 break;
 266         }
 267         /*---------------------------------------------- report the result */
 268         *pc = c;
 269         *pb = b;
 270 }
 271
 272 #if (CAA_BITS_PER_LONG == 32)
 273 static inline
 274 unsigned long test_hash_mix(const void *_key, size_t length, unsigned long seed)
 275 {
 276         unsigned int key = (unsigned int) _key;
 277
 278         urcu_posix_assert(length == sizeof(unsigned int));
 279         return hash_u32(&key, 1, seed);
 280 }
 281 #else
 282 static inline
 283 unsigned long test_hash_mix(const void *_key, size_t length, unsigned long seed)
 284 {
 285         union {
 286                 uint64_t v64;
 287                 uint32_t v32[2];
 288         } v;
 289         union {
 290                 uint64_t v64;
 291                 uint32_t v32[2];
 292         } key;
 293
 294         urcu_posix_assert(length == sizeof(unsigned long));
 295         v.v64 = (uint64_t) seed;
 296         key.v64 = (uint64_t) _key;
 297         hashword2(key.v32, 2, &v.v32[0], &v.v32[1]);
 298         return v.v64;
 299 }
 300 #endif
 301
 302 /*
 303  * Hash function with nr_hash_chains != 0 for testing purpose only!
 304  * Creates very long hash chains, deteriorating the hash table into a
 305  * few linked lists, depending on the nr_hash_chains value. The purpose
 306  * of this test is to check how the hash table behaves with hash chains
 307  * containing different values, which is a rare case in a normal hash
 308  * table.
 309  */
 310 static inline
 311 unsigned long test_hash(const void *_key, size_t length,
 312                         unsigned long seed)
 313 {
 314         if (nr_hash_chains == 0) {
 315                 return test_hash_mix(_key, length, seed);
 316         } else {
 317                 unsigned long v;
 318
 319                 urcu_posix_assert(length == sizeof(unsigned long));
 320                 v = (unsigned long) _key;
 321                 return v % nr_hash_chains;
 322         }
 323 }
 324
 325 unsigned long test_compare(const void *key1, size_t key1_len,
 326                            const void *key2, size_t key2_len);
 327
 328 static inline
 329 int test_match(struct cds_lfht_node *node, const void *key)
 330 {
 331         struct lfht_test_node *test_node = to_test_node(node);
 332
 333         return !test_compare(test_node->key, test_node->key_len,
 334                         key, sizeof(unsigned long));
 335 }
 336
 337 static inline
 338 void cds_lfht_test_lookup(struct cds_lfht *ht, void *key, size_t key_len,
 339                 struct cds_lfht_iter *iter)
 340 {
 341         urcu_posix_assert(key_len == sizeof(unsigned long));
 342
 343         cds_lfht_lookup(ht, test_hash(key, key_len, TEST_HASH_SEED),
 344                         test_match, key, iter);
 345 }
 346
 347 void free_node_cb(struct rcu_head *head);
 348
 349 /* rw test */
 350 void test_hash_rw_sigusr1_handler(int signo);
 351 void test_hash_rw_sigusr2_handler(int signo);
 352 void *test_hash_rw_thr_reader(void *_count);
 353 void *test_hash_rw_thr_writer(void *_count);
 354 int test_hash_rw_populate_hash(void);
 355
 356 /* unique test */
 357 void test_hash_unique_sigusr1_handler(int signo);
 358 void test_hash_unique_sigusr2_handler(int signo);
 359 void *test_hash_unique_thr_reader(void *_count);
 360 void *test_hash_unique_thr_writer(void *_count);
 361 int test_hash_unique_populate_hash(void);
 362
 363 #endif /* _TEST_URCU_HASH_H */