[tracing] Implement polling in MemoryDumpManager

base/trace_event/memory_dump_manager_unittest.cc

 // Copyright 2015 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/trace_event/memory_dump_manager.h"
 
 #include <stdint.h>
 
 #include <memory>
 #include <vector>
 
 #include "base/bind_helpers.h"
 #include "base/memory/ptr_util.h"
 #include "base/memory/ref_counted_memory.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "base/strings/stringprintf.h"
 #include "base/synchronization/waitable_event.h"
 #include "base/test/sequenced_worker_pool_owner.h"
 #include "base/test/test_io_thread.h"
 #include "base/test/trace_event_analyzer.h"
 #include "base/threading/platform_thread.h"
 #include "base/threading/sequenced_task_runner_handle.h"
 #include "base/threading/sequenced_worker_pool.h"
 #include "base/threading/thread.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "base/trace_event/memory_dump_provider.h"
+#include "base/trace_event/memory_dump_trigger.h"
 #include "base/trace_event/memory_infra_background_whitelist.h"
 #include "base/trace_event/process_memory_dump.h"
 #include "base/trace_event/trace_buffer.h"
 #include "base/trace_event/trace_config_memory_test_util.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 using testing::_;
 using testing::AnyNumber;
 using testing::AtMost;
@@ skipping 225 matching lines @@
                                         TraceLog::RECORDING_MODE);
   }
 
   void EnableTracingWithTraceConfig(const std::string& trace_config) {
     TraceLog::GetInstance()->SetEnabled(TraceConfig(trace_config),
                                         TraceLog::RECORDING_MODE);
   }
 
   void DisableTracing() { TraceLog::GetInstance()->SetDisabled(); }
 
-  bool IsPeriodicDumpingEnabled() const {
-    return mdm_->periodic_dump_timer_.IsRunning();
-  }
-
   int GetMaxConsecutiveFailuresCount() const {
     return MemoryDumpManager::kMaxConsecutiveFailuresCount;
   }
 
-  scoped_refptr<SequencedTaskRunner> GetPollingTaskRunnerUnsafe() {
-    return mdm_->dump_thread_->task_runner();
-  }
+  MemoryDumpTrigger* GetDumpTrigger() { return mdm_->dump_trigger_.get(); }
 
   const MemoryDumpProvider::Options kDefaultOptions;
   std::unique_ptr<MemoryDumpManager> mdm_;
   std::unique_ptr<MemoryDumpManagerDelegateForTesting> delegate_;
   bool last_callback_success_;
 
  private:
   std::unique_ptr<MessageLoop> message_loop_;
 
   // We want our singleton torn down after each test.
@@ skipping 461 matching lines @@
   std::unique_ptr<MockMemoryDumpProvider> mdp1(new MockMemoryDumpProvider());
   std::unique_ptr<MockMemoryDumpProvider> mdp2(new MockMemoryDumpProvider());
   mdp1->enable_mock_destructor = true;
   mdp2->enable_mock_destructor = true;
 
   EXPECT_CALL(*mdp1, SuspendFastMemoryPolling()).Times(1);
   EXPECT_CALL(*mdp2, SuspendFastMemoryPolling()).Times(1);
   EXPECT_CALL(*mdp1, Destructor());
   EXPECT_CALL(*mdp2, Destructor());
 
+  MemoryDumpProvider::Options options;
+  options.is_fast_polling_supported = true;
+  RegisterDumpProvider(mdp1.get(), nullptr, options);
+
   RunLoop run_loop;
   scoped_refptr<SingleThreadTaskRunner> test_task_runner =
       ThreadTaskRunnerHandle::Get();
   auto quit_closure = run_loop.QuitClosure();
 
+  const int kPollsToQuit = 10;
   int call_count = 0;
+  MemoryDumpManager* mdm = mdm_.get();
+  const auto poll_function1 = [&call_count, &test_task_runner, quit_closure,
+                               &mdp2, mdm, &options,
+                               this](uint64_t* total) -> void {
+    ++call_count;
+    if (call_count == 1)
+      RegisterDumpProvider(mdp2.get(), nullptr, options, kMDPName);
+    else if (call_count == 4)
+      mdm->UnregisterAndDeleteDumpProviderSoon(std::move(mdp2));
+    else if (call_count == kPollsToQuit)
+      test_task_runner->PostTask(FROM_HERE, quit_closure);
+
+    // Record increase of 10s of GiB of memory.
+    *total = call_count * 10lu * 1024 * 1024 * 1024;
+  };
   EXPECT_CALL(*mdp1, PollFastMemoryTotal(_))
