Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Liam Howlett <liam.howlett@oracle.com>
To:     Mauro Carvalho Chehab <mchehab@kernel.org>
CC:     Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        Jonathan Corbet <corbet@lwn.net>,
        "Matthew Wilcox (Oracle)" <willy@infradead.org>,
        Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
        Andrew Morton <akpm@linux-foundation.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "linux-mm@kvack.org" <linux-mm@kvack.org>
Subject: Re: [PATCH 15/22] mm: document maple tree pointer at unmap_vmas() at
 memory.c
Thread-Topic: [PATCH 15/22] mm: document maple tree pointer at unmap_vmas() at
 memory.c
Thread-Index: AQHYitP43WO/YWbn3keMiniJGtEfGK1lh8KA
Date:   Wed, 29 Jun 2022 00:25:24 +0000
Message-ID: <20220629002517.7xzweisyydh2mseb@revolver>
References: <cover.1656409369.git.mchehab@kernel.org>
 <d2690118414c5458c448348cc94f831d8e8444ce.1656409369.git.mchehab@kernel.org>
In-Reply-To: <d2690118414c5458c448348cc94f831d8e8444ce.1656409369.git.mchehab@kernel.org>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?ps/ju7C9RyxL/620RXTlgl/paJ8qcISLRbtkw0P1Oyqm8p66mQ+wMfyaHmZV?=
 =?us-ascii?Q?TPUFR3/8TPS6l7X54VaOaAfdhuIEsM3Uo8x5WLqV9bI5h9AY/+MKONSoL+do?=
 =?us-ascii?Q?vO/ssEXKIxoTkwM+GWDNstNAdF+uEq/0go7AvWBZCS8XBqCoOm43PvQ6wD7m?=
 =?us-ascii?Q?8vHoO6v1H8BXrGSC2ImQrvySJst6F9kWzUJL8wlQMEagKm0yAsRV+8JHFVb1?=
 =?us-ascii?Q?V2KT/jQ+AqUF5r/JKBnnFbvWqW8Xsu/+n2vCreRMocf6oTYa3A/pyORWsjC7?=
 =?us-ascii?Q?gxVZTxn5hKT5ZNzRCYBHoFpzSYu6J2akqC28cTFLYI8vAttwde60D+gPbQZv?=
 =?us-ascii?Q?r/hVL/Sb0jFCRk1jM1F4MCWPKeoHNFbe6LTduOZ71y6QJ97yYw0VV7n88Xjx?=
 =?us-ascii?Q?xfIz8rK212027aAJeco1TAd3xlWnRZNpZGd8niTx8DZnEdEhbeusXVz48CHW?=
 =?us-ascii?Q?0hmst1Z3Xbe0pn6o7tgOy7ksuiz5NigU6x8anjRkLruGzwBkFUgMSEcs3+Up?=
 =?us-ascii?Q?apLUgK6SCONAiHLSnM2hDHB3Ldiz1wL7xFZKVh+Rm9ZC0ECQMxuvMNWE7zXN?=
 =?us-ascii?Q?y4ci8eN/M3OwDK4fGk4GrrDIpII8PpRV4GnrslxdZKZ82+S/U0J5vrOggdUA?=
 =?us-ascii?Q?5dinE//fx99IoI9wHq0Ce9cNrnR21oMYNxBF0nT2JqIwlVycmbuup+cK2WqN?=
 =?us-ascii?Q?2LS0SQVOfVRaqb1KgAxG2Wr6gvgRTTCYIuLCFgFSF1j7o4JFuRRMhJWrKeLL?=
 =?us-ascii?Q?UfDgfJZPThsglSByrVltBZZqNdcZgszK+kY63ppruY2Z0jlWyrridq2/dHRx?=
 =?us-ascii?Q?4akx/YdnPzl0EHBtvPhPYuP65XMEGOiSaSPi2n74tF7vGLS2RAkFGf+wEo4i?=
 =?us-ascii?Q?C8VHiCsSqgSeAZTb1kaHZdT/+BO2n8oG4gp2GHaHHwHolDqRW0zuxaO2BSb3?=
 =?us-ascii?Q?pXu//EIWGV5nU48MiVS+2qEszMyq9HXS7BP9n33JXojCnJb8rX8xpmSwHAc9?=
 =?us-ascii?Q?CHOTaNw75Y93hWdH5hyXAmbO5F8kyZ89kwSVxeNdnLvqH1r3XzrWV6K/lebL?=
 =?us-ascii?Q?J6c7Cwkt25PdLKxZJDRR+jxNRWpYHnAiRnscBFjjKmjL/y3halCwEzFcsf39?=
 =?us-ascii?Q?ePuzEQEQGnR42bA8auU8AnZ/PwdQsC51iYnoqZsp2XFFfHBavR5GgjoZG7J4?=
 =?us-ascii?Q?Rn5Gwp9cUPgS3i0WN0J0pjSjXu97AlXJe0r55uAbvfRgYVrMQjuuYv379LxV?=
 =?us-ascii?Q?hKHDbmA5bgo9PP9CMoAq1EnIxQPhPyww+mdYjoibUZ6hAAKi0kfRpJJ/2+LE?=
 =?us-ascii?Q?6XhslgNjZMJ9Q2MVdazj+edhl5oyYeCZohcbkr3blag5LNC8Ygv4MqOMreh3?=
 =?us-ascii?Q?kjoT1WxSIPwdn/95CW0igtHhBoPCYBPWSbHyFWlyxASKF0sRyu1wxxlX7OcZ?=
 =?us-ascii?Q?IA7hru88T+R3eeSYkTYap8rC/9PBW72oHfgeB+Ni/fErjIen3DHdbeQzdBRX?=
 =?us-ascii?Q?7hmK7qjEJLaMdKRGz2juz/ww7SetKBqeaRNZBiyFUAMohjHAXwR1d29GiHMQ?=
 =?us-ascii?Q?1/pZumKXwOwu7p9xMgYRpa1SWHStoeurR5DZgDqJw2g7FNQL6wB+3eBwVP5V?=
 =?us-ascii?Q?kg=3D=3D?=
