From 4e976e0d58588366b138a5b33f42e02027ce8696 Mon Sep 17 00:00:00 2001
From: Aleksander Wasaznik <aleksander.wasaznik@nordicsemi.no>
Date: Thu, 16 Nov 2023 10:03:06 +0100
Subject: [PATCH] sys: atomic: Fix includes, create `atomic_types.h`

This patch fixes the include of `atomic_builtin.h` and `atomic_arch.h`
so that they are IWYU. This mean they compile correctly independent of
other includes at the include-site. It was nessessary to move the
definition of the atomic types out of `atomic.h` to avoid unsatifiable
circular dependencies between `atomic.h` and `atomic_builtin.h`, as well
as definition conflicts between `atomic_arch.h` and `atomic_builtin.h`.
The definition of the type was to moved to a new file `atomic_types.h`.

The include in `atomic.h` has a IWYU pragma which will preserve
backwards compatibility with code expecting the types to be defined in
`atomic.h` if we start linting for IWYU.

Signed-off-by: Aleksander Wasaznik <aleksander.wasaznik@nordicsemi.no>
---
 include/zephyr/sys/atomic.h         |  7 ++-----
 include/zephyr/sys/atomic_arch.h    |  4 ++++
 include/zephyr/sys/atomic_builtin.h |  4 ++++
 include/zephyr/sys/atomic_types.h   | 24 ++++++++++++++++++++++++
 4 files changed, 34 insertions(+), 5 deletions(-)
 create mode 100644 include/zephyr/sys/atomic_types.h

diff --git a/include/zephyr/sys/atomic.h b/include/zephyr/sys/atomic.h
index bcb122bf38a..8618e1bf903 100644
--- a/include/zephyr/sys/atomic.h
+++ b/include/zephyr/sys/atomic.h
@@ -1,6 +1,7 @@
 /*
  * Copyright (c) 1997-2015, Wind River Systems, Inc.
  * Copyright (c) 2021 Intel Corporation
+ * Copyright (c) 2023 Nordic Semiconductor ASA
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -12,6 +13,7 @@
 #include <zephyr/toolchain.h>
 #include <stddef.h>
 
+#include <zephyr/sys/atomic_types.h> /* IWYU pragma: export */
 #include <zephyr/types.h>
 #include <zephyr/sys/util_macro.h>
 
@@ -19,11 +21,6 @@
 extern "C" {
 #endif
 
-typedef long atomic_t;
-typedef atomic_t atomic_val_t;
-typedef void *atomic_ptr_t;
-typedef atomic_ptr_t atomic_ptr_val_t;
-
 /* Low-level primitives come in several styles: */
 
 #if defined(CONFIG_ATOMIC_OPERATIONS_C)
diff --git a/include/zephyr/sys/atomic_arch.h b/include/zephyr/sys/atomic_arch.h
index 7305743c4fb..1225a2e0970 100644
--- a/include/zephyr/sys/atomic_arch.h
+++ b/include/zephyr/sys/atomic_arch.h
@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2021 Demant A/S
+ * Copyright (c) 2023 Nordic Semiconductor ASA
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -7,6 +8,9 @@
 #ifndef ZEPHYR_INCLUDE_SYS_ATOMIC_ARCH_H_
 #define ZEPHYR_INCLUDE_SYS_ATOMIC_ARCH_H_
 
+#include <stdbool.h>
+#include <zephyr/sys/atomic_types.h>
+
 /* Included from <atomic.h> */
 
 /* Arch specific atomic primitives */
diff --git a/include/zephyr/sys/atomic_builtin.h b/include/zephyr/sys/atomic_builtin.h
index 43b40e8bed4..972200c4fc6 100644
--- a/include/zephyr/sys/atomic_builtin.h
+++ b/include/zephyr/sys/atomic_builtin.h
@@ -2,6 +2,7 @@
 
 /*
  * Copyright (c) 1997-2015, Wind River Systems, Inc.
+ * Copyright (c) 2023 Nordic Semiconductor ASA
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -9,6 +10,9 @@
 #ifndef ZEPHYR_INCLUDE_SYS_ATOMIC_BUILTIN_H_
 #define ZEPHYR_INCLUDE_SYS_ATOMIC_BUILTIN_H_
 
+#include <stdbool.h>
+#include <zephyr/sys/atomic_types.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
diff --git a/include/zephyr/sys/atomic_types.h b/include/zephyr/sys/atomic_types.h
new file mode 100644
index 00000000000..33935971f50
--- /dev/null
+++ b/include/zephyr/sys/atomic_types.h
@@ -0,0 +1,24 @@
+/* Copyright (c) 1997-2015, Wind River Systems, Inc.
+ * Copyright (c) 2021 Intel Corporation
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef ZEPHYR_INCLUDE_SYS_ATOMIC_TYPES_H_
+#define ZEPHYR_INCLUDE_SYS_ATOMIC_TYPES_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef long atomic_t;
+typedef atomic_t atomic_val_t;
+typedef void *atomic_ptr_t;
+typedef atomic_ptr_t atomic_ptr_val_t;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* ZEPHYR_INCLUDE_SYS_ATOMIC_TYPES_H_ */