From nobody Sun May 10 15:07:03 2026 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 82D4FC433EF for ; Sun, 1 May 2022 00:06:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238263AbiEAAJ1 (ORCPT ); Sat, 30 Apr 2022 20:09:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33152 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237650AbiEAAJT (ORCPT ); Sat, 30 Apr 2022 20:09:19 -0400 Received: from mail-io1-xd35.google.com (mail-io1-xd35.google.com [IPv6:2607:f8b0:4864:20::d35]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 510FD6257; Sat, 30 Apr 2022 17:05:56 -0700 (PDT) Received: by mail-io1-xd35.google.com with SMTP id h85so1888508iof.12; Sat, 30 Apr 2022 17:05:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=bPaGf/rH6ukn1gEDjnUl5sTBDKAvT3vaR48iLuz34ZI=; b=Yq9+f1NSq3TXgTBNe8Hyk8bJ049f3J+/b+8bPKW4WnQWUifG9JBd27qXgdHzjFZY1l iBzAylBQWoIi34jN43H2zwd38ZkxOvTJLxf+5x/JluX3IKFkeRrIlZAvDaGp7muU03fT wu+GFevhQZWTe06Mi3N5IoGeRfdZnRU42c5deZOmq8gJPjxJt9Xg5nn1SnYL0CTkSLLo WY+KH47nMfJMcl1JI/IhbWkL3g7DjKUMsiSZ+3d8BBn+fZ6QrgiF+aB8wD2529Br2ha8 WZDvYXmFz1bmM+RiD9SBgOTNwUhs2XTOXZ08ZSdnge08b4Iu8OL410teFAOVYsVd4E5a GSuw== 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:mime-version:content-transfer-encoding; bh=bPaGf/rH6ukn1gEDjnUl5sTBDKAvT3vaR48iLuz34ZI=; b=mpLo67jCLjGpn4W5GjntxpDV26+lTS0yidvpPeckw3qqM40mUMWdpwOP6T+KjalJUm 87BYZH2YiBn564Biyt8g9qpoKdmBWTArZVDG9+Y9kf+VhN03q0WCaLArEHpvCDJIjGck /XDBK18S5P/pk9yut0otnK2vhkb9m1XFeDFfiUeQp2ubvdxHzjDoWPXHcjEXJ+n8DGvw mbMR0LbRoq1UjoaMhMzaNYqxd5yrtFto8plUNQmXAIJtepNvMeqaMIUyGMOb23hw6CfI OXEkiY2rBQ7wUNnl6nWx7F7b2k9ZKKVoST8PbURJLwACkCFLuRLnTaJ1swwqamC+pDB0 IKQg== X-Gm-Message-State: AOAM530yDCMsodE3XoKoc3Oo/rcYOHp8ZT+T8rhv06YmS+5VjuBkIMO+ JwbU3imFuQQUl7YCdbfDxD4= X-Google-Smtp-Source: ABdhPJwcw8XQMx6rXmwXUHiaEQsEWlnaD+nLkJ72J3zOJyHLQ8tE85LSnZeluENmvit5b7wOckPFxg== X-Received: by 2002:a02:cddd:0:b0:32a:e923:d0a3 with SMTP id m29-20020a02cddd000000b0032ae923d0a3mr2489565jap.88.1651363555738; Sat, 30 Apr 2022 17:05:55 -0700 (PDT) Received: from xps8900.attlocal.net ([2600:1700:2442:6db0:809b:de5d:7e0a:bf83]) by smtp.gmail.com with ESMTPSA id n13-20020a92d9cd000000b002cde6e352dcsm1567160ilq.38.2022.04.30.17.05.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 30 Apr 2022 17:05:55 -0700 (PDT) From: frowand.list@gmail.com To: Rob Herring , pantelis.antoniou@konsulko.com, Slawomir Stepien , Dan Carpenter Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, Slawomir Stepien , Jan Kiszka , Geert Uytterhoeven Subject: [PATCH 1/3] of: overlay: add entry to of_overlay_action_name[] Date: Sat, 30 Apr 2022 19:05:41 -0500 Message-Id: <20220501000543.1368005-2-frowand.list@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220501000543.1368005-1-frowand.list@gmail.com> References: <20220501000543.1368005-1-frowand.list@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Frank Rowand The values of enum of_overlay_notify_action are used to index into array of_overlay_action_name. Add an entry to of_overlay_action_name for the value recently added to of_overlay_notify_action. Array of_overlay_action_name[] is moved into include/linux/of.h adjacent to enum of_overlay_notify_action to make the connection between the two more obvious if either is modified in the future. The only use of of_overlay_action_name is for error reporting in overlay_notify(). All callers of overlay_notify() report the same error, but with fewer details. Remove the redundant error reports in the callers. Fixes: 067c098766c6 ("of: overlay: rework overlay apply and remove kfree()s= ") Reported-by: Dan Carpenter Signed-off-by: Frank Rowand --- drivers/of/overlay.c | 27 +++++---------------------- include/linux/of.h | 13 +++++++++++++ 2 files changed, 18 insertions(+), 22 deletions(-) diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c index 64588bff99ce..48c240b06d3b 100644 --- a/drivers/of/overlay.c +++ b/drivers/of/overlay.c @@ -152,13 +152,6 @@ int of_overlay_notifier_unregister(struct notifier_blo= ck *nb) } EXPORT_SYMBOL_GPL(of_overlay_notifier_unregister); =20 -static char *of_overlay_action_name[] =3D { - "pre-apply", - "post-apply", - "pre-remove", - "post-remove", -}; - static int overlay_notify(struct overlay_changeset *ovcs, enum of_overlay_notify_action action) { @@ -180,7 +173,7 @@ static int overlay_notify(struct overlay_changeset *ovc= s, if (ret) { ret =3D notifier_to_errno(ret); pr_err("overlay changeset %s notifier error %d, target: %pOF\n", - of_overlay_action_name[action], ret, nd.target); + of_overlay_action_name(action), ret, nd.target); return ret; } } @@ -927,10 +920,8 @@ static int of_overlay_apply(struct overlay_changeset *= ovcs) goto out; =20 ret =3D overlay_notify(ovcs, OF_OVERLAY_PRE_APPLY); - if (ret) { - pr_err("overlay changeset pre-apply notify error %d\n", ret); + if (ret) goto out; - } =20 ret =3D build_changeset(ovcs); if (ret) @@ -953,12 +944,9 @@ static int of_overlay_apply(struct overlay_changeset *= ovcs) /* notify failure is not fatal, continue */ =20 ret_tmp =3D overlay_notify(ovcs, OF_OVERLAY_POST_APPLY); - if (ret_tmp) { - pr_err("overlay changeset post-apply notify error %d\n", - ret_tmp); + if (ret_tmp) if (!ret) ret =3D ret_tmp; - } =20 out: pr_debug("%s() err=3D%d\n", __func__, ret); @@ -1194,10 +1182,8 @@ int of_overlay_remove(int *ovcs_id) } =20 ret =3D overlay_notify(ovcs, OF_OVERLAY_PRE_REMOVE); - if (ret) { - pr_err("overlay changeset pre-remove notify error %d\n", ret); + if (ret) goto err_unlock; - } =20 ret_apply =3D 0; ret =3D __of_changeset_revert_entries(&ovcs->cset, &ret_apply); @@ -1220,12 +1206,9 @@ int of_overlay_remove(int *ovcs_id) * OF_OVERLAY_POST_REMOVE returns an error. */ ret_tmp =3D overlay_notify(ovcs, OF_OVERLAY_POST_REMOVE); - if (ret_tmp) { - pr_err("overlay changeset post-remove notify error %d\n", - ret_tmp); + if (ret_tmp) if (!ret) ret =3D ret_tmp; - } =20 free_overlay_changeset(ovcs); =20 diff --git a/include/linux/of.h b/include/linux/of.h index 17741eee0ca4..f0a5d6b10c5a 100644 --- a/include/linux/of.h +++ b/include/linux/of.h @@ -1550,6 +1550,19 @@ enum of_overlay_notify_action { OF_OVERLAY_POST_REMOVE, }; =20 +static inline char *of_overlay_action_name(enum of_overlay_notify_action a= ction) +{ + static char *of_overlay_action_name[] =3D { + "init", + "pre-apply", + "post-apply", + "pre-remove", + "post-remove", + }; + + return of_overlay_action_name[action]; +} + struct of_overlay_notify_data { struct device_node *overlay; struct device_node *target; --=20 Frank Rowand From nobody Sun May 10 15:07:03 2026 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 14E89C433EF for ; Sun, 1 May 2022 00:06:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238580AbiEAAJb (ORCPT ); Sat, 30 Apr 2022 20:09:31 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33272 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237497AbiEAAJV (ORCPT ); Sat, 30 Apr 2022 20:09:21 -0400 Received: from mail-il1-x134.google.com (mail-il1-x134.google.com [IPv6:2607:f8b0:4864:20::134]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7EDA71DA5E; Sat, 30 Apr 2022 17:05:57 -0700 (PDT) Received: by mail-il1-x134.google.com with SMTP id z12so6090713ilp.8; Sat, 30 Apr 2022 17:05:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=rx+5hqspyYEyjq5noUkF2cS/DIWViWG2PCaIwLb1HGc=; b=K9lNJB6mzLNUiS/jeSoegXzAM30vWfOuOYa9fnrnWYstdO/q129ZOwmQ8j5Un2yvQO 0HZ/AvGuO/smdoKVUjOghXRIQ5xjAY/n+66IxO+b950ofpngpE9SvR2Cl/DVfsEqFOhE T0GKtvk70WcaF2Fwh1pHjQSIb150EM6Kg3cS3u2go+kllSyeYhDaUxxwK+dRi1vBfhxW 3QTUep3KOBbXqhLXepFFfXxa/DW26MSoV2U4GbVwt1FjVkg/VvX43bXQU/qv9ILuL/Vl c7vNOfErOc6WsagwdJ8gcRELOtcrp38WyQKvgigLT0RTZBC8NVBQMp+RuyoCjPHEP9q+ Ilng== 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:mime-version:content-transfer-encoding; bh=rx+5hqspyYEyjq5noUkF2cS/DIWViWG2PCaIwLb1HGc=; b=b7Fxh6FW2NPdDh8WdFbYFqoCYlFlEdp1jSFzODMaVjbIzYv50FSCulAkpesMcKcXLy TKVrJPXKw9ZT043RsCxLYV6Q8qVqJMNsFazuM966D8z2RUzMCbTnRDQaANCsS8mRT361 Re6/1qNRjpTHk2dYfXj0OgzIUjDy4HZEZrs5qiFj1fAd3D/tFts6/vykhlFoYvrROE+H owUwsLvIe3SOaiZGwtuILy360hjgujgeyWpGfYEJrF2Ef3zSUaR8kaNE0hJVbrN8NJ6Y Kp1hmiAcIkx0rI3pH0rEDQaoVH2e49yo4FBTWaNT5HB48KmsS+JPBOiQknOxW9v8LyOG vaaQ== X-Gm-Message-State: AOAM530lCHCnGUuQxkEL6Tr1UWy9vmACjrn0GvaU97a/Jxr6/zysP6Dk sdx60UIurakYllaTjFcM5QfWVq4j65Y= X-Google-Smtp-Source: ABdhPJxG9ftLXf/jzsFjL5Cdz2mytER5t8dFm0RDb2CkYvhGsWZuncsWIns+/1LY0yXH7SJEmujJkQ== X-Received: by 2002:a05:6e02:8ae:b0:2c7:90a5:90b8 with SMTP id a14-20020a056e0208ae00b002c790a590b8mr2379536ilt.19.1651363556849; Sat, 30 Apr 2022 17:05:56 -0700 (PDT) Received: from xps8900.attlocal.net ([2600:1700:2442:6db0:809b:de5d:7e0a:bf83]) by smtp.gmail.com with ESMTPSA id n13-20020a92d9cd000000b002cde6e352dcsm1567160ilq.38.2022.04.30.17.05.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 30 Apr 2022 17:05:56 -0700 (PDT) From: frowand.list@gmail.com To: Rob Herring , pantelis.antoniou@konsulko.com, Slawomir Stepien , Dan Carpenter Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, Slawomir Stepien , Jan Kiszka , Geert Uytterhoeven Subject: [PATCH 2/3] of: overlay: unittest: add tests for overlay notifiers Date: Sat, 30 Apr 2022 19:05:42 -0500 Message-Id: <20220501000543.1368005-3-frowand.list@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220501000543.1368005-1-frowand.list@gmail.com> References: <20220501000543.1368005-1-frowand.list@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Frank Rowand Add tests for overlay apply and remove notifiers. Trigger errors for each of the notifier actions. These tests will reveal a memory leak problem when a notifier returns an error for action OF_OVERLAY_POST_APPLY. The pr_err() message is: OF: ERROR: memory leak, expected refcount 1 instead of 3, of_node_get()/of_node_put() unbalanced - destroy cset entry: attach overlay node /testcase-data/overlay-node/test-bus/test-unittest17 Signed-off-by: Frank Rowand --- =3D=3D=3D Output of the new overlay notifier unittests, as filtered by scripts/dtc/of_unittest_expect: ### dt-test ### pass of_unittest_overlay_notify():2825 ok OF: overlay: overlay changeset pre-apply notifier error -16, target: /te= stcase-data/overlay-node/test-bus ### dt-test ### pass of_unittest_overlay_notify():2846 ### dt-test ### pass of_unittest_overlay_notify():2851 ok OF: overlay: overlay changeset post-apply notifier error -17, target: /t= estcase-data/overlay-node/test-bus OF: ERROR: memory leak, expected refcount 1 instead of 3, of_node_get()/= of_node_put() unbalanced - destroy cset entry: attach overlay node /testcas= e-data/overlay-node/test-bus/test-unittest17 ### dt-test ### pass of_unittest_overlay_notify():2857 ### dt-test ### pass of_unittest_overlay_notify():2862 ### dt-test ### pass of_unittest_overlay_notify():2866 ### dt-test ### pass of_unittest_overlay_notify():2869 ok OF: overlay: overlay changeset pre-remove notifier error -18, target: /t= estcase-data/overlay-node/test-bus ### dt-test ### pass of_unittest_overlay_notify():2880 ### dt-test ### pass of_unittest_overlay_notify():2888 ### dt-test ### pass of_unittest_overlay_notify():2892 ### dt-test ### pass of_unittest_overlay_notify():2895 ok OF: overlay: overlay changeset post-remove notifier error -19, target: /= testcase-data/overlay-node/test-bus ### dt-test ### pass of_unittest_overlay_notify():2902 ### dt-test ### pass of_unittest_overlay_notify():2909 ### dt-test ### pass of_unittest_overlay_notify():2914 ### dt-test ### pass of_unittest_overlay_notify():2926 Note that four new kernel error messages are triggered by the new tests, and of_unittest_expect labels them as expected errors with the string 'ok ' in the first three columns. A fifth new kernel error message is a real bug, which will be fixed in patch 3/3: OF: ERROR: memory leak, expected refcount 1 instead of 3, of_node_get()/= of_node_put() unbalanced - destroy cset entry: attach overlay node /testcas= e-data/overlay-node/test-bus/test-unittest17 drivers/of/unittest-data/Makefile | 10 ++ drivers/of/unittest-data/overlay_16.dts | 15 ++ drivers/of/unittest-data/overlay_17.dts | 15 ++ drivers/of/unittest-data/overlay_18.dts | 15 ++ drivers/of/unittest-data/overlay_19.dts | 15 ++ drivers/of/unittest-data/overlay_20.dts | 15 ++ drivers/of/unittest.c | 198 ++++++++++++++++++++++++ 7 files changed, 283 insertions(+) create mode 100644 drivers/of/unittest-data/overlay_16.dts create mode 100644 drivers/of/unittest-data/overlay_17.dts create mode 100644 drivers/of/unittest-data/overlay_18.dts create mode 100644 drivers/of/unittest-data/overlay_19.dts create mode 100644 drivers/of/unittest-data/overlay_20.dts diff --git a/drivers/of/unittest-data/Makefile b/drivers/of/unittest-data/M= akefile index fbded24c608c..d072f3ba3971 100644 --- a/drivers/of/unittest-data/Makefile +++ b/drivers/of/unittest-data/Makefile @@ -17,6 +17,11 @@ obj-$(CONFIG_OF_OVERLAY) +=3D overlay.dtb.o \ overlay_12.dtb.o \ overlay_13.dtb.o \ overlay_15.dtb.o \ + overlay_16.dtb.o \ + overlay_17.dtb.o \ + overlay_18.dtb.o \ + overlay_19.dtb.o \ + overlay_20.dtb.o \ overlay_bad_add_dup_node.dtb.o \ overlay_bad_add_dup_prop.dtb.o \ overlay_bad_phandle.dtb.o \ @@ -75,6 +80,11 @@ apply_static_overlay_1 :=3D overlay_0.dtbo \ overlay_12.dtbo \ overlay_13.dtbo \ overlay_15.dtbo \ + overlay_16.dtbo \ + overlay_17.dtbo \ + overlay_18.dtbo \ + overlay_19.dtbo \ + overlay_20.dtbo \ overlay_gpio_01.dtbo \ overlay_gpio_02a.dtbo \ overlay_gpio_02b.dtbo \ diff --git a/drivers/of/unittest-data/overlay_16.dts b/drivers/of/unittest-= data/overlay_16.dts new file mode 100644 index 000000000000..80a46dc02581 --- /dev/null +++ b/drivers/of/unittest-data/overlay_16.dts @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: GPL-2.0 +/dts-v1/; +/plugin/; + +/* overlay_16 - notify test */ + +&unittest_test_bus { + #address-cells =3D <1>; + #size-cells =3D <0>; + + test-unittest16 { + compatible =3D "unittest"; + reg =3D <16>; + }; +}; diff --git a/drivers/of/unittest-data/overlay_17.dts b/drivers/of/unittest-= data/overlay_17.dts new file mode 100644 index 000000000000..5b8a2209177f --- /dev/null +++ b/drivers/of/unittest-data/overlay_17.dts @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: GPL-2.0 +/dts-v1/; +/plugin/; + +/* overlay_17 - notify test */ + +&unittest_test_bus { + #address-cells =3D <1>; + #size-cells =3D <0>; + + test-unittest17 { + compatible =3D "unittest"; + reg =3D <17>; + }; +}; diff --git a/drivers/of/unittest-data/overlay_18.dts b/drivers/of/unittest-= data/overlay_18.dts new file mode 100644 index 000000000000..dcddd5f6d301 --- /dev/null +++ b/drivers/of/unittest-data/overlay_18.dts @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: GPL-2.0 +/dts-v1/; +/plugin/; + +/* overlay_18 - notify test */ + +&unittest_test_bus { + #address-cells =3D <1>; + #size-cells =3D <0>; + + test-unittest18 { + compatible =3D "unittest"; + reg =3D <18>; + }; +}; diff --git a/drivers/of/unittest-data/overlay_19.dts b/drivers/of/unittest-= data/overlay_19.dts new file mode 100644 index 000000000000..32b3ba0b66a3 --- /dev/null +++ b/drivers/of/unittest-data/overlay_19.dts @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: GPL-2.0 +/dts-v1/; +/plugin/; + +/* overlay_19 - notify test */ + +&unittest_test_bus { + #address-cells =3D <1>; + #size-cells =3D <0>; + + test-unittest19 { + compatible =3D "unittest"; + reg =3D <19>; + }; +}; diff --git a/drivers/of/unittest-data/overlay_20.dts b/drivers/of/unittest-= data/overlay_20.dts new file mode 100644 index 000000000000..d4a4f2f32ec7 --- /dev/null +++ b/drivers/of/unittest-data/overlay_20.dts @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: GPL-2.0 +/dts-v1/; +/plugin/; + +/* overlay_20 - notify test */ + +&unittest_test_bus { + #address-cells =3D <1>; + #size-cells =3D <0>; + + test-unittest20 { + compatible =3D "unittest"; + reg =3D <20>; + }; +}; diff --git a/drivers/of/unittest.c b/drivers/of/unittest.c index c4106de9f137..e28c3df2c4c2 100644 --- a/drivers/of/unittest.c +++ b/drivers/of/unittest.c @@ -2741,6 +2741,192 @@ static inline void of_unittest_overlay_i2c_15(void)= { } =20 #endif =20 +static int of_notify(struct notifier_block *nb, unsigned long action, + void *arg) +{ + struct of_overlay_notify_data *nd =3D arg; + struct device_node *found; + int ret; + + /* + * For overlay_16 .. overlay_19, check that returning an error + * works for each of the actions by setting an arbitrary return + * error number that matches the test number. e.g. for unittest16, + * ret =3D -EBUSY which is -16. + * + * OVERLAY_INFO() for the overlays is declared to expect the same + * error number, so overlay_data_apply() will return no error. + * + * overlay_20 will return NOTIFY_DONE + */ + + ret =3D 0; + of_node_get(nd->overlay); + + switch (action) { + + case OF_OVERLAY_PRE_APPLY: + found =3D of_find_node_by_name(nd->overlay, "test-unittest16"); + if (found) { + of_node_put(found); + ret =3D -EBUSY; + } + break; + + case OF_OVERLAY_POST_APPLY: + found =3D of_find_node_by_name(nd->overlay, "test-unittest17"); + if (found) { + of_node_put(found); + ret =3D -EEXIST; + } + break; + + case OF_OVERLAY_PRE_REMOVE: + found =3D of_find_node_by_name(nd->overlay, "test-unittest18"); + if (found) { + of_node_put(found); + ret =3D -EXDEV; + } + break; + + case OF_OVERLAY_POST_REMOVE: + found =3D of_find_node_by_name(nd->overlay, "test-unittest19"); + if (found) { + of_node_put(found); + ret =3D -ENODEV; + } + break; + + default: /* should not happen */ + of_node_put(nd->overlay); + ret =3D -EINVAL; + break; + } + + if (ret) + return notifier_from_errno(ret); + + return NOTIFY_DONE; +} + +static struct notifier_block of_nb =3D { + .notifier_call =3D of_notify, +}; + + + + +static void __init of_unittest_overlay_notify(void) +{ + int ovcs_id; + int ret; + + ret =3D of_overlay_notifier_register(&of_nb); + unittest(!ret, + "of_overlay_notifier_register() failed, ret =3D %d\n", ret); + if (ret) + return; + + /* + * The overlays are applied by overlay_data_apply() + * instead of of_unittest_apply_overlay() so that they + * will not be tracked. Thus they will not be removed + * by of_unittest_remove_tracked_overlays(). + * + * Applying overlays 16 - 19 will each trigger an error for a + * different action in of_notify(). + * + * Applying overlay 20 will not trigger any error in of_notify(). + */ + + /* --- overlay 16 --- */ + + EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifie= r error -16, target: /testcase-data/overlay-node/test-bus"); + + unittest(overlay_data_apply("overlay_16", &ovcs_id), + "test OF_OVERLAY_PRE_APPLY notify injected error\n"); + + EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier = error -16, target: /testcase-data/overlay-node/test-bus"); + + unittest(!ovcs_id, "ovcs_id created for overlay_16\n"); + + /* --- overlay 17 --- */ + + EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-apply notifi= er error -17, target: /testcase-data/overlay-node/test-bus"); + + unittest(overlay_data_apply("overlay_17", &ovcs_id), + "test OF_OVERLAY_POST_APPLY notify injected error\n"); + + EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier= error -17, target: /testcase-data/overlay-node/test-bus"); + + unittest(!ovcs_id, "ovcs_id created for overlay_17\n"); + + /* --- overlay 18 --- */ + + unittest(overlay_data_apply("overlay_18", &ovcs_id), + "OF_OVERLAY_PRE_REMOVE notify injected error\n"); + + unittest(ovcs_id, "ovcs_id not created for overlay_18\n"); + + if (ovcs_id) { + EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset pre-remove notif= ier error -18, target: /testcase-data/overlay-node/test-bus"); + + ret =3D of_overlay_remove(&ovcs_id); + EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-remove notifie= r error -18, target: /testcase-data/overlay-node/test-bus"); + if (ret =3D=3D -EXDEV) { + /* + * change set ovcs_id should still exist + */ + unittest(1, "overlay_18 of_overlay_remove() injected error for OF_OVERL= AY_PRE_REMOVE\n"); + } else { + unittest(0, "overlay_18 of_overlay_remove() injected error for OF_OVERL= AY_PRE_REMOVE not returned\n"); + } + } else { + unittest(1, "ovcs_id not created for overlay_18\n"); + } + + unittest(ovcs_id, "ovcs_id removed for overlay_18\n"); + + /* --- overlay 19 --- */ + + unittest(overlay_data_apply("overlay_19", &ovcs_id), + "OF_OVERLAY_POST_REMOVE notify injected error\n"); + + unittest(ovcs_id, "ovcs_id not created for overlay_19\n"); + + if (ovcs_id) { + EXPECT_BEGIN(KERN_INFO, "OF: overlay: overlay changeset post-remove noti= fier error -19, target: /testcase-data/overlay-node/test-bus"); + ret =3D of_overlay_remove(&ovcs_id); + EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-remove notifi= er error -19, target: /testcase-data/overlay-node/test-bus"); + if (ret =3D=3D -ENODEV) + unittest(1, "overlay_19 of_overlay_remove() injected error for OF_OVERL= AY_POST_REMOVE\n"); + else + unittest(0, "overlay_19 of_overlay_remove() injected error for OF_OVERL= AY_POST_REMOVE not returned\n"); + } else { + unittest(1, "ovcs_id removed for overlay_19\n"); + } + + unittest(!ovcs_id, "changeset ovcs_id =3D %d not removed for overlay_19\n= ", + ovcs_id); + + /* --- overlay 20 --- */ + + unittest(overlay_data_apply("overlay_20", &ovcs_id), + "overlay notify no injected error\n"); + + if (ovcs_id) { + ret =3D of_overlay_remove(&ovcs_id); + if (ret) + unittest(1, "overlay_20 failed to be destroyed, ret =3D %d\n", + ret); + } else { + unittest(1, "ovcs_id not created for overlay_20\n"); + } + + unittest(!of_overlay_notifier_unregister(&of_nb), + "of_overlay_notifier_unregister() failed, ret =3D %d\n", ret); +} + static void __init of_unittest_overlay(void) { struct device_node *bus_np =3D NULL; @@ -2804,6 +2990,8 @@ static void __init of_unittest_overlay(void) =20 of_unittest_remove_tracked_overlays(); =20 + of_unittest_overlay_notify(); + out: of_node_put(bus_np); } @@ -2855,6 +3043,11 @@ OVERLAY_INFO_EXTERN(overlay_11); OVERLAY_INFO_EXTERN(overlay_12); OVERLAY_INFO_EXTERN(overlay_13); OVERLAY_INFO_EXTERN(overlay_15); +OVERLAY_INFO_EXTERN(overlay_16); +OVERLAY_INFO_EXTERN(overlay_17); +OVERLAY_INFO_EXTERN(overlay_18); +OVERLAY_INFO_EXTERN(overlay_19); +OVERLAY_INFO_EXTERN(overlay_20); OVERLAY_INFO_EXTERN(overlay_gpio_01); OVERLAY_INFO_EXTERN(overlay_gpio_02a); OVERLAY_INFO_EXTERN(overlay_gpio_02b); @@ -2885,6 +3078,11 @@ static struct overlay_info overlays[] =3D { OVERLAY_INFO(overlay_12, 0), OVERLAY_INFO(overlay_13, 0), OVERLAY_INFO(overlay_15, 0), + OVERLAY_INFO(overlay_16, -EBUSY), + OVERLAY_INFO(overlay_17, -EEXIST), + OVERLAY_INFO(overlay_18, 0), + OVERLAY_INFO(overlay_19, 0), + OVERLAY_INFO(overlay_20, 0), OVERLAY_INFO(overlay_gpio_01, 0), OVERLAY_INFO(overlay_gpio_02a, 0), OVERLAY_INFO(overlay_gpio_02b, 0), --=20 Frank Rowand From nobody Sun May 10 15:07:03 2026 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 55BD6C433EF for ; Sun, 1 May 2022 00:06:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238919AbiEAAJg (ORCPT ); Sat, 30 Apr 2022 20:09:36 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33298 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237705AbiEAAJV (ORCPT ); Sat, 30 Apr 2022 20:09:21 -0400 Received: from mail-io1-xd33.google.com (mail-io1-xd33.google.com [IPv6:2607:f8b0:4864:20::d33]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6CE38205D6; Sat, 30 Apr 2022 17:05:58 -0700 (PDT) Received: by mail-io1-xd33.google.com with SMTP id m6so9021298iob.4; Sat, 30 Apr 2022 17:05:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=fmRz1ww2hntYhSKRq/16Hr+8zlIhz/D9VnEyrgYQiW0=; b=jzj3NYMKubS/aJMg5kYwhjzpXtDMXBQxn4A+0O4dLAPeRXAI4YWlqvjNt5/F8lr0tv ly1aJjQ2GsoIKz6tfEGKWAZyqaNCp6H6JCSm67dF7MFSnaKH3XJ9FjzPrG+sgTniYrjQ Ub3lSACAtRTX/wrWKnHyji7Sif/84qf1YEkmziRk8jVUp7tuPUF5qAUVibnye7dIgG3Y 47A1Qhv1/6yxkuF//bPvTDjxySDgIpOFl9LXJi8u6emUihrfI3YuwC+l/w5xg2czg18d pifw5bSaApdNh560tLUZE5Os8e4npV1qtKo/NJ0MGPYVrOIN5ttf/is5u3OlnmgLIsCK UwHA== 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:mime-version:content-transfer-encoding; bh=fmRz1ww2hntYhSKRq/16Hr+8zlIhz/D9VnEyrgYQiW0=; b=XGC60+JlL3XHO3sM+GLSMKzuUgT5mktHJk4kBkiZ0wkIgCFFeSl+3EH+uF3fSeb9gx YEdkGcH8uIuCTJ5/atKPKBr1l74LuuVsl0bwKh8wwhR/z7ZnCxaeeMnqqqrmnIFzgJqq PF60vLXId0upMrb3ohN8IXuCaeoDLbQ41x74ECl9ZN2QULm7GnwHpHXyMmpbC57ebxyR QM+1FcAo9161D6DNfk7wopr8noszmruQKQ6yIRCSd6YZLEYfbzxyb+x5NfwfukHhCusH Hb4px/IZjduIdLgpyH0l/h8Jlb+IKm3wXZYPqny3gvhk9avSzCj4QsVV6GDZHgHMPVGu l8eA== X-Gm-Message-State: AOAM531crm/AlGqImcxDflTs8NA5jYyGgxIzVFjG3SPnf/g6ndS0XxId WitZAsem8i1PGwfsu+KuO74= X-Google-Smtp-Source: ABdhPJxSL81YunTahBT5wZ38W0/tBod3rFQZc3VTh1msEut9Ln5nAtLdBw0XzW/nTTadc6zEdW55tg== X-Received: by 2002:a05:6638:2643:b0:32a:cce3:e533 with SMTP id n3-20020a056638264300b0032acce3e533mr2490754jat.24.1651363557854; Sat, 30 Apr 2022 17:05:57 -0700 (PDT) Received: from xps8900.attlocal.net ([2600:1700:2442:6db0:809b:de5d:7e0a:bf83]) by smtp.gmail.com with ESMTPSA id n13-20020a92d9cd000000b002cde6e352dcsm1567160ilq.38.2022.04.30.17.05.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 30 Apr 2022 17:05:57 -0700 (PDT) From: frowand.list@gmail.com To: Rob Herring , pantelis.antoniou@konsulko.com, Slawomir Stepien , Dan Carpenter Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, Slawomir Stepien , Jan Kiszka , Geert Uytterhoeven Subject: [PATCH 3/3] of: overlay: do not free changeset when of_overlay_apply returns error Date: Sat, 30 Apr 2022 19:05:43 -0500 Message-Id: <20220501000543.1368005-4-frowand.list@gmail.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220501000543.1368005-1-frowand.list@gmail.com> References: <20220501000543.1368005-1-frowand.list@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Frank Rowand New unittests for overlay notifiers reveal a memory leak in of_overlay_apply() when a notifier returns an error for action OF_OVERLAY_POST_APPLY. The pr_err() message is: OF: ERROR: memory leak, expected refcount 1 instead of 3, of_node_get()/of_node_put() unbalanced - destroy cset entry: attach overlay node /testcase-data/overlay-node/test-bus/test-unittest17 Change the error path to no longer call free_overlay_changeset(), and document that the caller of of_overlay_fdt_apply() may choose to remove the overlay. Update the unittest that triggered the error to expect the changed return values and to call of_overlay_remove(). Signed-off-by: Frank Rowand --- =3D=3D=3D Output of the new overlay notifier unittests, as filtered by scripts/dtc/of_unittest_expect: ### dt-test ### pass of_unittest_overlay_notify():2825 ok OF: overlay: overlay changeset pre-apply notifier error -16, target: /te= stcase-data/overlay-node/test-bus ### dt-test ### pass of_unittest_overlay_notify():2846 ### dt-test ### pass of_unittest_overlay_notify():2851 ok OF: overlay: overlay changeset post-apply notifier error -17, target: /t= estcase-data/overlay-node/test-bus ### dt-test ### pass of_unittest_overlay_notify():2857 ### dt-test ### pass of_unittest_overlay_notify():2862 ### dt-test ### pass of_unittest_overlay_notify():2866 ### dt-test ### pass of_unittest_overlay_notify():2872 ### dt-test ### pass of_unittest_overlay_notify():2875 ok OF: overlay: overlay changeset pre-remove notifier error -18, target: /t= estcase-data/overlay-node/test-bus ### dt-test ### pass of_unittest_overlay_notify():2886 ### dt-test ### pass of_unittest_overlay_notify():2894 ### dt-test ### pass of_unittest_overlay_notify():2898 ### dt-test ### pass of_unittest_overlay_notify():2901 ok OF: overlay: overlay changeset post-remove notifier error -19, target: /= testcase-data/overlay-node/test-bus ### dt-test ### pass of_unittest_overlay_notify():2908 ### dt-test ### pass of_unittest_overlay_notify():2915 ### dt-test ### pass of_unittest_overlay_notify():2920 ### dt-test ### pass of_unittest_overlay_notify():2932 drivers/of/overlay.c | 29 ++++++++++++++++++++++++++--- drivers/of/unittest.c | 10 ++++++++-- 2 files changed, 34 insertions(+), 5 deletions(-) diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c index 48c240b06d3b..4c1ac36216b8 100644 --- a/drivers/of/overlay.c +++ b/drivers/of/overlay.c @@ -954,6 +954,25 @@ static int of_overlay_apply(struct overlay_changeset *= ovcs) return ret; } =20 +/* + * of_overlay_fdt_apply() - Create and apply an overlay changeset + * @overlay_fdt: pointer to overlay FDT + * @overlay_fdt_size: number of bytes in @overlay_fdt + * @ret_ovcs_id: pointer for returning created changeset id + * + * Creates and applies an overlay changeset. + * + * See of_overlay_apply() for important behavior information. + * + * Return: 0 on success, or a negative error number. *@ret_ovcs_id is set= to + * the value of overlay changeset id, which can be passed to of_overlay_re= move() + * to remove the overlay. + * + * On error return, the changeset may be partially applied. This is espec= ially + * likely if an OF_OVERLAY_POST_APPLY notifier returns an error. In this = case + * the caller should call of_overlay_remove() with the value in *@ret_ovcs= _id. + */ + int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size, int *ret_ovcs_id) { @@ -1021,15 +1040,19 @@ int of_overlay_fdt_apply(const void *overlay_fdt, u= 32 overlay_fdt_size, ovcs->overlay_mem =3D overlay_mem; =20 ret =3D of_overlay_apply(ovcs); - if (ret < 0) - goto err_free_ovcs; + /* + * If of_overlay_apply() error, calling free_overlay_changeset() may + * result in a memory leak if the apply partly succeeded, so do NOT + * goto err_free_ovcs. Instead, the caller of of_overlay_fdt_apply() + * can call of_overlay_remove(); + */ =20 mutex_unlock(&of_mutex); of_overlay_mutex_unlock(); =20 *ret_ovcs_id =3D ovcs->id; =20 - return 0; + return ret; =20 err_free_ovcs: free_overlay_changeset(ovcs); diff --git a/drivers/of/unittest.c b/drivers/of/unittest.c index e28c3df2c4c2..dff55ae09d97 100644 --- a/drivers/of/unittest.c +++ b/drivers/of/unittest.c @@ -2848,7 +2848,7 @@ static void __init of_unittest_overlay_notify(void) =20 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset pre-apply notifier = error -16, target: /testcase-data/overlay-node/test-bus"); =20 - unittest(!ovcs_id, "ovcs_id created for overlay_16\n"); + unittest(ovcs_id, "ovcs_id not created for overlay_16\n"); =20 /* --- overlay 17 --- */ =20 @@ -2859,7 +2859,13 @@ static void __init of_unittest_overlay_notify(void) =20 EXPECT_END(KERN_INFO, "OF: overlay: overlay changeset post-apply notifier= error -17, target: /testcase-data/overlay-node/test-bus"); =20 - unittest(!ovcs_id, "ovcs_id created for overlay_17\n"); + unittest(ovcs_id, "ovcs_id not created for overlay_17\n"); + + if (ovcs_id) { + ret =3D of_overlay_remove(&ovcs_id); + unittest(!ret, + "overlay_17 of_overlay_remove(), ret =3D %d\n", ret); + } =20 /* --- overlay 18 --- */ =20 --=20 Frank Rowand