Библиотеки CMake в составе KasperskyOS Community Edition

Этот раздел содержит описание библиотек, поставляемых в KasperskyOS Community Edition и предназначенных для автоматизации сборки решения на базе KasperskyOS.

Библиотека platform

Библиотека platform содержит следующие команды:

• initialize_platform() – команда для инициализации библиотеки platform.
• project_header_default() – команда для указания флагов компилятора и компоновщика для текущего проекта.

Эти команды используются в файлах CmakeLists.txt для программы Einit и прикладных программ.

Библиотека nk

Этот раздел содержит описание команд и макросов библиотеки CMake-библиотеки для работы с компилятором NK.

generate_edl_file()

Команда объявлена в файле /opt/KasperskyOS-Community-Edition-<version>toolchain/share/cmake/Modules/platform/nk2.cmake.

Команда генерирует EDL-файл с описанием класса процессов.

Параметры:

• NAME – название класса процессов. Обязательный параметр.
• PREFIX – имя глобального модуля, к которому относится EDL-файл. В этом параметре необходимо указать название проекта.
• EDL_COMPONENTS – имя компонента и его экземпляра, которые будут включены в EDL-файл. Например: EDL_COMPONENTS "env: kl.Env". Для включения нескольких компонентов нужно использовать несколько параметров EDL_COMPONENTS.
• SECURITY – квалифицированное имя метода интерфейса безопасности, который будет включен в EDL-файл.
• OUTPUT_DIR – директория, где будет создан EDL-файл. По умолчанию ${CMAKE_CURRENT_BINARY_DIR}.
• OUTPUT_FILE – имя создаваемого EDL-файла. По умолчанию ${OUTPUT_DIR}/${NAME}.edl.

В результате работы команды переменная EDL_FILE экспортируется и содержит путь до сгенерированного EDL файла.

Пример вызова:

Пример использования команды см. в статье "Файлы CMakeLists.txt для сборки прикладных программ".

nk_build_idl_files()

Команда объявлена в файле /opt/KasperskyOS-Community-Edition-<version>toolchain/share/cmake/Modules/platform/nk2.cmake.

Команда создает CMake-цель для генерации .idl.h-файлов для одного или нескольких заданных IDL-файлов при помощи компилятора NK.

Параметры:

• NAME – имя CMake-цели для сборки .idl.h-файлов. Если цель еще не создана, то она будет создана с помощью add_library() с указанным именем. Обязательный параметр.
• NOINSTALL – если указана эта опция, то файлы будут только сгенерированы в рабочей директории, но не будут установлены в глобальные директории: ${CMAKE_BINARY_DIR}/_headers_ ${CMAKE_BINARY_DIR}/_headers_/${PROJECT_NAME}.
• NK_MODULE – глобальный модуль, к которому относится интерфейс. В этом параметре необходимо указать название проекта.
• WORKING_DIRECTORY – рабочая директория для вызова компилятора NK, по умолчанию: ${CMAKE_CURRENT_BINARY_DIR}.
• DEPENDS – дополнительные цели сборки, от которых зависит IDL-файл.

  Для добавления нескольких целей нужно использовать несколько параметров DEPENDS.

• IDL – путь к IDL-файлу, для которого генерируется idl.h-файл. Обязательный параметр.

  Для добавления нескольких IDL-файлов нужно использовать несколько параметров IDL.

  Если один IDL-файл импортирует другой IDL-файл, то генерацию idl.h-файлов нужно производить в порядке, необходимом для соблюдения зависимостей (сначала самые вложенные).

• NK_FLAGS – дополнительные флаги для NK компилятора.

Пример вызова:

Пример использования команды см. в статье "Файлы CMakeLists.txt для сборки прикладных программ".

nk_build_cdl_files()

Команда объявлена в файле /opt/KasperskyOS-Community-Edition-<version>toolchain/share/cmake/Modules/platform/nk2.cmake.

Команда создает CMake-цель для генерации .cdl.h-файлов для одного или нескольких заданных CDL-файлов при помощи компилятора NK.

Параметры:

• NAME – имя CMake-цели для сборки .cdl.h-файлов. Если цель еще не создана, то она будет создана с помощью add_library() с указанным именем. Обязательный параметр.
• NOINSTALL – если указана эта опция, то файлы будут только сгенерированы в рабочей директории, но не установлены в глобальные директории: ${CMAKE_BINARY_DIR}/_headers_ ${CMAKE_BINARY_DIR}/_headers_/${PROJECT_NAME}.
• IDL_TARGET – цель сборки .idl.h-файлов для IDL-файлов, содержащих описания служб, предоставляемых компонентами, описанными в CDL-файлах.
• NK_MODULE – глобальный модуль, к которому относится компонент. В этом параметре необходимо указать название проекта.
• WORKING_DIRECTORY – рабочая директория для вызова компилятора NK, по умолчанию: ${CMAKE_CURRENT_BINARY_DIR}.
• DEPENDS – дополнительные цели сборки, от которых зависит CDL-файл.

  Для добавления нескольких целей нужно использовать несколько параметров DEPENDS.

• CDL – путь к CDL-файлу, для которого генерируется .cdl.h-файл. Обязательный параметр.

  Для добавления нескольких CDL-файлов нужно использовать несколько параметров CDL.

• NK_FLAGS – дополнительные флаги для NK компилятора.

Пример вызова:

