EDK: Add MojoHandleRights to DispatcherTransport.

mojo/edk/system/remote_message_pipe_unittest.cc

 // Copyright 2014 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 <stdint.h>
 #include <stdio.h>
 #include <string.h>
 
 #include <memory>
 #include <utility>
 #include <vector>
 
 #include "base/logging.h"
 #include "mojo/edk/embedder/simple_platform_support.h"
 #include "mojo/edk/platform/platform_handle_utils_posix.h"
 #include "mojo/edk/platform/platform_pipe.h"
 #include "mojo/edk/platform/platform_shared_buffer.h"
 #include "mojo/edk/platform/scoped_platform_handle.h"
 #include "mojo/edk/platform/thread_utils.h"
 #include "mojo/edk/system/channel.h"
 #include "mojo/edk/system/channel_endpoint.h"
 #include "mojo/edk/system/channel_endpoint_id.h"
+#include "mojo/edk/system/handle.h"
 #include "mojo/edk/system/handle_transport.h"
 #include "mojo/edk/system/incoming_endpoint.h"
 #include "mojo/edk/system/message_pipe.h"
 #include "mojo/edk/system/message_pipe_dispatcher.h"
 #include "mojo/edk/system/platform_handle_dispatcher.h"
 #include "mojo/edk/system/raw_channel.h"
 #include "mojo/edk/system/shared_buffer_dispatcher.h"
 #include "mojo/edk/system/test/scoped_test_dir.h"
 #include "mojo/edk/system/test/test_io_thread.h"
 #include "mojo/edk/system/test/timeouts.h"
@@ skipping 586 matching lines @@
   auto mp0 = MessagePipe::CreateLocalProxy(&ep0);
   RefPtr<ChannelEndpoint> ep1;
   auto mp1 = MessagePipe::CreateProxyLocal(&ep1);
   BootstrapChannelEndpoints(std::move(ep0), std::move(ep1));
 
   // We'll try to pass this dispatcher.
   auto dispatcher = MessagePipeDispatcher::Create(
       MessagePipeDispatcher::kDefaultCreateOptions);
   auto local_mp = MessagePipe::CreateLocalLocal();
   dispatcher->Init(local_mp.Clone(), 0);
+  Handle handle(std::move(dispatcher), MOJO_HANDLE_RIGHT_TRANSFER |
+                                           MOJO_HANDLE_RIGHT_READ |
+                                           MOJO_HANDLE_RIGHT_WRITE);
 
   // Prepare to wait on MP 1, port 1. (Add the waiter now. Otherwise, if we do
   // it later, it might already be readable.)
   waiter.Init();
   ASSERT_EQ(
       MOJO_RESULT_OK,
       mp1->AddAwakable(1, &waiter, MOJO_HANDLE_SIGNAL_READABLE, 123, nullptr));
 
   // Write to MP 0, port 0.
   {
-    DispatcherTransport transport(
-        test::DispatcherTryStartTransport(dispatcher.get()));
+    DispatcherTransport transport(test::HandleTryStartTransport(handle));
     EXPECT_TRUE(transport.is_valid());
 
     std::vector<DispatcherTransport> transports;
     transports.push_back(transport);
     EXPECT_EQ(
         MOJO_RESULT_OK,
         mp0->WriteMessage(0, UserPointer<const void>(kHello), sizeof(kHello),
                           &transports, MOJO_WRITE_MESSAGE_FLAG_NONE));
     transport.End();
 
-    // |dispatcher| should have been closed. This is |DCHECK()|ed when the
-    // |dispatcher| is destroyed.
-    EXPECT_TRUE(dispatcher->HasOneRef());
-    dispatcher = nullptr;
+    // |handle.dispatcher| should have been closed. This is |DCHECK()|ed when
+    // the |handle.dispatcher| is destroyed.
+    EXPECT_TRUE(handle.dispatcher->HasOneRef());
+    handle.reset();
   }
 
   // Wait.
   EXPECT_EQ(MOJO_RESULT_OK, waiter.Wait(MOJO_DEADLINE_INDEFINITE, &context));
   EXPECT_EQ(123u, context);
   hss = HandleSignalsState();
   mp1->RemoveAwakable(1, &waiter, &hss);
   EXPECT_EQ(MOJO_HANDLE_SIGNAL_READABLE | MOJO_HANDLE_SIGNAL_WRITABLE,
             hss.satisfied_signals);
   EXPECT_EQ(kAllSignals, hss.satisfiable_signals);
