首页>编程相关>C/C++
下载

libcopp

C ++中的跨平台Coroutine库。

CI构建状态

CI职位矩阵

目标系统工具链笔记
Linux海湾合作委员会静态链接
Linux海湾合作委员会动态链接
Linux GCC-Latest
Linux GCC-Latest不例外
Linux GCC-Latest线程不安全
Linux GCC 4.8遗产
Linux最叮当使用libc ++
mingw64海湾合作委员会动态链接
视窗Visual Studio 2019静态链接
视窗Visual Studio 2019动态链接
视窗Visual Studio 2017遗产，静态链接
macos appleclang使用libc ++

执照

根据MIT许可证的许可证

文档

可以在https://libcopp.atframe.work上找到文档，API参考CANBE在https://libcopp.atframe.work/doxygen/html/。

从1.3.x-1.4.x升级到2.x

  • using value_type = int;使用cotask::task<T>中的T 。
  • 使用T cotask::task<T>重命名stack_allocator_t到stack_allocator_type 。
  • 使用cotask::task<T>将coroutine_t重命名为T中的coroutine_type 。
  • 重命名libcopp::util::*到copp::util:: 。
  • 我们不允许使用libcopp::util::intrusive_ptr<cotask::impl::task_impl>现在，请改用cotask::task<T>::ptr_type 。

从1.2.x升级到1.3.x-1.4.x

  • 重命名cotask::task::await cotask::task::await_task
  • 替换cotask::task<TCO_MACRO, TTASK_MACRO>用cotask::task<TCO_MACRO> ，我们现在不允许自定义ID分配器。
  • 替换cotask::core::standard_int_id_allocator<uint64_t>用copp::util::uint64_id_allocator ，我们现在不允许现在自定义ID分配器。
  • 需要GCC 4.8+，MSVC 15+（Visual Studio 2017）>）
  • 需要CMAKE 3.12.0或上部

安装

libcopp使用cmake生成makefile并开关构建工具。

先决条件

  • [必需] GCC或CLANG或MSVC或CLANG-CL支持ISO C ++ 11和上部
  • [必需] CMAKE 3.16.0和上部
  • [可选] GTEST 1.6.0和上部（支持更好的单位测试）
  • [可选] boost.test（支持测试）

Unix

  • [必需] ar, as, ld （Binutils）或LLVM
  • [可选]如果使用gtest，则需要pthread。

视窗

  • [必需] MASM（在MSVC中）
  • [可选]如果使用gtest，则需要pthread。

使用VCPKG安装

  1. 克隆和设置VCPKG（请参阅https://github.com/microsoft/vcpkg上的更多详细信息） 
    git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
PS > bootstrap-vcpkg.bootstrap
Linux: ~ /$ ./bootstrap-vcpkg.sh
  2. 安装libcopp 
    PS > . v cpkg install libcopp [--triplet x64-windows-static/x64-windows/x64-windows-static-md and etc...]
Linux: ~ /$ ./vcpkg install libcopp

  3. 请参阅：参考：`与cmake <用法使用一起使用cmake>`在下面的cmake中使用。

自定义构建

  1. 克隆并制作一个构建目录
    git clone --single-branch --depth=1 -b master https://github.com/owent/libcopp.git
mkdir libcopp/build && cd libcopp/build
  2. 运行cmake命令
     # cmake <libcopp dir> [options...]
cmake .. -DPROJECT_ENABLE_UNITTEST=YES -DPROJECT_ENABLE_SAMPLE=YES
  3. 做libcopp 
    cmake --build . --config RelWithDebInfo # or make [options] when using Makefile
  4. 运行test/sample/benchmark [可选] 
     # Run test => Required: PROJECT_ENABLE_UNITTEST=YES
