Skip to content

Commit

Permalink
build: refactor example cmake
Browse files Browse the repository at this point in the history
  • Loading branch information
ehds committed Apr 30, 2024
1 parent 406ce3d commit bc94c6c
Show file tree
Hide file tree
Showing 15 changed files with 99 additions and 434 deletions.
10 changes: 8 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
name: ci
on: [push, pull_request]
on:
push:
branches:
- main
pull_request:
branches:
- main

permissions:
contents: read
Expand Down Expand Up @@ -66,7 +72,7 @@ jobs:
- name: Build with cmake
if: ${{ matrix.build_tool == 'cmake' }}
run: |
cmake -S "${{ github.workspace }}" -B "${{ env.CMAKE_BUILD_DIR }}" -DWITH_TESTS=ON -DWITH_COVERAGE=ON
cmake -S "${{ github.workspace }}" -B "${{ env.CMAKE_BUILD_DIR }}" -DWITH_TESTS=ON -DWITH_COVERAGE=ON -DWITH_EXAMPLES=ON
cmake --build bld --parallel 16 -- brpc-static
cmake --build "${{ env.CMAKE_BUILD_DIR }}" --parallel 16
Expand Down
27 changes: 21 additions & 6 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,17 @@ option(WITH_DEBUG_SYMBOLS "With debug symbols" ON)
# https://cmake.org/cmake/help/latest/policy/CMP0058.html
# suppress this CMP0058 warning
cmake_policy(SET CMP0058 OLD)

option(WITH_EXAMPLES "Whether to build examples" OFF)
option(WITH_TESTS "Whether to build unit tests" OFF)
option(WITH_COVERAGE "Whether build with coverage report" OFF)

set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

include(FindThreads)
include(FindProtobuf)
include(thirdparty/brpc/SetupBrpc)

set(WITH_GLOG_VAL "0")
if(BRPC_WITH_GLOG)
set(WITH_GLOG_VAL "1")
Expand All @@ -24,11 +32,13 @@ if(WITH_DEBUG_SYMBOLS)
set(DEBUG_SYMBOL "-g")
endif()

set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

include(FindThreads)
include(FindProtobuf)
include(thirdparty/brpc/SetupBrpc)
if (WITH_COVERAGE)
if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
link_libraries(gcov)
else()
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
endif()
endif()

if ((NOT BRPC_INCLUDE_PATH) OR (NOT BRPC_LIB))
message(FATAL_ERROR "Fail to find brpc")
Expand Down Expand Up @@ -233,7 +243,12 @@ add_subdirectory(src)
if(WITH_TESTS)
add_subdirectory(test)
endif()
# add_subdirectory(tools)

if(WITH_EXAMPLES)
add_subdirectory(example)
endif()

add_subdirectory(tools)

