// Copyright (c) 2012 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "base/metrics/statistics_recorder.h" #include #include #include #include "base/bind.h" #include "base/json/json_reader.h" #include "base/logging.h" #include "base/metrics/histogram_macros.h" #include "base/metrics/persistent_histogram_allocator.h" #include "base/metrics/sparse_histogram.h" #include "base/values.h" #include "testing/gtest/include/gtest/gtest.h" namespace { // Class to make sure any manipulations we do to the min log level are // contained (i.e., do not affect other unit tests). class LogStateSaver { public: LogStateSaver() : old_min_log_level_(logging::GetMinLogLevel()) {} ~LogStateSaver() { logging::SetMinLogLevel(old_min_log_level_); logging::SetLogAssertHandler(nullptr); } private: int old_min_log_level_; DISALLOW_COPY_AND_ASSIGN(LogStateSaver); }; } // namespace namespace base { class StatisticsRecorderTest : public testing::TestWithParam { protected: const int32_t kAllocatorMemorySize = 64 << 10; // 64 KiB StatisticsRecorderTest() : use_persistent_histogram_allocator_(GetParam()) { // Get this first so it never gets created in persistent storage and will // not appear in the StatisticsRecorder after it is re-initialized. PersistentHistogramAllocator::GetCreateHistogramResultHistogram(); // Each test will have a clean state (no Histogram / BucketRanges // registered). InitializeStatisticsRecorder(); // Use persistent memory for histograms if so indicated by test parameter. if (use_persistent_histogram_allocator_) { GlobalHistogramAllocator::CreateWithLocalMemory( kAllocatorMemorySize, 0, "StatisticsRecorderTest"); } } ~StatisticsRecorderTest() override { GlobalHistogramAllocator::ReleaseForTesting(); UninitializeStatisticsRecorder(); } void InitializeStatisticsRecorder() { DCHECK(!statistics_recorder_); StatisticsRecorder::UninitializeForTesting(); statistics_recorder_ = StatisticsRecorder::CreateTemporaryForTesting(); } void UninitializeStatisticsRecorder() { statistics_recorder_.reset(); StatisticsRecorder::UninitializeForTesting(); } Histogram* CreateHistogram(const std::string& name, HistogramBase::Sample min, HistogramBase::Sample max, size_t bucket_count) { BucketRanges* ranges = new BucketRanges(bucket_count + 1); Histogram::InitializeBucketRanges(min, max, ranges); const BucketRanges* registered_ranges = StatisticsRecorder::RegisterOrDeleteDuplicateRanges(ranges); return new Histogram(name, min, max, registered_ranges); } void DeleteHistogram(HistogramBase* histogram) { delete histogram; } int CountIterableHistograms(StatisticsRecorder::HistogramIterator* iter) { int count = 0; for (; *iter != StatisticsRecorder::end(); ++*iter) { ++count; } return count; } void InitLogOnShutdown() { DCHECK(statistics_recorder_); statistics_recorder_->InitLogOnShutdownWithoutLock(); } bool VLogInitialized() { DCHECK(statistics_recorder_); return statistics_recorder_->vlog_initialized_; } const bool use_persistent_histogram_allocator_; std::unique_ptr statistics_recorder_; std::unique_ptr old_global_allocator_; private: LogStateSaver log_state_saver_; DISALLOW_COPY_AND_ASSIGN(StatisticsRecorderTest); }; // Run all HistogramTest cases with both heap and persistent memory. INSTANTIATE_TEST_CASE_P(Allocator, StatisticsRecorderTest, testing::Bool()); TEST_P(StatisticsRecorderTest, NotInitialized) { UninitializeStatisticsRecorder(); ASSERT_FALSE(StatisticsRecorder::IsActive()); StatisticsRecorder::Histograms registered_histograms; std::vector registered_ranges; StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(0u, registered_histograms.size()); Histogram* histogram = CreateHistogram("TestHistogram", 1, 1000, 10); // When StatisticsRecorder is not initialized, register is a noop. EXPECT_EQ(histogram, StatisticsRecorder::RegisterOrDeleteDuplicate(histogram)); // Manually delete histogram that was not registered. DeleteHistogram(histogram); // RegisterOrDeleteDuplicateRanges is a no-op. BucketRanges* ranges = new BucketRanges(3); ranges->ResetChecksum(); EXPECT_EQ(ranges, StatisticsRecorder::RegisterOrDeleteDuplicateRanges(ranges)); StatisticsRecorder::GetBucketRanges(®istered_ranges); EXPECT_EQ(0u, registered_ranges.size()); } TEST_P(StatisticsRecorderTest, RegisterBucketRanges) { std::vector registered_ranges; BucketRanges* ranges1 = new BucketRanges(3); ranges1->ResetChecksum(); BucketRanges* ranges2 = new BucketRanges(4); ranges2->ResetChecksum(); // Register new ranges. EXPECT_EQ(ranges1, StatisticsRecorder::RegisterOrDeleteDuplicateRanges(ranges1)); EXPECT_EQ(ranges2, StatisticsRecorder::RegisterOrDeleteDuplicateRanges(ranges2)); StatisticsRecorder::GetBucketRanges(®istered_ranges); ASSERT_EQ(2u, registered_ranges.size()); // Register some ranges again. EXPECT_EQ(ranges1, StatisticsRecorder::RegisterOrDeleteDuplicateRanges(ranges1)); registered_ranges.clear(); StatisticsRecorder::GetBucketRanges(®istered_ranges); ASSERT_EQ(2u, registered_ranges.size()); // Make sure the ranges is still the one we know. ASSERT_EQ(3u, ranges1->size()); EXPECT_EQ(0, ranges1->range(0)); EXPECT_EQ(0, ranges1->range(1)); EXPECT_EQ(0, ranges1->range(2)); // Register ranges with same values. BucketRanges* ranges3 = new BucketRanges(3); ranges3->ResetChecksum(); EXPECT_EQ(ranges1, // returning ranges1 StatisticsRecorder::RegisterOrDeleteDuplicateRanges(ranges3)); registered_ranges.clear(); StatisticsRecorder::GetBucketRanges(®istered_ranges); ASSERT_EQ(2u, registered_ranges.size()); } TEST_P(StatisticsRecorderTest, RegisterHistogram) { // Create a Histogram that was not registered. Histogram* histogram = CreateHistogram("TestHistogram", 1, 1000, 10); StatisticsRecorder::Histograms registered_histograms; StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(0u, registered_histograms.size()); // Register the Histogram. EXPECT_EQ(histogram, StatisticsRecorder::RegisterOrDeleteDuplicate(histogram)); StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(1u, registered_histograms.size()); // Register the same Histogram again. EXPECT_EQ(histogram, StatisticsRecorder::RegisterOrDeleteDuplicate(histogram)); registered_histograms.clear(); StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(1u, registered_histograms.size()); } TEST_P(StatisticsRecorderTest, FindHistogram) { HistogramBase* histogram1 = Histogram::FactoryGet( "TestHistogram1", 1, 1000, 10, HistogramBase::kNoFlags); HistogramBase* histogram2 = Histogram::FactoryGet( "TestHistogram2", 1, 1000, 10, HistogramBase::kNoFlags); EXPECT_EQ(histogram1, StatisticsRecorder::FindHistogram("TestHistogram1")); EXPECT_EQ(histogram2, StatisticsRecorder::FindHistogram("TestHistogram2")); EXPECT_FALSE(StatisticsRecorder::FindHistogram("TestHistogram")); // Create a new global allocator using the same memory as the old one. Any // old one is kept around so the memory doesn't get released. old_global_allocator_ = GlobalHistogramAllocator::ReleaseForTesting(); if (use_persistent_histogram_allocator_) { GlobalHistogramAllocator::CreateWithPersistentMemory( const_cast(old_global_allocator_->data()), old_global_allocator_->length(), 0, old_global_allocator_->Id(), old_global_allocator_->Name()); } // Reset statistics-recorder to validate operation from a clean start. UninitializeStatisticsRecorder(); InitializeStatisticsRecorder(); if (use_persistent_histogram_allocator_) { EXPECT_TRUE(StatisticsRecorder::FindHistogram("TestHistogram1")); EXPECT_TRUE(StatisticsRecorder::FindHistogram("TestHistogram2")); } else { EXPECT_FALSE(StatisticsRecorder::FindHistogram("TestHistogram1")); EXPECT_FALSE(StatisticsRecorder::FindHistogram("TestHistogram2")); } EXPECT_FALSE(StatisticsRecorder::FindHistogram("TestHistogram")); } TEST_P(StatisticsRecorderTest, GetSnapshot) { Histogram::FactoryGet("TestHistogram1", 1, 1000, 10, Histogram::kNoFlags); Histogram::FactoryGet("TestHistogram2", 1, 1000, 10, Histogram::kNoFlags); Histogram::FactoryGet("TestHistogram3", 1, 1000, 10, Histogram::kNoFlags); StatisticsRecorder::Histograms snapshot; StatisticsRecorder::GetSnapshot("Test", &snapshot); EXPECT_EQ(3u, snapshot.size()); snapshot.clear(); StatisticsRecorder::GetSnapshot("1", &snapshot); EXPECT_EQ(1u, snapshot.size()); snapshot.clear(); StatisticsRecorder::GetSnapshot("hello", &snapshot); EXPECT_EQ(0u, snapshot.size()); } TEST_P(StatisticsRecorderTest, RegisterHistogramWithFactoryGet) { StatisticsRecorder::Histograms registered_histograms; StatisticsRecorder::GetHistograms(®istered_histograms); ASSERT_EQ(0u, registered_histograms.size()); // Create a histogram. HistogramBase* histogram = Histogram::FactoryGet( "TestHistogram", 1, 1000, 10, HistogramBase::kNoFlags); registered_histograms.clear(); StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(1u, registered_histograms.size()); // Get an existing histogram. HistogramBase* histogram2 = Histogram::FactoryGet( "TestHistogram", 1, 1000, 10, HistogramBase::kNoFlags); registered_histograms.clear(); StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(1u, registered_histograms.size()); EXPECT_EQ(histogram, histogram2); // Create a LinearHistogram. histogram = LinearHistogram::FactoryGet( "TestLinearHistogram", 1, 1000, 10, HistogramBase::kNoFlags); registered_histograms.clear(); StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(2u, registered_histograms.size()); // Create a BooleanHistogram. histogram = BooleanHistogram::FactoryGet( "TestBooleanHistogram", HistogramBase::kNoFlags); registered_histograms.clear(); StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(3u, registered_histograms.size()); // Create a CustomHistogram. std::vector custom_ranges; custom_ranges.push_back(1); custom_ranges.push_back(5); histogram = CustomHistogram::FactoryGet( "TestCustomHistogram", custom_ranges, HistogramBase::kNoFlags); registered_histograms.clear(); StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(4u, registered_histograms.size()); } TEST_P(StatisticsRecorderTest, RegisterHistogramWithMacros) { // Macros cache pointers and so tests that use them can only be run once. // Stop immediately if this test has run previously. static bool already_run = false; if (already_run) return; already_run = true; StatisticsRecorder::Histograms registered_histograms; HistogramBase* histogram = Histogram::FactoryGet( "TestHistogramCounts", 1, 1000000, 50, HistogramBase::kNoFlags); // The histogram we got from macro is the same as from FactoryGet. LOCAL_HISTOGRAM_COUNTS("TestHistogramCounts", 30); registered_histograms.clear(); StatisticsRecorder::GetHistograms(®istered_histograms); ASSERT_EQ(1u, registered_histograms.size()); EXPECT_EQ(histogram, registered_histograms[0]); LOCAL_HISTOGRAM_TIMES("TestHistogramTimes", TimeDelta::FromDays(1)); LOCAL_HISTOGRAM_ENUMERATION("TestHistogramEnumeration", 20, 200); registered_histograms.clear(); StatisticsRecorder::GetHistograms(®istered_histograms); EXPECT_EQ(3u, registered_histograms.size()); } TEST_P(StatisticsRecorderTest, BucketRangesSharing) { std::vector ranges; StatisticsRecorder::GetBucketRanges(&ranges); EXPECT_EQ(0u, ranges.size()); Histogram::FactoryGet("Histogram", 1, 64, 8, HistogramBase::kNoFlags); Histogram::FactoryGet("Histogram2", 1, 64, 8, HistogramBase::kNoFlags); StatisticsRecorder::GetBucketRanges(&ranges); EXPECT_EQ(1u, ranges.size()); Histogram::FactoryGet("Histogram3", 1, 64, 16, HistogramBase::kNoFlags); ranges.clear(); StatisticsRecorder::GetBucketRanges(&ranges); EXPECT_EQ(2u, ranges.size()); } TEST_P(StatisticsRecorderTest, ToJSON) { Histogram::FactoryGet("TestHistogram1", 1, 1000, 50, HistogramBase::kNoFlags) ->Add(30); Histogram::FactoryGet("TestHistogram1", 1, 1000, 50, HistogramBase::kNoFlags) ->Add(40); Histogram::FactoryGet("TestHistogram2", 1, 1000, 50, HistogramBase::kNoFlags) ->Add(30); Histogram::FactoryGet("TestHistogram2", 1, 1000, 50, HistogramBase::kNoFlags) ->Add(40); std::string json(StatisticsRecorder::ToJSON(std::string())); // Check for valid JSON. std::unique_ptr root = JSONReader::Read(json); ASSERT_TRUE(root.get()); DictionaryValue* root_dict = NULL; ASSERT_TRUE(root->GetAsDictionary(&root_dict)); // No query should be set. ASSERT_FALSE(root_dict->HasKey("query")); ListValue* histogram_list = NULL; ASSERT_TRUE(root_dict->GetList("histograms", &histogram_list)); ASSERT_EQ(2u, histogram_list->GetSize()); // Examine the first histogram. DictionaryValue* histogram_dict = NULL; ASSERT_TRUE(histogram_list->GetDictionary(0, &histogram_dict)); int sample_count; ASSERT_TRUE(histogram_dict->GetInteger("count", &sample_count)); EXPECT_EQ(2, sample_count); // Test the query filter. std::string query("TestHistogram2"); json = StatisticsRecorder::ToJSON(query); root = JSONReader::Read(json); ASSERT_TRUE(root.get()); ASSERT_TRUE(root->GetAsDictionary(&root_dict)); std::string query_value; ASSERT_TRUE(root_dict->GetString("query", &query_value)); EXPECT_EQ(query, query_value); ASSERT_TRUE(root_dict->GetList("histograms", &histogram_list)); ASSERT_EQ(1u, histogram_list->GetSize()); ASSERT_TRUE(histogram_list->GetDictionary(0, &histogram_dict)); std::string histogram_name; ASSERT_TRUE(histogram_dict->GetString("name", &histogram_name)); EXPECT_EQ("TestHistogram2", histogram_name); json.clear(); UninitializeStatisticsRecorder(); // No data should be returned. json = StatisticsRecorder::ToJSON(query); EXPECT_TRUE(json.empty()); } TEST_P(StatisticsRecorderTest, IterationTest) { Histogram::FactoryGet("IterationTest1", 1, 64, 16, HistogramBase::kNoFlags); Histogram::FactoryGet("IterationTest2", 1, 64, 16, HistogramBase::kNoFlags); StatisticsRecorder::HistogramIterator i1 = StatisticsRecorder::begin(true); EXPECT_EQ(2, CountIterableHistograms(&i1)); StatisticsRecorder::HistogramIterator i2 = StatisticsRecorder::begin(false); EXPECT_EQ(use_persistent_histogram_allocator_ ? 0 : 2, CountIterableHistograms(&i2)); // Create a new global allocator using the same memory as the old one. Any // old one is kept around so the memory doesn't get released. old_global_allocator_ = GlobalHistogramAllocator::ReleaseForTesting(); if (use_persistent_histogram_allocator_) { GlobalHistogramAllocator::CreateWithPersistentMemory( const_cast(old_global_allocator_->data()), old_global_allocator_->length(), 0, old_global_allocator_->Id(), old_global_allocator_->Name()); } // Reset statistics-recorder to validate operation from a clean start. UninitializeStatisticsRecorder(); InitializeStatisticsRecorder(); StatisticsRecorder::HistogramIterator i3 = StatisticsRecorder::begin(true); EXPECT_EQ(use_persistent_histogram_allocator_ ? 2 : 0, CountIterableHistograms(&i3)); StatisticsRecorder::HistogramIterator i4 = StatisticsRecorder::begin(false); EXPECT_EQ(0, CountIterableHistograms(&i4)); } namespace { // CallbackCheckWrapper is simply a convenient way to check and store that // a callback was actually run. struct CallbackCheckWrapper { CallbackCheckWrapper() : called(false), last_histogram_value(0) {} void OnHistogramChanged(base::HistogramBase::Sample histogram_value) { called = true; last_histogram_value = histogram_value; } bool called; base::HistogramBase::Sample last_histogram_value; }; } // namespace // Check that you can't overwrite the callback with another. TEST_P(StatisticsRecorderTest, SetCallbackFailsWithoutHistogramTest) { CallbackCheckWrapper callback_wrapper; bool result = base::StatisticsRecorder::SetCallback( "TestHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); EXPECT_TRUE(result); result = base::StatisticsRecorder::SetCallback( "TestHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); EXPECT_FALSE(result); } // Check that you can't overwrite the callback with another. TEST_P(StatisticsRecorderTest, SetCallbackFailsWithHistogramTest) { HistogramBase* histogram = Histogram::FactoryGet("TestHistogram", 1, 1000, 10, HistogramBase::kNoFlags); EXPECT_TRUE(histogram); CallbackCheckWrapper callback_wrapper; bool result = base::StatisticsRecorder::SetCallback( "TestHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); EXPECT_TRUE(result); EXPECT_EQ(histogram->flags() & base::HistogramBase::kCallbackExists, base::HistogramBase::kCallbackExists); result = base::StatisticsRecorder::SetCallback( "TestHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); EXPECT_FALSE(result); EXPECT_EQ(histogram->flags() & base::HistogramBase::kCallbackExists, base::HistogramBase::kCallbackExists); histogram->Add(1); EXPECT_TRUE(callback_wrapper.called); } // Check that you can't overwrite the callback with another. TEST_P(StatisticsRecorderTest, ClearCallbackSuceedsWithHistogramTest) { HistogramBase* histogram = Histogram::FactoryGet("TestHistogram", 1, 1000, 10, HistogramBase::kNoFlags); EXPECT_TRUE(histogram); CallbackCheckWrapper callback_wrapper; bool result = base::StatisticsRecorder::SetCallback( "TestHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); EXPECT_TRUE(result); EXPECT_EQ(histogram->flags() & base::HistogramBase::kCallbackExists, base::HistogramBase::kCallbackExists); base::StatisticsRecorder::ClearCallback("TestHistogram"); EXPECT_EQ(histogram->flags() & base::HistogramBase::kCallbackExists, 0); histogram->Add(1); EXPECT_FALSE(callback_wrapper.called); } // Check that callback is used. TEST_P(StatisticsRecorderTest, CallbackUsedTest) { { HistogramBase* histogram = Histogram::FactoryGet( "TestHistogram", 1, 1000, 10, HistogramBase::kNoFlags); EXPECT_TRUE(histogram); CallbackCheckWrapper callback_wrapper; base::StatisticsRecorder::SetCallback( "TestHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); histogram->Add(1); EXPECT_TRUE(callback_wrapper.called); EXPECT_EQ(callback_wrapper.last_histogram_value, 1); } { HistogramBase* linear_histogram = LinearHistogram::FactoryGet( "TestLinearHistogram", 1, 1000, 10, HistogramBase::kNoFlags); CallbackCheckWrapper callback_wrapper; base::StatisticsRecorder::SetCallback( "TestLinearHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); linear_histogram->Add(1); EXPECT_TRUE(callback_wrapper.called); EXPECT_EQ(callback_wrapper.last_histogram_value, 1); } { std::vector custom_ranges; custom_ranges.push_back(1); custom_ranges.push_back(5); HistogramBase* custom_histogram = CustomHistogram::FactoryGet( "TestCustomHistogram", custom_ranges, HistogramBase::kNoFlags); CallbackCheckWrapper callback_wrapper; base::StatisticsRecorder::SetCallback( "TestCustomHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); custom_histogram->Add(1); EXPECT_TRUE(callback_wrapper.called); EXPECT_EQ(callback_wrapper.last_histogram_value, 1); } { HistogramBase* custom_histogram = SparseHistogram::FactoryGet( "TestSparseHistogram", HistogramBase::kNoFlags); CallbackCheckWrapper callback_wrapper; base::StatisticsRecorder::SetCallback( "TestSparseHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); custom_histogram->Add(1); EXPECT_TRUE(callback_wrapper.called); EXPECT_EQ(callback_wrapper.last_histogram_value, 1); } } // Check that setting a callback before the histogram exists works. TEST_P(StatisticsRecorderTest, CallbackUsedBeforeHistogramCreatedTest) { CallbackCheckWrapper callback_wrapper; base::StatisticsRecorder::SetCallback( "TestHistogram", base::Bind(&CallbackCheckWrapper::OnHistogramChanged, base::Unretained(&callback_wrapper))); HistogramBase* histogram = Histogram::FactoryGet("TestHistogram", 1, 1000, 10, HistogramBase::kNoFlags); EXPECT_TRUE(histogram); histogram->Add(1); EXPECT_TRUE(callback_wrapper.called); EXPECT_EQ(callback_wrapper.last_histogram_value, 1); } TEST_P(StatisticsRecorderTest, LogOnShutdownNotInitialized) { UninitializeStatisticsRecorder(); logging::SetMinLogLevel(logging::LOG_WARNING); InitializeStatisticsRecorder(); EXPECT_FALSE(VLOG_IS_ON(1)); EXPECT_FALSE(VLogInitialized()); InitLogOnShutdown(); EXPECT_FALSE(VLogInitialized()); } TEST_P(StatisticsRecorderTest, LogOnShutdownInitializedExplicitly) { UninitializeStatisticsRecorder(); logging::SetMinLogLevel(logging::LOG_WARNING); InitializeStatisticsRecorder(); EXPECT_FALSE(VLOG_IS_ON(1)); EXPECT_FALSE(VLogInitialized()); logging::SetMinLogLevel(logging::LOG_VERBOSE); EXPECT_TRUE(VLOG_IS_ON(1)); InitLogOnShutdown(); EXPECT_TRUE(VLogInitialized()); } TEST_P(StatisticsRecorderTest, LogOnShutdownInitialized) { UninitializeStatisticsRecorder(); logging::SetMinLogLevel(logging::LOG_VERBOSE); InitializeStatisticsRecorder(); EXPECT_TRUE(VLOG_IS_ON(1)); EXPECT_TRUE(VLogInitialized()); } } // namespace base