From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-1.1 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B6C26C169C4 for ; Fri, 8 Feb 2019 05:22:38 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 7C62220863 for ; Fri, 8 Feb 2019 05:22:38 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ug4sduE1" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1725977AbfBHFWd (ORCPT ); Fri, 8 Feb 2019 00:22:33 -0500 Received: from mail-lf1-f67.google.com ([209.85.167.67]:40328 "EHLO mail-lf1-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725901AbfBHFWc (ORCPT ); Fri, 8 Feb 2019 00:22:32 -0500 Received: by mail-lf1-f67.google.com with SMTP id t14so1632090lfk.7; Thu, 07 Feb 2019 21:22:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=oQ4Ilbn2E5O3fse3aFqgWsQmQAFvePOUeZWey4DXpkM=; b=ug4sduE1Nnl6Ucdd6kGSolkdKH1uWHus2x+U5KYf2iN2rOsM9HLP3WTOmtwRbzp/vU WmI7jBaiRmhbQxbwHIe1HKiSj7rT5Pv4oHUINwtri7G7ilhTP4D78Yq6vvJJUSwIrTRk 2ZUDMC1PaOffK1wF+qWJhW3jgyxtid/rRRhQV+FwutdaTY+tC2WlM9hOb7ujI5dOg5DP EU9fmyUvSJJZv2KkRSduA90NhevjuS8YMcH4NWCpzE+PGCGGZkX1L5MalVS4z+wPl2v1 T8K0xfLoY4zbiJwnBzc2QcYZ5ejUJufl/jXJiF3yK/Xx/zcNB2iHuxOECHTIDbBUCpMu 3Lug== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=oQ4Ilbn2E5O3fse3aFqgWsQmQAFvePOUeZWey4DXpkM=; b=j9OmBml49Q9f4vZhvkAHb7ByNLI/RwVSBNSPE7WxHtxvYuLNaFfuX9/BzwLZnXXFyW NMyzwcCClxTb+h8HRSxSh5JXXZ2UZnRSOxJqWzeNqGcFTnIvMptmKhV8Z73HTY27gNzR M66LMj7ZVFG5jlEpuSi+Amf4ygTMnKUAMPgkQYQl+wMySNExr0vgZA7bdzp0wxr1dPIW p57tPnG9QIyrzAj96dLqYJdidnj2JQXh+8yozfLcv6fSB7JOvQDrl4q2pFoHZlhnbYM5 N9IrldqmjgCdIT0oRnkD4N5s4ZHsgfzLG+g2x9feywSLQ/3T2iTG3VJGWS2oGLuwkgui eTKA== X-Gm-Message-State: AHQUAuYtAa7HXOgFG0feo6SwYwphwVK9kpBdLpekV2iJqkXsmyLomcPl 24mzOsNvZkBtL/CWLdJqaQ+vHYLmc1iO5bJlJYU= X-Google-Smtp-Source: AHgI3IYz0SkMlWyxEeQhmXaahAF/5quTQnuzAn7bE9wiMnoPq679b6hVT3lDwP3on5fiZwP5X0S2WjPjR8kO/5pnmkU= X-Received: by 2002:ac2:5496:: with SMTP id t22mr1036162lfk.31.1549603349625; Thu, 07 Feb 2019 21:22:29 -0800 (PST) MIME-Version: 1.0 References: <20190131030812.GA2174@jordon-HP-15-Notebook-PC> <20190131083842.GE28876@rapoport-lnx> <20190207164739.GX21860@bombadil.infradead.org> In-Reply-To: <20190207164739.GX21860@bombadil.infradead.org> From: Souptick Joarder Date: Fri, 8 Feb 2019 10:52:16 +0530 Message-ID: Subject: Re: [PATCHv2 1/9] mm: Introduce new vm_insert_range and vm_insert_range_buggy API To: Matthew Wilcox Cc: Mike Rapoport , Andrew Morton , Michal Hocko , "Kirill A. Shutemov" , vbabka@suse.cz, Rik van Riel , Stephen Rothwell , rppt@linux.vnet.ibm.com, Peter Zijlstra , Russell King - ARM Linux , robin.murphy@arm.com, iamjoonsoo.kim@lge.com, treding@nvidia.com, Kees Cook , Marek Szyprowski , stefanr@s5r6.in-berlin.de, hjc@rock-chips.com, Heiko Stuebner , airlied@linux.ie, oleksandr_andrushchenko@epam.com, joro@8bytes.org, pawel@osciak.com, Kyungmin Park , mchehab@kernel.org, Boris Ostrovsky , Juergen Gross , linux-kernel@vger.kernel.org, Linux-MM , linux-arm-kernel@lists.infradead.org, linux1394-devel@lists.sourceforge.net, dri-devel@lists.freedesktop.org, linux-rockchip@lists.infradead.org, xen-devel@lists.xen.org, iommu@lists.linux-foundation.org, linux-media@vger.kernel.org Content-Type: text/plain; charset="UTF-8" Sender: linux-media-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-media@vger.kernel.org On Thu, Feb 7, 2019 at 10:17 PM Matthew Wilcox wrote: > > On Thu, Feb 07, 2019 at 09:19:47PM +0530, Souptick Joarder wrote: > > Just thought to take opinion for documentation before placing it in v3. > > Does it looks fine ? > > > > +/** > > + * __vm_insert_range - insert range of kernel pages into user vma > > + * @vma: user vma to map to > > + * @pages: pointer to array of source kernel pages > > + * @num: number of pages in page array > > + * @offset: user's requested vm_pgoff > > + * > > + * This allow drivers to insert range of kernel pages into a user vma. > > + * > > + * Return: 0 on success and error code otherwise. > > + */ > > +static int __vm_insert_range(struct vm_area_struct *vma, struct page **pages, > > + unsigned long num, unsigned long offset) > > For static functions, I prefer to leave off the second '*', ie make it > formatted like a docbook comment, but not be processed like a docbook > comment. That avoids cluttering the html with descriptions of internal > functions that people can't actually call. > > > +/** > > + * vm_insert_range - insert range of kernel pages starts with non zero offset > > + * @vma: user vma to map to > > + * @pages: pointer to array of source kernel pages > > + * @num: number of pages in page array > > + * > > + * Maps an object consisting of `num' `pages', catering for the user's > > Rather than using `num', you should use @num. > > > + * requested vm_pgoff > > + * > > + * If we fail to insert any page into the vma, the function will return > > + * immediately leaving any previously inserted pages present. Callers > > + * from the mmap handler may immediately return the error as their caller > > + * will destroy the vma, removing any successfully inserted pages. Other > > + * callers should make their own arrangements for calling unmap_region(). > > + * > > + * Context: Process context. Called by mmap handlers. > > + * Return: 0 on success and error code otherwise. > > + */ > > +int vm_insert_range(struct vm_area_struct *vma, struct page **pages, > > + unsigned long num) > > > > > > +/** > > + * vm_insert_range_buggy - insert range of kernel pages starts with zero offset > > + * @vma: user vma to map to > > + * @pages: pointer to array of source kernel pages > > + * @num: number of pages in page array > > + * > > + * Similar to vm_insert_range(), except that it explicitly sets @vm_pgoff to > > But vm_pgoff isn't a parameter, so it's misleading to format it as such. > > > + * 0. This function is intended for the drivers that did not consider > > + * @vm_pgoff. > > + * > > + * Context: Process context. Called by mmap handlers. > > + * Return: 0 on success and error code otherwise. > > + */ > > +int vm_insert_range_buggy(struct vm_area_struct *vma, struct page **pages, > > + unsigned long num) > > I don't think we should call it 'buggy'. 'zero' would make more sense > as a suffix. suffix can be *zero or zero_offset* whichever suits better. > > Given how this interface has evolved, I'm no longer sure than > 'vm_insert_range' makes sense as the name for it. Is it perhaps > 'vm_map_object' or 'vm_map_pages'? > I prefer vm_map_pages. Considering it, both the interface name can be changed to *vm_insert_range -> vm_map_pages* and *vm_insert_range_buggy -> vm_map_pages_{zero/zero_offset}. As this is only change in interface name and rest of code remain same shall I post it in v3 ( with additional change log mentioned about interface name changed) ? or, It will be a new patch series ( with carry forward all the Reviewed-by / Tested-by on vm_insert_range/ vm_insert_range_buggy ) ?