Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

更新cmake脚本, 便于支持find_package #1774

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

更新cmake脚本, 便于支持find_package #1774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b1cfe33
fix: use the official pre-defined macro for testing windows
zjyhjqs Dec 11, 2024
53f9d90
feat: add cmake config support, and simplify the modification of proj…
zjyhjqs Dec 14, 2024
a0e803c
fix: default value of `CMAKE_INSTALL_PREFIX` should not be set (defau…
zjyhjqs Dec 14, 2024
fe07828
fix: use `MSVC` to check all MSVC front-end compiler (including clang…
zjyhjqs Dec 14, 2024
e2f4b44
fix: delete the explicit `-O3` optimization flags, because it's unnec…
zjyhjqs Dec 14, 2024
7a955e6
perf: use modernized `compile_options`
zjyhjqs Dec 14, 2024
8576920
fix: wrong library name
zjyhjqs Dec 14, 2024
8e35fcc
doc: update documentation about compiling and using the library
zjyhjqs Dec 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 65 additions & 30 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ if (CMAKE_VERSION VERSION_LESS "3.0")
else()
cmake_minimum_required(VERSION 3.6)
endif()
project(GmSSL C)

SET(CMAKE_PROJECT_HOMEPAGE_URL "http://gmssl.org")
file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/include/gmssl/version.h" _gmssl_version_h_contents REGEX "#define GMSSL_VERSION_STR")
string(REGEX MATCH "\"GmSSL [^\"]*" _gmssl_version ${_gmssl_version_h_contents})
string(REGEX REPLACE ".* ([0-9]+\\.[0-9]+\\.[0-9]+) (.*)" "\\1-\\2" _gmssl_version ${_gmssl_version})
unset(_gmssl_version_h_contents)

string(REGEX REPLACE "([0-9]+\.[0-9]+\.[0-9]+).+" "\\1" _gmssl_version_sem "${_gmssl_version}")
project(GmSSL
VERSION ${_gmssl_version_sem}
HOMEPAGE_URL "http://gmssl.org"
LANGUAGES C)

set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
SET(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH};${CMAKE_CURRENT_SOURCE_DIR}/cmake")

include_directories(include)

if(MSVC)
#add_compile_options(/O2) # conflict with CI /0d (not optimized)
else()
add_compile_options(-O3)
endif()

option(ENABLE_TEST_SPEED "Enable test speed" OFF)


Expand Down Expand Up @@ -318,15 +318,15 @@ if (ENABLE_SM4_AVX2)
list(FIND src src/sm4.c sm4_index)
list(REMOVE_AT src ${sm4_index})
list(INSERT src ${sm4_index} src/sm4_avx2.c)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -march=native")
add_compile_options("-march=native")
endif()

if (ENABLE_SM4_AESNI)
message(STATUS "ENABLE_SM4_AESNI is ON")
list(FIND src src/sm4.c sm4_index)
list(REMOVE_AT src ${sm4_index})
list(INSERT src ${sm4_index} src/sm4_aesni.c)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -march=native")
add_compile_options("-march=native")
endif()


Expand All @@ -346,7 +346,7 @@ if (ENABLE_SM4_CTR_AESNI_AVX)
list(FIND src src/sm4_ctr.c sm4_ctr_index)
list(REMOVE_AT src ${sm4_ctr_index})
list(INSERT src ${sm4_ctr_index} src/sm4_ctr_aesni_avx.c)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -march=native")
add_compile_options("-march=native")
endif()


Expand Down Expand Up @@ -469,7 +469,7 @@ if (ENABLE_INTEL_RDRAND)
message(STATUS "ENABLE_INTEL_RDRAND")
add_definitions(-DENABLE_INTEL_RDRAND)
list(APPEND src src/rdrand.c)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mrdrnd")
add_compile_options("-mrdrnd")
endif()
if (ENABLE_INTEL_RDSEED)
set(CMAKE_REQUIRED_FLAGS "-rdseed")
Expand All @@ -479,7 +479,7 @@ if (ENABLE_INTEL_RDRAND)
if (HAVE_INTEL_RDSEED)
message(STATUS "ENABLE_INTEL_RDSEED")
add_definitions(-DENABLE_INTEL_RDSEED)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mrdseed")
add_compile_options("-mrdseed")
endif()
endif()
endif()
Expand Down Expand Up @@ -518,7 +518,7 @@ if (ENABLE_SKF)
src/skf/skf_wisec.c)
list(APPEND tools tools/skfutil.c)
add_library(skf_dummy SHARED src/skf/skf_dummy.c)
set_target_properties(skf_dummy PROPERTIES VERSION 3.1 SOVERSION 3)
set_target_properties(skf_dummy PROPERTIES VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION_MAJOR})
endif()