Content-Type: text/plain; charset="us-ascii"
Content-ID: <33791F33C9A83B489F24AD5552D818CB@namprd10.prod.outlook.com>
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: SN6PR10MB3022.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: af7c25c8-e539-4819-b38e-08da5965dbe7
X-MS-Exchange-CrossTenant-originalarrivaltime: 29 Jun 2022 00:25:24.1685
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: ryQx+/ipJKU/wE4NbwXz3a58EwBK794Ig7swVdd1XwbCBjTgvm4IN8s1Bd402Bsh2VDD959RFpGpujQdN5i4KQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR10MB5593
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.517,18.0.883
 definitions=2022-06-28_11:2022-06-28,2022-06-28 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 spamscore=0 bulkscore=0
 phishscore=0 mlxlogscore=851 adultscore=0 mlxscore=0 suspectscore=0
 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2204290000
 definitions=main-2206280095
X-Proofpoint-ORIG-GUID: vWhxlCoFIMBHaV1o00VNYNS6O_qqwLGG
X-Proofpoint-GUID: vWhxlCoFIMBHaV1o00VNYNS6O_qqwLGG
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,
        RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_NONE,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

* Mauro Carvalho Chehab <mchehab@kernel.org> [220628 05:46]:
> A maple tree pointer parameter was added at unmap_vmas() without
> description:
>=20
> 	mm/memory.c:1729: warning: Function parameter or member 'mt' not describ=
ed in 'unmap_vmas'
>=20
> Document it it.
>=20
> Fixes: 5966e5c968b2 ("mm: remove the vma linked list")
> Fixes: f8acc5e9581e ("Maple Tree: add new data structure")
> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> ---
>=20
> To avoid mailbombing on a large number of people, only mailing lists were=
 C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mc=
hehab@kernel.org/
>=20
>  mm/memory.c | 2 ++
>  1 file changed, 2 insertions(+)
>=20
> diff --git a/mm/memory.c b/mm/memory.c
> index e3d3596068f2..771b61444507 100644
> --- a/mm/memory.c
> +++ b/mm/memory.c
> @@ -1707,6 +1707,8 @@ static void unmap_single_vma(struct mmu_gather *tlb=
,
>  /**
>   * unmap_vmas - unmap a range of memory covered by a list of vma's
>   * @tlb: address of the caller's struct mmu_gather
> + * @mt: maple tree pointer. A maple tree is a RCU-safe range based B-tre=
e
> + *	designed to use modern processor cache efficiently

Thanks, but I think that's a little too descriptive of type and a little
lacking of description of what this tree actually holds.

Maybe something like:
@mt: The maple tree pointer for the VMAs?

>   * @vma: the starting vma
>   * @start_addr: virtual address at which to start unmapping
>   * @end_addr: virtual address at which to end unmapping
> --=20
> 2.36.1
>=20
> =