From: Radosław Zarzyński <rzarzyns@redhat.com>
Date: Sat, 2 Apr 2022 09:22:19 +0000 (+0200)
Subject: crimson/osd: document OperationThrottler's behavior towards op's blocker list.
X-Git-Tag: v18.0.0~947^2~46
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=2dc3770f7a195f6575277ad2ccd7c1e2bc1abcdc;p=ceph-ci.git

crimson/osd: document OperationThrottler's behavior towards op's blocker list.

Signed-off-by: Radosław Zarzyński <rzarzyns@redhat.com>
---

diff --git a/src/crimson/osd/osd_operation.h b/src/crimson/osd/osd_operation.h
index d883af55b8f..1eee01554b2 100644
--- a/src/crimson/osd/osd_operation.h
+++ b/src/crimson/osd/osd_operation.h
@@ -183,6 +183,10 @@ class OperationThrottler : public BlockerT<OperationThrottler>,
     F &&f) {
     if (!max_in_progress) return f();
     auto fut = acquire_throttle(params);
+    // At any given moment a particular op can  be blocked by a given
+    // OperationThrottler instance no more than once. This means the
+    // same throtter won't be on the op's blockers list more than one
+    // time.
     return op->with_blocking_future(std::move(fut))
       .then(std::forward<F>(f))
       .then([this](auto x) {