Update modules support

alibaba · Aug 6, 2024 · eea2224 · eea2224
1 parent 0ce5f7e
commit eea2224
Show file tree

Hide file tree

Showing 58 changed files with 2,221 additions and 138 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -140,6 +140,7 @@ if (ASYNC_SIMPLE_ENABLE_ASAN)
 endif()
 
 # Start Detecing Uthread
+set(UTHREAD OFF)
 if("${CMAKE_SYSTEM_NAME}" STREQUAL "Linux") # uname -s
   if("${CMAKE_SYSTEM_PROCESSOR}" MATCHES "x86_64|aarch64|ppc64le") # uname -m
     set(UTHREAD ON)
@@ -164,7 +165,7 @@ else()
     set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /MTd")
 endif()
 
-add_subdirectory(async_simple)
+option(STD_MODULE_AVAILABLE "if the std module is available by default" OFF)
 
 option(ASYNC_SIMPLE_BUILD_MODULES "Build async_simple library in C++20 Modules form" OFF)
 if(${ASYNC_SIMPLE_BUILD_MODULES})
@@ -184,11 +185,10 @@ if(${ASYNC_SIMPLE_BUILD_MODULES})
 
     set(CMAKE_CXX_STANDARD 20)
     set(CMAKE_CXX_STANDARD_REQUIRED ON)
-    set(CMAKE_CXX_EXTENSIONS OFF)
-
-    add_subdirectory(modules)
 endif()
 
+add_subdirectory(async_simple)
+
 option(ASYNC_SIMPLE_BUILD_DEMO_EXAMPLE "Build the demo example" ON)
 if (ASYNC_SIMPLE_BUILD_DEMO_EXAMPLE)
     add_subdirectory(demo_example)

diff --git a/README.md b/README.md
@@ -265,6 +265,8 @@ CC=clang CXX=clang++ cmake .. -DCMAKE_BUILD_TYPE=Release -DASYNC_SIMPLE_BUILD_MO
 ninja
 ```
 
+If std module is available, we can define `-DSTD_MODULE_AVAILABLE=ON` when configuring cmake to use std modules provided by vendors.
+
 **Note** that the `async_simple` module in the main branch is actually a named module's wrapper for headers for compatibility. We can find the practical usage of C++20 Modules in https://github.com/alibaba/async_simple/tree/CXX20Modules, which contains the support for xmake and cmake as well.
 
 # Questions

diff --git a/README_CN.md b/README_CN.md
@@ -252,6 +252,8 @@ CC=clang CXX=clang++ cmake .. -DCMAKE_BUILD_TYPE=Release -DASYNC_SIMPLE_BUILD_MO
 ninja
 ```
 
+若 std module 在环境中可用，我们可以在配置 cmake 时定义 `-DSTD_MODULE_AVAILABLE=ON` 以使用官方的 std module。
+
 **需要注意:** 出于兼容性考虑，目前 main 分支中的 `async_simple` Module 本质上只是将 `async_simple` 的头文件封装为了 `Named Modules` 而已。我们可以在  https://github.com/alibaba/async_simple/tree/CXX20Modules 中找到更完整的 `Named Modules` 使用方式。该分支中同样包含 xmake 和 cmake 的支持。
 
 # 存在问题？

diff --git a/async_simple/CMakeLists.txt b/async_simple/CMakeLists.txt
@@ -30,13 +30,32 @@ if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
   endif()
 endif()
 # If there is no Uthread, async_simple is a header only library 
-if(UTHREAD)
+if(${UTHREAD} OR ${ASYNC_SIMPLE_BUILD_MODULES})
   add_library(async_simple_static STATIC ${SRCS})
   add_library(async_simple SHARED ${SRCS})
+
+  if (${ASYNC_SIMPLE_BUILD_MODULES})
+    set(MODULES_SRCS "")
+    list(APPEND MODULES_SRCS async_simple.cppm)
+    if (NOT ${STD_MODULE_AVAILABLE})
+      list(APPEND MODULES_SRCS std.mock.cppm)
+    endif()
+    target_sources(async_simple_static
+      PUBLIC
+        FILE_SET CXX_MODULES FILES
+          ${MODULES_SRCS}
+    )
+    target_sources(async_simple
+      PUBLIC
+        FILE_SET CXX_MODULES FILES
+          ${MODULES_SRCS}
+    )
+  endif()
+
   target_link_libraries(async_simple PUBLIC async_simple_header_only)
   target_link_libraries(async_simple_static PUBLIC async_simple_header_only)
-  install(TARGETS async_simple EXPORT async_simple_targets DESTINATION lib/)
-  install(TARGETS async_simple_static EXPORT async_simple_targets DESTINATION lib/)
+  install(TARGETS async_simple EXPORT async_simple_targets FILE_SET CXX_MODULES DESTINATION lib/)
+  install(TARGETS async_simple_static EXPORT async_simple_targets FILE_SET CXX_MODULES DESTINATION lib/)
 else()
   add_library(async_simple_static INTERFACE)
   target_link_libraries(async_simple_static INTERFACE async_simple_header_only)

