zstd: vendor zstd 1.1.1 zstd is a new compression format and it is awesome, yielding higher compression ratios and significantly faster compression and decompression operations compared to zlib (our current compression engine of choice) across the board. We want zstd to be a 1st class citizen in Mercurial and to eventually be the preferred compression format for various operations. This patch starts the formal process of supporting zstd by vendoring a copy of zstd. Why do we need to vendor zstd? Good question. First, zstd is relatively new and not widely available yet. If we didn't vendor zstd or distribute it with Mercurial, most users likely wouldn't have zstd installed or even available to install. What good is a feature if you can't use it? Vendoring and distributing the zstd sources gives us the highest liklihood that zstd will be available to Mercurial installs. Second, the Python bindings to zstd (which will be vendored in a separate changeset) make use of zstd APIs that are only available via static linking. One reason they are only available via static linking is that they are unstable and could change at any time. While it might be possible for the Python bindings to attempt to talk to different versions of the zstd C library, the safest thing to do is link against a specific, known-working version of zstd. This is why the Python zstd bindings themselves vendor zstd and why we must as well. This also explains why the added files are in a "python-zstandard" directory. The added files are from the 1.1.1 release of zstd (Git commit 4c0b44f8ced84c4c8edfa07b564d31e4fa3e8885 from https://github.com/facebook/zstd) and are added without modifications. Not all files from the zstd "distribution" have been added. Notably missing are files to support interacting with "legacy," pre-1.0 versions of zstd. The decision of which files to include is made by the upstream python-zstandard project (which I'm the author of). The files in this commit are a snapshot of the files from the 0.5.0 release of that project, Git commit e637c1b214d5f869cf8116c550dcae23ec13b677 from https://github.com/indygreg/python-zstandard.

     1

/**

     2

 * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.

     3

 * All rights reserved.

     4

 *

     5

 * This source code is licensed under the BSD-style license found in the

     6

 * LICENSE file in the root directory of this source tree. An additional grant

     7

 * of patent rights can be found in the PATENTS file in the same directory.

     8

 */

     9

    10

#ifndef ZSTD_ERRORS_H_398273423

    11

#define ZSTD_ERRORS_H_398273423

    12

    13

#if defined (__cplusplus)

    14

extern "C" {

    15

#endif

    16

    17

/*===== dependency =====*/

    18

#include <stddef.h>   /* size_t */

    19

    20

    21

/*-****************************************

    22

*  error codes list

    23

******************************************/

    24

typedef enum {

    25

  ZSTD_error_no_error,

    26

  ZSTD_error_GENERIC,

    27

  ZSTD_error_prefix_unknown,

    28

  ZSTD_error_version_unsupported,

    29

  ZSTD_error_parameter_unknown,

    30

  ZSTD_error_frameParameter_unsupported,

    31

  ZSTD_error_frameParameter_unsupportedBy32bits,

    32

  ZSTD_error_frameParameter_windowTooLarge,

    33

  ZSTD_error_compressionParameter_unsupported,

    34

  ZSTD_error_init_missing,

    35

  ZSTD_error_memory_allocation,

    36

  ZSTD_error_stage_wrong,

    37

  ZSTD_error_dstSize_tooSmall,

    38

  ZSTD_error_srcSize_wrong,

    39

  ZSTD_error_corruption_detected,

    40

  ZSTD_error_checksum_wrong,

    41

  ZSTD_error_tableLog_tooLarge,

    42

  ZSTD_error_maxSymbolValue_tooLarge,

    43

  ZSTD_error_maxSymbolValue_tooSmall,

    44

  ZSTD_error_dictionary_corrupted,

    45

  ZSTD_error_dictionary_wrong,

    46

  ZSTD_error_maxCode

    47

} ZSTD_ErrorCode;

    48

    49

/*! ZSTD_getErrorCode() :

    50

    convert a `size_t` function result into a `ZSTD_ErrorCode` enum type,

    51

    which can be used to compare directly with enum list published into "error_public.h" */

    52

ZSTD_ErrorCode ZSTD_getErrorCode(size_t functionResult);

    53

const char* ZSTD_getErrorString(ZSTD_ErrorCode code);

    54

    55

    56

#if defined (__cplusplus)

    57

}

    58

#endif

    59

    60

#endif /* ZSTD_ERRORS_H_398273423 */