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 DECLARE_ARRAY(struct drm_msm_gem_submit_reloc, relocs);
50 struct msm_ringbuffer {
51 struct fd_ringbuffer base;
55 /* submit ioctl related tables:
56 * Note that bos and cmds are tracked by the parent ringbuffer, since
57 * that is global to the submit ioctl call. The reloc's table is tracked
62 DECLARE_ARRAY(struct drm_msm_gem_submit_bo, bos);
65 DECLARE_ARRAY(struct drm_msm_gem_submit_cmd, cmds);
68 /* should have matching entries in submit.bos: */
69 /* Note, only in parent ringbuffer */
70 DECLARE_ARRAY(struct fd_bo *, bos);
72 /* should have matching entries in submit.cmds: */
73 DECLARE_ARRAY(struct msm_cmd *, cmds);
75 /* List of physical cmdstream buffers (msm_cmd) assocated with this
76 * logical fd_ringbuffer.
78 * Note that this is different from msm_ringbuffer::cmds (which
79 * shadows msm_ringbuffer::submit::cmds for tracking submit ioctl
80 * related stuff, and *only* is tracked in the parent ringbuffer.
81 * And only has "completed" cmd buffers (ie. we already know the
82 * size) added via get_cmd().
84 struct list_head cmd_list;
91 /* maps fd_bo to idx: */
95 static inline struct msm_ringbuffer * to_msm_ringbuffer(struct fd_ringbuffer *x)
97 return (struct msm_ringbuffer *)x;
100 static void msm_ringbuffer_unref(struct fd_ringbuffer *ring);
101 static void msm_ringbuffer_ref(struct fd_ringbuffer *ring);
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 struct msm_cmd *current_cmd(struct fd_ringbuffer *ring)
175 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
176 assert(!LIST_IS_EMPTY(&msm_ring->cmd_list));
177 return LIST_LAST_ENTRY(&msm_ring->cmd_list, struct msm_cmd, list);
180 static uint32_t append_bo(struct fd_ringbuffer *ring, struct fd_bo *bo)
182 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
185 idx = APPEND(&msm_ring->submit, bos);
186 idx = APPEND(msm_ring, bos);
188 msm_ring->submit.bos[idx].flags = 0;
189 msm_ring->submit.bos[idx].handle = bo->handle;
190 msm_ring->submit.bos[idx].presumed = to_msm_bo(bo)->presumed;
192 msm_ring->bos[idx] = fd_bo_ref(bo);
197 /* add (if needed) bo, return idx: */
198 static uint32_t bo2idx(struct fd_ringbuffer *ring, struct fd_bo *bo, uint32_t flags)
200 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
201 struct msm_bo *msm_bo = to_msm_bo(bo);
203 pthread_mutex_lock(&idx_lock);
204 if (msm_bo->current_ring_seqno == msm_ring->seqno) {
209 if (!msm_ring->bo_table)
210 msm_ring->bo_table = drmHashCreate();
212 if (!drmHashLookup(msm_ring->bo_table, bo->handle, &val)) {
214 idx = (uint32_t)(uintptr_t)val;
216 idx = append_bo(ring, bo);
217 val = (void *)(uintptr_t)idx;
218 drmHashInsert(msm_ring->bo_table, bo->handle, val);
220 msm_bo->current_ring_seqno = msm_ring->seqno;
223 pthread_mutex_unlock(&idx_lock);
224 if (flags & FD_RELOC_READ)
225 msm_ring->submit.bos[idx].flags |= MSM_SUBMIT_BO_READ;
226 if (flags & FD_RELOC_WRITE)
227 msm_ring->submit.bos[idx].flags |= MSM_SUBMIT_BO_WRITE;
231 static int check_cmd_bo(struct fd_ringbuffer *ring,
232 struct drm_msm_gem_submit_cmd *cmd, struct fd_bo *bo)
234 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
235 return msm_ring->submit.bos[cmd->submit_idx].handle == bo->handle;
238 /* Ensure that submit has corresponding entry in cmds table for the
239 * target cmdstream buffer:
241 static void get_cmd(struct fd_ringbuffer *ring, struct msm_cmd *target_cmd,
242 uint32_t submit_offset, uint32_t size, uint32_t type)
244 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
245 struct drm_msm_gem_submit_cmd *cmd;
248 /* figure out if we already have a cmd buf: */
249 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
250 cmd = &msm_ring->submit.cmds[i];
251 if ((cmd->submit_offset == submit_offset) &&
252 (cmd->size == size) &&
253 (cmd->type == type) &&
254 check_cmd_bo(ring, cmd, target_cmd->ring_bo))
258 /* create cmd buf if not: */
259 i = APPEND(&msm_ring->submit, cmds);
260 APPEND(msm_ring, cmds);
261 msm_ring->cmds[i] = target_cmd;
262 cmd = &msm_ring->submit.cmds[i];
264 cmd->submit_idx = bo2idx(ring, target_cmd->ring_bo, FD_RELOC_READ);
265 cmd->submit_offset = submit_offset;
269 target_cmd->size = size;
272 static void * msm_ringbuffer_hostptr(struct fd_ringbuffer *ring)
274 return fd_bo_map(current_cmd(ring)->ring_bo);
277 static uint32_t find_next_reloc_idx(struct msm_cmd *msm_cmd,
278 uint32_t start, uint32_t offset)
282 /* a binary search would be more clever.. */
283 for (i = start; i < msm_cmd->nr_relocs; i++) {
284 struct drm_msm_gem_submit_reloc *reloc = &msm_cmd->relocs[i];
285 if (reloc->submit_offset >= offset)
292 static void delete_cmds(struct msm_ringbuffer *msm_ring)
294 struct msm_cmd *cmd, *tmp;
296 LIST_FOR_EACH_ENTRY_SAFE(cmd, tmp, &msm_ring->cmd_list, list) {
301 static void flush_reset(struct fd_ringbuffer *ring)
303 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
306 for (i = 0; i < msm_ring->nr_bos; i++) {
307 struct msm_bo *msm_bo = to_msm_bo(msm_ring->bos[i]);
308 msm_bo->current_ring_seqno = 0;
309 fd_bo_del(&msm_bo->base);
312 /* for each of the cmd buffers, clear their reloc's: */
313 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
314 struct msm_cmd *target_cmd = msm_ring->cmds[i];
315 if (target_cmd->ring->flags & FD_RINGBUFFER_OBJECT)
317 target_cmd->nr_relocs = 0;
320 msm_ring->submit.nr_cmds = 0;
321 msm_ring->submit.nr_bos = 0;
322 msm_ring->nr_cmds = 0;
323 msm_ring->nr_bos = 0;
325 if (msm_ring->bo_table) {
326 drmHashDestroy(msm_ring->bo_table);
327 msm_ring->bo_table = NULL;
330 if (msm_ring->is_growable) {
331 delete_cmds(msm_ring);
333 /* in old mode, just reset the # of relocs: */
334 current_cmd(ring)->nr_relocs = 0;
338 static void finalize_current_cmd(struct fd_ringbuffer *ring, uint32_t *last_start)
340 uint32_t submit_offset, size, type;
341 struct fd_ringbuffer *parent;
344 parent = ring->parent;
345 type = MSM_SUBMIT_CMD_IB_TARGET_BUF;
348 type = MSM_SUBMIT_CMD_BUF;
351 submit_offset = offset_bytes(last_start, ring->start);
352 size = offset_bytes(ring->cur, last_start);
354 get_cmd(parent, current_cmd(ring), submit_offset, size, type);
357 static void dump_submit(struct msm_ringbuffer *msm_ring)
361 for (i = 0; i < msm_ring->submit.nr_bos; i++) {
362 struct drm_msm_gem_submit_bo *bo = &msm_ring->submit.bos[i];
363 ERROR_MSG(" bos[%d]: handle=%u, flags=%x", i, bo->handle, bo->flags);
365 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
366 struct drm_msm_gem_submit_cmd *cmd = &msm_ring->submit.cmds[i];
367 struct drm_msm_gem_submit_reloc *relocs = U642VOID(cmd->relocs);
368 ERROR_MSG(" cmd[%d]: type=%u, submit_idx=%u, submit_offset=%u, size=%u",
369 i, cmd->type, cmd->submit_idx, cmd->submit_offset, cmd->size);
370 for (j = 0; j < cmd->nr_relocs; j++) {
371 struct drm_msm_gem_submit_reloc *r = &relocs[j];
372 ERROR_MSG(" reloc[%d]: submit_offset=%u, or=%08x, shift=%d, reloc_idx=%u"
373 ", reloc_offset=%"PRIu64, j, r->submit_offset, r->or, r->shift,
374 r->reloc_idx, r->reloc_offset);
379 static struct drm_msm_gem_submit_reloc *
380 handle_stateobj_relocs(struct fd_ringbuffer *parent, struct fd_ringbuffer *stateobj,
381 struct drm_msm_gem_submit_reloc *orig_relocs, unsigned nr_relocs)
383 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(stateobj);
384 struct drm_msm_gem_submit_reloc *relocs = malloc(nr_relocs * sizeof(*relocs));
387 for (i = 0; i < nr_relocs; i++) {
388 unsigned idx = orig_relocs[i].reloc_idx;
389 struct fd_bo *bo = msm_ring->bos[idx];
392 if (msm_ring->submit.bos[idx].flags & MSM_SUBMIT_BO_READ)
393 flags |= FD_RELOC_READ;
394 if (msm_ring->submit.bos[idx].flags & MSM_SUBMIT_BO_WRITE)
395 flags |= FD_RELOC_WRITE;
397 relocs[i] = orig_relocs[i];
398 relocs[i].reloc_idx = bo2idx(parent, bo, flags);
404 static int msm_ringbuffer_flush(struct fd_ringbuffer *ring, uint32_t *last_start,
405 int in_fence_fd, int *out_fence_fd)
407 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
408 struct drm_msm_gem_submit req = {
409 .flags = to_msm_pipe(ring->pipe)->pipe,
410 .queueid = to_msm_pipe(ring->pipe)->queue_id,
415 assert(!ring->parent);
417 if (in_fence_fd != -1) {
418 req.flags |= MSM_SUBMIT_FENCE_FD_IN | MSM_SUBMIT_NO_IMPLICIT;
419 req.fence_fd = in_fence_fd;
423 req.flags |= MSM_SUBMIT_FENCE_FD_OUT;
426 finalize_current_cmd(ring, last_start);
428 /* for each of the cmd's fix up their reloc's: */
429 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
430 struct drm_msm_gem_submit_cmd *cmd = &msm_ring->submit.cmds[i];
431 struct msm_cmd *msm_cmd = msm_ring->cmds[i];
432 uint32_t a = find_next_reloc_idx(msm_cmd, 0, cmd->submit_offset);
433 uint32_t b = find_next_reloc_idx(msm_cmd, a, cmd->submit_offset + cmd->size);
434 struct drm_msm_gem_submit_reloc *relocs = &msm_cmd->relocs[a];
435 unsigned nr_relocs = (b > a) ? b - a : 0;
437 /* for reusable stateobjs, the reloc table has reloc_idx that
438 * points into it's own private bos table, rather than the global
439 * bos table used for the submit, so we need to add the stateobj's
440 * bos to the global table and construct new relocs table with
441 * corresponding reloc_idx
443 if (msm_cmd->ring->flags & FD_RINGBUFFER_OBJECT) {
444 relocs = handle_stateobj_relocs(ring, msm_cmd->ring,
448 cmd->relocs = VOID2U64(relocs);
449 cmd->nr_relocs = nr_relocs;
452 /* needs to be after get_cmd() as that could create bos/cmds table: */
453 req.bos = VOID2U64(msm_ring->submit.bos),
454 req.nr_bos = msm_ring->submit.nr_bos;
455 req.cmds = VOID2U64(msm_ring->submit.cmds),
456 req.nr_cmds = msm_ring->submit.nr_cmds;
458 DEBUG_MSG("nr_cmds=%u, nr_bos=%u", req.nr_cmds, req.nr_bos);
460 ret = drmCommandWriteRead(ring->pipe->dev->fd, DRM_MSM_GEM_SUBMIT,
463 ERROR_MSG("submit failed: %d (%s)", ret, strerror(errno));
464 dump_submit(msm_ring);
466 /* update timestamp on all rings associated with submit: */
467 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
468 struct msm_cmd *msm_cmd = msm_ring->cmds[i];
469 msm_cmd->ring->last_timestamp = req.fence;
473 *out_fence_fd = req.fence_fd;
477 /* free dynamically constructed stateobj relocs tables: */
478 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
479 struct drm_msm_gem_submit_cmd *cmd = &msm_ring->submit.cmds[i];
480 struct msm_cmd *msm_cmd = msm_ring->cmds[i];
481 if (msm_cmd->ring->flags & FD_RINGBUFFER_OBJECT) {
482 msm_ringbuffer_unref(msm_cmd->ring);
483 free(U642VOID(cmd->relocs));
492 static void msm_ringbuffer_grow(struct fd_ringbuffer *ring, uint32_t size)
494 assert(to_msm_ringbuffer(ring)->is_growable);
495 finalize_current_cmd(ring, ring->last_start);
496 ring_cmd_new(ring, size);
499 static void msm_ringbuffer_reset(struct fd_ringbuffer *ring)
504 static void msm_ringbuffer_emit_reloc(struct fd_ringbuffer *ring,
505 const struct fd_reloc *r)
507 struct fd_ringbuffer *parent = ring->parent ? ring->parent : ring;
508 struct msm_bo *msm_bo = to_msm_bo(r->bo);
509 struct drm_msm_gem_submit_reloc *reloc;
510 struct msm_cmd *cmd = current_cmd(ring);
511 uint32_t idx = APPEND(cmd, relocs);
514 reloc = &cmd->relocs[idx];
516 reloc->reloc_idx = bo2idx(parent, r->bo, r->flags);
517 reloc->reloc_offset = r->offset;
519 reloc->shift = r->shift;
520 reloc->submit_offset = offset_bytes(ring->cur, ring->start);
522 addr = msm_bo->presumed;
523 if (reloc->shift < 0)
524 addr >>= -reloc->shift;
526 addr <<= reloc->shift;
527 (*ring->cur++) = addr | r->or;
529 if (ring->pipe->gpu_id >= 500) {
530 struct drm_msm_gem_submit_reloc *reloc_hi;
532 /* NOTE: grab reloc_idx *before* APPEND() since that could
533 * realloc() meaning that 'reloc' ptr is no longer valid:
535 uint32_t reloc_idx = reloc->reloc_idx;
537 idx = APPEND(cmd, relocs);
539 reloc_hi = &cmd->relocs[idx];
541 reloc_hi->reloc_idx = reloc_idx;
542 reloc_hi->reloc_offset = r->offset;
543 reloc_hi->or = r->orhi;
544 reloc_hi->shift = r->shift - 32;
545 reloc_hi->submit_offset = offset_bytes(ring->cur, ring->start);
547 addr = msm_bo->presumed >> 32;
548 if (reloc_hi->shift < 0)
549 addr >>= -reloc_hi->shift;
551 addr <<= reloc_hi->shift;
552 (*ring->cur++) = addr | r->orhi;
556 static uint32_t msm_ringbuffer_emit_reloc_ring(struct fd_ringbuffer *ring,
557 struct fd_ringbuffer *target, uint32_t cmd_idx,
558 uint32_t submit_offset, uint32_t size)
560 struct msm_cmd *cmd = NULL;
563 LIST_FOR_EACH_ENTRY(cmd, &to_msm_ringbuffer(target)->cmd_list, list) {
569 assert(cmd && (idx == cmd_idx));
571 if (idx < (to_msm_ringbuffer(target)->cmd_count - 1)) {
572 /* All but the last cmd buffer is fully "baked" (ie. already has
573 * done get_cmd() to add it to the cmds table). But in this case,
574 * the size we get is invalid (since it is calculated from the
579 struct fd_ringbuffer *parent = ring->parent ? ring->parent : ring;
580 get_cmd(parent, cmd, submit_offset, size, MSM_SUBMIT_CMD_IB_TARGET_BUF);
583 msm_ringbuffer_emit_reloc(ring, &(struct fd_reloc){
585 .flags = FD_RELOC_READ,
586 .offset = submit_offset,
589 /* Unlike traditional ringbuffers which are deleted as a set (after
590 * being flushed), mesa can't really guarantee that a stateobj isn't
591 * destroyed after emitted but before flush, so we must hold a ref:
593 if (target->flags & FD_RINGBUFFER_OBJECT) {
594 msm_ringbuffer_ref(target);
600 static uint32_t msm_ringbuffer_cmd_count(struct fd_ringbuffer *ring)
602 return to_msm_ringbuffer(ring)->cmd_count;
605 static void msm_ringbuffer_unref(struct fd_ringbuffer *ring)
607 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
609 if (!atomic_dec_and_test(&msm_ring->refcnt))
613 delete_cmds(msm_ring);
615 free(msm_ring->submit.cmds);
616 free(msm_ring->submit.bos);
618 free(msm_ring->cmds);
622 static void msm_ringbuffer_ref(struct fd_ringbuffer *ring)
624 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
625 atomic_inc(&msm_ring->refcnt);
628 static const struct fd_ringbuffer_funcs funcs = {
629 .hostptr = msm_ringbuffer_hostptr,
630 .flush = msm_ringbuffer_flush,
631 .grow = msm_ringbuffer_grow,
632 .reset = msm_ringbuffer_reset,
633 .emit_reloc = msm_ringbuffer_emit_reloc,
634 .emit_reloc_ring = msm_ringbuffer_emit_reloc_ring,
635 .cmd_count = msm_ringbuffer_cmd_count,
636 .destroy = msm_ringbuffer_unref,
639 drm_private struct fd_ringbuffer * msm_ringbuffer_new(struct fd_pipe *pipe,
640 uint32_t size, enum fd_ringbuffer_flags flags)
642 struct msm_ringbuffer *msm_ring;
643 struct fd_ringbuffer *ring;
645 msm_ring = calloc(1, sizeof(*msm_ring));
647 ERROR_MSG("allocation failed");
652 assert(pipe->dev->version >= FD_VERSION_UNLIMITED_CMDS);
654 msm_ring->is_growable = TRUE;
657 list_inithead(&msm_ring->cmd_list);
658 msm_ring->seqno = ++to_msm_device(pipe->dev)->ring_cnt;
659 atomic_set(&msm_ring->refcnt, 1);
661 ring = &msm_ring->base;
662 ring->funcs = &funcs;
664 ring->pipe = pipe; /* needed in ring_cmd_new() */
666 ring_cmd_new(ring, size);