From: Chuhong Yuan <hslester96@gmail.com>
To: unlisted-recipients:; (no To-header on input)
Cc: Jonathan Corbet <corbet@lwn.net>,
Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Chuhong Yuan <hslester96@gmail.com>
Subject: [PATCH v2] Documentation/checkpatch: Prefer str_has_prefix over strncmp
Date: Mon, 5 Aug 2019 15:26:45 +0800 [thread overview]
Message-ID: <20190805072645.32691-1-hslester96@gmail.com> (raw)
Add "strncmp() on string prefix" to
Documentation/process/deprecated.rst since using strncmp()
to check whether a string starts with a prefix is error-prone.
The safe replacement is str_has_prefix().
Also add check to the newly introduced deprecated_string_apis
in checkpatch.pl.
This patch depends on patch:
"Documentation/checkpatch: Prefer stracpy/strscpy over
strcpy/strlcpy/strncpy."
Signed-off-by: Chuhong Yuan <hslester96@gmail.com>
---
Changes in v2:
- Use "strncmp() on string prefix" instead of
"strncmp()" to make it more precise.
- Remove "c:func" and use "strncmp" directly
in description.
Documentation/process/deprecated.rst | 8 ++++++++
scripts/checkpatch.pl | 1 +
2 files changed, 9 insertions(+)
diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst
index 56280e108d5a..96fa32aba189 100644
--- a/Documentation/process/deprecated.rst
+++ b/Documentation/process/deprecated.rst
@@ -109,6 +109,14 @@ the given limit of bytes to copy. This is inefficient and can lead to
linear read overflows if a source string is not NUL-terminated. The
safe replacement is stracpy() or strscpy().
+strncmp() on string prefix
+--------------------------
+strncmp() is often used to test if a string starts with a prefix by
+strncmp(str, prefix, length of prefix). This is error-prone because length
+of prefix can have counting error if using a constant length, or use
+sizeof(prefix) without - 1. Also, if the prefix is a pointer, sizeof(prefix)
+leads to a wrong size. The safe replacement is str_has_prefix().
+
Variable Length Arrays (VLAs)
-----------------------------
Using stack VLAs produces much worse machine code than statically
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 0ae9ae01d855..38e82d2ac286 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -609,6 +609,7 @@ our %deprecated_string_apis = (
"strcpy" => "stracpy or strscpy",
"strlcpy" => "stracpy or strscpy",
"strncpy" => "stracpy or strscpy - for non-NUL-terminated uses, strncpy dest should be __nonstring",
+ "strncmp" => "str_has_prefix",
);
#Create a search pattern for all these strings apis to speed up a loop below
--
2.20.1
reply other threads:[~2019-08-05 7:26 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190805072645.32691-1-hslester96@gmail.com \
--to=hslester96@gmail.com \
--cc=apw@canonical.com \
--cc=corbet@lwn.net \
--cc=joe@perches.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).