~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/drm/ttm/ttm_bo_driver.h

Version: ~ [ linux-5.7 ] ~ [ linux-5.6.15 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.43 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.125 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.182 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.225 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.225 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.84 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp