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 dma_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 /** 378 * struct ttm_bo_driver member eviction_valuable 379 * 380 * @bo: the buffer object to be evicted 381 * @place: placement we need room for 382 * 383 * Check with the driver if it is valuable to evict a BO to make room 384 * for a certain placement. 385 */ 386 bool (*eviction_valuable)(struct ttm_buffer_object *bo, 387 const struct ttm_place *place); 388 /** 389 * struct ttm_bo_driver member evict_flags: 390 * 391 * @bo: the buffer object to be evicted 392 * 393 * Return the bo flags for a buffer which is not mapped to the hardware. 394 * These will be placed in proposed_flags so that when the move is 395 * finished, they'll end up in bo->mem.flags 396 */ 397 398 void (*evict_flags)(struct ttm_buffer_object *bo, 399 struct ttm_placement *placement); 400 401 /** 402 * struct ttm_bo_driver member move: 403 * 404 * @bo: the buffer to move 405 * @evict: whether this motion is evicting the buffer from 406 * the graphics address space 407 * @interruptible: Use interruptible sleeps if possible when sleeping. 408 * @no_wait: whether this should give up and return -EBUSY 409 * if this move would require sleeping 410 * @new_mem: the new memory region receiving the buffer 411 * 412 * Move a buffer between two memory regions. 413 */ 414 int (*move)(struct ttm_buffer_object *bo, bool evict, 415 bool interruptible, bool no_wait_gpu, 416 struct ttm_mem_reg *new_mem); 417 418 /** 419 * struct ttm_bo_driver_member verify_access 420 * 421 * @bo: Pointer to a buffer object. 422 * @filp: Pointer to a struct file trying to access the object. 423 * 424 * Called from the map / write / read methods to verify that the 425 * caller is permitted to access the buffer object. 426 * This member may be set to NULL, which will refuse this kind of 427 * access for all buffer objects. 428 * This function should return 0 if access is granted, -EPERM otherwise. 429 */ 430 int (*verify_access)(struct ttm_buffer_object *bo, 431 struct file *filp); 432 433 /* hook to notify driver about a driver move so it 434 * can do tiling things */ 435 void (*move_notify)(struct ttm_buffer_object *bo, 436 struct ttm_mem_reg *new_mem); 437 /* notify the driver we are taking a fault on this BO 438 * and have reserved it */ 439 int (*fault_reserve_notify)(struct ttm_buffer_object *bo); 440 441 /** 442 * notify the driver that we're about to swap out this bo 443 */ 444 void (*swap_notify)(struct ttm_buffer_object *bo); 445 446 /** 447 * Driver callback on when mapping io memory (for bo_move_memcpy 448 * for instance). TTM will take care to call io_mem_free whenever 449 * the mapping is not use anymore. io_mem_reserve & io_mem_free 450 * are balanced. 451 */ 452 int (*io_mem_reserve)(struct ttm_bo_device *bdev, 453 struct ttm_mem_reg *mem); 454 void (*io_mem_free)(struct ttm_bo_device *bdev, 455 struct ttm_mem_reg *mem); 456 457 /** 458 * Optional driver callback for when BO is removed from the LRU. 459 * Called with LRU lock held immediately before the removal. 460 */ 461 void (*lru_removal)(struct ttm_buffer_object *bo); 462 463 /** 464 * Return the list_head after which a BO should be inserted in the LRU. 465 */ 466 struct list_head *(*lru_tail)(struct ttm_buffer_object *bo); 467 struct list_head *(*swap_lru_tail)(struct ttm_buffer_object *bo); 468 }; 469 470 /** 471 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global. 472 */ 473 474 struct ttm_bo_global_ref { 475 struct drm_global_reference ref; 476 struct ttm_mem_global *mem_glob; 477 }; 478 479 /** 480 * struct ttm_bo_global - Buffer object driver global data. 481 * 482 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting. 483 * @dummy_read_page: Pointer to a dummy page used for mapping requests 484 * of unpopulated pages. 485 * @shrink: A shrink callback object used for buffer object swap. 486 * @device_list_mutex: Mutex protecting the device list. 487 * This mutex is held while traversing the device list for pm options. 488 * @lru_lock: Spinlock protecting the bo subsystem lru lists. 489 * @device_list: List of buffer object devices. 490 * @swap_lru: Lru list of buffer objects used for swapping. 491 */ 492 493 struct ttm_bo_global { 494 495 /** 496 * Constant after init. 497 */ 498 499 struct kobject kobj; 500 struct ttm_mem_global *mem_glob; 501 struct page *dummy_read_page; 502 struct ttm_mem_shrink shrink; 503 struct lock device_list_mutex; 504 struct lock lru_lock; 505 506 /** 507 * Protected by device_list_mutex. 508 */ 509 struct list_head device_list; 510 511 /** 512 * Protected by the lru_lock. 513 */ 514 struct list_head swap_lru; 515 516 /** 517 * Internal protection. 518 */ 519 atomic_t bo_count; 520 }; 521 522 523 #define TTM_NUM_MEM_TYPES 8 524 525 #define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs 526 idling before CPU mapping */ 527 #define TTM_BO_PRIV_FLAG_ACTIVE 1 528 #define TTM_BO_PRIV_FLAG_MAX 2 529 /** 530 * struct ttm_bo_device - Buffer object driver device-specific data. 531 * 532 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver. 533 * @man: An array of mem_type_managers. 534 * @vma_manager: Address space manager 535 * lru_lock: Spinlock that protects the buffer+device lru lists and 536 * ddestroy lists. 537 * @dev_mapping: A pointer to the struct address_space representing the 538 * device address space. 539 * @wq: Work queue structure for the delayed delete workqueue. 540 * 541 */ 542 543 struct ttm_bo_device { 544 545 /* 546 * Constant after bo device init / atomic. 547 */ 548 struct list_head device_list; 549 struct ttm_bo_global *glob; 550 struct ttm_bo_driver *driver; 551 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES]; 552 553 /* 554 * Protected by internal locks. 555 */ 556 struct drm_vma_offset_manager vma_manager; 557 558 /* 559 * Protected by the global:lru lock. 560 */ 561 struct list_head ddestroy; 562 563 /* 564 * Protected by load / firstopen / lastclose /unload sync. 565 */ 566 567 struct address_space *dev_mapping; 568 569 /* 570 * Internal protection. 571 */ 572 573 struct delayed_work wq; 574 575 bool need_dma32; 576 }; 577 578 /** 579 * ttm_flag_masked 580 * 581 * @old: Pointer to the result and original value. 582 * @new: New value of bits. 583 * @mask: Mask of bits to change. 584 * 585 * Convenience function to change a number of bits identified by a mask. 586 */ 587 588 static inline uint32_t 589 ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask) 590 { 591 *old ^= (*old ^ new) & mask; 592 return *old; 593 } 594 595 /** 596 * ttm_tt_init 597 * 598 * @ttm: The struct ttm_tt. 599 * @bdev: pointer to a struct ttm_bo_device: 600 * @size: Size of the data needed backing. 601 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. 602 * @dummy_read_page: See struct ttm_bo_device. 603 * 604 * Create a struct ttm_tt to back data with system memory pages. 605 * No pages are actually allocated. 606 * Returns: 607 * NULL: Out of memory. 608 */ 609 extern int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev, 610 unsigned long size, uint32_t page_flags, 611 struct page *dummy_read_page); 612 extern int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev, 613 unsigned long size, uint32_t page_flags, 614 struct page *dummy_read_page); 615 616 /** 617 * ttm_tt_fini 618 * 619 * @ttm: the ttm_tt structure. 620 * 621 * Free memory of ttm_tt structure 622 */ 623 extern void ttm_tt_fini(struct ttm_tt *ttm); 624 extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma); 625 626 /** 627 * ttm_ttm_bind: 628 * 629 * @ttm: The struct ttm_tt containing backing pages. 630 * @bo_mem: The struct ttm_mem_reg identifying the binding location. 631 * 632 * Bind the pages of @ttm to an aperture location identified by @bo_mem 633 */ 634 extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); 635 636 /** 637 * ttm_ttm_destroy: 638 * 639 * @ttm: The struct ttm_tt. 640 * 641 * Unbind, unpopulate and destroy common struct ttm_tt. 642 */ 643 extern void ttm_tt_destroy(struct ttm_tt *ttm); 644 645 /** 646 * ttm_ttm_unbind: 647 * 648 * @ttm: The struct ttm_tt. 649 * 650 * Unbind a struct ttm_tt. 651 */ 652 extern void ttm_tt_unbind(struct ttm_tt *ttm); 653 654 /** 655 * ttm_tt_swapin: 656 * 657 * @ttm: The struct ttm_tt. 658 * 659 * Swap in a previously swap out ttm_tt. 660 */ 661 extern int ttm_tt_swapin(struct ttm_tt *ttm); 662 663 /** 664 * ttm_tt_set_placement_caching: 665 * 666 * @ttm A struct ttm_tt the backing pages of which will change caching policy. 667 * @placement: Flag indicating the desired caching policy. 668 * 669 * This function will change caching policy of any default kernel mappings of 670 * the pages backing @ttm. If changing from cached to uncached or 671 * write-combined, 672 * all CPU caches will first be flushed to make sure the data of the pages 673 * hit RAM. This function may be very costly as it involves global TLB 674 * and cache flushes and potential page splitting / combining. 675 */ 676 extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement); 677 extern int ttm_tt_swapout(struct ttm_tt *ttm, 678 struct vm_object *persistent_swap_storage); 679 680 /** 681 * ttm_tt_unpopulate - free pages from a ttm 682 * 683 * @ttm: Pointer to the ttm_tt structure 684 * 685 * Calls the driver method to free all pages from a ttm 686 */ 687 extern void ttm_tt_unpopulate(struct ttm_tt *ttm); 688 689 /* 690 * ttm_bo.c 691 */ 692 693 /** 694 * ttm_mem_reg_is_pci 695 * 696 * @bdev: Pointer to a struct ttm_bo_device. 697 * @mem: A valid struct ttm_mem_reg. 698 * 699 * Returns true if the memory described by @mem is PCI memory, 700 * false otherwise. 701 */ 702 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev, 703 struct ttm_mem_reg *mem); 704 705 /** 706 * ttm_bo_mem_space 707 * 708 * @bo: Pointer to a struct ttm_buffer_object. the data of which 709 * we want to allocate space for. 710 * @proposed_placement: Proposed new placement for the buffer object. 711 * @mem: A struct ttm_mem_reg. 712 * @interruptible: Sleep interruptible when sliping. 713 * @no_wait_gpu: Return immediately if the GPU is busy. 714 * 715 * Allocate memory space for the buffer object pointed to by @bo, using 716 * the placement flags in @mem, potentially evicting other idle buffer objects. 717 * This function may sleep while waiting for space to become available. 718 * Returns: 719 * -EBUSY: No space available (only if no_wait == 1). 720 * -ENOMEM: Could not allocate memory for the buffer object, either due to 721 * fragmentation or concurrent allocators. 722 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal. 723 */ 724 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo, 725 struct ttm_placement *placement, 726 struct ttm_mem_reg *mem, 727 bool interruptible, 728 bool no_wait_gpu); 729 730 extern void ttm_bo_mem_put(struct ttm_buffer_object *bo, 731 struct ttm_mem_reg *mem); 732 extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo, 733 struct ttm_mem_reg *mem); 734 735 extern void ttm_bo_global_release(struct drm_global_reference *ref); 736 extern int ttm_bo_global_init(struct drm_global_reference *ref); 737 738 extern int ttm_bo_device_release(struct ttm_bo_device *bdev); 739 740 /** 741 * ttm_bo_device_init 742 * 743 * @bdev: A pointer to a struct ttm_bo_device to initialize. 744 * @glob: A pointer to an initialized struct ttm_bo_global. 745 * @driver: A pointer to a struct ttm_bo_driver set up by the caller. 746 * @mapping: The address space to use for this bo. 747 * @file_page_offset: Offset into the device address space that is available 748 * for buffer data. This ensures compatibility with other users of the 749 * address space. 750 * 751 * Initializes a struct ttm_bo_device: 752 * Returns: 753 * !0: Failure. 754 */ 755 extern int ttm_bo_device_init(struct ttm_bo_device *bdev, 756 struct ttm_bo_global *glob, 757 struct ttm_bo_driver *driver, 758 struct address_space *mapping, 759 uint64_t file_page_offset, bool need_dma32); 760 761 /** 762 * ttm_bo_unmap_virtual 763 * 764 * @bo: tear down the virtual mappings for this BO 765 */ 766 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo); 767 768 /** 769 * ttm_bo_unmap_virtual 770 * 771 * @bo: tear down the virtual mappings for this BO 772 * 773 * The caller must take ttm_mem_io_lock before calling this function. 774 */ 775 extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo); 776 777 extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo); 778 extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo); 779 extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man, 780 bool interruptible); 781 extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man); 782 783 extern void ttm_bo_del_sub_from_lru(struct ttm_buffer_object *bo); 784 785 struct list_head *ttm_bo_default_lru_tail(struct ttm_buffer_object *bo); 786 struct list_head *ttm_bo_default_swap_lru_tail(struct ttm_buffer_object *bo); 787 788 /** 789 * __ttm_bo_reserve: 790 * 791 * @bo: A pointer to a struct ttm_buffer_object. 792 * @interruptible: Sleep interruptible if waiting. 793 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. 794 * @ticket: ticket used to acquire the ww_mutex. 795 * 796 * Will not remove reserved buffers from the lru lists. 797 * Otherwise identical to ttm_bo_reserve. 798 * 799 * Returns: 800 * -EDEADLK: The reservation may cause a deadlock. 801 * Release all buffer reservations, wait for @bo to become unreserved and 802 * try again. (only if use_sequence == 1). 803 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by 804 * a signal. Release all buffer reservations and return to user-space. 805 * -EBUSY: The function needed to sleep, but @no_wait was true 806 * -EALREADY: Bo already reserved using @ticket. This error code will only 807 * be returned if @use_ticket is set to true. 808 */ 809 static inline int __ttm_bo_reserve(struct ttm_buffer_object *bo, 810 bool interruptible, bool no_wait, 811 struct ww_acquire_ctx *ticket) 812 { 813 int ret = 0; 814 815 if (no_wait) { 816 bool success; 817 if (WARN_ON(ticket)) 818 return -EBUSY; 819 820 success = ww_mutex_trylock(&bo->resv->lock); 821 return success ? 0 : -EBUSY; 822 } 823 824 if (interruptible) 825 ret = ww_mutex_lock_interruptible(&bo->resv->lock, ticket); 826 else 827 ret = ww_mutex_lock(&bo->resv->lock, ticket); 828 if (ret == -EINTR) 829 return -ERESTARTSYS; 830 return ret; 831 } 832 833 /** 834 * ttm_bo_reserve: 835 * 836 * @bo: A pointer to a struct ttm_buffer_object. 837 * @interruptible: Sleep interruptible if waiting. 838 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. 839 * @ticket: ticket used to acquire the ww_mutex. 840 * 841 * Locks a buffer object for validation. (Or prevents other processes from 842 * locking it for validation) and removes it from lru lists, while taking 843 * a number of measures to prevent deadlocks. 844 * 845 * Deadlocks may occur when two processes try to reserve multiple buffers in 846 * different order, either by will or as a result of a buffer being evicted 847 * to make room for a buffer already reserved. (Buffers are reserved before 848 * they are evicted). The following algorithm prevents such deadlocks from 849 * occurring: 850 * Processes attempting to reserve multiple buffers other than for eviction, 851 * (typically execbuf), should first obtain a unique 32-bit 852 * validation sequence number, 853 * and call this function with @use_ticket == 1 and @ticket->stamp == the unique 854 * sequence number. If upon call of this function, the buffer object is already 855 * reserved, the validation sequence is checked against the validation 856 * sequence of the process currently reserving the buffer, 857 * and if the current validation sequence is greater than that of the process 858 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps 859 * waiting for the buffer to become unreserved, after which it retries 860 * reserving. 861 * The caller should, when receiving an -EAGAIN error 862 * release all its buffer reservations, wait for @bo to become unreserved, and 863 * then rerun the validation with the same validation sequence. This procedure 864 * will always guarantee that the process with the lowest validation sequence 865 * will eventually succeed, preventing both deadlocks and starvation. 866 * 867 * Returns: 868 * -EDEADLK: The reservation may cause a deadlock. 869 * Release all buffer reservations, wait for @bo to become unreserved and 870 * try again. (only if use_sequence == 1). 871 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by 872 * a signal. Release all buffer reservations and return to user-space. 873 * -EBUSY: The function needed to sleep, but @no_wait was true 874 * -EALREADY: Bo already reserved using @ticket. This error code will only 875 * be returned if @use_ticket is set to true. 876 */ 877 static inline int ttm_bo_reserve(struct ttm_buffer_object *bo, 878 bool interruptible, bool no_wait, 879 struct ww_acquire_ctx *ticket) 880 { 881 int ret; 882 883 WARN_ON(!atomic_read(&bo->kref.refcount)); 884 885 ret = __ttm_bo_reserve(bo, interruptible, no_wait, ticket); 886 if (likely(ret == 0)) 887 ttm_bo_del_sub_from_lru(bo); 888 889 return ret; 890 } 891 892 /** 893 * ttm_bo_reserve_slowpath: 894 * @bo: A pointer to a struct ttm_buffer_object. 895 * @interruptible: Sleep interruptible if waiting. 896 * @sequence: Set (@bo)->sequence to this value after lock 897 * 898 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off 899 * from all our other reservations. Because there are no other reservations 900 * held by us, this function cannot deadlock any more. 901 */ 902 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo, 903 bool interruptible, 904 struct ww_acquire_ctx *ticket) 905 { 906 int ret = 0; 907 908 WARN_ON(!atomic_read(&bo->kref.refcount)); 909 910 if (interruptible) 911 ret = ww_mutex_lock_slow_interruptible(&bo->resv->lock, 912 ticket); 913 else 914 ww_mutex_lock_slow(&bo->resv->lock, ticket); 915 916 if (likely(ret == 0)) 917 ttm_bo_del_sub_from_lru(bo); 918 else if (ret == -EINTR) 919 ret = -ERESTARTSYS; 920 921 return ret; 922 } 923 924 /** 925 * __ttm_bo_unreserve 926 * @bo: A pointer to a struct ttm_buffer_object. 927 * 928 * Unreserve a previous reservation of @bo where the buffer object is 929 * already on lru lists. 930 */ 931 static inline void __ttm_bo_unreserve(struct ttm_buffer_object *bo) 932 { 933 ww_mutex_unlock(&bo->resv->lock); 934 } 935 936 /** 937 * ttm_bo_unreserve 938 * 939 * @bo: A pointer to a struct ttm_buffer_object. 940 * 941 * Unreserve a previous reservation of @bo. 942 */ 943 static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo) 944 { 945 if (!(bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) { 946 lockmgr(&bo->glob->lru_lock, LK_EXCLUSIVE); 947 ttm_bo_add_to_lru(bo); 948 lockmgr(&bo->glob->lru_lock, LK_RELEASE); 949 } 950 __ttm_bo_unreserve(bo); 951 } 952 953 /** 954 * ttm_bo_unreserve_ticket 955 * @bo: A pointer to a struct ttm_buffer_object. 956 * @ticket: ww_acquire_ctx used for reserving 957 * 958 * Unreserve a previous reservation of @bo made with @ticket. 959 */ 960 static inline void ttm_bo_unreserve_ticket(struct ttm_buffer_object *bo, 961 struct ww_acquire_ctx *t) 962 { 963 ttm_bo_unreserve(bo); 964 } 965 966 /* 967 * ttm_bo_util.c 968 */ 969 970 int ttm_mem_io_reserve(struct ttm_bo_device *bdev, 971 struct ttm_mem_reg *mem); 972 void ttm_mem_io_free(struct ttm_bo_device *bdev, 973 struct ttm_mem_reg *mem); 974 /** 975 * ttm_bo_move_ttm 976 * 977 * @bo: A pointer to a struct ttm_buffer_object. 978 * @interruptible: Sleep interruptible if waiting. 979 * @no_wait_gpu: Return immediately if the GPU is busy. 980 * @new_mem: struct ttm_mem_reg indicating where to move. 981 * 982 * Optimized move function for a buffer object with both old and 983 * new placement backed by a TTM. The function will, if successful, 984 * free any old aperture space, and set (@new_mem)->mm_node to NULL, 985 * and update the (@bo)->mem placement flags. If unsuccessful, the old 986 * data remains untouched, and it's up to the caller to free the 987 * memory space indicated by @new_mem. 988 * Returns: 989 * !0: Failure. 990 */ 991 992 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo, 993 bool interruptible, bool no_wait_gpu, 994 struct ttm_mem_reg *new_mem); 995 996 /** 997 * ttm_bo_move_memcpy 998 * 999 * @bo: A pointer to a struct ttm_buffer_object. 1000 * @interruptible: Sleep interruptible if waiting. 1001 * @no_wait_gpu: Return immediately if the GPU is busy. 1002 * @new_mem: struct ttm_mem_reg indicating where to move. 1003 * 1004 * Fallback move function for a mappable buffer object in mappable memory. 1005 * The function will, if successful, 1006 * free any old aperture space, and set (@new_mem)->mm_node to NULL, 1007 * and update the (@bo)->mem placement flags. If unsuccessful, the old 1008 * data remains untouched, and it's up to the caller to free the 1009 * memory space indicated by @new_mem. 1010 * Returns: 1011 * !0: Failure. 1012 */ 1013 1014 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo, 1015 bool interruptible, bool no_wait_gpu, 1016 struct ttm_mem_reg *new_mem); 1017 1018 /** 1019 * ttm_bo_free_old_node 1020 * 1021 * @bo: A pointer to a struct ttm_buffer_object. 1022 * 1023 * Utility function to free an old placement after a successful move. 1024 */ 1025 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo); 1026 1027 /** 1028 * ttm_bo_move_accel_cleanup. 1029 * 1030 * @bo: A pointer to a struct ttm_buffer_object. 1031 * @fence: A fence object that signals when moving is complete. 1032 * @evict: This is an evict move. Don't return until the buffer is idle. 1033 * @new_mem: struct ttm_mem_reg indicating where to move. 1034 * 1035 * Accelerated move function to be called when an accelerated move 1036 * has been scheduled. The function will create a new temporary buffer object 1037 * representing the old placement, and put the sync object on both buffer 1038 * objects. After that the newly created buffer object is unref'd to be 1039 * destroyed when the move is complete. This will help pipeline 1040 * buffer moves. 1041 */ 1042 1043 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo, 1044 struct dma_fence *fence, bool evict, 1045 struct ttm_mem_reg *new_mem); 1046 1047 /** 1048 * ttm_bo_pipeline_move. 1049 * 1050 * @bo: A pointer to a struct ttm_buffer_object. 1051 * @fence: A fence object that signals when moving is complete. 1052 * @evict: This is an evict move. Don't return until the buffer is idle. 1053 * @new_mem: struct ttm_mem_reg indicating where to move. 1054 * 1055 * Function for pipelining accelerated moves. Either free the memory 1056 * immediately or hang it on a temporary buffer object. 1057 */ 1058 int ttm_bo_pipeline_move(struct ttm_buffer_object *bo, 1059 struct dma_fence *fence, bool evict, 1060 struct ttm_mem_reg *new_mem); 1061 1062 /** 1063 * ttm_io_prot 1064 * 1065 * @c_state: Caching state. 1066 * @tmp: Page protection flag for a normal, cached mapping. 1067 * 1068 * Utility function that returns the pgprot_t that should be used for 1069 * setting up a PTE with the caching model indicated by @c_state. 1070 */ 1071 extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp); 1072 1073 extern const struct ttm_mem_type_manager_func ttm_bo_manager_func; 1074 1075 #if IS_ENABLED(CONFIG_AGP) 1076 #include <linux/agp_backend.h> 1077 1078 /** 1079 * ttm_agp_tt_create 1080 * 1081 * @bdev: Pointer to a struct ttm_bo_device. 1082 * @bridge: The agp bridge this device is sitting on. 1083 * @size: Size of the data needed backing. 1084 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. 1085 * @dummy_read_page: See struct ttm_bo_device. 1086 * 1087 * 1088 * Create a TTM backend that uses the indicated AGP bridge as an aperture 1089 * for TT memory. This function uses the linux agpgart interface to 1090 * bind and unbind memory backing a ttm_tt. 1091 */ 1092 extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev, 1093 struct agp_bridge_data *bridge, 1094 unsigned long size, uint32_t page_flags, 1095 struct page *dummy_read_page); 1096 int ttm_agp_tt_populate(struct ttm_tt *ttm); 1097 void ttm_agp_tt_unpopulate(struct ttm_tt *ttm); 1098 #endif 1099 1100 /* required for DragonFly VM, see ttm/ttm_bo_vm.c */ 1101 struct ttm_bo_device_buffer_objects; 1102 int ttm_bo_cmp_rb_tree_items(struct ttm_buffer_object *a, 1103 struct ttm_buffer_object *b); 1104 RB_PROTOTYPE(ttm_bo_device_buffer_objects, ttm_buffer_object, vm_rb, 1105 ttm_bo_cmp_rb_tree_items); 1106 1107 #endif 1108