Plumb the handle signals state out of Waiter::Wait().

mojo/edk/system/waiter_unittest.cc

 // Copyright 2013 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.
 
 // NOTE(vtl): Some of these tests are inherently flaky (e.g., if run on a
 // heavily-loaded system). Sorry. |test::EpsilonTimeout()| may be increased to
 // increase tolerance and reduce observed flakiness (though doing so reduces the
 // meaningfulness of the test).
 
 #include "mojo/edk/system/waiter.h"
@@ skipping 26 matching lines @@
         done_(false),
         result_(MOJO_RESULT_UNKNOWN),
         context_(static_cast<uint64_t>(-1)) {
     waiter_.Init();
   }
 
   ~WaitingThread() override { Join(); }
 
   void WaitUntilDone(MojoResult* result,
                      uint64_t* context,
+                     HandleSignalsState* signals_state,
                      MojoDeadline* elapsed) {
     for (;;) {
       {
         MutexLocker locker(&mutex_);
         if (done_) {
           *result = result_;
           *context = context_;
+          *signals_state = signals_state_;
           *elapsed = elapsed_;
           break;
         }
       }
 
       ThreadSleep(test::DeadlineFromMilliseconds(kPollTimeMs));
     }
   }
 
   Waiter* waiter() { return &waiter_; }
 
  private:
   void Run() override {
     Stopwatch stopwatch;
     MojoResult result;
     uint64_t context = static_cast<uint64_t>(-1);
+    HandleSignalsState signals_state;
     MojoDeadline elapsed;
 
     stopwatch.Start();
-    result = waiter_.Wait(deadline_, &context);
+    result = waiter_.Wait(deadline_, &context, &signals_state);
     elapsed = stopwatch.Elapsed();
 
     {
       MutexLocker locker(&mutex_);
       done_ = true;
       result_ = result;
       context_ = context;
+      signals_state_ = signals_state;
       elapsed_ = elapsed;
     }
   }
 
   const MojoDeadline deadline_;
   Waiter waiter_;  // Thread-safe.
 
   Mutex mutex_;
   bool done_ MOJO_GUARDED_BY(mutex_);
   MojoResult result_ MOJO_GUARDED_BY(mutex_);
   uint64_t context_ MOJO_GUARDED_BY(mutex_);
+  HandleSignalsState signals_state_ MOJO_GUARDED_BY(mutex_);
   MojoDeadline elapsed_ MOJO_GUARDED_BY(mutex_);
 
   MOJO_DISALLOW_COPY_AND_ASSIGN(WaitingThread);
 };
 
 TEST(WaiterTest, Basic) {
   MojoResult result;
   uint64_t context;
+  HandleSignalsState hss;
   MojoDeadline elapsed;
 
   // Finite deadline.
 
   // Awake immediately after thread start.
   {
     WaitingThread thread(10 * test::EpsilonTimeout());
     thread.Start();
     thread.waiter()->Awake(1, Awakable::AwakeReason::SATISFIED,
-                           HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE));
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_OK, result);
     EXPECT_EQ(1u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE)));
     EXPECT_LT(elapsed, test::EpsilonTimeout());
   }
 
   // Awake before after thread start.
   {
     WaitingThread thread(10 * test::EpsilonTimeout());
     thread.waiter()->Awake(2, Awakable::AwakeReason::CANCELLED,
-                           HandleSignalsState());
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_NONE,
+                                              MOJO_HANDLE_SIGNAL_WRITABLE));
     thread.Start();
