Ты технический писатель. Изучи текст "Конфигурируемые макросы, модули и мультимодули…
- User
Ты технический писатель. Изучи текст "Конфигурируемые макросы, модули и мультимодули Буквально все модули и мультимодули, а также подавляющее большинство макросов описаны в конфигурационных файлах build/bobmake.core.conf и файлах в директории build/conf. Там же определено множество переменных, определяющих свойства платформ, конфигураций и отдельных типов модулей.
Описание конфигурации делается на достаточно сложном декларативном DSL, позволяющем выразить:
Правила настройки (значения переменных) в зависимости от платформы и других параметров (тоже переменных); Описание макросов — их параметризацию и поведение; Шаблоны формирования сборочных команд: что, где и как надо вызывать, а также дополнительные свойства команд такие как, например, отображаемое имя или требуемые ресурсы; Входы и результаты для связывания команд в граф; Применение макросов по расширениям; Свойства модулей для связывания их с командами и между собой; Правила, относящиеся к конкретным модулям: свойства модулей и команд в них в зависимости от платформы и других параметров; Варианты мультимодулей и их связывание по зависимостям. Подробная информация по конфигурированию системы сборки и описанию своих модулей и макросов будет в разделе для разработчиков (TBD). Ниже лишь краткая информация, необходимая для более полного понимания того, что происходит в bob.make.
Правила Peerdir Policy Для упрощения отслеживания все такие ограничения хранятся централизованно в директории build/rules. При попытке сделать запрещённый PEERDIR система сборки выдаст configure-ошибку
PEERDIR from S/vendor/github.com/sirupsen/logrus is prohibited, ignored` При этом PEERDIR будет полностью проигнорирован, что в большинстве случаев приведёт к ошибкам сборки и/или исполнения тестов. Актуальный список файлов с правилами задаётся переменной PEERDIRS_RULES_PATH в bobmake.core.conf
Глобальные переменные Введение про переменные.
При описании модуля можно сделать часть переменных глобальными. Для этого нужно использовать свойство .GLOBAL у модуля. При работе с глобальной переменной нужно добавить суффикс _GLOBAL к указанному имени.
module MY_MOD { .CMD=builder --list ANOTHER_VAR_GLOBAL .GLOBAL=MY_VAR ANOTHER_VAR ...
SET(MY_VAR_GLOBAL $MODDIR) SET(ANOTHER_VAR_GLOBAL VERBOSE)} При конфигурации модуля глобальные переменные ведут себя как и локальные. Из них можно получить только то значение, которое было установлено в текущем модуле.
Однако во время рендера глобальная переменная разворачивается в список всех значений, установленных пирами текущего модуля. Порядок значений определяется обратным порядком обхода графа. Т.е. значения из корневых узлов будут в конце списка, а из листовых - в начале.
Для примера рассмотрим такой граф, все модули которого - MY_MOD из примера выше:
┌─────► lib-mid1──────┐ │ ▼ main lib-leaf │ ▲ └─────► lib-mid2──────┘ При построении графа для main получим такие сборочные команды:
lib-leaf
builder --list lib-leaf --extra VERBOSE
lib-mid1
builder --list lib-leaf lib-mid1 --extra VERBOSE VERBOSE
lib-mid2
builder --list lib-leaf lib-mid2 --extra VERBOSE VERBOSE
main
builder --list lib-leaf lib-mid1 lib-mid2 main --extra VERBOSE VERBOSE VERBOSE VERBOSE
Как уже отмечалось выше, разворачивание глобальных переменных происходит уже во время рендера. Это означает, что попытки использовать модификаторы input и output на глобальной переменной не приведет к желаемому результату - дополнительные ребра в графе не добавятся. Однако, таким образом получится собрать строковые списки или даже список нодовых ресурсов (например, {pre=arc/;suf=/bin:MY_VAR_GLOBAL}).
Найти пример глобальных переменных в аркадии и посмотреть на их использование можно тут.
Также в сборке есть предопределенные глобальные переменные:
-
PEERS
-
Глобальные ресурсы Для глобальных ресурсов действуют немного другие правила. Если глобальный ресурс определяется в нескольких модулях, то все определения обязаны быть одинаковыми. Если объявления ресурса в разных модулях будет отличаться, это приведет к ошибке конфигурации. Для глобальных ресурсов рендерится только одно значение (повторные объявления игнорируются).
-
INCLUDE по языкам
Правила системных заголовков [sysincl] Системные заголовки - заголовки, которые могут браться при сборке не из Аркадии, а доставляются в сборку через ресурсы. Соответственно их не нужно учитывать при определении зависимостей.
Первая проблема с такими заголовками в том, что в зависимости от платформы они могут браться и из Аркадии. Например, при сборке с системной libc ее заголовки привозятся в сборку вместе c os sdk, а при сборке с musl лежат в Аркадии. Аналогично со стандартной библиотекой c++. Для поддержки такого системные заголовки перечислены в конфигах в build/sysincl. Эти конфиги включаются в зависимости от сборочных переменных платформы в build/bobmake.core.conf.
Пример такого конфига:
-
includes:
- sys/queue.h
- errno.h:
- contrib/libs/cxxsupp/libcxx/include/errno.h
- contrib/libs/musl-1.1.20/include/errno.h
-
source_filter: "^contrib/libs/libevent"
- sys/queue.h: contrib/libs/libevent/compat/sys/queue.h
-
case_sensitive: false includes:
- winsock.h Конфиг определяет как должна резолвится строка из #include при определённых условиях. Возможные варианты:
#include должен игнорироваться (соответствующего файла нет в Аркадии). #include означает зависимость на один или несколько файлов в Аркадии (путь указывается от корня дерева исходного кода). Зависимость от нескольких файлах отражает неоднозначность резолвинга: в разных случаях #include означает один из перечисленных вариантов. source_filter позволяет задать регулярное выражение на имя файла, в котором написан #include. Если он указан, то правило будет действовать только на #include, написанные в файлах, удовлетворяющих выражению. case_sensitive: false означает, что правила (строки для #include) должны трактоваться без учёта регистра. Такое бывает нужно для стандартных хедеров Windows. Вторая проблема, что в даже рамках одной платформы они могут резолвиться в несколько мест в Аркадии. Например stdint.h есть как в musl, так и в libc++. Чтобы избежать неоднозначности (резолвим мы однократно) мы явно выписываем все возможные варианты в конфигах системных заголовков и консервативно считаем, что зависимость есть от всех. Чтобы такие размноженные зависимости не расползались, применение правил для системных заголовков можно ограничить регулярным выражением в source_filter. Если для инклуда возможно применение нескольких правил, то их результаты суммируются.
Глобальная фиксация версий библиотек Глобальная жесткая фиксация версий библиотек производится в глобальной переменной _FORCED_DEPENDENCY_MANAGEMENT_VALUE, эту фиксацию версий нельзя обойти с помощью макроса DEPENDENCY_MANAGEMENT
Объявление глобальной фиксации версий библиотек в bobmake.core.conf производится в формате:
_FORCED_DEPENDENCY_MANAGEMENT_VALUE=
path/to/lib1/1.1
path/to/lib2/2.5
... При этом использование библиотек в bob.make выглядит так:PEERDIR( path/to/lib1 path/to/lib2 ... ) При сборке автоматически будут подставлены path/to/lib1/1.1 и path/to/lib2/2.5 вместо указанных path/to/lib1 и path/to/lib2
Запрет альтернативных версий Версия некоторых библиотек жёстко зафиксирована глобально. В данный момент запрет на альтернативные версии введён для:
contrib/java/com/google/flatbuffers/flatbuffers-java (всех версий, отличных от {JAVA_PROTO_RUNTIME_VERSION}) contrib/java/com/google/protobuf/protobuf-javalite (всех версий, отличных от {JAVA_PROTO_RUNTIME_VERSION}) Версии данных библиотек контролируются через «подковёрный» DEPENDENCY_MANAGEMENT в bobmake.core.conf Для исправления ошибки сборки forbids direct or indirect PEERDIR dependency to module, нужно удалить пользовательский DEPENDENCY_MANAGEMENT, управляющий версиями указанных в сообщении библиотек.
LICENSE LICENSE(license...) Указывает лицензию текущего модуля. Позволяет указать SPDX выражение описывающее лицензию модуля. По умолчанию модули, не прописавшие свою лицензию через макрос LICENSE имеют лицензию, заданную переменной DEFAULT_MODULE_LICENSE в bobmake.core.conf
Для каждой отдельной лицензии используемой в выражении имени лицензии должны быть описаны её свойства в файле bobmake.core.conf с помощью служебных переменных LICENSE_PROPERTIES, LICENSES_<PROP_NAME>STATIC, LICENSES<PROP_NAME>DYNAMIC или LICENSES<PROP_NAME>. Лицензия, для которой не описаны её свойства считается неизвестной и её использование в макросе LICENSE диагностируется как ошибка конфигурации.
Из за синтаксических ограничений bob.make, при писпользвоании скобок в SPDX выражении, нужно заключить выражение или его часть использующую скобки в кавычки.
DEFAULT_MODULE_LICENSE Имя лицензии используемой по умолчанию для модулей, не указавших свою лицензию явно через макрос LICENSE. Переменная не может быть переопределена в модуле, лицензия по умолчанию задаётся на всю аркадию в bobmake.core.conf.
UnkStatm Ошибка UnkStatm выдаётся в том случае, когда в файле описании сборки проекта bob.make есть вызов неизвестного макроса. Макросы, которые можно использовать в сборке, описаны в build/bobmake.core.conf или в плагинах build/plugins, а также внутренние макросы реализованные в коде bobmake (описание таких макросов можно найти здесь). ". Напиши для чего нужен файл bobmake.core.conf
-
- Assistant
Файл
bobmake.core.confиграет ключевую роль в системе сборки Bobmake. Он служит основным конфигурационным файлом, в котором описаны важнейшие элементы, правила и переменные, управляющие процессом сборки и конфигураций модулей в проекте. Ниже приведены основные задачи, которые выполняет файлbobmake.core.conf:1. Определение переменных и их значений
Файл задает множество переменных, которые используются для управления различными аспектами сборочного процесса. Это включает в себя глобальные переменные, специфические для платформы и конфигурации, а также переменные, регулирующие поведение отдельных типов модулей. Например, переменная
PEERDIRS_RULES_PATHуказывает на актуальный список файлов с правилами, которые определяются в соответствии с директориями.2. Правила настройки и поведения макросов
Конфигурационный файл описывает правила настройки переменных в зависимости от платформы и других условий. Также здесь определяются и описываются макросы, их параметры и поведение. Это позволяет гибко управлять процессом сборки в зависимости от различных факторов.
3. Шаблоны формирования сборочных команд
Файл содержит шаблоны, описывающие, какие команды необходимо вызывать, где и как это делать, а также дополнительные свойства этих команд. В этом разделе можно определить отображаемое имя команды, требуемые ресурсы и другие атрибуты.
4. Связывание команд и модулей
В
bobmake.core.confопределены входы и результаты для связывания команд в граф зависимостей, а также свойства модулей и правила их связывания с командами и между собой. Это помогает организовать процесс сборки в виде графа зависимости, что позволяет строго контролировать порядок и условия выполнения различных задач.5. Подключение системных заголовков
Файл управляет включением системных заголовков, которые могут быть получены не из Аркадии, а через ресурсы. Он позволяет учитывать специфику различных платформ и контролировать, откуда должны быть взяты те или иные заголовки.
6. Фиксация версий библиотек
Здесь устанавливаются глобальные жесткие фиксации версий библиотек и правила запрета на использование альтернативных версий. Это критически важно для контроля зависимости и предотвращения конфликтов версий в проекте.
7. Управление лицензиями
Файл также позволяет управлять лицензиями модулей. Макрос
LICENSEвbobmake.core.confуказывает лицензию для каждого модуля по умолчанию и определяет свойства каждой из лицензий, которые могут быть использованы в проекте.8. Обработка ошибок
Файл определяет трактовку различных ошибок конфигурации, таких как
UnkStatm, которая указывает на использование неизвестного макроса в сборочном процессе. Это помогает разработчикам быстро диагностировать и исправлять ошибки в конфигурациях сборки.Таким образом, файл
bobmake.core.confявляется основным и центральным элементом конфигурационного управления в системе сборки Bobmake, обеспечивая гибкость и надежность процесса сборки и управления модулями в проекте.