From patchwork Tue Feb 21 14:06:12 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: 60112 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp40525wrd; Tue, 21 Feb 2023 06:32:34 -0800 (PST) X-Google-Smtp-Source: AK7set+GH1UzrWhGW6RON+Qy5s9sYc9yTmBCkm2p4KWRMsexJ/6o1Mv9jiVRIlYkOmVBxeYgyJzi X-Received: by 2002:a05:6a20:1605:b0:c7:68a0:e819 with SMTP id l5-20020a056a20160500b000c768a0e819mr19240950pzj.56.1676989953900; Tue, 21 Feb 2023 06:32:33 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1676989953; cv=none; d=google.com; s=arc-20160816; b=COP06JyYC3sBxaW/+5EWIuoIneUvtbiD5caJIX1LDpo9XSwh9T50ag7Zx480VSWnbg cGAKgNFsS8i92nF7X5Sn7M7vju5AJIrmoTw3n5L1M7A760yYT+g4IcMH8J2FjrFf4nb9 M7XMYNvsqj/xZZs1bpl3YvMK2wOcXY9r/AlBh9a2On3YAVjoyIo4WlHa87HC6QUI3lzl eu2hHVry1s2N7Mhsh+4bh9dmOgvbz1kGbdAWYPwPBQSfCqMtP7mR+5m2SvxVVIT7SRzW wL9KNcC8bXzFnqVoqE5XVoYDTrEL4ErW4OIyysuj+ZUPgDpaEvK1EfRk7gQ44ijfdxq0 rN/w== 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=5vcsWEQIGbtj416lHfrqd79oJr7rsz9Wmgj4Hu9fpE4=; b=qDSac0A/aAAR7oov/wopg4UHazAXgTy6NUuib1I/OwFRulHfa8denfeEVx/gVcAJCS KmtyN70lglW3hV2fBQn5OazM602tcaS97k4A7PYKq4aD2FhnrkShazm/CSPkNCxXR12V 3qcyxnzaoFS42wenNy7xrz16f3hPVJJ5vUCVSCjkJLvNghGnN+eGccgyUARtp8kYmX+K QHSX0b5UKLN6kkbnNz3ANDljs8fW77Zc+0yn2gisOFfx5NWCwOqCYnjfzTSjL0LsCsc2 6hCRLiBGnlcCltRPesygVVWHlvJ51G35M3uw0rBBOunZ071mQRmnHBl1pt+3+XhvrXrb G5UA== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@mailo.com header.s=mailo header.b=F17RF+dA; 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 g4-20020aa79f04000000b005aa2b935c7asi14938162pfr.99.2023.02.21.06.32.21; Tue, 21 Feb 2023 06:32:33 -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=F17RF+dA; 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 S233109AbjBUOHW (ORCPT + 99 others); Tue, 21 Feb 2023 09:07:22 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58348 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234017AbjBUOHN (ORCPT ); Tue, 21 Feb 2023 09:07:13 -0500 Received: from msg-2.mailo.com (msg-2.mailo.com [213.182.54.12]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 423A82A6E9; Tue, 21 Feb 2023 06:07:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=mailo.com; s=mailo; t=1676988377; bh=Y+XUERfWbYvdyrJk7Q/GnRbFZoY0tQf2LzvIHzC3ksw=; h=X-EA-Auth:Date:From:To:Cc:Subject:Message-ID:References: MIME-Version:Content-Type:In-Reply-To; b=F17RF+dA56Zv3bEUkJHxAE9Wosv4z4A8vYxzUx/W+WjqrnPdl6v/XQxbs9aa/vqj+ TiJRoX+hC1bVBbXY9NZy3fv+JO0LgiH6B6lI4LHmQK+KtyGvyAe5IBdwoP0hqjMZFP 0l2BQ9sPWZiLUgZ+fozEBTDVTam3OtNtMQuV9cew= Received: by b-6.in.mailobj.net [192.168.90.16] with ESMTP via ip-206.mailobj.net [213.182.55.206] Tue, 21 Feb 2023 15:06:17 +0100 (CET) X-EA-Auth: 95DtqBesPNbKd/UFYwNt3POXip0FA5AK5PntGkqZtIczCGt05/c6pRtMPqXs2vqAWFmQxIyOke3sqQheAG3bRVAQoY/z9TZH Date: Tue, 21 Feb 2023 19:36:12 +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 1/3] perf/x86/core: Use sysfs_emit() in show() callback function Message-ID: <719558b8a435a6f942b2cc3f5c0431212be76bc6.1676987821.git.drv@mailo.com> References: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: 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?1758451417608365875?= X-GMAIL-MSGID: =?utf-8?q?1758451417608365875?= 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); From patchwork Tue Feb 21 14:06:52 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: 60108 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp36757wrd; Tue, 21 Feb 2023 06:25:18 -0800 (PST) X-Google-Smtp-Source: AK7set+lOmvu5NGxpg83WnCMkMo1EGY0t9cmCLDz9SnJ1qQJdL3tCz3Y6NCRlyddaBFNupWM3A/Z X-Received: by 2002:a05:6a20:840d:b0:c7:717f:4863 with SMTP id c13-20020a056a20840d00b000c7717f4863mr5479017pzd.21.1676989518317; Tue, 21 Feb 2023 06:25:18 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1676989518; cv=none; d=google.com; s=arc-20160816; b=ISu1ZDh3O3mIIIUW2/YYWSOxcowyZBvjfSU1HfvCHe8NRO9H8RvYUOzfHZfAYrxqmh VjO/KDt3/rHu1QLGj8hQgh8Vsq6zBObaUNvd2x7O8tcZYT6XHcjMy7RRuXz2JLXRM91Z HCImWnzFyYMX6/hlisCwL4VTXN7DKbTEUJi1qFgStH0WkqJKAxZbdT9XhFhgBaCOBOu6 iguCMBSzWqF2VDSx1CWbNU59qQ7P4FD4JZy3hAZ2SrUQINujLcQrXFJyXFsUh3NWKzNh p7FRGU5FkPxIrByK6powMVey45OfmAvmjCBYcNTMv6+EeAVqKXjCuUFqIF/3pGBEs5YS Jx6w== 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=19VRzcXsM0miFVLsrMxq099FYLBUt7DF1wd1649/hrM=; b=BjGfL0whZFcl5OaNCR2QGJARtwIVymsVTf5DTfn0ej3PDK481XyZCGyEYrNmLN9WVA JJ/mXcNgpClNbsFCgDD3cLp5k2H1cFgKkDTZnX87rh5K/31Fzp8pukeI1Ejvr2JWUC4n Vtnr5fh/CMe/kCW8eyPmt2JydLVgcZU/NA3dwauHxltBLhMwVW4kKb8p/Df88pD410Ec F79t+u47wPrfI6NzBCQ6nYyw1MQSe7FeP/VFz203RooPGD9ewgkR64b3A4+OC57U0mbt Nw5SEJ5aUiRlICpZl7LtaTzNk/AkkQ6B757B69Wg9BGsBTF5jEq1zOCIc8pXDIDIgReJ Pe0g== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@mailo.com header.s=mailo header.b="ct/HGOoS"; 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 u190-20020a6279c7000000b005cd3a233e3asi2567556pfc.346.2023.02.21.06.25.04; Tue, 21 Feb 2023 06:25:18 -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="ct/HGOoS"; 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 S234045AbjBUOIM (ORCPT + 99 others); Tue, 21 Feb 2023 09:08:12 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60242 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233656AbjBUOII (ORCPT ); Tue, 21 Feb 2023 09:08:08 -0500 Received: from msg-4.mailo.com (msg-4.mailo.com [213.182.54.15]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 94CC82A99A; Tue, 21 Feb 2023 06:07:42 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=mailo.com; s=mailo; t=1676988418; bh=oLZwRpXxfR8jKepCYgBAd0gcxoO2D6bBAKStsCYFVz8=; h=X-EA-Auth:Date:From:To:Cc:Subject:Message-ID:References: MIME-Version:Content-Type:In-Reply-To; b=ct/HGOoSPl2yfAJdpTmfbCK4kQ8qIvxaKs0L4O54Kib0xMGCCh0W34MpMfkFTJl8j VOcr/oyOReG12/EEQ5gUPB3DGFW3K01KcX6ECXSJqTVFA0yZHWook5MYdkKBMhrspq rPqb2ddx9urUVC9k78cNNCT253DHeqi8pEPTluaQ= Received: by b-3.in.mailobj.net [192.168.90.13] with ESMTP via ip-206.mailobj.net [213.182.55.206] Tue, 21 Feb 2023 15:06:58 +0100 (CET) X-EA-Auth: at9OF3ziCtOVa+pv6TzsuxHGTTSacIrTPKQNDcL9n3nWoXnaOhWUsf84g1TEAEzf2IJx/eMLezJ3x9Jg2DvqQbGUPd6TRiTO Date: Tue, 21 Feb 2023 19:36:52 +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 2/3] perf/x86/intel/pt: Use sysfs_emit() in show() callback function Message-ID: <54c16281234d057ebed1ef05bde20d2d57d70669.1676987821.git.drv@mailo.com> References: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: 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?1758450960867720394?= X-GMAIL-MSGID: =?utf-8?q?1758450960867720394?= 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/intel/pt.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/arch/x86/events/intel/pt.c b/arch/x86/events/intel/pt.c index 42a55794004a..d9e6d771b458 100644 --- a/arch/x86/events/intel/pt.c +++ b/arch/x86/events/intel/pt.c @@ -96,7 +96,7 @@ static ssize_t pt_cap_show(struct device *cdev, container_of(attr, struct dev_ext_attribute, attr); enum pt_capabilities cap = (long)ea->var; - return snprintf(buf, PAGE_SIZE, "%x\n", intel_pt_validate_hw_cap(cap)); + return sysfs_emit(buf, "%x\n", intel_pt_validate_hw_cap(cap)); } static struct attribute_group pt_cap_group __ro_after_init = { From patchwork Tue Feb 21 14:07:33 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: 60109 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp38757wrd; Tue, 21 Feb 2023 06:29:24 -0800 (PST) X-Google-Smtp-Source: AK7set/eblgFMzcWdjUxGnId7lAXZ7Ewxm/Kr81xN/v7twrEgABIkKRJzVLk7x4KGsbRjh3BCOn6 X-Received: by 2002:a17:906:57c6:b0:8b1:fc1a:7d19 with SMTP id u6-20020a17090657c600b008b1fc1a7d19mr14770123ejr.3.1676989764614; Tue, 21 Feb 2023 06:29:24 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1676989764; cv=none; d=google.com; s=arc-20160816; b=Zr2dwvC+3ThlQAdShMP6woEQQGBkG6uRZzH7IxU5qyA3cP4kxUd2cCq5ZRS6gsxbOX WWAvzYmkP76k+poyoLIDfKnEoO0D7TNwfX5rrYpkvTPiVk9l7VvSSMFlB5A9cCVPB3RI iaZF5J9vrCLGjHYrPfxmg0ORHcCXB001Rr5/G9AjwjvpBEOHZE8lojrFr3jj6QYWRWri TNX7x6dajexNptA+dU4fjP5ozfJLjdV48MPTid0THvxIpWKpe9GnuKGyoADS5q3+rKTj R+wDsk/KyFhszSK7DxiJmWVXMpjLzQtDe6YVpNPHmV0QdoZToTlLe9NFLETRoKeKW8dS mfQA== 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=1IueYwST8+uFopStSTJwEWVD21VMPQXRRbeA1rPC4u4=; b=gFRz3E+vVNfzUdSZZh69dr8U9qGyL30kBPFMf+PXIf+pnmnrHLHgBqSTXxyKacDGUn eqHezwW8NrqsptsAQcA1LoIHWgtJO7NZKG9CgYrU8ww0jK0xGjiVXfpfkFtRSnBthYkK tFOpsRjj7ciQVO854S9XYQwwIa2gqOabafAv4mm4cg7otEquoy2l251qIjZphOXHPW9b VV05vZhNmWmW99iau+AjBjDpd6Pa6JYg3e3aPG1KsLC3inV0nso3X0r2s5EL/e0AR3Bw mdPllSRTs1GfWlzV9ibn8WR8DUdwU+rGZgBBQyNiBvxH39zkdaya2D5HLCwDlRg7i4zz hlKA== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@mailo.com header.s=mailo header.b=jJMAjZ+w; 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 ew6-20020a170907950600b008c9eb8758desi8869455ejc.915.2023.02.21.06.29.01; Tue, 21 Feb 2023 06:29:24 -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=jJMAjZ+w; 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 S233887AbjBUOIX (ORCPT + 99 others); Tue, 21 Feb 2023 09:08:23 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60400 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234307AbjBUOIU (ORCPT ); Tue, 21 Feb 2023 09:08:20 -0500 Received: from msg-2.mailo.com (msg-2.mailo.com [213.182.54.12]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2CF72DBF0; Tue, 21 Feb 2023 06:08:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=mailo.com; s=mailo; t=1676988458; bh=Rbss0jxu2oGKjdOiKMyt4uKTBzrOuv6xJ/DDTtxIAQM=; h=X-EA-Auth:Date:From:To:Cc:Subject:Message-ID:References: MIME-Version:Content-Type:In-Reply-To; b=jJMAjZ+wRXfZFrYdt+Xcn/ezo/9xrp/LwdbJoKl+AwbZm80cZgUsaDEbAWPJRxOBU HIM6ejsCz0X04GFUTgdxcvWy6IG+M2/nxMprwhgGlNT/3F8TJ3VgNxQBi54VdouWI9 6sBCN1q9IMevCHLOoKiHI+3JiSMc2d3w3VrlkmXc= 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:07:38 +0100 (CET) X-EA-Auth: vqvzvLOiwMJVZ0nf4zmrjP3ujrlYSnChDzDG2lu6ZTVMp0oV+9+mMIgP7QH2LsPs0i4s9VN9g+YYQSaiMUmcCpK/f2s81Znu Date: Tue, 21 Feb 2023 19:37:33 +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 3/3] perf/x86/intel: Use sysfs_emit() in show() callback function Message-ID: References: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: 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?1758451218943641338?= X-GMAIL-MSGID: =?utf-8?q?1758451218943641338?= 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/intel/core.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/arch/x86/events/intel/core.c b/arch/x86/events/intel/core.c index bafdc2be479a..8fb1225123ef 100644 --- a/arch/x86/events/intel/core.c +++ b/arch/x86/events/intel/core.c @@ -5273,7 +5273,7 @@ static ssize_t show_sysctl_tfa(struct device *cdev, struct device_attribute *attr, char *buf) { - return snprintf(buf, 40, "%d\n", allow_tsx_force_abort); + return sysfs_emit(buf, "%d\n", allow_tsx_force_abort); } static ssize_t set_sysctl_tfa(struct device *cdev, @@ -5307,7 +5307,7 @@ static ssize_t branches_show(struct device *cdev, struct device_attribute *attr, char *buf) { - return snprintf(buf, PAGE_SIZE, "%d\n", x86_pmu.lbr_nr); + return sysfs_emit(buf, "%d\n", x86_pmu.lbr_nr); } static DEVICE_ATTR_RO(branches); @@ -5323,7 +5323,7 @@ static ssize_t pmu_name_show(struct device *cdev, struct device_attribute *attr, char *buf) { - return snprintf(buf, PAGE_SIZE, "%s\n", pmu_name_str); + return sysfs_emit(buf, "%s\n", pmu_name_str); } static DEVICE_ATTR_RO(pmu_name);