diff --git a/async_simple/Collect.h b/async_simple/Collect.h
@@ -16,11 +16,14 @@
 #ifndef ASYNC_SIMPLE_COLLECT_H
 #define ASYNC_SIMPLE_COLLECT_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <iterator>
 #include <vector>
 #include "async_simple/Future.h"
 #include "async_simple/Try.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 // collectAll - collect all the values for a range of futures.

diff --git a/async_simple/Common.h b/async_simple/Common.h
@@ -16,9 +16,12 @@
 #ifndef ASYNC_SIMPLE_COMMON_H
 #define ASYNC_SIMPLE_COMMON_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <stdexcept>
 #include "async_simple/CommonMacros.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 // Different from assert, logicAssert is meaningful in
 // release mode. logicAssert should be used in case that

diff --git a/async_simple/Executor.h b/async_simple/Executor.h
@@ -16,6 +16,7 @@
 #ifndef ASYNC_SIMPLE_EXECUTOR_H
 #define ASYNC_SIMPLE_EXECUTOR_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <chrono>
 #include <functional>
 #include <string>
@@ -25,6 +26,8 @@
 #include "async_simple/experimental/coroutine.h"
 #include "async_simple/util/move_only_function.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 // Stat information for an executor.
 // It contains the number of pending task

diff --git a/async_simple/Future.h b/async_simple/Future.h
@@ -16,6 +16,7 @@
 #ifndef ASYNC_SIMPLE_FUTURE_H
 #define ASYNC_SIMPLE_FUTURE_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <condition_variable>
 #include <mutex>
 #include <type_traits>
@@ -25,6 +26,8 @@
 #include "async_simple/LocalState.h"
 #include "async_simple/Traits.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 template <typename T>

diff --git a/async_simple/FutureState.h b/async_simple/FutureState.h
@@ -16,6 +16,7 @@
 #ifndef ASYNC_SIMPLE_FUTURESTATE_H
 #define ASYNC_SIMPLE_FUTURESTATE_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <atomic>
 #include <cassert>
 #include <iostream>
@@ -26,6 +27,8 @@
 #include "async_simple/Try.h"
 #include "async_simple/util/move_only_function.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 // Details about the State of Future/Promise,

diff --git a/async_simple/IOExecutor.h b/async_simple/IOExecutor.h
@@ -16,9 +16,12 @@
 #ifndef ASYNC_SIMPLE_IO_EXECUTOR_H
 #define ASYNC_SIMPLE_IO_EXECUTOR_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <cstdint>
 #include <functional>
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 // IOExecutor accepts and performs io requests, callers will be notified by

diff --git a/async_simple/LocalState.h b/async_simple/LocalState.h
@@ -17,12 +17,15 @@
 #ifndef ASYNC_SIMPLE_LOCALSTATE_H
 #define ASYNC_SIMPLE_LOCALSTATE_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <functional>
 #include <utility>
 
 #include "async_simple/Executor.h"
 #include "async_simple/Try.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 // A component of Future/Promise. LocalState is owned by

diff --git a/async_simple/MoveWrapper.h b/async_simple/MoveWrapper.h
@@ -17,8 +17,11 @@
 #ifndef ASYNC_SIMPLE_MOVEWRAPPER_H
 #define ASYNC_SIMPLE_MOVEWRAPPER_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <utility>
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 // std::function requre copyConstructable, hence we provide MoveWrapper perform

diff --git a/async_simple/Promise.h b/async_simple/Promise.h
@@ -16,10 +16,13 @@
 #ifndef ASYNC_SIMPLE_PROMISE_H
 #define ASYNC_SIMPLE_PROMISE_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <exception>
 #include "async_simple/Common.h"
 #include "async_simple/Future.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 template <typename T>

diff --git a/async_simple/Traits.h b/async_simple/Traits.h
@@ -16,8 +16,11 @@
 #ifndef ASYNC_SIMPLE_TRAITS_H
 #define ASYNC_SIMPLE_TRAITS_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include "async_simple/Try.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 template <typename T>

diff --git a/async_simple/Try.h b/async_simple/Try.h
@@ -16,6 +16,7 @@
 #ifndef ASYNC_SIMPLE_TRY_H
 #define ASYNC_SIMPLE_TRY_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <cassert>
 #include <exception>
 #include <functional>
@@ -24,6 +25,8 @@
 #include "async_simple/Common.h"
 #include "async_simple/Unit.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 // Forward declaration

