Cmake实战指南

├── arch
├── cfg
├── doc
├── drivers
├── fs
├── include
├── kernel
├── library
├── sample
└── utils

├── CMakeLists.txt
├── arch
│   └── CMakeLists.txt
├── cfg
│   └── CMakeLists.txt
├── doc
│   └── CMakeLists.txt
├── drivers
│   └── CMakeLists.txt
├── fs
│   └── CMakeLists.txt
├── include
├── kernel
│   └── CMakeLists.txt
├── library
│   └── CMakeLists.txt
├── sample
│   └── CMakeLists.txt
└── utils
└── CMakeLists.txt
├── cmake
├── build

#cmake最低版本要求
cmake_minimum_required(VERSION 3.10.0)

#项目名字为test
project(test NONE)

#包含通用的编译环境模块到顶层目录
include(${CMAKE_SOURCE_DIR}/cmake/base.cmake)

#下一级的编译目录
add_subdirectory(arch)
add_subdirectory(cfg)
add_subdirectory(doc)
add_subdirectory(drivers)
add_subdirectory(fs)
add_subdirectory(kernel)
add_subdirectory(library)
add_subdirectory(sample)
add_subdirectory(utils)

cd build && cmake .. && make

#定义一个mytool 可执行程序输出目标，目前只有一个源文件  mytool.cpp
add_executable(mytool mytool.cpp)

#往mytool可执行程序输出目标添加源文件，现在mytool目标里面包含两个源文件
target_sources(mytool  PRIVATE mytool2.cpp)

#定义一个动态库archive 输出目标，文件有三个源文件
add_library(archive SHARED archive.cpp zip.cpp lzma.cpp)

#定义一个静态库archive 输出目标，也可以不指定STATIC 因为add_library默认输出目标是#静态库
add_library(archive STATIC archive.cpp zip.cpp lzma.cpp)

#从给出的源文件直接生成object文件，比如linux下C语言的.o文件
add_library(archive OBJECT archive.cpp zip.cpp lzma.cpp)

# gcc头文件查找目录，相当于-I选项，e.g -I/foo/bar
#CMAKE_SOURCE_DIR是cmake内置变量表示当前项目根目录
target_include_directories(test_elf
    PRIVATE
    ${CMAKE_SOURCE_DIR}
    ${CMAKE_SOURCE_DIR}/common
    ${CMAKE_SOURCE_DIR}/syscalls
)

# 编译的宏定义，e.g 相当于-D选项 e.g -Dmacro=defn
set(MONITOR_OMIT_BSS_INIT      "0")
set(MONITOR_OMIT_DATA_INIT     "0")
set(MONITOR_OMIT_T_CHECKS      "0")
target_compile_definitions(test_elf
    PRIVATE
    MONITOR_OMIT_BSS_INIT=${MONITOR_OMIT_BSS_INIT}              
    MONITOR_OMIT_DATA_INIT=${MONITOR_OMIT_DATA_INIT}            
    MONITOR_TRAP_NT_IRQS=${MONITOR_TRAP_NT_IRQS}                          
)

# 其他编译选项定义，e.g -fPIC
target_compile_options(test_elf
    PRIVATE
    -std=c99 
    -Wall 
    -Wextra 
    -Werror
)

# 链接选项设置
target_link_libraries(test_elf
    PRIVATE
    -msoft-float 
    -static 
    -nostdlib
)

#设置链接的标准路径的库
target_link_libraries(test_elf PRIVATE gcc)

#设置链接的本project自己输出的目标库libkernel.a
target_link_libraries(test_elf PRIVATE kernel)

#设置链接非标准路径中别人编译好的库
target_link_libraries(test_elf 
PRIVATE 
$ENV{HOME}/lib/libtest.a
)

add_library(archive archive.cpp)
target_compile_definitions(archive INTERFACE USING_ARCHIVE_LIB)

add_library(serialization serialization.cpp)
target_compile_definitions(serialization INTERFACE USING_SERIALIZATION_LIB)

add_library(archiveExtras extras.cpp)
target_link_libraries(archiveExtras PUBLIC archive)
target_link_libraries(archiveExtras PRIVATE serialization)
# archiveExtras is compiled with -DUSING_ARCHIVE_LIB
# and -DUSING_SERIALIZATION_LIB

add_executable(consumer consumer.cpp)
# consumer is compiled with -DUSING_ARCHIVE_LIB
target_link_libraries(consumer archiveExtras)

#在test_elf链接之前，先拷贝一些test_elf需要用到的文件到编译目录，在进行编译
add_custom_command(TARGET test_elf PRE_LINK
COMMAND
cp ${CMAKE_BINARY_DIR}/cfg/start.o ${CMAKE_BINARY_DIR}/. && 
cp ${CMAKE_SOURCE_DIR}/target/imx6_gcc/imx6.ld ${CMAKE_BINARY_DIR}/.
)

#把编译输出的test_elf进行进一步处理，生成最终的bin文件
add_custom_command(TARGET test_elf POST_BUILD
    COMMAND ${CUSTOM_CMD_OBJCOPY} -O binary -S test_elf test_elf.bin
)

