summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMichal Luczaj <mhal@rbox.co>2024-11-19 16:31:43 +0300
committerPaolo Abeni <pabeni@redhat.com>2024-11-28 10:57:42 +0300
commit49b2b973325add467270e906d4d794aa6679b38b (patch)
tree60dc45d6d52ff90178d5b51b5824531dd454d011 /include
parent02020056647017e70509bb58c3096448117099e1 (diff)
downloadlinux-49b2b973325add467270e906d4d794aa6679b38b.tar.xz
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>
Diffstat (limited to 'include')
-rw-r--r--include/linux/sockptr.h2
1 files changed, 2 insertions, 0 deletions
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)
{