Upgrade to use upstream OpenVINO 2022.1 release

The 2022 release changes the names of several of the shared libraries
produced by OpenVINO as well as their directory structure. The C API is
still available, however, so this change continues to use that for the
time being instead of the newer v2.0 API.

Because of the significant changes to the release structure, there is a
decision to be made regarding backwards compatibility--e.g., using older
versions of OpenVINO with this binding crate. This change makes the
decision to stop supporting pre-2022 installations of OpenVINO in
ongoing versions of this crate: once this crate is released (`v0.4.0`),
users will have to decide whether to use this version for the newest
versions of OpenVINO or downgrade to a previously-released crate
(`v0.3.*`) for pre-2022 versions of OpenVINO.

Author: abrown

.github/workflows/main.yml

@@ -61,10 +61,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu18, ubuntu20]
-        version: [2020.4, 2021.1, 2021.2, 2021.3, 2021.4]
-        exclude:
-        - os: ubuntu20
-          version: 2020.4
+        version: [2022.1.0]
     steps:
     - uses: actions/checkout@v2
       with:
@@ -79,18 +76,18 @@ jobs:
   # binaries, then compile against these).
   runtime_binaries:
     name: From runtime-linked binaries
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
       with:
         submodules: recursive
         lfs: true
     - name: Checkout LFS obects
       run: git lfs checkout
-    - uses: abrown/install-openvino-action@v1
+    - uses: abrown/install-openvino-action@v3
     - name: Build and run tests
       run: |
-        source /opt/intel/openvino/bin/setupvars.sh
+        source /opt/intel/openvino_2022/setupvars.sh
         cargo test --features openvino-sys/runtime-linking
 
   # Build and test from an existing OpenVINO installation inside a Docker image (i.e. download the

Dockerfile

@@ -25,4 +25,4 @@ RUN OPENVINO_INSTALL_DIR=/opt/intel/openvino cargo build -vv
 
 # Test; note that we need to setup the library paths before using them since the
 # OPENVINO_INSTALL_DIR can only affect the build library search path.
-RUN ["/bin/bash", "-c", "source /opt/intel/openvino/bin/setupvars.sh && OPENVINO_INSTALL_DIR=/opt/intel/openvino cargo test -v"]
+RUN ["/bin/bash", "-c", "source /opt/intel/openvino/setupvars.sh && OPENVINO_INSTALL_DIR=/opt/intel/openvino cargo test -v"]

README.md

@@ -35,7 +35,7 @@ git lfs checkout
 
 ```shell script
 cargo build
-source /opt/intel/openvino/bin/setupvars.sh
+source /opt/intel/openvino/setupvars.sh
 cargo test
 ```
 
@@ -55,7 +55,7 @@ script will do this automatically.
 
 ```shell script
 cargo build --features openvino-sys/runtime-linking
-source /opt/intel/openvino/bin/setupvars.sh
+source /opt/intel/openvino/setupvars.sh
 cargo test --features openvino-sys/runtime-linking
 ```
 
