STRUCT DRM_GPUVM_BO(9)

💖 struct drm_gpuvm_bo(9) — Kernel API Manual 💖

okay so this is the Kernel API Manual entry for struct drm_gpuvm_bo, and it's basically the situationship between a drm_gpuvm and a drm_gem_object. It's giving "indirection that makes everything faster," bestie. Let's get into it. 🦋✨

🌸 NAME 🌸

struct drm_gpuvm_bo — structure representing a &drm_gpuvm and &drm_gem_object combination. 💅

✨ SYNOPSIS ✨

       struct drm_gpuvm_bo {
           struct drm_gpuvm *vm;
           struct drm_gem_object *obj;
           bool evicted;
           struct kref kref;
           struct {
             struct list_head gpuva;
             struct {
               struct list_head gem;
               struct list_head extobj;
               struct list_head evict;
               struct llist_node bo_defer;
             } entry;
           } list;
        };

👑 Members 👑

• vm — the drm_gpuvm that obj is mapped in. It's a reference counted pointer, so handle with care, queen. 💖
• obj — the drm_gem_object being mapped in vm. Also a reference counted pointer. 🎀
• evicted — tells you whether the drm_gem_object is evicted; this field is protected by the drm_gem_object's dma-resv lock. No cap. 🔒
• kref — the reference count for this drm_gpuvm_bo. Keep track, bestie. 👑
• list — structure containing all list_heads.
• list.gpuva — the list of linked drm_gpuvas.

It is safe to access entries from this list as long as the GEM's gpuva lock is held. See also struct drm_gem_object. 🫶

• list.entry — structure containing all list_heads serving as entry.
  • list.entry.gem — list entry to attach to the gpuva list on the drm_gem_object.
  • list.entry.evict — list entry to attach to the drm_gpuvm's evict list.
  • list.entry.bo_defer — list entry to attach to the drm_gpuvm's bo_defer list.

💖 Description 💖

This structure is an abstraction representing a drm_gpuvm and drm_gem_object combination. It serves as an indirection to accelerate iterating all drm_gpuvas within a drm_gpuvm backed by the same drm_gem_object. Iconic behavior, honestly. ✨

Furthermore it is used to cache evicted GEM objects for a certain GPU-VM to accelerate validation. Lowkey a speedrun strat. 🔥

Typically, drivers want to create an instance of a struct drm_gpuvm_bo once a GEM object is mapped first in a GPU-VM and release the instance once the last mapping of the GEM object in this GPU-VM is unmapped. Periodt. 💅

🦋 SEE ALSO 🦋

Kernel file ./include/drm/drm_gpuvm.h is the main character here, and it's bringing the whole crew:

• enum drm_gpuva_flags(9)
• struct drm_gpuva(9)
• drm_gpuva_invalidate(9)
• drm_gpuva_invalidated(9)
• enum drm_gpuvm_flags(9)
• struct drm_gpuvm(9)
• drm_gpuvm_get(9)
• drm_gpuvm_resv_protected(9)
• drm_gpuvm_immediate_mode(9)
• drm_gpuvm_resv(9)
• drm_gpuvm_resv_obj(9)
• drm_gpuvm_is_extobj(9)
• drm_gpuvm_for_each_va_range(9)
• drm_gpuvm_for_each_va_range_safe(9)
• drm_gpuvm_for_each_va(9)
• drm_gpuvm_for_each_va_safe(9)
• struct drm_gpuvm_exec(9)
• drm_gpuvm_exec_unlock(9)
• drm_gpuvm_exec_resv_add_fence(9)
• drm_gpuvm_exec_validate(9)
• drm_gpuvm_bo_get(9)
• drm_gpuvm_bo_gem_evict(9)
• drm_gpuvm_bo_for_each_va(9)
• drm_gpuvm_bo_for_each_va_safe(9)
• enum drm_gpuva_op_type(9)
• struct drm_gpuva_op_map(9)
• struct drm_gpuva_op_unmap(9)
• struct drm_gpuva_op_remap(9)
• struct drm_gpuva_op_prefetch(9)
• struct drm_gpuva_op(9)
• struct drm_gpuva_ops(9)
• drm_gpuva_for_each_op(9)
• drm_gpuva_for_each_op_safe(9)
• drm_gpuva_for_each_op_from_reverse(9)
• drm_gpuva_for_each_op_reverse(9)
• drm_gpuva_first_op(9)
• drm_gpuva_last_op(9)
• drm_gpuva_prev_op(9)
• drm_gpuva_next_op(9)
• struct drm_gpuvm_map_req(9)
• struct drm_gpuvm_ops(9)
• drm_gpuva_op_remap_to_unmap_range(9)

okay that's the whole entire page, bestie — signed off from ./include/drm, October 2026, for struct drm_gpuvm_bo(9). 💜✨👑