[mirror_ubuntu-bionic-kernel.git] / include / drm / ttm / ttm_execbuf_util.h

/**************************************************************************
 *
 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/
/*
 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
 */

#ifndef _TTM_EXECBUF_UTIL_H_
#define _TTM_EXECBUF_UTIL_H_

#include <linux/list.h>

#include "ttm_bo_api.h"

/**
 * struct ttm_validate_buffer
 *
 * @head:           list head for thread-private list.
 * @bo:             refcounted buffer object pointer.
 * @shared:         should the fence be added shared?
 */

struct ttm_validate_buffer {
	struct list_head head;
	struct ttm_buffer_object *bo;
	bool shared;
};

/**
 * function ttm_eu_backoff_reservation
 *
 * @ticket:   ww_acquire_ctx from reserve call
 * @list:     thread private list of ttm_validate_buffer structs.
 *
 * Undoes all buffer validation reservations for bos pointed to by
 * the list entries.
 */

extern void ttm_eu_backoff_reservation(struct ww_acquire_ctx *ticket,
				       struct list_head *list);

/**
 * function ttm_eu_reserve_buffers
 *
 * @ticket:  [out] ww_acquire_ctx filled in by call, or NULL if only
 *           non-blocking reserves should be tried.
 * @list:    thread private list of ttm_validate_buffer structs.
 * @intr:    should the wait be interruptible
 * @dups:    [out] optional list of duplicates.
 *
 * Tries to reserve bos pointed to by the list entries for validation.
 * If the function returns 0, all buffers are marked as "unfenced",
 * taken off the lru lists and are not synced for write CPU usage.
 *
 * If the function detects a deadlock due to multiple threads trying to
 * reserve the same buffers in reverse order, all threads except one will
 * back off and retry. This function may sleep while waiting for
 * CPU write reservations to be cleared, and for other threads to
 * unreserve their buffers.
 *
 * If intr is set to true, this function may return -ERESTARTSYS if the
 * calling process receives a signal while waiting. In that case, no
 * buffers on the list will be reserved upon return.
 *
 * If dups is non NULL all buffers already reserved by the current thread
 * (e.g. duplicates) are added to this list, otherwise -EALREADY is returned
 * on the first already reserved buffer and all buffers from the list are
 * unreserved again.
 *
 * Buffers reserved by this function should be unreserved by
 * a call to either ttm_eu_backoff_reservation() or
 * ttm_eu_fence_buffer_objects() when command submission is complete or
 * has failed.
 */

extern int ttm_eu_reserve_buffers(struct ww_acquire_ctx *ticket,
				  struct list_head *list, bool intr,
				  struct list_head *dups);

/**
 * function ttm_eu_fence_buffer_objects.
 *
 * @ticket:      ww_acquire_ctx from reserve call
 * @list:        thread private list of ttm_validate_buffer structs.
 * @fence:       The new exclusive fence for the buffers.
 *
 * This function should be called when command submission is complete, and
 * it will add a new sync object to bos pointed to by entries on @list.
 * It also unreserves all buffers, putting them on lru lists.
 *
 */

extern void ttm_eu_fence_buffer_objects(struct ww_acquire_ctx *ticket,
					struct list_head *list,
					struct dma_fence *fence);

#endif
Commit	Line	Data
c078aa2f TH	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
	31	#ifndef _TTM_EXECBUF_UTIL_H_
	32	#define _TTM_EXECBUF_UTIL_H_
	33
c078aa2f TH	34	#include <linux/list.h>
c078aa2f TH	35
2da83319 MY	36	#include "ttm_bo_api.h"
2da83319 MY	37
c078aa2f TH	38	/**
	39	* struct ttm_validate_buffer
	40	*
	41	* @head: list head for thread-private list.
	42	* @bo: refcounted buffer object pointer.
ae9c0af2	43	* @shared: should the fence be added shared?
c078aa2f TH	44	*/
	45
	46	struct ttm_validate_buffer {
	47	struct list_head head;
	48	struct ttm_buffer_object *bo;
ae9c0af2	49	bool shared;
c078aa2f TH	50	};
	51
	52	/**
	53	* function ttm_eu_backoff_reservation
	54	*
ecff665f	55	* @ticket: ww_acquire_ctx from reserve call
c078aa2f TH	56	* @list: thread private list of ttm_validate_buffer structs.
	57	*
	58	* Undoes all buffer validation reservations for bos pointed to by
	59	* the list entries.
	60	*/
	61
ecff665f ML	62	extern void ttm_eu_backoff_reservation(struct ww_acquire_ctx *ticket,
ecff665f ML	63	struct list_head *list);
c078aa2f TH	64
	65	/**
	66	* function ttm_eu_reserve_buffers
	67	*
8d17fb44 TH	68	* @ticket: [out] ww_acquire_ctx filled in by call, or NULL if only
8d17fb44 TH	69	* non-blocking reserves should be tried.
c078aa2f	70	* @list: thread private list of ttm_validate_buffer structs.
58b4d720	71	* @intr: should the wait be interruptible
aa35071c	72	* @dups: [out] optional list of duplicates.
c078aa2f TH	73	*
	74	* Tries to reserve bos pointed to by the list entries for validation.
	75	* If the function returns 0, all buffers are marked as "unfenced",
	76	* taken off the lru lists and are not synced for write CPU usage.
	77	*
	78	* If the function detects a deadlock due to multiple threads trying to
	79	* reserve the same buffers in reverse order, all threads except one will
	80	* back off and retry. This function may sleep while waiting for
	81	* CPU write reservations to be cleared, and for other threads to
	82	* unreserve their buffers.
	83	*
58b4d720 ML	84	* If intr is set to true, this function may return -ERESTARTSYS if the
	85	* calling process receives a signal while waiting. In that case, no
	86	* buffers on the list will be reserved upon return.
c078aa2f	87	*
aa35071c CK	88	* If dups is non NULL all buffers already reserved by the current thread
	89	* (e.g. duplicates) are added to this list, otherwise -EALREADY is returned
	90	* on the first already reserved buffer and all buffers from the list are
	91	* unreserved again.
	92	*
c078aa2f TH	93	* Buffers reserved by this function should be unreserved by
	94	* a call to either ttm_eu_backoff_reservation() or
	95	* ttm_eu_fence_buffer_objects() when command submission is complete or
	96	* has failed.
	97	*/
	98
ecff665f	99	extern int ttm_eu_reserve_buffers(struct ww_acquire_ctx *ticket,
aa35071c CK	100	struct list_head *list, bool intr,
aa35071c CK	101	struct list_head *dups);
c078aa2f TH	102
	103	/**
	104	* function ttm_eu_fence_buffer_objects.
	105	*
ecff665f	106	* @ticket: ww_acquire_ctx from reserve call
c078aa2f	107	* @list: thread private list of ttm_validate_buffer structs.
f2c24b83	108	* @fence: The new exclusive fence for the buffers.
c078aa2f TH	109	*
	110	* This function should be called when command submission is complete, and
	111	* it will add a new sync object to bos pointed to by entries on @list.
	112	* It also unreserves all buffers, putting them on lru lists.
	113	*
	114	*/
	115
ecff665f	116	extern void ttm_eu_fence_buffer_objects(struct ww_acquire_ctx *ticket,
f2c24b83	117	struct list_head *list,
f54d1867	118	struct dma_fence *fence);
c078aa2f TH	119
c078aa2f TH	120	#endif