lib/librte_eal/common/eal_common_fbarray.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017-2018 Intel Corporation
   3  */
   4
   5 #include <inttypes.h>
   6 #include <limits.h>
   7 #include <sys/mman.h>
   8 #include <stdint.h>
   9 #include <errno.h>
  10 #include <sys/file.h>
  11 #include <string.h>
  12
  13 #include <rte_common.h>
  14 #include <rte_log.h>
  15 #include <rte_errno.h>
  16 #include <rte_spinlock.h>
  17 #include <rte_tailq.h>
  18
  19 #include "eal_filesystem.h"
  20 #include "eal_private.h"
  21
  22 #include "rte_fbarray.h"
  23
  24 #define MASK_SHIFT 6ULL
  25 #define MASK_ALIGN (1ULL << MASK_SHIFT)
  26 #define MASK_LEN_TO_IDX(x) ((x) >> MASK_SHIFT)
  27 #define MASK_LEN_TO_MOD(x) ((x) - RTE_ALIGN_FLOOR(x, MASK_ALIGN))
  28 #define MASK_GET_IDX(idx, mod) ((idx << MASK_SHIFT) + mod)
  29
  30 /*
  31  * This is a mask that is always stored at the end of array, to provide fast
  32  * way of finding free/used spots without looping through each element.
  33  */
  34
  35 struct used_mask {
  36         unsigned int n_masks;
  37         uint64_t data[];
  38 };
  39
  40 static size_t
  41 calc_mask_size(unsigned int len)
  42 {
  43         /* mask must be multiple of MASK_ALIGN, even though length of array
  44          * itself may not be aligned on that boundary.
  45          */
  46         len = RTE_ALIGN_CEIL(len, MASK_ALIGN);
  47         return sizeof(struct used_mask) +
  48                         sizeof(uint64_t) * MASK_LEN_TO_IDX(len);
  49 }
  50
  51 static size_t
  52 calc_data_size(size_t page_sz, unsigned int elt_sz, unsigned int len)
  53 {
  54         size_t data_sz = elt_sz * len;
  55         size_t msk_sz = calc_mask_size(len);
  56         return RTE_ALIGN_CEIL(data_sz + msk_sz, page_sz);
  57 }
  58
  59 static struct used_mask *
  60 get_used_mask(void *data, unsigned int elt_sz, unsigned int len)
  61 {
  62         return (struct used_mask *) RTE_PTR_ADD(data, elt_sz * len);
  63 }
  64
  65 static int
  66 resize_and_map(int fd, void *addr, size_t len)
  67 {
  68         char path[PATH_MAX];
  69         void *map_addr;
  70
  71         if (ftruncate(fd, len)) {
  72                 RTE_LOG(ERR, EAL, "Cannot truncate %s\n", path);
  73                 /* pass errno up the chain */
  74                 rte_errno = errno;
  75                 return -1;
  76         }
  77
  78         map_addr = mmap(addr, len, PROT_READ | PROT_WRITE,
  79                         MAP_SHARED | MAP_FIXED, fd, 0);
  80         if (map_addr != addr) {
  81                 RTE_LOG(ERR, EAL, "mmap() failed: %s\n", strerror(errno));
  82                 /* pass errno up the chain */
  83                 rte_errno = errno;
  84                 return -1;
  85         }
  86         return 0;
  87 }
  88
  89 static int
  90 find_next_n(const struct rte_fbarray *arr, unsigned int start, unsigned int n,
  91             bool used)
  92 {
  93         const struct used_mask *msk = get_used_mask(arr->data, arr->elt_sz,
  94                         arr->len);
  95         unsigned int msk_idx, lookahead_idx, first, first_mod;
  96         unsigned int last, last_mod;
  97         uint64_t last_msk, ignore_msk;
  98
  99         /*
 100          * mask only has granularity of MASK_ALIGN, but start may not be aligned
 101          * on that boundary, so construct a special mask to exclude anything we
 102          * don't want to see to avoid confusing ctz.
 103          */
 104         first = MASK_LEN_TO_IDX(start);
 105         first_mod = MASK_LEN_TO_MOD(start);
 106         ignore_msk = ~((1ULL << first_mod) - 1);
 107
 108         /* array length may not be aligned, so calculate ignore mask for last
 109          * mask index.
 110          */
 111         last = MASK_LEN_TO_IDX(arr->len);
 112         last_mod = MASK_LEN_TO_MOD(arr->len);
 113         last_msk = ~(-1ULL << last_mod);
 114
 115         for (msk_idx = first; msk_idx < msk->n_masks; msk_idx++) {
 116                 uint64_t cur_msk, lookahead_msk;
 117                 unsigned int run_start, clz, left;
 118                 bool found = false;
 119                 /*
 120                  * The process of getting n consecutive bits for arbitrary n is
 121                  * a bit involved, but here it is in a nutshell:
 122                  *
 123                  *  1. let n be the number of consecutive bits we're looking for
 124                  *  2. check if n can fit in one mask, and if so, do n-1
 125                  *     rshift-ands to see if there is an appropriate run inside
 126                  *     our current mask
 127                  *    2a. if we found a run, bail out early
 128                  *    2b. if we didn't find a run, proceed
 129                  *  3. invert the mask and count leading zeroes (that is, count
 130                  *     how many consecutive set bits we had starting from the
 131                  *     end of current mask) as k
 132                  *    3a. if k is 0, continue to next mask
 133                  *    3b. if k is not 0, we have a potential run
 134                  *  4. to satisfy our requirements, next mask must have n-k
 135                  *     consecutive set bits right at the start, so we will do
 136                  *     (n-k-1) rshift-ands and check if first bit is set.
 137                  *
 138                  * Step 4 will need to be repeated if (n-k) > MASK_ALIGN until
 139                  * we either run out of masks, lose the run, or find what we
 140                  * were looking for.
 141                  */
 142                 cur_msk = msk->data[msk_idx];
 143                 left = n;
 144
 145                 /* if we're looking for free spaces, invert the mask */
 146                 if (!used)
 147                         cur_msk = ~cur_msk;
 148
 149                 /* combine current ignore mask with last index ignore mask */
 150                 if (msk_idx == last)
 151                         ignore_msk |= last_msk;
 152
 153                 /* if we have an ignore mask, ignore once */
 154                 if (ignore_msk) {
 155                         cur_msk &= ignore_msk;
 156                         ignore_msk = 0;
 157                 }
 158
 159                 /* if n can fit in within a single mask, do a search */
 160                 if (n <= MASK_ALIGN) {
 161                         uint64_t tmp_msk = cur_msk;
 162                         unsigned int s_idx;
 163                         for (s_idx = 0; s_idx < n - 1; s_idx++)
 164                                 tmp_msk &= tmp_msk >> 1ULL;
 165                         /* we found what we were looking for */
 166                         if (tmp_msk != 0) {
 167                                 run_start = __builtin_ctzll(tmp_msk);
 168                                 return MASK_GET_IDX(msk_idx, run_start);
 169                         }
 170                 }
 171
 172                 /*
 173                  * we didn't find our run within the mask, or n > MASK_ALIGN,
 174                  * so we're going for plan B.
 175                  */
 176
 177                 /* count leading zeroes on inverted mask */
 178                 if (~cur_msk == 0)
 179                         clz = sizeof(cur_msk) * 8;
 180                 else
 181                         clz = __builtin_clzll(~cur_msk);
 182
 183                 /* if there aren't any runs at the end either, just continue */
 184                 if (clz == 0)
 185                         continue;
 186
 187                 /* we have a partial run at the end, so try looking ahead */
 188                 run_start = MASK_ALIGN - clz;
 189                 left -= clz;
 190
 191                 for (lookahead_idx = msk_idx + 1; lookahead_idx < msk->n_masks;
 192                                 lookahead_idx++) {
 193                         unsigned int s_idx, need;
 194                         lookahead_msk = msk->data[lookahead_idx];
 195
 196                         /* if we're looking for free space, invert the mask */
 197                         if (!used)
 198                                 lookahead_msk = ~lookahead_msk;
 199
 200                         /* figure out how many consecutive bits we need here */
 201                         need = RTE_MIN(left, MASK_ALIGN);
 202
 203                         for (s_idx = 0; s_idx < need - 1; s_idx++)
 204                                 lookahead_msk &= lookahead_msk >> 1ULL;
 205
 206                         /* if first bit is not set, we've lost the run */
 207                         if ((lookahead_msk & 1) == 0) {
 208                                 /*
 209                                  * we've scanned this far, so we know there are
 210                                  * no runs in the space we've lookahead-scanned
 211                                  * as well, so skip that on next iteration.
 212                                  */
 213                                 ignore_msk = ~((1ULL << need) - 1);
 214                                 msk_idx = lookahead_idx;
 215                                 break;
 216                         }
 217
 218                         left -= need;
 219
 220                         /* check if we've found what we were looking for */
 221                         if (left == 0) {
 222                                 found = true;
 223                                 break;
 224                         }
 225                 }
 226
 227                 /* we didn't find anything, so continue */
 228                 if (!found)
 229                         continue;
 230
 231                 return MASK_GET_IDX(msk_idx, run_start);
 232         }
 233         /* we didn't find anything */
 234         rte_errno = used ? -ENOENT : -ENOSPC;
 235         return -1;
 236 }
 237
 238 static int
 239 find_next(const struct rte_fbarray *arr, unsigned int start, bool used)
 240 {
 241         const struct used_mask *msk = get_used_mask(arr->data, arr->elt_sz,
 242                         arr->len);
 243         unsigned int idx, first, first_mod;
 244         unsigned int last, last_mod;
 245         uint64_t last_msk, ignore_msk;
 246
 247         /*
 248          * mask only has granularity of MASK_ALIGN, but start may not be aligned
 249          * on that boundary, so construct a special mask to exclude anything we
 250          * don't want to see to avoid confusing ctz.
 251          */
 252         first = MASK_LEN_TO_IDX(start);
 253         first_mod = MASK_LEN_TO_MOD(start);
 254         ignore_msk = ~((1ULL << first_mod) - 1ULL);
 255
 256         /* array length may not be aligned, so calculate ignore mask for last
 257          * mask index.
 258          */
 259         last = MASK_LEN_TO_IDX(arr->len);
 260         last_mod = MASK_LEN_TO_MOD(arr->len);
 261         last_msk = ~(-(1ULL) << last_mod);
 262
 263         for (idx = first; idx < msk->n_masks; idx++) {
 264                 uint64_t cur = msk->data[idx];
 265                 int found;
 266
 267                 /* if we're looking for free entries, invert mask */
 268                 if (!used)
 269                         cur = ~cur;
 270
 271                 if (idx == last)
 272                         cur &= last_msk;
 273
 274                 /* ignore everything before start on first iteration */
 275                 if (idx == first)
 276                         cur &= ignore_msk;
 277
 278                 /* check if we have any entries */
 279                 if (cur == 0)
 280                         continue;
 281
 282                 /*
 283                  * find first set bit - that will correspond to whatever it is
 284                  * that we're looking for.
 285                  */
 286                 found = __builtin_ctzll(cur);
 287                 return MASK_GET_IDX(idx, found);
 288         }
 289         /* we didn't find anything */
 290         rte_errno = used ? -ENOENT : -ENOSPC;
 291         return -1;
 292 }
 293
 294 static int
 295 find_contig(const struct rte_fbarray *arr, unsigned int start, bool used)
 296 {
 297         const struct used_mask *msk = get_used_mask(arr->data, arr->elt_sz,
 298                         arr->len);
 299         unsigned int idx, first, first_mod;
 300         unsigned int last, last_mod;
 301         uint64_t last_msk;
 302         unsigned int need_len, result = 0;
 303
 304         /* array length may not be aligned, so calculate ignore mask for last
 305          * mask index.
 306          */
 307         last = MASK_LEN_TO_IDX(arr->len);
 308         last_mod = MASK_LEN_TO_MOD(arr->len);
 309         last_msk = ~(-(1ULL) << last_mod);
 310
 311         first = MASK_LEN_TO_IDX(start);
 312         first_mod = MASK_LEN_TO_MOD(start);
 313         for (idx = first; idx < msk->n_masks; idx++, result += need_len) {
 314                 uint64_t cur = msk->data[idx];
 315                 unsigned int run_len;
 316
 317                 need_len = MASK_ALIGN;
 318
 319                 /* if we're looking for free entries, invert mask */
 320                 if (!used)
 321                         cur = ~cur;
 322
 323                 /* if this is last mask, ignore everything after last bit */
 324                 if (idx == last)
 325                         cur &= last_msk;
 326
 327                 /* ignore everything before start on first iteration */
 328                 if (idx == first) {
 329                         cur >>= first_mod;
 330                         /* at the start, we don't need the full mask len */
 331                         need_len -= first_mod;
 332                 }
 333
 334                 /* we will be looking for zeroes, so invert the mask */
 335                 cur = ~cur;
 336
 337                 /* if mask is zero, we have a complete run */
 338                 if (cur == 0)
 339                         continue;
 340
 341                 /*
 342                  * see if current run ends before mask end.
 343                  */
 344                 run_len = __builtin_ctzll(cur);
 345
 346                 /* add however many zeroes we've had in the last run and quit */
 347                 if (run_len < need_len) {
 348                         result += run_len;
 349                         break;
 350                 }
 351         }
 352         return result;
 353 }
 354
 355 static int
 356 set_used(struct rte_fbarray *arr, unsigned int idx, bool used)
 357 {
 358         struct used_mask *msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
 359         uint64_t msk_bit = 1ULL << MASK_LEN_TO_MOD(idx);
 360         unsigned int msk_idx = MASK_LEN_TO_IDX(idx);
 361         bool already_used;
 362         int ret = -1;
 363
 364         if (arr == NULL || idx >= arr->len) {
 365                 rte_errno = EINVAL;
 366                 return -1;
 367         }
 368         ret = 0;
 369
 370         /* prevent array from changing under us */
 371         rte_rwlock_write_lock(&arr->rwlock);
 372
 373         already_used = (msk->data[msk_idx] & msk_bit) != 0;
 374
 375         /* nothing to be done */
 376         if (used == already_used)
 377                 goto out;
 378
 379         if (used) {
 380                 msk->data[msk_idx] |= msk_bit;
 381                 arr->count++;
 382         } else {
 383                 msk->data[msk_idx] &= ~msk_bit;
 384                 arr->count--;
 385         }
 386 out:
 387         rte_rwlock_write_unlock(&arr->rwlock);
 388
 389         return ret;
 390 }
 391
 392 static int
 393 fully_validate(const char *name, unsigned int elt_sz, unsigned int len)
 394 {
 395         if (name == NULL || elt_sz == 0 || len == 0 || len > INT_MAX) {
 396                 rte_errno = EINVAL;
 397                 return -1;
 398         }
 399
 400         if (strnlen(name, RTE_FBARRAY_NAME_LEN) == RTE_FBARRAY_NAME_LEN) {
 401                 rte_errno = ENAMETOOLONG;
 402                 return -1;
 403         }
 404         return 0;
 405 }
 406
 407 int __rte_experimental
 408 rte_fbarray_init(struct rte_fbarray *arr, const char *name, unsigned int len,
 409                 unsigned int elt_sz)
 410 {
 411         size_t page_sz, mmap_len;
 412         char path[PATH_MAX];
 413         struct used_mask *msk;
 414         void *data = NULL;
 415         int fd = -1;
 416
 417         if (arr == NULL) {
 418                 rte_errno = EINVAL;
 419                 return -1;
 420         }
 421
 422         if (fully_validate(name, elt_sz, len))
 423                 return -1;
 424
 425         page_sz = sysconf(_SC_PAGESIZE);
 426         if (page_sz == (size_t)-1)
 427                 goto fail;
 428
 429         /* calculate our memory limits */
 430         mmap_len = calc_data_size(page_sz, elt_sz, len);
 431
 432         data = eal_get_virtual_area(NULL, &mmap_len, page_sz, 0, 0);
 433         if (data == NULL)
 434                 goto fail;
 435
 436         eal_get_fbarray_path(path, sizeof(path), name);
 437
 438         /*
 439          * Each fbarray is unique to process namespace, i.e. the filename
 440          * depends on process prefix. Try to take out a lock and see if we
 441          * succeed. If we don't, someone else is using it already.
 442          */
 443         fd = open(path, O_CREAT | O_RDWR, 0600);
 444         if (fd < 0) {
 445                 RTE_LOG(DEBUG, EAL, "%s(): couldn't open %s: %s\n", __func__,
 446                                 path, strerror(errno));
 447                 rte_errno = errno;
 448                 goto fail;
 449         } else if (flock(fd, LOCK_EX | LOCK_NB)) {
 450                 RTE_LOG(DEBUG, EAL, "%s(): couldn't lock %s: %s\n", __func__,
 451                                 path, strerror(errno));
 452                 rte_errno = EBUSY;
 453                 goto fail;
 454         }
 455
 456         /* take out a non-exclusive lock, so that other processes could still
 457          * attach to it, but no other process could reinitialize it.
 458          */
 459         if (flock(fd, LOCK_SH | LOCK_NB)) {
 460                 rte_errno = errno;
 461                 goto fail;
 462         }
 463
 464         if (resize_and_map(fd, data, mmap_len))
 465                 goto fail;
 466
 467         /* we've mmap'ed the file, we can now close the fd */
 468         close(fd);
 469
 470         /* initialize the data */
 471         memset(data, 0, mmap_len);
 472
 473         /* populate data structure */
 474         snprintf(arr->name, sizeof(arr->name), "%s", name);
 475         arr->data = data;
 476         arr->len = len;
 477         arr->elt_sz = elt_sz;
 478         arr->count = 0;
 479
 480         msk = get_used_mask(data, elt_sz, len);
 481         msk->n_masks = MASK_LEN_TO_IDX(RTE_ALIGN_CEIL(len, MASK_ALIGN));
 482
 483         rte_rwlock_init(&arr->rwlock);
 484
 485         return 0;
 486 fail:
 487         if (data)
 488                 munmap(data, mmap_len);
 489         if (fd >= 0)
 490                 close(fd);
 491         return -1;
 492 }
 493
 494 int __rte_experimental
 495 rte_fbarray_attach(struct rte_fbarray *arr)
 496 {
 497         size_t page_sz, mmap_len;
 498         char path[PATH_MAX];
 499         void *data = NULL;
 500         int fd = -1;
 501
 502         if (arr == NULL) {
 503                 rte_errno = EINVAL;
 504                 return -1;
 505         }
 506
 507         /*
 508          * we don't need to synchronize attach as two values we need (element
 509          * size and array length) are constant for the duration of life of
 510          * the array, so the parts we care about will not race.
 511          */
 512
 513         if (fully_validate(arr->name, arr->elt_sz, arr->len))
 514                 return -1;
 515
 516         page_sz = sysconf(_SC_PAGESIZE);
 517         if (page_sz == (size_t)-1)
 518                 goto fail;
 519
 520         mmap_len = calc_data_size(page_sz, arr->elt_sz, arr->len);
 521
 522         data = eal_get_virtual_area(arr->data, &mmap_len, page_sz, 0, 0);
 523         if (data == NULL)
 524                 goto fail;
 525
 526         eal_get_fbarray_path(path, sizeof(path), arr->name);
 527
 528         fd = open(path, O_RDWR);
 529         if (fd < 0) {
 530                 rte_errno = errno;
 531                 goto fail;
 532         }
 533
 534         /* lock the file, to let others know we're using it */
 535         if (flock(fd, LOCK_SH | LOCK_NB)) {
 536                 rte_errno = errno;
 537                 goto fail;
 538         }
 539
 540         if (resize_and_map(fd, data, mmap_len))
 541                 goto fail;
 542
 543         close(fd);
 544
 545         /* we're done */
 546
 547         return 0;
 548 fail:
 549         if (data)
 550                 munmap(data, mmap_len);
 551         if (fd >= 0)
 552                 close(fd);
 553         return -1;
 554 }
 555
 556 int __rte_experimental
 557 rte_fbarray_detach(struct rte_fbarray *arr)
 558 {
 559         if (arr == NULL) {
 560                 rte_errno = EINVAL;
 561                 return -1;
 562         }
 563
 564         /*
 565          * we don't need to synchronize detach as two values we need (element
 566          * size and total capacity) are constant for the duration of life of
 567          * the array, so the parts we care about will not race. if the user is
 568          * detaching while doing something else in the same process, we can't
 569          * really do anything about it, things will blow up either way.
 570          */
 571
 572         size_t page_sz = sysconf(_SC_PAGESIZE);
 573
 574         /* this may already be unmapped (e.g. repeated call from previously
 575          * failed destroy(), but this is on user, we can't (easily) know if this
 576          * is still mapped.
 577          */
 578         munmap(arr->data, calc_data_size(page_sz, arr->elt_sz, arr->len));
 579
 580         return 0;
 581 }
 582
 583 int __rte_experimental
 584 rte_fbarray_destroy(struct rte_fbarray *arr)
 585 {
 586         int fd, ret;
 587         char path[PATH_MAX];
 588
 589         ret = rte_fbarray_detach(arr);
 590         if (ret)
 591                 return ret;
 592
 593         /* try deleting the file */
 594         eal_get_fbarray_path(path, sizeof(path), arr->name);
 595
 596         fd = open(path, O_RDONLY);
 597         if (flock(fd, LOCK_EX | LOCK_NB)) {
 598                 RTE_LOG(DEBUG, EAL, "Cannot destroy fbarray - another process is using it\n");
 599                 rte_errno = EBUSY;
 600                 ret = -1;
 601         } else {
 602                 ret = 0;
 603                 unlink(path);
 604                 memset(arr, 0, sizeof(*arr));
 605         }
 606         close(fd);
 607
 608         return ret;
 609 }
 610
 611 void * __rte_experimental
 612 rte_fbarray_get(const struct rte_fbarray *arr, unsigned int idx)
 613 {
 614         void *ret = NULL;
 615         if (arr == NULL) {
 616                 rte_errno = EINVAL;
 617                 return NULL;
 618         }
 619
 620         if (idx >= arr->len) {
 621                 rte_errno = EINVAL;
 622                 return NULL;
 623         }
 624
 625         ret = RTE_PTR_ADD(arr->data, idx * arr->elt_sz);
 626
 627         return ret;
 628 }
 629
 630 int __rte_experimental
 631 rte_fbarray_set_used(struct rte_fbarray *arr, unsigned int idx)
 632 {
 633         return set_used(arr, idx, true);
 634 }
 635
 636 int __rte_experimental
 637 rte_fbarray_set_free(struct rte_fbarray *arr, unsigned int idx)
 638 {
 639         return set_used(arr, idx, false);
 640 }
 641
 642 int __rte_experimental
 643 rte_fbarray_is_used(struct rte_fbarray *arr, unsigned int idx)
 644 {
 645         struct used_mask *msk;
 646         int msk_idx;
 647         uint64_t msk_bit;
 648         int ret = -1;
 649
 650         if (arr == NULL || idx >= arr->len) {
 651                 rte_errno = EINVAL;
 652                 return -1;
 653         }
 654
 655         /* prevent array from changing under us */
 656         rte_rwlock_read_lock(&arr->rwlock);
 657
 658         msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
 659         msk_idx = MASK_LEN_TO_IDX(idx);
 660         msk_bit = 1ULL << MASK_LEN_TO_MOD(idx);
 661
 662         ret = (msk->data[msk_idx] & msk_bit) != 0;
 663
 664         rte_rwlock_read_unlock(&arr->rwlock);
 665
 666         return ret;
 667 }
 668
 669 int __rte_experimental
 670 rte_fbarray_find_next_free(struct rte_fbarray *arr, unsigned int start)
 671 {
 672         int ret = -1;
 673
 674         if (arr == NULL || start >= arr->len) {
 675                 rte_errno = EINVAL;
 676                 return -1;
 677         }
 678
 679         /* prevent array from changing under us */
 680         rte_rwlock_read_lock(&arr->rwlock);
 681
 682         if (arr->len == arr->count) {
 683                 rte_errno = ENOSPC;
 684                 goto out;
 685         }
 686
 687         ret = find_next(arr, start, false);
 688 out:
 689         rte_rwlock_read_unlock(&arr->rwlock);
 690         return ret;
 691 }
 692
 693 int __rte_experimental
 694 rte_fbarray_find_next_used(struct rte_fbarray *arr, unsigned int start)
 695 {
 696         int ret = -1;
 697
 698         if (arr == NULL || start >= arr->len) {
 699                 rte_errno = EINVAL;
 700                 return -1;
 701         }
 702
 703         /* prevent array from changing under us */
 704         rte_rwlock_read_lock(&arr->rwlock);
 705
 706         if (arr->count == 0) {
 707                 rte_errno = ENOENT;
 708                 goto out;
 709         }
 710
 711         ret = find_next(arr, start, true);
 712 out:
 713         rte_rwlock_read_unlock(&arr->rwlock);
 714         return ret;
 715 }
 716
 717 int __rte_experimental
 718 rte_fbarray_find_next_n_free(struct rte_fbarray *arr, unsigned int start,
 719                 unsigned int n)
 720 {
 721         int ret = -1;
 722
 723         if (arr == NULL || start >= arr->len || n > arr->len) {
 724                 rte_errno = EINVAL;
 725                 return -1;
 726         }
 727
 728         /* prevent array from changing under us */
 729         rte_rwlock_read_lock(&arr->rwlock);
 730
 731         if (arr->len == arr->count || arr->len - arr->count < n) {
 732                 rte_errno = ENOSPC;
 733                 goto out;
 734         }
 735
 736         ret = find_next_n(arr, start, n, false);
 737 out:
 738         rte_rwlock_read_unlock(&arr->rwlock);
 739         return ret;
 740 }
 741
 742 int __rte_experimental
 743 rte_fbarray_find_next_n_used(struct rte_fbarray *arr, unsigned int start,
 744                 unsigned int n)
 745 {
 746         int ret = -1;
 747
 748         if (arr == NULL || start >= arr->len || n > arr->len) {
 749                 rte_errno = EINVAL;
 750                 return -1;
 751         }
 752
 753         /* prevent array from changing under us */
 754         rte_rwlock_read_lock(&arr->rwlock);
 755
 756         if (arr->count < n) {
 757                 rte_errno = ENOENT;
 758                 goto out;
 759         }
 760
 761         ret = find_next_n(arr, start, n, true);
 762 out:
 763         rte_rwlock_read_unlock(&arr->rwlock);
 764         return ret;
 765 }
 766
 767 int __rte_experimental
 768 rte_fbarray_find_contig_free(struct rte_fbarray *arr, unsigned int start)
 769 {
 770         int ret = -1;
 771
 772         if (arr == NULL || start >= arr->len) {
 773                 rte_errno = EINVAL;
 774                 return -1;
 775         }
 776
 777         /* prevent array from changing under us */
 778         rte_rwlock_read_lock(&arr->rwlock);
 779
 780         if (arr->len == arr->count) {
 781                 rte_errno = ENOSPC;
 782                 goto out;
 783         }
 784
 785         if (arr->count == 0) {
 786                 ret = arr->len - start;
 787                 goto out;
 788         }
 789
 790         ret = find_contig(arr, start, false);
 791 out:
 792         rte_rwlock_read_unlock(&arr->rwlock);
 793         return ret;
 794 }
 795
 796 int __rte_experimental
 797 rte_fbarray_find_contig_used(struct rte_fbarray *arr, unsigned int start)
 798 {
 799         int ret = -1;
 800
 801         if (arr == NULL || start >= arr->len) {
 802                 rte_errno = EINVAL;
 803                 return -1;
 804         }
 805
 806         /* prevent array from changing under us */
 807         rte_rwlock_read_lock(&arr->rwlock);
 808
 809         ret = find_contig(arr, start, true);
 810
 811         rte_rwlock_read_unlock(&arr->rwlock);
 812         return ret;
 813 }
 814
 815 int __rte_experimental
 816 rte_fbarray_find_idx(const struct rte_fbarray *arr, const void *elt)
 817 {
 818         void *end;
 819         int ret = -1;
 820
 821         /*
 822          * no need to synchronize as it doesn't matter if underlying data
 823          * changes - we're doing pointer arithmetic here.
 824          */
 825
 826         if (arr == NULL || elt == NULL) {
 827                 rte_errno = EINVAL;
 828                 return -1;
 829         }
 830         end = RTE_PTR_ADD(arr->data, arr->elt_sz * arr->len);
 831         if (elt < arr->data || elt >= end) {
 832                 rte_errno = EINVAL;
 833                 return -1;
 834         }
 835
 836         ret = RTE_PTR_DIFF(elt, arr->data) / arr->elt_sz;
 837
 838         return ret;
 839 }
 840
 841 void __rte_experimental
 842 rte_fbarray_dump_metadata(struct rte_fbarray *arr, FILE *f)
 843 {
 844         struct used_mask *msk;
 845         unsigned int i;
 846
 847         if (arr == NULL || f == NULL) {
 848                 rte_errno = EINVAL;
 849                 return;
 850         }
 851
 852         if (fully_validate(arr->name, arr->elt_sz, arr->len)) {
 853                 fprintf(f, "Invalid file-backed array\n");
 854                 goto out;
 855         }
 856
 857         /* prevent array from changing under us */
 858         rte_rwlock_read_lock(&arr->rwlock);
 859
 860         fprintf(f, "File-backed array: %s\n", arr->name);
 861         fprintf(f, "size: %i occupied: %i elt_sz: %i\n",
 862                         arr->len, arr->count, arr->elt_sz);
 863
 864         msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
 865
 866         for (i = 0; i < msk->n_masks; i++)
 867                 fprintf(f, "msk idx %i: 0x%016" PRIx64 "\n", i, msk->data[i]);
 868 out:
 869         rte_rwlock_read_unlock(&arr->rwlock);
 870 }