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 find_prev_n(const struct rte_fbarray *arr, unsigned int start, unsigned int n,
 357                 bool used)
 358 {
 359         const struct used_mask *msk = get_used_mask(arr->data, arr->elt_sz,
 360                         arr->len);
 361         unsigned int msk_idx, lookbehind_idx, first, first_mod;
 362         uint64_t ignore_msk;
 363
 364         /*
 365          * mask only has granularity of MASK_ALIGN, but start may not be aligned
 366          * on that boundary, so construct a special mask to exclude anything we
 367          * don't want to see to avoid confusing ctz.
 368          */
 369         first = MASK_LEN_TO_IDX(start);
 370         first_mod = MASK_LEN_TO_MOD(start);
 371         /* we're going backwards, so mask must start from the top */
 372         ignore_msk = first_mod == MASK_ALIGN - 1 ?
 373                                 -1ULL : /* prevent overflow */
 374                                 ~(-1ULL << (first_mod + 1));
 375
 376         /* go backwards, include zero */
 377         msk_idx = first;
 378         do {
 379                 uint64_t cur_msk, lookbehind_msk;
 380                 unsigned int run_start, run_end, ctz, left;
 381                 bool found = false;
 382                 /*
 383                  * The process of getting n consecutive bits from the top for
 384                  * arbitrary n is a bit involved, but here it is in a nutshell:
 385                  *
 386                  *  1. let n be the number of consecutive bits we're looking for
 387                  *  2. check if n can fit in one mask, and if so, do n-1
 388                  *     lshift-ands to see if there is an appropriate run inside
 389                  *     our current mask
 390                  *    2a. if we found a run, bail out early
 391                  *    2b. if we didn't find a run, proceed
 392                  *  3. invert the mask and count trailing zeroes (that is, count
 393                  *     how many consecutive set bits we had starting from the
 394                  *     start of current mask) as k
 395                  *    3a. if k is 0, continue to next mask
 396                  *    3b. if k is not 0, we have a potential run
 397                  *  4. to satisfy our requirements, next mask must have n-k
 398                  *     consecutive set bits at the end, so we will do (n-k-1)
 399                  *     lshift-ands and check if last bit is set.
 400                  *
 401                  * Step 4 will need to be repeated if (n-k) > MASK_ALIGN until
 402                  * we either run out of masks, lose the run, or find what we
 403                  * were looking for.
 404                  */
 405                 cur_msk = msk->data[msk_idx];
 406                 left = n;
 407
 408                 /* if we're looking for free spaces, invert the mask */
 409                 if (!used)
 410                         cur_msk = ~cur_msk;
 411
 412                 /* if we have an ignore mask, ignore once */
 413                 if (ignore_msk) {
 414                         cur_msk &= ignore_msk;
 415                         ignore_msk = 0;
 416                 }
 417
 418                 /* if n can fit in within a single mask, do a search */
 419                 if (n <= MASK_ALIGN) {
 420                         uint64_t tmp_msk = cur_msk;
 421                         unsigned int s_idx;
 422                         for (s_idx = 0; s_idx < n - 1; s_idx++)
 423                                 tmp_msk &= tmp_msk << 1ULL;
 424                         /* we found what we were looking for */
 425                         if (tmp_msk != 0) {
 426                                 /* clz will give us offset from end of mask, and
 427                                  * we only get the end of our run, not start,
 428                                  * so adjust result to point to where start
 429                                  * would have been.
 430                                  */
 431                                 run_start = MASK_ALIGN -
 432                                                 __builtin_clzll(tmp_msk) - n;
 433                                 return MASK_GET_IDX(msk_idx, run_start);
 434                         }
 435                 }
 436
 437                 /*
 438                  * we didn't find our run within the mask, or n > MASK_ALIGN,
 439                  * so we're going for plan B.
 440                  */
 441
 442                 /* count trailing zeroes on inverted mask */
 443                 if (~cur_msk == 0)
 444                         ctz = sizeof(cur_msk) * 8;
 445                 else
 446                         ctz = __builtin_ctzll(~cur_msk);
 447
 448                 /* if there aren't any runs at the start either, just
 449                  * continue
 450                  */
 451                 if (ctz == 0)
 452                         continue;
 453
 454                 /* we have a partial run at the start, so try looking behind */
 455                 run_end = MASK_GET_IDX(msk_idx, ctz);
 456                 left -= ctz;
 457
 458                 /* go backwards, include zero */
 459                 lookbehind_idx = msk_idx - 1;
 460
 461                 /* we can't lookbehind as we've run out of masks, so stop */
 462                 if (msk_idx == 0)
 463                         break;
 464
 465                 do {
 466                         const uint64_t last_bit = 1ULL << (MASK_ALIGN - 1);
 467                         unsigned int s_idx, need;
 468
 469                         lookbehind_msk = msk->data[lookbehind_idx];
 470
 471                         /* if we're looking for free space, invert the mask */
 472                         if (!used)
 473                                 lookbehind_msk = ~lookbehind_msk;
 474
 475                         /* figure out how many consecutive bits we need here */
 476                         need = RTE_MIN(left, MASK_ALIGN);
 477
 478                         for (s_idx = 0; s_idx < need - 1; s_idx++)
 479                                 lookbehind_msk &= lookbehind_msk << 1ULL;
 480
 481                         /* if last bit is not set, we've lost the run */
 482                         if ((lookbehind_msk & last_bit) == 0) {
 483                                 /*
 484                                  * we've scanned this far, so we know there are
 485                                  * no runs in the space we've lookbehind-scanned
 486                                  * as well, so skip that on next iteration.
 487                                  */
 488                                 ignore_msk = -1ULL << need;
 489                                 msk_idx = lookbehind_idx;
 490                                 break;
 491                         }
 492
 493                         left -= need;
 494
 495                         /* check if we've found what we were looking for */
 496                         if (left == 0) {
 497                                 found = true;
 498                                 break;
 499                         }
 500                 } while ((lookbehind_idx--) != 0); /* decrement after check to
 501                                                     * include zero
 502                                                     */
 503
 504                 /* we didn't find anything, so continue */
 505                 if (!found)
 506                         continue;
 507
 508                 /* we've found what we were looking for, but we only know where
 509                  * the run ended, so calculate start position.
 510                  */
 511                 return run_end - n;
 512         } while (msk_idx-- != 0); /* decrement after check to include zero */
 513         /* we didn't find anything */
 514         rte_errno = used ? ENOENT : ENOSPC;
 515         return -1;
 516 }
 517
 518 static int
 519 find_prev(const struct rte_fbarray *arr, unsigned int start, bool used)
 520 {
 521         const struct used_mask *msk = get_used_mask(arr->data, arr->elt_sz,
 522                         arr->len);
 523         unsigned int idx, first, first_mod;
 524         uint64_t ignore_msk;
 525
 526         /*
 527          * mask only has granularity of MASK_ALIGN, but start may not be aligned
 528          * on that boundary, so construct a special mask to exclude anything we
 529          * don't want to see to avoid confusing clz.
 530          */
 531         first = MASK_LEN_TO_IDX(start);
 532         first_mod = MASK_LEN_TO_MOD(start);
 533         /* we're going backwards, so mask must start from the top */
 534         ignore_msk = first_mod == MASK_ALIGN - 1 ?
 535                                 -1ULL : /* prevent overflow */
 536                                 ~(-1ULL << (first_mod + 1));
 537
 538         /* go backwards, include zero */
 539         idx = first;
 540         do {
 541                 uint64_t cur = msk->data[idx];
 542                 int found;
 543
 544                 /* if we're looking for free entries, invert mask */
 545                 if (!used)
 546                         cur = ~cur;
 547
 548                 /* ignore everything before start on first iteration */
 549                 if (idx == first)
 550                         cur &= ignore_msk;
 551
 552                 /* check if we have any entries */
 553                 if (cur == 0)
 554                         continue;
 555
 556                 /*
 557                  * find last set bit - that will correspond to whatever it is
 558                  * that we're looking for. we're counting trailing zeroes, thus
 559                  * the value we get is counted from end of mask, so calculate
 560                  * position from start of mask.
 561                  */
 562                 found = MASK_ALIGN - __builtin_clzll(cur) - 1;
 563
 564                 return MASK_GET_IDX(idx, found);
 565         } while (idx-- != 0); /* decrement after check  to include zero*/
 566
 567         /* we didn't find anything */
 568         rte_errno = used ? ENOENT : ENOSPC;
 569         return -1;
 570 }
 571
 572 static int
 573 set_used(struct rte_fbarray *arr, unsigned int idx, bool used)
 574 {
 575         struct used_mask *msk;
 576         uint64_t msk_bit = 1ULL << MASK_LEN_TO_MOD(idx);
 577         unsigned int msk_idx = MASK_LEN_TO_IDX(idx);
 578         bool already_used;
 579         int ret = -1;
 580
 581         if (arr == NULL || idx >= arr->len) {
 582                 rte_errno = EINVAL;
 583                 return -1;
 584         }
 585         msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
 586         ret = 0;
 587
 588         /* prevent array from changing under us */
 589         rte_rwlock_write_lock(&arr->rwlock);
 590
 591         already_used = (msk->data[msk_idx] & msk_bit) != 0;
 592
 593         /* nothing to be done */
 594         if (used == already_used)
 595                 goto out;
 596
 597         if (used) {
 598                 msk->data[msk_idx] |= msk_bit;
 599                 arr->count++;
 600         } else {
 601                 msk->data[msk_idx] &= ~msk_bit;
 602                 arr->count--;
 603         }
 604 out:
 605         rte_rwlock_write_unlock(&arr->rwlock);
 606
 607         return ret;
 608 }
 609
 610 static int
 611 fully_validate(const char *name, unsigned int elt_sz, unsigned int len)
 612 {
 613         if (name == NULL || elt_sz == 0 || len == 0 || len > INT_MAX) {
 614                 rte_errno = EINVAL;
 615                 return -1;
 616         }
 617
 618         if (strnlen(name, RTE_FBARRAY_NAME_LEN) == RTE_FBARRAY_NAME_LEN) {
 619                 rte_errno = ENAMETOOLONG;
 620                 return -1;
 621         }
 622         return 0;
 623 }
 624
 625 int __rte_experimental
 626 rte_fbarray_init(struct rte_fbarray *arr, const char *name, unsigned int len,
 627                 unsigned int elt_sz)
 628 {
 629         size_t page_sz, mmap_len;
 630         char path[PATH_MAX];
 631         struct used_mask *msk;
 632         void *data = NULL;
 633         int fd = -1;
 634
 635         if (arr == NULL) {
 636                 rte_errno = EINVAL;
 637                 return -1;
 638         }
 639
 640         if (fully_validate(name, elt_sz, len))
 641                 return -1;
 642
 643         page_sz = sysconf(_SC_PAGESIZE);
 644         if (page_sz == (size_t)-1)
 645                 goto fail;
 646
 647         /* calculate our memory limits */
 648         mmap_len = calc_data_size(page_sz, elt_sz, len);
 649
 650         data = eal_get_virtual_area(NULL, &mmap_len, page_sz, 0, 0);
 651         if (data == NULL)
 652                 goto fail;
 653
 654         eal_get_fbarray_path(path, sizeof(path), name);
 655
 656         /*
 657          * Each fbarray is unique to process namespace, i.e. the filename
 658          * depends on process prefix. Try to take out a lock and see if we
 659          * succeed. If we don't, someone else is using it already.
 660          */
 661         fd = open(path, O_CREAT | O_RDWR, 0600);
 662         if (fd < 0) {
 663                 RTE_LOG(DEBUG, EAL, "%s(): couldn't open %s: %s\n", __func__,
 664                                 path, strerror(errno));
 665                 rte_errno = errno;
 666                 goto fail;
 667         } else if (flock(fd, LOCK_EX | LOCK_NB)) {
 668                 RTE_LOG(DEBUG, EAL, "%s(): couldn't lock %s: %s\n", __func__,
 669                                 path, strerror(errno));
 670                 rte_errno = EBUSY;
 671                 goto fail;
 672         }
 673
 674         /* take out a non-exclusive lock, so that other processes could still
 675          * attach to it, but no other process could reinitialize it.
 676          */
 677         if (flock(fd, LOCK_SH | LOCK_NB)) {
 678                 rte_errno = errno;
 679                 goto fail;
 680         }
 681
 682         if (resize_and_map(fd, data, mmap_len))
 683                 goto fail;
 684
 685         /* we've mmap'ed the file, we can now close the fd */
 686         close(fd);
 687
 688         /* initialize the data */
 689         memset(data, 0, mmap_len);
 690
 691         /* populate data structure */
 692         strlcpy(arr->name, name, sizeof(arr->name));
 693         arr->data = data;
 694         arr->len = len;
 695         arr->elt_sz = elt_sz;
 696         arr->count = 0;
 697
 698         msk = get_used_mask(data, elt_sz, len);
 699         msk->n_masks = MASK_LEN_TO_IDX(RTE_ALIGN_CEIL(len, MASK_ALIGN));
 700
 701         rte_rwlock_init(&arr->rwlock);
 702
 703         return 0;
 704 fail:
 705         if (data)
 706                 munmap(data, mmap_len);
 707         if (fd >= 0)
 708                 close(fd);
 709         return -1;
 710 }
 711
 712 int __rte_experimental
 713 rte_fbarray_attach(struct rte_fbarray *arr)
 714 {
 715         size_t page_sz, mmap_len;
 716         char path[PATH_MAX];
 717         void *data = NULL;
 718         int fd = -1;
 719
 720         if (arr == NULL) {
 721                 rte_errno = EINVAL;
 722                 return -1;
 723         }
 724
 725         /*
 726          * we don't need to synchronize attach as two values we need (element
 727          * size and array length) are constant for the duration of life of
 728          * the array, so the parts we care about will not race.
 729          */
 730
 731         if (fully_validate(arr->name, arr->elt_sz, arr->len))
 732                 return -1;
 733
 734         page_sz = sysconf(_SC_PAGESIZE);
 735         if (page_sz == (size_t)-1)
 736                 goto fail;
 737
 738         mmap_len = calc_data_size(page_sz, arr->elt_sz, arr->len);
 739
 740         data = eal_get_virtual_area(arr->data, &mmap_len, page_sz, 0, 0);
 741         if (data == NULL)
 742                 goto fail;
 743
 744         eal_get_fbarray_path(path, sizeof(path), arr->name);
 745
 746         fd = open(path, O_RDWR);
 747         if (fd < 0) {
 748                 rte_errno = errno;
 749                 goto fail;
 750         }
 751
 752         /* lock the file, to let others know we're using it */
 753         if (flock(fd, LOCK_SH | LOCK_NB)) {
 754                 rte_errno = errno;
 755                 goto fail;
 756         }
 757
 758         if (resize_and_map(fd, data, mmap_len))
 759                 goto fail;
 760
 761         close(fd);
 762
 763         /* we're done */
 764
 765         return 0;
 766 fail:
 767         if (data)
 768                 munmap(data, mmap_len);
 769         if (fd >= 0)
 770                 close(fd);
 771         return -1;
 772 }
 773
 774 int __rte_experimental
 775 rte_fbarray_detach(struct rte_fbarray *arr)
 776 {
 777         if (arr == NULL) {
 778                 rte_errno = EINVAL;
 779                 return -1;
 780         }
 781
 782         /*
 783          * we don't need to synchronize detach as two values we need (element
 784          * size and total capacity) are constant for the duration of life of
 785          * the array, so the parts we care about will not race. if the user is
 786          * detaching while doing something else in the same process, we can't
 787          * really do anything about it, things will blow up either way.
 788          */
 789
 790         size_t page_sz = sysconf(_SC_PAGESIZE);
 791
 792         if (page_sz == (size_t)-1)
 793                 return -1;
 794
 795         /* this may already be unmapped (e.g. repeated call from previously
 796          * failed destroy(), but this is on user, we can't (easily) know if this
 797          * is still mapped.
 798          */
 799         munmap(arr->data, calc_data_size(page_sz, arr->elt_sz, arr->len));
 800
 801         return 0;
 802 }
 803
 804 int __rte_experimental
 805 rte_fbarray_destroy(struct rte_fbarray *arr)
 806 {
 807         int fd, ret;
 808         char path[PATH_MAX];
 809
 810         ret = rte_fbarray_detach(arr);
 811         if (ret)
 812                 return ret;
 813
 814         /* try deleting the file */
 815         eal_get_fbarray_path(path, sizeof(path), arr->name);
 816
 817         fd = open(path, O_RDONLY);
 818         if (fd < 0) {
 819                 RTE_LOG(ERR, EAL, "Could not open fbarray file: %s\n",
 820                         strerror(errno));
 821                 return -1;
 822         }
 823         if (flock(fd, LOCK_EX | LOCK_NB)) {
 824                 RTE_LOG(DEBUG, EAL, "Cannot destroy fbarray - another process is using it\n");
 825                 rte_errno = EBUSY;
 826                 ret = -1;
 827         } else {
 828                 ret = 0;
 829                 unlink(path);
 830                 memset(arr, 0, sizeof(*arr));
 831         }
 832         close(fd);
 833
 834         return ret;
 835 }
 836
 837 void * __rte_experimental
 838 rte_fbarray_get(const struct rte_fbarray *arr, unsigned int idx)
 839 {
 840         void *ret = NULL;
 841         if (arr == NULL) {
 842                 rte_errno = EINVAL;
 843                 return NULL;
 844         }
 845
 846         if (idx >= arr->len) {
 847                 rte_errno = EINVAL;
 848                 return NULL;
 849         }
 850
 851         ret = RTE_PTR_ADD(arr->data, idx * arr->elt_sz);
 852
 853         return ret;
 854 }
 855
 856 int __rte_experimental
 857 rte_fbarray_set_used(struct rte_fbarray *arr, unsigned int idx)
 858 {
 859         return set_used(arr, idx, true);
 860 }
 861
 862 int __rte_experimental
 863 rte_fbarray_set_free(struct rte_fbarray *arr, unsigned int idx)
 864 {
 865         return set_used(arr, idx, false);
 866 }
 867
 868 int __rte_experimental
 869 rte_fbarray_is_used(struct rte_fbarray *arr, unsigned int idx)
 870 {
 871         struct used_mask *msk;
 872         int msk_idx;
 873         uint64_t msk_bit;
 874         int ret = -1;
 875
 876         if (arr == NULL || idx >= arr->len) {
 877                 rte_errno = EINVAL;
 878                 return -1;
 879         }
 880
 881         /* prevent array from changing under us */
 882         rte_rwlock_read_lock(&arr->rwlock);
 883
 884         msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
 885         msk_idx = MASK_LEN_TO_IDX(idx);
 886         msk_bit = 1ULL << MASK_LEN_TO_MOD(idx);
 887
 888         ret = (msk->data[msk_idx] & msk_bit) != 0;
 889
 890         rte_rwlock_read_unlock(&arr->rwlock);
 891
 892         return ret;
 893 }
 894
 895 static int
 896 fbarray_find(struct rte_fbarray *arr, unsigned int start, bool next, bool used)
 897 {
 898         int ret = -1;
 899
 900         if (arr == NULL || start >= arr->len) {
 901                 rte_errno = EINVAL;
 902                 return -1;
 903         }
 904
 905         /* prevent array from changing under us */
 906         rte_rwlock_read_lock(&arr->rwlock);
 907
 908         /* cheap checks to prevent doing useless work */
 909         if (!used) {
 910                 if (arr->len == arr->count) {
 911                         rte_errno = ENOSPC;
 912                         goto out;
 913                 }
 914                 if (arr->count == 0) {
 915                         ret = start;
 916                         goto out;
 917                 }
 918         } else {
 919                 if (arr->count == 0) {
 920                         rte_errno = ENOENT;
 921                         goto out;
 922                 }
 923                 if (arr->len == arr->count) {
 924                         ret = start;
 925                         goto out;
 926                 }
 927         }
 928         if (next)
 929                 ret = find_next(arr, start, used);
 930         else
 931                 ret = find_prev(arr, start, used);
 932 out:
 933         rte_rwlock_read_unlock(&arr->rwlock);
 934         return ret;
 935 }
 936
 937 int __rte_experimental
 938 rte_fbarray_find_next_free(struct rte_fbarray *arr, unsigned int start)
 939 {
 940         return fbarray_find(arr, start, true, false);
 941 }
 942
 943 int __rte_experimental
 944 rte_fbarray_find_next_used(struct rte_fbarray *arr, unsigned int start)
 945 {
 946         return fbarray_find(arr, start, true, true);
 947 }
 948
 949 int __rte_experimental
 950 rte_fbarray_find_prev_free(struct rte_fbarray *arr, unsigned int start)
 951 {
 952         return fbarray_find(arr, start, false, false);
 953 }
 954
 955 int __rte_experimental
 956 rte_fbarray_find_prev_used(struct rte_fbarray *arr, unsigned int start)
 957 {
 958         return fbarray_find(arr, start, false, true);
 959 }
 960
 961 static int
 962 fbarray_find_n(struct rte_fbarray *arr, unsigned int start, unsigned int n,
 963                 bool next, bool used)
 964 {
 965         int ret = -1;
 966
 967         if (arr == NULL || start >= arr->len || n > arr->len || n == 0) {
 968                 rte_errno = EINVAL;
 969                 return -1;
 970         }
 971         if (next && (arr->len - start) < n) {
 972                 rte_errno = used ? ENOENT : ENOSPC;
 973                 return -1;
 974         }
 975         if (!next && start < (n - 1)) {
 976                 rte_errno = used ? ENOENT : ENOSPC;
 977                 return -1;
 978         }
 979
 980         /* prevent array from changing under us */
 981         rte_rwlock_read_lock(&arr->rwlock);
 982
 983         /* cheap checks to prevent doing useless work */
 984         if (!used) {
 985                 if (arr->len == arr->count || arr->len - arr->count < n) {
 986                         rte_errno = ENOSPC;
 987                         goto out;
 988                 }
 989                 if (arr->count == 0) {
 990                         ret = next ? start : start - n + 1;
 991                         goto out;
 992                 }
 993         } else {
 994                 if (arr->count < n) {
 995                         rte_errno = ENOENT;
 996                         goto out;
 997                 }
 998                 if (arr->count == arr->len) {
 999                         ret = next ? start : start - n + 1;
1000                         goto out;
1001                 }
1002         }
1003
1004         if (next)
1005                 ret = find_next_n(arr, start, n, used);
1006         else
1007                 ret = find_prev_n(arr, start, n, used);
1008 out:
1009         rte_rwlock_read_unlock(&arr->rwlock);
1010         return ret;
1011 }
1012
1013 int __rte_experimental
1014 rte_fbarray_find_next_n_free(struct rte_fbarray *arr, unsigned int start,
1015                 unsigned int n)
1016 {
1017         return fbarray_find_n(arr, start, n, true, false);
1018 }
1019
1020 int __rte_experimental
1021 rte_fbarray_find_next_n_used(struct rte_fbarray *arr, unsigned int start,
1022                 unsigned int n)
1023 {
1024         return fbarray_find_n(arr, start, n, true, true);
1025 }
1026
1027 int __rte_experimental
1028 rte_fbarray_find_prev_n_free(struct rte_fbarray *arr, unsigned int start,
1029                 unsigned int n)
1030 {
1031         return fbarray_find_n(arr, start, n, false, false);
1032 }
1033
1034 int __rte_experimental
1035 rte_fbarray_find_prev_n_used(struct rte_fbarray *arr, unsigned int start,
1036                 unsigned int n)
1037 {
1038         return fbarray_find_n(arr, start, n, false, true);
1039 }
1040
1041 static int
1042 fbarray_find_contig(struct rte_fbarray *arr, unsigned int start, bool used)
1043 {
1044         int ret = -1;
1045
1046         if (arr == NULL || start >= arr->len) {
1047                 rte_errno = EINVAL;
1048                 return -1;
1049         }
1050
1051         /* prevent array from changing under us */
1052         rte_rwlock_read_lock(&arr->rwlock);
1053
1054         /* cheap checks to prevent doing useless work */
1055         if (used) {
1056                 if (arr->count == 0) {
1057                         ret = 0;
1058                         goto out;
1059                 }
1060                 if (arr->len == arr->count) {
1061                         ret = arr->len - start;
1062                         goto out;
1063                 }
1064         } else {
1065                 if (arr->len == arr->count) {
1066                         ret = 0;
1067                         goto out;
1068                 }
1069                 if (arr->count == 0) {
1070                         ret = arr->len - start;
1071                         goto out;
1072                 }
1073         }
1074
1075         ret = find_contig(arr, start, false);
1076 out:
1077         rte_rwlock_read_unlock(&arr->rwlock);
1078         return ret;
1079 }
1080
1081 int __rte_experimental
1082 rte_fbarray_find_contig_free(struct rte_fbarray *arr, unsigned int start)
1083 {
1084         return fbarray_find_contig(arr, start, false);
1085 }
1086
1087 int __rte_experimental
1088 rte_fbarray_find_contig_used(struct rte_fbarray *arr, unsigned int start)
1089 {
1090         return fbarray_find_contig(arr, start, true);
1091 }
1092
1093 int __rte_experimental
1094 rte_fbarray_find_idx(const struct rte_fbarray *arr, const void *elt)
1095 {
1096         void *end;
1097         int ret = -1;
1098
1099         /*
1100          * no need to synchronize as it doesn't matter if underlying data
1101          * changes - we're doing pointer arithmetic here.
1102          */
1103
1104         if (arr == NULL || elt == NULL) {
1105                 rte_errno = EINVAL;
1106                 return -1;
1107         }
1108         end = RTE_PTR_ADD(arr->data, arr->elt_sz * arr->len);
1109         if (elt < arr->data || elt >= end) {
1110                 rte_errno = EINVAL;
1111                 return -1;
1112         }
1113
1114         ret = RTE_PTR_DIFF(elt, arr->data) / arr->elt_sz;
1115
1116         return ret;
1117 }
1118
1119 void __rte_experimental
1120 rte_fbarray_dump_metadata(struct rte_fbarray *arr, FILE *f)
1121 {
1122         struct used_mask *msk;
1123         unsigned int i;
1124
1125         if (arr == NULL || f == NULL) {
1126                 rte_errno = EINVAL;
1127                 return;
1128         }
1129
1130         if (fully_validate(arr->name, arr->elt_sz, arr->len)) {
1131                 fprintf(f, "Invalid file-backed array\n");
1132                 goto out;
1133         }
1134
1135         /* prevent array from changing under us */
1136         rte_rwlock_read_lock(&arr->rwlock);
1137
1138         fprintf(f, "File-backed array: %s\n", arr->name);
1139         fprintf(f, "size: %i occupied: %i elt_sz: %i\n",
1140                         arr->len, arr->count, arr->elt_sz);
1141
1142         msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
1143
1144         for (i = 0; i < msk->n_masks; i++)
1145                 fprintf(f, "msk idx %i: 0x%016" PRIx64 "\n", i, msk->data[i]);
1146 out:
1147         rte_rwlock_read_unlock(&arr->rwlock);
1148 }