// SPDX-FileCopyrightText: Copyright 2019 yuzu Emulator Project // SPDX-FileCopyrightText: Copyright 2025 citron Emulator Project // SPDX-License-Identifier: GPL-2.0-or-later #include #include #include "common/logging/log.h" #include "common/zstd_compression.h" namespace Common::Compression { std::vector CompressDataZSTD(const u8* source, std::size_t source_size, s32 compression_level) { compression_level = std::clamp(compression_level, 1, ZSTD_maxCLevel()); const std::size_t max_compressed_size = ZSTD_compressBound(source_size); std::vector compressed(max_compressed_size); const std::size_t compressed_size = ZSTD_compress(compressed.data(), compressed.size(), source, source_size, compression_level); if (ZSTD_isError(compressed_size)) { // Compression failed return {}; } compressed.resize(compressed_size); return compressed; } std::vector CompressDataZSTDDefault(const u8* source, std::size_t source_size) { return CompressDataZSTD(source, source_size, ZSTD_CLEVEL_DEFAULT); } std::vector DecompressDataZSTD(std::span compressed) { if (compressed.empty()) { return {}; } const std::size_t decompressed_size = ZSTD_getFrameContentSize(compressed.data(), compressed.size()); // Define a reasonable maximum size for a decompressed network packet. // 16 MB is a very generous limit for a single game packet. constexpr u64 MAX_REASONABLE_PACKET_SIZE = 16 * 1024 * 1024; // ZSTD_CONTENTSIZE_ERROR indicates a corrupted frame or invalid data - reject it // ZSTD_CONTENTSIZE_UNKNOWN means the size isn't in the header but decompression can still work if (decompressed_size == ZSTD_CONTENTSIZE_ERROR) { LOG_ERROR(Common, "Received network packet with corrupted or invalid ZSTD frame"); return {}; } // Reject packets that claim to be larger than reasonable if (decompressed_size != ZSTD_CONTENTSIZE_UNKNOWN && decompressed_size > MAX_REASONABLE_PACKET_SIZE) { LOG_ERROR(Common, "Received network packet with oversized decompressed_size: {}", decompressed_size); return {}; } // When size is unknown, use streaming decompression with a reasonable initial buffer if (decompressed_size == ZSTD_CONTENTSIZE_UNKNOWN) { // Use streaming decompression for unknown size ZSTD_DCtx* dctx = ZSTD_createDCtx(); if (!dctx) { LOG_ERROR(Common, "Failed to create ZSTD decompression context"); return {}; } std::vector decompressed; decompressed.resize(64 * 1024); // Start with 64KB buffer ZSTD_inBuffer input = {compressed.data(), compressed.size(), 0}; ZSTD_outBuffer output = {decompressed.data(), decompressed.size(), 0}; while (input.pos < input.size) { const size_t ret = ZSTD_decompressStream(dctx, &output, &input); if (ZSTD_isError(ret)) { LOG_ERROR(Common, "ZSTD streaming decompression failed with error: {}", ZSTD_getErrorName(ret)); ZSTD_freeDCtx(dctx); return {}; } // If ret == 0, decompression is complete if (ret == 0) { break; } // If output buffer is full but we haven't consumed all input, need more space if (output.pos >= output.size && input.pos < input.size) { // Double the buffer size, up to maximum if (decompressed.size() > MAX_REASONABLE_PACKET_SIZE) { LOG_ERROR(Common, "ZSTD decompressed size exceeds maximum reasonable packet size"); ZSTD_freeDCtx(dctx); return {}; } const size_t old_size = decompressed.size(); decompressed.resize(std::min(old_size * 2, static_cast(MAX_REASONABLE_PACKET_SIZE))); output.dst = decompressed.data(); output.size = decompressed.size(); // Keep output.pos as is - it points to where we continue writing } } // Ensure all data was consumed if (input.pos < input.size) { LOG_ERROR(Common, "ZSTD streaming decompression: not all input was consumed"); ZSTD_freeDCtx(dctx); return {}; } decompressed.resize(output.pos); ZSTD_freeDCtx(dctx); return decompressed; } std::vector decompressed(decompressed_size); const std::size_t uncompressed_result_size = ZSTD_decompress( decompressed.data(), decompressed.size(), compressed.data(), compressed.size()); if (ZSTD_isError(uncompressed_result_size)) { // check the result of decompress // Decompression failed LOG_ERROR(Common, "ZSTD_decompress failed with error: {}", ZSTD_getErrorName(uncompressed_result_size)); return {}; } if (decompressed_size != uncompressed_result_size) { LOG_ERROR(Common, "ZSTD decompressed size mismatch. Expected {}, got {}", decompressed_size, uncompressed_result_size); return {}; } return decompressed; } } // namespace Common::Compression