ipc/ipc_channel_nacl.h

   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 #ifndef IPC_IPC_CHANNEL_NACL_H_
   6 #define IPC_IPC_CHANNEL_NACL_H_
   7
   8 #include <deque>
   9 #include <string>
  10
  11 #include "base/memory/linked_ptr.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "base/process/process.h"
  15 #include "base/threading/simple_thread.h"
  16 #include "ipc/ipc_channel.h"
  17 #include "ipc/ipc_channel_reader.h"
  18
  19 namespace IPC {
  20
  21 // Contains the results from one call to imc_recvmsg (data and file
  22 // descriptors).
  23 struct MessageContents;
  24
  25 // Similar to the Posix version of ChannelImpl but for Native Client code.
  26 // This is somewhat different because sendmsg/recvmsg here do not follow POSIX
  27 // semantics. Instead, they are implemented by a custom embedding of
  28 // NaClDescCustom. See NaClIPCAdapter for the trusted-side implementation.
  29 //
  30 // We don't need to worry about complicated set up and READWRITE mode for
  31 // sharing handles. We also currently do not support passing file descriptors or
  32 // named pipes, and we use background threads to emulate signaling when we can
  33 // read or write without blocking.
  34 class Channel::ChannelImpl : public internal::ChannelReader {
  35  public:
  36   // Mirror methods of Channel, see ipc_channel.h for description.
  37   ChannelImpl(const IPC::ChannelHandle& channel_handle,
  38               Mode mode,
  39               Listener* listener);
  40   virtual ~ChannelImpl();
  41
  42   // Channel implementation.
  43   base::ProcessId peer_pid() const;
  44   bool Connect();
  45   void Close();
  46   bool Send(Message* message);
  47
  48   // Posted to the main thread by ReaderThreadRunner.
  49   void DidRecvMsg(scoped_ptr<MessageContents> contents);
  50   void ReadDidFail();
  51
  52  private:
  53   class ReaderThreadRunner;
  54
  55   bool CreatePipe(const IPC::ChannelHandle& channel_handle);
  56   bool ProcessOutgoingMessages();
  57   void CallOnChannelConnected();
  58
  59   // ChannelReader implementation.
  60   virtual ReadState ReadData(char* buffer,
  61                              int buffer_len,
  62                              int* bytes_read) OVERRIDE;
  63   virtual bool WillDispatchInputMessage(Message* msg) OVERRIDE;
  64   virtual bool DidEmptyInputBuffers() OVERRIDE;
  65   virtual void HandleInternalMessage(const Message& msg) OVERRIDE;
  66
  67   Mode mode_;
  68   bool waiting_connect_;
  69
  70   // The pipe used for communication.
  71   int pipe_;
  72
  73   // The "name" of our pipe.  On Windows this is the global identifier for
  74   // the pipe.  On POSIX it's used as a key in a local map of file descriptors.
  75   // For NaCl, we don't actually support looking up file descriptors by name,
  76   // and it's only used for debug information.
  77   std::string pipe_name_;
  78
  79   // We use a thread for reading, so that we can simply block on reading and
  80   // post the received data back to the main thread to be properly interleaved
  81   // with other tasks in the MessagePump.
  82   //
  83   // imc_recvmsg supports non-blocking reads, but there's no easy way to be
  84   // informed when a write or read can be done without blocking (this is handled
  85   // by libevent in Posix).
  86   scoped_ptr<ReaderThreadRunner> reader_thread_runner_;
  87   scoped_ptr<base::DelegateSimpleThread> reader_thread_;
  88
  89   // IPC::ChannelReader expects to be able to call ReadData on us to
  90   // synchronously read data waiting in the pipe's buffer without blocking.
  91   // Since we can't do that (see 1 and 2 above), the reader thread does blocking
  92   // reads and posts the data over to the main thread in MessageContents. Each
  93   // MessageContents object is the result of one call to "imc_recvmsg".
  94   // DidRecvMsg breaks the MessageContents out in to the data and the file
  95   // descriptors, and puts them on these two queues.
  96   // TODO(dmichael): There's probably a more efficient way to emulate this with
  97   //                 a circular buffer or something, so we don't have to do so
  98   //                 many heap allocations. But it maybe isn't worth
  99   //                 the trouble given that we probably want to implement 1 and
 100   //                 2 above in NaCl eventually.
 101   // When ReadData is called, it pulls the bytes out of this queue in order.
 102   std::deque<linked_ptr<std::vector<char> > > read_queue_;
 103   // Queue of file descriptors extracted from imc_recvmsg messages.
 104   // NOTE: The implementation assumes underlying storage here is contiguous, so
 105   // don't change to something like std::deque<> without changing the
 106   // implementation!
 107   std::vector<int> input_fds_;
 108
 109   // This queue is used when a message is sent prior to Connect having been
 110   // called. Normally after we're connected, the queue is empty.
 111   std::deque<linked_ptr<Message> > output_queue_;
 112
 113   base::WeakPtrFactory<ChannelImpl> weak_ptr_factory_;
 114
 115   DISALLOW_IMPLICIT_CONSTRUCTORS(ChannelImpl);
 116 };
 117
 118 }  // namespace IPC
 119
 120 #endif  // IPC_IPC_CHANNEL_NACL_H_