zstd/build
Jennifer Liu 9d6ed9def3 Merge fastCover into DictBuilder (#1274)
* Minor fix

* Run non-optimize FASTCOVER 5 times in benchmark

* Merge fastCover into dictBuilder

* Fix mixed declaration issue

* Add fastcover to symbol.c

* Add fastCover.c and cover.h to build

* Change fastCover.c to fastcover.c

* Update benchmark to run FASTCOVER in dictBuilder

* Undo spliting fastcover_param into cover_param and f

* Remove convert param functions

* Assign f to parameter

* Add zdict.h to Makefile in lib

* Add cover.h to BUCK

* Cast 1 to U64 before shifting

* Remove trimming of zero freq head and tail in selectSegment and rebenchmark

* Remove f as a separate parameter of tryParam

* Read 8 bytes when d is 6

* Add trimming off zero frequency head and tail

* Use best functions from COVER and remove trimming part(which leads to worse compression ratio after previous bugs were fixed)

* Add finalize= argument to FASTCOVER to specify percentage of training samples passed to ZDICT_finalizeDictionary

* Change nbDmer to always read 8 bytes even when d=6

* Add skip=# argument to allow skipping dmers in computeFrequency in FASTCOVER

* Update comments and benchmarking result

* Change default method of ZDICT_trainFromBuffer to ZDICT_optimizeTrainFromBuffer_fastCover

* Add dictType enum and fix bug about passing zParam when converting to coverParam

* Combine finalize and skip into a single parameter

* Update acceleration parameters and benchmark on 3 sample sets

* Change default splitPoint of FASTCOVER to 0.75 and benchmark first 3 sample sets

* Initialize variables outside of for loop in benchmark.c

* Update benchmark result for hg-manifest

* Remove cover.h from install-includes

* Add explanation of f

* Set default compression level for trainFromBuffer to 3

* Add assertion of fastCoverParams in DiB_trainFromFiles

* Add checkTotalCompressedSize function + some minor fixes

* Add test for multithreading fastCovr

* Initialize segmentFreqs in every FASTCOVER_selectSegment and move mutex_unnlock to end of COVER_best_finish

* Free segmentFreqs

* Initialize segmentFreqs before calling FASTCOVER_buildDictionary instead of in FASTCOVER_selectSegment

* Add FASTCOVER_MEMMULT

* Minor fix

* Update benchmarking result
2018-08-23 12:06:20 -07:00
..
VS2008 Merge fastCover into DictBuilder (#1274) 2018-08-23 12:06:20 -07:00
VS2010 Merge fastCover into DictBuilder (#1274) 2018-08-23 12:06:20 -07:00
VS_scripts updated VS studio readme 2018-03-26 09:55:10 -07:00
cmake Merge fastCover into DictBuilder (#1274) 2018-08-23 12:06:20 -07:00
.gitignore Cmake now builds with CMAKE_BUILD_TYPE=Release by default, both while 2018-08-13 20:28:52 -04:00
README.md added back documentation/notification for VS2005 in build directory 2017-06-02 10:25:30 -07:00

README.md

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.