Backport 3.6: Include common header first #10526
Open
+23
−21
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
In library source files, the order of things should be: 1. Define macros that affect the behavior of system headers, such as `_POSIX_C_SOURCE` and `_GNU_SOURCE`. 2. Include the library's common header: `common.h`. It takes care of many things, including defining the library configuration, granting access to private fields in structures, and activating platform-specific hacks. 3. Possibly a few header inclusions and macro definitions. 4. Guard everything else by `#if defined(MBEDTLS_XXX_C)` or some such. Enforce this order in files that previously did things they shouldn't have before including `common.h`. To locate the potentially problematic files: ``` grep -m1 '^#' library/*.c | grep -v -F common.h ``` Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
gilles-peskine-arm
added
priority-medium
4 tasks
gilles-peskine-arm
added
the
needs-review
davidhorstmann-arm
previously approved these changes
Dec 3, 2025
Contributor
davidhorstmann-arm
left a comment
davidhorstmann-arm
left a comment
There was a problem hiding this comment.
LGTM, thanks!
irwir
reviewed
Dec 3, 2025
ChangeLog.d/aesce-include.txt
Outdated
| @@ -0,0 +1,3 @@ | |||
| Bugfix | |||
| * Fix compilation errors in `aesce.c` in some Visual Studio builds. | |||
| Fixes #548. | |||
Contributor
There was a problem hiding this comment.
TF-PSA-Crypto#548, maybe? In this repository it was very old different issue.
Contributor
Author
There was a problem hiding this comment.
Good point, thanks.
I amended the last commit, to also fix the changelog message (which would have caused GitHub to close #548 if it had been an open issue).
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
gilles-peskine-arm
force-pushed
the
include-common-first-202510-3.6
branch
from
6c3e1a8 to
e45e036
Compare
bjwtaylor
approved these changes
Dec 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Backport of Mbed-TLS/TF-PSA-Crypto#550. The structure is similar, but the commit "Include common.h before system headers" is a little different, both because the header name changed and because the set of affected files is slightly different.
PR checklist