drm_exec.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0 OR MIT */
 
#ifndef __DRM_EXEC_H__
#define __DRM_EXEC_H__
 
#include <linux/compiler.h>
#include <linux/ww_mutex.h>
 
#define DRM_EXEC_INTERRUPTIBLE_WAIT BIT(0)
#define DRM_EXEC_IGNORE_DUPLICATES  BIT(1)
 
/*
 * Dummy value used to initially enter the retry loop.
 * internal use only.
 */
#define DRM_EXEC_DUMMY ((void *)~0)
 
struct drm_gem_object;
 
struct drm_exec {
    u32                     flags;
 
    struct ww_acquire_ctx   ticket;
 
    unsigned int        num_objects;
 
    unsigned int        max_objects;
 
    struct drm_gem_object   **objects;
 
    struct drm_gem_object   *contended;
 
    struct drm_gem_object *prelocked;
};
 
static inline struct drm_gem_object *
drm_exec_obj(struct drm_exec *exec, unsigned long index)
{
    return index < exec->num_objects ? exec->objects[index] : NULL;
}
 
/* Helper for drm_exec_for_each_locked_object(). Internal use only. */
#define __drm_exec_for_each_locked_object(exec, obj, __index)       \
    for (unsigned long __index = 0; ((obj) = drm_exec_obj(exec, __index)); ++__index)
#define drm_exec_for_each_locked_object(exec, obj)          \
    __drm_exec_for_each_locked_object(exec, obj, __UNIQUE_ID(drm_exec))
 
/* Helper for drm_exec_for_each_locked_object_reverse(). Internal use only. */
#define __drm_exec_for_each_locked_object_reverse(exec, obj, __index)   \
    for (unsigned long __index = (exec)->num_objects - 1;       \
         ((obj) = drm_exec_obj(exec, __index)); --__index)
#define drm_exec_for_each_locked_object_reverse(exec, obj)      \
    __drm_exec_for_each_locked_object_reverse(exec, obj, __UNIQUE_ID(drm_exec))
 
#define drm_exec_until_all_locked(exec)                 \
    for (bool const __maybe_unused __drm_exec_loop = false;     \
         drm_exec_cleanup(exec);)                   \
        if (false) {                        \
drm_exec_retry: __maybe_unused;                     \
            continue;                   \
        } else
 
#define drm_exec_retry_on_contention(exec)          \
    do {                            \
        if (unlikely(drm_exec_is_contended(exec)))  \
            goto drm_exec_retry;            \
    } while (__drm_exec_loop)
 
static inline bool drm_exec_is_contended(struct drm_exec *exec)
{
    return !!exec->contended;
}
 
#define drm_exec_retry(_exec)                   \
    do {                            \
        WARN_ON((_exec)->contended != DRM_EXEC_DUMMY);  \
        goto drm_exec_retry;                \
    } while (__drm_exec_loop)
 
static inline struct ww_acquire_ctx *drm_exec_ticket(struct drm_exec *exec)
{
    return &exec->ticket;
}
 
void drm_exec_init(struct drm_exec *exec, u32 flags, unsigned nr);
void drm_exec_fini(struct drm_exec *exec);
bool drm_exec_cleanup(struct drm_exec *exec);
int drm_exec_lock_obj(struct drm_exec *exec, struct drm_gem_object *obj);
void drm_exec_unlock_obj(struct drm_exec *exec, struct drm_gem_object *obj);
int drm_exec_prepare_obj(struct drm_exec *exec, struct drm_gem_object *obj,
             unsigned int num_fences);
int drm_exec_prepare_array(struct drm_exec *exec,
               struct drm_gem_object **objects,
               unsigned int num_objects,
               unsigned int num_fences);
 
#endif