4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
37 #include <libcfs/libcfs.h>
38 #include <libcfs/libcfs_crypto.h>
39 #include <lustre/lustre_idl.h>
41 static inline unsigned char cksum_obd2cfs(cksum_type_t cksum_type)
45 return CFS_HASH_ALG_CRC32;
47 return CFS_HASH_ALG_ADLER32;
48 case OBD_CKSUM_CRC32C:
49 return CFS_HASH_ALG_CRC32C;
51 CERROR("Unknown checksum type (%x)!!!\n", cksum_type);
57 /* The OBD_FL_CKSUM_* flags is packed into 5 bits of o_flags, since there can
58 * only be a single checksum type per RPC.
60 * The OBD_CHECKSUM_* type bits passed in ocd_cksum_types are a 32-bit bitmask
61 * since they need to represent the full range of checksum algorithms that
62 * both the client and server can understand.
64 * In case of an unsupported types/flags we fall back to ADLER
65 * because that is supported by all clients since 1.8
67 * In case multiple algorithms are supported the best one is used. */
68 static inline obd_flag cksum_type_pack(cksum_type_t cksum_type)
70 unsigned int performance = 0, tmp;
71 obd_flag flag = OBD_FL_CKSUM_ADLER;
73 if (cksum_type & OBD_CKSUM_CRC32) {
74 tmp = cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32));
75 if (tmp > performance) {
77 flag = OBD_FL_CKSUM_CRC32;
80 if (cksum_type & OBD_CKSUM_CRC32C) {
81 tmp = cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32C));
82 if (tmp > performance) {
84 flag = OBD_FL_CKSUM_CRC32C;
87 if (cksum_type & OBD_CKSUM_ADLER) {
88 tmp = cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_ADLER));
89 if (tmp > performance) {
91 flag = OBD_FL_CKSUM_ADLER;
94 if (unlikely(cksum_type && !(cksum_type & (OBD_CKSUM_CRC32C |
97 CWARN("unknown cksum type %x\n", cksum_type);
102 static inline cksum_type_t cksum_type_unpack(obd_flag o_flags)
104 switch (o_flags & OBD_FL_CKSUM_ALL) {
105 case OBD_FL_CKSUM_CRC32C:
106 return OBD_CKSUM_CRC32C;
107 case OBD_FL_CKSUM_CRC32:
108 return OBD_CKSUM_CRC32;
113 return OBD_CKSUM_ADLER;
116 /* Return a bitmask of the checksum types supported on this system.
117 * 1.8 supported ADLER it is base and not depend on hw
118 * Client uses all available local algos
120 static inline cksum_type_t cksum_types_supported_client(void)
122 cksum_type_t ret = OBD_CKSUM_ADLER;
124 CDEBUG(D_INFO, "Crypto hash speed: crc %d, crc32c %d, adler %d\n",
125 cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32)),
126 cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32C)),
127 cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_ADLER)));
129 if (cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32C)) > 0)
130 ret |= OBD_CKSUM_CRC32C;
131 if (cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32)) > 0)
132 ret |= OBD_CKSUM_CRC32;
137 /* Server uses algos that perform at 50% or better of the Adler */
138 static inline cksum_type_t cksum_types_supported_server(void)
141 cksum_type_t ret = OBD_CKSUM_ADLER;
143 CDEBUG(D_INFO, "Crypto hash speed: crc %d, crc32c %d, adler %d\n",
144 cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32)),
145 cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32C)),
146 cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_ADLER)));
148 base_speed = cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_ADLER)) / 2;
150 if (cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32C)) >=
152 ret |= OBD_CKSUM_CRC32C;
153 if (cfs_crypto_hash_speed(cksum_obd2cfs(OBD_CKSUM_CRC32)) >=
155 ret |= OBD_CKSUM_CRC32;
161 /* Select the best checksum algorithm among those supplied in the cksum_types
164 * Currently, calling cksum_type_pack() with a mask will return the fastest
165 * checksum type due to its benchmarking at libcfs module load.
166 * Caution is advised, however, since what is fastest on a single client may
167 * not be the fastest or most efficient algorithm on the server. */
168 static inline cksum_type_t cksum_type_select(cksum_type_t cksum_types)
170 return cksum_type_unpack(cksum_type_pack(cksum_types));
173 /* Checksum algorithm names. Must be defined in the same order as the
174 * OBD_CKSUM_* flags. */
175 #define DECLARE_CKSUM_NAME char *cksum_name[] = {"crc32", "adler", "crc32c"}