folly/Checksum.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <stdint.h>
  20 #include <cstddef>
  21
  22 /*
  23  * Checksum functions
  24  */
  25
  26 namespace folly {
  27
  28 /**
  29  * Compute the CRC-32C checksum of a buffer, using a hardware-accelerated
  30  * implementation if available or a portable software implementation as
  31  * a default.
  32  *
  33  * @note CRC-32C is different from CRC-32; CRC-32C starts with a different
  34  *       polynomial and thus yields different results for the same input
  35  *       than a traditional CRC-32.
  36  */
  37 uint32_t crc32c(const uint8_t* data, size_t nbytes,
  38     uint32_t startingChecksum = ~0U);
  39
  40 /**
  41  * Compute the CRC-32 checksum of a buffer, using a hardware-accelerated
  42  * implementation if available or a portable software implementation as
  43  * a default.
  44  */
  45 uint32_t
  46 crc32(const uint8_t* data, size_t nbytes, uint32_t startingChecksum = ~0U);
  47
  48 } // folly