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 byOpenVINODeveloperPackageConfig.cmake
to import the following targets:Libraries for plugin development:
openvino::runtime
- shared OpenVINO libraryopenvino::runtime::dev
- interface library with OpenVINO Developer APIopenvino::pugixml
- static Pugixml libraryopenvino::xbyak
- interface library with Xbyak headersopenvino::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 librariesopenvino::common_test_utils
- static library with common tests utilitiesopenvino::func_test_utils
- static library with functional tests utilitiesopenvino::unit_test_utils
- static library with unit tests utilitiesopenvino::ov_models
- static library with the set ofov::Model
buildersopenvino::funcSharedTests
- static library with common functional tests
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
folderCode 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 thefind_package
CMake command and adds thesrc
andtests
subdirectories with plugin sources and their tests respectively:
cmake_minimum_required(VERSION 3.13)
project(OpenVINOTemplatePlugin)
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)
ov_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}"
"${OpenVINOTemplatePlugin_SOURCE_DIR}/include")
# link common OpenVINO Runtime libraries
target_link_libraries(${TARGET_NAME} PRIVATE
openvino::interpreter_backend
openvino::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")
ov_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
"${OpenVINOTemplatePlugin_SOURCE_DIR}/include"
"${CMAKE_CURRENT_SOURCE_DIR}/op_reference"
ADD_CLANG_FORMAT
LABELS
OV UNIT TEMPLATE
)
find_package(OpenCV QUIET COMPONENTS core imgproc)
if(OpenCV_FOUND AND OpenCV_VERSION VERSION_GREATER_EQUAL 3.4)
message(STATUS "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(WARNING "Reference preprocessing: OpenCV tests are disabled, because OpenCV ver. 3.4+ is not found")
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.