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