2 * Copyright © 2014-2017 Broadcom
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:
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
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
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
25 * @file v3d_simulator.c
27 * Implements VC5 simulation on top of a non-VC5 GEM fd.
29 * This file's goal is to emulate the VC5 ioctls' behavior in the kernel on
30 * top of the simpenrose software simulator. Generally, VC5 driver BOs have a
31 * GEM-side copy of their contents and a simulator-side memory area that the
32 * GEM contents get copied into during simulation. Once simulation is done,
33 * the simulator's data is copied back out to the GEM BOs, so that rendering
34 * appears on the screen as if actual hardware rendering had been done.
36 * One of the limitations of this code is that we shouldn't really need a
37 * GEM-side BO for non-window-system BOs. However, do we need unique BO
38 * handles for each of our GEM bos so that this file can look up its state
39 * from the handle passed in at submit ioctl time (also, a couple of places
40 * outside of this file still call ioctls directly on the fd).
42 * Another limitation is that BO import doesn't work unless the underlying
43 * window system's BO size matches what VC5 is going to use, which of course
44 * doesn't work out in practice. This means that for now, only DRI3 (VC5
45 * makes the winsys BOs) is supported, not DRI2 (window system makes the winys
49 #ifdef USE_V3D_SIMULATOR
52 #include "util/hash_table.h"
53 #include "util/ralloc.h"
55 #include "util/u_memory.h"
56 #include "util/u_mm.h"
57 #include "v3d_simulator_wrapper.h"
59 #include "v3d_screen.h"
60 #include "v3d_context.h"
62 /** Global (across GEM fds) state for the simulator */
63 static struct v3d_simulator_state
{
69 /* Base virtual address of the heap. */
71 /* Base hardware address of the heap. */
73 /* Size of the heap. */
76 struct mem_block
*heap
;
77 struct mem_block
*overflow
;
79 /** Mapping from GEM fd to struct v3d_simulator_file * */
80 struct hash_table
*fd_map
;
84 .mutex
= _MTX_INITIALIZER_NP
,
87 /** Per-GEM-fd state for the simulator. */
88 struct v3d_simulator_file
{
91 /** Mapping from GEM handle to struct v3d_simulator_bo * */
92 struct hash_table
*bo_map
;
94 struct mem_block
*gmp
;
98 /** Wrapper for drm_v3d_bo tracking the simulator-specific state. */
99 struct v3d_simulator_bo
{
100 struct v3d_simulator_file
*file
;
102 /** Area for this BO within sim_state->mem */
103 struct mem_block
*block
;
114 return (void *)(uintptr_t)key
;
117 static struct v3d_simulator_file
*
118 v3d_get_simulator_file_for_fd(int fd
)
120 struct hash_entry
*entry
= _mesa_hash_table_search(sim_state
.fd_map
,
122 return entry
? entry
->data
: NULL
;
125 /* A marker placed just after each BO, then checked after rendering to make
126 * sure it's still there.
128 #define BO_SENTINEL 0xfedcba98
131 #define GMP_ALIGN2 17
134 * Sets the range of GPU virtual address space to have the given GMP
135 * permissions (bit 0 = read, bit 1 = write, write-only forbidden).
138 set_gmp_flags(struct v3d_simulator_file
*file
,
139 uint32_t offset
, uint32_t size
, uint32_t flag
)
141 assert((offset
& ((1 << GMP_ALIGN2
) - 1)) == 0);
142 int gmp_offset
= offset
>> GMP_ALIGN2
;
143 int gmp_count
= align(size
, 1 << GMP_ALIGN2
) >> GMP_ALIGN2
;
144 uint32_t *gmp
= file
->gmp_vaddr
;
148 for (int i
= gmp_offset
; i
< gmp_offset
+ gmp_count
; i
++) {
149 int32_t bitshift
= (i
% 16) * 2;
150 gmp
[i
/ 16] &= ~(0x3 << bitshift
);
151 gmp
[i
/ 16] |= flag
<< bitshift
;
156 * Allocates space in simulator memory and returns a tracking struct for it
157 * that also contains the drm_gem_cma_object struct.
159 static struct v3d_simulator_bo
*
160 v3d_create_simulator_bo(int fd
, int handle
, unsigned size
)
162 struct v3d_simulator_file
*file
= v3d_get_simulator_file_for_fd(fd
);
163 struct v3d_simulator_bo
*sim_bo
= rzalloc(file
,
164 struct v3d_simulator_bo
);
165 size
= align(size
, 4096);
168 sim_bo
->handle
= handle
;
170 mtx_lock(&sim_state
.mutex
);
171 sim_bo
->block
= u_mmAllocMem(sim_state
.heap
, size
+ 4, GMP_ALIGN2
, 0);
172 mtx_unlock(&sim_state
.mutex
);
173 assert(sim_bo
->block
);
175 set_gmp_flags(file
, sim_bo
->block
->ofs
, size
, 0x3);
179 /* Allocate space for the buffer in simulator memory. */
180 sim_bo
->sim_vaddr
= sim_state
.mem
+ sim_bo
->block
->ofs
- sim_state
.mem_base
;
181 memset(sim_bo
->sim_vaddr
, 0xd0, size
);
183 *(uint32_t *)(sim_bo
->sim_vaddr
+ sim_bo
->size
) = BO_SENTINEL
;
185 /* Map the GEM buffer for copy in/out to the simulator. */
186 struct drm_mode_map_dumb map
= {
189 int ret
= drmIoctl(fd
, DRM_IOCTL_MODE_MAP_DUMB
, &map
);
191 fprintf(stderr
, "Failed to get MMAP offset: %d\n", ret
);
194 sim_bo
->gem_vaddr
= mmap(NULL
, sim_bo
->size
,
195 PROT_READ
| PROT_WRITE
, MAP_SHARED
,
197 if (sim_bo
->gem_vaddr
== MAP_FAILED
) {
198 fprintf(stderr
, "mmap of bo %d (offset 0x%016llx, size %d) failed\n",
199 handle
, (long long)map
.offset
, sim_bo
->size
);
203 /* A handle of 0 is used for v3d_gem.c internal allocations that
204 * don't need to go in the lookup table.
207 mtx_lock(&sim_state
.mutex
);
208 _mesa_hash_table_insert(file
->bo_map
, int_to_key(handle
),
210 mtx_unlock(&sim_state
.mutex
);
217 v3d_free_simulator_bo(struct v3d_simulator_bo
*sim_bo
)
219 struct v3d_simulator_file
*sim_file
= sim_bo
->file
;
221 set_gmp_flags(sim_file
, sim_bo
->block
->ofs
, sim_bo
->size
, 0x0);
223 if (sim_bo
->gem_vaddr
)
224 munmap(sim_bo
->gem_vaddr
, sim_bo
->size
);
226 mtx_lock(&sim_state
.mutex
);
227 u_mmFreeMem(sim_bo
->block
);
228 if (sim_bo
->handle
) {
229 _mesa_hash_table_remove_key(sim_file
->bo_map
,
230 int_to_key(sim_bo
->handle
));
232 mtx_unlock(&sim_state
.mutex
);
236 static struct v3d_simulator_bo
*
237 v3d_get_simulator_bo(struct v3d_simulator_file
*file
, int gem_handle
)
239 mtx_lock(&sim_state
.mutex
);
240 struct hash_entry
*entry
=
241 _mesa_hash_table_search(file
->bo_map
, int_to_key(gem_handle
));
242 mtx_unlock(&sim_state
.mutex
);
244 return entry
? entry
->data
: NULL
;
248 v3d_simulator_copy_in_handle(struct v3d_simulator_file
*file
, int handle
)
250 struct v3d_simulator_bo
*sim_bo
= v3d_get_simulator_bo(file
, handle
);
255 memcpy(sim_bo
->sim_vaddr
, sim_bo
->gem_vaddr
, sim_bo
->size
);
259 v3d_simulator_copy_out_handle(struct v3d_simulator_file
*file
, int handle
)
261 struct v3d_simulator_bo
*sim_bo
= v3d_get_simulator_bo(file
, handle
);
266 memcpy(sim_bo
->gem_vaddr
, sim_bo
->sim_vaddr
, sim_bo
->size
);
268 if (*(uint32_t *)(sim_bo
->sim_vaddr
+
269 sim_bo
->size
) != BO_SENTINEL
) {
270 fprintf(stderr
, "Buffer overflow in handle %d\n",
276 v3d_simulator_pin_bos(struct v3d_simulator_file
*file
,
277 struct drm_v3d_submit_cl
*submit
)
279 uint32_t *bo_handles
= (uint32_t *)(uintptr_t)submit
->bo_handles
;
281 for (int i
= 0; i
< submit
->bo_handle_count
; i
++)
282 v3d_simulator_copy_in_handle(file
, bo_handles
[i
]);
288 v3d_simulator_unpin_bos(struct v3d_simulator_file
*file
,
289 struct drm_v3d_submit_cl
*submit
)
291 uint32_t *bo_handles
= (uint32_t *)(uintptr_t)submit
->bo_handles
;
293 for (int i
= 0; i
< submit
->bo_handle_count
; i
++)
294 v3d_simulator_copy_out_handle(file
, bo_handles
[i
]);
300 v3d_simulator_submit_cl_ioctl(int fd
, struct drm_v3d_submit_cl
*submit
)
302 struct v3d_simulator_file
*file
= v3d_get_simulator_file_for_fd(fd
);
305 ret
= v3d_simulator_pin_bos(file
, submit
);
309 if (sim_state
.ver
>= 41)
310 v3d41_simulator_submit_cl_ioctl(sim_state
.v3d
, submit
, file
->gmp
->ofs
);
312 v3d33_simulator_submit_cl_ioctl(sim_state
.v3d
, submit
, file
->gmp
->ofs
);
314 ret
= v3d_simulator_unpin_bos(file
, submit
);
322 * Do fixups after a BO has been opened from a handle.
324 * This could be done at DRM_IOCTL_GEM_OPEN/DRM_IOCTL_GEM_PRIME_FD_TO_HANDLE
325 * time, but we're still using drmPrimeFDToHandle() so we have this helper to
326 * be called afterward instead.
328 void v3d_simulator_open_from_handle(int fd
, int handle
, uint32_t size
)
330 v3d_create_simulator_bo(fd
, handle
, size
);
334 * Simulated ioctl(fd, DRM_VC5_CREATE_BO) implementation.
336 * Making a VC5 BO is just a matter of making a corresponding BO on the host.
339 v3d_simulator_create_bo_ioctl(int fd
, struct drm_v3d_create_bo
*args
)
342 struct drm_mode_create_dumb create
= {
345 .height
= (args
->size
+ 127) / 128,
348 ret
= drmIoctl(fd
, DRM_IOCTL_MODE_CREATE_DUMB
, &create
);
349 assert(create
.size
>= args
->size
);
351 args
->handle
= create
.handle
;
353 struct v3d_simulator_bo
*sim_bo
=
354 v3d_create_simulator_bo(fd
, create
.handle
, args
->size
);
356 args
->offset
= sim_bo
->block
->ofs
;
362 * Simulated ioctl(fd, DRM_VC5_MMAP_BO) implementation.
364 * We just pass this straight through to dumb mmap.
367 v3d_simulator_mmap_bo_ioctl(int fd
, struct drm_v3d_mmap_bo
*args
)
370 struct drm_mode_map_dumb map
= {
371 .handle
= args
->handle
,
374 ret
= drmIoctl(fd
, DRM_IOCTL_MODE_MAP_DUMB
, &map
);
375 args
->offset
= map
.offset
;
381 v3d_simulator_get_bo_offset_ioctl(int fd
, struct drm_v3d_get_bo_offset
*args
)
383 struct v3d_simulator_file
*file
= v3d_get_simulator_file_for_fd(fd
);
384 struct v3d_simulator_bo
*sim_bo
= v3d_get_simulator_bo(file
,
387 args
->offset
= sim_bo
->block
->ofs
;
393 v3d_simulator_gem_close_ioctl(int fd
, struct drm_gem_close
*args
)
395 /* Free the simulator's internal tracking. */
396 struct v3d_simulator_file
*file
= v3d_get_simulator_file_for_fd(fd
);
397 struct v3d_simulator_bo
*sim_bo
= v3d_get_simulator_bo(file
,
400 v3d_free_simulator_bo(sim_bo
);
402 /* Pass the call on down. */
403 return drmIoctl(fd
, DRM_IOCTL_GEM_CLOSE
, args
);
407 v3d_simulator_get_param_ioctl(int fd
, struct drm_v3d_get_param
*args
)
409 if (sim_state
.ver
>= 41)
410 return v3d41_simulator_get_param_ioctl(sim_state
.v3d
, args
);
412 return v3d33_simulator_get_param_ioctl(sim_state
.v3d
, args
);
416 v3d_simulator_submit_tfu_ioctl(int fd
, struct drm_v3d_submit_tfu
*args
)
418 struct v3d_simulator_file
*file
= v3d_get_simulator_file_for_fd(fd
);
421 v3d_simulator_copy_in_handle(file
, args
->bo_handles
[0]);
422 v3d_simulator_copy_in_handle(file
, args
->bo_handles
[1]);
423 v3d_simulator_copy_in_handle(file
, args
->bo_handles
[2]);
424 v3d_simulator_copy_in_handle(file
, args
->bo_handles
[3]);
426 if (sim_state
.ver
>= 41)
427 ret
= v3d41_simulator_submit_tfu_ioctl(sim_state
.v3d
, args
);
429 ret
= v3d33_simulator_submit_tfu_ioctl(sim_state
.v3d
, args
);
431 v3d_simulator_copy_out_handle(file
, args
->bo_handles
[0]);
437 v3d_simulator_ioctl(int fd
, unsigned long request
, void *args
)
440 case DRM_IOCTL_V3D_SUBMIT_CL
:
441 return v3d_simulator_submit_cl_ioctl(fd
, args
);
442 case DRM_IOCTL_V3D_CREATE_BO
:
443 return v3d_simulator_create_bo_ioctl(fd
, args
);
444 case DRM_IOCTL_V3D_MMAP_BO
:
445 return v3d_simulator_mmap_bo_ioctl(fd
, args
);
446 case DRM_IOCTL_V3D_GET_BO_OFFSET
:
447 return v3d_simulator_get_bo_offset_ioctl(fd
, args
);
449 case DRM_IOCTL_V3D_WAIT_BO
:
450 /* We do all of the v3d rendering synchronously, so we just
451 * return immediately on the wait ioctls. This ignores any
452 * native rendering to the host BO, so it does mean we race on
453 * front buffer rendering.
457 case DRM_IOCTL_V3D_GET_PARAM
:
458 return v3d_simulator_get_param_ioctl(fd
, args
);
460 case DRM_IOCTL_GEM_CLOSE
:
461 return v3d_simulator_gem_close_ioctl(fd
, args
);
463 case DRM_IOCTL_V3D_SUBMIT_TFU
:
464 return v3d_simulator_submit_tfu_ioctl(fd
, args
);
466 case DRM_IOCTL_GEM_OPEN
:
467 case DRM_IOCTL_GEM_FLINK
:
468 return drmIoctl(fd
, request
, args
);
470 fprintf(stderr
, "Unknown ioctl 0x%08x\n", (int)request
);
476 v3d_simulator_init_global(const struct v3d_device_info
*devinfo
)
478 mtx_lock(&sim_state
.mutex
);
479 if (sim_state
.refcount
++) {
480 mtx_unlock(&sim_state
.mutex
);
484 sim_state
.v3d
= v3d_hw_auto_new(NULL
);
485 v3d_hw_alloc_mem(sim_state
.v3d
, 1024 * 1024 * 1024);
487 v3d_hw_get_mem(sim_state
.v3d
, &sim_state
.mem_size
,
490 /* Allocate from anywhere from 4096 up. We don't allocate at 0,
491 * because for OQs and some other addresses in the HW, 0 means
494 sim_state
.heap
= u_mmInit(4096, sim_state
.mem_size
- 4096);
496 /* Make a block of 0xd0 at address 0 to make sure we don't screw up
499 struct mem_block
*b
= u_mmAllocMem(sim_state
.heap
, 4096, GMP_ALIGN2
, 0);
500 memset(sim_state
.mem
+ b
->ofs
- sim_state
.mem_base
, 0xd0, 4096);
502 sim_state
.ver
= v3d_hw_get_version(sim_state
.v3d
);
504 mtx_unlock(&sim_state
.mutex
);
507 _mesa_hash_table_create(NULL
,
509 _mesa_key_pointer_equal
);
511 if (sim_state
.ver
>= 41)
512 v3d41_simulator_init_regs(sim_state
.v3d
);
514 v3d33_simulator_init_regs(sim_state
.v3d
);
518 v3d_simulator_init(struct v3d_screen
*screen
)
520 v3d_simulator_init_global(&screen
->devinfo
);
522 screen
->sim_file
= rzalloc(screen
, struct v3d_simulator_file
);
523 struct v3d_simulator_file
*sim_file
= screen
->sim_file
;
525 screen
->sim_file
->bo_map
=
526 _mesa_hash_table_create(screen
->sim_file
,
528 _mesa_key_pointer_equal
);
530 mtx_lock(&sim_state
.mutex
);
531 _mesa_hash_table_insert(sim_state
.fd_map
, int_to_key(screen
->fd
+ 1),
533 mtx_unlock(&sim_state
.mutex
);
535 sim_file
->gmp
= u_mmAllocMem(sim_state
.heap
, 8096, GMP_ALIGN2
, 0);
536 sim_file
->gmp_vaddr
= (sim_state
.mem
+ sim_file
->gmp
->ofs
-
541 v3d_simulator_destroy(struct v3d_screen
*screen
)
543 mtx_lock(&sim_state
.mutex
);
544 if (!--sim_state
.refcount
) {
545 _mesa_hash_table_destroy(sim_state
.fd_map
, NULL
);
546 u_mmDestroy(sim_state
.heap
);
547 /* No memsetting the struct, because it contains the mutex. */
548 sim_state
.mem
= NULL
;
550 mtx_unlock(&sim_state
.mutex
);
553 #endif /* USE_V3D_SIMULATOR */