file(COPY ${CMAKE_CURRENT_BINARY_DIR}/braft/
DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/output/include/braft/
Expand Down
3 changes: 3 additions & 0 deletions example/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_subdirectory(atomic)
add_subdirectory(block)
add_subdirectory(counter)
12 changes: 10 additions & 2 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@ Brief introduction of examples:
# Build steps

```shell
example=counter|atomic|block
cd $example && cmake . && make
cmake -B build -DWITH_EXAMPLES=ON -GNinja
ninja -C build all
```

# Run Server

```sh
# example = atomic/block/server.
export example=atomic
cd build/example/${example}/
bash run_server.sh
```

Expand All @@ -30,3 +33,8 @@ bash run_client.sh
* If server_num of run_server.sh has been changed, specify run_client to make it consistent.
* Add `--log_each_request` if you want detailed information of each request.

# Stop

```sh
bash stop.sh
```
158 changes: 19 additions & 139 deletions example/atomic/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,148 +1,28 @@
cmake_minimum_required(VERSION 2.8.10)
project(atomic C CXX)

option(EXAMPLE_LINK_SO "Whether examples are linked dynamically" OFF)
option(LINK_TCMALLOC "Link tcmalloc if possible" ON)

execute_process(
COMMAND bash -c "find ${CMAKE_SOURCE_DIR}/../.. -type d -path \"*output/include/braft\" | xargs dirname | xargs dirname | tr -d '\n'"
OUTPUT_VARIABLE OUTPUT_PATH
)

set(CMAKE_PREFIX_PATH ${OUTPUT_PATH})

include(FindThreads)
include(FindProtobuf)

if (NOT PROTOBUF_PROTOC_EXECUTABLE)
get_filename_component(PROTO_LIB_DIR ${PROTOBUF_LIBRARY} DIRECTORY)
set (PROTOBUF_PROTOC_EXECUTABLE "${PROTO_LIB_DIR}/../bin/protoc")
endif()

protobuf_generate_cpp(PROTO_SRC PROTO_HEADER atomic.proto)
# include PROTO_HEADER
include_directories(${CMAKE_CURRENT_BINARY_DIR})

find_path(BRPC_INCLUDE_PATH NAMES brpc/server.h)
if(EXAMPLE_LINK_SO)
find_library(BRPC_LIB NAMES brpc)
find_library(BRAFT_LIB NAMES braft)
else()
find_library(BRPC_LIB NAMES libbrpc.a brpc)
find_library(BRAFT_LIB NAMES libbraft.a braft)
endif()

if((NOT BRPC_INCLUDE_PATH) OR (NOT BRPC_LIB))
message(FATAL_ERROR "Fail to find brpc")
endif()
include_directories(${BRPC_INCLUDE_PATH})

find_path(BRAFT_INCLUDE_PATH NAMES braft/raft.h)
if ((NOT BRAFT_INCLUDE_PATH) OR (NOT BRAFT_LIB))
message (FATAL_ERROR "Fail to find braft")
endif()
include_directories(${BRAFT_INCLUDE_PATH})

find_path(GFLAGS_INCLUDE_PATH gflags/gflags.h)
find_library(GFLAGS_LIBRARY NAMES gflags libgflags)
if((NOT GFLAGS_INCLUDE_PATH) OR (NOT GFLAGS_LIBRARY))
message(FATAL_ERROR "Fail to find gflags")
endif()
include_directories(${GFLAGS_INCLUDE_PATH})

find_path(GLOG_INCLUDE_PATH glog/logging.h)
find_library(GLOG_LIBRARY NAMES glog libglog)
if((NOT GLOG_INCLUDE_PATH) OR (NOT GLOG_LIBRARY))
message(FATAL_ERROR "Fail to find glog")
endif()
include_directories(${GLOG_INCLUDE_PATH})

execute_process(
COMMAND bash -c "grep \"namespace [_A-Za-z0-9]\\+ {\" ${GFLAGS_INCLUDE_PATH}/gflags/gflags_declare.h | head -1 | awk '{print $2}' | tr -d '\n'"
OUTPUT_VARIABLE GFLAGS_NS
)
if(${GFLAGS_NS} STREQUAL "GFLAGS_NAMESPACE")
execute_process(
COMMAND bash -c "grep \"#define GFLAGS_NAMESPACE [_A-Za-z0-9]\\+\" ${GFLAGS_INCLUDE_PATH}/gflags/gflags_declare.h | head -1 | awk '{print $3}' | tr -d '\n'"
OUTPUT_VARIABLE GFLAGS_NS
)
endif()

if (LINK_TCMALLOC)
find_path(GPERFTOOLS_INCLUDE_DIR NAMES gperftools/heap-profiler.h)
find_library(GPERFTOOLS_LIBRARIES NAMES tcmalloc_and_profiler)
if (GPERFTOOLS_INCLUDE_DIR AND GPERFTOOLS_LIBRARIES)
set(CMAKE_CXX_FLAGS "-DBRPC_ENABLE_CPU_PROFILER")
include_directories(${GPERFTOOLS_INCLUDE_DIR})
else ()
set (GPERFTOOLS_LIBRARIES "")
endif ()
endif ()

set(CMAKE_CPP_FLAGS "-DGFLAGS_NS=${GFLAGS_NS}")
set(CMAKE_CXX_FLAGS "${CMAKE_CPP_FLAGS} ${CMAKE_CXX_FLAGS} -DNDEBUG -O2 -D__const__=__unused__ -pipe -W -Wall -Wno-unused-parameter -fPIC -fno-omit-frame-pointer")
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
# require at least gcc 4.8
if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.8)
message(FATAL_ERROR "GCC is too old, please install a newer version supporting C++11")
endif()
elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
# require at least clang 3.3
if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS 3.3)
message(FATAL_ERROR "Clang is too old, please install a newer version supporting C++11")
endif()
else()
message(WARNING "You are using an unsupported compiler! Compilation has only been tested with Clang and GCC.")
endif()

