[1/2,next] clk: visconti: Fix undefined behavior bug in struct visconti_pll_provider
Message ID | 0a59a721d54b557076cc94eabeb694d463773204.1697076650.git.gustavoars@kernel.org |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:612c:2908:b0:403:3b70:6f57 with SMTP id ib8csp936422vqb; Wed, 11 Oct 2023 19:18:03 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHrA8cADDbvmfAqsGyFuTzBICVtEnjE92boZo6EVojXSird2fPVpE/2gzvwbYvWrNTUFLzD X-Received: by 2002:a17:90a:3da1:b0:274:60c7:e15a with SMTP id i30-20020a17090a3da100b0027460c7e15amr20346211pjc.4.1697077083018; Wed, 11 Oct 2023 19:18:03 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1697077083; cv=none; d=google.com; s=arc-20160816; b=OaocpV0zBj+C/ldvBuL12XAGkJnBqmMOL7St6lIkqgLtwFvSLBHibxbRVkD1FukAia fBWaY87rtKyBv+JxJP5thsnc7cVHN+GqVMHy7TdX7AguaeoBcPazySeyxEEdQgENluK9 k1HP8/eC5QnGzIoklxgVgIhRTjZHL5L075KnC21ojHm+cnJv/gHcwEy8dn11JuiVy3d0 B23Iy6LfB/wo8Lb0CgyU4G1L6+WAbXB01XIdtMfKjDJ9+7VvdvSmMKX1Fv2QBPCv/IjI q9eAKENHpzZs55Ji+4kf/GhLgiq9v5kNQeW/YpbKQz69WqIIzY+kNd7/hI+KiCCIx9bl znBw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:in-reply-to:content-disposition:mime-version :references:message-id:subject:cc:to:from:date:dkim-signature; bh=b0EEK//hz1zzqOhZQrfba15e9aQ4Y4bL9hIpd+ldVVQ=; fh=gk24IOEycqD+6u11idkE8VXvRMctSQA5r+DBdFry3D0=; b=V0tPRBSeibRxvoEZFbDnzUK2zHcCroKIz+TP6SIbWRblVG9z6M5DH4m9GDO1zMrbN1 FXqDJjfsy3k2JB23wO37n5kXRXHDGwftKMYfmpRpfmG81JWsWkbyoCoRk96V24MJa+aU 2dhFW4C3fr6dDXUOrnhR+R5DMClZht3etwfFjDO0rwsQlzRA4gDU11MPWA/hVzquYZyf b3z48SpkLDjohQeUtqgykAbSz06AmYx2ZqfJZji8uco8xEJmK/ScBMl0kzqu4LPqOt3/ vt1VhoPvs1xMZD3/bUF0aGHBQ6FYAzi6yNhnqs7wu3VMAIMg55eSnvbs3BTSBGivKHr4 PyFw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=Lg46DKy1; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from pete.vger.email (pete.vger.email. [23.128.96.36]) by mx.google.com with ESMTPS id r207-20020a632bd8000000b0058bfcc0f4b7si1124301pgr.473.2023.10.11.19.18.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 11 Oct 2023 19:18:02 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) client-ip=23.128.96.36; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=Lg46DKy1; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by pete.vger.email (Postfix) with ESMTP id 868548199705; Wed, 11 Oct 2023 19:17:58 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at pete.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1376685AbjJLCRm (ORCPT <rfc822;kartikey406@gmail.com> + 18 others); Wed, 11 Oct 2023 22:17:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46432 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232321AbjJLCRl (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Wed, 11 Oct 2023 22:17:41 -0400 Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1F92798; Wed, 11 Oct 2023 19:17:40 -0700 (PDT) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 95431C433C7; Thu, 12 Oct 2023 02:17:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1697077059; bh=GWfBuFj92ThQwSFoJGmNN5lq51idDCBd7SCsrd8jqGY=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=Lg46DKy1m+EfsDO0AGJ0OVNV9j5iFYUVB0G74TlBT1kJjl1S7SeV/Si8q6QJi8WTd z7s6r3dh7LjvKosUTRg7Q6NWSKOyYAPjG4+eIbnCkHYFLnN0hHeIz8v7xHi/L2rodO 8xw39+Rh9BozeGiCu7iikMCLX8o3V7KceKkGGXDVvW9aehv0x6/vxaY7yDuvr72eGV 74MAXDgix+jX59VtehzPAlnmIDNDhOtKwh0UPC6I8oF4LtlBoz4aerGAQG8AOWxNrI ZF2WWBFxN6dNdPWALN4FUZY+2sfWxmd98OEIjc8KlhUhUiO6eZn9QYUukkITVSbOq7 CAWQ1R5FBn5GA== Date: Wed, 11 Oct 2023 20:17:36 -0600 From: "Gustavo A. R. Silva" <gustavoars@kernel.org> To: Michael Turquette <mturquette@baylibre.com>, Stephen Boyd <sboyd@kernel.org>, Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp> Cc: Kees Cook <keescook@chromium.org>, linux-clk@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, "Gustavo A. R. Silva" <gustavoars@kernel.org>, linux-hardening@vger.kernel.org Subject: [PATCH 1/2][next] clk: visconti: Fix undefined behavior bug in struct visconti_pll_provider Message-ID: <0a59a721d54b557076cc94eabeb694d463773204.1697076650.git.gustavoars@kernel.org> References: <cover.1697076650.git.gustavoars@kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <cover.1697076650.git.gustavoars@kernel.org> X-Spam-Status: No, score=2.4 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,MAILING_LIST_MULTI, RCVD_IN_SBL_CSS,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on pete.vger.email Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (pete.vger.email [0.0.0.0]); Wed, 11 Oct 2023 19:17:58 -0700 (PDT) X-Spam-Level: ** X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1779514299370635507 X-GMAIL-MSGID: 1779514299370635507 |
Series |
clk: visconti: Fix undefined behavior bug and add bounds-checking coverage
|
|
Commit Message
Gustavo A. R. Silva
Oct. 12, 2023, 2:17 a.m. UTC
`struct clk_hw_onecell_data` is a flexible structure, which means that
it contains flexible-array member at the bottom, in this case array
`hws`:
include/linux/clk-provider.h:
1380 struct clk_hw_onecell_data {
1381 unsigned int num;
1382 struct clk_hw *hws[] __counted_by(num);
1383 };
This could potentially lead to an overwrite of the objects following
`clk_data` in `struct visconti_pll_provider`, in this case
`struct device_node *node;`, at run-time:
drivers/clk/visconti/pll.h:
16 struct visconti_pll_provider {
17 void __iomem *reg_base;
18 struct clk_hw_onecell_data clk_data;
19 struct device_node *node;
20 };
Notice that a total of 56 bytes are allocated for flexible-array `hws`
at line 328. See below:
include/dt-bindings/clock/toshiba,tmpv770x.h:
14 #define TMPV770X_NR_PLL 7
drivers/clk/visconti/pll-tmpv770x.c:
69 ctx = visconti_init_pll(np, reg_base, TMPV770X_NR_PLL);
drivers/clk/visconti/pll.c:
321 struct visconti_pll_provider * __init visconti_init_pll(struct device_node *np,
322 void __iomem *base,
323 unsigned long nr_plls)
324 {
325 struct visconti_pll_provider *ctx;
...
328 ctx = kzalloc(struct_size(ctx, clk_data.hws, nr_plls), GFP_KERNEL);
`struct_size(ctx, clk_data.hws, nr_plls)` above translates to
sizeof(struct visconti_pll_provider) + sizeof(struct clk_hw *) * 7 ==
24 + 8 * 7 == 24 + 56
^^^^
|
allocated bytes for flex array `hws`
$ pahole -C visconti_pll_provider drivers/clk/visconti/pll.o
struct visconti_pll_provider {
void * reg_base; /* 0 8 */
struct clk_hw_onecell_data clk_data; /* 8 8 */
struct device_node * node; /* 16 8 */
/* size: 24, cachelines: 1, members: 3 */
/* last cacheline: 24 bytes */
};
And then, after the allocation, some data is written into all members
of `struct visconti_pll_provider`:
332 for (i = 0; i < nr_plls; ++i)
333 ctx->clk_data.hws[i] = ERR_PTR(-ENOENT);
334
335 ctx->node = np;
336 ctx->reg_base = base;
337 ctx->clk_data.num = nr_plls;
Fix all these by placing the declaration of object `clk_data` at the
end of `struct visconti_pll_provider`. Also, add a comment to make it
clear that this object must always be last in the structure, and
prevent this bug from being introduced again in the future.
Fixes: b4cbe606dc36 ("clk: visconti: Add support common clock driver and reset driver")
Cc: stable@vger.kernel.org
Signed-off-by: Gustavo A. R. Silva <gustavoars@kernel.org>
---
drivers/clk/visconti/pll.h | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
Comments
On Wed, Oct 11, 2023 at 08:17:36PM -0600, Gustavo A. R. Silva wrote: > `struct clk_hw_onecell_data` is a flexible structure, which means that > it contains flexible-array member at the bottom, in this case array > `hws`: > > include/linux/clk-provider.h: > 1380 struct clk_hw_onecell_data { > 1381 unsigned int num; > 1382 struct clk_hw *hws[] __counted_by(num); > 1383 }; > > This could potentially lead to an overwrite of the objects following > `clk_data` in `struct visconti_pll_provider`, in this case > `struct device_node *node;`, at run-time: > > drivers/clk/visconti/pll.h: > 16 struct visconti_pll_provider { > 17 void __iomem *reg_base; > 18 struct clk_hw_onecell_data clk_data; > 19 struct device_node *node; > 20 }; > > Notice that a total of 56 bytes are allocated for flexible-array `hws` > at line 328. See below: > > include/dt-bindings/clock/toshiba,tmpv770x.h: > 14 #define TMPV770X_NR_PLL 7 > > drivers/clk/visconti/pll-tmpv770x.c: > 69 ctx = visconti_init_pll(np, reg_base, TMPV770X_NR_PLL); > > drivers/clk/visconti/pll.c: > 321 struct visconti_pll_provider * __init visconti_init_pll(struct device_node *np, > 322 void __iomem *base, > 323 unsigned long nr_plls) > 324 { > 325 struct visconti_pll_provider *ctx; > ... > 328 ctx = kzalloc(struct_size(ctx, clk_data.hws, nr_plls), GFP_KERNEL); > > `struct_size(ctx, clk_data.hws, nr_plls)` above translates to > sizeof(struct visconti_pll_provider) + sizeof(struct clk_hw *) * 7 == > 24 + 8 * 7 == 24 + 56 > ^^^^ > | > allocated bytes for flex array `hws` > > $ pahole -C visconti_pll_provider drivers/clk/visconti/pll.o > struct visconti_pll_provider { > void * reg_base; /* 0 8 */ > struct clk_hw_onecell_data clk_data; /* 8 8 */ > struct device_node * node; /* 16 8 */ > > /* size: 24, cachelines: 1, members: 3 */ > /* last cacheline: 24 bytes */ > }; > > And then, after the allocation, some data is written into all members > of `struct visconti_pll_provider`: > > 332 for (i = 0; i < nr_plls; ++i) > 333 ctx->clk_data.hws[i] = ERR_PTR(-ENOENT); > 334 > 335 ctx->node = np; > 336 ctx->reg_base = base; > 337 ctx->clk_data.num = nr_plls; > > Fix all these by placing the declaration of object `clk_data` at the > end of `struct visconti_pll_provider`. Also, add a comment to make it > clear that this object must always be last in the structure, and > prevent this bug from being introduced again in the future. > > Fixes: b4cbe606dc36 ("clk: visconti: Add support common clock driver and reset driver") > Cc: stable@vger.kernel.org > Signed-off-by: Gustavo A. R. Silva <gustavoars@kernel.org> Another good catch. :) Reviewed-by: Kees Cook <keescook@chromium.org>
Hi Gustavo A. R. Silva, Thanks for your patch! > -----Original Message----- > From: Gustavo A. R. Silva <gustavoars@kernel.org> > Sent: Thursday, October 12, 2023 11:18 AM > To: Michael Turquette <mturquette@baylibre.com>; Stephen Boyd > <sboyd@kernel.org>; iwamatsu nobuhiro(岩松 信洋 ○DITC□DIT○O > ST) <nobuhiro1.iwamatsu@toshiba.co.jp> > Cc: Kees Cook <keescook@chromium.org>; linux-clk@vger.kernel.org; > linux-arm-kernel@lists.infradead.org; linux-kernel@vger.kernel.org; Gustavo A. > R. Silva <gustavoars@kernel.org>; linux-hardening@vger.kernel.org > Subject: [PATCH 1/2][next] clk: visconti: Fix undefined behavior bug in struct > visconti_pll_provider > > `struct clk_hw_onecell_data` is a flexible structure, which means that it > contains flexible-array member at the bottom, in this case array > `hws`: > > include/linux/clk-provider.h: > 1380 struct clk_hw_onecell_data { > 1381 unsigned int num; > 1382 struct clk_hw *hws[] __counted_by(num); > 1383 }; > > This could potentially lead to an overwrite of the objects following `clk_data` in > `struct visconti_pll_provider`, in this case `struct device_node *node;`, at > run-time: > > drivers/clk/visconti/pll.h: > 16 struct visconti_pll_provider { > 17 void __iomem *reg_base; > 18 struct clk_hw_onecell_data clk_data; > 19 struct device_node *node; > 20 }; > > Notice that a total of 56 bytes are allocated for flexible-array `hws` at line 328. > See below: > > include/dt-bindings/clock/toshiba,tmpv770x.h: > 14 #define TMPV770X_NR_PLL 7 > > drivers/clk/visconti/pll-tmpv770x.c: > 69 ctx = visconti_init_pll(np, reg_base, TMPV770X_NR_PLL); > > drivers/clk/visconti/pll.c: > 321 struct visconti_pll_provider * __init visconti_init_pll(struct device_node > *np, > 322 void __iomem > *base, > 323 unsigned long > nr_plls) > 324 { > 325 struct visconti_pll_provider *ctx; > ... > 328 ctx = kzalloc(struct_size(ctx, clk_data.hws, nr_plls), > GFP_KERNEL); > > `struct_size(ctx, clk_data.hws, nr_plls)` above translates to sizeof(struct > visconti_pll_provider) + sizeof(struct clk_hw *) * 7 == > 24 + 8 * 7 == 24 + 56 > ^^^^ > | > allocated bytes for flex array `hws` > > $ pahole -C visconti_pll_provider drivers/clk/visconti/pll.o struct > visconti_pll_provider { > void * reg_base; /* 0 8 */ > struct clk_hw_onecell_data clk_data; /* 8 8 */ > struct device_node * node; /* 16 8 */ > > /* size: 24, cachelines: 1, members: 3 */ > /* last cacheline: 24 bytes */ > }; > > And then, after the allocation, some data is written into all members of `struct > visconti_pll_provider`: > > 332 for (i = 0; i < nr_plls; ++i) > 333 ctx->clk_data.hws[i] = ERR_PTR(-ENOENT); > 334 > 335 ctx->node = np; > 336 ctx->reg_base = base; > 337 ctx->clk_data.num = nr_plls; > > Fix all these by placing the declaration of object `clk_data` at the end of `struct > visconti_pll_provider`. Also, add a comment to make it clear that this object > must always be last in the structure, and prevent this bug from being > introduced again in the future. > > Fixes: b4cbe606dc36 ("clk: visconti: Add support common clock driver and > reset driver") > Cc: stable@vger.kernel.org > Signed-off-by: Gustavo A. R. Silva <gustavoars@kernel.org> Acked-by: Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp> Best regards, Nobuhiro
diff --git a/drivers/clk/visconti/pll.h b/drivers/clk/visconti/pll.h index 01d07f1bf01b..c4bd40676da4 100644 --- a/drivers/clk/visconti/pll.h +++ b/drivers/clk/visconti/pll.h @@ -15,8 +15,10 @@ struct visconti_pll_provider { void __iomem *reg_base; - struct clk_hw_onecell_data clk_data; struct device_node *node; + + /* Must be last */ + struct clk_hw_onecell_data clk_data; }; #define VISCONTI_PLL_RATE(_rate, _dacen, _dsmen, \