-      .Times(4)
-      .WillRepeatedly(Invoke([&call_count, &test_task_runner,
-                              quit_closure](uint64_t* total) -> void {
-        ++call_count;
-        if (call_count == 4)
-          test_task_runner->PostTask(FROM_HERE, quit_closure);
-      }));
+      .Times(testing::AtLeast(kPollsToQuit))
+      .WillRepeatedly(Invoke(poll_function1));
 
   // Depending on the order of PostTask calls the mdp2 might be registered after
   // all polls or in between polls.
   EXPECT_CALL(*mdp2, PollFastMemoryTotal(_))
-      .Times(Between(0, 4))
+      .Times(Between(0, kPollsToQuit - 1))
       .WillRepeatedly(Return());
 
-  MemoryDumpProvider::Options options;
-  options.is_fast_polling_supported = true;
-  RegisterDumpProvider(mdp1.get(), nullptr, options);
+  MemoryDumpTrigger::SetPollingIntervalForTesting(1);
   EnableTracingWithTraceConfig(
-      TraceConfigMemoryTestUtil::GetTraceConfig_PeakDetectionTrigger(1));
-  scoped_refptr<SequencedTaskRunner> polling_task_runner =
-      GetPollingTaskRunnerUnsafe().get();
-  ASSERT_TRUE(polling_task_runner);
+      TraceConfigMemoryTestUtil::GetTraceConfig_PeakDetectionTrigger(3));
 