if (ENABLE_SDF)
Expand All @@ -543,19 +543,23 @@ endif()

option(BUILD_SHARED_LIBS "Build using shared libraries" ON)

if (CMAKE_C_COMPILER_ID MATCHES "MSVC")
if (MSVC)
message(STATUS "CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS")
set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON) # set before add_library
endif()

add_library(gmssl ${src})
add_library(GmSSL::${PROJECT_NAME} ALIAS gmssl)


target_include_directories(gmssl PUBLIC
$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
$<INSTALL_INTERFACE:include>
)



if (WIN32)
target_link_libraries(gmssl -lws2_32)
target_link_libraries(gmssl PRIVATE ws2_32)
elseif (APPLE)
if (ENABLE_SDF)
target_link_libraries(gmssl dl)
Expand All @@ -577,11 +581,41 @@ endif()

set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")

SET_TARGET_PROPERTIES(gmssl PROPERTIES VERSION 3.1 SOVERSION 3)


install(TARGETS gmssl ARCHIVE DESTINATION lib LIBRARY DESTINATION lib RUNTIME DESTINATION bin)
install(DIRECTORY ${CMAKE_SOURCE_DIR}/include/gmssl DESTINATION include)
include(GNUInstallDirs)
set(GmSSL_CMAKE_DIR ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME})

