Skip to content

Latest commit

 

History

History
272 lines (212 loc) · 10.7 KB

index.adoc

File metadata and controls

272 lines (212 loc) · 10.7 KB

Master programming.
Лекция №3 (CMake)

1. Основные понятия

1.1. Артефакты сборки

  • XXX.o — объектный файл, единица компиляции

  • libXXX.a — архив объектных файлов, статическая библиотека

  • libXXX.so — динамическая библиотека, имеет тот же уровень, что и исполнимый файл

  • libXXX.so.2 — динамическая библиотека с версией. Версию обрабатывает загрузчик

  • ELF — формат представления исполняемых файлов и динамических библиотек

1.2. Зависимости реального времени

[nix-shell] % ldd /nix/store/9f89z51na7w931aja8lqlmhqny9h16cj-gnugrep-3.1/bin/grep linux-vdso.so.1 (0x00007ffc5cde0000) libpcre.so.1 => /nix/store/pcre-8.42/lib/libpcre.so.1 (0x00007f48f3e86000) libc.so.6 => /nix/store/glibc-2.27/lib/libc.so.6 (0x00007f48f3ad2000) libpthread.so.0 => /nix/store/glibc-2.27/lib/libpthread.so.0 (0x00007f48f38b3000) /nix/store/glibc-2.27/lib/ld-linux-x86-64.so.2 => /nix/store/glibc-2.27/lib64/ld-linux-x86-64.so.2 (0x00007f48f40f8000)

  • ld-linux — загрузчик динамических библиотек

  • LD_LIBRARY_PATH — добавочные пути поиска динамических библиотек

  • rpath — добавочные пути поиска внутри ELF-файла

  • LD_PRELOAD — способ перегрузки функции динамической библиотеке

1.3. Этапы сборки программ и библиотек

  1. Препроцессинг — замена #define, #include и макросов

  2. Компиляция — получение объектного кода

  3. Архивирование (необязательно) — получение статической библиотеки

  4. Линковка — сборка всего в исполняемый файл или динамическую библиотек

1.4. Пример этапов сборки

link:images/library.dot[role=include]

2. Введение в CMake

2.1. Ссылки

2.2. Структура проекта для CMake

  • Нечто большее, чем система сборки — конфигуратор систем сборки

  • CMakeLists.txt — конфигурационные файлы CMake

  • Каждая директория может содержать CMakeLists.txt

  • Связывание с помощью add_subdirectory

  • add_library, add_executable — добавление основных целей (targets)

  • target_* — изменение свойств целей

  • add_test — добавление теста

  • export(package) — регистрирование проекта

  • include(CPack) — генерирование установочного пакета

2.3. Цели по умолчанию

  • all или просто make без целей

  • rebuild_cache — перестройка кеша (переконфигурирование)

  • clean — очистить дерево сборки от артефактов

  • test — запуск тестов

    • аналогично запуску ctest

  • install — установка собранных артефактов (используется в цели package)

  • package — создание пакета

    • аналогично запуску cpack

  • <name> — собирает отдельную цель name, созданную в CMakeLists.txt

  • help — выводит доступные цели

3. Синтаксис языка CMake

3.1. Синтаксис CMake

  • Идентификаторы переменных такие же, как в C++

  • Имена функций и макросов регистронезависимы

  • Основные структуры языка:

    • условные операторы и циклы (if, foreach)

    • функции и макросы (function, macro)

    • модули (include)

  • Точка входа — файл CMakeLists.txt

  • Режимы запуска

    • cmake <dir> — запускает <dir>/CMakeLists.txt

    • cmake -P <script> — режим скрипта

    • cmake -E <cmd> — командный режим

    • другие режимы

3.2. Переменные

  • VAL — имя переменной

  • ${VAL} — разыменование переменной, её значение

  • set(VAL "123 value") — установка значения переменной

  • set(VAL 1 2 3) === set(VAL "1;2;3") — списки

  • Значение переменных можно передавать в строке ввода:

    $ cmake -DMYVAL="value" -DMYVAL2=123 -DMYVAL3=ON

  • option(MYVAL "Опциональная переменная" ON) — может быть ON, OFF

  • $ENV{HOME} — доступ к переменным окружения

  • Важные переменные: CMAKE_PREFIX_PATH, CMAKE_PROGRAM_PATH, CMAKE_TOOLCHAIN_FILE

  • Стандартные переменные: CMAKE_SOURCE_DIR, CMAKE_CURRENT_SOURCE_DIR, CMAKE_BINARY_DIR, CMAKE_CURRENT_BINARY_DIR, CMAKE_CURRENT_LIST_DIR

