1 /*
2  * Copyright 2017 Red Hat Inc.
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 shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  */
22 #include "uvmm.h"
23 #include "umem.h"
24 #include "ummu.h"
25 
26 #include <core/client.h>
27 #include <core/memory.h>
28 
29 #include <nvif/if000c.h>
30 #include <nvif/unpack.h>
31 
32 static const struct nvkm_object_func nvkm_uvmm;
33 struct nvkm_vmm *
34 nvkm_uvmm_search(struct nvkm_client *client, u64 handle)
35 {
36 	struct nvkm_object *object;
37 
38 	object = nvkm_object_search(client, handle, &nvkm_uvmm);
39 	if (IS_ERR(object))
40 		return (void *)object;
41 
42 	return nvkm_uvmm(object)->vmm;
43 }
44 
45 static int
46 nvkm_uvmm_mthd_unmap(struct nvkm_uvmm *uvmm, void *argv, u32 argc)
47 {
48 	struct nvkm_client *client = uvmm->object.client;
49 	union {
50 		struct nvif_vmm_unmap_v0 v0;
51 	} *args = argv;
52 	struct nvkm_vmm *vmm = uvmm->vmm;
53 	struct nvkm_vma *vma;
54 	int ret = -ENOSYS;
55 	u64 addr;
56 
57 	if (!(ret = nvif_unpack(ret, &argv, &argc, args->v0, 0, 0, false))) {
58 		addr = args->v0.addr;
59 	} else
60 		return ret;
61 
62 	mutex_lock(&vmm->mutex);
63 	vma = nvkm_vmm_node_search(vmm, addr);
64 	if (ret = -ENOENT, !vma || vma->addr != addr) {
65 		VMM_DEBUG(vmm, "lookup %016llx: %016llx",
66 			  addr, vma ? vma->addr : ~0ULL);
67 		goto done;
68 	}
69 
70 	if (ret = -ENOENT, (!vma->user && !client->super) || vma->busy) {
71 		VMM_DEBUG(vmm, "denied %016llx: %d %d %d", addr,
72 			  vma->user, !client->super, vma->busy);
73 		goto done;
74 	}
75 
76 	if (ret = -EINVAL, !vma->memory) {
77 		VMM_DEBUG(vmm, "unmapped");
78 		goto done;
79 	}
80 
81 	nvkm_vmm_unmap_locked(vmm, vma);
82 	ret = 0;
83 done:
84 	mutex_unlock(&vmm->mutex);
85 	return ret;
86 }
87 
88 static int
89 nvkm_uvmm_mthd_map(struct nvkm_uvmm *uvmm, void *argv, u32 argc)
90 {
91 	struct nvkm_client *client = uvmm->object.client;
92 	union {
93 		struct nvif_vmm_map_v0 v0;
94 	} *args = argv;
95 	u64 addr, size, handle, offset;
96 	struct nvkm_vmm *vmm = uvmm->vmm;
97 	struct nvkm_vma *vma;
98 	struct nvkm_memory *memory;
99 	int ret = -ENOSYS;
100 
101 	if (!(ret = nvif_unpack(ret, &argv, &argc, args->v0, 0, 0, true))) {
102 		addr = args->v0.addr;
103 		size = args->v0.size;
104 		handle = args->v0.memory;
105 		offset = args->v0.offset;
106 	} else
107 		return ret;
108 
109 	if (IS_ERR((memory = nvkm_umem_search(client, handle)))) {
110 		VMM_DEBUG(vmm, "memory %016llx %ld\n", handle, PTR_ERR(memory));
111 		return PTR_ERR(memory);
112 	}
113 
114 	mutex_lock(&vmm->mutex);
115 	if (ret = -ENOENT, !(vma = nvkm_vmm_node_search(vmm, addr))) {
116 		VMM_DEBUG(vmm, "lookup %016llx", addr);
117 		goto fail;
118 	}
119 
120 	if (ret = -ENOENT, (!vma->user && !client->super) || vma->busy) {
121 		VMM_DEBUG(vmm, "denied %016llx: %d %d %d", addr,
122 			  vma->user, !client->super, vma->busy);
123 		goto fail;
124 	}
125 
126 	if (ret = -EINVAL, vma->addr != addr || vma->size != size) {
127 		if (addr + size > vma->addr + vma->size || vma->memory ||
128 		    (vma->refd == NVKM_VMA_PAGE_NONE && !vma->mapref)) {
129 			VMM_DEBUG(vmm, "split %d %d %d "
130 				       "%016llx %016llx %016llx %016llx",
131 				  !!vma->memory, vma->refd, vma->mapref,
132 				  addr, size, vma->addr, (u64)vma->size);
133 			goto fail;
134 		}
135 
136 		if (vma->addr != addr) {
137 			const u64 tail = vma->size + vma->addr - addr;
138 			if (ret = -ENOMEM, !(vma = nvkm_vma_tail(vma, tail)))
139 				goto fail;
140 			vma->part = true;
141 			nvkm_vmm_node_insert(vmm, vma);
142 		}
143 
144 		if (vma->size != size) {
145 			const u64 tail = vma->size - size;
146 			struct nvkm_vma *tmp;
147 			if (ret = -ENOMEM, !(tmp = nvkm_vma_tail(vma, tail))) {
148 				nvkm_vmm_unmap_region(vmm, vma);
149 				goto fail;
150 			}
151 			tmp->part = true;
152 			nvkm_vmm_node_insert(vmm, tmp);
153 		}
154 	}
155 	vma->busy = true;
156 	mutex_unlock(&vmm->mutex);
157 
158 	ret = nvkm_memory_map(memory, offset, vmm, vma, argv, argc);
159 	if (ret == 0) {
160 		/* Successful map will clear vma->busy. */
161 		nvkm_memory_unref(&memory);
162 		return 0;
163 	}
164 
165 	mutex_lock(&vmm->mutex);
166 	vma->busy = false;
167 	nvkm_vmm_unmap_region(vmm, vma);
168 fail:
169 	mutex_unlock(&vmm->mutex);
170 	nvkm_memory_unref(&memory);
171 	return ret;
172 }
173 
174 static int
175 nvkm_uvmm_mthd_put(struct nvkm_uvmm *uvmm, void *argv, u32 argc)
176 {
177 	struct nvkm_client *client = uvmm->object.client;
178 	union {
179 		struct nvif_vmm_put_v0 v0;
180 	} *args = argv;
181 	struct nvkm_vmm *vmm = uvmm->vmm;
182 	struct nvkm_vma *vma;
183 	int ret = -ENOSYS;
184 	u64 addr;
185 
186 	if (!(ret = nvif_unpack(ret, &argv, &argc, args->v0, 0, 0, false))) {
187 		addr = args->v0.addr;
188 	} else
189 		return ret;
190 
191 	mutex_lock(&vmm->mutex);
192 	vma = nvkm_vmm_node_search(vmm, args->v0.addr);
193 	if (ret = -ENOENT, !vma || vma->addr != addr || vma->part) {
194 		VMM_DEBUG(vmm, "lookup %016llx: %016llx %d", addr,
195 			  vma ? vma->addr : ~0ULL, vma ? vma->part : 0);
196 		goto done;
197 	}
198 
199 	if (ret = -ENOENT, (!vma->user && !client->super) || vma->busy) {
200 		VMM_DEBUG(vmm, "denied %016llx: %d %d %d", addr,
201 			  vma->user, !client->super, vma->busy);
202 		goto done;
203 	}
204 
205 	nvkm_vmm_put_locked(vmm, vma);
206 	ret = 0;
207 done:
208 	mutex_unlock(&vmm->mutex);
209 	return ret;
210 }
211 
212 static int
213 nvkm_uvmm_mthd_get(struct nvkm_uvmm *uvmm, void *argv, u32 argc)
214 {
215 	struct nvkm_client *client = uvmm->object.client;
216 	union {
217 		struct nvif_vmm_get_v0 v0;
218 	} *args = argv;
219 	struct nvkm_vmm *vmm = uvmm->vmm;
220 	struct nvkm_vma *vma;
221 	int ret = -ENOSYS;
222 	bool getref, mapref, sparse;
223 	u8 page, align;
224 	u64 size;
225 
226 	if (!(ret = nvif_unpack(ret, &argv, &argc, args->v0, 0, 0, false))) {
227 		getref = args->v0.type == NVIF_VMM_GET_V0_PTES;
228 		mapref = args->v0.type == NVIF_VMM_GET_V0_ADDR;
229 		sparse = args->v0.sparse;
230 		page = args->v0.page;
231 		align = args->v0.align;
232 		size = args->v0.size;
233 	} else
234 		return ret;
235 
236 	mutex_lock(&vmm->mutex);
237 	ret = nvkm_vmm_get_locked(vmm, getref, mapref, sparse,
238 				  page, align, size, &vma);
239 	mutex_unlock(&vmm->mutex);
240 	if (ret)
241 		return ret;
242 
243 	args->v0.addr = vma->addr;
244 	vma->user = !client->super;
245 	return ret;
246 }
247 
248 static int
249 nvkm_uvmm_mthd_page(struct nvkm_uvmm *uvmm, void *argv, u32 argc)
250 {
251 	union {
252 		struct nvif_vmm_page_v0 v0;
253 	} *args = argv;
254 	const struct nvkm_vmm_page *page;
255 	int ret = -ENOSYS;
256 	u8 type, index, nr;
257 
258 	page = uvmm->vmm->func->page;
259 	for (nr = 0; page[nr].shift; nr++);
260 
261 	if (!(ret = nvif_unpack(ret, &argv, &argc, args->v0, 0, 0, false))) {
262 		if ((index = args->v0.index) >= nr)
263 			return -EINVAL;
264 		type = page[index].type;
265 		args->v0.shift = page[index].shift;
266 		args->v0.sparse = !!(type & NVKM_VMM_PAGE_SPARSE);
267 		args->v0.vram = !!(type & NVKM_VMM_PAGE_VRAM);
268 		args->v0.host = !!(type & NVKM_VMM_PAGE_HOST);
269 		args->v0.comp = !!(type & NVKM_VMM_PAGE_COMP);
270 	} else
271 		return -ENOSYS;
272 
273 	return 0;
274 }
275 
276 static int
277 nvkm_uvmm_mthd(struct nvkm_object *object, u32 mthd, void *argv, u32 argc)
278 {
279 	struct nvkm_uvmm *uvmm = nvkm_uvmm(object);
280 	switch (mthd) {
281 	case NVIF_VMM_V0_PAGE  : return nvkm_uvmm_mthd_page  (uvmm, argv, argc);
282 	case NVIF_VMM_V0_GET   : return nvkm_uvmm_mthd_get   (uvmm, argv, argc);
283 	case NVIF_VMM_V0_PUT   : return nvkm_uvmm_mthd_put   (uvmm, argv, argc);
284 	case NVIF_VMM_V0_MAP   : return nvkm_uvmm_mthd_map   (uvmm, argv, argc);
285 	case NVIF_VMM_V0_UNMAP : return nvkm_uvmm_mthd_unmap (uvmm, argv, argc);
286 	default:
287 		break;
288 	}
289 	return -EINVAL;
290 }
291 
292 static void *
293 nvkm_uvmm_dtor(struct nvkm_object *object)
294 {
295 	struct nvkm_uvmm *uvmm = nvkm_uvmm(object);
296 	nvkm_vmm_unref(&uvmm->vmm);
297 	return uvmm;
298 }
299 
300 static const struct nvkm_object_func
301 nvkm_uvmm = {
302 	.dtor = nvkm_uvmm_dtor,
303 	.mthd = nvkm_uvmm_mthd,
304 };
305 
306 int
307 nvkm_uvmm_new(const struct nvkm_oclass *oclass, void *argv, u32 argc,
308 	      struct nvkm_object **pobject)
309 {
310 	struct nvkm_mmu *mmu = nvkm_ummu(oclass->parent)->mmu;
311 	const bool more = oclass->base.maxver >= 0;
312 	union {
313 		struct nvif_vmm_v0 v0;
314 	} *args = argv;
315 	const struct nvkm_vmm_page *page;
316 	struct nvkm_uvmm *uvmm;
317 	int ret = -ENOSYS;
318 	u64 addr, size;
319 
320 	if (!(ret = nvif_unpack(ret, &argv, &argc, args->v0, 0, 0, more))) {
321 		addr = args->v0.addr;
322 		size = args->v0.size;
323 	} else
324 		return ret;
325 
326 	if (!(uvmm = kzalloc(sizeof(*uvmm), GFP_KERNEL)))
327 		return -ENOMEM;
328 	nvkm_object_ctor(&nvkm_uvmm, oclass, &uvmm->object);
329 	*pobject = &uvmm->object;
330 
331 	if (!mmu->vmm) {
332 		ret = mmu->func->vmm.ctor(mmu, addr, size, argv, argc,
333 					  NULL, "user", &uvmm->vmm);
334 		if (ret)
335 			return ret;
336 
337 		uvmm->vmm->debug = max(uvmm->vmm->debug, oclass->client->debug);
338 	} else {
339 		if (size)
340 			return -EINVAL;
341 
342 		uvmm->vmm = nvkm_vmm_ref(mmu->vmm);
343 	}
344 
345 	page = uvmm->vmm->func->page;
346 	args->v0.page_nr = 0;
347 	while (page && (page++)->shift)
348 		args->v0.page_nr++;
349 	args->v0.addr = uvmm->vmm->start;
350 	args->v0.size = uvmm->vmm->limit;
351 	return 0;
352 }
353