Add example for the use of context parameters - #1399
Open
hanno-becker wants to merge 3 commits into
Open
Conversation
The public header mldsa_native.h can be included with MLD_CONFIG_CONSTANTS_ONLY set to obtain constant definitions without the function API. However, it still emitted namespacing and qualification macros for the omitted function declarations, which are irrelevant in that mode. Move the hash-algorithm and domain-separation constants above the namespacing section. Then move the '#if !defined(MLD_CONFIG_CONSTANTS_ONLY)' guard upwards so a single block encompasses both namespacing and the function API. Keep the config-file include unconditional because the Memory Usage constants (MLD_TOTAL_ALLOC_*) still depend on MLD_CONFIG_KEYGEN_PCT in constants-only builds. Ported from mlkem-native. Signed-off-by: Hanno Becker <beckphan@amazon.co.uk>
Contributor
CBMC Results (ML-DSA-44, REDUCE-RAM)
Full Results (210 proofs)
|
Contributor
CBMC Results (ML-DSA-65, REDUCE-RAM)
Full Results (210 proofs)
|
Contributor
CBMC Results (ML-DSA-44)
Full Results (210 proofs)
|
Contributor
CBMC Results (ML-DSA-87, REDUCE-RAM)
Full Results (210 proofs)
|
Contributor
CBMC Results (ML-DSA-65)
Full Results (210 proofs)
|
hanno-becker
force-pushed
the
context_param_ex
branch
from
August 28, 2026 03:47
795736d to
699367b
Compare
test_alloc_config.h was the only configuration combining custom alloc/free with a context parameter, but it was not usable as a template: it compiles only because test_alloc.c defines MLD_BUILD_INTERNAL before including mldsa_native.h. The forward declaration of struct test_ctx_t sat in the MLD_CONFIG_CUSTOM_ALLOC_FREE block, which is inside the build-only section of the configuration. A consumer includes mldsa_native.h without MLD_BUILD_INTERNAL, so the struct is first seen inside the public prototypes, where it declares a type distinct from the application's own, triggering -Wvisibility. Move the declaration next to MLD_CONFIG_CONTEXT_PARAMETER, which precedes the build-only section. Signed-off-by: Hanno Becker <beckphan@amazon.co.uk>
Demonstrates MLD_CONFIG_CONTEXT_PARAMETER by passing a bump allocator
through the public API to MLD_CUSTOM_ALLOC/MLD_CUSTOM_FREE. The buffer is
sized from MLD_TOTAL_ALLOC_{44,65,87}, and freeing is a single cursor
move since mldsa-native deallocates in reverse order of allocation.
Unlike test_alloc.c, the example sets MLD_BUILD_INTERNAL neither explicitly
nor implicitly: main.c obtains the context type solely from the public
header, via the include that mldsa_native_config.h places next to
MLD_CONFIG_CONTEXT_PARAMETER.
Ported from pq-code-package/mlkem-native#1877.
Signed-off-by: Hanno Becker <beckphan@amazon.co.uk>
hanno-becker
force-pushed
the
context_param_ex
branch
from
August 28, 2026 03:48
699367b to
1bee8dc
Compare
Contributor
CBMC Results (ML-DSA-87)
Full Results (210 proofs)
|
hanno-becker
marked this pull request as ready for review
August 28, 2026 04:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.