Skip to content

Latest commit

 

History

History
367 lines (240 loc) · 14 KB

RELEASE_NOTES.md

File metadata and controls

367 lines (240 loc) · 14 KB
Raw

Release notes for C-Blosc2 2.0.5

Changes from 2.0.4 to 2.0.5

#XXX version-specific blurb XXX#

Changes from 2.0.3 to 2.0.4

  • Restored support for type size that is not a divisor of a buffer size for more info. See #356.

  • Implemented a blosc2_rename_urlpath, a portable function to rename a file or a full directory. See #355.

  • Several improvements for packaging. See #354, #357, #359.

  • Fixed a bug in BloscLZ codec (bumped to 2.5.1).

Changes from 2.0.2 to 2.0.3

  • Improved BloscLZ codec (bumped to 2.5.0) for achieving better compression ratios on data with high entropy. Although in general LZ4 still does a better job in this scenario, BloscLZ can sometimes achieve better compression ratios.

  • Added blosc2_vlmeta_delete() for removing vlmeta data. Thanks to Marta Iborra.

  • Update pkg-config file to support blosc2. Fixes #236. Thanks to Håvard Flaget Aasen.

  • Build system: Change hard coded library path with CMAKE_INSTALL_LIBDIR CMake variable. Thanks to Håvard Flaget Aasen.

