sys/dev/drm/ttm/ttm_tt.c

   1 /**************************************************************************
   2  *
   3  * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27 /*
  28  * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
  29  */
  30 /*
  31  * Copyright (c) 2013 The FreeBSD Foundation
  32  * All rights reserved.
  33  *
  34  * Portions of this software were developed by Konstantin Belousov
  35  * <kib@FreeBSD.org> under sponsorship from the FreeBSD Foundation.
  36  *
  37  * $FreeBSD: head/sys/dev/drm2/ttm/ttm_tt.c 251452 2013-06-06 06:17:20Z alc $
  38  */
  39
  40 #include <drm/drmP.h>
  41
  42 #include <linux/export.h>
  43 #include <drm/ttm/ttm_module.h>
  44 #include <drm/ttm/ttm_bo_driver.h>
  45 #include <drm/ttm/ttm_placement.h>
  46 #include <drm/ttm/ttm_page_alloc.h>
  47
  48 /**
  49  * Allocates storage for pointers to the pages that back the ttm.
  50  */
  51 static void ttm_tt_alloc_page_directory(struct ttm_tt *ttm)
  52 {
  53         ttm->pages = kmalloc(ttm->num_pages * sizeof(void *),
  54             M_DRM, M_WAITOK | M_ZERO);
  55 }
  56
  57 static void ttm_dma_tt_alloc_page_directory(struct ttm_dma_tt *ttm)
  58 {
  59         ttm->ttm.pages = kmalloc(ttm->ttm.num_pages * sizeof(void *),
  60             M_DRM, M_WAITOK | M_ZERO);
  61         ttm->dma_address = kmalloc(ttm->ttm.num_pages *
  62             sizeof(*ttm->dma_address), M_DRM, M_WAITOK);
  63 }
  64
  65 static inline int ttm_tt_set_page_caching(vm_page_t p,
  66                                           enum ttm_caching_state c_old,
  67                                           enum ttm_caching_state c_new)
  68 {
  69
  70         /* XXXKIB our VM does not need this. */
  71 #if 0
  72         if (c_old != tt_cached) {
  73                 /* p isn't in the default caching state, set it to
  74                  * writeback first to free its current memtype. */
  75                 pmap_page_set_memattr(p, VM_MEMATTR_WRITE_BACK);
  76         }
  77 #endif
  78
  79         if (c_new == tt_wc)
  80                 pmap_page_set_memattr(p, VM_MEMATTR_WRITE_COMBINING);
  81         else if (c_new == tt_uncached)
  82                 pmap_page_set_memattr(p, VM_MEMATTR_UNCACHEABLE);
  83
  84         return (0);
  85 }
  86
  87 /*
  88  * Change caching policy for the linear kernel map
  89  * for range of pages in a ttm.
  90  */
  91
  92 static int ttm_tt_set_caching(struct ttm_tt *ttm,
  93                               enum ttm_caching_state c_state)
  94 {
  95         int i, j;
  96         vm_page_t cur_page;
  97         int ret;
  98
  99         if (ttm->caching_state == c_state)
 100                 return 0;
 101
 102         if (ttm->state == tt_unpopulated) {
 103                 /* Change caching but don't populate */
 104                 ttm->caching_state = c_state;
 105                 return 0;
 106         }
 107
 108         if (ttm->caching_state == tt_cached)
 109                 drm_clflush_pages(ttm->pages, ttm->num_pages);
 110
 111         for (i = 0; i < ttm->num_pages; ++i) {
 112                 cur_page = ttm->pages[i];
 113                 if (likely(cur_page != NULL)) {
 114                         ret = ttm_tt_set_page_caching(cur_page,
 115                                                       ttm->caching_state,
 116                                                       c_state);
 117                         if (unlikely(ret != 0))
 118                                 goto out_err;
 119                 }
 120         }
 121
 122         ttm->caching_state = c_state;
 123
 124         return 0;
 125
 126 out_err:
 127         for (j = 0; j < i; ++j) {
 128                 cur_page = ttm->pages[j];
 129                 if (likely(cur_page != NULL)) {
 130                         (void)ttm_tt_set_page_caching(cur_page, c_state,
 131                                                       ttm->caching_state);
 132                 }
 133         }
 134
 135         return ret;
 136 }
 137
 138 int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement)
 139 {
 140         enum ttm_caching_state state;
 141
 142         if (placement & TTM_PL_FLAG_WC)
 143                 state = tt_wc;
 144         else if (placement & TTM_PL_FLAG_UNCACHED)
 145                 state = tt_uncached;
 146         else
 147                 state = tt_cached;
 148
 149         return ttm_tt_set_caching(ttm, state);
 150 }
 151 EXPORT_SYMBOL(ttm_tt_set_placement_caching);
 152
 153 void ttm_tt_destroy(struct ttm_tt *ttm)
 154 {
 155         if (unlikely(ttm == NULL))
 156                 return;
 157
 158         if (ttm->state == tt_bound) {
 159                 ttm_tt_unbind(ttm);
 160         }
 161
 162         if (likely(ttm->pages != NULL)) {
 163                 ttm->bdev->driver->ttm_tt_unpopulate(ttm);
 164         }
 165
 166         if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP) &&
 167             ttm->swap_storage)
 168                 vm_object_deallocate(ttm->swap_storage);
 169
 170         ttm->swap_storage = NULL;
 171         ttm->func->destroy(ttm);
 172 }
 173
 174 int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev,
 175                 unsigned long size, uint32_t page_flags,
 176                 vm_page_t dummy_read_page)
 177 {
 178         ttm->bdev = bdev;
 179         ttm->glob = bdev->glob;
 180         ttm->num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
 181         ttm->caching_state = tt_cached;
 182         ttm->page_flags = page_flags;
 183         ttm->dummy_read_page = dummy_read_page;
 184         ttm->state = tt_unpopulated;
 185         ttm->swap_storage = NULL;
 186
 187         ttm_tt_alloc_page_directory(ttm);
 188         if (!ttm->pages) {
 189                 ttm_tt_destroy(ttm);
 190                 kprintf("Failed allocating page table\n");
 191                 return -ENOMEM;
 192         }
 193         return 0;
 194 }
 195 EXPORT_SYMBOL(ttm_tt_init);
 196
 197 void ttm_tt_fini(struct ttm_tt *ttm)
 198 {
 199         drm_free(ttm->pages, M_DRM);
 200         ttm->pages = NULL;
 201 }
 202 EXPORT_SYMBOL(ttm_tt_fini);
 203
 204 int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev,
 205                 unsigned long size, uint32_t page_flags,
 206                 vm_page_t dummy_read_page)
 207 {
 208         struct ttm_tt *ttm = &ttm_dma->ttm;
 209
 210         ttm->bdev = bdev;
 211         ttm->glob = bdev->glob;
 212         ttm->num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
 213         ttm->caching_state = tt_cached;
 214         ttm->page_flags = page_flags;
 215         ttm->dummy_read_page = dummy_read_page;
 216         ttm->state = tt_unpopulated;
 217         ttm->swap_storage = NULL;
 218
 219         INIT_LIST_HEAD(&ttm_dma->pages_list);
 220         ttm_dma_tt_alloc_page_directory(ttm_dma);
 221         if (!ttm->pages || !ttm_dma->dma_address) {
 222                 ttm_tt_destroy(ttm);
 223                 kprintf("Failed allocating page table\n");
 224                 return -ENOMEM;
 225         }
 226         return 0;
 227 }
 228 EXPORT_SYMBOL(ttm_dma_tt_init);
 229
 230 void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma)
 231 {
 232         struct ttm_tt *ttm = &ttm_dma->ttm;
 233
 234         drm_free(ttm->pages, M_DRM);
 235         ttm->pages = NULL;
 236         drm_free(ttm_dma->dma_address, M_DRM);
 237         ttm_dma->dma_address = NULL;
 238 }
 239 EXPORT_SYMBOL(ttm_dma_tt_fini);
 240
 241 void ttm_tt_unbind(struct ttm_tt *ttm)
 242 {
 243         int ret;
 244
 245         if (ttm->state == tt_bound) {
 246                 ret = ttm->func->unbind(ttm);
 247                 BUG_ON(ret);
 248                 ttm->state = tt_unbound;
 249         }
 250 }
 251
 252 int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem)
 253 {
 254         int ret = 0;
 255
 256         if (!ttm)
 257                 return -EINVAL;
 258
 259         if (ttm->state == tt_bound)
 260                 return 0;
 261
 262         ret = ttm->bdev->driver->ttm_tt_populate(ttm);
 263         if (ret)
 264                 return ret;
 265
 266         ret = ttm->func->bind(ttm, bo_mem);
 267         if (unlikely(ret != 0))
 268                 return ret;
 269
 270         ttm->state = tt_bound;
 271
 272         return 0;
 273 }
 274 EXPORT_SYMBOL(ttm_tt_bind);
 275
 276 int ttm_tt_swapin(struct ttm_tt *ttm)
 277 {
 278         vm_object_t obj;
 279         vm_page_t from_page, to_page;
 280         int i, ret, rv;
 281
 282         obj = ttm->swap_storage;
 283
 284         VM_OBJECT_WLOCK(obj);
 285         vm_object_pip_add(obj, 1);
 286         for (i = 0; i < ttm->num_pages; ++i) {
 287                 from_page = vm_page_grab(obj, i, VM_ALLOC_NORMAL |
 288                                                  VM_ALLOC_RETRY);
 289                 if (from_page->valid != VM_PAGE_BITS_ALL) {
 290                         if (vm_pager_has_page(obj, i)) {
 291                                 rv = vm_pager_get_page(obj, &from_page, 1);
 292                                 if (rv != VM_PAGER_OK) {
 293                                         vm_page_free(from_page);
 294                                         ret = -EIO;
 295                                         goto err_ret;
 296                                 }
 297                         } else {
 298                                 vm_page_zero_invalid(from_page, TRUE);
 299                         }
 300                 }
 301                 to_page = ttm->pages[i];
 302                 if (unlikely(to_page == NULL)) {
 303                         ret = -ENOMEM;
 304                         vm_page_wakeup(from_page);
 305                         goto err_ret;
 306                 }
 307                 pmap_copy_page(VM_PAGE_TO_PHYS(from_page),
 308                                VM_PAGE_TO_PHYS(to_page));
 309                 vm_page_wakeup(from_page);
 310         }
 311         vm_object_pip_wakeup(obj);
 312         VM_OBJECT_WUNLOCK(obj);
 313
 314         if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP))
 315                 vm_object_deallocate(obj);
 316         ttm->swap_storage = NULL;
 317         ttm->page_flags &= ~TTM_PAGE_FLAG_SWAPPED;
 318         return (0);
 319
 320 err_ret:
 321         vm_object_pip_wakeup(obj);
 322         VM_OBJECT_WUNLOCK(obj);
 323         return (ret);
 324 }
 325
 326 int ttm_tt_swapout(struct ttm_tt *ttm, vm_object_t persistent_swap_storage)
 327 {
 328         vm_object_t obj;
 329         vm_page_t from_page, to_page;
 330         int i;
 331
 332         BUG_ON(ttm->state != tt_unbound && ttm->state != tt_unpopulated);
 333         BUG_ON(ttm->caching_state != tt_cached);
 334
 335         if (!persistent_swap_storage) {
 336                 obj = swap_pager_alloc(NULL,
 337                     IDX_TO_OFF(ttm->num_pages), VM_PROT_DEFAULT, 0);
 338                 if (obj == NULL) {
 339                         kprintf("[TTM] Failed allocating swap storage\n");
 340                         return (-ENOMEM);
 341                 }
 342         } else
 343                 obj = persistent_swap_storage;
 344
 345         VM_OBJECT_WLOCK(obj);
 346         vm_object_pip_add(obj, 1);
 347         for (i = 0; i < ttm->num_pages; ++i) {
 348                 from_page = ttm->pages[i];
 349                 if (unlikely(from_page == NULL))
 350                         continue;
 351                 to_page = vm_page_grab(obj, i, VM_ALLOC_NORMAL |
 352                                                VM_ALLOC_RETRY);
 353                 pmap_copy_page(VM_PAGE_TO_PHYS(from_page),
 354                                         VM_PAGE_TO_PHYS(to_page));
 355                 to_page->valid = VM_PAGE_BITS_ALL;
 356                 vm_page_dirty(to_page);
 357                 vm_page_wakeup(to_page);
 358         }
 359         vm_object_pip_wakeup(obj);
 360         VM_OBJECT_WUNLOCK(obj);
 361
 362         ttm->bdev->driver->ttm_tt_unpopulate(ttm);
 363         ttm->swap_storage = obj;
 364         ttm->page_flags |= TTM_PAGE_FLAG_SWAPPED;
 365         if (persistent_swap_storage)
 366                 ttm->page_flags |= TTM_PAGE_FLAG_PERSISTENT_SWAP;
 367
 368         return 0;
 369 }