zstd_get_frame_header(9)

okay so bestie, welcome to the page for zstd_get_frame_header(9) from the Kernel API Manual! ✨ It's giving frame-header-extraction realness, and we're gonna go through it together. No cap. 💅

💖 NAME 💖

zstd_get_frame_header — extracts the parameters from a zstd or skippable frame. That's it, that's the whole vibe. 🎀

✨ SYNOPSIS ✨

the signature, character for character, no edits bestie:

size_t zstd_get_frame_header (zstd_frame_header *params , const void *src , size_t src_size );

🎀 ARGUMENTS 🎀

• params — on success, the frame parameters are written here. ✨
• src — the source buffer. It must point to a zstd or skippable frame. Like, that's not optional, bestie. 🫶
• src_size — the size of the source buffer. 🦋

🔥 RETURN 🔥

return value check, bestie:

• 0 — success. Slay. 💖
• if more data is required — it returns how many bytes must be provided to make forward progress. 🔥
• otherwise — it returns an error, and you can check that error using zstd_is_error. 😭

🦋 SEE ALSO 🦋

Kernel file: ./include/linux/zstd.h — that's the home base. 🏠

• zstd_compress_bound(9)
• zstd_is_error(9)
• zstd_get_error_code(9)
• zstd_get_error_name(9)
• zstd_min_clevel(9)
• zstd_max_clevel(9)
• zstd_default_clevel(9)
• zstd_get_params(9)
• zstd_get_cparams(9)
• zstd_cctx_set_param(9)
• zstd_cctx_workspace_bound(9)
• zstd_cctx_workspace_bound_with_ext_seq_prod(9)
• zstd_init_cctx(9)
• zstd_compress_cctx(9)
• zstd_create_cctx_advanced(9)
• zstd_free_cctx(9)
• zstd_create_cdict_byreference(9)
• zstd_free_cdict(9)
• zstd_compress_using_cdict(9)
• zstd_dctx_workspace_bound(9)
• zstd_init_dctx(9)
• zstd_decompress_dctx(9)
• zstd_create_ddict_byreference(9)
• zstd_free_ddict(9)
• zstd_create_dctx_advanced(9)
• zstd_free_dctx(9)
• zstd_decompress_using_ddict(9)
• zstd_cstream_workspace_bound(9)
• zstd_cstream_workspace_bound_with_ext_seq_prod(9)
• zstd_init_cstream(9)
• zstd_reset_cstream(9)
• zstd_compress_stream(9)
• zstd_flush_stream(9)
• zstd_end_stream(9)
• zstd_dstream_workspace_bound(9)
• zstd_init_dstream(9)
• zstd_reset_dstream(9)
• zstd_decompress_stream(9)
• zstd_find_frame_compressed_size(9)
• zstd_compress_sequences_and_literals(9)

mwah 💖 source/version: ./include/linux · date: October 2026 · page: zstd_get_frame_header(9) — bye bestie, ily! 🌸