UNITY_BUILD
Новое в версии 3.16.
При установке этого свойства в значение true, целевые исходные файлы будут объединены в пакеты для более быстрого компилирования. Это делается путём создания (набора) единых исходных файлов, #include исходных файлов, а затем компилируются эти единые исходные файлы вместо исходных. Это известно как Unity или Jumbo сборка.
CMake предоставляет различные алгоритмы для выбора исходных файлов, которые будут сгруппированы в пакет. Выбор алгоритма определяется свойством целевого объекта UNITY_BUILD_MODE, которое имеет следующие допустимые значения:
-
BATCHВ этом режиме CMake определяет, какие файлы будут сгруппированы вместе. СвойствоUNITY_BUILD_BATCH_SIZEуправляет максимальным количеством исходных файлов, которые могут быть объединены в один единый исходный файл. -
GROUPВ этом режиме каждый целевой объект явно определяет, как сгруппировать исходные файлы. Каждый исходный файл с одинаковым значением свойстваUNITY_GROUPбудет сгруппирован вместе. Любые исходные файлы, у которых этого свойства нет, будут скомпилированы по отдельности. СвойствоUNITY_BUILD_BATCH_SIZEигнорируется при использовании этого режима.
Если явно не задано значение UNITY_BUILD_MODE, CMake по умолчанию использует BATCH.
Сборка Unity в настоящее время не поддерживается для всех языков. CMake версии 3.22.6 поддерживает объединение C и CXX исходных файлов. Для целевых объектов, которые смешивают исходные файлы из более чем одного языка, CMake будет разделять языки таким образом, чтобы каждый сгенерированный единый исходный файл содержал только исходные файлы одного языка.
Это свойство инициализируется значением переменной CMAKE_UNITY_BUILD при создании целевого объекта.
Примечание
Проекты не должны напрямую устанавливать свойство UNITY_BUILD или связанную с ним переменную CMAKE_UNITY_BUILD в значение true. В зависимости от возможностей машины сборки и используемого компилятора, включение сборки Unity может быть или не быть уместным. Поэтому эта функция должна находиться под контролем разработчика, который обычно выбирает, устанавливать или нет переменную CMAKE_UNITY_BUILD в командной строке cmake(1) или некоторым другим эквивалентным способом. Однако рекомендуется установить свойство целевого объекта UNITY_BUILD в значение false, если известно, что включение сборки Unity для целевого объекта может привести к проблемам.
ODR (правило одной дефиниции) ошибки
Когда несколько исходных файлов включаются в один исходный файл, как это делается при сборке Unity, это потенциально может привести к ошибкам ODR. CMake предоставляет ряд мер для решения таких проблем:
- Любой исходный файл, у которого есть непустое свойство
COMPILE_OPTIONS,COMPILE_DEFINITIONS,COMPILE_FLAGSилиINCLUDE_DIRECTORIES, не будет объединён в единый исходный файл. - Проекты могут предотвратить объединение отдельного исходного файла в единый исходный файл, установив его свойство
SKIP_UNITY_BUILD_INCLUSIONв значение true. Это может быть более эффективным способом предотвратить проблемы со специфическими файлами, чем отключение сборки Unity для всего целевого объекта. - Проекты могут установить
UNITY_BUILD_UNIQUE_IDдля генерации допустимого идентификатора C, уникального для каждого файла в сборке Unity. Это может быть использовано для предотвращения проблем с анонимными именованными пространствами в сборках Unity. - Свойства целевого объекта
UNITY_BUILD_CODE_BEFORE_INCLUDEиUNITY_BUILD_CODE_AFTER_INCLUDEмогут быть использованы для вставки кода в единые исходные файлы до и после каждой#includeинструкции. - Порядок добавления исходных файлов в целевой объект с помощью команд, таких как
add_library(),add_executable()илиtarget_sources(), будет сохранён в сгенерированных единых исходных файлах. Это может быть использовано для ручного принуждения к определённой группировке на основе свойства целевого объектаUNITY_BUILD_BATCH_SIZE.
© 2000–2021 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.22/prop_tgt/UNITY_BUILD.html