15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef IPC_IPC_CHANNEL_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define IPC_IPC_CHANNEL_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_POSIX) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/types.h> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 15a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch#include "base/process/process.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_channel_handle.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_message.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_sender.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace IPC { 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Listener; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//------------------------------------------------------------------------------ 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// See 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// http://www.chromium.org/developers/design-documents/inter-process-communication 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// for overview of IPC in Chromium. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Channels are implemented using named pipes on Windows, and 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// socket pairs (or in some special cases unix domain sockets) on POSIX. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// On Windows we access pipes in various processes by name. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// On POSIX we pass file descriptors to child processes and assign names to them 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in a lookup table. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// In general on POSIX we do not use unix domain sockets due to security 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// concerns and the fact that they can leave garbage around the file system 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (MacOS does not support abstract named unix domain sockets). 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// You can use unix domain sockets if you like on POSIX by constructing the 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the channel with the mode set to one of the NAMED modes. NAMED modes are 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// currently used by automation and service processes. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class IPC_EXPORT Channel : public Sender { 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Security tests need access to the pipe handle. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class ChannelTest; 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Flags to test modes 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum ModeFlags { 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_NO_FLAG = 0x0, 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_SERVER_FLAG = 0x1, 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_CLIENT_FLAG = 0x2, 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_NAMED_FLAG = 0x4, 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_POSIX) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_OPEN_ACCESS_FLAG = 0x8, // Don't restrict access based on client UID. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Some Standard Modes 58cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // TODO(morrita): These are under deprecation work. You should use Create*() 59cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // functions instead. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum Mode { 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_NONE = MODE_NO_FLAG, 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_SERVER = MODE_SERVER_FLAG, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_CLIENT = MODE_CLIENT_FLAG, 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_NAMED_SERVER = MODE_SERVER_FLAG | MODE_NAMED_FLAG, 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_NAMED_CLIENT = MODE_CLIENT_FLAG | MODE_NAMED_FLAG, 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_POSIX) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_OPEN_NAMED_SERVER = MODE_OPEN_ACCESS_FLAG | MODE_SERVER_FLAG | 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MODE_NAMED_FLAG 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 724e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Messages internal to the IPC implementation are defined here. 734e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // Uses Maximum value of message type (uint16), to avoid conflicting 744e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // with normal message types, which are enumeration constants starting from 0. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum { 764e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // The Hello message is sent by the peer when the channel is connected. 774e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // The message contains just the process id (pid). 784e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // The message has a special routing_id (MSG_ROUTING_NONE) 794e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // and type (HELLO_MESSAGE_TYPE). 804e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) HELLO_MESSAGE_TYPE = kuint16max, 814e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // The CLOSE_FD_MESSAGE_TYPE is used in the IPC class to 824e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // work around a bug in sendmsg() on Mac. When an FD is sent 834e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // over the socket, a CLOSE_FD_MESSAGE is sent with hops = 2. 844e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // The client will return the message with hops = 1, *after* it 854e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // has received the message that contains the FD. When we 864e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // receive it again on the sender side, we close the FD. 874e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) CLOSE_FD_MESSAGE_TYPE = HELLO_MESSAGE_TYPE - 1 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The maximum message size in bytes. Attempting to receive a message of this 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // size or bigger results in a channel error. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const size_t kMaximumMessageSize = 128 * 1024 * 1024; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Amount of data to read at once from the pipe. 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const size_t kReadBufferSize = 4 * 1024; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Initialize a Channel. 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |channel_handle| identifies the communication Channel. For POSIX, if 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the file descriptor in the channel handle is != -1, the channel takes 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ownership of the file descriptor and will close it appropriately, otherwise 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it will create a new descriptor internally. 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |listener| receives a callback on the current thread for each newly 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // received message. 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 106cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // There are four type of modes how channels operate: 107cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // 108cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // - Server and named server: In these modes, the Channel is 109cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // responsible for settingb up the IPC object 110cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // - An "open" named server: It accepts connections from ANY client. 111cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // The caller must then implement their own access-control based on the 112cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // client process' user Id. 113cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // - Client and named client: In these mode, the Channel merely 114cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // connects to the already established IPC object. 115cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // 116cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // Each mode has its own Create*() API to create the Channel object. 117cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // 118cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // TODO(morrita): Replace CreateByModeForProxy() with one of above Create*(). 119cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // 12046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) static scoped_ptr<Channel> Create( 1211320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci const IPC::ChannelHandle &channel_handle, Mode mode, Listener* listener); 12246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) 123cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) static scoped_ptr<Channel> CreateClient( 124cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const IPC::ChannelHandle &channel_handle, Listener* listener); 125cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 126cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // Channels on Windows are named by default and accessible from other 127cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // processes. On POSIX channels are anonymous by default and not accessible 128cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // from other processes. Named channels work via named unix domain sockets. 129cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // On Windows MODE_NAMED_SERVER is equivalent to MODE_SERVER and 130cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // MODE_NAMED_CLIENT is equivalent to MODE_CLIENT. 131cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) static scoped_ptr<Channel> CreateNamedServer( 132cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const IPC::ChannelHandle &channel_handle, Listener* listener); 133cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) static scoped_ptr<Channel> CreateNamedClient( 134cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const IPC::ChannelHandle &channel_handle, Listener* listener); 135cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#if defined(OS_POSIX) 136cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // An "open" named server accepts connections from ANY client. 137cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // The caller must then implement their own access-control based on the 138cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // client process' user Id. 139cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) static scoped_ptr<Channel> CreateOpenNamedServer( 140cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const IPC::ChannelHandle &channel_handle, Listener* listener); 141cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#endif 142cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) static scoped_ptr<Channel> CreateServer( 143cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const IPC::ChannelHandle &channel_handle, Listener* listener); 144cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Channel(); 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Connect the pipe. On the server side, this will initiate 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // waiting for connections. On the client, it attempts to 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // connect to a pre-existing pipe. Note, calling Connect() 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will not block the calling thread and may complete 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // asynchronously. 15346d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual bool Connect() WARN_UNUSED_RESULT = 0; 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Close this Channel explicitly. May be called multiple times. 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // On POSIX calling close on an IPC channel that listens for connections will 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // cause it to close any accepted connections, and it will stop listening for 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // new connections. If you just want to close the currently accepted 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // connection and listen for new ones, use ResetToAcceptingConnectionState. 16046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual void Close() = 0; 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the process ID for the connected peer. 1632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // 1642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns base::kNullProcessId if the peer is not connected yet. Watch out 1652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // for race conditions. You can easily get a channel to another process, but 1662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // if your process has not yet processed the "hello" message from the remote 1672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // side, this will fail. You should either make sure calling this is either 1682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // in response to a message from the remote side (which guarantees that it's 1692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // been connected), or you wait for the "connected" notification on the 1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // listener. 17146d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual base::ProcessId GetPeerPID() const = 0; 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1735f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) // Get its own process id. This value is told to the peer. 1745f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) virtual base::ProcessId GetSelfPID() const = 0; 1755f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Send a message over the Channel to the listener on the other end. 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |message| must be allocated using operator new. This object will be 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // deleted once the contents of the Message have been sent. 18046d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual bool Send(Message* message) = 0; 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 18246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)#if defined(OS_POSIX) && !defined(OS_NACL) 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // On POSIX an IPC::Channel wraps a socketpair(), this method returns the 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // FD # for the client end of the socket. 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method may only be called on the server side of a channel. 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method can be called on any thread. 18746d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual int GetClientFileDescriptor() const = 0; 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Same as GetClientFileDescriptor, but transfers the ownership of the 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // file descriptor to the caller. 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method can be called on any thread. 19246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles) virtual int TakeClientFileDescriptor() = 0; 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // defined(OS_POSIX) && !defined(OS_NACL) 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if a named server channel is initialized on the given channel 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ID. Even if true, the server may have already accepted a connection. 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool IsNamedServerInitialized(const std::string& channel_id); 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if !defined(OS_NACL) 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Generates a channel ID that's non-predictable and unique. 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::string GenerateUniqueRandomChannelID(); 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Generates a channel ID that, if passed to the client as a shared secret, 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // will validate that the client's authenticity. On platforms that do not 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // require additional this is simply calls GenerateUniqueRandomChannelID(). 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For portability the prefix should not include the \ character. 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static std::string GenerateVerifiedChannelID(const std::string& prefix); 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_LINUX) 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sandboxed processes live in a PID namespace, so when sending the IPC hello 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message from client to server we need to send the PID from the global 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // PID namespace. 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void SetGlobalPid(int pid); 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 21723730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles)#if defined(OS_ANDROID) 21823730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles) // Most tests are single process and work the same on all platforms. However 21923730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles) // in some cases we want to test multi-process, and Android differs in that it 22023730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles) // can't 'exec' after forking. This callback resets any data in the forked 22123730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles) // process such that it acts similar to if it was exec'd, for tests. 22223730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles) static void NotifyProcessForkedForTesting(); 22323730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles)#endif 22423730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles) 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 227a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)#if defined(OS_POSIX) 228a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)// SocketPair() creates a pair of socket FDs suitable for using with 229a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)// IPC::Channel. 230a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)IPC_EXPORT bool SocketPair(int* fd1, int* fd2); 231a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)#endif 232a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace IPC 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // IPC_IPC_CHANNEL_H_ 236