-    thread.WaitUntilDone(&result, &context, &elapsed);
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_CANCELLED, result);
     EXPECT_EQ(2u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState(MOJO_HANDLE_SIGNAL_NONE,
+                                              MOJO_HANDLE_SIGNAL_WRITABLE)));
     EXPECT_LT(elapsed, test::EpsilonTimeout());
   }
 
   // Awake some time after thread start.
   {
     WaitingThread thread(10 * test::EpsilonTimeout());
     thread.Start();
     ThreadSleep(2 * test::EpsilonTimeout());
     thread.waiter()->Awake(3, Awakable::AwakeReason::SATISFIED,
-                           HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE |
+                                                  MOJO_HANDLE_SIGNAL_WRITABLE));
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_OK, result);
     EXPECT_EQ(3u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState(
+        MOJO_HANDLE_SIGNAL_READABLE,
+        MOJO_HANDLE_SIGNAL_READABLE | MOJO_HANDLE_SIGNAL_WRITABLE)));
     EXPECT_GT(elapsed, (2 - 1) * test::EpsilonTimeout());
     EXPECT_LT(elapsed, (2 + 1) * test::EpsilonTimeout());
   }
 
   // Awake some longer time after thread start.
   {
     WaitingThread thread(10 * test::EpsilonTimeout());
     thread.Start();
     ThreadSleep(5 * test::EpsilonTimeout());
     thread.waiter()->Awake(4, Awakable::AwakeReason::UNSATISFIABLE,
                            HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_FAILED_PRECONDITION, result);
     EXPECT_EQ(4u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState()));
     EXPECT_GT(elapsed, (5 - 1) * test::EpsilonTimeout());
     EXPECT_LT(elapsed, (5 + 1) * test::EpsilonTimeout());
   }
 
   // Don't awake -- time out (on another thread).
   {
     WaitingThread thread(2 * test::EpsilonTimeout());
     thread.Start();
-    thread.WaitUntilDone(&result, &context, &elapsed);
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_DEADLINE_EXCEEDED, result);
     EXPECT_EQ(static_cast<uint64_t>(-1), context);
     EXPECT_GT(elapsed, (2 - 1) * test::EpsilonTimeout());
     EXPECT_LT(elapsed, (2 + 1) * test::EpsilonTimeout());
   }
 
   // No (indefinite) deadline.
 
   // Awake immediately after thread start.
   {
     WaitingThread thread(MOJO_DEADLINE_INDEFINITE);
     thread.Start();
     thread.waiter()->Awake(5, Awakable::AwakeReason::SATISFIED,
-                           HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE));
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_OK, result);
     EXPECT_EQ(5u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE)));
     EXPECT_LT(elapsed, test::EpsilonTimeout());
   }
 
   // Awake before after thread start.
   {
     WaitingThread thread(MOJO_DEADLINE_INDEFINITE);
     thread.waiter()->Awake(6, Awakable::AwakeReason::CANCELLED,
                            HandleSignalsState());
     thread.Start();
-    thread.WaitUntilDone(&result, &context, &elapsed);
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_CANCELLED, result);
     EXPECT_EQ(6u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState()));
     EXPECT_LT(elapsed, test::EpsilonTimeout());
   }
 
   // Awake some time after thread start.
   {
     WaitingThread thread(MOJO_DEADLINE_INDEFINITE);
     thread.Start();
     ThreadSleep(2 * test::EpsilonTimeout());
     thread.waiter()->Awake(7, Awakable::AwakeReason::UNSATISFIABLE,
-                           HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_NONE,
+                                              MOJO_HANDLE_SIGNAL_WRITABLE));
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_FAILED_PRECONDITION, result);
     EXPECT_EQ(7u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState(MOJO_HANDLE_SIGNAL_NONE,
+                                              MOJO_HANDLE_SIGNAL_WRITABLE)));
     EXPECT_GT(elapsed, (2 - 1) * test::EpsilonTimeout());
     EXPECT_LT(elapsed, (2 + 1) * test::EpsilonTimeout());
   }
 
   // Awake some longer time after thread start.
   {
     WaitingThread thread(MOJO_DEADLINE_INDEFINITE);
     thread.Start();
     ThreadSleep(5 * test::EpsilonTimeout());
     thread.waiter()->Awake(8, Awakable::AwakeReason::CANCELLED,
-                           HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE));
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_CANCELLED, result);
     EXPECT_EQ(8u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE)));
     EXPECT_GT(elapsed, (5 - 1) * test::EpsilonTimeout());
     EXPECT_LT(elapsed, (5 + 1) * test::EpsilonTimeout());
   }
 }
 
 TEST(WaiterTest, TimeOut) {
   Stopwatch stopwatch;
   MojoDeadline elapsed;
 
   Waiter waiter;
   uint64_t context = 123;
 
   waiter.Init();
   stopwatch.Start();
-  EXPECT_EQ(MOJO_RESULT_DEADLINE_EXCEEDED, waiter.Wait(0, &context));
+  EXPECT_EQ(MOJO_RESULT_DEADLINE_EXCEEDED, waiter.Wait(0, &context, nullptr));
   elapsed = stopwatch.Elapsed();
   EXPECT_LT(elapsed, test::EpsilonTimeout());
   EXPECT_EQ(123u, context);
 
   waiter.Init();
   stopwatch.Start();
   EXPECT_EQ(MOJO_RESULT_DEADLINE_EXCEEDED,
-            waiter.Wait(2 * test::EpsilonTimeout(), &context));
+            waiter.Wait(2 * test::EpsilonTimeout(), &context, nullptr));
   elapsed = stopwatch.Elapsed();
   EXPECT_GT(elapsed, (2 - 1) * test::EpsilonTimeout());
   EXPECT_LT(elapsed, (2 + 1) * test::EpsilonTimeout());
   EXPECT_EQ(123u, context);
 
   waiter.Init();
   stopwatch.Start();
   EXPECT_EQ(MOJO_RESULT_DEADLINE_EXCEEDED,
-            waiter.Wait(5 * test::EpsilonTimeout(), &context));
+            waiter.Wait(5 * test::EpsilonTimeout(), &context, nullptr));
   elapsed = stopwatch.Elapsed();
   EXPECT_GT(elapsed, (5 - 1) * test::EpsilonTimeout());
   EXPECT_LT(elapsed, (5 + 1) * test::EpsilonTimeout());
   EXPECT_EQ(123u, context);
 }
 
 // The first |Awake()| should always win.
 TEST(WaiterTest, MultipleAwakes) {
   MojoResult result;
   uint64_t context;
+  HandleSignalsState hss;
   MojoDeadline elapsed;
 
   {
     WaitingThread thread(MOJO_DEADLINE_INDEFINITE);
     thread.Start();
     thread.waiter()->Awake(1, Awakable::AwakeReason::SATISFIED,
-                           HandleSignalsState());
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE));
     thread.waiter()->Awake(2, Awakable::AwakeReason::UNSATISFIABLE,
                            HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_OK, result);
     EXPECT_EQ(1u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE)));
     EXPECT_LT(elapsed, test::EpsilonTimeout());
   }
 
   {
     WaitingThread thread(MOJO_DEADLINE_INDEFINITE);
     thread.waiter()->Awake(3, Awakable::AwakeReason::UNSATISFIABLE,
                            HandleSignalsState());
     thread.Start();
     thread.waiter()->Awake(4, Awakable::AwakeReason::SATISFIED,
-                           HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE));
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_FAILED_PRECONDITION, result);
     EXPECT_EQ(3u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState()));
     EXPECT_LT(elapsed, test::EpsilonTimeout());
   }
 
   {
     WaitingThread thread(MOJO_DEADLINE_INDEFINITE);
     thread.Start();
     thread.waiter()->Awake(5, Awakable::AwakeReason::CANCELLED,
                            HandleSignalsState());
     ThreadSleep(2 * test::EpsilonTimeout());
     thread.waiter()->Awake(6, Awakable::AwakeReason::UNSATISFIABLE,
-                           HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE));
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_CANCELLED, result);
     EXPECT_EQ(5u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState()));
     EXPECT_LT(elapsed, test::EpsilonTimeout());
   }
 
   {
     WaitingThread thread(10 * test::EpsilonTimeout());
     thread.Start();
     ThreadSleep(1 * test::EpsilonTimeout());
     thread.waiter()->Awake(7, Awakable::AwakeReason::UNSATISFIABLE,
                            HandleSignalsState());
     ThreadSleep(2 * test::EpsilonTimeout());
     thread.waiter()->Awake(8, Awakable::AwakeReason::SATISFIED,
-                           HandleSignalsState());
-    thread.WaitUntilDone(&result, &context, &elapsed);
+                           HandleSignalsState(MOJO_HANDLE_SIGNAL_READABLE,
+                                              MOJO_HANDLE_SIGNAL_READABLE));
+    thread.WaitUntilDone(&result, &context, &hss, &elapsed);
     EXPECT_EQ(MOJO_RESULT_FAILED_PRECONDITION, result);
     EXPECT_EQ(7u, context);
+    EXPECT_TRUE(hss.equals(HandleSignalsState()));
     EXPECT_GT(elapsed, (1 - 1) * test::EpsilonTimeout());
     EXPECT_LT(elapsed, (1 + 1) * test::EpsilonTimeout());
   }
 }
 
 }  // namespace
 }  // namespace system
 }  // namespace mojo