folly/stats/Histogram.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <cstddef>
  20 #include <cstdint>
  21 #include <limits>
  22 #include <ostream>
  23 #include <stdexcept>
  24 #include <string>
  25 #include <vector>
  26
  27 #include <folly/CPortability.h>
  28 #include <folly/stats/detail/Bucket.h>
  29
  30 namespace folly {
  31
  32 namespace detail {
  33
  34 /*
  35  * A helper class to manage a set of histogram buckets.
  36  */
  37 template <typename T, typename BucketT>
  38 class HistogramBuckets {
  39  public:
  40   typedef T ValueType;
  41   typedef BucketT BucketType;
  42
  43   /*
  44    * Create a set of histogram buckets.
  45    *
  46    * One bucket will be created for each bucketSize interval of values within
  47    * the specified range.  Additionally, one bucket will be created to track
  48    * all values that fall below the specified minimum, and one bucket will be
  49    * created for all values above the specified maximum.
  50    *
  51    * If (max - min) is not a multiple of bucketSize, the last bucket will cover
  52    * a smaller range of values than the other buckets.
  53    *
  54    * (max - min) must be larger than or equal to bucketSize.
  55    */
  56   HistogramBuckets(ValueType bucketSize, ValueType min, ValueType max,
  57                    const BucketType& defaultBucket);
  58
  59   /* Returns the bucket size of each bucket in the histogram. */
  60   ValueType getBucketSize() const {
  61     return bucketSize_;
  62   }
  63
  64   /* Returns the min value at which bucketing begins. */
  65   ValueType getMin() const {
  66     return min_;
  67   }
  68
  69   /* Returns the max value at which bucketing ends. */
  70   ValueType getMax() const {
  71     return max_;
  72   }
  73
  74   /*
  75    * Returns the number of buckets.
  76    *
  77    * This includes the total number of buckets for the [min, max) range,
  78    * plus 2 extra buckets, one for handling values less than min, and one for
  79    * values greater than max.
  80    */
  81   size_t getNumBuckets() const {
  82     return buckets_.size();
  83   }
  84
  85   /* Returns the bucket index into which the given value would fall. */
  86   size_t getBucketIdx(ValueType value) const;
  87
  88   /* Returns the bucket for the specified value */
  89   BucketType& getByValue(ValueType value) {
  90     return buckets_[getBucketIdx(value)];
  91   }
  92
  93   /* Returns the bucket for the specified value */
  94   const BucketType& getByValue(ValueType value) const {
  95     return buckets_[getBucketIdx(value)];
  96   }
  97
  98   /*
  99    * Returns the bucket at the specified index.
 100    *
 101    * Note that index 0 is the bucket for all values less than the specified
 102    * minimum.  Index 1 is the first bucket in the specified bucket range.
 103    */
 104   BucketType& getByIndex(size_t idx) {
 105     return buckets_[idx];
 106   }
 107
 108   /* Returns the bucket at the specified index. */
 109   const BucketType& getByIndex(size_t idx) const {
 110     return buckets_[idx];
 111   }
 112
 113   /*
 114    * Returns the minimum threshold for the bucket at the given index.
 115    *
 116    * The bucket at the specified index will store values in the range
 117    * [bucketMin, bucketMin + bucketSize), or [bucketMin, max), if the overall
 118    * max is smaller than bucketMin + bucketSize.
 119    */
 120   ValueType getBucketMin(size_t idx) const {
 121     if (idx == 0) {
 122       return std::numeric_limits<ValueType>::min();
 123     }
 124     if (idx == buckets_.size() - 1) {
 125       return max_;
 126     }
 127
 128     return ValueType(min_ + ((idx - 1) * bucketSize_));
 129   }
 130
 131   /*
 132    * Returns the maximum threshold for the bucket at the given index.
 133    *
 134    * The bucket at the specified index will store values in the range
 135    * [bucketMin, bucketMin + bucketSize), or [bucketMin, max), if the overall
 136    * max is smaller than bucketMin + bucketSize.
 137    */
 138   ValueType getBucketMax(size_t idx) const {
 139     if (idx == buckets_.size() - 1) {
 140       return std::numeric_limits<ValueType>::max();
 141     }
 142
 143     return ValueType(min_ + (idx * bucketSize_));
 144   }
 145
 146   /**
 147    * Computes the total number of values stored across all buckets.
 148    *
 149    * Runs in O(numBuckets)
 150    *
 151    * @param countFn A function that takes a const BucketType&, and returns the
 152    *                number of values in that bucket
 153    * @return Returns the total number of values stored across all buckets
 154    */
 155   template <typename CountFn>
 156   uint64_t computeTotalCount(CountFn countFromBucket) const;
 157
 158   /**
 159    * Determine which bucket the specified percentile falls into.
 160    *
 161    * Looks for the bucket that contains the Nth percentile data point.
 162    *
 163    * @param pct     The desired percentile to find, as a value from 0.0 to 1.0.
 164    * @param countFn A function that takes a const BucketType&, and returns the
 165    *                number of values in that bucket.
 166    * @param lowPct  The lowest percentile stored in the selected bucket will be
 167    *                returned via this parameter.
 168    * @param highPct The highest percentile stored in the selected bucket will
 169    *                be returned via this parameter.
 170    *
 171    * @return Returns the index of the bucket that contains the Nth percentile
 172    *         data point.
 173    */
 174   template <typename CountFn>
 175   size_t getPercentileBucketIdx(
 176       double pct,
 177       CountFn countFromBucket,
 178       double* lowPct = nullptr,
 179       double* highPct = nullptr) const;
 180
 181   /**
 182    * Estimate the value at the specified percentile.
 183    *
 184    * @param pct     The desired percentile to find, as a value from 0.0 to 1.0.
 185    * @param countFn A function that takes a const BucketType&, and returns the
 186    *                number of values in that bucket.
 187    * @param avgFn   A function that takes a const BucketType&, and returns the
 188    *                average of all the values in that bucket.
 189    *
 190    * @return Returns an estimate for N, where N is the number where exactly pct
 191    *         percentage of the data points in the histogram are less than N.
 192    */
 193   template <typename CountFn, typename AvgFn>
 194   ValueType getPercentileEstimate(double pct,
 195                                   CountFn countFromBucket,
 196                                   AvgFn avgFromBucket) const;
 197
 198   /*
 199    * Iterator access to the buckets.
 200    *
 201    * Note that the first bucket is for all values less than min, and the last
 202    * bucket is for all values greater than max.  The buckets tracking values in
 203    * the [min, max) actually start at the second bucket.
 204    */
 205   typename std::vector<BucketType>::const_iterator begin() const {
 206     return buckets_.begin();
 207   }
 208   typename std::vector<BucketType>::iterator begin() {
 209     return buckets_.begin();
 210   }
 211   typename std::vector<BucketType>::const_iterator end() const {
 212     return buckets_.end();
 213   }
 214   typename std::vector<BucketType>::iterator end() {
 215     return buckets_.end();
 216   }
 217
 218  private:
 219   ValueType bucketSize_;
 220   ValueType min_;
 221   ValueType max_;
 222   std::vector<BucketType> buckets_;
 223 };
 224
 225 } // detail
 226
 227
 228 /*
 229  * A basic histogram class.
 230  *
 231  * Groups data points into equally-sized buckets, and stores the overall sum of
 232  * the data points in each bucket, as well as the number of data points in the
 233  * bucket.
 234  *
 235  * The caller must specify the minimum and maximum data points to expect ahead
 236  * of time, as well as the bucket width.
 237  */
 238 template <typename T>
 239 class Histogram {
 240  public:
 241   typedef T ValueType;
 242   typedef detail::Bucket<T> Bucket;
 243
 244   Histogram(ValueType bucketSize, ValueType min, ValueType max)
 245     : buckets_(bucketSize, min, max, Bucket()) {}
 246
 247   /* Add a data point to the histogram */
 248   void addValue(ValueType value) FOLLY_DISABLE_UNDEFINED_BEHAVIOR_SANITIZER(
 249       "signed-integer-overflow",
 250       "unsigned-integer-overflow") {
 251     Bucket& bucket = buckets_.getByValue(value);
 252     // NOTE: Overflow is handled elsewhere and tests check this
 253     // behavior (see HistogramTest.cpp TestOverflow* tests).
 254     // TODO: It would be nice to handle overflow here and redesign this class.
 255     bucket.sum += value;
 256     bucket.count += 1;
 257   }
 258
 259   /* Add multiple same data points to the histogram */
 260   void addRepeatedValue(ValueType value, uint64_t nSamples)
 261       FOLLY_DISABLE_UNDEFINED_BEHAVIOR_SANITIZER(
 262           "signed-integer-overflow",
 263           "unsigned-integer-overflow") {
 264     Bucket& bucket = buckets_.getByValue(value);
 265     // NOTE: Overflow is handled elsewhere and tests check this
 266     // behavior (see HistogramTest.cpp TestOverflow* tests).
 267     // TODO: It would be nice to handle overflow here and redesign this class.
 268     bucket.sum += value * nSamples;
 269     bucket.count += nSamples;
 270   }
 271
 272   /*
 273    * Remove a data point to the histogram
 274    *
 275    * Note that this method does not actually verify that this exact data point
 276    * had previously been added to the histogram; it merely subtracts the
 277    * requested value from the appropriate bucket's sum.
 278    */
 279   void removeValue(ValueType value) FOLLY_DISABLE_UNDEFINED_BEHAVIOR_SANITIZER(
 280       "signed-integer-overflow",
 281       "unsigned-integer-overflow") {
 282     Bucket& bucket = buckets_.getByValue(value);
 283     // NOTE: Overflow is handled elsewhere and tests check this
 284     // behavior (see HistogramTest.cpp TestOverflow* tests).
 285     // TODO: It would be nice to handle overflow here and redesign this class.
 286     if (bucket.count > 0) {
 287       bucket.sum -= value;
 288       bucket.count -= 1;
 289     } else {
 290       bucket.sum = ValueType();
 291       bucket.count = 0;
 292     }
 293   }
 294
 295   /* Remove multiple same data points from the histogram */
 296   void removeRepeatedValue(ValueType value, uint64_t nSamples) {
 297     Bucket& bucket = buckets_.getByValue(value);
 298     // TODO: It would be nice to handle overflow here.
 299     if (bucket.count >= nSamples) {
 300       bucket.sum -= value * nSamples;
 301       bucket.count -= nSamples;
 302     } else {
 303       bucket.sum = ValueType();
 304       bucket.count = 0;
 305     }
 306   }
 307
 308   /* Remove all data points from the histogram */
 309   void clear() {
 310     for (size_t i = 0; i < buckets_.getNumBuckets(); i++) {
 311       buckets_.getByIndex(i).clear();
 312     }
 313   }
 314
 315   /* Subtract another histogram data from the histogram */
 316   void subtract(const Histogram &hist) {
 317     // the two histogram bucket definitions must match to support
 318     // subtract.
 319     if (getBucketSize() != hist.getBucketSize() ||
 320         getMin() != hist.getMin() ||
 321         getMax() != hist.getMax() ||
 322         getNumBuckets() != hist.getNumBuckets() ) {
 323       throw std::invalid_argument("Cannot subtract input histogram.");
 324     }
 325
 326     for (size_t i = 0; i < buckets_.getNumBuckets(); i++) {
 327       buckets_.getByIndex(i) -= hist.buckets_.getByIndex(i);
 328     }
 329   }
 330
 331   /* Merge two histogram data together */
 332   void merge(const Histogram &hist) {
 333     // the two histogram bucket definitions must match to support
 334     // a merge.
 335     if (getBucketSize() != hist.getBucketSize() ||
 336         getMin() != hist.getMin() ||
 337         getMax() != hist.getMax() ||
 338         getNumBuckets() != hist.getNumBuckets() ) {
 339       throw std::invalid_argument("Cannot merge from input histogram.");
 340     }
 341
 342     for (size_t i = 0; i < buckets_.getNumBuckets(); i++) {
 343       buckets_.getByIndex(i) += hist.buckets_.getByIndex(i);
 344     }
 345   }
 346
 347   /* Copy bucket values from another histogram */
 348   void copy(const Histogram &hist) {
 349     // the two histogram bucket definition must match
 350     if (getBucketSize() != hist.getBucketSize() ||
 351         getMin() != hist.getMin() ||
 352         getMax() != hist.getMax() ||
 353         getNumBuckets() != hist.getNumBuckets() ) {
 354       throw std::invalid_argument("Cannot copy from input histogram.");
 355     }
 356
 357     for (size_t i = 0; i < buckets_.getNumBuckets(); i++) {
 358       buckets_.getByIndex(i) = hist.buckets_.getByIndex(i);
 359     }
 360   }
 361
 362   /* Returns the bucket size of each bucket in the histogram. */
 363   ValueType getBucketSize() const {
 364     return buckets_.getBucketSize();
 365   }
 366   /* Returns the min value at which bucketing begins. */
 367   ValueType getMin() const {
 368     return buckets_.getMin();
 369   }
 370   /* Returns the max value at which bucketing ends. */
 371   ValueType getMax() const {
 372     return buckets_.getMax();
 373   }
 374   /* Returns the number of buckets */
 375   size_t getNumBuckets() const {
 376     return buckets_.getNumBuckets();
 377   }
 378
 379   /* Returns the specified bucket (for reading only!) */
 380   const Bucket& getBucketByIndex(size_t idx) const {
 381     return buckets_.getByIndex(idx);
 382   }
 383
 384   /*
 385    * Returns the minimum threshold for the bucket at the given index.
 386    *
 387    * The bucket at the specified index will store values in the range
 388    * [bucketMin, bucketMin + bucketSize), or [bucketMin, max), if the overall
 389    * max is smaller than bucketMin + bucketSize.
 390    */
 391   ValueType getBucketMin(size_t idx) const {
 392     return buckets_.getBucketMin(idx);
 393   }
 394
 395   /*
 396    * Returns the maximum threshold for the bucket at the given index.
 397    *
 398    * The bucket at the specified index will store values in the range
 399    * [bucketMin, bucketMin + bucketSize), or [bucketMin, max), if the overall
 400    * max is smaller than bucketMin + bucketSize.
 401    */
 402   ValueType getBucketMax(size_t idx) const {
 403     return buckets_.getBucketMax(idx);
 404   }
 405
 406   /**
 407    * Computes the total number of values stored across all buckets.
 408    *
 409    * Runs in O(numBuckets)
 410    */
 411   uint64_t computeTotalCount() const {
 412     CountFromBucket countFn;
 413     return buckets_.computeTotalCount(countFn);
 414   }
 415
 416   /*
 417    * Get the bucket that the specified percentile falls into
 418    *
 419    * The lowest and highest percentile data points in returned bucket will be
 420    * returned in the lowPct and highPct arguments, if they are not nullptr.
 421    */
 422   size_t getPercentileBucketIdx(
 423       double pct,
 424       double* lowPct = nullptr,
 425       double* highPct = nullptr) const {
 426     // We unfortunately can't use lambdas here yet;
 427     // Some users of this code are still built with gcc-4.4.
 428     CountFromBucket countFn;
 429     return buckets_.getPercentileBucketIdx(pct, countFn, lowPct, highPct);
 430   }
 431
 432   /**
 433    * Estimate the value at the specified percentile.
 434    *
 435    * @param pct     The desired percentile to find, as a value from 0.0 to 1.0.
 436    *
 437    * @return Returns an estimate for N, where N is the number where exactly pct
 438    *         percentage of the data points in the histogram are less than N.
 439    */
 440   ValueType getPercentileEstimate(double pct) const {
 441     CountFromBucket countFn;
 442     AvgFromBucket avgFn;
 443     return buckets_.getPercentileEstimate(pct, countFn, avgFn);
 444   }
 445
 446   /*
 447    * Get a human-readable string describing the histogram contents
 448    */
 449   std::string debugString() const;
 450
 451   /*
 452    * Write the histogram contents in tab-separated values (TSV) format.
 453    * Format is "min max count sum".
 454    */
 455   void toTSV(std::ostream& out, bool skipEmptyBuckets = true) const;
 456
 457   struct CountFromBucket {
 458     uint64_t operator()(const Bucket& bucket) const {
 459       return bucket.count;
 460     }
 461   };
 462   struct AvgFromBucket {
 463     ValueType operator()(const Bucket& bucket) const {
 464       if (bucket.count == 0) {
 465         return ValueType(0);
 466       }
 467       // Cast bucket.count to a signed integer type.  This ensures that we
 468       // perform division properly here: If bucket.sum is a signed integer
 469       // type but we divide by an unsigned number, unsigned division will be
 470       // performed and bucket.sum will be converted to unsigned first.
 471       // If bucket.sum is unsigned, the code will still do unsigned division
 472       // correctly.
 473       //
 474       // The only downside is if bucket.count is large enough to be negative
 475       // when treated as signed.  That should be extremely unlikely, though.
 476       return bucket.sum / static_cast<int64_t>(bucket.count);
 477     }
 478   };
 479
 480  private:
 481   detail::HistogramBuckets<ValueType, Bucket> buckets_;
 482 };
 483
 484 } // folly