Skip to content

Add error checking to zstd hdf5 plugin #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pimlu wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Add error checking to zstd hdf5 plugin #280

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b211304
Add error checking to zstd hdf5 plugin
pimlu Jul 30, 2026
aad7cdd
Add error reporting with H5Epush
pimlu Aug 17, 2026
1e7c055
Remove variadic macros
pimlu Aug 17, 2026
ed4e885
better message for streaming
pimlu Aug 17, 2026
d9b5f57
copilot feedback
pimlu Aug 26, 2026
33c3991
add corrupt zstd tests
pimlu Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 35 additions & 4 deletions ZSTD/src/H5Zzstd.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ static size_t H5Z_filter_zstd(unsigned int flags, size_t cd_nelmts, const unsign

#define PUSH_ERR(func, minor, str) \
H5Epush(H5E_DEFAULT, __FILE__, func, __LINE__, H5E_ERR_CLS, H5E_PLINE, minor, str)
#define PUSH_ERR2(func, minor, str, arg) \
H5Epush(H5E_DEFAULT, __FILE__, func, __LINE__, H5E_ERR_CLS, H5E_PLINE, minor, str, arg)

const H5Z_class2_t H5Z_ZSTD[1] = {{
H5Z_CLASS_T_VERS, /* H5Z_class_t version */
Expand Down Expand Up @@ -65,11 +67,33 @@ H5Z_filter_zstd(unsigned int flags, size_t cd_nelmts, const unsigned int cd_valu

if (flags & H5Z_FLAG_REVERSE) {
/* We're decompressing */
size_t decompSize = ZSTD_getFrameContentSize(*buf, origSize);
if (NULL == (outbuf = malloc(decompSize)))
unsigned long long contentSize = ZSTD_getFrameContentSize(*buf, origSize);
if (contentSize == ZSTD_CONTENTSIZE_ERROR) {
PUSH_ERR("H5Z_filter_zstd", H5E_CALLBACK, "Input is not a valid zstd frame");
goto error;
}
if (contentSize == ZSTD_CONTENTSIZE_UNKNOWN) {
PUSH_ERR("H5Z_filter_zstd", H5E_CALLBACK,
"zstd frame missing decompressed size; data was likely compressed "
"with the zstd streaming API, which is not supported");
goto error;
}
if (contentSize == 0) {
PUSH_ERR("H5Z_filter_zstd", H5E_CALLBACK, "zstd frame has zero decompressed size");
goto error;
}

if (NULL == (outbuf = malloc((size_t)contentSize))) {
PUSH_ERR("H5Z_filter_zstd", H5E_CALLBACK, "Can't allocate zstd decompression buffer");
goto error;
}

@pimlu pimlu Aug 26, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a check against SIZE_MAX, if this leads to compiler warnings I can put it behind a conditional macro

decompSize = ZSTD_decompress(outbuf, decompSize, inbuf, origSize);
size_t decompSize = ZSTD_decompress(outbuf, (size_t)contentSize, inbuf, origSize);
if (ZSTD_isError(decompSize)) {
PUSH_ERR2("H5Z_filter_zstd", H5E_CALLBACK, "zstd decompression failed: %s",
ZSTD_getErrorName(decompSize));
goto error;
}

#ifdef ZSTD_DEBUG
fprintf(stderr, " decompressing nbytes: %ld\n", decompSize);
Comment thread
pimlu marked this conversation as resolved.
Outdated
Expand Down Expand Up @@ -100,10 +124,17 @@ H5Z_filter_zstd(unsigned int flags, size_t cd_nelmts, const unsigned int cd_valu
aggression = ZSTD_maxCLevel();

size_t compSize = ZSTD_compressBound(origSize);
if (NULL == (outbuf = malloc(compSize)))
if (NULL == (outbuf = malloc(compSize))) {
PUSH_ERR("H5Z_filter_zstd", H5E_CALLBACK, "Can't allocate zstd compression buffer");
goto error;
}

compSize = ZSTD_compress(outbuf, compSize, inbuf, origSize, aggression);
if (ZSTD_isError(compSize)) {
PUSH_ERR2("H5Z_filter_zstd", H5E_CALLBACK, "zstd compression failed: %s",
ZSTD_getErrorName(compSize));
goto error;
}

#ifdef ZSTD_DEBUG
fprintf(stderr, " compressing nbytes: %ld\n", compSize);
Expand Down
Loading