Received-SPF: pass (google.com: domain of linux-ext4-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Mon, 3 Jul 2023 12:48:50 -0700
From:   Eric Biggers <ebiggers@kernel.org>
To:     "Darrick J. Wong" <djwong@kernel.org>
Cc:     Pedro Falcato <pedro.falcato@gmail.com>, linux-ext4@vger.kernel.org
Subject: Re: Question regarding the use of CRC32c for checksumming
Message-ID: <20230703194850.GF1194@sol.localdomain>
References: <CAKbZUD01uR5kfP4=SSfQ111jKsfKi8ojfDZs5CStLD_h5qb5GQ@mail.gmail.com>
 <20230628045206.GA1908@sol.localdomain>
 <20230628185832.GK11467@frogsfrogsfrogs>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20230628185832.GK11467@frogsfrogsfrogs>
Precedence: bulk

On Wed, Jun 28, 2023 at 11:58:32AM -0700, Darrick J. Wong wrote:
> > As far as I can tell, you are correct that ext4's CRC32C is just a raw CRC.  It
> > doesn't do the bitwise inversion at either the beginning or end.
> 
> Yep.  
> 
> > IMO, this is a mistake.  In the design of CRCs, doing these inversions is
> > recommended to strengthen the CRC slightly.
> 
> Yep.  I wondered about that too back in the day (see below).
> 
> > However, it's also a common "mistake" to leave them out, and not too important,
> > especially if many of the messages checksummed are fixed-length structures.
> > 
> > Yes, if ext4 had used the kernel crypto API "properly", with crypto_shash_init()
> > + crypto_shash_update() + crypto_shash_final(), it would have gotten the
> > inversion at the beginning and end.  (Note, this is true for "crc32c" but not
> > "crc32".  The crypto API isn't consistent about its CRC conventions.)
> 
> 15 years ago when Ted and I first started talking about adding checksums
> to metadata blocks, we looked at what other parts of the kernel did, and
> stumbled upon lib/libcrc32c.c:
> 
> u32 crc32c(u32 crc, const void *address, unsigned int length)
> {
>         SHASH_DESC_ON_STACK(shash, tfm);
>         u32 ret, *ctx = (u32 *)shash_desc_ctx(shash);
>         int err;
> 
>         shash->tfm = tfm;
>         *ctx = crc;
> 
>         err = crypto_shash_update(shash, address, length);
>         BUG_ON(err);
> 
>         ret = *ctx;
>         barrier_data(ctx);
>         return ret;
> }
> EXPORT_SYMBOL(crc32c);
> 
> This looked like a handy crc32c library function that we could use to
> avoid dealing with the crypto api.  I noticed way back then that it
> didn't invert the outcome, but Ted and I decided it wasn't a big deal.
> btrfs and XFS both used this library function in the same way.
> 
> Eventually someone else (Andreas, maybe?) piped up to suggest that
> ext4/jbd2 should load the crc32{,c} driver dynamically to avoid a hard
> dependency on crc32 if the user is only running old filesystems, so we
> did end up using the crypto api directly.  Unfortunately, ext4 can't
> call the shash finalizer to invert the crc because that'll break the
> ondisk format.
> 
> > But I'd also think of ext4's direct use of crypto_shash_update() as less of ext4
> > taking a shortcut or hack, and more of ext4 just having to work around the
> > kernel crypto API being very clunky and inefficient for use cases like this...
> 
> At the time I thought that libcrc32c.c was a convenient shim for anyone
> who didn't want to deal with the clunky crypto api.  It would have
> really helped me to have had documentation of the preconditions (start
> with ~0) and postconditions (invert the return value of the last call)
> to nudge me into using this function correctly, because expecting
> callers also to be really smart about crc32c as an alternative to
> written guidelines is ... idiotic^WLKML.
> 
> An example of how to do a buffer would have helped:
> 
> static inline u32 crc32c_buffer(const void *address, unsigned int length)
> {
> 	return ~crc32c(~0U, address, length);
> }

IMO the best API for CRC's is like zlib's where you pass in 0 to start the CRC
and it does both the pre and post inversions for you.  Note, "updates" still
work as expected, since two inversions cancel each other out.

Unfortunately, many but not all of the CRC APIs in Linux decided to go with the
other convention, which is to leave the inversions entirely to the caller.

I think the kernel should also make the architecture-specific CRC
implementations accessible directly via a library API, similar to what's done
for Blake2s and ChaCha20.  There should be no need to go through shash at all...

> 
> This misuse could be fixed, but you'd have to burn an incompat flag to
> do it.  I'm less smart about crc32* than I was back in 2008, so I also
> don't have the skills to figure out if the correction is worth the cost.
> 
> --D

No, it's not worth changing the ext4 on-disk format for this.

- Eric