-  uint64_t value = 0;
-  for (int i = 0; i < 4; i++) {
-    if (i == 0)
-      RegisterDumpProvider(mdp2.get(), nullptr, options);
-    if (i == 2)
-      mdm_->UnregisterAndDeleteDumpProviderSoon(std::move(mdp2));
-    polling_task_runner->PostTask(
-        FROM_HERE, Bind(&MemoryDumpManagerTest::PollFastMemoryTotal,
-                        Unretained(this), &value));
-  }
+  int last_poll_to_request_dump = -2;
+  EXPECT_CALL(*delegate_, RequestGlobalMemoryDump(_, _))
+      .Times(testing::AtLeast(2))
+      .WillRepeatedly(Invoke([&last_poll_to_request_dump, &call_count](
+                                 const MemoryDumpRequestArgs& args,
+                                 const MemoryDumpCallback& callback) -> void {
+        // Minimum number of polls between dumps must be 3 (polling interval is
+        // 1ms).
+        EXPECT_GE(call_count - last_poll_to_request_dump, 3);
+        last_poll_to_request_dump = call_count;
+      }));
 
   run_loop.Run();
   DisableTracing();
   mdm_->UnregisterAndDeleteDumpProviderSoon(std::move(mdp1));
 }
 
 // If a thread (with a dump provider living on it) is torn down during a dump
 // its dump provider should be skipped but the dump itself should succeed.
 TEST_F(MemoryDumpManagerTest, TearDownThreadWhileDumping) {
   InitializeMemoryDumpManager(false /* is_coordinator */);
@@ skipping 102 matching lines @@
   // Don't trigger the default behavior of the mock delegate in this test,
   // which would short-circuit the dump request to the actual
   // CreateProcessDump().
   // We don't want to create any dump in this test, only check whether the dumps
   // are requested or not.
   ON_CALL(delegate, RequestGlobalMemoryDump(_, _)).WillByDefault(Return());
 
   // Enabling memory-infra in a non-coordinator process should not trigger any
   // periodic dumps.
   EnableTracingWithLegacyCategories(MemoryDumpManager::kTraceCategory);
-  EXPECT_FALSE(IsPeriodicDumpingEnabled());
+  EXPECT_FALSE(GetDumpTrigger()->IsPeriodicDumpTimerRunning());
   DisableTracing();
 
   // Enabling memory-infra with the new (JSON) TraceConfig in a non-coordinator
   // process with a fully defined trigger config should NOT enable any periodic
   // dumps.
   EnableTracingWithTraceConfig(
       TraceConfigMemoryTestUtil::GetTraceConfig_PeriodicTriggers(1, 5));
-  EXPECT_FALSE(IsPeriodicDumpingEnabled());
+  EXPECT_FALSE(GetDumpTrigger()->IsPeriodicDumpTimerRunning());
   DisableTracing();
 }
 
 TEST_F(MemoryDumpManagerTest, TraceConfigExpectationsWhenIsCoordinator) {
   InitializeMemoryDumpManager(true /* is_coordinator */);
   MemoryDumpManagerDelegateForTesting& delegate = *delegate_;
   ON_CALL(delegate, RequestGlobalMemoryDump(_, _)).WillByDefault(Return());
 
   // Enabling memory-infra with the legacy TraceConfig (category filter) in
   // a coordinator process should enable periodic dumps.
   EnableTracingWithLegacyCategories(MemoryDumpManager::kTraceCategory);
-  EXPECT_TRUE(IsPeriodicDumpingEnabled());
+  EXPECT_TRUE(GetDumpTrigger()->IsPeriodicDumpTimerRunning());
   DisableTracing();
 
   // Enabling memory-infra with the new (JSON) TraceConfig in a coordinator
   // process without specifying any "memory_dump_config" section should enable
   // periodic dumps. This is to preserve the behavior chrome://tracing UI, that
   // is: ticking memory-infra should dump periodically with the default config.
   EnableTracingWithTraceConfig(
       TraceConfigMemoryTestUtil::GetTraceConfig_NoTriggers());
-  EXPECT_TRUE(IsPeriodicDumpingEnabled());
+  EXPECT_TRUE(GetDumpTrigger()->IsPeriodicDumpTimerRunning());
   DisableTracing();
 
   // Enabling memory-infra with the new (JSON) TraceConfig in a coordinator
   // process with an empty "memory_dump_config" should NOT enable periodic
   // dumps. This is the way telemetry is supposed to use memory-infra with
   // only explicitly triggered dumps.
   EnableTracingWithTraceConfig(
       TraceConfigMemoryTestUtil::GetTraceConfig_EmptyTriggers());
-  EXPECT_FALSE(IsPeriodicDumpingEnabled());
+  EXPECT_FALSE(GetDumpTrigger()->IsPeriodicDumpTimerRunning());
   DisableTracing();
 
   // Enabling memory-infra with the new (JSON) TraceConfig in a coordinator
   // process with a fully defined trigger config should cause periodic dumps to
   // be performed in the correct order.
   RunLoop run_loop;
   auto quit_closure = run_loop.QuitClosure();
 
   const int kHeavyDumpRate = 5;
   const int kLightDumpPeriodMs = 1;
@@ skipping 240 matching lines @@
   RegisterDumpProvider(mdp1.get());
   std::unique_ptr<MockMemoryDumpProvider> mdp2(new MockMemoryDumpProvider);
   RegisterDumpProvider(mdp2.get(), nullptr, kDefaultOptions,
                        kWhitelistedMDPName);
 
   EXPECT_CALL(*mdp1, OnMemoryDump(_, _)).Times(0);
   EXPECT_CALL(*mdp2, OnMemoryDump(_, _)).Times(1).WillOnce(Return(true));
   EXPECT_CALL(*delegate_, RequestGlobalMemoryDump(_, _)).Times(1);
 
   EnableTracingWithLegacyCategories(MemoryDumpManager::kTraceCategory);
-  EXPECT_FALSE(IsPeriodicDumpingEnabled());
+  EXPECT_FALSE(GetDumpTrigger()->IsPeriodicDumpTimerRunning());
   RequestGlobalDumpAndWait(MemoryDumpType::EXPLICITLY_TRIGGERED,
                            MemoryDumpLevelOfDetail::BACKGROUND);
   DisableTracing();
 }
 
 TEST_F(MemoryDumpManagerTest, TestBackgroundTracingSetup) {
   InitializeMemoryDumpManager(true /* is_coordinator */);
 
   RunLoop run_loop;
   auto quit_closure = run_loop.QuitClosure();
@@ skipping 15 matching lines @@
   // Only background mode dumps should be allowed with the trace config.
   last_callback_success_ = false;
   RequestGlobalDumpAndWait(MemoryDumpType::EXPLICITLY_TRIGGERED,
                            MemoryDumpLevelOfDetail::LIGHT);
   EXPECT_FALSE(last_callback_success_);
   last_callback_success_ = false;
   RequestGlobalDumpAndWait(MemoryDumpType::EXPLICITLY_TRIGGERED,
                            MemoryDumpLevelOfDetail::DETAILED);
   EXPECT_FALSE(last_callback_success_);
 
-  ASSERT_TRUE(IsPeriodicDumpingEnabled());
+  ASSERT_TRUE(GetDumpTrigger()->IsPeriodicDumpTimerRunning());
   run_loop.Run();
   DisableTracing();
 }
 
 }  // namespace trace_event
 }  // namespace base