base/threading/thread_unittest.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "base/threading/thread.h"
   6
   7 #include <vector>
   8
   9 #include "base/bind.h"
  10 #include "base/message_loop/message_loop.h"
  11 #include "base/third_party/dynamic_annotations/dynamic_annotations.h"
  12 #include "testing/gtest/include/gtest/gtest.h"
  13 #include "testing/platform_test.h"
  14
  15 using base::Thread;
  16
  17 typedef PlatformTest ThreadTest;
  18
  19 namespace {
  20
  21 void ToggleValue(bool* value) {
  22   ANNOTATE_BENIGN_RACE(value, "Test-only data race on boolean "
  23                        "in base/thread_unittest");
  24   *value = !*value;
  25 }
  26
  27 class SleepInsideInitThread : public Thread {
  28  public:
  29   SleepInsideInitThread() : Thread("none") {
  30     init_called_ = false;
  31     ANNOTATE_BENIGN_RACE(
  32         this, "Benign test-only data race on vptr - http://crbug.com/98219");
  33   }
  34   ~SleepInsideInitThread() override { Stop(); }
  35
  36   void Init() override {
  37     base::PlatformThread::Sleep(base::TimeDelta::FromMilliseconds(500));
  38     init_called_ = true;
  39   }
  40   bool InitCalled() { return init_called_; }
  41  private:
  42   bool init_called_;
  43 };
  44
  45 enum ThreadEvent {
  46   // Thread::Init() was called.
  47   THREAD_EVENT_INIT = 0,
  48
  49   // The MessageLoop for the thread was deleted.
  50   THREAD_EVENT_MESSAGE_LOOP_DESTROYED,
  51
  52   // Thread::CleanUp() was called.
  53   THREAD_EVENT_CLEANUP,
  54
  55   // Keep at end of list.
  56   THREAD_NUM_EVENTS
  57 };
  58
  59 typedef std::vector<ThreadEvent> EventList;
  60
  61 class CaptureToEventList : public Thread {
  62  public:
  63   // This Thread pushes events into the vector |event_list| to show
  64   // the order they occured in. |event_list| must remain valid for the
  65   // lifetime of this thread.
  66   explicit CaptureToEventList(EventList* event_list)
  67       : Thread("none"),
  68         event_list_(event_list) {
  69   }
  70
  71   ~CaptureToEventList() override { Stop(); }
  72
  73   void Init() override { event_list_->push_back(THREAD_EVENT_INIT); }
  74
  75   void CleanUp() override { event_list_->push_back(THREAD_EVENT_CLEANUP); }
  76
  77  private:
  78   EventList* event_list_;
  79 };
  80
  81 // Observer that writes a value into |event_list| when a message loop has been
  82 // destroyed.
  83 class CapturingDestructionObserver
  84     : public base::MessageLoop::DestructionObserver {
  85  public:
  86   // |event_list| must remain valid throughout the observer's lifetime.
  87   explicit CapturingDestructionObserver(EventList* event_list)
  88       : event_list_(event_list) {
  89   }
  90
  91   // DestructionObserver implementation:
  92   void WillDestroyCurrentMessageLoop() override {
  93     event_list_->push_back(THREAD_EVENT_MESSAGE_LOOP_DESTROYED);
  94     event_list_ = NULL;
  95   }
  96
  97  private:
  98   EventList* event_list_;
  99 };
 100
 101 // Task that adds a destruction observer to the current message loop.
 102 void RegisterDestructionObserver(
 103     base::MessageLoop::DestructionObserver* observer) {
 104   base::MessageLoop::current()->AddDestructionObserver(observer);
 105 }
 106
 107 }  // namespace
 108
 109 TEST_F(ThreadTest, Restart) {
 110   Thread a("Restart");
 111   a.Stop();
 112   EXPECT_FALSE(a.message_loop());
 113   EXPECT_FALSE(a.IsRunning());
 114   EXPECT_TRUE(a.Start());
 115   EXPECT_TRUE(a.message_loop());
 116   EXPECT_TRUE(a.IsRunning());
 117   a.Stop();
 118   EXPECT_FALSE(a.message_loop());
 119   EXPECT_FALSE(a.IsRunning());
 120   EXPECT_TRUE(a.Start());
 121   EXPECT_TRUE(a.message_loop());
 122   EXPECT_TRUE(a.IsRunning());
 123   a.Stop();
 124   EXPECT_FALSE(a.message_loop());
 125   EXPECT_FALSE(a.IsRunning());
 126   a.Stop();
 127   EXPECT_FALSE(a.message_loop());
 128   EXPECT_FALSE(a.IsRunning());
 129 }
 130
 131 TEST_F(ThreadTest, StartWithOptions_StackSize) {
 132   Thread a("StartWithStackSize");
 133   // Ensure that the thread can work with only 12 kb and still process a
 134   // message.
 135   Thread::Options options;
 136 #if defined(ADDRESS_SANITIZER) && defined(OS_MACOSX)
 137   // ASan bloats the stack variables and overflows the 12 kb stack on OSX.
 138   options.stack_size = 24*1024;
 139 #else
 140   options.stack_size = 12*1024;
 141 #endif
 142   EXPECT_TRUE(a.StartWithOptions(options));
 143   EXPECT_TRUE(a.message_loop());
 144   EXPECT_TRUE(a.IsRunning());
 145
 146   bool was_invoked = false;
 147   a.message_loop()->PostTask(FROM_HERE, base::Bind(&ToggleValue, &was_invoked));
 148
 149   // wait for the task to run (we could use a kernel event here
 150   // instead to avoid busy waiting, but this is sufficient for
 151   // testing purposes).
 152   for (int i = 100; i >= 0 && !was_invoked; --i) {
 153     base::PlatformThread::Sleep(base::TimeDelta::FromMilliseconds(10));
 154   }
 155   EXPECT_TRUE(was_invoked);
 156 }
 157
 158 TEST_F(ThreadTest, TwoTasks) {
 159   bool was_invoked = false;
 160   {
 161     Thread a("TwoTasks");
 162     EXPECT_TRUE(a.Start());
 163     EXPECT_TRUE(a.message_loop());
 164
 165     // Test that all events are dispatched before the Thread object is
 166     // destroyed.  We do this by dispatching a sleep event before the
 167     // event that will toggle our sentinel value.
 168     a.message_loop()->PostTask(
 169         FROM_HERE,
 170         base::Bind(
 171             static_cast<void (*)(base::TimeDelta)>(
 172                 &base::PlatformThread::Sleep),
 173             base::TimeDelta::FromMilliseconds(20)));
 174     a.message_loop()->PostTask(FROM_HERE, base::Bind(&ToggleValue,
 175                                                      &was_invoked));
 176   }
 177   EXPECT_TRUE(was_invoked);
 178 }
 179
 180 TEST_F(ThreadTest, StopSoon) {
 181   Thread a("StopSoon");
 182   EXPECT_TRUE(a.Start());
 183   EXPECT_TRUE(a.message_loop());
 184   EXPECT_TRUE(a.IsRunning());
 185   a.StopSoon();
 186   a.StopSoon();
 187   a.Stop();
 188   EXPECT_FALSE(a.message_loop());
 189   EXPECT_FALSE(a.IsRunning());
 190 }
 191
 192 TEST_F(ThreadTest, ThreadName) {
 193   Thread a("ThreadName");
 194   EXPECT_TRUE(a.Start());
 195   EXPECT_EQ("ThreadName", a.thread_name());
 196 }
 197
 198 // Make sure we can't use a thread between Start() and Init().
 199 TEST_F(ThreadTest, SleepInsideInit) {
 200   SleepInsideInitThread t;
 201   EXPECT_FALSE(t.InitCalled());
 202   t.Start();
 203   EXPECT_TRUE(t.InitCalled());
 204 }
 205
 206 // Make sure that the destruction sequence is:
 207 //
 208 //  (1) Thread::CleanUp()
 209 //  (2) MessageLoop::~MessageLoop()
 210 //      MessageLoop::DestructionObservers called.
 211 TEST_F(ThreadTest, CleanUp) {
 212   EventList captured_events;
 213   CapturingDestructionObserver loop_destruction_observer(&captured_events);
 214
 215   {
 216     // Start a thread which writes its event into |captured_events|.
 217     CaptureToEventList t(&captured_events);
 218     EXPECT_TRUE(t.Start());
 219     EXPECT_TRUE(t.message_loop());
 220     EXPECT_TRUE(t.IsRunning());
 221
 222     // Register an observer that writes into |captured_events| once the
 223     // thread's message loop is destroyed.
 224     t.message_loop()->PostTask(
 225         FROM_HERE, base::Bind(&RegisterDestructionObserver,
 226                               base::Unretained(&loop_destruction_observer)));
 227
 228     // Upon leaving this scope, the thread is deleted.
 229   }
 230
 231   // Check the order of events during shutdown.
 232   ASSERT_EQ(static_cast<size_t>(THREAD_NUM_EVENTS), captured_events.size());
 233   EXPECT_EQ(THREAD_EVENT_INIT, captured_events[0]);
 234   EXPECT_EQ(THREAD_EVENT_CLEANUP, captured_events[1]);
 235   EXPECT_EQ(THREAD_EVENT_MESSAGE_LOOP_DESTROYED, captured_events[2]);
 236 }