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