From patchwork Tue Feb 21 14:12:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Deepak R Varma X-Patchwork-Id: 60105 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp34534wrd; Tue, 21 Feb 2023 06:21:02 -0800 (PST) X-Google-Smtp-Source: AK7set/EjycjtDl5LdyfBLtZxTVovymOkQEpEND7fdaTjdqlWby8R1eYci9Y60z3MGDXmhTNBTuu X-Received: by 2002:a17:906:f84b:b0:8aa:a802:adcd with SMTP id ks11-20020a170906f84b00b008aaa802adcdmr10829681ejb.30.1676989262431; Tue, 21 Feb 2023 06:21:02 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1676989262; cv=none; d=google.com; s=arc-20160816; b=JO92ukgpa164REdC9QBwt7MvutuChgPMgXesxk0D8EYuUtbzM2HchdDK4y2jYZAsun r1z5GqLBL6mSH1hVHiYBKAkJK5tFKkr03bxxGVLM0xrC1pE3hNOQZl481xVRgisZ4eCE quUQ9WLRr/Iny4qZpGSVwUI1fhPTkUgLW22V4hUzW5fKgYPOze1m0sI4FquCysZ6QpVr YDwUxdniycUZEvpMsB/MqzbaX6Xii+jUr353LiWj/DdgyqT/jZTIzi436fm1gRYSJs8x I0Q3wcOLav2pIkJ1IVpHo8vvHZzx6JhaM6dfNUKzeZ2UlAkfNlJ6fRR03BGQ3gBENg8Q 40gg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-disposition:mime-version:message-id :subject:cc:to:from:date:dkim-signature; bh=5vcsWEQIGbtj416lHfrqd79oJr7rsz9Wmgj4Hu9fpE4=; b=pYcdM+iT/7tbmgqq7+giJPJWU3w+PsRo8AD5ZStSHUsUjbIqaV9VXSKY6WG3S3qXCy fYRMgbtlNCZjIflZu44Z745d66r3xjj8bZcoPJMqUjE0sCjAzoeyyImh0xXfBkm776gr 4s7z4nSNKcyOVauvrz2ifluVhgX6C0ergJwRyxGjoS3h39dzVHC+eNyLlZayWhU5XNXe XARTZI7P2DuNZIAUaFN+tXzz4jaZeRtTb6nnNAp32eFYjTJRq6ETmDZR1rCt/WQu+koz RCJ3Fauu7huBkXThB9UqLXarPFrcLVd5Y3iVNRtgdRo9TYJ6bUgtkqU8eTSbO68uCoua XIGg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@mailo.com header.s=mailo header.b="bbv/URB4"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=mailo.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id bp5-20020a170907918500b008d2c91d5119si5907056ejb.308.2023.02.21.06.20.38; Tue, 21 Feb 2023 06:21:02 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=fail header.i=@mailo.com header.s=mailo header.b="bbv/URB4"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=mailo.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233542AbjBUONK (ORCPT + 99 others); Tue, 21 Feb 2023 09:13:10 -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 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1758450692825569471?= X-GMAIL-MSGID: =?utf-8?q?1758450692825569471?= 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 with 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 = 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 = 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); } 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()); } static DEVICE_ATTR_RO(max_precise);