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