#先为这个第三方工具设置一个自定义目标，这个目标并没有实际输出文件，
#只是一个目标的名字比如这边的autoconfig 
add_custom_target(autoconfig ALL)
#利用这个目标去运行这个第三方工具，这边是cfg，后面是这个工具需要的参数
add_custom_command(TARGET autoconfig PRE_BUILD
COMMAND 
cfg --pass ${pass} ${CFG_ELF_INCLUDE} ${rom_image} ${symbol_table} ${T_file} ${CFG_TABLES}
)   

#autoconfig和test_elf这两目标，没有直接的关系（像前面介绍的可执行程序，可能依赖其#他库输出目标，这里没有这样的关系），需要指定目标输出顺序，先对autoconfig进行输
#出（自动生成源码），在进行test_elf输出（编译和链接）
add_dependencies(test_elf autoconfig)

#把自动生成的源文件cfg_out.c加到test_elf目标去编译
target_sources(test_elf  PRIVATE cfg_out.c)
#指明cfg_out.c是自动生成的文件，否则会认为找不到文件而出错
set_source_files_properties(cfg_out.c PROPERTIES GENERATED 1)

#支持的编程语言配置
enable_language(ASM)

#设置汇编源文件的编译器，我这边配置成和C语言的编译器一样
set(CMAKE_ASM_COMPILER ${CMAKE_C_COMPILER})

#把汇编源码和C源码一起放置在待编译的源文件列表里面就行
set(SRC_KERNEL_LIB
    ${CMAKE_SOURCE_DIR}/target/imx6_gcc/target_support.S
    ${CMAKE_SOURCE_DIR}/arch/arm_gcc/mpcore/chip_support.S
    ${CMAKE_SOURCE_DIR}/arch/arm_gcc/common/core_support.S
    ${CMAKE_SOURCE_DIR}/drivers/mmu_table.c
)

#配置交叉编译变量
set(CMAKE_SYSTEM_NAME Linux)
set(CMAKE_SYSTEM_PROCESSOR arm)
set(CMAKE_CROSSCOMPILING TRUE)
#不使用动态链接 -rdyamic
set(CMAKE_SHARED_LIBRARY_LINK_C_FLAGS "") 

set(CMAKE_C_COMPILER "$ENV{CROSS_COMPILE_ROOT_PATH}/bin/$ENV{CROSS_COMPILE_PREFIX}-gcc")
set(CMAKE_ASM_COMPILER ${CMAKE_C_COMPILER})
set(CMAKE_AR "$ENV{CROSS_COMPILE_ROOT_PATH}/bin/$ENV{CROSS_COMPILE_PREFIX}-ar")
set(CMAKE_RANLIB "$ENV{CROSS_COMPILE_ROOT_PATH}/bin/$ENV{CROSS_COMPILE_PREFIX}-ranlib")
set(CUSTOM_CMD_OBJCOPY "$ENV{CROSS_COMPILE_ROOT_PATH}/bin/$ENV{CROSS_COMPILE_PREFIX}-objcopy")
set(CUSTOM_CMD_NM "$ENV{CROSS_COMPILE_ROOT_PATH}/bin/$ENV{CROSS_COMPILE_PREFIX}-nm") 

set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)
set(CMAKE_FIND_ROOT_PATH $ENV{CROSS_COMPILE_ROOT_PATH})

#编译C源文件
if(NOT CMAKE_C_COMPILE_OBJECT)
  set(CMAKE_C_COMPILE_OBJECT
    "<CMAKE_C_COMPILER> <DEFINES> <INCLUDES> <FLAGS> -o <OBJECT>   -c <SOURCE>")
endif()

#链接C源文件
if(NOT CMAKE_C_LINK_EXECUTABLE)
  set(CMAKE_C_LINK_EXECUTABLE
    "<CMAKE_C_COMPILER> <FLAGS> <CMAKE_C_LINK_FLAGS> <LINK_FLAGS> <OBJECTS>  -o <TARGET> <LINK_LIBRARIES>")
endif()

#静态库的链接过程
if(NOT DEFINED CMAKE_C_ARCHIVE_CREATE)
  set(CMAKE_C_ARCHIVE_CREATE "<CMAKE_AR> qc <TARGET> <LINK_FLAGS> <OBJECTS>")
endif()
if(NOT DEFINED CMAKE_C_ARCHIVE_APPEND)
  set(CMAKE_C_ARCHIVE_APPEND "<CMAKE_AR> q  <TARGET> <LINK_FLAGS> <OBJECTS>")
endif()
if(NOT DEFINED CMAKE_C_ARCHIVE_FINISH)
  set(CMAKE_C_ARCHIVE_FINISH "<CMAKE_RANLIB> <TARGET>")
endif()

#自定义的ar生成规则（cmake默认的ar打包参数和我项目源码定义参数不一样，所以自己重新定义）
set(CMAKE_STATIC_LINKER_FLAGS "-rcs")
set(CMAKE_C_ARCHIVE_CREATE "<CMAKE_AR> <LINK_FLAGS> <TARGET> <OBJECTS>")