Simplified cancel behavior (#4224)

docs/template_plugin/src/template_infer_request.cpp

@@ -131,13 +131,6 @@ void TemplateInferRequest::InferImpl() {
 }
 // ! [infer_request:infer_impl]
 
-// ! [infer_request:cancel]
-InferenceEngine::StatusCode TemplateInferRequest::Cancel() {
-    // TODO: add code to  handle cancellation request
-    return InferenceEngine::OK;
-}
-// ! [infer_request:cancel]
-
 template<typename SrcT, typename DstT>
 static void blobCopy(const Blob::Ptr& src, const Blob::Ptr& dst) {
     std::copy_n(InferenceEngine::as<InferenceEngine::MemoryBlob>(src)->rmap().as<const SrcT*>(),

docs/template_plugin/src/template_infer_request.hpp

@@ -40,8 +40,6 @@ public:
     void InferImpl() override;
     std::map<std::string, InferenceEngine::InferenceEngineProfileInfo> GetPerformanceCounts() const override;
 
-    InferenceEngine::StatusCode Cancel() override;
-
     // pipeline methods-stages which are used in async infer request implementation and assigned to particular executor
     void inferPreprocess();
     void startPipeline();

inference-engine/include/cpp/ie_infer_request.hpp

@@ -162,10 +162,13 @@ public:
         CALL_STATUS_FNC_NO_ARGS(Infer);
     }
 
-    StatusCode Cancel() {
+    /**
-        ResponseDesc resp;
+     * @copybrief IInferRequest::Cancel
-        if (actual == nullptr) THROW_IE_EXCEPTION << "InferRequest was not initialized.";
+     *
-        return actual->Cancel(&resp);
+     * Wraps IInferRequest::Cancel
+     */
+    void Cancel() {
+        CALL_STATUS_FNC_NO_ARGS(Cancel);
     }
 
     /**

inference-engine/include/details/ie_exception_conversion.hpp

@@ -60,6 +60,8 @@ inline void extract_exception(StatusCode status, const char* msg) {
         throw InferNotStarted(msg);
     case NETWORK_NOT_READ:
         throw NetworkNotRead(msg);
+    case INFER_CANCELLED:
+        throw InferCancelled(msg);
     default:
         THROW_IE_EXCEPTION << msg << InferenceEngine::details::as_status << status;
     }

inference-engine/include/ie_common.h

@@ -334,6 +334,11 @@ class NetworkNotRead : public std::logic_error {
     using std::logic_error::logic_error;
 };
 
+/** @brief This class represents StatusCode::INFER_CANCELLED exception */
+class InferCancelled : public std::logic_error {
+    using std::logic_error::logic_error;
+};
+
 }  // namespace InferenceEngine
 
 #if defined(_WIN32)

inference-engine/src/gna_plugin/gna_infer_request.hpp

@@ -117,9 +117,5 @@ class GNAInferRequest : public InferenceEngine::AsyncInferRequestInternal {
         return plg->QueryState();
     }
     IE_SUPPRESS_DEPRECATED_END
-
-    InferenceEngine::StatusCode Cancel() override {
-        return InferenceEngine::NOT_IMPLEMENTED;
-    }
 };
 }  // namespace GNAPluginNS

inference-engine/src/plugin_api/cpp_interfaces/base/ie_infer_async_request_base.hpp

@@ -38,7 +38,7 @@ public:
 
     StatusCode Cancel(ResponseDesc* resp) noexcept override {
         OV_ITT_SCOPED_TASK(itt::domains::Plugin, "Cancel");
-        NO_EXCEPT_CALL_RETURN_STATUS(_impl->Cancel());
+        TO_STATUS(_impl->Cancel());
     }
 
     StatusCode GetPerformanceCounts(std::map<std::string, InferenceEngineProfileInfo>& perfMap,

inference-engine/src/plugin_api/cpp_interfaces/impl/ie_infer_async_request_thread_safe_default.hpp

@@ -281,13 +281,10 @@ public:
         }
     }
 
