electrobun 0.0.1 → 0.0.2

package/src/bsdiff/zstd/README.md

@@ -1,227 +0,0 @@
-<p align="center"><img src="https://raw.githubusercontent.com/facebook/zstd/dev/doc/images/zstd_logo86.png" alt="Zstandard"></p>
-
-__Zstandard__, or `zstd` as short version, is a fast lossless compression algorithm,
-targeting real-time compression scenarios at zlib-level and better compression ratios.
-It's backed by a very fast entropy stage, provided by [Huff0 and FSE library](https://github.com/Cyan4973/FiniteStateEntropy).
-
-Zstandard's format is stable and documented in [RFC8878](https://datatracker.ietf.org/doc/html/rfc8878). Multiple independent implementations are already available.
-This repository represents the reference implementation, provided as an open-source dual [BSD](LICENSE) OR [GPLv2](COPYING) licensed **C** library,
-and a command line utility producing and decoding `.zst`, `.gz`, `.xz` and `.lz4` files.
-Should your project require another programming language,
-a list of known ports and bindings is provided on [Zstandard homepage](https://facebook.github.io/zstd/#other-languages).
-
-**Development branch status:**
-
-[![Build Status][travisDevBadge]][travisLink]
-[![Build status][CircleDevBadge]][CircleLink]
-[![Build status][CirrusDevBadge]][CirrusLink]
-[![Fuzzing Status][OSSFuzzBadge]][OSSFuzzLink]
-
-[travisDevBadge]: https://api.travis-ci.com/facebook/zstd.svg?branch=dev "Continuous Integration test suite"
-[travisLink]: https://travis-ci.com/facebook/zstd
-[CircleDevBadge]: https://circleci.com/gh/facebook/zstd/tree/dev.svg?style=shield "Short test suite"
-[CircleLink]: https://circleci.com/gh/facebook/zstd
-[CirrusDevBadge]: https://api.cirrus-ci.com/github/facebook/zstd.svg?branch=dev
-[CirrusLink]: https://cirrus-ci.com/github/facebook/zstd
-[OSSFuzzBadge]: https://oss-fuzz-build-logs.storage.googleapis.com/badges/zstd.svg
-[OSSFuzzLink]: https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:zstd
-
-## Benchmarks
-
-For reference, several fast compression algorithms were tested and compared
-on a desktop running Ubuntu 20.04 (`Linux 5.11.0-41-generic`),
-with a Core i7-9700K CPU @ 4.9GHz,
-using [lzbench], an open-source in-memory benchmark by @inikep
-compiled with [gcc] 9.3.0,
-on the [Silesia compression corpus].
-
-[lzbench]: https://github.com/inikep/lzbench
-[Silesia compression corpus]: https://sun.aei.polsl.pl//~sdeor/index.php?page=silesia
-[gcc]: https://gcc.gnu.org/
-
-| Compressor name         | Ratio | Compression| Decompress.|
-| ---------------         | ------| -----------| ---------- |
-| **zstd 1.5.1 -1**       | 2.887 |   530 MB/s |  1700 MB/s |
-| [zlib] 1.2.11 -1        | 2.743 |    95 MB/s |   400 MB/s |
-| brotli 1.0.9 -0         | 2.702 |   395 MB/s |   450 MB/s |
-| **zstd 1.5.1 --fast=1** | 2.437 |   600 MB/s |  2150 MB/s |
-| **zstd 1.5.1 --fast=3** | 2.239 |   670 MB/s |  2250 MB/s |
-| quicklz 1.5.0 -1        | 2.238 |   540 MB/s |   760 MB/s |
-| **zstd 1.5.1 --fast=4** | 2.148 |   710 MB/s |  2300 MB/s |
-| lzo1x 2.10 -1           | 2.106 |   660 MB/s |   845 MB/s |
-| [lz4] 1.9.3             | 2.101 |   740 MB/s |  4500 MB/s |
-| lzf 3.6 -1              | 2.077 |   410 MB/s |   830 MB/s |
-| snappy 1.1.9            | 2.073 |   550 MB/s |  1750 MB/s |
-
-[zlib]: https://www.zlib.net/
-[lz4]: https://lz4.github.io/lz4/
-
-The negative compression levels, specified with `--fast=#`,
-offer faster compression and decompression speed
-at the cost of compression ratio (compared to level 1).
-
-Zstd can also offer stronger compression ratios at the cost of compression speed.
-Speed vs Compression trade-off is configurable by small increments.
-Decompression speed is preserved and remains roughly the same at all settings,
-a property shared by most LZ compression algorithms, such as [zlib] or lzma.
-
-The following tests were run
-on a server running Linux Debian (`Linux version 4.14.0-3-amd64`)
-with a Core i7-6700K CPU @ 4.0GHz,
-using [lzbench], an open-source in-memory benchmark by @inikep
-compiled with [gcc] 7.3.0,
-on the [Silesia compression corpus].
-
-Compression Speed vs Ratio | Decompression Speed
----------------------------|--------------------
-![Compression Speed vs Ratio](doc/images/CSpeed2.png "Compression Speed vs Ratio") | ![Decompression Speed](doc/images/DSpeed3.png "Decompression Speed")
-
-A few other algorithms can produce higher compression ratios at slower speeds, falling outside of the graph.
-For a larger picture including slow modes, [click on this link](doc/images/DCspeed5.png).
-
-
-## The case for Small Data compression
-
-Previous charts provide results applicable to typical file and stream scenarios (several MB). Small data comes with different perspectives.
-
-The smaller the amount of data to compress, the more difficult it is to compress. This problem is common to all compression algorithms, and reason is, compression algorithms learn from past data how to compress future data. But at the beginning of a new data set, there is no "past" to build upon.
-
-To solve this situation, Zstd offers a __training mode__, which can be used to tune the algorithm for a selected type of data.
-Training Zstandard is achieved by providing it with a few samples (one file per sample). The result of this training is stored in a file called "dictionary", which must be loaded before compression and decompression.
-Using this dictionary, the compression ratio achievable on small data improves dramatically.
-
-The following example uses the `github-users` [sample set](https://github.com/facebook/zstd/releases/tag/v1.1.3), created from [github public API](https://developer.github.com/v3/users/#get-all-users).
-It consists of roughly 10K records weighing about 1KB each.
-
-Compression Ratio | Compression Speed | Decompression Speed
-------------------|-------------------|--------------------
-![Compression Ratio](doc/images/dict-cr.png "Compression Ratio") | ![Compression Speed](doc/images/dict-cs.png "Compression Speed") | ![Decompression Speed](doc/images/dict-ds.png "Decompression Speed")
-
-
-These compression gains are achieved while simultaneously providing _faster_ compression and decompression speeds.
-
-Training works if there is some correlation in a family of small data samples. The more data-specific a dictionary is, the more efficient it is (there is no _universal dictionary_).
-Hence, deploying one dictionary per type of data will provide the greatest benefits.
-Dictionary gains are mostly effective in the first few KB. Then, the compression algorithm will gradually use previously decoded content to better compress the rest of the file.
-
-### Dictionary compression How To:
-
-1. Create the dictionary
-
-   `zstd --train FullPathToTrainingSet/* -o dictionaryName`
-
-2. Compress with dictionary
-
-   `zstd -D dictionaryName FILE`
-
-3. Decompress with dictionary
-
-   `zstd -D dictionaryName --decompress FILE.zst`
-
-
-## Build instructions
-
-`make` is the officially maintained build system of this project.
-All other build systems are "compatible" and 3rd-party maintained,
-they may feature small differences in advanced options.
-When your system allows it, prefer using `make` to build `zstd` and `libzstd`.
-
-### Makefile
-
-If your system is compatible with standard `make` (or `gmake`),
-invoking `make` in root directory will generate `zstd` cli in root directory.
-It will also create `libzstd` into `lib/`.
-
-Other available options include:
-- `make install` : create and install zstd cli, library and man pages
-- `make check` : create and run `zstd`, test its behavior on local platform
-
-The `Makefile` follows the [GNU Standard Makefile conventions](https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html),
-allowing staged install, standard flags, directory variables and command variables.
-
-For advanced use cases, specialized compilation flags which control binary generation
-are documented in [`lib/README.md`](lib/README.md#modular-build) for the `libzstd` library
-and in [`programs/README.md`](programs/README.md#compilation-variables) for the `zstd` CLI.
-
-### cmake
-
-A `cmake` project generator is provided within `build/cmake`.
-It can generate Makefiles or other build scripts
-to create `zstd` binary, and `libzstd` dynamic and static libraries.
-
-By default, `CMAKE_BUILD_TYPE` is set to `Release`.
-
-#### Support for Fat (Universal2) Output
-
-`zstd` can be built and installed with support for both Apple Silicon (M1/M2) as well as Intel by using CMake's Universal2 support.
-To perform a Fat/Universal2 build and install use the following commands:
-
-```bash
-cmake -B build-cmake-debug -S build/cmake -G Ninja -DCMAKE_OSX_ARCHITECTURES="x86_64;x86_64h;arm64"
-cd build-cmake-debug
-ninja
-sudo ninja install
-```
-
-### Meson
-
-A Meson project is provided within [`build/meson`](build/meson). Follow
-build instructions in that directory.
-
-You can also take a look at [`.travis.yml`](.travis.yml) file for an
-example about how Meson is used to build this project.
-
-Note that default build type is **release**.
-
-### VCPKG
-You can build and install zstd [vcpkg](https://github.com/Microsoft/vcpkg/) dependency manager:
-
-    git clone https://github.com/Microsoft/vcpkg.git
-    cd vcpkg
-    ./bootstrap-vcpkg.sh
-    ./vcpkg integrate install
-    ./vcpkg install zstd
-
-The zstd port in vcpkg is kept up to date by Microsoft team members and community contributors.
-If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
-
-### Visual Studio (Windows)
-
-Going into `build` directory, you will find additional possibilities:
-- Projects for Visual Studio 2005, 2008 and 2010.
-  + VS2010 project is compatible with VS2012, VS2013, VS2015 and VS2017.
-- Automated build scripts for Visual compiler by [@KrzysFR](https://github.com/KrzysFR), in `build/VS_scripts`,
-  which will build `zstd` cli and `libzstd` library without any need to open Visual Studio solution.
-
-### Buck
-
-You can build the zstd binary via buck by executing: `buck build programs:zstd` from the root of the repo.
-The output binary will be in `buck-out/gen/programs/`.
-
-### Bazel
-
-You easily can integrate zstd into your Bazel project by using the module hosted on the [Bazel Central Repository](https://registry.bazel.build/modules/zstd).
-
-## Testing
-
-You can run quick local smoke tests by running `make check`.
-If you can't use `make`, execute the `playTest.sh` script from the `src/tests` directory.
-Two env variables `$ZSTD_BIN` and `$DATAGEN_BIN` are needed for the test script to locate the `zstd` and `datagen` binary.
-For information on CI testing, please refer to `TESTING.md`.
-
-## Status
-
-Zstandard is currently deployed within Facebook and many other large cloud infrastructures.
-It is run continuously to compress large amounts of data in multiple formats and use cases.
-Zstandard is considered safe for production environments.
-
-## License
-
-Zstandard is dual-licensed under [BSD](LICENSE) OR [GPLv2](COPYING).
-
-## Contributing
-
-The `dev` branch is the one where all contributions are merged before reaching `release`.
-If you plan to propose a patch, please commit into the `dev` branch, or its own feature branch.
-Direct commit to `release` are not permitted.
-For more information, please read [CONTRIBUTING](CONTRIBUTING.md).

package/src/bsdiff/zstd/SECURITY.md

@@ -1,15 +0,0 @@
-# Reporting and Fixing Security Issues
-
-Please do not open GitHub issues or pull requests - this makes the problem immediately visible to everyone, including malicious actors. Security issues in this open source project can be safely reported via the Meta Bug Bounty program:
-
-https://www.facebook.com/whitehat
-
-Meta's security team will triage your report and determine whether or not is it eligible for a bounty under our program.
-
-# Receiving Vulnerability Notifications
-
-In the case that a significant security vulnerability is reported to us or discovered by us---without being publicly known---we will, at our discretion, notify high-profile, high-exposure users of Zstandard ahead of our public disclosure of the issue and associated fix.
-
-If you believe your project would benefit from inclusion in this list, please reach out to one of the maintainers.
-
-<!-- Note to maintainers: this list is kept [here](https://fburl.com/wiki/cgc1l62x). -->

package/src/bsdiff/zstd/TESTING.md

@@ -1,43 +0,0 @@
-Testing
-=======
-
-Zstandard CI testing is split up into three sections:
-short, medium, and long tests.
-
-Short Tests
------------
-Short tests run on CircleCI for new commits on every branch and pull request.
-They consist of the following tests:
-- Compilation on all supported targets (x86, x86_64, ARM, AArch64, PowerPC, and PowerPC64)
-- Compilation on various versions of gcc, clang, and g++
-- `tests/playTests.sh` on x86_64, without the tests on long data (CLI tests)
-- Small tests (`tests/legacy.c`, `tests/longmatch.c`) on x64_64
-
-Medium Tests
-------------
-Medium tests run on every commit and pull request to `dev` branch, on TravisCI.
-They consist of the following tests:
-- The following tests run with UBsan and Asan on x86_64 and x86, as well as with
-  Msan on x86_64
-  - `tests/playTests.sh --test-large-data`
-  - Fuzzer tests: `tests/fuzzer.c`, `tests/zstreamtest.c`, and `tests/decodecorpus.c`
-- `tests/zstreamtest.c` under Tsan (streaming mode, including multithreaded mode)
-- Valgrind Test (`make -C tests test-valgrind`) (testing CLI and fuzzer under `valgrind`)
-- Fuzzer tests (see above) on ARM, AArch64, PowerPC, and PowerPC64
-
-Long Tests
-----------
-Long tests run on all commits to `release` branch,
-and once a day on the current version of `dev` branch,
-on TravisCI.
-They consist of the following tests:
-- Entire test suite (including fuzzers and some other specialized tests) on:
-  - x86_64 and x86 with UBsan and Asan
-  - x86_64 with Msan
-  - ARM, AArch64, PowerPC, and PowerPC64
-- Streaming mode fuzzer with Tsan (for the `zstdmt` testing)
-- ZlibWrapper tests, including under valgrind
-- Versions test (ensuring `zstd` can decode files from all previous versions)
-- `pzstd` with asan and tsan, as well as in 32-bits mode
-- Testing `zstd` with legacy mode off
-- Entire test suite and make install on macOS

package/src/bsdiff/zstd/build/README.md

@@ -1,56 +0,0 @@
-Projects for various integrated development environments (IDE)
-==============================================================
-
-#### Included projects
-
-The following projects are included with the zstd distribution:
-- `cmake` - CMake project contributed by Artyom Dymchenko
-- `VS2005` - Visual Studio 2005 Project (this project has been moved to the contrib directory and will no longer be supported)
-- `VS2008` - Visual Studio 2008 project
-- `VS2010` - Visual Studio 2010 project (which also works well with Visual Studio 2012, 2013, 2015)
-- `VS_scripts` - command line scripts prepared for Visual Studio compilation without IDE
-
-
-#### How to compile zstd with Visual Studio
-
-1. Install Visual Studio e.g. VS 2015 Community Edition (it's free).
-2. Download the latest version of zstd from https://github.com/facebook/zstd/releases
-3. Decompress ZIP archive.
-4. Go to decompressed directory then to `projects` then `VS2010` and open `zstd.sln`
-5. Visual Studio will ask about converting VS2010 project to VS2015 and you should agree.
-6. Change `Debug` to `Release` and if you have 64-bit Windows change also `Win32` to `x64`.
-7. Press F7 on keyboard or select `BUILD` from the menu bar and choose `Build Solution`.
-8. If compilation will be fine a compiled executable will be in `projects\VS2010\bin\x64\Release\zstd.exe`
-
-
-#### Projects available within zstd.sln
-
-The Visual Studio solution file `visual\VS2010\zstd.sln` contains many projects that will be compiled to the
-`visual\VS2010\bin\$(Platform)_$(Configuration)` directory. For example `zstd` set to `x64` and
-`Release` will be compiled to `visual\VS2010\bin\x64_Release\zstd.exe`. The solution file contains the
-following projects:
-
-- `zstd` : Command Line Utility, supporting gzip-like arguments
-- `datagen` : Synthetic and parametrable data generator, for tests
-- `fullbench`  : Precisely measure speed for each zstd inner functions
-- `fuzzer` : Test tool, to check zstd integrity on target platform 
-- `libzstd` : A static ZSTD library compiled to `libzstd_static.lib`
-- `libzstd-dll` : A dynamic ZSTD library (DLL) compiled to `libzstd.dll` with the import library `libzstd.lib`
-- `fullbench-dll` : The fullbench program compiled with the import library; the executable requires ZSTD DLL
-
-
-#### Using ZSTD DLL with Microsoft Visual C++ project
-
-The header file `lib\zstd.h` and the import library
-`visual\VS2010\bin\$(Platform)_$(Configuration)\libzstd.lib` are required to compile
-a project using Visual C++.
-
-1. The path to header files should be added to `Additional Include Directories` that can
-   be found in Project Properties of Visual Studio IDE in the `C/C++` Property Pages on the `General` page.
-2. The import library has to be added to `Additional Dependencies` that can
-   be found in Project Properties in the `Linker` Property Pages on the `Input` page.
-   If one will provide only the name `libzstd.lib` without a full path to the library
-   then the directory has to be added to `Linker\General\Additional Library Directories`.
-
-The compiled executable will require ZSTD DLL which is available at
-`visual\VS2010\bin\$(Platform)_$(Configuration)\libzstd.dll`.