Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752966AbbGWNP5 (ORCPT ); Thu, 23 Jul 2015 09:15:57 -0400 Received: from mail-wi0-f177.google.com ([209.85.212.177]:37166 "EHLO mail-wi0-f177.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751025AbbGWNPs (ORCPT ); Thu, 23 Jul 2015 09:15:48 -0400 Message-ID: <55B0E900.8090207@gmail.com> Date: Thu, 23 Jul 2015 15:15:44 +0200 From: "Michael Kerrisk (man-pages)" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.7.0 MIME-Version: 1.0 To: David Rientjes , Mike Kravetz CC: mtk.manpages@gmail.com, Hugh Dickins , Davide Libenzi , Eric B Munson , 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 References: <55B027D3.4020608@oracle.com> In-Reply-To: Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 2881 Lines: 79 On 07/23/2015 01:49 AM, David Rientjes wrote: > On Wed, 22 Jul 2015, Mike Kravetz wrote: > >> On 07/21/2015 05:41 PM, David Rientjes wrote: >>> munmap(2) will fail with an errno of EINVAL for hugetlb memory if the >>> length is not a multiple of the underlying page size. >>> >>> Documentation/vm/hugetlbpage.txt was updated to specify this behavior >>> since Linux 4.1 in commit 80d6b94bd69a ("mm, doc: cleanup and clarify >>> munmap behavior for hugetlb memory"). >>> >>> Signed-off-by: David Rientjes >>> --- >>> man2/mmap.2 | 4 ++++ >>> 1 file changed, 4 insertions(+) >>> >>> diff --git a/man2/mmap.2 b/man2/mmap.2 >>> --- a/man2/mmap.2 >>> +++ b/man2/mmap.2 >>> @@ -383,6 +383,10 @@ All pages containing a part >>> of the indicated range are unmapped, and subsequent references >>> to these pages will generate >>> .BR SIGSEGV . >>> +An exception is when the underlying memory is not of the native page >>> +size, such as hugetlb page sizes, whereas >>> +.I length >>> +must be a multiple of the underlying page size. >>> It is not an error if the >>> indicated range does not contain any mapped pages. >>> .SS Timestamps changes for file-backed mappings >>> >>> -- >> >> 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. ? Thanks, Michael -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- 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/