From patchwork Mon Aug 14 18:44:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Xu X-Patchwork-Id: 13353179 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 447C5EB64DD for ; Mon, 14 Aug 2023 18:44:24 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 23807900004; Mon, 14 Aug 2023 14:44:23 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 14BC2900003; Mon, 14 Aug 2023 14:44:23 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id EB800900004; Mon, 14 Aug 2023 14:44:22 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id DAB1B900003 for ; Mon, 14 Aug 2023 14:44:22 -0400 (EDT) Received: from smtpin20.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 8019E1A0C96 for ; Mon, 14 Aug 2023 18:44:22 +0000 (UTC) X-FDA: 81123585564.20.8981D0D Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by imf13.hostedemail.com (Postfix) with ESMTP id 6C6162001F for ; Mon, 14 Aug 2023 18:44:20 +0000 (UTC) Authentication-Results: imf13.hostedemail.com; dkim=pass header.d=redhat.com header.s=mimecast20190719 header.b=HV5JE647; spf=pass (imf13.hostedemail.com: domain of peterx@redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=peterx@redhat.com; dmarc=pass (policy=none) header.from=redhat.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1692038660; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=PXZG/qw2ayWAI5P15GI+5RH7awNhex4k3sDbvA4UjWg=; b=TluH4epoQGaG5TOJ+dKQS4JT7wwSO8ezH4XKQBQtqFFScWSVzJqpXVrqjn7a6g+LJMcsGP LSLfRPfUJIFv6RIw5NtJBCogDwi1F5mSME4BSgPJIfx7VwzlcUeFmOfWvVDGiAPJ2TwdEL bUZZlTJ2Q1QlHRIDL29378wNLCEYaZQ= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1692038660; a=rsa-sha256; cv=none; b=fHn9QsHfx0JFIpsovkkcwEwwkqxDlEV5QezvsxYFh07sBsPp9jUzJYUkP2FWzzFrNtzqql iDUi65+5QdHXpgF7KToLdmzZJ/t284dCAL4RvQaEewxp9E6IfJp+teY+SYDh71c/VFTe7P PvotVSs37fQniizGUOIewohenCqgIVU= ARC-Authentication-Results: i=1; imf13.hostedemail.com; dkim=pass header.d=redhat.com header.s=mimecast20190719 header.b=HV5JE647; spf=pass (imf13.hostedemail.com: domain of peterx@redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=peterx@redhat.com; dmarc=pass (policy=none) header.from=redhat.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1692038659; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=PXZG/qw2ayWAI5P15GI+5RH7awNhex4k3sDbvA4UjWg=; b=HV5JE6478oB5UMhfQj/gIez8FUQOPzXtwyBNeOtCSa2m5F218JKadgh8+/eM7QB7NVQ6kZ nAMo5cS7Jz1OI3U7NByWOHGUZ8a+kHVp6ruGGQFYKc99wqNs9xLY/CQg0r0PqtaCNAWyHa xVrD75BB2phShzsqqiRwJYYhP/uDrEw= Received: from mail-qv1-f70.google.com (mail-qv1-f70.google.com [209.85.219.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-133-e6DJ6oGhN12wqrBPrHPoiw-1; Mon, 14 Aug 2023 14:44:18 -0400 X-MC-Unique: e6DJ6oGhN12wqrBPrHPoiw-1 Received: by mail-qv1-f70.google.com with SMTP id 6a1803df08f44-63d2b88325bso13402066d6.1 for ; Mon, 14 Aug 2023 11:44:18 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1692038657; x=1692643457; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=PXZG/qw2ayWAI5P15GI+5RH7awNhex4k3sDbvA4UjWg=; b=ekA+ISMWDU+4MpjKAwoxTU9eLcFeNe+DJ95F9k/mkVlINHuNpD8Dn6SudHWW9+cIZM SSXfzFxYZh1jilRDEb/xU6I01BEQntmT+SXO/n3RQiVckqq3hjgPMqdACdg02ZwGFj4p h2vsL+r+LeT5MbYB0SvPy6V57Sm9yCThZ+15xpO+LvdZrT2uARwROE14rR6tftwSJeLO TkrIWnHVC+mEfXOWoDzk/mEs1AJ1EPc72k32DZELR9jTBcsoj7j9IMRvbrf9vpEpDK8N X0cW5mkLi9eDFrE3a67LFozQ5Hmx9btYeHu3ZJXow4e2hlgb7KzY9Wq0mqaSdN3EPzQA aT0Q== X-Gm-Message-State: AOJu0Yy11yKx7eBg6vQUsT/yr0B39jr3HuxB9j89qOzofS9tHuT2Yfck 2uQPKXjtOyNhvzUjw0Wv54whNa2y3dvsPJBD943KjfPvH7Vh5dhLL/6A3SHhdGqmGhqpW96AcEA AdqklakGu7m9eRgQX3p+4cahR44dbKTnl/KNjJg59xZchmt5VdThb52/JOjQ9o0938iYH X-Received: by 2002:a05:6214:1d09:b0:635:d9d0:cccf with SMTP id e9-20020a0562141d0900b00635d9d0cccfmr14722037qvd.4.1692038657582; Mon, 14 Aug 2023 11:44:17 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGNyKVLMZ66Hr3NQvsgtXcZ9D0YXzjmGtFWrY2Aeh8Bf9t6sbpvwCpEe2tOq//nQtrBk7xUeg== X-Received: by 2002:a05:6214:1d09:b0:635:d9d0:cccf with SMTP id e9-20020a0562141d0900b00635d9d0cccfmr14722010qvd.4.1692038657287; Mon, 14 Aug 2023 11:44:17 -0700 (PDT) Received: from x1n.redhat.com (cpe5c7695f3aee0-cm5c7695f3aede.cpe.net.cable.rogers.com. [99.254.144.39]) by smtp.gmail.com with ESMTPSA id a7-20020a0cb347000000b00630c0ed6339sm3566561qvf.64.2023.08.14.11.44.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 14 Aug 2023 11:44:16 -0700 (PDT) From: Peter Xu To: linux-mm@kvack.org, linux-kernel@vger.kernel.org Cc: Mike Kravetz , David Hildenbrand , Matthew Wilcox , Andrew Morton , peterx@redhat.com, Yu Zhao , Ryan Roberts , Yang Shi , Hugh Dickins , "Kirill A . Shutemov" Subject: [PATCH RFC v2 3/3] mm: Proper document tail pages fields for folio Date: Mon, 14 Aug 2023 14:44:11 -0400 Message-ID: <20230814184411.330496-4-peterx@redhat.com> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230814184411.330496-1-peterx@redhat.com> References: <20230814184411.330496-1-peterx@redhat.com> MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Rspamd-Queue-Id: 6C6162001F X-Rspam-User: X-Rspamd-Server: rspam11 X-Stat-Signature: roze3opoggagywqfioprq177gwcm88nz X-HE-Tag: 1692038660-398122 X-HE-Meta: U2FsdGVkX18W16QMTm6m4aLvp2v3c+nEA7VN7Yd/hhfG+kt8/6BOmY9umtZgn3bKJDnD8Qipy/9QET5fXjYfOpPnK1AHxfv1ffQqxON5NoFHCNv7DqA6O4kYVvpzRgspPfXPI//xMcLaCXBuEa6otkC9tUlx12eZ7236ZB1mfPfUz/LXXM9hcmot5MZjPoHhmRT9q6DkUmVJJbEUIWohVRWw6GRsreI/SWNxdJwFr7HkdQwjcNf29tbtZ5PjhJ2a4f0gYgBXwaKH+58ZTJ0qhRBnYxlSdtsg0seIJ5rB8EkMqvvohLDiTNmqkruoMEcaqecjiZl7947tKMiftIBeKhvY7hLl/9iV2MFjMIJOe+EoDQNneVQo1Z+PcPVOeJpklcQRDg5U+4X2XgugZ6Wb2i1pYi5jQvGHF9uMAXFd1amgTn5CeU7OF8DYcbQ3CXds/BmZ/24uriZ5i4uOx0A4iu+oUl+IsSRz7apxVx227Ak32RJWKBfUzmrwvXT5TFIsX9dQBK4Kvp9ZbmsYVUD38BqZ7no0mvMsnvYn6jxlyzMVcORCDkLCfYbCMEOTthmDPCO/k3Dr7kbs+e/FZJZ30N8M2WeXVmdcz04UOfhQcfgFQeRRfhcKsX0GyzhkrWBgQ4drSvLZdUsqm65QYoSiHL8yz8lQTMkH4/qSJYY6k/r5HMipeUMstuHTsj3l2wOO3J4bezuuQiqnKm14U0wPpZA0Y6rg3sqZwHqM0FrImv8Z44CJRU2prIJpaTujOq2aM/XIbm8lWdHG9LlD15rf++dk38jdspDUnyEEObKNlzELMUXv+6ahk3EDwj8upn+0mVZLrDwFEymx8mr9owPfmjomwn4pcFwWGoCJ4QslHA2N9MzAMZIMqPn3+4uQGdxzW8NMw1tBh1lYHnBL0ieEmLqZaMWPcAvA97ypoiZZhty1c2J1QX/9N5mS5uxPRw3Q2xgpC8InhxC962seUV6 ffxkwYPk sOPHIbrtdY2g5mVhb9vfvqWs5ZRnq6hLMegR1/nEcDnYEdoLcrU24M8lU63yhU3DlcSyTpV9uKZBAArQkifPpUPwfrbdj+NT7z7I+2xd66ZFOycv6o7xb5Vvm6W1Z2LrzgUEO1bJC5jUfMg5j/HfPg8ig67Kn3x7GOe+XqUmo5ztSRiJfOnUjerSROcSX6/zCrgxEjf4hNeh3X7TG3U+IfMfF0CV/23DrVVE4w5Dm0+OtT7gHpRHBsp6oHnR4ZsUobNqRU2+EyB38VOllNak9nBJqesxaCTWNU7W8NilQVAx6TXhcxwURcXWNlMEctmtvaKKelJNnXruaidwvn+nUX0c0c9tuxtC3Ni58U210hNfsTZ2GTzHO/7nQlIBHLh7GP5CAxrx6umj+Ylo= X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Tail page struct reuse is over-comlicated. Not only because we have implicit uses of tail page fields (mapcounts, or private for thp swap support, etc., that we _may_ still use in the page structs, but not obvious the relationship between that and the folio definitions), but also because we have 32/64 bits layouts for struct page so it's unclear what we can use and what we cannot when trying to find a new spot in folio struct. We also have tricks like page->mapping, where we can reuse only the tail page 1/2 but nothing more than tail page 2. It is all mostly hidden, until someone starts to read into a VM_BUG_ON_PAGE() of __split_huge_page_tail(). It's also unclear on how many fields we can reuse for a tail page. The real answer is (after help from Matthew): we have 7 WORDs guaranteed on 64 bits and 8 WORDs on 32 bits. Nothing more than that is guaranteed to even exist. Let's document it clearly on what we can use and what we can't when extending folio on reusing tail page fields, with 100% explanations on each of them. Hopefully after the doc update it will make it easier when: (1) Any reader to know exactly what field is where and for what, the relationships between folio tail pages and struct page definitions, (2) Any potential new fields to be added to a large folio, so we're clear which field one can still reuse. This is assuming WORD is defined as sizeof(void *) on any archs, just like the other comment in struct page we already have. Signed-off-by: Peter Xu --- include/linux/mm_types.h | 41 ++++++++++++++++++++++++++++++++++------ 1 file changed, 35 insertions(+), 6 deletions(-) diff --git a/include/linux/mm_types.h b/include/linux/mm_types.h index 829f5adfded1..9c744f70ae84 100644 --- a/include/linux/mm_types.h +++ b/include/linux/mm_types.h @@ -322,11 +322,40 @@ struct folio { }; struct page page; }; + /* + * Some of the tail page fields may not be reused by the folio + * object because they're already been used by the page struct. On + * 32bits there're at least 8 WORDs while on 64 bits there're at + * least 7 WORDs: + * + * |--------+-------------+-------------------| + * | index | 32 bits | 64 bits | + * |--------+-------------+-------------------| + * | 0 | flags | flags | + * | 1 | head | head | + * | 2 | FREE | FREE | + * | 3 | FREE [1] | FREE [1] | + * | 4 | FREE | FREE | + * | 5 | FREE | private [2] | + * | 6 | mapcnt | mapcnt+refcnt [3] | + * | 7 | refcnt [3] | | + * |--------+-------------+-------------------| + * + * [1] "mapping" field. It is free to use but needs to be with + * some caution due to poisoning, see TAIL_MAPPING_REUSED_MAX. + * + * [2] "private" field, used when THP_SWAP is on (but disabled on + * 32 bits, so this index is FREE on 32bit or hugetlb folios). + * May need to be fixed finally. + * + * [3] "refcount" field must be zero for all tail pages. See e.g. + * has_unmovable_pages() on page_ref_count() check and comment. + */ union { struct { unsigned long _flags_1; unsigned long _head_1; - /* public: */ + /* public: WORD 2 */ unsigned char _folio_dtor; unsigned char _folio_order; /* private: 2 bytes can be reused later */ @@ -335,7 +364,7 @@ struct folio { /* 4 bytes can be reused later (64 bits only) */ unsigned char _free_1_1[4]; #endif - /* public: */ + /* public: WORD 3 */ atomic_t _entire_mapcount; atomic_t _nr_pages_mapped; atomic_t _pincount; @@ -350,20 +379,20 @@ struct folio { struct page __page_1; }; union { - struct { + struct { /* hugetlb folios */ unsigned long _flags_2; unsigned long _head_2; - /* public: */ + /* public: WORD 2 */ void *_hugetlb_subpool; void *_hugetlb_cgroup; void *_hugetlb_cgroup_rsvd; void *_hugetlb_hwpoison; /* private: the union with struct page is transitional */ }; - struct { + struct { /* non-hugetlb folios */ unsigned long _flags_2a; unsigned long _head_2a; - /* public: */ + /* public: WORD 2-3 */ struct list_head _deferred_list; /* private: 8 more free bytes for either 32/64 bits */ unsigned char _free_2_1[8];