4. Примеры

4.1. MWE (Minimal Workable Example)

cmake_minimum_required(VERSION 3.9) project(example VERSION 0.1.0 LANGUAGES CXX DESCRIPTION "la-la-la") set(CMAKE_CXX_STANDARD 17) include(CTest) file(GLOB SOURCES src/*.cpp) add_library(unit STATIC ${SOURCES}) # libunit.a target_include_directories(unit PUBLIC include) add_executable(example app/main.cpp) target_link_libraries(example PUBLIC unit m dl) add_test(NAME simple_test COMMAND example --filter sim --dir /tmp) set_tests_properties(simple_test PROPERTIES PASS_REGULAR_EXPRESSION "hello world")

4.2. Пример создания пакета

include(GNUInstallDirs) install(DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) install(TARGETS example unit RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} ) list(APPEND CPACK_GENERATOR TGZ) set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR}) set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR}) set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH}) set(CPACK_SYSTEM_NAME ${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR}) set(CPACK_PACKAGE_CONTACT "MIET") set(CPACK_DEBIAN_PACKAGE_DEPENDS "libfuse3 (>= 3.2.0)") include(CPack)

5. Связывание проектов

5.1. Экспорты

  • Связывание проектов можно осуществить с помощью экспорта целей

  • find_package позволяет осуществить подключение сторонних целей

  • В CMake есть локальный реестр пакетов (~/.cmake/packages)

  • С помощью find_package и CMAKE_MODULE_PATH можно экспортировать существующие библиотеки

5.2. Install-дерево и export

target_include_directories(unit PUBLIC $<INSTALL_INTERFACE:include> $<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/include>) install(TARGETS example unit EXPORT ${PROJECT_NAME}-config RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} ) install(EXPORT ${PROJECT_NAME}-config NAMESPACE my:: DESTINATION ${CMAKE_INSTALL_DATADIR}/cmake/${PROJECT_NAME}) export(TARGETS example unit NAMESPACE my:: FILE ${PROJECT_NAME}-config.cmake) export(PACKAGE ${PROJECT_NAME})

  • Локальное дерево сборки:

    • export(TARGETS …​) — создание экспорт-файла в дереве сборки

    • export(PACKAGE …​) — создание ссылки в локальном реестре на каталог сборки

  • Install-дерево:

    • install(TARGETS …​ EXPORT …​) — прописывание целей в экспорте

    • install(EXPORT …​) — установка экспорт-файла

5.3. Использование в стороннем проекте

find_package(example REQUIRED) add_executable(myprog ${SRCS}) target_link_libraries(myprog my::unit)

Если проект example установлен по нестандартному пути /path/to/example, его можно указать в переменной окружения CMAKE_PREFIX_PATH:

$ export CMAKE_PREFIX_PATH+=:/path/to/example

5.4. Экспорты для сторонних библиотек

# Файл cmake/FindFuse.cmake find_path(FUSE_INC fuse3/fuse.h) find_library(FUSE_LIBS fuse3) add_library(Fuse::fuse3 INTERFACE IMPORTED) set_target_properties(Fuse::fuse3 PROPERTIES INTERFACE_LINK_LIBRARIES ${FUSE_LIBS} INTERFACE_INCLUDE_DIRECTORIES ${FUSE_INC} )
Использование
list(APPNED CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake) #list(APPEND CMAKE_MODULE_PATH $ENV{CMAKE_MODULE_PATH}) find_package(Fuse REQUIRED) target_link_libraries(myprog PUBLIC Fuse::fuse3)

6. Дополнительная функциональность

6.1. Подкаталоги

  • add_subdirectory — добавление каталога, в котором есть CMakeLists.txt

  • Таргеты из других каталогов всегда read-only

  • install можно сделать только в той же директории, где находится таргет

cmake_minimum_required(VERSION 3.9) project(example CXX) file(GLOB SRCS src/*cpp) add_library(unit ${SRCS}) add_subdirectory(tests)
# tests/CMakeLists.txt add_executable(testengine main.cpp) target_link_libraries(testengine unit) add_test(first testengine -i one) add_test(second testengine -i two) add_test(third testengine -i three)

6.2. Тесты

  • Добавление теста: add_test(NAME name COMMAND cmd args)

  • Добавление параметров тестирования set_tests_properties

    • возможности test suite (FIXTURES_SETUP/REQUIRED/CLEANUP)

    • установка переменных окружения (ENVIRONMENT)

  • Успешность теста — возвращаемое значение команды

  • Аналог команды expect из linux

close