1 /* 2 * idr-test.c: Test the IDR API 3 * Copyright (c) 2016 Matthew Wilcox <willy@infradead.org> 4 * 5 * This program is free software; you can redistribute it and/or modify it 6 * under the terms and conditions of the GNU General Public License, 7 * version 2, as published by the Free Software Foundation. 8 * 9 * This program is distributed in the hope it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 12 * more details. 13 */ 14 #include <linux/bitmap.h> 15 #include <linux/idr.h> 16 #include <linux/slab.h> 17 #include <linux/kernel.h> 18 #include <linux/errno.h> 19 20 #include "test.h" 21 22 #define DUMMY_PTR ((void *)0x12) 23 24 int item_idr_free(int id, void *p, void *data) 25 { 26 struct item *item = p; 27 assert(item->index == id); 28 free(p); 29 30 return 0; 31 } 32 33 void item_idr_remove(struct idr *idr, int id) 34 { 35 struct item *item = idr_find(idr, id); 36 assert(item->index == id); 37 idr_remove(idr, id); 38 free(item); 39 } 40 41 void idr_alloc_test(void) 42 { 43 unsigned long i; 44 DEFINE_IDR(idr); 45 46 assert(idr_alloc_cyclic(&idr, DUMMY_PTR, 0, 0x4000, GFP_KERNEL) == 0); 47 assert(idr_alloc_cyclic(&idr, DUMMY_PTR, 0x3ffd, 0x4000, GFP_KERNEL) == 0x3ffd); 48 idr_remove(&idr, 0x3ffd); 49 idr_remove(&idr, 0); 50 51 for (i = 0x3ffe; i < 0x4003; i++) { 52 int id; 53 struct item *item; 54 55 if (i < 0x4000) 56 item = item_create(i, 0); 57 else 58 item = item_create(i - 0x3fff, 0); 59 60 id = idr_alloc_cyclic(&idr, item, 1, 0x4000, GFP_KERNEL); 61 assert(id == item->index); 62 } 63 64 idr_for_each(&idr, item_idr_free, &idr); 65 idr_destroy(&idr); 66 } 67 68 void idr_replace_test(void) 69 { 70 DEFINE_IDR(idr); 71 72 idr_alloc(&idr, (void *)-1, 10, 11, GFP_KERNEL); 73 idr_replace(&idr, &idr, 10); 74 75 idr_destroy(&idr); 76 } 77 78 /* 79 * Unlike the radix tree, you can put a NULL pointer -- with care -- into 80 * the IDR. Some interfaces, like idr_find() do not distinguish between 81 * "present, value is NULL" and "not present", but that's exactly what some 82 * users want. 83 */ 84 void idr_null_test(void) 85 { 86 int i; 87 DEFINE_IDR(idr); 88 89 assert(idr_is_empty(&idr)); 90 91 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0); 92 assert(!idr_is_empty(&idr)); 93 idr_remove(&idr, 0); 94 assert(idr_is_empty(&idr)); 95 96 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0); 97 assert(!idr_is_empty(&idr)); 98 idr_destroy(&idr); 99 assert(idr_is_empty(&idr)); 100 101 for (i = 0; i < 10; i++) { 102 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == i); 103 } 104 105 assert(idr_replace(&idr, DUMMY_PTR, 3) == NULL); 106 assert(idr_replace(&idr, DUMMY_PTR, 4) == NULL); 107 assert(idr_replace(&idr, NULL, 4) == DUMMY_PTR); 108 assert(idr_replace(&idr, DUMMY_PTR, 11) == ERR_PTR(-ENOENT)); 109 idr_remove(&idr, 5); 110 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 5); 111 idr_remove(&idr, 5); 112 113 for (i = 0; i < 9; i++) { 114 idr_remove(&idr, i); 115 assert(!idr_is_empty(&idr)); 116 } 117 idr_remove(&idr, 8); 118 assert(!idr_is_empty(&idr)); 119 idr_remove(&idr, 9); 120 assert(idr_is_empty(&idr)); 121 122 assert(idr_alloc(&idr, NULL, 0, 0, GFP_KERNEL) == 0); 123 assert(idr_replace(&idr, DUMMY_PTR, 3) == ERR_PTR(-ENOENT)); 124 assert(idr_replace(&idr, DUMMY_PTR, 0) == NULL); 125 assert(idr_replace(&idr, NULL, 0) == DUMMY_PTR); 126 127 idr_destroy(&idr); 128 assert(idr_is_empty(&idr)); 129 130 for (i = 1; i < 10; i++) { 131 assert(idr_alloc(&idr, NULL, 1, 0, GFP_KERNEL) == i); 132 } 133 134 idr_destroy(&idr); 135 assert(idr_is_empty(&idr)); 136 } 137 138 void idr_nowait_test(void) 139 { 140 unsigned int i; 141 DEFINE_IDR(idr); 142 143 idr_preload(GFP_KERNEL); 144 145 for (i = 0; i < 3; i++) { 146 struct item *item = item_create(i, 0); 147 assert(idr_alloc(&idr, item, i, i + 1, GFP_NOWAIT) == i); 148 } 149 150 idr_preload_end(); 151 152 idr_for_each(&idr, item_idr_free, &idr); 153 idr_destroy(&idr); 154 } 155 156 void idr_get_next_test(int base) 157 { 158 unsigned long i; 159 int nextid; 160 DEFINE_IDR(idr); 161 idr_init_base(&idr, base); 162 163 int indices[] = {4, 7, 9, 15, 65, 128, 1000, 99999, 0}; 164 165 for(i = 0; indices[i]; i++) { 166 struct item *item = item_create(indices[i], 0); 167 assert(idr_alloc(&idr, item, indices[i], indices[i+1], 168 GFP_KERNEL) == indices[i]); 169 } 170 171 for(i = 0, nextid = 0; indices[i]; i++) { 172 idr_get_next(&idr, &nextid); 173 assert(nextid == indices[i]); 174 nextid++; 175 } 176 177 idr_for_each(&idr, item_idr_free, &idr); 178 idr_destroy(&idr); 179 } 180 181 int idr_u32_cb(int id, void *ptr, void *data) 182 { 183 BUG_ON(id < 0); 184 BUG_ON(ptr != DUMMY_PTR); 185 return 0; 186 } 187 188 void idr_u32_test1(struct idr *idr, u32 handle) 189 { 190 static bool warned = false; 191 u32 id = handle; 192 int sid = 0; 193 void *ptr; 194 195 BUG_ON(idr_alloc_u32(idr, DUMMY_PTR, &id, id, GFP_KERNEL)); 196 BUG_ON(id != handle); 197 BUG_ON(idr_alloc_u32(idr, DUMMY_PTR, &id, id, GFP_KERNEL) != -ENOSPC); 198 BUG_ON(id != handle); 199 if (!warned && id > INT_MAX) 200 printk("vvv Ignore these warnings\n"); 201 ptr = idr_get_next(idr, &sid); 202 if (id > INT_MAX) { 203 BUG_ON(ptr != NULL); 204 BUG_ON(sid != 0); 205 } else { 206 BUG_ON(ptr != DUMMY_PTR); 207 BUG_ON(sid != id); 208 } 209 idr_for_each(idr, idr_u32_cb, NULL); 210 if (!warned && id > INT_MAX) { 211 printk("^^^ Warnings over\n"); 212 warned = true; 213 } 214 BUG_ON(idr_remove(idr, id) != DUMMY_PTR); 215 BUG_ON(!idr_is_empty(idr)); 216 } 217 218 void idr_u32_test(int base) 219 { 220 DEFINE_IDR(idr); 221 idr_init_base(&idr, base); 222 idr_u32_test1(&idr, 10); 223 idr_u32_test1(&idr, 0x7fffffff); 224 idr_u32_test1(&idr, 0x80000000); 225 idr_u32_test1(&idr, 0x80000001); 226 idr_u32_test1(&idr, 0xffe00000); 227 idr_u32_test1(&idr, 0xffffffff); 228 } 229 230 void idr_checks(void) 231 { 232 unsigned long i; 233 DEFINE_IDR(idr); 234 235 for (i = 0; i < 10000; i++) { 236 struct item *item = item_create(i, 0); 237 assert(idr_alloc(&idr, item, 0, 20000, GFP_KERNEL) == i); 238 } 239 240 assert(idr_alloc(&idr, DUMMY_PTR, 5, 30, GFP_KERNEL) < 0); 241 242 for (i = 0; i < 5000; i++) 243 item_idr_remove(&idr, i); 244 245 idr_remove(&idr, 3); 246 247 idr_for_each(&idr, item_idr_free, &idr); 248 idr_destroy(&idr); 249 250 assert(idr_is_empty(&idr)); 251 252 idr_remove(&idr, 3); 253 idr_remove(&idr, 0); 254 255 assert(idr_alloc(&idr, DUMMY_PTR, 0, 0, GFP_KERNEL) == 0); 256 idr_remove(&idr, 1); 257 for (i = 1; i < RADIX_TREE_MAP_SIZE; i++) 258 assert(idr_alloc(&idr, DUMMY_PTR, 0, 0, GFP_KERNEL) == i); 259 idr_remove(&idr, 1 << 30); 260 idr_destroy(&idr); 261 262 for (i = INT_MAX - 3UL; i < INT_MAX + 1UL; i++) { 263 struct item *item = item_create(i, 0); 264 assert(idr_alloc(&idr, item, i, i + 10, GFP_KERNEL) == i); 265 } 266 assert(idr_alloc(&idr, DUMMY_PTR, i - 2, i, GFP_KERNEL) == -ENOSPC); 267 assert(idr_alloc(&idr, DUMMY_PTR, i - 2, i + 10, GFP_KERNEL) == -ENOSPC); 268 269 idr_for_each(&idr, item_idr_free, &idr); 270 idr_destroy(&idr); 271 idr_destroy(&idr); 272 273 assert(idr_is_empty(&idr)); 274 275 idr_set_cursor(&idr, INT_MAX - 3UL); 276 for (i = INT_MAX - 3UL; i < INT_MAX + 3UL; i++) { 277 struct item *item; 278 unsigned int id; 279 if (i <= INT_MAX) 280 item = item_create(i, 0); 281 else 282 item = item_create(i - INT_MAX - 1, 0); 283 284 id = idr_alloc_cyclic(&idr, item, 0, 0, GFP_KERNEL); 285 assert(id == item->index); 286 } 287 288 idr_for_each(&idr, item_idr_free, &idr); 289 idr_destroy(&idr); 290 assert(idr_is_empty(&idr)); 291 292 for (i = 1; i < 10000; i++) { 293 struct item *item = item_create(i, 0); 294 assert(idr_alloc(&idr, item, 1, 20000, GFP_KERNEL) == i); 295 } 296 297 idr_for_each(&idr, item_idr_free, &idr); 298 idr_destroy(&idr); 299 300 idr_replace_test(); 301 idr_alloc_test(); 302 idr_null_test(); 303 idr_nowait_test(); 304 idr_get_next_test(0); 305 idr_get_next_test(1); 306 idr_get_next_test(4); 307 idr_u32_test(4); 308 idr_u32_test(1); 309 idr_u32_test(0); 310 } 311 312 /* 313 * Check that we get the correct error when we run out of memory doing 314 * allocations. To ensure we run out of memory, just "forget" to preload. 315 * The first test is for not having a bitmap available, and the second test 316 * is for not being able to allocate a level of the radix tree. 317 */ 318 void ida_check_nomem(void) 319 { 320 DEFINE_IDA(ida); 321 int id, err; 322 323 err = ida_get_new_above(&ida, 256, &id); 324 assert(err == -EAGAIN); 325 err = ida_get_new_above(&ida, 1UL << 30, &id); 326 assert(err == -EAGAIN); 327 } 328 329 /* 330 * Check what happens when we fill a leaf and then delete it. This may 331 * discover mishandling of IDR_FREE. 332 */ 333 void ida_check_leaf(void) 334 { 335 DEFINE_IDA(ida); 336 int id; 337 unsigned long i; 338 339 for (i = 0; i < IDA_BITMAP_BITS; i++) { 340 assert(ida_pre_get(&ida, GFP_KERNEL)); 341 assert(!ida_get_new(&ida, &id)); 342 assert(id == i); 343 } 344 345 ida_destroy(&ida); 346 assert(ida_is_empty(&ida)); 347 348 assert(ida_pre_get(&ida, GFP_KERNEL)); 349 assert(!ida_get_new(&ida, &id)); 350 assert(id == 0); 351 ida_destroy(&ida); 352 assert(ida_is_empty(&ida)); 353 } 354 355 /* 356 * Check handling of conversions between exceptional entries and full bitmaps. 357 */ 358 void ida_check_conv(void) 359 { 360 DEFINE_IDA(ida); 361 int id; 362 unsigned long i; 363 364 for (i = 0; i < IDA_BITMAP_BITS * 2; i += IDA_BITMAP_BITS) { 365 assert(ida_pre_get(&ida, GFP_KERNEL)); 366 assert(!ida_get_new_above(&ida, i + 1, &id)); 367 assert(id == i + 1); 368 assert(!ida_get_new_above(&ida, i + BITS_PER_LONG, &id)); 369 assert(id == i + BITS_PER_LONG); 370 ida_remove(&ida, i + 1); 371 ida_remove(&ida, i + BITS_PER_LONG); 372 assert(ida_is_empty(&ida)); 373 } 374 375 assert(ida_pre_get(&ida, GFP_KERNEL)); 376 377 for (i = 0; i < IDA_BITMAP_BITS * 2; i++) { 378 assert(ida_pre_get(&ida, GFP_KERNEL)); 379 assert(!ida_get_new(&ida, &id)); 380 assert(id == i); 381 } 382 383 for (i = IDA_BITMAP_BITS * 2; i > 0; i--) { 384 ida_remove(&ida, i - 1); 385 } 386 assert(ida_is_empty(&ida)); 387 388 for (i = 0; i < IDA_BITMAP_BITS + BITS_PER_LONG - 4; i++) { 389 assert(ida_pre_get(&ida, GFP_KERNEL)); 390 assert(!ida_get_new(&ida, &id)); 391 assert(id == i); 392 } 393 394 for (i = IDA_BITMAP_BITS + BITS_PER_LONG - 4; i > 0; i--) { 395 ida_remove(&ida, i - 1); 396 } 397 assert(ida_is_empty(&ida)); 398 399 radix_tree_cpu_dead(1); 400 for (i = 0; i < 1000000; i++) { 401 int err = ida_get_new(&ida, &id); 402 if (err == -EAGAIN) { 403 assert((i % IDA_BITMAP_BITS) == (BITS_PER_LONG - 2)); 404 assert(ida_pre_get(&ida, GFP_KERNEL)); 405 err = ida_get_new(&ida, &id); 406 } else { 407 assert((i % IDA_BITMAP_BITS) != (BITS_PER_LONG - 2)); 408 } 409 assert(!err); 410 assert(id == i); 411 } 412 ida_destroy(&ida); 413 } 414 415 /* 416 * Check allocations up to and slightly above the maximum allowed (2^31-1) ID. 417 * Allocating up to 2^31-1 should succeed, and then allocating the next one 418 * should fail. 419 */ 420 void ida_check_max(void) 421 { 422 DEFINE_IDA(ida); 423 int id, err; 424 unsigned long i, j; 425 426 for (j = 1; j < 65537; j *= 2) { 427 unsigned long base = (1UL << 31) - j; 428 for (i = 0; i < j; i++) { 429 assert(ida_pre_get(&ida, GFP_KERNEL)); 430 assert(!ida_get_new_above(&ida, base, &id)); 431 assert(id == base + i); 432 } 433 assert(ida_pre_get(&ida, GFP_KERNEL)); 434 err = ida_get_new_above(&ida, base, &id); 435 assert(err == -ENOSPC); 436 ida_destroy(&ida); 437 assert(ida_is_empty(&ida)); 438 rcu_barrier(); 439 } 440 } 441 442 void ida_check_random(void) 443 { 444 DEFINE_IDA(ida); 445 DECLARE_BITMAP(bitmap, 2048); 446 int id, err; 447 unsigned int i; 448 time_t s = time(NULL); 449 450 repeat: 451 memset(bitmap, 0, sizeof(bitmap)); 452 for (i = 0; i < 100000; i++) { 453 int i = rand(); 454 int bit = i & 2047; 455 if (test_bit(bit, bitmap)) { 456 __clear_bit(bit, bitmap); 457 ida_remove(&ida, bit); 458 } else { 459 __set_bit(bit, bitmap); 460 do { 461 ida_pre_get(&ida, GFP_KERNEL); 462 err = ida_get_new_above(&ida, bit, &id); 463 } while (err == -EAGAIN); 464 assert(!err); 465 assert(id == bit); 466 } 467 } 468 ida_destroy(&ida); 469 if (time(NULL) < s + 10) 470 goto repeat; 471 } 472 473 void ida_simple_get_remove_test(void) 474 { 475 DEFINE_IDA(ida); 476 unsigned long i; 477 478 for (i = 0; i < 10000; i++) { 479 assert(ida_simple_get(&ida, 0, 20000, GFP_KERNEL) == i); 480 } 481 assert(ida_simple_get(&ida, 5, 30, GFP_KERNEL) < 0); 482 483 for (i = 0; i < 10000; i++) { 484 ida_simple_remove(&ida, i); 485 } 486 assert(ida_is_empty(&ida)); 487 488 ida_destroy(&ida); 489 } 490 491 void ida_checks(void) 492 { 493 DEFINE_IDA(ida); 494 int id; 495 unsigned long i; 496 497 radix_tree_cpu_dead(1); 498 ida_check_nomem(); 499 500 for (i = 0; i < 10000; i++) { 501 assert(ida_pre_get(&ida, GFP_KERNEL)); 502 assert(!ida_get_new(&ida, &id)); 503 assert(id == i); 504 } 505 506 ida_remove(&ida, 20); 507 ida_remove(&ida, 21); 508 for (i = 0; i < 3; i++) { 509 assert(ida_pre_get(&ida, GFP_KERNEL)); 510 assert(!ida_get_new(&ida, &id)); 511 if (i == 2) 512 assert(id == 10000); 513 } 514 515 for (i = 0; i < 5000; i++) 516 ida_remove(&ida, i); 517 518 assert(ida_pre_get(&ida, GFP_KERNEL)); 519 assert(!ida_get_new_above(&ida, 5000, &id)); 520 assert(id == 10001); 521 522 ida_destroy(&ida); 523 524 assert(ida_is_empty(&ida)); 525 526 assert(ida_pre_get(&ida, GFP_KERNEL)); 527 assert(!ida_get_new_above(&ida, 1, &id)); 528 assert(id == 1); 529 530 ida_remove(&ida, id); 531 assert(ida_is_empty(&ida)); 532 ida_destroy(&ida); 533 assert(ida_is_empty(&ida)); 534 535 assert(ida_pre_get(&ida, GFP_KERNEL)); 536 assert(!ida_get_new_above(&ida, 1, &id)); 537 ida_destroy(&ida); 538 assert(ida_is_empty(&ida)); 539 540 assert(ida_pre_get(&ida, GFP_KERNEL)); 541 assert(!ida_get_new_above(&ida, 1, &id)); 542 assert(id == 1); 543 assert(ida_pre_get(&ida, GFP_KERNEL)); 544 assert(!ida_get_new_above(&ida, 1025, &id)); 545 assert(id == 1025); 546 assert(ida_pre_get(&ida, GFP_KERNEL)); 547 assert(!ida_get_new_above(&ida, 10000, &id)); 548 assert(id == 10000); 549 ida_remove(&ida, 1025); 550 ida_destroy(&ida); 551 assert(ida_is_empty(&ida)); 552 553 ida_check_leaf(); 554 ida_check_max(); 555 ida_check_conv(); 556 ida_check_random(); 557 ida_simple_get_remove_test(); 558 559 radix_tree_cpu_dead(1); 560 } 561 562 static void *ida_random_fn(void *arg) 563 { 564 rcu_register_thread(); 565 ida_check_random(); 566 rcu_unregister_thread(); 567 return NULL; 568 } 569 570 void ida_thread_tests(void) 571 { 572 pthread_t threads[20]; 573 int i; 574 575 for (i = 0; i < ARRAY_SIZE(threads); i++) 576 if (pthread_create(&threads[i], NULL, ida_random_fn, NULL)) { 577 perror("creating ida thread"); 578 exit(1); 579 } 580 581 while (i--) 582 pthread_join(threads[i], NULL); 583 } 584 585 int __weak main(void) 586 { 587 radix_tree_init(); 588 idr_checks(); 589 ida_checks(); 590 ida_thread_tests(); 591 radix_tree_cpu_dead(1); 592 rcu_barrier(); 593 if (nr_allocated) 594 printf("nr_allocated = %d\n", nr_allocated); 595 return 0; 596 } 597