Constants

XE_MULTI_QUEUE_PRIORITY_LOW

Priority low

XE_MULTI_QUEUE_PRIORITY_NORMAL

Priority normal

XE_MULTI_QUEUE_PRIORITY_HIGH

Priority high

Definition:

struct xe_exec_queue_group {    struct xe_exec_queue *primary;    struct xe_bo *cgp_bo;    struct xarray xa;    struct list_head list;    struct mutex list_lock;    bool sync_pending;    bool banned;    bool stopped;};

Members

primary

Primary queue of this group

cgp_bo

BO for the Context Group Page

xa

xarray to store LRCs

list

List of all secondary queues in the group

list_lock

Secondary queue list lock

sync_pending

CGP_SYNC_DONE g2h response pending

banned

Group banned

stopped

Group is stopped, protected by list_lock

Definition:

struct xe_exec_queue {    struct xe_file *xef;    struct xe_gt *gt;    struct xe_hw_engine *hwe;    struct kref refcount;    struct xe_vm *vm;    struct xe_vm *user_vm;    enum xe_engine_class class;    u32 logical_mask;    char name[MAX_FENCE_NAME_LEN];    u16 width;    u16 msix_vec;    struct xe_hw_fence_irq *fence_irq;    struct dma_fence *last_fence;#define EXEC_QUEUE_FLAG_KERNEL                  BIT(0);#define EXEC_QUEUE_FLAG_PERMANENT               BIT(1);#define EXEC_QUEUE_FLAG_VM                      BIT(2);#define EXEC_QUEUE_FLAG_BIND_ENGINE_CHILD       BIT(3);#define EXEC_QUEUE_FLAG_HIGH_PRIORITY           BIT(4);#define EXEC_QUEUE_FLAG_LOW_LATENCY             BIT(5);#define EXEC_QUEUE_FLAG_MIGRATE                 BIT(6);    unsigned long flags;    union {        struct list_head multi_gt_list;        struct list_head multi_gt_link;    };    union {        struct xe_execlist_exec_queue *execlist;        struct xe_guc_exec_queue *guc;    };    struct {        struct xe_exec_queue_group *group;        struct list_head link;        enum xe_multi_queue_priority priority;        spinlock_t lock;        u8 pos;        u8 valid:1;        u8 is_primary:1;    } multi_queue;    struct {        u32 timeslice_us;        u32 preempt_timeout_us;        u32 job_timeout_ms;        enum xe_exec_queue_priority priority;    } sched_props;    struct {        struct dma_fence *pfence;        u64 context;        u32 seqno;        struct list_head link;    } lr;#define XE_EXEC_QUEUE_TLB_INVAL_PRIMARY_GT      0;#define XE_EXEC_QUEUE_TLB_INVAL_MEDIA_GT        1;#define XE_EXEC_QUEUE_TLB_INVAL_COUNT           (XE_EXEC_QUEUE_TLB_INVAL_MEDIA_GT  + 1);    struct {        struct xe_dep_scheduler *dep_scheduler;        struct dma_fence *last_fence;    } tlb_inval[XE_EXEC_QUEUE_TLB_INVAL_COUNT];    struct list_head vm_exec_queue_link;    struct {        u8 type;        struct list_head link;    } pxp;    struct drm_syncobj *ufence_syncobj;    u64 ufence_timeline_value;    void *replay_state;    const struct xe_exec_queue_ops *ops;    const struct xe_ring_ops *ring_ops;    struct drm_sched_entity *entity;#define XE_MAX_JOB_COUNT_PER_EXEC_QUEUE 1000;    atomic_t job_cnt;    u64 tlb_flush_seqno;    struct list_head hw_engine_group_link;    struct xe_lrc *lrc[] ;};

Members

xef

Back pointer to xe file if this is user created exec queue

gt

GT structure this exec queue can submit to

hwe

A hardware of the same class. May (physical engine) or may not(virtual engine) be where jobs actual engine up running. Should neverreally be used for submissions.

refcount

ref count of this exec queue

vm

VM (address space) for this exec queue

user_vm

User VM (address space) for this exec queue (bind queuesonly)

class

class of this exec queue

logical_mask

logical mask of where job submitted to exec queue can run

name

name of this exec queue

width

width (number BB submitted per exec) of this exec queue

msix_vec

MSI-X vector (for platforms that support it)

fence_irq

fence IRQ used to signal job completion

last_fence

last fence for tlb invalidation, protected byvm->lock in write mode

flags

flags for this exec queue, should statically setup aside from banbit

{unnamed_union}

anonymous

multi_gt_list

list head for VM bind engines if multi-GT

multi_gt_link

link for VM bind engines if multi-GT

{unnamed_union}

anonymous

execlist

execlist backend specific state for exec queue

guc

GuC backend specific state for exec queue

multi_queue

Multi queue information

multi_queue.priority

Queue priority within the multi-queue group.It is protected bymulti_queue.lock.

sched_props

scheduling properties

lr

long-running exec queue state

tlb_inval

TLB invalidations exec queue state

tlb_inval.dep_scheduler

The TLB invalidationdependency scheduler

vm_exec_queue_link

Link to track exec queue within a VM’s list of exec queues.

pxp

PXP info tracking

ufence_syncobj

User fence syncobj

ufence_timeline_value

User fence timeline value

replay_state

GPU hang replay state

ops

submission backend exec queue operations

ring_ops

ring operations for this exec queue

entity

DRM sched entity for this exec queue (1 to 1 relationship)

job_cnt

number of drm jobs in this exec queue

tlb_flush_seqno

The seqno of the last rebind tlb flush performedProtected byvm’s resv. Unused ifvm == NULL.

hw_engine_group_link

link into exec queues in the same hw engine group

lrc

logical ring context for this exec queue

Definition:

struct xe_exec_queue_ops {    int (*init)(struct xe_exec_queue *q);    void (*kill)(struct xe_exec_queue *q);    void (*fini)(struct xe_exec_queue *q);    void (*destroy)(struct xe_exec_queue *q);    int (*set_priority)(struct xe_exec_queue *q, enum xe_exec_queue_priority priority);    int (*set_timeslice)(struct xe_exec_queue *q, u32 timeslice_us);    int (*set_preempt_timeout)(struct xe_exec_queue *q, u32 preempt_timeout_us);    int (*set_multi_queue_priority)(struct xe_exec_queue *q, enum xe_multi_queue_priority priority);    int (*suspend)(struct xe_exec_queue *q);    int (*suspend_wait)(struct xe_exec_queue *q);    void (*resume)(struct xe_exec_queue *q);    bool (*reset_status)(struct xe_exec_queue *q);    bool (*active)(struct xe_exec_queue *q);};

Members

init

Initialize exec queue for submission backend

kill

Kill inflight submissions for backend

fini

Undoes theinit() for submission backend

destroy

Destroy exec queue for submission backend. The backendfunction must callxe_exec_queue_fini() (which will in turn call thefini() backend function) to ensure the queue is properly cleaned up.

set_priority

Set priority for exec queue

set_timeslice

Set timeslice for exec queue

set_preempt_timeout

Set preemption timeout for exec queue

set_multi_queue_priority

Set multi queue priority

suspend

Suspend exec queue from executing, allowed to be calledmultiple times in a row before resume with the caveat thatsuspend_wait returns before calling suspend again.

suspend_wait

Wait for an exec queue to suspend executing, should becall after suspend. In dma-fencing path thus must return within areasonable amount of time. -ETIME return shall indicate an errorwaiting for suspend resulting in associated VM getting killed.-EAGAIN return indicates the wait should be tried again, if the waitis within a work item, the work item should be requeued as deadlockavoidance mechanism.

resume

Resume exec queue execution, exec queue must be in a suspendedstate and dma fence returned from most recent suspend call must besignalled when this function is called.

reset_status

check exec queue reset status

active

check exec queue is active

Parameters

structxe_exec_queue*q

The exec_queue

Return

True if the exec_queue is part of a queue group, false otherwise.

Parameters

structxe_exec_queue*q

The exec_queue

Return

True ifq is primary queue of a queue group, false otherwise.

Parameters

structxe_exec_queue*q

The exec_queue

Return

True ifq is secondary queue of a queue group, false otherwise.

Parameters

structxe_exec_queue*q

The exec_queue

Description

Ifq belongs to a multi queue group, then the primary queue of the group willbe returned. Otherwise,q will be returned.

Parameters

structxe_exec_queue*q

The exec_queue

Description

If an exec queue is not parallel and is idle, the suspend steps can beskipped in the submission backend immediatley signaling the suspend fence.Parallel queues cannot skip this step due to limitations in the submissionbackend.

Return

True if exec queue is idle and can skip suspend steps, Falseotherwise

Parameters

structxe_device*xe

Xe device.

structxe_tile*tile

tile which bind exec queue belongs to.

structxe_vm*user_vm

The user VM which this exec queue belongs to

u32flags

exec queue creation flags

u64extensions

exec queue creation extensions

Description

Normalize bind exec queue creation. Bind exec queue is tied to migration VMfor access to physical memory required for page table programming. On afaulting devices the reserved copy engine instance must be used to avoiddeadlocking (user binds cannot get stuck behind faults as kernel binds whichresolve faults depend on user binds). On non-faulting devices any copy enginecan be used.

Returns exec queue on success, ERR_PTR on failure

Parameters

structxe_exec_queue*q

The exec_queue.

Description

Retrieves the primary LRC for the exec queue. Note that this functionreturns only the first LRC instance, even when multiple parallel LRCsare configured.

Return

Pointer to LRC on success, error on failure

Parameters

structxe_exec_queue*q

The exec_queue

Return

True if the exec_queue is long-running, false otherwise.

Parameters

structxe_exec_queue*q

The exec_queue

Description

FIXME: Need to determine what to use as the short-livedtimeline lock for the exec_queues, so that the return valueof this function becomes more than just an advisorysnapshot in time. The timeline lock must protect theseqno from racing submissions on the same exec_queue.Typically vm->resv, but user-created timeline locks use the migrate vmand never grabs the migrate vm->resv so we have a race there.

Return

True if the exec_queue is idle, false otherwise.

Parameters

structxe_exec_queue*q

The exec queue

Description

Update the timestamp saved by HW for this exec queue and save run tickscalculated by using the delta from last update.

Parameters

structxe_exec_queue*q

The exec queue

Description

This function permanently stops all activity on an exec queue. If the queueis actively executing on the HW, it will be kicked off the engine; anypending jobs are discarded and all future submissions are rejected.This function is safe to call multiple times.

Parameters

structxe_exec_queue*q

The exec queue

structxe_vm*vm

The VM the engine does a bind or exec for

Parameters

structxe_exec_queue*q

The exec queue

Description

Only safe to be called fromxe_exec_queue_destroy().

Parameters

structxe_exec_queue*q

The exec queue

structxe_vm*vm

The VM the engine does a bind or exec for

Description

Get last fence, takes a ref

Return

last fence if not signaled, dma fence stub if signaled

Parameters

structxe_exec_queue*q

The exec queue

structxe_vm*vm

The VM the engine does a bind or exec for

Description

Get last fence, takes a ref. Only safe to be called in the context ofresuming the hw engine group’s long-running exec queue, when the groupsemaphore is held.

Return

last fence if not signaled, dma fence stub if signaled

Parameters

structxe_exec_queue*q

The exec queue

structxe_vm*vm

The VM the engine does a bind or exec for

structdma_fence*fence

The fence

Description

Set the last fence for the engine. Increases reference count for fence, whenclosing engine xe_exec_queue_last_fence_put should be called.

Parameters

structxe_exec_queue*q

The exec queue

structxe_vm*vm

The VM the engine does a bind for

unsignedinttype

Either primary or media GT

Parameters

structxe_exec_queue*q

The exec queue

unsignedinttype

Either primary or media GT

Description

Only safe to be called fromxe_exec_queue_destroy().

Parameters

structxe_exec_queue*q

The exec queue

structxe_vm*vm

The VM the engine does a bind for

unsignedinttype

Either primary or media GT

Description

Get last fence, takes a ref

Return

last fence if not signaled, dma fence stub if signaled

Parameters

structxe_exec_queue*q

The exec queue

structxe_vm*vm

The VM the engine does a bind for

structdma_fence*fence

The fence

unsignedinttype

Either primary or media GT

Description

Set the last fence for the tlb invalidation type on the queue. Increasesreference count for fence, when closing queuexe_exec_queue_tlb_inval_last_fence_put should be called.

Parameters

structxe_exec_queue*q

thexe_exec_queuestructinstance containing target LRCs

void*scratch

scratch buffer to be used as temporary storage

Return

zero on success, negative error code on failure