[linux-block.git] / drivers / gpu / drm / vmwgfx / vmwgfx_validation.h

/* SPDX-License-Identifier: GPL-2.0 OR MIT */
/**************************************************************************
 *
 * Copyright © 2018 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.
 *
 **************************************************************************/
#ifndef _VMWGFX_VALIDATION_H_
#define _VMWGFX_VALIDATION_H_

#include <linux/list.h>
#include <linux/ww_mutex.h>

#include <drm/ttm/ttm_execbuf_util.h>

#include "vmwgfx_hashtab.h"

#define VMW_RES_DIRTY_NONE 0
#define VMW_RES_DIRTY_SET BIT(0)
#define VMW_RES_DIRTY_CLEAR BIT(1)

/**
 * struct vmw_validation_context - Per command submission validation context
 * @ht: Hash table used to find resource- or buffer object duplicates
 * @resource_list: List head for resource validation metadata
 * @resource_ctx_list: List head for resource validation metadata for
 * resources that need to be validated before those in @resource_list
 * @bo_list: List head for buffer objects
 * @page_list: List of pages used by the memory allocator
 * @ticket: Ticked used for ww mutex locking
 * @res_mutex: Pointer to mutex used for resource reserving
 * @merge_dups: Whether to merge metadata for duplicate resources or
 * buffer objects
 * @mem_size_left: Free memory left in the last page in @page_list
 * @page_address: Kernel virtual address of the last page in @page_list
 * @vm: A pointer to the memory reservation interface or NULL if no
 * memory reservation is needed.
 * @vm_size_left: Amount of reserved memory that so far has not been allocated.
 * @total_mem: Amount of reserved memory.
 */
struct vmw_validation_context {
	struct vmwgfx_open_hash *ht;
	struct list_head resource_list;
	struct list_head resource_ctx_list;
	struct list_head bo_list;
	struct list_head page_list;
	struct ww_acquire_ctx ticket;
	struct mutex *res_mutex;
	unsigned int merge_dups;
	unsigned int mem_size_left;
	u8 *page_address;
	struct vmw_validation_mem *vm;
	size_t vm_size_left;
	size_t total_mem;
};

struct vmw_buffer_object;
struct vmw_resource;
struct vmw_fence_obj;

#if 0
/**
 * DECLARE_VAL_CONTEXT - Declare a validation context with initialization
 * @_name: The name of the variable
 * @_ht: The hash table used to find dups or NULL if none
 * @_merge_dups: Whether to merge duplicate buffer object- or resource
 * entries. If set to true, ideally a hash table pointer should be supplied
 * as well unless the number of resources and buffer objects per validation
 * is known to be very small
 */
#endif
#define DECLARE_VAL_CONTEXT(_name, _ht, _merge_dups)			\
	struct vmw_validation_context _name =				\
	{ .ht = _ht,							\
	  .resource_list = LIST_HEAD_INIT((_name).resource_list),	\
	  .resource_ctx_list = LIST_HEAD_INIT((_name).resource_ctx_list), \
	  .bo_list = LIST_HEAD_INIT((_name).bo_list),			\
	  .page_list = LIST_HEAD_INIT((_name).page_list),		\
	  .res_mutex = NULL,						\
	  .merge_dups = _merge_dups,					\
	  .mem_size_left = 0,						\
	}

/**
 * vmw_validation_has_bos - return whether the validation context has
 * any buffer objects registered.
 *
 * @ctx: The validation context
 * Returns: Whether any buffer objects are registered
 */
static inline bool
vmw_validation_has_bos(struct vmw_validation_context *ctx)
{
	return !list_empty(&ctx->bo_list);
}

/**
 * vmw_validation_set_ht - Register a hash table for duplicate finding
 * @ctx: The validation context
 * @ht: Pointer to a hash table to use for duplicate finding
 * This function is intended to be used if the hash table wasn't
 * available at validation context declaration time
 */
static inline void vmw_validation_set_ht(struct vmw_validation_context *ctx,
					 struct vmwgfx_open_hash *ht)
{
	ctx->ht = ht;
}

/**
 * vmw_validation_bo_reserve - Reserve buffer objects registered with a
 * validation context
 * @ctx: The validation context
 * @intr: Perform waits interruptible
 *
 * Return: Zero on success, -ERESTARTSYS when interrupted, negative error
 * code on failure
 */
