Add -Wsign-compare to the project's CFLAGS #118
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The lttng-tools code base has many erroneous comparisons between
signed and unsigned values.
While some uses are benign, like using a signed integer to loop
between 0 and sizeof(struct some_structure), there are many
cases where the "signed integer" result of a syscall
(e.g. sendmsg, recvmsg, read, write) is compared to an expected
structure size using sizeof, which returns a result of type
size_t.
The following pattern:
ret = sendmsg(...);
if (ret < sizeof(struct some_structure)) {
/* Handle error. */
}
is common and _unsafe_ if the intention is to check for an error
(-1) and that the operation was completed (ret == sizeof(...)).
Follow-up patches address the various instances of the problem.
The "Clean-up:" prefix is used when the comparison was safe
and the change is mainly done to silence the warning.
The "Fix:" prefix is used when the commit fixes an unsafe
comparison and should be backported to previous versions.
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
jgalar
added
bug
refactor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The lttng-tools code base has many erroneous comparisons between
signed and unsigned values.
While some uses are benign, like using a signed integer to loop
between
0andsizeof(struct some_structure), there are manycases where the "signed integer" result of a syscall
(e.g.
sendmsg,recvmsg,read,write) is compared to an expectedstructure size using the
sizeofoperator, which returns a result of typesize_t.The following pattern:
is common and unsafe if the intention is to check for an error
(
-1) and that the operation was completed (ret == sizeof(...)).Follow-up patches address the various instances of the problem.
The
Clean-up:prefix is used when the comparison was safeand the change is mainly done to silence the warning.
The
Fix:prefix is used when the commit fixes an unsafecomparison and should be backported to previous versions.