From patchwork Fri Jan 31 11:03:05 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Pierre-Eric Pelloux-Prayer X-Patchwork-Id: 861143 Received: from NAM10-DM6-obe.outbound.protection.outlook.com (mail-dm6nam10on2073.outbound.protection.outlook.com [40.107.93.73]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3A9391BEF79; Fri, 31 Jan 2025 11:06:02 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=fail smtp.client-ip=40.107.93.73 ARC-Seal: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738321564; cv=fail; b=qU647tvFV7sjCg3QCCMZlqyX3XkvH+hFTf6vHTIG4Vh1KR+Y6GSTkEbBrjjRgZBCmq/SU47z7VfEb2spscllAqciFDah783MiYIanPv02Xv6EzvYuryDvpe2Tb/jvPtFm4EhHLBpiXiwjYASVGKhWFvW3VFZxAibKE7tX16QUvM= ARC-Message-Signature: i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738321564; c=relaxed/simple; bh=zl8Q9rDW+YVAfKAAUl5Gdzm8js0hN7tUXjLqcg5bWfM=; h=From:To:CC:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=VsL48l/z46Ul1A/nIJppVq/Ei8bdylGebL/efXU1vs/ECqk7VT1jXOD/0pTouaVt8pJv6H1IqcRCG/GDEXf0zhiVPWnPkWO7RAyz9j+VwPzb0j5HFVxaf5xnBZ/pRrFMCcZgcNRsoTnalkMsk93blsA4zNvsTHFwrwyWwm7Xz/o= ARC-Authentication-Results: i=2; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=amd.com; spf=fail smtp.mailfrom=amd.com; dkim=pass (1024-bit key) header.d=amd.com header.i=@amd.com header.b=HZf9+cg6; arc=fail smtp.client-ip=40.107.93.73 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=amd.com Authentication-Results: smtp.subspace.kernel.org; spf=fail smtp.mailfrom=amd.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=amd.com header.i=@amd.com header.b="HZf9+cg6" ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=uDPzhwQky0U62Rl+1Z/wv4LROxQUeBkqutiPKxLy26ZLBI6wMYYssg3xUWTT7NzB1js9OCJUAE6EocNjomskCPWEbPPbq3in+beKvcpFWAnJkbYOAgBOgDxk26RyeSovEl1Oqac4fFfOl9MtDqgWHulGICDHF0b21Rh+40gW1tLhQt71nEn3L/G3j7cSxXUtYcp/fI6pSvBAoqgck118yS2yzAy4YOlPUDVBhMBAisyYXucIFGjiDSEgSYsr+1Sc+cA47Hx1VHQ96v6qBQyzu4rjhx2vVF3l58AQ1Mr9Gs0xPI5a2LrOqtyxtqjuQ8OQoRZTHmeuENjTI8qIYerh8A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=n6MDbT8v+gxmhoDMeriaMSYFjzzdTqJvYlcSWdv+Uy8=; b=smeGTNTZHWlr7u7y2hAUDbpojHTdL4RKq7wss20TsifrGHrbZMvoRvjMJw05e79y1IhPd6D8cNbUSZmsE7YBZceeYZEa1/itFERYBrDxWfv/2QZKU4bdewGhRKly0bWwtNfj1LkhFUgNfXMNgFVifZ4spGXJLSX54ICy2O9VT+cdfhiohRYZEoKs2GAE7tNEVHmgAfheN0IIHIj+7f06TxIZCOWAcnYVflrLQLhAbt46XYsUTyB2CLtrVLn8QHSzoIm6vtU/aEQqybqnsj7+GI7S58ehhnm2yFkWCiWWngNVI3UvhZ3GSwIo+sEqeap92oaTBTZ7uhwuBJXkz3/ajA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=gmail.com smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=n6MDbT8v+gxmhoDMeriaMSYFjzzdTqJvYlcSWdv+Uy8=; b=HZf9+cg64wGLpQXzYUNmREaZDjRDUjYrAK7g6pKf5P1GRZgwmAr3Kh5kMigN9LYuSg/tEM9qHQ09kS9cC3fqKDqLvQt2wQ7IXBwSGFKvXx0jc5fjbgkz+tkq5CREyzh8qkTHh3Kog8vW7fomYOIpv9i+rf6+S0H+ubCtVqzzxgY= Received: from MW3PR05CA0013.namprd05.prod.outlook.com (2603:10b6:303:2b::18) by PH7PR12MB9127.namprd12.prod.outlook.com (2603:10b6:510:2f6::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8398.21; Fri, 31 Jan 2025 11:06:00 +0000 Received: from CO1PEPF000044F1.namprd05.prod.outlook.com (2603:10b6:303:2b:cafe::83) by MW3PR05CA0013.outlook.office365.com (2603:10b6:303:2b::18) with Microsoft SMTP Server (version=TLS1_3, cipher=TLS_AES_256_GCM_SHA384) id 15.20.8398.18 via Frontend Transport; Fri, 31 Jan 2025 11:06:00 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C Received: from SATLEXMB04.amd.com (165.204.84.17) by CO1PEPF000044F1.mail.protection.outlook.com (10.167.241.71) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.8398.14 via Frontend Transport; Fri, 31 Jan 2025 11:05:59 +0000 Received: from patedamande.amd.com (10.180.168.240) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.39; Fri, 31 Jan 2025 05:05:54 -0600 From: Pierre-Eric Pelloux-Prayer To: David Airlie , Simona Vetter , "Maarten Lankhorst" , Maxime Ripard , Thomas Zimmermann , "Jonathan Corbet" , Luben Tuikov , Matthew Brost , Danilo Krummrich , "Philipp Stanner" , Sumit Semwal , =?utf-8?q?Christian_K=C3=B6nig?= CC: Pierre-Eric Pelloux-Prayer , "Lucas Stach" , =?utf-8?q?Ma=C3=ADra_Canal?= , , , , , Subject: [PATCH v7 7/7] drm/doc: document some tracepoints as uAPI Date: Fri, 31 Jan 2025 12:03:05 +0100 Message-ID: <20250131110328.706695-8-pierre-eric.pelloux-prayer@amd.com> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250131110328.706695-1-pierre-eric.pelloux-prayer@amd.com> References: <20250131110328.706695-1-pierre-eric.pelloux-prayer@amd.com> Precedence: bulk X-Mailing-List: linux-media@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-ClientProxiedBy: SATLEXMB03.amd.com (10.181.40.144) To SATLEXMB04.amd.com (10.181.40.145) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1PEPF000044F1:EE_|PH7PR12MB9127:EE_ X-MS-Office365-Filtering-Correlation-Id: 112b4828-5dfa-4ec4-7537-08dd41e73e85 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; ARA:13230040|1800799024|36860700013|7416014|376014|82310400026|921020; X-Microsoft-Antispam-Message-Info: =?utf-8?q?RLxKdSgi0PNyGfSg6g1C/qqfkP9pD8K?= =?utf-8?q?jaIDnI80MiTmHm4cbYBXtIKyvlZJCdLise5068d7pSG5UY4DhYbG1I7VEF5HxF7ou?= =?utf-8?q?Bc2a0Cyvrc7X5NmiilIMePB+77MQfxd65/XdXfwTEAcIG09UScIuTLNNuzWl2SRIe?= =?utf-8?q?hzm1J5zuEBgQlDUIkrDcB64Lh8l5bKOVeZM0kTk43XcgM1yZNI5vdNiUdgzEVz77X?= =?utf-8?q?miZKUj4tN/ZZB651FHTcRGBVNWgH8xnDH+81yAohZVzm+HJLevqThvccAoQ9Ak2Tv?= =?utf-8?q?kvWzPeBgR/xkRJZ3joPUtW1VPKsnsOOkbLuciwpFjMJuP26xVVoQ9GAfWAxMMUi85?= =?utf-8?q?MY/QdQg+cO8hKhl6/sKxfNlef6BcuAb7XJXv4K/fNcqzUyFWctT2mQtRpbST6grEG?= =?utf-8?q?amHUJNF0k0B2jA2nA3Ax3wYvNjoBJxLqxYfIOuNoDPLDSUDVriho6Hr59tUGZ+5xX?= =?utf-8?q?ZYUiy5hz98BrIQv/jsX9EE0sSdHTG0OUt9gDTRfjru3Xt91JTMRCuZ8Q0GM3vNgZG?= =?utf-8?q?OhD9IdHfNVFCt0O672afFcj0cA6RuRq/jEz9xyRLfEkjecyLEfYXltFQ12Zey/R2g?= =?utf-8?q?MpOeZUQoc3so/fiRLUrF+3AQRO8CFsnZN0cCVsax3+h9mCsB2XSagGsu/attleIQe?= =?utf-8?q?F1lVookLHyhzkVbDejGH5dpPGYOE7kOpDd0Ble4FSZnZjhPAIAt6lnM7dy/pEcVce?= =?utf-8?q?4cwkTDkuHZ8U41tnxmLYuem6skJtNve7FpjB5qhKW6Bp/Bsd/0Q0pdnfXOgEHkVjM?= =?utf-8?q?A0FOsp7nkv2QDtVMe1tQuxnWeeZ+G5wUAqLtx5xjyEGZ4HKbElxJUwGLblIvx9May?= =?utf-8?q?r9rMEEGXQUmtzacn37NRgUfjm58c9NiKoaAHVkugqDunn1Wp/f+uEFsEznRbOijc0?= =?utf-8?q?HZFhr04TGd6cZ7LgZXsAu56JVtSyi57LyxIPkc8kFfUaW9pE/s56HsNwr/FdX3Foa?= =?utf-8?q?U+uIyIiDhI6Pp3cESzY1C2Lf7qOQAdqSouyiLZpJKpnKDdPLOJO/XBSnr+Q8fMoxJ?= =?utf-8?q?6iwqokXQx9KNommBD++Q2VgIJUya1XZAcwoZniSxrSgaC1JEKAQVjYzHncL6P2nIT?= =?utf-8?q?sXORVxUfevyDnQFgRAOdiYFcmW+cXYrdqLyxH5t2wA9XDgS16PCpQoljhqR+0t3PC?= =?utf-8?q?IYMxofQlg4Q3ueaCf982NGqftGGPo14EGLjSqeyCmhDmpH5PCfl2zWO61PK2qqsaW?= =?utf-8?q?rIV8/0tCKvSIkfgglCsaVJB4JIS5EDqCufZyiJQI7gzsbeI0irI4VeyKWx8LmYpoO?= =?utf-8?q?BBmJB3r1PfV0yVGh8msRFjVZBCRJylYa/BYPv6HDAHFKPUgNZeQNSWm6An8dRXSGn?= =?utf-8?q?zPPcQ+RQGdMPsH3h/X1q9exR9J4TxkQyg2N8eFGj8iF/BIZlQQvGIGy1oW1yuz6WQ?= =?utf-8?q?LdxgBwA1xU4xAMqfLk3IE/KrycLZSNMq3Gl27K5D0V32s2cTNRauAoMPi/NVNIjlB?= =?utf-8?q?bR4UyS/AVK?= X-Forefront-Antispam-Report: CIP:165.204.84.17; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:SATLEXMB04.amd.com; PTR:InfoDomainNonexistent; CAT:NONE; SFS:(13230040)(1800799024)(36860700013)(7416014)(376014)(82310400026)(921020); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 Jan 2025 11:05:59.7100 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 112b4828-5dfa-4ec4-7537-08dd41e73e85 X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d; Ip=[165.204.84.17]; Helo=[SATLEXMB04.amd.com] X-MS-Exchange-CrossTenant-AuthSource: CO1PEPF000044F1.namprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR12MB9127 This commit adds a document section in drm-uapi.rst about tracepoints, and mark the events gpu_scheduler_trace.h as stable uAPI. The goal is to explicitly state that tools can rely on the fields, formats and semantics of these events. Acked-by: Lucas Stach Acked-by: Maíra Canal Signed-off-by: Pierre-Eric Pelloux-Prayer --- Documentation/gpu/drm-uapi.rst | 19 ++++++++++++++++ .../gpu/drm/scheduler/gpu_scheduler_trace.h | 22 +++++++++++++++++++ 2 files changed, 41 insertions(+) diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst index b75cc9a70d1f..9603ac0f4c09 100644 --- a/Documentation/gpu/drm-uapi.rst +++ b/Documentation/gpu/drm-uapi.rst @@ -583,3 +583,22 @@ dma-buf interoperability Please see Documentation/userspace-api/dma-buf-alloc-exchange.rst for information on how dma-buf is integrated and exposed within DRM. + + +Trace events +============ + +See Documentation/trace/tracepoints.rst for information about using +Linux Kernel Tracepoints. +In the DRM subsystem, some events are considered stable uAPI to avoid +breaking tools (e.g.: GPUVis, umr) relying on them. Stable means that fields +cannot be removed, nor their formatting updated. Adding new fields is +possible, under the normal uAPI requirements. + +Stable uAPI events +------------------ + +From ``drivers/gpu/drm/scheduler/gpu_scheduler_trace.h`` + +.. kernel-doc:: drivers/gpu/drm/scheduler/gpu_scheduler_trace.h + :doc: uAPI trace events \ No newline at end of file diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler_trace.h b/drivers/gpu/drm/scheduler/gpu_scheduler_trace.h index 5c740cb80037..85d547f3fadd 100644 --- a/drivers/gpu/drm/scheduler/gpu_scheduler_trace.h +++ b/drivers/gpu/drm/scheduler/gpu_scheduler_trace.h @@ -33,6 +33,28 @@ #define TRACE_SYSTEM gpu_scheduler #define TRACE_INCLUDE_FILE gpu_scheduler_trace + +/** + * DOC: uAPI trace events + * + * ``drm_sched_job``, ``drm_run_job``, ``drm_sched_process_job``, + * and ``drm_sched_job_wait_dep`` are considered stable uAPI. + * + * Common trace events attributes: + * + * * ``id`` - this is &drm_sched_job->id. It uniquely idenfies a job + * inside a &struct drm_gpu_scheduler. + * + * * ``dev`` - the dev_name() of the device running the job. + * + * * ``ring`` - the hardware ring running the job. Together with ``dev`` it + * uniquely identifies where the job is going to be executed. + * + * * ``fence`` - the &dma_fence.context and the &dma_fence.seqno of + * &drm_sched_fence.finished + * + */ + #ifndef __TRACE_EVENT_GPU_SCHEDULER_PRINT_FN #define __TRACE_EVENT_GPU_SCHEDULER_PRINT_FN /* Similar to trace_print_array_seq but for fences. */