Migrate hashtest/hashtest2 to be unit tests.
[asterisk/asterisk.git] / tests / test_astobj2_thrash.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, David M. Lee, II
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*
20  *! \file \brief Thrash a astobj2 container, for fun and profit.
21  *
22  * \author\verbatim David M. Lee, II <dlee@digium.com> \endverbatim
23  *
24  * Inspired by the original hashtest2.c by Steve Murphy <murf@digium.com>.  This test runs
25  * several threads manipulatings a concurrent astobj2 container to see if they maintain
26  * consistency. While the tests attempt to check consistency and error normally, threading
27  * errors often result in segfaults.
28  * \ingroup tests
29  */
30
31 /*** MODULEINFO
32         <depend>TEST_FRAMEWORK</depend>
33         <support_level>core</support_level>
34  ***/
35
36 #include "asterisk.h"
37
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
39 #include <pthread.h>
40 #include "asterisk/astobj2.h"
41 #include "asterisk/hashtab.h"
42 #include "asterisk/lock.h"
43 #include "asterisk/module.h"
44 #include "asterisk/test.h"
45 #include "asterisk/time.h"
46 #include "asterisk/utils.h"
47
48 #define MAX_HASH_ENTRIES 15000
49 #define MAX_TEST_SECONDS 60
50
51 struct hash_test {
52         /*! Unit under test */
53         struct ao2_container *to_be_thrashed;
54         /*! Number of entries to insert in the grow thread. */
55         int max_grow;
56         /*! Number of enteries added by the grow thread. */
57         int grow_count;
58         /*! Entries preloaded into the hashtab; to be deleted by the shrink thread */
59         int preload;
60         /*! When to give up on the tests */
61         struct timeval deadline;
62 };
63
64 static int alloc_count = 0;
65
66 static int is_timed_out(struct hash_test const *data) {
67         return ast_tvdiff_us(data->deadline, ast_tvnow()) < 0;
68 }
69
70 /*! /brief Free test element */
71 static void ht_delete(void *obj)
72 {
73         ast_atomic_fetchadd_int(&alloc_count, -1);
74 }
75
76 /*! /brief Create test element */
77 static char *ht_new(int i)
78 {
79         const int buflen = 12;
80         char *keybuf = ao2_alloc(buflen, ht_delete);
81         int needed;
82         if (keybuf == NULL) {
83                 return NULL;
84         }
85         needed = snprintf(keybuf, buflen, "key%08x", i);
86         ast_atomic_fetchadd_int(&alloc_count, 1);
87         ast_assert(needed + 1 <= buflen);
88         return keybuf;
89 }
90
91 /*! /brief Grow the hash data as specified */
92 static void *hash_test_grow(void *d)
93 {
94         struct hash_test *data = d;
95         int i;
96
97         for (i = 0; i < data->max_grow; ++i) {
98                 char *ht;
99                 if (is_timed_out(data)) {
100                         printf("Growth timed out at %d\n", i);
101                         return "Growth timed out";
102                 }
103                 ht = ht_new(i);
104                 if (ht == NULL) {
105                         return "Allocation failed";
106                 }
107                 ao2_link(data->to_be_thrashed, ht);
108                 ao2_ref(ht, -1);
109                 ast_atomic_fetchadd_int(&data->grow_count, 1);
110         }
111         return NULL;
112 }
113
114 /*! Randomly lookup data in the hash */
115 static void *hash_test_lookup(void *d)
116 {
117         struct hash_test *data = d;
118         int max;
119         unsigned seed = time(NULL);
120
121         /* ast_atomic_fetchadd_int provide a memory fence so that the optimizer doesn't
122          * optimize away reads.
123          */
124         while ((max = ast_atomic_fetchadd_int(&data->grow_count, 0)) < data->max_grow) {
125                 int i;
126                 char *obj;
127                 char *from_ao2;
128
129                 if (is_timed_out(data)) {
130                         return "Lookup timed out";
131                 }
132
133                 if (max == 0) {
134                         /* No data yet; yield and try again */
135                         sched_yield();
136                         continue;
137                 }
138
139                 /* Randomly lookup one object from the hash */
140                 i = rand_r(&seed) % max;
141                 obj = ht_new(i);
142                 if (obj == NULL) {
143                         return "Allocation failed";
144                 }
145                 from_ao2 = ao2_find(data->to_be_thrashed, obj, OBJ_POINTER);
146                 ao2_ref(obj, -1);
147                 ao2_ref(from_ao2, -1);
148                 if (from_ao2 == NULL) {
149                         return "Key unexpectedly missing";
150                 }
151         }
152
153         return NULL;
154 }
155
156 /*! Delete entries from the hash */
157 static void *hash_test_shrink(void *d)
158 {
159         const struct hash_test *data = d;
160         int i;
161
162         for (i = 1; i < data->preload; ++i) {
163                 char *obj = ht_new(-i);
164                 char *from_ao2;
165
166                 if (obj == NULL) {
167                         return "Allocation failed";
168                 }
169                 from_ao2 = ao2_find(data->to_be_thrashed, obj, OBJ_UNLINK | OBJ_POINTER);
170
171                 ao2_ref(obj, -1);
172                 if (from_ao2) {
173                         ao2_ref(from_ao2, -1);
174                 } else {
175                         return "Could not find object to delete";
176                 }
177
178                 if (is_timed_out(data)) {
179                         return "Shrink timed out";
180                 }
181         }
182
183         return NULL;
184 }
185
186 /*! ao2_callback for hash_test_count */
187 static int increment_count(void *obj, void *arg, int flags) {
188         char *ht = obj;
189         int *count = arg;
190         if (strncmp(ht, "key0", 4) == 0) {
191                 ++(*count);
192         }
193         return 0;
194 }
195
196 /*! Continuously iterate through all the entries in the hash */
197 static void *hash_test_count(void *d)
198 {
199         const struct hash_test *data = d;
200         int count = 0;
201         int last_count = 0;
202
203         while (count < data->max_grow) {
204                 last_count = count;
205                 count = 0;
206                 ao2_callback(data->to_be_thrashed, OBJ_MULTIPLE, increment_count, &count);
207
208                 if (last_count == count) {
209                         /* Allow other threads to run. */
210                         sched_yield();
211                 } else if (last_count > count) {
212                         /* Make sure the ao2 container never shrinks */
213                         return "ao2 container unexpectedly shrank";
214                 }
215
216                 if (is_timed_out(data)) {
217                         return "Count timed out";
218                 }
219         }
220
221         /* Successfully iterated over all of the expected elements */
222         return NULL;
223 }
224
225 static int hash_string(const void *obj, const int flags)
226 {
227         return ast_hashtab_hash_string_nocase(obj);
228 }
229
230 static int compare_strings(void *lhs, void *rhs, int flags)
231 {
232         const char *lhs_str = lhs;
233         const char *rhs_str = rhs;
234         if (strcasecmp(lhs_str, rhs_str) == 0) {
235                 return CMP_MATCH | CMP_STOP;
236         } else {
237                 return 0;
238         }
239 }
240
241 AST_TEST_DEFINE(hash_test)
242 {
243         enum ast_test_result_state res = AST_TEST_PASS;
244         struct hash_test data = {};
245         pthread_t grow_thread, count_thread, lookup_thread, shrink_thread;
246         void *thread_results;
247         int i;
248
249         switch (cmd) {
250         case TEST_INIT:
251                 info->name = "thrash";
252                 info->category = "/main/astobj2/";
253                 info->summary = "Testing astobj2 container concurrency";
254                 info->description = "Test astobj2 container concurrency correctness.";
255                 return AST_TEST_NOT_RUN;
256         case TEST_EXECUTE:
257                 break;
258         }
259
260         ast_test_status_update(test, "Executing hash concurrency test...\n");
261         data.preload = MAX_HASH_ENTRIES / 2;
262         data.max_grow = MAX_HASH_ENTRIES - data.preload;
263         data.deadline = ast_tvadd(ast_tvnow(), ast_tv(MAX_TEST_SECONDS, 0));
264         data.to_be_thrashed = ao2_container_alloc(MAX_HASH_ENTRIES / 100, hash_string,
265                 compare_strings);
266
267         if (data.to_be_thrashed == NULL) {
268                 ast_test_status_update(test, "Allocation failed\n");
269                 /* Nothing needs to be freed; early return is fine */
270                 return AST_TEST_FAIL;
271         }
272
273         /* preload with data to delete */
274         for (i = 1; i < data.preload; ++i) {
275                 char *ht = ht_new(-i);
276                 if (ht == NULL) {
277                         ast_test_status_update(test, "Allocation failed\n");
278                         ao2_ref(data.to_be_thrashed, -1);
279                         return AST_TEST_FAIL;
280                 }
281                 ao2_link(data.to_be_thrashed, ht);
282                 ao2_ref(ht, -1);
283         }
284
285         /* add data.max_grow entries to the ao2 container */
286         ast_pthread_create(&grow_thread, NULL, hash_test_grow, &data);
287         /* continually count the keys added by the grow thread */
288         ast_pthread_create(&count_thread, NULL, hash_test_count, &data);
289         /* continually lookup keys added by the grow thread */
290         ast_pthread_create(&lookup_thread, NULL, hash_test_lookup, &data);
291         /* delete all keys preloaded into the ao2 container */
292         ast_pthread_create(&shrink_thread, NULL, hash_test_shrink, &data);
293
294         pthread_join(grow_thread, &thread_results);
295         if (thread_results != NULL) {
296                 ast_test_status_update(test, "Growth thread failed: %s\n",
297                         (char *)thread_results);
298                 res = AST_TEST_FAIL;
299         }
300
301         pthread_join(count_thread, &thread_results);
302         if (thread_results != NULL) {
303                 ast_test_status_update(test, "Count thread failed: %s\n",
304                         (char *)thread_results);
305                 res = AST_TEST_FAIL;
306         }
307
308         pthread_join(lookup_thread, &thread_results);
309         if (thread_results != NULL) {
310                 ast_test_status_update(test, "Lookup thread failed: %s\n",
311                         (char *)thread_results);
312                 res = AST_TEST_FAIL;
313         }
314
315         pthread_join(shrink_thread, &thread_results);
316         if (thread_results != NULL) {
317                 ast_test_status_update(test, "Shrink thread failed: %s\n",
318                         (char *)thread_results);
319                 res = AST_TEST_FAIL;
320         }
321
322         if (ao2_container_count(data.to_be_thrashed) != data.max_grow) {
323                 ast_test_status_update(test,
324                         "Invalid ao2 container size. Expected: %d, Actual: %d\n",
325                         data.max_grow, ao2_container_count(data.to_be_thrashed));
326                 res = AST_TEST_FAIL;
327         }
328
329         ao2_ref(data.to_be_thrashed, -1);
330
331         /* check for object leaks */
332         if (ast_atomic_fetchadd_int(&alloc_count, 0) != 0) {
333                 ast_test_status_update(test, "Leaked %d objects!\n",
334                         ast_atomic_fetchadd_int(&alloc_count, 0));
335                 res = AST_TEST_FAIL;
336         }
337
338         return res;
339 }
340
341 static int unload_module(void)
342 {
343         AST_TEST_UNREGISTER(hash_test);
344         return 0;
345 }
346
347 static int load_module(void)
348 {
349         AST_TEST_REGISTER(hash_test);
350         return AST_MODULE_LOAD_SUCCESS;
351 }
352
353 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "astobj2 container thrash test");