grpc 1.47.0 → 1.48.0.pre1

data/src/core/ext/transport/chttp2/transport/chttp2_transport.h

@@ -29,7 +29,7 @@
 #include "src/core/lib/gprpp/ref_counted_ptr.h"
 #include "src/core/lib/iomgr/closure.h"
 #include "src/core/lib/iomgr/endpoint.h"
-#include "src/core/lib/transport/transport.h"
+#include "src/core/lib/transport/transport_fwd.h"
 
 extern grpc_core::TraceFlag grpc_http_trace;
 extern grpc_core::TraceFlag grpc_keepalive_trace;

data/src/core/ext/transport/chttp2/transport/flow_control.cc

@@ -23,18 +23,18 @@
 #include <inttypes.h>
 #include <limits.h>
 
+#include <algorithm>
 #include <cmath>
+#include <ostream>
 #include <string>
+#include <vector>
 
+#include "absl/strings/str_cat.h"
 #include "absl/strings/str_format.h"
+#include "absl/strings/str_join.h"
 
-#include <grpc/slice.h>
-#include <grpc/support/alloc.h>
 #include <grpc/support/log.h>
 
-#include "src/core/ext/transport/chttp2/transport/frame.h"
-#include "src/core/ext/transport/chttp2/transport/internal.h"
-#include "src/core/lib/gpr/string.h"
 #include "src/core/lib/gpr/useful.h"
 #include "src/core/lib/iomgr/exec_ctx.h"
 #include "src/core/lib/resource_quota/memory_quota.h"
