Add Correlation Id string support for BLS (triton-inference-server#344)

* Add correlation id string support for BLS

CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright 2020-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# Copyright 2020-2024, 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
@@ -149,6 +149,8 @@ configure_file(src/libtriton_python.ldscript libtriton_python.ldscript COPYONLY)
 
 set(
   COMMON_SRCS
+  src/correlation_id.cc
+  src/correlation_id.h
   src/infer_response.cc
   src/infer_response.h
   src/infer_request.cc

README.md

@@ -1,5 +1,5 @@
 <!--
-# Copyright 2020-2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# Copyright 2020-2024, 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
@@ -1125,6 +1125,8 @@ class TritonPythonModel:
       # `pb_utils.InferenceRequest` supports request_id, correlation_id,
       # model version, timeout and preferred_memory in addition to the
       # arguments described above.
+      # Note: Starting from the 24.03 release, the `correlation_id` parameter
+      # supports both string and unsigned integer values.
       # These arguments are optional. An example containing all the arguments:
       # inference_request = pb_utils.InferenceRequest(model_name='model_name',
       #   requested_output_names=['REQUESTED_OUTPUT_1', 'REQUESTED_OUTPUT_2'],
@@ -1262,11 +1264,13 @@ class TritonPythonModel:
       # `pb_utils.InferenceRequest` supports request_id, correlation_id,
       # model version, timeout and preferred_memory in addition to the
       # arguments described above.
+      # Note: Starting from the 24.03 release, the `correlation_id` parameter
+      # supports both string and unsigned integer values.
       # These arguments are optional. An example containing all the arguments:
       # inference_request = pb_utils.InferenceRequest(model_name='model_name',
       #   requested_output_names=['REQUESTED_OUTPUT_1', 'REQUESTED_OUTPUT_2'],
       #   inputs=[<list of pb_utils.Tensor objects>],
-      #   request_id="1", correlation_id=4, model_version=1, flags=0, timeout=5,
+      #   request_id="1", correlation_id="ex-4", model_version=1, flags=0, timeout=5,
       #   preferred_memory=pb_utils.PreferredMemory(
       #     pb_utils.TRITONSERVER_MEMORY_GPU, # or pb_utils.TRITONSERVER_MEMORY_CPU
       #     0))

src/correlation_id.cc

@@ -0,0 +1,120 @@
+// Copyright 2024, 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 "correlation_id.h"
+
+namespace triton { namespace backend { namespace python {
+
+CorrelationId::CorrelationId()
+    : id_string_(""), id_uint_(0), id_type_(CorrelationIdDataType::UINT64)
+{
+}
+
+CorrelationId::CorrelationId(const std::string& id_string)
+    : id_string_(id_string), id_uint_(0),
+      id_type_(CorrelationIdDataType::STRING)
+{
+}
+
+CorrelationId::CorrelationId(uint64_t id_uint)
+    : id_string_(""), id_uint_(id_uint), id_type_(CorrelationIdDataType::UINT64)
+{
+}
+
+CorrelationId::CorrelationId(const CorrelationId& rhs)
+{
+  id_uint_ = rhs.id_uint_;
+  id_type_ = rhs.id_type_;
+  id_string_ = rhs.id_string_;
+}
+
+CorrelationId::CorrelationId(std::unique_ptr<CorrelationId>& correlation_id_shm)
+{
+  id_uint_ = correlation_id_shm->id_uint_;
+  id_type_ = correlation_id_shm->id_type_;
+  id_string_ = correlation_id_shm->id_string_;
+}
+
+CorrelationId&
+CorrelationId::operator=(const CorrelationId& rhs)
+{
+  id_uint_ = rhs.id_uint_;
+  id_type_ = rhs.id_type_;
+  id_string_ = rhs.id_string_;
+  return *this;
+}
+
+void
+CorrelationId::SaveToSharedMemory(
+    std::unique_ptr<SharedMemoryManager>& shm_pool)
+{
+  AllocatedSharedMemory<CorrelationIdShm> correlation_id_shm =
+      shm_pool->Construct<CorrelationIdShm>();
+  correlation_id_shm_ptr_ = correlation_id_shm.data_.get();
+
+  std::unique_ptr<PbString> id_string_shm =
+      PbString::Create(shm_pool, id_string_);
+
+  correlation_id_shm_ptr_->id_uint = id_uint_;
+  correlation_id_shm_ptr_->id_string_shm_handle = id_string_shm->ShmHandle();
+  correlation_id_shm_ptr_->id_type = id_type_;
+
+  // Save the references to shared memory.
+  correlation_id_shm_ = std::move(correlation_id_shm);
+  id_string_shm_ = std::move(id_string_shm);
+  shm_handle_ = correlation_id_shm_.handle_;
+}
+
+std::unique_ptr<CorrelationId>
+CorrelationId::LoadFromSharedMemory(
+    std::unique_ptr<SharedMemoryManager>& shm_pool,
+    bi::managed_external_buffer::handle_t handle)
+{
+  AllocatedSharedMemory<CorrelationIdShm> correlation_id_shm =
+      shm_pool->Load<CorrelationIdShm>(handle);
+  CorrelationIdShm* correlation_id_shm_ptr = correlation_id_shm.data_.get();
+
+  std::unique_ptr<PbString> id_string_shm = PbString::LoadFromSharedMemory(
+      shm_pool, correlation_id_shm_ptr->id_string_shm_handle);
+
+  return std::unique_ptr<CorrelationId>(
+      new CorrelationId(correlation_id_shm, id_string_shm));
+}
+
+CorrelationId::CorrelationId(
+    AllocatedSharedMemory<CorrelationIdShm>& correlation_id_shm,
+    std::unique_ptr<PbString>& id_string_shm)
+    : correlation_id_shm_(std::move(correlation_id_shm)),
+      id_string_shm_(std::move(id_string_shm))
+{
+  correlation_id_shm_ptr_ = correlation_id_shm_.data_.get();
+  shm_handle_ = correlation_id_shm_.handle_;
+  id_string_ = id_string_shm_->String();
+  id_uint_ = correlation_id_shm_ptr_->id_uint;
+  id_type_ = correlation_id_shm_ptr_->id_type;
+}
+
+}}};  // namespace triton::backend::python

src/correlation_id.h

@@ -0,0 +1,93 @@
+// Copyright 2024, 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 <string>
+
+#include "pb_string.h"
+#include "pb_utils.h"
+
+namespace triton { namespace backend { namespace python {
+
+enum class CorrelationIdDataType { UINT64, STRING };
+
+struct CorrelationIdShm {
+  bi::managed_external_buffer::handle_t id_string_shm_handle;
+  uint64_t id_uint;
+  CorrelationIdDataType id_type;
+};
+
+class CorrelationId {
+ public:
+  CorrelationId();
+  CorrelationId(const std::string& id_string);
+  CorrelationId(uint64_t id_uint);
+  CorrelationId(const CorrelationId& rhs);
+  CorrelationId(std::unique_ptr<CorrelationId>& correlation_id_shm);
+  CorrelationId& operator=(const CorrelationId& rhs);
+
+  /// Save CorrelationId object to shared memory.
+  /// \param shm_pool Shared memory pool to save the CorrelationId object.
+  void SaveToSharedMemory(std::unique_ptr<SharedMemoryManager>& shm_pool);
+
+  /// Create a CorrelationId object from shared memory.
+  /// \param shm_pool Shared memory pool
+  /// \param handle Shared memory handle of the CorrelationId.
+  /// \return Returns the CorrelationId in the specified handle
+  /// location.
+  static std::unique_ptr<CorrelationId> LoadFromSharedMemory(
+      std::unique_ptr<SharedMemoryManager>& shm_pool,
+      bi::managed_external_buffer::handle_t handle);
+
+  // Function that help determine exact type of Correlation Id
+  CorrelationIdDataType Type() const { return id_type_; }
+
+  // Get the value of the CorrelationId based on the type
+  const std::string& StringValue() const { return id_string_; }
+  uint64_t UnsignedIntValue() const { return id_uint_; }
+
+  bi::managed_external_buffer::handle_t ShmHandle() { return shm_handle_; }
+
+ private:
+  // The private constructor for creating a CorrelationId object from shared
+  // memory.
+  CorrelationId(
+      AllocatedSharedMemory<CorrelationIdShm>& correlation_id_shm,
+      std::unique_ptr<PbString>& id_string_shm);
+
+  std::string id_string_;
+  uint64_t id_uint_;
+  CorrelationIdDataType id_type_;
+
+  // Shared Memory Data Structures
+  AllocatedSharedMemory<CorrelationIdShm> correlation_id_shm_;
+  CorrelationIdShm* correlation_id_shm_ptr_;
+  bi::managed_external_buffer::handle_t shm_handle_;
+  std::unique_ptr<PbString> id_string_shm_;
+};
+
+}}};  // namespace triton::backend::python