Compare index with size set at MessageQueueu constructor.

Author: yinggeh

src/message_queue.h

@@ -44,7 +44,8 @@ namespace bi = boost::interprocess;
 
 /// Struct holding the representation of a message queue inside the shared
 /// memory.
-/// \param size Total size of the message queue.
+/// \param size Total size of the message queue. Considered invalid after
+/// MessageQueue::LoadFromSharedMemory. Check DLIS-8378 for additional details.
 /// \param mutex Handle of the mutex variable protecting index.
 /// \param index Used element index.
 /// \param sem_empty Semaphore object counting the number of empty buffer slots.
@@ -118,13 +119,15 @@ class MessageQueue {
       int head_idx = Head();
       // Additional check to avoid out of bounds read/write. Check DLIS-8378 for
       // additional details.
-      if (head_idx < 0 || static_cast<size_t>(head_idx) >= Size()) {
-        constexpr const char* error_msg =
-            "Message queue head index out of bounds";
+      if (head_idx < 0 || static_cast<uint32_t>(head_idx) >= Size()) {
+        std::string error_msg =
+            "internal error: message queue head index out of bounds. Expects "
+            "positive integer less than the size of message queue " +
+            std::to_string(Size()) + " but got " + std::to_string(head_idx);
 #ifdef TRITON_PB_STUB
         LOG_ERROR << error_msg;
 #else
-        LOG_MESSAGE(TRITONSERVER_LOG_ERROR, error_msg);
+        LOG_MESSAGE(TRITONSERVER_LOG_ERROR, error_msg.c_str());
 #endif
         return;
       }
@@ -166,13 +169,15 @@ class MessageQueue {
       int head_idx = Head();
       // Additional check to avoid out of bounds read/write. Check DLIS-8378 for
       // additional details.
-      if (head_idx < 0 || static_cast<size_t>(head_idx) >= Size()) {
-        constexpr const char* error_msg =
-            "Message queue head index out of bounds";
+      if (head_idx < 0 || static_cast<uint32_t>(head_idx) >= Size()) {
+        std::string error_msg =
+            "internal error: message queue head index out of bounds. Expects "
+            "positive integer less than the size of message queue " +
+            std::to_string(Size()) + " but got " + std::to_string(head_idx);
 #ifdef TRITON_PB_STUB
         LOG_ERROR << error_msg;
 #else
-        LOG_MESSAGE(TRITONSERVER_LOG_ERROR, error_msg);
+        LOG_MESSAGE(TRITONSERVER_LOG_ERROR, error_msg.c_str());
 #endif
         return;
       }
@@ -275,7 +280,7 @@ class MessageQueue {
   }
 
  private:
-  std::size_t& Size() { return mq_shm_ptr_->size; }
+  uint32_t Size() { return size_; }
   const bi::interprocess_mutex& Mutex() { return mq_shm_ptr_->mutex; }
   bi::interprocess_mutex* MutexMutable() { return &(mq_shm_ptr_->mutex); }
   int& Head() { return mq_shm_ptr_->head; }
@@ -304,6 +309,7 @@ class MessageQueue {
   MessageQueueShm* mq_shm_ptr_;
   T* mq_buffer_shm_ptr_;
   bi::managed_external_buffer::handle_t mq_handle_;
+  uint32_t size_;
 
   /// Create/load a Message queue.
   /// \param mq_shm Message queue representation in shared memory.
@@ -315,6 +321,7 @@ class MessageQueue {
     mq_buffer_shm_ptr_ = mq_buffer_shm_.data_.get();
     mq_shm_ptr_ = mq_shm_.data_.get();
     mq_handle_ = mq_shm_.handle_;
+    size_ = mq_shm_ptr_->size;
   }
 };
 }}}  // namespace triton::backend::python

src/pb_utils.h

@@ -73,7 +73,7 @@ namespace bi = boost::interprocess;
             TRITONSERVER_ErrorMessage(pb2_exception.what()));      \
       }                                                            \
     }                                                              \
-    while (false)
+  } while (false)
 
 #define THROW_IF_TRITON_ERROR(X)                                              \
   do {                                                                        \