Commit c18c20f1 authored Nov 07, 2022 by Vlastimil Babka

mm, slab: remove duplicate kernel-doc comment for ksize()



Akira reports:

> "make htmldocs" reports duplicate C declaration of ksize() as follows:

> /linux/Documentation/core-api/mm-api:43: ./mm/slab_common.c:1428: WARNING: Duplicate C declaration, also defined at core-api/mm-api:212.
> Declaration is '.. c:function:: size_t ksize (const void *objp)'.

> This is due to the kernel-doc comment for ksize() declaration added in
> include/linux/slab.h by commit 05a94065 ("slab: Introduce
> kmalloc_size_roundup()").

There is an older kernel-doc comment for ksize() definition in
mm/slab_common.c, which is not only duplicated, but also contradicts the
new one - the additional storage discovered by ksize() should not be
used by callers anymore. Delete the old kernel-doc.

Reported-by: Akira Yokosawa <akiyks@gmail.com>
Link: https://lore.kernel.org/all/d33440f6-40cf-9747-3340-e54ffaf7afb8@gmail.com/


Fixes: 05a94065 ("slab: Introduce kmalloc_size_roundup()")
Cc: Kees Cook <keescook@chromium.org>
Signed-off-by: Vlastimil Babka <vbabka@suse.cz>

parent 32868715

mm/slab_common.c

+0 −14

Original line number	Diff line number	Diff line
		@@ -1409,20 +1409,6 @@ void kfree_sensitive(const void *p)
		}
		EXPORT_SYMBOL(kfree_sensitive);

		/**
		* ksize - get the actual amount of memory allocated for a given object
		* @objp: Pointer to the object
		*
		* kmalloc may internally round up allocations and return more memory
		* than requested. ksize() can be used to determine the actual amount of
		* memory allocated. The caller may use this additional memory, even though
		* a smaller amount of memory was initially specified with the kmalloc call.
		* The caller must guarantee that objp points to a valid object previously
		* allocated with either kmalloc() or kmem_cache_alloc(). The object
		* must not be freed during the duration of the call.
		*
		* Return: size of the actual memory used by @objp in bytes
		*/
		size_t ksize(const void *objp)
		{
		size_t size;