lib/zstd/zstd_decompress_module.c
Source file repositories/reference/linux-study-clean/lib/zstd/zstd_decompress_module.c
File Facts
- System
- Linux kernel
- Corpus path
lib/zstd/zstd_decompress_module.c- Extension
.c- Size
- 3682 bytes
- Lines
- 142
- Domain
- Kernel Services
- Bucket
- lib
- Inferred role
- Kernel Services: exported/initcall integration point
- Status
- integration implementation candidate
Why This File Exists
Shared kernel service surface used by multiple subsystems, including helpers, cryptography, virtualization support, and async I/O infrastructure.
- Shared kernel service surface used by multiple subsystems, including helpers, cryptography, virtualization support, and async I/O infrastructure.
- Exports symbols or registers init work; inspect boot/module ordering and who consumes the exported contract.
Dependency Surface
linux/kernel.hlinux/module.hlinux/string.hlinux/zstd.hcommon/zstd_deps.h
Detected Declarations
function Copyrightfunction zstd_get_error_codefunction zstd_dctx_workspace_boundfunction zstd_free_dctxfunction zstd_free_ddictfunction zstd_decompress_dctxfunction zstd_decompress_using_ddictfunction zstd_dstream_workspace_boundfunction zstd_reset_dstreamfunction zstd_decompress_streamfunction zstd_find_frame_compressed_sizefunction zstd_get_frame_headerexport zstd_is_errorexport zstd_get_error_codeexport zstd_get_error_nameexport zstd_dctx_workspace_boundexport zstd_create_dctx_advancedexport zstd_free_dctxexport zstd_create_ddict_byreferenceexport zstd_free_ddictexport zstd_init_dctxexport zstd_decompress_dctxexport zstd_decompress_using_ddictexport zstd_dstream_workspace_boundexport zstd_init_dstreamexport zstd_reset_dstreamexport zstd_decompress_streamexport zstd_find_frame_compressed_sizeexport zstd_get_frame_header
Annotated Snippet
// SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
*
* This source code is licensed under both the BSD-style license (found in the
* LICENSE file in the root directory of this source tree) and the GPLv2 (found
* in the COPYING file in the root directory of this source tree).
* You may select, at your option, one of the above-listed licenses.
*/
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/string.h>
#include <linux/zstd.h>
#include "common/zstd_deps.h"
/* Common symbols. zstd_compress must depend on zstd_decompress. */
unsigned int zstd_is_error(size_t code)
{
return ZSTD_isError(code);
}
EXPORT_SYMBOL(zstd_is_error);
zstd_error_code zstd_get_error_code(size_t code)
{
return ZSTD_getErrorCode(code);
}
EXPORT_SYMBOL(zstd_get_error_code);
const char *zstd_get_error_name(size_t code)
{
return ZSTD_getErrorName(code);
}
EXPORT_SYMBOL(zstd_get_error_name);
/* Decompression symbols. */
size_t zstd_dctx_workspace_bound(void)
{
return ZSTD_estimateDCtxSize();
}
EXPORT_SYMBOL(zstd_dctx_workspace_bound);
zstd_dctx *zstd_create_dctx_advanced(zstd_custom_mem custom_mem)
{
return ZSTD_createDCtx_advanced(custom_mem);
}
EXPORT_SYMBOL(zstd_create_dctx_advanced);
size_t zstd_free_dctx(zstd_dctx *dctx)
{
return ZSTD_freeDCtx(dctx);
}
EXPORT_SYMBOL(zstd_free_dctx);
zstd_ddict *zstd_create_ddict_byreference(const void *dict, size_t dict_size,
zstd_custom_mem custom_mem)
{
return ZSTD_createDDict_advanced(dict, dict_size, ZSTD_dlm_byRef,
ZSTD_dct_auto, custom_mem);
}
EXPORT_SYMBOL(zstd_create_ddict_byreference);
size_t zstd_free_ddict(zstd_ddict *ddict)
{
return ZSTD_freeDDict(ddict);
}
EXPORT_SYMBOL(zstd_free_ddict);
zstd_dctx *zstd_init_dctx(void *workspace, size_t workspace_size)
{
if (workspace == NULL)
return NULL;
return ZSTD_initStaticDCtx(workspace, workspace_size);
}
EXPORT_SYMBOL(zstd_init_dctx);
size_t zstd_decompress_dctx(zstd_dctx *dctx, void *dst, size_t dst_capacity,
const void *src, size_t src_size)
{
return ZSTD_decompressDCtx(dctx, dst, dst_capacity, src, src_size);
}
EXPORT_SYMBOL(zstd_decompress_dctx);
size_t zstd_decompress_using_ddict(zstd_dctx *dctx,
void *dst, size_t dst_capacity, const void* src, size_t src_size,
Annotation
- Immediate include surface: `linux/kernel.h`, `linux/module.h`, `linux/string.h`, `linux/zstd.h`, `common/zstd_deps.h`.
- Detected declarations: `function Copyright`, `function zstd_get_error_code`, `function zstd_dctx_workspace_bound`, `function zstd_free_dctx`, `function zstd_free_ddict`, `function zstd_decompress_dctx`, `function zstd_decompress_using_ddict`, `function zstd_dstream_workspace_bound`, `function zstd_reset_dstream`, `function zstd_decompress_stream`.
- Atlas domain: Kernel Services / lib.
- Implementation status: integration implementation candidate.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.