@@ skipping 99 matching lines @@
   static const char kWorld[] = "world!";
   Waiter waiter;
   HandleSignalsState hss;
   uint32_t context = 0;
 
   // We'll try to pass this dispatcher.
   auto dispatcher = MessagePipeDispatcher::Create(
       MessagePipeDispatcher::kDefaultCreateOptions);
   auto local_mp = MessagePipe::CreateLocalLocal();
   dispatcher->Init(local_mp.Clone(), 0);
+  Handle handle(std::move(dispatcher), MOJO_HANDLE_RIGHT_TRANSFER |
+                                           MOJO_HANDLE_RIGHT_READ |
+                                           MOJO_HANDLE_RIGHT_WRITE);
 
   hss = local_mp->GetHandleSignalsState(0);
   EXPECT_EQ(MOJO_HANDLE_SIGNAL_WRITABLE, hss.satisfied_signals);
   EXPECT_EQ(kAllSignals, hss.satisfiable_signals);
   // Write to the other end (|local_mp|, port 1), and then close it.
   EXPECT_EQ(
       MOJO_RESULT_OK,
       local_mp->WriteMessage(1, UserPointer<const void>(kHello), sizeof(kHello),
                              nullptr, MOJO_WRITE_MESSAGE_FLAG_NONE));
   hss = local_mp->GetHandleSignalsState(0);
@@ skipping 20 matching lines @@
 
   // Prepare to wait on MP 1, port 1. (Add the waiter now. Otherwise, if we do
   // it later, it might already be readable.)
   waiter.Init();
   ASSERT_EQ(
       MOJO_RESULT_OK,
       mp1->AddAwakable(1, &waiter, MOJO_HANDLE_SIGNAL_READABLE, 123, nullptr));
 
   // Write to MP 0, port 0.
   {
-    DispatcherTransport transport(
-        test::DispatcherTryStartTransport(dispatcher.get()));
+    DispatcherTransport transport(test::HandleTryStartTransport(handle));
     EXPECT_TRUE(transport.is_valid());
 
     std::vector<DispatcherTransport> transports;
     transports.push_back(transport);
     EXPECT_EQ(
         MOJO_RESULT_OK,
         mp0->WriteMessage(0, UserPointer<const void>(kHello), sizeof(kHello),
                           &transports, MOJO_WRITE_MESSAGE_FLAG_NONE));
     transport.End();
 
-    // |dispatcher| should have been closed. This is |DCHECK()|ed when the
-    // |dispatcher| is destroyed.
-    EXPECT_TRUE(dispatcher->HasOneRef());
-    dispatcher = nullptr;
+    // |handle.dispatcher| should have been closed. This is |DCHECK()|ed when
+    // the |handle.dispatcher| is destroyed.
+    EXPECT_TRUE(handle.dispatcher->HasOneRef());
+    handle.reset();
   }
 
   // Wait.
   EXPECT_EQ(MOJO_RESULT_OK, waiter.Wait(MOJO_DEADLINE_INDEFINITE, &context));
   EXPECT_EQ(123u, context);
   hss = HandleSignalsState();
   mp1->RemoveAwakable(1, &waiter, &hss);
   EXPECT_EQ(MOJO_HANDLE_SIGNAL_READABLE | MOJO_HANDLE_SIGNAL_WRITABLE,
             hss.satisfied_signals);
   EXPECT_EQ(kAllSignals, hss.satisfiable_signals);
@@ skipping 72 matching lines @@
   auto mp1 = MessagePipe::CreateProxyLocal(&ep1);
   BootstrapChannelEndpoints(std::move(ep0), std::move(ep1));
 
   // We'll try to pass this dispatcher.
   MojoResult result = MOJO_RESULT_INTERNAL;
   auto dispatcher = SharedBufferDispatcher::Create(
       platform_support(), SharedBufferDispatcher::kDefaultCreateOptions, 100,
       &result);
   EXPECT_EQ(MOJO_RESULT_OK, result);
   ASSERT_TRUE(dispatcher);
