From patchwork Thu Nov 2 18:55:43 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Justin Stitt X-Patchwork-Id: 1858702 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=osuosl.org header.i=@osuosl.org header.a=rsa-sha256 header.s=default header.b=btz8hf74; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=osuosl.org (client-ip=140.211.166.136; helo=smtp3.osuosl.org; envelope-from=intel-wired-lan-bounces@osuosl.org; receiver=patchwork.ozlabs.org) Received: from smtp3.osuosl.org (smtp3.osuosl.org [140.211.166.136]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4SLwJG5x9wz1yQx for ; Fri, 3 Nov 2023 07:21:34 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id 4E2E47072B; Thu, 2 Nov 2023 20:21:32 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org 4E2E47072B DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org; s=default; t=1698956492; bh=PfIhft6u6fKUc+25+yCzYMIg6zDkVbR0gjfmX5TzYHw=; h=Date:In-Reply-To:References:From:To:Subject:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: Cc:From; b=btz8hf745R8cNhDQmNgd9xCoaCrU8aaFVheWcOk3ADNIP82Q7Y5Vrm9CqH2QspOzO ayPzv33QvcTGExyrmrNBzt0oRvTInlwXtbdDpBs8q+g0S5OlhBMVx1GaLMQeTmf7Uv LeRgQtrj7kN3R9ppxp5QkfXwApmr1HRLLbyZG5Mh5srGbWVVWTFKi3GVfRrZFF3w/Q uLyixqVrvI4eeyHxBh3spmT4t+GqcjLw7KSY/y6cYAp90M4g23AsslxLhthXL6XF1H z/MgMOsUOcd3NTF5zu+zXLMm1cIC/QPm9lr0GPUBPvNq+7ZdpRl/ZN7PgyznqHeL4U qz4b3k8OUElGQ== X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id q0BJUbQGyphi; Thu, 2 Nov 2023 20:21:31 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by smtp3.osuosl.org (Postfix) with ESMTP id 558CC70756; Thu, 2 Nov 2023 20:21:31 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org 558CC70756 X-Original-To: intel-wired-lan@lists.osuosl.org Delivered-To: intel-wired-lan@lists.osuosl.org Received: from smtp2.osuosl.org (smtp2.osuosl.org [140.211.166.133]) by ash.osuosl.org (Postfix) with ESMTP id 2458D1BF287 for ; Thu, 2 Nov 2023 18:55:57 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp2.osuosl.org (Postfix) with ESMTP id EF13B43549 for ; Thu, 2 Nov 2023 18:55:56 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp2.osuosl.org EF13B43549 X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp2.osuosl.org ([127.0.0.1]) by localhost (smtp2.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id r3pfk7H_FOIe for ; Thu, 2 Nov 2023 18:55:52 +0000 (UTC) Received: from mail-oo1-xc49.google.com (mail-oo1-xc49.google.com [IPv6:2607:f8b0:4864:20::c49]) by smtp2.osuosl.org (Postfix) with ESMTPS id 88C6443541 for ; Thu, 2 Nov 2023 18:55:52 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 smtp2.osuosl.org 88C6443541 Received: by mail-oo1-xc49.google.com with SMTP id 006d021491bc7-581ff5ab8d3so2639229eaf.1 for ; Thu, 02 Nov 2023 11:55:52 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1698951351; x=1699556151; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=32K79yUePS03VyWxcYP10LK3dnc9q0LtbXtqJtsNvV4=; b=jNkaI02zrOESGJU+ma9Wjuqw2iaDZkOYyH/MoUMvi/M9qjwVtBB3YSUJanSomh7PA+ 1L2mYVJ70kkqXuxG4DguW6e6TrAqiPCEfFyge25wELjoqxmq38X3FOK/J2IMPQ0heZAK bxPbxgOWLgP1n/WT5OMxjRlZF1UzMreGD8A64gxyDJf8cIDMMO8OeFkk9A/y8/8Dfysy s6efwNwdGaHkAe0rPWGe/A70TniLYitBklF4tJC3CQnSFFnFpuZzMBWBrqQ7SPTcAdgw HKULLQxt5GP2Ix3kQK98uc3DPWfYxrsoN1AeXWf9uIYJla48Jxfbp4LYsjZptFmIx/FD on8g== X-Gm-Message-State: AOJu0Yy006HkyNYfcRTbhAxbypAFcXsYTtuBkTRPB5jdi0M+7hS0CpPD hDwDYFGRBpZc7bJbnmoYlnKMW3GQTtM8ifELxw== X-Google-Smtp-Source: AGHT+IEDkF7Oi1IvBAECUO1D2BZ/WfZR7U3roLxCuXWWPqD/1I8emyNHZYAH7mCiA7sr/QX8V5tqqhhnpUgVQ3gPTg== X-Received: from jstitt-linux1.c.googlers.com ([fda3:e722:ac3:cc00:2b:ff92:c0a8:23b5]) (user=justinstitt job=sendgmr) by 2002:a05:6870:b629:b0:1e9:a86f:ec44 with SMTP id cm41-20020a056870b62900b001e9a86fec44mr375267oab.2.1698951351424; Thu, 02 Nov 2023 11:55:51 -0700 (PDT) Date: Thu, 02 Nov 2023 18:55:43 +0000 In-Reply-To: <20231102-ethtool_puts_impl-v4-0-14e1e9278496@google.com> Mime-Version: 1.0 References: <20231102-ethtool_puts_impl-v4-0-14e1e9278496@google.com> X-Developer-Key: i=justinstitt@google.com; a=ed25519; pk=tC3hNkJQTpNX/gLKxTNQKDmiQl6QjBNCGKJINqAdJsE= X-Developer-Signature: v=1; a=ed25519-sha256; t=1698951347; l=1990; i=justinstitt@google.com; s=20230717; h=from:subject:message-id; bh=5WZCSRmn5I240grrVCw4x/4n7/d4Ou3ZeMgHOu6QRHU=; b=1nZEvR6w+gOAIckxQFx/hzREhfGTALc08T+ct+mnZ2DmKk8uycd6z6khwq8TbMAwCu9Ezqp/H Dfu4ZT5igmOB2KC0bZOz7azBMQm7Hj6sTI87CdS0CAZqv2537ilCpzL X-Mailer: b4 0.12.3 Message-ID: <20231102-ethtool_puts_impl-v4-2-14e1e9278496@google.com> From: Justin Stitt To: "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Shay Agroskin , Arthur Kiyanovski , David Arinzon , Noam Dagan , Saeed Bishara , Rasesh Mody , Sudarsana Kalluru , GR-Linux-NIC-Dev@marvell.com, Dimitris Michailidis , Yisen Zhuang , Salil Mehta , Jesse Brandeburg , Tony Nguyen , Louis Peens , Shannon Nelson , Brett Creeley , drivers@pensando.io, "K. Y. Srinivasan" , Haiyang Zhang , Wei Liu , Dexuan Cui , Ronak Doshi , VMware PV-Drivers Reviewers , Andy Whitcroft , Joe Perches , Dwaipayan Ray , Lukas Bulwahn , Hauke Mehrtens , Andrew Lunn , Florian Fainelli , Vladimir Oltean , " =?utf-8?b?QXLEsW7DpyDDnE5BTA==?= " , Daniel Golle , Landen Chao , DENG Qingfang , Sean Wang , Matthias Brugger , AngeloGioacchino Del Regno , Linus Walleij , " =?utf-8?q?Alvin_=C5=A0ipraga?= " , Wei Fang , Shenwei Wang , Clark Wang , NXP Linux Team , Lars Povlsen , Steen Hegelund , Daniel Machon , UNGLinuxDriver@microchip.com, Jiawen Wu , Mengyuan Lou , Heiner Kallweit , Russell King , Alexei Starovoitov , Daniel Borkmann , Jesper Dangaard Brouer , John Fastabend X-Mailman-Approved-At: Thu, 02 Nov 2023 20:21:17 +0000 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1698951351; x=1699556151; darn=lists.osuosl.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=32K79yUePS03VyWxcYP10LK3dnc9q0LtbXtqJtsNvV4=; b=YdshN/4XkUJaA3sxCirCnFSOtjHI4ZsuxjTjRMB8+yIxqwJO74nzVdpsca+B+a73D9 3x7CtaaF5EC7s+xlzAzaxuzEK1xzSM098620hNQ7ULO1JHEZF7+4qkpOA/Np3iXZz156 //4wiu63JBeP6xJei49jye7eDCa2B3jnXYEBuTNBZplXNevDeKlcueWn0qFjj9ZMsfrv G2aAW0lfWeWEHKVT4sB2WtwNvrPWPR2hxsWYAwe3EFh+qw1n9v7U2r80DPI4fJFYJea+ l8VRl359RISLkQp8eAG+hLSuF5vEmXNyPoIk9A7ILjErA3IWm6Q1FjLCdhPJLyAU9eqm FaBw== X-Mailman-Original-Authentication-Results: smtp2.osuosl.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.a=rsa-sha256 header.s=20230601 header.b=YdshN/4X Subject: [Intel-wired-lan] [PATCH net-next v4 2/3] checkpatch: add ethtool_sprintf rules X-BeenThere: intel-wired-lan@osuosl.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Intel Wired Ethernet Linux Kernel Driver Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: linux-hyperv@vger.kernel.org, Kees Cook , netdev@vger.kernel.org, Nick Desaulniers , linux-kernel@vger.kernel.org, Nathan Chancellor , oss-drivers@corigine.com, intel-wired-lan@lists.osuosl.org, Justin Stitt , linux-mediatek@lists.infradead.org, bpf@vger.kernel.org, linux-arm-kernel@lists.infradead.org Errors-To: intel-wired-lan-bounces@osuosl.org Sender: "Intel-wired-lan" Add some warnings for using ethtool_sprintf() where a simple ethtool_puts() would suffice. The two cases are: 1) Use ethtool_sprintf() with just two arguments: | ethtool_sprintf(&data, driver[i].name); or 2) Use ethtool_sprintf() with a standalone "%s" fmt string: | ethtool_sprintf(&data, "%s", driver[i].name); The former may cause -Wformat-security warnings while the latter is just not preferred. Both are safely in the category of warnings, not errors. Signed-off-by: Justin Stitt --- scripts/checkpatch.pl | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 7d16f863edf1..9369ce1d15c5 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -7020,6 +7020,25 @@ sub process { "Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90\n" . $herecurr); } +# ethtool_sprintf uses that should likely be ethtool_puts + if ($line =~ /\bethtool_sprintf\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { + if (WARN("PREFER_ETHTOOL_PUTS", + "Prefer ethtool_puts over ethtool_sprintf with only two arguments\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*($FuncArg)/ethtool_puts($1, $7)/; + } + } + + # use $rawline because $line loses %s via sanitization and thus we can't match against it. + if ($rawline =~ /\bethtool_sprintf\s*\(\s*$FuncArg\s*,\s*\"\%s\"\s*,\s*$FuncArg\s*\)/) { + if (WARN("PREFER_ETHTOOL_PUTS", + "Prefer ethtool_puts over ethtool_sprintf with standalone \"%s\" specifier\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*"\%s"\s*,\s*($FuncArg)/ethtool_puts($1, $7)/; + } + } + + # typecasts on min/max could be min_t/max_t if ($perl_version_ok && defined $stat &&