Change rate stats classes to use int64_t not size_t

This avoids integer overflows when size_t is 32 bits, and conforms
to style guide recommendations to avoid unsigned integers.

Also add tests for overflow on RateStatistics accumulator.

Bug: webrtc:11247
Change-Id: Ifa0db567f41bbcf3ec46d89ab888f2ed9d03f3f0
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/163991
Commit-Queue: Harald Alvestrand <hta@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Reviewed-by: Yves Gerey <yvesg@google.com>
Cr-Commit-Position: refs/heads/master@{#30268}

rtc_base/rate_statistics.cc

@@ -15,6 +15,8 @@
 #include <memory>
 
 #include "rtc_base/checks.h"
+#include "rtc_base/logging.h"
+#include "rtc_base/numerics/safe_conversions.h"
 
 namespace webrtc {
 
@@ -30,6 +32,7 @@ RateStatistics::RateStatistics(int64_t window_size_ms, float scale)
 
 RateStatistics::RateStatistics(const RateStatistics& other)
     : accumulated_count_(other.accumulated_count_),
+      overflow_(other.overflow_),
       num_samples_(other.num_samples_),
       oldest_time_(other.oldest_time_),
       oldest_index_(other.oldest_index_),
@@ -47,6 +50,7 @@ RateStatistics::~RateStatistics() {}
 
 void RateStatistics::Reset() {
   accumulated_count_ = 0;
+  overflow_ = false;
   num_samples_ = 0;
   oldest_time_ = -max_window_size_ms_;
   oldest_index_ = 0;
@@ -55,7 +59,8 @@ void RateStatistics::Reset() {
     buckets_[i] = Bucket();
 }
 
-void RateStatistics::Update(size_t count, int64_t now_ms) {
+void RateStatistics::Update(int64_t count, int64_t now_ms) {
+  RTC_DCHECK_LE(0, count);
   if (now_ms < oldest_time_) {
     // Too old data is ignored.
     return;
@@ -67,38 +72,45 @@ void RateStatistics::Update(size_t count, int64_t now_ms) {
   if (!IsInitialized())
     oldest_time_ = now_ms;
 
-  uint32_t now_offset = static_cast<uint32_t>(now_ms - oldest_time_);
+  uint32_t now_offset = rtc::dchecked_cast<uint32_t>(now_ms - oldest_time_);
   RTC_DCHECK_LT(now_offset, max_window_size_ms_);
   uint32_t index = oldest_index_ + now_offset;
   if (index >= max_window_size_ms_)
     index -= max_window_size_ms_;
   buckets_[index].sum += count;
   ++buckets_[index].samples;
+  if (std::numeric_limits<int64_t>::max() - accumulated_count_ > count) {
     accumulated_count_ += count;
+  } else {
+    overflow_ = true;
+  }
   ++num_samples_;
 }
 
-absl::optional<uint32_t> RateStatistics::Rate(int64_t now_ms) const {
+absl::optional<int64_t> RateStatistics::Rate(int64_t now_ms) const {
   // Yeah, this const_cast ain't pretty, but the alternative is to declare most
   // of the members as mutable...
   const_cast<RateStatistics*>(this)->EraseOld(now_ms);
 
   // If window is a single bucket or there is only one sample in a data set that
-  // has not grown to the full window size, treat this as rate unavailable.
-  int64_t active_window_size = now_ms - oldest_time_ + 1;
+  // has not grown to the full window size, or if the accumulator has
+  // overflowed, treat this as rate unavailable.
+  int active_window_size = now_ms - oldest_time_ + 1;
   if (num_samples_ == 0 || active_window_size <= 1 ||
-      (num_samples_ <= 1 && active_window_size < current_window_size_ms_)) {
+      (num_samples_ <= 1 &&
+       rtc::SafeLt(active_window_size, current_window_size_ms_)) ||
+      overflow_) {
     return absl::nullopt;
   }
 
-  float scale = scale_ / active_window_size;
+  float scale = static_cast<float>(scale_) / active_window_size;
   float result = accumulated_count_ * scale + 0.5f;
 
   // Better return unavailable rate than garbage value (undefined behavior).
-  if (result > std::numeric_limits<uint32_t>::max()) {
+  if (result > static_cast<float>(std::numeric_limits<int64_t>::max())) {
     return absl::nullopt;
   }
-  return static_cast<uint32_t>(result);
+  return rtc::dchecked_cast<int64_t>(result);
 }
 
 void RateStatistics::EraseOld(int64_t now_ms) {
@@ -123,6 +135,8 @@ void RateStatistics::EraseOld(int64_t now_ms) {
     if (++oldest_index_ >= max_window_size_ms_)
       oldest_index_ = 0;
     ++oldest_time_;
+    // This does not clear overflow_ even when counter is empty.
+    // TODO(https://bugs.webrtc.org/11247): Consider if overflow_ can be reset.
   }
   oldest_time_ = new_oldest_time;
 }
@@ -130,7 +144,6 @@ void RateStatistics::EraseOld(int64_t now_ms) {
 bool RateStatistics::SetWindowSize(int64_t window_size_ms, int64_t now_ms) {
   if (window_size_ms <= 0 || window_size_ms > max_window_size_ms_)
     return false;
-
   current_window_size_ms_ = window_size_ms;
   EraseOld(now_ms);
   return true;

rtc_base/rate_statistics.h

@@ -21,6 +21,13 @@
 
 namespace webrtc {
 
+// Class to estimate rates based on counts in a sequence of 1-millisecond
+// intervals.
+
+// This class uses int64 for all its numbers because some rates can be very
+// high; for instance, a 20 Mbit/sec video stream can wrap a 32-bit byte
+// counter in 14 minutes.
+
 class RTC_EXPORT RateStatistics {
  public:
   static constexpr float kBpsScale = 8000.0f;
@@ -42,7 +49,7 @@ class RTC_EXPORT RateStatistics {
   void Reset();
 
   // Update rate with a new data point, moving averaging window as needed.
-  void Update(size_t count, int64_t now_ms);
+  void Update(int64_t count, int64_t now_ms);
 
   // Note that despite this being a const method, it still updates the internal
   // state (moves averaging window), but it doesn't make any alterations that
@@ -50,7 +57,7 @@ class RTC_EXPORT RateStatistics {
   // from a monotonic clock. Ie, it doesn't matter if this call moves the
   // window, since any subsequent call to Update or Rate would still have moved
   // the window as much or more.
-  absl::optional<uint32_t> Rate(int64_t now_ms) const;
+  absl::optional<int64_t> Rate(int64_t now_ms) const;
 
   // Update the size of the averaging window. The maximum allowed value for
   // window_size_ms is max_window_size_ms as supplied in the constructor.
@@ -63,22 +70,26 @@ class RTC_EXPORT RateStatistics {
   // Counters are kept in buckets (circular buffer), with one bucket
   // per millisecond.
   struct Bucket {
-    size_t sum;      // Sum of all samples in this bucket.
-    size_t samples;  // Number of samples in this bucket.
+    int64_t sum;  // Sum of all samples in this bucket.
+    int samples;  // Number of samples in this bucket.
   };
   std::unique_ptr<Bucket[]> buckets_;
 
   // Total count recorded in buckets.
-  size_t accumulated_count_;
+  int64_t accumulated_count_;
+
+  // True if accumulated_count_ has ever grown too large to be
+  // contained in its integer type.
+  bool overflow_ = false;
 
   // The total number of samples in the buckets.
-  size_t num_samples_;
+  int num_samples_;
 
   // Oldest time recorded in buckets.
   int64_t oldest_time_;
 
   // Bucket index of oldest counter recorded in buckets.
-  uint32_t oldest_index_;
+  int64_t oldest_index_;
 
   // To convert counts/ms to desired units
   const float scale_;

rtc_base/rate_statistics_unittest.cc

@@ -278,4 +278,33 @@ TEST_F(RateStatisticsTest, HandlesQuietPeriods) {
   EXPECT_TRUE(static_cast<bool>(bitrate));
   EXPECT_EQ(0u, *bitrate);
 }
+
+TEST_F(RateStatisticsTest, HandlesBigNumbers) {
+  int64_t large_number = 0x100000000u;
+  int64_t now_ms = 0;
+  stats_.Update(large_number, now_ms++);
+  stats_.Update(large_number, now_ms);
+  EXPECT_TRUE(stats_.Rate(now_ms));
+  EXPECT_EQ(large_number * RateStatistics::kBpsScale, *stats_.Rate(now_ms));
+}
+
+TEST_F(RateStatisticsTest, HandlesTooLargeNumbers) {
+  int64_t very_large_number = std::numeric_limits<int64_t>::max();
+  int64_t now_ms = 0;
+  stats_.Update(very_large_number, now_ms++);
+  stats_.Update(very_large_number, now_ms);
+  // This should overflow the internal accumulator.
+  EXPECT_FALSE(stats_.Rate(now_ms));
+}
+
+TEST_F(RateStatisticsTest, HandlesSomewhatLargeNumbers) {
+  int64_t very_large_number = std::numeric_limits<int64_t>::max();
+  int64_t now_ms = 0;
+  stats_.Update(very_large_number / 4, now_ms++);
+  stats_.Update(very_large_number / 4, now_ms);
+  // This should generate a rate of more than int64_t max, but still
+  // accumulate less than int64_t overflow.
+  EXPECT_FALSE(stats_.Rate(now_ms));
+}
+
 }  // namespace

rtc_base/rate_tracker.cc

@@ -22,7 +22,7 @@ static const int64_t kTimeUnset = -1;
 RateTracker::RateTracker(int64_t bucket_milliseconds, size_t bucket_count)
     : bucket_milliseconds_(bucket_milliseconds),
       bucket_count_(bucket_count),
-      sample_buckets_(new size_t[bucket_count + 1]),
+      sample_buckets_(new int64_t[bucket_count + 1]),
       total_sample_count_(0u),
       bucket_start_time_milliseconds_(kTimeUnset) {
   RTC_CHECK(bucket_milliseconds > 0);
@@ -76,7 +76,7 @@ double RateTracker::ComputeRateForInterval(
   size_t start_bucket = NextBucketIndex(current_bucket_ + buckets_to_skip);
   // Only count a portion of the first bucket according to how much of the
   // first bucket is within the current interval.
-  size_t total_samples = ((sample_buckets_[start_bucket] *
+  int64_t total_samples = ((sample_buckets_[start_bucket] *
                             (bucket_milliseconds_ - milliseconds_to_skip)) +
                            (bucket_milliseconds_ >> 1)) /
                           bucket_milliseconds_;
@@ -103,11 +103,12 @@ double RateTracker::ComputeTotalRate() const {
              TimeDiff(current_time, initialization_time_milliseconds_));
 }
 
-size_t RateTracker::TotalSampleCount() const {
+int64_t RateTracker::TotalSampleCount() const {
   return total_sample_count_;
 }
 
-void RateTracker::AddSamples(size_t sample_count) {
+void RateTracker::AddSamples(int64_t sample_count) {
+  RTC_DCHECK_LE(0, sample_count);
   EnsureInitialized();
   int64_t current_time = Time();
   // Advance the current bucket as needed for the current time, and reset

rtc_base/rate_tracker.h

@@ -41,11 +41,11 @@ class RateTracker {
   double ComputeTotalRate() const;
 
   // The total number of samples added.
-  size_t TotalSampleCount() const;
+  int64_t TotalSampleCount() const;
 
   // Reads the current time in order to determine the appropriate bucket for
   // these samples, and increments the count for that bucket by sample_count.
-  void AddSamples(size_t sample_count);
+  void AddSamples(int64_t sample_count);
 
  protected:
   // overrideable for tests
@@ -57,7 +57,7 @@ class RateTracker {
 
   const int64_t bucket_milliseconds_;
   const size_t bucket_count_;
-  size_t* sample_buckets_;
+  int64_t* sample_buckets_;
   size_t total_sample_count_;
   size_t current_bucket_;
   int64_t bucket_start_time_milliseconds_;

rtc_base/rate_tracker_unittest.cc

@@ -166,4 +166,13 @@ TEST(RateTrackerTest, TestGetUnitSecondsAfterInitialValue) {
   EXPECT_DOUBLE_EQ(1234.0, tracker.ComputeRateForInterval(1000));
 }
 
+TEST(RateTrackerTest, TestLargeNumbers) {
+  RateTrackerForTest tracker;
+  const uint64_t large_number = 0x100000000;
+  tracker.AddSamples(large_number);
+  tracker.AdvanceTime(1000);
+  tracker.AddSamples(large_number);
+  EXPECT_DOUBLE_EQ(large_number * 2, tracker.ComputeRate());
+}
+
 }  // namespace rtc