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=-9.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS autolearn=ham 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 03755C433E3 for ; Mon, 24 Aug 2020 23:49:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C6E01207D3 for ; Mon, 24 Aug 2020 23:49:17 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=osandov-com.20150623.gappssmtp.com header.i=@osandov-com.20150623.gappssmtp.com header.b="pB7eTlEq" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726831AbgHXXtP (ORCPT ); Mon, 24 Aug 2020 19:49:15 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36484 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726745AbgHXXtN (ORCPT ); Mon, 24 Aug 2020 19:49:13 -0400 Received: from mail-pg1-x543.google.com (mail-pg1-x543.google.com [IPv6:2607:f8b0:4864:20::543]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4BF7EC061755 for ; Mon, 24 Aug 2020 16:49:13 -0700 (PDT) Received: by mail-pg1-x543.google.com with SMTP id o13so5504797pgf.0 for ; Mon, 24 Aug 2020 16:49:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=osandov-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=AmkrCLujxDI1c4Ep3Oyzt+yWmvm0w6UdnGpLz40Q0IE=; b=pB7eTlEquwCPl/L4eg6LBf0zmAb5JgNjHUs0LVnJm0aJnVOc/P4B5gW3et04lXgdzu 0VpbP+wNS6z28ZGxIvwlnJ/cbjD982nNuBobOTaQEDJuMsvhse/2trI34TaOneKQaAS6 9u45PO5Pa1Xv0LA1bQmYrKhiSx6rhASaKv1sfnu+OXLkHJV4tI7rrrHy3EmrZBPyXHLK bbZ8J65Of4oYy0LhsEO63CLmQ8Svwg8gTFBx1GnLXDtIisGlQzxjFNAuX1eCjGlP2XRo 2egkyq9k0u9HYy0+okLq4cbPX5f9RaE2/jfR+lUWt5ALyRCdiBNVQAU+e4zxqH7Zo89+ ioKA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=AmkrCLujxDI1c4Ep3Oyzt+yWmvm0w6UdnGpLz40Q0IE=; b=BZV25YFN8fDn7GcNYrxkCuTWoqh0xGTUC+hYAoKI2ByeQeJV2FJf+lAYzbmXwkNRo+ sCyqyMHdK8XAAisimiZddgitLra+c6xvSPQEa320UOvAxodKajKO2uzsqAV/Oi3Kx1qs 9VV8MoLfrNMj6Y/EsNNq4MC2iCf8uMc0G4zHOoCawP1+JS2M2Yt5BEbWMdK5tAiWZQEy qUZ9omszMpwTS2c5bli2MEAWKzwr2DP84ZkcSrCmNChESXmvimz5WFyE9e54VwH0U1F0 AOHqEopeG1/4faPkA8UNhTahEkMXp2dCn7H/6qXKfKHNtumZUfXMjLJsWmSAsjE0OAh3 cMtQ== X-Gm-Message-State: AOAM532tBXaRtVJ4qdErhME3kgT0S+Quh3sESB4CUujtWEhKGZE4Gsn4 oH6xJJTZgfWaS9H6b5C91z4GiA== X-Google-Smtp-Source: ABdhPJwgLA+j1+Ua7OdYOkEAkCKln/R1NdyUayWhnhl7SoZ71Atg6NxFgN0HKR/SlUx0XpFhNs6wfg== X-Received: by 2002:a63:4451:: with SMTP id t17mr4264443pgk.92.1598312952588; Mon, 24 Aug 2020 16:49:12 -0700 (PDT) Received: from exodia.localdomain ([2601:602:8b80:8e0::c6ee]) by smtp.gmail.com with ESMTPSA id g129sm12764674pfb.33.2020.08.24.16.49.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 24 Aug 2020 16:49:11 -0700 (PDT) Date: Mon, 24 Aug 2020 16:49:03 -0700 From: Omar Sandoval To: Amir Goldstein Cc: linux-fsdevel , Linux Btrfs , Al Viro , Christoph Hellwig , Dave Chinner , Jann Horn , Aleksa Sarai , Linux API , kernel-team@fb.com Subject: Re: [PATCH v5 3/9] fs: add RWF_ENCODED for reading/writing compressed data Message-ID: <20200824234903.GA202819@exodia.localdomain> References: <9020a583581b644ae86b7c05de6a39fd5204f06d.1597993855.git.osandov@osandov.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Sender: linux-api-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-api@vger.kernel.org On Fri, Aug 21, 2020 at 11:47:54AM +0300, Amir Goldstein wrote: > On Fri, Aug 21, 2020 at 10:38 AM Omar Sandoval wrote: > > > > From: Omar Sandoval > > > > Btrfs supports transparent compression: data written by the user can be > > compressed when written to disk and decompressed when read back. > > However, we'd like to add an interface to write pre-compressed data > > directly to the filesystem, and the matching interface to read > > compressed data without decompressing it. This adds support for > > so-called "encoded I/O" via preadv2() and pwritev2(). > > > > A new RWF_ENCODED flags indicates that a read or write is "encoded". If > > this flag is set, iov[0].iov_base points to a struct encoded_iov which > > is used for metadata: namely, the compression algorithm, unencoded > > (i.e., decompressed) length, and what subrange of the unencoded data > > should be used (needed for truncated or hole-punched extents and when > > reading in the middle of an extent). For reads, the filesystem returns > > this information; for writes, the caller provides it to the filesystem. > > iov[0].iov_len must be set to sizeof(struct encoded_iov), which can be > > used to extend the interface in the future a la copy_struct_from_user(). > > The remaining iovecs contain the encoded extent. > > > > This adds the VFS helpers for supporting encoded I/O and documentation > > for filesystem support. > > > > Signed-off-by: Omar Sandoval > > --- > > Documentation/filesystems/encoded_io.rst | 74 ++++++++++ > > Documentation/filesystems/index.rst | 1 + > > include/linux/fs.h | 16 +++ > > include/uapi/linux/fs.h | 33 ++++- > > mm/filemap.c | 166 +++++++++++++++++++++-- > > 5 files changed, 276 insertions(+), 14 deletions(-) > > create mode 100644 Documentation/filesystems/encoded_io.rst > > > > diff --git a/Documentation/filesystems/encoded_io.rst b/Documentation/filesystems/encoded_io.rst > > new file mode 100644 > > index 000000000000..50405276d866 > > --- /dev/null > > +++ b/Documentation/filesystems/encoded_io.rst > > @@ -0,0 +1,74 @@ > > +=========== > > +Encoded I/O > > +=========== > > + > > +Encoded I/O is a mechanism for reading and writing encoded (e.g., compressed > > +and/or encrypted) data directly from/to the filesystem. The userspace interface > > +is thoroughly described in the :manpage:`encoded_io(7)` man page; this document > > +describes the requirements for filesystem support. > > + > > +First of all, a filesystem supporting encoded I/O must indicate this by setting > > +the ``FMODE_ENCODED_IO`` flag in its ``file_open`` file operation:: > > + > > + static int foo_file_open(struct inode *inode, struct file *filp) > > + { > > + ... > > + filep->f_mode |= FMODE_ENCODED_IO; > > + ... > > + } > > + > > +Encoded I/O goes through ``read_iter`` and ``write_iter``, designated by the > > +``IOCB_ENCODED`` flag in ``kiocb->ki_flags``. > > + > > +Reads > > +===== > > + > > +Encoded ``read_iter`` should: > > + > > +1. Call ``generic_encoded_read_checks()`` to validate the file and buffers > > + provided by userspace. > > +2. Initialize the ``encoded_iov`` appropriately. > > +3. Copy it to the user with ``copy_encoded_iov_to_iter()``. > > +4. Copy the encoded data to the user. > > +5. Advance ``kiocb->ki_pos`` by ``encoded_iov->len``. > > +6. Return the size of the encoded data read, not including the ``encoded_iov``. > > + > > +There are a few details to be aware of: > > + > > +* Encoded ``read_iter`` should support reading unencoded data if the extent is > > + not encoded. > > +* If the buffers provided by the user are not large enough to contain an entire > > + encoded extent, then ``read_iter`` should return ``-ENOBUFS``. This is to > > + avoid confusing userspace with truncated data that cannot be properly > > + decoded. > > +* Reads in the middle of an encoded extent can be returned by setting > > + ``encoded_iov->unencoded_offset`` to non-zero. > > +* Truncated unencoded data (e.g., because the file does not end on a block > > + boundary) may be returned by setting ``encoded_iov->len`` to a value smaller > > + value than ``encoded_iov->unencoded_len - encoded_iov->unencoded_offset``. > > + > > +Writes > > +====== > > + > > +Encoded ``write_iter`` should (in addition to the usual accounting/checks done > > +by ``write_iter``): > > + > > +1. Call ``copy_encoded_iov_from_iter()`` to get and validate the > > + ``encoded_iov``. > > +2. Call ``generic_encoded_write_checks()`` instead of > > + ``generic_write_checks()``. > > +3. Check that the provided encoding in ``encoded_iov`` is supported. > > +4. Advance ``kiocb->ki_pos`` by ``encoded_iov->len``. > > +5. Return the size of the encoded data written. > > + > > +Again, there are a few details: > > + > > +* Encoded ``write_iter`` doesn't need to support writing unencoded data. > > +* ``write_iter`` should either write all of the encoded data or none of it; it > > + must not do partial writes. > > +* ``write_iter`` doesn't need to validate the encoded data; a subsequent read > > + may return, e.g., ``-EIO`` if the data is not valid. > > +* The user may lie about the unencoded size of the data; a subsequent read > > + should truncate or zero-extend the unencoded data rather than returning an > > + error. > > +* Be careful of page cache coherency. > > Haha that rings in my head like the "Smoking kills!" warnings... > > I find it a bit odd that you mix page cache at all when reading > unencoded extents. > Feels like a file with FMODE_ENCODED_IO should stick to direct IO in all cases. > I don't know how btrfs deals with mixing direct IO and page cache IO normally, > but surely the rules could be made even stricter for an inode accessed with this > new API? > > Is there something I am misunderstanding? > > Thanks, > Amir. I'm not completely following here, are you suggesting that if a file is open with O_ALLOW_ENCODED, buffered I/O to that file should return an error? Btrfs at least does the necessary range locking and page cache invalidation to ensure that direct I/O gets along with buffered I/O (and now encoded I/O).