linux-kernel - Re: [PATCH net-next v4 5/5] net: Document netmem driver support

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: <CAHS8izMw4m7Bv5zD2eT2MwFzk0QGFx1gkPu6wig7Uk__tpjW9g@mail.gmail.com>
Date: Tue, 17 Dec 2024 11:27:42 -0800
From: Mina Almasry <almasrymina@...gle.com>
To: "Nelson, Shannon" <shannon.nelson@....com>
Cc: netdev@...r.kernel.org, Jakub Kicinski <kuba@...nel.org>, 
	Pavel Begunkov <asml.silence@...il.com>, Willem de Bruijn <willemb@...gle.com>, 
	Kaiyuan Zhang <kaiyuanz@...gle.com>, Samiullah Khawaja <skhawaja@...gle.com>, linux-doc@...r.kernel.org, 
	linux-kernel@...r.kernel.org, "David S. Miller" <davem@...emloft.net>, 
	Eric Dumazet <edumazet@...gle.com>, Paolo Abeni <pabeni@...hat.com>, Simon Horman <horms@...nel.org>, 
	Jonathan Corbet <corbet@....net>, Jesper Dangaard Brouer <hawk@...nel.org>, 
	Ilias Apalodimas <ilias.apalodimas@...aro.org>
Subject: Re: [PATCH net-next v4 5/5] net: Document netmem driver support

On Wed, Dec 11, 2024 at 2:58 PM Nelson, Shannon <shannon.nelson@....com> wrote:
> > +
> > +Driver support
> > +==============
> > +
> > +1. The driver must support page_pool. The driver must not do its own recycling
> > +   on top of page_pool.
> > +
> > +2. The driver must support the tcp-data-split ethtool option.
> > +
> > +3. The driver must use the page_pool netmem APIs. The netmem APIs are
> > +   currently 1-to-1 correspond with page APIs. Conversion to netmem should be
> > +   achievable by switching the page APIs to netmem APIs and tracking memory via
> > +   netmem_refs in the driver rather than struct page * :
> > +
> > +   - page_pool_alloc -> page_pool_alloc_netmem
> > +   - page_pool_get_dma_addr -> page_pool_get_dma_addr_netmem
> > +   - page_pool_put_page -> page_pool_put_netmem
> > +
> > +   Not all page APIs have netmem equivalents at the moment. If your driver
> > +   relies on a missing netmem API, feel free to add and propose to netdev@ or
> > +   reach out to almasrymina@...gle.com for help adding the netmem API.
>
> You may want to replace your name with "the maintainers" and let the
> MAINTAINERS file keep track of who currently takes care of netmem
> things, rather than risk this email getting stale and forgotten.
>

If it's OK with you, I'll change this to "the maintainers and/or
almasrymina@...gle.com".

Reasoning is that currently Jakub really has reviewed all the netmem
stuff very closely, and I'm hesitant to practically point to him to
all future netmem questions or issues, especially since I can help
with all the low hanging fruit. I don't currently show up in the
maintainers file, and unless called for there is no entry for netmem
maintenance. Wording the docs like this gives me the chance to help
with some of the low hanging fruit without going so far as to add
myself to maintainers.

If the email does go stale we can always update it and if there
becomes a dedicated entry in MAINTAINERS for netmem we can always
remove this.

Will address all the other points, thanks!

-- 
Thanks,
Mina