Received-SPF: pass (google.com: domain of linux-kernel+bounces-162769-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>,
	"Liang, Kan" <kan.liang@linux.intel.com>,
	Kees Cook <keescook@chromium.org>,
	"Gustavo A. R. Silva" <gustavoars@kernel.org>,
	Justin Stitt <justinstitt@google.com>
Cc: Erick Archer <erick.archer@outlook.com>,
	linux-perf-users@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-hardening@vger.kernel.org
Subject: [PATCH] perf/ring_buffer: Prefer struct_size over open coded arithmetic
Date: Mon, 29 Apr 2024 19:40:58 +0200
Message-ID:
 <AS8PR02MB72372AB065EA8340D960CCC48B1B2@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_|PA4PR02MB8237:EE_
X-MS-Office365-Filtering-Correlation-Id: c1453e7e-2988-48a1-8584-08dc687391f2
X-Microsoft-Antispam:
	BCL:0;ARA:14566002|461199019|3412199016|440099019|1602099003|1710799017;
X-Microsoft-Antispam-Message-Info:
	6VieQkeIyGYtf/20mFkp2pk/DaN75IiMstYx0rBMHDriZ8WSamXYzVYU/xv38/fyuBr1e+MjDo++EABpRPVVMN/UMWHzJR5X7xo7IFwz+RD0I6nh9hHn2dWa1QyFZ1ESe9Zw3NmHaDNDdAB8WQARivelG5UER3udojToWxNg1l1T0g3QmliMB1UcnJY60D34k4bdUpzxWPnqI3QQFQlA7vvr/vUwnDFOGHCxO8eICb7UYp/8WMsYMILj0fAK5o6Ioqdthw9lUlqjgin96jBXv8hni5o5V8k02E+JO4GSIMg44TNPE7AYEqWm1WH+Sp3udvmZJrOSvd/VdbcI01eccFV1t6u7n43w7zhSYPNhtGj73qslXpDxwRcDGjofFDlcXfk1XYBrk2nNXlLR4H3zs+wpebvmQdfMGlEXfkajlfwxBMUMuf3vt/YmPErVEBLQM0/yj0iPzhBNTK2FJAcAjN3yXk0z2EytWOQdKTPR7fGD6P7mHyAI5fd19g0MVBeoIyPnDQOStfZgaRfdivhO06bIbpSOZzGrMMF3btwm4urZIrtgMT7QcqXbcPFjyFTMH57rjYk2hNXrBsXHsfoKyXk+3t4YjuCWOXvcqdysJFDNTEHzZ5vil406QFtmHSJ6SUNi6RqPQ8LrAYFvG9vsbyRZ0MWJdrrF9Z2a4+6PpOe6tw+hotpm6J7n17BAlYOwdqTBziiEtU87mMh6RHFdOw==
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?2NNB6JBvaSDB+Lb7z5FA5LJcjpMGSXMaUYVaQAk8Lw4s+xKYf+SsWFjJ+1r8?=
 =?us-ascii?Q?pmBN1Aft0idaA+3dOSwBEraHAO5Wo/CWOcAcEOtAtNVr/3P0BRyqOSYgvubh?=
 =?us-ascii?Q?K8kxfUNQ5icdnuzzF6il3WNVvI+ROzM0Rdk02dlIcJqA8HxA3OGYb8pO5Nkl?=
 =?us-ascii?Q?g8DrevFOgc23YZaBrnI1NHOXXNJf+wu9HAp+WdCs/UQAxy5cZ8jfGqbC/QIT?=
 =?us-ascii?Q?GT2RaXOYJ1PZG5H4/bieR/Q2rBMTO4qkHYrR3pYOPvKpaeTWOX938zyN2jfZ?=
 =?us-ascii?Q?dMimuWB1yE16ekTjdKdPJusjlZkOoRNSuez7mWWjefF2Si92UbuvfjUjapa8?=
 =?us-ascii?Q?a7XhXVA3anJQxii0mtHe/UuoZPR57hjH50PfFnFuDeWkahKa0qbRbcVPM6sZ?=
 =?us-ascii?Q?8ErHaRppJnQzG27a2zVeAWxgCK2fbRgzJAtiDX7iKk8aDtavC6tH0v5JbVJ3?=
 =?us-ascii?Q?8MfPw0dGT/ZCKFYR9dudqILGKCXuNZ33jeJ93+GrFbfIrfxBtofathWvimjE?=
 =?us-ascii?Q?jAbK9ultiYF/TtiALgNrYzc5Gq9Q1X8o7vBKQW4Suy7dyymiFBSYvmqwxNsb?=
 =?us-ascii?Q?48GicxL71mSYpczoe5tCSyorbKfzPvk5iBpIxHIokVDbL4z4WfbEMhqocpsv?=
 =?us-ascii?Q?ehJZTUcqh0GR1YQdSUpE21CuZfkX4L3jpTAd+jheZcz9ORZ7aygnTHDSBARA?=
 =?us-ascii?Q?KKYJnAbqIiIgbuvOVNq6rHY0dgHybsqTNqMnZH/hlluivwn725IyD1fogfcI?=
 =?us-ascii?Q?yzzUij21HQGRsG2GcI0G5tBts2H7b09FMmAgZurkVzuGjE8sJgjW3EPkAFCq?=
 =?us-ascii?Q?5wyktkDBxZDzsP7CDaLwXBSEjKF/qO1L3ivDDtbCUhbszgiKKZh/W18jYhQL?=
 =?us-ascii?Q?AUZ38L6b2cH6WnZwAc8G1XBBiL45vUJTLlY3at4YY6xRqjoJeVSzgJrpROG1?=
 =?us-ascii?Q?JXCgQtlMw5nS8rrvHXod2DKmucb7nT7GrA/x+kJIsJcK4KUUdWZboJ3edPS0?=
 =?us-ascii?Q?uDEFTJaWAKgfbHXaxf7Ilq+pPXZf7ix/Pb1YEjEHt+9E6LFAZOFYf9WULRuC?=
 =?us-ascii?Q?5p+QICrYsEqXAOvhiuV6y8uCBNJe6mrAQ/T1kJ7X6zlSK311bKG/+KYdmdEJ?=
 =?us-ascii?Q?GFwWu2oQG4eeOLed8UnIyxMeVJfZbi2cVcsrsKVug/v1jwxLjjCIC2ASDI1D?=
 =?us-ascii?Q?+0xiU0zlqBj/4371UuqBQRdc3rb2xxK2FMGqZRTTr4kwu22eitXv8gQEYXxc?=
 =?us-ascii?Q?it6WvH6OAHxARprumvM0?=
X-OriginatorOrg: outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: c1453e7e-2988-48a1-8584-08dc687391f2
X-MS-Exchange-CrossTenant-AuthSource: AS8PR02MB7237.eurprd02.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Apr 2024 17:41:16.1265
 (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: PA4PR02MB8237

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

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

struct perf_buffer {
	[...]
	void	*data_pages[];
};

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() functions.

In the "rb_alloc" function defined in the else branch of the macro

 #ifndef CONFIG_PERF_USE_VMALLOC

the count in the struct_size helper is the literal "1" since only one
pointer to void is allocated. Also, remove the "size" variable as it
is no longer needed.

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)
..
i0 += 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
---
 kernel/events/ring_buffer.c | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)

