summaryrefslogtreecommitdiffstats
path: root/ipc/chromium/src/chrome/common/ipc_message.h
diff options
context:
space:
mode:
Diffstat (limited to 'ipc/chromium/src/chrome/common/ipc_message.h')
-rw-r--r--ipc/chromium/src/chrome/common/ipc_message.h370
1 files changed, 370 insertions, 0 deletions
diff --git a/ipc/chromium/src/chrome/common/ipc_message.h b/ipc/chromium/src/chrome/common/ipc_message.h
new file mode 100644
index 000000000..60cec5f13
--- /dev/null
+++ b/ipc/chromium/src/chrome/common/ipc_message.h
@@ -0,0 +1,370 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+// Copyright (c) 2006-2008 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 CHROME_COMMON_IPC_MESSAGE_H__
+#define CHROME_COMMON_IPC_MESSAGE_H__
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/pickle.h"
+
+#ifdef MOZ_TASK_TRACER
+#include "GeckoTaskTracer.h"
+#endif
+
+#if defined(OS_POSIX)
+#include "nsAutoPtr.h"
+#endif
+
+namespace base {
+struct FileDescriptor;
+}
+
+class FileDescriptorSet;
+
+namespace IPC {
+
+//------------------------------------------------------------------------------
+
+class Channel;
+class Message;
+struct LogData;
+
+class Message : public Pickle {
+ public:
+ typedef uint32_t msgid_t;
+
+ enum NestedLevel {
+ NOT_NESTED = 1,
+ NESTED_INSIDE_SYNC = 2,
+ NESTED_INSIDE_CPOW = 3
+ };
+
+ enum PriorityValue {
+ NORMAL_PRIORITY,
+ HIGH_PRIORITY,
+ };
+
+ enum MessageCompression {
+ COMPRESSION_NONE,
+ COMPRESSION_ENABLED,
+ COMPRESSION_ALL
+ };
+
+ virtual ~Message();
+
+ Message();
+
+ // Initialize a message with a user-defined type, priority value, and
+ // destination WebView ID.
+ Message(int32_t routing_id,
+ msgid_t type,
+ NestedLevel nestedLevel = NOT_NESTED,
+ PriorityValue priority = NORMAL_PRIORITY,
+ MessageCompression compression = COMPRESSION_NONE,
+ const char* const name="???");
+
+ Message(const char* data, int data_len);
+
+ Message(const Message& other) = delete;
+ Message(Message&& other);
+ Message& operator=(const Message& other) = delete;
+ Message& operator=(Message&& other);
+
+ NestedLevel nested_level() const {
+ return static_cast<NestedLevel>(header()->flags & NESTED_MASK);
+ }
+
+ void set_nested_level(NestedLevel nestedLevel) {
+ DCHECK((nestedLevel & ~NESTED_MASK) == 0);
+ header()->flags = (header()->flags & ~NESTED_MASK) | nestedLevel;
+ }
+
+ PriorityValue priority() const {
+ if (header()->flags & PRIO_BIT) {
+ return HIGH_PRIORITY;
+ }
+ return NORMAL_PRIORITY;
+ }
+
+ void set_priority(PriorityValue prio) {
+ header()->flags &= ~PRIO_BIT;
+ if (prio == HIGH_PRIORITY) {
+ header()->flags |= PRIO_BIT;
+ }
+ }
+
+ // True if this is a synchronous message.
+ bool is_sync() const {
+ return (header()->flags & SYNC_BIT) != 0;
+ }
+
+ // True if this is a synchronous message.
+ bool is_interrupt() const {
+ return (header()->flags & INTERRUPT_BIT) != 0;
+ }
+
+ // True if compression is enabled for this message.
+ MessageCompression compress_type() const {
+ return (header()->flags & COMPRESS_BIT) ?
+ COMPRESSION_ENABLED :
+ (header()->flags & COMPRESSALL_BIT) ?
+ COMPRESSION_ALL :
+ COMPRESSION_NONE;
+ }
+
+ // Set this on a reply to a synchronous message.
+ void set_reply() {
+ header()->flags |= REPLY_BIT;
+ }
+
+ bool is_reply() const {
+ return (header()->flags & REPLY_BIT) != 0;
+ }
+
+ // Set this on a reply to a synchronous message to indicate that no receiver
+ // was found.
+ void set_reply_error() {
+ header()->flags |= REPLY_ERROR_BIT;
+ }
+
+ bool is_reply_error() const {
+ return (header()->flags & REPLY_ERROR_BIT) != 0;
+ }
+
+ msgid_t type() const {
+ return header()->type;
+ }
+
+ int32_t routing_id() const {
+ return header()->routing;
+ }
+
+ void set_routing_id(int32_t new_id) {
+ header()->routing = new_id;
+ }
+
+ int32_t transaction_id() const {
+ return header()->txid;
+ }
+
+ void set_transaction_id(int32_t txid) {
+ header()->txid = txid;
+ }
+
+ uint32_t interrupt_remote_stack_depth_guess() const {
+ return header()->interrupt_remote_stack_depth_guess;
+ }
+
+ void set_interrupt_remote_stack_depth_guess(uint32_t depth) {
+ DCHECK(is_interrupt());
+ header()->interrupt_remote_stack_depth_guess = depth;
+ }
+
+ uint32_t interrupt_local_stack_depth() const {
+ return header()->interrupt_local_stack_depth;
+ }
+
+ void set_interrupt_local_stack_depth(uint32_t depth) {
+ DCHECK(is_interrupt());
+ header()->interrupt_local_stack_depth = depth;
+ }
+
+ int32_t seqno() const {
+ return header()->seqno;
+ }
+
+ void set_seqno(int32_t aSeqno) {
+ header()->seqno = aSeqno;
+ }
+
+ const char* name() const {
+ return name_;
+ }
+
+ void set_name(const char* const aName) {
+ name_ = aName;
+ }
+
+#if defined(OS_POSIX)
+ uint32_t num_fds() const;
+#endif
+
+ template<class T>
+ static bool Dispatch(const Message* msg, T* obj, void (T::*func)()) {
+ (obj->*func)();
+ return true;
+ }
+
+ template<class T>
+ static bool Dispatch(const Message* msg, T* obj, void (T::*func)() const) {
+ (obj->*func)();
+ return true;
+ }
+
+ template<class T>
+ static bool Dispatch(const Message* msg, T* obj,
+ void (T::*func)(const Message&)) {
+ (obj->*func)(*msg);
+ return true;
+ }
+
+ template<class T>
+ static bool Dispatch(const Message* msg, T* obj,
+ void (T::*func)(const Message&) const) {
+ (obj->*func)(*msg);
+ return true;
+ }
+
+ // Used for async messages with no parameters.
+ static void Log(const Message* msg, std::wstring* l) {
+ }
+
+ // Figure out how big the message starting at range_start is. Returns 0 if
+ // there's no enough data to determine (i.e., if [range_start, range_end) does
+ // not contain enough of the message header to know the size).
+ static uint32_t MessageSize(const char* range_start, const char* range_end) {
+ return Pickle::MessageSize(sizeof(Header), range_start, range_end);
+ }
+
+#if defined(OS_POSIX)
+ // On POSIX, a message supports reading / writing FileDescriptor objects.
+ // This is used to pass a file descriptor to the peer of an IPC channel.
+
+ // Add a descriptor to the end of the set. Returns false iff the set is full.
+ bool WriteFileDescriptor(const base::FileDescriptor& descriptor);
+ // Get a file descriptor from the message. Returns false on error.
+ // iter: a Pickle iterator to the current location in the message.
+ bool ReadFileDescriptor(PickleIterator* iter, base::FileDescriptor* descriptor) const;
+
+#if defined(OS_MACOSX)
+ void set_fd_cookie(uint32_t cookie) {
+ header()->cookie = cookie;
+ }
+ uint32_t fd_cookie() const {
+ return header()->cookie;
+ }
+#endif
+#endif
+
+
+ friend class Channel;
+ friend class MessageReplyDeserializer;
+ friend class SyncMessage;
+
+ void set_sync() {
+ header()->flags |= SYNC_BIT;
+ }
+
+ void set_interrupt() {
+ header()->flags |= INTERRUPT_BIT;
+ }
+
+#if !defined(OS_MACOSX)
+ protected:
+#endif
+
+ // flags
+ enum {
+ NESTED_MASK = 0x0003,
+ PRIO_BIT = 0x0004,
+ SYNC_BIT = 0x0008,
+ REPLY_BIT = 0x0010,
+ REPLY_ERROR_BIT = 0x0020,
+ INTERRUPT_BIT = 0x0040,
+ COMPRESS_BIT = 0x0080,
+ COMPRESSALL_BIT = 0x0100,
+ };
+
+ struct Header : Pickle::Header {
+ int32_t routing; // ID of the view that this message is destined for
+ msgid_t type; // specifies the user-defined message type
+ uint32_t flags; // specifies control flags for the message
+#if defined(OS_POSIX)
+ uint32_t num_fds; // the number of descriptors included with this message
+# if defined(OS_MACOSX)
+ uint32_t cookie; // cookie to ACK that the descriptors have been read.
+# endif
+#endif
+ union {
+ // For Interrupt messages, a guess at what the *other* side's stack depth is.
+ uint32_t interrupt_remote_stack_depth_guess;
+
+ // For RPC and Urgent messages, a transaction ID for message ordering.
+ int32_t txid;
+ };
+ // The actual local stack depth.
+ uint32_t interrupt_local_stack_depth;
+ // Sequence number
+ int32_t seqno;
+#ifdef MOZ_TASK_TRACER
+ uint64_t source_event_id;
+ uint64_t parent_task_id;
+ mozilla::tasktracer::SourceEventType source_event_type;
+#endif
+ };
+
+ Header* header() {
+ return headerT<Header>();
+ }
+ const Header* header() const {
+ return headerT<Header>();
+ }
+
+ void InitLoggingVariables(const char* const name="???");
+
+#if defined(OS_POSIX)
+ // The set of file descriptors associated with this message.
+ RefPtr<FileDescriptorSet> file_descriptor_set_;
+
+ // Ensure that a FileDescriptorSet is allocated
+ void EnsureFileDescriptorSet();
+
+ FileDescriptorSet* file_descriptor_set() {
+ EnsureFileDescriptorSet();
+ return file_descriptor_set_.get();
+ }
+ const FileDescriptorSet* file_descriptor_set() const {
+ return file_descriptor_set_.get();
+ }
+#endif
+
+ const char* name_;
+
+};
+
+class MessageInfo {
+public:
+ typedef uint32_t msgid_t;
+
+ explicit MessageInfo(const Message& aMsg)
+ : mSeqno(aMsg.seqno()), mType(aMsg.type()) {}
+
+ int32_t seqno() const { return mSeqno; }
+ msgid_t type() const { return mType; }
+
+private:
+ int32_t mSeqno;
+ msgid_t mType;
+};
+
+//------------------------------------------------------------------------------
+
+} // namespace IPC
+
+enum SpecialRoutingIDs {
+ // indicates that we don't have a routing ID yet.
+ MSG_ROUTING_NONE = kint32min,
+
+ // indicates a general message not sent to a particular tab.
+ MSG_ROUTING_CONTROL = kint32max
+};
+
+#define IPC_REPLY_ID 0xFFF0 // Special message id for replies
+#define IPC_LOGGING_ID 0xFFF1 // Special message id for logging
+
+#endif // CHROME_COMMON_IPC_MESSAGE_H__
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-02 12:22:26 +0000