include/drm/ttm/ttm_bo_driver.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 #ifndef _TTM_BO_DRIVER_H_
  31 #define _TTM_BO_DRIVER_H_
  32
  33 #include <drm/drm_mm.h>
  34 #include <drm/drm_vma_manager.h>
  35 #include <linux/workqueue.h>
  36 #include <linux/fs.h>
  37 #include <linux/spinlock.h>
  38 #include <linux/dma-resv.h>
  39
  40 #include <drm/ttm/ttm_device.h>
  41
  42 #include "ttm_bo_api.h"
  43 #include "ttm_kmap_iter.h"
  44 #include "ttm_placement.h"
  45 #include "ttm_tt.h"
  46 #include "ttm_pool.h"
  47
  48 /*
  49  * ttm_bo.c
  50  */
  51
  52 /**
  53  * ttm_bo_mem_space
  54  *
  55  * @bo: Pointer to a struct ttm_buffer_object. the data of which
  56  * we want to allocate space for.
  57  * @proposed_placement: Proposed new placement for the buffer object.
  58  * @mem: A struct ttm_resource.
  59  * @interruptible: Sleep interruptible when sliping.
  60  * @no_wait_gpu: Return immediately if the GPU is busy.
  61  *
  62  * Allocate memory space for the buffer object pointed to by @bo, using
  63  * the placement flags in @mem, potentially evicting other idle buffer objects.
  64  * This function may sleep while waiting for space to become available.
  65  * Returns:
  66  * -EBUSY: No space available (only if no_wait == 1).
  67  * -ENOMEM: Could not allocate memory for the buffer object, either due to
  68  * fragmentation or concurrent allocators.
  69  * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
  70  */
  71 int ttm_bo_mem_space(struct ttm_buffer_object *bo,
  72                      struct ttm_placement *placement,
  73                      struct ttm_resource **mem,
  74                      struct ttm_operation_ctx *ctx);
  75
  76 /**
  77  * ttm_bo_unmap_virtual
  78  *
  79  * @bo: tear down the virtual mappings for this BO
  80  */
  81 void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
  82
  83 /**
  84  * ttm_bo_reserve:
  85  *
  86  * @bo: A pointer to a struct ttm_buffer_object.
  87  * @interruptible: Sleep interruptible if waiting.
  88  * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
  89  * @ticket: ticket used to acquire the ww_mutex.
  90  *
  91  * Locks a buffer object for validation. (Or prevents other processes from
  92  * locking it for validation), while taking a number of measures to prevent
  93  * deadlocks.
  94  *
  95  * Returns:
  96  * -EDEADLK: The reservation may cause a deadlock.
  97  * Release all buffer reservations, wait for @bo to become unreserved and
  98  * try again.
  99  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
 100  * a signal. Release all buffer reservations and return to user-space.
 101  * -EBUSY: The function needed to sleep, but @no_wait was true
 102  * -EALREADY: Bo already reserved using @ticket. This error code will only
 103  * be returned if @use_ticket is set to true.
 104  */
 105 static inline int ttm_bo_reserve(struct ttm_buffer_object *bo,
 106                                  bool interruptible, bool no_wait,
 107                                  struct ww_acquire_ctx *ticket)
 108 {
 109         int ret = 0;
 110
 111         if (no_wait) {
 112                 bool success;
 113                 if (WARN_ON(ticket))
 114                         return -EBUSY;
 115
 116                 success = dma_resv_trylock(bo->base.resv);
 117                 return success ? 0 : -EBUSY;
 118         }
 119
 120         if (interruptible)
 121                 ret = dma_resv_lock_interruptible(bo->base.resv, ticket);
 122         else
 123                 ret = dma_resv_lock(bo->base.resv, ticket);
 124         if (ret == -EINTR)
 125                 return -ERESTARTSYS;
 126         return ret;
 127 }
 128
 129 /**
 130  * ttm_bo_reserve_slowpath:
 131  * @bo: A pointer to a struct ttm_buffer_object.
 132  * @interruptible: Sleep interruptible if waiting.
 133  * @sequence: Set (@bo)->sequence to this value after lock
 134  *
 135  * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
 136  * from all our other reservations. Because there are no other reservations
 137  * held by us, this function cannot deadlock any more.
 138  */
 139 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo,
 140                                           bool interruptible,
 141                                           struct ww_acquire_ctx *ticket)
 142 {
 143         if (interruptible) {
 144                 int ret = dma_resv_lock_slow_interruptible(bo->base.resv,
 145                                                            ticket);
 146                 if (ret == -EINTR)
 147                         ret = -ERESTARTSYS;
 148                 return ret;
 149         }
 150         dma_resv_lock_slow(bo->base.resv, ticket);
 151         return 0;
 152 }
 153
 154 static inline void
 155 ttm_bo_move_to_lru_tail_unlocked(struct ttm_buffer_object *bo)
 156 {
 157         spin_lock(&bo->bdev->lru_lock);
 158         ttm_bo_move_to_lru_tail(bo);
 159         spin_unlock(&bo->bdev->lru_lock);
 160 }
 161
 162 static inline void ttm_bo_assign_mem(struct ttm_buffer_object *bo,
 163                                      struct ttm_resource *new_mem)
 164 {
 165         WARN_ON(bo->resource);
 166         bo->resource = new_mem;
 167 }
 168
 169 /**
 170  * ttm_bo_move_null = assign memory for a buffer object.
 171  * @bo: The bo to assign the memory to
 172  * @new_mem: The memory to be assigned.
 173  *
 174  * Assign the memory from new_mem to the memory of the buffer object bo.
 175  */
 176 static inline void ttm_bo_move_null(struct ttm_buffer_object *bo,
 177                                     struct ttm_resource *new_mem)
 178 {
 179         ttm_resource_free(bo, &bo->resource);
 180         ttm_bo_assign_mem(bo, new_mem);
 181 }
 182
 183 /**
 184  * ttm_bo_unreserve
 185  *
 186  * @bo: A pointer to a struct ttm_buffer_object.
 187  *
 188  * Unreserve a previous reservation of @bo.
 189  */
 190 static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo)
 191 {
 192         ttm_bo_move_to_lru_tail_unlocked(bo);
 193         dma_resv_unlock(bo->base.resv);
 194 }
 195
 196 /*
 197  * ttm_bo_util.c
 198  */
 199 int ttm_mem_io_reserve(struct ttm_device *bdev,
 200                        struct ttm_resource *mem);
 201 void ttm_mem_io_free(struct ttm_device *bdev,
 202                      struct ttm_resource *mem);
 203
 204 /**
 205  * ttm_bo_move_memcpy
 206  *
 207  * @bo: A pointer to a struct ttm_buffer_object.
 208  * @interruptible: Sleep interruptible if waiting.
 209  * @no_wait_gpu: Return immediately if the GPU is busy.
 210  * @new_mem: struct ttm_resource indicating where to move.
 211  *
 212  * Fallback move function for a mappable buffer object in mappable memory.
 213  * The function will, if successful,
 214  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
 215  * and update the (@bo)->mem placement flags. If unsuccessful, the old
 216  * data remains untouched, and it's up to the caller to free the
 217  * memory space indicated by @new_mem.
 218  * Returns:
 219  * !0: Failure.
 220  */
 221
 222 int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
 223                        struct ttm_operation_ctx *ctx,
 224                        struct ttm_resource *new_mem);
 225
 226 /**
 227  * ttm_bo_move_accel_cleanup.
 228  *
 229  * @bo: A pointer to a struct ttm_buffer_object.
 230  * @fence: A fence object that signals when moving is complete.
 231  * @evict: This is an evict move. Don't return until the buffer is idle.
 232  * @pipeline: evictions are to be pipelined.
 233  * @new_mem: struct ttm_resource indicating where to move.
 234  *
 235  * Accelerated move function to be called when an accelerated move
 236  * has been scheduled. The function will create a new temporary buffer object
 237  * representing the old placement, and put the sync object on both buffer
 238  * objects. After that the newly created buffer object is unref'd to be
 239  * destroyed when the move is complete. This will help pipeline
 240  * buffer moves.
 241  */
 242 int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
 243                               struct dma_fence *fence, bool evict,
 244                               bool pipeline,
 245                               struct ttm_resource *new_mem);
 246
 247 /**
 248  * ttm_bo_move_sync_cleanup.
 249  *
 250  * @bo: A pointer to a struct ttm_buffer_object.
 251  * @new_mem: struct ttm_resource indicating where to move.
 252  *
 253  * Special case of ttm_bo_move_accel_cleanup where the bo is guaranteed
 254  * by the caller to be idle. Typically used after memcpy buffer moves.
 255  */
 256 void ttm_bo_move_sync_cleanup(struct ttm_buffer_object *bo,
 257                               struct ttm_resource *new_mem);
 258
 259 /**
 260  * ttm_bo_pipeline_gutting.
 261  *
 262  * @bo: A pointer to a struct ttm_buffer_object.
 263  *
 264  * Pipelined gutting a BO of its backing store.
 265  */
 266 int ttm_bo_pipeline_gutting(struct ttm_buffer_object *bo);
 267
 268 /**
 269  * ttm_io_prot
 270  *
 271  * bo: ttm buffer object
 272  * res: ttm resource object
 273  * @tmp: Page protection flag for a normal, cached mapping.
 274  *
 275  * Utility function that returns the pgprot_t that should be used for
 276  * setting up a PTE with the caching model indicated by @c_state.
 277  */
 278 pgprot_t ttm_io_prot(struct ttm_buffer_object *bo, struct ttm_resource *res,
 279                      pgprot_t tmp);
 280
 281 /**
 282  * ttm_bo_tt_bind
 283  *
 284  * Bind the object tt to a memory resource.
 285  */
 286 int ttm_bo_tt_bind(struct ttm_buffer_object *bo, struct ttm_resource *mem);
 287
 288 /**
 289  * ttm_bo_tt_destroy.
 290  */
 291 void ttm_bo_tt_destroy(struct ttm_buffer_object *bo);
 292
 293 void ttm_move_memcpy(bool clear,
 294                      u32 num_pages,
 295                      struct ttm_kmap_iter *dst_iter,
 296                      struct ttm_kmap_iter *src_iter);
 297
 298 struct ttm_kmap_iter *
 299 ttm_kmap_iter_iomap_init(struct ttm_kmap_iter_iomap *iter_io,
 300                          struct io_mapping *iomap,
 301                          struct sg_table *st,
 302                          resource_size_t start);
 303 #endif