include/drm/ttm/ttm_bo_api.h

   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 #ifndef _TTM_BO_API_H_
  32 #define _TTM_BO_API_H_
  33
  34 #include <drm/drm_gem.h>
  35 #include <drm/drm_vma_manager.h>
  36 #include <linux/kref.h>
  37 #include <linux/list.h>
  38 #include <linux/wait.h>
  39 #include <linux/mutex.h>
  40 #include <linux/mm.h>
  41 #include <linux/bitmap.h>
  42 #include <linux/dma-resv.h>
  43
  44 #include "ttm_resource.h"
  45
  46 struct ttm_global;
  47
  48 struct ttm_device;
  49
  50 struct iosys_map;
  51
  52 struct drm_mm_node;
  53
  54 struct ttm_placement;
  55
  56 struct ttm_place;
  57
  58 /**
  59  * enum ttm_bo_type
  60  *
  61  * @ttm_bo_type_device: These are 'normal' buffers that can
  62  * be mmapped by user space. Each of these bos occupy a slot in the
  63  * device address space, that can be used for normal vm operations.
  64  *
  65  * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
  66  * but they cannot be accessed from user-space. For kernel-only use.
  67  *
  68  * @ttm_bo_type_sg: Buffer made from dmabuf sg table shared with another
  69  * driver.
  70  */
  71
  72 enum ttm_bo_type {
  73         ttm_bo_type_device,
  74         ttm_bo_type_kernel,
  75         ttm_bo_type_sg
  76 };
  77
  78 struct ttm_tt;
  79
  80 /**
  81  * struct ttm_buffer_object
  82  *
  83  * @base: drm_gem_object superclass data.
  84  * @bdev: Pointer to the buffer object device structure.
  85  * @type: The bo type.
  86  * @page_alignment: Page alignment.
  87  * @destroy: Destruction function. If NULL, kfree is used.
  88  * @num_pages: Actual number of pages.
  89  * @kref: Reference count of this buffer object. When this refcount reaches
  90  * zero, the object is destroyed or put on the delayed delete list.
  91  * @mem: structure describing current placement.
  92  * @ttm: TTM structure holding system pages.
  93  * @evicted: Whether the object was evicted without user-space knowing.
  94  * @deleted: True if the object is only a zombie and already deleted.
  95  * @ddestroy: List head for the delayed destroy list.
  96  * @swap: List head for swap LRU list.
  97  * @moving: Fence set when BO is moving
  98  * @offset: The current GPU offset, which can have different meanings
  99  * depending on the memory type. For SYSTEM type memory, it should be 0.
 100  * @cur_placement: Hint of current placement.
 101  *
 102  * Base class for TTM buffer object, that deals with data placement and CPU
 103  * mappings. GPU mappings are really up to the driver, but for simpler GPUs
 104  * the driver can usually use the placement offset @offset directly as the
 105  * GPU virtual address. For drivers implementing multiple
 106  * GPU memory manager contexts, the driver should manage the address space
 107  * in these contexts separately and use these objects to get the correct
 108  * placement and caching for these GPU maps. This makes it possible to use
 109  * these objects for even quite elaborate memory management schemes.
 110  * The destroy member, the API visibility of this object makes it possible
 111  * to derive driver specific types.
 112  */
 113
 114 struct ttm_buffer_object {
 115         struct drm_gem_object base;
 116
 117         /**
 118          * Members constant at init.
 119          */
 120
 121         struct ttm_device *bdev;
 122         enum ttm_bo_type type;
 123         uint32_t page_alignment;
 124         void (*destroy) (struct ttm_buffer_object *);
 125
 126         /**
 127         * Members not needing protection.
 128         */
 129         struct kref kref;
 130
 131         /**
 132          * Members protected by the bo::resv::reserved lock.
 133          */
 134
 135         struct ttm_resource *resource;
 136         struct ttm_tt *ttm;
 137         bool deleted;
 138         struct ttm_lru_bulk_move *bulk_move;
 139
 140         /**
 141          * Members protected by the bdev::lru_lock.
 142          */
 143
 144         struct list_head ddestroy;
 145
 146         /**
 147          * Members protected by a bo reservation.
 148          */
 149
 150         struct dma_fence *moving;
 151         unsigned priority;
 152         unsigned pin_count;
 153
 154         /**
 155          * Special members that are protected by the reserve lock
 156          * and the bo::lock when written to. Can be read with
 157          * either of these locks held.
 158          */
 159
 160         struct sg_table *sg;
 161 };
 162
 163 /**
 164  * struct ttm_bo_kmap_obj
 165  *
 166  * @virtual: The current kernel virtual address.
 167  * @page: The page when kmap'ing a single page.
 168  * @bo_kmap_type: Type of bo_kmap.
 169  *
 170  * Object describing a kernel mapping. Since a TTM bo may be located
 171  * in various memory types with various caching policies, the
 172  * mapping can either be an ioremap, a vmap, a kmap or part of a
 173  * premapped region.
 174  */
 175
 176 #define TTM_BO_MAP_IOMEM_MASK 0x80
 177 struct ttm_bo_kmap_obj {
 178         void *virtual;
 179         struct page *page;
 180         enum {
 181                 ttm_bo_map_iomap        = 1 | TTM_BO_MAP_IOMEM_MASK,
 182                 ttm_bo_map_vmap         = 2,
 183                 ttm_bo_map_kmap         = 3,
 184                 ttm_bo_map_premapped    = 4 | TTM_BO_MAP_IOMEM_MASK,
 185         } bo_kmap_type;
 186         struct ttm_buffer_object *bo;
 187 };
 188
 189 /**
 190  * struct ttm_operation_ctx
 191  *
 192  * @interruptible: Sleep interruptible if sleeping.
 193  * @no_wait_gpu: Return immediately if the GPU is busy.
 194  * @gfp_retry_mayfail: Set the __GFP_RETRY_MAYFAIL when allocation pages.
 195  * @allow_res_evict: Allow eviction of reserved BOs. Can be used when multiple
 196  * BOs share the same reservation object.
 197  * @force_alloc: Don't check the memory account during suspend or CPU page
 198  * faults. Should only be used by TTM internally.
 199  * @resv: Reservation object to allow reserved evictions with.
 200  *
 201  * Context for TTM operations like changing buffer placement or general memory
 202  * allocation.
 203  */
 204 struct ttm_operation_ctx {
 205         bool interruptible;
 206         bool no_wait_gpu;
 207         bool gfp_retry_mayfail;
 208         bool allow_res_evict;
 209         bool force_alloc;
 210         struct dma_resv *resv;
 211         uint64_t bytes_moved;
 212 };
 213
 214 /**
 215  * ttm_bo_get - reference a struct ttm_buffer_object
 216  *
 217  * @bo: The buffer object.
 218  */
 219 static inline void ttm_bo_get(struct ttm_buffer_object *bo)
 220 {
 221         kref_get(&bo->kref);
 222 }
 223
 224 /**
 225  * ttm_bo_get_unless_zero - reference a struct ttm_buffer_object unless
 226  * its refcount has already reached zero.
 227  * @bo: The buffer object.
 228  *
 229  * Used to reference a TTM buffer object in lookups where the object is removed
 230  * from the lookup structure during the destructor and for RCU lookups.
 231  *
 232  * Returns: @bo if the referencing was successful, NULL otherwise.
 233  */
 234 static inline __must_check struct ttm_buffer_object *
 235 ttm_bo_get_unless_zero(struct ttm_buffer_object *bo)
 236 {
 237         if (!kref_get_unless_zero(&bo->kref))
 238                 return NULL;
 239         return bo;
 240 }
 241
 242 /**
 243  * ttm_bo_wait - wait for buffer idle.
 244  *
 245  * @bo:  The buffer object.
 246  * @interruptible:  Use interruptible wait.
 247  * @no_wait:  Return immediately if buffer is busy.
 248  *
 249  * This function must be called with the bo::mutex held, and makes
 250  * sure any previous rendering to the buffer is completed.
 251  * Note: It might be necessary to block validations before the
 252  * wait by reserving the buffer.
 253  * Returns -EBUSY if no_wait is true and the buffer is busy.
 254  * Returns -ERESTARTSYS if interrupted by a signal.
 255  */
 256 int ttm_bo_wait(struct ttm_buffer_object *bo, bool interruptible, bool no_wait);
 257
 258 static inline int ttm_bo_wait_ctx(struct ttm_buffer_object *bo, struct ttm_operation_ctx *ctx)
 259 {
 260         return ttm_bo_wait(bo, ctx->interruptible, ctx->no_wait_gpu);
 261 }
 262
 263 /**
 264  * ttm_bo_validate
 265  *
 266  * @bo: The buffer object.
 267  * @placement: Proposed placement for the buffer object.
 268  * @ctx: validation parameters.
 269  *
 270  * Changes placement and caching policy of the buffer object
 271  * according proposed placement.
 272  * Returns
 273  * -EINVAL on invalid proposed placement.
 274  * -ENOMEM on out-of-memory condition.
 275  * -EBUSY if no_wait is true and buffer busy.
 276  * -ERESTARTSYS if interrupted by a signal.
 277  */
 278 int ttm_bo_validate(struct ttm_buffer_object *bo,
 279                     struct ttm_placement *placement,
 280                     struct ttm_operation_ctx *ctx);
 281
 282 /**
 283  * ttm_bo_put
 284  *
 285  * @bo: The buffer object.
 286  *
 287  * Unreference a buffer object.
 288  */
 289 void ttm_bo_put(struct ttm_buffer_object *bo);
 290
 291 void ttm_bo_move_to_lru_tail(struct ttm_buffer_object *bo);
 292 void ttm_bo_set_bulk_move(struct ttm_buffer_object *bo,
 293                           struct ttm_lru_bulk_move *bulk);
 294
 295 /**
 296  * ttm_bo_lock_delayed_workqueue
 297  *
 298  * Prevent the delayed workqueue from running.
 299  * Returns
 300  * True if the workqueue was queued at the time
 301  */
 302 int ttm_bo_lock_delayed_workqueue(struct ttm_device *bdev);
 303
 304 /**
 305  * ttm_bo_unlock_delayed_workqueue
 306  *
 307  * Allows the delayed workqueue to run.
 308  */
 309 void ttm_bo_unlock_delayed_workqueue(struct ttm_device *bdev, int resched);
 310
 311 /**
 312  * ttm_bo_eviction_valuable
 313  *
 314  * @bo: The buffer object to evict
 315  * @place: the placement we need to make room for
 316  *
 317  * Check if it is valuable to evict the BO to make room for the given placement.
 318  */
 319 bool ttm_bo_eviction_valuable(struct ttm_buffer_object *bo,
 320                               const struct ttm_place *place);
 321
 322 /**
 323  * ttm_bo_init_reserved
 324  *
 325  * @bdev: Pointer to a ttm_device struct.
 326  * @bo: Pointer to a ttm_buffer_object to be initialized.
 327  * @size: Requested size of buffer object.
 328  * @type: Requested type of buffer object.
 329  * @placement: Initial placement for buffer object.
 330  * @page_alignment: Data alignment in pages.
 331  * @ctx: TTM operation context for memory allocation.
 332  * @sg: Scatter-gather table.
 333  * @resv: Pointer to a dma_resv, or NULL to let ttm allocate one.
 334  * @destroy: Destroy function. Use NULL for kfree().
 335  *
 336  * This function initializes a pre-allocated struct ttm_buffer_object.
 337  * As this object may be part of a larger structure, this function,
 338  * together with the @destroy function,
 339  * enables driver-specific objects derived from a ttm_buffer_object.
 340  *
 341  * On successful return, the caller owns an object kref to @bo. The kref and
 342  * list_kref are usually set to 1, but note that in some situations, other
 343  * tasks may already be holding references to @bo as well.
 344  * Furthermore, if resv == NULL, the buffer's reservation lock will be held,
 345  * and it is the caller's responsibility to call ttm_bo_unreserve.
 346  *
 347  * If a failure occurs, the function will call the @destroy function, or
 348  * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
 349  * illegal and will likely cause memory corruption.
 350  *
 351  * Returns
 352  * -ENOMEM: Out of memory.
 353  * -EINVAL: Invalid placement flags.
 354  * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
 355  */
 356
 357 int ttm_bo_init_reserved(struct ttm_device *bdev,
 358                          struct ttm_buffer_object *bo,
 359                          size_t size, enum ttm_bo_type type,
 360                          struct ttm_placement *placement,
 361                          uint32_t page_alignment,
 362                          struct ttm_operation_ctx *ctx,
 363                          struct sg_table *sg, struct dma_resv *resv,
 364                          void (*destroy) (struct ttm_buffer_object *));
 365
 366 /**
 367  * ttm_bo_init
 368  *
 369  * @bdev: Pointer to a ttm_device struct.
 370  * @bo: Pointer to a ttm_buffer_object to be initialized.
 371  * @size: Requested size of buffer object.
 372  * @type: Requested type of buffer object.
 373  * @placement: Initial placement for buffer object.
 374  * @page_alignment: Data alignment in pages.
 375  * @interruptible: If needing to sleep to wait for GPU resources,
 376  * sleep interruptible.
 377  * pinned in physical memory. If this behaviour is not desired, this member
 378  * holds a pointer to a persistent shmem object. Typically, this would
 379  * point to the shmem object backing a GEM object if TTM is used to back a
 380  * GEM user interface.
 381  * @sg: Scatter-gather table.
 382  * @resv: Pointer to a dma_resv, or NULL to let ttm allocate one.
 383  * @destroy: Destroy function. Use NULL for kfree().
 384  *
 385  * This function initializes a pre-allocated struct ttm_buffer_object.
 386  * As this object may be part of a larger structure, this function,
 387  * together with the @destroy function,
 388  * enables driver-specific objects derived from a ttm_buffer_object.
 389  *
 390  * On successful return, the caller owns an object kref to @bo. The kref and
 391  * list_kref are usually set to 1, but note that in some situations, other
 392  * tasks may already be holding references to @bo as well.
 393  *
 394  * If a failure occurs, the function will call the @destroy function, or
 395  * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
 396  * illegal and will likely cause memory corruption.
 397  *
 398  * Returns
 399  * -ENOMEM: Out of memory.
 400  * -EINVAL: Invalid placement flags.
 401  * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
 402  */
 403 int ttm_bo_init(struct ttm_device *bdev, struct ttm_buffer_object *bo,
 404                 size_t size, enum ttm_bo_type type,
 405                 struct ttm_placement *placement,
 406                 uint32_t page_alignment, bool interrubtible,
 407                 struct sg_table *sg, struct dma_resv *resv,
 408                 void (*destroy) (struct ttm_buffer_object *));
 409
 410 /**
 411  * ttm_kmap_obj_virtual
 412  *
 413  * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
 414  * @is_iomem: Pointer to an integer that on return indicates 1 if the
 415  * virtual map is io memory, 0 if normal memory.
 416  *
 417  * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
 418  * If *is_iomem is 1 on return, the virtual address points to an io memory area,
 419  * that should strictly be accessed by the iowriteXX() and similar functions.
 420  */
 421 static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
 422                                          bool *is_iomem)
 423 {
 424         *is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK);
 425         return map->virtual;
 426 }
 427
 428 /**
 429  * ttm_bo_kmap
 430  *
 431  * @bo: The buffer object.
 432  * @start_page: The first page to map.
 433  * @num_pages: Number of pages to map.
 434  * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
 435  *
 436  * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
 437  * data in the buffer object. The ttm_kmap_obj_virtual function can then be
 438  * used to obtain a virtual address to the data.
 439  *
 440  * Returns
 441  * -ENOMEM: Out of memory.
 442  * -EINVAL: Invalid range.
 443  */
 444 int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
 445                 unsigned long num_pages, struct ttm_bo_kmap_obj *map);
 446
 447 /**
 448  * ttm_bo_kunmap
 449  *
 450  * @map: Object describing the map to unmap.
 451  *
 452  * Unmaps a kernel map set up by ttm_bo_kmap.
 453  */
 454 void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
 455
 456 /**
 457  * ttm_bo_vmap
 458  *
 459  * @bo: The buffer object.
 460  * @map: pointer to a struct iosys_map representing the map.
 461  *
 462  * Sets up a kernel virtual mapping, using ioremap or vmap to the
 463  * data in the buffer object. The parameter @map returns the virtual
 464  * address as struct iosys_map. Unmap the buffer with ttm_bo_vunmap().
 465  *
 466  * Returns
 467  * -ENOMEM: Out of memory.
 468  * -EINVAL: Invalid range.
 469  */
 470 int ttm_bo_vmap(struct ttm_buffer_object *bo, struct iosys_map *map);
 471
 472 /**
 473  * ttm_bo_vunmap
 474  *
 475  * @bo: The buffer object.
 476  * @map: Object describing the map to unmap.
 477  *
 478  * Unmaps a kernel map set up by ttm_bo_vmap().
 479  */
 480 void ttm_bo_vunmap(struct ttm_buffer_object *bo, struct iosys_map *map);
 481
 482 /**
 483  * ttm_bo_mmap_obj - mmap memory backed by a ttm buffer object.
 484  *
 485  * @vma:       vma as input from the fbdev mmap method.
 486  * @bo:        The bo backing the address space.
 487  *
 488  * Maps a buffer object.
 489  */
 490 int ttm_bo_mmap_obj(struct vm_area_struct *vma, struct ttm_buffer_object *bo);
 491
 492 /**
 493  * ttm_bo_io
 494  *
 495  * @bdev:      Pointer to the struct ttm_device.
 496  * @filp:      Pointer to the struct file attempting to read / write.
 497  * @wbuf:      User-space pointer to address of buffer to write. NULL on read.
 498  * @rbuf:      User-space pointer to address of buffer to read into.
 499  * Null on write.
 500  * @count:     Number of bytes to read / write.
 501  * @f_pos:     Pointer to current file position.
 502  * @write:     1 for read, 0 for write.
 503  *
 504  * This function implements read / write into ttm buffer objects, and is
 505  * intended to
 506  * be called from the fops::read and fops::write method.
 507  * Returns:
 508  * See man (2) write, man(2) read. In particular,
 509  * the function may return -ERESTARTSYS if
 510  * interrupted by a signal.
 511  */
 512 ssize_t ttm_bo_io(struct ttm_device *bdev, struct file *filp,
 513                   const char __user *wbuf, char __user *rbuf,
 514                   size_t count, loff_t *f_pos, bool write);
 515
 516 int ttm_bo_swapout(struct ttm_buffer_object *bo, struct ttm_operation_ctx *ctx,
 517                    gfp_t gfp_flags);
 518
 519 void ttm_bo_pin(struct ttm_buffer_object *bo);
 520 void ttm_bo_unpin(struct ttm_buffer_object *bo);
 521
 522 int ttm_mem_evict_first(struct ttm_device *bdev,
 523                         struct ttm_resource_manager *man,
 524                         const struct ttm_place *place,
 525                         struct ttm_operation_ctx *ctx,
 526                         struct ww_acquire_ctx *ticket);
 527
 528 /* Default number of pre-faulted pages in the TTM fault handler */
 529 #define TTM_BO_VM_NUM_PREFAULT 16
 530
 531 vm_fault_t ttm_bo_vm_reserve(struct ttm_buffer_object *bo,
 532                              struct vm_fault *vmf);
 533
 534 vm_fault_t ttm_bo_vm_fault_reserved(struct vm_fault *vmf,
 535                                     pgprot_t prot,
 536                                     pgoff_t num_prefault);
 537
 538 vm_fault_t ttm_bo_vm_fault(struct vm_fault *vmf);
 539
 540 void ttm_bo_vm_open(struct vm_area_struct *vma);
 541
 542 void ttm_bo_vm_close(struct vm_area_struct *vma);
 543
 544 int ttm_bo_vm_access(struct vm_area_struct *vma, unsigned long addr,
 545                      void *buf, int len, int write);
 546 bool ttm_bo_delayed_delete(struct ttm_device *bdev, bool remove_all);
 547
 548 vm_fault_t ttm_bo_vm_dummy_page(struct vm_fault *vmf, pgprot_t prot);
 549
 550 #endif