From nobody Thu Sep 11 00:05:05 2025 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 8F938C6379F for ; Tue, 21 Feb 2023 14:13:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234264AbjBUONL (ORCPT ); Tue, 21 Feb 2023 09:13:11 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36964 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229945AbjBUONJ (ORCPT ); Tue, 21 Feb 2023 09:13:09 -0500 Received: from msg-1.mailo.com (msg-1.mailo.com [213.182.54.11]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4C11011644; Tue, 21 Feb 2023 06:12:58 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=mailo.com; s=mailo; t=1676988740; bh=Y+XUERfWbYvdyrJk7Q/GnRbFZoY0tQf2LzvIHzC3ksw=; h=X-EA-Auth:Date:From:To:Cc:Subject:Message-ID:MIME-Version: Content-Type; b=bbv/URB4n568NFzb4GZ1LRt2TvS2hSVe+Qhu06enXxysj+JIFaSaane4lnUHgz4Bn S/oG9/hrY5dvLyjfiyql2LZw5YtSNTFAo+RhhuuBk9u3MnNomtcK56cL0+cy5AzX/u JLIUfeGHDxv4p2cjnSmZ8nTraRhxwlgxRivuh5qY= Received: by b-4.in.mailobj.net [192.168.90.14] with ESMTP via ip-206.mailobj.net [213.182.55.206] Tue, 21 Feb 2023 15:12:20 +0100 (CET) X-EA-Auth: /mGkXO4TmPlY0gMC/hZgUu73fMaPxcvWM61GG+jGP9YYZyawHPuUKmU9xmg7oVb1hSv4F/r0UFq77Y+IhowKxCkKroXFiG6M Date: Tue, 21 Feb 2023 19:42:15 +0530 From: Deepak R Varma To: Peter Zijlstra , Ingo Molnar , Arnaldo Carvalho de Melo , Mark Rutland , Alexander Shishkin , Jiri Olsa , Namhyung Kim , Thomas Gleixner , Borislav Petkov , Dave Hansen , x86@kernel.org, "H. Peter Anvin" , linux-perf-users@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Saurabh Singh Sengar , Praveen Kumar , Deepak R Varma Subject: [PATCH v2] perf/x86/core: Use sysfs_emit() in show() callback function Message-ID: MIME-Version: 1.0 Content-Disposition: inline Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" As per C99 standard, snprintf() returns the number of bytes that would be encoded in the destination buffer when it is sufficiently large. This return value may be different from what the caller is expecting and hence may lead to potential errors in the program. Kernel release 2.6.2 introduced scnprintf() & vscnprintf() which precisely return the actual bytes encoded into the destination buffer. For the sysfs attribute show() callback functions, which returns the number of bytes to the user space, a more recent recommendation is to use sysfs_emit() or sysfs_emit_at() instead of sprintf() family of functions. This is recorded in the Documentation/filesystems/sysfs.rst Kernel documentation file. Issue identified using the coccinelle device_attr_show.cocci script. Signed-off-by: Deepak R Varma --- Changes in v2: - Revise patch log message to include details on the potential issues wi= th current implementation and how the proposal is a better solution. Feedback provided by Peter Zijlstra arch/x86/events/core.c | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/arch/x86/events/core.c b/arch/x86/events/core.c index 85a63a41c471..27c03e6dcb5d 100644 --- a/arch/x86/events/core.c +++ b/arch/x86/events/core.c @@ -1896,9 +1896,7 @@ ssize_t events_hybrid_sysfs_show(struct device *dev, if (x86_pmu.hybrid_pmu[i].cpu_type & pmu->cpu_type) { next_str =3D strchr(str, ';'); if (next_str) - return snprintf(page, next_str - str + 1, "%s", str); - else - return sprintf(page, "%s", str); + return sysfs_emit(page, "%s", str); } str =3D strchr(str, ';'); str++; @@ -2544,7 +2542,7 @@ static ssize_t get_attr_rdpmc(struct device *cdev, struct device_attribute *attr, char *buf) { - return snprintf(buf, 40, "%d\n", x86_pmu.attr_rdpmc); + return sysfs_emit(buf, "%d\n", x86_pmu.attr_rdpmc); } =20 static ssize_t set_attr_rdpmc(struct device *cdev, @@ -2602,7 +2600,7 @@ static ssize_t max_precise_show(struct device *cdev, struct device_attribute *attr, char *buf) { - return snprintf(buf, PAGE_SIZE, "%d\n", x86_pmu_max_precise()); + return sysfs_emit(buf, "%d\n", x86_pmu_max_precise()); } =20 static DEVICE_ATTR_RO(max_precise); --=20 2.34.1