On Mon, 29 Apr 2024, Justin Stitt wrote:
> I am going to quote Lee Jones who has been doing some snprintf ->
> scnprintf refactorings:
>
> "There is a general misunderstanding amongst engineers that
> {v}snprintf() returns the length of the data *actually* encoded into the
> destination array. However, as per the C99 standard {v}snprintf()
> really returns the length of the data that *would have been* written if
> there were enough space for it. This misunderstanding has led to
> buffer-overruns in the past. It's generally considered safer to use the
> {v}scnprintf() variants in their place (or even sprintf() in simple
> cases). So let's do that."
>
> To help prevent new instances of snprintf() from popping up, let's add a
> check to checkpatch.pl.
>
> Suggested-by: Finn Thain <[email protected]>
> Signed-off-by: Justin Stitt <[email protected]>
> ---
> Changes in v6:
> - move capture group to only include symbol name (not spaces or paren)
> - Link to v5:
> https://lore.kernel.org/r/[email protected]
>
> Changes in v5:
> - use capture groups to let the user know which variation they used
> - Link to v4:
> https://lore.kernel.org/r/[email protected]
>
> Changes in v4:
> - also check for vsnprintf variant (thanks Bill)
> - Link to v3:
> https://lore.kernel.org/r/[email protected]
>
> Changes in v3:
> - fix indentation
> - add reference link (https://github.com/KSPP/linux/issues/105) (thanks Joe)
> - Link to v2:
> https://lore.kernel.org/r/[email protected]
>
> Changes in v2:
> - Had a vim moment and deleted a character before sending the patch.
> - Replaced the character :)
> - Link to v1:
> https://lore.kernel.org/r/[email protected]
> ---
> From a discussion here [1].
>
> [1]:
> https://lore.kernel.org/all/[email protected]/
> ---
> scripts/checkpatch.pl | 6 ++++++
> 1 file changed, 6 insertions(+)
Reviewed-by: Lee Jones <[email protected]>
--
Lee Jones [李琼斯]
