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