@@ -47,144 +47,63 @@ namespace chttp2 {
 TestOnlyTransportTargetWindowEstimatesMocker*
     g_test_only_transport_target_window_estimates_mocker;
 
-bool g_test_only_transport_flow_control_window_check;
-
 namespace {
 
-constexpr const int kTracePadding = 30;
 constexpr const int64_t kMaxWindowUpdateSize = (1u << 31) - 1;
 
-char* fmt_int64_diff_str(int64_t old_val, int64_t new_val) {
-  std::string str;
-  if (old_val != new_val) {
-    str = absl::StrFormat("%" PRId64 " -> %" PRId64 "", old_val, new_val);
-  } else {
-    str = absl::StrFormat("%" PRId64 "", old_val);
-  }
-  return gpr_leftpad(str.c_str(), ' ', kTracePadding);
-}
-
-char* fmt_uint32_diff_str(uint32_t old_val, uint32_t new_val) {
-  std::string str;
-  if (old_val != new_val) {
-    str = absl::StrFormat("%" PRIu32 " -> %" PRIu32 "", old_val, new_val);
-  } else {
-    str = absl::StrFormat("%" PRIu32 "", old_val);
-  }
-  return gpr_leftpad(str.c_str(), ' ', kTracePadding);
-}
 }  // namespace
 
-void FlowControlTrace::Init(const char* reason, TransportFlowControl* tfc,
-                            StreamFlowControl* sfc) {
-  tfc_ = tfc;
-  sfc_ = sfc;
-  reason_ = reason;
-  remote_window_ = tfc->remote_window();
-  target_window_ = tfc->target_window();
-  announced_window_ = tfc->announced_window();
-  if (sfc != nullptr) {
-    remote_window_delta_ = sfc->remote_window_delta();
-    local_window_delta_ = sfc->local_window_delta();
-    announced_window_delta_ = sfc->announced_window_delta();
-  }
-}
-
-void FlowControlTrace::Finish() {
-  uint32_t acked_local_window =
-      tfc_->transport()->settings[GRPC_SENT_SETTINGS]
-                                 [GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE];
-  uint32_t remote_window =
-      tfc_->transport()->settings[GRPC_PEER_SETTINGS]
-                                 [GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE];
-  char* trw_str = fmt_int64_diff_str(remote_window_, tfc_->remote_window());
-  char* tlw_str = fmt_int64_diff_str(target_window_, tfc_->target_window());
-  char* taw_str =
-      fmt_int64_diff_str(announced_window_, tfc_->announced_window());
-  char* srw_str;
-  char* slw_str;
-  char* saw_str;
-  if (sfc_ != nullptr) {
-    srw_str = fmt_int64_diff_str(remote_window_delta_ + remote_window,
-                                 sfc_->remote_window_delta() + remote_window);
-    slw_str =
-        fmt_int64_diff_str(local_window_delta_ + acked_local_window,
-                           sfc_->local_window_delta() + acked_local_window);
-    saw_str =
-        fmt_int64_diff_str(announced_window_delta_ + acked_local_window,
-                           sfc_->announced_window_delta() + acked_local_window);
-  } else {
-    srw_str = gpr_leftpad("", ' ', kTracePadding);
-    slw_str = gpr_leftpad("", ' ', kTracePadding);
-    saw_str = gpr_leftpad("", ' ', kTracePadding);
-  }
-  gpr_log(GPR_DEBUG,
-          "%p[%u][%s] | %s | trw:%s, tlw:%s, taw:%s, srw:%s, slw:%s, saw:%s",
-          tfc_, sfc_ != nullptr ? sfc_->stream()->id : 0,
-          tfc_->transport()->is_client ? "cli" : "svr", reason_, trw_str,
-          tlw_str, taw_str, srw_str, slw_str, saw_str);
-  gpr_free(trw_str);
-  gpr_free(tlw_str);
-  gpr_free(taw_str);
-  gpr_free(srw_str);
-  gpr_free(slw_str);
-  gpr_free(saw_str);
-}
-
 const char* FlowControlAction::UrgencyString(Urgency u) {
   switch (u) {
     case Urgency::NO_ACTION_NEEDED:
-      return "no action";
+      return "no-action";
     case Urgency::UPDATE_IMMEDIATELY:
-      return "update immediately";
+      return "now";
     case Urgency::QUEUE_UPDATE:
-      return "queue update";
+      return "queue";
     default:
       GPR_UNREACHABLE_CODE(return "unknown");
   }
   GPR_UNREACHABLE_CODE(return "unknown");
 }
 
-void FlowControlAction::Trace(grpc_chttp2_transport* t) const {
-  char* iw_str = fmt_uint32_diff_str(
-      t->settings[GRPC_SENT_SETTINGS][GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE],
-      initial_window_size_);
-  char* mf_str = fmt_uint32_diff_str(
-      t->settings[GRPC_SENT_SETTINGS][GRPC_CHTTP2_SETTINGS_MAX_FRAME_SIZE],
-      max_frame_size_);
-  gpr_log(GPR_DEBUG, "t[%s],  s[%s], iw:%s:%s mf:%s:%s",
-          UrgencyString(send_transport_update_),
-          UrgencyString(send_stream_update_),
-          UrgencyString(send_initial_window_update_), iw_str,
-          UrgencyString(send_max_frame_size_update_), mf_str);
-  gpr_free(iw_str);
-  gpr_free(mf_str);
+std::ostream& operator<<(std::ostream& out, FlowControlAction::Urgency u) {
+  return out << FlowControlAction::UrgencyString(u);
 }
 
-TransportFlowControlDisabled::TransportFlowControlDisabled(
-    grpc_chttp2_transport* t) {
-  remote_window_ = kMaxWindow;
-  target_initial_window_size_ = kMaxWindow;
-  announced_window_ = kMaxWindow;
-  t->settings[GRPC_PEER_SETTINGS][GRPC_CHTTP2_SETTINGS_MAX_FRAME_SIZE] =
-      kFrameSize;
-  t->settings[GRPC_SENT_SETTINGS][GRPC_CHTTP2_SETTINGS_MAX_FRAME_SIZE] =
-      kFrameSize;
-  t->settings[GRPC_ACKED_SETTINGS][GRPC_CHTTP2_SETTINGS_MAX_FRAME_SIZE] =
-      kFrameSize;
-  t->settings[GRPC_PEER_SETTINGS][GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE] =
-      kMaxWindow;
-  t->settings[GRPC_SENT_SETTINGS][GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE] =
-      kMaxWindow;
-  t->settings[GRPC_ACKED_SETTINGS][GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE] =
-      kMaxWindow;
+std::string FlowControlAction::DebugString() const {
+  std::vector<std::string> segments;
+  if (send_transport_update_ != Urgency::NO_ACTION_NEEDED) {
+    segments.push_back(
+        absl::StrCat("t:", UrgencyString(send_transport_update_)));
+  }
+  if (send_stream_update_ != Urgency::NO_ACTION_NEEDED) {
+    segments.push_back(absl::StrCat("s:", UrgencyString(send_stream_update_)));
+  }
+  if (send_initial_window_update_ != Urgency::NO_ACTION_NEEDED) {
+    segments.push_back(
+        absl::StrCat("iw=", initial_window_size_, ":",
+                     UrgencyString(send_initial_window_update_)));
+  }
+  if (send_max_frame_size_update_ != Urgency::NO_ACTION_NEEDED) {
+    segments.push_back(
+        absl::StrCat("mf=", max_frame_size_, ":",
+                     UrgencyString(send_max_frame_size_update_)));
+  }
+  if (segments.empty()) return "no action";
+  return absl::StrJoin(segments, ",");
 }
 
-TransportFlowControl::TransportFlowControl(const grpc_chttp2_transport* t,
-                                           bool enable_bdp_probe)
-    : t_(t),
+std::ostream& operator<<(std::ostream& out, const FlowControlAction& action) {
+  return out << action.DebugString();
+}
+
+TransportFlowControl::TransportFlowControl(const char* name,
+                                           bool enable_bdp_probe,
+                                           MemoryOwner* memory_owner)
+    : memory_owner_(memory_owner),
       enable_bdp_probe_(enable_bdp_probe),
-      bdp_estimator_(t->peer_string.c_str()),
+      bdp_estimator_(name),
       pid_controller_(PidController::Args()
                           .set_gain_p(4)
                           .set_gain_i(8)
@@ -196,7 +115,6 @@ TransportFlowControl::TransportFlowControl(const grpc_chttp2_transport* t,
       last_pid_update_(ExecCtx::Get()->Now()) {}
 
 uint32_t TransportFlowControl::MaybeSendUpdate(bool writing_anyway) {
-  FlowControlTrace trace("t updt sent", this, nullptr);
   const uint32_t target_announced_window =
       static_cast<uint32_t>(target_window());
   if ((writing_anyway || announced_window_ <= target_announced_window / 2) &&
@@ -210,121 +128,55 @@ uint32_t TransportFlowControl::MaybeSendUpdate(bool writing_anyway) {
   return 0;
 }
 
-grpc_error_handle TransportFlowControl::ValidateRecvData(
-    int64_t incoming_frame_size) {
-  if (incoming_frame_size > announced_window_) {
-    return GRPC_ERROR_CREATE_FROM_CPP_STRING(absl::StrFormat(
-        "frame of size %" PRId64 " overflows local window of %" PRId64,
-        incoming_frame_size, announced_window_));
-  }
-  return GRPC_ERROR_NONE;
-}
+StreamFlowControl::StreamFlowControl(TransportFlowControl* tfc) : tfc_(tfc) {}
 
-StreamFlowControl::StreamFlowControl(TransportFlowControl* tfc,
-                                     const grpc_chttp2_stream* s)
-    : tfc_(tfc), s_(s) {}
-
-grpc_error_handle StreamFlowControl::RecvData(int64_t incoming_frame_size) {
-  FlowControlTrace trace("  data recv", tfc_, this);
-
-  grpc_error_handle error = GRPC_ERROR_NONE;
-  error = tfc_->ValidateRecvData(incoming_frame_size);
-  if (error != GRPC_ERROR_NONE) return error;
-
-  uint32_t sent_init_window =
-      tfc_->transport()->settings[GRPC_SENT_SETTINGS]
-                                 [GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE];
-  uint32_t acked_init_window =
-      tfc_->transport()->settings[GRPC_ACKED_SETTINGS]
-                                 [GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE];
-
-  int64_t acked_stream_window = announced_window_delta_ + acked_init_window;
-  int64_t sent_stream_window = announced_window_delta_ + sent_init_window;
-  if (incoming_frame_size > acked_stream_window) {
-    if (incoming_frame_size <= sent_stream_window) {
-      gpr_log(GPR_ERROR,
-              "Incoming frame of size %" PRId64
-              " exceeds local window size of %" PRId64
-              ".\n"
-              "The (un-acked, future) window size would be %" PRId64
-              " which is not exceeded.\n"
-              "This would usually cause a disconnection, but allowing it due to"
-              "broken HTTP2 implementations in the wild.\n"
-              "See (for example) https://github.com/netty/netty/issues/6520.",
-              incoming_frame_size, acked_stream_window, sent_stream_window);
-    } else {
-      return GRPC_ERROR_CREATE_FROM_CPP_STRING(absl::StrFormat(
+absl::Status StreamFlowControl::IncomingUpdateContext::RecvData(
+    int64_t incoming_frame_size) {
+  return tfc_upd_.RecvData(incoming_frame_size, [this, incoming_frame_size]() {
+    int64_t acked_stream_window =
+        sfc_->announced_window_delta_ + sfc_->tfc_->acked_init_window();
+    if (incoming_frame_size > acked_stream_window) {
+      return absl::InternalError(absl::StrFormat(
           "frame of size %" PRId64 " overflows local window of %" PRId64,
           incoming_frame_size, acked_stream_window));
     }
-  }
 
-  UpdateAnnouncedWindowDelta(tfc_, -incoming_frame_size);
-  local_window_delta_ -= incoming_frame_size;
-  tfc_->CommitRecvData(incoming_frame_size);
-  return GRPC_ERROR_NONE;
+    tfc_upd_.UpdateAnnouncedWindowDelta(&sfc_->announced_window_delta_,
+                                        -incoming_frame_size);
+    sfc_->min_progress_size_ -=
+        std::min(sfc_->min_progress_size_, incoming_frame_size);
+    return absl::OkStatus();
+  });
 }
 
-uint32_t StreamFlowControl::MaybeSendUpdate() {
-  FlowControlTrace trace("s updt sent", tfc_, this);
-  // If a recently sent settings frame caused the stream's flow control window
-  // to go in the negative (or < GRPC_HEADER_SIZE_IN_BYTES), update the delta if
-  // one of the following conditions is satisfied -
-  // 1) There is a pending byte_stream and higher layers have expressed interest
-  // in reading additional data through the invokation of `Next()` where the
-  // bytes are to be available asynchronously. 2) There is a pending
-  // recv_message op.
-  // In these cases, we want to make sure that bytes are still flowing.
-  if (local_window_delta_ < GRPC_HEADER_SIZE_IN_BYTES) {
-    if (s_->on_next != nullptr) {
-      GPR_DEBUG_ASSERT(s_->pending_byte_stream);
-      IncomingByteStreamUpdate(GRPC_HEADER_SIZE_IN_BYTES, 0);
-    } else if (s_->recv_message != nullptr) {
-      IncomingByteStreamUpdate(GRPC_HEADER_SIZE_IN_BYTES,
-                               s_->frame_storage.length);
-    }
-  }
-  if (local_window_delta_ > announced_window_delta_) {
-    uint32_t announce = static_cast<uint32_t>(
-        Clamp(local_window_delta_ - announced_window_delta_, int64_t(0),
-              kMaxWindowUpdateSize));
-    UpdateAnnouncedWindowDelta(tfc_, announce);
-    return announce;
+absl::Status TransportFlowControl::IncomingUpdateContext::RecvData(
+    int64_t incoming_frame_size, absl::FunctionRef<absl::Status()> stream) {
+  if (incoming_frame_size > tfc_->announced_window_) {
+    return absl::InternalError(absl::StrFormat(
+        "frame of size %" PRId64 " overflows local window of %" PRId64,
+        incoming_frame_size, tfc_->announced_window_));
   }
-  return 0;
+  absl::Status error = stream();
+  if (!error.ok()) return error;
+  tfc_->announced_window_ -= incoming_frame_size;
+  return absl::OkStatus();
 }
 
-void StreamFlowControl::IncomingByteStreamUpdate(size_t max_size_hint,
-                                                 size_t have_already) {
-  FlowControlTrace trace("app st recv", tfc_, this);
-  uint32_t max_recv_bytes;
-
-  /* clamp max recv hint to an allowable size */
-  if (max_size_hint >= kMaxWindowDelta) {
-    max_recv_bytes = kMaxWindowDelta;
-  } else {
-    max_recv_bytes = static_cast<uint32_t>(max_size_hint);
-  }
-
-  /* account for bytes already received but unknown to higher layers */
-  if (max_recv_bytes >= have_already) {
-    max_recv_bytes -= static_cast<uint32_t>(have_already);
-  } else {
-    max_recv_bytes = 0;
-  }
+int64_t TransportFlowControl::target_window() const {
+  // See comment above announced_stream_total_over_incoming_window_ for the
+  // logic behind this decision.
+  return static_cast<uint32_t>(
+      std::min(static_cast<int64_t>((1u << 31) - 1),
+               announced_stream_total_over_incoming_window_ +
+                   target_initial_window_size_));
+}
 
-  /* add some small lookahead to keep pipelines flowing */
-  GPR_DEBUG_ASSERT(
-      max_recv_bytes <=
-      kMaxWindowUpdateSize -
-          tfc_->transport()
-              ->settings[GRPC_SENT_SETTINGS]
-                        [GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE]);
-  if (local_window_delta_ < max_recv_bytes) {
-    uint32_t add_max_recv_bytes =
-        static_cast<uint32_t>(max_recv_bytes - local_window_delta_);
-    local_window_delta_ += add_max_recv_bytes;
+FlowControlAction TransportFlowControl::UpdateAction(FlowControlAction action) {
+  if (announced_window_ < target_window() / 2) {
+    action.set_send_transport_update(
+        FlowControlAction::Urgency::UPDATE_IMMEDIATELY);
   }
+  return action;
 }
 
 // Take in a target and modifies it based on the memory pressure of the system
@@ -345,10 +197,9 @@ static double AdjustForMemoryPressure(double memory_pressure, double target) {
 }
 
 double TransportFlowControl::TargetLogBdp() {
-  return AdjustForMemoryPressure(t_->memory_owner.is_valid()
-                                     ? t_->memory_owner.InstantaneousPressure()
-                                     : 0.0,
-                                 1 + log2(bdp_estimator_.EstimateBdp()));
+  return AdjustForMemoryPressure(
+      memory_owner_->is_valid() ? memory_owner_->InstantaneousPressure() : 0.0,
+      1 + log2(bdp_estimator_.EstimateBdp()));
 }
 
 double TransportFlowControl::SmoothLogBdp(double value) {
@@ -361,15 +212,17 @@ double TransportFlowControl::SmoothLogBdp(double value) {
   return pid_controller_.Update(bdp_error, dt > kMaxDt ? kMaxDt : dt);
 }
 
-FlowControlAction::Urgency TransportFlowControl::DeltaUrgency(
-    int64_t value, grpc_chttp2_setting_id setting_id) {
-  int64_t delta = value - static_cast<int64_t>(
-                              t_->settings[GRPC_LOCAL_SETTINGS][setting_id]);
+void TransportFlowControl::UpdateSetting(
+    int64_t* desired_value, int64_t new_desired_value,
+    FlowControlAction* action,
+    FlowControlAction& (FlowControlAction::*set)(FlowControlAction::Urgency,
+                                                 uint32_t)) {
+  int64_t delta = new_desired_value - *desired_value;
   // TODO(ncteisen): tune this
-  if (delta != 0 && (delta <= -value / 5 || delta >= value / 5)) {
-    return FlowControlAction::Urgency::QUEUE_UPDATE;
-  } else {
-    return FlowControlAction::Urgency::NO_ACTION_NEEDED;
+  if (delta != 0 &&
+      (delta <= -*desired_value / 5 || delta >= *desired_value / 5)) {
+    *desired_value = new_desired_value;
+    (action->*set)(FlowControlAction::Urgency::QUEUE_UPDATE, *desired_value);
   }
 }
 
@@ -389,46 +242,73 @@ FlowControlAction TransportFlowControl::PeriodicUpdate() {
     }
     // Though initial window 'could' drop to 0, we keep the floor at
     // kMinInitialWindowSize
-    target_initial_window_size_ = static_cast<int32_t>(Clamp(
-        target, double(kMinInitialWindowSize), double(kMaxInitialWindowSize)));
-    action.set_send_initial_window_update(
-        DeltaUrgency(target_initial_window_size_,
-                     GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE),
-        static_cast<uint32_t>(target_initial_window_size_));
+    UpdateSetting(
+        &target_initial_window_size_,
+        static_cast<int32_t>(Clamp(target, double(kMinInitialWindowSize),
+                                   double(kMaxInitialWindowSize))),
+        &action, &FlowControlAction::set_send_initial_window_update);
 
     // get bandwidth estimate and update max_frame accordingly.
     double bw_dbl = bdp_estimator_.EstimateBandwidth();
     // we target the max of BDP or bandwidth in microseconds.
-    int32_t frame_size = static_cast<int32_t>(Clamp(
-        std::max(
-            static_cast<int32_t>(Clamp(bw_dbl, 0.0, double(INT_MAX))) / 1000,
-            static_cast<int32_t>(target_initial_window_size_)),
-        16384, 16777215));
-    action.set_send_max_frame_size_update(
-        DeltaUrgency(static_cast<int64_t>(frame_size),
-                     GRPC_CHTTP2_SETTINGS_MAX_FRAME_SIZE),
-        frame_size);
+    UpdateSetting(
+        &target_frame_size_,
+        static_cast<int32_t>(Clamp(
+            std::max(static_cast<int32_t>(Clamp(bw_dbl, 0.0, double(INT_MAX))) /
+                         1000,
+                     static_cast<int32_t>(target_initial_window_size_)),
+            16384, 16777215)),
+        &action, &FlowControlAction::set_send_max_frame_size_update);
   }
   return UpdateAction(action);
 }
 
+uint32_t StreamFlowControl::MaybeSendUpdate() {
+  TransportFlowControl::IncomingUpdateContext tfc_upd(tfc_);
+  const uint32_t announce = DesiredAnnounceSize();
+  pending_size_ = absl::nullopt;
+  tfc_upd.UpdateAnnouncedWindowDelta(&announced_window_delta_, announce);
+  GPR_ASSERT(DesiredAnnounceSize() == 0);
+  tfc_upd.MakeAction();
+  return announce;
+}
+
+uint32_t StreamFlowControl::DesiredAnnounceSize() const {
+  int64_t desired_window_delta = [this]() {
+    if (min_progress_size_ == 0) {
+      if (pending_size_.has_value() &&
+          announced_window_delta_ < -*pending_size_) {
+        return -*pending_size_;
+      } else {
+        return announced_window_delta_;
+      }
+    } else {
+      return std::min(min_progress_size_, kMaxWindowDelta);
+    }
+  }();
+  return Clamp(desired_window_delta - announced_window_delta_, int64_t(0),
+               kMaxWindowUpdateSize);
+}
+
 FlowControlAction StreamFlowControl::UpdateAction(FlowControlAction action) {
-  // TODO(ncteisen): tune this
-  if (!s_->read_closed) {
-    uint32_t sent_init_window =
-        tfc_->transport()->settings[GRPC_SENT_SETTINGS]
-                                   [GRPC_CHTTP2_SETTINGS_INITIAL_WINDOW_SIZE];
-    if (local_window_delta_ > announced_window_delta_ &&
-        announced_window_delta_ + sent_init_window <= sent_init_window / 2) {
+  const int64_t desired_announce_size = DesiredAnnounceSize();
+  if (desired_announce_size > 0) {
+    if ((min_progress_size_ > 0 && announced_window_delta_ < 0) ||
+        desired_announce_size >= 8192) {
       action.set_send_stream_update(
           FlowControlAction::Urgency::UPDATE_IMMEDIATELY);
-    } else if (local_window_delta_ > announced_window_delta_) {
+    } else {
       action.set_send_stream_update(FlowControlAction::Urgency::QUEUE_UPDATE);
     }
   }
-
   return action;
 }
 
+void StreamFlowControl::IncomingUpdateContext::SetPendingSize(
+    int64_t pending_size) {
+  GPR_ASSERT(pending_size >= 0);
+  sfc_->pending_size_ = pending_size;
+}
+
 }  // namespace chttp2
 }  // namespace grpc_core