drivers/iommu/iova.c

   1 /*
   2  * Copyright © 2006-2009, Intel Corporation.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms and conditions of the GNU General Public License,
   6  * version 2, as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
  15  * Place - Suite 330, Boston, MA 02111-1307 USA.
  16  *
  17  * Author: Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>
  18  */
  19
  20 #include <linux/iova.h>
  21 #include <linux/module.h>
  22 #include <linux/slab.h>
  23 #include <linux/smp.h>
  24 #include <linux/bitops.h>
  25 #include <linux/cpu.h>
  26
  27 /* The anchor node sits above the top of the usable address space */
  28 #define IOVA_ANCHOR     ~0UL
  29
  30 static bool iova_rcache_insert(struct iova_domain *iovad,
  31                                unsigned long pfn,
  32                                unsigned long size);
  33 static unsigned long iova_rcache_get(struct iova_domain *iovad,
  34                                      unsigned long size,
  35                                      unsigned long limit_pfn);
  36 static void init_iova_rcaches(struct iova_domain *iovad);
  37 static void free_iova_rcaches(struct iova_domain *iovad);
  38 static void fq_destroy_all_entries(struct iova_domain *iovad);
  39 static void fq_flush_timeout(unsigned long data);
  40
  41 void
  42 init_iova_domain(struct iova_domain *iovad, unsigned long granule,
  43         unsigned long start_pfn)
  44 {
  45         /*
  46          * IOVA granularity will normally be equal to the smallest
  47          * supported IOMMU page size; both *must* be capable of
  48          * representing individual CPU pages exactly.
  49          */
  50         BUG_ON((granule > PAGE_SIZE) || !is_power_of_2(granule));
  51
  52         spin_lock_init(&iovad->iova_rbtree_lock);
  53         iovad->rbroot = RB_ROOT;
  54         iovad->cached_node = &iovad->anchor.node;
  55         iovad->cached32_node = &iovad->anchor.node;
  56         iovad->granule = granule;
  57         iovad->start_pfn = start_pfn;
  58         iovad->dma_32bit_pfn = 1UL << (32 - iova_shift(iovad));
  59         iovad->flush_cb = NULL;
  60         iovad->fq = NULL;
  61         iovad->anchor.pfn_lo = iovad->anchor.pfn_hi = IOVA_ANCHOR;
  62         rb_link_node(&iovad->anchor.node, NULL, &iovad->rbroot.rb_node);
  63         rb_insert_color(&iovad->anchor.node, &iovad->rbroot);
  64         init_iova_rcaches(iovad);
  65 }
  66 EXPORT_SYMBOL_GPL(init_iova_domain);
  67
  68 static void free_iova_flush_queue(struct iova_domain *iovad)
  69 {
  70         if (!iovad->fq)
  71                 return;
  72
  73         if (timer_pending(&iovad->fq_timer))
  74                 del_timer(&iovad->fq_timer);
  75
  76         fq_destroy_all_entries(iovad);
  77
  78         free_percpu(iovad->fq);
  79
  80         iovad->fq         = NULL;
  81         iovad->flush_cb   = NULL;
  82         iovad->entry_dtor = NULL;
  83 }
  84
  85 int init_iova_flush_queue(struct iova_domain *iovad,
  86                           iova_flush_cb flush_cb, iova_entry_dtor entry_dtor)
  87 {
  88         int cpu;
  89
  90         atomic64_set(&iovad->fq_flush_start_cnt,  0);
  91         atomic64_set(&iovad->fq_flush_finish_cnt, 0);
  92
  93         iovad->fq = alloc_percpu(struct iova_fq);
  94         if (!iovad->fq)
  95                 return -ENOMEM;
  96
  97         iovad->flush_cb   = flush_cb;
  98         iovad->entry_dtor = entry_dtor;
  99
 100         for_each_possible_cpu(cpu) {
 101                 struct iova_fq *fq;
 102
 103                 fq = per_cpu_ptr(iovad->fq, cpu);
 104                 fq->head = 0;
 105                 fq->tail = 0;
 106
 107                 spin_lock_init(&fq->lock);
 108         }
 109
 110         setup_timer(&iovad->fq_timer, fq_flush_timeout, (unsigned long)iovad);
 111         atomic_set(&iovad->fq_timer_on, 0);
 112
 113         return 0;
 114 }
 115 EXPORT_SYMBOL_GPL(init_iova_flush_queue);
 116
 117 static struct rb_node *
 118 __get_cached_rbnode(struct iova_domain *iovad, unsigned long limit_pfn)
 119 {
 120         if (limit_pfn <= iovad->dma_32bit_pfn)
 121                 return iovad->cached32_node;
 122
 123         return iovad->cached_node;
 124 }
 125
 126 static void
 127 __cached_rbnode_insert_update(struct iova_domain *iovad, struct iova *new)
 128 {
 129         if (new->pfn_hi < iovad->dma_32bit_pfn)
 130                 iovad->cached32_node = &new->node;
 131         else
 132                 iovad->cached_node = &new->node;
 133 }
 134
 135 static void
 136 __cached_rbnode_delete_update(struct iova_domain *iovad, struct iova *free)
 137 {
 138         struct iova *cached_iova;
 139
 140         cached_iova = rb_entry(iovad->cached32_node, struct iova, node);
 141         if (free->pfn_hi < iovad->dma_32bit_pfn &&
 142             free->pfn_lo >= cached_iova->pfn_lo)
 143                 iovad->cached32_node = rb_next(&free->node);
 144
 145         cached_iova = rb_entry(iovad->cached_node, struct iova, node);
 146         if (free->pfn_lo >= cached_iova->pfn_lo)
 147                 iovad->cached_node = rb_next(&free->node);
 148 }
 149
 150 /* Insert the iova into domain rbtree by holding writer lock */
 151 static void
 152 iova_insert_rbtree(struct rb_root *root, struct iova *iova,
 153                    struct rb_node *start)
 154 {
 155         struct rb_node **new, *parent = NULL;
 156
 157         new = (start) ? &start : &(root->rb_node);
 158         /* Figure out where to put new node */
 159         while (*new) {
 160                 struct iova *this = rb_entry(*new, struct iova, node);
 161
 162                 parent = *new;
 163
 164                 if (iova->pfn_lo < this->pfn_lo)
 165                         new = &((*new)->rb_left);
 166                 else if (iova->pfn_lo > this->pfn_lo)
 167                         new = &((*new)->rb_right);
 168                 else {
 169                         WARN_ON(1); /* this should not happen */
 170                         return;
 171                 }
 172         }
 173         /* Add new node and rebalance tree. */
 174         rb_link_node(&iova->node, parent, new);
 175         rb_insert_color(&iova->node, root);
 176 }
 177
 178 static int __alloc_and_insert_iova_range(struct iova_domain *iovad,
 179                 unsigned long size, unsigned long limit_pfn,
 180                         struct iova *new, bool size_aligned)
 181 {
 182         struct rb_node *curr, *prev;
 183         struct iova *curr_iova;
 184         unsigned long flags;
 185         unsigned long new_pfn;
 186         unsigned long align_mask = ~0UL;
 187
 188         if (size_aligned)
 189                 align_mask <<= fls_long(size - 1);
 190
 191         /* Walk the tree backwards */
 192         spin_lock_irqsave(&iovad->iova_rbtree_lock, flags);
 193         curr = __get_cached_rbnode(iovad, limit_pfn);
 194         curr_iova = rb_entry(curr, struct iova, node);
 195         do {
 196                 limit_pfn = min(limit_pfn, curr_iova->pfn_lo);
 197                 new_pfn = (limit_pfn - size) & align_mask;
 198                 prev = curr;
 199                 curr = rb_prev(curr);
 200                 curr_iova = rb_entry(curr, struct iova, node);
 201         } while (curr && new_pfn <= curr_iova->pfn_hi);
 202
 203         if (limit_pfn < size || new_pfn < iovad->start_pfn) {
 204                 spin_unlock_irqrestore(&iovad->iova_rbtree_lock, flags);
 205                 return -ENOMEM;
 206         }
 207
 208         /* pfn_lo will point to size aligned address if size_aligned is set */
 209         new->pfn_lo = new_pfn;
 210         new->pfn_hi = new->pfn_lo + size - 1;
 211
 212         /* If we have 'prev', it's a valid place to start the insertion. */
 213         iova_insert_rbtree(&iovad->rbroot, new, prev);
 214         __cached_rbnode_insert_update(iovad, new);
 215
 216         spin_unlock_irqrestore(&iovad->iova_rbtree_lock, flags);
 217
 218
 219         return 0;
 220 }
 221
 222 static struct kmem_cache *iova_cache;
 223 static unsigned int iova_cache_users;
 224 static DEFINE_MUTEX(iova_cache_mutex);
 225
 226 struct iova *alloc_iova_mem(void)
 227 {
 228         return kmem_cache_alloc(iova_cache, GFP_ATOMIC);
 229 }
 230 EXPORT_SYMBOL(alloc_iova_mem);
 231
 232 void free_iova_mem(struct iova *iova)
 233 {
 234         if (iova->pfn_lo != IOVA_ANCHOR)
 235                 kmem_cache_free(iova_cache, iova);
 236 }
 237 EXPORT_SYMBOL(free_iova_mem);
 238
 239 int iova_cache_get(void)
 240 {
 241         mutex_lock(&iova_cache_mutex);
 242         if (!iova_cache_users) {
 243                 iova_cache = kmem_cache_create(
 244                         "iommu_iova", sizeof(struct iova), 0,
 245                         SLAB_HWCACHE_ALIGN, NULL);
 246                 if (!iova_cache) {
 247                         mutex_unlock(&iova_cache_mutex);
 248                         printk(KERN_ERR "Couldn't create iova cache\n");
 249                         return -ENOMEM;
 250                 }
 251         }
 252
 253         iova_cache_users++;
 254         mutex_unlock(&iova_cache_mutex);
 255
 256         return 0;
 257 }
 258 EXPORT_SYMBOL_GPL(iova_cache_get);
 259
 260 void iova_cache_put(void)
 261 {
 262         mutex_lock(&iova_cache_mutex);
 263         if (WARN_ON(!iova_cache_users)) {
 264                 mutex_unlock(&iova_cache_mutex);
 265                 return;
 266         }
 267         iova_cache_users--;
 268         if (!iova_cache_users)
 269                 kmem_cache_destroy(iova_cache);
 270         mutex_unlock(&iova_cache_mutex);
 271 }
 272 EXPORT_SYMBOL_GPL(iova_cache_put);
 273
 274 /**
 275  * alloc_iova - allocates an iova
 276  * @iovad: - iova domain in question
 277  * @size: - size of page frames to allocate
 278  * @limit_pfn: - max limit address
 279  * @size_aligned: - set if size_aligned address range is required
 280  * This function allocates an iova in the range iovad->start_pfn to limit_pfn,
 281  * searching top-down from limit_pfn to iovad->start_pfn. If the size_aligned
 282  * flag is set then the allocated address iova->pfn_lo will be naturally
 283  * aligned on roundup_power_of_two(size).
 284  */
 285 struct iova *
 286 alloc_iova(struct iova_domain *iovad, unsigned long size,
 287         unsigned long limit_pfn,
 288         bool size_aligned)
 289 {
 290         struct iova *new_iova;
 291         int ret;
 292
 293         new_iova = alloc_iova_mem();
 294         if (!new_iova)
 295                 return NULL;
 296
 297         ret = __alloc_and_insert_iova_range(iovad, size, limit_pfn + 1,
 298                         new_iova, size_aligned);
 299
 300         if (ret) {
 301                 free_iova_mem(new_iova);
 302                 return NULL;
 303         }
 304
 305         return new_iova;
 306 }
 307 EXPORT_SYMBOL_GPL(alloc_iova);
 308
 309 static struct iova *
 310 private_find_iova(struct iova_domain *iovad, unsigned long pfn)
 311 {
 312         struct rb_node *node = iovad->rbroot.rb_node;
 313
 314         assert_spin_locked(&iovad->iova_rbtree_lock);
 315
 316         while (node) {
 317                 struct iova *iova = rb_entry(node, struct iova, node);
 318
 319                 if (pfn < iova->pfn_lo)
 320                         node = node->rb_left;
 321                 else if (pfn > iova->pfn_hi)
 322                         node = node->rb_right;
 323                 else
 324                         return iova;    /* pfn falls within iova's range */
 325         }
 326
 327         return NULL;
 328 }
 329
 330 static void private_free_iova(struct iova_domain *iovad, struct iova *iova)
 331 {
 332         assert_spin_locked(&iovad->iova_rbtree_lock);
 333         __cached_rbnode_delete_update(iovad, iova);
 334         rb_erase(&iova->node, &iovad->rbroot);
 335         free_iova_mem(iova);
 336 }
 337
 338 /**
 339  * find_iova - finds an iova for a given pfn
 340  * @iovad: - iova domain in question.
 341  * @pfn: - page frame number
 342  * This function finds and returns an iova belonging to the
 343  * given doamin which matches the given pfn.
 344  */
 345 struct iova *find_iova(struct iova_domain *iovad, unsigned long pfn)
 346 {
 347         unsigned long flags;
 348         struct iova *iova;
 349
 350         /* Take the lock so that no other thread is manipulating the rbtree */
 351         spin_lock_irqsave(&iovad->iova_rbtree_lock, flags);
 352         iova = private_find_iova(iovad, pfn);
 353         spin_unlock_irqrestore(&iovad->iova_rbtree_lock, flags);
 354         return iova;
 355 }
 356 EXPORT_SYMBOL_GPL(find_iova);
 357
 358 /**
 359  * __free_iova - frees the given iova
 360  * @iovad: iova domain in question.
 361  * @iova: iova in question.
 362  * Frees the given iova belonging to the giving domain
 363  */
 364 void
 365 __free_iova(struct iova_domain *iovad, struct iova *iova)
 366 {
 367         unsigned long flags;
 368
 369         spin_lock_irqsave(&iovad->iova_rbtree_lock, flags);
 370         private_free_iova(iovad, iova);
 371         spin_unlock_irqrestore(&iovad->iova_rbtree_lock, flags);
 372 }
 373 EXPORT_SYMBOL_GPL(__free_iova);
 374
 375 /**
 376  * free_iova - finds and frees the iova for a given pfn
 377  * @iovad: - iova domain in question.
 378  * @pfn: - pfn that is allocated previously
 379  * This functions finds an iova for a given pfn and then
 380  * frees the iova from that domain.
 381  */
 382 void
 383 free_iova(struct iova_domain *iovad, unsigned long pfn)
 384 {
 385         struct iova *iova = find_iova(iovad, pfn);
 386
 387         if (iova)
 388                 __free_iova(iovad, iova);
 389
 390 }
 391 EXPORT_SYMBOL_GPL(free_iova);
 392
 393 /**
 394  * alloc_iova_fast - allocates an iova from rcache
 395  * @iovad: - iova domain in question
 396  * @size: - size of page frames to allocate
 397  * @limit_pfn: - max limit address
 398  * This function tries to satisfy an iova allocation from the rcache,
 399  * and falls back to regular allocation on failure.
 400 */
 401 unsigned long
 402 alloc_iova_fast(struct iova_domain *iovad, unsigned long size,
 403                 unsigned long limit_pfn)
 404 {
 405         bool flushed_rcache = false;
 406         unsigned long iova_pfn;
 407         struct iova *new_iova;
 408
 409         iova_pfn = iova_rcache_get(iovad, size, limit_pfn + 1);
 410         if (iova_pfn)
 411                 return iova_pfn;
 412
 413 retry:
 414         new_iova = alloc_iova(iovad, size, limit_pfn, true);
 415         if (!new_iova) {
 416                 unsigned int cpu;
 417
 418                 if (flushed_rcache)
 419                         return 0;
 420
 421                 /* Try replenishing IOVAs by flushing rcache. */
 422                 flushed_rcache = true;
 423                 for_each_online_cpu(cpu)
 424                         free_cpu_cached_iovas(cpu, iovad);
 425                 goto retry;
 426         }
 427
 428         return new_iova->pfn_lo;
 429 }
 430 EXPORT_SYMBOL_GPL(alloc_iova_fast);
 431
 432 /**
 433  * free_iova_fast - free iova pfn range into rcache
 434  * @iovad: - iova domain in question.
 435  * @pfn: - pfn that is allocated previously
 436  * @size: - # of pages in range
 437  * This functions frees an iova range by trying to put it into the rcache,
 438  * falling back to regular iova deallocation via free_iova() if this fails.
 439  */
 440 void
 441 free_iova_fast(struct iova_domain *iovad, unsigned long pfn, unsigned long size)
 442 {
 443         if (iova_rcache_insert(iovad, pfn, size))
 444                 return;
 445
 446         free_iova(iovad, pfn);
 447 }
 448 EXPORT_SYMBOL_GPL(free_iova_fast);
 449
 450 #define fq_ring_for_each(i, fq) \
 451         for ((i) = (fq)->head; (i) != (fq)->tail; (i) = ((i) + 1) % IOVA_FQ_SIZE)
 452
 453 static inline bool fq_full(struct iova_fq *fq)
 454 {
 455         assert_spin_locked(&fq->lock);
 456         return (((fq->tail + 1) % IOVA_FQ_SIZE) == fq->head);
 457 }
 458
 459 static inline unsigned fq_ring_add(struct iova_fq *fq)
 460 {
 461         unsigned idx = fq->tail;
 462
 463         assert_spin_locked(&fq->lock);
 464
 465         fq->tail = (idx + 1) % IOVA_FQ_SIZE;
 466
 467         return idx;
 468 }
 469
 470 static void fq_ring_free(struct iova_domain *iovad, struct iova_fq *fq)
 471 {
 472         u64 counter = atomic64_read(&iovad->fq_flush_finish_cnt);
 473         unsigned idx;
 474
 475         assert_spin_locked(&fq->lock);
 476
 477         fq_ring_for_each(idx, fq) {
 478
 479                 if (fq->entries[idx].counter >= counter)
 480                         break;
 481
 482                 if (iovad->entry_dtor)
 483                         iovad->entry_dtor(fq->entries[idx].data);
 484
 485                 free_iova_fast(iovad,
 486                                fq->entries[idx].iova_pfn,
 487                                fq->entries[idx].pages);
 488
 489                 fq->head = (fq->head + 1) % IOVA_FQ_SIZE;
 490         }
 491 }
 492
 493 static void iova_domain_flush(struct iova_domain *iovad)
 494 {
 495         atomic64_inc(&iovad->fq_flush_start_cnt);
 496         iovad->flush_cb(iovad);
 497         atomic64_inc(&iovad->fq_flush_finish_cnt);
 498 }
 499
 500 static void fq_destroy_all_entries(struct iova_domain *iovad)
 501 {
 502         int cpu;
 503
 504         /*
 505          * This code runs when the iova_domain is being detroyed, so don't
 506          * bother to free iovas, just call the entry_dtor on all remaining
 507          * entries.
 508          */
 509         if (!iovad->entry_dtor)
 510                 return;
 511
 512         for_each_possible_cpu(cpu) {
 513                 struct iova_fq *fq = per_cpu_ptr(iovad->fq, cpu);
 514                 int idx;
 515
 516                 fq_ring_for_each(idx, fq)
 517                         iovad->entry_dtor(fq->entries[idx].data);
 518         }
 519 }
 520
 521 static void fq_flush_timeout(unsigned long data)
 522 {
 523         struct iova_domain *iovad = (struct iova_domain *)data;
 524         int cpu;
 525
 526         atomic_set(&iovad->fq_timer_on, 0);
 527         iova_domain_flush(iovad);
 528
 529         for_each_possible_cpu(cpu) {
 530                 unsigned long flags;
 531                 struct iova_fq *fq;
 532
 533                 fq = per_cpu_ptr(iovad->fq, cpu);
 534                 spin_lock_irqsave(&fq->lock, flags);
 535                 fq_ring_free(iovad, fq);
 536                 spin_unlock_irqrestore(&fq->lock, flags);
 537         }
 538 }
 539
 540 void queue_iova(struct iova_domain *iovad,
 541                 unsigned long pfn, unsigned long pages,
 542                 unsigned long data)
 543 {
 544         struct iova_fq *fq = get_cpu_ptr(iovad->fq);
 545         unsigned long flags;
 546         unsigned idx;
 547
 548         spin_lock_irqsave(&fq->lock, flags);
 549
 550         /*
 551          * First remove all entries from the flush queue that have already been
 552          * flushed out on another CPU. This makes the fq_full() check below less
 553          * likely to be true.
 554          */
 555         fq_ring_free(iovad, fq);
 556
 557         if (fq_full(fq)) {
 558                 iova_domain_flush(iovad);
 559                 fq_ring_free(iovad, fq);
 560         }
 561
 562         idx = fq_ring_add(fq);
 563
 564         fq->entries[idx].iova_pfn = pfn;
 565         fq->entries[idx].pages    = pages;
 566         fq->entries[idx].data     = data;
 567         fq->entries[idx].counter  = atomic64_read(&iovad->fq_flush_start_cnt);
 568
 569         spin_unlock_irqrestore(&fq->lock, flags);
 570
 571         if (atomic_cmpxchg(&iovad->fq_timer_on, 0, 1) == 0)
 572                 mod_timer(&iovad->fq_timer,
 573                           jiffies + msecs_to_jiffies(IOVA_FQ_TIMEOUT));
 574
 575         put_cpu_ptr(iovad->fq);
 576 }
 577 EXPORT_SYMBOL_GPL(queue_iova);
 578
 579 /**
 580  * put_iova_domain - destroys the iova doamin
 581  * @iovad: - iova domain in question.
 582  * All the iova's in that domain are destroyed.
 583  */
 584 void put_iova_domain(struct iova_domain *iovad)
 585 {
 586         struct iova *iova, *tmp;
 587
 588         free_iova_flush_queue(iovad);
 589         free_iova_rcaches(iovad);
 590         rbtree_postorder_for_each_entry_safe(iova, tmp, &iovad->rbroot, node)
 591                 free_iova_mem(iova);
 592 }
 593 EXPORT_SYMBOL_GPL(put_iova_domain);
 594
 595 static int
 596 __is_range_overlap(struct rb_node *node,
 597         unsigned long pfn_lo, unsigned long pfn_hi)
 598 {
 599         struct iova *iova = rb_entry(node, struct iova, node);
 600
 601         if ((pfn_lo <= iova->pfn_hi) && (pfn_hi >= iova->pfn_lo))
 602                 return 1;
 603         return 0;
 604 }
 605
 606 static inline struct iova *
 607 alloc_and_init_iova(unsigned long pfn_lo, unsigned long pfn_hi)
 608 {
 609         struct iova *iova;
 610
 611         iova = alloc_iova_mem();
 612         if (iova) {
 613                 iova->pfn_lo = pfn_lo;
 614                 iova->pfn_hi = pfn_hi;
 615         }
 616
 617         return iova;
 618 }
 619
 620 static struct iova *
 621 __insert_new_range(struct iova_domain *iovad,
 622         unsigned long pfn_lo, unsigned long pfn_hi)
 623 {
 624         struct iova *iova;
 625
 626         iova = alloc_and_init_iova(pfn_lo, pfn_hi);
 627         if (iova)
 628                 iova_insert_rbtree(&iovad->rbroot, iova, NULL);
 629
 630         return iova;
 631 }
 632
 633 static void
 634 __adjust_overlap_range(struct iova *iova,
 635         unsigned long *pfn_lo, unsigned long *pfn_hi)
 636 {
 637         if (*pfn_lo < iova->pfn_lo)
 638                 iova->pfn_lo = *pfn_lo;
 639         if (*pfn_hi > iova->pfn_hi)
 640                 *pfn_lo = iova->pfn_hi + 1;
 641 }
 642
 643 /**
 644  * reserve_iova - reserves an iova in the given range
 645  * @iovad: - iova domain pointer
 646  * @pfn_lo: - lower page frame address
 647  * @pfn_hi:- higher pfn adderss
 648  * This function allocates reserves the address range from pfn_lo to pfn_hi so
 649  * that this address is not dished out as part of alloc_iova.
 650  */
 651 struct iova *
 652 reserve_iova(struct iova_domain *iovad,
 653         unsigned long pfn_lo, unsigned long pfn_hi)
 654 {
 655         struct rb_node *node;
 656         unsigned long flags;
 657         struct iova *iova;
 658         unsigned int overlap = 0;
 659
 660         /* Don't allow nonsensical pfns */
 661         if (WARN_ON((pfn_hi | pfn_lo) > (ULLONG_MAX >> iova_shift(iovad))))
 662                 return NULL;
 663
 664         spin_lock_irqsave(&iovad->iova_rbtree_lock, flags);
 665         for (node = rb_first(&iovad->rbroot); node; node = rb_next(node)) {
 666                 if (__is_range_overlap(node, pfn_lo, pfn_hi)) {
 667                         iova = rb_entry(node, struct iova, node);
 668                         __adjust_overlap_range(iova, &pfn_lo, &pfn_hi);
 669                         if ((pfn_lo >= iova->pfn_lo) &&
 670                                 (pfn_hi <= iova->pfn_hi))
 671                                 goto finish;
 672                         overlap = 1;
 673
 674                 } else if (overlap)
 675                                 break;
 676         }
 677
 678         /* We are here either because this is the first reserver node
 679          * or need to insert remaining non overlap addr range
 680          */
 681         iova = __insert_new_range(iovad, pfn_lo, pfn_hi);
 682 finish:
 683
 684         spin_unlock_irqrestore(&iovad->iova_rbtree_lock, flags);
 685         return iova;
 686 }
 687 EXPORT_SYMBOL_GPL(reserve_iova);
 688
 689 /**
 690  * copy_reserved_iova - copies the reserved between domains
 691  * @from: - source doamin from where to copy
 692  * @to: - destination domin where to copy
 693  * This function copies reserved iova's from one doamin to
 694  * other.
 695  */
 696 void
 697 copy_reserved_iova(struct iova_domain *from, struct iova_domain *to)
 698 {
 699         unsigned long flags;
 700         struct rb_node *node;
 701
 702         spin_lock_irqsave(&from->iova_rbtree_lock, flags);
 703         for (node = rb_first(&from->rbroot); node; node = rb_next(node)) {
 704                 struct iova *iova = rb_entry(node, struct iova, node);
 705                 struct iova *new_iova;
 706
 707                 new_iova = reserve_iova(to, iova->pfn_lo, iova->pfn_hi);
 708                 if (!new_iova)
 709                         printk(KERN_ERR "Reserve iova range %lx@%lx failed\n",
 710                                 iova->pfn_lo, iova->pfn_lo);
 711         }
 712         spin_unlock_irqrestore(&from->iova_rbtree_lock, flags);
 713 }
 714 EXPORT_SYMBOL_GPL(copy_reserved_iova);
 715
 716 struct iova *
 717 split_and_remove_iova(struct iova_domain *iovad, struct iova *iova,
 718                       unsigned long pfn_lo, unsigned long pfn_hi)
 719 {
 720         unsigned long flags;
 721         struct iova *prev = NULL, *next = NULL;
 722
 723         spin_lock_irqsave(&iovad->iova_rbtree_lock, flags);
 724         if (iova->pfn_lo < pfn_lo) {
 725                 prev = alloc_and_init_iova(iova->pfn_lo, pfn_lo - 1);
 726                 if (prev == NULL)
 727                         goto error;
 728         }
 729         if (iova->pfn_hi > pfn_hi) {
 730                 next = alloc_and_init_iova(pfn_hi + 1, iova->pfn_hi);
 731                 if (next == NULL)
 732                         goto error;
 733         }
 734
 735         __cached_rbnode_delete_update(iovad, iova);
 736         rb_erase(&iova->node, &iovad->rbroot);
 737
 738         if (prev) {
 739                 iova_insert_rbtree(&iovad->rbroot, prev, NULL);
 740                 iova->pfn_lo = pfn_lo;
 741         }
 742         if (next) {
 743                 iova_insert_rbtree(&iovad->rbroot, next, NULL);
 744                 iova->pfn_hi = pfn_hi;
 745         }
 746         spin_unlock_irqrestore(&iovad->iova_rbtree_lock, flags);
 747
 748         return iova;
 749
 750 error:
 751         spin_unlock_irqrestore(&iovad->iova_rbtree_lock, flags);
 752         if (prev)
 753                 free_iova_mem(prev);
 754         return NULL;
 755 }
 756
 757 /*
 758  * Magazine caches for IOVA ranges.  For an introduction to magazines,
 759  * see the USENIX 2001 paper "Magazines and Vmem: Extending the Slab
 760  * Allocator to Many CPUs and Arbitrary Resources" by Bonwick and Adams.
 761  * For simplicity, we use a static magazine size and don't implement the
 762  * dynamic size tuning described in the paper.
 763  */
 764
 765 #define IOVA_MAG_SIZE 128
 766
 767 struct iova_magazine {
 768         unsigned long size;
 769         unsigned long pfns[IOVA_MAG_SIZE];
 770 };
 771
 772 struct iova_cpu_rcache {
 773         spinlock_t lock;
 774         struct iova_magazine *loaded;
 775         struct iova_magazine *prev;
 776 };
 777
 778 static struct iova_magazine *iova_magazine_alloc(gfp_t flags)
 779 {
 780         return kzalloc(sizeof(struct iova_magazine), flags);
 781 }
 782
 783 static void iova_magazine_free(struct iova_magazine *mag)
 784 {
 785         kfree(mag);
 786 }
 787
 788 static void
 789 iova_magazine_free_pfns(struct iova_magazine *mag, struct iova_domain *iovad)
 790 {
 791         unsigned long flags;
 792         int i;
 793
 794         if (!mag)
 795                 return;
 796
 797         spin_lock_irqsave(&iovad->iova_rbtree_lock, flags);
 798
 799         for (i = 0 ; i < mag->size; ++i) {
 800                 struct iova *iova = private_find_iova(iovad, mag->pfns[i]);
 801
 802                 BUG_ON(!iova);
 803                 private_free_iova(iovad, iova);
 804         }
 805
 806         spin_unlock_irqrestore(&iovad->iova_rbtree_lock, flags);
 807
 808         mag->size = 0;
 809 }
 810
 811 static bool iova_magazine_full(struct iova_magazine *mag)
 812 {
 813         return (mag && mag->size == IOVA_MAG_SIZE);
 814 }
 815
 816 static bool iova_magazine_empty(struct iova_magazine *mag)
 817 {
 818         return (!mag || mag->size == 0);
 819 }
 820
 821 static unsigned long iova_magazine_pop(struct iova_magazine *mag,
 822                                        unsigned long limit_pfn)
 823 {
 824         int i;
 825         unsigned long pfn;
 826
 827         BUG_ON(iova_magazine_empty(mag));
 828
 829         /* Only fall back to the rbtree if we have no suitable pfns at all */
 830         for (i = mag->size - 1; mag->pfns[i] > limit_pfn; i--)
 831                 if (i == 0)
 832                         return 0;
 833
 834         /* Swap it to pop it */
 835         pfn = mag->pfns[i];
 836         mag->pfns[i] = mag->pfns[--mag->size];
 837
 838         return pfn;
 839 }
 840
 841 static void iova_magazine_push(struct iova_magazine *mag, unsigned long pfn)
 842 {
 843         BUG_ON(iova_magazine_full(mag));
 844
 845         mag->pfns[mag->size++] = pfn;
 846 }
 847
 848 static void init_iova_rcaches(struct iova_domain *iovad)
 849 {
 850         struct iova_cpu_rcache *cpu_rcache;
 851         struct iova_rcache *rcache;
 852         unsigned int cpu;
 853         int i;
 854
 855         for (i = 0; i < IOVA_RANGE_CACHE_MAX_SIZE; ++i) {
 856                 rcache = &iovad->rcaches[i];
 857                 spin_lock_init(&rcache->lock);
 858                 rcache->depot_size = 0;
 859                 rcache->cpu_rcaches = __alloc_percpu(sizeof(*cpu_rcache), cache_line_size());
 860                 if (WARN_ON(!rcache->cpu_rcaches))
 861                         continue;
 862                 for_each_possible_cpu(cpu) {
 863                         cpu_rcache = per_cpu_ptr(rcache->cpu_rcaches, cpu);
 864                         spin_lock_init(&cpu_rcache->lock);
 865                         cpu_rcache->loaded = iova_magazine_alloc(GFP_KERNEL);
 866                         cpu_rcache->prev = iova_magazine_alloc(GFP_KERNEL);
 867                 }
 868         }
 869 }
 870
 871 /*
 872  * Try inserting IOVA range starting with 'iova_pfn' into 'rcache', and
 873  * return true on success.  Can fail if rcache is full and we can't free
 874  * space, and free_iova() (our only caller) will then return the IOVA
 875  * range to the rbtree instead.
 876  */
 877 static bool __iova_rcache_insert(struct iova_domain *iovad,
 878                                  struct iova_rcache *rcache,
 879                                  unsigned long iova_pfn)
 880 {
 881         struct iova_magazine *mag_to_free = NULL;
 882         struct iova_cpu_rcache *cpu_rcache;
 883         bool can_insert = false;
 884         unsigned long flags;
 885
 886         cpu_rcache = raw_cpu_ptr(rcache->cpu_rcaches);
 887         spin_lock_irqsave(&cpu_rcache->lock, flags);
 888
 889         if (!iova_magazine_full(cpu_rcache->loaded)) {
 890                 can_insert = true;
 891         } else if (!iova_magazine_full(cpu_rcache->prev)) {
 892                 swap(cpu_rcache->prev, cpu_rcache->loaded);
 893                 can_insert = true;
 894         } else {
 895                 struct iova_magazine *new_mag = iova_magazine_alloc(GFP_ATOMIC);
 896
 897                 if (new_mag) {
 898                         spin_lock(&rcache->lock);
 899                         if (rcache->depot_size < MAX_GLOBAL_MAGS) {
 900                                 rcache->depot[rcache->depot_size++] =
 901                                                 cpu_rcache->loaded;
 902                         } else {
 903                                 mag_to_free = cpu_rcache->loaded;
 904                         }
 905                         spin_unlock(&rcache->lock);
 906
 907                         cpu_rcache->loaded = new_mag;
 908                         can_insert = true;
 909                 }
 910         }
 911
 912         if (can_insert)
 913                 iova_magazine_push(cpu_rcache->loaded, iova_pfn);
 914
 915         spin_unlock_irqrestore(&cpu_rcache->lock, flags);
 916
 917         if (mag_to_free) {
 918                 iova_magazine_free_pfns(mag_to_free, iovad);
 919                 iova_magazine_free(mag_to_free);
 920         }
 921
 922         return can_insert;
 923 }
 924
 925 static bool iova_rcache_insert(struct iova_domain *iovad, unsigned long pfn,
 926                                unsigned long size)
 927 {
 928         unsigned int log_size = order_base_2(size);
 929
 930         if (log_size >= IOVA_RANGE_CACHE_MAX_SIZE)
 931                 return false;
 932
 933         return __iova_rcache_insert(iovad, &iovad->rcaches[log_size], pfn);
 934 }
 935
 936 /*
 937  * Caller wants to allocate a new IOVA range from 'rcache'.  If we can
 938  * satisfy the request, return a matching non-NULL range and remove
 939  * it from the 'rcache'.
 940  */
 941 static unsigned long __iova_rcache_get(struct iova_rcache *rcache,
 942                                        unsigned long limit_pfn)
 943 {
 944         struct iova_cpu_rcache *cpu_rcache;
 945         unsigned long iova_pfn = 0;
 946         bool has_pfn = false;
 947         unsigned long flags;
 948
 949         cpu_rcache = raw_cpu_ptr(rcache->cpu_rcaches);
 950         spin_lock_irqsave(&cpu_rcache->lock, flags);
 951
 952         if (!iova_magazine_empty(cpu_rcache->loaded)) {
 953                 has_pfn = true;
 954         } else if (!iova_magazine_empty(cpu_rcache->prev)) {
 955                 swap(cpu_rcache->prev, cpu_rcache->loaded);
 956                 has_pfn = true;
 957         } else {
 958                 spin_lock(&rcache->lock);
 959                 if (rcache->depot_size > 0) {
 960                         iova_magazine_free(cpu_rcache->loaded);
 961                         cpu_rcache->loaded = rcache->depot[--rcache->depot_size];
 962                         has_pfn = true;
 963                 }
 964                 spin_unlock(&rcache->lock);
 965         }
 966
 967         if (has_pfn)
 968                 iova_pfn = iova_magazine_pop(cpu_rcache->loaded, limit_pfn);
 969
 970         spin_unlock_irqrestore(&cpu_rcache->lock, flags);
 971
 972         return iova_pfn;
 973 }
 974
 975 /*
 976  * Try to satisfy IOVA allocation range from rcache.  Fail if requested
 977  * size is too big or the DMA limit we are given isn't satisfied by the
 978  * top element in the magazine.
 979  */
 980 static unsigned long iova_rcache_get(struct iova_domain *iovad,
 981                                      unsigned long size,
 982                                      unsigned long limit_pfn)
 983 {
 984         unsigned int log_size = order_base_2(size);
 985
 986         if (log_size >= IOVA_RANGE_CACHE_MAX_SIZE)
 987                 return 0;
 988
 989         return __iova_rcache_get(&iovad->rcaches[log_size], limit_pfn - size);
 990 }
 991
 992 /*
 993  * free rcache data structures.
 994  */
 995 static void free_iova_rcaches(struct iova_domain *iovad)
 996 {
 997         struct iova_rcache *rcache;
 998         struct iova_cpu_rcache *cpu_rcache;
 999         unsigned int cpu;
1000         int i, j;
1001
1002         for (i = 0; i < IOVA_RANGE_CACHE_MAX_SIZE; ++i) {
1003                 rcache = &iovad->rcaches[i];
1004                 for_each_possible_cpu(cpu) {
1005                         cpu_rcache = per_cpu_ptr(rcache->cpu_rcaches, cpu);
1006                         iova_magazine_free(cpu_rcache->loaded);
1007                         iova_magazine_free(cpu_rcache->prev);
1008                 }
1009                 free_percpu(rcache->cpu_rcaches);
1010                 for (j = 0; j < rcache->depot_size; ++j)
1011                         iova_magazine_free(rcache->depot[j]);
1012         }
1013 }
1014
1015 /*
1016  * free all the IOVA ranges cached by a cpu (used when cpu is unplugged)
1017  */
1018 void free_cpu_cached_iovas(unsigned int cpu, struct iova_domain *iovad)
1019 {
1020         struct iova_cpu_rcache *cpu_rcache;
1021         struct iova_rcache *rcache;
1022         unsigned long flags;
1023         int i;
1024
1025         for (i = 0; i < IOVA_RANGE_CACHE_MAX_SIZE; ++i) {
1026                 rcache = &iovad->rcaches[i];
1027                 cpu_rcache = per_cpu_ptr(rcache->cpu_rcaches, cpu);
1028                 spin_lock_irqsave(&cpu_rcache->lock, flags);
1029                 iova_magazine_free_pfns(cpu_rcache->loaded, iovad);
1030                 iova_magazine_free_pfns(cpu_rcache->prev, iovad);
1031                 spin_unlock_irqrestore(&cpu_rcache->lock, flags);
1032         }
1033 }
1034
1035 MODULE_AUTHOR("Anil S Keshavamurthy <anil.s.keshavamurthy@intel.com>");
1036 MODULE_LICENSE("GPL");