Build Plugin Using CMake¶

OpenVINO build infrastructure provides the OpenVINO Developer Package for plugin development.

OpenVINO Developer Package¶

To automatically generate the OpenVINO Developer Package, run the cmake tool during a OpenVINO build:

$ mkdir openvino-release-build
$ cd openvino-release-build
$ cmake -DCMAKE_BUILD_TYPE=Release ../openvino

Once the commands above are executed, the OpenVINO Developer Package is generated in the openvino-release-build folder. It consists of several files:

OpenVINODeveloperPackageConfig.cmake - the main CMake script which imports targets and provides compilation flags and CMake options.
OpenVINODeveloperPackageConfig-version.cmake - a file with a package version.
targets_developer.cmake - an automatically generated file which contains all targets exported from the OpenVINO build tree. This file is included by OpenVINODeveloperPackageConfig.cmake to import the following targets:
- Libraries for plugin development:
  - openvino::runtime - shared OpenVINO library
  - openvino::runtime::dev - interface library with OpenVINO Developer API
  - openvino::pugixml - static Pugixml library
  - openvino::xbyak - interface library with Xbyak headers
  - openvino::itt - static library with tools for performance measurement using Intel ITT
- Libraries for tests development:
  - openvino::gtest, openvino::gtest_main, openvino::gmock - Google Tests framework libraries
  - openvino::commonTestUtils - static library with common tests utilities
  - openvino::funcTestUtils - static library with functional tests utilities
  - openvino::unitTestUtils - static library with unit tests utilities
  - openvino::ngraphFunctions - static library with the set of ov::Model builders
  - openvino::funcSharedTests - static library with common functional tests
  - openvino::ngraph_reference - static library with operation reference implementations.

Note

It’s enough just to run cmake --build . --target ov_dev_targets command to build only targets from the OpenVINO Developer package.

Build Plugin using OpenVINO Developer Package¶

To build a plugin source tree using the OpenVINO Developer Package, run the commands below:

$ mkdir template-plugin-release-build
$ cd template-plugin-release-build
$ cmake -DOpenVINODeveloperPackage_DIR=../openvino-release-build ../template-plugin

A common plugin consists of the following components:

Plugin code in the src folder
Code of tests in the tests folder

To build a plugin and its tests, run the following CMake scripts:

Root CMakeLists.txt, which finds the OpenVINO Developer Package using the find_package CMake command and adds the src and tests subdirectories with plugin sources and their tests respectively:

cmake_minimum_required(VERSION 3.13)

project(OpenVINOTemplatePlugin)

set(TEMPLATE_PLUGIN_SOURCE_DIR ${OpenVINOTemplatePlugin_SOURCE_DIR})

find_package(OpenVINODeveloperPackage REQUIRED)

ov_option(ENABLE_TEMPLATE_REGISTRATION "Enables registration of TEMPLATE plugin" OFF)

if(CMAKE_COMPILER_IS_GNUCXX)
    ov_add_compiler_flags(-Wall)
endif()

add_subdirectory(src)

if(ENABLE_TESTS)
    include(CTest)
    enable_testing()

    if(ENABLE_FUNCTIONAL_TESTS)
        add_subdirectory(tests/functional)
    endif()
endif()

# install

if(OpenVINODeveloperPackage_FOUND)
    ie_cpack(template)
endif()

Note

The default values of the ENABLE_TESTS, ENABLE_FUNCTIONAL_TESTS options are shared via the OpenVINO Developer Package and they are the same as for the main OpenVINO build tree. You can override them during plugin build using the command below:

$ cmake -DENABLE_FUNCTIONAL_TESTS=OFF -DOpenVINODeveloperPackage_DIR=../openvino-release-build ../template-plugin

src/CMakeLists.txt to build a plugin shared library from sources:

set(TARGET_NAME "openvino_template_plugin")

file(GLOB_RECURSE SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)
file(GLOB_RECURSE HEADERS ${CMAKE_CURRENT_SOURCE_DIR}/*.hpp)

if (NOT ENABLE_TEMPLATE_REGISTRATION)
    # Skip install and registration of template component
    set(skip_plugin SKIP_INSTALL SKIP_REGISTRATION)
endif()

# adds a shared library with plugin
ov_add_plugin(NAME ${TARGET_NAME}
              DEVICE_NAME "TEMPLATE"
              SOURCES ${SOURCES} ${HEADERS}
              ${skip_plugin}
              VERSION_DEFINES_FOR plugin.cpp
              ADD_CLANG_FORMAT)

# Enable support of CC for the plugin
ov_mark_target_as_cc(${TARGET_NAME})

target_include_directories(${TARGET_NAME} PRIVATE
    "${CMAKE_CURRENT_SOURCE_DIR}"
    "${TEMPLATE_PLUGIN_SOURCE_DIR}/include")

# link common Inference Engine libraries
target_link_libraries(${TARGET_NAME} PRIVATE
    openvino::interpreter_backend
    openvino::ngraph_reference)

set_target_properties(${TARGET_NAME} PROPERTIES INTERPROCEDURAL_OPTIMIZATION_RELEASE ${ENABLE_LTO})

if (ENABLE_TEMPLATE_REGISTRATION)
    # Update the plugins.xml file
    ov_register_plugins(MAIN_TARGET ${TARGET_NAME})
endif()

Note

openvino::... targets are imported from the OpenVINO Developer Package.

tests/functional/CMakeLists.txt to build a set of functional plugin tests:

set(TARGET_NAME ov_template_func_tests)

if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
    ie_add_compiler_flags(/wd4305)
endif()

ov_add_test_target(
        NAME ${TARGET_NAME}
        ROOT ${CMAKE_CURRENT_SOURCE_DIR}
        DEPENDENCIES
            openvino_template_plugin
        LINK_LIBRARIES
            openvino::funcSharedTests
            openvino::runtime::dev
        INCLUDES
            "${TEMPLATE_PLUGIN_SOURCE_DIR}/include"
            "${CMAKE_CURRENT_SOURCE_DIR}/op_reference"
        # ADD_CPPLINT
        LABELS
            TEMPLATE
)

find_package(OpenCV QUIET COMPONENTS core imgproc)

if(OpenCV_FOUND)
    message("-- Reference preprocessing: OpenCV tests are enabled")
    target_compile_definitions(${TARGET_NAME} PRIVATE OPENCV_TEMPLATE_TESTS)
    target_link_libraries(${TARGET_NAME} PRIVATE opencv_imgproc opencv_core)
else()
    message("-- Reference preprocessing: OpenCV tests are disabled")
endif()

if (ENABLE_INTEL_CPU)
    set_source_files_properties(
        "${CMAKE_CURRENT_SOURCE_DIR}/shared_tests_instances/behavior/executable_network/get_metric.cpp"
        PROPERTIES COMPILE_DEFINITIONS ENABLE_INTEL_CPU=1)
endif()

Note

The openvino::funcSharedTests static library with common functional OpenVINO Plugin tests is imported via the OpenVINO Developer Package.