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, 31 Mar 2023 16:04:08 +0800
Mime-Version: 1.0
Message-ID: <20230331080411.981038-1-davidgow@google.com>
Subject: [RFC PATCH v2 0/3] kunit: Deferred action helpers
From:   David Gow <davidgow@google.com>
To:     Matti Vaittinen <mazziesaccount@gmail.com>,
        Maxime Ripard <maxime@cerno.tech>,
        Brendan Higgins <brendan.higgins@linux.dev>,
        Stephen Boyd <sboyd@kernel.org>,
        Shuah Khan <skhan@linuxfoundation.org>,
        Daniel Latypov <dlatypov@google.com>,
        Rae Moar <rmoar@google.com>,
        Benjamin Berg <benjamin@sipsolutions.net>
Cc:     David Gow <davidgow@google.com>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        "Rafael J . Wysocki" <rafael@kernel.org>,
        Heikki Krogerus <heikki.krogerus@linux.intel.com>,
        Jonathan Cameron <jic23@kernel.org>,
        linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org,
        kunit-dev@googlegroups.com
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

This is a follow-up to the kunit_defer() parts of 'KUnit device API
proposal'[1], with a number of changes suggested by Matti Vaittinen,
Maxime Ripard and Benjamin Berg.

Most notably, kunit_defer() has been renamed to kunit_add_action(), in
order to match the equivalent devres API[2]. Likewise:
kunit_defer_cancel() has become kunit_remove_action(), and
kunit_defer_trigger() has become kunit_release_action().

The _token() versions of these APIs remain, for the moment, even though
they're a bit more awkward and less useful, as they have two advantages:
1. They're faster, as the action doesn't need to be looked up.
2. They provide more flexibility in the ordering of actions in cases
where several identical actions are interleaved with other, different
actions.

Similarly, the internal_gfp argument remains for now, as this is useful
in implementing kunit_kalloc() and similar.

The implementation now uses a single allocation for both the
kunit_resource and the kunit_action_ctx (previously kunit_defer_ctx).

The 'cancellation token' is now of type 'struct kunit_action_ctx',
instead of void*.

Tests have been added to the kunit-resource-test suite which exercise
this functionality. Similarly, the kunit executor tests and
kunit allocation functions have been updated to make use of this API.

I'd love to hear any further thoughts!

Cheers,
-- David


[1]: https://lore.kernel.org/linux-kselftest/20230325043104.3761770-1-davidgow@google.com/
[2]: https://docs.kernel.org/driver-api/basics.html#c.devm_add_action

David Gow (3):
  kunit: Add kunit_add_action() to defer a call until test exit
  kunit: executor_test: Use kunit_add_action()
  kunit: kmalloc_array: Use kunit_add_action()

 include/kunit/resource.h  |  89 +++++++++++++++++++++++++++
 lib/kunit/executor_test.c |  12 ++--
 lib/kunit/kunit-test.c    | 123 +++++++++++++++++++++++++++++++++++++-
 lib/kunit/resource.c      |  99 ++++++++++++++++++++++++++++++
 lib/kunit/test.c          |  48 +++------------
 5 files changed, 323 insertions(+), 48 deletions(-)

-- 
2.40.0.348.gf938b09366-goog