1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**************************************************************************
4 * Copyright © 2018 VMware, Inc., Palo Alto, CA., USA
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:
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
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.
27 **************************************************************************/
28 #ifndef _VMWGFX_VALIDATION_H_
29 #define _VMWGFX_VALIDATION_H_
31 #include <drm/drm_hashtab.h>
32 #include <linux/list.h>
33 #include <linux/ww_mutex.h>
34 #include <drm/ttm/ttm_execbuf_util.h>
37 * struct vmw_validation_context - Per command submission validation context
38 * @ht: Hash table used to find resource- or buffer object duplicates
39 * @resource_list: List head for resource validation metadata
40 * @resource_ctx_list: List head for resource validation metadata for
41 * resources that need to be validated before those in @resource_list
42 * @bo_list: List head for buffer objects
43 * @page_list: List of pages used by the memory allocator
44 * @ticket: Ticked used for ww mutex locking
45 * @res_mutex: Pointer to mutex used for resource reserving
46 * @merge_dups: Whether to merge metadata for duplicate resources or
48 * @mem_size_left: Free memory left in the last page in @page_list
49 * @page_address: Kernel virtual address of the last page in @page_list
51 struct vmw_validation_context {
52 struct drm_open_hash *ht;
53 struct list_head resource_list;
54 struct list_head resource_ctx_list;
55 struct list_head bo_list;
56 struct list_head page_list;
57 struct ww_acquire_ctx ticket;
58 struct mutex *res_mutex;
59 unsigned int merge_dups;
60 unsigned int mem_size_left;
64 struct vmw_buffer_object;
70 * DECLARE_VAL_CONTEXT - Declare a validation context with initialization
71 * @_name: The name of the variable
72 * @_ht: The hash table used to find dups or NULL if none
73 * @_merge_dups: Whether to merge duplicate buffer object- or resource
74 * entries. If set to true, ideally a hash table pointer should be supplied
75 * as well unless the number of resources and buffer objects per validation
76 * is known to be very small
79 #define DECLARE_VAL_CONTEXT(_name, _ht, _merge_dups) \
80 struct vmw_validation_context _name = \
82 .resource_list = LIST_HEAD_INIT((_name).resource_list), \
83 .resource_ctx_list = LIST_HEAD_INIT((_name).resource_ctx_list), \
84 .bo_list = LIST_HEAD_INIT((_name).bo_list), \
85 .page_list = LIST_HEAD_INIT((_name).page_list), \
87 .merge_dups = _merge_dups, \
92 * vmw_validation_has_bos - return whether the validation context has
93 * any buffer objects registered.
95 * @ctx: The validation context
96 * Returns: Whether any buffer objects are registered
99 vmw_validation_has_bos(struct vmw_validation_context *ctx)
101 return !list_empty(&ctx->bo_list);
105 * vmw_validation_set_ht - Register a hash table for duplicate finding
106 * @ctx: The validation context
107 * @ht: Pointer to a hash table to use for duplicate finding
108 * This function is intended to be used if the hash table wasn't
109 * available at validation context declaration time
111 static inline void vmw_validation_set_ht(struct vmw_validation_context *ctx,
112 struct drm_open_hash *ht)
118 * vmw_validation_bo_reserve - Reserve buffer objects registered with a
120 * @ctx: The validation context
121 * @intr: Perform waits interruptible
123 * Return: Zero on success, -ERESTARTSYS when interrupted, negative error
127 vmw_validation_bo_reserve(struct vmw_validation_context *ctx,
130 return ttm_eu_reserve_buffers(&ctx->ticket, &ctx->bo_list, intr,
135 * vmw_validation_bo_backoff - Unreserve buffer objects registered with a
137 * @ctx: The validation context
139 * This function unreserves the buffer objects previously reserved using
140 * vmw_validation_bo_reserve. It's typically used as part of an error path
143 vmw_validation_bo_backoff(struct vmw_validation_context *ctx)
145 ttm_eu_backoff_reservation(&ctx->ticket, &ctx->bo_list);
149 * vmw_validation_bo_fence - Unreserve and fence buffer objects registered
150 * with a validation context
151 * @ctx: The validation context
153 * This function unreserves the buffer objects previously reserved using
154 * vmw_validation_bo_reserve, and fences them with a fence object.
157 vmw_validation_bo_fence(struct vmw_validation_context *ctx,
158 struct vmw_fence_obj *fence)
160 ttm_eu_fence_buffer_objects(&ctx->ticket, &ctx->bo_list,
165 * vmw_validation_context_init - Initialize a validation context
166 * @ctx: Pointer to the validation context to initialize
168 * This function initializes a validation context with @merge_dups set
172 vmw_validation_context_init(struct vmw_validation_context *ctx)
174 memset(ctx, 0, sizeof(*ctx));
175 INIT_LIST_HEAD(&ctx->resource_list);
176 INIT_LIST_HEAD(&ctx->resource_ctx_list);
177 INIT_LIST_HEAD(&ctx->bo_list);
181 * vmw_validation_align - Align a validation memory allocation
182 * @val: The size to be aligned
184 * Returns: @val aligned to the granularity used by the validation memory
187 static inline unsigned int vmw_validation_align(unsigned int val)
189 return ALIGN(val, sizeof(long));
192 int vmw_validation_add_bo(struct vmw_validation_context *ctx,
193 struct vmw_buffer_object *vbo,
194 bool as_mob, bool cpu_blit);
195 int vmw_validation_bo_validate_single(struct ttm_buffer_object *bo,
197 bool validate_as_mob);
198 int vmw_validation_bo_validate(struct vmw_validation_context *ctx, bool intr);
199 void vmw_validation_unref_lists(struct vmw_validation_context *ctx);
200 int vmw_validation_add_resource(struct vmw_validation_context *ctx,
201 struct vmw_resource *res,
205 void vmw_validation_drop_ht(struct vmw_validation_context *ctx);
206 int vmw_validation_res_reserve(struct vmw_validation_context *ctx,
208 void vmw_validation_res_unreserve(struct vmw_validation_context *ctx,
210 void vmw_validation_res_switch_backup(struct vmw_validation_context *ctx,
212 struct vmw_buffer_object *vbo,
213 unsigned long backup_offset);
214 int vmw_validation_res_validate(struct vmw_validation_context *ctx, bool intr);
216 int vmw_validation_prepare(struct vmw_validation_context *ctx,
217 struct mutex *mutex, bool intr);
218 void vmw_validation_revert(struct vmw_validation_context *ctx);
219 void vmw_validation_done(struct vmw_validation_context *ctx,
220 struct vmw_fence_obj *fence);
222 void *vmw_validation_mem_alloc(struct vmw_validation_context *ctx,
224 int vmw_validation_preload_bo(struct vmw_validation_context *ctx);
225 int vmw_validation_preload_res(struct vmw_validation_context *ctx,