module/zfs/include/sys/zio_checksum.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  */
  24
  25 #ifndef _SYS_ZIO_CHECKSUM_H
  26 #define _SYS_ZIO_CHECKSUM_H
  27
  28 #include <sys/zio.h>
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /*
  35  * Signature for checksum functions.
  36  */
  37 typedef void zio_checksum_t(const void *data, uint64_t size, zio_cksum_t *zcp);
  38
  39 /*
  40  * Information about each checksum function.
  41  */
  42 typedef struct zio_checksum_info {
  43         zio_checksum_t  *ci_func[2]; /* checksum function for each byteorder */
  44         int             ci_correctable; /* number of correctable bits   */
  45         int             ci_eck;         /* uses zio embedded checksum? */
  46         int             ci_dedup;       /* strong enough for dedup? */
  47         char            *ci_name;       /* descriptive name */
  48 } zio_checksum_info_t;
  49
  50 typedef struct zio_bad_cksum {
  51         zio_cksum_t             zbc_expected;
  52         zio_cksum_t             zbc_actual;
  53         const char              *zbc_checksum_name;
  54         uint8_t                 zbc_byteswapped;
  55         uint8_t                 zbc_injected;
  56         uint8_t                 zbc_has_cksum;  /* expected/actual valid */
  57 } zio_bad_cksum_t;
  58
  59 extern zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS];
  60
  61 /*
  62  * Checksum routines.
  63  */
  64 extern zio_checksum_t zio_checksum_SHA256;
  65
  66 extern void zio_checksum_compute(zio_t *zio, enum zio_checksum checksum,
  67     void *data, uint64_t size);
  68 extern int zio_checksum_error(zio_t *zio, zio_bad_cksum_t *out);
  69 extern enum zio_checksum spa_dedup_checksum(spa_t *spa);
  70
  71 #ifdef  __cplusplus
  72 }
  73 #endif
  74
  75 #endif  /* _SYS_ZIO_CHECKSUM_H */