[Intel-xe] [PATCH v2 1/6] drm/xe/uapi: Add support for cache and coherency mode
Souza, Jose
jose.souza at intel.com
Mon Sep 25 18:26:42 UTC 2023
On Mon, 2023-09-25 at 09:06 +0100, Matthew Auld wrote:
> On 21/09/2023 21:07, Souza, Jose wrote:
> > On Thu, 2023-09-14 at 16:31 +0100, Matthew Auld wrote:
> > > From: Pallavi Mishra <pallavi.mishra at intel.com>
> > >
> > > Allow userspace to specify the CPU caching mode to use for system memory
> > > in addition to coherency modes during object creation. Modify gem create
> > > handler and introduce xe_bo_create_user to replace xe_bo_create. In a
> > > later patch we will support setting the pat_index as part of vm_bind,
> > > where expectation is that the coherency mode extracted from the
> > > pat_index must match the one set at object creation.
> > >
> > > v2
> > > - s/smem_caching/smem_cpu_caching/ and
> > > s/XE_GEM_CACHING/XE_GEM_CPU_CACHING/. (Matt Roper)
> > > - Drop COH_2WAY and just use COH_NONE + COH_AT_LEAST_1WAY; KMD mostly
> > > just cares that zeroing/swap-in can't be bypassed with the given
> > > smem_caching mode. (Matt Roper)
> > > - Fix broken range check for coh_mode and smem_cpu_caching and also
> > > don't use constant value, but the already defined macros. (José)
> > > - Prefer switch statement for smem_cpu_caching -> ttm_caching. (José)
> > > - Add note in kernel-doc for dgpu and coherency modes for system
> > > memory. (José)
> > >
> > > Signed-off-by: Pallavi Mishra <pallavi.mishra at intel.com>
> > > Co-authored-by: Matthew Auld <matthew.auld at intel.com>
> > > Signed-off-by: Matthew Auld <matthew.auld at intel.com>
> > > Cc: Thomas Hellström <thomas.hellstrom at linux.intel.com>
> > > Cc: Joonas Lahtinen <joonas.lahtinen at linux.intel.com>
> > > Cc: Lucas De Marchi <lucas.demarchi at intel.com>
> > > Cc: Matt Roper <matthew.d.roper at intel.com>
> > > Cc: José Roberto de Souza <jose.souza at intel.com>
> > > Cc: Filip Hazubski <filip.hazubski at intel.com>
> > > Cc: Carl Zhang <carl.zhang at intel.com>
> > > Cc: Effie Yu <effie.yu at intel.com>
> > > ---
> > > drivers/gpu/drm/xe/xe_bo.c | 105 ++++++++++++++++++++++++++-----
> > > drivers/gpu/drm/xe/xe_bo.h | 3 +-
> > > drivers/gpu/drm/xe/xe_bo_types.h | 10 +++
> > > drivers/gpu/drm/xe/xe_dma_buf.c | 5 +-
> > > include/uapi/drm/xe_drm.h | 57 ++++++++++++++++-
> > > 5 files changed, 158 insertions(+), 22 deletions(-)
> > >
> > > diff --git a/drivers/gpu/drm/xe/xe_bo.c b/drivers/gpu/drm/xe/xe_bo.c
> > > index 27726d4f3423..f3facd788f15 100644
> > > --- a/drivers/gpu/drm/xe/xe_bo.c
> > > +++ b/drivers/gpu/drm/xe/xe_bo.c
> > > @@ -325,7 +325,7 @@ static struct ttm_tt *xe_ttm_tt_create(struct ttm_buffer_object *ttm_bo,
> > > struct xe_device *xe = xe_bo_device(bo);
> > > struct xe_ttm_tt *tt;
> > > unsigned long extra_pages;
> > > - enum ttm_caching caching = ttm_cached;
> > > + enum ttm_caching caching;
> > > int err;
> > >
> > > tt = kzalloc(sizeof(*tt), GFP_KERNEL);
> > > @@ -339,13 +339,25 @@ static struct ttm_tt *xe_ttm_tt_create(struct ttm_buffer_object *ttm_bo,
> > > extra_pages = DIV_ROUND_UP(xe_device_ccs_bytes(xe, bo->size),
> > > PAGE_SIZE);
> > >
> > > + switch (bo->smem_cpu_caching) {
> > > + case XE_GEM_CPU_CACHING_WC:
> > > + caching = ttm_write_combined;
> > > + break;
> > > + case XE_GEM_CPU_CACHING_UC:
> > > + caching = ttm_uncached;
> > > + break;
> > > + default:
> > > + caching = ttm_cached;
> > > + break;
> > > + }
> > > +
> > > /*
> > > * Display scanout is always non-coherent with the CPU cache.
> > > *
> > > * For Xe_LPG and beyond, PPGTT PTE lookups are also non-coherent and
> > > * require a CPU:WC mapping.
> > > */
> > > - if (bo->flags & XE_BO_SCANOUT_BIT ||
> > > + if ((!bo->smem_cpu_caching && bo->flags & XE_BO_SCANOUT_BIT) ||
> > > (xe->info.graphics_verx100 >= 1270 && bo->flags & XE_BO_PAGETABLE))
> > > caching = ttm_write_combined;
> > >
> > > @@ -1184,9 +1196,10 @@ void xe_bo_free(struct xe_bo *bo)
> > > kfree(bo);
> > > }
> > >
> > > -struct xe_bo *__xe_bo_create_locked(struct xe_device *xe, struct xe_bo *bo,
> > > +struct xe_bo *___xe_bo_create_locked(struct xe_device *xe, struct xe_bo *bo,
> > > struct xe_tile *tile, struct dma_resv *resv,
> > > struct ttm_lru_bulk_move *bulk, size_t size,
> > > + u16 smem_cpu_caching, u16 coh_mode,
> > > enum ttm_bo_type type, u32 flags)
> > > {
> > > struct ttm_operation_ctx ctx = {
> > > @@ -1224,6 +1237,8 @@ struct xe_bo *__xe_bo_create_locked(struct xe_device *xe, struct xe_bo *bo,
> > > bo->tile = tile;
> > > bo->size = size;
> > > bo->flags = flags;
> > > + bo->smem_cpu_caching = smem_cpu_caching;
> > > + bo->coh_mode = coh_mode;
> > > bo->ttm.base.funcs = &xe_gem_object_funcs;
> > > bo->props.preferred_mem_class = XE_BO_PROPS_INVALID;
> > > bo->props.preferred_gt = XE_BO_PROPS_INVALID;
> > > @@ -1307,10 +1322,11 @@ static int __xe_bo_fixed_placement(struct xe_device *xe,
> > > }
> > >
> > > struct xe_bo *
> > > -xe_bo_create_locked_range(struct xe_device *xe,
> > > - struct xe_tile *tile, struct xe_vm *vm,
> > > - size_t size, u64 start, u64 end,
> > > - enum ttm_bo_type type, u32 flags)
> > > +__xe_bo_create_locked(struct xe_device *xe,
> > > + struct xe_tile *tile, struct xe_vm *vm,
> > > + size_t size, u64 start, u64 end,
> > > + u16 smem_cpu_caching, u16 coh_mode,
> > > + enum ttm_bo_type type, u32 flags)
> > > {
> > > struct xe_bo *bo = NULL;
> > > int err;
> > > @@ -1331,10 +1347,11 @@ xe_bo_create_locked_range(struct xe_device *xe,
> > > }
> > > }
> > >
> > > - bo = __xe_bo_create_locked(xe, bo, tile, vm ? &vm->resv : NULL,
> > > + bo = ___xe_bo_create_locked(xe, bo, tile, vm ? &vm->resv : NULL,
> > > vm && !xe_vm_in_fault_mode(vm) &&
> > > flags & XE_BO_CREATE_USER_BIT ?
> > > &vm->lru_bulk_move : NULL, size,
> > > + smem_cpu_caching, coh_mode,
> > > type, flags);
> > > if (IS_ERR(bo))
> > > return bo;
> > > @@ -1368,11 +1385,35 @@ xe_bo_create_locked_range(struct xe_device *xe,
> > > return ERR_PTR(err);
> > > }
> > >
> > > +struct xe_bo *
> > > +xe_bo_create_locked_range(struct xe_device *xe,
> > > + struct xe_tile *tile, struct xe_vm *vm,
> > > + size_t size, u64 start, u64 end,
> > > + enum ttm_bo_type type, u32 flags)
> > > +{
> > > + return __xe_bo_create_locked(xe, tile, vm, size, 0, ~0ULL, 0, 0, type, flags);
> > > +}
> > > +
> > > struct xe_bo *xe_bo_create_locked(struct xe_device *xe, struct xe_tile *tile,
> > > struct xe_vm *vm, size_t size,
> > > enum ttm_bo_type type, u32 flags)
> > > {
> > > - return xe_bo_create_locked_range(xe, tile, vm, size, 0, ~0ULL, type, flags);
> > > + return __xe_bo_create_locked(xe, tile, vm, size, 0, ~0ULL, 0, 0, type, flags);
> > > +}
> > > +
> > > +static struct xe_bo *xe_bo_create_user(struct xe_device *xe, struct xe_tile *tile,
> > > + struct xe_vm *vm, size_t size,
> > > + u16 smem_cpu_caching, u16 coh_mode,
> > > + enum ttm_bo_type type,
> > > + u32 flags)
> > > +{
> > > + struct xe_bo *bo = __xe_bo_create_locked(xe, tile, vm, size, 0, ~0ULL,
> > > + smem_cpu_caching, coh_mode, type,
> > > + flags | XE_BO_CREATE_USER_BIT);
> > > + if (!IS_ERR(bo))
> > > + xe_bo_unlock_vm_held(bo);
> > > +
> > > + return bo;
> > > }
> > >
> > > struct xe_bo *xe_bo_create(struct xe_device *xe, struct xe_tile *tile,
> > > @@ -1755,11 +1796,11 @@ int xe_gem_create_ioctl(struct drm_device *dev, void *data,
> > > struct drm_xe_gem_create *args = data;
> > > struct xe_vm *vm = NULL;
> > > struct xe_bo *bo;
> > > - unsigned int bo_flags = XE_BO_CREATE_USER_BIT;
> > > + unsigned int bo_flags;
> > > u32 handle;
> > > int err;
> > >
> > > - if (XE_IOCTL_DBG(xe, args->extensions) || XE_IOCTL_DBG(xe, args->pad) ||
> > > + if (XE_IOCTL_DBG(xe, args->extensions) ||
> > > XE_IOCTL_DBG(xe, args->reserved[0] || args->reserved[1]))
> > > return -EINVAL;
> > >
> > > @@ -1801,6 +1842,32 @@ int xe_gem_create_ioctl(struct drm_device *dev, void *data,
> > > bo_flags |= XE_BO_NEEDS_CPU_ACCESS;
> > > }
> > >
> > > + if (XE_IOCTL_DBG(xe, args->coh_mode > XE_GEM_COH_AT_LEAST_1WAY))
> > > + return -EINVAL;
> > > +
> > > + if (XE_IOCTL_DBG(xe, args->smem_cpu_caching > XE_GEM_CPU_CACHING_UC))
> > > + return -EINVAL;
> > > +
> > > + if (bo_flags & XE_BO_CREATE_SYSTEM_BIT) {
> > > + if (XE_IOCTL_DBG(xe, !args->coh_mode))
> > > + return -EINVAL;
> > > +
> > > + if (XE_IOCTL_DBG(xe, !args->smem_cpu_caching))
> > > + return -EINVAL;
> > > +
> > > + if (XE_IOCTL_DBG(xe, !IS_DGFX(xe) &&
> > > + bo_flags & XE_BO_SCANOUT_BIT &&
> > > + args->smem_cpu_caching == XE_GEM_CPU_CACHING_WB))
> > > + return -EINVAL;
> > > +
> > > + if (args->coh_mode == XE_GEM_COH_NONE) {
> > > + if (XE_IOCTL_DBG(xe, args->smem_cpu_caching == XE_GEM_CPU_CACHING_WB))
> > > + return -EINVAL;
> > > + }
> > > + } else if (XE_IOCTL_DBG(xe, args->smem_cpu_caching)) {
> >
> > should be XE_IOCTL_DBG(xe, !args->smem_cpu_caching).
> >
> > uAPI don't say anything about allow smem_cpu_caching or coh_mode == 0, did this to be able to run tests without display in DG2:
>
> The above check is for VRAM-only objects. For smem_cpu_caching the
> kernel-doc says: "MUST be left as zero for VRAM-only objects."
> Internally the KMD uses WC for CPU mapping VRAM which is out of the
> control of userspace.
In my opinion this should be != 0 and match with the PAT index that will be set in VM bind.
Have not read much but I believe a CXL GPU memory would be mapped as WB to take advantage of CXL caching protocols.
So I believe the kernel doc restrictions should be removed and run time check for a (smem_cpu_caching != WC && is_dgfx()) return -EINVAL;
A question related to that, so a bo placed in lmem + smem can have a WB caching in DG2? How would that work? So far Mesa was handling that case as WC
as well.
>
> coh_mode == 0 is not meant to be allowed, but looks like I missed the
> check here for VRAM-only. Will fix.
>
> >
> >
> > diff --git a/drivers/gpu/drm/xe/xe_bo.c b/drivers/gpu/drm/xe/xe_bo.c
> > index f3facd788f152..e0e4fefcd2060 100644
> > --- a/drivers/gpu/drm/xe/xe_bo.c
> > +++ b/drivers/gpu/drm/xe/xe_bo.c
> > @@ -1796,7 +1796,7 @@ int xe_gem_create_ioctl(struct drm_device *dev, void *data,
> > struct drm_xe_gem_create *args = data;
> > struct xe_vm *vm = NULL;
> > struct xe_bo *bo;
> > - unsigned int bo_flags;
> > + unsigned int bo_flags = 0;
> > u32 handle;
> > int err;
> >
> > @@ -1842,19 +1842,15 @@ int xe_gem_create_ioctl(struct drm_device *dev, void *data,
> > bo_flags |= XE_BO_NEEDS_CPU_ACCESS;
> > }
> >
> > - if (XE_IOCTL_DBG(xe, args->coh_mode > XE_GEM_COH_AT_LEAST_1WAY))
> > + if (XE_IOCTL_DBG(xe, args->coh_mode > XE_GEM_COH_AT_LEAST_1WAY) ||
> > + XE_IOCTL_DBG(xe, !args->coh_mode))
> > return -EINVAL;
> >
> > - if (XE_IOCTL_DBG(xe, args->smem_cpu_caching > XE_GEM_CPU_CACHING_UC))
> > + if (XE_IOCTL_DBG(xe, args->smem_cpu_caching > XE_GEM_CPU_CACHING_UC) ||
> > + XE_IOCTL_DBG(xe, !args->smem_cpu_caching))
> > return -EINVAL;
> >
> > if (bo_flags & XE_BO_CREATE_SYSTEM_BIT) {
> > - if (XE_IOCTL_DBG(xe, !args->coh_mode))
> > - return -EINVAL;
> > -
> > - if (XE_IOCTL_DBG(xe, !args->smem_cpu_caching))
> > - return -EINVAL;
> > -
> > if (XE_IOCTL_DBG(xe, !IS_DGFX(xe) &&
> > bo_flags & XE_BO_SCANOUT_BIT &&
> > args->smem_cpu_caching == XE_GEM_CPU_CACHING_WB))
> > @@ -1864,8 +1860,6 @@ int xe_gem_create_ioctl(struct drm_device *dev, void *data,
> > if (XE_IOCTL_DBG(xe, args->smem_cpu_caching == XE_GEM_CPU_CACHING_WB))
> > return -EINVAL;
> > }
> > - } else if (XE_IOCTL_DBG(xe, args->smem_cpu_caching)) {
> > - return -EINVAL;
> > }
> >
> > if (args->vm_id) {
> >
> >
> > > + return -EINVAL;
> > > + }
> > > +
> > > if (args->vm_id) {
> > > vm = xe_vm_lookup(xef, args->vm_id);
> > > if (XE_IOCTL_DBG(xe, !vm))
> > > @@ -1812,8 +1879,10 @@ int xe_gem_create_ioctl(struct drm_device *dev, void *data,
> > > }
> > > }
> > >
> > > - bo = xe_bo_create(xe, NULL, vm, args->size, ttm_bo_type_device,
> > > - bo_flags);
> > > + bo = xe_bo_create_user(xe, NULL, vm, args->size,
> > > + args->smem_cpu_caching, args->coh_mode,
> > > + ttm_bo_type_device,
> > > + bo_flags);
> > > if (IS_ERR(bo)) {
> > > err = PTR_ERR(bo);
> > > goto out_vm;
> > > @@ -2105,10 +2174,12 @@ int xe_bo_dumb_create(struct drm_file *file_priv,
> > > args->size = ALIGN(mul_u32_u32(args->pitch, args->height),
> > > page_size);
> > >
> > > - bo = xe_bo_create(xe, NULL, NULL, args->size, ttm_bo_type_device,
> > > - XE_BO_CREATE_VRAM_IF_DGFX(xe_device_get_root_tile(xe)) |
> > > - XE_BO_CREATE_USER_BIT | XE_BO_SCANOUT_BIT |
> > > - XE_BO_NEEDS_CPU_ACCESS);
> > > + bo = xe_bo_create_user(xe, NULL, NULL, args->size,
> > > + XE_GEM_CPU_CACHING_WC, XE_GEM_COH_NONE,
> > > + ttm_bo_type_device,
> > > + XE_BO_CREATE_VRAM_IF_DGFX(xe_device_get_root_tile(xe)) |
> > > + XE_BO_CREATE_USER_BIT | XE_BO_SCANOUT_BIT |
> > > + XE_BO_NEEDS_CPU_ACCESS);
> > > if (IS_ERR(bo))
> > > return PTR_ERR(bo);
> > >
> > > diff --git a/drivers/gpu/drm/xe/xe_bo.h b/drivers/gpu/drm/xe/xe_bo.h
> > > index 4a68d869b3b5..4a0ee81fe598 100644
> > > --- a/drivers/gpu/drm/xe/xe_bo.h
> > > +++ b/drivers/gpu/drm/xe/xe_bo.h
> > > @@ -81,9 +81,10 @@ struct sg_table;
> > > struct xe_bo *xe_bo_alloc(void);
> > > void xe_bo_free(struct xe_bo *bo);
> > >
> > > -struct xe_bo *__xe_bo_create_locked(struct xe_device *xe, struct xe_bo *bo,
> > > +struct xe_bo *___xe_bo_create_locked(struct xe_device *xe, struct xe_bo *bo,
> > > struct xe_tile *tile, struct dma_resv *resv,
> > > struct ttm_lru_bulk_move *bulk, size_t size,
> > > + u16 smem_cpu_caching, u16 coh_mode,
> > > enum ttm_bo_type type, u32 flags);
> > > struct xe_bo *
> > > xe_bo_create_locked_range(struct xe_device *xe,
> > > diff --git a/drivers/gpu/drm/xe/xe_bo_types.h b/drivers/gpu/drm/xe/xe_bo_types.h
> > > index 2ea9ad423170..9bee220a6872 100644
> > > --- a/drivers/gpu/drm/xe/xe_bo_types.h
> > > +++ b/drivers/gpu/drm/xe/xe_bo_types.h
> > > @@ -68,6 +68,16 @@ struct xe_bo {
> > > struct llist_node freed;
> > > /** @created: Whether the bo has passed initial creation */
> > > bool created;
> > > + /**
> > > + * @coh_mode: Coherency setting. Currently only used for userspace
> > > + * objects.
> > > + */
> > > + u16 coh_mode;
> > > + /**
> > > + * @smem_cpu_caching: Caching mode for smem. Currently only used for
> > > + * userspace objects.
> > > + */
> > > + u16 smem_cpu_caching;
> > > };
> > >
> > > #define intel_bo_to_drm_bo(bo) (&(bo)->ttm.base)
> > > diff --git a/drivers/gpu/drm/xe/xe_dma_buf.c b/drivers/gpu/drm/xe/xe_dma_buf.c
> > > index 09343b8b3e96..ac20dbc27a2b 100644
> > > --- a/drivers/gpu/drm/xe/xe_dma_buf.c
> > > +++ b/drivers/gpu/drm/xe/xe_dma_buf.c
> > > @@ -200,8 +200,9 @@ xe_dma_buf_init_obj(struct drm_device *dev, struct xe_bo *storage,
> > > int ret;
> > >
> > > dma_resv_lock(resv, NULL);
> > > - bo = __xe_bo_create_locked(xe, storage, NULL, resv, NULL, dma_buf->size,
> > > - ttm_bo_type_sg, XE_BO_CREATE_SYSTEM_BIT);
> > > + bo = ___xe_bo_create_locked(xe, storage, NULL, resv, NULL, dma_buf->size,
> > > + 0, 0, /* Will require 1way or 2way for vm_bind */
> > > + ttm_bo_type_sg, XE_BO_CREATE_SYSTEM_BIT);
> > > if (IS_ERR(bo)) {
> > > ret = PTR_ERR(bo);
> > > goto error;
> > > diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> > > index 00d5cb4ef85e..737bb1d4c6f7 100644
> > > --- a/include/uapi/drm/xe_drm.h
> > > +++ b/include/uapi/drm/xe_drm.h
> > > @@ -456,8 +456,61 @@ struct drm_xe_gem_create {
> > > */
> > > __u32 handle;
> > >
> > > - /** @pad: MBZ */
> > > - __u32 pad;
> > > + /**
> > > + * @coh_mode: The coherency mode for this object. This will limit the
> > > + * possible @smem_caching values.
> > > + *
> > > + * Supported values:
> > > + *
> > > + * XE_GEM_COH_NONE: GPU access is assumed to be not coherent with
> > > + * CPU. CPU caches are not snooped.
> > > + *
> > > + * XE_GEM_COH_AT_LEAST_1WAY:
> > > + *
> > > + * CPU-GPU coherency must be at least 1WAY.
> > > + *
> > > + * If 1WAY then GPU access is coherent with CPU (CPU caches are snooped)
> > > + * until GPU acquires. The acquire by the GPU is not tracked by CPU
> > > + * caches.
> > > + *
> > > + * If 2WAY then should be fully coherent between GPU and CPU. Fully
> > > + * tracked by CPU caches. Both CPU and GPU caches are snooped.
> > > + *
> > > + * Note: On dgpu the GPU device never caches system memory (outside of
> > > + * the special system-memory-read-only cache, which is anyway flushed by
> > > + * KMD when nuking TLBs for a given object so should be no concern to
> > > + * userspace). The device should be thought of as always 1WAY coherent,
> > > + * with the addition that the GPU never caches system memory. At least
> > > + * on current dgpu HW there is no way to turn off snooping so likely the
> > > + * different coherency modes of the pat_index make no difference for
> > > + * system memory.
> > > + */
> > > +#define XE_GEM_COH_NONE 1
> > > +#define XE_GEM_COH_AT_LEAST_1WAY 2
> > > + __u16 coh_mode;
> > > +
> > > + /**
> > > + * @smem_cpu_caching: The CPU caching mode to select for system memory.
> > > + *
> > > + * Supported values:
> > > + *
> > > + * XE_GEM_CPU_CACHING_WB: Allocate the pages with write-back caching.
> > > + * On iGPU this can't be used for scanout surfaces. The @coh_mode must
> > > + * be XE_GEM_COH_AT_LEAST_1WAY.
> > > + *
> > > + * XE_GEM_CPU_CACHING_WC: Allocate the pages as write-combined. This is
> > > + * uncached. Any @coh_mode is permitted. Scanout surfaces should likely
> > > + * use this.
> > > + *
> > > + * XE_GEM_CPU_CACHING_UC: Allocate the pages as uncached. Any @coh_mode
> > > + * is permitted. Scanout surfaces are permitted to use this.
> > > + *
> > > + * MUST be left as zero for VRAM-only objects.
> > > + */
> > > +#define XE_GEM_CPU_CACHING_WB 1
> > > +#define XE_GEM_CPU_CACHING_WC 2
> > > +#define XE_GEM_CPU_CACHING_UC 3
> > > + __u16 smem_cpu_caching;
> > >
> > > /** @reserved: Reserved */
> > > __u64 reserved[2];
> >
More information about the Intel-xe
mailing list