if(CMAKE_VERSION VERSION_LESS "3.1.3")
if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
endif()
if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
endif()
else()
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
endif()

find_path(LEVELDB_INCLUDE_PATH NAMES leveldb/db.h)
find_library(LEVELDB_LIB NAMES leveldb)
if ((NOT LEVELDB_INCLUDE_PATH) OR (NOT LEVELDB_LIB))
message(FATAL_ERROR "Fail to find leveldb")
endif()
include_directories(${LEVELDB_INCLUDE_PATH})

add_executable(atomic_client client.cpp ${PROTO_SRC} ${PROTO_HEADER})
add_executable(atomic_server server.cpp ${PROTO_SRC} ${PROTO_HEADER})
add_executable(atomic_test test.cpp ${PROTO_SRC} ${PROTO_HEADER})

set(DYNAMIC_LIB
${CMAKE_THREAD_LIBS_INIT}
${GFLAGS_LIBRARY}
${GLOG_LIBRARY}
${PROTOBUF_LIBRARY}
${GPERFTOOLS_LIBRARIES}
${LEVELDB_LIB}
${BRAFT_LIB}
${BRPC_LIB}
rt
ssl
crypto
dl
z
)
target_link_libraries(atomic_client braft-static)
target_link_libraries(atomic_server braft-static)
target_link_libraries(atomic_test braft-static)

message("--- ${CMAKE_CURRENT_BINARY_DIR}")
message("--- ${CMAKE_CURRENT_SOURCE_DIR}")
message("--- ${CMAKE_CURRENT_LIST_DIR}")

# Copy start/stop scripts
file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/
DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/
FILES_MATCHING
PATTERN "run_client.sh"
PATTERN "run_server.sh"
PATTERN "stop.sh"
)

target_link_libraries(atomic_client
"-Xlinker \"-(\""
${DYNAMIC_LIB}
"-Xlinker \"-)\"")
target_link_libraries(atomic_server
"-Xlinker \"-(\""
${DYNAMIC_LIB}
"-Xlinker \"-)\"")
target_link_libraries(atomic_test
"-Xlinker \"-(\""
${DYNAMIC_LIB}
"-Xlinker \"-)\"")
file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/../shflags
DESTINATION ${CMAKE_CURRENT_BINARY_DIR}
)
2 changes: 1 addition & 1 deletion example/atomic/run_client.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# source shflags from current directory
mydir="${BASH_SOURCE%/*}"
if [[ ! -d "$mydir" ]]; then mydir="$PWD"; fi
. $mydir/../shflags
. $mydir/shflags


# define command-line flags
Expand Down
2 changes: 1 addition & 1 deletion example/atomic/run_server.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# source shflags from current directory
mydir="${BASH_SOURCE%/*}"
if [[ ! -d "$mydir" ]]; then mydir="$PWD"; fi
. $mydir/../shflags
. $mydir/shflags

# define command-line flags
DEFINE_string crash_on_fatal 'true' 'Crash on fatal log'
Expand Down
Loading

0 comments on commit bc94c6c

Please sign in to comment.