blob: 484b0e694c9cb98cdc60e9c44ed00e5854c9441b [file] [log] [blame]
/*
* Copyright (c) 2018 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#include "api/transport/test/network_control_tester.h"
#include "logging/rtc_event_log/mock/mock_rtc_event_log.h"
#include "modules/congestion_controller/goog_cc/include/goog_cc_factory.h"
#include "test/gtest.h"
using testing::Field;
using testing::Matcher;
using testing::NiceMock;
using testing::Property;
using testing::_;
namespace webrtc {
namespace webrtc_cc {
namespace test {
namespace {
const uint32_t kInitialBitrateKbps = 60;
const DataRate kInitialBitrate = DataRate::kbps(kInitialBitrateKbps);
const float kDefaultPacingRate = 2.5f;
} // namespace
class GoogCcNetworkControllerTest : public ::testing::Test {
protected:
GoogCcNetworkControllerTest()
: current_time_(Timestamp::ms(123456)), factory_(&event_log_) {}
~GoogCcNetworkControllerTest() override {}
void SetUp() override {
controller_ = factory_.Create(InitialConfig());
NetworkControlUpdate update =
controller_->OnProcessInterval(DefaultInterval());
EXPECT_EQ(update.target_rate->target_rate, kInitialBitrate);
EXPECT_EQ(update.pacer_config->data_rate(),
kInitialBitrate * kDefaultPacingRate);
EXPECT_EQ(update.probe_cluster_configs[0].target_data_rate,
kInitialBitrate * 3);
EXPECT_EQ(update.probe_cluster_configs[1].target_data_rate,
kInitialBitrate * 5);
}
// Custom setup - use an observer that tracks the target bitrate, without
// prescribing on which iterations it must change (like a mock would).
void TargetBitrateTrackingSetup() {
controller_ = factory_.Create(InitialConfig());
controller_->OnProcessInterval(DefaultInterval());
}
NetworkControllerConfig InitialConfig(
int starting_bandwidth_kbps = kInitialBitrateKbps,
int min_data_rate_kbps = 0,
int max_data_rate_kbps = 5 * kInitialBitrateKbps) {
NetworkControllerConfig config;
config.constraints.at_time = current_time_;
config.constraints.min_data_rate = DataRate::kbps(min_data_rate_kbps);
config.constraints.max_data_rate = DataRate::kbps(max_data_rate_kbps);
config.constraints.starting_rate = DataRate::kbps(starting_bandwidth_kbps);
return config;
}
ProcessInterval DefaultInterval() {
ProcessInterval interval;
interval.at_time = current_time_;
return interval;
}
RemoteBitrateReport CreateBitrateReport(DataRate rate) {
RemoteBitrateReport report;
report.receive_time = current_time_;
report.bandwidth = rate;
return report;
}
PacketResult CreateResult(int64_t arrival_time_ms,
int64_t send_time_ms,
size_t payload_size,
PacedPacketInfo pacing_info) {
PacketResult packet_result;
packet_result.sent_packet = SentPacket();
packet_result.sent_packet->send_time = Timestamp::ms(send_time_ms);
packet_result.sent_packet->size = DataSize::bytes(payload_size);
packet_result.sent_packet->pacing_info = pacing_info;
packet_result.receive_time = Timestamp::ms(arrival_time_ms);
return packet_result;
}
NetworkRouteChange CreateRouteChange(DataRate start_rate = DataRate::Zero(),
DataRate min_rate = DataRate::Zero(),
DataRate max_rate = DataRate::Zero()) {
NetworkRouteChange route_change;
route_change.at_time = current_time_;
route_change.constraints.at_time = current_time_;
route_change.constraints.min_data_rate = min_rate;
route_change.constraints.max_data_rate = max_rate;
route_change.constraints.starting_rate = start_rate;
return route_change;
}
void AdvanceTimeMilliseconds(int timedelta_ms) {
current_time_ += TimeDelta::ms(timedelta_ms);
}
void OnUpdate(NetworkControlUpdate update) {
if (update.target_rate)
target_bitrate_ = update.target_rate->target_rate;
}
void PacketTransmissionAndFeedbackBlock(int64_t runtime_ms, int64_t delay) {
int64_t delay_buildup = 0;
int64_t start_time_ms = current_time_.ms();
while (current_time_.ms() - start_time_ms < runtime_ms) {
constexpr size_t kPayloadSize = 1000;
PacketResult packet =
CreateResult(current_time_.ms() + delay_buildup, current_time_.ms(),
kPayloadSize, PacedPacketInfo());
delay_buildup += delay;
controller_->OnSentPacket(*packet.sent_packet);
TransportPacketsFeedback feedback;
feedback.feedback_time = packet.receive_time;
feedback.packet_feedbacks.push_back(packet);
OnUpdate(controller_->OnTransportPacketsFeedback(feedback));
AdvanceTimeMilliseconds(50);
OnUpdate(controller_->OnProcessInterval(DefaultInterval()));
}
}
Timestamp current_time_;
absl::optional<DataRate> target_bitrate_;
NiceMock<MockRtcEventLog> event_log_;
GoogCcNetworkControllerFactory factory_;
std::unique_ptr<NetworkControllerInterface> controller_;
};
TEST_F(GoogCcNetworkControllerTest, ReactsToChangedNetworkConditions) {
// Test no change.
AdvanceTimeMilliseconds(25);
controller_->OnProcessInterval(DefaultInterval());
NetworkControlUpdate update;
controller_->OnRemoteBitrateReport(CreateBitrateReport(kInitialBitrate * 2));
AdvanceTimeMilliseconds(25);
update = controller_->OnProcessInterval(DefaultInterval());
EXPECT_EQ(update.target_rate->target_rate, kInitialBitrate * 2);
EXPECT_EQ(update.pacer_config->data_rate(),
kInitialBitrate * 2 * kDefaultPacingRate);
controller_->OnRemoteBitrateReport(CreateBitrateReport(kInitialBitrate));
AdvanceTimeMilliseconds(25);
update = controller_->OnProcessInterval(DefaultInterval());
EXPECT_EQ(update.target_rate->target_rate, kInitialBitrate);
EXPECT_EQ(update.pacer_config->data_rate(),
kInitialBitrate * kDefaultPacingRate);
}
TEST_F(GoogCcNetworkControllerTest, OnNetworkRouteChanged) {
NetworkControlUpdate update;
DataRate new_bitrate = DataRate::bps(200000);
update = controller_->OnNetworkRouteChange(CreateRouteChange(new_bitrate));
EXPECT_EQ(update.target_rate->target_rate, new_bitrate);
EXPECT_EQ(update.pacer_config->data_rate(), new_bitrate * kDefaultPacingRate);
EXPECT_EQ(update.probe_cluster_configs.size(), 2u);
// If the bitrate is reset to -1, the new starting bitrate will be
// the minimum default bitrate.
const DataRate kDefaultMinBitrate = DataRate::bps(10000);
update = controller_->OnNetworkRouteChange(CreateRouteChange());
EXPECT_EQ(update.target_rate->target_rate, kDefaultMinBitrate);
EXPECT_EQ(update.pacer_config->data_rate(),
kDefaultMinBitrate * kDefaultPacingRate);
EXPECT_EQ(update.probe_cluster_configs.size(), 2u);
}
TEST_F(GoogCcNetworkControllerTest, ProbeOnRouteChange) {
NetworkControlUpdate update;
update = controller_->OnNetworkRouteChange(CreateRouteChange(
2 * kInitialBitrate, DataRate::Zero(), 20 * kInitialBitrate));
EXPECT_TRUE(update.pacer_config.has_value());
EXPECT_EQ(update.target_rate->target_rate, kInitialBitrate * 2);
EXPECT_EQ(update.probe_cluster_configs.size(), 2u);
EXPECT_EQ(update.probe_cluster_configs[0].target_data_rate,
kInitialBitrate * 6);
EXPECT_EQ(update.probe_cluster_configs[1].target_data_rate,
kInitialBitrate * 12);
update = controller_->OnProcessInterval(DefaultInterval());
}
// Estimated bitrate reduced when the feedbacks arrive with such a long delay,
// that the send-time-history no longer holds the feedbacked packets.
TEST_F(GoogCcNetworkControllerTest, LongFeedbackDelays) {
TargetBitrateTrackingSetup();
const webrtc::PacedPacketInfo kPacingInfo0(0, 5, 2000);
const webrtc::PacedPacketInfo kPacingInfo1(1, 8, 4000);
const int64_t kFeedbackTimeoutMs = 60001;
const int kMaxConsecutiveFailedLookups = 5;
for (int i = 0; i < kMaxConsecutiveFailedLookups; ++i) {
std::vector<PacketResult> packets;
packets.push_back(CreateResult(i * 100, 2 * i * 100, 1500, kPacingInfo0));
packets.push_back(
CreateResult(i * 100 + 10, 2 * i * 100 + 10, 1500, kPacingInfo0));
packets.push_back(
CreateResult(i * 100 + 20, 2 * i * 100 + 20, 1500, kPacingInfo0));
packets.push_back(
CreateResult(i * 100 + 30, 2 * i * 100 + 30, 1500, kPacingInfo1));
packets.push_back(
CreateResult(i * 100 + 40, 2 * i * 100 + 40, 1500, kPacingInfo1));
for (PacketResult& packet : packets) {
controller_->OnSentPacket(*packet.sent_packet);
// Simulate packet timeout
packet.sent_packet = absl::nullopt;
}
TransportPacketsFeedback feedback;
feedback.feedback_time = packets[0].receive_time;
feedback.packet_feedbacks = packets;
AdvanceTimeMilliseconds(kFeedbackTimeoutMs);
SentPacket later_packet;
later_packet.send_time = Timestamp::ms(kFeedbackTimeoutMs + i * 200 + 40);
later_packet.size = DataSize::bytes(1500);
later_packet.pacing_info = kPacingInfo1;
controller_->OnSentPacket(later_packet);
OnUpdate(controller_->OnTransportPacketsFeedback(feedback));
}
OnUpdate(controller_->OnProcessInterval(DefaultInterval()));
EXPECT_EQ(kInitialBitrateKbps / 2, target_bitrate_->kbps());
// Test with feedback that isn't late enough to time out.
{
std::vector<PacketResult> packets;
packets.push_back(CreateResult(100, 200, 1500, kPacingInfo0));
packets.push_back(CreateResult(110, 210, 1500, kPacingInfo0));
packets.push_back(CreateResult(120, 220, 1500, kPacingInfo0));
packets.push_back(CreateResult(130, 230, 1500, kPacingInfo1));
packets.push_back(CreateResult(140, 240, 1500, kPacingInfo1));
for (const PacketResult& packet : packets)
controller_->OnSentPacket(*packet.sent_packet);
TransportPacketsFeedback feedback;
feedback.feedback_time = packets[0].receive_time;
feedback.packet_feedbacks = packets;
AdvanceTimeMilliseconds(kFeedbackTimeoutMs - 1);
SentPacket later_packet;
later_packet.send_time = Timestamp::ms(kFeedbackTimeoutMs + 240);
later_packet.size = DataSize::bytes(1500);
later_packet.pacing_info = kPacingInfo1;
controller_->OnSentPacket(later_packet);
OnUpdate(controller_->OnTransportPacketsFeedback(feedback));
}
}
// Bandwidth estimation is updated when feedbacks are received.
// Feedbacks which show an increasing delay cause the estimation to be reduced.
TEST_F(GoogCcNetworkControllerTest, UpdatesDelayBasedEstimate) {
TargetBitrateTrackingSetup();
const int64_t kRunTimeMs = 6000;
// The test must run and insert packets/feedback long enough that the
// BWE computes a valid estimate. This is first done in an environment which
// simulates no bandwidth limitation, and therefore not built-up delay.
PacketTransmissionAndFeedbackBlock(kRunTimeMs, 0);
ASSERT_TRUE(target_bitrate_.has_value());
// Repeat, but this time with a building delay, and make sure that the
// estimation is adjusted downwards.
DataRate bitrate_before_delay = *target_bitrate_;
PacketTransmissionAndFeedbackBlock(kRunTimeMs, 50);
EXPECT_LT(*target_bitrate_, bitrate_before_delay);
}
TEST_F(GoogCcNetworkControllerTest,
FeedbackVersionUpdatesTargetSendRateBasedOnFeedback) {
GoogCcFeedbackNetworkControllerFactory factory(&event_log_);
webrtc::test::NetworkControllerTester tester(&factory,
InitialConfig(60, 0, 600));
auto packet_producer = &webrtc::test::SimpleTargetRateProducer::ProduceNext;
tester.RunSimulation(TimeDelta::seconds(10), TimeDelta::ms(10),
DataRate::kbps(300), TimeDelta::ms(100),
packet_producer);
EXPECT_NEAR(tester.GetState().target_rate->target_rate.kbps<double>(), 300,
50);
tester.RunSimulation(TimeDelta::seconds(10), TimeDelta::ms(10),
DataRate::kbps(500), TimeDelta::ms(100),
packet_producer);
EXPECT_NEAR(tester.GetState().target_rate->target_rate.kbps<double>(), 500,
100);
tester.RunSimulation(TimeDelta::seconds(30), TimeDelta::ms(10),
DataRate::kbps(100), TimeDelta::ms(200),
packet_producer);
EXPECT_NEAR(tester.GetState().target_rate->target_rate.kbps<double>(), 100,
20);
}
} // namespace test
} // namespace webrtc_cc
} // namespace webrtc