mirror of https://github.com/grpc/grpc.git
Craig Tiller
7 years ago
committed by
GitHub
commit
e9cb5d8da4
20 changed files with 704 additions and 662 deletions
@ -0,0 +1,328 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2017 gRPC authors. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||
* you may not use this file except in compliance with the License. |
||||
* You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software |
||||
* distributed under the License is distributed on an "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||
* See the License for the specific language governing permissions and |
||||
* limitations under the License. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_CORE_EXT_TRANSPORT_CHTTP2_TRANSPORT_FLOW_CONTROL_H |
||||
#define GRPC_CORE_EXT_TRANSPORT_CHTTP2_TRANSPORT_FLOW_CONTROL_H |
||||
|
||||
#include <stdint.h> |
||||
|
||||
#include <grpc/support/useful.h> |
||||
#include "src/core/ext/transport/chttp2/transport/http2_settings.h" |
||||
#include "src/core/lib/support/manual_constructor.h" |
||||
#include "src/core/lib/transport/bdp_estimator.h" |
||||
#include "src/core/lib/transport/pid_controller.h" |
||||
|
||||
struct grpc_chttp2_transport; |
||||
struct grpc_chttp2_stream; |
||||
|
||||
extern "C" grpc_tracer_flag grpc_flowctl_trace; |
||||
|
||||
namespace grpc_core { |
||||
namespace chttp2 { |
||||
|
||||
static constexpr uint32_t kDefaultWindow = 65535; |
||||
|
||||
class TransportFlowControl; |
||||
class StreamFlowControl; |
||||
|
||||
class FlowControlAction { |
||||
public: |
||||
enum class Urgency : uint8_t { |
||||
// Nothing to be done.
|
||||
NO_ACTION_NEEDED = 0, |
||||
// Initiate a write to update the initial window immediately.
|
||||
UPDATE_IMMEDIATELY, |
||||
// Push the flow control update into a send buffer, to be sent
|
||||
// out the next time a write is initiated.
|
||||
QUEUE_UPDATE, |
||||
}; |
||||
|
||||
Urgency send_stream_update() const { return send_stream_update_; } |
||||
Urgency send_transport_update() const { return send_transport_update_; } |
||||
Urgency send_initial_window_update() const { |
||||
return send_initial_window_update_; |
||||
} |
||||
Urgency send_max_frame_size_update() const { |
||||
return send_max_frame_size_update_; |
||||
} |
||||
uint32_t initial_window_size() const { return initial_window_size_; } |
||||
uint32_t max_frame_size() const { return max_frame_size_; } |
||||
|
||||
FlowControlAction& set_send_stream_update(Urgency u) { |
||||
send_stream_update_ = u; |
||||
return *this; |
||||
} |
||||
FlowControlAction& set_send_transport_update(Urgency u) { |
||||
send_transport_update_ = u; |
||||
return *this; |
||||
} |
||||
FlowControlAction& set_send_initial_window_update(Urgency u, |
||||
uint32_t update) { |
||||
send_initial_window_update_ = u; |
||||
initial_window_size_ = update; |
||||
return *this; |
||||
} |
||||
FlowControlAction& set_send_max_frame_size_update(Urgency u, |
||||
uint32_t update) { |
||||
send_max_frame_size_update_ = u; |
||||
max_frame_size_ = update; |
||||
return *this; |
||||
} |
||||
|
||||
static const char* UrgencyString(Urgency u); |
||||
void Trace(grpc_chttp2_transport* t) const; |
||||
|
||||
private: |
||||
Urgency send_stream_update_ = Urgency::NO_ACTION_NEEDED; |
||||
Urgency send_transport_update_ = Urgency::NO_ACTION_NEEDED; |
||||
Urgency send_initial_window_update_ = Urgency::NO_ACTION_NEEDED; |
||||
Urgency send_max_frame_size_update_ = Urgency::NO_ACTION_NEEDED; |
||||
uint32_t initial_window_size_ = 0; |
||||
uint32_t max_frame_size_ = 0; |
||||
}; |
||||
|
||||
class FlowControlTrace { |
||||
public: |
||||
FlowControlTrace(const char* reason, TransportFlowControl* tfc, |
||||
StreamFlowControl* sfc) { |
||||
if (enabled_) Init(reason, tfc, sfc); |
||||
} |
||||
|
||||
~FlowControlTrace() { |
||||
if (enabled_) Finish(); |
||||
} |
||||
|
||||
private: |
||||
void Init(const char* reason, TransportFlowControl* tfc, |
||||
StreamFlowControl* sfc); |
||||
void Finish(); |
||||
|
||||
const bool enabled_ = GRPC_TRACER_ON(grpc_flowctl_trace); |
||||
|
||||
TransportFlowControl* tfc_; |
||||
StreamFlowControl* sfc_; |
||||
const char* reason_; |
||||
int64_t remote_window_; |
||||
int64_t target_window_; |
||||
int64_t announced_window_; |
||||
int64_t remote_window_delta_; |
||||
int64_t local_window_delta_; |
||||
int64_t announced_window_delta_; |
||||
}; |
||||
|
||||
class TransportFlowControl { |
||||
public: |
||||
TransportFlowControl(grpc_exec_ctx* exec_ctx, const grpc_chttp2_transport* t, |
||||
bool enable_bdp_probe); |
||||
~TransportFlowControl() {} |
||||
|
||||
bool bdp_probe() const { return enable_bdp_probe_; } |
||||
|
||||
// returns an announce if we should send a transport update to our peer,
|
||||
// else returns zero; writing_anyway indicates if a write would happen
|
||||
// regardless of the send - if it is false and this function returns non-zero,
|
||||
// this announce will cause a write to occur
|
||||
uint32_t MaybeSendUpdate(bool writing_anyway); |
||||
|
||||
// Reads the flow control data and returns and actionable struct that will
|
||||
// tell chttp2 exactly what it needs to do
|
||||
FlowControlAction MakeAction() { return UpdateAction(FlowControlAction()); } |
||||
|
||||
// Call periodically (at a low-ish rate, 100ms - 10s makes sense)
|
||||
// to perform more complex flow control calculations and return an action
|
||||
// to let chttp2 change its parameters
|
||||
FlowControlAction PeriodicUpdate(grpc_exec_ctx* exec_ctx); |
||||
|
||||
void StreamSentData(int64_t size) { remote_window_ -= size; } |
||||
|
||||
grpc_error* ValidateRecvData(int64_t incoming_frame_size); |
||||
void CommitRecvData(int64_t incoming_frame_size) { |
||||
announced_window_ -= incoming_frame_size; |
||||
} |
||||
|
||||
grpc_error* RecvData(int64_t incoming_frame_size) { |
||||
FlowControlTrace trace(" data recv", this, nullptr); |
||||
grpc_error* error = ValidateRecvData(incoming_frame_size); |
||||
if (error != GRPC_ERROR_NONE) return error; |
||||
CommitRecvData(incoming_frame_size); |
||||
return GRPC_ERROR_NONE; |
||||
} |
||||
|
||||
// we have received a WINDOW_UPDATE frame for a transport
|
||||
void RecvUpdate(uint32_t size) { |
||||
FlowControlTrace trace("t updt recv", this, nullptr); |
||||
remote_window_ += size; |
||||
} |
||||
|
||||
int64_t remote_window() const { return remote_window_; } |
||||
int64_t target_window() const { |
||||
return (uint32_t)GPR_MIN((int64_t)((1u << 31) - 1), |
||||
announced_stream_total_over_incoming_window_ + |
||||
target_initial_window_size_); |
||||
} |
||||
int64_t announced_window() const { return announced_window_; } |
||||
|
||||
const grpc_chttp2_transport* transport() const { return t_; } |
||||
|
||||
void PreUpdateAnnouncedWindowOverIncomingWindow(int64_t delta) { |
||||
if (delta > 0) { |
||||
announced_stream_total_over_incoming_window_ -= delta; |
||||
} else { |
||||
announced_stream_total_under_incoming_window_ += -delta; |
||||
} |
||||
} |
||||
|
||||
void PostUpdateAnnouncedWindowOverIncomingWindow(int64_t delta) { |
||||
if (delta > 0) { |
||||
announced_stream_total_over_incoming_window_ += delta; |
||||
} else { |
||||
announced_stream_total_under_incoming_window_ -= -delta; |
||||
} |
||||
} |
||||
|
||||
BdpEstimator* bdp_estimator() { return &bdp_estimator_; } |
||||
|
||||
void TestOnlyForceHugeWindow() { |
||||
announced_window_ = 1024 * 1024 * 1024; |
||||
remote_window_ = 1024 * 1024 * 1024; |
||||
} |
||||
|
||||
private: |
||||
double TargetLogBdp(); |
||||
double SmoothLogBdp(grpc_exec_ctx* exec_ctx, double value); |
||||
FlowControlAction::Urgency DeltaUrgency(int32_t value, |
||||
grpc_chttp2_setting_id setting_id); |
||||
|
||||
FlowControlAction UpdateAction(FlowControlAction action) { |
||||
if (announced_window_ < target_window() / 2) { |
||||
action.set_send_transport_update( |
||||
FlowControlAction::Urgency::UPDATE_IMMEDIATELY); |
||||
} |
||||
return action; |
||||
} |
||||
|
||||
const grpc_chttp2_transport* const t_; |
||||
|
||||
/** Our bookkeeping for the remote peer's available window */ |
||||
int64_t remote_window_ = kDefaultWindow; |
||||
|
||||
/** calculating what we should give for local window:
|
||||
we track the total amount of flow control over initial window size |
||||
across all streams: this is data that we want to receive right now (it |
||||
has an outstanding read) |
||||
and the total amount of flow control under initial window size across all |
||||
streams: this is data we've read early |
||||
we want to adjust incoming_window such that: |
||||
incoming_window = total_over - max(bdp - total_under, 0) */ |
||||
int64_t announced_stream_total_over_incoming_window_ = 0; |
||||
int64_t announced_stream_total_under_incoming_window_ = 0; |
||||
|
||||
/** This is out window according to what we have sent to our remote peer. The
|
||||
* difference between this and target window is what we use to decide when |
||||
* to send WINDOW_UPDATE frames. */ |
||||
int64_t announced_window_ = kDefaultWindow; |
||||
|
||||
int32_t target_initial_window_size_ = kDefaultWindow; |
||||
|
||||
/** should we probe bdp? */ |
||||
const bool enable_bdp_probe_; |
||||
|
||||
/* bdp estimation */ |
||||
grpc_core::BdpEstimator bdp_estimator_; |
||||
|
||||
/* pid controller */ |
||||
grpc_core::PidController pid_controller_; |
||||
grpc_millis last_pid_update_ = 0; |
||||
}; |
||||
|
||||
class StreamFlowControl { |
||||
public: |
||||
StreamFlowControl(TransportFlowControl* tfc, const grpc_chttp2_stream* s); |
||||
~StreamFlowControl() { |
||||
tfc_->PreUpdateAnnouncedWindowOverIncomingWindow(announced_window_delta_); |
||||
} |
||||
|
||||
FlowControlAction UpdateAction(FlowControlAction action); |
||||
FlowControlAction MakeAction() { return UpdateAction(tfc_->MakeAction()); } |
||||
|
||||
// we have sent data on the wire, we must track this in our bookkeeping for
|
||||
// the remote peer's flow control.
|
||||
void SentData(int64_t outgoing_frame_size) { |
||||
FlowControlTrace tracer(" data sent", tfc_, this); |
||||
tfc_->StreamSentData(outgoing_frame_size); |
||||
remote_window_delta_ -= outgoing_frame_size; |
||||
} |
||||
|
||||
// we have received data from the wire
|
||||
grpc_error* RecvData(int64_t incoming_frame_size); |
||||
|
||||
// returns an announce if we should send a stream update to our peer, else
|
||||
// returns zero
|
||||
uint32_t MaybeSendUpdate(); |
||||
|
||||
// we have received a WINDOW_UPDATE frame for a stream
|
||||
void RecvUpdate(uint32_t size) { |
||||
FlowControlTrace trace("s updt recv", tfc_, this); |
||||
remote_window_delta_ += size; |
||||
} |
||||
|
||||
// the application is asking for a certain amount of bytes
|
||||
void IncomingByteStreamUpdate(size_t max_size_hint, size_t have_already); |
||||
|
||||
int64_t remote_window_delta() const { return remote_window_delta_; } |
||||
int64_t local_window_delta() const { return local_window_delta_; } |
||||
int64_t announced_window_delta() const { return announced_window_delta_; } |
||||
|
||||
const grpc_chttp2_stream* stream() const { return s_; } |
||||
|
||||
void TestOnlyForceHugeWindow() { |
||||
announced_window_delta_ = 1024 * 1024 * 1024; |
||||
local_window_delta_ = 1024 * 1024 * 1024; |
||||
remote_window_delta_ = 1024 * 1024 * 1024; |
||||
} |
||||
|
||||
private: |
||||
TransportFlowControl* const tfc_; |
||||
const grpc_chttp2_stream* const s_; |
||||
|
||||
void UpdateAnnouncedWindowDelta(TransportFlowControl* tfc, int64_t change) { |
||||
tfc->PreUpdateAnnouncedWindowOverIncomingWindow(announced_window_delta_); |
||||
announced_window_delta_ += change; |
||||
tfc->PostUpdateAnnouncedWindowOverIncomingWindow(announced_window_delta_); |
||||
} |
||||
|
||||
/** window available for us to send to peer, over or under the initial
|
||||
* window |
||||
* size of the transport... ie: |
||||
* remote_window = remote_window_delta + transport.initial_window_size */ |
||||
int64_t remote_window_delta_ = 0; |
||||
|
||||
/** window available for peer to send to us (as a delta on
|
||||
* transport.initial_window_size) |
||||
* local_window = local_window_delta + transport.initial_window_size */ |
||||
int64_t local_window_delta_ = 0; |
||||
|
||||
/** window available for peer to send to us over this stream that we have
|
||||
* announced to the peer */ |
||||
int64_t announced_window_delta_ = 0; |
||||
}; |
||||
|
||||
} // namespace chttp2
|
||||
} // namespace grpc_core
|
||||
|
||||
#endif |
||||
Loading…
Reference in new issue