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 "xf86atomic.h"
33 #include "freedreno_ringbuffer.h"
36 /* represents a single cmd buffer in the submit ioctl. Each cmd buffer has
37 * a backing bo, and a reloc table.
40 struct list_head list;
42 struct fd_ringbuffer *ring;
43 struct fd_bo *ring_bo;
46 DECLARE_ARRAY(struct drm_msm_gem_submit_reloc, 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 DECLARE_ARRAY(struct drm_msm_gem_submit_bo, bos);
64 DECLARE_ARRAY(struct drm_msm_gem_submit_cmd, cmds);
67 /* should have matching entries in submit.bos: */
68 /* Note, only in parent ringbuffer */
69 DECLARE_ARRAY(struct fd_bo *, bos);
71 /* should have matching entries in submit.cmds: */
72 DECLARE_ARRAY(struct msm_cmd *, cmds);
74 /* List of physical cmdstream buffers (msm_cmd) assocated with this
75 * logical fd_ringbuffer.
77 * Note that this is different from msm_ringbuffer::cmds (which
78 * shadows msm_ringbuffer::submit::cmds for tracking submit ioctl
79 * related stuff, and *only* is tracked in the parent ringbuffer.
80 * And only has "completed" cmd buffers (ie. we already know the
81 * size) added via get_cmd().
83 struct list_head cmd_list;
90 /* maps fd_bo to idx: */
94 static inline struct msm_ringbuffer * to_msm_ringbuffer(struct fd_ringbuffer *x)
96 return (struct msm_ringbuffer *)x;
99 #define INIT_SIZE 0x1000
101 static pthread_mutex_t idx_lock = PTHREAD_MUTEX_INITIALIZER;
103 static void ring_cmd_del(struct msm_cmd *cmd)
105 fd_bo_del(cmd->ring_bo);
106 list_del(&cmd->list);
107 to_msm_ringbuffer(cmd->ring)->cmd_count--;
112 static struct msm_cmd * ring_cmd_new(struct fd_ringbuffer *ring, uint32_t size)
114 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
115 struct msm_cmd *cmd = calloc(1, sizeof(*cmd));
121 cmd->ring_bo = fd_bo_new_ring(ring->pipe->dev, size, 0);
125 list_addtail(&cmd->list, &msm_ring->cmd_list);
126 msm_ring->cmd_count++;
135 static struct msm_cmd *current_cmd(struct fd_ringbuffer *ring)
137 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
138 assert(!LIST_IS_EMPTY(&msm_ring->cmd_list));
139 return LIST_LAST_ENTRY(&msm_ring->cmd_list, struct msm_cmd, list);
142 static uint32_t append_bo(struct fd_ringbuffer *ring, struct fd_bo *bo)
144 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
147 idx = APPEND(&msm_ring->submit, bos);
148 idx = APPEND(msm_ring, bos);
150 msm_ring->submit.bos[idx].flags = 0;
151 msm_ring->submit.bos[idx].handle = bo->handle;
152 msm_ring->submit.bos[idx].presumed = to_msm_bo(bo)->presumed;
154 msm_ring->bos[idx] = fd_bo_ref(bo);
159 /* add (if needed) bo, return idx: */
160 static uint32_t bo2idx(struct fd_ringbuffer *ring, struct fd_bo *bo, uint32_t flags)
162 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
163 struct msm_bo *msm_bo = to_msm_bo(bo);
165 pthread_mutex_lock(&idx_lock);
166 if (msm_bo->current_ring_seqno == msm_ring->seqno) {
171 if (!msm_ring->bo_table)
172 msm_ring->bo_table = drmHashCreate();
174 if (!drmHashLookup(msm_ring->bo_table, bo->handle, &val)) {
176 idx = (uint32_t)(uintptr_t)val;
178 idx = append_bo(ring, bo);
179 val = (void *)(uintptr_t)idx;
180 drmHashInsert(msm_ring->bo_table, bo->handle, val);
182 msm_bo->current_ring_seqno = msm_ring->seqno;
185 pthread_mutex_unlock(&idx_lock);
186 if (flags & FD_RELOC_READ)
187 msm_ring->submit.bos[idx].flags |= MSM_SUBMIT_BO_READ;
188 if (flags & FD_RELOC_WRITE)
189 msm_ring->submit.bos[idx].flags |= MSM_SUBMIT_BO_WRITE;
193 static int check_cmd_bo(struct fd_ringbuffer *ring,
194 struct drm_msm_gem_submit_cmd *cmd, struct fd_bo *bo)
196 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
197 return msm_ring->submit.bos[cmd->submit_idx].handle == bo->handle;
200 /* Ensure that submit has corresponding entry in cmds table for the
201 * target cmdstream buffer:
203 * Returns TRUE if new cmd added (else FALSE if it was already in
206 static int get_cmd(struct fd_ringbuffer *ring, struct msm_cmd *target_cmd,
207 uint32_t submit_offset, uint32_t size, uint32_t type)
209 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
210 struct drm_msm_gem_submit_cmd *cmd;
213 /* figure out if we already have a cmd buf: */
214 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
215 cmd = &msm_ring->submit.cmds[i];
216 if ((cmd->submit_offset == submit_offset) &&
217 (cmd->size == size) &&
218 (cmd->type == type) &&
219 check_cmd_bo(ring, cmd, target_cmd->ring_bo))
223 /* create cmd buf if not: */
224 i = APPEND(&msm_ring->submit, cmds);
225 APPEND(msm_ring, cmds);
226 msm_ring->cmds[i] = target_cmd;
227 cmd = &msm_ring->submit.cmds[i];
229 cmd->submit_idx = bo2idx(ring, target_cmd->ring_bo, FD_RELOC_READ);
230 cmd->submit_offset = submit_offset;
234 target_cmd->size = size;
239 static void * msm_ringbuffer_hostptr(struct fd_ringbuffer *ring)
241 return fd_bo_map(current_cmd(ring)->ring_bo);
244 static uint32_t find_next_reloc_idx(struct msm_cmd *msm_cmd,
245 uint32_t start, uint32_t offset)
249 /* a binary search would be more clever.. */
250 for (i = start; i < msm_cmd->nr_relocs; i++) {
251 struct drm_msm_gem_submit_reloc *reloc = &msm_cmd->relocs[i];
252 if (reloc->submit_offset >= offset)
259 static void delete_cmds(struct msm_ringbuffer *msm_ring)
261 struct msm_cmd *cmd, *tmp;
263 LIST_FOR_EACH_ENTRY_SAFE(cmd, tmp, &msm_ring->cmd_list, list) {
268 static void flush_reset(struct fd_ringbuffer *ring)
270 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
273 for (i = 0; i < msm_ring->nr_bos; i++) {
274 struct msm_bo *msm_bo = to_msm_bo(msm_ring->bos[i]);
277 msm_bo->current_ring_seqno = 0;
278 fd_bo_del(&msm_bo->base);
281 /* for each of the cmd buffers, clear their reloc's: */
282 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
283 struct msm_cmd *target_cmd = msm_ring->cmds[i];
286 target_cmd->nr_relocs = 0;
289 msm_ring->submit.nr_cmds = 0;
290 msm_ring->submit.nr_bos = 0;
291 msm_ring->nr_cmds = 0;
292 msm_ring->nr_bos = 0;
294 if (msm_ring->bo_table) {
295 drmHashDestroy(msm_ring->bo_table);
296 msm_ring->bo_table = NULL;
299 if (msm_ring->is_growable) {
300 delete_cmds(msm_ring);
302 /* in old mode, just reset the # of relocs: */
303 current_cmd(ring)->nr_relocs = 0;
307 static void finalize_current_cmd(struct fd_ringbuffer *ring, uint32_t *last_start)
309 uint32_t submit_offset, size, type;
310 struct fd_ringbuffer *parent;
313 parent = ring->parent;
314 type = MSM_SUBMIT_CMD_IB_TARGET_BUF;
317 type = MSM_SUBMIT_CMD_BUF;
320 submit_offset = offset_bytes(last_start, ring->start);
321 size = offset_bytes(ring->cur, last_start);
323 get_cmd(parent, current_cmd(ring), submit_offset, size, type);
326 static void dump_submit(struct msm_ringbuffer *msm_ring)
330 for (i = 0; i < msm_ring->submit.nr_bos; i++) {
331 struct drm_msm_gem_submit_bo *bo = &msm_ring->submit.bos[i];
332 ERROR_MSG(" bos[%d]: handle=%u, flags=%x", i, bo->handle, bo->flags);
334 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
335 struct drm_msm_gem_submit_cmd *cmd = &msm_ring->submit.cmds[i];
336 struct drm_msm_gem_submit_reloc *relocs = U642VOID(cmd->relocs);
337 ERROR_MSG(" cmd[%d]: type=%u, submit_idx=%u, submit_offset=%u, size=%u",
338 i, cmd->type, cmd->submit_idx, cmd->submit_offset, cmd->size);
339 for (j = 0; j < cmd->nr_relocs; j++) {
340 struct drm_msm_gem_submit_reloc *r = &relocs[j];
341 ERROR_MSG(" reloc[%d]: submit_offset=%u, or=%08x, shift=%d, reloc_idx=%u"
342 ", reloc_offset=%"PRIu64, j, r->submit_offset, r->or, r->shift,
343 r->reloc_idx, r->reloc_offset);
348 static struct drm_msm_gem_submit_reloc *
349 handle_stateobj_relocs(struct fd_ringbuffer *parent, struct fd_ringbuffer *stateobj,
350 struct drm_msm_gem_submit_reloc *orig_relocs, unsigned nr_relocs)
352 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(stateobj);
353 struct drm_msm_gem_submit_reloc *relocs = malloc(nr_relocs * sizeof(*relocs));
356 for (i = 0; i < nr_relocs; i++) {
357 unsigned idx = orig_relocs[i].reloc_idx;
358 struct fd_bo *bo = msm_ring->bos[idx];
361 if (msm_ring->submit.bos[idx].flags & MSM_SUBMIT_BO_READ)
362 flags |= FD_RELOC_READ;
363 if (msm_ring->submit.bos[idx].flags & MSM_SUBMIT_BO_WRITE)
364 flags |= FD_RELOC_WRITE;
366 relocs[i] = orig_relocs[i];
367 relocs[i].reloc_idx = bo2idx(parent, bo, flags);
373 static int msm_ringbuffer_flush(struct fd_ringbuffer *ring, uint32_t *last_start,
374 int in_fence_fd, int *out_fence_fd)
376 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
377 struct drm_msm_gem_submit req = {
378 .flags = to_msm_pipe(ring->pipe)->pipe,
379 .queueid = to_msm_pipe(ring->pipe)->queue_id,
384 assert(!ring->parent);
386 if (in_fence_fd != -1) {
387 req.flags |= MSM_SUBMIT_FENCE_FD_IN | MSM_SUBMIT_NO_IMPLICIT;
388 req.fence_fd = in_fence_fd;
392 req.flags |= MSM_SUBMIT_FENCE_FD_OUT;
395 finalize_current_cmd(ring, last_start);
397 /* for each of the cmd's fix up their reloc's: */
398 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
399 struct drm_msm_gem_submit_cmd *cmd = &msm_ring->submit.cmds[i];
400 struct msm_cmd *msm_cmd = msm_ring->cmds[i];
401 uint32_t a = find_next_reloc_idx(msm_cmd, 0, cmd->submit_offset);
402 uint32_t b = find_next_reloc_idx(msm_cmd, a, cmd->submit_offset + cmd->size);
403 struct drm_msm_gem_submit_reloc *relocs = &msm_cmd->relocs[a];
404 unsigned nr_relocs = (b > a) ? b - a : 0;
406 /* for reusable stateobjs, the reloc table has reloc_idx that
407 * points into it's own private bos table, rather than the global
408 * bos table used for the submit, so we need to add the stateobj's
409 * bos to the global table and construct new relocs table with
410 * corresponding reloc_idx
412 if (msm_cmd->ring->flags & FD_RINGBUFFER_OBJECT) {
413 relocs = handle_stateobj_relocs(ring, msm_cmd->ring,
417 cmd->relocs = VOID2U64(relocs);
418 cmd->nr_relocs = nr_relocs;
421 /* needs to be after get_cmd() as that could create bos/cmds table: */
422 req.bos = VOID2U64(msm_ring->submit.bos),
423 req.nr_bos = msm_ring->submit.nr_bos;
424 req.cmds = VOID2U64(msm_ring->submit.cmds),
425 req.nr_cmds = msm_ring->submit.nr_cmds;
427 DEBUG_MSG("nr_cmds=%u, nr_bos=%u", req.nr_cmds, req.nr_bos);
429 ret = drmCommandWriteRead(ring->pipe->dev->fd, DRM_MSM_GEM_SUBMIT,
432 ERROR_MSG("submit failed: %d (%s)", ret, strerror(errno));
433 dump_submit(msm_ring);
435 /* update timestamp on all rings associated with submit: */
436 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
437 struct msm_cmd *msm_cmd = msm_ring->cmds[i];
438 msm_cmd->ring->last_timestamp = req.fence;
442 *out_fence_fd = req.fence_fd;
446 /* free dynamically constructed stateobj relocs tables: */
447 for (i = 0; i < msm_ring->submit.nr_cmds; i++) {
448 struct drm_msm_gem_submit_cmd *cmd = &msm_ring->submit.cmds[i];
449 struct msm_cmd *msm_cmd = msm_ring->cmds[i];
450 if (msm_cmd->ring->flags & FD_RINGBUFFER_OBJECT) {
451 /* we could have dropped last reference: */
452 msm_ring->cmds[i] = NULL;
453 fd_ringbuffer_del(msm_cmd->ring);
454 free(U642VOID(cmd->relocs));
463 static void msm_ringbuffer_grow(struct fd_ringbuffer *ring, uint32_t size)
465 assert(to_msm_ringbuffer(ring)->is_growable);
466 finalize_current_cmd(ring, ring->last_start);
467 ring_cmd_new(ring, size);
470 static void msm_ringbuffer_reset(struct fd_ringbuffer *ring)
475 static void msm_ringbuffer_emit_reloc(struct fd_ringbuffer *ring,
476 const struct fd_reloc *r)
478 struct fd_ringbuffer *parent = ring->parent ? ring->parent : ring;
479 struct msm_bo *msm_bo = to_msm_bo(r->bo);
480 struct drm_msm_gem_submit_reloc *reloc;
481 struct msm_cmd *cmd = current_cmd(ring);
482 uint32_t idx = APPEND(cmd, relocs);
485 reloc = &cmd->relocs[idx];
487 reloc->reloc_idx = bo2idx(parent, r->bo, r->flags);
488 reloc->reloc_offset = r->offset;
490 reloc->shift = r->shift;
491 reloc->submit_offset = offset_bytes(ring->cur, ring->start);
493 addr = msm_bo->presumed;
494 if (reloc->shift < 0)
495 addr >>= -reloc->shift;
497 addr <<= reloc->shift;
498 (*ring->cur++) = addr | r->or;
500 if (ring->pipe->gpu_id >= 500) {
501 struct drm_msm_gem_submit_reloc *reloc_hi;
503 /* NOTE: grab reloc_idx *before* APPEND() since that could
504 * realloc() meaning that 'reloc' ptr is no longer valid:
506 uint32_t reloc_idx = reloc->reloc_idx;
508 idx = APPEND(cmd, relocs);
510 reloc_hi = &cmd->relocs[idx];
512 reloc_hi->reloc_idx = reloc_idx;
513 reloc_hi->reloc_offset = r->offset;
514 reloc_hi->or = r->orhi;
515 reloc_hi->shift = r->shift - 32;
516 reloc_hi->submit_offset = offset_bytes(ring->cur, ring->start);
518 addr = msm_bo->presumed >> 32;
519 if (reloc_hi->shift < 0)
520 addr >>= -reloc_hi->shift;
522 addr <<= reloc_hi->shift;
523 (*ring->cur++) = addr | r->orhi;
527 static uint32_t msm_ringbuffer_emit_reloc_ring(struct fd_ringbuffer *ring,
528 struct fd_ringbuffer *target, uint32_t cmd_idx,
529 uint32_t submit_offset, uint32_t size)
531 struct msm_cmd *cmd = NULL;
533 int added_cmd = FALSE;
535 LIST_FOR_EACH_ENTRY(cmd, &to_msm_ringbuffer(target)->cmd_list, list) {
541 assert(cmd && (idx == cmd_idx));
543 if (idx < (to_msm_ringbuffer(target)->cmd_count - 1)) {
544 /* All but the last cmd buffer is fully "baked" (ie. already has
545 * done get_cmd() to add it to the cmds table). But in this case,
546 * the size we get is invalid (since it is calculated from the
551 struct fd_ringbuffer *parent = ring->parent ? ring->parent : ring;
552 added_cmd = get_cmd(parent, cmd, submit_offset, size,
553 MSM_SUBMIT_CMD_IB_TARGET_BUF);
556 msm_ringbuffer_emit_reloc(ring, &(struct fd_reloc){
558 .flags = FD_RELOC_READ,
559 .offset = submit_offset,
562 /* Unlike traditional ringbuffers which are deleted as a set (after
563 * being flushed), mesa can't really guarantee that a stateobj isn't
564 * destroyed after emitted but before flush, so we must hold a ref:
566 if (added_cmd && (target->flags & FD_RINGBUFFER_OBJECT)) {
567 fd_ringbuffer_ref(target);
573 static uint32_t msm_ringbuffer_cmd_count(struct fd_ringbuffer *ring)
575 return to_msm_ringbuffer(ring)->cmd_count;
578 static void msm_ringbuffer_destroy(struct fd_ringbuffer *ring)
580 struct msm_ringbuffer *msm_ring = to_msm_ringbuffer(ring);
583 delete_cmds(msm_ring);
585 free(msm_ring->submit.cmds);
586 free(msm_ring->submit.bos);
588 free(msm_ring->cmds);
592 static const struct fd_ringbuffer_funcs funcs = {
593 .hostptr = msm_ringbuffer_hostptr,
594 .flush = msm_ringbuffer_flush,
595 .grow = msm_ringbuffer_grow,
596 .reset = msm_ringbuffer_reset,
597 .emit_reloc = msm_ringbuffer_emit_reloc,
598 .emit_reloc_ring = msm_ringbuffer_emit_reloc_ring,
599 .cmd_count = msm_ringbuffer_cmd_count,
600 .destroy = msm_ringbuffer_destroy,
603 drm_private struct fd_ringbuffer * msm_ringbuffer_new(struct fd_pipe *pipe,
604 uint32_t size, enum fd_ringbuffer_flags flags)
606 struct msm_ringbuffer *msm_ring;
607 struct fd_ringbuffer *ring;
609 msm_ring = calloc(1, sizeof(*msm_ring));
611 ERROR_MSG("allocation failed");
616 assert(pipe->dev->version >= FD_VERSION_UNLIMITED_CMDS);
618 msm_ring->is_growable = TRUE;
621 list_inithead(&msm_ring->cmd_list);
622 msm_ring->seqno = ++to_msm_device(pipe->dev)->ring_cnt;
624 ring = &msm_ring->base;
625 atomic_set(&ring->refcnt, 1);
627 ring->funcs = &funcs;
629 ring->pipe = pipe; /* needed in ring_cmd_new() */
631 ring_cmd_new(ring, size);