ctest -VV . -C RelWithDebInfo -L libcopp.unit_test
# Run sample => Required: PROJECT_ENABLE_SAMPLE=YES
ctest -VV . -C RelWithDebInfo -L libcopp.sample
# Run benchmark => Required: PROJECT_ENABLE_SAMPLE=YES
ctest -VV . -C RelWithDebInfo -L libcopp.benchmark
  5. 安装[可选] 
    cmake --build . --config RelWithDebInfo --target install # or make install when using Makefile

  6. 然后只需包含并链接libcopp.*/libcotask.* ，或参见：ref：`与cmake <使用cmake-usage-using-make> make>`对于下面的cmake。

CMAKE选项

选项可以是CMAKE选项。例如控制构建操作的LIBCOPP的设置编译工具链，源目录或选项。 LIBCOPP选项如下：

选项描述
build_shared_libs = yes |否[default = no]构建动态库。
libcopp_enable_seginged_stacks = yes |否[default = no]启用拆分堆栈支持的上下文。
libcopp_enable_valgrind = yes |否[default = yes]启用valgrind支持的上下文。
project_enable_unittest = yes |否[默认值=否]构建单元测试。
project_enable_sample = yes |否[默认值= no]构建样本。
libcopp_lock_disable_this_mt = yes |否[default = no]禁用对copp::this_coroutine和cotask::this_task多线程支持。
libcopp_disable_atomic_lock = yes |否[default = no]禁用多线程支持。
libcotask_enable = yes |否[default = yes]启用构建libcotask。
libcopp_fcontext_use_tsx = yes |否[default = yes]启用英特尔交易同步扩展（TSX）。
libcopp_macro_tls_stack_protector = yes |否[default = no]用户需要设置libcopp_macro_tls_stack_protector = on用-fstack-protector编译时。因为它更改了默认上下文切换逻辑。
gtest_root = [路径]设置GTEST库安装前缀路径
boost_root = [路径]设置boost.test库安装前缀路径

用法

与Cmake一起使用

  1. 使用set(Libcopp_ROOT <where to find libcopp/INSTALL_PREFIX>)
  2. 仅使用Find_package（libcopp）使用libcopp模块。
  3. 示例：（我们假设目标名称存储在${CUSTOM_TARGET_NAME}中） 
 find_package (Libcopp CONFIG REQUIRED)
target_link_libraries ( ${CUSTOM_TARGET_NAME} libcopp::cotask)
# Or just using copp by target_link_libraries(${CUSTOM_TARGET_NAME} libcopp::copp)