static inline int
vmw_validation_bo_reserve(struct vmw_validation_context *ctx,
			  bool intr)
{
	return ttm_eu_reserve_buffers(&ctx->ticket, &ctx->bo_list, intr,
				      NULL);
}

/**
 * vmw_validation_bo_fence - Unreserve and fence buffer objects registered
 * with a validation context
 * @ctx: The validation context
 *
 * This function unreserves the buffer objects previously reserved using
 * vmw_validation_bo_reserve, and fences them with a fence object.
 */
static inline void
vmw_validation_bo_fence(struct vmw_validation_context *ctx,
			struct vmw_fence_obj *fence)
{
	ttm_eu_fence_buffer_objects(&ctx->ticket, &ctx->bo_list,
				    (void *) fence);
}

/**
 * vmw_validation_align - Align a validation memory allocation
 * @val: The size to be aligned
 *
 * Returns: @val aligned to the granularity used by the validation memory
 * allocator.
 */
static inline unsigned int vmw_validation_align(unsigned int val)
{
	return ALIGN(val, sizeof(long));
}

int vmw_validation_add_bo(struct vmw_validation_context *ctx,
			  struct vmw_buffer_object *vbo,
			  bool as_mob, bool cpu_blit);
int vmw_validation_bo_validate_single(struct ttm_buffer_object *bo,
				      bool interruptible,
				      bool validate_as_mob);
int vmw_validation_bo_validate(struct vmw_validation_context *ctx, bool intr);
void vmw_validation_unref_lists(struct vmw_validation_context *ctx);
int vmw_validation_add_resource(struct vmw_validation_context *ctx,
				struct vmw_resource *res,
				size_t priv_size,
				u32 dirty,
				void **p_node,
				bool *first_usage);
void vmw_validation_drop_ht(struct vmw_validation_context *ctx);
int vmw_validation_res_reserve(struct vmw_validation_context *ctx,
			       bool intr);
void vmw_validation_res_unreserve(struct vmw_validation_context *ctx,
				  bool backoff);
void vmw_validation_res_switch_backup(struct vmw_validation_context *ctx,
				      void *val_private,
				      struct vmw_buffer_object *vbo,
				      unsigned long backup_offset);
int vmw_validation_res_validate(struct vmw_validation_context *ctx, bool intr);

int vmw_validation_prepare(struct vmw_validation_context *ctx,
			   struct mutex *mutex, bool intr);
void vmw_validation_revert(struct vmw_validation_context *ctx);
void vmw_validation_done(struct vmw_validation_context *ctx,
			 struct vmw_fence_obj *fence);

void *vmw_validation_mem_alloc(struct vmw_validation_context *ctx,
			       unsigned int size);
int vmw_validation_preload_bo(struct vmw_validation_context *ctx);
int vmw_validation_preload_res(struct vmw_validation_context *ctx,
			       unsigned int size);
void vmw_validation_res_set_dirty(struct vmw_validation_context *ctx,
				  void *val_private, u32 dirty);
void vmw_validation_bo_backoff(struct vmw_validation_context *ctx);

#endif
Commit	Line	Data
038ecc50 TH	1	/* SPDX-License-Identifier: GPL-2.0 OR MIT */
	2	/**************************************************************************
	3	*
	4	* Copyright © 2018 VMware, Inc., Palo Alto, CA., USA
	5	* All Rights Reserved.
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a
	8	* copy of this software and associated documentation files (the
	9	* "Software"), to deal in the Software without restriction, including
	10	* without limitation the rights to use, copy, modify, merge, publish,
	11	* distribute, sub license, and/or sell copies of the Software, and to
	12	* permit persons to whom the Software is furnished to do so, subject to
	13	* the following conditions:
	14	*
	15	* The above copyright notice and this permission notice (including the
	16	* next paragraph) shall be included in all copies or substantial portions
	17	* of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
	22	* THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
	23	* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
	24	* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
	25	* USE OR OTHER DEALINGS IN THE SOFTWARE.
	26	*
	27	**************************************************************************/
	28	#ifndef _VMWGFX_VALIDATION_H_
	29	#define _VMWGFX_VALIDATION_H_
	30
