util: add type checking to CONTAINER_OF #61962
Merged
Conversation
This file contains 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
fabiobaltieri
force-pushed
the
container-of-typecheck
branch
8 times, most recently
from
ad7c966
to
1bcd92d
Compare
fabiobaltieri
force-pushed
the
container-of-typecheck
branch
9 times, most recently
from
0c75c9f
to
522427a
Compare
|
The following west manifest projects have been modified in this Pull Request:
Note: This message is automatically posted and updated by the Manifest GitHub Action. |
fabiobaltieri
force-pushed
the
container-of-typecheck
branch
4 times, most recently
from
24465ce
to
151de10
Compare
Add a SAME_TYPE checking macro and use it to add type validation to CONTAINER_OF. This is inspired by the Linux container_of implementation. The check is inhibited when using C++ as __builtin_types_compatible_p is not available there. Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
fabiobaltieri
force-pushed
the
container-of-typecheck
branch
from
151de10
to
cc7fb99
Compare
fabiobaltieri
requested review from
cfriedt,
henrikbrixandersen,
gmarull and
keith-zephyr
and removed request for
dcpleung
andyross
approved these changes
Sep 7, 2023
Yeah it wasn't too bad, sure there will be more in the weekly run. |
keith-zephyr
approved these changes
Sep 7, 2023
carlescufi
approved these changes
Sep 7, 2023
You asked, I delivered :-) |
marc-hb
reviewed
Sep 8, 2023
| @@ -15,6 +15,7 @@ | |||
| #define ZEPHYR_INCLUDE_SYS_UTIL_H_ | |||
|
|
|||
| #include <zephyr/sys/util_macro.h> | |||
| #include <zephyr/toolchain/common.h> | |||
There was a problem hiding this comment.
This addition just revealed a funny ZRESTRICT conflict between include/zephyr/toolchain/common.h and include/zephyr/toolchain/gcc.h when compiling C++
As a datapoint/evidence, replacing this line with #include <zephyr/toolchain/gcc.h> avoids the warning.
https://github.com/thesofproject/sof/actions/runs/6127039819/job/16632163797?pr=8175
/zep_workspace/sof/src/audio/module_adapter/iadk/module_initial_settings_concrete.cpp
In file included from /zep_workspace/zephyr/include/zephyr/toolchain.h:50,
from /zep_workspace/zephyr/include/zephyr/sys/time_units.h:10,
from /zep_workspace/zephyr/include/zephyr/sys/util.h:640,
from /zep_workspace/sof/src/include/sof/audio/module_adapter/iadk/adsp_stddef.h:15,
from /zep_workspace/sof/src/audio/module_adapter/iadk/module_initial_settings_concrete.cpp:7:
/zep_workspace/zephyr/include/zephyr/toolchain/gcc.h:87: error: "ZRESTRICT" redefined [-Werror]
87 | #define ZRESTRICT __restrict
|
In file included from /zep_workspace/zephyr/include/zephyr/sys/util.h:18:
/zep_workspace/zephyr/include/zephyr/toolchain/common.h:33: note: this is the location of the previous definition
33 | #define ZRESTRICT
|
cc1plus: all warnings being treated as errors
|
As ZRESTRICT does not seem to be related to CONTAINER_OF, I filed new bug |
trond-snekvik
added a commit
to trond-snekvik/fw-nrfconnect-nrf
that referenced
this pull request
Nov 17, 2023
The bas_client used the k_delayed_work struct instead of the k_work struct to resolve the bt_bas_client with CONTAINER_OF. As k_work is the first member in k_delayed_work, this isn't an active bug, but zephyrproject-rtos/zephyr#61962 adds a static assert for this, which starts failing in the upmerge. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
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.
Add a SAME_TYPE checking macro and use it to add type validation to CONTAINER_OF. This is inspired by the Linux container_of implementation.
The check is inhibited when using C++ as __builtin_types_compatible_p is not available there.
Linux version: https://elixir.bootlin.com/linux/latest/source/include/linux/container_of.h#L18
Deps:
Push test run: https://github.com/zephyrproject-rtos/zephyr-testing/tree/vfabio-testing-branch
^^ there's some unrelated breakage in this one, but no type checking errors.
There may be more issues in the weekly CI run, but this is as much as I could fix before that.