Repository navigation
sys.h: Do not depend on configuration options - #1938
Merged
Merged
Conversation
mkannwischer
force-pushed
the
mjk/no-asm-config-order
branch
2 times, most recently
from
October 13, 2026 07:39
79b388d to
92eea31
Compare
Contributor
CBMC Results (ML-KEM-512)
Full Results (195 configurations)
|
Contributor
CBMC Results (ML-KEM-768)
Full Results (195 configurations)
|
Contributor
CBMC Results (ML-KEM-1024)
Full Results (195 configurations)
|
sys.h evaluated MLK_CONFIG_NO_ASM, MLK_CONFIG_CT_TESTING_ENABLED and MLK_CONFIG_CUSTOM_CAPABILITY_FUNC when it was first included. Configuration hooks such as MLK_CONFIG_CUSTOM_ZEROIZE include sys.h, and its include guard prevents re-evaluation, so an option defined after such a hook was silently ignored or, for the capability function, caused a redefinition error. This affects the order of the config template and test/configs/no_asm_config.h: the "No ASM" configuration kept the inline-assembly value barrier and never built the volatile opt-blocker, and a late CT_TESTING_ENABLED made constant-time tests vacuous. Move the inline-assembly decision and the CT-testing macros to common.h, after the whole configuration has been read. Move the default mlk_sys_check_capability() to a new shared header capability.h, included from common.h, so that multilevel builds still define it only once. Document in sys.h that it must not depend on configuration options. Signed-off-by: Matthias J. Kannwischer <matthias@zerorisc.com>
mkannwischer
force-pushed
the
mjk/no-asm-config-order
branch
from
October 13, 2026 08:56
92eea31 to
c5280f8
Compare
mkannwischer
marked this pull request as ready for review
October 13, 2026 10:52
hanno-becker
approved these changes
Oct 15, 2026
hanno-becker
left a comment
Contributor
There was a problem hiding this comment.
Thank you @mkannwischer, I greatly support the disentanglement of sys.h and the config.
I'd suggest that we add a lint check to confirm that sys.h does not talk about config options; otherwise, this is good to go.
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Oct 15, 2026
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.
sys.h evaluated MLK_CONFIG_NO_ASM, MLK_CONFIG_CT_TESTING_ENABLED and MLK_CONFIG_CUSTOM_CAPABILITY_FUNC when it was first included. Configuration hooks such as MLK_CONFIG_CUSTOM_ZEROIZE include sys.h, and its include guard prevents re-evaluation, so an option defined after such a hook was silently ignored or, for the capability function, caused a redefinition error. This affects the order of the config template and test/configs/no_asm_config.h: the "No ASM" configuration kept the inline-assembly value barrier and never built the volatile opt-blocker, and a late CT_TESTING_ENABLED made constant-time tests vacuous.
Move the inline-assembly decision and the CT-testing macros to common.h, after the whole configuration has been read. Move the default mlk_sys_check_capability() to a new shared header capability.h, included from common.h, so that multilevel builds still define it only once. Document in sys.h that it must not depend on configuration options.