From patchwork Thu Jul 7 18:29:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vikas Gupta X-Patchwork-Id: 12910069 X-Patchwork-Delegate: kuba@kernel.org 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id E0C2FC433EF for ; Thu, 7 Jul 2022 18:34:26 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236198AbiGGSeZ (ORCPT ); Thu, 7 Jul 2022 14:34:25 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57002 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236704AbiGGScb (ORCPT ); Thu, 7 Jul 2022 14:32:31 -0400 Received: from mail-pg1-x534.google.com (mail-pg1-x534.google.com [IPv6:2607:f8b0:4864:20::534]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A2E856068C for ; Thu, 7 Jul 2022 11:30:23 -0700 (PDT) Received: by mail-pg1-x534.google.com with SMTP id e132so20028137pgc.5 for ; Thu, 07 Jul 2022 11:30:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=broadcom.com; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=OriDeEWxl1oSXLeFmUsGaJdRMhwJBw2mqDkwWYMz1+w=; b=DPXFEtI60WMsqw8LQWtXsDi1ltsCDUd98G5aw0ypEVU7pryFstLtAS/HAS54gS43Yx 57T3r0f8NV7/Xb+xYohZ5i1fbqvPrCr0a4BAUnP5Ffq62Unrk7G+mXvhn2jY8nSyzIQm lXpZ/XPeBmYVb4Hjtw/DFN6B5SB6SsFnVEGpw= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=OriDeEWxl1oSXLeFmUsGaJdRMhwJBw2mqDkwWYMz1+w=; b=Rcycd+THKcz7djV0mu7r6RQTxnQSBefNodKk45oEGkk0VFQRQKenFqT/CHu9rKULvl AbJZJD08zpYqt2i4s9zcPftyDtEj6vFYAMeJQVbrKAABaDA+G5rAynKuy6UKBMA968sX FVv5un9riJQXHmkduMiwjphEk0zTPfvfU86f6xpMsOSQFekmJLsYN0aySrfXPtQO5JCG Z8pWKaBZb8UhbthLPCvWyjWDKk2F67mzNGnLon7e1qdIRjfldUqFIebzZkspnIef3whN aqGPsOw9V1rk0qoCkoRY7MnJ9K40ECgmBylpUyJ8MMpbZtOQt3p1u0fqQ3m41IZFIqkn jJYg== X-Gm-Message-State: AJIora97DDeTmWFtT9VcZIC7o+2iKugZjVEBj4l7nBe1xiEnuEExRIIV l1yXTAnZqQHR9Ka+nAj1IU7b/g== X-Google-Smtp-Source: AGRyM1sIipm971ZqE89vxyMR6A9r0jRVO+ByhiVDOSeV0G11NXpRaleySzrZb3j/tFPOUKz2DeefPQ== X-Received: by 2002:a17:90b:507:b0:1ee:de8c:6aa2 with SMTP id r7-20020a17090b050700b001eede8c6aa2mr6879982pjz.105.1657218621336; Thu, 07 Jul 2022 11:30:21 -0700 (PDT) Received: from rahul_yocto_ubuntu18.ibn.broadcom.net ([192.19.252.250]) by smtp.gmail.com with ESMTPSA id pj9-20020a17090b4f4900b001ef92e0e7c1sm7132234pjb.10.2022.07.07.11.30.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 07 Jul 2022 11:30:20 -0700 (PDT) From: Vikas Gupta To: jiri@nvidia.com, kuba@kernel.org Cc: netdev@vger.kernel.org, linux-kernel@vger.kernel.org, davem@davemloft.net, dsahern@kernel.org, stephen@networkplumber.org, edumazet@google.com, pabeni@redhat.com, ast@kernel.org, leon@kernel.org, linux-doc@vger.kernel.org, corbet@lwn.net, michael.chan@broadcom.com, andrew.gospodarek@broadcom.com, Vikas Gupta Subject: [PATCH net-next v2 1/3] devlink: introduce framework for selftests Date: Thu, 7 Jul 2022 23:59:48 +0530 Message-Id: <20220707182950.29348-2-vikas.gupta@broadcom.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20220707182950.29348-1-vikas.gupta@broadcom.com> References: <20220628164241.44360-1-vikas.gupta@broadcom.com> <20220707182950.29348-1-vikas.gupta@broadcom.com> Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org X-Patchwork-Delegate: kuba@kernel.org Add a framework for running selftests. Framework exposes devlink commands and test suite(s) to the user to execute and query the supported tests by the driver. Below are new entries in devlink_nl_ops devlink_nl_cmd_selftests_show: To query the supported selftests by the driver. devlink_nl_cmd_selftests_run: To execute selftests. Users can provide a test mask for executing group tests or standalone tests. Documentation/networking/devlink/ path is already part of MAINTAINERS & the new files come under this path. Hence no update needed to the MAINTAINERS Signed-off-by: Vikas Gupta Reviewed-by: Michael Chan Reviewed-by: Andy Gospodarek Reported-by: kernel test robot Reported-by: kernel test robot --- .../networking/devlink/devlink-selftests.rst | 34 +++++ include/net/devlink.h | 30 ++++ include/uapi/linux/devlink.h | 26 ++++ net/core/devlink.c | 144 ++++++++++++++++++ 4 files changed, 234 insertions(+) create mode 100644 Documentation/networking/devlink/devlink-selftests.rst diff --git a/Documentation/networking/devlink/devlink-selftests.rst b/Documentation/networking/devlink/devlink-selftests.rst new file mode 100644 index 000000000000..796d38f77038 --- /dev/null +++ b/Documentation/networking/devlink/devlink-selftests.rst @@ -0,0 +1,34 @@ +.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) + +================= +Devlink Selftests +================= + +The ``devlink-selftests`` API allows executing selftests on the device. + +Tests Mask +========== +The ``devlink-selftests`` command should be run with a mask indicating +the tests to be executed. + +Tests Description +================= +The following is a list of tests that drivers may execute. + +.. list-table:: List of tests + :widths: 5 90 + + * - Name + - Description + * - ``DEVLINK_SELFTEST_FLASH`` + - Runs a flash test on the device. + +example usage +------------- + +.. code:: shell + + # Query selftests supported on the device + $ devlink dev selftests show DEV + # Executes selftests on the device + $ devlink dev selftests run DEV test {flash | all} diff --git a/include/net/devlink.h b/include/net/devlink.h index 2a2a2a0c93f7..cb7c378cf720 100644 --- a/include/net/devlink.h +++ b/include/net/devlink.h @@ -1215,6 +1215,18 @@ enum { DEVLINK_F_RELOAD = 1UL << 0, }; +#define DEVLINK_SELFTEST_FLASH_TEST_NAME "flash" + +static inline const char *devlink_selftest_name(int test) +{ + switch (test) { + case DEVLINK_SELFTEST_FLASH_BIT: + return DEVLINK_SELFTEST_FLASH_TEST_NAME; + default: + return "unknown"; + } +} + struct devlink_ops { /** * @supported_flash_update_params: @@ -1509,6 +1521,24 @@ struct devlink_ops { struct devlink_rate *parent, void *priv_child, void *priv_parent, struct netlink_ext_ack *extack); + /** + * selftests_show() - Shows selftests supported by device + * @devlink: Devlink instance + * @extack: extack for reporting error messages + * + * Return: test mask supported by driver + */ + u32 (*selftests_show)(struct devlink *devlink, + struct netlink_ext_ack *extack); + /** + * selftests_run() - Runs selftests + * @devlink: Devlink instance + * @tests_mask: tests to be run by driver + * @results: test results by driver + * @extack: extack for reporting error messages + */ + void (*selftests_run)(struct devlink *devlink, u32 tests_mask, + u8 *results, struct netlink_ext_ack *extack); }; void *devlink_priv(struct devlink *devlink); diff --git a/include/uapi/linux/devlink.h b/include/uapi/linux/devlink.h index b3d40a5d72ff..1dba262328b9 100644 --- a/include/uapi/linux/devlink.h +++ b/include/uapi/linux/devlink.h @@ -136,6 +136,9 @@ enum devlink_command { DEVLINK_CMD_LINECARD_NEW, DEVLINK_CMD_LINECARD_DEL, + DEVLINK_CMD_SELFTESTS_SHOW, + DEVLINK_CMD_SELFTESTS_RUN, + /* add new commands above here */ __DEVLINK_CMD_MAX, DEVLINK_CMD_MAX = __DEVLINK_CMD_MAX - 1 @@ -276,6 +279,25 @@ enum { #define DEVLINK_SUPPORTED_FLASH_OVERWRITE_SECTIONS \ (_BITUL(__DEVLINK_FLASH_OVERWRITE_MAX_BIT) - 1) +/* Commonly used test cases */ +enum { + DEVLINK_SELFTEST_FLASH_BIT, + + __DEVLINK_SELFTEST_MAX_BIT, + DEVLINK_SELFTEST_MAX_BIT = __DEVLINK_SELFTEST_MAX_BIT - 1 +}; + +#define DEVLINK_SELFTEST_FLASH _BITUL(DEVLINK_SELFTEST_FLASH_BIT) + +#define DEVLINK_SELFTESTS_MASK \ + (_BITUL(__DEVLINK_SELFTEST_MAX_BIT) - 1) + +enum { + DEVLINK_SELFTEST_SKIP, + DEVLINK_SELFTEST_PASS, + DEVLINK_SELFTEST_FAIL +}; + /** * enum devlink_trap_action - Packet trap action. * @DEVLINK_TRAP_ACTION_DROP: Packet is dropped by the device and a copy is not @@ -576,6 +598,10 @@ enum devlink_attr { DEVLINK_ATTR_LINECARD_TYPE, /* string */ DEVLINK_ATTR_LINECARD_SUPPORTED_TYPES, /* nested */ + DEVLINK_ATTR_SELFTESTS_MASK, /* u32 */ + DEVLINK_ATTR_TEST_RESULT, /* nested */ + DEVLINK_ATTR_TEST_NAME, /* string */ + DEVLINK_ATTR_TEST_RESULT_VAL, /* u8 */ /* add new attributes above here, update the policy in devlink.c */ __DEVLINK_ATTR_MAX, diff --git a/net/core/devlink.c b/net/core/devlink.c index db61f3a341cb..0b7341ab6379 100644 --- a/net/core/devlink.c +++ b/net/core/devlink.c @@ -4794,6 +4794,136 @@ static int devlink_nl_cmd_flash_update(struct sk_buff *skb, return ret; } +static int devlink_selftest_name_put(struct sk_buff *skb, int test) +{ + const char *name = devlink_selftest_name(test); + if (nla_put_string(skb, DEVLINK_ATTR_TEST_NAME, name)) + return -EMSGSIZE; + + return 0; +} + +static int devlink_nl_cmd_selftests_show(struct sk_buff *skb, + struct genl_info *info) +{ + struct devlink *devlink = info->user_ptr[0]; + struct sk_buff *msg; + unsigned long tests; + int err = 0; + void *hdr; + int test; + + if (!devlink->ops->selftests_show) + return -EOPNOTSUPP; + + msg = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL); + if (!msg) + return -ENOMEM; + + hdr = genlmsg_put(msg, info->snd_portid, info->snd_seq, + &devlink_nl_family, 0, DEVLINK_CMD_SELFTESTS_SHOW); + if (!hdr) + goto free_msg; + + if (devlink_nl_put_handle(msg, devlink)) + goto genlmsg_cancel; + + tests = devlink->ops->selftests_show(devlink, info->extack); + + for_each_set_bit(test, &tests, __DEVLINK_SELFTEST_MAX_BIT) { + err = devlink_selftest_name_put(msg, test); + if (err) + goto genlmsg_cancel; + } + + genlmsg_end(msg, hdr); + + return genlmsg_reply(msg, info); + +genlmsg_cancel: + genlmsg_cancel(msg, hdr); +free_msg: + nlmsg_free(msg); + return err; +} + +static int devlink_selftest_result_put(struct sk_buff *skb, int test, + u8 result) +{ + const char *name = devlink_selftest_name(test); + struct nlattr *result_attr; + + result_attr = nla_nest_start_noflag(skb, DEVLINK_ATTR_TEST_RESULT); + if (!result_attr) + return -EMSGSIZE; + + if (nla_put_string(skb, DEVLINK_ATTR_TEST_NAME, name) || + nla_put_u8(skb, DEVLINK_ATTR_TEST_RESULT_VAL, result)) + goto nla_put_failure; + + nla_nest_end(skb, result_attr); + + return 0; + +nla_put_failure: + nla_nest_cancel(skb, result_attr); + return -EMSGSIZE; +} + +static int devlink_nl_cmd_selftests_run(struct sk_buff *skb, + struct genl_info *info) +{ + u8 test_results[DEVLINK_SELFTEST_MAX_BIT + 1] = {}; + struct devlink *devlink = info->user_ptr[0]; + unsigned long tests; + struct sk_buff *msg; + u32 tests_mask; + void *hdr; + int err = 0; + int test; + + if (!devlink->ops->selftests_run) + return -EOPNOTSUPP; + + if (!info->attrs[DEVLINK_ATTR_SELFTESTS_MASK]) + return -EINVAL; + + msg = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL); + if (!msg) + return -ENOMEM; + + hdr = genlmsg_put(msg, info->snd_portid, info->snd_seq, + &devlink_nl_family, 0, DEVLINK_CMD_SELFTESTS_RUN); + if (!hdr) + goto free_msg; + + if (devlink_nl_put_handle(msg, devlink)) + goto genlmsg_cancel; + + tests_mask = nla_get_u32(info->attrs[DEVLINK_ATTR_SELFTESTS_MASK]); + + devlink->ops->selftests_run(devlink, tests_mask, test_results, + info->extack); + tests = tests_mask; + + for_each_set_bit(test, &tests, __DEVLINK_SELFTEST_MAX_BIT) { + err = devlink_selftest_result_put(msg, test, + test_results[test]); + if (err) + goto genlmsg_cancel; + } + + genlmsg_end(msg, hdr); + + return genlmsg_reply(msg, info); + +genlmsg_cancel: + genlmsg_cancel(msg, hdr); +free_msg: + nlmsg_free(msg); + return err; +} + static const struct devlink_param devlink_param_generic[] = { { .id = DEVLINK_PARAM_GENERIC_ID_INT_ERR_RESET, @@ -9000,6 +9130,8 @@ static const struct nla_policy devlink_nl_policy[DEVLINK_ATTR_MAX + 1] = { [DEVLINK_ATTR_RATE_PARENT_NODE_NAME] = { .type = NLA_NUL_STRING }, [DEVLINK_ATTR_LINECARD_INDEX] = { .type = NLA_U32 }, [DEVLINK_ATTR_LINECARD_TYPE] = { .type = NLA_NUL_STRING }, + [DEVLINK_ATTR_SELFTESTS_MASK] = NLA_POLICY_MASK(NLA_U32, + DEVLINK_SELFTESTS_MASK), }; static const struct genl_small_ops devlink_nl_ops[] = { @@ -9361,6 +9493,18 @@ static const struct genl_small_ops devlink_nl_ops[] = { .doit = devlink_nl_cmd_trap_policer_set_doit, .flags = GENL_ADMIN_PERM, }, + { + .cmd = DEVLINK_CMD_SELFTESTS_SHOW, + .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP, + .doit = devlink_nl_cmd_selftests_show, + .flags = GENL_ADMIN_PERM, + }, + { + .cmd = DEVLINK_CMD_SELFTESTS_RUN, + .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP, + .doit = devlink_nl_cmd_selftests_run, + .flags = GENL_ADMIN_PERM, + }, }; static struct genl_family devlink_nl_family __ro_after_init = {