[deliverable/linux.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 <ttm/ttm_bo_api.h>
#include <linux/list.h>

/**
 * struct ttm_validate_buffer
 *
 * @head:           list head for thread-private list.
 * @bo:             refcounted buffer object pointer.
 */

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

/**
 * 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
 *
 * 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.
 *
 * 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);

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