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 <ttm/ttm_bo_api.h> 34 #include <ttm/ttm_memory.h> 35 #include <ttm/ttm_module.h> 36 #include <ttm/ttm_placement.h> 37 #include <drm/drm_mm.h> 38 #include <drm/drm_global.h> 39 #include <drm/drm_vma_manager.h> 40 #include <linux/workqueue.h> 41 #include <linux/fs.h> 42 #include <linux/spinlock.h> 43 #include <linux/reservation.h> 44 45 struct ttm_backend_func { 46 /** 47 * struct ttm_backend_func member bind 48 * 49 * @ttm: Pointer to a struct ttm_tt. 50 * @bo_mem: Pointer to a struct ttm_mem_reg describing the 51 * memory type and location for binding. 52 * 53 * Bind the backend pages into the aperture in the location 54 * indicated by @bo_mem. This function should be able to handle 55 * differences between aperture and system page sizes. 56 */ 57 int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); 58 59 /** 60 * struct ttm_backend_func member unbind 61 * 62 * @ttm: Pointer to a struct ttm_tt. 63 * 64 * Unbind previously bound backend pages. This function should be 65 * able to handle differences between aperture and system page sizes. 66 */ 67 int (*unbind) (struct ttm_tt *ttm); 68 69 /** 70 * struct ttm_backend_func member destroy 71 * 72 * @ttm: Pointer to a struct ttm_tt. 73 * 74 * Destroy the backend. This will be call back from ttm_tt_destroy so 75 * don't call ttm_tt_destroy from the callback or infinite loop. 76 */ 77 void (*destroy) (struct ttm_tt *ttm); 78 }; 79 80 #define TTM_PAGE_FLAG_WRITE (1 << 3) 81 #define TTM_PAGE_FLAG_SWAPPED (1 << 4) 82 #define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5) 83 #define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6) 84 #define TTM_PAGE_FLAG_DMA32 (1 << 7) 85 #define TTM_PAGE_FLAG_SG (1 << 8) 86 87 enum ttm_caching_state { 88 tt_uncached, 89 tt_wc, 90 tt_cached 91 }; 92 93 /** 94 * struct ttm_tt 95 * 96 * @bdev: Pointer to a struct ttm_bo_device. 97 * @func: Pointer to a struct ttm_backend_func that describes 98 * the backend methods. 99 * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL 100 * pointer. 101 * @pages: Array of pages backing the data. 102 * @num_pages: Number of pages in the page array. 103 * @bdev: Pointer to the current struct ttm_bo_device. 104 * @be: Pointer to the ttm backend. 105 * @swap_storage: Pointer to shmem struct file for swap storage. 106 * @caching_state: The current caching state of the pages. 107 * @state: The current binding state of the pages. 108 * 109 * This is a structure holding the pages, caching- and aperture binding 110 * status for a buffer object that isn't backed by fixed (VRAM / AGP) 111 * memory. 112 */ 113 114 struct ttm_tt { 115 struct ttm_bo_device *bdev; 116 struct ttm_backend_func *func; 117 struct page *dummy_read_page; 118 struct page **pages; 119 uint32_t page_flags; 120 unsigned long num_pages; 121 struct sg_table *sg; /* for SG objects via dma-buf */ 122 struct ttm_bo_global *glob; 123 struct vm_object *swap_storage; 124 enum ttm_caching_state caching_state; 125 enum { 126 tt_bound, 127 tt_unbound, 128 tt_unpopulated, 129 } state; 130 }; 131 132 /** 133 * struct ttm_dma_tt 134 * 135 * @ttm: Base ttm_tt struct. 136 * @dma_address: The DMA (bus) addresses of the pages 137 * @pages_list: used by some page allocation backend 138 * 139 * This is a structure holding the pages, caching- and aperture binding 140 * status for a buffer object that isn't backed by fixed (VRAM / AGP) 141 * memory. 142 */ 143 struct ttm_dma_tt { 144 struct ttm_tt ttm; 145 dma_addr_t *dma_address; 146 struct list_head pages_list; 147 }; 148 149 #define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */ 150 #define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */ 151 #define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */ 152 153 struct ttm_mem_type_manager; 154 155 struct ttm_mem_type_manager_func { 156 /** 157 * struct ttm_mem_type_manager member init 158 * 159 * @man: Pointer to a memory type manager. 160 * @p_size: Implementation dependent, but typically the size of the 161 * range to be managed in pages. 162 * 163 * Called to initialize a private range manager. The function is 164 * expected to initialize the man::priv member. 165 * Returns 0 on success, negative error code on failure. 166 */ 167 int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size); 168 169 /** 170 * struct ttm_mem_type_manager member takedown 171 * 172 * @man: Pointer to a memory type manager. 173 * 174 * Called to undo the setup done in init. All allocated resources 175 * should be freed. 176 */ 177 int (*takedown)(struct ttm_mem_type_manager *man); 178 179 /** 180 * struct ttm_mem_type_manager member get_node 181 * 182 * @man: Pointer to a memory type manager. 183 * @bo: Pointer to the buffer object we're allocating space for. 184 * @placement: Placement details. 185 * @mem: Pointer to a struct ttm_mem_reg to be filled in. 186 * 187 * This function should allocate space in the memory type managed 188 * by @man. Placement details if 189 * applicable are given by @placement. If successful, 190 * @mem::mm_node should be set to a non-null value, and 191 * @mem::start should be set to a value identifying the beginning 192 * of the range allocated, and the function should return zero. 193 * If the memory region accommodate the buffer object, @mem::mm_node 194 * should be set to NULL, and the function should return 0. 195 * If a system error occurred, preventing the request to be fulfilled, 196 * the function should return a negative error code. 197 * 198 * Note that @mem::mm_node will only be dereferenced by 199 * struct ttm_mem_type_manager functions and optionally by the driver, 200 * which has knowledge of the underlying type. 201 * 202 * This function may not be called from within atomic context, so 203 * an implementation can and must use either a mutex or a spinlock to 204 * protect any data structures managing the space. 205 */ 206 int (*get_node)(struct ttm_mem_type_manager *man, 207 struct ttm_buffer_object *bo, 208 const struct ttm_place *place, 209 struct ttm_mem_reg *mem); 210 211 /** 212 * struct ttm_mem_type_manager member put_node 213 * 214 * @man: Pointer to a memory type manager. 215 * @mem: Pointer to a struct ttm_mem_reg to be filled in. 216 * 217 * This function frees memory type resources previously allocated 218 * and that are identified by @mem::mm_node and @mem::start. May not 219 * be called from within atomic context. 220 */ 221 void (*put_node)(struct ttm_mem_type_manager *man, 222 struct ttm_mem_reg *mem); 223 224 /** 225 * struct ttm_mem_type_manager member debug 226 * 227 * @man: Pointer to a memory type manager. 228 * @prefix: Prefix to be used in printout to identify the caller. 229 * 230 * This function is called to print out the state of the memory 231 * type manager to aid debugging of out-of-memory conditions. 232 * It may not be called from within atomic context. 233 */ 234 void (*debug)(struct ttm_mem_type_manager *man, const char *prefix); 235 }; 236 237 /** 238 * struct ttm_mem_type_manager 239 * 240 * @has_type: The memory type has been initialized. 241 * @use_type: The memory type is enabled. 242 * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory 243 * managed by this memory type. 244 * @gpu_offset: If used, the GPU offset of the first managed page of 245 * fixed memory or the first managed location in an aperture. 246 * @size: Size of the managed region. 247 * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX, 248 * as defined in ttm_placement_common.h 249 * @default_caching: The default caching policy used for a buffer object 250 * placed in this memory type if the user doesn't provide one. 251 * @func: structure pointer implementing the range manager. See above 252 * @priv: Driver private closure for @func. 253 * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures 254 * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions 255 * reserved by the TTM vm system. 256 * @io_reserve_lru: Optional lru list for unreserving io mem regions. 257 * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain 258 * @move_lock: lock for move fence 259 * static information. bdev::driver::io_mem_free is never used. 260 * @lru: The lru list for this memory type. 261 * @move: The fence of the last pipelined move operation. 262 * 263 * This structure is used to identify and manage memory types for a device. 264 * It's set up by the ttm_bo_driver::init_mem_type method. 265 */ 266 267 268 269 struct ttm_mem_type_manager { 270 struct ttm_bo_device *bdev; 271 272 /* 273 * No protection. Constant from start. 274 */ 275 276 bool has_type; 277 bool use_type; 278 uint32_t flags; 279 uint64_t gpu_offset; /* GPU address space is independent of CPU word size */ 280 uint64_t size; 281 uint32_t available_caching; 282 uint32_t default_caching; 283 const struct ttm_mem_type_manager_func *func; 284 void *priv; 285 struct lock io_reserve_mutex; 286 bool use_io_reserve_lru; 287 bool io_reserve_fastpath; 288 spinlock_t move_lock; 289 290 /* 291 * Protected by @io_reserve_mutex: 292 */ 293 294 struct list_head io_reserve_lru; 295 296 /* 297 * Protected by the global->lru_lock. 298 */ 299 300 struct list_head lru; 301 302 /* 303 * Protected by @move_lock. 304 */ 305 struct fence *move; 306 }; 307 308 /** 309 * struct ttm_bo_driver 310 * 311 * @create_ttm_backend_entry: Callback to create a struct ttm_backend. 312 * @invalidate_caches: Callback to invalidate read caches when a buffer object 313 * has been evicted. 314 * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager 315 * structure. 316 * @evict_flags: Callback to obtain placement flags when a buffer is evicted. 317 * @move: Callback for a driver to hook in accelerated functions to 318 * move a buffer. 319 * If set to NULL, a potentially slow memcpy() move is used. 320 */ 321 322 struct ttm_bo_driver { 323 /** 324 * ttm_tt_create 325 * 326 * @bdev: pointer to a struct ttm_bo_device: 327 * @size: Size of the data needed backing. 328 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. 329 * @dummy_read_page: See struct ttm_bo_device. 330 * 331 * Create a struct ttm_tt to back data with system memory pages. 332 * No pages are actually allocated. 333 * Returns: 334 * NULL: Out of memory. 335 */ 336 struct ttm_tt *(*ttm_tt_create)(struct ttm_bo_device *bdev, 337 unsigned long size, 338 uint32_t page_flags, 339 struct page *dummy_read_page); 340 341 /** 342 * ttm_tt_populate 343 * 344 * @ttm: The struct ttm_tt to contain the backing pages. 345 * 346 * Allocate all backing pages 347 * Returns: 348 * -ENOMEM: Out of memory. 349 */ 350 int (*ttm_tt_populate)(struct ttm_tt *ttm); 351 352 /** 353 * ttm_tt_unpopulate 354 * 355 * @ttm: The struct ttm_tt to contain the backing pages. 356 * 357 * Free all backing page 358 */ 359 void (*ttm_tt_unpopulate)(struct ttm_tt *ttm); 360 361 /** 362 * struct ttm_bo_driver member invalidate_caches 363 * 364 * @bdev: the buffer object device. 365 * @flags: new placement of the rebound buffer object. 366 * 367 * A previosly evicted buffer has been rebound in a 368 * potentially new location. Tell the driver that it might 369 * consider invalidating read (texture) caches on the next command 370 * submission as a consequence. 371 */ 372 373 int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags); 374 int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type, 375 struct ttm_mem_type_manager *man); 376 /** 377 * struct ttm_bo_driver member evict_flags: 378 * 379 * @bo: the buffer object to be evicted 380 * 381 * Return the bo flags for a buffer which is not mapped to the hardware. 382 * These will be placed in proposed_flags so that when the move is 383 * finished, they'll end up in bo->mem.flags 384 */ 385 386 void(*evict_flags) (struct ttm_buffer_object *bo, 387 struct ttm_placement *placement); 388 /** 389 * struct ttm_bo_driver member move: 390 * 391 * @bo: the buffer to move 392 * @evict: whether this motion is evicting the buffer from 393 * the graphics address space 394 * @interruptible: Use interruptible sleeps if possible when sleeping. 395 * @no_wait: whether this should give up and return -EBUSY 396 * if this move would require sleeping 397 * @new_mem: the new memory region receiving the buffer 398 * 399 * Move a buffer between two memory regions. 400 */ 401 int (*move) (struct ttm_buffer_object *bo, 402 bool evict, bool interruptible, 403 bool no_wait_gpu, 404 struct ttm_mem_reg *new_mem); 405 406 /** 407 * struct ttm_bo_driver_member verify_access 408 * 409 * @bo: Pointer to a buffer object. 410 * @filp: Pointer to a struct file trying to access the object. 411 * 412 * Called from the map / write / read methods to verify that the 413 * caller is permitted to access the buffer object. 414 * This member may be set to NULL, which will refuse this kind of 415 * access for all buffer objects. 416 * This function should return 0 if access is granted, -EPERM otherwise. 417 */ 418 int (*verify_access) (struct ttm_buffer_object *bo, 419 struct file *filp); 420 421 /* hook to notify driver about a driver move so it 422 * can do tiling things */ 423 void (*move_notify)(struct ttm_buffer_object *bo, 424 struct ttm_mem_reg *new_mem); 425 /* notify the driver we are taking a fault on this BO 426 * and have reserved it */ 427 int (*fault_reserve_notify)(struct ttm_buffer_object *bo); 428 429 /** 430 * notify the driver that we're about to swap out this bo 431 */ 432 void (*swap_notify) (struct ttm_buffer_object *bo); 433 434 /** 435 * Driver callback on when mapping io memory (for bo_move_memcpy 436 * for instance). TTM will take care to call io_mem_free whenever 437 * the mapping is not use anymore. io_mem_reserve & io_mem_free 438 * are balanced. 439 */ 440 int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem); 441 void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem); 442 443 /** 444 * Optional driver callback for when BO is removed from the LRU. 445 * Called with LRU lock held immediately before the removal. 446 */ 447 void (*lru_removal)(struct ttm_buffer_object *bo); 448 449 /** 450 * Return the list_head after which a BO should be inserted in the LRU. 451 */ 452 struct list_head *(*lru_tail)(struct ttm_buffer_object *bo); 453 struct list_head *(*swap_lru_tail)(struct ttm_buffer_object *bo); 454 }; 455 456 /** 457 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global. 458 */ 459 460 struct ttm_bo_global_ref { 461 struct drm_global_reference ref; 462 struct ttm_mem_global *mem_glob; 463 }; 464 465 /** 466 * struct ttm_bo_global - Buffer object driver global data. 467 * 468 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting. 469 * @dummy_read_page: Pointer to a dummy page used for mapping requests 470 * of unpopulated pages. 471 * @shrink: A shrink callback object used for buffer object swap. 472 * @device_list_mutex: Mutex protecting the device list. 473 * This mutex is held while traversing the device list for pm options. 474 * @lru_lock: Spinlock protecting the bo subsystem lru lists. 475 * @device_list: List of buffer object devices. 476 * @swap_lru: Lru list of buffer objects used for swapping. 477 */ 478 479 struct ttm_bo_global { 480 481 /** 482 * Constant after init. 483 */ 484 485 struct kobject kobj; 486 struct ttm_mem_global *mem_glob; 487 struct page *dummy_read_page; 488 struct ttm_mem_shrink shrink; 489 struct lock device_list_mutex; 490 struct lock lru_lock; 491 492 /** 493 * Protected by device_list_mutex. 494 */ 495 struct list_head device_list; 496 497 /** 498 * Protected by the lru_lock. 499 */ 500 struct list_head swap_lru; 501 502 /** 503 * Internal protection. 504 */ 505 atomic_t bo_count; 506 }; 507 508 509 #define TTM_NUM_MEM_TYPES 8 510 511 #define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs 512 idling before CPU mapping */ 513 #define TTM_BO_PRIV_FLAG_ACTIVE 1 514 #define TTM_BO_PRIV_FLAG_MAX 2 515 /** 516 * struct ttm_bo_device - Buffer object driver device-specific data. 517 * 518 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver. 519 * @man: An array of mem_type_managers. 520 * @vma_manager: Address space manager 521 * lru_lock: Spinlock that protects the buffer+device lru lists and 522 * ddestroy lists. 523 * @dev_mapping: A pointer to the struct address_space representing the 524 * device address space. 525 * @wq: Work queue structure for the delayed delete workqueue. 526 * 527 */ 528 529 struct ttm_bo_device { 530 531 /* 532 * Constant after bo device init / atomic. 533 */ 534 struct list_head device_list; 535 struct ttm_bo_global *glob; 536 struct ttm_bo_driver *driver; 537 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES]; 538 539 /* 540 * Protected by internal locks. 541 */ 542 struct drm_vma_offset_manager vma_manager; 543 544 /* 545 * Protected by the global:lru lock. 546 */ 547 struct list_head ddestroy; 548 549 /* 550 * Protected by load / firstopen / lastclose /unload sync. 551 */ 552 553 struct address_space *dev_mapping; 554 555 /* 556 * Internal protection. 557 */ 558 559 struct delayed_work wq; 560 561 bool need_dma32; 562 }; 563 564 /** 565 * ttm_flag_masked 566 * 567 * @old: Pointer to the result and original value. 568 * @new: New value of bits. 569 * @mask: Mask of bits to change. 570 * 571 * Convenience function to change a number of bits identified by a mask. 572 */ 573 574 static inline uint32_t 575 ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask) 576 { 577 *old ^= (*old ^ new) & mask; 578 return *old; 579 } 580 581 /** 582 * ttm_tt_init 583 * 584 * @ttm: The struct ttm_tt. 585 * @bdev: pointer to a struct ttm_bo_device: 586 * @size: Size of the data needed backing. 587 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. 588 * @dummy_read_page: See struct ttm_bo_device. 589 * 590 * Create a struct ttm_tt to back data with system memory pages. 591 * No pages are actually allocated. 592 * Returns: 593 * NULL: Out of memory. 594 */ 595 extern int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev, 596 unsigned long size, uint32_t page_flags, 597 struct page *dummy_read_page); 598 extern int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev, 599 unsigned long size, uint32_t page_flags, 600 struct page *dummy_read_page); 601 602 /** 603 * ttm_tt_fini 604 * 605 * @ttm: the ttm_tt structure. 606 * 607 * Free memory of ttm_tt structure 608 */ 609 extern void ttm_tt_fini(struct ttm_tt *ttm); 610 extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma); 611 612 /** 613 * ttm_ttm_bind: 614 * 615 * @ttm: The struct ttm_tt containing backing pages. 616 * @bo_mem: The struct ttm_mem_reg identifying the binding location. 617 * 618 * Bind the pages of @ttm to an aperture location identified by @bo_mem 619 */ 620 extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); 621 622 /** 623 * ttm_ttm_destroy: 624 * 625 * @ttm: The struct ttm_tt. 626 * 627 * Unbind, unpopulate and destroy common struct ttm_tt. 628 */ 629 extern void ttm_tt_destroy(struct ttm_tt *ttm); 630 631 /** 632 * ttm_ttm_unbind: 633 * 634 * @ttm: The struct ttm_tt. 635 * 636 * Unbind a struct ttm_tt. 637 */ 638 extern void ttm_tt_unbind(struct ttm_tt *ttm); 639 640 /** 641 * ttm_tt_swapin: 642 * 643 * @ttm: The struct ttm_tt. 644 * 645 * Swap in a previously swap out ttm_tt. 646 */ 647 extern int ttm_tt_swapin(struct ttm_tt *ttm); 648 649 /** 650 * ttm_tt_set_placement_caching: 651 * 652 * @ttm A struct ttm_tt the backing pages of which will change caching policy. 653 * @placement: Flag indicating the desired caching policy. 654 * 655 * This function will change caching policy of any default kernel mappings of 656 * the pages backing @ttm. If changing from cached to uncached or 657 * write-combined, 658 * all CPU caches will first be flushed to make sure the data of the pages 659 * hit RAM. This function may be very costly as it involves global TLB 660 * and cache flushes and potential page splitting / combining. 661 */ 662 extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement); 663 extern int ttm_tt_swapout(struct ttm_tt *ttm, 664 struct vm_object *persistent_swap_storage); 665 666 /** 667 * ttm_tt_unpopulate - free pages from a ttm 668 * 669 * @ttm: Pointer to the ttm_tt structure 670 * 671 * Calls the driver method to free all pages from a ttm 672 */ 673 extern void ttm_tt_unpopulate(struct ttm_tt *ttm); 674 675 /* 676 * ttm_bo.c 677 */ 678 679 /** 680 * ttm_mem_reg_is_pci 681 * 682 * @bdev: Pointer to a struct ttm_bo_device. 683 * @mem: A valid struct ttm_mem_reg. 684 * 685 * Returns true if the memory described by @mem is PCI memory, 686 * false otherwise. 687 */ 688 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev, 689 struct ttm_mem_reg *mem); 690 691 /** 692 * ttm_bo_mem_space 693 * 694 * @bo: Pointer to a struct ttm_buffer_object. the data of which 695 * we want to allocate space for. 696 * @proposed_placement: Proposed new placement for the buffer object. 697 * @mem: A struct ttm_mem_reg. 698 * @interruptible: Sleep interruptible when sliping. 699 * @no_wait_gpu: Return immediately if the GPU is busy. 700 * 701 * Allocate memory space for the buffer object pointed to by @bo, using 702 * the placement flags in @mem, potentially evicting other idle buffer objects. 703 * This function may sleep while waiting for space to become available. 704 * Returns: 705 * -EBUSY: No space available (only if no_wait == 1). 706 * -ENOMEM: Could not allocate memory for the buffer object, either due to 707 * fragmentation or concurrent allocators. 708 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal. 709 */ 710 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo, 711 struct ttm_placement *placement, 712 struct ttm_mem_reg *mem, 713 bool interruptible, 714 bool no_wait_gpu); 715 716 extern void ttm_bo_mem_put(struct ttm_buffer_object *bo, 717 struct ttm_mem_reg *mem); 718 extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo, 719 struct ttm_mem_reg *mem); 720 721 extern void ttm_bo_global_release(struct drm_global_reference *ref); 722 extern int ttm_bo_global_init(struct drm_global_reference *ref); 723 724 extern int ttm_bo_device_release(struct ttm_bo_device *bdev); 725 726 /** 727 * ttm_bo_device_init 728 * 729 * @bdev: A pointer to a struct ttm_bo_device to initialize. 730 * @glob: A pointer to an initialized struct ttm_bo_global. 731 * @driver: A pointer to a struct ttm_bo_driver set up by the caller. 732 * @mapping: The address space to use for this bo. 733 * @file_page_offset: Offset into the device address space that is available 734 * for buffer data. This ensures compatibility with other users of the 735 * address space. 736 * 737 * Initializes a struct ttm_bo_device: 738 * Returns: 739 * !0: Failure. 740 */ 741 extern int ttm_bo_device_init(struct ttm_bo_device *bdev, 742 struct ttm_bo_global *glob, 743 struct ttm_bo_driver *driver, 744 struct address_space *mapping, 745 uint64_t file_page_offset, bool need_dma32); 746 747 /** 748 * ttm_bo_unmap_virtual 749 * 750 * @bo: tear down the virtual mappings for this BO 751 */ 752 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo); 753 754 /** 755 * ttm_bo_unmap_virtual 756 * 757 * @bo: tear down the virtual mappings for this BO 758 * 759 * The caller must take ttm_mem_io_lock before calling this function. 760 */ 761 extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo); 762 763 extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo); 764 extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo); 765 extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man, 766 bool interruptible); 767 extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man); 768 769 extern void ttm_bo_del_sub_from_lru(struct ttm_buffer_object *bo); 770 771 struct list_head *ttm_bo_default_lru_tail(struct ttm_buffer_object *bo); 772 struct list_head *ttm_bo_default_swap_lru_tail(struct ttm_buffer_object *bo); 773 774 /** 775 * __ttm_bo_reserve: 776 * 777 * @bo: A pointer to a struct ttm_buffer_object. 778 * @interruptible: Sleep interruptible if waiting. 779 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. 780 * @ticket: ticket used to acquire the ww_mutex. 781 * 782 * Will not remove reserved buffers from the lru lists. 783 * Otherwise identical to ttm_bo_reserve. 784 * 785 * Returns: 786 * -EDEADLK: The reservation may cause a deadlock. 787 * Release all buffer reservations, wait for @bo to become unreserved and 788 * try again. (only if use_sequence == 1). 789 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by 790 * a signal. Release all buffer reservations and return to user-space. 791 * -EBUSY: The function needed to sleep, but @no_wait was true 792 * -EALREADY: Bo already reserved using @ticket. This error code will only 793 * be returned if @use_ticket is set to true. 794 */ 795 static inline int __ttm_bo_reserve(struct ttm_buffer_object *bo, 796 bool interruptible, bool no_wait, 797 struct ww_acquire_ctx *ticket) 798 { 799 int ret = 0; 800 801 if (no_wait) { 802 bool success; 803 if (WARN_ON(ticket)) 804 return -EBUSY; 805 806 success = ww_mutex_trylock(&bo->resv->lock); 807 return success ? 0 : -EBUSY; 808 } 809 810 if (interruptible) 811 ret = ww_mutex_lock_interruptible(&bo->resv->lock, ticket); 812 else 813 ret = ww_mutex_lock(&bo->resv->lock, ticket); 814 if (ret == -EINTR) 815 return -ERESTARTSYS; 816 return ret; 817 } 818 819 /** 820 * ttm_bo_reserve: 821 * 822 * @bo: A pointer to a struct ttm_buffer_object. 823 * @interruptible: Sleep interruptible if waiting. 824 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. 825 * @ticket: ticket used to acquire the ww_mutex. 826 * 827 * Locks a buffer object for validation. (Or prevents other processes from 828 * locking it for validation) and removes it from lru lists, while taking 829 * a number of measures to prevent deadlocks. 830 * 831 * Deadlocks may occur when two processes try to reserve multiple buffers in 832 * different order, either by will or as a result of a buffer being evicted 833 * to make room for a buffer already reserved. (Buffers are reserved before 834 * they are evicted). The following algorithm prevents such deadlocks from 835 * occurring: 836 * Processes attempting to reserve multiple buffers other than for eviction, 837 * (typically execbuf), should first obtain a unique 32-bit 838 * validation sequence number, 839 * and call this function with @use_ticket == 1 and @ticket->stamp == the unique 840 * sequence number. If upon call of this function, the buffer object is already 841 * reserved, the validation sequence is checked against the validation 842 * sequence of the process currently reserving the buffer, 843 * and if the current validation sequence is greater than that of the process 844 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps 845 * waiting for the buffer to become unreserved, after which it retries 846 * reserving. 847 * The caller should, when receiving an -EAGAIN error 848 * release all its buffer reservations, wait for @bo to become unreserved, and 849 * then rerun the validation with the same validation sequence. This procedure 850 * will always guarantee that the process with the lowest validation sequence 851 * will eventually succeed, preventing both deadlocks and starvation. 852 * 853 * Returns: 854 * -EDEADLK: The reservation may cause a deadlock. 855 * Release all buffer reservations, wait for @bo to become unreserved and 856 * try again. (only if use_sequence == 1). 857 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by 858 * a signal. Release all buffer reservations and return to user-space. 859 * -EBUSY: The function needed to sleep, but @no_wait was true 860 * -EALREADY: Bo already reserved using @ticket. This error code will only 861 * be returned if @use_ticket is set to true. 862 */ 863 static inline int ttm_bo_reserve(struct ttm_buffer_object *bo, 864 bool interruptible, bool no_wait, 865 struct ww_acquire_ctx *ticket) 866 { 867 int ret; 868 869 WARN_ON(!atomic_read(&bo->kref.refcount)); 870 871 ret = __ttm_bo_reserve(bo, interruptible, no_wait, ticket); 872 if (likely(ret == 0)) 873 ttm_bo_del_sub_from_lru(bo); 874 875 return ret; 876 } 877 878 /** 879 * ttm_bo_reserve_slowpath: 880 * @bo: A pointer to a struct ttm_buffer_object. 881 * @interruptible: Sleep interruptible if waiting. 882 * @sequence: Set (@bo)->sequence to this value after lock 883 * 884 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off 885 * from all our other reservations. Because there are no other reservations 886 * held by us, this function cannot deadlock any more. 887 */ 888 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo, 889 bool interruptible, 890 struct ww_acquire_ctx *ticket) 891 { 892 int ret = 0; 893 894 WARN_ON(!atomic_read(&bo->kref.refcount)); 895 896 if (interruptible) 897 ret = ww_mutex_lock_slow_interruptible(&bo->resv->lock, 898 ticket); 899 else 900 ww_mutex_lock_slow(&bo->resv->lock, ticket); 901 902 if (likely(ret == 0)) 903 ttm_bo_del_sub_from_lru(bo); 904 else if (ret == -EINTR) 905 ret = -ERESTARTSYS; 906 907 return ret; 908 } 909 910 /** 911 * __ttm_bo_unreserve 912 * @bo: A pointer to a struct ttm_buffer_object. 913 * 914 * Unreserve a previous reservation of @bo where the buffer object is 915 * already on lru lists. 916 */ 917 static inline void __ttm_bo_unreserve(struct ttm_buffer_object *bo) 918 { 919 ww_mutex_unlock(&bo->resv->lock); 920 } 921 922 /** 923 * ttm_bo_unreserve 924 * 925 * @bo: A pointer to a struct ttm_buffer_object. 926 * 927 * Unreserve a previous reservation of @bo. 928 */ 929 static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo) 930 { 931 if (!(bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) { 932 lockmgr(&bo->glob->lru_lock, LK_EXCLUSIVE); 933 ttm_bo_add_to_lru(bo); 934 lockmgr(&bo->glob->lru_lock, LK_RELEASE); 935 } 936 __ttm_bo_unreserve(bo); 937 } 938 939 /** 940 * ttm_bo_unreserve_ticket 941 * @bo: A pointer to a struct ttm_buffer_object. 942 * @ticket: ww_acquire_ctx used for reserving 943 * 944 * Unreserve a previous reservation of @bo made with @ticket. 945 */ 946 static inline void ttm_bo_unreserve_ticket(struct ttm_buffer_object *bo, 947 struct ww_acquire_ctx *t) 948 { 949 ttm_bo_unreserve(bo); 950 } 951 952 /* 953 * ttm_bo_util.c 954 */ 955 956 int ttm_mem_io_reserve(struct ttm_bo_device *bdev, 957 struct ttm_mem_reg *mem); 958 void ttm_mem_io_free(struct ttm_bo_device *bdev, 959 struct ttm_mem_reg *mem); 960 /** 961 * ttm_bo_move_ttm 962 * 963 * @bo: A pointer to a struct ttm_buffer_object. 964 * @interruptible: Sleep interruptible if waiting. 965 * @no_wait_gpu: Return immediately if the GPU is busy. 966 * @new_mem: struct ttm_mem_reg indicating where to move. 967 * 968 * Optimized move function for a buffer object with both old and 969 * new placement backed by a TTM. The function will, if successful, 970 * free any old aperture space, and set (@new_mem)->mm_node to NULL, 971 * and update the (@bo)->mem placement flags. If unsuccessful, the old 972 * data remains untouched, and it's up to the caller to free the 973 * memory space indicated by @new_mem. 974 * Returns: 975 * !0: Failure. 976 */ 977 978 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo, 979 bool interruptible, bool no_wait_gpu, 980 struct ttm_mem_reg *new_mem); 981 982 /** 983 * ttm_bo_move_memcpy 984 * 985 * @bo: A pointer to a struct ttm_buffer_object. 986 * @interruptible: Sleep interruptible if waiting. 987 * @no_wait_gpu: Return immediately if the GPU is busy. 988 * @new_mem: struct ttm_mem_reg indicating where to move. 989 * 990 * Fallback move function for a mappable buffer object in mappable memory. 991 * The function will, if successful, 992 * free any old aperture space, and set (@new_mem)->mm_node to NULL, 993 * and update the (@bo)->mem placement flags. If unsuccessful, the old 994 * data remains untouched, and it's up to the caller to free the 995 * memory space indicated by @new_mem. 996 * Returns: 997 * !0: Failure. 998 */ 999 1000 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo, 1001 bool interruptible, bool no_wait_gpu, 1002 struct ttm_mem_reg *new_mem); 1003 1004 /** 1005 * ttm_bo_free_old_node 1006 * 1007 * @bo: A pointer to a struct ttm_buffer_object. 1008 * 1009 * Utility function to free an old placement after a successful move. 1010 */ 1011 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo); 1012 1013 /** 1014 * ttm_bo_move_accel_cleanup. 1015 * 1016 * @bo: A pointer to a struct ttm_buffer_object. 1017 * @fence: A fence object that signals when moving is complete. 1018 * @evict: This is an evict move. Don't return until the buffer is idle. 1019 * @new_mem: struct ttm_mem_reg indicating where to move. 1020 * 1021 * Accelerated move function to be called when an accelerated move 1022 * has been scheduled. The function will create a new temporary buffer object 1023 * representing the old placement, and put the sync object on both buffer 1024 * objects. After that the newly created buffer object is unref'd to be 1025 * destroyed when the move is complete. This will help pipeline 1026 * buffer moves. 1027 */ 1028 1029 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo, 1030 struct fence *fence, bool evict, 1031 struct ttm_mem_reg *new_mem); 1032 1033 /** 1034 * ttm_bo_pipeline_move. 1035 * 1036 * @bo: A pointer to a struct ttm_buffer_object. 1037 * @fence: A fence object that signals when moving is complete. 1038 * @evict: This is an evict move. Don't return until the buffer is idle. 1039 * @new_mem: struct ttm_mem_reg indicating where to move. 1040 * 1041 * Function for pipelining accelerated moves. Either free the memory 1042 * immediately or hang it on a temporary buffer object. 1043 */ 1044 int ttm_bo_pipeline_move(struct ttm_buffer_object *bo, 1045 struct fence *fence, bool evict, 1046 struct ttm_mem_reg *new_mem); 1047 1048 /** 1049 * ttm_io_prot 1050 * 1051 * @c_state: Caching state. 1052 * @tmp: Page protection flag for a normal, cached mapping. 1053 * 1054 * Utility function that returns the pgprot_t that should be used for 1055 * setting up a PTE with the caching model indicated by @c_state. 1056 */ 1057 extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp); 1058 1059 extern const struct ttm_mem_type_manager_func ttm_bo_manager_func; 1060 1061 #if IS_ENABLED(CONFIG_AGP) 1062 #include <linux/agp_backend.h> 1063 1064 /** 1065 * ttm_agp_tt_create 1066 * 1067 * @bdev: Pointer to a struct ttm_bo_device. 1068 * @bridge: The agp bridge this device is sitting on. 1069 * @size: Size of the data needed backing. 1070 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. 1071 * @dummy_read_page: See struct ttm_bo_device. 1072 * 1073 * 1074 * Create a TTM backend that uses the indicated AGP bridge as an aperture 1075 * for TT memory. This function uses the linux agpgart interface to 1076 * bind and unbind memory backing a ttm_tt. 1077 */ 1078 extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev, 1079 struct agp_bridge_data *bridge, 1080 unsigned long size, uint32_t page_flags, 1081 struct page *dummy_read_page); 1082 int ttm_agp_tt_populate(struct ttm_tt *ttm); 1083 void ttm_agp_tt_unpopulate(struct ttm_tt *ttm); 1084 #endif 1085 1086 /* required for DragonFly VM, see ttm/ttm_bo_vm.c */ 1087 struct ttm_bo_device_buffer_objects; 1088 int ttm_bo_cmp_rb_tree_items(struct ttm_buffer_object *a, 1089 struct ttm_buffer_object *b); 1090 RB_PROTOTYPE(ttm_bo_device_buffer_objects, ttm_buffer_object, vm_rb, 1091 ttm_bo_cmp_rb_tree_items); 1092 1093 #endif 1094