xref: /src/sys/netinet/sctp_crc32.c (revision 7b71f57f4e514a2ab7308ce4147e14d90e099ad0)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
5  * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6  * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * a) Redistributions of source code must retain the above copyright notice,
12  *   this list of conditions and the following disclaimer.
13  *
14  * b) Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *   the documentation and/or other materials provided with the distribution.
17  *
18  * c) Neither the name of Cisco Systems, Inc. nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include "opt_sctp.h"
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/gsb_crc32.h>
40 #include <sys/mbuf.h>
41 
42 #include <netinet/sctp.h>
43 #include <netinet/sctp_crc32.h>
44 #if defined(SCTP) || defined(SCTP_SUPPORT)
45 #include <netinet/sctp_os.h>
46 #include <netinet/sctp_pcb.h>
47 #endif
48 
49 static uint32_t
sctp_finalize_crc32c(uint32_t crc32c)50 sctp_finalize_crc32c(uint32_t crc32c)
51 {
52 #if BYTE_ORDER == BIG_ENDIAN
53 	uint32_t byte0, byte1, byte2, byte3;
54 #endif
55 
56 #if BYTE_ORDER == BIG_ENDIAN
57 	/*
58 	 * For BIG-ENDIAN platforms, the result is in LITTLE-ENDIAN byte
59 	 * order. For LITTLE-ENDIAN platforms, the result is in in
60 	 * BIG-ENDIAN byte order. So for BIG-ENDIAN platforms the bytes must
61 	 * be swapped to return the result always in network byte order (aka
62 	 * BIG-ENDIAN).
63 	 */
64 	byte0 = crc32c & 0x000000ff;
65 	byte1 = (crc32c >> 8) & 0x000000ff;
66 	byte2 = (crc32c >> 16) & 0x000000ff;
67 	byte3 = (crc32c >> 24) & 0x000000ff;
68 	crc32c = ((byte0 << 24) | (byte1 << 16) | (byte2 << 8) | byte3);
69 #endif
70 	return (~crc32c);
71 }
72 
73 static int
sctp_calculate_cksum_cb(void * arg,void * data,u_int len)74 sctp_calculate_cksum_cb(void *arg, void *data, u_int len)
75 {
76 	uint32_t *basep;
77 
78 	basep = arg;
79 	*basep = calculate_crc32c(*basep, data, len);
80 	return (0);
81 }
82 
83 /*
84  * Compute the SCTP checksum in network byte order for a given mbuf chain m
85  * which contains an SCTP packet starting at offset.
86  * Since this function is also called by ipfw, don't assume that
87  * it is compiled on a kernel with SCTP support.
88  */
89 uint32_t
sctp_calculate_cksum(struct mbuf * m,int32_t offset)90 sctp_calculate_cksum(struct mbuf *m, int32_t offset)
91 {
92 	uint32_t base;
93 	int len;
94 
95 	M_ASSERTPKTHDR(m);
96 	KASSERT(offset < m->m_pkthdr.len,
97 	    ("%s: invalid offset %u into mbuf %p", __func__, offset, m));
98 
99 	base = 0xffffffff;
100 	len = m->m_pkthdr.len - offset;
101 	(void)m_apply(m, offset, len, sctp_calculate_cksum_cb, &base);
102 	return (sctp_finalize_crc32c(base));
103 }
104 
105 #if defined(SCTP) || defined(SCTP_SUPPORT)
106 
107 VNET_DEFINE(struct sctp_base_info, system_base_info);
108 
109 /*
110  * Compute and insert the SCTP checksum in network byte order for a given
111  * mbuf chain m which contains an SCTP packet starting at offset.
112  */
113 void
sctp_delayed_cksum(struct mbuf * m,uint32_t offset)114 sctp_delayed_cksum(struct mbuf *m, uint32_t offset)
115 {
116 	uint32_t checksum;
117 
118 	checksum = sctp_calculate_cksum(m, offset);
119 	SCTP_STAT_DECR(sctps_sendhwcrc);
120 	SCTP_STAT_INCR(sctps_sendswcrc);
121 	offset += offsetof(struct sctphdr, checksum);
122 
123 	if (offset + sizeof(uint32_t) > (uint32_t)(m->m_pkthdr.len)) {
124 #ifdef INVARIANTS
125 		panic("sctp_delayed_cksum(): m->m_pkthdr.len: %d, offset: %u.",
126 		    m->m_pkthdr.len, offset);
127 #else
128 		SCTP_PRINTF("sctp_delayed_cksum(): m->m_pkthdr.len: %d, offset: %u.\n",
129 		    m->m_pkthdr.len, offset);
130 #endif
131 		return;
132 	}
133 	m_copyback(m, (int)offset, (int)sizeof(uint32_t), (caddr_t)&checksum);
134 }
135 #endif
136