set(_targets_export_name ${PROJECT_NAME}Targets)
include(CMakePackageConfigHelpers)
configure_package_config_file(
${PROJECT_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in
${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
INSTALL_DESTINATION ${GmSSL_CMAKE_DIR})
write_basic_package_version_file(
${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
VERSION ${PROJECT_VERSION}
COMPATIBILITY SameMajorVersion)
install(
FILES
${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
DESTINATION ${GmSSL_CMAKE_DIR})

install(DIRECTORY ${CMAKE_SOURCE_DIR}/include/gmssl DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
install(TARGETS gmssl
EXPORT ${_targets_export_name}
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
set_target_properties(gmssl PROPERTIES
VERSION ${PROJECT_VERSION} SOVERSION ${PROJECT_VERSION_MAJOR}
EXPORT_NAME ${PROJECT_NAME})
export(EXPORT ${_targets_export_name}
NAMESPACE GmSSL::
FILE "${CMAKE_CURRENT_BINARY_DIR}/cmake/${_targets_export_name}.cmake")

install(EXPORT ${_targets_export_name}
NAMESPACE GmSSL::
DESTINATION ${GmSSL_CMAKE_DIR})

if(UNIX AND NOT APPLE)
message(STATUS "Detected Linux, configuring /etc/ld.so.conf.d/gmssl.conf")
Expand Down Expand Up @@ -611,10 +645,9 @@ if (NOT ${CMAKE_SYSTEM_NAME} STREQUAL "iOS")
install(TARGETS gmssl-bin RUNTIME DESTINATION bin)
endif()

if (CMAKE_C_COMPILER_ID MATCHES "MSVC")
if (MSVC)
set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT gmssl-bin)
set(CMAKE_INSTALL_PREFIX "C:/Program Files/GmSSL") # change by `cmake -DCMAKE_INSTALL_PREFIX=C:\path\to\install`
# run `set path=%path%;C:\Program Files\GmSSL\bin`

add_compile_definitions(_CRT_SECURE_NO_WARNINGS)

target_compile_options(gmssl PRIVATE /utf-8)
Expand Down Expand Up @@ -642,9 +675,11 @@ endif()
# Install the STGZ package
# ./GmSSL-<version>-Linux.sh --prefix=/usr/local
#
set(CPACK_PACKAGE_NAME "GmSSL")
# The `-DEV` part is important
string(REGEX REPLACE "([0-9]+\.[0-9]+)\.([0-9]+.*)" "\\2" CPACK_PACKAGE_VERSION_PATCH "${_gmssl_version}")
set(CPACK_PACKAGE_VENDOR "GmSSL develop team")
set(CPACK_PACKAGE_VERSION "3.1.2-Dev")
set(CPACK_PACKAGE_DESCRIPTION_FILE ${PROJECT_SOURCE_DIR}/README.md)
set(CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/LICENSE)
set(CPACK_RESOURCE_FILE_README ${PROJECT_SOURCE_DIR}/README.md)
set(CPACK_GENERATOR TGZ) # default generator, can be overwritten by `cpack -G`
set(CPACK_NSIS_MODIFY_PATH ON)
include(CPack)
103 changes: 53 additions & 50 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,20 @@

GmSSL当前版本采用CMake构建系统。由于CMake是一个跨平台的编译、安装工具，因此GmSSL可以在大多数主流操作系统上编译、安装和运行。GmSSL项目官方测试了Windows (包括Visual Stduio和Cygwin)、Linux、Mac、Android和iOS这几个主流操作系统上的编译，并通过GitHub的CI工作流对提交的最新代码进行自动化的编译测试。

和其他基于CMake的开源项目类似，GmSSL的构建过程主要包含配置、编译、测试、安装这几个步骤。以Linux操作系统环境为例，在下载并解压GmSSL源代码后，进入源代码目录，执行如下命令：
和其他基于CMake的开源项目类似，GmSSL的构建过程主要包含配置、编译、测试、安装这几个步骤。在下载并解压GmSSL源代码后，进入源代码目录，执行如下命令：

```bash
mkdir build
cd build
cmake ..
make
make test
sudo make install
cmake -B build # -G "Ninja Multi-Config"
cmake --build build
ctest --test-dir build
sudo cmake --install build # --prefix /path
```

就可以完成配置、编译、测试和安装。

在执行`make`编译成功后，在`build/bin`目录下会生成项目的可执行文件和库文件。对于密码工具来说，在安装使用之前通过`make test`进行测试是重要的一步，如果测试失败，那么不应该使用这个软件。在发生某个测试错误后，可以执行`build/bin`下的具体某个测试命令行，如`sm4test`，这样可以看到具体的错误打印信息。
在执行`cmake --build`编译成功后，在`build/bin`目录下会生成项目的可执行文件和库文件。对于密码工具来说，在安装使用之前通过`ctest`进行测试是重要的一步，如果测试失败，那么不应该使用这个软件。在发生某个测试错误后，可以执行`build/bin`下的具体某个测试命令行，如`sm4test`，这样可以看到具体的错误打印信息。

执行`sudo make install`，安装完成后，可以命令行中调用`gmssl`命令行工具。在Linux和Mac环境下，头文件通常被安装在`/usr/local/include/gmssl`目录下，库文件被安装在`/usr/local/lib`目录下。
执行`sudo cmake --install`，安装完成后，可以命令行中调用`gmssl`命令行工具。在Linux和Mac环境下，头文件通常被安装在`/usr/local/include/gmssl`目录下，库文件被安装在`/usr/local/lib`目录下。

## 项目源代码

Expand Down Expand Up @@ -82,7 +80,7 @@ GmSSL包含了针对特定硬件和处理指令集的密码算法优化实现，

```bash
cmake .. -DENABLE_BROKEN_CRYPTO=ON
make
cmake --build .
```

重新编译后，加入GmSSL库文件的算法包括：
Expand All @@ -96,28 +94,26 @@ make

CMake支持通过指定不同的构建系统生成器（Generator），生成不同类型的Makefile。在Windows和Visual Studio环境下，CMake即可以生成常规的Visual Studio解决方案(.sln)文件，在Visual Studio图形界面中完成编译，也可以生成类似于Linux环境下的Makefile文件，在命令行环境下完成编译和测试。

### 生成Makefile编译
### 生成Makefile/Ninja编译

在安装完Visual Studio之后，在启动菜单栏中会出现Visual Studio菜单目录，其中包含x64 Native Tools Command Prompt for VS 2022等多个终端命令行环境菜单项。

```bash
```pwsh
C:\Program Files\Microsoft Visual Studio\2022\Community>cd /path/to/gmssl
mkdir build
cd build
cmake .. -G "NMake Makefiles"
nmake
nmake test
cmake -B build -G "NMake Makefiles"
# cmake -B build -G "Ninja"
ctest --test-dir build
```

在编译完成后直接执行安装会报权限错误，这是因为安装过程需要向系统目录中写入文件，而当前打开命令行环境的用户不具备该权限。可以通过右键选择“更多-以管理员身份运行”打开x64 Native Tools Command Prompt for VS 2022终端，执行

```
nmake install
```pwsh
cmake --install build
```

那么`gmssl`命令行程序、头文件和库文件分别被写入`C:/Program Files/GmSSL/bin`、`C:/Program Files/GmSSL/include`、`C:/Program Files/GmSSL/lib`这几个系统目录中。为了能够直接在命令行环境任意目录下执行`gmssl`命令行程序，需要将其安装目录加入到系统路径中，可以执行：

```bash
```batch
set path=%path%;C:\Program Files\GmSSL\bin
```

Expand All @@ -127,11 +123,10 @@ set path=%path%;C:\Program Files\GmSSL\bin

在安装完Visual Studio之后，在启动菜单栏中会出现Visual Studio菜单目录，其中包含x64 Native Tools Command Prompt for VS 2022等多个终端命令行环境菜单项。

```bash
```pwsh
C:\Program Files\Microsoft Visual Studio\2022\Community>cd /path/to/gmssl
mkdir build
cd build
cmake ..
# 此处`-G`可以不显式指定, 因为cmake在windows上使用MSBuild作为默认generator
cmake -B build # -G "Visual Studio 17 2022"
```

完成后可以看到CMake在`build`目录下生成了一个`GmSSL.sln`文件和大量的`.vcxproj`文件。
Expand Down Expand Up @@ -179,15 +174,13 @@ cp "/cygdrive/c/Users/Guan Zhi/Downloads/GmSSL-master.zip" ~/
```bash
unzip GmSSL-master.zip
cd GmSSL-master
mkdir build
cd build
cmake ..
make
make test
make install
cmake -B build
cmake --build build
ctest --test-dir build
cmake --install build # --prefix /path
```

注意，由于在Cygwin环境中用户本身具有系统权限，因此在执行`make install`时不需要`sudo`。
注意，由于在Cygwin环境中用户本身具有系统权限，因此在执行`cmake --install`时不需要`sudo`。

在安装完成之后，可以在Cygwin的命令行环境下执行`gmssl`命令行，或者运行源代码`demo`目录下的演示脚本。

Expand Down Expand Up @@ -218,7 +211,7 @@ cmake --build . --config Release
```bash
mkdir build; cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake -DANDROID_ABI=arm64-v8a -DANDROID_PLATFORM=android-23
make
cmake --build .
```

## 安装包构建
Expand Down Expand Up @@ -258,23 +251,33 @@ make package

在正式发布之前，需要在测试平台上编译、测试、安装。验证`gmssl`命令行可以正确使用，验证`sm3_demo.c`可以正确和`-lgmssl`编译，并且可以正确输出哈希值。

完成编译和测试后，在`build`目录下执行如下操作

``` bash
#!/bin/bash -x
VERSION=3.2.0
OS=macos
ARCH=arm64
mkdir build; cd build; cmake ..; make
cmake .. -DBUILD_SHARED_LIBS=OFF; make
mkdir gmssl-$VERSION
cd gmssl-$VERSION
mkdir bin; mkdir lib; mkdir include
cp ../bin/gmssl bin
cp -P ../bin/libgmssl* lib
cp -r ../../include/gmssl include
cd ..
tar czvf gmssl-$VERSION-$OS-$ARCH.tar.gz gmssl-$VERSION
完成编译和测试后，进行编译打包操作。

### 生成开发压缩包

对于需要打包多模式 (`Debug`, `Release`, `RelWithDebInfo`) 的 (主要为Windows平台，因为`MSVC`的`Debug`/`Release`标准库运行时独立)，可以根据以下示例进行操作。示例中脚本需要环境中存在ninja。

```shell
cmake -B build -G "Ninja Multi-Config" -DCMAKE_CONFIGURATION_TYPES="Debug;Release" -DBUILD_SHARED_LIBS=OFF -DCMAKE_DEBUG_POSTFIX="d"
cd build
cmake --build . --config Debug
cmake --build . --config Release
cpack -C "Debug;Release" # -G TGZ
```

其中`cmake .. -DBUILD_SHARED_LIBS=OFF; make`重新生成了静态库，以及和静态库连接的`gmssl`二进制程序，因此最终打包的`gmssl`命令行不依赖系统库之外的动态库。
其中指定`BUILD_SHARED_LIBS=OFF`重新生成了静态库，以及和静态库连接的`gmssl`二进制程序，因此最终打包的`gmssl`命令行不依赖系统库之外的动态库。

### 在CMake中进行依赖

GmSSL库较为简单，只需将对应头文件路径与所需链接库配置进target即可。但目前也已支持了Modern CMake的依赖方式。

假设我们将以上打包内容解压至`/path/GmSSL-3.1.2-win64`

```cmake
set(GmSSL_ROOT "/path/GmSSL-3.1.2-win64")
find_package(GmSSL REQUIRED) # required表示必须找到，否则报错

# `MyTarget` is created by `add_library` or `add_executable`
target_link_libraries(MyTarget GmSSL::GmSSL)
```
通过以上配置，即可正常使用GmSSL。
Loading