| Message ID | 1562219683-15474-1-git-send-email-nitin.r.gote@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | checkpatch: Added warnings in favor of strscpy(). | expand |
On Thu, 2019-07-04 at 11:24 +0530, Nitin Gote wrote: > Added warnings in checkpatch.pl script to : > > 1. Deprecate strcpy() in favor of strscpy(). > 2. Deprecate strlcpy() in favor of strscpy(). > 3. Deprecate strncpy() in favor of strscpy() or strscpy_pad(). > > Updated strncpy() section in Documentation/process/deprecated.rst > to cover strscpy_pad() case. > > Signed-off-by: Nitin Gote <nitin.r.gote@intel.com> OK, for whatever reason, this when into a spam folder. > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl [] > @@ -595,6 +595,11 @@ our %deprecated_apis = ( > "rcu_barrier_sched" => "rcu_barrier", > "get_state_synchronize_sched" => "get_state_synchronize_rcu", > "cond_synchronize_sched" => "cond_synchronize_rcu", > + "strcpy" => "strscpy", > + "strlcpy" => "strscpy", > + "strncpy" => "strscpy, strscpy_pad or for > + non-NUL-terminated strings, strncpy() can still be used, but > + destinations should be marked with the __nonstring", > ); $ git grep -w strcpy | wc -l 2239 $ git grep -w strlcpy | wc -l 1760 $ git grep -w strncpy | wc -l 839 These functions are _really_ commonly used in the kernel. This should probably be a different %deprecated_string_api and these should probably not be emitted at WARN level when using command line option -f/--file but at CHECK level so that novice script users just don't send bad patches. Also, perhaps there could be some macro for the relatively commonly used strscpy(foo, bar, sizeof(foo)) and strlcpy(foo, bar, sizeof(foo)) so argument 1 doesn't have to be repeated in the sizeof() Something like: #define stracpy(to, from) \ ({ \ size_t size = ARRAY_SIZE(to); \ BUILD_BUG_ON(!__same_type(typeof(*to), char)); \ \ strscpy(to, from, size); \ })
diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst index 49e0f64..f564de3 100644 --- a/Documentation/process/deprecated.rst +++ b/Documentation/process/deprecated.rst @@ -93,9 +93,9 @@ will be NUL terminated. This can lead to various linear read overflows and other misbehavior due to the missing termination. It also NUL-pads the destination buffer if the source contents are shorter than the destination buffer size, which may be a needless performance penalty for callers using -only NUL-terminated strings. The safe replacement is :c:func:`strscpy`. -(Users of :c:func:`strscpy` still needing NUL-padding will need an -explicit :c:func:`memset` added.) +only NUL-terminated strings. In this case, the safe replacement is +:c:func:`strscpy`. If, however, the destination buffer still needs +NUL-padding, the safe replacement is :c:func:`strscpy_pad`. If a caller is using non-NUL-terminated strings, :c:func:`strncpy()` can still be used, but destinations should be marked with the `__nonstring diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 342c7c7..3d80967 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -595,6 +595,11 @@ our %deprecated_apis = ( "rcu_barrier_sched" => "rcu_barrier", "get_state_synchronize_sched" => "get_state_synchronize_rcu", "cond_synchronize_sched" => "cond_synchronize_rcu", + "strcpy" => "strscpy", + "strlcpy" => "strscpy", + "strncpy" => "strscpy, strscpy_pad or for + non-NUL-terminated strings, strncpy() can still be used, but + destinations should be marked with the __nonstring", ); #Create a search pattern for all these strings to speed up a loop below