Пример использования команды см. в статье "Файлы CMakeLists.txt для сборки прикладных программ".

nk_build_edl_files()

Команда объявлена в файле /opt/KasperskyOS-Community-Edition-<version>toolchain/share/cmake/Modules/platform/nk2.cmake.

Команда создает CMake-цель для генерации .edl.h-файла для одного заданного EDL-файла при помощи компилятора NK.

Параметры:

• NAME – имя CMake-цели сборки .edl.h-файла. Если цель еще не создана, то она будет создана с помощью add_library() с указанным именем. Обязательный параметр.
• NOINSTALL – если указана эта опция, то файлы будут только сгенерированы в рабочей директории, но не установлены в глобальные директории: ${CMAKE_BINARY_DIR}/_headers_ ${CMAKE_BINARY_DIR}/_headers_/${PROJECT_NAME}.
• CDL_TARGET – цель сборки .cdl.h-файлов для CDL-файлов, содержащих описания компонентов EDL-файла, для которого выполняется сборка.
• IDL_TARGET – цель сборки .idl.h-файлов для IDL-файлов, содержащих описания интерфейсов EDL-файла, для которого выполняется сборка.
• NK_MODULE – глобальный модуль, к которому относится EDL-файл. В этом параметре необходимо указать название проекта.
• WORKING_DIRECTORY – рабочая директория для вызова компилятора NK, по умолчанию: ${CMAKE_CURRENT_BINARY_DIR}.
• DEPENDS – дополнительные цели сборки, от которых зависит EDL-файл.

  Для добавления нескольких целей нужно использовать несколько параметров DEPENDS.

• EDL – путь к EDL файлу, для которого генерируется edl.h-файл. Обязательный параметр.
• NK_FLAGS – дополнительные флаги для NK компилятора.

Примеры вызова:

Пример использования команды см. в статье "Файлы CMakeLists.txt для сборки прикладных программ".

Библиотека image

Этот раздел содержит описание команд и макросов CMake-библиотеки image , входящей в состав KasperskyOS Community Edition и содержащей скрипты сборки образа решения.

build_kos_hw_image()

Команда объявлена в файле /opt/KasperskyOS-Community-Edition-<version>toolchain/share/cmake/Modules/platform/image.cmake.

Команда создает CMake-цель сборки образа решения, которую впоследствии можно использовать для сборки образа для аппаратной платформы с помощью make.

Параметры:

• NAME – имя CMake-цели для сборки образа решения. Обязательный параметр.
• PERFCNT_KERNEL – использовать ядро со счетчиками производительности, если оно доступно в составе KasperskyOS Community Edition.
• EINIT_ENTITY – имя исполняемого файла, из которого будет запускаться программа Einit.
• EXTRA_XDL_DIR – дополнительные директории для включения при сборке программы Einit.
• CONNECTIONS_CFG – путь до файла init.yaml или шаблона init.yaml.in.
• SECURITY_PSL – путь до файла security.psl или шаблона security.psl.in.
• KLOG_ENTITY – цель сборки системной программы Klog, отвечающей за аудит безопасности. Если цель не указана – аудит не выполняется.
• IMAGE_BINARY_DIR_BIN – директория для финального образа и других артефактов, по умолчанию CMAKE_CURRENT_BINARY_DIR.
• IMAGE_FILES – исполняемые файлы прикладных и системных программ (кроме программы Einit) и любые другие файлы для добавления в образ ROMFS.

  Для добавления нескольких программ или файлов можно использовать несколько параметров IMAGE_FILES.

• <пути до файлов> – свободные параметры, тоже что IMAGE_FILES.

Пример вызова:

Пример использования команды см. в статье "Файлы CMakeLists.txt для сборки программы Einit".

build_kos_qemu_image()

Команда объявлена в файле /opt/KasperskyOS-Community-Edition-<version>toolchain/share/cmake/Modules/platform/image.cmake.

Команда создает CMake-цель сборки образа решения, которую впоследствии можно использовать для сборки образа для QEMU с помощью make.

Параметры:

• NAME – имя CMake-цели для сборки образа решения. Обязательный параметр.
• PERFCNT_KERNEL – использовать ядро со счетчиками производительности, если оно доступно в составе KasperskyOS Community Edition.
• EINIT_ENTITY – имя исполняемого файла, из которого будет запускаться программа Einit.
• EXTRA_XDL_DIR – дополнительные директории для включения при сборке программы Einit.
• CONNECTIONS_CFG – путь до файла init.yaml или шаблона init.yaml.in.
• SECURITY_PSL – путь до файла security.psl или шаблона security.psl.in.
• KLOG_ENTITY – цель сборки системной программы Klog, отвечающей за аудит безопасности. Если цель не указана – аудит не выполняется.
• QEMU_FLAGS – дополнительные флаги для запуска QEMU.
• IMAGE_BINARY_DIR_BIN – директория для финального образа и других артефактов, по умолчанию совпадает с CMAKE_CURRENT_BINARY_DIR.
• IMAGE_FILES – исполняемые файлы прикладных и системных программ (кроме программы Einit) и любые другие файлы для добавления в образ ROMFS.

  Для добавления нескольких программ или файлов можно использовать несколько параметров IMAGE_FILES.

• <пути до файлов> – свободные параметры, тоже что IMAGE_FILES.

Пример вызова:

Пример использования команды см. в статье "Файлы CMakeLists.txt для сборки программы Einit".