-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Python backend request cancellation (#304)
* Add cancelled response status * Add request cancellation * Check cancellation on response factory if available * Remove unnecessary wrapping * Throw error instead of log error * Add is cancelled check at response sender * Enable more reuse on request cancellation and improve model interface * Documentation wording updates * Copyright year update * Rollback response sender auto close on cancel * Rollback non-decoupled any response on cancel * Decoupled final flag docs update
- Loading branch information
Showing
14 changed files
with
329 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| // Copyright 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| // | ||
| // Redistribution and use in source and binary forms, with or without | ||
| // modification, are permitted provided that the following conditions | ||
| // are met: | ||
| // * Redistributions of source code must retain the above copyright | ||
| // notice, this list of conditions and the following disclaimer. | ||
| // * Redistributions in binary form must reproduce the above copyright | ||
| // notice, this list of conditions and the following disclaimer in the | ||
| // documentation and/or other materials provided with the distribution. | ||
| // * Neither the name of NVIDIA CORPORATION nor the names of its | ||
| // contributors may be used to endorse or promote products derived | ||
| // from this software without specific prior written permission. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY | ||
| // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | ||
| // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
| // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
| // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
| // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | ||
| // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
|
||
| #include "pb_cancel.h" | ||
|
|
||
| #include "pb_stub.h" | ||
|
|
||
| namespace triton { namespace backend { namespace python { | ||
|
|
||
| void | ||
| PbCancel::SaveToSharedMemory(std::unique_ptr<SharedMemoryManager>& shm_pool) | ||
| { | ||
| cancel_shm_ = shm_pool->Construct<IsCancelledMessage>(); | ||
| new (&(cancel_shm_.data_->mu)) bi::interprocess_mutex; | ||
| new (&(cancel_shm_.data_->cv)) bi::interprocess_condition; | ||
| cancel_shm_.data_->waiting_on_stub = false; | ||
| cancel_shm_.data_->response_factory_address = response_factory_address_; | ||
| cancel_shm_.data_->request_address = request_address_; | ||
| cancel_shm_.data_->is_cancelled = is_cancelled_; | ||
| } | ||
|
|
||
| bi::managed_external_buffer::handle_t | ||
| PbCancel::ShmHandle() | ||
| { | ||
| return cancel_shm_.handle_; | ||
| } | ||
|
|
||
| IsCancelledMessage* | ||
| PbCancel::ShmPayload() | ||
| { | ||
| return cancel_shm_.data_.get(); | ||
| } | ||
|
|
||
| bool | ||
| PbCancel::IsCancelled() | ||
| { | ||
| std::unique_lock<std::mutex> lk(mu_); | ||
| // The cancelled flag can only move from false to true, not the other way, so | ||
| // it is checked on each query until cancelled and then implicitly cached. | ||
| if (is_cancelled_) { | ||
| return is_cancelled_; | ||
| } | ||
| if (!updating_) { | ||
| std::unique_ptr<Stub>& stub = Stub::GetOrCreateInstance(); | ||
| if (!stub->StubToParentServiceActive()) { | ||
| LOG_ERROR << "Cannot communicate with parent service"; | ||
| return false; | ||
| } | ||
| stub->EnqueueIsCancelled(this); | ||
| updating_ = true; | ||
| } | ||
| cv_.wait(lk, [this] { return !updating_; }); | ||
| return is_cancelled_; | ||
| } | ||
|
|
||
| void | ||
| PbCancel::ReportIsCancelled(bool is_cancelled) | ||
| { | ||
| { | ||
| std::lock_guard<std::mutex> lk(mu_); | ||
| is_cancelled_ = is_cancelled; | ||
| updating_ = false; | ||
| } | ||
| cv_.notify_all(); | ||
| } | ||
|
|
||
| }}} // namespace triton::backend::python |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // Copyright 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| // | ||
| // Redistribution and use in source and binary forms, with or without | ||
| // modification, are permitted provided that the following conditions | ||
| // are met: | ||
| // * Redistributions of source code must retain the above copyright | ||
| // notice, this list of conditions and the following disclaimer. | ||
| // * Redistributions in binary form must reproduce the above copyright | ||
| // notice, this list of conditions and the following disclaimer in the | ||
| // documentation and/or other materials provided with the distribution. | ||
| // * Neither the name of NVIDIA CORPORATION nor the names of its | ||
| // contributors may be used to endorse or promote products derived | ||
| // from this software without specific prior written permission. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY | ||
| // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | ||
| // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
| // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
| // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
| // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY | ||
| // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <condition_variable> | ||
| #include <mutex> | ||
|
|
||
| #include "pb_utils.h" | ||
|
|
||
| namespace triton { namespace backend { namespace python { | ||
|
|
||
| class PbCancel { | ||
| public: | ||
| PbCancel(intptr_t response_factory_address, intptr_t request_address) | ||
| : updating_(false), response_factory_address_(response_factory_address), | ||
| request_address_(request_address), is_cancelled_(false) | ||
| { | ||
| } | ||
| DISALLOW_COPY_AND_ASSIGN(PbCancel); | ||
|
|
||
| void SaveToSharedMemory(std::unique_ptr<SharedMemoryManager>& shm_pool); | ||
| bi::managed_external_buffer::handle_t ShmHandle(); | ||
| IsCancelledMessage* ShmPayload(); | ||
|
|
||
| bool IsCancelled(); | ||
| void ReportIsCancelled(bool is_cancelled); | ||
|
|
||
| private: | ||
| AllocatedSharedMemory<IsCancelledMessage> cancel_shm_; | ||
|
|
||
| std::mutex mu_; | ||
| std::condition_variable cv_; | ||
| bool updating_; | ||
|
|
||
| intptr_t response_factory_address_; | ||
| intptr_t request_address_; | ||
| bool is_cancelled_; | ||
| }; | ||
|
|
||
| }}}; // namespace triton::backend::python |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.