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);