Changes from 2.0.1 to 2.0.2

  • Fixed data chunk memory leaks in frame (see #335).

  • Fixed blosc2_stdio_open never returns NULL if it cannot open file.

  • Standardized places for headers in blosc/ and include/ dirs.

  • nthreads is int16_t everywhere in the API. Fixes #331.

  • Add blosc2_remove_urlpath function (see #330).

  • Fixed a bug when a lazy_chunk was created from a small, memcpyed chunk. (see #329).

  • Fixed many issues in documentation (see #333).

Changes from 2.0.0 to 2.0.1

  • The blosc2_schunk_fill_special function was not exported, so not in the shared library. This has been fixed; see #328. Thanks to Mark Kittisopikul.

Changes from 2.0.0.rc2 to 2.0.0 (final)

  • Now Blosc is always compiled with LZ4. See #324.

  • Implemented a system to register plugins (PR #314). See our blog at: https://www.blosc.org/posts/registering-plugins.

  • Added Blosc Lite version. Just activate BUILD_LITE cmake option with: -DBUILD_LITE. See #316.

  • You can deactivate the plugins by setting cmake option BUILD_PLUGINS to OFF.

  • Created include folder. See #310.

  • Moved codecs-registry.h and filters-registry.h to include/blosc2. See #325.

  • Fix error in endian-handler function affecting frames metadata. See #320.

  • Improved tolerance to Win64 workflows failure. See #319.

  • zlib-ng updated to 2.0.5.

  • New COMPILING_WITH_WHEELS.rst doc added.

Changes from 2.0.0.rc.1 to 2.0.0.rc2

  • New compatibility with MinGW32/64. See #302.

  • Improved support for AArch64 (aka ARM64), ARMv7l, ARMv6l and powerpc64le. See #306. Thanks to Alexandr Romanenko, Mark Kittisopikul and Mosè Giordano from the Julia packaging team for their help.

  • BloscLZ updated to 2.4.0. Aligned access in ARM has been enabled, as well as other performance improvements. Expect much better performance, specially on ARM platforms (like Apple Silicon).

  • Zstd sources updated to 1.5.0.

  • zlib-ng sources updated to 2.0.3.

Changes from 2.0.0-beta.5 to 2.0.0.rc.1

  • [API change] blosc2_decompress_ctx() gets a new srcsize parameter to ensure that it does not read past the end of the provided buffer. See #144. Thanks to Nathan Moinvaziri (@nmoinvaz).

  • [BREAKING CHANGE] The format for frames has changed and BLOSC2_VERSION_FRAME_FORMAT is now set to 2. There is no attempt to support previous formats, but there will probably be backward compatibility support starting from version 2 on.

  • New functionality for updating, inserting and deleting chunks in a super-chunk.

  • Support for special values. Large sequences of repeated values can be represented with an efficient, simple and fast run-length representation, without the need to use regular codecs.

  • Internal Zstd sources updated to 1.4.9.

  • Internal LZ4 sources updated to 1.9.3.

  • Internal zlib support is provided now by new zlib-ng 2.0.2 (replacing miniz).

  • The support for Snappy codec has been completely removed. Snappy is a C++ library, which is not good for a library that aims to be fully pure C. Snappy was removed from sources in C-Blosc(1) some years ago, so there should not be a lot of data compressed with Blosc/Snappy out there (and for the existing ones, a transcoding is always possible using C-Blosc(1)).

  • The Lizard codec has been removed. Lizard is a pretty good one, but it looks like it is not timely maintained. Zstd/Zlib can cover its place pretty nicely.

  • The split of blocks only happens for BLOSCLZ and LZ4 codecs. All the rest are not split at all.

  • Public APIs for frames have been removed. Frames should be considered an storage detail, so having them accessible publicly should only bring unnecessary cognitive load. Care have been carried out so as to ensure the same functionality via the super-chunk (schunk) API.

  • [FORMAT] New sparse frame format for on-disk I/O. This allows for storing data chunks in super-chunks in separate files inside a directory. The way to generate sparse frames is via storage.contiguous=false and storage.urlpath=dirname. See README_SFRAME_FORMAT.rst for details.

Changes from 2.0.0-beta.4 to 2.0.0.beta5

  • The prefilter functionality has been introduced and declared stable. With that, you can callback arbitrary functions previous to any filter. This can be useful for performing (parallel) computations on chunks. For an example of use, see tests/test_prefilter.c.

  • New blosc2_set_maskout() function to avoid decompressing blocks. This can be handy when it is not needed to decompress all the blocks in a chunk. This should be always called before blosc2_decompress_ctx() and its effect is reset to the default (decompress all blocks) after that.

  • New ALTIVEC optimizations for Power architecture. These include support for both shuffle and bitshuffle filters. For details, see Blosc#98. Thanks to Jerome Kieffer and ESRF for making this happen.

  • New frame_from_bframe() function for getting a blosc2_frame out of an in-memory serialized frame.

  • Zstd codec updated to 1.4.4.

Changes from 2.0.0-beta.3 to 2.0.0-beta.4

  • New pluggable threading backend. Instead of having Blosc use its own thread pool, you can instead call blosc_set_threads_callback(threads_callback, callback_data) to install your own threading backend. This gives Blosc the possibility to use the same threading mechanism as one you are using in the rest of your program (e.g. OpenMP or Intel TBB), sharing the same threads, rather than starting its own threads that compete with yours for the CPU cores. See #PR 81. Thanks to Steven G. Johnson.

  • The endianness of the platform that is writing the data in chunks is stored now in the headers of the chunks. This info is not used yet, but this should allow a good hint for implementing format compatibility among platforms with different endianness in other layers. See PR #84.

  • Fixed a nasty bug that prevented frames to go more than 2 GB in size.

  • Added a cache for on-disk offsets. This accelerates the reading of slices from disk quite a lot (up to 50% with my benchmarks).

  • Zstd codec upgraded from 1.4.0 to 1.4.3.

Changes from 2.0.0-beta.2 to 2.0.0-beta.3

  • Quick release to fix that beta.2 was tagged on top of a branch, not master.

  • The msgpack trailer now properly starts with 0x90 + 4 value, not plain wrong 0x09 + 4.

  • Trailer version bumped to 1.

Changes from 2.0.0-beta.1 to 2.0.0-beta.2

  • A new vlmetalayers chunk in schunk allows to store arbitrary meta-information that is up to the user. If the schunk has an attached frame, the later will be updated accordingly too. For more info, see PR #74 and docstrings of new blosc2_update_vlmetalayer() and blosc2_get_vlmetalayer() functions.

  • Metalayers must now be attached to super-chunks, not frames. The reason is that frames are increasingly treated as a storage specifier (in-memory or disk now, but can be other means in the future), whereas the actual API for I/O (including metainfo) goes into super-chunks. See PR #75.

  • New frame format documented in README_CFRAME_FORMAT.rst. Remember that the frame format is not written in stone yet, so some changes may be introduced before getting out of beta.

  • BREAKING CHANGE: the format for frames has changed and BLOSC2_VERSION_FRAME_FORMAT is now set to 1. There is no attempt to support previous formats, but there will probably be backward compatibility support starting from version 1 on.

  • BREAKING CHANGE: the next APIs have been renamed:

    • blosc2_frame_has_metalayer -> blosc2_has_metalayer
    • blosc2_frame_add_metalayer -> blosc2_add_metalayer
    • blosc2_frame_update_metalayer -> blosc2_update_metalayer
    • blosc2_frame_metalayer -> blosc2_get_metalayer

    Although the API was declared stable in beta.1, the fact that metalayers are attached now to super-chunks directly, made this change completely necessary.

  • BREAKING CHANGE: the next symbols have been renamed:

    • BLOSC_CPARAMS_DEFAULTS -> BLOSC2_CPARAMS_DEFAULTS
    • BLOSC_DPARAMS_DEFAULTS -> BLOSC2_DPARAMS_DEFAULTS

Changes from 2.0.0a5 to 2.0.0-beta.1

  • The library is called now blosc2 and not blosc anymore. This is necessary so as to prevent collisions with existing blosc deployments.

  • The make install now install all the necessary requirements out-of-the-box.

  • Use Intel IPP's LZ4Safe when compressing/decompressing: this provides better compression ratios and speed (in some cases). It is activated automatically if Intel IPP is found in the system, but you can always disable it with: cmake -DDEACTIVATE_IPP=ON

  • BREAKING CHANGE: the next API have been made private:

    • blosc2_frame_append_chunk -> frame_append_chunk
    • blosc2_frame_get_chunk -> frame_get_chunk
    • blosc2_frame_decompress_chunk -> frame_decompress_chunk

    Now the appending and retrieval of data in frames should always be made via the frame-backed super-chunk API. The idea is to deduplicate the I/O primitives as much as possible, and the super-chunks are the logical way for doing this.

  • BREAKING CHANGE: the next APIs have been renamed:

    • blosc2_get_cparams - > blosc2_schunk_get_cparams
    • blosc2_get_dparams - > blosc2_schunk_get_dparams

  • Internal BloscLZ sources bumped to 2.0.0.

  • Internal LZ4 sources bumped to 1.9.1.

  • Internal Zstd sources bumped to 1.4.0.

Changes from 2.0.0a4 to 2.0.0a5

  • Delta filter now implemented as a XOR instead of a NEG for better numerical stability.

  • Zstd dictionaries are supported. This allows for (much) better compression ratios when using small blocksizes, while improving compression speed.

  • Performance upgrades in the BloscLZ codec, specially for decompression in ARM architectures.

  • Preliminary support for Neon instruction set in ARM CPUs. Shuffle seems to work well, but still some issues with bitshuffle.

  • Internal LZ4 sources bumped to 1.8.2.

  • Internal Zstd sources bumped to 1.3.4.

Changes from 2.0.0a3 to 2.0.0a4

  • New filter pipeline designed to work inside a chunk. The pipeline has a current capacity of 5 slots, and is designed to apply different filters sequentially over the same chunk. For this, a new extended header for the chunk has been put in place (see README_HEADER.rst).

  • New delta filter meant to work inside a chunk. Previously delta was working inside a super-chunk, but the new implementation is both faster and simpler and gets better compression ratios (at least for the tested datasets).

  • New re-parametrization of BloscLZ for improved compression ratio and also more speed (at least on modern Intel/AMD CPUs). Version for internal BloscLZ codec bumped to 1.0.6.

  • Internal zstd sources bumbed to 1.3.0.

  • The BLOSC_MAX_OVERHEAD symbol is always 32 bytes, not 16 as in Blosc1. This is needed in order to allow buffers larger than 32 bits (31 actually :).

Changes from 2.0.0a2 to 2.0.0a3

  • New blosc2_create_context() and blosc2_free_context() for creating contexts so that Blosc can be used from threaded applications without the global lock. For now contexts can be only used from blosc2_compress_ctx() and blosc2_decompress_ctx() (see below).

  • The blosc_compress_ctx() and blosc_decompress_ctx() have been replaced by blosc2_compress_ctx() and blosc2_decompress_ctx() that do accept actual contexts.

  • Added support for new Zstd codec (https://github.com/Cyan4973/zstd). This is a new compressor by Yann Collet, the author of LZ4 and LZ4HC. For details on Zstd, see this nice intro: http://fastcompression.blogspot.com.es/2015/01/zstd-stronger-compression-algorithm.html.

  • The blosc2_append_chunk() has been removed. This is this because an existing chunk may not fulfill the sequence of filters in super header. It is best that the user will use blosc2_schunk_append_buffer() and compress it internally.

  • The split of blocks only happens for BLOSCLZ and SNAPPY codecs. All the rest are not split at all. This allows for faster operation for the rest of codecs (most specially zstd).

  • The internal zlib 1.2.8 sources have been replaced by the miniz library, which is meant to be fully compatible with Zlib, but much smaller and besides tends to be a bit faster. Also, miniz is preferred to an external Zlib.

  • The internal Snappy sources have been removed. If the Snappy library is found, the support for it is still there.

  • Internal LZ4 sources upgraded to 1.7.1.

Changes from 2.0.0a1 to 2.0.0a2

  • The delta filter runs inside of the compression pipeline.

  • Many fixes for the delta filter in super-chunks.

  • Added tests for delta filter in combination with super-chunks.