From: Len Baker <len.baker@gmx.com>
To: Jonathan Corbet <corbet@lwn.net>, Kees Cook <keescook@chromium.org>
Cc: Len Baker <len.baker@gmx.com>,
"Gustavo A. R. Silva" <gustavoars@kernel.org>,
Joe Perches <joe@perches.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-hardening@vger.kernel.org
Subject: [PATCH v3] docs: deprecated.rst: Clarify open-coded arithmetic with literals
Date: Sat, 25 Sep 2021 16:34:55 +0200 [thread overview]
Message-ID: <20210925143455.21221-1-len.baker@gmx.com> (raw)
Although using literals for size calculation in allocator arguments may
be harmless due to compiler warnings in case of overflows, it is better
to refactor the code to avoid the use of open-coded arithmetic.
So, clarify the preferred way in these cases.
Suggested-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Len Baker <len.baker@gmx.com>
---
Changelog v1 -> v2
- Clarify the sentence by changing "keep <foo> out" with "avoid <foo>"
(Joe Perches).
Changelog v2 -> v3
- Reword the sentence to comunicate better (Jonathan Corbet).
The previous version can be found here [1].
[1] https://lore.kernel.org/linux-hardening/20210829144716.2931-1-len.baker@gmx.com/
Documentation/process/deprecated.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst
index 8ced754a5a0f..388cb19f5dbb 100644
--- a/Documentation/process/deprecated.rst
+++ b/Documentation/process/deprecated.rst
@@ -59,8 +59,9 @@ risk of them overflowing. This could lead to values wrapping around and a
smaller allocation being made than the caller was expecting. Using those
allocations could lead to linear overflows of heap memory and other
misbehaviors. (One exception to this is literal values where the compiler
-can warn if they might overflow. Though using literals for arguments as
-suggested below is also harmless.)
+can warn if they might overflow. However, the preferred way in these
+cases is to refactor the code as suggested below to avoid the open-coded
+arithmetic.)
For example, do not use ``count * size`` as an argument, as in::
--
2.25.1
next reply other threads:[~2021-09-25 14:35 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-25 14:34 Len Baker [this message]
2021-10-20 23:52 ` [PATCH v3] docs: deprecated.rst: Clarify open-coded arithmetic with literals Gustavo A. R. Silva
2021-10-26 15:44 ` Jonathan Corbet
2021-10-26 17:05 ` Gustavo A. R. Silva
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=20210925143455.21221-1-len.baker@gmx.com \
--to=len.baker@gmx.com \
--cc=corbet@lwn.net \
--cc=gustavoars@kernel.org \
--cc=joe@perches.com \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hardening@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).