+  Handle handle(std::move(dispatcher),
+                MOJO_HANDLE_RIGHT_DUPLICATE | MOJO_HANDLE_RIGHT_TRANSFER |
+                    MOJO_HANDLE_RIGHT_READ | MOJO_HANDLE_RIGHT_WRITE);
 
   // Make a mapping.
   std::unique_ptr<PlatformSharedBufferMapping> mapping0;
-  EXPECT_EQ(MOJO_RESULT_OK, dispatcher->MapBuffer(
+  EXPECT_EQ(MOJO_RESULT_OK, handle.dispatcher->MapBuffer(
                                 0, 100, MOJO_MAP_BUFFER_FLAG_NONE, &mapping0));
   ASSERT_TRUE(mapping0);
   ASSERT_TRUE(mapping0->GetBase());
   ASSERT_EQ(100u, mapping0->GetLength());
   static_cast<char*>(mapping0->GetBase())[0] = 'A';
   static_cast<char*>(mapping0->GetBase())[50] = 'B';
   static_cast<char*>(mapping0->GetBase())[99] = 'C';
 
   // Prepare to wait on MP 1, port 1. (Add the waiter now. Otherwise, if we do
   // it later, it might already be readable.)
   waiter.Init();
   ASSERT_EQ(
       MOJO_RESULT_OK,
       mp1->AddAwakable(1, &waiter, MOJO_HANDLE_SIGNAL_READABLE, 123, nullptr));
 
   // Write to MP 0, port 0.
   {
-    DispatcherTransport transport(
-        test::DispatcherTryStartTransport(dispatcher.get()));
+    DispatcherTransport transport(test::HandleTryStartTransport(handle));
     EXPECT_TRUE(transport.is_valid());
 
     std::vector<DispatcherTransport> transports;
     transports.push_back(transport);
     EXPECT_EQ(
         MOJO_RESULT_OK,
         mp0->WriteMessage(0, UserPointer<const void>(kHello), sizeof(kHello),
                           &transports, MOJO_WRITE_MESSAGE_FLAG_NONE));
     transport.End();
 
-    // |dispatcher| should have been closed. This is |DCHECK()|ed when the
-    // |dispatcher| is destroyed.
-    EXPECT_TRUE(dispatcher->HasOneRef());
-    dispatcher = nullptr;
+    // |handle.dispatcher| should have been closed. This is |DCHECK()|ed when
+    // the |handle.dispatcher| is destroyed.
+    EXPECT_TRUE(handle.dispatcher->HasOneRef());
+    handle.reset();
   }
 
   // Wait.
   EXPECT_EQ(MOJO_RESULT_OK, waiter.Wait(MOJO_DEADLINE_INDEFINITE, &context));
   EXPECT_EQ(123u, context);
   hss = HandleSignalsState();
   mp1->RemoveAwakable(1, &waiter, &hss);
   EXPECT_EQ(MOJO_HANDLE_SIGNAL_READABLE | MOJO_HANDLE_SIGNAL_WRITABLE,
             hss.satisfied_signals);
   EXPECT_EQ(kAllSignals, hss.satisfiable_signals);
@@ skipping 64 matching lines @@
   RefPtr<ChannelEndpoint> ep1;
   auto mp1 = MessagePipe::CreateProxyLocal(&ep1);
   BootstrapChannelEndpoints(std::move(ep0), std::move(ep1));
 
   util::ScopedFILE fp(test_dir.CreateFile());
   EXPECT_EQ(sizeof(kHello), fwrite(kHello, 1, sizeof(kHello), fp.get()));
   // We'll try to pass this dispatcher, which will cause a |PlatformHandle| to
   // be passed.
   auto dispatcher =
       PlatformHandleDispatcher::Create(PlatformHandleFromFILE(std::move(fp)));
+  // TODO(vtl): Are these the correct rights for a |PlatformHandleDispatcher|?
+  Handle handle(std::move(dispatcher), MOJO_HANDLE_RIGHT_TRANSFER |
+                                           MOJO_HANDLE_RIGHT_READ |
+                                           MOJO_HANDLE_RIGHT_WRITE);
 
   // Prepare to wait on MP 1, port 1. (Add the waiter now. Otherwise, if we do
   // it later, it might already be readable.)
   waiter.Init();
   ASSERT_EQ(
       MOJO_RESULT_OK,
       mp1->AddAwakable(1, &waiter, MOJO_HANDLE_SIGNAL_READABLE, 123, nullptr));
 
   // Write to MP 0, port 0.
   {
-    DispatcherTransport transport(
-        test::DispatcherTryStartTransport(dispatcher.get()));
+    DispatcherTransport transport(test::HandleTryStartTransport(handle));
     EXPECT_TRUE(transport.is_valid());
 
     std::vector<DispatcherTransport> transports;
     transports.push_back(transport);
     EXPECT_EQ(
         MOJO_RESULT_OK,
         mp0->WriteMessage(0, UserPointer<const void>(kWorld), sizeof(kWorld),
                           &transports, MOJO_WRITE_MESSAGE_FLAG_NONE));
     transport.End();
 
-    // |dispatcher| should have been closed. This is |DCHECK()|ed when the
-    // |dispatcher| is destroyed.
-    EXPECT_TRUE(dispatcher->HasOneRef());
-    dispatcher = nullptr;
+    // |handle.dispatcher| should have been closed. This is |DCHECK()|ed when
+    // the |handle.dispatcher| is destroyed.
+    EXPECT_TRUE(handle.dispatcher->HasOneRef());
+    handle.reset();
   }
 
   // Wait.
   EXPECT_EQ(MOJO_RESULT_OK, waiter.Wait(MOJO_DEADLINE_INDEFINITE, &context));
   EXPECT_EQ(123u, context);
   hss = HandleSignalsState();
   mp1->RemoveAwakable(1, &waiter, &hss);
   EXPECT_EQ(MOJO_HANDLE_SIGNAL_READABLE | MOJO_HANDLE_SIGNAL_WRITABLE,
             hss.satisfied_signals);
   EXPECT_EQ(kAllSignals, hss.satisfiable_signals);
@@ skipping 89 matching lines @@
   auto mp0 = MessagePipe::CreateLocalProxy(&ep0);
   RefPtr<ChannelEndpoint> ep1;
   auto mp1 = MessagePipe::CreateProxyLocal(&ep1);
   BootstrapChannelEndpoints(std::move(ep0), std::move(ep1));
 
   // We'll try to pass this dispatcher.
   auto dispatcher = MessagePipeDispatcher::Create(
       MessagePipeDispatcher::kDefaultCreateOptions);
   auto local_mp = MessagePipe::CreateLocalLocal();
   dispatcher->Init(local_mp.Clone(), 0);
+  Handle handle(std::move(dispatcher), MOJO_HANDLE_RIGHT_TRANSFER |
+                                           MOJO_HANDLE_RIGHT_READ |
+                                           MOJO_HANDLE_RIGHT_WRITE);
 
   // Prepare to wait on MP 1, port 1. (Add the waiter now. Otherwise, if we do
   // it later, it might already be readable.)
   waiter.Init();
   ASSERT_EQ(
       MOJO_RESULT_OK,
       mp1->AddAwakable(1, &waiter, MOJO_HANDLE_SIGNAL_READABLE, 123, nullptr));
 
   // Write to MP 0, port 0.
   {
-    DispatcherTransport transport(
-        test::DispatcherTryStartTransport(dispatcher.get()));
+    DispatcherTransport transport(test::HandleTryStartTransport(handle));
     EXPECT_TRUE(transport.is_valid());
 
     std::vector<DispatcherTransport> transports;
     transports.push_back(transport);
     EXPECT_EQ(
         MOJO_RESULT_OK,
         mp0->WriteMessage(0, UserPointer<const void>(kHello), sizeof(kHello),
                           &transports, MOJO_WRITE_MESSAGE_FLAG_NONE));
     transport.End();
 
-    // |dispatcher| should have been closed. This is |DCHECK()|ed when the
-    // |dispatcher| is destroyed.
-    EXPECT_TRUE(dispatcher->HasOneRef());
-    dispatcher = nullptr;
+    // |handle.dispatcher| should have been closed. This is |DCHECK()|ed when
+    // the |handle.dispatcher| is destroyed.
+    EXPECT_TRUE(handle.dispatcher->HasOneRef());
+    handle.reset();
   }
 
   // Wait.
   EXPECT_EQ(MOJO_RESULT_OK, waiter.Wait(MOJO_DEADLINE_INDEFINITE, &context));
   EXPECT_EQ(123u, context);
   hss = HandleSignalsState();
   mp1->RemoveAwakable(1, &waiter, &hss);
   EXPECT_EQ(MOJO_HANDLE_SIGNAL_READABLE | MOJO_HANDLE_SIGNAL_WRITABLE,
             hss.satisfied_signals);
   EXPECT_EQ(kAllSignals, hss.satisfiable_signals);
@@ skipping 12 matching lines @@
   EXPECT_STREQ(kHello, read_buffer);
   EXPECT_EQ(1u, read_dispatchers.size());
   EXPECT_EQ(1u, read_num_dispatchers);
   ASSERT_TRUE(read_dispatchers[0]);
   EXPECT_TRUE(read_dispatchers[0]->HasOneRef());
 
   EXPECT_EQ(Dispatcher::Type::MESSAGE_PIPE, read_dispatchers[0]->GetType());
   dispatcher = RefPtr<MessagePipeDispatcher>(
       static_cast<MessagePipeDispatcher*>(read_dispatchers[0].get()));
   read_dispatchers.clear();
+  // TODO(vtl): We should really get |handle| from |ReadMessage()|.
+  handle = Handle(std::move(dispatcher), MOJO_HANDLE_RIGHT_TRANSFER |
+                                             MOJO_HANDLE_RIGHT_READ |
+                                             MOJO_HANDLE_RIGHT_WRITE);
 
   // Now pass it back.
 
   // Prepare to wait on MP 0, port 0. (Add the waiter now. Otherwise, if we do
   // it later, it might already be readable.)
   waiter.Init();
   ASSERT_EQ(
       MOJO_RESULT_OK,
       mp0->AddAwakable(0, &waiter, MOJO_HANDLE_SIGNAL_READABLE, 456, nullptr));
 
   // Write to MP 1, port 1.
   {
-    DispatcherTransport transport(
-        test::DispatcherTryStartTransport(dispatcher.get()));
+    DispatcherTransport transport(test::HandleTryStartTransport(handle));
     EXPECT_TRUE(transport.is_valid());
 
     std::vector<DispatcherTransport> transports;
     transports.push_back(transport);
     EXPECT_EQ(
         MOJO_RESULT_OK,
         mp1->WriteMessage(1, UserPointer<const void>(kWorld), sizeof(kWorld),
                           &transports, MOJO_WRITE_MESSAGE_FLAG_NONE));
     transport.End();
 
-    // |dispatcher| should have been closed. This is |DCHECK()|ed when the
-    // |dispatcher| is destroyed.
-    EXPECT_TRUE(dispatcher->HasOneRef());
-    dispatcher = nullptr;
+    // |handle.dispatcher| should have been closed. This is |DCHECK()|ed when
+    // the |handle.dispatcher| is destroyed.
+    EXPECT_TRUE(handle.dispatcher->HasOneRef());
+    handle.reset();
   }
 
   // Wait.
   EXPECT_EQ(MOJO_RESULT_OK, waiter.Wait(MOJO_DEADLINE_INDEFINITE, &context));
   EXPECT_EQ(456u, context);
   hss = HandleSignalsState();
   mp0->RemoveAwakable(0, &waiter, &hss);
   EXPECT_EQ(MOJO_HANDLE_SIGNAL_READABLE | MOJO_HANDLE_SIGNAL_WRITABLE,
             hss.satisfied_signals);
   EXPECT_EQ(kAllSignals, hss.satisfiable_signals);
@@ skipping 86 matching lines @@
   mp0->Close(0);
   mp1->Close(1);
   EXPECT_EQ(MOJO_RESULT_OK, dispatcher->Close());
   // Note that |local_mp|'s port 0 belong to |dispatcher|, which was closed.
   local_mp->Close(1);
 }
 
 }  // namespace
 }  // namespace system
 }  // namespace mojo