histogram.h revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Histogram is an object that aggregates statistics, and can summarize them in 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// various forms, including ASCII graphical, HTML, and numerically (as a 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// vector of numbers corresponding to each of the aggregating buckets). 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// It supports calls to accumulate either time intervals (which are processed 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// as integral number of milliseconds), or arbitrary integral units. 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// For Histogram(exponential histogram), LinearHistogram and CustomHistogram, 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the minimum for a declared range is 1 (instead of 0), while the maximum is 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (HistogramBase::kSampleType_MAX - 1). Currently you can declare histograms 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// with ranges exceeding those limits (e.g. 0 as minimal or 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// HistogramBase::kSampleType_MAX as maximal), but those excesses will be 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// silently clamped to those limits (for backwards compatibility with existing 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// code). Best practice is to not exceed the limits. 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Each use of a histogram with the same name will reference the same underlying 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// data, so it is safe to record to the same histogram from multiple locations 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the code. It is a runtime error if all uses of the same histogram do not 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// agree exactly in type, bucket size and range. 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// For Histogram and LinearHistogram, the maximum for a declared range should 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// always be larger (not equal) than minmal range. Zero and 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// HistogramBase::kSampleType_MAX are implicitly added as first and last ranges, 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// so the smallest legal bucket_count is 3. However CustomHistogram can have 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// bucket count as 2 (when you give a custom ranges vector containing only 1 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// range). 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// For these 3 kinds of histograms, the max bucket count is always 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (Histogram::kBucketCount_MAX - 1). 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The buckets layout of class Histogram is exponential. For example, buckets 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// might contain (sequentially) the count of values in the following intervals: 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// [0,1), [1,2), [2,4), [4,8), [8,16), [16,32), [32,64), [64,infinity) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// That bucket allocation would actually result from construction of a histogram 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// for values between 1 and 64, with 8 buckets, such as: 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Histogram count("some name", 1, 64, 8); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Note that the underflow bucket [0,1) and the overflow bucket [64,infinity) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// are also counted by the constructor in the user supplied "bucket_count" 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// argument. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The above example has an exponential ratio of 2 (doubling the bucket width 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in each consecutive bucket. The Histogram class automatically calculates 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the smallest ratio that it can use to construct the number of buckets 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// selected in the constructor. An another example, if you had 50 buckets, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and millisecond time values from 1 to 10000, then the ratio between 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// consecutive bucket widths will be approximately somewhere around the 50th 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// root of 10000. This approach provides very fine grain (narrow) buckets 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// at the low end of the histogram scale, but allows the histogram to cover a 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// gigantic range with the addition of very few buckets. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Usually we use macros to define and use a histogram. These macros use a 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// pattern involving a function static variable, that is a pointer to a 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// histogram. This static is explicitly initialized on any thread 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// that detects a uninitialized (NULL) pointer. The potentially racy 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// initialization is not a problem as it is always set to point to the same 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// value (i.e., the FactoryGet always returns the same value). FactoryGet 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// is also completely thread safe, which results in a completely thread safe, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and relatively fast, set of counters. To avoid races at shutdown, the static 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// pointer is NOT deleted, and we leak the histograms at process termination. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_METRICS_HISTOGRAM_H_ 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_METRICS_HISTOGRAM_H_ 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/atomicops.h" 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/base_export.h" 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/gtest_prod_util.h" 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/metrics/bucket_ranges.h" 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/metrics/histogram_base.h" 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/metrics/histogram_samples.h" 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/time.h" 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Pickle; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PickleIterator; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Lock; 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Histograms are often put in areas where they are called many many times, and 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// performance is critical. As a result, they are designed to have a very low 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// recurring cost of executing (adding additional samples). Toward that end, 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the macros declare a static pointer to the histogram in question, and only 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// take a "slow path" to construct (or find) the histogram on the first run 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// through the macro. We leak the histograms at shutdown time so that we don't 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// have to validate using the pointers at any time during the running of the 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// process. 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The following code is generally what a thread-safe static pointer 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// initializaion looks like for a histogram (after a macro is expanded). This 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// sample is an expansion (with comments) of the code for 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// HISTOGRAM_CUSTOM_COUNTS(). 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do { 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The pointer's presence indicates the initialization is complete. 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initialization is idempotent, so it can safely be atomically repeated. 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static base::subtle::AtomicWord atomic_histogram_pointer = 0; 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Acquire_Load() ensures that we acquire visibility to the pointed-to data 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in the histogrom. 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram* histogram_pointer(reinterpret_cast<base::Histogram*>( 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::subtle::Acquire_Load(&atomic_histogram_pointer))); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!histogram_pointer) { 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This is the slow path, which will construct OR find the matching 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // histogram. FactoryGet includes locks on a global histogram name map 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and is completely thread safe. 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) histogram_pointer = base::Histogram::FactoryGet( 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, min, max, bucket_count, base::HistogramBase::kNoFlags); 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Use Release_Store to ensure that the histogram data is made available 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // globally before we make the pointer visible. 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Several threads may perform this store, but the same value will be 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // stored in all cases (for a given named/spec'ed histogram). 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We could do this without any barrier, since FactoryGet entered and 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // exited a lock after construction, but this barrier makes things clear. 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::subtle::Release_Store(&atomic_histogram_pointer, 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reinterpret_cast<base::subtle::AtomicWord>(histogram_pointer)); 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Ensure calling contract is upheld, and the name does NOT vary. 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(histogram_pointer->histogram_name() == constant_histogram_name); 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) histogram_pointer->Add(sample); 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } while (0); 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)*/ 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The above pattern is repeated in several macros. The only elements that 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// vary are the invocation of the Add(sample) vs AddTime(sample), and the choice 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// of which FactoryGet method to use. The different FactoryGet methods have 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// various argument lists, so the function with its argument list is provided as 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// a macro argument here. The name is only used in a DCHECK, to assure that 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// callers don't try to vary the name of the histogram (which would tend to be 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ignored by the one-time initialization of the histogtram_pointer). 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define STATIC_HISTOGRAM_POINTER_BLOCK(constant_histogram_name, \ 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) histogram_add_method_invocation, \ 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) histogram_factory_get_invocation) \ 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) do { \ 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static base::subtle::AtomicWord atomic_histogram_pointer = 0; \ 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram* histogram_pointer(reinterpret_cast<base::Histogram*>( \ 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::subtle::Acquire_Load(&atomic_histogram_pointer))); \ 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!histogram_pointer) { \ 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) histogram_pointer = histogram_factory_get_invocation; \ 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::subtle::Release_Store(&atomic_histogram_pointer, \ 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) reinterpret_cast<base::subtle::AtomicWord>(histogram_pointer)); \ 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } \ 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK_EQ(histogram_pointer->histogram_name(), \ 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string(constant_histogram_name)); \ 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) histogram_pointer->histogram_add_method_invocation; \ 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } while (0) 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Provide easy general purpose histogram in a macro, just like stats counters. 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The first four macros use 50 buckets. 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_TIMES(name, sample) HISTOGRAM_CUSTOM_TIMES( \ 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, base::TimeDelta::FromMilliseconds(1), \ 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta::FromSeconds(10), 50) 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_COUNTS(name, sample) HISTOGRAM_CUSTOM_COUNTS( \ 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, 1, 1000000, 50) 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_COUNTS_100(name, sample) HISTOGRAM_CUSTOM_COUNTS( \ 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, 1, 100, 50) 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_COUNTS_10000(name, sample) HISTOGRAM_CUSTOM_COUNTS( \ 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, 1, 10000, 50) 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_CUSTOM_COUNTS(name, sample, min, max, bucket_count) \ 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, Add(sample), \ 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram::FactoryGet(name, min, max, bucket_count, \ 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::HistogramBase::kNoFlags)) 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_PERCENTAGE(name, under_one_hundred) \ 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HISTOGRAM_ENUMERATION(name, under_one_hundred, 101) 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// For folks that need real specific times, use this to select a precise range 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// of times you want plotted, and the number of buckets you want used. 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_CUSTOM_TIMES(name, sample, min, max, bucket_count) \ 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, AddTime(sample), \ 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram::FactoryTimeGet(name, min, max, bucket_count, \ 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::HistogramBase::kNoFlags)) 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Support histograming of an enumerated value. The samples should always be 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// strictly less than |boundary_value| -- this prevents you from running into 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// problems down the line if you add additional buckets to the histogram. Note 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// also that, despite explicitly setting the minimum bucket value to |1| below, 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// it is fine for enumerated histograms to be 0-indexed -- this is because 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// enumerated histograms should never have underflow. 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_ENUMERATION(name, sample, boundary_value) \ 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, Add(sample), \ 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::LinearHistogram::FactoryGet(name, 1, boundary_value, \ 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) boundary_value + 1, base::HistogramBase::kNoFlags)) 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Support histograming of an enumerated value. Samples should be one of the 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// std::vector<int> list provided via |custom_ranges|. See comments above 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// CustomRanges::FactoryGet about the requirement of |custom_ranges|. 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// You can use the helper function CustomHistogram::ArrayToCustomRanges to 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// transform a C-style array of valid sample values to a std::vector<int>. 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HISTOGRAM_CUSTOM_ENUMERATION(name, sample, custom_ranges) \ 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, Add(sample), \ 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::CustomHistogram::FactoryGet(name, custom_ranges, \ 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::HistogramBase::kNoFlags)) 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Define Debug vs non-debug flavors of macros. 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NDEBUG 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_TIMES(name, sample) HISTOGRAM_TIMES(name, sample) 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_COUNTS(name, sample) HISTOGRAM_COUNTS(name, sample) 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_PERCENTAGE(name, under_one_hundred) HISTOGRAM_PERCENTAGE(\ 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, under_one_hundred) 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_CUSTOM_TIMES(name, sample, min, max, bucket_count) \ 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HISTOGRAM_CUSTOM_TIMES(name, sample, min, max, bucket_count) 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_CLIPPED_TIMES(name, sample, min, max, bucket_count) \ 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HISTOGRAM_CLIPPED_TIMES(name, sample, min, max, bucket_count) 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_CUSTOM_COUNTS(name, sample, min, max, bucket_count) \ 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HISTOGRAM_CUSTOM_COUNTS(name, sample, min, max, bucket_count) 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_ENUMERATION(name, sample, boundary_value) \ 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HISTOGRAM_ENUMERATION(name, sample, boundary_value) 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_CUSTOM_ENUMERATION(name, sample, custom_ranges) \ 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HISTOGRAM_CUSTOM_ENUMERATION(name, sample, custom_ranges) 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else // NDEBUG 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Keep a mention of passed variables to avoid unused variable warnings in 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// release build if these variables are only used in macros. 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DISCARD_2_ARGUMENTS(a, b) \ 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) while (0) { \ 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(a); \ 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(b); \ 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DISCARD_3_ARGUMENTS(a, b, c) \ 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) while (0) { \ 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(a); \ 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(b); \ 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(c); \ 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DISCARD_5_ARGUMENTS(a, b, c, d ,e) \ 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) while (0) { \ 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(a); \ 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(b); \ 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(c); \ 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(d); \ 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<void>(e); \ 2565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_TIMES(name, sample) \ 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISCARD_2_ARGUMENTS(name, sample) 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_COUNTS(name, sample) \ 2615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISCARD_2_ARGUMENTS(name, sample) 2625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_PERCENTAGE(name, under_one_hundred) \ 2645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISCARD_2_ARGUMENTS(name, under_one_hundred) 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_CUSTOM_TIMES(name, sample, min, max, bucket_count) \ 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISCARD_5_ARGUMENTS(name, sample, min, max, bucket_count) 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_CLIPPED_TIMES(name, sample, min, max, bucket_count) \ 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISCARD_5_ARGUMENTS(name, sample, min, max, bucket_count) 2715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_CUSTOM_COUNTS(name, sample, min, max, bucket_count) \ 2735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISCARD_5_ARGUMENTS(name, sample, min, max, bucket_count) 2745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_ENUMERATION(name, sample, boundary_value) \ 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISCARD_3_ARGUMENTS(name, sample, boundary_value) 2775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define DHISTOGRAM_CUSTOM_ENUMERATION(name, sample, custom_ranges) \ 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISCARD_3_ARGUMENTS(name, sample, custom_ranges) 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NDEBUG 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The following macros provide typical usage scenarios for callers that wish 2855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// to record histogram data, and have the data submitted/uploaded via UMA. 2865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Not all systems support such UMA, but if they do, the following macros 2875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// should work with the service. 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_TIMES(name, sample) UMA_HISTOGRAM_CUSTOM_TIMES( \ 2905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, base::TimeDelta::FromMilliseconds(1), \ 2915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta::FromSeconds(10), 50) 2925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_MEDIUM_TIMES(name, sample) UMA_HISTOGRAM_CUSTOM_TIMES( \ 2945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, base::TimeDelta::FromMilliseconds(10), \ 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta::FromMinutes(3), 50) 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use this macro when times can routinely be much longer than 10 seconds. 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_LONG_TIMES(name, sample) UMA_HISTOGRAM_CUSTOM_TIMES( \ 2995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, base::TimeDelta::FromMilliseconds(1), \ 3005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta::FromHours(1), 50) 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_CUSTOM_TIMES(name, sample, min, max, bucket_count) \ 3035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, AddTime(sample), \ 3045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram::FactoryTimeGet(name, min, max, bucket_count, \ 3055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram::kUmaTargetedHistogramFlag)) 3065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_COUNTS(name, sample) UMA_HISTOGRAM_CUSTOM_COUNTS( \ 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, 1, 1000000, 50) 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_COUNTS_100(name, sample) UMA_HISTOGRAM_CUSTOM_COUNTS( \ 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, 1, 100, 50) 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_COUNTS_10000(name, sample) UMA_HISTOGRAM_CUSTOM_COUNTS( \ 3145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, 1, 10000, 50) 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_CUSTOM_COUNTS(name, sample, min, max, bucket_count) \ 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, Add(sample), \ 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram::FactoryGet(name, min, max, bucket_count, \ 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram::kUmaTargetedHistogramFlag)) 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_MEMORY_KB(name, sample) UMA_HISTOGRAM_CUSTOM_COUNTS( \ 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, 1000, 500000, 50) 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_MEMORY_MB(name, sample) UMA_HISTOGRAM_CUSTOM_COUNTS( \ 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name, sample, 1, 1000, 50) 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_PERCENTAGE(name, under_one_hundred) \ 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) UMA_HISTOGRAM_ENUMERATION(name, under_one_hundred, 101) 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_BOOLEAN(name, sample) \ 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, AddBoolean(sample), \ 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::BooleanHistogram::FactoryGet(name, \ 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram::kUmaTargetedHistogramFlag)) 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The samples should always be strictly less than |boundary_value|. For more 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// details, see the comment for the |HISTOGRAM_ENUMERATION| macro, above. 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_ENUMERATION(name, sample, boundary_value) \ 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, Add(sample), \ 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::LinearHistogram::FactoryGet(name, 1, boundary_value, \ 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) boundary_value + 1, base::Histogram::kUmaTargetedHistogramFlag)) 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UMA_HISTOGRAM_CUSTOM_ENUMERATION(name, sample, custom_ranges) \ 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) STATIC_HISTOGRAM_POINTER_BLOCK(name, Add(sample), \ 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::CustomHistogram::FactoryGet(name, custom_ranges, \ 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::Histogram::kUmaTargetedHistogramFlag)) 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BucketRanges; 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SampleVector; 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BooleanHistogram; 3535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CustomHistogram; 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Histogram; 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LinearHistogram; 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BASE_EXPORT Histogram : public HistogramBase { 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initialize maximum number of buckets in histograms as 16,384. 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const size_t kBucketCount_MAX; 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::vector<Count> Counts; 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Inconsistencies { 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NO_INCONSISTENCIES = 0x0, 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RANGE_CHECKSUM_ERROR = 0x1, 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BUCKET_ORDER_ERROR = 0x2, 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) COUNT_HIGH_ERROR = 0x4, 3695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) COUNT_LOW_ERROR = 0x8, 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NEVER_EXCEEDED_VALUE = 0x10 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct DescriptionPair { 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample sample; 3765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* description; // Null means end of a list of pairs. 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //---------------------------------------------------------------------------- 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For a valid histogram, input should follow these restrictions: 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // minimum > 0 (if a minimum below 1 is specified, it will implicitly be 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // normalized up to 1) 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // maximum > minimum 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // buckets > 2 [minimum buckets needed: underflow, overflow and the range] 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Additionally, 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // buckets <= (maximum - minimum + 2) - this is to ensure that we don't have 3875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // more buckets than the range of numbers; having more buckets than 1 per 3885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // value in the range would be nonsensical. 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Histogram* FactoryGet(const std::string& name, 3905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample minimum, 3915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample maximum, 3925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 3935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32 flags); 3945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Histogram* FactoryTimeGet(const std::string& name, 3955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta minimum, 3965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta maximum, 3975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 3985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32 flags); 3995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Time call for use with DHISTOGRAM*. 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns TimeTicks::Now() in debug and TimeTicks() in release build. 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static TimeTicks DebugNow(); 4035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void InitializeBucketRanges(Sample minimum, 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample maximum, 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BucketRanges* ranges); 4085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method is an interface, used only by BooleanHistogram. 4105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void AddBoolean(bool value); 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Accept a TimeDelta to increment. 4135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddTime(TimeDelta time) { 4145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Add(static_cast<int>(time.InMilliseconds())); 4155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 4165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddSamples(const HistogramSamples& samples); 4185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool AddSamplesFromPickle(PickleIterator* iter); 4195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Convenience methods for serializing/deserializing the histograms. 4215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Histograms from Renderer process are serialized and sent to the browser. 4225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Browser process reconstructs the histogram from the pickled version 4235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // accumulates the browser-side shadow copy of histograms (that mirror 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // histograms created in the renderer). 4255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Serialize the given snapshot of a Histogram into a String. Uses 4275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Pickle class to flatten the object. 4285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::string SerializeHistogramInfo(const Histogram& histogram, 4295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const HistogramSamples& snapshot); 4305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The following method accepts a list of pickled histograms and 4325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // builds a histogram and updates shadow copy of histogram data in the 4335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // browser process. 4345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool DeserializeHistogramInfo(const std::string& histogram_info); 4355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This constant if for FindCorruption. Since snapshots of histograms are 4375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // taken asynchronously relative to sampling, and our counting code currently 4385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // does not prevent race conditions, it is pretty likely that we'll catch a 4395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // redundant count that doesn't match the sample count. We allow for a 4405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // certain amount of slop before flagging this as an inconsistency. Even with 4415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // an inconsistency, we'll snapshot it again (for UMA in about a half hour), 4425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // so we'll eventually get the data, if it was not the result of a corruption. 4435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const int kCommonRaceBasedCountMismatch; 4445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Check to see if bucket ranges, counts and tallies in the snapshot are 4465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // consistent with the bucket ranges and checksums in our histogram. This can 4475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // produce a false-alarm if a race occurred in the reading of the data during 4485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a SnapShot process, but should otherwise be false at all times (unless we 4495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // have memory over-writes, or DRAM failures). 4505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual Inconsistencies FindCorruption(const HistogramSamples& samples) const; 4515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //---------------------------------------------------------------------------- 4535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Accessors for factory constuction, serialization and testing. 4545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //---------------------------------------------------------------------------- 4555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample declared_min() const { return declared_min_; } 4565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample declared_max() const { return declared_max_; } 4575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual Sample ranges(size_t i) const; 4585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual size_t bucket_count() const; 4595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BucketRanges* bucket_ranges() const { return bucket_ranges_; } 4605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This function validates histogram construction arguments. It returns false 4625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // if some of the arguments are totally bad. 4635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note. Currently it allow some bad input, e.g. 0 as minimum, but silently 4645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // converts it to good input: 1. 4655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(kaiwang): Be more restrict and return false for any bad input, and 4665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // make this a readonly validating function. 4675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool InspectConstructionArguments(const std::string& name, 4685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample* minimum, 4695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample* maximum, 4705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t* bucket_count); 4715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // HistogramBase implementation: 4735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual HistogramType GetHistogramType() const OVERRIDE; 4745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool HasConstructionArguments(Sample minimum, 4755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample maximum, 4765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count) const OVERRIDE; 4775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Add(Sample value) OVERRIDE; 4785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual scoped_ptr<HistogramSamples> SnapshotSamples() const OVERRIDE; 4795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void WriteHTMLGraph(std::string* output) const OVERRIDE; 4805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void WriteAscii(std::string* output) const OVERRIDE; 4815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 4835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |bucket_count| and |ranges| should contain the underflow and overflow 4845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // buckets. See top comments for example. 4855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Histogram(const std::string& name, 4865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample minimum, 4875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample maximum, 4885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 4895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BucketRanges* ranges); 4905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Histogram(); 4925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Serialize the histogram's ranges to |*pickle|, returning true on success. 4945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Most subclasses can leave this no-op implementation, but some will want to 4955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // override it, especially if the ranges cannot be re-derived from other 4965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // serialized parameters. 4975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool SerializeRanges(Pickle* pickle) const; 4985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Method to override to skip the display of the i'th bucket if it's empty. 5005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool PrintEmptyBucket(size_t index) const; 5015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get normalized size, relative to the ranges(i). 5035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual double GetBucketSize(Count current, size_t i) const; 5045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return a string description of what goes in a given bucket. 5065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Most commonly this is the numeric value, but in derived classes it may 5075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // be a name (or string description) given to the bucket. 5085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual const std::string GetAsciiBucketRange(size_t it) const; 5095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 5115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Allow tests to corrupt our innards for testing purposes. 5125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(HistogramTest, BoundsTest); 5135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(HistogramTest, BucketPlacementTest); 5145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(HistogramTest, CorruptBucketBounds); 5155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(HistogramTest, CorruptSampleCounts); 5165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(HistogramTest, NameMatchTest); 5175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class StatisticsRecorder; // To allow it to delete duplicates. 5195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class StatisticsRecorderTest; 5205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Implementation of SnapshotSamples function. 5225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<SampleVector> SnapshotSampleVector() const; 5235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) //---------------------------------------------------------------------------- 5255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Helpers for emitting Ascii graphic. Each method appends data to output. 5265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteAsciiImpl(bool graph_it, 5285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& newline, 5295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* output) const; 5305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Find out how large (graphically) the largest bucket will appear to be. 5325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) double GetPeakBucketSize(const SampleVector& samples) const; 5335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Write a common header message describing this histogram. 5355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteAsciiHeader(const SampleVector& samples, 5365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Count sample_count, 5375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* output) const; 5385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Write information about previous, current, and next buckets. 5405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Information such as cumulative percentage, etc. 5415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteAsciiBucketContext(const int64 past, const Count current, 5425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const int64 remaining, const size_t i, 5435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* output) const; 5445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Write textual description of the bucket contents (relative to histogram). 5465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Output is the count in the buckets, as well as the percentage. 5475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteAsciiBucketValue(Count current, double scaled_sum, 5485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* output) const; 5495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Produce actual graph (set of blank vs non blank char's) for a bucket. 5515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void WriteAsciiBucketGraph(double current_size, double max_size, 5525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string* output) const; 5535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WriteJSON calls these. 5555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void GetParameters(DictionaryValue* params) const OVERRIDE; 5565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void GetCountAndBucketData(Count* count, 5585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ListValue* buckets) const OVERRIDE; 5595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Does not own this object. Should get from StatisticsRecorder. 5615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BucketRanges* bucket_ranges_; 5625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample declared_min_; // Less than this goes into counts_[0] 5645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample declared_max_; // Over this goes into counts_[bucket_count_ - 1]. 5655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count_; // Dimension of counts_[]. 5665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Finally, provide the state that changes with the addition of each new 5685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // sample. 5695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<SampleVector> samples_; 5705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(Histogram); 5725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 5735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 5755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LinearHistogram is a more traditional histogram, with evenly spaced 5775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// buckets. 5785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BASE_EXPORT LinearHistogram : public Histogram { 5795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 5805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~LinearHistogram(); 5815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* minimum should start from 1. 0 is as minimum is invalid. 0 is an implicit 5835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) default underflow bucket. */ 5845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Histogram* FactoryGet(const std::string& name, 5855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample minimum, 5865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample maximum, 5875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 5885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32 flags); 5895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Histogram* FactoryTimeGet(const std::string& name, 5905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TimeDelta minimum, 5915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TimeDelta maximum, 5925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 5935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32 flags); 5945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Create a LinearHistogram and store a list of number/text values for use in 5965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // writing the histogram graph. 5975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |descriptions| can be NULL, which means no special descriptions to set. If 5985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it's not NULL, the last element in the array must has a NULL in its 5995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "description" field. 6005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Histogram* FactoryGetWithRangeDescription( 6015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& name, 6025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample minimum, 6035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample maximum, 6045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 6055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32 flags, 6065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const DescriptionPair descriptions[]); 6075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void InitializeBucketRanges(Sample minimum, 6095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample maximum, 6105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 6115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BucketRanges* ranges); 6125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from Histogram: 6145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual HistogramType GetHistogramType() const OVERRIDE; 6155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 6175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LinearHistogram(const std::string& name, 6185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample minimum, 6195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Sample maximum, 6205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t bucket_count, 6215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BucketRanges* ranges); 6225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual double GetBucketSize(Count current, size_t i) const OVERRIDE; 6245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If we have a description for a bucket, then return that. Otherwise 6265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // let parent class provide a (numeric) description. 6275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual const std::string GetAsciiBucketRange(size_t i) const OVERRIDE; 6285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Skip printing of name for numeric range if we have a name (and if this is 6305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // an empty bucket). 6315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool PrintEmptyBucket(size_t index) const OVERRIDE; 6325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 6345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For some ranges, we store a printable description of a bucket range. 6355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If there is no desciption, then GetAsciiBucketRange() uses parent class 6365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to provide a description. 6375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<Sample, std::string> BucketDescriptionMap; 6385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BucketDescriptionMap bucket_description_; 6395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(LinearHistogram); 6415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 6425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 6445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// BooleanHistogram is a histogram for booleans. 6465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BASE_EXPORT BooleanHistogram : public LinearHistogram { 6475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 6485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Histogram* FactoryGet(const std::string& name, int32 flags); 6495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual HistogramType GetHistogramType() const OVERRIDE; 6515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void AddBoolean(bool value) OVERRIDE; 6535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 6555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanHistogram(const std::string& name, const BucketRanges* ranges); 6565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(BooleanHistogram); 6585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 6595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 6615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// CustomHistogram is a histogram for a set of custom integers. 6635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BASE_EXPORT CustomHistogram : public Histogram { 6645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 6655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |custom_ranges| contains a vector of limits on ranges. Each limit should be 6665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // > 0 and < kSampleType_MAX. (Currently 0 is still accepted for backward 6675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // compatibility). The limits can be unordered or contain duplication, but 6685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // client should not depend on this. 6695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Histogram* FactoryGet(const std::string& name, 6705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::vector<Sample>& custom_ranges, 6715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32 flags); 6725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden from Histogram: 6745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual HistogramType GetHistogramType() const OVERRIDE; 6755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Helper method for transforming an array of valid enumeration values 6775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to the std::vector<int> expected by HISTOGRAM_CUSTOM_ENUMERATION. 6785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This function ensures that a guard bucket exists right after any 6795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // valid sample value (unless the next higher sample is also a valid value), 6805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // so that invalid samples never fall into the same bucket as valid samples. 6815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(kaiwang): Change name to ArrayToCustomEnumRanges. 6825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::vector<Sample> ArrayToCustomRanges(const Sample* values, 6835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t num_values); 6845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Helper for deserializing CustomHistograms. |*ranges| should already be 6865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // correctly sized before this call. Return true on success. 6875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool DeserializeRanges(PickleIterator* iter, 6885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<Sample>* ranges); 6895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 6905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CustomHistogram(const std::string& name, 6915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const BucketRanges* ranges); 6925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool SerializeRanges(Pickle* pickle) const OVERRIDE; 6945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual double GetBucketSize(Count current, size_t i) const OVERRIDE; 6965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 6985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool ValidateCustomRanges(const std::vector<Sample>& custom_ranges); 6995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static BucketRanges* CreateBucketRangesFromCustomRanges( 7005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::vector<Sample>& custom_ranges); 7015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(CustomHistogram); 7035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 7045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace base 7065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_METRICS_HISTOGRAM_H_ 708