Factor out the shared parts of IPC channel reading.

ipc/ipc_channel_posix.h

 // 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.
 
 #ifndef IPC_IPC_CHANNEL_POSIX_H_
 #define IPC_IPC_CHANNEL_POSIX_H_
 #pragma once
 
 #include "ipc/ipc_channel.h"
 
 #include <sys/socket.h>  // for CMSG macros
 
 #include <queue>
 #include <string>
 #include <vector>
 
 #include "base/message_loop.h"
 #include "ipc/file_descriptor_set_posix.h"
+#include "ipc/ipc_channel_reader.h"
 
 #if !defined(OS_MACOSX)
 // On Linux, the seccomp sandbox makes it very expensive to call
 // recvmsg() and sendmsg(). The restriction on calling read() and write(), which
 // are cheap, is that we can't pass file descriptors over them.
 //
 // As we cannot anticipate when the sender will provide us with file
 // descriptors, we have to make the decision about whether we call read() or
 // recvmsg() before we actually make the call. The easiest option is to
 // create a dedicated socketpair() for exchanging file descriptors. Any file
@@ skipping 11 matching lines @@
 // this switch 'on' on the Mac as well.
 //
 // The HELLO message from the client to the server is always sent using
 // sendmsg because it will contain the file descriptor that the server
 // needs to send file descriptors in later messages.
 #define IPC_USES_READWRITE 1
 #endif
 
 namespace IPC {
 
-class Channel::ChannelImpl : public MessageLoopForIO::Watcher {
+class Channel::ChannelImpl : public internal::ChannelReader,
+                             public MessageLoopForIO::Watcher {
  public:
   // Mirror methods of Channel, see ipc_channel.h for description.
   ChannelImpl(const IPC::ChannelHandle& channel_handle, Mode mode,
               Listener* listener);
   virtual ~ChannelImpl();
   bool Connect();
   void Close();
-  void set_listener(Listener* listener) { listener_ = listener; }
   bool Send(Message* message);
   int GetClientFileDescriptor();
   int TakeClientFileDescriptor();
   void CloseClientFileDescriptor();
   bool AcceptsConnections() const;
   bool HasAcceptedConnection() const;
   bool GetClientEuid(uid_t* client_euid) const;
   void ResetToAcceptingConnectionState();
   static bool IsNamedServerInitialized(const std::string& channel_id);
 #if defined(OS_LINUX)
   static void SetGlobalPid(int pid);
 #endif  // OS_LINUX
 
  private:
-  enum ReadState { READ_SUCCEEDED, READ_FAILED, READ_PENDING };
-
   bool CreatePipe(const IPC::ChannelHandle& channel_handle);
 
-  bool ProcessIncomingMessages();
   bool ProcessOutgoingMessages();
 
   bool AcceptConnection();
   void ClosePipeOnError();
   int GetHelloMessageProcId();
   void QueueHelloMessage();
-  bool IsHelloMessage(const Message* m) const;
 
-  // Populates the given buffer with data from the pipe.
-  //
-  // Returns the state of the read. On READ_SUCCESS, the number of bytes
-  // read will be placed into |*bytes_read| (which can be less than the
-  // buffer size). On READ_FAILED, the channel will be closed.
-  //
-  // If the return value is READ_PENDING, it means that there was no data
-  // ready for reading. The implementation is then responsible for either
-  // calling AsyncReadComplete with the number of bytes read into the
-  // buffer, or ProcessIncomingMessages to try the read again (depending
-  // on whether the platform's async I/O is "try again" or "write
-  // asynchronously into your buffer").
-  ReadState ReadData(char* buffer, int buffer_len, int* bytes_read);
-
-  // Takes the given data received from the IPC channel and dispatches any
-  // fully completed messages.
-  //
-  // Returns true on success. False means channel error.
-  bool DispatchInputData(const char* input_data, int input_data_len);
+  // ChannelReader implementation.
+  virtual ReadState ReadData(char* buffer,
+                             int buffer_len,
+                             int* bytes_read) OVERRIDE;
+  virtual bool WillDispatchInputMessage(Message* msg) OVERRIDE;
+  virtual bool DidEmptyInputBuffers() OVERRIDE;
+  virtual void HandleHelloMessage(const Message& msg) OVERRIDE;
 
 #if defined(IPC_USES_READWRITE)
   // Reads the next message from the fd_pipe_ and appends them to the
   // input_fds_ queue. Returns false if there was a message receiving error.
   // True means there was a message and it was processed properly, or there was
   // no messages.
   bool ReadFileDescriptorsFromFDPipe();
 #endif
 
-  // Loads the required file desciptors into the given message. Returns true
-  // on success. False means a fatal channel error.
-  //
-  // This will read from the input_fds_ and read more handles from the FD
-  // pipe if necessary.
-  bool WillDispatchInputMessage(Message* msg);
-
-  // Performs post-dispatch checks. Called when all input buffers are empty,
-  // though there could be more data ready to be read from the OS.
-  bool DidEmptyInputBuffers();
-
   // Finds the set of file descriptors in the given message.  On success,
   // appends the descriptors to the input_fds_ member and returns true
   //
   // Returns false if the message was truncated. In this case, any handles that
   // were sent will be closed.
   bool ExtractFileDescriptorsFromMsghdr(msghdr* msg);
 
   // Closes all handles in the input_fds_ list and clears the list. This is
   // used to clean up handles in error conditions to avoid leaking the handles.
   void ClearInputFDs();
 
-  // Handles the first message sent over the pipe which contains setup info.
-  void HandleHelloMessage(const Message& msg);
-
   // MessageLoopForIO::Watcher implementation.
   virtual void OnFileCanReadWithoutBlocking(int fd) OVERRIDE;
   virtual void OnFileCanWriteWithoutBlocking(int fd) OVERRIDE;
 
   Mode mode_;
 
   // After accepting one client connection on our server socket we want to
   // stop listening.
   MessageLoopForIO::FileDescriptorWatcher server_listen_connection_watcher_;
   MessageLoopForIO::FileDescriptorWatcher read_watcher_;
@@ skipping 22 matching lines @@
 #if defined(IPC_USES_READWRITE)
   // Linux/BSD use a dedicated socketpair() for passing file descriptors.
   int fd_pipe_;
   int remote_fd_pipe_;
 #endif
 
   // The "name" of our pipe.  On Windows this is the global identifier for
   // the pipe.  On POSIX it's used as a key in a local map of file descriptors.
   std::string pipe_name_;
 
-  Listener* listener_;
-
   // Messages to be sent are queued here.
   std::queue<Message*> output_queue_;
 
-  // We read from the pipe into this buffer. Managed by DispatchInputData, do
-  // not access directly outside that function.
-  char input_buf_[Channel::kReadBufferSize];
-
-  // Large messages that span multiple pipe buffers, get built-up using
-  // this buffer.
-  std::string input_overflow_buf_;
-
   // We assume a worst case: kReadBufferSize bytes of messages, where each
   // message has no payload and a full complement of descriptors.
   static const size_t kMaxReadFDs =
       (Channel::kReadBufferSize / sizeof(IPC::Message::Header)) *
       FileDescriptorSet::kMaxDescriptorsPerMessage;
 
   // Buffer size for file descriptors used for recvmsg. On Mac the CMSG macros
   // don't seem to be constant so we have to pick a "large enough" value.
 #if defined(OS_MACOSX)
   static const size_t kMaxReadFDBuffer = 1024;
@@ skipping 25 matching lines @@
 
 // The maximum length of the name of a pipe for MODE_NAMED_SERVER or
 // MODE_NAMED_CLIENT if you want to pass in your own socket.
 // The standard size on linux is 108, mac is 104. To maintain consistency
 // across platforms we standardize on the smaller value.
 static const size_t kMaxPipeNameLength = 104;
 
 }  // namespace IPC
 
 #endif  // IPC_IPC_CHANNEL_POSIX_H_