nk-gen-c

Компилятор NK (nk-gen-с) генерирует набор транспортных методов и типов на основе EDL-, CDL- и IDL-описаний сущностей, компонентов и интерфейсов. Транспортные методы и типы нужны для формирования, отправки, приема и обработки IPC-сообщений.

Транспортные методы и типы генерируются с полностью квалифицированными именами. В именах в качестве префиксов используется полное имя сущности/компонента/интерфейса. (объявленное в соответствующем EDL-, CDL- или IDL-файле) с заменой точек на подчеркивания (_).

Компилятор NK принимает EDL-, CDL- или IDL-файл и создает следующие файлы:

• H-файл, содержащий объявление и реализацию транспортных методов и типов.
• D-файл, в котором перечислены зависимости созданного C-файла. Этот файл может быть использован для автоматизации сборки с помощью утилиты make.

Синтаксис использования компилятора NK:

nk-gen-c [-I PATH][-o PATH][--types][--interface][--client][--server][--extended-errors][--enforce-alignment-check][--help][--version] FILE

Параметры:

• FILE

  Путь к EDL-, CDL- или IDL-описанию сущности, компонента или интерфейса, для которого необходимо сгенерировать транспортные методы и типы.

• -I PATH

  Путь к директории, содержащей вспомогательные файлы, необходимые для генерации транспортных методов и типов. По умолчанию эти файлы располагаются в директории /opt/KasperskyOS-Community-Edition-<version>/sysroot-x86_64-pc-kos/include.

  Также может использоваться для добавления других директорий для поиска файлов, необходимых для генерации.

  Чтобы указать более одной директории, можно использовать несколько параметров -I.

• -o PATH

  Путь к существующей директории, в которой будут созданы файлы, содержащие транспортные методы и типы.

• -h, --help

  Отображает текст справки.

• --version

  Отображает версию nk-gen-c

• --enforce-alignment-check

  Включает обязательную проверку выравнивания обращений к памяти, даже если такая проверка отключена для целевой платформы. Если проверка включена, то компилятор NK добавляет дополнительные проверки выравнивания в код валидаторов IPC-сообщений.

  По умолчанию параметры проверки выравнивания обращения к памяти задаются для каждой платформы в файле system.platform.

• --extended-errors

  Включает расширенную обработку ошибок в коде клиентских и серверных методов.

Выборочная генерация

Чтобы уменьшить количество генерируемого компилятором NK кода можно использовать флаги выборочной генерации. Например для сущностей, реализующих интерфейсы, удобно использовать флаг --server, а для сущностей, являющихся клиентами интерфейсов, удобно использовать флаг --client.

Если ни один из флагов выборочной генерации не указан, компилятор NK создаст все возможные для указанного файла транспортные типы и методы.

Флаги выборочной генерации для описаний интерфейсов (IDL-файлов):

• --types

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

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

• --interface

  Компилятор создаст файлы, создаваемые с флагом --types, а также структуры сообщений запросов и ответов для всех методов этого интерфейса.

• --client

  Компилятор создаст файлы, создаваемые с флагом --interface, а также клиентские прокси-объекты и функции их инициализации для всех методов этого интерфейса.

• --server

  Компилятор создаст файлы, создаваемые с флагом --interface, а также типы и методы диспетчера этого интерфейса.

Флаги выборочной генерации для описаний компонентов (CDL-файлов) и сущностей (EDL-файлов):

• --types

  Компилятор создаст файлы, создаваемые с флагом --types для всех интерфейсов, используемых в этом компоненте/сущности.

  При этом явно включены в генерируемые файлы будут только те типы, которые используются в аргументах интерфейсных методов.

• --interface

  Компилятор создаст файлы, создаваемые с флагом --types для этого компонента/сущности, а также файлы, создаваемые с флагом --interface для всех интерфейсов, используемых в этом компоненте/сущности.

• --client

  Компилятор создаст файлы, создаваемые с флагом --interface, а также клиентские прокси-объекты и функции их инициализации для всех интерфейсов, используемых в этом компоненте/сущности.

• --server

  Компилятор создаст файлы, создаваемые с флагом --interface, а также типы и методы диспетчера этого компонента/сущности и типы и методы диспетчеров для всех интерфейсов, используемых в этом компоненте/сущности.

В начало