Пример uart_toybox

Пример демонстрирует работу с компонентом Toybox в решении на базе KasperskyOS.

Директория примера в SDK

Код примера и скрипты для сборки находятся по следующему пути:

/opt/KasperskyOS-Community-Edition-<platform>-<version>/examples/uart_toybox

Список программ

• Launcher – прикладная программа, запускающая программу Toybox.
• Terminal – системная программа, обеспечивающая взаимодействие между последовательным портом UART и виртуальной файловой системой (программа Vfs) для реализации стандартных потоков ввода-вывода.
• ExecMgrEntity – системная программа, управляющая жизненным циклом процессов через IPC-механизмы.
• BlobContainer – системная программа, предназначенная для загрузки бинарных данных в память и используемая программой Execution Manager для запуска процессов.
• Dmesg – системная программа, используемая для считывания из буфера ядра KasperskyOS диагностических сообщений и последующей их обработки, организации хранения и вывода. В решении используется при выполнении команды dmesg.
• Ping – системная программа, используемая для диагностики сетевой доступности, отправки ICMP-запросов и проверки соединения с другими узлами в сети. В решении используется при выполнении команды ping.
• EntropyEntity – системная программа, реализующая генератор случайных чисел.
• Dhcpcd – системная программа, реализующая DHCP-клиент, который в фоновом режиме получает параметры сетевых интерфейсов от внешнего DHCP-сервера и передает их виртуальной файловой системе.
• Ntpd – системная программа, реализующая NTP-клиент, который получает параметры времени от внешних NTP-серверов в фоновом режиме и передаёт их ядру KasperskyOS.
• Vfs – системная программа, реализующая виртуальную файловую систему, в которую включены как сетевой стек, так и файловые системы. В программе настраиваются параметры терминала, обрабатываются аргументы командной строки и переменные окружения, после чего проверяется инициализация VFS-бэкенда и запускается основной цикл обработки файловых операций.
• DCM – системная программа, позволяющая динамически создавать IPC-каналы.
• SDCard – драйвер SD-карты.
• DNetSrv – драйвер сетевой карты.
• UART – драйвер для работы с универсальным асинхронным приемопередатчиком.

При сборке примера для целевой аппаратной платформы в решение автоматически включаются платформенно-зависимые драйверы:

• BSP – пакет поддержки аппаратной платформы (англ. Board Support Package). Обеспечивает кросс-платформенную настройку периферии для Radxa ROCK 3A и Raspberry Pi 4 B.
• PCIE – драйвер шины PCIe для Radxa ROCK 3A и Raspberry Pi 4 B.
• GPIO – драйвер поддержки GPIO для Radxa ROCK 3A и Raspberry Pi 4 B.
• PinCtrl – драйвер низкоуровневой конфигурации мультиплексирования пинов (pinmux) для Radxa ROCK 3A.
• USB – драйвер для управления всеми типами USB-устройств для Radxa ROCK 3A и Raspberry Pi 4 B.
• Bcm2711MboxArmToVc – драйвер для работы с сопроцессором VideoCore (VC6) через технологию mailbox для Raspberry Pi 4 B.

Описание инициализации

Файл описания инициализации решения init.yaml генерируется в процессе сборки решения на основе шаблона ./einit/src/init.yaml.in. Макросы вида @INIT_*@, которые содержатся в шаблоне, автоматически раскрываются в итоговом файле init.yaml. Подробнее см. "Шаблон init.yaml.in".

Описание политики безопасности

Файл security.psl содержит описание политики безопасности решения на базе KasperskyOS и находится в директории ./einit/src. Декларации в PSL-файле снабжены комментариями, которые поясняют назначение этих деклараций.

Описание политики безопасности решения в этом примере разрешает любые взаимодействия процессов между собой и ядром. Эту политику можно использовать только в качестве заглушки на ранних стадиях разработки решения, чтобы модуль безопасности не препятствовал взаимодействиям. В реальном решении на KasperskyOS применять такую политику недопустимо.

Ресурсы

Файл ./resources/xdl/exec_app/ExecApp.edl является EDL-описанием для класса процессов, запускаемых при выполнении команды exec компонента Toybox.

В директории ./resources/xdl/toybox расположены файлы Vfs.edl и Launcher.edl – EDL-описания программ Vfs и Launcher соответственно.

В директории ./resources/hdd/etc расположены файлы конфигурации для программ Vfs и Dhcpcd: hosts и dhcpcd.conf соответственно.

Директория ./resources/hdd/var/db/dhcpcd используется программой Dhcpcd для хранения данных о подключении к сети.

Сценарий работы

Программа Launcher выполняет следующие действия:

1. Устанавливает имя исполняемого файла /romfs/Toybox, из которого будет запущен процесс с использованием компонента ExecutionManager.
2. Получает указатель на экземпляр интерфейса IExecutionManager компонента ExecutionManager используя функцию DcmConnect(). (Для соединения с процессом ExecutionManager используется системная программа DCM.)
3. Получает доступ к интерфейсу IApplicationController компонента ExecutionManager используя указатель на экземпляр интерфейса IExecutionManager, полученный на шаге 2.
4. Проверяет доступность сети.
5. Устанавливает в структуре StartEntityInfo, которая содержит параметры для запуска процесса, следующие значения:
   • имя процесса: Toybox;
   • класс процесса: toybox.Toybox;
   • переменные окружения, которые будут переданы процессу при запуске: "VFS_NETWORK_BACKEND=client:toybox.Vfs" и "VFS_FILESYSTEM_BACKEND=client:toybox.Vfs".
6. Запускает процесс из исполняемого файла /romfs/Toybox используя функцию StartEntity() интерфейса IApplicationController.
7. Отслеживает по маске события, которые связаны с запущенным процессом, используя методы SubscribeToObject(), GetEvent() и UnsubscribeFromEvent() из службы уведомлений. В случае возникновения отслеживаемых событий (завершение, ошибка или остановка процесса Toybox), снова запускает этот процесс.

После запуска программы Launcher терминал перейдет в интерактивный режим работы, о чем свидетельствует отображение стандартного приглашения командной строки $. В данном режиме становятся доступны команды, описанные в компоненте Terminal.

Сборка и запуск примера

Для сборки и запуска примера используется система CMake из состава KasperskyOS Community Edition.

Для корректной работы примера на Radxa ROCK 3A примените DTBO-оверлей rk3568-uart2-m0 к бинарному файлу описания аппаратной конфигурации rk3568-rock-3a.dtb согласно инструкции по применению оверлеев в разделе "Сборка драйверов для аппаратной платформы Radxa ROCK 3A".

См. "Сборка и запуск примеров".