Date: Thu, 23 Jul 2015 13:52:02 -0700 (PDT)
From: David Rientjes <rientjes@google.com>
To: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
cc: Mike Kravetz <mike.kravetz@oracle.com>, Hugh Dickins <hughd@google.com>,
        Davide Libenzi <davidel@xmailserver.org>,
        Eric B Munson <emunson@akamai.com>, linux-kernel@vger.kernel.org,
        linux-mm@kvack.org, linux-man@vger.kernel.org
Subject: Re: [patch] mmap.2: document the munmap exception for underlying
 page size
In-Reply-To: <55B0E900.8090207@gmail.com>
Message-ID: <alpine.DEB.2.10.1507231349080.31024@chino.kir.corp.google.com>
References: <alpine.DEB.2.10.1507211736300.24133@chino.kir.corp.google.com> <55B027D3.4020608@oracle.com> <alpine.DEB.2.10.1507221646100.14953@chino.kir.corp.google.com> <55B0E900.8090207@gmail.com>
User-Agent: Alpine 2.10 (DEB 1266 2009-07-14)
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1998
Lines: 49

On Thu, 23 Jul 2015, Michael Kerrisk (man-pages) wrote:

> >> Should we also add a similar comment for the mmap offset?  Currently
> >> the man page says:
> >>
> >> "offset must be a multiple of the page size as returned by
> >>  sysconf(_SC_PAGE_SIZE)."
> >>
> >> For hugetlbfs, I beieve the offset must be a multiple of the
> >> hugetlb page size.  A similar comment/exception about using
> >> the "underlying page size" would apply here as well.
> >>
> > 
> > Yes, that makes sense, thanks.  We should also explicitly say that mmap(2) 
> > automatically aligns length to be hugepage aligned if backed by hugetlbfs.
> 
> And, surely, it also does something similar for mmap()'s 'addr'
> argument? 
> 
> I suggest we add a subsection to describe the HugeTLB differences. How 
> about something like:
> 
>    Huge page (Huge TLB) mappings
>        For  mappings  that  employ  huge pages, the requirements for the
>        arguments  of  mmap()  and  munmap()  differ  somewhat  from  the
>        requirements for mappings that use the native system page size.
> 
>        For mmap(), offset must be a multiple of the underlying huge page
>        size.  The system automatically aligns length to be a multiple of
>        the underlying huge page size.
> 
>        For  munmap(),  addr  and  length  must both be a multiple of the
>        underlying huge page size.
> ?
> 

Looks good, please add my acked-by.  The commit that expanded on the 
documentation of this behavior was 
80d6b94bd69a7a49b52bf503ef6a841f43cf5bbb.

Answering from your other email, no, this behavior in the kernel has not 
changed recently but we found it wasn't properly documented so we wanted 
to fix that both in the kernel tree and in the man-pages to make it 
explicit.
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/