Re: [PATCH v36 2/4] drm/xe/uapi: Define drm_xe_vm_get_property

["Souza, Jose" <jose.souza@intel.com>]

On Fri, 2026-03-06 at 15:55 +0000, Jonathan Cavitt wrote:
> Add initial declarations for the drm_xe_vm_get_property ioctl.
> 
> v2:
> - Expand kernel docs for drm_xe_vm_get_property (Jianxun)
> 
> v3:
> - Remove address type external definitions (Jianxun)
> - Add fault type to xe_drm_fault struct (Jianxun)
> 
> v4:
> - Remove engine class and instance (Ivan)
> 
> v5:
> - Add declares for fault type, access type, and fault level (Matt
> Brost,
>   Ivan)
> 
> v6:
> - Fix inconsistent use of whitespace in defines
> 
> v7:
> - Rebase and refactor (jcavitt)
> 
> v8:
> - Rebase (jcavitt)
> 
> uAPI: https://github.com/intel/compute-runtime/pull/878
> Signed-off-by: Jonathan Cavitt <jonathan.cavitt@intel.com>
> Reviewed-by: Shuicheng Lin <shuicheng.lin@intel.com>
> Acked-by: Matthew Brost <matthew.brost@intel.com>
> Acked-by: Ivan Briano <ivan.briano@intel.com>
> Cc: Zhang Jianxun <jianxun.zhang@intel.com>
> Cc: Ivan Briano <ivan.briano@intel.com>
> Cc: Matthew Brost <matthew.brost@intel.com>
> ---
>  include/uapi/drm/xe_drm.h | 86
> +++++++++++++++++++++++++++++++++++++++
>  1 file changed, 86 insertions(+)
> 
> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> index b0264c32ceb2..be27e9c45333 100644
> --- a/include/uapi/drm/xe_drm.h
> +++ b/include/uapi/drm/xe_drm.h
> @@ -83,6 +83,7 @@ extern "C" {
>   *  - &DRM_IOCTL_XE_OBSERVATION
>   *  - &DRM_IOCTL_XE_MADVISE
>   *  - &DRM_IOCTL_XE_VM_QUERY_MEM_RANGE_ATTRS
> + *  - &DRM_IOCTL_XE_VM_GET_PROPERTY
>   */
>  
>  /*
> @@ -107,6 +108,7 @@ extern "C" {
>  #define DRM_XE_MADVISE			0x0c
>  #define DRM_XE_VM_QUERY_MEM_RANGE_ATTRS	0x0d
>  #define DRM_XE_EXEC_QUEUE_SET_PROPERTY	0x0e
> +#define DRM_XE_VM_GET_PROPERTY		0x0f
>  
>  /* Must be kept compact -- no holes */
>  
> @@ -125,6 +127,7 @@ extern "C" {
>  #define
> DRM_IOCTL_XE_MADVISE			DRM_IOW(DRM_COMMAND_BASE + DRM_XE_MADVISE, structdrm_xe_madvise)
>  #define
> DRM_IOCTL_XE_VM_QUERY_MEM_RANGE_ATTRS	DRM_IOWR(DRM_COMMAND_BASE + DRM_XE_VM_QUERY_MEM_RANGE_ATTRS,structdrm_xe_vm_query_mem_range_attr)
>  #define
> DRM_IOCTL_XE_EXEC_QUEUE_SET_PROPERTY	DRM_IOW(DRM_COMMAND_BASE + DRM_XE_EXEC_QUEUE_SET_PROPERTY,structdrm_xe_exec_queue_set_property)
> +#define
> DRM_IOCTL_XE_VM_GET_PROPERTY		DRM_IOWR(DRM_COMMAND_BASE + DRM_XE_VM_GET_PROPERTY,structdrm_xe_vm_get_property)

Was the option to use DRM_IOCTL_XE_DEVICE_QUERY discussed? We could add
a extension to pass the VM id and avoid add another uAPI.

>  
>  /**
>   * DOC: Xe IOCTL Extensions
> @@ -1249,6 +1252,89 @@ struct drm_xe_vm_bind {
>  	__u64 reserved[2];
>  };
>  
> +/** struct xe_vm_fault - Describes faults for
> %DRM_XE_VM_GET_PROPERTY_FAULTS */
> +struct xe_vm_fault {
> +	/** @address: Address of the fault */
> +	__u64 address;

Looks like the address returned is not in canonical format. Just to
make clear, please add it to the comment.

> +	/** @address_precision: Precision of faulted address */
> +	__u32 address_precision;
> +	/** @access_type: Type of address access that resulted in
> fault */
> +#define FAULT_ACCESS_TYPE_READ		0
> +#define FAULT_ACCESS_TYPE_WRITE		1
> +#define FAULT_ACCESS_TYPE_ATOMIC	2

I confirmed with Jonathan and this and access_type are not a bit mask.

> +	__u8 access_type;
> +	/** @fault_type: Type of fault reported */
> +#define FAULT_TYPE_NOT_PRESENT		0
> +#define FAULT_TYPE_WRITE_ACCESS		1
> +#define FAULT_TYPE_ATOMIC_ACCESS	2
> +	__u8 fault_type;
> +	/** @fault_level: fault level of the fault */
> +#define FAULT_LEVEL_PTE		0
> +#define FAULT_LEVEL_PDE		1
> +#define FAULT_LEVEL_PDP		2
> +#define FAULT_LEVEL_PML4	3
> +#define FAULT_LEVEL_PML5	4
> +	__u8 fault_level;
> +	/** @pad: MBZ */
> +	__u8 pad;
> +	/** @reserved: MBZ */
> +	__u64 reserved[4];
> +};
> +
> +/**
> + * struct drm_xe_vm_get_property - Input of
> &DRM_IOCTL_XE_VM_GET_PROPERTY
> + *
> + * The user provides a VM and a property to query among
> DRM_XE_VM_GET_PROPERTY_*,
> + * and sets the values in the vm_id and property members,
> respectively.  This
> + * determines both the VM to get the property of, as well as the
> property to
> + * report.
> + *
> + * If size is set to 0, the driver fills it with the required size
> for the
> + * requested property.  The user is expected here to allocate memory
> for the
> + * property structure and to provide a pointer to the allocated
> memory using the
> + * data member.  For some properties, this may be zero, in which
> case, the
> + * value of the property will be saved to the value member and size
> will remain
> + * zero on return.
> + *
> + * If size is not zero, then the IOCTL will attempt to copy the
> requested
> + * property into the data member.
> + *
> + * The IOCTL will return -ENOENT if the VM could not be identified
> from the
> + * provided VM ID, or -EINVAL if the IOCTL fails for any other
> reason, such as
> + * providing an invalid size for the given property or if the
> property data
> + * could not be copied to the memory allocated to the data member.
> + *
> + * The property member can be:
> + *  - %DRM_XE_VM_GET_PROPERTY_FAULTS
> + */
> +struct drm_xe_vm_get_property {
> +	/** @extensions: Pointer to the first extension struct, if
> any */
> +	__u64 extensions;
> +
> +	/** @vm_id: The ID of the VM to query the properties of */
> +	__u32 vm_id;
> +
> +#define DRM_XE_VM_GET_PROPERTY_FAULTS		0
> +	/** @property: property to get */
> +	__u32 property;
> +
> +	/** @size: Size to allocate for @data */
> +	__u32 size;
> +
> +	/** @pad: MBZ */
> +	__u32 pad;
> +
> +	union {
> +		/** @data: Pointer to user-defined array of flexible
> size and type */
> +		__u64 data;
> +		/** @value: Return value for scalar queries */
> +		__u64 value;
> +	};
> +
> +	/** @reserved: MBZ */
> +	__u64 reserved[3];
> +};
> +
>  /**
>   * struct drm_xe_exec_queue_create - Input of
> &DRM_IOCTL_XE_EXEC_QUEUE_CREATE
>   *