Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <71b57f2d-37cd-9c33-c6b2-7f4b14b2b691@suse.cz>
Date:   Mon, 7 Nov 2022 17:23:40 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.4.1
Subject: Re: Duplicate kernel-doc comments for ksize()
Content-Language: en-US
To:     Akira Yokosawa <akiyks@gmail.com>,
        Kees Cook <keescook@chromium.org>,
        Hyeonggon Yoo <42.hyeyoo@gmail.com>,
        Christoph Lameter <cl@linux.com>,
        David Rientjes <rientjes@google.com>,
        Joonsoo Kim <iamjoonsoo.kim@lge.com>,
        Pekka Enberg <penberg@kernel.org>,
        Roman Gushchin <roman.gushchin@linux.dev>
Cc:     Jonathan Corbet <corbet@lwn.net>, linux-mm@kvack.org,
        linux-kernel@vger.kernel.org
References: <d33440f6-40cf-9747-3340-e54ffaf7afb8@gmail.com>
From:   Vlastimil Babka <vbabka@suse.cz>
In-Reply-To: <d33440f6-40cf-9747-3340-e54ffaf7afb8@gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 11/7/22 11:41, Akira Yokosawa wrote:
> Hi Kees,
> 
> "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() added in
> include/linux/slab.h by a commit you have authored:
>   05a940656e1e ("slab:Introduce kmalloc_size_roundup()").
> 
> /**
>  * ksize - Report actual allocation size of associated object
>  *
>  * @objp: Pointer returned from a prior kmalloc()-family allocation.
>  *
>  * This should not be used for writing beyond the originally requested
>  * allocation size. Either use krealloc() or round up the allocation size
>  * with kmalloc_size_roundup() prior to allocation. If this is used to
>  * access beyond the originally requested allocation size, UBSAN_BOUNDS
>  * and/or FORTIFY_SOURCE may trip, since they only know about the
>  * originally allocated size via the __alloc_size attribute.
>  */
> 
> There is another kernel-doc comment in mm/slab_common.c (originally
> by Manfred, since v2.6.14):
> 
> /**
>  * 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
>  */
> 
> I guess the one in slab_common.c is outdated and can be removed.
> Can you please take care of it?

Thanks for the report, I've removed the comment myself in a slab.git fixes
branch I'll be sending a PR for this week:

https://git.kernel.org/pub/scm/linux/kernel/git/vbabka/slab.git/commit/?h=slab/for-6.1-rc4/fixes&id=c18c20f16219516b12a4f2fd29c25e06be97e064

>         Thanks, Akira