-    StatusCode Cancel() override {
+    void Cancel() override {
         std::lock_guard<std::mutex> lock{_mutex};
-        if (_state == InferState::Idle) {
+        if (_state == InferState::Busy) {
-            return StatusCode::INFER_NOT_STARTED;
-        } else {
             _state = InferState::Canceled;
-            return InferenceEngine::OK;
         }
     }
 

inference-engine/src/plugin_api/cpp_interfaces/impl/ie_infer_request_internal.hpp

@@ -66,8 +66,8 @@ public:
     /**
      * @brief Default common implementation for all plugins
      */
-    StatusCode Cancel() override {
+    void Cancel() override {
-        return InferenceEngine::NOT_IMPLEMENTED;
+        THROW_IE_EXCEPTION_WITH_STATUS(NOT_IMPLEMENTED);
     }
 
     /**

inference-engine/src/plugin_api/cpp_interfaces/interface/ie_iinfer_request_internal.hpp

@@ -42,7 +42,7 @@ public:
     /**
      * @brief Cancel current inference request execution
      */
-    virtual StatusCode Cancel() = 0;
+    virtual void Cancel() = 0;
 
     /**
      * @brief Queries performance measures per layer to get feedback of what is the most time consuming layer.

inference-engine/tests/functional/plugin/shared/include/behavior/infer_request_cancellation.hpp

@@ -41,31 +41,13 @@ TEST_P(CancellationTests, canCancelAsyncRequest) {
     auto execNet = ie->LoadNetwork(cnnNet, targetDevice, configuration);
     // Create InferRequest
     InferenceEngine::InferRequest req = execNet.CreateInferRequest();
-    bool cancelled = false;
-    req.SetCompletionCallback<std::function<void(InferenceEngine::InferRequest, InferenceEngine::StatusCode)>>(
-            [&](InferenceEngine::InferRequest request, InferenceEngine::StatusCode status) {
-                if (targetDevice == CommonTestUtils::DEVICE_CPU) {
-                    cancelled = (status == InferenceEngine::StatusCode::INFER_CANCELLED);
-                }
-            });
-
     req.StartAsync();
-    InferenceEngine::StatusCode cancelStatus = req.Cancel();
-    InferenceEngine::StatusCode waitStatus = req.Wait(InferenceEngine::IInferRequest::WaitMode::RESULT_READY);
 
-    if (targetDevice == CommonTestUtils::DEVICE_CPU) {
+    ASSERT_NO_THROW(req.Cancel());
-        ASSERT_EQ(true, cancelStatus == InferenceEngine::StatusCode::OK ||
+    try {
-                        cancelStatus == InferenceEngine::StatusCode::INFER_NOT_STARTED);
+        req.Wait(InferenceEngine::IInferRequest::WaitMode::RESULT_READY);
-        if (cancelStatus == InferenceEngine::StatusCode::OK) {
+    } catch (const InferenceEngine::InferCancelled& ex) {
-            ASSERT_EQ(true, cancelled);
+        SUCCEED();
-            ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::INFER_CANCELLED), waitStatus);
-        } else {
-            ASSERT_EQ(false, cancelled);
-            ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::OK), waitStatus);
-        }
-    } else {
-        ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::NOT_IMPLEMENTED), cancelStatus);
-        ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::OK), waitStatus);
     }
 }
 
@@ -79,14 +61,16 @@ TEST_P(CancellationTests, canResetAfterCancelAsyncRequest) {
     // Create InferRequest
     InferenceEngine::InferRequest req = execNet.CreateInferRequest();
 
-    req.StartAsync();
+    ASSERT_NO_THROW(req.StartAsync());
-    req.Cancel();
+    ASSERT_NO_THROW(req.Cancel());
-    req.Wait(InferenceEngine::IInferRequest::WaitMode::RESULT_READY);
+    try {
+        req.Wait(InferenceEngine::IInferRequest::WaitMode::RESULT_READY);
+    } catch (const InferenceEngine::InferCancelled& ex) {
+        SUCCEED();
+    }
 
-    req.StartAsync();
+    ASSERT_NO_THROW(req.StartAsync());
-    InferenceEngine::StatusCode waitStatus = req.Wait(InferenceEngine::IInferRequest::WaitMode::RESULT_READY);
+    ASSERT_NO_THROW(req.Wait(InferenceEngine::IInferRequest::WaitMode::RESULT_READY));
-
-    ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::OK), waitStatus);
 }
 
 TEST_P(CancellationTests, canCancelBeforeAsyncRequest) {
@@ -99,13 +83,7 @@ TEST_P(CancellationTests, canCancelBeforeAsyncRequest) {
     // Create InferRequest
     InferenceEngine::InferRequest req = execNet.CreateInferRequest();
 
-    InferenceEngine::StatusCode cancelStatus = req.Cancel();
+    ASSERT_NO_THROW(req.Cancel());
-
-    if (targetDevice == CommonTestUtils::DEVICE_CPU) {
-        ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::INFER_NOT_STARTED), cancelStatus);
-    } else {
-        ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::NOT_IMPLEMENTED), cancelStatus);
-    }
 }
 
 TEST_P(CancellationTests, canCancelInferRequest) {
@@ -126,24 +104,11 @@ TEST_P(CancellationTests, canCancelInferRequest) {
     while (req.Wait(statusOnly) == InferenceEngine::StatusCode::INFER_NOT_STARTED) {
     }
 
-    InferenceEngine::StatusCode cancelStatus = req.Cancel();
+    ASSERT_NO_THROW(req.Cancel());
-    InferenceEngine::StatusCode inferStatus = InferenceEngine::StatusCode::OK;
-
     try {
         infer.get();
-    } catch (InferenceEngine::details::InferenceEngineException& ex) {
+    } catch (const InferenceEngine::InferCancelled& ex) {
-        inferStatus = ex.getStatus();
+        SUCCEED();
-    }
-
-    if (targetDevice == CommonTestUtils::DEVICE_CPU) {
-        if (cancelStatus == InferenceEngine::StatusCode::OK) {
-            ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::INFER_CANCELLED), inferStatus);
-        } else {
-            ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::OK), inferStatus);
-        }
-    } else {
-        ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::NOT_IMPLEMENTED), cancelStatus);
-        ASSERT_EQ(static_cast<int>(InferenceEngine::StatusCode::OK), inferStatus);
     }
 }
 }  // namespace BehaviorTestsDefinitions

inference-engine/tests/ie_test_utils/unit_test_utils/mocks/cpp_interfaces/impl/mock_async_infer_request_internal.hpp

@@ -32,6 +32,6 @@ public:
     MOCK_METHOD1(setNetworkOutputs, void(OutputsDataMap));
     MOCK_METHOD1(GetBlob, Blob::Ptr(const std::string&));
     MOCK_METHOD1(SetCompletionCallback, void(IInferRequest::CompletionCallback));
-    MOCK_METHOD0(Cancel, InferenceEngine::StatusCode());
+    MOCK_METHOD0(Cancel, void());
-    MOCK_METHOD0(Cancel_ThreadUnsafe, InferenceEngine::StatusCode());
+    MOCK_METHOD0(Cancel_ThreadUnsafe, void());
 };

inference-engine/tests/ie_test_utils/unit_test_utils/mocks/cpp_interfaces/impl/mock_infer_request_internal.hpp

@@ -23,5 +23,5 @@ public:
     MOCK_METHOD0(InferImpl, void());
     MOCK_CONST_METHOD0(GetPerformanceCounts, std::map<std::string, InferenceEngineProfileInfo>());
     MOCK_METHOD0(checkBlobs, void());
-    MOCK_METHOD0(Cancel, InferenceEngine::StatusCode());
+    MOCK_METHOD0(Cancel, void());
 };

inference-engine/tests/ie_test_utils/unit_test_utils/mocks/cpp_interfaces/interface/mock_iasync_infer_request_internal.hpp

@@ -28,5 +28,5 @@ public:
     MOCK_METHOD1(SetCompletionCallback, void(InferenceEngine::IInferRequest::CompletionCallback));
     MOCK_METHOD1(SetBatch, void(int));
     MOCK_METHOD0(QueryState, std::vector<IVariableStateInternal::Ptr>());
-    MOCK_METHOD0(Cancel, InferenceEngine::StatusCode());
+    MOCK_METHOD0(Cancel, void());
 };