038ecc50 TH	31	#include <linux/list.h>
038ecc50 TH	32	#include <linux/ww_mutex.h>
d5c1f011	33
038ecc50 TH	34	#include <drm/ttm/ttm_execbuf_util.h>
038ecc50 TH	35
2985c964 TZ	36	#include "vmwgfx_hashtab.h"
2985c964 TZ	37
a9f58c45 TH	38	#define VMW_RES_DIRTY_NONE 0
	39	#define VMW_RES_DIRTY_SET BIT(0)
	40	#define VMW_RES_DIRTY_CLEAR BIT(1)
	41
038ecc50 TH	42	/**
	43	* struct vmw_validation_context - Per command submission validation context
	44	* @ht: Hash table used to find resource- or buffer object duplicates
	45	* @resource_list: List head for resource validation metadata
	46	* @resource_ctx_list: List head for resource validation metadata for
	47	* resources that need to be validated before those in @resource_list
	48	* @bo_list: List head for buffer objects
fc18afcf	49	* @page_list: List of pages used by the memory allocator
038ecc50 TH	50	* @ticket: Ticked used for ww mutex locking
	51	* @res_mutex: Pointer to mutex used for resource reserving
	52	* @merge_dups: Whether to merge metadata for duplicate resources or
	53	* buffer objects
fc18afcf TH	54	* @mem_size_left: Free memory left in the last page in @page_list
fc18afcf TH	55	* @page_address: Kernel virtual address of the last page in @page_list
fd567467 TH	56	* @vm: A pointer to the memory reservation interface or NULL if no
	57	* memory reservation is needed.
	58	* @vm_size_left: Amount of reserved memory that so far has not been allocated.
	59	* @total_mem: Amount of reserved memory.
038ecc50 TH	60	*/
038ecc50 TH	61	struct vmw_validation_context {
2985c964	62	struct vmwgfx_open_hash *ht;
038ecc50 TH	63	struct list_head resource_list;
	64	struct list_head resource_ctx_list;
	65	struct list_head bo_list;
fc18afcf	66	struct list_head page_list;
038ecc50 TH	67	struct ww_acquire_ctx ticket;
	68	struct mutex *res_mutex;
	69	unsigned int merge_dups;
fc18afcf TH	70	unsigned int mem_size_left;
fc18afcf TH	71	u8 *page_address;
fd567467 TH	72	struct vmw_validation_mem *vm;
	73	size_t vm_size_left;
	74	size_t total_mem;
038ecc50 TH	75	};
	76
	77	struct vmw_buffer_object;
	78	struct vmw_resource;
	79	struct vmw_fence_obj;
	80
	81	#if 0
	82	/**
	83	* DECLARE_VAL_CONTEXT - Declare a validation context with initialization
	84	* @_name: The name of the variable
	85	* @_ht: The hash table used to find dups or NULL if none
	86	* @_merge_dups: Whether to merge duplicate buffer object- or resource
	87	* entries. If set to true, ideally a hash table pointer should be supplied
	88	* as well unless the number of resources and buffer objects per validation
	89	* is known to be very small
	90	*/
	91	#endif
	92	#define DECLARE_VAL_CONTEXT(_name, _ht, _merge_dups) \
	93	struct vmw_validation_context _name = \
	94	{ .ht = _ht, \
	95	.resource_list = LIST_HEAD_INIT((_name).resource_list), \
	96	.resource_ctx_list = LIST_HEAD_INIT((_name).resource_ctx_list), \
	97	.bo_list = LIST_HEAD_INIT((_name).bo_list), \
fc18afcf TH	98	.page_list = LIST_HEAD_INIT((_name).page_list), \
fc18afcf TH	99	.res_mutex = NULL, \
038ecc50	100	.merge_dups = _merge_dups, \
fc18afcf	101	.mem_size_left = 0, \
038ecc50 TH	102	}
	103
	104	/**
	105	* vmw_validation_has_bos - return whether the validation context has
	106	* any buffer objects registered.
	107	*
	108	* @ctx: The validation context
	109	* Returns: Whether any buffer objects are registered
	110	*/
	111	static inline bool
	112	vmw_validation_has_bos(struct vmw_validation_context *ctx)
	113	{
	114	return !list_empty(&ctx->bo_list);
	115	}
	116
	117	/**
	118	* vmw_validation_set_ht - Register a hash table for duplicate finding
	119	* @ctx: The validation context
	120	* @ht: Pointer to a hash table to use for duplicate finding
	121	* This function is intended to be used if the hash table wasn't
	122	* available at validation context declaration time
	123	*/
	124	static inline void vmw_validation_set_ht(struct vmw_validation_context *ctx,
2985c964	125	struct vmwgfx_open_hash *ht)
038ecc50 TH	126	{
	127	ctx->ht = ht;
	128	}
	129
	130	/**
	131	* vmw_validation_bo_reserve - Reserve buffer objects registered with a
	132	* validation context
	133	* @ctx: The validation context
	134	* @intr: Perform waits interruptible
	135	*
	136	* Return: Zero on success, -ERESTARTSYS when interrupted, negative error
	137	* code on failure
	138	*/
	139	static inline int
	140	vmw_validation_bo_reserve(struct vmw_validation_context *ctx,
	141	bool intr)
	142	{
	143	return ttm_eu_reserve_buffers(&ctx->ticket, &ctx->bo_list, intr,
9165fb87	144	NULL);
038ecc50 TH	145	}
038ecc50 TH	146
038ecc50 TH	147	/**
	148	* vmw_validation_bo_fence - Unreserve and fence buffer objects registered
	149	* with a validation context
	150	* @ctx: The validation context
	151	*
	152	* This function unreserves the buffer objects previously reserved using
	153	* vmw_validation_bo_reserve, and fences them with a fence object.
	154	*/
	155	static inline void
	156	vmw_validation_bo_fence(struct vmw_validation_context *ctx,
	157	struct vmw_fence_obj *fence)
	158	{
	159	ttm_eu_fence_buffer_objects(&ctx->ticket, &ctx->bo_list,
	160	(void *) fence);
	161	}
	162
