Google Git
Sign in
webrtc / src / 54c8230a472603aa97770e34b5e891eba4dde7b8 / . / logging / rtc_event_log / rtc_event_log_unittest.cc
blob: a181a858914f610b4602bfe08a1027e47c7ac603 [file] [log] [blame]
/*
* Copyright (c) 2015 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/rtc_event_log/rtc_event_log.h"
#include <algorithm>
#include <cstddef>
#include <cstdint>
#include <limits>
#include <map>
#include <memory>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
#include "api/environment/environment.h"
#include "api/environment/environment_factory.h"
#include "api/rtc_event_log/rtc_event_log_factory.h"
#include "api/units/time_delta.h"
#include "api/units/timestamp.h"
#include "logging/rtc_event_log/events/rtc_event_alr_state.h"
#include "logging/rtc_event_log/events/rtc_event_audio_network_adaptation.h"
#include "logging/rtc_event_log/events/rtc_event_audio_playout.h"
#include "logging/rtc_event_log/events/rtc_event_audio_receive_stream_config.h"
#include "logging/rtc_event_log/events/rtc_event_audio_send_stream_config.h"
#include "logging/rtc_event_log/events/rtc_event_bwe_update_delay_based.h"
#include "logging/rtc_event_log/events/rtc_event_bwe_update_loss_based.h"
#include "logging/rtc_event_log/events/rtc_event_dtls_transport_state.h"
#include "logging/rtc_event_log/events/rtc_event_dtls_writable_state.h"
#include "logging/rtc_event_log/events/rtc_event_frame_decoded.h"
#include "logging/rtc_event_log/events/rtc_event_generic_ack_received.h"
#include "logging/rtc_event_log/events/rtc_event_generic_packet_received.h"
#include "logging/rtc_event_log/events/rtc_event_generic_packet_sent.h"
#include "logging/rtc_event_log/events/rtc_event_ice_candidate_pair.h"
#include "logging/rtc_event_log/events/rtc_event_ice_candidate_pair_config.h"
#include "logging/rtc_event_log/events/rtc_event_probe_cluster_created.h"
#include "logging/rtc_event_log/events/rtc_event_probe_result_failure.h"
#include "logging/rtc_event_log/events/rtc_event_probe_result_success.h"
#include "logging/rtc_event_log/events/rtc_event_remote_estimate.h"
#include "logging/rtc_event_log/events/rtc_event_route_change.h"
#include "logging/rtc_event_log/events/rtc_event_rtcp_packet_incoming.h"
#include "logging/rtc_event_log/events/rtc_event_rtcp_packet_outgoing.h"
#include "logging/rtc_event_log/events/rtc_event_rtp_packet_incoming.h"
#include "logging/rtc_event_log/events/rtc_event_rtp_packet_outgoing.h"
#include "logging/rtc_event_log/events/rtc_event_video_receive_stream_config.h"
#include "logging/rtc_event_log/events/rtc_event_video_send_stream_config.h"
#include "logging/rtc_event_log/rtc_event_log_parser.h"
#include "logging/rtc_event_log/rtc_event_log_unittest_helper.h"
#include "modules/rtp_rtcp/include/rtp_header_extension_map.h"
#include "modules/rtp_rtcp/include/rtp_rtcp_defines.h"
#include "modules/rtp_rtcp/source/rtp_dependency_descriptor_extension.h"
#include "rtc_base/checks.h"
#include "rtc_base/fake_clock.h"
#include "rtc_base/random.h"
#include "rtc_base/time_utils.h"
#include "test/explicit_key_value_config.h"
#include "test/gtest.h"
#include "test/logging/log_writer.h"
#include "test/logging/memory_log_writer.h"
#include "test/testsupport/file_utils.h"
namespace webrtc {
namespace {
using test::ExplicitKeyValueConfig;
struct EventCounts {
size_t audio_send_streams = 0;
size_t audio_recv_streams = 0;
size_t video_send_streams = 0;
size_t video_recv_streams = 0;
size_t alr_states = 0;
size_t route_changes = 0;
size_t audio_playouts = 0;
size_t ana_configs = 0;
size_t bwe_loss_events = 0;
size_t bwe_delay_events = 0;
size_t dtls_transport_states = 0;
size_t dtls_writable_states = 0;
size_t frame_decoded_events = 0;
size_t probe_creations = 0;
size_t probe_successes = 0;
size_t probe_failures = 0;
size_t ice_configs = 0;
size_t ice_events = 0;
size_t incoming_rtp_packets = 0;
size_t outgoing_rtp_packets = 0;
size_t incoming_rtcp_packets = 0;
size_t outgoing_rtcp_packets = 0;
size_t generic_packets_sent = 0;
size_t generic_packets_received = 0;
size_t generic_acks_received = 0;
size_t total_nonconfig_events() const {
return alr_states + route_changes + audio_playouts + ana_configs +
bwe_loss_events + bwe_delay_events + dtls_transport_states +
dtls_writable_states + frame_decoded_events + probe_creations +
probe_successes + probe_failures + ice_configs + ice_events +
incoming_rtp_packets + outgoing_rtp_packets + incoming_rtcp_packets +
outgoing_rtcp_packets + generic_packets_sent +
generic_packets_received + generic_acks_received;
}
size_t total_config_events() const {
return audio_send_streams + audio_recv_streams + video_send_streams +
video_recv_streams;
}
size_t total_events() const {
return total_nonconfig_events() + total_config_events();
}
};
std::unique_ptr<FieldTrialsView> CreateFieldTrialsFor(
RtcEventLog::EncodingType encoding_type) {
switch (encoding_type) {
case RtcEventLog::EncodingType::Legacy:
return std::make_unique<ExplicitKeyValueConfig>(
"WebRTC-RtcEventLogNewFormat/Disabled/");
case RtcEventLog::EncodingType::NewFormat:
return std::make_unique<ExplicitKeyValueConfig>(
"WebRTC-RtcEventLogNewFormat/Enabled/");
case RtcEventLog::EncodingType::ProtoFree:
RTC_CHECK(false);
return nullptr;
}
}
class RtcEventLogSession
: public ::testing::TestWithParam<
std::tuple<uint64_t, int64_t, RtcEventLog::EncodingType>> {
public:
RtcEventLogSession()
: seed_(std::get<0>(GetParam())),
prng_(seed_),
output_period_ms_(std::get<1>(GetParam())),
encoding_type_(std::get<2>(GetParam())),
gen_(seed_ * 880001UL),
verifier_(encoding_type_),
log_storage_(),
log_output_factory_(log_storage_.CreateFactory()) {
clock_.SetTime(Timestamp::Micros(prng_.Rand<uint32_t>()));
// Find the name of the current test, in order to use it as a temporary
// filename.
auto test_info = ::testing::UnitTest::GetInstance()->current_test_info();
std::string test_name =
std::string(test_info->test_case_name()) + "_" + test_info->name();
std::replace(test_name.begin(), test_name.end(), '/', '_');
temp_filename_ = test::OutputPath() + test_name;
}
// Create and buffer the config events and `num_events_before_start`
// randomized non-config events. Then call StartLogging and finally create and
// write the remaining non-config events.
void WriteLog(EventCounts count, size_t num_events_before_start);
void ReadAndVerifyLog();
bool IsNewFormat() {
return encoding_type_ == RtcEventLog::EncodingType::NewFormat;
}
private:
void WriteAudioRecvConfigs(size_t audio_recv_streams, RtcEventLog* event_log);
void WriteAudioSendConfigs(size_t audio_send_streams, RtcEventLog* event_log);
void WriteVideoRecvConfigs(size_t video_recv_streams, RtcEventLog* event_log);
void WriteVideoSendConfigs(size_t video_send_streams, RtcEventLog* event_log);
std::vector<std::pair<uint32_t, RtpHeaderExtensionMap>> incoming_extensions_;
std::vector<std::pair<uint32_t, RtpHeaderExtensionMap>> outgoing_extensions_;
// Config events.
std::vector<std::unique_ptr<RtcEventAudioSendStreamConfig>>
audio_send_config_list_;
std::vector<std::unique_ptr<RtcEventAudioReceiveStreamConfig>>
audio_recv_config_list_;
std::vector<std::unique_ptr<RtcEventVideoSendStreamConfig>>
video_send_config_list_;
std::vector<std::unique_ptr<RtcEventVideoReceiveStreamConfig>>
video_recv_config_list_;
// Regular events.
std::vector<std::unique_ptr<RtcEventAlrState>> alr_state_list_;
std::map<uint32_t, std::vector<std::unique_ptr<RtcEventAudioPlayout>>>
audio_playout_map_; // Groups audio by SSRC.
std::vector<std::unique_ptr<RtcEventAudioNetworkAdaptation>>
ana_configs_list_;
std::vector<std::unique_ptr<RtcEventBweUpdateDelayBased>> bwe_delay_list_;
std::vector<std::unique_ptr<RtcEventBweUpdateLossBased>> bwe_loss_list_;
std::vector<std::unique_ptr<RtcEventDtlsTransportState>>
dtls_transport_state_list_;
std::vector<std::unique_ptr<RtcEventDtlsWritableState>>
dtls_writable_state_list_;
std::map<uint32_t, std::vector<std::unique_ptr<RtcEventFrameDecoded>>>
frame_decoded_event_map_;
std::vector<std::unique_ptr<RtcEventGenericAckReceived>>
generic_acks_received_;
std::vector<std::unique_ptr<RtcEventGenericPacketReceived>>
generic_packets_received_;
std::vector<std::unique_ptr<RtcEventGenericPacketSent>> generic_packets_sent_;
std::vector<std::unique_ptr<RtcEventIceCandidatePair>> ice_event_list_;
std::vector<std::unique_ptr<RtcEventIceCandidatePairConfig>> ice_config_list_;
std::vector<std::unique_ptr<RtcEventProbeClusterCreated>>
probe_creation_list_;
std::vector<std::unique_ptr<RtcEventProbeResultFailure>> probe_failure_list_;
std::vector<std::unique_ptr<RtcEventProbeResultSuccess>> probe_success_list_;
std::vector<std::unique_ptr<RtcEventRouteChange>> route_change_list_;
std::vector<std::unique_ptr<RtcEventRemoteEstimate>> remote_estimate_list_;
std::vector<std::unique_ptr<RtcEventRtcpPacketIncoming>> incoming_rtcp_list_;
std::vector<std::unique_ptr<RtcEventRtcpPacketOutgoing>> outgoing_rtcp_list_;
std::map<uint32_t, std::vector<std::unique_ptr<RtcEventRtpPacketIncoming>>>
incoming_rtp_map_; // Groups incoming RTP by SSRC.
std::map<uint32_t, std::vector<std::unique_ptr<RtcEventRtpPacketOutgoing>>>
outgoing_rtp_map_; // Groups outgoing RTP by SSRC.
int64_t start_time_us_;
int64_t utc_start_time_us_;
int64_t stop_time_us_;
int64_t first_timestamp_ms_ = std::numeric_limits<int64_t>::max();
int64_t last_timestamp_ms_ = std::numeric_limits<int64_t>::min();
const uint64_t seed_;
Random prng_;
const int64_t output_period_ms_;
const RtcEventLog::EncodingType encoding_type_;
test::EventGenerator gen_;
test::EventVerifier verifier_;
ScopedFakeClock clock_;
std::string temp_filename_;
MemoryLogStorage log_storage_;
std::unique_ptr<LogWriterFactoryInterface> log_output_factory_;
};
bool SsrcUsed(
uint32_t ssrc,
const std::vector<std::pair<uint32_t, RtpHeaderExtensionMap>>& streams) {
for (const auto& kv : streams) {
if (kv.first == ssrc)
return true;
}
return false;
}
void RtcEventLogSession::WriteAudioRecvConfigs(size_t audio_recv_streams,
RtcEventLog* event_log) {
RTC_CHECK(event_log != nullptr);
uint32_t ssrc;
for (size_t i = 0; i < audio_recv_streams; i++) {
clock_.AdvanceTime(TimeDelta::Millis(prng_.Rand(20)));
do {
ssrc = prng_.Rand<uint32_t>();
} while (SsrcUsed(ssrc, incoming_extensions_));
RtpHeaderExtensionMap extensions = gen_.NewRtpHeaderExtensionMap(
/*configure_all=*/false,
/*excluded_extensions=*/{RtpDependencyDescriptorExtension::kId});
incoming_extensions_.emplace_back(ssrc, extensions);
auto event = gen_.NewAudioReceiveStreamConfig(ssrc, extensions);
event_log->Log(event->Copy());
audio_recv_config_list_.push_back(std::move(event));
}
}
void RtcEventLogSession::WriteAudioSendConfigs(size_t audio_send_streams,
RtcEventLog* event_log) {
RTC_CHECK(event_log != nullptr);
uint32_t ssrc;
for (size_t i = 0; i < audio_send_streams; i++) {
clock_.AdvanceTime(TimeDelta::Millis(prng_.Rand(20)));
do {
ssrc = prng_.Rand<uint32_t>();
} while (SsrcUsed(ssrc, outgoing_extensions_));
RtpHeaderExtensionMap extensions = gen_.NewRtpHeaderExtensionMap(
/*configure_all=*/false,
/*excluded_extensions=*/{RtpDependencyDescriptorExtension::kId});
outgoing_extensions_.emplace_back(ssrc, extensions);
auto event = gen_.NewAudioSendStreamConfig(ssrc, extensions);
event_log->Log(event->Copy());
audio_send_config_list_.push_back(std::move(event));
}
}
void RtcEventLogSession::WriteVideoRecvConfigs(size_t video_recv_streams,
RtcEventLog* event_log) {
RTC_CHECK(event_log != nullptr);
RTC_CHECK_GE(video_recv_streams, 1);
// Force least one stream to use all header extensions, to ensure
// (statistically) that every extension is tested in packet creation.
RtpHeaderExtensionMap all_extensions =
ParsedRtcEventLog::GetDefaultHeaderExtensionMap();
if (std::get<2>(GetParam()) == RtcEventLog::EncodingType::Legacy) {
all_extensions.Deregister(RtpDependencyDescriptorExtension::Uri());
}
clock_.AdvanceTime(TimeDelta::Millis(prng_.Rand(20)));
uint32_t ssrc = prng_.Rand<uint32_t>();
incoming_extensions_.emplace_back(ssrc, all_extensions);
auto event = gen_.NewVideoReceiveStreamConfig(ssrc, all_extensions);
event_log->Log(event->Copy());
video_recv_config_list_.push_back(std::move(event));
for (size_t i = 1; i < video_recv_streams; i++) {
clock_.AdvanceTime(TimeDelta::Millis(prng_.Rand(20)));
do {
ssrc = prng_.Rand<uint32_t>();
} while (SsrcUsed(ssrc, incoming_extensions_));
std::vector<RTPExtensionType> excluded_extensions;
if (std::get<2>(GetParam()) == RtcEventLog::EncodingType::Legacy) {
excluded_extensions.push_back(RtpDependencyDescriptorExtension::kId);
}
RtpHeaderExtensionMap extensions = gen_.NewRtpHeaderExtensionMap(
/*configure_all=*/false, excluded_extensions);
incoming_extensions_.emplace_back(ssrc, extensions);
auto new_event = gen_.NewVideoReceiveStreamConfig(ssrc, extensions);
event_log->Log(new_event->Copy());
video_recv_config_list_.push_back(std::move(new_event));
}
}
void RtcEventLogSession::WriteVideoSendConfigs(size_t video_send_streams,
RtcEventLog* event_log) {
RTC_CHECK(event_log != nullptr);
RTC_CHECK_GE(video_send_streams, 1);
// Force least one stream to use all header extensions, to ensure
// (statistically) that every extension is tested in packet creation.
RtpHeaderExtensionMap all_extensions =
ParsedRtcEventLog::GetDefaultHeaderExtensionMap();
if (std::get<2>(GetParam()) == RtcEventLog::EncodingType::Legacy) {
all_extensions.Deregister(RtpDependencyDescriptorExtension::Uri());
}
clock_.AdvanceTime(TimeDelta::Millis(prng_.Rand(20)));
uint32_t ssrc = prng_.Rand<uint32_t>();
outgoing_extensions_.emplace_back(ssrc, all_extensions);
auto first_event = gen_.NewVideoSendStreamConfig(ssrc, all_extensions);
event_log->Log(first_event->Copy());
video_send_config_list_.push_back(std::move(first_event));
for (size_t i = 1; i < video_send_streams; i++) {
clock_.AdvanceTime(TimeDelta::Millis(prng_.Rand(20)));
do {
ssrc = prng_.Rand<uint32_t>();
} while (SsrcUsed(ssrc, outgoing_extensions_));
std::vector<RTPExtensionType> excluded_extensions;
if (std::get<2>(GetParam()) == RtcEventLog::EncodingType::Legacy) {
excluded_extensions.push_back(RtpDependencyDescriptorExtension::kId);
}
RtpHeaderExtensionMap extensions = gen_.NewRtpHeaderExtensionMap(
/*configure_all=*/false, excluded_extensions);
outgoing_extensions_.emplace_back(ssrc, extensions);
auto event = gen_.NewVideoSendStreamConfig(ssrc, extensions);
event_log->Log(event->Copy());
video_send_config_list_.push_back(std::move(event));
}
}
void RtcEventLogSession::WriteLog(EventCounts count,
size_t num_events_before_start) {
// TODO(terelius): Allow test to run with either a real or a fake clock_
// e.g. by using clock and task_queue_factory from TimeController
// when RtcEventLogImpl switches to use injected clock from the environment.
// The log will be flushed to output when the event_log goes out of scope.
std::unique_ptr<RtcEventLog> event_log = RtcEventLogFactory().Create(
CreateEnvironment(CreateFieldTrialsFor(encoding_type_)));
// We can't send or receive packets without configured streams.
RTC_CHECK_GE(count.video_recv_streams, 1);
RTC_CHECK_GE(count.video_send_streams, 1);
WriteAudioRecvConfigs(count.audio_recv_streams, event_log.get());
WriteAudioSendConfigs(count.audio_send_streams, event_log.get());
WriteVideoRecvConfigs(count.video_recv_streams, event_log.get());
WriteVideoSendConfigs(count.video_send_streams, event_log.get());
size_t remaining_events = count.total_nonconfig_events();
ASSERT_LE(num_events_before_start, remaining_events);
size_t remaining_events_at_start = remaining_events - num_events_before_start;
for (; remaining_events > 0; remaining_events--) {
if (remaining_events == remaining_events_at_start) {
clock_.AdvanceTime(TimeDelta::Millis(prng_.Rand(20)));
event_log->StartLogging(log_output_factory_->Create(temp_filename_),
output_period_ms_);
start_time_us_ = TimeMicros();
utc_start_time_us_ = TimeUTCMicros();
}
clock_.AdvanceTime(TimeDelta::Millis(prng_.Rand(20)));
size_t selection = prng_.Rand(remaining_events - 1);
first_timestamp_ms_ = std::min(first_timestamp_ms_, TimeMillis());
last_timestamp_ms_ = std::max(last_timestamp_ms_, TimeMillis());
if (selection < count.alr_states) {
auto event = gen_.NewAlrState();
event_log->Log(event->Copy());
alr_state_list_.push_back(std::move(event));
count.alr_states--;
continue;
}
selection -= count.alr_states;
if (selection < count.route_changes) {
auto event = gen_.NewRouteChange();
event_log->Log(event->Copy());
route_change_list_.push_back(std::move(event));
count.route_changes--;
continue;
}
selection -= count.route_changes;
if (selection < count.audio_playouts) {
size_t stream = prng_.Rand(incoming_extensions_.size() - 1);
// This might be a video SSRC, but the parser does not use the config.
uint32_t ssrc = incoming_extensions_[stream].first;
auto event = gen_.NewAudioPlayout(ssrc);
event_log->Log(event->Copy());
audio_playout_map_[ssrc].push_back(std::move(event));
count.audio_playouts--;
continue;
}
selection -= count.audio_playouts;
if (selection < count.ana_configs) {
auto event = gen_.NewAudioNetworkAdaptation();
event_log->Log(event->Copy());
ana_configs_list_.push_back(std::move(event));
count.ana_configs--;
continue;
}
selection -= count.ana_configs;
if (selection < count.bwe_loss_events) {
auto event = gen_.NewBweUpdateLossBased();
event_log->Log(event->Copy());
bwe_loss_list_.push_back(std::move(event));
count.bwe_loss_events--;
continue;
}
selection -= count.bwe_loss_events;
if (selection < count.bwe_delay_events) {
auto event = gen_.NewBweUpdateDelayBased();
event_log->Log(event->Copy());
bwe_delay_list_.push_back(std::move(event));
count.bwe_delay_events--;
continue;
}
selection -= count.bwe_delay_events;
if (selection < count.probe_creations) {
auto event = gen_.NewProbeClusterCreated();
event_log->Log(event->Copy());
probe_creation_list_.push_back(std::move(event));
count.probe_creations--;
continue;
}
selection -= count.probe_creations;
if (selection < count.probe_successes) {
auto event = gen_.NewProbeResultSuccess();
event_log->Log(event->Copy());
probe_success_list_.push_back(std::move(event));
count.probe_successes--;
continue;
}
selection -= count.probe_successes;
if (selection < count.probe_failures) {
auto event = gen_.NewProbeResultFailure();
event_log->Log(event->Copy());
probe_failure_list_.push_back(std::move(event));
count.probe_failures--;
continue;
}
selection -= count.probe_failures;
if (selection < count.dtls_transport_states) {
auto event = gen_.NewDtlsTransportState();
event_log->Log(event->Copy());
dtls_transport_state_list_.push_back(std::move(event));
count.dtls_transport_states--;
continue;
}
selection -= count.dtls_transport_states;
if (selection < count.dtls_writable_states) {
auto event = gen_.NewDtlsWritableState();
event_log->Log(event->Copy());
dtls_writable_state_list_.push_back(std::move(event));
count.dtls_writable_states--;
continue;
}
selection -= count.dtls_writable_states;
if (selection < count.frame_decoded_events) {
size_t stream = prng_.Rand(incoming_extensions_.size() - 1);
// This might be an audio SSRC, but that won't affect the parser.
uint32_t ssrc = incoming_extensions_[stream].first;
auto event = gen_.NewFrameDecodedEvent(ssrc);
event_log->Log(event->Copy());
frame_decoded_event_map_[ssrc].push_back(std::move(event));
count.frame_decoded_events--;
continue;
}
selection -= count.frame_decoded_events;
if (selection < count.ice_configs) {
auto event = gen_.NewIceCandidatePairConfig();
event_log->Log(event->Copy());
ice_config_list_.push_back(std::move(event));
count.ice_configs--;
continue;
}
selection -= count.ice_configs;
if (selection < count.ice_events) {
auto event = gen_.NewIceCandidatePair();
event_log->Log(event->Copy());
ice_event_list_.push_back(std::move(event));
count.ice_events--;
continue;
}
selection -= count.ice_events;
if (selection < count.incoming_rtp_packets) {
size_t stream = prng_.Rand(incoming_extensions_.size() - 1);
uint32_t ssrc = incoming_extensions_[stream].first;
auto event =
gen_.NewRtpPacketIncoming(ssrc, incoming_extensions_[stream].second);
event_log->Log(event->Copy());
incoming_rtp_map_[ssrc].push_back(std::move(event));
count.incoming_rtp_packets--;
continue;
}
selection -= count.incoming_rtp_packets;
if (selection < count.outgoing_rtp_packets) {
size_t stream = prng_.Rand(outgoing_extensions_.size() - 1);
uint32_t ssrc = outgoing_extensions_[stream].first;
auto event =
gen_.NewRtpPacketOutgoing(ssrc, outgoing_extensions_[stream].second);
event_log->Log(event->Copy());
outgoing_rtp_map_[ssrc].push_back(std::move(event));
count.outgoing_rtp_packets--;
continue;
}
selection -= count.outgoing_rtp_packets;
if (selection < count.incoming_rtcp_packets) {
auto event = gen_.NewRtcpPacketIncoming();
event_log->Log(event->Copy());
incoming_rtcp_list_.push_back(std::move(event));
count.incoming_rtcp_packets--;
continue;
}
selection -= count.incoming_rtcp_packets;
if (selection < count.outgoing_rtcp_packets) {
auto event = gen_.NewRtcpPacketOutgoing();
event_log->Log(event->Copy());
outgoing_rtcp_list_.push_back(std::move(event));
count.outgoing_rtcp_packets--;
continue;
}
selection -= count.outgoing_rtcp_packets;
if (selection < count.generic_packets_sent) {
auto event = gen_.NewGenericPacketSent();
generic_packets_sent_.push_back(event->Copy());
event_log->Log(std::move(event));
count.generic_packets_sent--;
continue;
}
selection -= count.generic_packets_sent;
if (selection < count.generic_packets_received) {
auto event = gen_.NewGenericPacketReceived();
generic_packets_received_.push_back(event->Copy());
event_log->Log(std::move(event));
count.generic_packets_received--;
continue;
}
selection -= count.generic_packets_received;
if (selection < count.generic_acks_received) {
auto event = gen_.NewGenericAckReceived();
generic_acks_received_.push_back(event->Copy());
event_log->Log(std::move(event));
count.generic_acks_received--;
continue;
}
selection -= count.generic_acks_received;
RTC_DCHECK_NOTREACHED();
}
event_log->StopLogging();
stop_time_us_ = TimeMicros();
ASSERT_EQ(count.total_nonconfig_events(), static_cast<size_t>(0));
}
// Read the log and verify that what we read back from the event log is the
// same as what we wrote down.
void RtcEventLogSession::ReadAndVerifyLog() {
// Read the generated log from memory.
ParsedRtcEventLog parsed_log;
auto it = log_storage_.logs().find(temp_filename_);
ASSERT_TRUE(it != log_storage_.logs().end());
ASSERT_TRUE(parsed_log.ParseString(it->second).ok());
// Start and stop events.
auto& parsed_start_log_events = parsed_log.start_log_events();
ASSERT_EQ(parsed_start_log_events.size(), static_cast<size_t>(1));
verifier_.VerifyLoggedStartEvent(start_time_us_, utc_start_time_us_,
parsed_start_log_events[0]);
auto& parsed_stop_log_events = parsed_log.stop_log_events();
ASSERT_EQ(parsed_stop_log_events.size(), static_cast<size_t>(1));
verifier_.VerifyLoggedStopEvent(stop_time_us_, parsed_stop_log_events[0]);
auto& parsed_alr_state_events = parsed_log.alr_state_events();
ASSERT_EQ(parsed_alr_state_events.size(), alr_state_list_.size());
for (size_t i = 0; i < parsed_alr_state_events.size(); i++) {
verifier_.VerifyLoggedAlrStateEvent(*alr_state_list_[i],
parsed_alr_state_events[i]);
}
auto& parsed_route_change_events = parsed_log.route_change_events();
ASSERT_EQ(parsed_route_change_events.size(), route_change_list_.size());
for (size_t i = 0; i < parsed_route_change_events.size(); i++) {
verifier_.VerifyLoggedRouteChangeEvent(*route_change_list_[i],
parsed_route_change_events[i]);
}
const auto& parsed_audio_playout_map = parsed_log.audio_playout_events();
ASSERT_EQ(parsed_audio_playout_map.size(), audio_playout_map_.size());
for (const auto& kv : parsed_audio_playout_map) {
uint32_t ssrc = kv.first;
const auto& parsed_audio_playout_stream = kv.second;
const auto& audio_playout_stream = audio_playout_map_[ssrc];
ASSERT_EQ(parsed_audio_playout_stream.size(), audio_playout_stream.size());
for (size_t i = 0; i < audio_playout_stream.size(); i++) {
verifier_.VerifyLoggedAudioPlayoutEvent(*audio_playout_stream[i],
parsed_audio_playout_stream[i]);
}
}
auto& parsed_audio_network_adaptation_events =
parsed_log.audio_network_adaptation_events();
ASSERT_EQ(parsed_audio_network_adaptation_events.size(),
ana_configs_list_.size());
for (size_t i = 0; i < parsed_audio_network_adaptation_events.size(); i++) {
verifier_.VerifyLoggedAudioNetworkAdaptationEvent(
*ana_configs_list_[i], parsed_audio_network_adaptation_events[i]);
}
auto& parsed_bwe_delay_updates = parsed_log.bwe_delay_updates();
ASSERT_EQ(parsed_bwe_delay_updates.size(), bwe_delay_list_.size());
for (size_t i = 0; i < parsed_bwe_delay_updates.size(); i++) {
verifier_.VerifyLoggedBweDelayBasedUpdate(*bwe_delay_list_[i],
parsed_bwe_delay_updates[i]);
}
auto& parsed_bwe_loss_updates = parsed_log.bwe_loss_updates();
ASSERT_EQ(parsed_bwe_loss_updates.size(), bwe_loss_list_.size());
for (size_t i = 0; i < parsed_bwe_loss_updates.size(); i++) {
verifier_.VerifyLoggedBweLossBasedUpdate(*bwe_loss_list_[i],
parsed_bwe_loss_updates[i]);
}
auto& parsed_bwe_probe_cluster_created_events =
parsed_log.bwe_probe_cluster_created_events();
ASSERT_EQ(parsed_bwe_probe_cluster_created_events.size(),
probe_creation_list_.size());
for (size_t i = 0; i < parsed_bwe_probe_cluster_created_events.size(); i++) {
verifier_.VerifyLoggedBweProbeClusterCreatedEvent(
*probe_creation_list_[i], parsed_bwe_probe_cluster_created_events[i]);
}
auto& parsed_bwe_probe_failure_events = parsed_log.bwe_probe_failure_events();
ASSERT_EQ(parsed_bwe_probe_failure_events.size(), probe_failure_list_.size());
for (size_t i = 0; i < parsed_bwe_probe_failure_events.size(); i++) {
verifier_.VerifyLoggedBweProbeFailureEvent(
*probe_failure_list_[i], parsed_bwe_probe_failure_events[i]);
}
auto& parsed_bwe_probe_success_events = parsed_log.bwe_probe_success_events();
ASSERT_EQ(parsed_bwe_probe_success_events.size(), probe_success_list_.size());
for (size_t i = 0; i < parsed_bwe_probe_success_events.size(); i++) {
verifier_.VerifyLoggedBweProbeSuccessEvent(
*probe_success_list_[i], parsed_bwe_probe_success_events[i]);
}
auto& parsed_dtls_transport_states = parsed_log.dtls_transport_states();
ASSERT_EQ(parsed_dtls_transport_states.size(),
dtls_transport_state_list_.size());
for (size_t i = 0; i < parsed_dtls_transport_states.size(); i++) {
verifier_.VerifyLoggedDtlsTransportState(*dtls_transport_state_list_[i],
parsed_dtls_transport_states[i]);
}
auto& parsed_dtls_writable_states = parsed_log.dtls_writable_states();
ASSERT_EQ(parsed_dtls_writable_states.size(),
dtls_writable_state_list_.size());
for (size_t i = 0; i < parsed_dtls_writable_states.size(); i++) {
verifier_.VerifyLoggedDtlsWritableState(*dtls_writable_state_list_[i],
parsed_dtls_writable_states[i]);
}
const auto& parsed_frame_decoded_map = parsed_log.decoded_frames();
ASSERT_EQ(parsed_frame_decoded_map.size(), frame_decoded_event_map_.size());
for (const auto& kv : parsed_frame_decoded_map) {
uint32_t ssrc = kv.first;
const auto& parsed_decoded_frames = kv.second;
const auto& decoded_frames = frame_decoded_event_map_[ssrc];
ASSERT_EQ(parsed_decoded_frames.size(), decoded_frames.size());
for (size_t i = 0; i < decoded_frames.size(); i++) {
verifier_.VerifyLoggedFrameDecoded(*decoded_frames[i],
parsed_decoded_frames[i]);
}
}
auto& parsed_ice_candidate_pair_configs =
parsed_log.ice_candidate_pair_configs();
ASSERT_EQ(parsed_ice_candidate_pair_configs.size(), ice_config_list_.size());
for (size_t i = 0; i < parsed_ice_candidate_pair_configs.size(); i++) {
verifier_.VerifyLoggedIceCandidatePairConfig(
*ice_config_list_[i], parsed_ice_candidate_pair_configs[i]);
}
auto& parsed_ice_candidate_pair_events =
parsed_log.ice_candidate_pair_events();
ASSERT_EQ(parsed_ice_candidate_pair_events.size(),
parsed_ice_candidate_pair_events.size());
for (size_t i = 0; i < parsed_ice_candidate_pair_events.size(); i++) {
verifier_.VerifyLoggedIceCandidatePairEvent(
*ice_event_list_[i], parsed_ice_candidate_pair_events[i]);
}
auto& parsed_incoming_rtp_packets_by_ssrc =
parsed_log.incoming_rtp_packets_by_ssrc();
ASSERT_EQ(parsed_incoming_rtp_packets_by_ssrc.size(),
incoming_rtp_map_.size());
for (const auto& kv : parsed_incoming_rtp_packets_by_ssrc) {
uint32_t ssrc = kv.ssrc;
const auto& parsed_rtp_stream = kv.incoming_packets;
const auto& rtp_stream = incoming_rtp_map_[ssrc];
ASSERT_EQ(parsed_rtp_stream.size(), rtp_stream.size());
for (size_t i = 0; i < parsed_rtp_stream.size(); i++) {
verifier_.VerifyLoggedRtpPacketIncoming(*rtp_stream[i],
parsed_rtp_stream[i]);
}
}
auto& parsed_outgoing_rtp_packets_by_ssrc =
parsed_log.outgoing_rtp_packets_by_ssrc();
ASSERT_EQ(parsed_outgoing_rtp_packets_by_ssrc.size(),
outgoing_rtp_map_.size());
for (const auto& kv : parsed_outgoing_rtp_packets_by_ssrc) {
uint32_t ssrc = kv.ssrc;
const auto& parsed_rtp_stream = kv.outgoing_packets;
const auto& rtp_stream = outgoing_rtp_map_[ssrc];
ASSERT_EQ(parsed_rtp_stream.size(), rtp_stream.size());
for (size_t i = 0; i < parsed_rtp_stream.size(); i++) {
verifier_.VerifyLoggedRtpPacketOutgoing(*rtp_stream[i],
parsed_rtp_stream[i]);
}
}
auto& parsed_incoming_rtcp_packets = parsed_log.incoming_rtcp_packets();
ASSERT_EQ(parsed_incoming_rtcp_packets.size(), incoming_rtcp_list_.size());
for (size_t i = 0; i < parsed_incoming_rtcp_packets.size(); i++) {
verifier_.VerifyLoggedRtcpPacketIncoming(*incoming_rtcp_list_[i],
parsed_incoming_rtcp_packets[i]);
}
auto& parsed_outgoing_rtcp_packets = parsed_log.outgoing_rtcp_packets();
ASSERT_EQ(parsed_outgoing_rtcp_packets.size(), outgoing_rtcp_list_.size());
for (size_t i = 0; i < parsed_outgoing_rtcp_packets.size(); i++) {
verifier_.VerifyLoggedRtcpPacketOutgoing(*outgoing_rtcp_list_[i],
parsed_outgoing_rtcp_packets[i]);
}
auto& parsed_audio_recv_configs = parsed_log.audio_recv_configs();
ASSERT_EQ(parsed_audio_recv_configs.size(), audio_recv_config_list_.size());
for (size_t i = 0; i < parsed_audio_recv_configs.size(); i++) {
verifier_.VerifyLoggedAudioRecvConfig(*audio_recv_config_list_[i],
parsed_audio_recv_configs[i]);
}
auto& parsed_audio_send_configs = parsed_log.audio_send_configs();
ASSERT_EQ(parsed_audio_send_configs.size(), audio_send_config_list_.size());
for (size_t i = 0; i < parsed_audio_send_configs.size(); i++) {
verifier_.VerifyLoggedAudioSendConfig(*audio_send_config_list_[i],
parsed_audio_send_configs[i]);
}
auto& parsed_video_recv_configs = parsed_log.video_recv_configs();
ASSERT_EQ(parsed_video_recv_configs.size(), video_recv_config_list_.size());
for (size_t i = 0; i < parsed_video_recv_configs.size(); i++) {
verifier_.VerifyLoggedVideoRecvConfig(*video_recv_config_list_[i],
parsed_video_recv_configs[i]);
}
auto& parsed_video_send_configs = parsed_log.video_send_configs();
ASSERT_EQ(parsed_video_send_configs.size(), video_send_config_list_.size());
for (size_t i = 0; i < parsed_video_send_configs.size(); i++) {
verifier_.VerifyLoggedVideoSendConfig(*video_send_config_list_[i],
parsed_video_send_configs[i]);
}
auto& parsed_generic_packets_received = parsed_log.generic_packets_received();
ASSERT_EQ(parsed_generic_packets_received.size(),
generic_packets_received_.size());
for (size_t i = 0; i < parsed_generic_packets_received.size(); i++) {
verifier_.VerifyLoggedGenericPacketReceived(
*generic_packets_received_[i], parsed_generic_packets_received[i]);
}
auto& parsed_generic_packets_sent = parsed_log.generic_packets_sent();
ASSERT_EQ(parsed_generic_packets_sent.size(), generic_packets_sent_.size());
for (size_t i = 0; i < parsed_generic_packets_sent.size(); i++) {
verifier_.VerifyLoggedGenericPacketSent(*generic_packets_sent_[i],
parsed_generic_packets_sent[i]);
}
auto& parsed_generic_acks_received = parsed_log.generic_acks_received();
ASSERT_EQ(parsed_generic_acks_received.size(), generic_acks_received_.size());
for (size_t i = 0; i < parsed_generic_acks_received.size(); i++) {
verifier_.VerifyLoggedGenericAckReceived(*generic_acks_received_[i],
parsed_generic_acks_received[i]);
}
EXPECT_EQ(first_timestamp_ms_, parsed_log.first_timestamp().ms());
EXPECT_EQ(last_timestamp_ms_, parsed_log.last_timestamp().ms());
EXPECT_EQ(parsed_log.first_log_segment().start_time_ms(),
std::min(start_time_us_ / 1000, first_timestamp_ms_));
EXPECT_EQ(parsed_log.first_log_segment().stop_time_ms(),
stop_time_us_ / 1000);
}
} // namespace
TEST_P(RtcEventLogSession, StartLoggingFromBeginning) {
EventCounts count;
count.audio_send_streams = 2;
count.audio_recv_streams = 2;
count.video_send_streams = 3;
count.video_recv_streams = 4;
count.alr_states = 4;
count.audio_playouts = 100;
count.ana_configs = 3;
count.bwe_loss_events = 20;
count.bwe_delay_events = 20;
count.probe_creations = 4;
count.probe_successes = 2;
count.probe_failures = 2;
count.ice_configs = 3;
count.ice_events = 10;
count.incoming_rtp_packets = 100;
count.outgoing_rtp_packets = 100;
count.incoming_rtcp_packets = 20;
count.outgoing_rtcp_packets = 20;
if (IsNewFormat()) {
count.dtls_transport_states = 4;
count.dtls_writable_states = 2;
count.frame_decoded_events = 50;
count.generic_packets_sent = 100;
count.generic_packets_received = 100;
count.generic_acks_received = 20;
count.route_changes = 4;
}
WriteLog(count, 0);
ReadAndVerifyLog();
}
TEST_P(RtcEventLogSession, StartLoggingInTheMiddle) {
EventCounts count;
count.audio_send_streams = 3;
count.audio_recv_streams = 4;
count.video_send_streams = 5;
count.video_recv_streams = 6;
count.alr_states = 10;
count.audio_playouts = 500;
count.ana_configs = 10;
count.bwe_loss_events = 50;
count.bwe_delay_events = 50;
count.probe_creations = 10;
count.probe_successes = 5;
count.probe_failures = 5;
count.ice_configs = 10;
count.ice_events = 20;
count.incoming_rtp_packets = 500;
count.outgoing_rtp_packets = 500;
count.incoming_rtcp_packets = 50;
count.outgoing_rtcp_packets = 50;
if (IsNewFormat()) {
count.dtls_transport_states = 4;
count.dtls_writable_states = 5;
count.frame_decoded_events = 250;
count.generic_packets_sent = 500;
count.generic_packets_received = 500;
count.generic_acks_received = 50;
count.route_changes = 10;
}
WriteLog(count, 500);
ReadAndVerifyLog();
}
INSTANTIATE_TEST_SUITE_P(
RtcEventLogTest,
RtcEventLogSession,
::testing::Combine(
::testing::Values(1234567, 7654321),
::testing::Values(RtcEventLog::kImmediateOutput, 1, 5),
::testing::Values(RtcEventLog::EncodingType::Legacy,
RtcEventLog::EncodingType::NewFormat)));
class RtcEventLogCircularBufferTest
: public ::testing::TestWithParam<RtcEventLog::EncodingType> {
public:
RtcEventLogCircularBufferTest()
: encoding_type_(GetParam()),
verifier_(encoding_type_),
log_storage_(),
log_output_factory_(log_storage_.CreateFactory()) {}
const RtcEventLog::EncodingType encoding_type_;
const test::EventVerifier verifier_;
MemoryLogStorage log_storage_;
std::unique_ptr<LogWriterFactoryInterface> log_output_factory_;
};
TEST_P(RtcEventLogCircularBufferTest, KeepsMostRecentEvents) {
// TODO(terelius): Maybe make a separate RtcEventLogImplTest that can access
// the size of the cyclic buffer?
constexpr size_t kNumEvents = 20000;
constexpr int64_t kStartTimeSeconds = 1;
constexpr int32_t kStartBitrate = 1000000;
auto test_info = ::testing::UnitTest::GetInstance()->current_test_info();
std::string test_name =
std::string(test_info->test_case_name()) + "_" + test_info->name();
std::replace(test_name.begin(), test_name.end(), '/', '_');
const std::string temp_filename = test::OutputPath() + test_name;
std::unique_ptr<ScopedFakeClock> fake_clock =
std::make_unique<ScopedFakeClock>();
fake_clock->SetTime(Timestamp::Seconds(kStartTimeSeconds));
// Create a scope for the TQ and event log factories.
// This way, we make sure that task queue instances that may rely on a clock
// have been torn down before we run the verification steps at the end of
// the test.
int64_t start_time_us, utc_start_time_us, stop_time_us;
{
// When `log` goes out of scope, the contents are flushed to the output.
std::unique_ptr<RtcEventLog> log = RtcEventLogFactory().Create(
CreateEnvironment(CreateFieldTrialsFor(encoding_type_)));
for (size_t i = 0; i < kNumEvents; i++) {
// The purpose of the test is to verify that the log can handle
// more events than what fits in the internal circular buffer. The exact
// type of events does not matter so we chose ProbeSuccess events for
// simplicity.
// We base the various values on the index. We use this for some basic
// consistency checks when we read back.
log->Log(std::make_unique<RtcEventProbeResultSuccess>(
i, kStartBitrate + i * 1000));
fake_clock->AdvanceTime(TimeDelta::Millis(10));
}
start_time_us = TimeMicros();
utc_start_time_us = TimeUTCMicros();
log->StartLogging(log_output_factory_->Create(temp_filename),
RtcEventLog::kImmediateOutput);
fake_clock->AdvanceTime(TimeDelta::Millis(10));
stop_time_us = TimeMicros();
log->StopLogging();
}
// Read the generated log from memory.
ParsedRtcEventLog parsed_log;
auto it = log_storage_.logs().find(temp_filename);
ASSERT_TRUE(it != log_storage_.logs().end());
ASSERT_TRUE(parsed_log.ParseString(it->second).ok());
const auto& start_log_events = parsed_log.start_log_events();
ASSERT_EQ(start_log_events.size(), 1u);
verifier_.VerifyLoggedStartEvent(start_time_us, utc_start_time_us,
start_log_events[0]);
const auto& stop_log_events = parsed_log.stop_log_events();
ASSERT_EQ(stop_log_events.size(), 1u);
verifier_.VerifyLoggedStopEvent(stop_time_us, stop_log_events[0]);
const auto& probe_success_events = parsed_log.bwe_probe_success_events();
// If the following fails, it probably means that kNumEvents isn't larger
// than the size of the cyclic buffer in the event log. Try increasing
// kNumEvents.
EXPECT_LT(probe_success_events.size(), kNumEvents);
ASSERT_GT(probe_success_events.size(), 1u);
int64_t first_timestamp_ms = probe_success_events[0].timestamp.ms();
uint32_t first_id = probe_success_events[0].id;
int32_t first_bitrate_bps = probe_success_events[0].bitrate_bps;
// We want to reset the time to what we used when generating the events, but
// the fake clock implementation DCHECKS if time moves backwards. We therefore
// recreate the clock. However we must ensure that the old fake_clock is
// destroyed before the new one is created, so we have to reset() first.
fake_clock.reset();
fake_clock = std::make_unique<ScopedFakeClock>();
fake_clock->SetTime(Timestamp::Millis(first_timestamp_ms));
for (size_t i = 1; i < probe_success_events.size(); i++) {
fake_clock->AdvanceTime(TimeDelta::Millis(10));
verifier_.VerifyLoggedBweProbeSuccessEvent(
RtcEventProbeResultSuccess(first_id + i, first_bitrate_bps + i * 1000),
probe_success_events[i]);
}
}
INSTANTIATE_TEST_SUITE_P(
RtcEventLogTest,
RtcEventLogCircularBufferTest,
::testing::Values(RtcEventLog::EncodingType::Legacy,
RtcEventLog::EncodingType::NewFormat));
// TODO(terelius): Verify parser behavior if the timestamps are not
// monotonically increasing in the log.
TEST(DereferencingVectorTest, NonConstVector) {
std::vector<int> v{0, 1, 2, 3, 4, 5, 6, 7, 8, 9};
DereferencingVector<int> even;
EXPECT_TRUE(even.empty());
EXPECT_EQ(even.size(), 0u);
EXPECT_EQ(even.begin(), even.end());
for (size_t i = 0; i < v.size(); i += 2) {
even.push_back(&v[i]);
}
EXPECT_FALSE(even.empty());
EXPECT_EQ(even.size(), 5u);
EXPECT_NE(even.begin(), even.end());
// Test direct access.
for (size_t i = 0; i < even.size(); i++) {
EXPECT_EQ(even[i], 2 * static_cast<int>(i));
}
// Test iterator.
for (int val : even) {
EXPECT_EQ(val % 2, 0);
}
// Test modification through iterator.
for (int& val : even) {
val = val * 2;
EXPECT_EQ(val % 2, 0);
}
// Backing vector should have been modified.
std::vector<int> expected{0, 1, 4, 3, 8, 5, 12, 7, 16, 9};
for (size_t i = 0; i < v.size(); i++) {
EXPECT_EQ(v[i], expected[i]);
}
}
TEST(DereferencingVectorTest, ConstVector) {
std::vector<int> v{0, 1, 2, 3, 4, 5, 6, 7, 8, 9};
DereferencingVector<const int> odd;
EXPECT_TRUE(odd.empty());
EXPECT_EQ(odd.size(), 0u);
EXPECT_EQ(odd.begin(), odd.end());
for (size_t i = 1; i < v.size(); i += 2) {
odd.push_back(&v[i]);
}
EXPECT_FALSE(odd.empty());
EXPECT_EQ(odd.size(), 5u);
EXPECT_NE(odd.begin(), odd.end());
// Test direct access.
for (size_t i = 0; i < odd.size(); i++) {
EXPECT_EQ(odd[i], 2 * static_cast<int>(i) + 1);
}
// Test iterator.
for (int val : odd) {
EXPECT_EQ(val % 2, 1);
}
}
} // namespace webrtc