diff --git a/thirdparty/ngtcp2/HPKBUILD b/thirdparty/ngtcp2/HPKBUILD new file mode 100644 index 0000000000000000000000000000000000000000..fe9677062916e15403488452a1db40320ea9a221 --- /dev/null +++ b/thirdparty/ngtcp2/HPKBUILD @@ -0,0 +1,51 @@ +# Contributor: chengkan +# Maintainer: chengkan +pkgname=ngtcp2 +pkgver=v0.16.0 +pkgrel=0 +pkgdesc="ngtcp2 project is an effort to implement RFC9000 QUIC protocol" +url="https://github.com/ngtcp2/ngtcp2" +archs=("armeabi-v7a" "arm64-v8a") +license=("MIT") +depends=("CUnit" "openssl_quic" "nghttp3") +makedepends=() + +source="https://github.com/ngtcp2/$pkgname/archive/refs/tags/$pkgver.tar.gz" + +autounpack=true +downloadpackage=true + +builddir=$pkgname-${pkgver:1} +packagename=$builddir.tar.gz + +prepare() { + mkdir -p $builddir/$ARCH-build +} + +build() { + cd $builddir + # ohos的cmake 3.16 版本不支持 CMakeCCompiler.cmake:45:set(CMAKE_C_BYTE_ORDER "LITTLE_ENDIAN") 这个变量，所以使用编译机3.26版本的cmake + cmake "$@" -DOHOS_ARCH=$ARCH -B$ARCH-build -S./ -L > `pwd`/$ARCH-build/build.log 2>&1 + # main是ngtcp2的单元测试程序 需要一起编译出来 + make VERBOSE=1 -j4 -C $ARCH-build >> `pwd`/$ARCH-build/build.log 2>&1 && make VERBOSE=1 -j4 main -C $ARCH-build >> `pwd`/$ARCH-build/build.log 2>&1 + ret=$? + cd $OLDPWD + return $ret +} + +package() { + cd "$builddir" + make -C $ARCH-build install >> `pwd`/$ARCH-build/build.log 2>&1 + cd $OLDPWD +} + +check() { + echo "The test must be on an OpenHarmony device!" + # 设置LD_LIBRARY_PATH环境变量 + # ctest测试 +} + +# 清理环境 +cleanbuild() { + rm -rf ${PWD}/$builddir #${PWD}/$packagename +} diff --git a/thirdparty/ngtcp2/OAT.xml b/thirdparty/ngtcp2/OAT.xml new file mode 100644 index 0000000000000000000000000000000000000000..96937ea08644b79312d0ced7c0b3eb1e845108ee --- /dev/null +++ b/thirdparty/ngtcp2/OAT.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/thirdparty/ngtcp2/README.OpenSource b/thirdparty/ngtcp2/README.OpenSource new file mode 100644 index 0000000000000000000000000000000000000000..d35d42bca57a6672b83d07c409031be9d97b7154 --- /dev/null +++ b/thirdparty/ngtcp2/README.OpenSource @@ -0,0 +1,11 @@ +[ + { + "Name": "ngtcp2", + "License": "MIT license", + "License File": "https://github.com/ngtcp2/ngtcp2/blob/main/COPYING", + "Version Number": "v0.16.0", + "Owner": "kanchengc@isoftstone.com", + "Upstream URL": "https://github.com/ngtcp2/ngtcp2/archive/refs/tags/v0.16.0.tar.gz", + "Description": "ngtcp2 project is an effort to implement IETF QUIC protocol." + } +] diff --git a/thirdparty/ngtcp2/README_zh.md b/thirdparty/ngtcp2/README_zh.md new file mode 100644 index 0000000000000000000000000000000000000000..c6993455851415e733a202cdd08b5888303b5601 --- /dev/null +++ b/thirdparty/ngtcp2/README_zh.md @@ -0,0 +1,16 @@ +# ngtcp2三方库说明 +## 功能简介 +ngtcp2项目是实现RFC9000 QUIC协议。 +## 使用约束 +- ROM版本：OpenHarmony3.2Release + +- IDE版本：DevEco Studio 3.1 Release + +- SDK：ohos_sdk_public 4.0.8.1 (API Version 10 Release) + +- 三方库版本：3.3.10 + + +- [MIT license](https://github.com/ngtcp2/ngtcp2/blob/main/COPYING) +## 集成方式 ++ [系统hap包集成](docs/hap_integrate.md) diff --git a/thirdparty/ngtcp2/SHA512SUM b/thirdparty/ngtcp2/SHA512SUM new file mode 100644 index 0000000000000000000000000000000000000000..55caeb982f6f840e86c0f2dbbc13001d53645b67 --- /dev/null +++ b/thirdparty/ngtcp2/SHA512SUM @@ -0,0 +1 @@ +59fd3b1dacd34d6945acb4b2f4d7e9ea4b62496f4b834d24e4f3d5366a73976c26420baaab87de48cba0fcb64a9c18634ead7b2f839ac4687b4b066f58b938f6 ngtcp2-0.16.0.tar.gz diff --git a/thirdparty/ngtcp2/docs/hap_integrate.md b/thirdparty/ngtcp2/docs/hap_integrate.md new file mode 100644 index 0000000000000000000000000000000000000000..73cba622b29b839812c181514b438e1ecceae679 --- /dev/null +++ b/thirdparty/ngtcp2/docs/hap_integrate.md @@ -0,0 +1,99 @@ +# ngtcp2集成到应用hap +本库是在RK3568开发板上基于OpenHarmony3.2 Release版本的镜像验证的，如果是从未使用过RK3568，可以先查看[润和RK3568开发板标准系统快速上手](https://gitee.com/openharmony-sig/knowledge_demo_temp/tree/master/docs/rk3568_helloworld)。 +## 开发环境 +- ubuntu20.04 +- [OpenHarmony3.2Release镜像](https://gitee.com/link?target=https%3A%2F%2Frepo.huaweicloud.com%2Fopenharmony%2Fos%2F3.2-Release%2Fdayu200_standard_arm32.tar.gz) +- [ohos_sdk_public 4.0.8.1 (API Version 10 Release)](https://gitee.com/link?target=http%3A%2F%2Fdownload.ci.openharmony.cn%2Fversion%2FMaster_Version%2FOpenHarmony_4.0.8.1%2F20230608_091058%2Fversion-Master_Version-OpenHarmony_4.0.8.1-20230608_091058-ohos-sdk-public.tar.gz) +- [DevEco Studio 3.1 Release](https://gitee.com/link?target=https%3A%2F%2Fcontentcenter-vali-drcn.dbankcdn.cn%2Fpvt_2%2FDeveloperAlliance_package_901_9%2F81%2Fv3%2FtgRUB84wR72nTfE8Ir_xMw%2Fdevecostudio-windows-3.1.0.501.zip%3FHW-CC-KV%3DV1%26HW-CC-Date%3D20230621T074329Z%26HW-CC-Expire%3D315360000%26HW-CC-Sign%3D22F6787DF6093ECB4D4E08F9379B114280E1F65DA710599E48EA38CB24F3DBF2) +- [准备三方库构建环境](../../../tools/README.md#编译环境准备) +- [准备三方库测试环境](../../../tools/README.md#ci环境准备) + +## 编译三方库 +- 下载本仓库 + ``` + git clone https://gitee.com/openharmony-sig/tpc_c_cplusplus.git --depth=1 + ``` +- 三方库目录结构 + ``` + tpc_c_cplusplus/thirdparty/ngtcp2 #三方库ngtcp2的目录结构如下 + ├── docs #三方库相关文档的文件夹 + ├── HPKBUILD #构建脚本 + ├── SHA512SUM #三方库校验文件 + ├── README.OpenSource #说明三方库源码的下载地址，版本，license等信息 + ├── README_zh.md + ``` + +- 将ngtcp2拷贝和依赖的库拷贝至tools/main目录下 + ``` + cd tpc_c_cplusplus + cp thirdparty/ngtcp2 tools/main -rf + cp thirdparty/CUnit tools/main -rf + cp thirdparty/openssl_quic tools/main -rf + cp thirdparty/nghttp3 tools/main -rf + + ``` +- 在tools目录下编译三方库 + 编译环境的搭建参考[准备三方库构建环境](../../../tools/README.md#编译环境准备) + + ``` + (ngtcp2库所需要的依赖库有 CUnit openssl_quic nghttp3，所以编译时需要一起编译) + + cd tools + ./build.sh CUnit openssl_quic nghttp3 ngtcp2 + ``` +- 三方库头文件及生成的库 + 在tools目录下会生成usr目录，该目录下存在已编译完成的32位和64位三方库 + + ``` + ngtcp2/arm64-v8a ngtcp2/armeabi-v7a CUnit/arm64-v8a CUnit/armeabi-v7a + openssl_quic/arm64-v8a openssl_quic/armeabi-v7a nghttp3/arm64-v8a nghttp3/armeabi-v7a + ``` + +- [测试三方库](#测试三方库) + +## 应用中使用三方库 +- 在IDE的cpp目录下新增thirdparty/ngtcp2目录，将编译生成的库所在目录拷贝到该目录下，如下图所示 + ![ngtcp2_install](pic/ngtcp2_install.png) +- 在最外层（cpp目录下）CMakeLists.txt中添加如下语句 + ``` + + #将三方库加入工程中 + target_link_libraries(entry PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/ngtcp2/nghttp3/${OHOS_ARCH}/lib/libnghttp3.so.5 + ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/ngtcp2/openssl_quic/${OHOS_ARCH}/lib/libssl.so.81.1.1 + ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/ngtcp2/openssl_quic/${OHOS_ARCH}/lib/libcrypto.so.81.1.1 + ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/ngtcp2/ngtcp2/${OHOS_ARCH}/lib/libngtcp2_crypto_openssl.so.5 + ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/ngtcp2/ngtcp2/${OHOS_ARCH}/lib/libngtcp2.so.13) + #将三方库的头文件加入工程中 + target_include_directories(entry PRIVATE + ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/ngtcp2/ngtcp2/${OHOS_ARCH}/include + ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/ngtcp2/openssl_quic/${OHOS_ARCH}/include + ${CMAKE_CURRENT_SOURCE_DIR}/thirdparty/ngtcp2/nghttp3/${OHOS_ARCH}/include) + + ``` + ![ngtcp2_usage](pic/ngtcp2_usage.png) +## 测试三方库 +三方库的测试使用原库自带的测试用例来做测试，[准备三方库测试环境](../../../tools/README.md#ci环境准备) + + + +- 将测试资源导入到开发板 +- 设置依赖库路径 +``` +32位系统 +export LD_LIBRARY_PATH=/data/local/tmp/lycium/usr/CUnit/armeabi-v7a/lib:/data/local/tmp/lycium/usr/nghttp3/armeabi-v7a/lib:/data/local/tmp/lycium/usr/ngtcp2/armeabi-v7a/lib:/data/local/tmp/lycium/usr/openssl_quic/armeabi-v7a/lib + +##64位系统 +export LD_LIBRARY_PATH=/data/local/tmp/lycium/usr/CUnit/arm64-v8a/lib:/data/local/tmp/lycium/usr/nghttp3/arm64-v8a/lib:/data/local/tmp/lycium/usr/ngtcp2/arm64-v8a/lib:/data/local/tmp/lycium/usr/openssl_quic/arm64-v8a/lib +``` +- 进入到构建目录执行 ctest 运行测试用例，如下截图（arm64-v8a-build为构建64位的目录，armeabi-v7a-build为构建32位的目录） + + + +![ngtcp2](pic/ngtcp2_test.png) + +## 参考资料 +- [润和RK3568开发板标准系统快速上手](https://gitee.com/openharmony-sig/knowledge_demo_temp/tree/master/docs/rk3568_helloworld) +- [OpenHarmony三方库地址](https://gitee.com/openharmony-tpc) +- [OpenHarmony知识体系](https://gitee.com/openharmony-sig/knowledge) +- [通过DevEco Studio开发一个NAPI工程](https://gitee.com/openharmony-sig/knowledge_demo_temp/blob/master/docs/napi_study/docs/hello_napi.md) diff --git a/thirdparty/ngtcp2/docs/pic/ngtcp2_install.png b/thirdparty/ngtcp2/docs/pic/ngtcp2_install.png new file mode 100644 index 0000000000000000000000000000000000000000..f83db668da5a94b416e09516bb0dc9449858cf20 Binary files /dev/null and b/thirdparty/ngtcp2/docs/pic/ngtcp2_install.png differ diff --git a/thirdparty/ngtcp2/docs/pic/ngtcp2_test.png b/thirdparty/ngtcp2/docs/pic/ngtcp2_test.png new file mode 100644 index 0000000000000000000000000000000000000000..ff1b03b822c8047e86b3eccd0d40a0155b857791 Binary files /dev/null and b/thirdparty/ngtcp2/docs/pic/ngtcp2_test.png differ diff --git a/thirdparty/ngtcp2/docs/pic/ngtcp2_usage.png b/thirdparty/ngtcp2/docs/pic/ngtcp2_usage.png new file mode 100644 index 0000000000000000000000000000000000000000..ebc74b1674fae0b03fa23e18e4bca828f6135b4e Binary files /dev/null and b/thirdparty/ngtcp2/docs/pic/ngtcp2_usage.png differ