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 find_rev_contig(const struct rte_fbarray *arr, unsigned int start, bool used)
 574 {
 575         const struct used_mask *msk = get_used_mask(arr->data, arr->elt_sz,
 576                         arr->len);
 577         unsigned int idx, first, first_mod;
 578         unsigned int need_len, result = 0;
 579
 580         first = MASK_LEN_TO_IDX(start);
 581         first_mod = MASK_LEN_TO_MOD(start);
 582
 583         /* go backwards, include zero */
 584         idx = first;
 585         do {
 586                 uint64_t cur = msk->data[idx];
 587                 unsigned int run_len;
 588
 589                 need_len = MASK_ALIGN;
 590
 591                 /* if we're looking for free entries, invert mask */
 592                 if (!used)
 593                         cur = ~cur;
 594
 595                 /* ignore everything after start on first iteration */
 596                 if (idx == first) {
 597                         unsigned int end_len = MASK_ALIGN - first_mod - 1;
 598                         cur <<= end_len;
 599                         /* at the start, we don't need the full mask len */
 600                         need_len -= end_len;
 601                 }
 602
 603                 /* we will be looking for zeroes, so invert the mask */
 604                 cur = ~cur;
 605
 606                 /* if mask is zero, we have a complete run */
 607                 if (cur == 0)
 608                         goto endloop;
 609
 610                 /*
 611                  * see where run ends, starting from the end.
 612                  */
 613                 run_len = __builtin_clzll(cur);
 614
 615                 /* add however many zeroes we've had in the last run and quit */
 616                 if (run_len < need_len) {
 617                         result += run_len;
 618                         break;
 619                 }
 620 endloop:
 621                 result += need_len;
 622         } while (idx-- != 0); /* decrement after check to include zero */
 623         return result;
 624 }
 625
 626 static int
 627 set_used(struct rte_fbarray *arr, unsigned int idx, bool used)
 628 {
 629         struct used_mask *msk;
 630         uint64_t msk_bit = 1ULL << MASK_LEN_TO_MOD(idx);
 631         unsigned int msk_idx = MASK_LEN_TO_IDX(idx);
 632         bool already_used;
 633         int ret = -1;
 634
 635         if (arr == NULL || idx >= arr->len) {
 636                 rte_errno = EINVAL;
 637                 return -1;
 638         }
 639         msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
 640         ret = 0;
 641
 642         /* prevent array from changing under us */
 643         rte_rwlock_write_lock(&arr->rwlock);
 644
 645         already_used = (msk->data[msk_idx] & msk_bit) != 0;
 646
 647         /* nothing to be done */
 648         if (used == already_used)
 649                 goto out;
 650
 651         if (used) {
 652                 msk->data[msk_idx] |= msk_bit;
 653                 arr->count++;
 654         } else {
 655                 msk->data[msk_idx] &= ~msk_bit;
 656                 arr->count--;
 657         }
 658 out:
 659         rte_rwlock_write_unlock(&arr->rwlock);
 660
 661         return ret;
 662 }
 663
 664 static int
 665 fully_validate(const char *name, unsigned int elt_sz, unsigned int len)
 666 {
 667         if (name == NULL || elt_sz == 0 || len == 0 || len > INT_MAX) {
 668                 rte_errno = EINVAL;
 669                 return -1;
 670         }
 671
 672         if (strnlen(name, RTE_FBARRAY_NAME_LEN) == RTE_FBARRAY_NAME_LEN) {
 673                 rte_errno = ENAMETOOLONG;
 674                 return -1;
 675         }
 676         return 0;
 677 }
 678
 679 int __rte_experimental
 680 rte_fbarray_init(struct rte_fbarray *arr, const char *name, unsigned int len,
 681                 unsigned int elt_sz)
 682 {
 683         size_t page_sz, mmap_len;
 684         char path[PATH_MAX];
 685         struct used_mask *msk;
 686         void *data = NULL;
 687         int fd = -1;
 688
 689         if (arr == NULL) {
 690                 rte_errno = EINVAL;
 691                 return -1;
 692         }
 693
 694         if (fully_validate(name, elt_sz, len))
 695                 return -1;
 696
 697         page_sz = sysconf(_SC_PAGESIZE);
 698         if (page_sz == (size_t)-1)
 699                 goto fail;
 700
 701         /* calculate our memory limits */
 702         mmap_len = calc_data_size(page_sz, elt_sz, len);
 703
 704         data = eal_get_virtual_area(NULL, &mmap_len, page_sz, 0, 0);
 705         if (data == NULL)
 706                 goto fail;
 707
 708         eal_get_fbarray_path(path, sizeof(path), name);
 709
 710         /*
 711          * Each fbarray is unique to process namespace, i.e. the filename
 712          * depends on process prefix. Try to take out a lock and see if we
 713          * succeed. If we don't, someone else is using it already.
 714          */
 715         fd = open(path, O_CREAT | O_RDWR, 0600);
 716         if (fd < 0) {
 717                 RTE_LOG(DEBUG, EAL, "%s(): couldn't open %s: %s\n", __func__,
 718                                 path, strerror(errno));
 719                 rte_errno = errno;
 720                 goto fail;
 721         } else if (flock(fd, LOCK_EX | LOCK_NB)) {
 722                 RTE_LOG(DEBUG, EAL, "%s(): couldn't lock %s: %s\n", __func__,
 723                                 path, strerror(errno));
 724                 rte_errno = EBUSY;
 725                 goto fail;
 726         }
 727
 728         /* take out a non-exclusive lock, so that other processes could still
 729          * attach to it, but no other process could reinitialize it.
 730          */
 731         if (flock(fd, LOCK_SH | LOCK_NB)) {
 732                 rte_errno = errno;
 733                 goto fail;
 734         }
 735
 736         if (resize_and_map(fd, data, mmap_len))
 737                 goto fail;
 738
 739         /* we've mmap'ed the file, we can now close the fd */
 740         close(fd);
 741
 742         /* initialize the data */
 743         memset(data, 0, mmap_len);
 744
 745         /* populate data structure */
 746         strlcpy(arr->name, name, sizeof(arr->name));
 747         arr->data = data;
 748         arr->len = len;
 749         arr->elt_sz = elt_sz;
 750         arr->count = 0;
 751
 752         msk = get_used_mask(data, elt_sz, len);
 753         msk->n_masks = MASK_LEN_TO_IDX(RTE_ALIGN_CEIL(len, MASK_ALIGN));
 754
 755         rte_rwlock_init(&arr->rwlock);
 756
 757         return 0;
 758 fail:
 759         if (data)
 760                 munmap(data, mmap_len);
 761         if (fd >= 0)
 762                 close(fd);
 763         return -1;
 764 }
 765
 766 int __rte_experimental
 767 rte_fbarray_attach(struct rte_fbarray *arr)
 768 {
 769         size_t page_sz, mmap_len;
 770         char path[PATH_MAX];
 771         void *data = NULL;
 772         int fd = -1;
 773
 774         if (arr == NULL) {
 775                 rte_errno = EINVAL;
 776                 return -1;
 777         }
 778
 779         /*
 780          * we don't need to synchronize attach as two values we need (element
 781          * size and array length) are constant for the duration of life of
 782          * the array, so the parts we care about will not race.
 783          */
 784
 785         if (fully_validate(arr->name, arr->elt_sz, arr->len))
 786                 return -1;
 787
 788         page_sz = sysconf(_SC_PAGESIZE);
 789         if (page_sz == (size_t)-1)
 790                 goto fail;
 791
 792         mmap_len = calc_data_size(page_sz, arr->elt_sz, arr->len);
 793
 794         data = eal_get_virtual_area(arr->data, &mmap_len, page_sz, 0, 0);
 795         if (data == NULL)
 796                 goto fail;
 797
 798         eal_get_fbarray_path(path, sizeof(path), arr->name);
 799
 800         fd = open(path, O_RDWR);
 801         if (fd < 0) {
 802                 rte_errno = errno;
 803                 goto fail;
 804         }
 805
 806         /* lock the file, to let others know we're using it */
 807         if (flock(fd, LOCK_SH | LOCK_NB)) {
 808                 rte_errno = errno;
 809                 goto fail;
 810         }
 811
 812         if (resize_and_map(fd, data, mmap_len))
 813                 goto fail;
 814
 815         close(fd);
 816
 817         /* we're done */
 818
 819         return 0;
 820 fail:
 821         if (data)
 822                 munmap(data, mmap_len);
 823         if (fd >= 0)
 824                 close(fd);
 825         return -1;
 826 }
 827
 828 int __rte_experimental
 829 rte_fbarray_detach(struct rte_fbarray *arr)
 830 {
 831         if (arr == NULL) {
 832                 rte_errno = EINVAL;
 833                 return -1;
 834         }
 835
 836         /*
 837          * we don't need to synchronize detach as two values we need (element
 838          * size and total capacity) are constant for the duration of life of
 839          * the array, so the parts we care about will not race. if the user is
 840          * detaching while doing something else in the same process, we can't
 841          * really do anything about it, things will blow up either way.
 842          */
 843
 844         size_t page_sz = sysconf(_SC_PAGESIZE);
 845
 846         if (page_sz == (size_t)-1)
 847                 return -1;
 848
 849         /* this may already be unmapped (e.g. repeated call from previously
 850          * failed destroy(), but this is on user, we can't (easily) know if this
 851          * is still mapped.
 852          */
 853         munmap(arr->data, calc_data_size(page_sz, arr->elt_sz, arr->len));
 854
 855         return 0;
 856 }
 857
 858 int __rte_experimental
 859 rte_fbarray_destroy(struct rte_fbarray *arr)
 860 {
 861         int fd, ret;
 862         char path[PATH_MAX];
 863
 864         ret = rte_fbarray_detach(arr);
 865         if (ret)
 866                 return ret;
 867
 868         /* try deleting the file */
 869         eal_get_fbarray_path(path, sizeof(path), arr->name);
 870
 871         fd = open(path, O_RDONLY);
 872         if (fd < 0) {
 873                 RTE_LOG(ERR, EAL, "Could not open fbarray file: %s\n",
 874                         strerror(errno));
 875                 return -1;
 876         }
 877         if (flock(fd, LOCK_EX | LOCK_NB)) {
 878                 RTE_LOG(DEBUG, EAL, "Cannot destroy fbarray - another process is using it\n");
 879                 rte_errno = EBUSY;
 880                 ret = -1;
 881         } else {
 882                 ret = 0;
 883                 unlink(path);
 884                 memset(arr, 0, sizeof(*arr));
 885         }
 886         close(fd);
 887
 888         return ret;
 889 }
 890
 891 void * __rte_experimental
 892 rte_fbarray_get(const struct rte_fbarray *arr, unsigned int idx)
 893 {
 894         void *ret = NULL;
 895         if (arr == NULL) {
 896                 rte_errno = EINVAL;
 897                 return NULL;
 898         }
 899
 900         if (idx >= arr->len) {
 901                 rte_errno = EINVAL;
 902                 return NULL;
 903         }
 904
 905         ret = RTE_PTR_ADD(arr->data, idx * arr->elt_sz);
 906
 907         return ret;
 908 }
 909
 910 int __rte_experimental
 911 rte_fbarray_set_used(struct rte_fbarray *arr, unsigned int idx)
 912 {
 913         return set_used(arr, idx, true);
 914 }
 915
 916 int __rte_experimental
 917 rte_fbarray_set_free(struct rte_fbarray *arr, unsigned int idx)
 918 {
 919         return set_used(arr, idx, false);
 920 }
 921
 922 int __rte_experimental
 923 rte_fbarray_is_used(struct rte_fbarray *arr, unsigned int idx)
 924 {
 925         struct used_mask *msk;
 926         int msk_idx;
 927         uint64_t msk_bit;
 928         int ret = -1;
 929
 930         if (arr == NULL || idx >= arr->len) {
 931                 rte_errno = EINVAL;
 932                 return -1;
 933         }
 934
 935         /* prevent array from changing under us */
 936         rte_rwlock_read_lock(&arr->rwlock);
 937
 938         msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
 939         msk_idx = MASK_LEN_TO_IDX(idx);
 940         msk_bit = 1ULL << MASK_LEN_TO_MOD(idx);
 941
 942         ret = (msk->data[msk_idx] & msk_bit) != 0;
 943
 944         rte_rwlock_read_unlock(&arr->rwlock);
 945
 946         return ret;
 947 }
 948
 949 static int
 950 fbarray_find(struct rte_fbarray *arr, unsigned int start, bool next, bool used)
 951 {
 952         int ret = -1;
 953
 954         if (arr == NULL || start >= arr->len) {
 955                 rte_errno = EINVAL;
 956                 return -1;
 957         }
 958
 959         /* prevent array from changing under us */
 960         rte_rwlock_read_lock(&arr->rwlock);
 961
 962         /* cheap checks to prevent doing useless work */
 963         if (!used) {
 964                 if (arr->len == arr->count) {
 965                         rte_errno = ENOSPC;
 966                         goto out;
 967                 }
 968                 if (arr->count == 0) {
 969                         ret = start;
 970                         goto out;
 971                 }
 972         } else {
 973                 if (arr->count == 0) {
 974                         rte_errno = ENOENT;
 975                         goto out;
 976                 }
 977                 if (arr->len == arr->count) {
 978                         ret = start;
 979                         goto out;
 980                 }
 981         }
 982         if (next)
 983                 ret = find_next(arr, start, used);
 984         else
 985                 ret = find_prev(arr, start, used);
 986 out:
 987         rte_rwlock_read_unlock(&arr->rwlock);
 988         return ret;
 989 }
 990
 991 int __rte_experimental
 992 rte_fbarray_find_next_free(struct rte_fbarray *arr, unsigned int start)
 993 {
 994         return fbarray_find(arr, start, true, false);
 995 }
 996
 997 int __rte_experimental
 998 rte_fbarray_find_next_used(struct rte_fbarray *arr, unsigned int start)
 999 {
1000         return fbarray_find(arr, start, true, true);
1001 }
1002
1003 int __rte_experimental
1004 rte_fbarray_find_prev_free(struct rte_fbarray *arr, unsigned int start)
1005 {
1006         return fbarray_find(arr, start, false, false);
1007 }
1008
1009 int __rte_experimental
1010 rte_fbarray_find_prev_used(struct rte_fbarray *arr, unsigned int start)
1011 {
1012         return fbarray_find(arr, start, false, true);
1013 }
1014
1015 static int
1016 fbarray_find_n(struct rte_fbarray *arr, unsigned int start, unsigned int n,
1017                 bool next, bool used)
1018 {
1019         int ret = -1;
1020
1021         if (arr == NULL || start >= arr->len || n > arr->len || n == 0) {
1022                 rte_errno = EINVAL;
1023                 return -1;
1024         }
1025         if (next && (arr->len - start) < n) {
1026                 rte_errno = used ? ENOENT : ENOSPC;
1027                 return -1;
1028         }
1029         if (!next && start < (n - 1)) {
1030                 rte_errno = used ? ENOENT : ENOSPC;
1031                 return -1;
1032         }
1033
1034         /* prevent array from changing under us */
1035         rte_rwlock_read_lock(&arr->rwlock);
1036
1037         /* cheap checks to prevent doing useless work */
1038         if (!used) {
1039                 if (arr->len == arr->count || arr->len - arr->count < n) {
1040                         rte_errno = ENOSPC;
1041                         goto out;
1042                 }
1043                 if (arr->count == 0) {
1044                         ret = next ? start : start - n + 1;
1045                         goto out;
1046                 }
1047         } else {
1048                 if (arr->count < n) {
1049                         rte_errno = ENOENT;
1050                         goto out;
1051                 }
1052                 if (arr->count == arr->len) {
1053                         ret = next ? start : start - n + 1;
1054                         goto out;
1055                 }
1056         }
1057
1058         if (next)
1059                 ret = find_next_n(arr, start, n, used);
1060         else
1061                 ret = find_prev_n(arr, start, n, used);
1062 out:
1063         rte_rwlock_read_unlock(&arr->rwlock);
1064         return ret;
1065 }
1066
1067 int __rte_experimental
1068 rte_fbarray_find_next_n_free(struct rte_fbarray *arr, unsigned int start,
1069                 unsigned int n)
1070 {
1071         return fbarray_find_n(arr, start, n, true, false);
1072 }
1073
1074 int __rte_experimental
1075 rte_fbarray_find_next_n_used(struct rte_fbarray *arr, unsigned int start,
1076                 unsigned int n)
1077 {
1078         return fbarray_find_n(arr, start, n, true, true);
1079 }
1080
1081 int __rte_experimental
1082 rte_fbarray_find_prev_n_free(struct rte_fbarray *arr, unsigned int start,
1083                 unsigned int n)
1084 {
1085         return fbarray_find_n(arr, start, n, false, false);
1086 }
1087
1088 int __rte_experimental
1089 rte_fbarray_find_prev_n_used(struct rte_fbarray *arr, unsigned int start,
1090                 unsigned int n)
1091 {
1092         return fbarray_find_n(arr, start, n, false, true);
1093 }
1094
1095 static int
1096 fbarray_find_contig(struct rte_fbarray *arr, unsigned int start, bool next,
1097                 bool used)
1098 {
1099         int ret = -1;
1100
1101         if (arr == NULL || start >= arr->len) {
1102                 rte_errno = EINVAL;
1103                 return -1;
1104         }
1105
1106         /* prevent array from changing under us */
1107         rte_rwlock_read_lock(&arr->rwlock);
1108
1109         /* cheap checks to prevent doing useless work */
1110         if (used) {
1111                 if (arr->count == 0) {
1112                         ret = 0;
1113                         goto out;
1114                 }
1115                 if (next && arr->count == arr->len) {
1116                         ret = arr->len - start;
1117                         goto out;
1118                 }
1119                 if (!next && arr->count == arr->len) {
1120                         ret = start + 1;
1121                         goto out;
1122                 }
1123         } else {
1124                 if (arr->len == arr->count) {
1125                         ret = 0;
1126                         goto out;
1127                 }
1128                 if (next && arr->count == 0) {
1129                         ret = arr->len - start;
1130                         goto out;
1131                 }
1132                 if (!next && arr->count == 0) {
1133                         ret = start + 1;
1134                         goto out;
1135                 }
1136         }
1137
1138         if (next)
1139                 ret = find_contig(arr, start, used);
1140         else
1141                 ret = find_rev_contig(arr, start, used);
1142 out:
1143         rte_rwlock_read_unlock(&arr->rwlock);
1144         return ret;
1145 }
1146
1147 int __rte_experimental
1148 rte_fbarray_find_contig_free(struct rte_fbarray *arr, unsigned int start)
1149 {
1150         return fbarray_find_contig(arr, start, true, false);
1151 }
1152
1153 int __rte_experimental
1154 rte_fbarray_find_contig_used(struct rte_fbarray *arr, unsigned int start)
1155 {
1156         return fbarray_find_contig(arr, start, true, true);
1157 }
1158
1159 int __rte_experimental
1160 rte_fbarray_find_rev_contig_free(struct rte_fbarray *arr, unsigned int start)
1161 {
1162         return fbarray_find_contig(arr, start, false, false);
1163 }
1164
1165 int __rte_experimental
1166 rte_fbarray_find_rev_contig_used(struct rte_fbarray *arr, unsigned int start)
1167 {
1168         return fbarray_find_contig(arr, start, false, true);
1169 }
1170
1171 int __rte_experimental
1172 rte_fbarray_find_idx(const struct rte_fbarray *arr, const void *elt)
1173 {
1174         void *end;
1175         int ret = -1;
1176
1177         /*
1178          * no need to synchronize as it doesn't matter if underlying data
1179          * changes - we're doing pointer arithmetic here.
1180          */
1181
1182         if (arr == NULL || elt == NULL) {
1183                 rte_errno = EINVAL;
1184                 return -1;
1185         }
1186         end = RTE_PTR_ADD(arr->data, arr->elt_sz * arr->len);
1187         if (elt < arr->data || elt >= end) {
1188                 rte_errno = EINVAL;
1189                 return -1;
1190         }
1191
1192         ret = RTE_PTR_DIFF(elt, arr->data) / arr->elt_sz;
1193
1194         return ret;
1195 }
1196
1197 void __rte_experimental
1198 rte_fbarray_dump_metadata(struct rte_fbarray *arr, FILE *f)
1199 {
1200         struct used_mask *msk;
1201         unsigned int i;
1202
1203         if (arr == NULL || f == NULL) {
1204                 rte_errno = EINVAL;
1205                 return;
1206         }
1207
1208         if (fully_validate(arr->name, arr->elt_sz, arr->len)) {
1209                 fprintf(f, "Invalid file-backed array\n");
1210                 goto out;
1211         }
1212
1213         /* prevent array from changing under us */
1214         rte_rwlock_read_lock(&arr->rwlock);
1215
1216         fprintf(f, "File-backed array: %s\n", arr->name);
1217         fprintf(f, "size: %i occupied: %i elt_sz: %i\n",
1218                         arr->len, arr->count, arr->elt_sz);
1219
1220         msk = get_used_mask(arr->data, arr->elt_sz, arr->len);
1221
1222         for (i = 0; i < msk->n_masks; i++)
1223                 fprintf(f, "msk idx %i: 0x%016" PRIx64 "\n", i, msk->data[i]);
1224 out:
1225         rte_rwlock_read_unlock(&arr->rwlock);
1226 }