blob: 8211f48b98e6d19c5abfd0f1db13cf8893d93424 [file] [log] [blame]
Christoph Hellwigbc02e862012-11-16 09:20:37 +11001#ifndef _XFS_CKSUM_H
2#define _XFS_CKSUM_H 1
3
Darrick J. Wongc8ce5402017-06-16 11:00:05 -07004#define XFS_CRC_SEED (~(uint32_t)0)
Christoph Hellwigbc02e862012-11-16 09:20:37 +11005
6/*
7 * Calculate the intermediate checksum for a buffer that has the CRC field
8 * inside it. The offset of the 32bit crc fields is passed as the
Dave Chinnercae028d2016-12-05 14:40:32 +11009 * cksum_offset parameter. We do not modify the buffer during verification,
10 * hence we have to split the CRC calculation across the cksum_offset.
Christoph Hellwigbc02e862012-11-16 09:20:37 +110011 */
Darrick J. Wongc8ce5402017-06-16 11:00:05 -070012static inline uint32_t
Dave Chinnercae028d2016-12-05 14:40:32 +110013xfs_start_cksum_safe(char *buffer, size_t length, unsigned long cksum_offset)
Christoph Hellwigbc02e862012-11-16 09:20:37 +110014{
Darrick J. Wongc8ce5402017-06-16 11:00:05 -070015 uint32_t zero = 0;
16 uint32_t crc;
Christoph Hellwigbc02e862012-11-16 09:20:37 +110017
18 /* Calculate CRC up to the checksum. */
19 crc = crc32c(XFS_CRC_SEED, buffer, cksum_offset);
20
21 /* Skip checksum field */
22 crc = crc32c(crc, &zero, sizeof(__u32));
23
24 /* Calculate the rest of the CRC. */
25 return crc32c(crc, &buffer[cksum_offset + sizeof(__be32)],
26 length - (cksum_offset + sizeof(__be32)));
27}
28
29/*
Dave Chinnercae028d2016-12-05 14:40:32 +110030 * Fast CRC method where the buffer is modified. Callers must have exclusive
31 * access to the buffer while the calculation takes place.
32 */
Darrick J. Wongc8ce5402017-06-16 11:00:05 -070033static inline uint32_t
Dave Chinnercae028d2016-12-05 14:40:32 +110034xfs_start_cksum_update(char *buffer, size_t length, unsigned long cksum_offset)
35{
36 /* zero the CRC field */
37 *(__le32 *)(buffer + cksum_offset) = 0;
38
39 /* single pass CRC calculation for the entire buffer */
40 return crc32c(XFS_CRC_SEED, buffer, length);
41}
42
43/*
Christoph Hellwigbc02e862012-11-16 09:20:37 +110044 * Convert the intermediate checksum to the final ondisk format.
45 *
46 * The CRC32c calculation uses LE format even on BE machines, but returns the
47 * result in host endian format. Hence we need to byte swap it back to LE format
48 * so that it is consistent on disk.
49 */
50static inline __le32
Darrick J. Wongc8ce5402017-06-16 11:00:05 -070051xfs_end_cksum(uint32_t crc)
Christoph Hellwigbc02e862012-11-16 09:20:37 +110052{
53 return ~cpu_to_le32(crc);
54}
55
56/*
57 * Helper to generate the checksum for a buffer.
Dave Chinnercae028d2016-12-05 14:40:32 +110058 *
59 * This modifies the buffer temporarily - callers must have exclusive
60 * access to the buffer while the calculation takes place.
Christoph Hellwigbc02e862012-11-16 09:20:37 +110061 */
62static inline void
63xfs_update_cksum(char *buffer, size_t length, unsigned long cksum_offset)
64{
Darrick J. Wongc8ce5402017-06-16 11:00:05 -070065 uint32_t crc = xfs_start_cksum_update(buffer, length, cksum_offset);
Christoph Hellwigbc02e862012-11-16 09:20:37 +110066
67 *(__le32 *)(buffer + cksum_offset) = xfs_end_cksum(crc);
68}
69
70/*
71 * Helper to verify the checksum for a buffer.
72 */
73static inline int
74xfs_verify_cksum(char *buffer, size_t length, unsigned long cksum_offset)
75{
Darrick J. Wongc8ce5402017-06-16 11:00:05 -070076 uint32_t crc = xfs_start_cksum_safe(buffer, length, cksum_offset);
Christoph Hellwigbc02e862012-11-16 09:20:37 +110077
78 return *(__le32 *)(buffer + cksum_offset) == xfs_end_cksum(crc);
79}
80
81#endif /* _XFS_CKSUM_H */