Use a single configuration for internal and external headers #1348
Conversation
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
Signed-off-by: Hanno Becker <beckphan@amazon.co.uk>
Previously, mlkem_native.h required users to set MLK_CONFIG_API_* macros
before including it. Now it directly includes the config file and derives
all API settings from the same configuration used internally.
1. Unified Configuration: Eliminate MLK_CONFIG_API_* macros. The public
API now uses the same MLK_CONFIG_* macros as the internal build:
- MLK_CONFIG_API_PARAMETER_SET → MLK_CONFIG_PARAMETER_SET
- MLK_CONFIG_API_NAMESPACE_PREFIX → MLK_CONFIG_NAMESPACE_PREFIX
- MLK_CONFIG_API_CONSTANTS_ONLY → MLK_CONFIG_CONSTANTS_ONLY
2. New Config Options:
- MLK_CONFIG_MULTILEVEL_BUILD: explicit flag for multi-level builds
This makes it a bit simpler in mlkem_native.h to determine whether
to append the parameter set to the namespace prefix.
- MLK_CONFIG_NO_SUPERCOP: We had this before in mlkem_native.h as
MLK_CONFIG_API_NO_SUPERCOP; it's now in the config and documented.
- MLK_CONFIG_CONSTANTS_ONLY: We had this before in mlkem_native.h as
MLK_CONFIG_API_CONSTANTS_ONLY; it's now in the config and documented.
3. Build-Internal vs API Config Separation: Config file now guards
build-only options with #if defined(MLK_BUILD_INTERNAL).
4. Example Directory Restructuring: All examples refactored with mlkem/
subdirectories renamed to mlkem_native/ and CFLAGS configuration
replaced by custom configs.
Updated READMEs to reflect new paths and clarify which options are
set in config files vs passed via CFLAGS.
Signed-off-by: Hanno Becker <beckphan@amazon.co.uk>
Signed-off-by: Hanno Becker <beckphan@amazon.co.uk>
hanno-becker
force-pushed
the
config_cleanup
branch
from
22d6bcf to
8f2ec09
Compare
Contributor
Author
|
@davidchisnall I'd be glad if you could try this and see if it makes your integration smoother. |
Signed-off-by: Hanno Becker <beckphan@amazon.co.uk>
hanno-becker
force-pushed
the
config_cleanup
branch
from
dd0f050 to
51bb7b9
Compare
Contributor
Author
|
As it stands, this is a breaking change (as witnessed e.g. by the breaking AWS-LC integration) that could only be merged as part of a v2 release. If we keep |
Contributor
Author
|
Closing in favor of the (hopefully) API-compatible #1352 |
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.
Following the conversation with @davidchisnall in #1344, this draft PR explores the use of a single configuration file for both internal files and the external-facing header
mlkem_native.h.