linux-kernel - Re: [RFC PATCH] docs/mm: add VMA locks documentation

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: <Zyjl-YxldU7EQAdv@kernel.org>
Date: Mon, 4 Nov 2024 17:19:21 +0200
From: Mike Rapoport <rppt@...nel.org>
To: Lorenzo Stoakes <lorenzo.stoakes@...cle.com>
Cc: Jonathan Corbet <corbet@....net>,
	Andrew Morton <akpm@...ux-foundation.org>,
	"Liam R . Howlett" <Liam.Howlett@...cle.com>,
	Vlastimil Babka <vbabka@...e.cz>, Jann Horn <jannh@...gle.com>,
	Alice Ryhl <aliceryhl@...gle.com>,
	Boqun Feng <boqun.feng@...il.com>,
	Matthew Wilcox <willy@...radead.org>, linux-mm@...ck.org,
	linux-kernel@...r.kernel.org
Subject: Re: [RFC PATCH] docs/mm: add VMA locks documentation

On Mon, Nov 04, 2024 at 02:17:36PM +0000, Lorenzo Stoakes wrote:
> On Sat, Nov 02, 2024 at 11:00:20AM +0200, Mike Rapoport wrote:
> > > +
> > > +The table specifies which write locks must be held to write to the field.
> > > +
> > > +.. list-table::
> > > +   :widths: 20 10 22 5 20
> > > +   :header-rows: 1
> >
> > And use .. table here as well, e.g
> 
> Hm this one is a little less clearly worth it because not only will that take me
> ages but it'll be quite difficult to read in a sensible editor. I can if you
> insist though?

With spaces it will look just fine in a text editor and IMHO better than
list-table, but I don't insist.
 
> > .. table::
> >
> >     ======== ======== ========================== ================== ==========
> >     Field    Config   Description                Unstable RCU read? Write lock
> >     ======== ======== ========================== ================== ==========
> >     vm_start          Inclusive start virtual                       mmap write,
> >                       address of range VMA                          VMA write
> >                       describes
> >
> >     vm_end            Exclusive end virtual                         mmap write,
> >                       address of range VMA                          VMA write
> >                       describes
> >
> >     vm_rcu   vma_lock RCU list head, in union    N/A                N/A
> >                       with vma_start, vma_end.
> >                       RCU implementation detail
> >     ======== ======== ========================== ================== ==========

-- 
Sincerely yours,
Mike.