libcoppダウンロードlibcoppソースコードのダウンロード

libcopp

C/C++

v2.2.0

ダウンロード

libcopp

C ++のクロスプラットフォームCoroutineライブラリ。

CIビルドステータス

CIジョブマトリックス

ターゲットシステム	ツールチェーン	注記
Linux	GCC	静的リンク
Linux	GCC	動的リンク
Linux	gcc-latest
Linux	gcc-latest	例外ではありません
Linux	gcc-latest	スレッドは安全ではありません
Linux	GCC 4.8	遺産
Linux	Clang-Latest	LIBC ++で
MINGW64	GCC	動的リンク
Windows	Visual Studio 2019	静的リンク
Windows	Visual Studio 2019	動的リンク
Windows	Visual Studio 2017	レガシー、静的リンク
macos	Appleclang	LIBC ++で

ライセンス

MITライセンスに基づくライセンス

書類

ドキュメントは、https：//libcopp.atframe.work、api参照https://libcopp.atframe.work/doxygen/html/で見つけることができます（docs/sphinxおよびdocopp.doxyfile.in.docopp.doxyfile.in）を使用して、Sphinxとdoxygenが生成）。

1.3.x-1.4.xから2.xにアップグレードします

using value_type = int; cotask::task<T>を使用する場合のTに。
cotask::task<T>使用すると、 stack_allocator_t Tでtのstack_allocator_typeに変更します。
cotask::task<T>を使用する場合、tのTのcoroutine_typeにcoroutine_t変更します。
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（boost.testサポート）

Unix

[必須] ar, as, ld （binutils）またはllvm
[オプション] GTESTを使用している場合、pthreadが必要です。

Windows

[必須] MASM（MSVCで）
[オプション] GTESTを使用している場合、pthreadが必要です。

VCPKGでインストールします

クローンとセットアップVCPKG（https://github.com/microsoft/vcpkgの詳細を参照）

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
PS > bootstrap-vcpkg.bootstrap
Linux: ~ /$ ./bootstrap-vcpkg.sh

libcoppをインストールします

PS > . v cpkg install libcopp [--triplet x64-windows-static/x64-windows/x64-windows-static-md and etc...]
Linux: ~ /$ ./vcpkg install libcopp

参照：ref： `cmake <usage-using with cmake>`を使用してcmakeを使用します。

カスタムビルド

クローンとビルドディレクトリを作成します

git clone --single-branch --depth=1 -b master https://github.com/owent/libcopp.git
mkdir libcopp/build && cd libcopp/build

cmakeコマンドを実行します

 # cmake <libcopp dir> [options...]
cmake .. -DPROJECT_ENABLE_UNITTEST=YES -DPROJECT_ENABLE_SAMPLE=YES

libcoppを作ります

cmake --build . --config RelWithDebInfo # or make [options] when using Makefile

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

[オプション]インストール

cmake --build . --config RelWithDebInfo --target install # or make install when using Makefile

次に、 libcopp.*/libcotask.* 、または参照：ref： `cmake <usage-using with cmake>`を以下で使用します。

cmakeオプション

オプションは、cmakeオプションにすることができます。コンパイルツールチェーン、ソースディレクトリ、またはビルドアクションを制御するLibCoppのオプションなど。 libcoppオプションは以下にリストされています。

オプション	説明
build_shared_libs = yes \| no	[デフォルト=いいえ]動的ライブラリをビルドします。
libcopp_enable_segmented_stacks = yes \| no	[デフォルト=いいえ]スプリットスタックサポートされたコンテキストを有効にします。（LinuxとGCC 4.7.0または上部でのみ利用できます）
libcopp_enable_valgrind = yes \| no	[デフォルト=はい] Valgrindサポートされたコンテキストを有効にします。
project_enable_unittest = yes \| no	[デフォルト=いいえ]ビルド単位テスト。
project_enable_sample = yes \| no	[デフォルト=いいえ]サンプルをビルドします。
libcopp_lock_disable_this_mt = yes \| no	[default = no] `copp::this_coroutine`および`cotask::this_task`のマルチスレッドサポートを無効にします。
libcopp_disable_atomic_lock = yes \| no	[デフォルト=いいえ]マルチスレッドサポートを無効にします。
libcotask_enable = yes \| no	[デフォルト=はい] Build Libcotaskを有効にします。
libcopp_fcontext_use_tsx = yes \| no	[デフォルト=はい] Intel Transactional同期拡張機能（TSX）を有効にします。
libcopp_macro_tls_stack_protector = yes \| no	[デフォルト=いいえ]ユーザーは、 `-fstack-protector`とコンパイルするときにlibcopp_macro_tls_stack_protector = onを設定する必要があります。デフォルトのコンテキストの切り替えロジックを変更するため。
gtest_root = [path]	GTESTライブラリを設定するプレフィックスパスをインストールします
boost_root = [path]	boost.testライブラリを設定するプレフィックスパスをインストールします

使用法

cmakeで使用します

set(Libcopp_ROOT <where to find libcopp/INSTALL_PREFIX>)
find_package（libcopp）を使用して、libcoppモジュールを使用します。
例：（ターゲット名が${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/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 ：

Coroutineコンテキストを使用します
Coroutineタスクの使用
Coroutineタスクマネージャーの使用
スタックプールを使用します
task::thenまたはtask::await_task使用します
copp::callable_promiseのC ++ 20 Coroutineの使用
copp::generator_futureを使用して、C ++ 20 Coroutine
C ++ 20 Coroutineを使用する場合のカスタムエラー（たとえばタイムアウト）
C ++ 20 Coroutineをcotask::taskで動作させます
cotask::taskを使用してWindowsでWindowsファイバーとSetUnhandledExceptionFilter使用します

すべてのサンプルコードは、REF： `Examples <Examples_doc_anchor>`およびサンプルにあります。

知らせ

スプリットスタックサポート：LinuxおよびユーザーGCC 4.7.0またはアッパーで、 -DLIBCOPP_ENABLE_SEGMENTED_STACKS=YES Split Stackサポートコンテキストを使用します。

GCCスプリートスタックの代わりに、スタックプールを使用することを推奨しています。

ベンチマーク

最新のベンチマークレポートについては、CI出力をご覧ください。クリックしてgithubアクションにアクセスします。

よくある質問

Q：C ++ 20 Coroutineを有効にする方法

ANS：ADD /std:c++latest /await MSVC 1932以下または-std=c++20 -fcoroutines-ts -stdlib=libc++ clang 13以下またはGCC 10の-std=c++20 -fcoroutines 。

-std=c++20 -stdlib=libc++ clang 14以降を使用できる場合は、gcc 11以降は-astd=c++20 、および/std:c++latest 。

Q：Libcoppは例外を処理しますか？

ANS：C ++ 11以降を使用すると、Libcoppはすべてのハンドルされた例外をキャッチし、Coroutineが再開された後にそれをreり回ります。

Q：なぜSetUnhandledExceptionFilterコルーチンで未処理の例外をキャッチできないのですか？

ANS： SetUnhandledExceptionFilter Windowsファイバーでのみ動作します。詳細については、sample/sample_readme_11.cppを参照してください。

フィードバック

質問がある場合は、問題を作成し、環境の情報を提供してください。例えば：

OS ：Windows 10 Pro 19041 （これは「msinfo32``」を実行した後に見ることができます） / manjaro（arch）linux 5.4.39-1-manjaro
コンパイラ：Visual Studio 2019 C ++ 16.5.5 VS 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
関連環境変数：CMakeツールチェーン、 CC 、 CXX 、 ARなどを変更するすべての環境変数を提供してください。