12874c5fdSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
21da177e4SLinus Torvalds /*
31da177e4SLinus Torvalds * INET An implementation of the TCP/IP protocol suite for the LINUX
41da177e4SLinus Torvalds * operating system. INET is implemented using the BSD Socket
51da177e4SLinus Torvalds * interface as the means of communication with the user level.
61da177e4SLinus Torvalds *
71da177e4SLinus Torvalds * Checksumming functions for IP, TCP, UDP and so on
81da177e4SLinus Torvalds *
91da177e4SLinus Torvalds * Authors: Jorge Cwik, <jorge@laser.satlink.net>
101da177e4SLinus Torvalds * Arnt Gulbrandsen, <agulbra@nvg.unit.no>
111da177e4SLinus Torvalds * Borrows very liberally from tcp.c and ip.c, see those
121da177e4SLinus Torvalds * files for more names.
131da177e4SLinus Torvalds */
141da177e4SLinus Torvalds
151da177e4SLinus Torvalds #ifndef _CHECKSUM_H
161da177e4SLinus Torvalds #define _CHECKSUM_H
171da177e4SLinus Torvalds
181da177e4SLinus Torvalds #include <linux/errno.h>
191da177e4SLinus Torvalds #include <asm/types.h>
201da177e4SLinus Torvalds #include <asm/byteorder.h>
211da177e4SLinus Torvalds #include <asm/checksum.h>
22*68f4eae7SJakub Kicinski #if !defined(_HAVE_ARCH_COPY_AND_CSUM_FROM_USER) || !defined(HAVE_CSUM_COPY_USER)
23*68f4eae7SJakub Kicinski #include <linux/uaccess.h>
24*68f4eae7SJakub Kicinski #endif
251da177e4SLinus Torvalds
261da177e4SLinus Torvalds #ifndef _HAVE_ARCH_COPY_AND_CSUM_FROM_USER
275486f5bfSChristophe Leroy static __always_inline
csum_and_copy_from_user(const void __user * src,void * dst,int len)2856649d5dSAl Viro __wsum csum_and_copy_from_user (const void __user *src, void *dst,
29c693cc46SAl Viro int len)
301da177e4SLinus Torvalds {
315904122cSAl Viro if (copy_from_user(dst, src, len))
32c693cc46SAl Viro return 0;
33c693cc46SAl Viro return csum_partial(dst, len, ~0U);
341da177e4SLinus Torvalds }
351da177e4SLinus Torvalds #endif
361da177e4SLinus Torvalds
371da177e4SLinus Torvalds #ifndef HAVE_CSUM_COPY_USER
csum_and_copy_to_user(const void * src,void __user * dst,int len)385486f5bfSChristophe Leroy static __always_inline __wsum csum_and_copy_to_user
39c693cc46SAl Viro (const void *src, void __user *dst, int len)
401da177e4SLinus Torvalds {
41c693cc46SAl Viro __wsum sum = csum_partial(src, len, ~0U);
421da177e4SLinus Torvalds
431da177e4SLinus Torvalds if (copy_to_user(dst, src, len) == 0)
441da177e4SLinus Torvalds return sum;
45c693cc46SAl Viro return 0;
461da177e4SLinus Torvalds }
471da177e4SLinus Torvalds #endif
481da177e4SLinus Torvalds
496e41c585SAl Viro #ifndef _HAVE_ARCH_CSUM_AND_COPY
505486f5bfSChristophe Leroy static __always_inline __wsum
csum_partial_copy_nocheck(const void * src,void * dst,int len)51cc44c17bSAl Viro csum_partial_copy_nocheck(const void *src, void *dst, int len)
526e41c585SAl Viro {
536e41c585SAl Viro memcpy(dst, src, len);
54cc44c17bSAl Viro return csum_partial(dst, len, 0);
556e41c585SAl Viro }
566e41c585SAl Viro #endif
576e41c585SAl Viro
5807064c6eSTom Herbert #ifndef HAVE_ARCH_CSUM_ADD
csum_add(__wsum csum,__wsum addend)595486f5bfSChristophe Leroy static __always_inline __wsum csum_add(__wsum csum, __wsum addend)
601da177e4SLinus Torvalds {
6156649d5dSAl Viro u32 res = (__force u32)csum;
6256649d5dSAl Viro res += (__force u32)addend;
6356649d5dSAl Viro return (__force __wsum)(res + (res < (__force u32)addend));
641da177e4SLinus Torvalds }
6507064c6eSTom Herbert #endif
661da177e4SLinus Torvalds
csum_sub(__wsum csum,__wsum addend)675486f5bfSChristophe Leroy static __always_inline __wsum csum_sub(__wsum csum, __wsum addend)
681da177e4SLinus Torvalds {
691da177e4SLinus Torvalds return csum_add(csum, ~addend);
701da177e4SLinus Torvalds }
711da177e4SLinus Torvalds
csum16_add(__sum16 csum,__be16 addend)725486f5bfSChristophe Leroy static __always_inline __sum16 csum16_add(__sum16 csum, __be16 addend)
7399f0b958SEric Dumazet {
7499f0b958SEric Dumazet u16 res = (__force u16)csum;
7599f0b958SEric Dumazet
7699f0b958SEric Dumazet res += (__force u16)addend;
7799f0b958SEric Dumazet return (__force __sum16)(res + (res < (__force u16)addend));
7899f0b958SEric Dumazet }
7999f0b958SEric Dumazet
csum16_sub(__sum16 csum,__be16 addend)805486f5bfSChristophe Leroy static __always_inline __sum16 csum16_sub(__sum16 csum, __be16 addend)
8199f0b958SEric Dumazet {
8299f0b958SEric Dumazet return csum16_add(csum, ~addend);
8399f0b958SEric Dumazet }
8499f0b958SEric Dumazet
853af722cbSChristophe Leroy #ifndef HAVE_ARCH_CSUM_SHIFT
csum_shift(__wsum sum,int offset)865486f5bfSChristophe Leroy static __always_inline __wsum csum_shift(__wsum sum, int offset)
87594e450bSAl Viro {
88594e450bSAl Viro /* rotate sum to align it with a 16b boundary */
89594e450bSAl Viro if (offset & 1)
90594e450bSAl Viro return (__force __wsum)ror32((__force u32)sum, 8);
91594e450bSAl Viro return sum;
92594e450bSAl Viro }
933af722cbSChristophe Leroy #endif
94594e450bSAl Viro
955486f5bfSChristophe Leroy static __always_inline __wsum
csum_block_add(__wsum csum,__wsum csum2,int offset)9656649d5dSAl Viro csum_block_add(__wsum csum, __wsum csum2, int offset)
971da177e4SLinus Torvalds {
98594e450bSAl Viro return csum_add(csum, csum_shift(csum2, offset));
991da177e4SLinus Torvalds }
1001da177e4SLinus Torvalds
1015486f5bfSChristophe Leroy static __always_inline __wsum
csum_block_add_ext(__wsum csum,__wsum csum2,int offset,int len)1022817a336SDaniel Borkmann csum_block_add_ext(__wsum csum, __wsum csum2, int offset, int len)
1032817a336SDaniel Borkmann {
1042817a336SDaniel Borkmann return csum_block_add(csum, csum2, offset);
1052817a336SDaniel Borkmann }
1062817a336SDaniel Borkmann
1075486f5bfSChristophe Leroy static __always_inline __wsum
csum_block_sub(__wsum csum,__wsum csum2,int offset)10856649d5dSAl Viro csum_block_sub(__wsum csum, __wsum csum2, int offset)
1091da177e4SLinus Torvalds {
11033803963SAlexander Duyck return csum_block_add(csum, ~csum2, offset);
11156649d5dSAl Viro }
11256649d5dSAl Viro
csum_unfold(__sum16 n)1135486f5bfSChristophe Leroy static __always_inline __wsum csum_unfold(__sum16 n)
11456649d5dSAl Viro {
11556649d5dSAl Viro return (__force __wsum)n;
1161da177e4SLinus Torvalds }
1171da177e4SLinus Torvalds
1185486f5bfSChristophe Leroy static __always_inline
csum_partial_ext(const void * buff,int len,__wsum sum)1195486f5bfSChristophe Leroy __wsum csum_partial_ext(const void *buff, int len, __wsum sum)
120cea80ea8SDaniel Borkmann {
121cea80ea8SDaniel Borkmann return csum_partial(buff, len, sum);
122cea80ea8SDaniel Borkmann }
123cea80ea8SDaniel Borkmann
124f6ab0288SAl Viro #define CSUM_MANGLED_0 ((__force __sum16)0xffff)
125a99a00cfSPatrick McHardy
csum_replace_by_diff(__sum16 * sum,__wsum diff)1265486f5bfSChristophe Leroy static __always_inline void csum_replace_by_diff(__sum16 *sum, __wsum diff)
1278050c0f0SDaniel Borkmann {
1288050c0f0SDaniel Borkmann *sum = csum_fold(csum_add(diff, ~csum_unfold(*sum)));
1298050c0f0SDaniel Borkmann }
1308050c0f0SDaniel Borkmann
csum_replace4(__sum16 * sum,__be32 from,__be32 to)1315486f5bfSChristophe Leroy static __always_inline void csum_replace4(__sum16 *sum, __be32 from, __be32 to)
132a99a00cfSPatrick McHardy {
133d53a2aa3SEric Dumazet __wsum tmp = csum_sub(~csum_unfold(*sum), (__force __wsum)from);
134d53a2aa3SEric Dumazet
135d53a2aa3SEric Dumazet *sum = csum_fold(csum_add(tmp, (__force __wsum)to));
136a99a00cfSPatrick McHardy }
137a99a00cfSPatrick McHardy
13899f0b958SEric Dumazet /* Implements RFC 1624 (Incremental Internet Checksum)
13999f0b958SEric Dumazet * 3. Discussion states :
14099f0b958SEric Dumazet * HC' = ~(~HC + ~m + m')
14199f0b958SEric Dumazet * m : old value of a 16bit field
14299f0b958SEric Dumazet * m' : new value of a 16bit field
14399f0b958SEric Dumazet */
csum_replace2(__sum16 * sum,__be16 old,__be16 new)1445486f5bfSChristophe Leroy static __always_inline void csum_replace2(__sum16 *sum, __be16 old, __be16 new)
145a99a00cfSPatrick McHardy {
14699f0b958SEric Dumazet *sum = ~csum16_add(csum16_sub(~(*sum), old), new);
147a99a00cfSPatrick McHardy }
148a99a00cfSPatrick McHardy
csum_replace(__wsum * csum,__wsum old,__wsum new)149d9b5ae5cSPaul Blakey static inline void csum_replace(__wsum *csum, __wsum old, __wsum new)
150d9b5ae5cSPaul Blakey {
151d9b5ae5cSPaul Blakey *csum = csum_add(csum_sub(*csum, old), new);
152d9b5ae5cSPaul Blakey }
153d9b5ae5cSPaul Blakey
154a99a00cfSPatrick McHardy struct sk_buff;
1554fc70747SJoe Perches void inet_proto_csum_replace4(__sum16 *sum, struct sk_buff *skb,
1564b048d6dSTom Herbert __be32 from, __be32 to, bool pseudohdr);
1574fc70747SJoe Perches void inet_proto_csum_replace16(__sum16 *sum, struct sk_buff *skb,
1582cf545e8SPatrick McHardy const __be32 *from, const __be32 *to,
1594b048d6dSTom Herbert bool pseudohdr);
160abc5d1ffSTom Herbert void inet_proto_csum_replace_by_diff(__sum16 *sum, struct sk_buff *skb,
161abc5d1ffSTom Herbert __wsum diff, bool pseudohdr);
162a99a00cfSPatrick McHardy
1635486f5bfSChristophe Leroy static __always_inline
inet_proto_csum_replace2(__sum16 * sum,struct sk_buff * skb,__be16 from,__be16 to,bool pseudohdr)1645486f5bfSChristophe Leroy void inet_proto_csum_replace2(__sum16 *sum, struct sk_buff *skb,
1655486f5bfSChristophe Leroy __be16 from, __be16 to, bool pseudohdr)
166a99a00cfSPatrick McHardy {
167a99a00cfSPatrick McHardy inet_proto_csum_replace4(sum, skb, (__force __be32)from,
168a99a00cfSPatrick McHardy (__force __be32)to, pseudohdr);
169a99a00cfSPatrick McHardy }
170a99a00cfSPatrick McHardy
remcsum_adjust(void * ptr,__wsum csum,int start,int offset)1715486f5bfSChristophe Leroy static __always_inline __wsum remcsum_adjust(void *ptr, __wsum csum,
1727c967b22STom Herbert int start, int offset)
1737c967b22STom Herbert {
1747c967b22STom Herbert __sum16 *psum = (__sum16 *)(ptr + offset);
1757c967b22STom Herbert __wsum delta;
1767c967b22STom Herbert
1777c967b22STom Herbert /* Subtract out checksum up to start */
1787c967b22STom Herbert csum = csum_sub(csum, csum_partial(ptr, start, 0));
1797c967b22STom Herbert
1807c967b22STom Herbert /* Set derived checksum in packet */
181369620a0STom Herbert delta = csum_sub((__force __wsum)csum_fold(csum),
182369620a0STom Herbert (__force __wsum)*psum);
1837c967b22STom Herbert *psum = csum_fold(csum);
1847c967b22STom Herbert
1857c967b22STom Herbert return delta;
1867c967b22STom Herbert }
1877c967b22STom Herbert
remcsum_unadjust(__sum16 * psum,__wsum delta)1885486f5bfSChristophe Leroy static __always_inline void remcsum_unadjust(__sum16 *psum, __wsum delta)
18926c4f7daSTom Herbert {
19022fbece1SLance Richardson *psum = csum_fold(csum_sub(delta, (__force __wsum)*psum));
19126c4f7daSTom Herbert }
19226c4f7daSTom Herbert
wsum_negate(__wsum val)1935486f5bfSChristophe Leroy static __always_inline __wsum wsum_negate(__wsum val)
19445cac675SEric Dumazet {
19545cac675SEric Dumazet return (__force __wsum)-((__force u32)val);
19645cac675SEric Dumazet }
1971da177e4SLinus Torvalds #endif
198