Message-ID: <6dcb55104d5065d30a9dab4bca878922.sboyd@kernel.org>
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
In-Reply-To: <20230215232712.17072-1-ansuelsmth@gmail.com>
References: <20230215232712.17072-1-ansuelsmth@gmail.com>
Subject: Re: [PATCH] clk: Fix wrong clock returned in parent_data with .name and no .index
From:   Stephen Boyd <sboyd@kernel.org>
Cc:     Christian Marangi <ansuelsmth@gmail.com>,
        Miquel Raynal <miquel.raynal@bootlin.com>,
        Jerome Brunet <jbrunet@baylibre.com>,
        Russell King <linux@armlinux.org.uk>,
        Jeffrey Hugo <jhugo@codeaurora.org>,
        Chen-Yu Tsai <wens@csie.org>
To:     Christian Marangi <ansuelsmth@gmail.com>,
        Michael Turquette <mturquette@baylibre.com>,
        linux-clk@vger.kernel.org, linux-kernel@vger.kernel.org
Date:   Fri, 17 Feb 2023 14:11:20 -0800
User-Agent: alot/0.10
Precedence: bulk

Quoting Christian Marangi (2023-02-15 15:27:12)
> Commit 601b6e93304a ("clk: Allow parents to be specified via clkspec inde=
x")
> introduced a regression due to a "fragile" implementation present in some=
 very
> corner case.
>=20
> Such commit introduced the support for parents to be specified using
> clkspec index. The index is an int and should be -1 if the feature
> should not be used. This is the case with parent_hws or legacy
> parent_names used and the index value is set to -1 by default.
> With parent_data the situation is different, since it's a struct that
> can have multiple value (.index, .name, .fw_name), it's init to all 0 by
> default. This cause the index value to be set to 0 everytime even if not

It's only initialized to all 0 because that's what you've decided to do.
It could be on the stack and have random stack junk values.

> intended to be defined and used.
>=20
> This simple "fragile" implementation cause side-effect and unintended
> behaviour.
>=20
> Assuming the following scenario (to repro the corner case and doesn't
> reflect real code):
>=20
> In dt we have a node like this:
>                 acc1: clock-controller@2098000 {
>                         compatible =3D "qcom,kpss-acc-v1";
>                         reg =3D <0x02098000 0x1000>, <0x02008000 0x1000>;
>                         clock-output-names =3D "acpu1_aux";
>                         clocks =3D <&pxo_board>;
>                         clock-names =3D "pxo";
>                         #clock-cells =3D <0>;
>                 };
>=20
> And on the relevant driver we have the parent data defined as such:
>                 static const struct clk_parent_data aux_parents[] =3D {
>                         { .name =3D "pll8_vote" },
>                         { .fw_name =3D "pxo", .name =3D "pxo_board" },
>                 };
>=20
> Someone would expect the first parent to be globally searched and set to
> point to the clock named "pll8_vote".
> But this is not the case and instead under the hood, the parent point to
> the pxo clock. This happen without any warning and was discovered on
> another platform while the gcc driver was converted to parent_data and
> only .name was defined.

You didn't set .index explicitly to zero, but it is zero because of the
use of static struct initializers here. If the struct was on the stack
nobody knows what the value would be. Set -1 if you don't want to use
the index lookup path.