ipc/ipc_message.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_MESSAGE_H_
   6 #define IPC_IPC_MESSAGE_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/memory/ref_counted.h"
  12 #include "base/pickle.h"
  13 #include "base/trace_event/trace_event.h"
  14 #include "ipc/ipc_export.h"
  15
  16 #if !defined(NDEBUG)
  17 #define IPC_MESSAGE_LOG_ENABLED
  18 #endif
  19
  20 namespace IPC {
  21
  22 namespace internal {
  23 class ChannelReader;
  24 }  // namespace internal
  25
  26 //------------------------------------------------------------------------------
  27
  28 struct LogData;
  29 class MessageAttachment;
  30 class MessageAttachmentSet;
  31
  32 class IPC_EXPORT Message : public base::Pickle {
  33  public:
  34   enum PriorityValue {
  35     PRIORITY_LOW = 1,
  36     PRIORITY_NORMAL,
  37     PRIORITY_HIGH
  38   };
  39
  40   // Bit values used in the flags field.
  41   // Upper 24 bits of flags store a reference number, so this enum is limited to
  42   // 8 bits.
  43   enum {
  44     PRIORITY_MASK     = 0x03,  // Low 2 bits of store the priority value.
  45     SYNC_BIT          = 0x04,
  46     REPLY_BIT         = 0x08,
  47     REPLY_ERROR_BIT   = 0x10,
  48     UNBLOCK_BIT       = 0x20,
  49     PUMPING_MSGS_BIT  = 0x40,
  50     HAS_SENT_TIME_BIT = 0x80,
  51   };
  52
  53   ~Message() override;
  54
  55   Message();
  56
  57   // Initialize a message with a user-defined type, priority value, and
  58   // destination WebView ID.
  59   Message(int32 routing_id, uint32 type, PriorityValue priority);
  60
  61   // Initializes a message from a const block of data.  The data is not copied;
  62   // instead the data is merely referenced by this message.  Only const methods
  63   // should be used on the message when initialized this way.
  64   Message(const char* data, int data_len);
  65
  66   Message(const Message& other);
  67   Message& operator=(const Message& other);
  68
  69   PriorityValue priority() const {
  70     return static_cast<PriorityValue>(header()->flags & PRIORITY_MASK);
  71   }
  72
  73   // True if this is a synchronous message.
  74   void set_sync() {
  75     header()->flags |= SYNC_BIT;
  76   }
  77   bool is_sync() const {
  78     return (header()->flags & SYNC_BIT) != 0;
  79   }
  80
  81   // Set this on a reply to a synchronous message.
  82   void set_reply() {
  83     header()->flags |= REPLY_BIT;
  84   }
  85
  86   bool is_reply() const {
  87     return (header()->flags & REPLY_BIT) != 0;
  88   }
  89
  90   // Set this on a reply to a synchronous message to indicate that no receiver
  91   // was found.
  92   void set_reply_error() {
  93     header()->flags |= REPLY_ERROR_BIT;
  94   }
  95
  96   bool is_reply_error() const {
  97     return (header()->flags & REPLY_ERROR_BIT) != 0;
  98   }
  99
 100   // Normally when a receiver gets a message and they're blocked on a
 101   // synchronous message Send, they buffer a message.  Setting this flag causes
 102   // the receiver to be unblocked and the message to be dispatched immediately.
 103   void set_unblock(bool unblock) {
 104     if (unblock) {
 105       header()->flags |= UNBLOCK_BIT;
 106     } else {
 107       header()->flags &= ~UNBLOCK_BIT;
 108     }
 109   }
 110
 111   bool should_unblock() const {
 112     return (header()->flags & UNBLOCK_BIT) != 0;
 113   }
 114
 115   // Tells the receiver that the caller is pumping messages while waiting
 116   // for the result.
 117   bool is_caller_pumping_messages() const {
 118     return (header()->flags & PUMPING_MSGS_BIT) != 0;
 119   }
 120
 121   void set_dispatch_error() const {
 122     dispatch_error_ = true;
 123   }
 124
 125   bool dispatch_error() const {
 126     return dispatch_error_;
 127   }
 128
 129   uint32 type() const {
 130     return header()->type;
 131   }
 132
 133   int32 routing_id() const {
 134     return header()->routing;
 135   }
 136
 137   void set_routing_id(int32 new_id) {
 138     header()->routing = new_id;
 139   }
 140
 141   uint32 flags() const {
 142     return header()->flags;
 143   }
 144
 145   // Sets all the given header values. The message should be empty at this
 146   // call.
 147   void SetHeaderValues(int32 routing, uint32 type, uint32 flags);
 148
 149   template<class T, class S, class P>
 150   static bool Dispatch(const Message* msg, T* obj, S* sender, P* parameter,
 151                        void (T::*func)()) {
 152     (obj->*func)();
 153     return true;
 154   }
 155
 156   template<class T, class S, class P>
 157   static bool Dispatch(const Message* msg, T* obj, S* sender, P* parameter,
 158                        void (T::*func)(P*)) {
 159     (obj->*func)(parameter);
 160     return true;
 161   }
 162
 163   // Used for async messages with no parameters.
 164   static void Log(std::string* name, const Message* msg, std::string* l) {
 165   }
 166
 167   // Find the end of the message data that starts at range_start.  Returns NULL
 168   // if the entire message is not found in the given data range.
 169   static const char* FindNext(const char* range_start, const char* range_end) {
 170     return base::Pickle::FindNext(sizeof(Header), range_start, range_end);
 171   }
 172
 173   // WriteAttachment appends |attachment| to the end of the set. It returns
 174   // false iff the set is full.
 175   bool WriteAttachment(scoped_refptr<MessageAttachment> attachment);
 176   // ReadAttachment parses an attachment given the parsing state |iter| and
 177   // writes it to |*attachment|. It returns true on success.
 178   bool ReadAttachment(base::PickleIterator* iter,
 179                       scoped_refptr<MessageAttachment>* attachment) const;
 180   // Returns true if there are any attachment in this message.
 181   bool HasAttachments() const;
 182   // Returns true if there are any MojoHandleAttachments in this message.
 183   bool HasMojoHandles() const;
 184   // Whether the message has any brokerable attachments.
 185   bool HasBrokerableAttachments() const;
 186
 187   void set_sender_pid(base::ProcessId id) { sender_pid_ = id; }
 188   base::ProcessId get_sender_pid() const { return sender_pid_; }
 189
 190 #ifdef IPC_MESSAGE_LOG_ENABLED
 191   // Adds the outgoing time from Time::Now() at the end of the message and sets
 192   // a bit to indicate that it's been added.
 193   void set_sent_time(int64 time);
 194   int64 sent_time() const;
 195
 196   void set_received_time(int64 time) const;
 197   int64 received_time() const { return received_time_; }
 198   void set_output_params(const std::string& op) const { output_params_ = op; }
 199   const std::string& output_params() const { return output_params_; }
 200   // The following four functions are needed so we can log sync messages with
 201   // delayed replies.  We stick the log data from the sent message into the
 202   // reply message, so that when it's sent and we have the output parameters
 203   // we can log it.  As such, we set a flag on the sent message to not log it.
 204   void set_sync_log_data(LogData* data) const { log_data_ = data; }
 205   LogData* sync_log_data() const { return log_data_; }
 206   void set_dont_log() const { dont_log_ = true; }
 207   bool dont_log() const { return dont_log_; }
 208 #endif
 209
 210  protected:
 211   friend class Channel;
 212   friend class ChannelMojo;
 213   friend class ChannelNacl;
 214   friend class ChannelPosix;
 215   friend class ChannelWin;
 216   friend class internal::ChannelReader;
 217   friend class MessageReplyDeserializer;
 218   friend class SyncMessage;
 219
 220 #pragma pack(push, 4)
 221   struct Header : base::Pickle::Header {
 222     int32 routing;  // ID of the view that this message is destined for
 223     uint32 type;    // specifies the user-defined message type
 224     uint32 flags;   // specifies control flags for the message
 225 #if defined(OS_POSIX)
 226     uint16 num_fds; // the number of descriptors included with this message
 227     uint16 pad;     // explicitly initialize this to appease valgrind
 228 #endif
 229   };
 230 #pragma pack(pop)
 231
 232   Header* header() {
 233     return headerT<Header>();
 234   }
 235   const Header* header() const {
 236     return headerT<Header>();
 237   }
 238
 239   void Init();
 240
 241   // Used internally to support IPC::Listener::OnBadMessageReceived.
 242   mutable bool dispatch_error_;
 243
 244   // The set of file descriptors associated with this message.
 245   scoped_refptr<MessageAttachmentSet> attachment_set_;
 246
 247   // Ensure that a MessageAttachmentSet is allocated
 248   void EnsureMessageAttachmentSet();
 249
 250   MessageAttachmentSet* attachment_set() {
 251     EnsureMessageAttachmentSet();
 252     return attachment_set_.get();
 253   }
 254   const MessageAttachmentSet* attachment_set() const {
 255     return attachment_set_.get();
 256   }
 257
 258   // The process id of the sender of the message. This member is populated with
 259   // a valid value for every message dispatched to listeners.
 260   base::ProcessId sender_pid_;
 261
 262 #ifdef IPC_MESSAGE_LOG_ENABLED
 263   // Used for logging.
 264   mutable int64 received_time_;
 265   mutable std::string output_params_;
 266   mutable LogData* log_data_;
 267   mutable bool dont_log_;
 268 #endif
 269 };
 270
 271 //------------------------------------------------------------------------------
 272
 273 }  // namespace IPC
 274
 275 enum SpecialRoutingIDs {
 276   // indicates that we don't have a routing ID yet.
 277   MSG_ROUTING_NONE = -2,
 278
 279   // indicates a general message not sent to a particular tab.
 280   MSG_ROUTING_CONTROL = kint32max,
 281 };
 282
 283 #define IPC_REPLY_ID 0xFFFFFFF0  // Special message id for replies
 284 #define IPC_LOGGING_ID 0xFFFFFFF1  // Special message id for logging
 285
 286 #endif  // IPC_IPC_MESSAGE_H_