1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */
4 * Copyright (C) 2013 Rob Clark <robclark@freedesktop.org>
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * Rob Clark <robclark@freedesktop.org>
32 #include "freedreno_ringbuffer.h"
35 /* represents a single cmd buffer in the submit ioctl. Each cmd buffer has
36 * a backing bo, and a reloc table.
39 struct list_head list;
41 struct fd_ringbuffer *ring;
42 struct fd_bo *ring_bo;
45 struct drm_msm_gem_submit_reloc *relocs;
46 uint32_t nr_relocs, max_relocs;
51 struct msm_ringbuffer {
52 struct fd_ringbuffer base;
54 /* submit ioctl related tables:
55 * Note that bos and cmds are tracked by the parent ringbuffer, since
56 * that is global to the submit ioctl call. The reloc's table is tracked
61 struct drm_msm_gem_submit_bo *bos;
62 uint32_t nr_bos, max_bos;
65 struct drm_msm_gem_submit_cmd *cmds;
66 uint32_t nr_cmds, max_cmds;
69 /* should have matching entries in submit.bos: */
70 /* Note, only in parent ringbuffer */
72 uint32_t nr_bos, max_bos;
74 /* should have matching entries in submit.cmds: */
75 struct msm_cmd **cmds;
76 uint32_t nr_cmds, max_cmds;
78 /* List of physical cmdstream buffers (msm_cmd) assocated with this
79 * logical fd_ringbuffer.
81 * Note that this is different from msm_ringbuffer::cmds (which
82 * shadows msm_ringbuffer::submit::cmds for tracking submit ioctl
83 * related stuff, and *only* is tracked in the parent ringbuffer.
84 * And only has "completed" cmd buffers (ie. we already know the
85 * size) added via get_cmd().
87 struct list_head cmd_list;
94 /* maps fd_bo to idx: */
98 static inline struct msm_ringbuffer * to_msm_ringbuffer(struct fd_ringbuffer *x)
100 return (struct msm_ringbuffer *)x;
103 #define INIT_SIZE 0x1000
105 static pthread_mutex_t idx_lock = PTHREAD_MUTEX_INITIALIZER;
106 drm_private extern pthread_mutex_t table_lock;
108 static void ring_bo_del(struct fd_device *dev, struct fd_bo *bo)
112 pthread_mutex_lock(&table_lock);
113 ret = fd_bo_cache_free(&to_msm_device(dev)->ring_cache, bo);
114 pthread_mutex_unlock(&table_lock);
122 static struct fd_bo * ring_bo_new(struct fd_device *dev, uint32_t size)
126 bo = fd_bo_cache_alloc(&to_msm_device(dev)->ring_cache, &size, 0);
130 bo = fd_bo_new(dev, size, 0);
134 /* keep ringbuffer bo's out of the normal bo cache: */
135 bo->bo_reuse = FALSE;
140 static void ring_cmd_del(struct msm_cmd *cmd)
143 ring_bo_del(cmd->ring->pipe->dev, cmd->ring_bo);
144 list_del(&cmd->list);
145 to_msm_ringbuffer(cmd->ring)->cmd_count--;
150 static struct msm_cmd * ring_cmd_new(struct fd_ringbuffer *ring, uint32_t size)
152 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
153 struct msm_cmd *cmd = calloc(1, sizeof(*cmd));
159 cmd->ring_bo = ring_bo_new(ring->pipe->dev, size);
163 list_addtail(&cmd->list, &msm_ring->cmd_list);
164 msm_ring->cmd_count++;
173 static void *grow(void *ptr, uint32_t nr, uint32_t *max, uint32_t sz)
175 if ((nr + 1) > *max) {
176 if ((*max * 2) < (nr + 1))
180 ptr = realloc(ptr, *max * sz);
185 #define APPEND(x, name) ({ \
186 (x)->name = grow((x)->name, (x)->nr_ ## name, &(x)->max_ ## name, sizeof((x)->name[0])); \
187 (x)->nr_ ## name ++; \
190 static struct msm_cmd *current_cmd(struct fd_ringbuffer *ring)
192 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
193 assert(!LIST_IS_EMPTY(&msm_ring->cmd_list));
194 return LIST_LAST_ENTRY(&msm_ring->cmd_list, struct msm_cmd, list);
197 static uint32_t append_bo(struct fd_ringbuffer *ring, struct fd_bo *bo)
199 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
202 idx = APPEND(&msm_ring->submit, bos);
203 idx = APPEND(msm_ring, bos);
205 msm_ring->submit.bos[idx].flags = 0;
206 msm_ring->submit.bos[idx].handle = bo->handle;
207 msm_ring->submit.bos[idx].presumed = to_msm_bo(bo)->presumed;
209 msm_ring->bos[idx] = fd_bo_ref(bo);
214 /* add (if needed) bo, return idx: */
215 static uint32_t bo2idx(struct fd_ringbuffer *ring, struct fd_bo *bo, uint32_t flags)
217 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
218 struct msm_bo *msm_bo = to_msm_bo(bo);
220 pthread_mutex_lock(&idx_lock);
221 if (msm_bo->current_ring_seqno == msm_ring->seqno) {
226 if (!msm_ring->bo_table)
227 msm_ring->bo_table = drmHashCreate();
229 if (!drmHashLookup(msm_ring->bo_table, bo->handle, &val)) {
231 idx = (uint32_t)(uintptr_t)val;
233 idx = append_bo(ring, bo);
234 val = (void *)(uintptr_t)idx;
235 drmHashInsert(msm_ring->bo_table, bo->handle, val);
237 msm_bo->current_ring_seqno = msm_ring->seqno;
240 pthread_mutex_unlock(&idx_lock);
241 if (flags & FD_RELOC_READ)
242 msm_ring->submit.bos[idx].flags |= MSM_SUBMIT_BO_READ;
243 if (flags & FD_RELOC_WRITE)
244 msm_ring->submit.bos[idx].flags |= MSM_SUBMIT_BO_WRITE;
248 static int check_cmd_bo(struct fd_ringbuffer *ring,
249 struct drm_msm_gem_submit_cmd *cmd, struct fd_bo *bo)
251 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
252 return msm_ring->submit.bos[cmd->submit_idx].handle == bo->handle;
255 /* Ensure that submit has corresponding entry in cmds table for the
256 * target cmdstream buffer:
258 static void get_cmd(struct fd_ringbuffer *ring, struct msm_cmd *target_cmd,
259 uint32_t submit_offset, uint32_t size, uint32_t type)
261 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
262 struct drm_msm_gem_submit_cmd *cmd;
265 /* figure out if we already have a cmd buf: */
266 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
267 cmd = &msm_ring->submit.cmds[i];
268 if ((cmd->submit_offset == submit_offset) &&
269 (cmd->size == size) &&
270 (cmd->type == type) &&
271 check_cmd_bo(ring, cmd, target_cmd->ring_bo))
275 /* create cmd buf if not: */
276 i = APPEND(&msm_ring->submit, cmds);
277 APPEND(msm_ring, cmds);
278 msm_ring->cmds[i] = target_cmd;
279 cmd = &msm_ring->submit.cmds[i];
281 cmd->submit_idx = bo2idx(ring, target_cmd->ring_bo, FD_RELOC_READ);
282 cmd->submit_offset = submit_offset;
286 target_cmd->size = size;
289 static void * msm_ringbuffer_hostptr(struct fd_ringbuffer *ring)
291 return fd_bo_map(current_cmd(ring)->ring_bo);
294 static uint32_t find_next_reloc_idx(struct msm_cmd *msm_cmd,
295 uint32_t start, uint32_t offset)
299 /* a binary search would be more clever.. */
300 for (i = start; i < msm_cmd->nr_relocs; i++) {
301 struct drm_msm_gem_submit_reloc *reloc = &msm_cmd->relocs[i];
302 if (reloc->submit_offset >= offset)
309 static void delete_cmds(struct msm_ringbuffer *msm_ring)
311 struct msm_cmd *cmd, *tmp;
313 LIST_FOR_EACH_ENTRY_SAFE(cmd, tmp, &msm_ring->cmd_list, list) {
318 static void flush_reset(struct fd_ringbuffer *ring)
320 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
323 for (i = 0; i < msm_ring->nr_bos; i++) {
324 struct msm_bo *msm_bo = to_msm_bo(msm_ring->bos[i]);
325 msm_bo->current_ring_seqno = 0;
326 fd_bo_del(&msm_bo->base);
329 /* for each of the cmd buffers, clear their reloc's: */
330 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
331 struct msm_cmd *target_cmd = msm_ring->cmds[i];
332 target_cmd->nr_relocs = 0;
335 msm_ring->submit.nr_cmds = 0;
336 msm_ring->submit.nr_bos = 0;
337 msm_ring->nr_cmds = 0;
338 msm_ring->nr_bos = 0;
340 if (msm_ring->bo_table) {
341 drmHashDestroy(msm_ring->bo_table);
342 msm_ring->bo_table = NULL;
345 if (msm_ring->is_growable) {
346 delete_cmds(msm_ring);
348 /* in old mode, just reset the # of relocs: */
349 current_cmd(ring)->nr_relocs = 0;
353 static void finalize_current_cmd(struct fd_ringbuffer *ring, uint32_t *last_start)
355 uint32_t submit_offset, size, type;
356 struct fd_ringbuffer *parent;
359 parent = ring->parent;
360 type = MSM_SUBMIT_CMD_IB_TARGET_BUF;
363 type = MSM_SUBMIT_CMD_BUF;
366 submit_offset = offset_bytes(last_start, ring->start);
367 size = offset_bytes(ring->cur, last_start);
369 get_cmd(parent, current_cmd(ring), submit_offset, size, type);
372 static void dump_submit(struct msm_ringbuffer *msm_ring)
376 for (i = 0; i < msm_ring->submit.nr_bos; i++) {
377 struct drm_msm_gem_submit_bo *bo = &msm_ring->submit.bos[i];
378 ERROR_MSG(" bos[%d]: handle=%u, flags=%x", i, bo->handle, bo->flags);
380 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
381 struct drm_msm_gem_submit_cmd *cmd = &msm_ring->submit.cmds[i];
382 struct drm_msm_gem_submit_reloc *relocs = U642VOID(cmd->relocs);
383 ERROR_MSG(" cmd[%d]: type=%u, submit_idx=%u, submit_offset=%u, size=%u",
384 i, cmd->type, cmd->submit_idx, cmd->submit_offset, cmd->size);
385 for (j = 0; j < cmd->nr_relocs; j++) {
386 struct drm_msm_gem_submit_reloc *r = &relocs[j];
387 ERROR_MSG(" reloc[%d]: submit_offset=%u, or=%08x, shift=%d, reloc_idx=%u"
388 ", reloc_offset=%"PRIu64, j, r->submit_offset, r->or, r->shift,
389 r->reloc_idx, r->reloc_offset);
394 static int msm_ringbuffer_flush(struct fd_ringbuffer *ring, uint32_t *last_start,
395 int in_fence_fd, int *out_fence_fd)
397 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
398 struct drm_msm_gem_submit req = {
399 .flags = to_msm_pipe(ring->pipe)->pipe,
400 .queueid = to_msm_pipe(ring->pipe)->queue_id,
405 if (in_fence_fd != -1) {
406 req.flags |= MSM_SUBMIT_FENCE_FD_IN | MSM_SUBMIT_NO_IMPLICIT;
407 req.fence_fd = in_fence_fd;
411 req.flags |= MSM_SUBMIT_FENCE_FD_OUT;
414 finalize_current_cmd(ring, last_start);
416 /* needs to be after get_cmd() as that could create bos/cmds table: */
417 req.bos = VOID2U64(msm_ring->submit.bos),
418 req.nr_bos = msm_ring->submit.nr_bos;
419 req.cmds = VOID2U64(msm_ring->submit.cmds),
420 req.nr_cmds = msm_ring->submit.nr_cmds;
422 /* for each of the cmd's fix up their reloc's: */
423 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
424 struct drm_msm_gem_submit_cmd *cmd = &msm_ring->submit.cmds[i];
425 struct msm_cmd *msm_cmd = msm_ring->cmds[i];
426 uint32_t a = find_next_reloc_idx(msm_cmd, 0, cmd->submit_offset);
427 uint32_t b = find_next_reloc_idx(msm_cmd, a, cmd->submit_offset + cmd->size);
428 cmd->relocs = VOID2U64(&msm_cmd->relocs[a]);
429 cmd->nr_relocs = (b > a) ? b - a : 0;
432 DEBUG_MSG("nr_cmds=%u, nr_bos=%u", req.nr_cmds, req.nr_bos);
434 ret = drmCommandWriteRead(ring->pipe->dev->fd, DRM_MSM_GEM_SUBMIT,
437 ERROR_MSG("submit failed: %d (%s)", ret, strerror(errno));
438 dump_submit(msm_ring);
440 /* update timestamp on all rings associated with submit: */
441 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
442 struct msm_cmd *msm_cmd = msm_ring->cmds[i];
443 msm_cmd->ring->last_timestamp = req.fence;
447 *out_fence_fd = req.fence_fd;
456 static void msm_ringbuffer_grow(struct fd_ringbuffer *ring, uint32_t size)
458 assert(to_msm_ringbuffer(ring)->is_growable);
459 finalize_current_cmd(ring, ring->last_start);
460 ring_cmd_new(ring, size);
463 static void msm_ringbuffer_reset(struct fd_ringbuffer *ring)
468 static void msm_ringbuffer_emit_reloc(struct fd_ringbuffer *ring,
469 const struct fd_reloc *r)
471 struct fd_ringbuffer *parent = ring->parent ? ring->parent : ring;
472 struct msm_bo *msm_bo = to_msm_bo(r->bo);
473 struct drm_msm_gem_submit_reloc *reloc;
474 struct msm_cmd *cmd = current_cmd(ring);
475 uint32_t idx = APPEND(cmd, relocs);
478 reloc = &cmd->relocs[idx];
480 reloc->reloc_idx = bo2idx(parent, r->bo, r->flags);
481 reloc->reloc_offset = r->offset;
483 reloc->shift = r->shift;
484 reloc->submit_offset = offset_bytes(ring->cur, ring->start);
486 addr = msm_bo->presumed;
487 if (reloc->shift < 0)
488 addr >>= -reloc->shift;
490 addr <<= reloc->shift;
491 (*ring->cur++) = addr | r->or;
493 if (ring->pipe->gpu_id >= 500) {
494 struct drm_msm_gem_submit_reloc *reloc_hi;
496 /* NOTE: grab reloc_idx *before* APPEND() since that could
497 * realloc() meaning that 'reloc' ptr is no longer valid:
499 uint32_t reloc_idx = reloc->reloc_idx;
501 idx = APPEND(cmd, relocs);
503 reloc_hi = &cmd->relocs[idx];
505 reloc_hi->reloc_idx = reloc_idx;
506 reloc_hi->reloc_offset = r->offset;
507 reloc_hi->or = r->orhi;
508 reloc_hi->shift = r->shift - 32;
509 reloc_hi->submit_offset = offset_bytes(ring->cur, ring->start);
511 addr = msm_bo->presumed >> 32;
512 if (reloc_hi->shift < 0)
513 addr >>= -reloc_hi->shift;
515 addr <<= reloc_hi->shift;
516 (*ring->cur++) = addr | r->orhi;
520 static uint32_t msm_ringbuffer_emit_reloc_ring(struct fd_ringbuffer *ring,
521 struct fd_ringbuffer *target, uint32_t cmd_idx,
522 uint32_t submit_offset, uint32_t size)
524 struct msm_cmd *cmd = NULL;
527 LIST_FOR_EACH_ENTRY(cmd, &to_msm_ringbuffer(target)->cmd_list, list) {
533 assert(cmd && (idx == cmd_idx));
535 if (idx < (to_msm_ringbuffer(target)->cmd_count - 1)) {
536 /* All but the last cmd buffer is fully "baked" (ie. already has
537 * done get_cmd() to add it to the cmds table). But in this case,
538 * the size we get is invalid (since it is calculated from the
543 get_cmd(ring, cmd, submit_offset, size, MSM_SUBMIT_CMD_IB_TARGET_BUF);
546 msm_ringbuffer_emit_reloc(ring, &(struct fd_reloc){
548 .flags = FD_RELOC_READ,
549 .offset = submit_offset,
555 static uint32_t msm_ringbuffer_cmd_count(struct fd_ringbuffer *ring)
557 return to_msm_ringbuffer(ring)->cmd_count;
560 static void msm_ringbuffer_destroy(struct fd_ringbuffer *ring)
562 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
565 delete_cmds(msm_ring);
567 free(msm_ring->submit.cmds);
568 free(msm_ring->submit.bos);
570 free(msm_ring->cmds);
574 static const struct fd_ringbuffer_funcs funcs = {
575 .hostptr = msm_ringbuffer_hostptr,
576 .flush = msm_ringbuffer_flush,
577 .grow = msm_ringbuffer_grow,
578 .reset = msm_ringbuffer_reset,
579 .emit_reloc = msm_ringbuffer_emit_reloc,
580 .emit_reloc_ring = msm_ringbuffer_emit_reloc_ring,
581 .cmd_count = msm_ringbuffer_cmd_count,
582 .destroy = msm_ringbuffer_destroy,
585 drm_private struct fd_ringbuffer * msm_ringbuffer_new(struct fd_pipe *pipe,
586 uint32_t size, enum fd_ringbuffer_flags flags)
588 struct msm_ringbuffer *msm_ring;
589 struct fd_ringbuffer *ring;
593 msm_ring = calloc(1, sizeof(*msm_ring));
595 ERROR_MSG("allocation failed");
600 assert(pipe->dev->version >= FD_VERSION_UNLIMITED_CMDS);
602 msm_ring->is_growable = TRUE;
605 list_inithead(&msm_ring->cmd_list);
606 msm_ring->seqno = ++to_msm_device(pipe->dev)->ring_cnt;
608 ring = &msm_ring->base;
609 ring->funcs = &funcs;
611 ring->pipe = pipe; /* needed in ring_cmd_new() */
613 ring_cmd_new(ring, size);