// 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/observer_list.h" #include "base/observer_list_threadsafe.h" #include #include "base/compiler_specific.h" #include "base/location.h" #include "base/memory/weak_ptr.h" #include "base/run_loop.h" #include "base/single_thread_task_runner.h" #include "base/threading/platform_thread.h" #include "testing/gtest/include/gtest/gtest.h" namespace base { namespace { class Foo { public: virtual void Observe(int x) = 0; virtual ~Foo() {} virtual int GetValue() const { return 0; } }; class Adder : public Foo { public: explicit Adder(int scaler) : total(0), scaler_(scaler) {} ~Adder() override {} void Observe(int x) override { total += x * scaler_; } int GetValue() const override { return total; } int total; private: int scaler_; }; class Disrupter : public Foo { public: Disrupter(ObserverList* list, Foo* doomed, bool remove_self) : list_(list), doomed_(doomed), remove_self_(remove_self) {} Disrupter(ObserverList* list, Foo* doomed) : Disrupter(list, doomed, false) {} Disrupter(ObserverList* list, bool remove_self) : Disrupter(list, nullptr, remove_self) {} ~Disrupter() override {} void Observe(int x) override { if (remove_self_) list_->RemoveObserver(this); if (doomed_) list_->RemoveObserver(doomed_); } void SetDoomed(Foo* doomed) { doomed_ = doomed; } private: ObserverList* list_; Foo* doomed_; bool remove_self_; }; class ThreadSafeDisrupter : public Foo { public: ThreadSafeDisrupter(ObserverListThreadSafe* list, Foo* doomed) : list_(list), doomed_(doomed) { } ~ThreadSafeDisrupter() override {} void Observe(int x) override { list_->RemoveObserver(doomed_); } private: ObserverListThreadSafe* list_; Foo* doomed_; }; template class AddInObserve : public Foo { public: explicit AddInObserve(ObserverListType* observer_list) : observer_list(observer_list), to_add_() {} void SetToAdd(Foo* to_add) { to_add_ = to_add; } void Observe(int x) override { if (to_add_) { observer_list->AddObserver(to_add_); to_add_ = nullptr; } } ObserverListType* observer_list; Foo* to_add_; }; static const int kThreadRunTime = 2000; // ms to run the multi-threaded test. // A thread for use in the ThreadSafeObserver test // which will add and remove itself from the notification // list repeatedly. class AddRemoveThread : public PlatformThread::Delegate, public Foo { public: AddRemoveThread(ObserverListThreadSafe* list, bool notify) : list_(list), loop_(nullptr), in_list_(false), start_(Time::Now()), count_observes_(0), count_addtask_(0), do_notifies_(notify), weak_factory_(this) { } ~AddRemoveThread() override {} void ThreadMain() override { loop_ = new MessageLoop(); // Fire up a message loop. loop_->task_runner()->PostTask( FROM_HERE, base::Bind(&AddRemoveThread::AddTask, weak_factory_.GetWeakPtr())); RunLoop().Run(); delete loop_; loop_ = reinterpret_cast(0xdeadbeef); delete this; } // This task just keeps posting to itself in an attempt // to race with the notifier. void AddTask() { count_addtask_++; if ((Time::Now() - start_).InMilliseconds() > kThreadRunTime) { VLOG(1) << "DONE!"; return; } if (!in_list_) { list_->AddObserver(this); in_list_ = true; } if (do_notifies_) { list_->Notify(FROM_HERE, &Foo::Observe, 10); } loop_->task_runner()->PostTask( FROM_HERE, base::Bind(&AddRemoveThread::AddTask, weak_factory_.GetWeakPtr())); } void Quit() { loop_->task_runner()->PostTask(FROM_HERE, MessageLoop::QuitWhenIdleClosure()); } void Observe(int x) override { count_observes_++; // If we're getting called after we removed ourselves from // the list, that is very bad! DCHECK(in_list_); // This callback should fire on the appropriate thread EXPECT_EQ(loop_, MessageLoop::current()); list_->RemoveObserver(this); in_list_ = false; } private: ObserverListThreadSafe* list_; MessageLoop* loop_; bool in_list_; // Are we currently registered for notifications. // in_list_ is only used on |this| thread. Time start_; // The time we started the test. int count_observes_; // Number of times we observed. int count_addtask_; // Number of times thread AddTask was called bool do_notifies_; // Whether these threads should do notifications. base::WeakPtrFactory weak_factory_; }; } // namespace TEST(ObserverListTest, BasicTest) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1), e(-1); Disrupter evil(&observer_list, &c); observer_list.AddObserver(&a); observer_list.AddObserver(&b); EXPECT_TRUE(observer_list.HasObserver(&a)); EXPECT_FALSE(observer_list.HasObserver(&c)); for (auto& observer : observer_list) observer.Observe(10); observer_list.AddObserver(&evil); observer_list.AddObserver(&c); observer_list.AddObserver(&d); // Removing an observer not in the list should do nothing. observer_list.RemoveObserver(&e); for (auto& observer : observer_list) observer.Observe(10); EXPECT_EQ(20, a.total); EXPECT_EQ(-20, b.total); EXPECT_EQ(0, c.total); EXPECT_EQ(-10, d.total); EXPECT_EQ(0, e.total); } TEST(ObserverListTest, DisruptSelf) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter evil(&observer_list, true); observer_list.AddObserver(&a); observer_list.AddObserver(&b); for (auto& observer : observer_list) observer.Observe(10); observer_list.AddObserver(&evil); observer_list.AddObserver(&c); observer_list.AddObserver(&d); for (auto& observer : observer_list) observer.Observe(10); EXPECT_EQ(20, a.total); EXPECT_EQ(-20, b.total); EXPECT_EQ(10, c.total); EXPECT_EQ(-10, d.total); } TEST(ObserverListTest, DisruptBefore) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter evil(&observer_list, &b); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&evil); observer_list.AddObserver(&c); observer_list.AddObserver(&d); for (auto& observer : observer_list) observer.Observe(10); for (auto& observer : observer_list) observer.Observe(10); EXPECT_EQ(20, a.total); EXPECT_EQ(-10, b.total); EXPECT_EQ(20, c.total); EXPECT_EQ(-20, d.total); } TEST(ObserverListThreadSafeTest, BasicTest) { MessageLoop loop; scoped_refptr > observer_list( new ObserverListThreadSafe); Adder a(1); Adder b(-1); Adder c(1); Adder d(-1); ThreadSafeDisrupter evil(observer_list.get(), &c); observer_list->AddObserver(&a); observer_list->AddObserver(&b); observer_list->Notify(FROM_HERE, &Foo::Observe, 10); RunLoop().RunUntilIdle(); observer_list->AddObserver(&evil); observer_list->AddObserver(&c); observer_list->AddObserver(&d); observer_list->Notify(FROM_HERE, &Foo::Observe, 10); RunLoop().RunUntilIdle(); EXPECT_EQ(20, a.total); EXPECT_EQ(-20, b.total); EXPECT_EQ(0, c.total); EXPECT_EQ(-10, d.total); } TEST(ObserverListThreadSafeTest, RemoveObserver) { MessageLoop loop; scoped_refptr > observer_list( new ObserverListThreadSafe); Adder a(1), b(1); // A workaround for the compiler bug. See http://crbug.com/121960. EXPECT_NE(&a, &b); // Should do nothing. observer_list->RemoveObserver(&a); observer_list->RemoveObserver(&b); observer_list->Notify(FROM_HERE, &Foo::Observe, 10); RunLoop().RunUntilIdle(); EXPECT_EQ(0, a.total); EXPECT_EQ(0, b.total); observer_list->AddObserver(&a); // Should also do nothing. observer_list->RemoveObserver(&b); observer_list->Notify(FROM_HERE, &Foo::Observe, 10); RunLoop().RunUntilIdle(); EXPECT_EQ(10, a.total); EXPECT_EQ(0, b.total); } TEST(ObserverListThreadSafeTest, WithoutMessageLoop) { scoped_refptr > observer_list( new ObserverListThreadSafe); Adder a(1), b(1), c(1); // No MessageLoop, so these should not be added. observer_list->AddObserver(&a); observer_list->AddObserver(&b); { // Add c when there's a loop. MessageLoop loop; observer_list->AddObserver(&c); observer_list->Notify(FROM_HERE, &Foo::Observe, 10); RunLoop().RunUntilIdle(); EXPECT_EQ(0, a.total); EXPECT_EQ(0, b.total); EXPECT_EQ(10, c.total); // Now add a when there's a loop. observer_list->AddObserver(&a); // Remove c when there's a loop. observer_list->RemoveObserver(&c); // Notify again. observer_list->Notify(FROM_HERE, &Foo::Observe, 20); RunLoop().RunUntilIdle(); EXPECT_EQ(20, a.total); EXPECT_EQ(0, b.total); EXPECT_EQ(10, c.total); } // Removing should always succeed with or without a loop. observer_list->RemoveObserver(&a); // Notifying should not fail but should also be a no-op. MessageLoop loop; observer_list->AddObserver(&b); observer_list->Notify(FROM_HERE, &Foo::Observe, 30); RunLoop().RunUntilIdle(); EXPECT_EQ(20, a.total); EXPECT_EQ(30, b.total); EXPECT_EQ(10, c.total); } class FooRemover : public Foo { public: explicit FooRemover(ObserverListThreadSafe* list) : list_(list) {} ~FooRemover() override {} void AddFooToRemove(Foo* foo) { foos_.push_back(foo); } void Observe(int x) override { std::vector tmp; tmp.swap(foos_); for (std::vector::iterator it = tmp.begin(); it != tmp.end(); ++it) { list_->RemoveObserver(*it); } } private: const scoped_refptr > list_; std::vector foos_; }; TEST(ObserverListThreadSafeTest, RemoveMultipleObservers) { MessageLoop loop; scoped_refptr > observer_list( new ObserverListThreadSafe); FooRemover a(observer_list.get()); Adder b(1); observer_list->AddObserver(&a); observer_list->AddObserver(&b); a.AddFooToRemove(&a); a.AddFooToRemove(&b); observer_list->Notify(FROM_HERE, &Foo::Observe, 1); RunLoop().RunUntilIdle(); } // A test driver for a multi-threaded notification loop. Runs a number // of observer threads, each of which constantly adds/removes itself // from the observer list. Optionally, if cross_thread_notifies is set // to true, the observer threads will also trigger notifications to // all observers. static void ThreadSafeObserverHarness(int num_threads, bool cross_thread_notifies) { MessageLoop loop; const int kMaxThreads = 15; num_threads = num_threads > kMaxThreads ? kMaxThreads : num_threads; scoped_refptr > observer_list( new ObserverListThreadSafe); Adder a(1); Adder b(-1); Adder c(1); Adder d(-1); observer_list->AddObserver(&a); observer_list->AddObserver(&b); AddRemoveThread* threaded_observer[kMaxThreads]; base::PlatformThreadHandle threads[kMaxThreads]; for (int index = 0; index < num_threads; index++) { threaded_observer[index] = new AddRemoveThread(observer_list.get(), false); EXPECT_TRUE(PlatformThread::Create(0, threaded_observer[index], &threads[index])); } Time start = Time::Now(); while (true) { if ((Time::Now() - start).InMilliseconds() > kThreadRunTime) break; observer_list->Notify(FROM_HERE, &Foo::Observe, 10); RunLoop().RunUntilIdle(); } for (int index = 0; index < num_threads; index++) { threaded_observer[index]->Quit(); PlatformThread::Join(threads[index]); } } TEST(ObserverListThreadSafeTest, CrossThreadObserver) { // Use 7 observer threads. Notifications only come from // the main thread. ThreadSafeObserverHarness(7, false); } TEST(ObserverListThreadSafeTest, CrossThreadNotifications) { // Use 3 observer threads. Notifications will fire from // the main thread and all 3 observer threads. ThreadSafeObserverHarness(3, true); } TEST(ObserverListThreadSafeTest, OutlivesMessageLoop) { MessageLoop* loop = new MessageLoop; scoped_refptr > observer_list( new ObserverListThreadSafe); Adder a(1); observer_list->AddObserver(&a); delete loop; // Test passes if we don't crash here. observer_list->Notify(FROM_HERE, &Foo::Observe, 1); } TEST(ObserverListTest, Existing) { ObserverList observer_list(ObserverList::NOTIFY_EXISTING_ONLY); Adder a(1); AddInObserve > b(&observer_list); Adder c(1); b.SetToAdd(&c); observer_list.AddObserver(&a); observer_list.AddObserver(&b); for (auto& observer : observer_list) observer.Observe(1); EXPECT_FALSE(b.to_add_); // B's adder should not have been notified because it was added during // notification. EXPECT_EQ(0, c.total); // Notify again to make sure b's adder is notified. for (auto& observer : observer_list) observer.Observe(1); EXPECT_EQ(1, c.total); } // Same as above, but for ObserverListThreadSafe TEST(ObserverListThreadSafeTest, Existing) { MessageLoop loop; scoped_refptr > observer_list( new ObserverListThreadSafe(ObserverList::NOTIFY_EXISTING_ONLY)); Adder a(1); AddInObserve > b(observer_list.get()); Adder c(1); b.SetToAdd(&c); observer_list->AddObserver(&a); observer_list->AddObserver(&b); observer_list->Notify(FROM_HERE, &Foo::Observe, 1); RunLoop().RunUntilIdle(); EXPECT_FALSE(b.to_add_); // B's adder should not have been notified because it was added during // notification. EXPECT_EQ(0, c.total); // Notify again to make sure b's adder is notified. observer_list->Notify(FROM_HERE, &Foo::Observe, 1); RunLoop().RunUntilIdle(); EXPECT_EQ(1, c.total); } class AddInClearObserve : public Foo { public: explicit AddInClearObserve(ObserverList* list) : list_(list), added_(false), adder_(1) {} void Observe(int /* x */) override { list_->Clear(); list_->AddObserver(&adder_); added_ = true; } bool added() const { return added_; } const Adder& adder() const { return adder_; } private: ObserverList* const list_; bool added_; Adder adder_; }; TEST(ObserverListTest, ClearNotifyAll) { ObserverList observer_list; AddInClearObserve a(&observer_list); observer_list.AddObserver(&a); for (auto& observer : observer_list) observer.Observe(1); EXPECT_TRUE(a.added()); EXPECT_EQ(1, a.adder().total) << "Adder should observe once and have sum of 1."; } TEST(ObserverListTest, ClearNotifyExistingOnly) { ObserverList observer_list(ObserverList::NOTIFY_EXISTING_ONLY); AddInClearObserve a(&observer_list); observer_list.AddObserver(&a); for (auto& observer : observer_list) observer.Observe(1); EXPECT_TRUE(a.added()); EXPECT_EQ(0, a.adder().total) << "Adder should not observe, so sum should still be 0."; } class ListDestructor : public Foo { public: explicit ListDestructor(ObserverList* list) : list_(list) {} ~ListDestructor() override {} void Observe(int x) override { delete list_; } private: ObserverList* list_; }; TEST(ObserverListTest, IteratorOutlivesList) { ObserverList* observer_list = new ObserverList; ListDestructor a(observer_list); observer_list->AddObserver(&a); for (auto& observer : *observer_list) observer.Observe(0); // If this test fails, there'll be Valgrind errors when this function goes out // of scope. } TEST(ObserverListTest, BasicStdIterator) { using FooList = ObserverList; FooList observer_list; // An optimization: begin() and end() do not involve weak pointers on // empty list. EXPECT_FALSE(observer_list.begin().list_); EXPECT_FALSE(observer_list.end().list_); // Iterate over empty list: no effect, no crash. for (auto& i : observer_list) i.Observe(10); Adder a(1), b(-1), c(1), d(-1); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&c); observer_list.AddObserver(&d); for (FooList::iterator i = observer_list.begin(), e = observer_list.end(); i != e; ++i) i->Observe(1); EXPECT_EQ(1, a.total); EXPECT_EQ(-1, b.total); EXPECT_EQ(1, c.total); EXPECT_EQ(-1, d.total); // Check an iteration over a 'const view' for a given container. const FooList& const_list = observer_list; for (FooList::const_iterator i = const_list.begin(), e = const_list.end(); i != e; ++i) { EXPECT_EQ(1, std::abs(i->GetValue())); } for (const auto& o : const_list) EXPECT_EQ(1, std::abs(o.GetValue())); } TEST(ObserverListTest, StdIteratorRemoveItself) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter disrupter(&observer_list, true); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&disrupter); observer_list.AddObserver(&c); observer_list.AddObserver(&d); for (auto& o : observer_list) o.Observe(1); for (auto& o : observer_list) o.Observe(10); EXPECT_EQ(11, a.total); EXPECT_EQ(-11, b.total); EXPECT_EQ(11, c.total); EXPECT_EQ(-11, d.total); } TEST(ObserverListTest, StdIteratorRemoveBefore) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter disrupter(&observer_list, &b); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&disrupter); observer_list.AddObserver(&c); observer_list.AddObserver(&d); for (auto& o : observer_list) o.Observe(1); for (auto& o : observer_list) o.Observe(10); EXPECT_EQ(11, a.total); EXPECT_EQ(-1, b.total); EXPECT_EQ(11, c.total); EXPECT_EQ(-11, d.total); } TEST(ObserverListTest, StdIteratorRemoveAfter) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter disrupter(&observer_list, &c); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&disrupter); observer_list.AddObserver(&c); observer_list.AddObserver(&d); for (auto& o : observer_list) o.Observe(1); for (auto& o : observer_list) o.Observe(10); EXPECT_EQ(11, a.total); EXPECT_EQ(-11, b.total); EXPECT_EQ(0, c.total); EXPECT_EQ(-11, d.total); } TEST(ObserverListTest, StdIteratorRemoveAfterFront) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter disrupter(&observer_list, &a); observer_list.AddObserver(&a); observer_list.AddObserver(&disrupter); observer_list.AddObserver(&b); observer_list.AddObserver(&c); observer_list.AddObserver(&d); for (auto& o : observer_list) o.Observe(1); for (auto& o : observer_list) o.Observe(10); EXPECT_EQ(1, a.total); EXPECT_EQ(-11, b.total); EXPECT_EQ(11, c.total); EXPECT_EQ(-11, d.total); } TEST(ObserverListTest, StdIteratorRemoveBeforeBack) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter disrupter(&observer_list, &d); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&c); observer_list.AddObserver(&disrupter); observer_list.AddObserver(&d); for (auto& o : observer_list) o.Observe(1); for (auto& o : observer_list) o.Observe(10); EXPECT_EQ(11, a.total); EXPECT_EQ(-11, b.total); EXPECT_EQ(11, c.total); EXPECT_EQ(0, d.total); } TEST(ObserverListTest, StdIteratorRemoveFront) { using FooList = ObserverList; FooList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter disrupter(&observer_list, true); observer_list.AddObserver(&disrupter); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&c); observer_list.AddObserver(&d); bool test_disruptor = true; for (FooList::iterator i = observer_list.begin(), e = observer_list.end(); i != e; ++i) { i->Observe(1); // Check that second call to i->Observe() would crash here. if (test_disruptor) { EXPECT_FALSE(i.GetCurrent()); test_disruptor = false; } } for (auto& o : observer_list) o.Observe(10); EXPECT_EQ(11, a.total); EXPECT_EQ(-11, b.total); EXPECT_EQ(11, c.total); EXPECT_EQ(-11, d.total); } TEST(ObserverListTest, StdIteratorRemoveBack) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter disrupter(&observer_list, true); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&c); observer_list.AddObserver(&d); observer_list.AddObserver(&disrupter); for (auto& o : observer_list) o.Observe(1); for (auto& o : observer_list) o.Observe(10); EXPECT_EQ(11, a.total); EXPECT_EQ(-11, b.total); EXPECT_EQ(11, c.total); EXPECT_EQ(-11, d.total); } TEST(ObserverListTest, NestedLoop) { ObserverList observer_list; Adder a(1), b(-1), c(1), d(-1); Disrupter disrupter(&observer_list, true); observer_list.AddObserver(&disrupter); observer_list.AddObserver(&a); observer_list.AddObserver(&b); observer_list.AddObserver(&c); observer_list.AddObserver(&d); for (auto& o : observer_list) { o.Observe(10); for (auto& o : observer_list) o.Observe(1); } EXPECT_EQ(15, a.total); EXPECT_EQ(-15, b.total); EXPECT_EQ(15, c.total); EXPECT_EQ(-15, d.total); } TEST(ObserverListTest, NonCompactList) { ObserverList observer_list; Adder a(1), b(-1); Disrupter disrupter1(&observer_list, true); Disrupter disrupter2(&observer_list, true); // Disrupt itself and another one. disrupter1.SetDoomed(&disrupter2); observer_list.AddObserver(&disrupter1); observer_list.AddObserver(&disrupter2); observer_list.AddObserver(&a); observer_list.AddObserver(&b); for (auto& o : observer_list) { // Get the { nullptr, nullptr, &a, &b } non-compact list // on the first inner pass. o.Observe(10); for (auto& o : observer_list) o.Observe(1); } EXPECT_EQ(13, a.total); EXPECT_EQ(-13, b.total); } TEST(ObserverListTest, BecomesEmptyThanNonEmpty) { ObserverList observer_list; Adder a(1), b(-1); Disrupter disrupter1(&observer_list, true); Disrupter disrupter2(&observer_list, true); // Disrupt itself and another one. disrupter1.SetDoomed(&disrupter2); observer_list.AddObserver(&disrupter1); observer_list.AddObserver(&disrupter2); bool add_observers = true; for (auto& o : observer_list) { // Get the { nullptr, nullptr } empty list on the first inner pass. o.Observe(10); for (auto& o : observer_list) o.Observe(1); if (add_observers) { observer_list.AddObserver(&a); observer_list.AddObserver(&b); add_observers = false; } } EXPECT_EQ(12, a.total); EXPECT_EQ(-12, b.total); } TEST(ObserverListTest, AddObserverInTheLastObserve) { using FooList = ObserverList; FooList observer_list; AddInObserve a(&observer_list); Adder b(-1); a.SetToAdd(&b); observer_list.AddObserver(&a); auto it = observer_list.begin(); while (it != observer_list.end()) { auto& observer = *it; // Intentionally increment the iterator before calling Observe(). The // ObserverList starts with only one observer, and it == observer_list.end() // should be true after the next line. ++it; // However, the first Observe() call will add a second observer: at this // point, it != observer_list.end() should be true, and Observe() should be // called on the newly added observer on the next iteration of the loop. observer.Observe(10); } EXPECT_EQ(-10, b.total); } } // namespace base