Received-SPF: pass (google.com: domain of linux-kernel+bounces-17723-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
From: =?UTF-8?q?Micha=C5=82=20Winiarski?= <michal.winiarski@intel.com>
To: <intel-xe@lists.freedesktop.org>, <dri-devel@lists.freedesktop.org>,
	<linux-kernel@vger.kernel.org>
CC: Rodrigo Vivi <rodrigo.vivi@intel.com>, Michal Wajdeczko
	<michal.wajdeczko@intel.com>, Maarten Lankhorst
	<maarten.lankhorst@linux.intel.com>, Maxime Ripard <mripard@kernel.org>,
	Thomas Zimmermann <tzimmermann@suse.de>, David Airlie <airlied@gmail.com>,
	Daniel Vetter <daniel@ffwll.ch>, Javier Martinez Canillas
	<javierm@redhat.com>, =?UTF-8?q?Ma=C3=ADra=20Canal?= <mcanal@igalia.com>,
	=?UTF-8?q?Micha=C5=82=20Winiarski?= <michal.winiarski@intel.com>
Subject: [PATCH v4 4/6] drm/tests: managed: Add comments and expect fail messages
Date: Fri, 5 Jan 2024 11:13:22 +0100
Message-ID: <20240105101324.26811-5-michal.winiarski@intel.com>
In-Reply-To: <20240105101324.26811-1-michal.winiarski@intel.com>
References: <20240105101324.26811-1-michal.winiarski@intel.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 8bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?UHgzZ1hLUmNKVWZ5SERxcHlFcDQ0dDB3VFdhemRuTUZMemQ5bXAvSTVGTVZ0?=
 =?utf-8?B?U0xuUTByMVdMbTNIbnhzNGl5VDVUMU5PQ1QvWTQxa1RrcEVBTS9QQ3N2Vlo1?=
 =?utf-8?B?aHdsRHBhRURjaUxGU2o5aFNUT201ZTZpRXlXYmJLQ2tqZEx2YlZHUUtRUGIy?=
 =?utf-8?B?KzJlVEJJRnJmME5sQUZwWU5VK2cvdDFGYjhUNTk5SWx3bVVseWUxdlRmMmoz?=
 =?utf-8?B?dktCZ2pwaHZudFNkZDJsWE5lUHRFbE5jaDg4TmpQRzIzVmlCUEdqTGNEcVIz?=
 =?utf-8?B?UkpiWWpET010TzlQOGFQcmI0dkFFSTg3TlVNTHYrRFpNNXljTEhVK1M5SE1r?=
 =?utf-8?B?L1JpOEJwaHhnU1UyZ0d0dXpsRDJIcVFwOFRIamtwRUhFcE1BTDdTTndFTFpu?=
 =?utf-8?B?c2dGcStXM242elovRHMyc0dTQmNaYmQ1MWQ5NXRUbnZrbTJwYjR4dmRibFlp?=
 =?utf-8?B?ZjEvM2dRYUVTMUlyblJtZWx3MGcvZW5aNDJjTjdFMnMxcHFrbzBpUTZOMUtp?=
 =?utf-8?B?Qk5XREFxSU45VyswUXJvVWFnSGRMenFoSTF1cC82bkk2Q3htV2hSczhqbm1m?=
 =?utf-8?B?bDJaL0c1djZvOXZMVUJTNW5NcmptTHFka255VWk5bDZDTXo1QkcrbmpJUHBN?=
 =?utf-8?B?ZXBIVGFEVHRaRDFNTEhVNVpGc2ZSUE41QU9qMWdWMlV1TDFCRFM1NjVqQThn?=
 =?utf-8?B?U0VrVUN6VmUvcU5LbXhQUGticDE4cWd1ZTNHS3plb0dDaGV1TWJEa0gwNzlP?=
 =?utf-8?B?NjZUcHpGNTdZMVdJSmJlb1FLeDJxZlB6emJQeS92QVRUVy9UaHNRdThzMzNj?=
 =?utf-8?B?ek4vc0dtc2tVT1lhU0JkZjRuWmRWZWJHekpEc3QxcHZ2eG1wVnNhaytMU0Vt?=
 =?utf-8?B?aHc0OGhPN0F1MmxzNGthQk95alJ1Y1hBOEZETGJORWMyNzNJRWV3Tjhzc0FR?=
 =?utf-8?B?M280VkQ3R3JJOW5Qcy94bE9PWG1VUENQQ3pBOEZDbEdrMFhjTU5SUk11Nlo3?=
 =?utf-8?B?M3dDU1lLM2EwZTdCMTlYWHJkR1plbGo5ZnExcUpiUGZOdTVxMWFiL3EzcEZP?=
 =?utf-8?B?Vmo0N3pyUGlzT3pzcFNQL3hha2F2NE85VXdFblRqUjVMd2ExMnVSUHdHbkZ2?=
 =?utf-8?B?aVpDZkp0VWJBc3duTkNnMFVHMG9hNmJBR3hQYzU1OTlXUVg4Wk95M2MwRWdS?=
 =?utf-8?B?WlhKVE8xWjdwSmNlaTE3eGFTUEg0Q09lMXRxNldoZkRzMFowMXJPRkJoNFQ3?=
 =?utf-8?B?TWJ0TWRvZ3NGNTYrZFUxNzJXQ0NxVlMwWk1wY1VsejlCWngwRUNDY2pFNzhY?=
 =?utf-8?B?bkl6cGxCYndIZ2RycHl2Y2hFMXV4OFZZczFxNmJyWFlCcWpHbGlQMFg3WWw2?=
 =?utf-8?B?S0psVG5BNU5DY3lqSzRJRlhVek5Qck5RK3h3VnB0UDZQMUovS21QSmdCYWNH?=
 =?utf-8?B?dkx6c2Q4ZDJVd3lCcnl3QUNENDRXTEtoKzVZVmNZVmxOSjZOb1cvRmNIQUNa?=
 =?utf-8?B?YnJLNmJIdHVyMk9weGpveTZ1SW5hZytCYmtlRjFDbi83aXQ4OHQxdGZDdUNC?=
 =?utf-8?B?UzBiRi9IS000OFplSTB0NW13OEtCeVdTOCthazdOY21ObjlZK0VvUGJvckZ0?=
 =?utf-8?B?S3FrTTVjc1RZclFsM3BQc1p5aWYzSkF4SWVIMDNXQnFPUndzRVIvSXhPRFNr?=
 =?utf-8?B?NkFBakorZVRCZkk5WWdadUVmNnV4Z2FSR1BFdXpiaWxycVoxOXgwekoybTFk?=
 =?utf-8?B?cVoxRXJPc2Y3YmxmOW5kWm9HN1Y3ek9lL3BqSHVYWU9JWnV3dlZFNzFXNm5u?=
 =?utf-8?B?UUR5SCtNVURHbTZHd2FqdTdQSExpOEpIVXVxZnJTYms5cUYzZ0lPdFcyS09C?=
 =?utf-8?B?Nk9OaXc0Zm5XUjJ0blM5OHQ4QWlYcEUyQk1LNExTNmZoelJja3lGeEtrR2Iy?=
 =?utf-8?B?em1qM1VING1kbFFmMzlTMVE5TkF6SG0wU2lKd3IzSHV4Uy9DaUVqQTZOS2Zm?=
 =?utf-8?B?cjZQYW9kS3d0WGNtbzNzbzg0dWlWMVhEcmxJS1lBYmlDQmxBTVhCTi9UMWQw?=
 =?utf-8?B?NmJjNzhtdG4wOVBjWkNOQWx3bUx1bkZIcDFacGY0TWhlSysyWk5NQ2dLZTBS?=
 =?utf-8?B?NTl1RWx6NUVWN0dVQ1JwRTFhUVZSTUJnYXk5SmJkL0ttdGo4S0JKSU95cWxI?=
 =?utf-8?B?aVE9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: d960fb1a-3988-44e4-87d6-08dc0dd700bc
X-MS-Exchange-CrossTenant-AuthSource: BL1PR11MB5365.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jan 2024 10:13:46.6390
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: wnBS3Xq0KhmIAbrqLEYcMVDLROpXSuYfz8ax9F94iaGEqq0Ue+yRBIWv1MzvSMnUDgT8eAklSpjX6TvHWoz6ObugDd9nGd08Pk+0N00mPXw=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR11MB4823
X-OriginatorOrg: intel.com

Add comments explaining the intention behind the test and certain
implementation details related to device lifetime.

Signed-off-by: Michał Winiarski <michal.winiarski@intel.com>
---
 drivers/gpu/drm/tests/drm_managed_test.c | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/tests/drm_managed_test.c b/drivers/gpu/drm/tests/drm_managed_test.c
index e4790ae838ba7..986a38c9144a5 100644
--- a/drivers/gpu/drm/tests/drm_managed_test.c
+++ b/drivers/gpu/drm/tests/drm_managed_test.c
@@ -19,6 +19,10 @@ static void drm_action(struct drm_device *drm, void *ptr)
 	priv->action_done = true;
 }
 
+/*
+ * The test verifies that the release action is called automatically when the
+ * device is released.
+ */
 static void drm_test_managed_run_action(struct kunit *test)
 {
 	struct managed_test_priv *priv;
@@ -32,6 +36,11 @@ static void drm_test_managed_run_action(struct kunit *test)
 	dev = drm_kunit_helper_alloc_device(test);
 	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, dev);
 
+	/*
+	 * DRM device can't be embedded in priv, since priv->action_done needs
+	 * to remain allocated beyond both parent device and drm_device
+	 * lifetime.
+	 */
 	drm = __drm_kunit_helper_alloc_drm_device(test, dev, sizeof(*drm), 0, DRIVER_MODESET);
 	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, drm);
 
@@ -44,7 +53,7 @@ static void drm_test_managed_run_action(struct kunit *test)
 	drm_dev_unregister(drm);
 	drm_kunit_helper_free_device(test, dev);
 
-	KUNIT_EXPECT_TRUE(test, priv->action_done);
+	KUNIT_EXPECT_TRUE_MSG(test, priv->action_done, "Release action was not called");
 }
 
 static struct kunit_case drm_managed_tests[] = {
-- 
2.43.0