如果使用MSVC和VCPKG，则CRT必须与VCPKG的三重态匹配，以下这些代码可能很有帮助： 

 if ( MSVC AND VCPKG_TOOLCHAIN)
    if ( DEFINED ENV{VCPKG_DEFAULT_TRIPLET} AND NOT DEFINED VCPKG_TARGET_TRIPLET)
        set (VCPKG_TARGET_TRIPLET " $ENV{VCPKG_DEFAULT_TRIPLET} " CACHE STRING "" )
    endif ()
    if (VCPKG_TARGET_TRIPLET MATCHES "^.*windows-static$" )
        set (CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>" CACHE STRING "" )
    else ()
        set (CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL" CACHE STRING "" )
    endif ()
endif ()

在https://github.com/microsoft/vcpkg/tree/master/master/ports/libcopp上查看更多详细信息。

直接使用标题和库

只需包括标题和链接平台的库文件以使用libcopp即可。 

LIBCOPP_PREFIX= < WHERE TO INSTALL libcopp >

# Example command for build sample with gcc 4.9 or upper on Linux
for source in sample_readme_ * .cpp ; do
    g++ -std=c++14 -O2 -g -ggdb -Wall -Werror -fPIC -rdynamic -fdiagnostics-color=auto -Wno-unused-local-typedefs 
        -I $LIBCOPP_PREFIX /include -L $LIBCOPP_PREFIX /lib64 -lcopp -lcotask $source -o $source .exe ;
done

# Example command for build sample with clang 3.9 or upper and libc++ on Linux
for source in sample_readme_ * .cpp ; do
    clang++ -std=c++17 -stdlib=libc++ -O2 -g -ggdb -Wall -Werror -fPIC -rdynamic        
        -I $LIBCOPP_PREFIX /include -L $LIBCOPP_PREFIX /lib64 -lcopp -lcotask -lc++ -lc++abi  
        $source -o $source .exe ;
done

# AppleClang on macOS just like those scripts upper.
# If you are using MinGW on Windows, it's better to add -static-libstdc++ -static-libgcc to
#     use static linking and other scripts are just like those on Linux. 
 # Example command for build sample with MSVC 1914 or upper on Windows & powershell(Debug Mode /MDd)
foreach ( $source in Get-ChildItem -File -Name . s ample_readme_ * .cpp) {
    cl /nologo /MP /W4 /wd " 4100 " /wd " 4125 " /EHsc /std:c++17 /Zc:__cplusplus /O2 /MDd /I $LIBCOPP_PREFIX /include $LIBCOPP_PREFIX /lib64/copp.lib $LIBCOPP_PREFIX /lib64/cotask.lib $source
}

开始和示例

服务器示例用于使用copp::coroutine_context ， copp::coroutine_context_fiber和cotask::task ：

  1. 使用Coroutine上下文
  2. 使用Coroutine任务
  3. 使用Coroutine任务管理器
  4. 使用堆栈池
  5. 使用task::then或task::await_task
  6. 使用C ++ 20 Coroutine的copp::callable_promise
  7. 使用copp::generator_future for C ++ 20 Coroutine
  8. 自定义错误（例如超时）使用C ++ 20 Coroutine
  9. 让C ++ 20 Coroutine与cotask::task
  10. 使用cotask::task在Windows上使用Windows Fiber和SetUnhandledExceptionFilter

所有示例代码均可在：ref：`示例<示例_doc_anchor>` and sample。

注意

拆分堆栈支持：如果在Linux和用户GCC 4.7.0或upper中，请添加-DLIBCOPP_ENABLE_SEGMENTED_STACKS=YES使用拆分堆栈支持的上下文。

建议使用堆栈池代替GCC拆分堆栈。

基准

请参阅CI输出以获取最新的基准报告。点击访问GitHub动作。

常问问题

问：如何启用C ++ 20 Coroutine

ANS：ADD /std:c++latest /await MSVC 1932及以下或以下或-std=c++20 -fcoroutines-ts -stdlib=libc++ clang 13及以下或以下或以下或以下或-std=c++20 -fcoroutines for GCC 10。

如果您只能使用-std=c++20 -stdlib=libc++ clang 14或更高，则为GCC 11或更高版本-astd=c++20 ，和/std:c++latest MSVC 1932或更新。

问：libcopp会处理异常吗？

回答：使用C ++ 11或更高时，LibCopp会捕获所有未经手的异常，并在恢复Coroutine后将其重新抛弃。

问：为什么SetUnhandledExceptionFilter无法在coroutine中捕获未经治疗的异常？

ANS： SetUnhandledExceptionFilter仅与Windows光纤一起使用，请参阅sample/sample_readme_11.cpp有关详细信息。

反馈

如果您有任何疑问，请创建一个问题并提供您的环境信息。例如：

  • OS ：Windows 10 Pro 19041 （可以在运行``MSINFO32``````
  • 编译器：Visual Studio 2019 C ++ 16.5.5与2019 C ++ V14.25或MSVC 1925/ GCC 9.3.0
  • cmake命令： cmake .. -G "Visual Studio 16 2019" -A x64 -DLIBCOPP_FCONTEXT_USE_TSX=ON -DPROJECT_ENABLE_UNITTEST=ON -DPROJECT_ENABLE_SAMPLE=ON-DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_INSTALL_PREFIX=%cd%/install-prefix / cmake .. -G Ninja -DLIBCOPP_FCONTEXT_USE_TSX=ON -DPROJECT_ENABLE_UNITTEST=ON -DPROJECT_ENABLE_SAMPLE=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_INSTALL_PREFIX=/opt/libcopp
  • 编译命令： cmake --build . -j
  • 相关环境变量：请CXX所有将CC CMAKE工具链AR环境变量

约束

  • Owent

由于

  • Mutouyun
展开
附加信息
相关应用
为您推荐
相关资讯 全部