Loading...
1/**************************************************************************
2 *
3 * Copyright © 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#include "vmwgfx_drv.h"
29#include "vmwgfx_drm.h"
30#include "ttm/ttm_object.h"
31#include "ttm/ttm_placement.h"
32#include "drmP.h"
33
34#define VMW_RES_CONTEXT ttm_driver_type0
35#define VMW_RES_SURFACE ttm_driver_type1
36#define VMW_RES_STREAM ttm_driver_type2
37
38struct vmw_user_context {
39 struct ttm_base_object base;
40 struct vmw_resource res;
41};
42
43struct vmw_user_surface {
44 struct ttm_base_object base;
45 struct vmw_surface srf;
46};
47
48struct vmw_user_dma_buffer {
49 struct ttm_base_object base;
50 struct vmw_dma_buffer dma;
51};
52
53struct vmw_bo_user_rep {
54 uint32_t handle;
55 uint64_t map_handle;
56};
57
58struct vmw_stream {
59 struct vmw_resource res;
60 uint32_t stream_id;
61};
62
63struct vmw_user_stream {
64 struct ttm_base_object base;
65 struct vmw_stream stream;
66};
67
68static inline struct vmw_dma_buffer *
69vmw_dma_buffer(struct ttm_buffer_object *bo)
70{
71 return container_of(bo, struct vmw_dma_buffer, base);
72}
73
74static inline struct vmw_user_dma_buffer *
75vmw_user_dma_buffer(struct ttm_buffer_object *bo)
76{
77 struct vmw_dma_buffer *vmw_bo = vmw_dma_buffer(bo);
78 return container_of(vmw_bo, struct vmw_user_dma_buffer, dma);
79}
80
81struct vmw_resource *vmw_resource_reference(struct vmw_resource *res)
82{
83 kref_get(&res->kref);
84 return res;
85}
86
87static void vmw_resource_release(struct kref *kref)
88{
89 struct vmw_resource *res =
90 container_of(kref, struct vmw_resource, kref);
91 struct vmw_private *dev_priv = res->dev_priv;
92
93 idr_remove(res->idr, res->id);
94 write_unlock(&dev_priv->resource_lock);
95
96 if (likely(res->hw_destroy != NULL))
97 res->hw_destroy(res);
98
99 if (res->res_free != NULL)
100 res->res_free(res);
101 else
102 kfree(res);
103
104 write_lock(&dev_priv->resource_lock);
105}
106
107void vmw_resource_unreference(struct vmw_resource **p_res)
108{
109 struct vmw_resource *res = *p_res;
110 struct vmw_private *dev_priv = res->dev_priv;
111
112 *p_res = NULL;
113 write_lock(&dev_priv->resource_lock);
114 kref_put(&res->kref, vmw_resource_release);
115 write_unlock(&dev_priv->resource_lock);
116}
117
118static int vmw_resource_init(struct vmw_private *dev_priv,
119 struct vmw_resource *res,
120 struct idr *idr,
121 enum ttm_object_type obj_type,
122 void (*res_free) (struct vmw_resource *res))
123{
124 int ret;
125
126 kref_init(&res->kref);
127 res->hw_destroy = NULL;
128 res->res_free = res_free;
129 res->res_type = obj_type;
130 res->idr = idr;
131 res->avail = false;
132 res->dev_priv = dev_priv;
133
134 do {
135 if (unlikely(idr_pre_get(idr, GFP_KERNEL) == 0))
136 return -ENOMEM;
137
138 write_lock(&dev_priv->resource_lock);
139 ret = idr_get_new_above(idr, res, 1, &res->id);
140 write_unlock(&dev_priv->resource_lock);
141
142 } while (ret == -EAGAIN);
143
144 return ret;
145}
146
147/**
148 * vmw_resource_activate
149 *
150 * @res: Pointer to the newly created resource
151 * @hw_destroy: Destroy function. NULL if none.
152 *
153 * Activate a resource after the hardware has been made aware of it.
154 * Set tye destroy function to @destroy. Typically this frees the
155 * resource and destroys the hardware resources associated with it.
156 * Activate basically means that the function vmw_resource_lookup will
157 * find it.
158 */
159
160static void vmw_resource_activate(struct vmw_resource *res,
161 void (*hw_destroy) (struct vmw_resource *))
162{
163 struct vmw_private *dev_priv = res->dev_priv;
164
165 write_lock(&dev_priv->resource_lock);
166 res->avail = true;
167 res->hw_destroy = hw_destroy;
168 write_unlock(&dev_priv->resource_lock);
169}
170
171struct vmw_resource *vmw_resource_lookup(struct vmw_private *dev_priv,
172 struct idr *idr, int id)
173{
174 struct vmw_resource *res;
175
176 read_lock(&dev_priv->resource_lock);
177 res = idr_find(idr, id);
178 if (res && res->avail)
179 kref_get(&res->kref);
180 else
181 res = NULL;
182 read_unlock(&dev_priv->resource_lock);
183
184 if (unlikely(res == NULL))
185 return NULL;
186
187 return res;
188}
189
190/**
191 * Context management:
192 */
193
194static void vmw_hw_context_destroy(struct vmw_resource *res)
195{
196
197 struct vmw_private *dev_priv = res->dev_priv;
198 struct {
199 SVGA3dCmdHeader header;
200 SVGA3dCmdDestroyContext body;
201 } *cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
202
203 if (unlikely(cmd == NULL)) {
204 DRM_ERROR("Failed reserving FIFO space for surface "
205 "destruction.\n");
206 return;
207 }
208
209 cmd->header.id = cpu_to_le32(SVGA_3D_CMD_CONTEXT_DESTROY);
210 cmd->header.size = cpu_to_le32(sizeof(cmd->body));
211 cmd->body.cid = cpu_to_le32(res->id);
212
213 vmw_fifo_commit(dev_priv, sizeof(*cmd));
214 vmw_3d_resource_dec(dev_priv);
215}
216
217static int vmw_context_init(struct vmw_private *dev_priv,
218 struct vmw_resource *res,
219 void (*res_free) (struct vmw_resource *res))
220{
221 int ret;
222
223 struct {
224 SVGA3dCmdHeader header;
225 SVGA3dCmdDefineContext body;
226 } *cmd;
227
228 ret = vmw_resource_init(dev_priv, res, &dev_priv->context_idr,
229 VMW_RES_CONTEXT, res_free);
230
231 if (unlikely(ret != 0)) {
232 if (res_free == NULL)
233 kfree(res);
234 else
235 res_free(res);
236 return ret;
237 }
238
239 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
240 if (unlikely(cmd == NULL)) {
241 DRM_ERROR("Fifo reserve failed.\n");
242 vmw_resource_unreference(&res);
243 return -ENOMEM;
244 }
245
246 cmd->header.id = cpu_to_le32(SVGA_3D_CMD_CONTEXT_DEFINE);
247 cmd->header.size = cpu_to_le32(sizeof(cmd->body));
248 cmd->body.cid = cpu_to_le32(res->id);
249
250 vmw_fifo_commit(dev_priv, sizeof(*cmd));
251 (void) vmw_3d_resource_inc(dev_priv);
252 vmw_resource_activate(res, vmw_hw_context_destroy);
253 return 0;
254}
255
256struct vmw_resource *vmw_context_alloc(struct vmw_private *dev_priv)
257{
258 struct vmw_resource *res = kmalloc(sizeof(*res), GFP_KERNEL);
259 int ret;
260
261 if (unlikely(res == NULL))
262 return NULL;
263
264 ret = vmw_context_init(dev_priv, res, NULL);
265 return (ret == 0) ? res : NULL;
266}
267
268/**
269 * User-space context management:
270 */
271
272static void vmw_user_context_free(struct vmw_resource *res)
273{
274 struct vmw_user_context *ctx =
275 container_of(res, struct vmw_user_context, res);
276
277 kfree(ctx);
278}
279
280/**
281 * This function is called when user space has no more references on the
282 * base object. It releases the base-object's reference on the resource object.
283 */
284
285static void vmw_user_context_base_release(struct ttm_base_object **p_base)
286{
287 struct ttm_base_object *base = *p_base;
288 struct vmw_user_context *ctx =
289 container_of(base, struct vmw_user_context, base);
290 struct vmw_resource *res = &ctx->res;
291
292 *p_base = NULL;
293 vmw_resource_unreference(&res);
294}
295
296int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
297 struct drm_file *file_priv)
298{
299 struct vmw_private *dev_priv = vmw_priv(dev);
300 struct vmw_resource *res;
301 struct vmw_user_context *ctx;
302 struct drm_vmw_context_arg *arg = (struct drm_vmw_context_arg *)data;
303 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
304 int ret = 0;
305
306 res = vmw_resource_lookup(dev_priv, &dev_priv->context_idr, arg->cid);
307 if (unlikely(res == NULL))
308 return -EINVAL;
309
310 if (res->res_free != &vmw_user_context_free) {
311 ret = -EINVAL;
312 goto out;
313 }
314
315 ctx = container_of(res, struct vmw_user_context, res);
316 if (ctx->base.tfile != tfile && !ctx->base.shareable) {
317 ret = -EPERM;
318 goto out;
319 }
320
321 ttm_ref_object_base_unref(tfile, ctx->base.hash.key, TTM_REF_USAGE);
322out:
323 vmw_resource_unreference(&res);
324 return ret;
325}
326
327int vmw_context_define_ioctl(struct drm_device *dev, void *data,
328 struct drm_file *file_priv)
329{
330 struct vmw_private *dev_priv = vmw_priv(dev);
331 struct vmw_user_context *ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
332 struct vmw_resource *res;
333 struct vmw_resource *tmp;
334 struct drm_vmw_context_arg *arg = (struct drm_vmw_context_arg *)data;
335 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
336 int ret;
337
338 if (unlikely(ctx == NULL))
339 return -ENOMEM;
340
341 res = &ctx->res;
342 ctx->base.shareable = false;
343 ctx->base.tfile = NULL;
344
345 ret = vmw_context_init(dev_priv, res, vmw_user_context_free);
346 if (unlikely(ret != 0))
347 return ret;
348
349 tmp = vmw_resource_reference(&ctx->res);
350 ret = ttm_base_object_init(tfile, &ctx->base, false, VMW_RES_CONTEXT,
351 &vmw_user_context_base_release, NULL);
352
353 if (unlikely(ret != 0)) {
354 vmw_resource_unreference(&tmp);
355 goto out_err;
356 }
357
358 arg->cid = res->id;
359out_err:
360 vmw_resource_unreference(&res);
361 return ret;
362
363}
364
365int vmw_context_check(struct vmw_private *dev_priv,
366 struct ttm_object_file *tfile,
367 int id)
368{
369 struct vmw_resource *res;
370 int ret = 0;
371
372 read_lock(&dev_priv->resource_lock);
373 res = idr_find(&dev_priv->context_idr, id);
374 if (res && res->avail) {
375 struct vmw_user_context *ctx =
376 container_of(res, struct vmw_user_context, res);
377 if (ctx->base.tfile != tfile && !ctx->base.shareable)
378 ret = -EPERM;
379 } else
380 ret = -EINVAL;
381 read_unlock(&dev_priv->resource_lock);
382
383 return ret;
384}
385
386
387/**
388 * Surface management.
389 */
390
391static void vmw_hw_surface_destroy(struct vmw_resource *res)
392{
393
394 struct vmw_private *dev_priv = res->dev_priv;
395 struct {
396 SVGA3dCmdHeader header;
397 SVGA3dCmdDestroySurface body;
398 } *cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
399
400 if (unlikely(cmd == NULL)) {
401 DRM_ERROR("Failed reserving FIFO space for surface "
402 "destruction.\n");
403 return;
404 }
405
406 cmd->header.id = cpu_to_le32(SVGA_3D_CMD_SURFACE_DESTROY);
407 cmd->header.size = cpu_to_le32(sizeof(cmd->body));
408 cmd->body.sid = cpu_to_le32(res->id);
409
410 vmw_fifo_commit(dev_priv, sizeof(*cmd));
411 vmw_3d_resource_dec(dev_priv);
412}
413
414void vmw_surface_res_free(struct vmw_resource *res)
415{
416 struct vmw_surface *srf = container_of(res, struct vmw_surface, res);
417
418 kfree(srf->sizes);
419 kfree(srf->snooper.image);
420 kfree(srf);
421}
422
423int vmw_surface_init(struct vmw_private *dev_priv,
424 struct vmw_surface *srf,
425 void (*res_free) (struct vmw_resource *res))
426{
427 int ret;
428 struct {
429 SVGA3dCmdHeader header;
430 SVGA3dCmdDefineSurface body;
431 } *cmd;
432 SVGA3dSize *cmd_size;
433 struct vmw_resource *res = &srf->res;
434 struct drm_vmw_size *src_size;
435 size_t submit_size;
436 uint32_t cmd_len;
437 int i;
438
439 BUG_ON(res_free == NULL);
440 ret = vmw_resource_init(dev_priv, res, &dev_priv->surface_idr,
441 VMW_RES_SURFACE, res_free);
442
443 if (unlikely(ret != 0)) {
444 res_free(res);
445 return ret;
446 }
447
448 submit_size = sizeof(*cmd) + srf->num_sizes * sizeof(SVGA3dSize);
449 cmd_len = sizeof(cmd->body) + srf->num_sizes * sizeof(SVGA3dSize);
450
451 cmd = vmw_fifo_reserve(dev_priv, submit_size);
452 if (unlikely(cmd == NULL)) {
453 DRM_ERROR("Fifo reserve failed for create surface.\n");
454 vmw_resource_unreference(&res);
455 return -ENOMEM;
456 }
457
458 cmd->header.id = cpu_to_le32(SVGA_3D_CMD_SURFACE_DEFINE);
459 cmd->header.size = cpu_to_le32(cmd_len);
460 cmd->body.sid = cpu_to_le32(res->id);
461 cmd->body.surfaceFlags = cpu_to_le32(srf->flags);
462 cmd->body.format = cpu_to_le32(srf->format);
463 for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i) {
464 cmd->body.face[i].numMipLevels =
465 cpu_to_le32(srf->mip_levels[i]);
466 }
467
468 cmd += 1;
469 cmd_size = (SVGA3dSize *) cmd;
470 src_size = srf->sizes;
471
472 for (i = 0; i < srf->num_sizes; ++i, cmd_size++, src_size++) {
473 cmd_size->width = cpu_to_le32(src_size->width);
474 cmd_size->height = cpu_to_le32(src_size->height);
475 cmd_size->depth = cpu_to_le32(src_size->depth);
476 }
477
478 vmw_fifo_commit(dev_priv, submit_size);
479 (void) vmw_3d_resource_inc(dev_priv);
480 vmw_resource_activate(res, vmw_hw_surface_destroy);
481 return 0;
482}
483
484static void vmw_user_surface_free(struct vmw_resource *res)
485{
486 struct vmw_surface *srf = container_of(res, struct vmw_surface, res);
487 struct vmw_user_surface *user_srf =
488 container_of(srf, struct vmw_user_surface, srf);
489
490 kfree(srf->sizes);
491 kfree(srf->snooper.image);
492 kfree(user_srf);
493}
494
495int vmw_user_surface_lookup_handle(struct vmw_private *dev_priv,
496 struct ttm_object_file *tfile,
497 uint32_t handle, struct vmw_surface **out)
498{
499 struct vmw_resource *res;
500 struct vmw_surface *srf;
501 struct vmw_user_surface *user_srf;
502 struct ttm_base_object *base;
503 int ret = -EINVAL;
504
505 base = ttm_base_object_lookup(tfile, handle);
506 if (unlikely(base == NULL))
507 return -EINVAL;
508
509 if (unlikely(base->object_type != VMW_RES_SURFACE))
510 goto out_bad_resource;
511
512 user_srf = container_of(base, struct vmw_user_surface, base);
513 srf = &user_srf->srf;
514 res = &srf->res;
515
516 read_lock(&dev_priv->resource_lock);
517
518 if (!res->avail || res->res_free != &vmw_user_surface_free) {
519 read_unlock(&dev_priv->resource_lock);
520 goto out_bad_resource;
521 }
522
523 kref_get(&res->kref);
524 read_unlock(&dev_priv->resource_lock);
525
526 *out = srf;
527 ret = 0;
528
529out_bad_resource:
530 ttm_base_object_unref(&base);
531
532 return ret;
533}
534
535static void vmw_user_surface_base_release(struct ttm_base_object **p_base)
536{
537 struct ttm_base_object *base = *p_base;
538 struct vmw_user_surface *user_srf =
539 container_of(base, struct vmw_user_surface, base);
540 struct vmw_resource *res = &user_srf->srf.res;
541
542 *p_base = NULL;
543 vmw_resource_unreference(&res);
544}
545
546int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
547 struct drm_file *file_priv)
548{
549 struct drm_vmw_surface_arg *arg = (struct drm_vmw_surface_arg *)data;
550 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
551
552 return ttm_ref_object_base_unref(tfile, arg->sid, TTM_REF_USAGE);
553}
554
555int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
556 struct drm_file *file_priv)
557{
558 struct vmw_private *dev_priv = vmw_priv(dev);
559 struct vmw_user_surface *user_srf =
560 kmalloc(sizeof(*user_srf), GFP_KERNEL);
561 struct vmw_surface *srf;
562 struct vmw_resource *res;
563 struct vmw_resource *tmp;
564 union drm_vmw_surface_create_arg *arg =
565 (union drm_vmw_surface_create_arg *)data;
566 struct drm_vmw_surface_create_req *req = &arg->req;
567 struct drm_vmw_surface_arg *rep = &arg->rep;
568 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
569 struct drm_vmw_size __user *user_sizes;
570 int ret;
571 int i;
572
573 if (unlikely(user_srf == NULL))
574 return -ENOMEM;
575
576 srf = &user_srf->srf;
577 res = &srf->res;
578
579 srf->flags = req->flags;
580 srf->format = req->format;
581 srf->scanout = req->scanout;
582 memcpy(srf->mip_levels, req->mip_levels, sizeof(srf->mip_levels));
583 srf->num_sizes = 0;
584 for (i = 0; i < DRM_VMW_MAX_SURFACE_FACES; ++i)
585 srf->num_sizes += srf->mip_levels[i];
586
587 if (srf->num_sizes > DRM_VMW_MAX_SURFACE_FACES *
588 DRM_VMW_MAX_MIP_LEVELS) {
589 ret = -EINVAL;
590 goto out_err0;
591 }
592
593 srf->sizes = kmalloc(srf->num_sizes * sizeof(*srf->sizes), GFP_KERNEL);
594 if (unlikely(srf->sizes == NULL)) {
595 ret = -ENOMEM;
596 goto out_err0;
597 }
598
599 user_sizes = (struct drm_vmw_size __user *)(unsigned long)
600 req->size_addr;
601
602 ret = copy_from_user(srf->sizes, user_sizes,
603 srf->num_sizes * sizeof(*srf->sizes));
604 if (unlikely(ret != 0)) {
605 ret = -EFAULT;
606 goto out_err1;
607 }
608
609 if (srf->scanout &&
610 srf->num_sizes == 1 &&
611 srf->sizes[0].width == 64 &&
612 srf->sizes[0].height == 64 &&
613 srf->format == SVGA3D_A8R8G8B8) {
614
615 /* allocate image area and clear it */
616 srf->snooper.image = kzalloc(64 * 64 * 4, GFP_KERNEL);
617 if (!srf->snooper.image) {
618 DRM_ERROR("Failed to allocate cursor_image\n");
619 ret = -ENOMEM;
620 goto out_err1;
621 }
622 } else {
623 srf->snooper.image = NULL;
624 }
625 srf->snooper.crtc = NULL;
626
627 user_srf->base.shareable = false;
628 user_srf->base.tfile = NULL;
629
630 /**
631 * From this point, the generic resource management functions
632 * destroy the object on failure.
633 */
634
635 ret = vmw_surface_init(dev_priv, srf, vmw_user_surface_free);
636 if (unlikely(ret != 0))
637 return ret;
638
639 tmp = vmw_resource_reference(&srf->res);
640 ret = ttm_base_object_init(tfile, &user_srf->base,
641 req->shareable, VMW_RES_SURFACE,
642 &vmw_user_surface_base_release, NULL);
643
644 if (unlikely(ret != 0)) {
645 vmw_resource_unreference(&tmp);
646 vmw_resource_unreference(&res);
647 return ret;
648 }
649
650 rep->sid = user_srf->base.hash.key;
651 if (rep->sid == SVGA3D_INVALID_ID)
652 DRM_ERROR("Created bad Surface ID.\n");
653
654 vmw_resource_unreference(&res);
655 return 0;
656out_err1:
657 kfree(srf->sizes);
658out_err0:
659 kfree(user_srf);
660 return ret;
661}
662
663int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
664 struct drm_file *file_priv)
665{
666 union drm_vmw_surface_reference_arg *arg =
667 (union drm_vmw_surface_reference_arg *)data;
668 struct drm_vmw_surface_arg *req = &arg->req;
669 struct drm_vmw_surface_create_req *rep = &arg->rep;
670 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
671 struct vmw_surface *srf;
672 struct vmw_user_surface *user_srf;
673 struct drm_vmw_size __user *user_sizes;
674 struct ttm_base_object *base;
675 int ret = -EINVAL;
676
677 base = ttm_base_object_lookup(tfile, req->sid);
678 if (unlikely(base == NULL)) {
679 DRM_ERROR("Could not find surface to reference.\n");
680 return -EINVAL;
681 }
682
683 if (unlikely(base->object_type != VMW_RES_SURFACE))
684 goto out_bad_resource;
685
686 user_srf = container_of(base, struct vmw_user_surface, base);
687 srf = &user_srf->srf;
688
689 ret = ttm_ref_object_add(tfile, &user_srf->base, TTM_REF_USAGE, NULL);
690 if (unlikely(ret != 0)) {
691 DRM_ERROR("Could not add a reference to a surface.\n");
692 goto out_no_reference;
693 }
694
695 rep->flags = srf->flags;
696 rep->format = srf->format;
697 memcpy(rep->mip_levels, srf->mip_levels, sizeof(srf->mip_levels));
698 user_sizes = (struct drm_vmw_size __user *)(unsigned long)
699 rep->size_addr;
700
701 if (user_sizes)
702 ret = copy_to_user(user_sizes, srf->sizes,
703 srf->num_sizes * sizeof(*srf->sizes));
704 if (unlikely(ret != 0)) {
705 DRM_ERROR("copy_to_user failed %p %u\n",
706 user_sizes, srf->num_sizes);
707 ret = -EFAULT;
708 }
709out_bad_resource:
710out_no_reference:
711 ttm_base_object_unref(&base);
712
713 return ret;
714}
715
716int vmw_surface_check(struct vmw_private *dev_priv,
717 struct ttm_object_file *tfile,
718 uint32_t handle, int *id)
719{
720 struct ttm_base_object *base;
721 struct vmw_user_surface *user_srf;
722
723 int ret = -EPERM;
724
725 base = ttm_base_object_lookup(tfile, handle);
726 if (unlikely(base == NULL))
727 return -EINVAL;
728
729 if (unlikely(base->object_type != VMW_RES_SURFACE))
730 goto out_bad_surface;
731
732 user_srf = container_of(base, struct vmw_user_surface, base);
733 *id = user_srf->srf.res.id;
734 ret = 0;
735
736out_bad_surface:
737 /**
738 * FIXME: May deadlock here when called from the
739 * command parsing code.
740 */
741
742 ttm_base_object_unref(&base);
743 return ret;
744}
745
746/**
747 * Buffer management.
748 */
749
750static size_t vmw_dmabuf_acc_size(struct ttm_bo_global *glob,
751 unsigned long num_pages)
752{
753 static size_t bo_user_size = ~0;
754
755 size_t page_array_size =
756 (num_pages * sizeof(void *) + PAGE_SIZE - 1) & PAGE_MASK;
757
758 if (unlikely(bo_user_size == ~0)) {
759 bo_user_size = glob->ttm_bo_extra_size +
760 ttm_round_pot(sizeof(struct vmw_dma_buffer));
761 }
762
763 return bo_user_size + page_array_size;
764}
765
766void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo)
767{
768 struct vmw_dma_buffer *vmw_bo = vmw_dma_buffer(bo);
769 struct ttm_bo_global *glob = bo->glob;
770
771 ttm_mem_global_free(glob->mem_glob, bo->acc_size);
772 kfree(vmw_bo);
773}
774
775int vmw_dmabuf_init(struct vmw_private *dev_priv,
776 struct vmw_dma_buffer *vmw_bo,
777 size_t size, struct ttm_placement *placement,
778 bool interruptible,
779 void (*bo_free) (struct ttm_buffer_object *bo))
780{
781 struct ttm_bo_device *bdev = &dev_priv->bdev;
782 struct ttm_mem_global *mem_glob = bdev->glob->mem_glob;
783 size_t acc_size;
784 int ret;
785
786 BUG_ON(!bo_free);
787
788 acc_size =
789 vmw_dmabuf_acc_size(bdev->glob,
790 (size + PAGE_SIZE - 1) >> PAGE_SHIFT);
791
792 ret = ttm_mem_global_alloc(mem_glob, acc_size, false, false);
793 if (unlikely(ret != 0)) {
794 /* we must free the bo here as
795 * ttm_buffer_object_init does so as well */
796 bo_free(&vmw_bo->base);
797 return ret;
798 }
799
800 memset(vmw_bo, 0, sizeof(*vmw_bo));
801
802 INIT_LIST_HEAD(&vmw_bo->validate_list);
803
804 ret = ttm_bo_init(bdev, &vmw_bo->base, size,
805 ttm_bo_type_device, placement,
806 0, 0, interruptible,
807 NULL, acc_size, bo_free);
808 return ret;
809}
810
811static void vmw_user_dmabuf_destroy(struct ttm_buffer_object *bo)
812{
813 struct vmw_user_dma_buffer *vmw_user_bo = vmw_user_dma_buffer(bo);
814 struct ttm_bo_global *glob = bo->glob;
815
816 ttm_mem_global_free(glob->mem_glob, bo->acc_size);
817 kfree(vmw_user_bo);
818}
819
820static void vmw_user_dmabuf_release(struct ttm_base_object **p_base)
821{
822 struct vmw_user_dma_buffer *vmw_user_bo;
823 struct ttm_base_object *base = *p_base;
824 struct ttm_buffer_object *bo;
825
826 *p_base = NULL;
827
828 if (unlikely(base == NULL))
829 return;
830
831 vmw_user_bo = container_of(base, struct vmw_user_dma_buffer, base);
832 bo = &vmw_user_bo->dma.base;
833 ttm_bo_unref(&bo);
834}
835
836int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
837 struct drm_file *file_priv)
838{
839 struct vmw_private *dev_priv = vmw_priv(dev);
840 union drm_vmw_alloc_dmabuf_arg *arg =
841 (union drm_vmw_alloc_dmabuf_arg *)data;
842 struct drm_vmw_alloc_dmabuf_req *req = &arg->req;
843 struct drm_vmw_dmabuf_rep *rep = &arg->rep;
844 struct vmw_user_dma_buffer *vmw_user_bo;
845 struct ttm_buffer_object *tmp;
846 struct vmw_master *vmaster = vmw_master(file_priv->master);
847 int ret;
848
849 vmw_user_bo = kzalloc(sizeof(*vmw_user_bo), GFP_KERNEL);
850 if (unlikely(vmw_user_bo == NULL))
851 return -ENOMEM;
852
853 ret = ttm_read_lock(&vmaster->lock, true);
854 if (unlikely(ret != 0)) {
855 kfree(vmw_user_bo);
856 return ret;
857 }
858
859 ret = vmw_dmabuf_init(dev_priv, &vmw_user_bo->dma, req->size,
860 &vmw_vram_sys_placement, true,
861 &vmw_user_dmabuf_destroy);
862 if (unlikely(ret != 0))
863 goto out_no_dmabuf;
864
865 tmp = ttm_bo_reference(&vmw_user_bo->dma.base);
866 ret = ttm_base_object_init(vmw_fpriv(file_priv)->tfile,
867 &vmw_user_bo->base,
868 false,
869 ttm_buffer_type,
870 &vmw_user_dmabuf_release, NULL);
871 if (unlikely(ret != 0))
872 goto out_no_base_object;
873 else {
874 rep->handle = vmw_user_bo->base.hash.key;
875 rep->map_handle = vmw_user_bo->dma.base.addr_space_offset;
876 rep->cur_gmr_id = vmw_user_bo->base.hash.key;
877 rep->cur_gmr_offset = 0;
878 }
879
880out_no_base_object:
881 ttm_bo_unref(&tmp);
882out_no_dmabuf:
883 ttm_read_unlock(&vmaster->lock);
884
885 return ret;
886}
887
888int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
889 struct drm_file *file_priv)
890{
891 struct drm_vmw_unref_dmabuf_arg *arg =
892 (struct drm_vmw_unref_dmabuf_arg *)data;
893
894 return ttm_ref_object_base_unref(vmw_fpriv(file_priv)->tfile,
895 arg->handle,
896 TTM_REF_USAGE);
897}
898
899uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
900 uint32_t cur_validate_node)
901{
902 struct vmw_dma_buffer *vmw_bo = vmw_dma_buffer(bo);
903
904 if (likely(vmw_bo->on_validate_list))
905 return vmw_bo->cur_validate_node;
906
907 vmw_bo->cur_validate_node = cur_validate_node;
908 vmw_bo->on_validate_list = true;
909
910 return cur_validate_node;
911}
912
913void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo)
914{
915 struct vmw_dma_buffer *vmw_bo = vmw_dma_buffer(bo);
916
917 vmw_bo->on_validate_list = false;
918}
919
920int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
921 uint32_t handle, struct vmw_dma_buffer **out)
922{
923 struct vmw_user_dma_buffer *vmw_user_bo;
924 struct ttm_base_object *base;
925
926 base = ttm_base_object_lookup(tfile, handle);
927 if (unlikely(base == NULL)) {
928 printk(KERN_ERR "Invalid buffer object handle 0x%08lx.\n",
929 (unsigned long)handle);
930 return -ESRCH;
931 }
932
933 if (unlikely(base->object_type != ttm_buffer_type)) {
934 ttm_base_object_unref(&base);
935 printk(KERN_ERR "Invalid buffer object handle 0x%08lx.\n",
936 (unsigned long)handle);
937 return -EINVAL;
938 }
939
940 vmw_user_bo = container_of(base, struct vmw_user_dma_buffer, base);
941 (void)ttm_bo_reference(&vmw_user_bo->dma.base);
942 ttm_base_object_unref(&base);
943 *out = &vmw_user_bo->dma;
944
945 return 0;
946}
947
948/*
949 * Stream management
950 */
951
952static void vmw_stream_destroy(struct vmw_resource *res)
953{
954 struct vmw_private *dev_priv = res->dev_priv;
955 struct vmw_stream *stream;
956 int ret;
957
958 DRM_INFO("%s: unref\n", __func__);
959 stream = container_of(res, struct vmw_stream, res);
960
961 ret = vmw_overlay_unref(dev_priv, stream->stream_id);
962 WARN_ON(ret != 0);
963}
964
965static int vmw_stream_init(struct vmw_private *dev_priv,
966 struct vmw_stream *stream,
967 void (*res_free) (struct vmw_resource *res))
968{
969 struct vmw_resource *res = &stream->res;
970 int ret;
971
972 ret = vmw_resource_init(dev_priv, res, &dev_priv->stream_idr,
973 VMW_RES_STREAM, res_free);
974
975 if (unlikely(ret != 0)) {
976 if (res_free == NULL)
977 kfree(stream);
978 else
979 res_free(&stream->res);
980 return ret;
981 }
982
983 ret = vmw_overlay_claim(dev_priv, &stream->stream_id);
984 if (ret) {
985 vmw_resource_unreference(&res);
986 return ret;
987 }
988
989 DRM_INFO("%s: claimed\n", __func__);
990
991 vmw_resource_activate(&stream->res, vmw_stream_destroy);
992 return 0;
993}
994
995/**
996 * User-space context management:
997 */
998
999static void vmw_user_stream_free(struct vmw_resource *res)
1000{
1001 struct vmw_user_stream *stream =
1002 container_of(res, struct vmw_user_stream, stream.res);
1003
1004 kfree(stream);
1005}
1006
1007/**
1008 * This function is called when user space has no more references on the
1009 * base object. It releases the base-object's reference on the resource object.
1010 */
1011
1012static void vmw_user_stream_base_release(struct ttm_base_object **p_base)
1013{
1014 struct ttm_base_object *base = *p_base;
1015 struct vmw_user_stream *stream =
1016 container_of(base, struct vmw_user_stream, base);
1017 struct vmw_resource *res = &stream->stream.res;
1018
1019 *p_base = NULL;
1020 vmw_resource_unreference(&res);
1021}
1022
1023int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
1024 struct drm_file *file_priv)
1025{
1026 struct vmw_private *dev_priv = vmw_priv(dev);
1027 struct vmw_resource *res;
1028 struct vmw_user_stream *stream;
1029 struct drm_vmw_stream_arg *arg = (struct drm_vmw_stream_arg *)data;
1030 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1031 int ret = 0;
1032
1033 res = vmw_resource_lookup(dev_priv, &dev_priv->stream_idr, arg->stream_id);
1034 if (unlikely(res == NULL))
1035 return -EINVAL;
1036
1037 if (res->res_free != &vmw_user_stream_free) {
1038 ret = -EINVAL;
1039 goto out;
1040 }
1041
1042 stream = container_of(res, struct vmw_user_stream, stream.res);
1043 if (stream->base.tfile != tfile) {
1044 ret = -EINVAL;
1045 goto out;
1046 }
1047
1048 ttm_ref_object_base_unref(tfile, stream->base.hash.key, TTM_REF_USAGE);
1049out:
1050 vmw_resource_unreference(&res);
1051 return ret;
1052}
1053
1054int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
1055 struct drm_file *file_priv)
1056{
1057 struct vmw_private *dev_priv = vmw_priv(dev);
1058 struct vmw_user_stream *stream = kmalloc(sizeof(*stream), GFP_KERNEL);
1059 struct vmw_resource *res;
1060 struct vmw_resource *tmp;
1061 struct drm_vmw_stream_arg *arg = (struct drm_vmw_stream_arg *)data;
1062 struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
1063 int ret;
1064
1065 if (unlikely(stream == NULL))
1066 return -ENOMEM;
1067
1068 res = &stream->stream.res;
1069 stream->base.shareable = false;
1070 stream->base.tfile = NULL;
1071
1072 ret = vmw_stream_init(dev_priv, &stream->stream, vmw_user_stream_free);
1073 if (unlikely(ret != 0))
1074 return ret;
1075
1076 tmp = vmw_resource_reference(res);
1077 ret = ttm_base_object_init(tfile, &stream->base, false, VMW_RES_STREAM,
1078 &vmw_user_stream_base_release, NULL);
1079
1080 if (unlikely(ret != 0)) {
1081 vmw_resource_unreference(&tmp);
1082 goto out_err;
1083 }
1084
1085 arg->stream_id = res->id;
1086out_err:
1087 vmw_resource_unreference(&res);
1088 return ret;
1089}
1090
1091int vmw_user_stream_lookup(struct vmw_private *dev_priv,
1092 struct ttm_object_file *tfile,
1093 uint32_t *inout_id, struct vmw_resource **out)
1094{
1095 struct vmw_user_stream *stream;
1096 struct vmw_resource *res;
1097 int ret;
1098
1099 res = vmw_resource_lookup(dev_priv, &dev_priv->stream_idr, *inout_id);
1100 if (unlikely(res == NULL))
1101 return -EINVAL;
1102
1103 if (res->res_free != &vmw_user_stream_free) {
1104 ret = -EINVAL;
1105 goto err_ref;
1106 }
1107
1108 stream = container_of(res, struct vmw_user_stream, stream.res);
1109 if (stream->base.tfile != tfile) {
1110 ret = -EPERM;
1111 goto err_ref;
1112 }
1113
1114 *inout_id = stream->stream.stream_id;
1115 *out = res;
1116 return 0;
1117err_ref:
1118 vmw_resource_unreference(&res);
1119 return ret;
1120}
1// SPDX-License-Identifier: GPL-2.0 OR MIT
2/**************************************************************************
3 *
4 * Copyright 2009-2023 VMware, Inc., Palo Alto, CA., USA
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#include <drm/ttm/ttm_placement.h>
29
30#include "vmwgfx_binding.h"
31#include "vmwgfx_bo.h"
32#include "vmwgfx_drv.h"
33#include "vmwgfx_resource_priv.h"
34
35#define VMW_RES_EVICT_ERR_COUNT 10
36
37/**
38 * vmw_resource_mob_attach - Mark a resource as attached to its backing mob
39 * @res: The resource
40 */
41void vmw_resource_mob_attach(struct vmw_resource *res)
42{
43 struct vmw_bo *gbo = res->guest_memory_bo;
44 struct rb_node **new = &gbo->res_tree.rb_node, *parent = NULL;
45
46 dma_resv_assert_held(gbo->tbo.base.resv);
47 res->used_prio = (res->res_dirty) ? res->func->dirty_prio :
48 res->func->prio;
49
50 while (*new) {
51 struct vmw_resource *this =
52 container_of(*new, struct vmw_resource, mob_node);
53
54 parent = *new;
55 new = (res->guest_memory_offset < this->guest_memory_offset) ?
56 &((*new)->rb_left) : &((*new)->rb_right);
57 }
58
59 rb_link_node(&res->mob_node, parent, new);
60 rb_insert_color(&res->mob_node, &gbo->res_tree);
61
62 vmw_bo_prio_add(gbo, res->used_prio);
63}
64
65/**
66 * vmw_resource_mob_detach - Mark a resource as detached from its backing mob
67 * @res: The resource
68 */
69void vmw_resource_mob_detach(struct vmw_resource *res)
70{
71 struct vmw_bo *gbo = res->guest_memory_bo;
72
73 dma_resv_assert_held(gbo->tbo.base.resv);
74 if (vmw_resource_mob_attached(res)) {
75 rb_erase(&res->mob_node, &gbo->res_tree);
76 RB_CLEAR_NODE(&res->mob_node);
77 vmw_bo_prio_del(gbo, res->used_prio);
78 }
79}
80
81struct vmw_resource *vmw_resource_reference(struct vmw_resource *res)
82{
83 kref_get(&res->kref);
84 return res;
85}
86
87struct vmw_resource *
88vmw_resource_reference_unless_doomed(struct vmw_resource *res)
89{
90 return kref_get_unless_zero(&res->kref) ? res : NULL;
91}
92
93/**
94 * vmw_resource_release_id - release a resource id to the id manager.
95 *
96 * @res: Pointer to the resource.
97 *
98 * Release the resource id to the resource id manager and set it to -1
99 */
100void vmw_resource_release_id(struct vmw_resource *res)
101{
102 struct vmw_private *dev_priv = res->dev_priv;
103 struct idr *idr = &dev_priv->res_idr[res->func->res_type];
104
105 spin_lock(&dev_priv->resource_lock);
106 if (res->id != -1)
107 idr_remove(idr, res->id);
108 res->id = -1;
109 spin_unlock(&dev_priv->resource_lock);
110}
111
112static void vmw_resource_release(struct kref *kref)
113{
114 struct vmw_resource *res =
115 container_of(kref, struct vmw_resource, kref);
116 struct vmw_private *dev_priv = res->dev_priv;
117 int id;
118 int ret;
119 struct idr *idr = &dev_priv->res_idr[res->func->res_type];
120
121 spin_lock(&dev_priv->resource_lock);
122 list_del_init(&res->lru_head);
123 spin_unlock(&dev_priv->resource_lock);
124 if (res->guest_memory_bo) {
125 struct ttm_buffer_object *bo = &res->guest_memory_bo->tbo;
126
127 ret = ttm_bo_reserve(bo, false, false, NULL);
128 BUG_ON(ret);
129 if (vmw_resource_mob_attached(res) &&
130 res->func->unbind != NULL) {
131 struct ttm_validate_buffer val_buf;
132
133 val_buf.bo = bo;
134 val_buf.num_shared = 0;
135 res->func->unbind(res, false, &val_buf);
136 }
137 res->guest_memory_size = false;
138 vmw_resource_mob_detach(res);
139 if (res->dirty)
140 res->func->dirty_free(res);
141 if (res->coherent)
142 vmw_bo_dirty_release(res->guest_memory_bo);
143 ttm_bo_unreserve(bo);
144 vmw_user_bo_unref(&res->guest_memory_bo);
145 }
146
147 if (likely(res->hw_destroy != NULL)) {
148 mutex_lock(&dev_priv->binding_mutex);
149 vmw_binding_res_list_kill(&res->binding_head);
150 mutex_unlock(&dev_priv->binding_mutex);
151 res->hw_destroy(res);
152 }
153
154 id = res->id;
155 if (res->res_free != NULL)
156 res->res_free(res);
157 else
158 kfree(res);
159
160 spin_lock(&dev_priv->resource_lock);
161 if (id != -1)
162 idr_remove(idr, id);
163 spin_unlock(&dev_priv->resource_lock);
164}
165
166void vmw_resource_unreference(struct vmw_resource **p_res)
167{
168 struct vmw_resource *res = *p_res;
169
170 *p_res = NULL;
171 kref_put(&res->kref, vmw_resource_release);
172}
173
174
175/**
176 * vmw_resource_alloc_id - release a resource id to the id manager.
177 *
178 * @res: Pointer to the resource.
179 *
180 * Allocate the lowest free resource from the resource manager, and set
181 * @res->id to that id. Returns 0 on success and -ENOMEM on failure.
182 */
183int vmw_resource_alloc_id(struct vmw_resource *res)
184{
185 struct vmw_private *dev_priv = res->dev_priv;
186 int ret;
187 struct idr *idr = &dev_priv->res_idr[res->func->res_type];
188
189 BUG_ON(res->id != -1);
190
191 idr_preload(GFP_KERNEL);
192 spin_lock(&dev_priv->resource_lock);
193
194 ret = idr_alloc(idr, res, 1, 0, GFP_NOWAIT);
195 if (ret >= 0)
196 res->id = ret;
197
198 spin_unlock(&dev_priv->resource_lock);
199 idr_preload_end();
200 return ret < 0 ? ret : 0;
201}
202
203/**
204 * vmw_resource_init - initialize a struct vmw_resource
205 *
206 * @dev_priv: Pointer to a device private struct.
207 * @res: The struct vmw_resource to initialize.
208 * @delay_id: Boolean whether to defer device id allocation until
209 * the first validation.
210 * @res_free: Resource destructor.
211 * @func: Resource function table.
212 */
213int vmw_resource_init(struct vmw_private *dev_priv, struct vmw_resource *res,
214 bool delay_id,
215 void (*res_free) (struct vmw_resource *res),
216 const struct vmw_res_func *func)
217{
218 kref_init(&res->kref);
219 res->hw_destroy = NULL;
220 res->res_free = res_free;
221 res->dev_priv = dev_priv;
222 res->func = func;
223 RB_CLEAR_NODE(&res->mob_node);
224 INIT_LIST_HEAD(&res->lru_head);
225 INIT_LIST_HEAD(&res->binding_head);
226 res->id = -1;
227 res->guest_memory_bo = NULL;
228 res->guest_memory_offset = 0;
229 res->guest_memory_dirty = false;
230 res->res_dirty = false;
231 res->coherent = false;
232 res->used_prio = 3;
233 res->dirty = NULL;
234 if (delay_id)
235 return 0;
236 else
237 return vmw_resource_alloc_id(res);
238}
239
240
241/**
242 * vmw_user_resource_lookup_handle - lookup a struct resource from a
243 * TTM user-space handle and perform basic type checks
244 *
245 * @dev_priv: Pointer to a device private struct
246 * @tfile: Pointer to a struct ttm_object_file identifying the caller
247 * @handle: The TTM user-space handle
248 * @converter: Pointer to an object describing the resource type
249 * @p_res: On successful return the location pointed to will contain
250 * a pointer to a refcounted struct vmw_resource.
251 *
252 * If the handle can't be found or is associated with an incorrect resource
253 * type, -EINVAL will be returned.
254 */
255int vmw_user_resource_lookup_handle(struct vmw_private *dev_priv,
256 struct ttm_object_file *tfile,
257 uint32_t handle,
258 const struct vmw_user_resource_conv
259 *converter,
260 struct vmw_resource **p_res)
261{
262 struct ttm_base_object *base;
263 struct vmw_resource *res;
264 int ret = -EINVAL;
265
266 base = ttm_base_object_lookup(tfile, handle);
267 if (unlikely(!base))
268 return -EINVAL;
269
270 if (unlikely(ttm_base_object_type(base) != converter->object_type))
271 goto out_bad_resource;
272
273 res = converter->base_obj_to_res(base);
274 kref_get(&res->kref);
275
276 *p_res = res;
277 ret = 0;
278
279out_bad_resource:
280 ttm_base_object_unref(&base);
281
282 return ret;
283}
284
285/*
286 * Helper function that looks either a surface or bo.
287 *
288 * The pointer this pointed at by out_surf and out_buf needs to be null.
289 */
290int vmw_user_lookup_handle(struct vmw_private *dev_priv,
291 struct drm_file *filp,
292 uint32_t handle,
293 struct vmw_surface **out_surf,
294 struct vmw_bo **out_buf)
295{
296 struct ttm_object_file *tfile = vmw_fpriv(filp)->tfile;
297 struct vmw_resource *res;
298 int ret;
299
300 BUG_ON(*out_surf || *out_buf);
301
302 ret = vmw_user_resource_lookup_handle(dev_priv, tfile, handle,
303 user_surface_converter,
304 &res);
305 if (!ret) {
306 *out_surf = vmw_res_to_srf(res);
307 return 0;
308 }
309
310 *out_surf = NULL;
311 ret = vmw_user_bo_lookup(filp, handle, out_buf);
312 return ret;
313}
314
315/**
316 * vmw_resource_buf_alloc - Allocate a guest memory buffer for a resource.
317 *
318 * @res: The resource for which to allocate a gbo buffer.
319 * @interruptible: Whether any sleeps during allocation should be
320 * performed while interruptible.
321 */
322static int vmw_resource_buf_alloc(struct vmw_resource *res,
323 bool interruptible)
324{
325 unsigned long size = PFN_ALIGN(res->guest_memory_size);
326 struct vmw_bo *gbo;
327 struct vmw_bo_params bo_params = {
328 .domain = res->func->domain,
329 .busy_domain = res->func->busy_domain,
330 .bo_type = ttm_bo_type_device,
331 .size = res->guest_memory_size,
332 .pin = false
333 };
334 int ret;
335
336 if (likely(res->guest_memory_bo)) {
337 BUG_ON(res->guest_memory_bo->tbo.base.size < size);
338 return 0;
339 }
340
341 ret = vmw_gem_object_create(res->dev_priv, &bo_params, &gbo);
342 if (unlikely(ret != 0))
343 goto out_no_bo;
344
345 res->guest_memory_bo = gbo;
346
347out_no_bo:
348 return ret;
349}
350
351/**
352 * vmw_resource_do_validate - Make a resource up-to-date and visible
353 * to the device.
354 *
355 * @res: The resource to make visible to the device.
356 * @val_buf: Information about a buffer possibly
357 * containing backup data if a bind operation is needed.
358 * @dirtying: Transfer dirty regions.
359 *
360 * On hardware resource shortage, this function returns -EBUSY and
361 * should be retried once resources have been freed up.
362 */
363static int vmw_resource_do_validate(struct vmw_resource *res,
364 struct ttm_validate_buffer *val_buf,
365 bool dirtying)
366{
367 int ret = 0;
368 const struct vmw_res_func *func = res->func;
369
370 if (unlikely(res->id == -1)) {
371 ret = func->create(res);
372 if (unlikely(ret != 0))
373 return ret;
374 }
375
376 if (func->bind &&
377 ((func->needs_guest_memory && !vmw_resource_mob_attached(res) &&
378 val_buf->bo) ||
379 (!func->needs_guest_memory && val_buf->bo))) {
380 ret = func->bind(res, val_buf);
381 if (unlikely(ret != 0))
382 goto out_bind_failed;
383 if (func->needs_guest_memory)
384 vmw_resource_mob_attach(res);
385 }
386
387 /*
388 * Handle the case where the backup mob is marked coherent but
389 * the resource isn't.
390 */
391 if (func->dirty_alloc && vmw_resource_mob_attached(res) &&
392 !res->coherent) {
393 if (res->guest_memory_bo->dirty && !res->dirty) {
394 ret = func->dirty_alloc(res);
395 if (ret)
396 return ret;
397 } else if (!res->guest_memory_bo->dirty && res->dirty) {
398 func->dirty_free(res);
399 }
400 }
401
402 /*
403 * Transfer the dirty regions to the resource and update
404 * the resource.
405 */
406 if (res->dirty) {
407 if (dirtying && !res->res_dirty) {
408 pgoff_t start = res->guest_memory_offset >> PAGE_SHIFT;
409 pgoff_t end = __KERNEL_DIV_ROUND_UP
410 (res->guest_memory_offset + res->guest_memory_size,
411 PAGE_SIZE);
412
413 vmw_bo_dirty_unmap(res->guest_memory_bo, start, end);
414 }
415
416 vmw_bo_dirty_transfer_to_res(res);
417 return func->dirty_sync(res);
418 }
419
420 return 0;
421
422out_bind_failed:
423 func->destroy(res);
424
425 return ret;
426}
427
428/**
429 * vmw_resource_unreserve - Unreserve a resource previously reserved for
430 * command submission.
431 *
432 * @res: Pointer to the struct vmw_resource to unreserve.
433 * @dirty_set: Change dirty status of the resource.
434 * @dirty: When changing dirty status indicates the new status.
435 * @switch_guest_memory: Guest memory buffer has been switched.
436 * @new_guest_memory_bo: Pointer to new guest memory buffer if command submission
437 * switched. May be NULL.
438 * @new_guest_memory_offset: New gbo offset if @switch_guest_memory is true.
439 *
440 * Currently unreserving a resource means putting it back on the device's
441 * resource lru list, so that it can be evicted if necessary.
442 */
443void vmw_resource_unreserve(struct vmw_resource *res,
444 bool dirty_set,
445 bool dirty,
446 bool switch_guest_memory,
447 struct vmw_bo *new_guest_memory_bo,
448 unsigned long new_guest_memory_offset)
449{
450 struct vmw_private *dev_priv = res->dev_priv;
451
452 if (!list_empty(&res->lru_head))
453 return;
454
455 if (switch_guest_memory && new_guest_memory_bo != res->guest_memory_bo) {
456 if (res->guest_memory_bo) {
457 vmw_resource_mob_detach(res);
458 if (res->coherent)
459 vmw_bo_dirty_release(res->guest_memory_bo);
460 vmw_user_bo_unref(&res->guest_memory_bo);
461 }
462
463 if (new_guest_memory_bo) {
464 res->guest_memory_bo = vmw_user_bo_ref(new_guest_memory_bo);
465
466 /*
467 * The validation code should already have added a
468 * dirty tracker here.
469 */
470 WARN_ON(res->coherent && !new_guest_memory_bo->dirty);
471
472 vmw_resource_mob_attach(res);
473 } else {
474 res->guest_memory_bo = NULL;
475 }
476 } else if (switch_guest_memory && res->coherent) {
477 vmw_bo_dirty_release(res->guest_memory_bo);
478 }
479
480 if (switch_guest_memory)
481 res->guest_memory_offset = new_guest_memory_offset;
482
483 if (dirty_set)
484 res->res_dirty = dirty;
485
486 if (!res->func->may_evict || res->id == -1 || res->pin_count)
487 return;
488
489 spin_lock(&dev_priv->resource_lock);
490 list_add_tail(&res->lru_head,
491 &res->dev_priv->res_lru[res->func->res_type]);
492 spin_unlock(&dev_priv->resource_lock);
493}
494
495/**
496 * vmw_resource_check_buffer - Check whether a backup buffer is needed
497 * for a resource and in that case, allocate
498 * one, reserve and validate it.
499 *
500 * @ticket: The ww acquire context to use, or NULL if trylocking.
501 * @res: The resource for which to allocate a backup buffer.
502 * @interruptible: Whether any sleeps during allocation should be
503 * performed while interruptible.
504 * @val_buf: On successful return contains data about the
505 * reserved and validated backup buffer.
506 */
507static int
508vmw_resource_check_buffer(struct ww_acquire_ctx *ticket,
509 struct vmw_resource *res,
510 bool interruptible,
511 struct ttm_validate_buffer *val_buf)
512{
513 struct ttm_operation_ctx ctx = { true, false };
514 struct list_head val_list;
515 bool guest_memory_dirty = false;
516 int ret;
517
518 if (unlikely(!res->guest_memory_bo)) {
519 ret = vmw_resource_buf_alloc(res, interruptible);
520 if (unlikely(ret != 0))
521 return ret;
522 }
523
524 INIT_LIST_HEAD(&val_list);
525 ttm_bo_get(&res->guest_memory_bo->tbo);
526 val_buf->bo = &res->guest_memory_bo->tbo;
527 val_buf->num_shared = 0;
528 list_add_tail(&val_buf->head, &val_list);
529 ret = ttm_eu_reserve_buffers(ticket, &val_list, interruptible, NULL);
530 if (unlikely(ret != 0))
531 goto out_no_reserve;
532
533 if (res->func->needs_guest_memory && !vmw_resource_mob_attached(res))
534 return 0;
535
536 guest_memory_dirty = res->guest_memory_dirty;
537 vmw_bo_placement_set(res->guest_memory_bo, res->func->domain,
538 res->func->busy_domain);
539 ret = ttm_bo_validate(&res->guest_memory_bo->tbo,
540 &res->guest_memory_bo->placement,
541 &ctx);
542
543 if (unlikely(ret != 0))
544 goto out_no_validate;
545
546 return 0;
547
548out_no_validate:
549 ttm_eu_backoff_reservation(ticket, &val_list);
550out_no_reserve:
551 ttm_bo_put(val_buf->bo);
552 val_buf->bo = NULL;
553 if (guest_memory_dirty)
554 vmw_user_bo_unref(&res->guest_memory_bo);
555
556 return ret;
557}
558
559/*
560 * vmw_resource_reserve - Reserve a resource for command submission
561 *
562 * @res: The resource to reserve.
563 *
564 * This function takes the resource off the LRU list and make sure
565 * a guest memory buffer is present for guest-backed resources.
566 * However, the buffer may not be bound to the resource at this
567 * point.
568 *
569 */
570int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
571 bool no_guest_memory)
572{
573 struct vmw_private *dev_priv = res->dev_priv;
574 int ret;
575
576 spin_lock(&dev_priv->resource_lock);
577 list_del_init(&res->lru_head);
578 spin_unlock(&dev_priv->resource_lock);
579
580 if (res->func->needs_guest_memory && !res->guest_memory_bo &&
581 !no_guest_memory) {
582 ret = vmw_resource_buf_alloc(res, interruptible);
583 if (unlikely(ret != 0)) {
584 DRM_ERROR("Failed to allocate a guest memory buffer "
585 "of size %lu. bytes\n",
586 (unsigned long) res->guest_memory_size);
587 return ret;
588 }
589 }
590
591 return 0;
592}
593
594/**
595 * vmw_resource_backoff_reservation - Unreserve and unreference a
596 * guest memory buffer
597 *.
598 * @ticket: The ww acquire ctx used for reservation.
599 * @val_buf: Guest memory buffer information.
600 */
601static void
602vmw_resource_backoff_reservation(struct ww_acquire_ctx *ticket,
603 struct ttm_validate_buffer *val_buf)
604{
605 struct list_head val_list;
606
607 if (likely(val_buf->bo == NULL))
608 return;
609
610 INIT_LIST_HEAD(&val_list);
611 list_add_tail(&val_buf->head, &val_list);
612 ttm_eu_backoff_reservation(ticket, &val_list);
613 ttm_bo_put(val_buf->bo);
614 val_buf->bo = NULL;
615}
616
617/**
618 * vmw_resource_do_evict - Evict a resource, and transfer its data
619 * to a backup buffer.
620 *
621 * @ticket: The ww acquire ticket to use, or NULL if trylocking.
622 * @res: The resource to evict.
623 * @interruptible: Whether to wait interruptible.
624 */
625static int vmw_resource_do_evict(struct ww_acquire_ctx *ticket,
626 struct vmw_resource *res, bool interruptible)
627{
628 struct ttm_validate_buffer val_buf;
629 const struct vmw_res_func *func = res->func;
630 int ret;
631
632 BUG_ON(!func->may_evict);
633
634 val_buf.bo = NULL;
635 val_buf.num_shared = 0;
636 ret = vmw_resource_check_buffer(ticket, res, interruptible, &val_buf);
637 if (unlikely(ret != 0))
638 return ret;
639
640 if (unlikely(func->unbind != NULL &&
641 (!func->needs_guest_memory || vmw_resource_mob_attached(res)))) {
642 ret = func->unbind(res, res->res_dirty, &val_buf);
643 if (unlikely(ret != 0))
644 goto out_no_unbind;
645 vmw_resource_mob_detach(res);
646 }
647 ret = func->destroy(res);
648 res->guest_memory_dirty = true;
649 res->res_dirty = false;
650out_no_unbind:
651 vmw_resource_backoff_reservation(ticket, &val_buf);
652
653 return ret;
654}
655
656
657/**
658 * vmw_resource_validate - Make a resource up-to-date and visible
659 * to the device.
660 * @res: The resource to make visible to the device.
661 * @intr: Perform waits interruptible if possible.
662 * @dirtying: Pending GPU operation will dirty the resource
663 *
664 * On successful return, any backup DMA buffer pointed to by @res->backup will
665 * be reserved and validated.
666 * On hardware resource shortage, this function will repeatedly evict
667 * resources of the same type until the validation succeeds.
668 *
669 * Return: Zero on success, -ERESTARTSYS if interrupted, negative error code
670 * on failure.
671 */
672int vmw_resource_validate(struct vmw_resource *res, bool intr,
673 bool dirtying)
674{
675 int ret;
676 struct vmw_resource *evict_res;
677 struct vmw_private *dev_priv = res->dev_priv;
678 struct list_head *lru_list = &dev_priv->res_lru[res->func->res_type];
679 struct ttm_validate_buffer val_buf;
680 unsigned err_count = 0;
681
682 if (!res->func->create)
683 return 0;
684
685 val_buf.bo = NULL;
686 val_buf.num_shared = 0;
687 if (res->guest_memory_bo)
688 val_buf.bo = &res->guest_memory_bo->tbo;
689 do {
690 ret = vmw_resource_do_validate(res, &val_buf, dirtying);
691 if (likely(ret != -EBUSY))
692 break;
693
694 spin_lock(&dev_priv->resource_lock);
695 if (list_empty(lru_list) || !res->func->may_evict) {
696 DRM_ERROR("Out of device device resources "
697 "for %s.\n", res->func->type_name);
698 ret = -EBUSY;
699 spin_unlock(&dev_priv->resource_lock);
700 break;
701 }
702
703 evict_res = vmw_resource_reference
704 (list_first_entry(lru_list, struct vmw_resource,
705 lru_head));
706 list_del_init(&evict_res->lru_head);
707
708 spin_unlock(&dev_priv->resource_lock);
709
710 /* Trylock backup buffers with a NULL ticket. */
711 ret = vmw_resource_do_evict(NULL, evict_res, intr);
712 if (unlikely(ret != 0)) {
713 spin_lock(&dev_priv->resource_lock);
714 list_add_tail(&evict_res->lru_head, lru_list);
715 spin_unlock(&dev_priv->resource_lock);
716 if (ret == -ERESTARTSYS ||
717 ++err_count > VMW_RES_EVICT_ERR_COUNT) {
718 vmw_resource_unreference(&evict_res);
719 goto out_no_validate;
720 }
721 }
722
723 vmw_resource_unreference(&evict_res);
724 } while (1);
725
726 if (unlikely(ret != 0))
727 goto out_no_validate;
728 else if (!res->func->needs_guest_memory && res->guest_memory_bo) {
729 WARN_ON_ONCE(vmw_resource_mob_attached(res));
730 vmw_user_bo_unref(&res->guest_memory_bo);
731 }
732
733 return 0;
734
735out_no_validate:
736 return ret;
737}
738
739
740/**
741 * vmw_resource_unbind_list
742 *
743 * @vbo: Pointer to the current backing MOB.
744 *
745 * Evicts the Guest Backed hardware resource if the backup
746 * buffer is being moved out of MOB memory.
747 * Note that this function will not race with the resource
748 * validation code, since resource validation and eviction
749 * both require the backup buffer to be reserved.
750 */
751void vmw_resource_unbind_list(struct vmw_bo *vbo)
752{
753 struct ttm_validate_buffer val_buf = {
754 .bo = &vbo->tbo,
755 .num_shared = 0
756 };
757
758 dma_resv_assert_held(vbo->tbo.base.resv);
759 while (!RB_EMPTY_ROOT(&vbo->res_tree)) {
760 struct rb_node *node = vbo->res_tree.rb_node;
761 struct vmw_resource *res =
762 container_of(node, struct vmw_resource, mob_node);
763
764 if (!WARN_ON_ONCE(!res->func->unbind))
765 (void) res->func->unbind(res, res->res_dirty, &val_buf);
766
767 res->guest_memory_size = true;
768 res->res_dirty = false;
769 vmw_resource_mob_detach(res);
770 }
771
772 (void) ttm_bo_wait(&vbo->tbo, false, false);
773}
774
775
776/**
777 * vmw_query_readback_all - Read back cached query states
778 *
779 * @dx_query_mob: Buffer containing the DX query MOB
780 *
781 * Read back cached states from the device if they exist. This function
782 * assumes binding_mutex is held.
783 */
784int vmw_query_readback_all(struct vmw_bo *dx_query_mob)
785{
786 struct vmw_resource *dx_query_ctx;
787 struct vmw_private *dev_priv;
788 struct {
789 SVGA3dCmdHeader header;
790 SVGA3dCmdDXReadbackAllQuery body;
791 } *cmd;
792
793
794 /* No query bound, so do nothing */
795 if (!dx_query_mob || !dx_query_mob->dx_query_ctx)
796 return 0;
797
798 dx_query_ctx = dx_query_mob->dx_query_ctx;
799 dev_priv = dx_query_ctx->dev_priv;
800
801 cmd = VMW_CMD_CTX_RESERVE(dev_priv, sizeof(*cmd), dx_query_ctx->id);
802 if (unlikely(cmd == NULL))
803 return -ENOMEM;
804
805 cmd->header.id = SVGA_3D_CMD_DX_READBACK_ALL_QUERY;
806 cmd->header.size = sizeof(cmd->body);
807 cmd->body.cid = dx_query_ctx->id;
808
809 vmw_cmd_commit(dev_priv, sizeof(*cmd));
810
811 /* Triggers a rebind the next time affected context is bound */
812 dx_query_mob->dx_query_ctx = NULL;
813
814 return 0;
815}
816
817
818
819/**
820 * vmw_query_move_notify - Read back cached query states
821 *
822 * @bo: The TTM buffer object about to move.
823 * @old_mem: The memory region @bo is moving from.
824 * @new_mem: The memory region @bo is moving to.
825 *
826 * Called before the query MOB is swapped out to read back cached query
827 * states from the device.
828 */
829void vmw_query_move_notify(struct ttm_buffer_object *bo,
830 struct ttm_resource *old_mem,
831 struct ttm_resource *new_mem)
832{
833 struct vmw_bo *dx_query_mob;
834 struct ttm_device *bdev = bo->bdev;
835 struct vmw_private *dev_priv = vmw_priv_from_ttm(bdev);
836
837 mutex_lock(&dev_priv->binding_mutex);
838
839 /* If BO is being moved from MOB to system memory */
840 if (old_mem &&
841 new_mem->mem_type == TTM_PL_SYSTEM &&
842 old_mem->mem_type == VMW_PL_MOB) {
843 struct vmw_fence_obj *fence;
844
845 dx_query_mob = to_vmw_bo(&bo->base);
846 if (!dx_query_mob || !dx_query_mob->dx_query_ctx) {
847 mutex_unlock(&dev_priv->binding_mutex);
848 return;
849 }
850
851 (void) vmw_query_readback_all(dx_query_mob);
852 mutex_unlock(&dev_priv->binding_mutex);
853
854 /* Create a fence and attach the BO to it */
855 (void) vmw_execbuf_fence_commands(NULL, dev_priv, &fence, NULL);
856 vmw_bo_fence_single(bo, fence);
857
858 if (fence != NULL)
859 vmw_fence_obj_unreference(&fence);
860
861 (void) ttm_bo_wait(bo, false, false);
862 } else
863 mutex_unlock(&dev_priv->binding_mutex);
864}
865
866/**
867 * vmw_resource_needs_backup - Return whether a resource needs a backup buffer.
868 *
869 * @res: The resource being queried.
870 */
871bool vmw_resource_needs_backup(const struct vmw_resource *res)
872{
873 return res->func->needs_guest_memory;
874}
875
876/**
877 * vmw_resource_evict_type - Evict all resources of a specific type
878 *
879 * @dev_priv: Pointer to a device private struct
880 * @type: The resource type to evict
881 *
882 * To avoid thrashing starvation or as part of the hibernation sequence,
883 * try to evict all evictable resources of a specific type.
884 */
885static void vmw_resource_evict_type(struct vmw_private *dev_priv,
886 enum vmw_res_type type)
887{
888 struct list_head *lru_list = &dev_priv->res_lru[type];
889 struct vmw_resource *evict_res;
890 unsigned err_count = 0;
891 int ret;
892 struct ww_acquire_ctx ticket;
893
894 do {
895 spin_lock(&dev_priv->resource_lock);
896
897 if (list_empty(lru_list))
898 goto out_unlock;
899
900 evict_res = vmw_resource_reference(
901 list_first_entry(lru_list, struct vmw_resource,
902 lru_head));
903 list_del_init(&evict_res->lru_head);
904 spin_unlock(&dev_priv->resource_lock);
905
906 /* Wait lock backup buffers with a ticket. */
907 ret = vmw_resource_do_evict(&ticket, evict_res, false);
908 if (unlikely(ret != 0)) {
909 spin_lock(&dev_priv->resource_lock);
910 list_add_tail(&evict_res->lru_head, lru_list);
911 spin_unlock(&dev_priv->resource_lock);
912 if (++err_count > VMW_RES_EVICT_ERR_COUNT) {
913 vmw_resource_unreference(&evict_res);
914 return;
915 }
916 }
917
918 vmw_resource_unreference(&evict_res);
919 } while (1);
920
921out_unlock:
922 spin_unlock(&dev_priv->resource_lock);
923}
924
925/**
926 * vmw_resource_evict_all - Evict all evictable resources
927 *
928 * @dev_priv: Pointer to a device private struct
929 *
930 * To avoid thrashing starvation or as part of the hibernation sequence,
931 * evict all evictable resources. In particular this means that all
932 * guest-backed resources that are registered with the device are
933 * evicted and the OTable becomes clean.
934 */
935void vmw_resource_evict_all(struct vmw_private *dev_priv)
936{
937 enum vmw_res_type type;
938
939 mutex_lock(&dev_priv->cmdbuf_mutex);
940
941 for (type = 0; type < vmw_res_max; ++type)
942 vmw_resource_evict_type(dev_priv, type);
943
944 mutex_unlock(&dev_priv->cmdbuf_mutex);
945}
946
947/*
948 * vmw_resource_pin - Add a pin reference on a resource
949 *
950 * @res: The resource to add a pin reference on
951 *
952 * This function adds a pin reference, and if needed validates the resource.
953 * Having a pin reference means that the resource can never be evicted, and
954 * its id will never change as long as there is a pin reference.
955 * This function returns 0 on success and a negative error code on failure.
956 */
957int vmw_resource_pin(struct vmw_resource *res, bool interruptible)
958{
959 struct ttm_operation_ctx ctx = { interruptible, false };
960 struct vmw_private *dev_priv = res->dev_priv;
961 int ret;
962
963 mutex_lock(&dev_priv->cmdbuf_mutex);
964 ret = vmw_resource_reserve(res, interruptible, false);
965 if (ret)
966 goto out_no_reserve;
967
968 if (res->pin_count == 0) {
969 struct vmw_bo *vbo = NULL;
970
971 if (res->guest_memory_bo) {
972 vbo = res->guest_memory_bo;
973
974 ret = ttm_bo_reserve(&vbo->tbo, interruptible, false, NULL);
975 if (ret)
976 goto out_no_validate;
977 if (!vbo->tbo.pin_count) {
978 vmw_bo_placement_set(vbo,
979 res->func->domain,
980 res->func->busy_domain);
981 ret = ttm_bo_validate
982 (&vbo->tbo,
983 &vbo->placement,
984 &ctx);
985 if (ret) {
986 ttm_bo_unreserve(&vbo->tbo);
987 goto out_no_validate;
988 }
989 }
990
991 /* Do we really need to pin the MOB as well? */
992 vmw_bo_pin_reserved(vbo, true);
993 }
994 ret = vmw_resource_validate(res, interruptible, true);
995 if (vbo)
996 ttm_bo_unreserve(&vbo->tbo);
997 if (ret)
998 goto out_no_validate;
999 }
1000 res->pin_count++;
1001
1002out_no_validate:
1003 vmw_resource_unreserve(res, false, false, false, NULL, 0UL);
1004out_no_reserve:
1005 mutex_unlock(&dev_priv->cmdbuf_mutex);
1006
1007 return ret;
1008}
1009
1010/**
1011 * vmw_resource_unpin - Remove a pin reference from a resource
1012 *
1013 * @res: The resource to remove a pin reference from
1014 *
1015 * Having a pin reference means that the resource can never be evicted, and
1016 * its id will never change as long as there is a pin reference.
1017 */
1018void vmw_resource_unpin(struct vmw_resource *res)
1019{
1020 struct vmw_private *dev_priv = res->dev_priv;
1021 int ret;
1022
1023 mutex_lock(&dev_priv->cmdbuf_mutex);
1024
1025 ret = vmw_resource_reserve(res, false, true);
1026 WARN_ON(ret);
1027
1028 WARN_ON(res->pin_count == 0);
1029 if (--res->pin_count == 0 && res->guest_memory_bo) {
1030 struct vmw_bo *vbo = res->guest_memory_bo;
1031
1032 (void) ttm_bo_reserve(&vbo->tbo, false, false, NULL);
1033 vmw_bo_pin_reserved(vbo, false);
1034 ttm_bo_unreserve(&vbo->tbo);
1035 }
1036
1037 vmw_resource_unreserve(res, false, false, false, NULL, 0UL);
1038
1039 mutex_unlock(&dev_priv->cmdbuf_mutex);
1040}
1041
1042/**
1043 * vmw_res_type - Return the resource type
1044 *
1045 * @res: Pointer to the resource
1046 */
1047enum vmw_res_type vmw_res_type(const struct vmw_resource *res)
1048{
1049 return res->func->res_type;
1050}
1051
1052/**
1053 * vmw_resource_dirty_update - Update a resource's dirty tracker with a
1054 * sequential range of touched backing store memory.
1055 * @res: The resource.
1056 * @start: The first page touched.
1057 * @end: The last page touched + 1.
1058 */
1059void vmw_resource_dirty_update(struct vmw_resource *res, pgoff_t start,
1060 pgoff_t end)
1061{
1062 if (res->dirty)
1063 res->func->dirty_range_add(res, start << PAGE_SHIFT,
1064 end << PAGE_SHIFT);
1065}
1066
1067/**
1068 * vmw_resources_clean - Clean resources intersecting a mob range
1069 * @vbo: The mob buffer object
1070 * @start: The mob page offset starting the range
1071 * @end: The mob page offset ending the range
1072 * @num_prefault: Returns how many pages including the first have been
1073 * cleaned and are ok to prefault
1074 */
1075int vmw_resources_clean(struct vmw_bo *vbo, pgoff_t start,
1076 pgoff_t end, pgoff_t *num_prefault)
1077{
1078 struct rb_node *cur = vbo->res_tree.rb_node;
1079 struct vmw_resource *found = NULL;
1080 unsigned long res_start = start << PAGE_SHIFT;
1081 unsigned long res_end = end << PAGE_SHIFT;
1082 unsigned long last_cleaned = 0;
1083
1084 /*
1085 * Find the resource with lowest backup_offset that intersects the
1086 * range.
1087 */
1088 while (cur) {
1089 struct vmw_resource *cur_res =
1090 container_of(cur, struct vmw_resource, mob_node);
1091
1092 if (cur_res->guest_memory_offset >= res_end) {
1093 cur = cur->rb_left;
1094 } else if (cur_res->guest_memory_offset + cur_res->guest_memory_size <=
1095 res_start) {
1096 cur = cur->rb_right;
1097 } else {
1098 found = cur_res;
1099 cur = cur->rb_left;
1100 /* Continue to look for resources with lower offsets */
1101 }
1102 }
1103
1104 /*
1105 * In order of increasing guest_memory_offset, clean dirty resources
1106 * intersecting the range.
1107 */
1108 while (found) {
1109 if (found->res_dirty) {
1110 int ret;
1111
1112 if (!found->func->clean)
1113 return -EINVAL;
1114
1115 ret = found->func->clean(found);
1116 if (ret)
1117 return ret;
1118
1119 found->res_dirty = false;
1120 }
1121 last_cleaned = found->guest_memory_offset + found->guest_memory_size;
1122 cur = rb_next(&found->mob_node);
1123 if (!cur)
1124 break;
1125
1126 found = container_of(cur, struct vmw_resource, mob_node);
1127 if (found->guest_memory_offset >= res_end)
1128 break;
1129 }
1130
1131 /*
1132 * Set number of pages allowed prefaulting and fence the buffer object
1133 */
1134 *num_prefault = 1;
1135 if (last_cleaned > res_start) {
1136 struct ttm_buffer_object *bo = &vbo->tbo;
1137
1138 *num_prefault = __KERNEL_DIV_ROUND_UP(last_cleaned - res_start,
1139 PAGE_SIZE);
1140 vmw_bo_fence_single(bo, NULL);
1141 }
1142
1143 return 0;
1144}