1 /*
2 * Copyright 2012 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11 #include "pc/legacy_stats_collector.h"
12
13 #include <stddef.h>
14 #include <stdint.h>
15
16 #include <algorithm>
17 #include <cmath>
18 #include <list>
19 #include <set>
20 #include <utility>
21 #include <vector>
22
23 #include "absl/strings/string_view.h"
24 #include "absl/types/optional.h"
25 #include "api/audio_codecs/audio_encoder.h"
26 #include "api/candidate.h"
27 #include "api/data_channel_interface.h"
28 #include "api/field_trials_view.h"
29 #include "api/media_types.h"
30 #include "api/rtp_sender_interface.h"
31 #include "api/scoped_refptr.h"
32 #include "api/sequence_checker.h"
33 #include "api/video/video_content_type.h"
34 #include "api/video/video_timing.h"
35 #include "call/call.h"
36 #include "media/base/media_channel.h"
37 #include "modules/audio_processing/include/audio_processing_statistics.h"
38 #include "p2p/base/ice_transport_internal.h"
39 #include "p2p/base/p2p_constants.h"
40 #include "pc/channel_interface.h"
41 #include "pc/data_channel_utils.h"
42 #include "pc/rtp_receiver.h"
43 #include "pc/rtp_receiver_proxy.h"
44 #include "pc/rtp_sender_proxy.h"
45 #include "pc/rtp_transceiver.h"
46 #include "pc/transport_stats.h"
47 #include "rtc_base/checks.h"
48 #include "rtc_base/ip_address.h"
49 #include "rtc_base/logging.h"
50 #include "rtc_base/rtc_certificate.h"
51 #include "rtc_base/socket_address.h"
52 #include "rtc_base/ssl_stream_adapter.h"
53 #include "rtc_base/string_encode.h"
54 #include "rtc_base/thread.h"
55 #include "rtc_base/time_utils.h"
56 #include "rtc_base/trace_event.h"
57
58 namespace webrtc {
59 namespace {
60
61 // Field trial which controls whether to report standard-compliant bytes
62 // sent/received per stream. If enabled, padding and headers are not included
63 // in bytes sent or received.
64 constexpr char kUseStandardBytesStats[] = "WebRTC-UseStandardBytesStats";
65
66 // The following is the enum RTCStatsIceCandidateType from
67 // http://w3c.github.io/webrtc-stats/#rtcstatsicecandidatetype-enum such that
68 // our stats report for ice candidate type could conform to that.
69 const char STATSREPORT_LOCAL_PORT_TYPE[] = "host";
70 const char STATSREPORT_STUN_PORT_TYPE[] = "serverreflexive";
71 const char STATSREPORT_PRFLX_PORT_TYPE[] = "peerreflexive";
72 const char STATSREPORT_RELAY_PORT_TYPE[] = "relayed";
73
74 // Strings used by the stats collector to report adapter types. This fits the
75 // general stype of http://w3c.github.io/webrtc-stats than what
76 // AdapterTypeToString does.
77 const char* STATSREPORT_ADAPTER_TYPE_ETHERNET = "lan";
78 const char* STATSREPORT_ADAPTER_TYPE_WIFI = "wlan";
79 const char* STATSREPORT_ADAPTER_TYPE_WWAN = "wwan";
80 const char* STATSREPORT_ADAPTER_TYPE_VPN = "vpn";
81 const char* STATSREPORT_ADAPTER_TYPE_LOOPBACK = "loopback";
82 const char* STATSREPORT_ADAPTER_TYPE_WILDCARD = "wildcard";
83
84 template <typename ValueType>
85 struct TypeForAdd {
86 const StatsReport::StatsValueName name;
87 const ValueType& value;
88 };
89
90 typedef TypeForAdd<bool> BoolForAdd;
91 typedef TypeForAdd<float> FloatForAdd;
92 typedef TypeForAdd<int64_t> Int64ForAdd;
93 typedef TypeForAdd<int> IntForAdd;
94
AddTrackReport(StatsCollection * reports,const std::string & track_id)95 StatsReport* AddTrackReport(StatsCollection* reports,
96 const std::string& track_id) {
97 // Adds an empty track report.
98 StatsReport::Id id(
99 StatsReport::NewTypedId(StatsReport::kStatsReportTypeTrack, track_id));
100 StatsReport* report = reports->ReplaceOrAddNew(id);
101 report->AddString(StatsReport::kStatsValueNameTrackId, track_id);
102 return report;
103 }
104
105 template <class Track>
CreateTrackReport(const Track * track,StatsCollection * reports,TrackIdMap * track_ids)106 void CreateTrackReport(const Track* track,
107 StatsCollection* reports,
108 TrackIdMap* track_ids) {
109 const std::string& track_id = track->id();
110 StatsReport* report = AddTrackReport(reports, track_id);
111 RTC_DCHECK(report != nullptr);
112 (*track_ids)[track_id] = report;
113 }
114
115 template <class TrackVector>
CreateTrackReports(const TrackVector & tracks,StatsCollection * reports,TrackIdMap * track_ids)116 void CreateTrackReports(const TrackVector& tracks,
117 StatsCollection* reports,
118 TrackIdMap* track_ids) {
119 for (const auto& track : tracks) {
120 CreateTrackReport(track.get(), reports, track_ids);
121 }
122 }
123
ExtractCommonSendProperties(const cricket::MediaSenderInfo & info,StatsReport * report,bool use_standard_bytes_stats)124 void ExtractCommonSendProperties(const cricket::MediaSenderInfo& info,
125 StatsReport* report,
126 bool use_standard_bytes_stats) {
127 report->AddString(StatsReport::kStatsValueNameCodecName, info.codec_name);
128 int64_t bytes_sent = info.payload_bytes_sent;
129 if (!use_standard_bytes_stats) {
130 bytes_sent += info.header_and_padding_bytes_sent;
131 }
132 report->AddInt64(StatsReport::kStatsValueNameBytesSent, bytes_sent);
133 if (info.rtt_ms >= 0) {
134 report->AddInt64(StatsReport::kStatsValueNameRtt, info.rtt_ms);
135 }
136 }
137
ExtractCommonReceiveProperties(const cricket::MediaReceiverInfo & info,StatsReport * report)138 void ExtractCommonReceiveProperties(const cricket::MediaReceiverInfo& info,
139 StatsReport* report) {
140 report->AddString(StatsReport::kStatsValueNameCodecName, info.codec_name);
141 }
142
SetAudioProcessingStats(StatsReport * report,const AudioProcessingStats & apm_stats)143 void SetAudioProcessingStats(StatsReport* report,
144 const AudioProcessingStats& apm_stats) {
145 if (apm_stats.delay_median_ms) {
146 report->AddInt(StatsReport::kStatsValueNameEchoDelayMedian,
147 *apm_stats.delay_median_ms);
148 }
149 if (apm_stats.delay_standard_deviation_ms) {
150 report->AddInt(StatsReport::kStatsValueNameEchoDelayStdDev,
151 *apm_stats.delay_standard_deviation_ms);
152 }
153 if (apm_stats.echo_return_loss) {
154 report->AddInt(StatsReport::kStatsValueNameEchoReturnLoss,
155 *apm_stats.echo_return_loss);
156 }
157 if (apm_stats.echo_return_loss_enhancement) {
158 report->AddInt(StatsReport::kStatsValueNameEchoReturnLossEnhancement,
159 *apm_stats.echo_return_loss_enhancement);
160 }
161 if (apm_stats.residual_echo_likelihood) {
162 report->AddFloat(StatsReport::kStatsValueNameResidualEchoLikelihood,
163 static_cast<float>(*apm_stats.residual_echo_likelihood));
164 }
165 if (apm_stats.residual_echo_likelihood_recent_max) {
166 report->AddFloat(
167 StatsReport::kStatsValueNameResidualEchoLikelihoodRecentMax,
168 static_cast<float>(*apm_stats.residual_echo_likelihood_recent_max));
169 }
170 if (apm_stats.divergent_filter_fraction) {
171 report->AddFloat(StatsReport::kStatsValueNameAecDivergentFilterFraction,
172 static_cast<float>(*apm_stats.divergent_filter_fraction));
173 }
174 }
175
ExtractStats(const cricket::VoiceReceiverInfo & info,StatsReport * report,bool use_standard_bytes_stats)176 void ExtractStats(const cricket::VoiceReceiverInfo& info,
177 StatsReport* report,
178 bool use_standard_bytes_stats) {
179 ExtractCommonReceiveProperties(info, report);
180 const FloatForAdd floats[] = {
181 {StatsReport::kStatsValueNameExpandRate, info.expand_rate},
182 {StatsReport::kStatsValueNameSecondaryDecodedRate,
183 info.secondary_decoded_rate},
184 {StatsReport::kStatsValueNameSecondaryDiscardedRate,
185 info.secondary_discarded_rate},
186 {StatsReport::kStatsValueNameSpeechExpandRate, info.speech_expand_rate},
187 {StatsReport::kStatsValueNameAccelerateRate, info.accelerate_rate},
188 {StatsReport::kStatsValueNamePreemptiveExpandRate,
189 info.preemptive_expand_rate},
190 {StatsReport::kStatsValueNameTotalAudioEnergy, info.total_output_energy},
191 {StatsReport::kStatsValueNameTotalSamplesDuration,
192 info.total_output_duration}};
193
194 const IntForAdd ints[] = {
195 {StatsReport::kStatsValueNameCurrentDelayMs, info.delay_estimate_ms},
196 {StatsReport::kStatsValueNameDecodingCNG, info.decoding_cng},
197 {StatsReport::kStatsValueNameDecodingCTN, info.decoding_calls_to_neteq},
198 {StatsReport::kStatsValueNameDecodingCTSG,
199 info.decoding_calls_to_silence_generator},
200 {StatsReport::kStatsValueNameDecodingMutedOutput,
201 info.decoding_muted_output},
202 {StatsReport::kStatsValueNameDecodingNormal, info.decoding_normal},
203 {StatsReport::kStatsValueNameDecodingPLC, info.decoding_plc},
204 {StatsReport::kStatsValueNameDecodingPLCCNG, info.decoding_plc_cng},
205 {StatsReport::kStatsValueNameJitterBufferMs, info.jitter_buffer_ms},
206 {StatsReport::kStatsValueNameJitterReceived, info.jitter_ms},
207 {StatsReport::kStatsValueNamePacketsLost, info.packets_lost},
208 {StatsReport::kStatsValueNamePacketsReceived, info.packets_rcvd},
209 {StatsReport::kStatsValueNamePreferredJitterBufferMs,
210 info.jitter_buffer_preferred_ms},
211 };
212
213 for (const auto& f : floats)
214 report->AddFloat(f.name, f.value);
215
216 for (const auto& i : ints)
217 report->AddInt(i.name, i.value);
218 if (info.audio_level >= 0) {
219 report->AddInt(StatsReport::kStatsValueNameAudioOutputLevel,
220 info.audio_level);
221 }
222 if (info.decoding_codec_plc)
223 report->AddInt(StatsReport::kStatsValueNameDecodingCodecPLC,
224 info.decoding_codec_plc);
225
226 int64_t bytes_rcvd = info.payload_bytes_rcvd;
227 if (!use_standard_bytes_stats) {
228 bytes_rcvd += info.header_and_padding_bytes_rcvd;
229 }
230 report->AddInt64(StatsReport::kStatsValueNameBytesReceived, bytes_rcvd);
231 if (info.capture_start_ntp_time_ms >= 0) {
232 report->AddInt64(StatsReport::kStatsValueNameCaptureStartNtpTimeMs,
233 info.capture_start_ntp_time_ms);
234 }
235 report->AddString(StatsReport::kStatsValueNameMediaType, "audio");
236 }
237
ExtractStats(const cricket::VoiceSenderInfo & info,StatsReport * report,bool use_standard_bytes_stats)238 void ExtractStats(const cricket::VoiceSenderInfo& info,
239 StatsReport* report,
240 bool use_standard_bytes_stats) {
241 ExtractCommonSendProperties(info, report, use_standard_bytes_stats);
242
243 SetAudioProcessingStats(report, info.apm_statistics);
244
245 const FloatForAdd floats[] = {
246 {StatsReport::kStatsValueNameTotalAudioEnergy, info.total_input_energy},
247 {StatsReport::kStatsValueNameTotalSamplesDuration,
248 info.total_input_duration}};
249
250 RTC_DCHECK_GE(info.audio_level, 0);
251 const IntForAdd ints[] = {
252 {StatsReport::kStatsValueNameAudioInputLevel, info.audio_level},
253 {StatsReport::kStatsValueNameJitterReceived, info.jitter_ms},
254 {StatsReport::kStatsValueNamePacketsLost, info.packets_lost},
255 {StatsReport::kStatsValueNamePacketsSent, info.packets_sent},
256 };
257
258 for (const auto& f : floats) {
259 report->AddFloat(f.name, f.value);
260 }
261
262 for (const auto& i : ints) {
263 if (i.value >= 0) {
264 report->AddInt(i.name, i.value);
265 }
266 }
267 report->AddString(StatsReport::kStatsValueNameMediaType, "audio");
268 if (info.ana_statistics.bitrate_action_counter) {
269 report->AddInt(StatsReport::kStatsValueNameAnaBitrateActionCounter,
270 *info.ana_statistics.bitrate_action_counter);
271 }
272 if (info.ana_statistics.channel_action_counter) {
273 report->AddInt(StatsReport::kStatsValueNameAnaChannelActionCounter,
274 *info.ana_statistics.channel_action_counter);
275 }
276 if (info.ana_statistics.dtx_action_counter) {
277 report->AddInt(StatsReport::kStatsValueNameAnaDtxActionCounter,
278 *info.ana_statistics.dtx_action_counter);
279 }
280 if (info.ana_statistics.fec_action_counter) {
281 report->AddInt(StatsReport::kStatsValueNameAnaFecActionCounter,
282 *info.ana_statistics.fec_action_counter);
283 }
284 if (info.ana_statistics.frame_length_increase_counter) {
285 report->AddInt(StatsReport::kStatsValueNameAnaFrameLengthIncreaseCounter,
286 *info.ana_statistics.frame_length_increase_counter);
287 }
288 if (info.ana_statistics.frame_length_decrease_counter) {
289 report->AddInt(StatsReport::kStatsValueNameAnaFrameLengthDecreaseCounter,
290 *info.ana_statistics.frame_length_decrease_counter);
291 }
292 if (info.ana_statistics.uplink_packet_loss_fraction) {
293 report->AddFloat(StatsReport::kStatsValueNameAnaUplinkPacketLossFraction,
294 *info.ana_statistics.uplink_packet_loss_fraction);
295 }
296 }
297
ExtractStats(const cricket::VideoReceiverInfo & info,StatsReport * report,bool use_standard_bytes_stats)298 void ExtractStats(const cricket::VideoReceiverInfo& info,
299 StatsReport* report,
300 bool use_standard_bytes_stats) {
301 ExtractCommonReceiveProperties(info, report);
302 report->AddString(StatsReport::kStatsValueNameCodecImplementationName,
303 info.decoder_implementation_name);
304 int64_t bytes_rcvd = info.payload_bytes_rcvd;
305 if (!use_standard_bytes_stats) {
306 bytes_rcvd += info.header_and_padding_bytes_rcvd;
307 }
308 report->AddInt64(StatsReport::kStatsValueNameBytesReceived, bytes_rcvd);
309 if (info.capture_start_ntp_time_ms >= 0) {
310 report->AddInt64(StatsReport::kStatsValueNameCaptureStartNtpTimeMs,
311 info.capture_start_ntp_time_ms);
312 }
313 if (info.first_frame_received_to_decoded_ms >= 0) {
314 report->AddInt64(StatsReport::kStatsValueNameFirstFrameReceivedToDecodedMs,
315 info.first_frame_received_to_decoded_ms);
316 }
317 if (info.qp_sum)
318 report->AddInt64(StatsReport::kStatsValueNameQpSum, *info.qp_sum);
319
320 if (info.nacks_sent) {
321 report->AddInt(StatsReport::kStatsValueNameNacksSent, *info.nacks_sent);
322 }
323
324 const IntForAdd ints[] = {
325 {StatsReport::kStatsValueNameCurrentDelayMs, info.current_delay_ms},
326 {StatsReport::kStatsValueNameDecodeMs, info.decode_ms},
327 {StatsReport::kStatsValueNameFirsSent, info.firs_sent},
328 {StatsReport::kStatsValueNameFrameHeightReceived, info.frame_height},
329 {StatsReport::kStatsValueNameFrameRateDecoded, info.framerate_decoded},
330 {StatsReport::kStatsValueNameFrameRateOutput, info.framerate_output},
331 {StatsReport::kStatsValueNameFrameRateReceived, info.framerate_rcvd},
332 {StatsReport::kStatsValueNameFrameWidthReceived, info.frame_width},
333 {StatsReport::kStatsValueNameJitterBufferMs, info.jitter_buffer_ms},
334 {StatsReport::kStatsValueNameMaxDecodeMs, info.max_decode_ms},
335 {StatsReport::kStatsValueNameMinPlayoutDelayMs,
336 info.min_playout_delay_ms},
337 {StatsReport::kStatsValueNamePacketsLost, info.packets_lost},
338 {StatsReport::kStatsValueNamePacketsReceived, info.packets_rcvd},
339 {StatsReport::kStatsValueNamePlisSent, info.plis_sent},
340 {StatsReport::kStatsValueNameRenderDelayMs, info.render_delay_ms},
341 {StatsReport::kStatsValueNameTargetDelayMs, info.target_delay_ms},
342 {StatsReport::kStatsValueNameFramesDecoded, info.frames_decoded},
343 };
344
345 for (const auto& i : ints)
346 report->AddInt(i.name, i.value);
347 report->AddString(StatsReport::kStatsValueNameMediaType, "video");
348
349 if (info.timing_frame_info) {
350 report->AddString(StatsReport::kStatsValueNameTimingFrameInfo,
351 info.timing_frame_info->ToString());
352 }
353
354 report->AddInt64(StatsReport::kStatsValueNameInterframeDelayMaxMs,
355 info.interframe_delay_max_ms);
356
357 report->AddString(
358 StatsReport::kStatsValueNameContentType,
359 webrtc::videocontenttypehelpers::ToString(info.content_type));
360 }
361
ExtractStats(const cricket::VideoSenderInfo & info,StatsReport * report,bool use_standard_bytes_stats)362 void ExtractStats(const cricket::VideoSenderInfo& info,
363 StatsReport* report,
364 bool use_standard_bytes_stats) {
365 ExtractCommonSendProperties(info, report, use_standard_bytes_stats);
366
367 report->AddString(StatsReport::kStatsValueNameCodecImplementationName,
368 info.encoder_implementation_name);
369 report->AddBoolean(StatsReport::kStatsValueNameBandwidthLimitedResolution,
370 (info.adapt_reason & 0x2) > 0);
371 report->AddBoolean(StatsReport::kStatsValueNameCpuLimitedResolution,
372 (info.adapt_reason & 0x1) > 0);
373 report->AddBoolean(StatsReport::kStatsValueNameHasEnteredLowResolution,
374 info.has_entered_low_resolution);
375
376 if (info.qp_sum)
377 report->AddInt(StatsReport::kStatsValueNameQpSum, *info.qp_sum);
378
379 const IntForAdd ints[] = {
380 {StatsReport::kStatsValueNameAdaptationChanges, info.adapt_changes},
381 {StatsReport::kStatsValueNameAvgEncodeMs, info.avg_encode_ms},
382 {StatsReport::kStatsValueNameEncodeUsagePercent,
383 info.encode_usage_percent},
384 {StatsReport::kStatsValueNameFirsReceived, info.firs_rcvd},
385 {StatsReport::kStatsValueNameFrameHeightSent, info.send_frame_height},
386 {StatsReport::kStatsValueNameFrameRateInput, round(info.framerate_input)},
387 {StatsReport::kStatsValueNameFrameRateSent, info.framerate_sent},
388 {StatsReport::kStatsValueNameFrameWidthSent, info.send_frame_width},
389 {StatsReport::kStatsValueNameNacksReceived, info.nacks_rcvd},
390 {StatsReport::kStatsValueNamePacketsLost, info.packets_lost},
391 {StatsReport::kStatsValueNamePacketsSent, info.packets_sent},
392 {StatsReport::kStatsValueNamePlisReceived, info.plis_rcvd},
393 {StatsReport::kStatsValueNameFramesEncoded, info.frames_encoded},
394 {StatsReport::kStatsValueNameHugeFramesSent, info.huge_frames_sent},
395 };
396
397 for (const auto& i : ints)
398 report->AddInt(i.name, i.value);
399 report->AddString(StatsReport::kStatsValueNameMediaType, "video");
400 report->AddString(
401 StatsReport::kStatsValueNameContentType,
402 webrtc::videocontenttypehelpers::ToString(info.content_type));
403 }
404
ExtractStats(const cricket::BandwidthEstimationInfo & info,double stats_gathering_started,StatsReport * report)405 void ExtractStats(const cricket::BandwidthEstimationInfo& info,
406 double stats_gathering_started,
407 StatsReport* report) {
408 RTC_DCHECK(report->type() == StatsReport::kStatsReportTypeBwe);
409
410 report->set_timestamp(stats_gathering_started);
411 const IntForAdd ints[] = {
412 {StatsReport::kStatsValueNameAvailableSendBandwidth,
413 info.available_send_bandwidth},
414 {StatsReport::kStatsValueNameAvailableReceiveBandwidth,
415 info.available_recv_bandwidth},
416 {StatsReport::kStatsValueNameTargetEncBitrate, info.target_enc_bitrate},
417 {StatsReport::kStatsValueNameActualEncBitrate, info.actual_enc_bitrate},
418 {StatsReport::kStatsValueNameRetransmitBitrate, info.retransmit_bitrate},
419 {StatsReport::kStatsValueNameTransmitBitrate, info.transmit_bitrate},
420 };
421 for (const auto& i : ints)
422 report->AddInt(i.name, i.value);
423 report->AddInt64(StatsReport::kStatsValueNameBucketDelay, info.bucket_delay);
424 }
425
ExtractRemoteStats(const cricket::MediaSenderInfo & info,StatsReport * report)426 void ExtractRemoteStats(const cricket::MediaSenderInfo& info,
427 StatsReport* report) {
428 report->set_timestamp(info.remote_stats[0].timestamp);
429 // TODO(hta): Extract some stats here.
430 }
431
ExtractRemoteStats(const cricket::MediaReceiverInfo & info,StatsReport * report)432 void ExtractRemoteStats(const cricket::MediaReceiverInfo& info,
433 StatsReport* report) {
434 report->set_timestamp(info.remote_stats[0].timestamp);
435 // TODO(hta): Extract some stats here.
436 }
437
GetTrackIdBySsrc(uint32_t ssrc,StatsReport::Direction direction,const std::map<uint32_t,std::string> & track_id_by_ssrc)438 std::string GetTrackIdBySsrc(
439 uint32_t ssrc,
440 StatsReport::Direction direction,
441 const std::map<uint32_t, std::string>& track_id_by_ssrc) {
442 auto it = track_id_by_ssrc.find(ssrc);
443 if (it != track_id_by_ssrc.end()) {
444 return it->second;
445 }
446 if (direction == StatsReport::kReceive) {
447 // If the track ID was not found, this might be an unsignaled receive
448 // SSRC, so try looking up by the special SSRC 0.
449 it = track_id_by_ssrc.find(0);
450 if (it != track_id_by_ssrc.end()) {
451 RTC_LOG(LS_INFO) << "Assuming SSRC=" << ssrc
452 << " is an unsignalled receive stream corresponding "
453 "to the RtpReceiver with track ID \""
454 << it->second << "\".";
455 return it->second;
456 }
457 }
458 return "";
459 }
460
461 // Template to extract stats from a data vector.
462 // In order to use the template, the functions that are called from it,
463 // ExtractStats and ExtractRemoteStats, must be defined and overloaded
464 // for each type.
465 template <typename T>
ExtractStatsFromList(const std::vector<T> & data,const StatsReport::Id & transport_id,LegacyStatsCollector * collector,StatsReport::Direction direction,const std::map<uint32_t,std::string> & track_id_by_ssrc)466 void ExtractStatsFromList(
467 const std::vector<T>& data,
468 const StatsReport::Id& transport_id,
469 LegacyStatsCollector* collector,
470 StatsReport::Direction direction,
471 const std::map<uint32_t, std::string>& track_id_by_ssrc) {
472 for (const auto& d : data) {
473 uint32_t ssrc = d.ssrc();
474 std::string track_id = GetTrackIdBySsrc(ssrc, direction, track_id_by_ssrc);
475 // Each track can have stats for both local and remote objects.
476 // TODO(hta): Handle the case of multiple SSRCs per object.
477 StatsReport* report =
478 collector->PrepareReport(true, ssrc, track_id, transport_id, direction);
479 if (report)
480 ExtractStats(d, report, collector->UseStandardBytesStats());
481
482 if (!d.remote_stats.empty()) {
483 report = collector->PrepareReport(false, ssrc, track_id, transport_id,
484 direction);
485 if (report)
486 ExtractRemoteStats(d, report);
487 }
488 }
489 }
490
491 } // namespace
492
IceCandidateTypeToStatsType(const std::string & candidate_type)493 const char* IceCandidateTypeToStatsType(const std::string& candidate_type) {
494 if (candidate_type == cricket::LOCAL_PORT_TYPE) {
495 return STATSREPORT_LOCAL_PORT_TYPE;
496 }
497 if (candidate_type == cricket::STUN_PORT_TYPE) {
498 return STATSREPORT_STUN_PORT_TYPE;
499 }
500 if (candidate_type == cricket::PRFLX_PORT_TYPE) {
501 return STATSREPORT_PRFLX_PORT_TYPE;
502 }
503 if (candidate_type == cricket::RELAY_PORT_TYPE) {
504 return STATSREPORT_RELAY_PORT_TYPE;
505 }
506 RTC_DCHECK_NOTREACHED();
507 return "unknown";
508 }
509
AdapterTypeToStatsType(rtc::AdapterType type)510 const char* AdapterTypeToStatsType(rtc::AdapterType type) {
511 switch (type) {
512 case rtc::ADAPTER_TYPE_UNKNOWN:
513 return "unknown";
514 case rtc::ADAPTER_TYPE_ETHERNET:
515 return STATSREPORT_ADAPTER_TYPE_ETHERNET;
516 case rtc::ADAPTER_TYPE_WIFI:
517 return STATSREPORT_ADAPTER_TYPE_WIFI;
518 case rtc::ADAPTER_TYPE_CELLULAR:
519 case rtc::ADAPTER_TYPE_CELLULAR_2G:
520 case rtc::ADAPTER_TYPE_CELLULAR_3G:
521 case rtc::ADAPTER_TYPE_CELLULAR_4G:
522 case rtc::ADAPTER_TYPE_CELLULAR_5G:
523 return STATSREPORT_ADAPTER_TYPE_WWAN;
524 case rtc::ADAPTER_TYPE_VPN:
525 return STATSREPORT_ADAPTER_TYPE_VPN;
526 case rtc::ADAPTER_TYPE_LOOPBACK:
527 return STATSREPORT_ADAPTER_TYPE_LOOPBACK;
528 case rtc::ADAPTER_TYPE_ANY:
529 return STATSREPORT_ADAPTER_TYPE_WILDCARD;
530 default:
531 RTC_DCHECK_NOTREACHED();
532 return "";
533 }
534 }
535
LegacyStatsCollector(PeerConnectionInternal * pc)536 LegacyStatsCollector::LegacyStatsCollector(PeerConnectionInternal* pc)
537 : pc_(pc),
538 stats_gathering_started_(0),
539 use_standard_bytes_stats_(
540 pc->trials().IsEnabled(kUseStandardBytesStats)) {
541 RTC_DCHECK(pc_);
542 }
543
~LegacyStatsCollector()544 LegacyStatsCollector::~LegacyStatsCollector() {
545 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
546 }
547
548 // Wallclock time in ms.
GetTimeNow()549 double LegacyStatsCollector::GetTimeNow() {
550 return static_cast<double>(rtc::TimeUTCMillis());
551 }
552
553 // Adds a MediaStream with tracks that can be used as a `selector` in a call
554 // to GetStats.
AddStream(MediaStreamInterface * stream)555 void LegacyStatsCollector::AddStream(MediaStreamInterface* stream) {
556 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
557 RTC_DCHECK(stream != NULL);
558
559 CreateTrackReports<AudioTrackVector>(stream->GetAudioTracks(), &reports_,
560 &track_ids_);
561 CreateTrackReports<VideoTrackVector>(stream->GetVideoTracks(), &reports_,
562 &track_ids_);
563 }
564
AddTrack(MediaStreamTrackInterface * track)565 void LegacyStatsCollector::AddTrack(MediaStreamTrackInterface* track) {
566 if (track->kind() == MediaStreamTrackInterface::kAudioKind) {
567 CreateTrackReport(static_cast<AudioTrackInterface*>(track), &reports_,
568 &track_ids_);
569 } else if (track->kind() == MediaStreamTrackInterface::kVideoKind) {
570 CreateTrackReport(static_cast<VideoTrackInterface*>(track), &reports_,
571 &track_ids_);
572 } else {
573 RTC_DCHECK_NOTREACHED() << "Illegal track kind";
574 }
575 }
576
AddLocalAudioTrack(AudioTrackInterface * audio_track,uint32_t ssrc)577 void LegacyStatsCollector::AddLocalAudioTrack(AudioTrackInterface* audio_track,
578 uint32_t ssrc) {
579 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
580 RTC_DCHECK(audio_track != NULL);
581 #if RTC_DCHECK_IS_ON
582 for (const auto& track : local_audio_tracks_)
583 RTC_DCHECK(track.first != audio_track || track.second != ssrc);
584 #endif
585
586 local_audio_tracks_.push_back(std::make_pair(audio_track, ssrc));
587
588 // Create the kStatsReportTypeTrack report for the new track if there is no
589 // report yet.
590 StatsReport::Id id(StatsReport::NewTypedId(StatsReport::kStatsReportTypeTrack,
591 audio_track->id()));
592 StatsReport* report = reports_.Find(id);
593 if (!report) {
594 report = reports_.InsertNew(id);
595 report->AddString(StatsReport::kStatsValueNameTrackId, audio_track->id());
596 }
597 }
598
RemoveLocalAudioTrack(AudioTrackInterface * audio_track,uint32_t ssrc)599 void LegacyStatsCollector::RemoveLocalAudioTrack(
600 AudioTrackInterface* audio_track,
601 uint32_t ssrc) {
602 RTC_DCHECK(audio_track != NULL);
603 local_audio_tracks_.erase(
604 std::remove_if(
605 local_audio_tracks_.begin(), local_audio_tracks_.end(),
606 [audio_track, ssrc](const LocalAudioTrackVector::value_type& track) {
607 return track.first == audio_track && track.second == ssrc;
608 }),
609 local_audio_tracks_.end());
610 }
611
GetStats(MediaStreamTrackInterface * track,StatsReports * reports)612 void LegacyStatsCollector::GetStats(MediaStreamTrackInterface* track,
613 StatsReports* reports) {
614 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
615 RTC_DCHECK(reports != NULL);
616 RTC_DCHECK(reports->empty());
617
618 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
619
620 if (!track) {
621 reports->reserve(reports_.size());
622 for (auto* r : reports_)
623 reports->push_back(r);
624 return;
625 }
626
627 StatsReport* report = reports_.Find(StatsReport::NewTypedId(
628 StatsReport::kStatsReportTypeSession, pc_->session_id()));
629 if (report)
630 reports->push_back(report);
631
632 report = reports_.Find(
633 StatsReport::NewTypedId(StatsReport::kStatsReportTypeTrack, track->id()));
634
635 if (!report)
636 return;
637
638 reports->push_back(report);
639
640 std::string track_id;
641 for (const auto* r : reports_) {
642 if (r->type() != StatsReport::kStatsReportTypeSsrc)
643 continue;
644
645 const StatsReport::Value* v =
646 r->FindValue(StatsReport::kStatsValueNameTrackId);
647 if (v && v->string_val() == track->id())
648 reports->push_back(r);
649 }
650 }
651
UpdateStats(PeerConnectionInterface::StatsOutputLevel level)652 void LegacyStatsCollector::UpdateStats(
653 PeerConnectionInterface::StatsOutputLevel level) {
654 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
655 // Calls to UpdateStats() that occur less than kMinGatherStatsPeriodMs apart
656 // will be ignored. Using a monotonic clock specifically for this, while using
657 // a UTC clock for the reports themselves.
658 const int64_t kMinGatherStatsPeriodMs = 50;
659 int64_t cache_now_ms = rtc::TimeMillis();
660 if (cache_timestamp_ms_ != 0 &&
661 cache_timestamp_ms_ + kMinGatherStatsPeriodMs > cache_now_ms) {
662 return;
663 }
664 cache_timestamp_ms_ = cache_now_ms;
665 stats_gathering_started_ = GetTimeNow();
666
667 // TODO(tommi): ExtractSessionInfo now has a single hop to the network thread
668 // to fetch stats, then applies them on the signaling thread. See if we need
669 // to do this synchronously or if updating the stats without blocking is safe.
670 std::map<std::string, std::string> transport_names_by_mid =
671 ExtractSessionInfo();
672
673 // TODO(tommi): All of these hop over to the worker thread to fetch
674 // information. We could post a task to run all of these and post
675 // the information back to the signaling thread where we can create and
676 // update stats reports. That would also clean up the threading story a bit
677 // since we'd be creating/updating the stats report objects consistently on
678 // the same thread (this class has no locks right now).
679 ExtractBweInfo();
680 ExtractMediaInfo(transport_names_by_mid);
681 ExtractSenderInfo();
682 ExtractDataInfo();
683 UpdateTrackReports();
684 }
685
PrepareReport(bool local,uint32_t ssrc,const std::string & track_id,const StatsReport::Id & transport_id,StatsReport::Direction direction)686 StatsReport* LegacyStatsCollector::PrepareReport(
687 bool local,
688 uint32_t ssrc,
689 const std::string& track_id,
690 const StatsReport::Id& transport_id,
691 StatsReport::Direction direction) {
692 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
693 StatsReport::Id id(StatsReport::NewIdWithDirection(
694 local ? StatsReport::kStatsReportTypeSsrc
695 : StatsReport::kStatsReportTypeRemoteSsrc,
696 rtc::ToString(ssrc), direction));
697 StatsReport* report = reports_.Find(id);
698 if (!report) {
699 report = reports_.InsertNew(id);
700 }
701
702 // FYI - for remote reports, the timestamp will be overwritten later.
703 report->set_timestamp(stats_gathering_started_);
704
705 report->AddInt64(StatsReport::kStatsValueNameSsrc, ssrc);
706 if (!track_id.empty()) {
707 report->AddString(StatsReport::kStatsValueNameTrackId, track_id);
708 }
709 // Add the mapping of SSRC to transport.
710 report->AddId(StatsReport::kStatsValueNameTransportId, transport_id);
711 return report;
712 }
713
PrepareADMReport()714 StatsReport* LegacyStatsCollector::PrepareADMReport() {
715 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
716 StatsReport::Id id(StatsReport::NewTypedId(
717 StatsReport::kStatsReportTypeSession, pc_->session_id()));
718 StatsReport* report = reports_.FindOrAddNew(id);
719 return report;
720 }
721
IsValidTrack(const std::string & track_id)722 bool LegacyStatsCollector::IsValidTrack(const std::string& track_id) {
723 return reports_.Find(StatsReport::NewTypedId(
724 StatsReport::kStatsReportTypeTrack, track_id)) != nullptr;
725 }
726
AddCertificateReports(std::unique_ptr<rtc::SSLCertificateStats> cert_stats)727 StatsReport* LegacyStatsCollector::AddCertificateReports(
728 std::unique_ptr<rtc::SSLCertificateStats> cert_stats) {
729 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
730
731 StatsReport* first_report = nullptr;
732 StatsReport* prev_report = nullptr;
733 for (rtc::SSLCertificateStats* stats = cert_stats.get(); stats;
734 stats = stats->issuer.get()) {
735 StatsReport::Id id(StatsReport::NewTypedId(
736 StatsReport::kStatsReportTypeCertificate, stats->fingerprint));
737
738 StatsReport* report = reports_.ReplaceOrAddNew(id);
739 report->set_timestamp(stats_gathering_started_);
740 report->AddString(StatsReport::kStatsValueNameFingerprint,
741 stats->fingerprint);
742 report->AddString(StatsReport::kStatsValueNameFingerprintAlgorithm,
743 stats->fingerprint_algorithm);
744 report->AddString(StatsReport::kStatsValueNameDer,
745 stats->base64_certificate);
746 if (!first_report)
747 first_report = report;
748 else
749 prev_report->AddId(StatsReport::kStatsValueNameIssuerId, id);
750 prev_report = report;
751 }
752 return first_report;
753 }
754
AddConnectionInfoReport(const std::string & content_name,int component,int connection_id,const StatsReport::Id & channel_report_id,const cricket::ConnectionInfo & info)755 StatsReport* LegacyStatsCollector::AddConnectionInfoReport(
756 const std::string& content_name,
757 int component,
758 int connection_id,
759 const StatsReport::Id& channel_report_id,
760 const cricket::ConnectionInfo& info) {
761 StatsReport::Id id(
762 StatsReport::NewCandidatePairId(content_name, component, connection_id));
763 StatsReport* report = reports_.ReplaceOrAddNew(id);
764 report->set_timestamp(stats_gathering_started_);
765
766 const BoolForAdd bools[] = {
767 {StatsReport::kStatsValueNameActiveConnection, info.best_connection},
768 {StatsReport::kStatsValueNameReceiving, info.receiving},
769 {StatsReport::kStatsValueNameWritable, info.writable},
770 };
771 for (const auto& b : bools)
772 report->AddBoolean(b.name, b.value);
773
774 report->AddId(StatsReport::kStatsValueNameChannelId, channel_report_id);
775 cricket::CandidateStats local_candidate_stats(info.local_candidate);
776 cricket::CandidateStats remote_candidate_stats(info.remote_candidate);
777 report->AddId(StatsReport::kStatsValueNameLocalCandidateId,
778 AddCandidateReport(local_candidate_stats, true)->id());
779 report->AddId(StatsReport::kStatsValueNameRemoteCandidateId,
780 AddCandidateReport(remote_candidate_stats, false)->id());
781
782 const Int64ForAdd int64s[] = {
783 {StatsReport::kStatsValueNameBytesReceived, info.recv_total_bytes},
784 {StatsReport::kStatsValueNameBytesSent, info.sent_total_bytes},
785 {StatsReport::kStatsValueNamePacketsSent, info.sent_total_packets},
786 {StatsReport::kStatsValueNameRtt, info.rtt},
787 {StatsReport::kStatsValueNameSendPacketsDiscarded,
788 info.sent_discarded_packets},
789 {StatsReport::kStatsValueNameSentPingRequestsTotal,
790 info.sent_ping_requests_total},
791 {StatsReport::kStatsValueNameSentPingRequestsBeforeFirstResponse,
792 info.sent_ping_requests_before_first_response},
793 {StatsReport::kStatsValueNameSentPingResponses, info.sent_ping_responses},
794 {StatsReport::kStatsValueNameRecvPingRequests, info.recv_ping_requests},
795 {StatsReport::kStatsValueNameRecvPingResponses, info.recv_ping_responses},
796 };
797 for (const auto& i : int64s)
798 report->AddInt64(i.name, i.value);
799
800 report->AddString(StatsReport::kStatsValueNameLocalAddress,
801 info.local_candidate.address().ToString());
802 report->AddString(StatsReport::kStatsValueNameLocalCandidateType,
803 info.local_candidate.type());
804 report->AddString(StatsReport::kStatsValueNameRemoteAddress,
805 info.remote_candidate.address().ToString());
806 report->AddString(StatsReport::kStatsValueNameRemoteCandidateType,
807 info.remote_candidate.type());
808 report->AddString(StatsReport::kStatsValueNameTransportType,
809 info.local_candidate.protocol());
810 report->AddString(StatsReport::kStatsValueNameLocalCandidateRelayProtocol,
811 info.local_candidate.relay_protocol());
812
813 return report;
814 }
815
AddCandidateReport(const cricket::CandidateStats & candidate_stats,bool local)816 StatsReport* LegacyStatsCollector::AddCandidateReport(
817 const cricket::CandidateStats& candidate_stats,
818 bool local) {
819 const auto& candidate = candidate_stats.candidate();
820 StatsReport::Id id(StatsReport::NewCandidateId(local, candidate.id()));
821 StatsReport* report = reports_.Find(id);
822 if (!report) {
823 report = reports_.InsertNew(id);
824 report->set_timestamp(stats_gathering_started_);
825 if (local) {
826 report->AddString(StatsReport::kStatsValueNameCandidateNetworkType,
827 AdapterTypeToStatsType(candidate.network_type()));
828 }
829 report->AddString(StatsReport::kStatsValueNameCandidateIPAddress,
830 candidate.address().ipaddr().ToString());
831 report->AddString(StatsReport::kStatsValueNameCandidatePortNumber,
832 candidate.address().PortAsString());
833 report->AddInt(StatsReport::kStatsValueNameCandidatePriority,
834 candidate.priority());
835 report->AddString(StatsReport::kStatsValueNameCandidateType,
836 IceCandidateTypeToStatsType(candidate.type()));
837 report->AddString(StatsReport::kStatsValueNameCandidateTransportType,
838 candidate.protocol());
839 }
840 report->set_timestamp(stats_gathering_started_);
841
842 if (local && candidate_stats.stun_stats().has_value()) {
843 const auto& stun_stats = candidate_stats.stun_stats().value();
844 report->AddInt64(StatsReport::kStatsValueNameSentStunKeepaliveRequests,
845 stun_stats.stun_binding_requests_sent);
846 report->AddInt64(StatsReport::kStatsValueNameRecvStunKeepaliveResponses,
847 stun_stats.stun_binding_responses_received);
848 report->AddFloat(StatsReport::kStatsValueNameStunKeepaliveRttTotal,
849 stun_stats.stun_binding_rtt_ms_total);
850 report->AddFloat(StatsReport::kStatsValueNameStunKeepaliveRttSquaredTotal,
851 stun_stats.stun_binding_rtt_ms_squared_total);
852 }
853
854 return report;
855 }
856
ExtractSessionInfo()857 std::map<std::string, std::string> LegacyStatsCollector::ExtractSessionInfo() {
858 TRACE_EVENT0("webrtc", "LegacyStatsCollector::ExtractSessionInfo");
859 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
860
861 SessionStats stats;
862 auto transceivers = pc_->GetTransceiversInternal();
863 pc_->network_thread()->BlockingCall(
864 [&, sctp_transport_name = pc_->sctp_transport_name(),
865 sctp_mid = pc_->sctp_mid()]() mutable {
866 stats = ExtractSessionInfo_n(
867 transceivers, std::move(sctp_transport_name), std::move(sctp_mid));
868 });
869
870 ExtractSessionInfo_s(stats);
871
872 return std::move(stats.transport_names_by_mid);
873 }
874
ExtractSessionInfo_n(const std::vector<rtc::scoped_refptr<RtpTransceiverProxyWithInternal<RtpTransceiver>>> & transceivers,absl::optional<std::string> sctp_transport_name,absl::optional<std::string> sctp_mid)875 LegacyStatsCollector::SessionStats LegacyStatsCollector::ExtractSessionInfo_n(
876 const std::vector<rtc::scoped_refptr<
877 RtpTransceiverProxyWithInternal<RtpTransceiver>>>& transceivers,
878 absl::optional<std::string> sctp_transport_name,
879 absl::optional<std::string> sctp_mid) {
880 TRACE_EVENT0("webrtc", "LegacyStatsCollector::ExtractSessionInfo_n");
881 RTC_DCHECK_RUN_ON(pc_->network_thread());
882 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
883 SessionStats stats;
884 stats.candidate_stats = pc_->GetPooledCandidateStats();
885 for (auto& transceiver : transceivers) {
886 cricket::ChannelInterface* channel = transceiver->internal()->channel();
887 if (channel) {
888 stats.transport_names_by_mid[channel->mid()] =
889 std::string(channel->transport_name());
890 }
891 }
892
893 if (sctp_transport_name) {
894 RTC_DCHECK(sctp_mid);
895 stats.transport_names_by_mid[*sctp_mid] = *sctp_transport_name;
896 }
897
898 std::set<std::string> transport_names;
899 for (const auto& entry : stats.transport_names_by_mid) {
900 transport_names.insert(entry.second);
901 }
902
903 std::map<std::string, cricket::TransportStats> transport_stats_by_name =
904 pc_->GetTransportStatsByNames(transport_names);
905
906 for (auto& entry : transport_stats_by_name) {
907 stats.transport_stats.emplace_back(entry.first, std::move(entry.second));
908 TransportStats& transport = stats.transport_stats.back();
909
910 // Attempt to get a copy of the certificates from the transport and
911 // expose them in stats reports. All channels in a transport share the
912 // same local and remote certificates.
913 //
914 StatsReport::Id local_cert_report_id, remote_cert_report_id;
915 rtc::scoped_refptr<rtc::RTCCertificate> certificate;
916 if (pc_->GetLocalCertificate(transport.name, &certificate)) {
917 transport.local_cert_stats =
918 certificate->GetSSLCertificateChain().GetStats();
919 }
920
921 std::unique_ptr<rtc::SSLCertChain> remote_cert_chain =
922 pc_->GetRemoteSSLCertChain(transport.name);
923 if (remote_cert_chain) {
924 transport.remote_cert_stats = remote_cert_chain->GetStats();
925 }
926 }
927
928 return stats;
929 }
930
ExtractSessionInfo_s(SessionStats & session_stats)931 void LegacyStatsCollector::ExtractSessionInfo_s(SessionStats& session_stats) {
932 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
933 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
934
935 StatsReport::Id id(StatsReport::NewTypedId(
936 StatsReport::kStatsReportTypeSession, pc_->session_id()));
937 StatsReport* report = reports_.ReplaceOrAddNew(id);
938 report->set_timestamp(stats_gathering_started_);
939 report->AddBoolean(StatsReport::kStatsValueNameInitiator,
940 pc_->initial_offerer());
941
942 for (const cricket::CandidateStats& stats : session_stats.candidate_stats) {
943 AddCandidateReport(stats, true);
944 }
945
946 for (auto& transport : session_stats.transport_stats) {
947 // Attempt to get a copy of the certificates from the transport and
948 // expose them in stats reports. All channels in a transport share the
949 // same local and remote certificates.
950 //
951 StatsReport::Id local_cert_report_id, remote_cert_report_id;
952 if (transport.local_cert_stats) {
953 StatsReport* r =
954 AddCertificateReports(std::move(transport.local_cert_stats));
955 if (r)
956 local_cert_report_id = r->id();
957 }
958
959 if (transport.remote_cert_stats) {
960 StatsReport* r =
961 AddCertificateReports(std::move(transport.remote_cert_stats));
962 if (r)
963 remote_cert_report_id = r->id();
964 }
965
966 for (const auto& channel_iter : transport.stats.channel_stats) {
967 StatsReport::Id channel_stats_id(
968 StatsReport::NewComponentId(transport.name, channel_iter.component));
969 StatsReport* channel_report = reports_.ReplaceOrAddNew(channel_stats_id);
970 channel_report->set_timestamp(stats_gathering_started_);
971 channel_report->AddInt(StatsReport::kStatsValueNameComponent,
972 channel_iter.component);
973 if (local_cert_report_id.get()) {
974 channel_report->AddId(StatsReport::kStatsValueNameLocalCertificateId,
975 local_cert_report_id);
976 }
977 if (remote_cert_report_id.get()) {
978 channel_report->AddId(StatsReport::kStatsValueNameRemoteCertificateId,
979 remote_cert_report_id);
980 }
981 int srtp_crypto_suite = channel_iter.srtp_crypto_suite;
982 if (srtp_crypto_suite != rtc::kSrtpInvalidCryptoSuite &&
983 rtc::SrtpCryptoSuiteToName(srtp_crypto_suite).length()) {
984 channel_report->AddString(
985 StatsReport::kStatsValueNameSrtpCipher,
986 rtc::SrtpCryptoSuiteToName(srtp_crypto_suite));
987 }
988 int ssl_cipher_suite = channel_iter.ssl_cipher_suite;
989 if (ssl_cipher_suite != rtc::kTlsNullWithNullNull &&
990 rtc::SSLStreamAdapter::SslCipherSuiteToName(ssl_cipher_suite)
991 .length()) {
992 channel_report->AddString(
993 StatsReport::kStatsValueNameDtlsCipher,
994 rtc::SSLStreamAdapter::SslCipherSuiteToName(ssl_cipher_suite));
995 }
996
997 // Collect stats for non-pooled candidates. Note that the reports
998 // generated here supersedes the candidate reports generated in
999 // AddConnectionInfoReport below, and they may report candidates that are
1000 // not paired. Also, the candidate report generated in
1001 // AddConnectionInfoReport do not report port stats like StunStats.
1002 for (const cricket::CandidateStats& stats :
1003 channel_iter.ice_transport_stats.candidate_stats_list) {
1004 AddCandidateReport(stats, true);
1005 }
1006
1007 int connection_id = 0;
1008 for (const cricket::ConnectionInfo& info :
1009 channel_iter.ice_transport_stats.connection_infos) {
1010 StatsReport* connection_report = AddConnectionInfoReport(
1011 transport.name, channel_iter.component, connection_id++,
1012 channel_report->id(), info);
1013 if (info.best_connection) {
1014 channel_report->AddId(
1015 StatsReport::kStatsValueNameSelectedCandidatePairId,
1016 connection_report->id());
1017 }
1018 }
1019 }
1020 }
1021 }
1022
ExtractBweInfo()1023 void LegacyStatsCollector::ExtractBweInfo() {
1024 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1025
1026 if (pc_->signaling_state() == PeerConnectionInterface::kClosed)
1027 return;
1028
1029 webrtc::Call::Stats call_stats = pc_->GetCallStats();
1030 cricket::BandwidthEstimationInfo bwe_info;
1031 bwe_info.available_send_bandwidth = call_stats.send_bandwidth_bps;
1032 bwe_info.available_recv_bandwidth = call_stats.recv_bandwidth_bps;
1033 bwe_info.bucket_delay = call_stats.pacer_delay_ms;
1034
1035 // Fill in target encoder bitrate, actual encoder bitrate, rtx bitrate, etc.
1036 // TODO(holmer): Also fill this in for audio.
1037 auto transceivers = pc_->GetTransceiversInternal();
1038 std::vector<cricket::VideoMediaChannel*> video_media_channels;
1039 for (const auto& transceiver : transceivers) {
1040 if (transceiver->media_type() != cricket::MEDIA_TYPE_VIDEO) {
1041 continue;
1042 }
1043 auto* video_channel = transceiver->internal()->channel();
1044 if (video_channel) {
1045 video_media_channels.push_back(static_cast<cricket::VideoMediaChannel*>(
1046 video_channel->media_channel()));
1047 }
1048 }
1049
1050 if (!video_media_channels.empty()) {
1051 pc_->worker_thread()->BlockingCall([&] {
1052 for (const auto& channel : video_media_channels) {
1053 channel->FillBitrateInfo(&bwe_info);
1054 }
1055 });
1056 }
1057
1058 StatsReport::Id report_id(StatsReport::NewBandwidthEstimationId());
1059 StatsReport* report = reports_.FindOrAddNew(report_id);
1060 ExtractStats(bwe_info, stats_gathering_started_, report);
1061 }
1062
1063 namespace {
1064
1065 class MediaChannelStatsGatherer {
1066 public:
1067 virtual ~MediaChannelStatsGatherer() = default;
1068
1069 virtual bool GetStatsOnWorkerThread() = 0;
1070
1071 virtual void ExtractStats(LegacyStatsCollector* collector) const = 0;
1072
1073 virtual bool HasRemoteAudio() const = 0;
1074
1075 std::string mid;
1076 std::string transport_name;
1077 std::map<uint32_t, std::string> sender_track_id_by_ssrc;
1078 std::map<uint32_t, std::string> receiver_track_id_by_ssrc;
1079
1080 protected:
1081 template <typename ReceiverT, typename SenderT>
ExtractSenderReceiverStats(LegacyStatsCollector * collector,const std::vector<ReceiverT> & receiver_data,const std::vector<SenderT> & sender_data) const1082 void ExtractSenderReceiverStats(
1083 LegacyStatsCollector* collector,
1084 const std::vector<ReceiverT>& receiver_data,
1085 const std::vector<SenderT>& sender_data) const {
1086 RTC_DCHECK(collector);
1087 StatsReport::Id transport_id = StatsReport::NewComponentId(
1088 transport_name, cricket::ICE_CANDIDATE_COMPONENT_RTP);
1089 ExtractStatsFromList(receiver_data, transport_id, collector,
1090 StatsReport::kReceive, receiver_track_id_by_ssrc);
1091 ExtractStatsFromList(sender_data, transport_id, collector,
1092 StatsReport::kSend, sender_track_id_by_ssrc);
1093 }
1094 };
1095
1096 class VoiceMediaChannelStatsGatherer final : public MediaChannelStatsGatherer {
1097 public:
VoiceMediaChannelStatsGatherer(cricket::VoiceMediaChannel * voice_media_channel)1098 VoiceMediaChannelStatsGatherer(
1099 cricket::VoiceMediaChannel* voice_media_channel)
1100 : voice_media_channel_(voice_media_channel) {
1101 RTC_DCHECK(voice_media_channel_);
1102 }
1103
GetStatsOnWorkerThread()1104 bool GetStatsOnWorkerThread() override {
1105 return voice_media_channel_->GetStats(&voice_media_info,
1106 /*get_and_clear_legacy_stats=*/true);
1107 }
1108
ExtractStats(LegacyStatsCollector * collector) const1109 void ExtractStats(LegacyStatsCollector* collector) const override {
1110 ExtractSenderReceiverStats(collector, voice_media_info.receivers,
1111 voice_media_info.senders);
1112 if (voice_media_info.device_underrun_count == -2 ||
1113 voice_media_info.device_underrun_count > 0) {
1114 StatsReport* report = collector->PrepareADMReport();
1115 report->AddInt(StatsReport::kStatsValueNameAudioDeviceUnderrunCounter,
1116 voice_media_info.device_underrun_count);
1117 }
1118 }
1119
HasRemoteAudio() const1120 bool HasRemoteAudio() const override {
1121 return !voice_media_info.receivers.empty();
1122 }
1123
1124 private:
1125 cricket::VoiceMediaChannel* voice_media_channel_;
1126 cricket::VoiceMediaInfo voice_media_info;
1127 };
1128
1129 class VideoMediaChannelStatsGatherer final : public MediaChannelStatsGatherer {
1130 public:
VideoMediaChannelStatsGatherer(cricket::VideoMediaChannel * video_media_channel)1131 VideoMediaChannelStatsGatherer(
1132 cricket::VideoMediaChannel* video_media_channel)
1133 : video_media_channel_(video_media_channel) {
1134 RTC_DCHECK(video_media_channel_);
1135 }
1136
GetStatsOnWorkerThread()1137 bool GetStatsOnWorkerThread() override {
1138 return video_media_channel_->GetStats(&video_media_info);
1139 }
1140
ExtractStats(LegacyStatsCollector * collector) const1141 void ExtractStats(LegacyStatsCollector* collector) const override {
1142 ExtractSenderReceiverStats(collector, video_media_info.receivers,
1143 video_media_info.aggregated_senders);
1144 }
1145
HasRemoteAudio() const1146 bool HasRemoteAudio() const override { return false; }
1147
1148 private:
1149 cricket::VideoMediaChannel* video_media_channel_;
1150 cricket::VideoMediaInfo video_media_info;
1151 };
1152
CreateMediaChannelStatsGatherer(cricket::MediaChannel * channel)1153 std::unique_ptr<MediaChannelStatsGatherer> CreateMediaChannelStatsGatherer(
1154 cricket::MediaChannel* channel) {
1155 RTC_DCHECK(channel);
1156 if (channel->media_type() == cricket::MEDIA_TYPE_AUDIO) {
1157 return std::make_unique<VoiceMediaChannelStatsGatherer>(
1158 static_cast<cricket::VoiceMediaChannel*>(channel));
1159 } else {
1160 RTC_DCHECK_EQ(channel->media_type(), cricket::MEDIA_TYPE_VIDEO);
1161 return std::make_unique<VideoMediaChannelStatsGatherer>(
1162 static_cast<cricket::VideoMediaChannel*>(channel));
1163 }
1164 }
1165
1166 } // namespace
1167
ExtractMediaInfo(const std::map<std::string,std::string> & transport_names_by_mid)1168 void LegacyStatsCollector::ExtractMediaInfo(
1169 const std::map<std::string, std::string>& transport_names_by_mid) {
1170 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1171
1172 std::vector<std::unique_ptr<MediaChannelStatsGatherer>> gatherers;
1173
1174 auto transceivers = pc_->GetTransceiversInternal();
1175 {
1176 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1177 for (const auto& transceiver : transceivers) {
1178 cricket::ChannelInterface* channel = transceiver->internal()->channel();
1179 if (!channel) {
1180 continue;
1181 }
1182 std::unique_ptr<MediaChannelStatsGatherer> gatherer =
1183 CreateMediaChannelStatsGatherer(channel->media_channel());
1184 gatherer->mid = channel->mid();
1185 gatherer->transport_name = transport_names_by_mid.at(gatherer->mid);
1186
1187 for (const auto& sender : transceiver->internal()->senders()) {
1188 auto track = sender->track();
1189 std::string track_id = (track ? track->id() : "");
1190 gatherer->sender_track_id_by_ssrc.insert(
1191 std::make_pair(sender->ssrc(), track_id));
1192 }
1193
1194 // Populating `receiver_track_id_by_ssrc` will be done on the worker
1195 // thread as the `ssrc` property of the receiver needs to be accessed
1196 // there.
1197
1198 gatherers.push_back(std::move(gatherer));
1199 }
1200 }
1201
1202 pc_->worker_thread()->BlockingCall([&] {
1203 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1204 // Populate `receiver_track_id_by_ssrc` for the gatherers.
1205 int i = 0;
1206 for (const auto& transceiver : transceivers) {
1207 cricket::ChannelInterface* channel = transceiver->internal()->channel();
1208 if (!channel)
1209 continue;
1210 MediaChannelStatsGatherer* gatherer = gatherers[i++].get();
1211 RTC_DCHECK_EQ(gatherer->mid, channel->mid());
1212
1213 for (const auto& receiver : transceiver->internal()->receivers()) {
1214 gatherer->receiver_track_id_by_ssrc.insert(std::make_pair(
1215 receiver->internal()->ssrc(), receiver->track()->id()));
1216 }
1217 }
1218
1219 for (auto it = gatherers.begin(); it != gatherers.end();
1220 /* incremented manually */) {
1221 MediaChannelStatsGatherer* gatherer = it->get();
1222 if (!gatherer->GetStatsOnWorkerThread()) {
1223 RTC_LOG(LS_ERROR) << "Failed to get media channel stats for mid="
1224 << gatherer->mid;
1225 it = gatherers.erase(it);
1226 continue;
1227 }
1228 ++it;
1229 }
1230 });
1231
1232 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1233
1234 bool has_remote_audio = false;
1235 for (const auto& gatherer : gatherers) {
1236 gatherer->ExtractStats(this);
1237 has_remote_audio |= gatherer->HasRemoteAudio();
1238 }
1239
1240 UpdateStatsFromExistingLocalAudioTracks(has_remote_audio);
1241 }
1242
ExtractSenderInfo()1243 void LegacyStatsCollector::ExtractSenderInfo() {
1244 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1245
1246 for (const auto& sender : pc_->GetSenders()) {
1247 // TODO(bugs.webrtc.org/8694): SSRC == 0 currently means none. Delete check
1248 // when that is fixed.
1249 if (!sender->ssrc()) {
1250 continue;
1251 }
1252 const rtc::scoped_refptr<MediaStreamTrackInterface> track(sender->track());
1253 if (!track || track->kind() != MediaStreamTrackInterface::kVideoKind) {
1254 continue;
1255 }
1256 // Safe, because kind() == kVideoKind implies a subclass of
1257 // VideoTrackInterface; see mediastreaminterface.h.
1258 VideoTrackSourceInterface* source =
1259 static_cast<VideoTrackInterface*>(track.get())->GetSource();
1260
1261 VideoTrackSourceInterface::Stats stats;
1262 if (!source->GetStats(&stats)) {
1263 continue;
1264 }
1265 const StatsReport::Id stats_id = StatsReport::NewIdWithDirection(
1266 StatsReport::kStatsReportTypeSsrc, rtc::ToString(sender->ssrc()),
1267 StatsReport::kSend);
1268 StatsReport* report = reports_.FindOrAddNew(stats_id);
1269 report->AddInt(StatsReport::kStatsValueNameFrameWidthInput,
1270 stats.input_width);
1271 report->AddInt(StatsReport::kStatsValueNameFrameHeightInput,
1272 stats.input_height);
1273 }
1274 }
1275
ExtractDataInfo()1276 void LegacyStatsCollector::ExtractDataInfo() {
1277 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1278
1279 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1280
1281 std::vector<DataChannelStats> data_stats = pc_->GetDataChannelStats();
1282 for (const auto& stats : data_stats) {
1283 StatsReport::Id id(StatsReport::NewTypedIntId(
1284 StatsReport::kStatsReportTypeDataChannel, stats.id));
1285 StatsReport* report = reports_.ReplaceOrAddNew(id);
1286 report->set_timestamp(stats_gathering_started_);
1287 report->AddString(StatsReport::kStatsValueNameLabel, stats.label);
1288 // Filter out the initial id (-1).
1289 if (stats.id >= 0) {
1290 report->AddInt(StatsReport::kStatsValueNameDataChannelId, stats.id);
1291 }
1292 report->AddString(StatsReport::kStatsValueNameProtocol, stats.protocol);
1293 report->AddString(StatsReport::kStatsValueNameState,
1294 DataChannelInterface::DataStateString(stats.state));
1295 }
1296 }
1297
GetReport(const StatsReport::StatsType & type,const std::string & id,StatsReport::Direction direction)1298 StatsReport* LegacyStatsCollector::GetReport(const StatsReport::StatsType& type,
1299 const std::string& id,
1300 StatsReport::Direction direction) {
1301 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1302 RTC_DCHECK(type == StatsReport::kStatsReportTypeSsrc ||
1303 type == StatsReport::kStatsReportTypeRemoteSsrc);
1304 return reports_.Find(StatsReport::NewIdWithDirection(type, id, direction));
1305 }
1306
UpdateStatsFromExistingLocalAudioTracks(bool has_remote_tracks)1307 void LegacyStatsCollector::UpdateStatsFromExistingLocalAudioTracks(
1308 bool has_remote_tracks) {
1309 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1310 // Loop through the existing local audio tracks.
1311 for (const auto& it : local_audio_tracks_) {
1312 AudioTrackInterface* track = it.first;
1313 uint32_t ssrc = it.second;
1314 StatsReport* report = GetReport(StatsReport::kStatsReportTypeSsrc,
1315 rtc::ToString(ssrc), StatsReport::kSend);
1316 if (report == NULL) {
1317 // This can happen if a local audio track is added to a stream on the
1318 // fly and the report has not been set up yet. Do nothing in this case.
1319 RTC_LOG(LS_ERROR) << "Stats report does not exist for ssrc " << ssrc;
1320 continue;
1321 }
1322
1323 // The same ssrc can be used by both local and remote audio tracks.
1324 const StatsReport::Value* v =
1325 report->FindValue(StatsReport::kStatsValueNameTrackId);
1326 if (!v || v->string_val() != track->id())
1327 continue;
1328
1329 report->set_timestamp(stats_gathering_started_);
1330 UpdateReportFromAudioTrack(track, report, has_remote_tracks);
1331 }
1332 }
1333
UpdateReportFromAudioTrack(AudioTrackInterface * track,StatsReport * report,bool has_remote_tracks)1334 void LegacyStatsCollector::UpdateReportFromAudioTrack(
1335 AudioTrackInterface* track,
1336 StatsReport* report,
1337 bool has_remote_tracks) {
1338 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1339 RTC_DCHECK(track != NULL);
1340
1341 // Don't overwrite report values if they're not available.
1342 int signal_level;
1343 if (track->GetSignalLevel(&signal_level)) {
1344 RTC_DCHECK_GE(signal_level, 0);
1345 report->AddInt(StatsReport::kStatsValueNameAudioInputLevel, signal_level);
1346 }
1347
1348 auto audio_processor(track->GetAudioProcessor());
1349
1350 if (audio_processor.get()) {
1351 AudioProcessorInterface::AudioProcessorStatistics stats =
1352 audio_processor->GetStats(has_remote_tracks);
1353
1354 SetAudioProcessingStats(report, stats.apm_statistics);
1355 }
1356 }
1357
UpdateTrackReports()1358 void LegacyStatsCollector::UpdateTrackReports() {
1359 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1360
1361 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1362
1363 for (const auto& entry : track_ids_) {
1364 StatsReport* report = entry.second;
1365 report->set_timestamp(stats_gathering_started_);
1366 }
1367 }
1368
InvalidateCache()1369 void LegacyStatsCollector::InvalidateCache() {
1370 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1371 cache_timestamp_ms_ = 0;
1372 }
1373
1374 } // namespace webrtc
1375