Linux-libre 5.3.12-gnu
[librecmc/linux-libre.git] / drivers / gpu / drm / i915 / i915_vgpu.c
1 /*
2  * Copyright(c) 2011-2015 Intel Corporation. All rights reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  */
23
24 #include "intel_drv.h"
25 #include "i915_vgpu.h"
26
27 /**
28  * DOC: Intel GVT-g guest support
29  *
30  * Intel GVT-g is a graphics virtualization technology which shares the
31  * GPU among multiple virtual machines on a time-sharing basis. Each
32  * virtual machine is presented a virtual GPU (vGPU), which has equivalent
33  * features as the underlying physical GPU (pGPU), so i915 driver can run
34  * seamlessly in a virtual machine. This file provides vGPU specific
35  * optimizations when running in a virtual machine, to reduce the complexity
36  * of vGPU emulation and to improve the overall performance.
37  *
38  * A primary function introduced here is so-called "address space ballooning"
39  * technique. Intel GVT-g partitions global graphics memory among multiple VMs,
40  * so each VM can directly access a portion of the memory without hypervisor's
41  * intervention, e.g. filling textures or queuing commands. However with the
42  * partitioning an unmodified i915 driver would assume a smaller graphics
43  * memory starting from address ZERO, then requires vGPU emulation module to
44  * translate the graphics address between 'guest view' and 'host view', for
45  * all registers and command opcodes which contain a graphics memory address.
46  * To reduce the complexity, Intel GVT-g introduces "address space ballooning",
47  * by telling the exact partitioning knowledge to each guest i915 driver, which
48  * then reserves and prevents non-allocated portions from allocation. Thus vGPU
49  * emulation module only needs to scan and validate graphics addresses without
50  * complexity of address translation.
51  *
52  */
53
54 /**
55  * i915_check_vgpu - detect virtual GPU
56  * @dev_priv: i915 device private
57  *
58  * This function is called at the initialization stage, to detect whether
59  * running on a vGPU.
60  */
61 void i915_check_vgpu(struct drm_i915_private *dev_priv)
62 {
63         struct intel_uncore *uncore = &dev_priv->uncore;
64         u64 magic;
65         u16 version_major;
66
67         BUILD_BUG_ON(sizeof(struct vgt_if) != VGT_PVINFO_SIZE);
68
69         magic = __raw_uncore_read64(uncore, vgtif_reg(magic));
70         if (magic != VGT_MAGIC)
71                 return;
72
73         version_major = __raw_uncore_read16(uncore, vgtif_reg(version_major));
74         if (version_major < VGT_VERSION_MAJOR) {
75                 DRM_INFO("VGT interface version mismatch!\n");
76                 return;
77         }
78
79         dev_priv->vgpu.caps = __raw_uncore_read32(uncore, vgtif_reg(vgt_caps));
80
81         dev_priv->vgpu.active = true;
82         mutex_init(&dev_priv->vgpu.lock);
83         DRM_INFO("Virtual GPU for Intel GVT-g detected.\n");
84 }
85
86 bool intel_vgpu_has_full_ppgtt(struct drm_i915_private *dev_priv)
87 {
88         return dev_priv->vgpu.caps & VGT_CAPS_FULL_PPGTT;
89 }
90
91 struct _balloon_info_ {
92         /*
93          * There are up to 2 regions per mappable/unmappable graphic
94          * memory that might be ballooned. Here, index 0/1 is for mappable
95          * graphic memory, 2/3 for unmappable graphic memory.
96          */
97         struct drm_mm_node space[4];
98 };
99
100 static struct _balloon_info_ bl_info;
101
102 static void vgt_deballoon_space(struct i915_ggtt *ggtt,
103                                 struct drm_mm_node *node)
104 {
105         if (!drm_mm_node_allocated(node))
106                 return;
107
108         DRM_DEBUG_DRIVER("deballoon space: range [0x%llx - 0x%llx] %llu KiB.\n",
109                          node->start,
110                          node->start + node->size,
111                          node->size / 1024);
112
113         ggtt->vm.reserved -= node->size;
114         drm_mm_remove_node(node);
115 }
116
117 /**
118  * intel_vgt_deballoon - deballoon reserved graphics address trunks
119  * @dev_priv: i915 device private data
120  *
121  * This function is called to deallocate the ballooned-out graphic memory, when
122  * driver is unloaded or when ballooning fails.
123  */
124 void intel_vgt_deballoon(struct drm_i915_private *dev_priv)
125 {
126         int i;
127
128         if (!intel_vgpu_active(dev_priv))
129                 return;
130
131         DRM_DEBUG("VGT deballoon.\n");
132
133         for (i = 0; i < 4; i++)
134                 vgt_deballoon_space(&dev_priv->ggtt, &bl_info.space[i]);
135 }
136
137 static int vgt_balloon_space(struct i915_ggtt *ggtt,
138                              struct drm_mm_node *node,
139                              unsigned long start, unsigned long end)
140 {
141         unsigned long size = end - start;
142         int ret;
143
144         if (start >= end)
145                 return -EINVAL;
146
147         DRM_INFO("balloon space: range [ 0x%lx - 0x%lx ] %lu KiB.\n",
148                  start, end, size / 1024);
149         ret = i915_gem_gtt_reserve(&ggtt->vm, node,
150                                    size, start, I915_COLOR_UNEVICTABLE,
151                                    0);
152         if (!ret)
153                 ggtt->vm.reserved += size;
154
155         return ret;
156 }
157
158 /**
159  * intel_vgt_balloon - balloon out reserved graphics address trunks
160  * @dev_priv: i915 device private data
161  *
162  * This function is called at the initialization stage, to balloon out the
163  * graphic address space allocated to other vGPUs, by marking these spaces as
164  * reserved. The ballooning related knowledge(starting address and size of
165  * the mappable/unmappable graphic memory) is described in the vgt_if structure
166  * in a reserved mmio range.
167  *
168  * To give an example, the drawing below depicts one typical scenario after
169  * ballooning. Here the vGPU1 has 2 pieces of graphic address spaces ballooned
170  * out each for the mappable and the non-mappable part. From the vGPU1 point of
171  * view, the total size is the same as the physical one, with the start address
172  * of its graphic space being zero. Yet there are some portions ballooned out(
173  * the shadow part, which are marked as reserved by drm allocator). From the
174  * host point of view, the graphic address space is partitioned by multiple
175  * vGPUs in different VMs. ::
176  *
177  *                         vGPU1 view         Host view
178  *              0 ------> +-----------+     +-----------+
179  *                ^       |###########|     |   vGPU3   |
180  *                |       |###########|     +-----------+
181  *                |       |###########|     |   vGPU2   |
182  *                |       +-----------+     +-----------+
183  *         mappable GM    | available | ==> |   vGPU1   |
184  *                |       +-----------+     +-----------+
185  *                |       |###########|     |           |
186  *                v       |###########|     |   Host    |
187  *                +=======+===========+     +===========+
188  *                ^       |###########|     |   vGPU3   |
189  *                |       |###########|     +-----------+
190  *                |       |###########|     |   vGPU2   |
191  *                |       +-----------+     +-----------+
192  *       unmappable GM    | available | ==> |   vGPU1   |
193  *                |       +-----------+     +-----------+
194  *                |       |###########|     |           |
195  *                |       |###########|     |   Host    |
196  *                v       |###########|     |           |
197  *  total GM size ------> +-----------+     +-----------+
198  *
199  * Returns:
200  * zero on success, non-zero if configuration invalid or ballooning failed
201  */
202 int intel_vgt_balloon(struct drm_i915_private *dev_priv)
203 {
204         struct i915_ggtt *ggtt = &dev_priv->ggtt;
205         unsigned long ggtt_end = ggtt->vm.total;
206
207         unsigned long mappable_base, mappable_size, mappable_end;
208         unsigned long unmappable_base, unmappable_size, unmappable_end;
209         int ret;
210
211         if (!intel_vgpu_active(dev_priv))
212                 return 0;
213
214         mappable_base = I915_READ(vgtif_reg(avail_rs.mappable_gmadr.base));
215         mappable_size = I915_READ(vgtif_reg(avail_rs.mappable_gmadr.size));
216         unmappable_base = I915_READ(vgtif_reg(avail_rs.nonmappable_gmadr.base));
217         unmappable_size = I915_READ(vgtif_reg(avail_rs.nonmappable_gmadr.size));
218
219         mappable_end = mappable_base + mappable_size;
220         unmappable_end = unmappable_base + unmappable_size;
221
222         DRM_INFO("VGT ballooning configuration:\n");
223         DRM_INFO("Mappable graphic memory: base 0x%lx size %ldKiB\n",
224                  mappable_base, mappable_size / 1024);
225         DRM_INFO("Unmappable graphic memory: base 0x%lx size %ldKiB\n",
226                  unmappable_base, unmappable_size / 1024);
227
228         if (mappable_end > ggtt->mappable_end ||
229             unmappable_base < ggtt->mappable_end ||
230             unmappable_end > ggtt_end) {
231                 DRM_ERROR("Invalid ballooning configuration!\n");
232                 return -EINVAL;
233         }
234
235         /* Unmappable graphic memory ballooning */
236         if (unmappable_base > ggtt->mappable_end) {
237                 ret = vgt_balloon_space(ggtt, &bl_info.space[2],
238                                         ggtt->mappable_end, unmappable_base);
239
240                 if (ret)
241                         goto err;
242         }
243
244         if (unmappable_end < ggtt_end) {
245                 ret = vgt_balloon_space(ggtt, &bl_info.space[3],
246                                         unmappable_end, ggtt_end);
247                 if (ret)
248                         goto err_upon_mappable;
249         }
250
251         /* Mappable graphic memory ballooning */
252         if (mappable_base) {
253                 ret = vgt_balloon_space(ggtt, &bl_info.space[0],
254                                         0, mappable_base);
255
256                 if (ret)
257                         goto err_upon_unmappable;
258         }
259
260         if (mappable_end < ggtt->mappable_end) {
261                 ret = vgt_balloon_space(ggtt, &bl_info.space[1],
262                                         mappable_end, ggtt->mappable_end);
263
264                 if (ret)
265                         goto err_below_mappable;
266         }
267
268         DRM_INFO("VGT balloon successfully\n");
269         return 0;
270
271 err_below_mappable:
272         vgt_deballoon_space(ggtt, &bl_info.space[0]);
273 err_upon_unmappable:
274         vgt_deballoon_space(ggtt, &bl_info.space[3]);
275 err_upon_mappable:
276         vgt_deballoon_space(ggtt, &bl_info.space[2]);
277 err:
278         DRM_ERROR("VGT balloon fail\n");
279         return ret;
280 }