1 /**************************************************************************
3 * Copyright © 2009-2015 VMware, Inc., Palo Alto, CA., USA
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 #include "vmwgfx_drv.h"
29 #include "vmwgfx_resource_priv.h"
30 #include "vmwgfx_so.h"
31 #include "vmwgfx_binding.h"
32 #include <ttm/ttm_placement.h>
33 #include "device_include/svga3d_surfacedefs.h"
37 * struct vmw_user_surface - User-space visible surface resource
39 * @base: The TTM base object handling user-space visibility.
40 * @srf: The surface metadata.
41 * @size: TTM accounting size for the surface.
42 * @master: master of the creating client. Used for security check.
44 struct vmw_user_surface {
45 struct ttm_prime_object prime;
46 struct vmw_surface srf;
48 struct drm_master *master;
49 struct ttm_base_object *backup_base;
53 * struct vmw_surface_offset - Backing store mip level offset info
55 * @face: Surface face.
57 * @bo_offset: Offset into backing store of this mip level.
60 struct vmw_surface_offset {
66 static void vmw_user_surface_free(struct vmw_resource *res);
67 static struct vmw_resource *
68 vmw_user_surface_base_to_res(struct ttm_base_object *base);
69 static int vmw_legacy_srf_bind(struct vmw_resource *res,
70 struct ttm_validate_buffer *val_buf);
71 static int vmw_legacy_srf_unbind(struct vmw_resource *res,
73 struct ttm_validate_buffer *val_buf);
74 static int vmw_legacy_srf_create(struct vmw_resource *res);
75 static int vmw_legacy_srf_destroy(struct vmw_resource *res);
76 static int vmw_gb_surface_create(struct vmw_resource *res);
77 static int vmw_gb_surface_bind(struct vmw_resource *res,
78 struct ttm_validate_buffer *val_buf);
79 static int vmw_gb_surface_unbind(struct vmw_resource *res,
81 struct ttm_validate_buffer *val_buf);
82 static int vmw_gb_surface_destroy(struct vmw_resource *res);
85 static const struct vmw_user_resource_conv user_surface_conv = {
86 .object_type = VMW_RES_SURFACE,
87 .base_obj_to_res = vmw_user_surface_base_to_res,
88 .res_free = vmw_user_surface_free
91 const struct vmw_user_resource_conv *user_surface_converter =
95 static uint64_t vmw_user_surface_size;
97 static const struct vmw_res_func vmw_legacy_surface_func = {
98 .res_type = vmw_res_surface,
99 .needs_backup = false,
101 .type_name = "legacy surfaces",
102 .backup_placement = &vmw_srf_placement,
103 .create = &vmw_legacy_srf_create,
104 .destroy = &vmw_legacy_srf_destroy,
105 .bind = &vmw_legacy_srf_bind,
106 .unbind = &vmw_legacy_srf_unbind
109 static const struct vmw_res_func vmw_gb_surface_func = {
110 .res_type = vmw_res_surface,
111 .needs_backup = true,
113 .type_name = "guest backed surfaces",
114 .backup_placement = &vmw_mob_placement,
115 .create = vmw_gb_surface_create,
116 .destroy = vmw_gb_surface_destroy,
117 .bind = vmw_gb_surface_bind,
118 .unbind = vmw_gb_surface_unbind
122 * struct vmw_surface_dma - SVGA3D DMA command
124 struct vmw_surface_dma {
125 SVGA3dCmdHeader header;
126 SVGA3dCmdSurfaceDMA body;
128 SVGA3dCmdSurfaceDMASuffix suffix;
132 * struct vmw_surface_define - SVGA3D Surface Define command
134 struct vmw_surface_define {
135 SVGA3dCmdHeader header;
136 SVGA3dCmdDefineSurface body;
140 * struct vmw_surface_destroy - SVGA3D Surface Destroy command
142 struct vmw_surface_destroy {
143 SVGA3dCmdHeader header;
144 SVGA3dCmdDestroySurface body;
149 * vmw_surface_dma_size - Compute fifo size for a dma command.
151 * @srf: Pointer to a struct vmw_surface
153 * Computes the required size for a surface dma command for backup or
154 * restoration of the surface represented by @srf.
156 static inline uint32_t vmw_surface_dma_size(const struct vmw_surface *srf)
158 return srf->num_sizes * sizeof(struct vmw_surface_dma);
163 * vmw_surface_define_size - Compute fifo size for a surface define command.
165 * @srf: Pointer to a struct vmw_surface
167 * Computes the required size for a surface define command for the definition
168 * of the surface represented by @srf.
170 static inline uint32_t vmw_surface_define_size(const struct vmw_surface *srf)
172 return sizeof(struct vmw_surface_define) + srf->num_sizes *
178 * vmw_surface_destroy_size - Compute fifo size for a surface destroy command.
180 * Computes the required size for a surface destroy command for the destruction
183 static inline uint32_t vmw_surface_destroy_size(void)
185 return sizeof(struct vmw_surface_destroy);
189 * vmw_surface_destroy_encode - Encode a surface_destroy command.
191 * @id: The surface id
192 * @cmd_space: Pointer to memory area in which the commands should be encoded.
194 static void vmw_surface_destroy_encode(uint32_t id,
197 struct vmw_surface_destroy *cmd = (struct vmw_surface_destroy *)
200 cmd->header.id = SVGA_3D_CMD_SURFACE_DESTROY;
201 cmd->header.size = sizeof(cmd->body);
206 * vmw_surface_define_encode - Encode a surface_define command.
208 * @srf: Pointer to a struct vmw_surface object.
209 * @cmd_space: Pointer to memory area in which the commands should be encoded.
211 static void vmw_surface_define_encode(const struct vmw_surface *srf,
214 struct vmw_surface_define *cmd = (struct vmw_surface_define *)
216 struct drm_vmw_size *src_size;
217 SVGA3dSize *cmd_size;
221 cmd_len = sizeof(cmd->body) + srf->num_sizes * sizeof(SVGA3dSize);
223 cmd->header.id = SVGA_3D_CMD_SURFACE_DEFINE;
224 cmd->header.size = cmd_len;
225 cmd->body.sid = srf->res.id;
226 cmd->body.surfaceFlags = srf->flags;
227 cmd->body.format = srf->format;
228 for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i)
229 cmd->body.face[i].numMipLevels = srf->mip_levels[i];
232 cmd_size = (SVGA3dSize *) cmd;
233 src_size = srf->sizes;
235 for (i = 0; i < srf->num_sizes; ++i, cmd_size++, src_size++) {
236 cmd_size->width = src_size->width;
237 cmd_size->height = src_size->height;
238 cmd_size->depth = src_size->depth;
243 * vmw_surface_dma_encode - Encode a surface_dma command.
245 * @srf: Pointer to a struct vmw_surface object.
246 * @cmd_space: Pointer to memory area in which the commands should be encoded.
247 * @ptr: Pointer to an SVGAGuestPtr indicating where the surface contents
248 * should be placed or read from.
249 * @to_surface: Boolean whether to DMA to the surface or from the surface.
251 static void vmw_surface_dma_encode(struct vmw_surface *srf,
253 const SVGAGuestPtr *ptr,
257 struct vmw_surface_dma *cmd = (struct vmw_surface_dma *)cmd_space;
258 const struct svga3d_surface_desc *desc =
259 svga3dsurface_get_desc(srf->format);
261 for (i = 0; i < srf->num_sizes; ++i) {
262 SVGA3dCmdHeader *header = &cmd->header;
263 SVGA3dCmdSurfaceDMA *body = &cmd->body;
264 SVGA3dCopyBox *cb = &cmd->cb;
265 SVGA3dCmdSurfaceDMASuffix *suffix = &cmd->suffix;
266 const struct vmw_surface_offset *cur_offset = &srf->offsets[i];
267 const struct drm_vmw_size *cur_size = &srf->sizes[i];
269 header->id = SVGA_3D_CMD_SURFACE_DMA;
270 header->size = sizeof(*body) + sizeof(*cb) + sizeof(*suffix);
272 body->guest.ptr = *ptr;
273 body->guest.ptr.offset += cur_offset->bo_offset;
274 body->guest.pitch = svga3dsurface_calculate_pitch(desc,
276 body->host.sid = srf->res.id;
277 body->host.face = cur_offset->face;
278 body->host.mipmap = cur_offset->mip;
279 body->transfer = ((to_surface) ? SVGA3D_WRITE_HOST_VRAM :
280 SVGA3D_READ_HOST_VRAM);
287 cb->w = cur_size->width;
288 cb->h = cur_size->height;
289 cb->d = cur_size->depth;
291 suffix->suffixSize = sizeof(*suffix);
292 suffix->maximumOffset =
293 svga3dsurface_get_image_buffer_size(desc, cur_size,
295 suffix->flags.discard = 0;
296 suffix->flags.unsynchronized = 0;
297 suffix->flags.reserved = 0;
304 * vmw_hw_surface_destroy - destroy a Device surface
306 * @res: Pointer to a struct vmw_resource embedded in a struct
309 * Destroys a the device surface associated with a struct vmw_surface if
310 * any, and adjusts accounting and resource count accordingly.
312 static void vmw_hw_surface_destroy(struct vmw_resource *res)
315 struct vmw_private *dev_priv = res->dev_priv;
316 struct vmw_surface *srf;
319 if (res->func->destroy == vmw_gb_surface_destroy) {
320 (void) vmw_gb_surface_destroy(res);
326 cmd = vmw_fifo_reserve(dev_priv, vmw_surface_destroy_size());
327 if (unlikely(!cmd)) {
328 DRM_ERROR("Failed reserving FIFO space for surface "
333 vmw_surface_destroy_encode(res->id, cmd);
334 vmw_fifo_commit(dev_priv, vmw_surface_destroy_size());
337 * used_memory_size_atomic, or separate lock
338 * to avoid taking dev_priv::cmdbuf_mutex in
342 mutex_lock(&dev_priv->cmdbuf_mutex);
343 srf = vmw_res_to_srf(res);
344 dev_priv->used_memory_size -= res->backup_size;
345 mutex_unlock(&dev_priv->cmdbuf_mutex);
347 vmw_fifo_resource_dec(dev_priv);
351 * vmw_legacy_srf_create - Create a device surface as part of the
352 * resource validation process.
354 * @res: Pointer to a struct vmw_surface.
356 * If the surface doesn't have a hw id.
358 * Returns -EBUSY if there wasn't sufficient device resources to
359 * complete the validation. Retry after freeing up resources.
361 * May return other errors if the kernel is out of guest resources.
363 static int vmw_legacy_srf_create(struct vmw_resource *res)
365 struct vmw_private *dev_priv = res->dev_priv;
366 struct vmw_surface *srf;
367 uint32_t submit_size;
371 if (likely(res->id != -1))
374 srf = vmw_res_to_srf(res);
375 if (unlikely(dev_priv->used_memory_size + res->backup_size >=
376 dev_priv->memory_size))
380 * Alloc id for the resource.
383 ret = vmw_resource_alloc_id(res);
384 if (unlikely(ret != 0)) {
385 DRM_ERROR("Failed to allocate a surface id.\n");
389 if (unlikely(res->id >= SVGA3D_MAX_SURFACE_IDS)) {
395 * Encode surface define- commands.
398 submit_size = vmw_surface_define_size(srf);
399 cmd = vmw_fifo_reserve(dev_priv, submit_size);
400 if (unlikely(!cmd)) {
401 DRM_ERROR("Failed reserving FIFO space for surface "
407 vmw_surface_define_encode(srf, cmd);
408 vmw_fifo_commit(dev_priv, submit_size);
410 * Surface memory usage accounting.
413 dev_priv->used_memory_size += res->backup_size;
417 vmw_resource_release_id(res);
423 * vmw_legacy_srf_dma - Copy backup data to or from a legacy surface.
425 * @res: Pointer to a struct vmw_res embedded in a struct
427 * @val_buf: Pointer to a struct ttm_validate_buffer containing
428 * information about the backup buffer.
429 * @bind: Boolean wether to DMA to the surface.
431 * Transfer backup data to or from a legacy surface as part of the
432 * validation process.
433 * May return other errors if the kernel is out of guest resources.
434 * The backup buffer will be fenced or idle upon successful completion,
435 * and if the surface needs persistent backup storage, the backup buffer
436 * will also be returned reserved iff @bind is true.
438 static int vmw_legacy_srf_dma(struct vmw_resource *res,
439 struct ttm_validate_buffer *val_buf,
443 struct vmw_fence_obj *fence;
444 uint32_t submit_size;
445 struct vmw_surface *srf = vmw_res_to_srf(res);
447 struct vmw_private *dev_priv = res->dev_priv;
449 BUG_ON(!val_buf->bo);
450 submit_size = vmw_surface_dma_size(srf);
451 cmd = vmw_fifo_reserve(dev_priv, submit_size);
452 if (unlikely(!cmd)) {
453 DRM_ERROR("Failed reserving FIFO space for surface "
457 vmw_bo_get_guest_ptr(val_buf->bo, &ptr);
458 vmw_surface_dma_encode(srf, cmd, &ptr, bind);
460 vmw_fifo_commit(dev_priv, submit_size);
463 * Create a fence object and fence the backup buffer.
466 (void) vmw_execbuf_fence_commands(NULL, dev_priv,
469 vmw_fence_single_bo(val_buf->bo, fence);
471 if (likely(fence != NULL))
472 vmw_fence_obj_unreference(&fence);
478 * vmw_legacy_srf_bind - Perform a legacy surface bind as part of the
479 * surface validation process.
481 * @res: Pointer to a struct vmw_res embedded in a struct
483 * @val_buf: Pointer to a struct ttm_validate_buffer containing
484 * information about the backup buffer.
486 * This function will copy backup data to the surface if the
487 * backup buffer is dirty.
489 static int vmw_legacy_srf_bind(struct vmw_resource *res,
490 struct ttm_validate_buffer *val_buf)
492 if (!res->backup_dirty)
495 return vmw_legacy_srf_dma(res, val_buf, true);
500 * vmw_legacy_srf_unbind - Perform a legacy surface unbind as part of the
501 * surface eviction process.
503 * @res: Pointer to a struct vmw_res embedded in a struct
505 * @val_buf: Pointer to a struct ttm_validate_buffer containing
506 * information about the backup buffer.
508 * This function will copy backup data from the surface.
510 static int vmw_legacy_srf_unbind(struct vmw_resource *res,
512 struct ttm_validate_buffer *val_buf)
514 if (unlikely(readback))
515 return vmw_legacy_srf_dma(res, val_buf, false);
520 * vmw_legacy_srf_destroy - Destroy a device surface as part of a
521 * resource eviction process.
523 * @res: Pointer to a struct vmw_res embedded in a struct
526 static int vmw_legacy_srf_destroy(struct vmw_resource *res)
528 struct vmw_private *dev_priv = res->dev_priv;
529 uint32_t submit_size;
532 BUG_ON(res->id == -1);
535 * Encode the dma- and surface destroy commands.
538 submit_size = vmw_surface_destroy_size();
539 cmd = vmw_fifo_reserve(dev_priv, submit_size);
540 if (unlikely(!cmd)) {
541 DRM_ERROR("Failed reserving FIFO space for surface "
546 vmw_surface_destroy_encode(res->id, cmd);
547 vmw_fifo_commit(dev_priv, submit_size);
550 * Surface memory usage accounting.
553 dev_priv->used_memory_size -= res->backup_size;
556 * Release the surface ID.
559 vmw_resource_release_id(res);
566 * vmw_surface_init - initialize a struct vmw_surface
568 * @dev_priv: Pointer to a device private struct.
569 * @srf: Pointer to the struct vmw_surface to initialize.
570 * @res_free: Pointer to a resource destructor used to free
573 static int vmw_surface_init(struct vmw_private *dev_priv,
574 struct vmw_surface *srf,
575 void (*res_free) (struct vmw_resource *res))
578 struct vmw_resource *res = &srf->res;
581 if (!dev_priv->has_mob)
582 vmw_fifo_resource_inc(dev_priv);
583 ret = vmw_resource_init(dev_priv, res, true, res_free,
584 (dev_priv->has_mob) ? &vmw_gb_surface_func :
585 &vmw_legacy_surface_func);
587 if (unlikely(ret != 0)) {
588 if (!dev_priv->has_mob)
589 vmw_fifo_resource_dec(dev_priv);
595 * The surface won't be visible to hardware until a
599 INIT_LIST_HEAD(&srf->view_list);
600 vmw_resource_activate(res, vmw_hw_surface_destroy);
605 * vmw_user_surface_base_to_res - TTM base object to resource converter for
606 * user visible surfaces
608 * @base: Pointer to a TTM base object
610 * Returns the struct vmw_resource embedded in a struct vmw_surface
611 * for the user-visible object identified by the TTM base object @base.
613 static struct vmw_resource *
614 vmw_user_surface_base_to_res(struct ttm_base_object *base)
616 return &(container_of(base, struct vmw_user_surface,
617 prime.base)->srf.res);
621 * vmw_user_surface_free - User visible surface resource destructor
623 * @res: A struct vmw_resource embedded in a struct vmw_surface.
625 static void vmw_user_surface_free(struct vmw_resource *res)
627 struct vmw_surface *srf = vmw_res_to_srf(res);
628 struct vmw_user_surface *user_srf =
629 container_of(srf, struct vmw_user_surface, srf);
630 struct vmw_private *dev_priv = srf->res.dev_priv;
631 uint32_t size = user_srf->size;
633 if (user_srf->master)
634 drm_master_put(&user_srf->master);
637 kfree(srf->snooper.image);
638 ttm_prime_object_kfree(user_srf, prime);
639 ttm_mem_global_free(vmw_mem_glob(dev_priv), size);
643 * vmw_user_surface_free - User visible surface TTM base object destructor
645 * @p_base: Pointer to a pointer to a TTM base object
646 * embedded in a struct vmw_user_surface.
648 * Drops the base object's reference on its resource, and the
649 * pointer pointed to by *p_base is set to NULL.
651 static void vmw_user_surface_base_release(struct ttm_base_object **p_base)
653 struct ttm_base_object *base = *p_base;
654 struct vmw_user_surface *user_srf =
655 container_of(base, struct vmw_user_surface, prime.base);
656 struct vmw_resource *res = &user_srf->srf.res;
659 if (user_srf->backup_base)
660 ttm_base_object_unref(&user_srf->backup_base);
661 vmw_resource_unreference(&res);
665 * vmw_user_surface_destroy_ioctl - Ioctl function implementing
666 * the user surface destroy functionality.
668 * @dev: Pointer to a struct drm_device.
669 * @data: Pointer to data copied from / to user-space.
670 * @file_priv: Pointer to a drm file private structure.
672 int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
673 struct drm_file *file_priv)
675 struct drm_vmw_surface_arg *arg = (struct drm_vmw_surface_arg *)data;
676 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
678 return ttm_ref_object_base_unref(tfile, arg->sid, TTM_REF_USAGE);
682 * vmw_user_surface_define_ioctl - Ioctl function implementing
683 * the user surface define functionality.
685 * @dev: Pointer to a struct drm_device.
686 * @data: Pointer to data copied from / to user-space.
687 * @file_priv: Pointer to a drm file private structure.
689 int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
690 struct drm_file *file_priv)
692 struct vmw_private *dev_priv = vmw_priv(dev);
693 struct vmw_user_surface *user_srf;
694 struct vmw_surface *srf;
695 struct vmw_resource *res;
696 struct vmw_resource *tmp;
697 union drm_vmw_surface_create_arg *arg =
698 (union drm_vmw_surface_create_arg *)data;
699 struct drm_vmw_surface_create_req *req = &arg->req;
700 struct drm_vmw_surface_arg *rep = &arg->rep;
701 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
704 uint32_t cur_bo_offset;
705 struct drm_vmw_size *cur_size;
706 struct vmw_surface_offset *cur_offset;
709 const struct svga3d_surface_desc *desc;
711 if (unlikely(vmw_user_surface_size == 0))
712 vmw_user_surface_size = ttm_round_pot(sizeof(*user_srf)) +
716 for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i) {
717 if (req->mip_levels[i] > DRM_VMW_MAX_MIP_LEVELS)
719 num_sizes += req->mip_levels[i];
722 if (num_sizes > DRM_VMW_MAX_SURFACE_FACES * DRM_VMW_MAX_MIP_LEVELS ||
726 size = vmw_user_surface_size + 128 +
727 ttm_round_pot(num_sizes * sizeof(struct drm_vmw_size)) +
728 ttm_round_pot(num_sizes * sizeof(struct vmw_surface_offset));
731 desc = svga3dsurface_get_desc(req->format);
732 if (unlikely(desc->block_desc == SVGA3DBLOCKDESC_NONE)) {
733 DRM_ERROR("Invalid surface format for surface creation.\n");
734 DRM_ERROR("Format requested is: %d\n", req->format);
738 ret = ttm_read_lock(&dev_priv->reservation_sem, true);
739 if (unlikely(ret != 0))
742 ret = ttm_mem_global_alloc(vmw_mem_glob(dev_priv),
744 if (unlikely(ret != 0)) {
745 if (ret != -ERESTARTSYS)
746 DRM_ERROR("Out of graphics memory for surface"
751 user_srf = kzalloc(sizeof(*user_srf), GFP_KERNEL);
752 if (unlikely(!user_srf)) {
754 goto out_no_user_srf;
757 srf = &user_srf->srf;
760 srf->flags = req->flags;
761 srf->format = req->format;
762 srf->scanout = req->scanout;
764 memcpy(srf->mip_levels, req->mip_levels, sizeof(srf->mip_levels));
765 srf->num_sizes = num_sizes;
766 user_srf->size = size;
767 srf->sizes = memdup_user((struct drm_vmw_size __user *)(unsigned long)
769 sizeof(*srf->sizes) * srf->num_sizes);
770 if (IS_ERR(srf->sizes)) {
771 ret = PTR_ERR(srf->sizes);
774 srf->offsets = kmalloc_array(srf->num_sizes,
775 sizeof(*srf->offsets),
777 if (unlikely(!srf->offsets)) {
782 srf->base_size = *srf->sizes;
783 srf->autogen_filter = SVGA3D_TEX_FILTER_NONE;
784 srf->multisample_count = 0;
787 cur_offset = srf->offsets;
788 cur_size = srf->sizes;
790 for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i) {
791 for (j = 0; j < srf->mip_levels[i]; ++j) {
792 uint32_t stride = svga3dsurface_calculate_pitch
795 cur_offset->face = i;
797 cur_offset->bo_offset = cur_bo_offset;
798 cur_bo_offset += svga3dsurface_get_image_buffer_size
799 (desc, cur_size, stride);
804 res->backup_size = cur_bo_offset;
806 srf->num_sizes == 1 &&
807 srf->sizes[0].width == 64 &&
808 srf->sizes[0].height == 64 &&
809 srf->format == SVGA3D_A8R8G8B8) {
811 srf->snooper.image = kzalloc(64 * 64 * 4, GFP_KERNEL);
812 if (!srf->snooper.image) {
813 DRM_ERROR("Failed to allocate cursor_image\n");
818 srf->snooper.image = NULL;
820 srf->snooper.crtc = NULL;
822 user_srf->prime.base.shareable = false;
823 user_srf->prime.base.tfile = NULL;
824 if (drm_is_primary_client(file_priv))
825 user_srf->master = drm_master_get(file_priv->master);
828 * From this point, the generic resource management functions
829 * destroy the object on failure.
832 ret = vmw_surface_init(dev_priv, srf, vmw_user_surface_free);
833 if (unlikely(ret != 0))
837 * A gb-aware client referencing a shared surface will
838 * expect a backup buffer to be present.
840 if (dev_priv->has_mob && req->shareable) {
841 uint32_t backup_handle;
843 ret = vmw_user_dmabuf_alloc(dev_priv, tfile,
848 &user_srf->backup_base);
849 if (unlikely(ret != 0)) {
850 vmw_resource_unreference(&res);
855 tmp = vmw_resource_reference(&srf->res);
856 ret = ttm_prime_object_init(tfile, res->backup_size, &user_srf->prime,
857 req->shareable, VMW_RES_SURFACE,
858 &vmw_user_surface_base_release, NULL);
860 if (unlikely(ret != 0)) {
861 vmw_resource_unreference(&tmp);
862 vmw_resource_unreference(&res);
866 rep->sid = user_srf->prime.base.hash.key;
867 vmw_resource_unreference(&res);
869 ttm_read_unlock(&dev_priv->reservation_sem);
876 ttm_prime_object_kfree(user_srf, prime);
878 ttm_mem_global_free(vmw_mem_glob(dev_priv), size);
880 ttm_read_unlock(&dev_priv->reservation_sem);
886 vmw_surface_handle_reference(struct vmw_private *dev_priv,
887 struct drm_file *file_priv,
889 enum drm_vmw_handle_type handle_type,
890 struct ttm_base_object **base_p)
892 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
893 struct vmw_user_surface *user_srf;
895 struct ttm_base_object *base;
897 bool require_exist = false;
899 if (handle_type == DRM_VMW_HANDLE_PRIME) {
900 ret = ttm_prime_fd_to_handle(tfile, u_handle, &handle);
901 if (unlikely(ret != 0))
904 if (unlikely(drm_is_render_client(file_priv)))
905 require_exist = true;
907 if (ACCESS_ONCE(vmw_fpriv(file_priv)->locked_master)) {
908 DRM_ERROR("Locked master refused legacy "
909 "surface reference.\n");
917 base = ttm_base_object_lookup_for_ref(dev_priv->tdev, handle);
918 if (unlikely(!base)) {
919 DRM_ERROR("Could not find surface to reference.\n");
923 if (unlikely(ttm_base_object_type(base) != VMW_RES_SURFACE)) {
924 DRM_ERROR("Referenced object is not a surface.\n");
925 goto out_bad_resource;
928 if (handle_type != DRM_VMW_HANDLE_PRIME) {
929 user_srf = container_of(base, struct vmw_user_surface,
933 * Make sure the surface creator has the same
934 * authenticating master, or is already registered with us.
936 if (drm_is_primary_client(file_priv) &&
937 user_srf->master != file_priv->master)
938 require_exist = true;
940 ret = ttm_ref_object_add(tfile, base, TTM_REF_USAGE, NULL,
942 if (unlikely(ret != 0)) {
943 DRM_ERROR("Could not add a reference to a surface.\n");
944 goto out_bad_resource;
952 ttm_base_object_unref(&base);
954 if (handle_type == DRM_VMW_HANDLE_PRIME)
955 (void) ttm_ref_object_base_unref(tfile, handle, TTM_REF_USAGE);
961 * vmw_user_surface_define_ioctl - Ioctl function implementing
962 * the user surface reference functionality.
964 * @dev: Pointer to a struct drm_device.
965 * @data: Pointer to data copied from / to user-space.
966 * @file_priv: Pointer to a drm file private structure.
968 int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
969 struct drm_file *file_priv)
971 struct vmw_private *dev_priv = vmw_priv(dev);
972 union drm_vmw_surface_reference_arg *arg =
973 (union drm_vmw_surface_reference_arg *)data;
974 struct drm_vmw_surface_arg *req = &arg->req;
975 struct drm_vmw_surface_create_req *rep = &arg->rep;
976 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
977 struct vmw_surface *srf;
978 struct vmw_user_surface *user_srf;
979 struct drm_vmw_size __user *user_sizes;
980 struct ttm_base_object *base;
983 ret = vmw_surface_handle_reference(dev_priv, file_priv, req->sid,
984 req->handle_type, &base);
985 if (unlikely(ret != 0))
988 user_srf = container_of(base, struct vmw_user_surface, prime.base);
989 srf = &user_srf->srf;
991 rep->flags = srf->flags;
992 rep->format = srf->format;
993 memcpy(rep->mip_levels, srf->mip_levels, sizeof(srf->mip_levels));
994 user_sizes = (struct drm_vmw_size __user *)(unsigned long)
998 ret = copy_to_user(user_sizes, &srf->base_size,
999 sizeof(srf->base_size));
1000 if (unlikely(ret != 0)) {
1001 DRM_ERROR("copy_to_user failed %p %u\n",
1002 user_sizes, srf->num_sizes);
1003 ttm_ref_object_base_unref(tfile, base->hash.key, TTM_REF_USAGE);
1007 ttm_base_object_unref(&base);
1013 * vmw_surface_define_encode - Encode a surface_define command.
1015 * @srf: Pointer to a struct vmw_surface object.
1016 * @cmd_space: Pointer to memory area in which the commands should be encoded.
1018 static int vmw_gb_surface_create(struct vmw_resource *res)
1020 struct vmw_private *dev_priv = res->dev_priv;
1021 struct vmw_surface *srf = vmw_res_to_srf(res);
1022 uint32_t cmd_len, cmd_id, submit_len;
1025 SVGA3dCmdHeader header;
1026 SVGA3dCmdDefineGBSurface body;
1029 SVGA3dCmdHeader header;
1030 SVGA3dCmdDefineGBSurface_v2 body;
1033 if (likely(res->id != -1))
1036 vmw_fifo_resource_inc(dev_priv);
1037 ret = vmw_resource_alloc_id(res);
1038 if (unlikely(ret != 0)) {
1039 DRM_ERROR("Failed to allocate a surface id.\n");
1043 if (unlikely(res->id >= VMWGFX_NUM_GB_SURFACE)) {
1048 if (srf->array_size > 0) {
1049 /* has_dx checked on creation time. */
1050 cmd_id = SVGA_3D_CMD_DEFINE_GB_SURFACE_V2;
1051 cmd_len = sizeof(cmd2->body);
1052 submit_len = sizeof(*cmd2);
1054 cmd_id = SVGA_3D_CMD_DEFINE_GB_SURFACE;
1055 cmd_len = sizeof(cmd->body);
1056 submit_len = sizeof(*cmd);
1059 cmd = vmw_fifo_reserve(dev_priv, submit_len);
1060 cmd2 = (typeof(cmd2))cmd;
1061 if (unlikely(!cmd)) {
1062 DRM_ERROR("Failed reserving FIFO space for surface "
1068 if (srf->array_size > 0) {
1069 cmd2->header.id = cmd_id;
1070 cmd2->header.size = cmd_len;
1071 cmd2->body.sid = srf->res.id;
1072 cmd2->body.surfaceFlags = srf->flags;
1073 cmd2->body.format = cpu_to_le32(srf->format);
1074 cmd2->body.numMipLevels = srf->mip_levels[0];
1075 cmd2->body.multisampleCount = srf->multisample_count;
1076 cmd2->body.autogenFilter = srf->autogen_filter;
1077 cmd2->body.size.width = srf->base_size.width;
1078 cmd2->body.size.height = srf->base_size.height;
1079 cmd2->body.size.depth = srf->base_size.depth;
1080 cmd2->body.arraySize = srf->array_size;
1082 cmd->header.id = cmd_id;
1083 cmd->header.size = cmd_len;
1084 cmd->body.sid = srf->res.id;
1085 cmd->body.surfaceFlags = srf->flags;
1086 cmd->body.format = cpu_to_le32(srf->format);
1087 cmd->body.numMipLevels = srf->mip_levels[0];
1088 cmd->body.multisampleCount = srf->multisample_count;
1089 cmd->body.autogenFilter = srf->autogen_filter;
1090 cmd->body.size.width = srf->base_size.width;
1091 cmd->body.size.height = srf->base_size.height;
1092 cmd->body.size.depth = srf->base_size.depth;
1095 vmw_fifo_commit(dev_priv, submit_len);
1100 vmw_resource_release_id(res);
1102 vmw_fifo_resource_dec(dev_priv);
1107 static int vmw_gb_surface_bind(struct vmw_resource *res,
1108 struct ttm_validate_buffer *val_buf)
1110 struct vmw_private *dev_priv = res->dev_priv;
1112 SVGA3dCmdHeader header;
1113 SVGA3dCmdBindGBSurface body;
1116 SVGA3dCmdHeader header;
1117 SVGA3dCmdUpdateGBSurface body;
1119 uint32_t submit_size;
1120 struct ttm_buffer_object *bo = val_buf->bo;
1122 BUG_ON(bo->mem.mem_type != VMW_PL_MOB);
1124 submit_size = sizeof(*cmd1) + (res->backup_dirty ? sizeof(*cmd2) : 0);
1126 cmd1 = vmw_fifo_reserve(dev_priv, submit_size);
1127 if (unlikely(!cmd1)) {
1128 DRM_ERROR("Failed reserving FIFO space for surface "
1133 cmd1->header.id = SVGA_3D_CMD_BIND_GB_SURFACE;
1134 cmd1->header.size = sizeof(cmd1->body);
1135 cmd1->body.sid = res->id;
1136 cmd1->body.mobid = bo->mem.start;
1137 if (res->backup_dirty) {
1138 cmd2 = (void *) &cmd1[1];
1139 cmd2->header.id = SVGA_3D_CMD_UPDATE_GB_SURFACE;
1140 cmd2->header.size = sizeof(cmd2->body);
1141 cmd2->body.sid = res->id;
1142 res->backup_dirty = false;
1144 vmw_fifo_commit(dev_priv, submit_size);
1149 static int vmw_gb_surface_unbind(struct vmw_resource *res,
1151 struct ttm_validate_buffer *val_buf)
1153 struct vmw_private *dev_priv = res->dev_priv;
1154 struct ttm_buffer_object *bo = val_buf->bo;
1155 struct vmw_fence_obj *fence;
1158 SVGA3dCmdHeader header;
1159 SVGA3dCmdReadbackGBSurface body;
1162 SVGA3dCmdHeader header;
1163 SVGA3dCmdInvalidateGBSurface body;
1166 SVGA3dCmdHeader header;
1167 SVGA3dCmdBindGBSurface body;
1169 uint32_t submit_size;
1173 BUG_ON(bo->mem.mem_type != VMW_PL_MOB);
1175 submit_size = sizeof(*cmd3) + (readback ? sizeof(*cmd1) : sizeof(*cmd2));
1176 cmd = vmw_fifo_reserve(dev_priv, submit_size);
1177 if (unlikely(!cmd)) {
1178 DRM_ERROR("Failed reserving FIFO space for surface "
1184 cmd1 = (void *) cmd;
1185 cmd1->header.id = SVGA_3D_CMD_READBACK_GB_SURFACE;
1186 cmd1->header.size = sizeof(cmd1->body);
1187 cmd1->body.sid = res->id;
1188 cmd3 = (void *) &cmd1[1];
1190 cmd2 = (void *) cmd;
1191 cmd2->header.id = SVGA_3D_CMD_INVALIDATE_GB_SURFACE;
1192 cmd2->header.size = sizeof(cmd2->body);
1193 cmd2->body.sid = res->id;
1194 cmd3 = (void *) &cmd2[1];
1197 cmd3->header.id = SVGA_3D_CMD_BIND_GB_SURFACE;
1198 cmd3->header.size = sizeof(cmd3->body);
1199 cmd3->body.sid = res->id;
1200 cmd3->body.mobid = SVGA3D_INVALID_ID;
1202 vmw_fifo_commit(dev_priv, submit_size);
1205 * Create a fence object and fence the backup buffer.
1208 (void) vmw_execbuf_fence_commands(NULL, dev_priv,
1211 vmw_fence_single_bo(val_buf->bo, fence);
1213 if (likely(fence != NULL))
1214 vmw_fence_obj_unreference(&fence);
1219 static int vmw_gb_surface_destroy(struct vmw_resource *res)
1221 struct vmw_private *dev_priv = res->dev_priv;
1222 struct vmw_surface *srf = vmw_res_to_srf(res);
1224 SVGA3dCmdHeader header;
1225 SVGA3dCmdDestroyGBSurface body;
1228 if (likely(res->id == -1))
1231 mutex_lock(&dev_priv->binding_mutex);
1232 vmw_view_surface_list_destroy(dev_priv, &srf->view_list);
1233 vmw_binding_res_list_scrub(&res->binding_head);
1235 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
1236 if (unlikely(!cmd)) {
1237 DRM_ERROR("Failed reserving FIFO space for surface "
1239 mutex_unlock(&dev_priv->binding_mutex);
1243 cmd->header.id = SVGA_3D_CMD_DESTROY_GB_SURFACE;
1244 cmd->header.size = sizeof(cmd->body);
1245 cmd->body.sid = res->id;
1246 vmw_fifo_commit(dev_priv, sizeof(*cmd));
1247 mutex_unlock(&dev_priv->binding_mutex);
1248 vmw_resource_release_id(res);
1249 vmw_fifo_resource_dec(dev_priv);
1256 * vmw_gb_surface_define_ioctl - Ioctl function implementing
1257 * the user surface define functionality.
1259 * @dev: Pointer to a struct drm_device.
1260 * @data: Pointer to data copied from / to user-space.
1261 * @file_priv: Pointer to a drm file private structure.
1263 int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1264 struct drm_file *file_priv)
1266 struct vmw_private *dev_priv = vmw_priv(dev);
1267 struct vmw_user_surface *user_srf;
1268 struct vmw_surface *srf;
1269 struct vmw_resource *res;
1270 struct vmw_resource *tmp;
1271 union drm_vmw_gb_surface_create_arg *arg =
1272 (union drm_vmw_gb_surface_create_arg *)data;
1273 struct drm_vmw_gb_surface_create_req *req = &arg->req;
1274 struct drm_vmw_gb_surface_create_rep *rep = &arg->rep;
1275 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1278 uint32_t backup_handle = 0;
1280 if (req->multisample_count != 0)
1283 if (req->mip_levels > DRM_VMW_MAX_MIP_LEVELS)
1286 if (unlikely(vmw_user_surface_size == 0))
1287 vmw_user_surface_size = ttm_round_pot(sizeof(*user_srf)) +
1290 size = vmw_user_surface_size + 128;
1292 /* Define a surface based on the parameters. */
1293 ret = vmw_surface_gb_priv_define(dev,
1297 req->drm_surface_flags & drm_vmw_surface_flag_scanout,
1299 req->multisample_count,
1303 if (unlikely(ret != 0))
1306 user_srf = container_of(srf, struct vmw_user_surface, srf);
1307 if (drm_is_primary_client(file_priv))
1308 user_srf->master = drm_master_get(file_priv->master);
1310 ret = ttm_read_lock(&dev_priv->reservation_sem, true);
1311 if (unlikely(ret != 0))
1314 res = &user_srf->srf.res;
1317 if (req->buffer_handle != SVGA3D_INVALID_ID) {
1318 ret = vmw_user_dmabuf_lookup(tfile, req->buffer_handle,
1320 &user_srf->backup_base);
1322 if (res->backup->base.num_pages * PAGE_SIZE <
1324 DRM_ERROR("Surface backup buffer is too small.\n");
1325 vmw_dmabuf_unreference(&res->backup);
1329 backup_handle = req->buffer_handle;
1332 } else if (req->drm_surface_flags & drm_vmw_surface_flag_create_buffer)
1333 ret = vmw_user_dmabuf_alloc(dev_priv, tfile,
1335 req->drm_surface_flags &
1336 drm_vmw_surface_flag_shareable,
1339 &user_srf->backup_base);
1341 if (unlikely(ret != 0)) {
1342 vmw_resource_unreference(&res);
1346 tmp = vmw_resource_reference(res);
1347 ret = ttm_prime_object_init(tfile, res->backup_size, &user_srf->prime,
1348 req->drm_surface_flags &
1349 drm_vmw_surface_flag_shareable,
1351 &vmw_user_surface_base_release, NULL);
1353 if (unlikely(ret != 0)) {
1354 vmw_resource_unreference(&tmp);
1355 vmw_resource_unreference(&res);
1359 rep->handle = user_srf->prime.base.hash.key;
1360 rep->backup_size = res->backup_size;
1362 rep->buffer_map_handle =
1363 drm_vma_node_offset_addr(&res->backup->base.vma_node);
1364 rep->buffer_size = res->backup->base.num_pages * PAGE_SIZE;
1365 rep->buffer_handle = backup_handle;
1367 rep->buffer_map_handle = 0;
1368 rep->buffer_size = 0;
1369 rep->buffer_handle = SVGA3D_INVALID_ID;
1372 vmw_resource_unreference(&res);
1375 ttm_read_unlock(&dev_priv->reservation_sem);
1380 * vmw_gb_surface_reference_ioctl - Ioctl function implementing
1381 * the user surface reference functionality.
1383 * @dev: Pointer to a struct drm_device.
1384 * @data: Pointer to data copied from / to user-space.
1385 * @file_priv: Pointer to a drm file private structure.
1387 int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1388 struct drm_file *file_priv)
1390 struct vmw_private *dev_priv = vmw_priv(dev);
1391 union drm_vmw_gb_surface_reference_arg *arg =
1392 (union drm_vmw_gb_surface_reference_arg *)data;
1393 struct drm_vmw_surface_arg *req = &arg->req;
1394 struct drm_vmw_gb_surface_ref_rep *rep = &arg->rep;
1395 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1396 struct vmw_surface *srf;
1397 struct vmw_user_surface *user_srf;
1398 struct ttm_base_object *base;
1399 uint32_t backup_handle;
1402 ret = vmw_surface_handle_reference(dev_priv, file_priv, req->sid,
1403 req->handle_type, &base);
1404 if (unlikely(ret != 0))
1407 user_srf = container_of(base, struct vmw_user_surface, prime.base);
1408 srf = &user_srf->srf;
1409 if (!srf->res.backup) {
1410 DRM_ERROR("Shared GB surface is missing a backup buffer.\n");
1411 goto out_bad_resource;
1414 mutex_lock(&dev_priv->cmdbuf_mutex); /* Protect res->backup */
1415 ret = vmw_user_dmabuf_reference(tfile, srf->res.backup,
1417 mutex_unlock(&dev_priv->cmdbuf_mutex);
1419 if (unlikely(ret != 0)) {
1420 DRM_ERROR("Could not add a reference to a GB surface "
1421 "backup buffer.\n");
1422 (void) ttm_ref_object_base_unref(tfile, base->hash.key,
1424 goto out_bad_resource;
1427 rep->creq.svga3d_flags = srf->flags;
1428 rep->creq.format = srf->format;
1429 rep->creq.mip_levels = srf->mip_levels[0];
1430 rep->creq.drm_surface_flags = 0;
1431 rep->creq.multisample_count = srf->multisample_count;
1432 rep->creq.autogen_filter = srf->autogen_filter;
1433 rep->creq.array_size = srf->array_size;
1434 rep->creq.buffer_handle = backup_handle;
1435 rep->creq.base_size = srf->base_size;
1436 rep->crep.handle = user_srf->prime.base.hash.key;
1437 rep->crep.backup_size = srf->res.backup_size;
1438 rep->crep.buffer_handle = backup_handle;
1439 rep->crep.buffer_map_handle =
1440 drm_vma_node_offset_addr(&srf->res.backup->base.vma_node);
1441 rep->crep.buffer_size = srf->res.backup->base.num_pages * PAGE_SIZE;
1444 ttm_base_object_unref(&base);
1450 * vmw_surface_gb_priv_define - Define a private GB surface
1452 * @dev: Pointer to a struct drm_device
1453 * @user_accounting_size: Used to track user-space memory usage, set
1454 * to 0 for kernel mode only memory
1455 * @svga3d_flags: SVGA3d surface flags for the device
1456 * @format: requested surface format
1457 * @for_scanout: true if inteded to be used for scanout buffer
1458 * @num_mip_levels: number of MIP levels
1459 * @multisample_count:
1460 * @array_size: Surface array size.
1461 * @size: width, heigh, depth of the surface requested
1462 * @user_srf_out: allocated user_srf. Set to NULL on failure.
1464 * GB surfaces allocated by this function will not have a user mode handle, and
1465 * thus will only be visible to vmwgfx. For optimization reasons the
1466 * surface may later be given a user mode handle by another function to make
1467 * it available to user mode drivers.
1469 int vmw_surface_gb_priv_define(struct drm_device *dev,
1470 uint32_t user_accounting_size,
1471 uint32_t svga3d_flags,
1472 SVGA3dSurfaceFormat format,
1474 uint32_t num_mip_levels,
1475 uint32_t multisample_count,
1476 uint32_t array_size,
1477 struct drm_vmw_size size,
1478 struct vmw_surface **srf_out)
1480 struct vmw_private *dev_priv = vmw_priv(dev);
1481 struct vmw_user_surface *user_srf;
1482 struct vmw_surface *srf;
1489 if (!svga3dsurface_is_screen_target_format(format)) {
1490 DRM_ERROR("Invalid Screen Target surface format.");
1494 const struct svga3d_surface_desc *desc;
1496 desc = svga3dsurface_get_desc(format);
1497 if (unlikely(desc->block_desc == SVGA3DBLOCKDESC_NONE)) {
1498 DRM_ERROR("Invalid surface format.\n");
1503 /* array_size must be null for non-GL3 host. */
1504 if (array_size > 0 && !dev_priv->has_dx) {
1505 DRM_ERROR("Tried to create DX surface on non-DX host.\n");
1509 ret = ttm_read_lock(&dev_priv->reservation_sem, true);
1510 if (unlikely(ret != 0))
1513 ret = ttm_mem_global_alloc(vmw_mem_glob(dev_priv),
1514 user_accounting_size, false, true);
1515 if (unlikely(ret != 0)) {
1516 if (ret != -ERESTARTSYS)
1517 DRM_ERROR("Out of graphics memory for surface"
1522 user_srf = kzalloc(sizeof(*user_srf), GFP_KERNEL);
1523 if (unlikely(!user_srf)) {
1525 goto out_no_user_srf;
1528 *srf_out = &user_srf->srf;
1529 user_srf->size = user_accounting_size;
1530 user_srf->prime.base.shareable = false;
1531 user_srf->prime.base.tfile = NULL;
1533 srf = &user_srf->srf;
1534 srf->flags = svga3d_flags;
1535 srf->format = format;
1536 srf->scanout = for_scanout;
1537 srf->mip_levels[0] = num_mip_levels;
1540 srf->offsets = NULL;
1541 srf->base_size = size;
1542 srf->autogen_filter = SVGA3D_TEX_FILTER_NONE;
1543 srf->array_size = array_size;
1544 srf->multisample_count = multisample_count;
1547 num_layers = array_size;
1548 else if (svga3d_flags & SVGA3D_SURFACE_CUBEMAP)
1549 num_layers = SVGA3D_MAX_SURFACE_FACES;
1553 srf->res.backup_size =
1554 svga3dsurface_get_serialized_size(srf->format,
1559 if (srf->flags & SVGA3D_SURFACE_BIND_STREAM_OUTPUT)
1560 srf->res.backup_size += sizeof(SVGA3dDXSOState);
1562 if (dev_priv->active_display_unit == vmw_du_screen_target &&
1564 srf->flags |= SVGA3D_SURFACE_SCREENTARGET;
1567 * From this point, the generic resource management functions
1568 * destroy the object on failure.
1570 ret = vmw_surface_init(dev_priv, srf, vmw_user_surface_free);
1572 ttm_read_unlock(&dev_priv->reservation_sem);
1576 ttm_mem_global_free(vmw_mem_glob(dev_priv), user_accounting_size);
1579 ttm_read_unlock(&dev_priv->reservation_sem);