diff --git a/async_simple/async_simple.cppm b/async_simple/async_simple.cppm
@@ -0,0 +1,87 @@
+// There unhandled macro uses found in the body:
+//	'CPU_SETSIZE' defined in /usr/include/sched.h:82:10
+//	'CPU_ISSET' defined in /usr/include/sched.h:85:10
+//	'CPU_ZERO' defined in /usr/include/sched.h:87:10
+//	'CPU_SET' defined in /usr/include/sched.h:83:10
+module;
+// WARNING: Detected unhandled non interesting includes.
+// It is not suggested mix includes and imports from the compiler's
+// perspective. Since it may introduce redeclarations within different
+// translation units and the compiler is not able to handle such patterns
+// efficiently.
+//
+// See https://clang.llvm.org/docs/StandardCPlusPlusModules.html#performance-tips
+#include <version>
+#include <cassert>
+#include <stdio.h>
+#include <climits>
+
+#ifdef __linux__
+#include <sched.h>
+#endif
+
+export module async_simple;
+import std;
+#define ASYNC_SIMPLE_USE_MODULES
+extern "C++" {
+  #include "util/move_only_function.h"
+  #include "coro/Traits.h"
+  #include "experimental/coroutine.h"
+}
+export extern "C++" {
+  #include "MoveWrapper.h"
+  #include "Executor.h"
+}
+extern "C++" {
+  #include "CommonMacros.h"
+  #include "Common.h"
+  #include "Unit.h"
+}
+export extern "C++" {
+  #include "Try.h"
+}
+extern "C++" {
+  #include "FutureState.h"
+  #include "LocalState.h"
+  #include "Traits.h"
+}
+export extern "C++" {
+  #include "Future.h"
+  #include "Promise.h"
+  #include "coro/DetachedCoroutine.h"
+  #include "coro/ViaCoroutine.h"
+  #include "coro/Lazy.h"
+}
+extern "C++" {
+  #include "uthread/internal/thread_impl.h"
+  #include "uthread/internal/thread.h"
+}
+export extern "C++" { 
+  #include "uthread/Await.h"
+  #include "uthread/Latch.h"
+  #include "uthread/Uthread.h"
+  #include "uthread/Async.h"
+  #include "coro/ConditionVariable.h"
+  #include "coro/SpinLock.h"
+  #include "coro/Latch.h"
+  #include "coro/CountEvent.h"
+  #include "coro/Collect.h"
+  #include "IOExecutor.h"
+  #include "coro/SharedMutex.h"
+  #include "uthread/Collect.h"
+  #include "coro/PromiseAllocator.h"
+  #include "executors/SimpleIOExecutor.h"
+  #include "coro/Mutex.h"
+  #include "Collect.h"
+  #include "util/Condition.h"
+  #include "coro/Dispatch.h"
+  #include "coro/Sleep.h"
+  #include "util/Queue.h"
+  #include "util/ThreadPool.h"
+  #include "coro/ResumeBySchedule.h"
+  #include "coro/FutureAwaiter.h"
+  #include "coro/SyncAwait.h"
+  #include "executors/SimpleExecutor.h"
+  #include "coro/Semaphore.h"
+  #include "coro/Generator.h"
+}
diff --git a/async_simple/coro/Collect.h b/async_simple/coro/Collect.h
@@ -16,6 +16,7 @@
 #ifndef ASYNC_SIMPLE_CORO_COLLECT_H
 #define ASYNC_SIMPLE_CORO_COLLECT_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <array>
 #include <exception>
 #include <memory>
@@ -31,6 +32,8 @@
 #include "async_simple/coro/Lazy.h"
 #include "async_simple/experimental/coroutine.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 namespace coro {
 

diff --git a/async_simple/coro/ConditionVariable.h b/async_simple/coro/ConditionVariable.h
@@ -16,9 +16,12 @@
 #ifndef ASYNC_SIMPLE_CORO_CONDITION_VARIABLE_H
 #define ASYNC_SIMPLE_CORO_CONDITION_VARIABLE_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <mutex>
 #include "async_simple/coro/Lazy.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 namespace coro {
 

diff --git a/async_simple/coro/CountEvent.h b/async_simple/coro/CountEvent.h
@@ -16,11 +16,14 @@
 #ifndef ASYNC_SIMPLE_CORO_EVENT_H
 #define ASYNC_SIMPLE_CORO_EVENT_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <atomic>
 #include <cstddef>
 #include <utility>
 #include "async_simple/experimental/coroutine.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 namespace coro {

diff --git a/async_simple/coro/DetachedCoroutine.h b/async_simple/coro/DetachedCoroutine.h
@@ -16,10 +16,13 @@
 #ifndef ASYNC_SIMPLE_CORO_DETACHED_COROUTINE_H
 #define ASYNC_SIMPLE_CORO_DETACHED_COROUTINE_H
 
+#ifndef ASYNC_SIMPLE_USE_MODULES
 #include <stdio.h>
 #include <exception>
 #include "async_simple/experimental/coroutine.h"
 
+#endif // ASYNC_SIMPLE_USE_MODULES
+
 namespace async_simple {
 
 namespace coro {