From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id A9188CCF9EC for ; Wed, 25 Sep 2024 19:23:25 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 70CB810E2EF; Wed, 25 Sep 2024 19:23:25 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=intel.com header.i=@intel.com header.b="QsSuPSz/"; dkim-atps=neutral Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.15]) by gabe.freedesktop.org (Postfix) with ESMTPS id 39A8F10E2EF for ; Wed, 25 Sep 2024 19:23:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1727292204; x=1758828204; h=date:from:to:cc:subject:message-id:references: mime-version:content-transfer-encoding:in-reply-to; bh=df6ej2ylbJ5VPq5C1Mcflbq2cUvF8jCMCDij1jp2bS8=; b=QsSuPSz/0aNylzd7cgn/Du/t7PmFtGSIItpmcqhKozYpOxrOectzWqZ3 v7kOLFHFhbY5+ysaV/CWEnCeAypImdJtKQGbezulzQ/54yWk2EUHzfz84 o4LevgeuBG5a0oqMNpHcQmV25NeIbHbPsfOTGVFJeLETHXvdfVkWKWu6Y Opk5ihB9cm4MrWVmvp7sDbznePHYGICsuieEjr8WjYON9l1PnMOB5xch1 ywYWiaPcNvYGOLZEZ0S/zZQ6Jjp13HYMOIzPgy8IvMpbOSN4gc8u64Hw5 dlzbXEq5/MjiUmy9qghgtJUDubAOrC8h992kLm252kB4id6kSykNeZFkK A==; X-CSE-ConnectionGUID: NeklpF3rRleoe4GqkO32Bg== X-CSE-MsgGUID: liu40wLEQMiecEb4f0PE0w== X-IronPort-AV: E=McAfee;i="6700,10204,11206"; a="30072894" X-IronPort-AV: E=Sophos;i="6.10,258,1719903600"; d="scan'208";a="30072894" Received: from fmviesa008.fm.intel.com ([10.60.135.148]) by orvoesa107.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 25 Sep 2024 12:23:24 -0700 X-CSE-ConnectionGUID: 9boChqidQw2vDY1taWxZGw== X-CSE-MsgGUID: 4s9QTOxTSCapzuF0EMt1iQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.10,258,1719903600"; d="scan'208";a="72023297" Received: from stinkpipe.fi.intel.com (HELO stinkbox) ([10.237.72.74]) by fmviesa008.fm.intel.com with SMTP; 25 Sep 2024 12:23:19 -0700 Received: by stinkbox (sSMTP sendmail emulation); Wed, 25 Sep 2024 22:23:18 +0300 Date: Wed, 25 Sep 2024 22:23:18 +0300 From: Ville =?iso-8859-1?Q?Syrj=E4l=E4?= To: Christoph Manszewski Cc: igt-dev@lists.freedesktop.org, Zbigniew =?utf-8?Q?Kempczy=C5=84ski?= , Kamil Konieczny , Dominik Grzegorzek , Maciej Patelczyk , Dominik Karol =?utf-8?Q?Pi=C4=85tkowski?= , Pawel Sikora , Andrzej Hajda , Kolanupaka Naveena , Mika Kuoppala , Gwan-gyeong Mun , Jan Sokolowski , Mika Kuoppala Subject: Re: [PATCH i-g-t v7 09/16] drm-uapi/xe: Sync with eudebug uapi Message-ID: References: <20240918113017.144687-1-christoph.manszewski@intel.com> <20240918113017.144687-10-christoph.manszewski@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <20240918113017.144687-10-christoph.manszewski@intel.com> X-Patchwork-Hint: comment X-BeenThere: igt-dev@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development mailing list for IGT GPU Tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: igt-dev-bounces@lists.freedesktop.org Sender: "igt-dev" On Wed, Sep 18, 2024 at 01:30:10PM +0200, Christoph Manszewski wrote: > From: Dominik Grzegorzek > > Align with kernel commit 09411c6ecbef ("drm/xe/eudebug: Add debug > metadata support for xe_eudebug") from: > > https://gitlab.freedesktop.org/miku/kernel.git > > which introduces most recent changes to the eudebug uapi. > > Signed-off-by: Dominik Grzegorzek > Signed-off-by: Mika Kuoppala > Signed-off-by: Christoph Manszewski > Acked-by: Zbigniew Kempczyński > --- > include/drm-uapi/xe_drm_eudebug.h | 341 ++++++++++++++++++++++++++++++ I don't think non-upstream stuff should go here. This will now screw up anyone (namely me) attempting to do a bulk update the uapi headers. > 1 file changed, 341 insertions(+) > create mode 100644 include/drm-uapi/xe_drm_eudebug.h > > diff --git a/include/drm-uapi/xe_drm_eudebug.h b/include/drm-uapi/xe_drm_eudebug.h > new file mode 100644 > index 000000000..13c069e00 > --- /dev/null > +++ b/include/drm-uapi/xe_drm_eudebug.h > @@ -0,0 +1,341 @@ > +/* SPDX-License-Identifier: MIT */ > +/* > + * Copyright © 2023 Intel Corporation > + */ > + > +#ifndef _XE_DRM_EUDEBUG_H_ > +#define _XE_DRM_EUDEBUG_H_ > + > +#if defined(__cplusplus) > +extern "C" { > +#endif > + > +/* > + * The Xe EU debugger extends the uapi by both extending the api for the Xe device as well as > + * adding an api to use with a separate debugger handle. Currently the KMD part adds the former to > + * 'xe_drm.h' and the latter to 'xe_drm_eudebug.h'. Since the KMD part is not yet merged upstream, > + * let's put all eudebug specific uapi here to keep the 'xe_drm.h' file synced with the upstream > + * kernel. > + */ > + > +/* XXX: BEGIN section moved from xe_drm.h as temporary solution */ > +#define DRM_XE_EUDEBUG_CONNECT 0x0c > +#define DRM_XE_DEBUG_METADATA_CREATE 0x0d > +#define DRM_XE_DEBUG_METADATA_DESTROY 0x0e > + > +/* ... */ > + > +#define DRM_IOCTL_XE_EUDEBUG_CONNECT DRM_IOWR(DRM_COMMAND_BASE + DRM_XE_EUDEBUG_CONNECT, struct drm_xe_eudebug_connect) > +#define DRM_IOCTL_XE_DEBUG_METADATA_CREATE DRM_IOWR(DRM_COMMAND_BASE + DRM_XE_DEBUG_METADATA_CREATE, struct drm_xe_debug_metadata_create) > +#define DRM_IOCTL_XE_DEBUG_METADATA_DESTROY DRM_IOW(DRM_COMMAND_BASE + DRM_XE_DEBUG_METADATA_DESTROY, struct drm_xe_debug_metadata_destroy) > + > +/* ... */ > + > +struct drm_xe_vm_bind_op_ext_attach_debug { > + /** @base: base user extension */ > + struct drm_xe_user_extension base; > + > + /** @id: Debug object id from create metadata */ > + __u64 metadata_id; > + > + /** @flags: Flags */ > + __u64 flags; > + > + /** @cookie: Cookie */ > + __u64 cookie; > + > + /** @reserved: Reserved */ > + __u64 reserved; > +}; > + > +/* ... */ > + > +#define XE_VM_BIND_OP_EXTENSIONS_ATTACH_DEBUG 0 > + > +/* ... */ > + > +#define DRM_XE_EXEC_QUEUE_SET_PROPERTY_EUDEBUG 2 > +#define DRM_XE_EXEC_QUEUE_EUDEBUG_FLAG_ENABLE (1 << 0) > + > +/* ... */ > + > +/* > + * Debugger ABI (ioctl and events) Version History: > + * 0 - No debugger available > + * 1 - Initial version > + */ > +#define DRM_XE_EUDEBUG_VERSION 1 > + > +struct drm_xe_eudebug_connect { > + /** @extensions: Pointer to the first extension struct, if any */ > + __u64 extensions; > + > + __u64 pid; /* input: Target process ID */ > + __u32 flags; /* MBZ */ > + > + __u32 version; /* output: current ABI (ioctl / events) version */ > +}; > + > +/* > + * struct drm_xe_debug_metadata_create - Create debug metadata > + * > + * Add a region of user memory to be marked as debug metadata. > + * When the debugger attaches, the metadata regions will be delivered > + * for debugger. Debugger can then map these regions to help decode > + * the program state. > + * > + * Returns handle to created metadata entry. > + */ > +struct drm_xe_debug_metadata_create { > + /** @extensions: Pointer to the first extension struct, if any */ > + __u64 extensions; > + > +#define DRM_XE_DEBUG_METADATA_ELF_BINARY 0 > +#define DRM_XE_DEBUG_METADATA_PROGRAM_MODULE 1 > +#define WORK_IN_PROGRESS_DRM_XE_DEBUG_METADATA_MODULE_AREA 2 > +#define WORK_IN_PROGRESS_DRM_XE_DEBUG_METADATA_SBA_AREA 3 > +#define WORK_IN_PROGRESS_DRM_XE_DEBUG_METADATA_SIP_AREA 4 > +#define WORK_IN_PROGRESS_DRM_XE_DEBUG_METADATA_NUM (1 + \ > + WORK_IN_PROGRESS_DRM_XE_DEBUG_METADATA_SIP_AREA) > + > + /** @type: Type of metadata */ > + __u64 type; > + > + /** @user_addr: pointer to start of the metadata */ > + __u64 user_addr; > + > + /** @len: length, in bytes of the medata */ > + __u64 len; > + > + /** @metadata_id: created metadata handle (out) */ > + __u32 metadata_id; > +}; > + > +/** > + * struct drm_xe_debug_metadata_destroy - Destroy debug metadata > + * > + * Destroy debug metadata. > + */ > +struct drm_xe_debug_metadata_destroy { > + /** @extensions: Pointer to the first extension struct, if any */ > + __u64 extensions; > + > + /** @metadata_id: metadata handle to destroy */ > + __u32 metadata_id; > +}; > + > +/* XXX: END section moved from xe_drm.h as temporary solution */ > + > +/** > + * Do a eudebug event read for a debugger connection. > + * > + * This ioctl is available in debug version 1. > + */ > +#define DRM_XE_EUDEBUG_IOCTL_READ_EVENT _IO('j', 0x0) > +#define DRM_XE_EUDEBUG_IOCTL_EU_CONTROL _IOWR('j', 0x2, struct drm_xe_eudebug_eu_control) > +#define DRM_XE_EUDEBUG_IOCTL_ACK_EVENT _IOW('j', 0x4, struct drm_xe_eudebug_ack_event) > +#define DRM_XE_EUDEBUG_IOCTL_VM_OPEN _IOW('j', 0x1, struct drm_xe_eudebug_vm_open) > +#define DRM_XE_EUDEBUG_IOCTL_READ_METADATA _IOWR('j', 0x3, struct drm_xe_eudebug_read_metadata) > + > +/* XXX: Document events to match their internal counterparts when moved to xe_drm.h */ > +struct drm_xe_eudebug_event { > + __u32 len; > + > + __u16 type; > +#define DRM_XE_EUDEBUG_EVENT_NONE 0 > +#define DRM_XE_EUDEBUG_EVENT_READ 1 > +#define DRM_XE_EUDEBUG_EVENT_OPEN 2 > +#define DRM_XE_EUDEBUG_EVENT_VM 3 > +#define DRM_XE_EUDEBUG_EVENT_EXEC_QUEUE 4 > +#define DRM_XE_EUDEBUG_EVENT_EU_ATTENTION 5 > +#define DRM_XE_EUDEBUG_EVENT_VM_BIND 6 > +#define DRM_XE_EUDEBUG_EVENT_VM_BIND_OP 7 > +#define DRM_XE_EUDEBUG_EVENT_VM_BIND_UFENCE 8 > +#define DRM_XE_EUDEBUG_EVENT_METADATA 9 > +#define DRM_XE_EUDEBUG_EVENT_VM_BIND_OP_METADATA 10 > + > + __u16 flags; > +#define DRM_XE_EUDEBUG_EVENT_CREATE (1 << 0) > +#define DRM_XE_EUDEBUG_EVENT_DESTROY (1 << 1) > +#define DRM_XE_EUDEBUG_EVENT_STATE_CHANGE (1 << 2) > +#define DRM_XE_EUDEBUG_EVENT_NEED_ACK (1 << 3) > + > + __u64 seqno; > + __u64 reserved; > +}; > + > +struct drm_xe_eudebug_event_client { > + struct drm_xe_eudebug_event base; > + > + __u64 client_handle; /* This is unique per debug connection */ > +}; > + > +struct drm_xe_eudebug_event_vm { > + struct drm_xe_eudebug_event base; > + > + __u64 client_handle; > + __u64 vm_handle; > +}; > + > +struct drm_xe_eudebug_event_exec_queue { > + struct drm_xe_eudebug_event base; > + > + __u64 client_handle; > + __u64 vm_handle; > + __u64 exec_queue_handle; > + __u32 engine_class; > + __u32 width; > + __u64 lrc_handle[]; > +}; > + > +struct drm_xe_eudebug_event_eu_attention { > + struct drm_xe_eudebug_event base; > + > + __u64 client_handle; > + __u64 exec_queue_handle; > + __u64 lrc_handle; > + __u32 flags; > + __u32 bitmask_size; > + __u8 bitmask[]; > +}; > + > +struct drm_xe_eudebug_eu_control { > + __u64 client_handle; > + > +#define DRM_XE_EUDEBUG_EU_CONTROL_CMD_INTERRUPT_ALL 0 > +#define DRM_XE_EUDEBUG_EU_CONTROL_CMD_STOPPED 1 > +#define DRM_XE_EUDEBUG_EU_CONTROL_CMD_RESUME 2 > + __u32 cmd; > + __u32 flags; > + > + __u64 seqno; > + > + __u64 exec_queue_handle; > + __u64 lrc_handle; > + __u32 reserved; > + __u32 bitmask_size; > + __u64 bitmask_ptr; > +}; > + > +/* > + * When client (debuggee) does vm_bind_ioctl() following event > + * sequence will be created (for the debugger): > + * > + * ┌───────────────────────┐ > + * │ EVENT_VM_BIND ├───────┬─┬─┐ > + * └───────────────────────┘ │ │ │ > + * ┌───────────────────────┐ │ │ │ > + * │ EVENT_VM_BIND_OP #1 ├───┘ │ │ > + * └───────────────────────┘ │ │ > + * ... │ │ > + * ┌───────────────────────┐ │ │ > + * │ EVENT_VM_BIND_OP #n ├─────┘ │ > + * └───────────────────────┘ │ > + * │ > + * ┌───────────────────────┐ │ > + * │ EVENT_UFENCE ├───────┘ > + * └───────────────────────┘ > + * > + * All the events below VM_BIND will reference the VM_BIND > + * they associate with, by field .vm_bind_ref_seqno. > + * event_ufence will only be included if the client did > + * attach sync of type UFENCE into its vm_bind_ioctl(). > + * > + * When EVENT_UFENCE is sent by the driver, all the OPs of > + * the original VM_BIND are completed and the [addr,range] > + * contained in them are present and modifiable through the > + * vm accessors. Accessing [addr, range] before related ufence > + * event will lead to undefined results as the actual bind > + * operations are async and the backing storage might not > + * be there on a moment of receiving the event. > + * > + * Client's UFENCE sync will be held by the driver: client's > + * drm_xe_wait_ufence will not complete and the value of the ufence > + * won't appear until ufence is acked by the debugger process calling > + * DRM_XE_EUDEBUG_IOCTL_ACK_EVENT with the event_ufence.base.seqno. > + * This will signal the fence, .value will update and the wait will > + * complete allowing the client to continue. > + * > + */ > + > +struct drm_xe_eudebug_event_vm_bind { > + struct drm_xe_eudebug_event base; > + > + __u64 client_handle; > + __u64 vm_handle; > + > + __u32 flags; > +#define DRM_XE_EUDEBUG_EVENT_VM_BIND_FLAG_UFENCE (1 << 0) > + > + __u32 num_binds; > +}; > + > +struct drm_xe_eudebug_event_vm_bind_op { > + struct drm_xe_eudebug_event base; > + __u64 vm_bind_ref_seqno; /* *_event_vm_bind.base.seqno */ > + __u64 num_extensions; > + > + __u64 addr; /* XXX: Zero for unmap all? */ > + __u64 range; /* XXX: Zero for unmap all? */ > +}; > + > +struct drm_xe_eudebug_event_vm_bind_ufence { > + struct drm_xe_eudebug_event base; > + __u64 vm_bind_ref_seqno; /* *_event_vm_bind.base.seqno */ > +}; > + > +struct drm_xe_eudebug_ack_event { > + __u32 type; > + __u32 flags; /* MBZ */ > + __u64 seqno; > +}; > + > +struct drm_xe_eudebug_vm_open { > + /** @extensions: Pointer to the first extension struct, if any */ > + __u64 extensions; > + > + /** @client_handle: id of client */ > + __u64 client_handle; > + > + /** @vm_handle: id of vm */ > + __u64 vm_handle; > + > + /** @flags: flags */ > + __u64 flags; > + > + /** @timeout_ns: Timeout value in nanoseconds operations (fsync) */ > + __u64 timeout_ns; > +}; > + > +struct drm_xe_eudebug_read_metadata { > + __u64 client_handle; > + __u64 metadata_handle; > + __u32 flags; > + __u32 reserved; > + __u64 ptr; > + __u64 size; > +}; > + > +struct drm_xe_eudebug_event_metadata { > + struct drm_xe_eudebug_event base; > + > + __u64 client_handle; > + __u64 metadata_handle; > + /* XXX: Refer to xe_drm.h for fields */ > + __u64 type; > + __u64 len; > +}; > + > +struct drm_xe_eudebug_event_vm_bind_op_metadata { > + struct drm_xe_eudebug_event base; > + __u64 vm_bind_op_ref_seqno; /* *_event_vm_bind_op.base.seqno */ > + > + __u64 metadata_handle; > + __u64 metadata_cookie; > +}; > + > +#if defined(__cplusplus) > +} > +#endif > + > +#endif > -- > 2.34.1 -- Ville Syrjälä Intel