From: Michal Luczaj <mhal@rbox.co>
Date: Tue, 19 Nov 2024 13:31:43 +0000 (+0100)
Subject: net: Comment copy_from_sockptr() explaining its behaviour
X-Git-Tag: microblaze-v6.16~504^2~9^2
X-Git-Url: http://git.monstr.eu/?a=commitdiff_plain;h=49b2b973325add467270e906d4d794aa6679b38b;p=linux-2.6-microblaze.git

net: Comment copy_from_sockptr() explaining its behaviour

copy_from_sockptr() has a history of misuse. Add a comment explaining that
the function follows API of copy_from_user(), i.e. returns 0 for success,
or number of bytes not copied on error.

Signed-off-by: Michal Luczaj <mhal@rbox.co>
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
---

diff --git a/include/linux/sockptr.h b/include/linux/sockptr.h
index 195debe2b1db..3e6c8e9d67ae 100644
--- a/include/linux/sockptr.h
+++ b/include/linux/sockptr.h
@@ -53,6 +53,8 @@ static inline int copy_from_sockptr_offset(void *dst, sockptr_t src,
 /* Deprecated.
  * This is unsafe, unless caller checked user provided optlen.
  * Prefer copy_safe_from_sockptr() instead.
+ *
+ * Returns 0 for success, or number of bytes not copied on error.
  */
 static inline int copy_from_sockptr(void *dst, sockptr_t src, size_t size)
 {