Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Fri, 19 May 2023 15:30:47 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     David Gow <davidgow@google.com>,
        Matti Vaittinen <mazziesaccount@gmail.com>,
        Daniel Latypov <dlatypov@google.com>,
        Maxime Ripard <maxime@cerno.tech>,
        Benjamin Berg <benjamin@sipsolutions.net>,
        Brendan Higgins <brendan.higgins@linux.dev>,
        Stephen Boyd <sboyd@kernel.org>,
        Shuah Khan <skhan@linuxfoundation.org>,
        Rae Moar <rmoar@google.com>
Cc:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        "Rafael J . Wysocki" <rafael@kernel.org>,
        Heikki Krogerus <heikki.krogerus@linux.intel.com>,
        Jonathan Cameron <jic23@kernel.org>,
        Sadiya Kazi <sadiyakazi@google.com>,
        Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org,
        kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 4/4] Documentation: kunit: Add usage notes for
 kunit_add_action()
Message-ID: <ZGcztwtEvf/c0kGg@debian.me>
References: <20230518083849.2631178-1-davidgow@google.com>
 <20230518083849.2631178-4-davidgow@google.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="QNlhZ+8rjoCCRHiA"
Content-Disposition: inline
In-Reply-To: <20230518083849.2631178-4-davidgow@google.com>
Precedence: bulk


--QNlhZ+8rjoCCRHiA
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, May 18, 2023 at 04:38:46PM +0800, David Gow wrote:
> +Registering Cleanup Actions
> +---------------------------
> +
> +If you need to perform some cleanup beyond simple use of ``kunit_kzalloc=
``,
> +you can register a cusom "deferred action", which is a cleanup function
> +run when the test exits (whether cleanly, or via a failed assertion).
> +
> +Actions are simple functions with no return value, and a single ``void*``
> +context argument, and forfil the same role as "cleanup" functions in Pyt=
hon
"... fulfill the same role ..."?

> +and Go tests, "defer" statements in languages which support them, and
> +(in some cases) destructors in RAII languages.
> +
> +These are very useful for unregistering things from global lists, closing
> +files or other resources, or freeing resources.
> +
> +For example:
> +
> +.. code-block:: C
> +
> +	static void cleanup_device(void *ctx)
> +	{
> +		struct device *dev =3D (struct device *)ctx;
> +
> +		device_unregister(dev);
> +	}
> +
> +	void example_device_test(struct kunit *test)
> +	{
> +		struct my_device dev;
> +
> +		device_register(&dev);
> +
> +		kunit_add_action(test, &cleanup_device, &dev);
> +	}
> +
> +Note that, for functions like device_unregister which only accept a sing=
le
> +pointer-sized argument, it's possible to directly cast that function to
> +a ``kunit_action_t`` rather than writing a wrapper function, for example:
> +
> +.. code-block:: C
> +
> +	kunit_add_action(test, (kunit_action_t *)&device_unregister, &dev);
> +
> +``kunit_add_action`` can fail if, for example, the system is out of memo=
ry.
> +You can use ``kunit_add_action_or_reset`` instead which runs the action
> +immediately if it cannot be deferred.
> +
> +If you need more control over when the cleanup function is called, you
> +can trigger it early using ``kunit_release_action``, or cancel it entire=
ly
> +with ``kunit_remove_action``.
> +
> =20
>  Testing Static Functions
>  ------------------------

The rest is LGTM.

--=20
An old man doll... just what I always wanted! - Clara

--QNlhZ+8rjoCCRHiA
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZGczrQAKCRD2uYlJVVFO
o/9jAQDrHL35jfTcr1SjBI6FfCy61zx+YCt53C13kD/XIJCcwAEA7U8wmdm73+Rh
MIbRXJdpUi02nfl88HIERDTHo5VFOAw=
=lpla
-----END PGP SIGNATURE-----

--QNlhZ+8rjoCCRHiA--