facebook/zstd

Refactor ZSTD_estimateCCtxSize_usingCCtxParams_internal()

Open

#3,404 opened on Dec 28, 2022

View on GitHub
 (5 comments) (1 reaction) (1 assignee)C (27,100 stars) (2,481 forks)batch import
enhancementgood first issuelong-term

Description

ZSTD_estimateCCtxSize_usingCCtxParams_internal() currently takes a long list of parameters. Some (all?) of the parameters are extracted from external ZSTD_CCtx_params objects and passed in one by one. It would be cleaner to reduce the number of parameters by directly passing in a ZSTD_CCtx_params const*.

This should be an easy refactor. Code pointer: https://github.com/facebook/zstd/blob/90597d78eadadae7acf3633ab4d81ef7c4e6057f/lib/compress/zstd_compress.c#L1488-L1495

Contributor guide

Tech stack
c
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C programmingbasic understanding of zstd
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Modify the function signature of ZSTD estimateCCtxSize usingCCtxParams internal in lib/compress/zstd compress.c (line 1488) to accept a const pointer to ZSTD CCtx params instead of the individual parameters. Then update all callers of this function to pass the pointer. There may be internal and external callers to consider. Ensure the change is consistent with the existing code style and passes tests.