64ad2abf TH	163	/**
	164	* vmw_validation_align - Align a validation memory allocation
	165	* @val: The size to be aligned
	166	*
	167	* Returns: @val aligned to the granularity used by the validation memory
	168	* allocator.
	169	*/
	170	static inline unsigned int vmw_validation_align(unsigned int val)
	171	{
	172	return ALIGN(val, sizeof(long));
	173	}
	174
038ecc50 TH	175	int vmw_validation_add_bo(struct vmw_validation_context *ctx,
	176	struct vmw_buffer_object *vbo,
	177	bool as_mob, bool cpu_blit);
	178	int vmw_validation_bo_validate_single(struct ttm_buffer_object *bo,
	179	bool interruptible,
	180	bool validate_as_mob);
	181	int vmw_validation_bo_validate(struct vmw_validation_context *ctx, bool intr);
	182	void vmw_validation_unref_lists(struct vmw_validation_context *ctx);
	183	int vmw_validation_add_resource(struct vmw_validation_context *ctx,
	184	struct vmw_resource *res,
	185	size_t priv_size,
a9f58c45	186	u32 dirty,
038ecc50 TH	187	void **p_node,
	188	bool *first_usage);
	189	void vmw_validation_drop_ht(struct vmw_validation_context *ctx);
	190	int vmw_validation_res_reserve(struct vmw_validation_context *ctx,
	191	bool intr);
	192	void vmw_validation_res_unreserve(struct vmw_validation_context *ctx,
	193	bool backoff);
	194	void vmw_validation_res_switch_backup(struct vmw_validation_context *ctx,
	195	void *val_private,
	196	struct vmw_buffer_object *vbo,
	197	unsigned long backup_offset);
	198	int vmw_validation_res_validate(struct vmw_validation_context *ctx, bool intr);
	199
	200	int vmw_validation_prepare(struct vmw_validation_context *ctx,
	201	struct mutex *mutex, bool intr);
	202	void vmw_validation_revert(struct vmw_validation_context *ctx);
	203	void vmw_validation_done(struct vmw_validation_context *ctx,
	204	struct vmw_fence_obj *fence);
	205
64ad2abf TH	206	void vmw_validation_mem_alloc(struct vmw_validation_context ctx,
	207	unsigned int size);
	208	int vmw_validation_preload_bo(struct vmw_validation_context *ctx);
	209	int vmw_validation_preload_res(struct vmw_validation_context *ctx,
	210	unsigned int size);
a9f58c45 TH	211	void vmw_validation_res_set_dirty(struct vmw_validation_context *ctx,
a9f58c45 TH	212	void *val_private, u32 dirty);
b7468b15 TH	213	void vmw_validation_bo_backoff(struct vmw_validation_context *ctx);
b7468b15 TH	214
038ecc50	215	#endif