webrtc_m130/pc/rtcstatstraversal.cc
Henrik Boström b619936dee Stats traversal algorithm added.
This is part of the work to add a selector argument to getStats().

Changes:
- TakeReferencedStats() added, which traverses the stats graph and takes
  any stats from the report that are directly or indirectly accessible
  from the starting stats objects in the stats graph. The result is
  returned as a stats report.
- GetStatsReferencedIds(), an efficient helper function for getting
  neighbor stats object IDs.
- RTCStatsReport::Take(), removed the stats object with the given ID and
  returns ownership of it (so that it can be added to another report).

TakeReferencedStats() is tested with a bunch of sample stats graphs.

GetStatsReferencedIds() is tested in the rtcstats_integrationttest.cc,
making sure the expected IDs are returned. The expected IDs are the
values of the stats object members with the "Id" or "Ids" suffix.

Design doc:
https://docs.google.com/document/d/18BywbtXgHCjsbR5nWBedpzqDjAfXrFSTJNiADnzoK0w/edit?usp=sharing

Bug: chromium:680172
Change-Id: I5da9da8250da0cb05adb864015901393a4290776
Reviewed-on: https://webrtc-review.googlesource.com/60869
Commit-Queue: Henrik Boström <hbos@webrtc.org>
Reviewed-by: Taylor Brandstetter <deadbeef@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#22381}
2018-03-12 10:54:09 +00:00

120 lines
4.7 KiB
C++

/*
* Copyright 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 "pc/rtcstatstraversal.h"
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "api/stats/rtcstats_objects.h"
#include "rtc_base/checks.h"
namespace webrtc {
namespace {
void TraverseAndTakeVisitedStats(RTCStatsReport* report,
RTCStatsReport* visited_report,
const std::string& current_id) {
// Mark current stats object as visited by moving it |report| to
// |visited_report|.
std::unique_ptr<const RTCStats> current = report->Take(current_id);
if (!current) {
// This node has already been visited (or it is an invalid id).
return;
}
std::vector<const std::string*> neighbor_ids =
GetStatsReferencedIds(*current);
visited_report->AddStats(std::move(current));
// Recursively traverse all neighbors.
for (const auto* neighbor_id : neighbor_ids) {
TraverseAndTakeVisitedStats(report, visited_report, *neighbor_id);
}
}
void AddIdIfDefined(const RTCStatsMember<std::string>& id,
std::vector<const std::string*>* neighbor_ids) {
if (id.is_defined())
neighbor_ids->push_back(&(*id));
}
void AddIdsIfDefined(const RTCStatsMember<std::vector<std::string>>& ids,
std::vector<const std::string*>* neighbor_ids) {
if (ids.is_defined()) {
for (const std::string& id : *ids)
neighbor_ids->push_back(&id);
}
}
} // namespace
rtc::scoped_refptr<RTCStatsReport> TakeReferencedStats(
rtc::scoped_refptr<RTCStatsReport> report,
const std::vector<std::string>& ids) {
rtc::scoped_refptr<RTCStatsReport> result = RTCStatsReport::Create();
for (const auto& id : ids) {
TraverseAndTakeVisitedStats(report.get(), result.get(), id);
}
return result;
}
std::vector<const std::string*> GetStatsReferencedIds(const RTCStats& stats) {
std::vector<const std::string*> neighbor_ids;
const char* type = stats.type();
if (type == RTCCertificateStats::kType) {
const auto& certificate = static_cast<const RTCCertificateStats&>(stats);
AddIdIfDefined(certificate.issuer_certificate_id, &neighbor_ids);
} else if (type == RTCCodecStats::kType) {
// RTCCodecStats does not have any neighbor references.
} else if (type == RTCDataChannelStats::kType) {
// RTCDataChannelStats does not have any neighbor references.
} else if (type == RTCIceCandidatePairStats::kType) {
const auto& candidate_pair =
static_cast<const RTCIceCandidatePairStats&>(stats);
AddIdIfDefined(candidate_pair.transport_id, &neighbor_ids);
AddIdIfDefined(candidate_pair.local_candidate_id, &neighbor_ids);
AddIdIfDefined(candidate_pair.remote_candidate_id, &neighbor_ids);
} else if (type == RTCLocalIceCandidateStats::kType ||
type == RTCRemoteIceCandidateStats::kType) {
const auto& local_or_remote_candidate =
static_cast<const RTCIceCandidateStats&>(stats);
AddIdIfDefined(local_or_remote_candidate.transport_id, &neighbor_ids);
} else if (type == RTCMediaStreamStats::kType) {
const auto& stream = static_cast<const RTCMediaStreamStats&>(stats);
AddIdsIfDefined(stream.track_ids, &neighbor_ids);
} else if (type == RTCMediaStreamTrackStats::kType) {
// RTCMediaStreamTrackStats does not have any neighbor references.
} else if (type == RTCPeerConnectionStats::kType) {
// RTCPeerConnectionStats does not have any neighbor references.
} else if (type == RTCInboundRTPStreamStats::kType ||
type == RTCOutboundRTPStreamStats::kType) {
const auto& rtp = static_cast<const RTCRTPStreamStats&>(stats);
AddIdIfDefined(rtp.associate_stats_id, &neighbor_ids);
AddIdIfDefined(rtp.track_id, &neighbor_ids);
AddIdIfDefined(rtp.transport_id, &neighbor_ids);
AddIdIfDefined(rtp.codec_id, &neighbor_ids);
} else if (type == RTCTransportStats::kType) {
// RTCTransportStats does not have any neighbor references.
const auto& transport = static_cast<const RTCTransportStats&>(stats);
AddIdIfDefined(transport.rtcp_transport_stats_id, &neighbor_ids);
AddIdIfDefined(transport.selected_candidate_pair_id, &neighbor_ids);
AddIdIfDefined(transport.local_certificate_id, &neighbor_ids);
AddIdIfDefined(transport.remote_certificate_id, &neighbor_ids);
} else {
RTC_NOTREACHED() << "Unrecognized type: " << type;
}
return neighbor_ids;
}
} // namespace webrtc