linux-kernel - Re: [PATCH v14 011/138] mm/lru: Add folio LRU functions

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]

Message-ID: <YPbLWVXXC8sJNt8N@casper.infradead.org>
Date:   Tue, 20 Jul 2021 14:10:49 +0100
From:   Matthew Wilcox <willy@...radead.org>
To:     Mike Rapoport <rppt@...nel.org>
Cc:     linux-kernel@...r.kernel.org, linux-mm@...ck.org,
        linux-fsdevel@...r.kernel.org, Yu Zhao <yuzhao@...gle.com>,
        Christoph Hellwig <hch@....de>,
        David Howells <dhowells@...hat.com>,
        "Kirill A . Shutemov" <kirill.shutemov@...ux.intel.com>
Subject: Re: [PATCH v14 011/138] mm/lru: Add folio LRU functions

On Tue, Jul 20, 2021 at 01:44:10PM +0300, Mike Rapoport wrote:
> >  /**
> > - * page_is_file_lru - should the page be on a file LRU or anon LRU?
> > - * @page: the page to test
> > + * folio_is_file_lru - should the folio be on a file LRU or anon LRU?
> > + * @folio: the folio to test
> >   *
> > - * Returns 1 if @page is a regular filesystem backed page cache page or a lazily
> > - * freed anonymous page (e.g. via MADV_FREE).  Returns 0 if @page is a normal
> > - * anonymous page, a tmpfs page or otherwise ram or swap backed page.  Used by
> > - * functions that manipulate the LRU lists, to sort a page onto the right LRU
> > - * list.
> > + * Returns 1 if @folio is a regular filesystem backed page cache folio
> > + * or a lazily freed anonymous folio (e.g. via MADV_FREE).  Returns 0 if
> > + * @folio is a normal anonymous folio, a tmpfs folio or otherwise ram or
> > + * swap backed folio.  Used by functions that manipulate the LRU lists,
> > + * to sort a folio onto the right LRU list.
> >   *
> >   * We would like to get this info without a page flag, but the state
> > - * needs to survive until the page is last deleted from the LRU, which
> > + * needs to survive until the folio is last deleted from the LRU, which
> >   * could be as far down as __page_cache_release.
> 
> It seems mm_inline.h is not a part of generated API docs, otherwise
> kerneldoc would be unhappy about missing Return: description.

kernel-doc doesn't warn about that by default.

    # This check emits a lot of warnings at the moment, because many
    # functions don't have a 'Return' doc section. So until the number
    # of warnings goes sufficiently down, the check is only performed in
    # verbose mode.
    # TODO: always perform the check.
    if ($verbose && !$noret) {
            check_return_section($file, $declaration_name, $return_type);
    }