diff --git a/kernel/events/ring_buffer.c b/kernel/events/ring_buffer.c
index 4013408ce012..e68b02a56382 100644
--- a/kernel/events/ring_buffer.c
+++ b/kernel/events/ring_buffer.c
@@ -822,9 +822,7 @@ struct perf_buffer *rb_alloc(int nr_pages, long watermark, int cpu, int flags)
 	unsigned long size;
 	int i, node;
 
-	size = sizeof(struct perf_buffer);
-	size += nr_pages * sizeof(void *);
-
+	size = struct_size(rb, data_pages, nr_pages);
 	if (order_base_2(size) > PAGE_SHIFT+MAX_PAGE_ORDER)
 		goto fail;
 
@@ -916,15 +914,11 @@ void rb_free(struct perf_buffer *rb)
 struct perf_buffer *rb_alloc(int nr_pages, long watermark, int cpu, int flags)
 {
 	struct perf_buffer *rb;
-	unsigned long size;
 	void *all_buf;
 	int node;
 
-	size = sizeof(struct perf_buffer);
-	size += sizeof(void *);
-
 	node = (cpu == -1) ? cpu : cpu_to_node(cpu);
-	rb = kzalloc_node(size, GFP_KERNEL, node);
+	rb = kzalloc_node(struct_size(rb, data_pages, 1), GFP_KERNEL, node);
 	if (!rb)
 		goto fail;
 
-- 
2.25.1