CMake는 Kitware에서 개발하고 있으며, cmake.org에서 학습하고 다운로드 할 수 있습니다. 전통적인 C/C++ 빌드 도구는 make입니다. make는 Makefile을 작성해 주어야 하는데, Makefile 작성시 의존관계를 개발자가 직접 기술해야 하며, 개발자는 정확한 의존성을 위해 소스코드를 들여다보며 많은 노동을 투입하여 작성해야 합니다. Makefile 작성시 실수로 의존관계를 빠뜨리면 변경이 업데이트 되지 않거나, 컴파일 오류나 런타임 오류가 발생하기도 합니다. 특히 런타임 오류는 그 원인을 파악하기도 어렵습니다. make 사용시 clean 구성을 자주 사용하기도 하는 이유기도 합니다. CMake는 소스파일을 파싱하여 의존관계를 파악하여 자동으로 Makefile들이 작성되도록 돕는 것이 1차 목표 입니다.
CMake를 사용하는 것은 cmake에 의해 CMakeLists.txt를 파싱하거나 Makefile을 생성하는 구성(Configure) 단계와, make에 의한 빌드 (Build) 단계로 나눠 볼 수 있습니다.
구성단계는 CMakeLists.txt를 파싱하고 실행하여 Makefile 이나 Ninja, vsproj등을 생성하는 단계이며, 이 파일들을 자동으로 구성하는 것이 cmake의 기본 목표 입니다. 이 글은 Makefile만을 구성하는 과정을 다룹니다.
빌드를 하면 많은 중간 파일들이 생성됩니다. 이 중간 파일들이 프로젝트 소스 파일과 섞이는 것을 막기 위해, 별도의 폴더를 만들고, 빌드를 합니다. 프로젝드 폴더에 build폴더를 만들고, 프로젝트 경로를 지정하여 빌드하는 것이 일반적입니다.
cd project_dir
mkdir build
cmake ..
make
sudo make install그런데 저는 build폴더가 프로젝트와 섞이는게 싫어서 별도의 경로에 빌드 합니다.
mkdir project_dir.build
cd project_dir.build
cmake project_dir
make
sudo make installCMake는 Configure와 Generate 2단계로 구성 됩니다.
기본적으로 make를 위해 아래처럼 명령합니다.
cd project_dir
mkdir build
cmake ..
또는
mkdir building_path
cd building_path
cmake project_path
cmake ..이글의 주제는 아니지만 참고로 다른 빌드 시스템을 위한 cmake 옵션은 다음과 같습니다.
Visual Studio
cmake ./project_path/ -G "visual Studio 15 2017 Win64"Unix/Linux Ninja
cmake ./project_path/ -G NinjaXCode
cmake ./project_path/ -G XCodebuild 단계는 다른 외부 도구를 사용합니다. Makefile을 생성하였으면 make를 실행 합니다.
makesudo make install기본적으로 4 가지 변종을 지원하며, 필요시 사용자 정의 변종을 정의할 수 있습니다.
- Debug: 디버깅을 위한 빌드.
- Release: 배포를 위한 빌드.
- RelWithDebInfo: 배포를 위한 빌드이지만 디버깅 정보 포함.
- MinSizeRel: 배포를 위한 빌드인데 최소 크기로 최적화.
선택한 변종에 따라 컴파일 및 링크 옵션은 추가 합니다. 빌드 목적별로 빌드 스크립트를 각각 따로 작성하는 수고들 덜어 줍니다.
CMake는 별도로 지정하지 않는다면 프로젝트 폴더 내에 있는 CMakeLists.txt파일을 파싱하고 실행 합니다.
- cmake 명령과 변수이름은 대소문자를 구분하지 않습니다.
- 내장 상수는 반드시 대문자입니다.
- 파일이름은 각 운영체제 기준을 따릅니다. Windows는 구분하지 않으며, Unix나 Unix Link 운영체제는 대소문자를 구분합니다.
이 예제에서는 소문자로 표시한 스크립트는 대문자나 소문자로 작성할 수 있습니다. 대문자로 표시한 스크립트는 반드시 대문자로 작성해야 합니다.
예를 들어
project(my_project)이렇게 소문자로 작성하였으면,
PROJECT(my_project)아래 STATIC처럼 대문자로 표시한 스크립트는 반드시 대문자만으로 기술해야 합니다.
add_library(my_lib STATIC ${source})# 주석은 #문자로 지정합니다.cmake_minimum_required(VERSION 3.10)이 cmake 스크립트는 3.10 이상 버전의 cmake를 필요로 합니다.
프로젝트의 이름을 지정합니다.
project(my_project)프로젝트에서 언어와 버전을 지정할 수도 있습니다.
prject(my_project LANGUAGE CXX VERSION 1.2.3)set(my_variable value)set 명령으로 변수이름과 값을 지정합니다.
${my_variable}${}안에 변수이름을 넣으면 변수의 그 값을 참조할 수 있습니다.
예를 들어 파일이름 목록을 SOURCE라는 변수에 넣고 다른 명령에서 참조 하겠습니다.
set (SOURCE file1.c file2.cpp ...)이 SOURCE 변수에 있는 파일 이름들을 add_library()라는 명령에 전달 합니다.
set (SOURCE file1.c file2.cpp ...)
add_library(${PROJECT_NAME} SHARED ${SOURCE})set (CMAKE_VERBOSE_MAKEFILE true/false)CMAKE_VERBOSE_MAKEFILE라는 내장 변수에 true를 지정하면 Makefile을 구성하는 단계에서 이 모든 출력 메시지들을 표시하도록 Makefile을 생성합니다. 빠른 문제 해결을 위해 이 변수의 값은 기본적으로 켜는 것이 좋습니다.
컴파일러의 경로를 CMAKE_C_COMPILER 내장 변수에 지정합니다.
set(CMAKE_C_COMPILER c_compiler_path)C/C++ 컴파일러의 옵션을 지정 합니다.
add_compile_options(-g -Wall ... )CMAKE_C_FLAGS_빌드구성이라는 내장 변수에 C 컴파일 플래그(옵션)을 지정합니다.
set(CMAKE_C_FLAGS_빌드구성 ...)로 지정합니다. 다음은 Release구성을 위한 C 컴파일 옵션을 지정 합니다.
set(CMAKE_C_FLAGS_RELEASE "-DMY_DEFINE 3 -DYOUR_DEFINE 4" ...)옵션이 여러개인 경우 " "로 감싸 주어야 합니다.
C 컴파일러 옵션 -D에 해당 합니다.
add_definitions(-Dmy_define=value -Dyour_define=value -Dhis_define=value ...)C 컴파일러 옵션 -I에 해당 합니다.
include_directories(my_include_directory your_include_directory his_include_directory ...)링크 옵션중 -L에 해당 합니다.
link_directories(my_lib_dir your_lib_dir ...)링크 옵션중 -l에 해당 합니다.
link_libraries(mine yours his her ...)이 명령 인자들을 -에서 시작하도록 하여 직접 링크 옵션을 지정할 수도 있습니다.
link_libraries(libmine libyours libhis libher -static ...)여기서 -static을 지정하여 공유 라이브러리를 사용하지 않도록 지정 하였습니다.
CMAKE_EXE_LINKER_FLAGS_빌드구성이라는 내장 변수에 구성별 링크 옵션을 지정합니다.
set(CMAKE_EXE_LINKER_FLAGS_빌드구성 ...)set(CMAKE_EXE_LINKER_FLAGS_DEBUG "-DCONFIG_DEBUG -Wl,-whole-archive")옵션이 여러개인경우 " "로 감싸 주어야 합니다.
내장 변수 RUNTIME_OUTPUT_DIRECTORY에 빌드 완료한 실행 바이너리를 저장할 디렉토리를 지정합니다.
set(RUNTIME_OUTPUT_DIRECTORY output/bin )내장 변수 LIBRARY_OUTPUT_DIRECTORY에 빌드 완료한 실행 바이너리를 저장할 디렉토리를 지정합니다.
set(LIBRARY_OUTPUT_DIRECTORY my_lib_output_path)빌드 완료한 static 라이브러리를 저장할 디렉토리를 지정합니다.
set(ARCHIVE_OUTPUT_DIRECTORY my_archive_output_path)add_executable(my_executable main.cpp data.cpp network.cppp ...)add_library(my_lib main.cpp data.cpp network.cpp ...)add_library(my_lib STATIC main.cpp data.cpp network.cpp ...)add_library(my_lib SHARED main.cpp data.cpp network.cpp ...)add_custom_target(my_target ...)예) 다음 구문은 ESP8266 프로젝트에서 생성한 바이너리(app.bin)를 Flashing하기 위한 make flash 매크로를 정의합니다.
add_custom_target ( flash
COMMENT "Flashing binary"
WORKING_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
COMMAND python esptool.py write_flash app.bin
DEPENDS app.out
)add_executable, add_library, add_custom_target 명령으로 정의한 타겟들간의 의존성을 정의 합니다.
add_dependencies(my_taget your_target his_target ...)my_target은 your_target과 his_target에 의존하게 됩니다.
`ADD_DEPENDENCIES ( flash app.out )`타겟이 다수이고 타겟별로 빌드 옵션을 지정할 경우 사용합니다.
target_compile_options(my_target PUBLIC option1 option2 option3 ... )여기서 PUBLIC은 전역 컴파일 옵션입니다. 이외에 INTERFACE, PRIVATE가 있습니다.
target_compile_definitions(my_target PUBLIC macro1 macro2=value macro3=value ...)컴파일러에 -D 옵션을 추가한것과 같습니다. add_definition()과 달리 -D로 시작 하지 않습니다.
target_include_directories(my_target PUBLIC include_dir1 include_dir2 ...)target_link_libraries(my_target PUBLIC lib_dir1 lib_dir2 ...)변수의 값을 참조하여 템플릿 파일의 일부를 치환하여 파일을 출력 합니다.
configure_file(template_filename output_filename)템플릿 파일은 $variable$ 또는 @variable@으로 변수이름을 지정합니다.
예를 들어 다음과 같은 템플릿 파일 version.h.in이 있습니다.
#define __VERSION__ "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}.${VERSION_TWEAK}"그리고 CMakeLists.txt에 다음 변수들이 정의되어 있습니다.
set(VERSION_MAJOR 1)
set(VERSION_MINOR 0)
set(VERSION_PATCH 45)
set(VERSION_TWEAK 32)그러면 version.h는 아래와 같이 출력됩니다.
#define __VERSION__ "1.0.45.32"add_custom_command(
OUTPUT output_file_list
[COMMENT output_message]
[DEPENDS dependency_list]
[WORKING_DIRECTORY working_directory]
COMMAND command
[COMMAND command]
...
)다음은 파이썬을 실행하여 아이콘 파일을 생성합니다.
add_custom_command(
OUTPUT app.ico
COMMENT "Generating app.ico file"
DEPENDS app_icon.png
COMMAND python myicon.py app.ico app_icon.png
)add_custom_command(
TARGET target_name
PRE_BUILD|PRE_LINK|POST_BUILD 중 선택
[COMMENT output_message]
[WORKING_DIRECTORY working_directory]
COMMAND command
[COMMAND command]
...
)PRE_BUILD|PRE_LINK|POST_BUILD중 하나를 선택하는 옵션이 있습니다. 빌드전, 링크전, 빌드 후 실행할 명령을 지정 합니다.
서브 디렉토리에는 별도의 CMakeLists.txt파일이 존재해야 합니다.
add_subdirectory(my_subdirectory)현재 디렉토리의 하위 디렉토리가 아니라면 빌드 디렉토리를 지정해야 합니다.
add_subdirectory(../other_directory/subdirectory ./build/other_subdirectory)message는 구성 단계에 콘솔에 메시지나 변수를 표시합니다.
message(type message)type은 다음중 하나이며, 생략 할 수 있습니다.
STATUS: 상태 메시지이며 메시지 앞에--가 추가되어 표시 됩니다.WARNING: 경고 메시지이며, 구성을 계속 진행 합니다.AUTHOR_WARNING: 프로젝트 개발자용 경고 메시지이며, 구성을 계속 진행 합니다.SEND_ERROR: 오류 메시지를 출력하고, 계속 진행 하지만,Makefile은 생성하지 않습니다.FATAL_ERROR: 오류 메시지를 출력하고, 구성을 즉시 중단 합니다.type이 없으면 중요한 정보임을 나타내며, 구성을 계속 진행 합니다.
make 중에 메시지를 표시하려면, add_custom_command()명령으로 Makefile에 메시지를 추가해야 합니다.
make install
을 하였을때 수행할 동작을 정의 합니다.
install(TARGETS target_list
RUNTIME DESTINATION bin_file_installation_path
LIBRARY DESTINATION lib_file_installation_path
ARCHIVE DESTINATION archive_file_installation_path
)설치 경로가 동일하다면 아래처럼 간단히 정의 할 수 있습니다.
install(TARGETS target_list DESTINATION installation_path)다음 예제는 타겟을 /usr/local에 설치 합니다.
install(TARGETS target1 target2
RUNTIME_DESTINATION /usr/local/bin
ARCHIVE_DESTINATION /usr/local/lib
)내장 변수 CMAKE_INSTALL_PREFIX에 install() 명령에서 사용할 기본 경로를 지정합니다. 지정하지 않으면 기본 값은 /usr/local 입니다.
다음은 예제는
install(TARGETS target1 target2
RUNTIME_DESTINATION /usr/world/bin
ARCHIVE_DESTINATION /usr/world/lib
)다음처럼 기술 할수 있습니다.
set(CMAKE_INSTALL_PREFIX /usr/world)