Received-SPF: pass (google.com: domain of linux-kernel+bounces-125744-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
From: Erick Archer <erick.archer@outlook.com>
To: Peter Zijlstra <peterz@infradead.org>,
	Ingo Molnar <mingo@redhat.com>,
	Arnaldo Carvalho de Melo <acme@kernel.org>,
	Namhyung Kim <namhyung@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Alexander Shishkin <alexander.shishkin@linux.intel.com>,
	Jiri Olsa <jolsa@kernel.org>,
	Ian Rogers <irogers@google.com>,
	Adrian Hunter <adrian.hunter@intel.com>,
	Thomas Gleixner <tglx@linutronix.de>,
	Borislav Petkov <bp@alien8.de>,
	Dave Hansen <dave.hansen@linux.intel.com>,
	"H. Peter Anvin" <hpa@zytor.com>,
	Kees Cook <keescook@chromium.org>,
	"Gustavo A. R. Silva" <gustavoars@kernel.org>
Cc: Erick Archer <erick.archer@outlook.com>,
	x86@kernel.org,
	linux-perf-users@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-hardening@vger.kernel.org
Subject: [PATCH] perf/x86/intel/uncore: Prefer struct_size over open coded arithmetic
Date: Sat, 30 Mar 2024 15:32:59 +0100
Message-ID:
 <AS8PR02MB7237F4D39BF6AA0FF40E91638B392@AS8PR02MB7237.eurprd02.prod.outlook.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: AS8PR02MB7237:EE_|AM0PR02MB5827:EE_
X-MS-Office365-Filtering-Correlation-Id: 2e7713d4-d927-4284-dff4-08dc50c65ada
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info:
	NCzC4hUwZMhoMS/qbpYs282m4bKV+R5pHdnGfM+uJQc3uOT3rWQZgog4H0bx7g2B84F+69ZvKdqgjRSiHpmluJNX56mDeKWKCeEHio5fiY/f+UHLqwaUjoVY1WQZ4d8ACdEchBWchgcZJLu5DtVYMfD2H40BSowYYsxqHv/cQn1FXAowwgZ7ILZy2D/3deuLIwx8pFnWXVTT/8SamEF3wXvH7m2idaUcknOxzvCJ55vPpVtl9nWXOcnnkWdJW99tyFUKaAkxG0ALcASF3FAUvrl1JIuRgx1YufTMvZWWI+rnyv7kHJLdIUOypHKpUgDM3Tm4jKH1Tw1GzPMK7oh85iiu5GMi5cGHlQyHg3IpTXOK+kY08FtdlQGVCX2cbr4TekGjzyM2l5rrDV0kzrjrE6VzGJLIn6uYTuhYaY/oa4BOSxh22DBLQJkP1FwMdgmMNjgJZdBvEMB2QC/NZvVBGHdjMiKMNuMyAFTCfP6LS0gpSSTO1HWYh/Q16kP3dzu78UNPbAkPhH532lMtL6a6RqfVfnVnkrSHcHPeT6MNq/NlMf/5mg6cu/hYEf0jcbC5nI0X8xmucEUabU2CtCFEzuMdMtwGgYGxA3U3CCCauPX2X7qrJowCuTphfmaBojFgDrOLHJg5/7N/PS5DMupqWfe/cNYshc7E74a7PHBZRTFQQRo6ls9zh6POwnzazd5d
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?UK3dsu9VTwjLPGsf7OGMySfHq+16NuV3exIt89dc+BaRNjED7qdRFO+BOBBe?=
 =?us-ascii?Q?0wLKXPUFj7TMYneQMi6U1MEOsLjoUhupBLMcoJU4M5e3J+Mo0UU0WWfytQjN?=
 =?us-ascii?Q?hHCgUoFBI2CRz5JiNzMxYMQ8WqJSaQslQgx2CAnJV/8LrMfbw2jidJJOGGI+?=
 =?us-ascii?Q?EmBMUcbpCnbdxqgi3AMLowmLqeiJZXd3i2ZpmoshsJn92cUuyWvsaOwieuz/?=
 =?us-ascii?Q?EOFCedZkQYKiGfrxOWJGH6Iy1gF7O9Soy65hlNTTfhBGlPo2AfC9fKmKaR2x?=
 =?us-ascii?Q?Zi4p86PesFz+slMab8SCnpfCv65dM4r3EIyjEfHxVL0RcuzjmDHMjSSGeVF4?=
 =?us-ascii?Q?NZMjSaMUhiIhBRgejz1JjRprwRr3XeRAlNHF2ll+RXusD4pZ8FVGhN7RcHgD?=
 =?us-ascii?Q?Ia2CST/n7mjQ9po46NG/GXe91YwkgpaQtlKYR14dbSwjvANJvmMjp7cU2eGk?=
 =?us-ascii?Q?s9YUxr1LjUl6YAVTezQOgpTeClyfqtrosmVB5K6dlf5ljv0Huw/GFSytXmH+?=
 =?us-ascii?Q?TfH5dqtRfiZAEQ47dN8TPjxM2DOPQnWdlc4wP0qyrW5IcKWmLU5hXrdVpsRv?=
 =?us-ascii?Q?IeZmaN5zqu+ORL7gyeROmzSuu5BN1tPpAs3kWYGbXCb+Oi4Rj5/5yLR8CvaP?=
 =?us-ascii?Q?TkwjQSJWtmFuuJGug4GGHKHj2YaY8p6RWe5Tf72ctWel/ugfkZil72nv4Ww0?=
 =?us-ascii?Q?z/LaZ91v0gTR1qCCb/4DaontS56sWif+mSSwZF6GuqK+anHP5GNwsTimTt9/?=
 =?us-ascii?Q?vfiiHg3oxszjFNc6NzAaEF0MF135I5Z5v9ZZ48AtcCI6QI6MA3Mu37UXJhZ6?=
 =?us-ascii?Q?yjcKzHJ0YujzrlRADJU9Ahv/6tQIIW1pFZihDBst1WfsipROmL9A+PX53CNH?=
 =?us-ascii?Q?HIlw0jkXoFjqIhwYiz2LXY4EHR0oFO9wOtkUtMOj9njm+Y4JoHK3T/r1Vg+W?=
 =?us-ascii?Q?k30PjxHapBiOaRutbbs9Bc8YgXXJ3abKCosnYPuybkGHWXCL3gMFa8Hd9pgT?=
 =?us-ascii?Q?IP00U4H/tzNpXnrCMNK9l7OTRad0mC/rHlEsyEftV5XbnhGVkoqgV2szMVhC?=
 =?us-ascii?Q?EtDEifvKRnV7++YfSCXZrjQSCYiofc9X6qxgmMNL39bSmoY4NNIkN40qnaDZ?=
 =?us-ascii?Q?pk40y5lBoFD8lS5qxy5NbRnc9hLIYqJDZuGkUOMk/gKUjVKAaRUCdfX0PPXq?=
 =?us-ascii?Q?4OBeG5ZultiRozBmU7jKQK0X+ejJ93fzFnV8W0LOC6mQTLaZNlZFAGtE4YJS?=
 =?us-ascii?Q?lKM6gWRlk4rlG80HSzAF?=
X-OriginatorOrg: outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 2e7713d4-d927-4284-dff4-08dc50c65ada
X-MS-Exchange-CrossTenant-AuthSource: AS8PR02MB7237.eurprd02.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Mar 2024 14:33:23.9457
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg:
	00000000-0000-0000-0000-000000000000
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM0PR02MB5827

This is an effort to get rid of all multiplications from allocation
functions in order to prevent integer overflows [1][2].

As the "box" variable is a pointer to "struct intel_uncore_box" and
this structure ends in a flexible array:

struct intel_uncore_box {
	[...]
	struct intel_uncore_extra_reg shared_regs[];
};

the preferred way in the kernel is to use the struct_size() helper to
do the arithmetic instead of the calculation "size + count * size" in
the kzalloc_node() function.

This way, the code is more readable and safer.

This code was detected with the help of Coccinelle, and audited and
modified manually.

Link: https://www.kernel.org/doc/html/latest/process/deprecated.html#open-coded-arithmetic-in-allocator-arguments [1]
Link: https://github.com/KSPP/linux/issues/160 [2]
Signed-off-by: Erick Archer <erick.archer@outlook.com>
---
Hi,

The Coccinelle script used to detect this code pattern is the following:

virtual report

@rule1@
type t1;
type t2;
identifier i0;
identifier i1;
identifier i2;
identifier ALLOC =~ "kmalloc|kzalloc|kmalloc_node|kzalloc_node|vmalloc|vzalloc|kvmalloc|kvzalloc";
position p1;
@@

i0 = sizeof(t1) + sizeof(t2) * i1;
..
i2 = ALLOC@p1(..., i0, ...);

@script:python depends on report@
p1 << rule1.p1;
@@

msg = "WARNING: verify allocation on line %s" % (p1[0].line)
coccilib.report.print_report(p1[0],msg)

Regards,
Erick
---
 arch/x86/events/intel/uncore.c | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/arch/x86/events/intel/uncore.c b/arch/x86/events/intel/uncore.c
index 258e2cdf28fa..ce756d24c370 100644
--- a/arch/x86/events/intel/uncore.c
+++ b/arch/x86/events/intel/uncore.c
@@ -350,12 +350,11 @@ static void uncore_pmu_init_hrtimer(struct intel_uncore_box *box)
 static struct intel_uncore_box *uncore_alloc_box(struct intel_uncore_type *type,
 						 int node)
 {
-	int i, size, numshared = type->num_shared_regs ;
+	int i, numshared = type->num_shared_regs;
 	struct intel_uncore_box *box;
 
-	size = sizeof(*box) + numshared * sizeof(struct intel_uncore_extra_reg);
-
-	box = kzalloc_node(size, GFP_KERNEL, node);
+	box = kzalloc_node(struct_size(box, shared_regs, numshared), GFP_KERNEL,
+			   node);
 	if (!box)
 		return NULL;
 
-- 
2.25.1