linux-kernel - Re: [PATCH] highmem: Document kunmap

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 24 Jan 2022 04:28:53 -0800
From:   Christoph Hellwig <hch@...radead.org>
To:     ira.weiny@...el.com
Cc:     Andrew Morton <akpm@...ux-foundation.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] highmem: Document kunmap_local()

On Sun, Jan 23, 2022 at 05:30:44PM -0800, ira.weiny@...el.com wrote:
> + * __addr is often an address returned from kmap_local_page().  However,
> + * this address can be any address within the mapped page.  It does not need to
> + * be the exact address returned from kmap_local_page()
> + */

I'd word this a little different:

> + * __addr is often an address returned from kmap_local_page().  However,
> + * this address can be any address within the mapped page.  It does not need to
> + * be the exact address returned from kmap_local_page()
> + */

 * @__addr can be any address within the mapped page.  Commonly it is the
 * address return from kmap_local_page(), but it can also include offsets.

But documenting this definitively is a good idea!