@@ -64,7 +64,7 @@ The `openvino-rs` crates also support linking from a shared library at runtime (
 present and only later--at runtime--providing the OpenVINO™ shared libraries. All underlying system
 calls are wrapped so that a call to `openvino_sys::library::load` will link them to their shared
 library implementation (using the logic in [openvino-finder] to locate the shared libraries). For
-high-level users, call `openvino::Core::new` first to automatically load and link the libraries. 
+high-level users, call `openvino::Core::new` first to automatically load and link the libraries.
 
 
 

crates/openvino-finder/src/lib.rs

@@ -36,7 +36,7 @@ pub fn find(library_name: &str) -> Option<PathBuf> {
     }
 
     // Search using the `OPENVINO_INSTALL_DIR` environment variable; this may be set by users of the
-    // openvino-rs library.
+    // `openvino-rs` library.
     if let Some(install_dir) = env::var_os(ENV_OPENVINO_INSTALL_DIR) {
         let install_dir = PathBuf::from(install_dir);
         for lib_dir in KNOWN_INSTALLATION_SUBDIRECTORIES {
@@ -46,7 +46,7 @@ pub fn find(library_name: &str) -> Option<PathBuf> {
     }
 
     // Search using the `OPENVINO_BUILD_DIR` environment variable; this may be set by users of the
-    // openvino-rs library.
+    // `openvino-rs` library.
     if let Some(build_dir) = env::var_os(ENV_OPENVINO_BUILD_DIR) {
         let install_dir = PathBuf::from(build_dir);
         for lib_dir in KNOWN_BUILD_SUBDIRECTORIES {
@@ -56,7 +56,7 @@ pub fn find(library_name: &str) -> Option<PathBuf> {
     }
 
     // Search using the `INTEL_OPENVINO_DIR` environment variable; this is set up by an OpenVINO
-    // installation (e.g. `source /opt/intel/openvino/bin/setupvars.sh`).
+    // installation (e.g. `source /opt/intel/openvino/setupvars.sh`).
     if let Some(install_dir) = env::var_os(ENV_INTEL_OPENVINO_DIR) {
         let install_dir = PathBuf::from(install_dir);
         for lib_dir in KNOWN_INSTALLATION_SUBDIRECTORIES {
@@ -66,8 +66,7 @@ pub fn find(library_name: &str) -> Option<PathBuf> {
     }
 
     // Search in the OS library path (i.e. `LD_LIBRARY_PATH` on Linux, `PATH` on Windows, and
-    // `DYLD_LIBRARY_PATH` on MacOS). See
-    // https://docs.openvinotoolkit.org/latest/openvino_docs_IE_DG_Deep_Learning_Inference_Engine_DevGuide.html
+    // `DYLD_LIBRARY_PATH` on MacOS).
     if let Some(path) = env::var_os(ENV_LIBRARY_PATH) {
         for lib_dir in env::split_paths(&path) {
             let search_path = lib_dir.join(&file);
@@ -110,24 +109,19 @@ cfg_if! {
 cfg_if! {
     if #[cfg(any(target_os = "linux", target_os = "macos"))] {
         const DEFAULT_INSTALLATION_DIRECTORIES: & [& str] =
-            &["/opt/intel/openvino_2021", "/opt/intel/openvino"];
+            &["/opt/intel/openvino_2022", "/opt/intel/openvino"];
     } else if #[cfg(target_os = "windows")] {
         const DEFAULT_INSTALLATION_DIRECTORIES: & [& str] = &[
+            "C:\\Program Files (x86)\\Intel\\openvino_2022",
             "C:\\Program Files (x86)\\Intel\\openvino",
-            "C:\\Program Files (x86)\\Intel\\openvino_2021",
         ];
     } else {
         const DEFAULT_INSTALLATION_DIRECTORIES: & [& str] = &[];
     }
 }
 
-const KNOWN_INSTALLATION_SUBDIRECTORIES: &[&str] = &[
-    "deployment_tools/ngraph/lib",
-    "deployment_tools/inference_engine/lib/intel64",
-    "deployment_tools/inference_engine/external/hddl/lib",
-    "deployment_tools/inference_engine/external/gna/lib",
-    "deployment_tools/inference_engine/external/tbb/lib",
-];
+const KNOWN_INSTALLATION_SUBDIRECTORIES: &[&str] =
+    &["runtime/lib/intel64", "runtime/3rdparty/tbb/lib"];
 
 const KNOWN_BUILD_SUBDIRECTORIES: &[&str] = &[
     "bin/intel64/Debug/lib",
@@ -139,11 +133,11 @@ const KNOWN_BUILD_SUBDIRECTORIES: &[&str] = &[
 mod test {
     use super::*;
 
-    /// This test uses `find` to search for the `inference_engine_c_api` library on the local
+    /// This test uses `find` to search for the `openvino_c` library on the local
     /// system.
     #[test]
-    fn find_inference_engine_c_api_locally() {
+    fn find_openvino_c_locally() {
         pretty_env_logger::init();
-        assert!(find("inference_engine_c_api").is_some());
+        assert!(find("openvino_c").is_some());
     }
 }

crates/openvino-sys/build.rs

@@ -2,14 +2,7 @@ use std::env;
 use std::path::{Path, PathBuf};
 
 // These are the libraries we expect to be available to dynamically link to:
-const LIBRARIES: &[&str] = &[
-    "inference_engine",
-    "inference_engine_legacy",
-    "inference_engine_transformations",
-    "inference_engine_c_api",
-    "ngraph",
-    "tbb",
-];
+const LIBRARIES: &[&str] = &["openvino", "openvino_c", "tbb"];
 
 // A user-specified environment variable indicating that `build.rs` should not attempt to link
 // against any libraries (e.g. a doc build, user may link them later).
@@ -50,8 +43,8 @@ fn main() {
     let (c_api_library_path, library_search_paths) = if cfg!(feature = "from-source") {
         build_from_source_using_cmake()
     } else if linking == Linking::None {
-        (openvino_finder::find("inference_engine_c_api"), vec![])
-    } else if let Some(path) = openvino_finder::find("inference_engine_c_api") {
+        (openvino_finder::find("openvino_c"), vec![])
+    } else if let Some(path) = openvino_finder::find("openvino_c") {
         (Some(path), find_libraries_in_existing_installation())
     } else {
         panic!("Unable to find an OpenVINO installation on your system; build with runtime linking using `--features runtime-linking` or build from source with `--features from-source`.")
@@ -63,7 +56,7 @@ fn main() {
     if let Some(path) = c_api_library_path {
         record_library_path(path);
     } else {
-        println!("cargo:warning=openvino-sys cannot find the `inference_engine_c_api` library in any of the library search paths: {:?}", &library_search_paths);
+        println!("cargo:warning=openvino-sys cannot find the `openvino_c` library in any of the library search paths: {:?}", &library_search_paths);
         println!("cargo:warning=Proceeding with an empty value of {}; users must specify this location at runtime, e.g. `Core::new(Some(...))`.", ENV_OPENVINO_LIB_PATH);
         record_library_path(PathBuf::new());
     }
@@ -194,12 +187,12 @@ fn build_from_source_using_cmake() -> (Option<PathBuf>, Vec<PathBuf>) {
     }
 
     // Specifying the build targets reduces the build time somewhat; this one will trigger
-    // builds for other necessary shared libraries (e.g. inference_engine).
+    // builds for other necessary shared libraries (e.g., `openvino`).
     let build_path = cmake(out.to_str().unwrap())
-        .build_target("inference_engine_c_api")
+        .build_target("openvino_c")
         .build();
 
-    // Unfortunately, `inference_engine_c_api` will not build the OpenVINO plugins used for
+    // Unfortunately, `openvino_c` will not build the OpenVINO plugins used for
     // the actual computation. Here we re-run CMake for each plugin the user specifies using
     // Cargo features (see `Cargo.toml`).
     for plugin in get_plugin_target_from_features() {
@@ -228,7 +221,7 @@ fn build_from_source_using_cmake() -> (Option<PathBuf>, Vec<PathBuf>) {
     .expect("failed visiting TBB directory");
 
     let c_api = format!(
-        "{}inference_engine_c_api{}",
+        "{}openvino_c{}",
         env::consts::DLL_PREFIX,
         env::consts::DLL_SUFFIX
     );

crates/openvino-sys/src/lib.rs

@@ -40,9 +40,9 @@ pub mod library {
     pub use super::generated::load;
 
     /// Return the location of the shared library `openvino-sys` will link to. If compiled with
-    /// runtime linking, this will attempt to discover the location of a `inference_engine_c_api`
-    /// shared library on the system. Otherwise (with dynamic linking or compilation from source),
-    /// this relies on a static path discovered at build time.
+    /// runtime linking, this will attempt to discover the location of a `openvino_c` shared library
+    /// on the system. Otherwise (with dynamic linking or compilation from source), this relies on a
+    /// static path discovered at build time.
     ///
     /// Knowing the location of the OpenVINO libraries is critical to avoid errors, unfortunately.
     /// OpenVINO loads target-specific libraries on demand for performing inference. To do so, it
@@ -53,7 +53,7 @@ pub mod library {
     /// `find().unwrap().parent()`.
     pub fn find() -> Option<PathBuf> {
         if cfg!(feature = "runtime-linking") {
-            openvino_finder::find("inference_engine_c_api")
+            openvino_finder::find("openvino_c")
         } else {
             Some(PathBuf::from(env!("OPENVINO_LIB_PATH")))
         }

crates/openvino-sys/src/linking/runtime.rs

@@ -77,7 +77,7 @@ macro_rules! link {
         /// May fail if the `openvino-finder` cannot discover the library on the current system.
         pub fn load() -> Result<(), String> {
             match crate::library::find() {
-                None => Err("Unable to find the `inference_engine_c_api` library to load".into()),
+                None => Err("Unable to find the `openvino_c` library to load".into()),
                 Some(path) => load_from(path),
             }
         }
@@ -111,10 +111,10 @@ macro_rules! link {
             pub unsafe fn $name($($pname: $pty), *) $(-> $ret)* {
                 let f = with_library(|l| {
                     l.functions.$name.expect(concat!(
-                        "`inference_engine_c_api` function not loaded: `",
+                        "`openvino_c` function not loaded: `",
                         stringify!($name)
                     ))
-                }).expect("an `inference_engine_c_api` shared library is not loaded on this thread");
+                }).expect("an `openvino_c` shared library is not loaded on this thread");
                 f($($pname), *)
             }
         )+