michael@0: // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
michael@0: // Use of this source code is governed by a BSD-style license that can be
michael@0: // found in the LICENSE file.
michael@0: 
michael@0: #include "chrome/common/mach_ipc_mac.h"
michael@0: 
michael@0: #import <Foundation/Foundation.h>
michael@0: 
michael@0: #include <stdio.h>
michael@0: #include "base/logging.h"
michael@0: 
michael@0: //==============================================================================
michael@0: MachSendMessage::MachSendMessage(int32_t message_id) : MachMessage() {
michael@0:   Initialize(message_id);
michael@0: }
michael@0: 
michael@0: MachSendMessage::MachSendMessage(void *storage, size_t storage_length,
michael@0:                                  int32_t message_id)
michael@0:     : MachMessage(storage, storage_length) {
michael@0:   Initialize(message_id);
michael@0: }
michael@0: 
michael@0: void MachSendMessage::Initialize(int32_t message_id) {
michael@0:   Head()->msgh_bits = MACH_MSGH_BITS(MACH_MSG_TYPE_COPY_SEND, 0);
michael@0: 
michael@0:   // head.msgh_remote_port = ...; // filled out in MachPortSender::SendMessage()
michael@0:   Head()->msgh_local_port = MACH_PORT_NULL;
michael@0:   Head()->msgh_reserved = 0;
michael@0:   Head()->msgh_id = 0;
michael@0: 
michael@0:   SetDescriptorCount(0);  // start out with no descriptors
michael@0: 
michael@0:   SetMessageID(message_id);
michael@0:   SetData(NULL, 0);       // client may add data later
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: MachMessage::MachMessage()
michael@0:     : storage_(new MachMessageData),  // Allocate storage_ ourselves
michael@0:       storage_length_bytes_(sizeof(MachMessageData)),
michael@0:       own_storage_(true) {
michael@0:   memset(storage_, 0, storage_length_bytes_);
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: MachMessage::MachMessage(void *storage, size_t storage_length)
michael@0:     : storage_(static_cast<MachMessageData*>(storage)),
michael@0:       storage_length_bytes_(storage_length),
michael@0:       own_storage_(false) {
michael@0:   DCHECK(storage);
michael@0:   DCHECK(storage_length >= kEmptyMessageSize);
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: MachMessage::~MachMessage() {
michael@0:   if (own_storage_) {
michael@0:     delete storage_;
michael@0:     storage_ = NULL;
michael@0:   }
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: // returns true if successful
michael@0: bool MachMessage::SetData(const void* data,
michael@0:                           int32_t data_length) {
michael@0:   // Enforce the fact that it's only safe to call this method once on a
michael@0:   // message.
michael@0:   DCHECK(GetDataPacket()->data_length == 0);
michael@0: 
michael@0:   // first check to make sure we have enough space
michael@0:   int size = CalculateSize();
michael@0:   int new_size = size + data_length;
michael@0: 
michael@0:   if ((unsigned)new_size > storage_length_bytes_) {
michael@0:     return false;  // not enough space
michael@0:   }
michael@0: 
michael@0:   GetDataPacket()->data_length = EndianU32_NtoL(data_length);
michael@0:   if (data) memcpy(GetDataPacket()->data, data, data_length);
michael@0: 
michael@0:   // Update the Mach header with the new aligned size of the message.
michael@0:   CalculateSize();
michael@0: 
michael@0:   return true;
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: // calculates and returns the total size of the message
michael@0: // Currently, the entire message MUST fit inside of the MachMessage
michael@0: //    messsage size <= EmptyMessageSize()
michael@0: int MachMessage::CalculateSize() {
michael@0:   int size = sizeof(mach_msg_header_t) + sizeof(mach_msg_body_t);
michael@0: 
michael@0:   // add space for MessageDataPacket
michael@0:   int32_t alignedDataLength = (GetDataLength() + 3) & ~0x3;
michael@0:   size += 2*sizeof(int32_t) + alignedDataLength;
michael@0: 
michael@0:   // add space for descriptors
michael@0:   size += GetDescriptorCount() * sizeof(MachMsgPortDescriptor);
michael@0: 
michael@0:   Head()->msgh_size = size;
michael@0: 
michael@0:   return size;
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: MachMessage::MessageDataPacket *MachMessage::GetDataPacket() {
michael@0:   int desc_size = sizeof(MachMsgPortDescriptor)*GetDescriptorCount();
michael@0:   MessageDataPacket *packet =
michael@0:     reinterpret_cast<MessageDataPacket*>(storage_->padding + desc_size);
michael@0: 
michael@0:   return packet;
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: void MachMessage::SetDescriptor(int n,
michael@0:                                 const MachMsgPortDescriptor &desc) {
michael@0:   MachMsgPortDescriptor *desc_array =
michael@0:     reinterpret_cast<MachMsgPortDescriptor*>(storage_->padding);
michael@0:   desc_array[n] = desc;
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: // returns true if successful otherwise there was not enough space
michael@0: bool MachMessage::AddDescriptor(const MachMsgPortDescriptor &desc) {
michael@0:   // first check to make sure we have enough space
michael@0:   int size = CalculateSize();
michael@0:   int new_size = size + sizeof(MachMsgPortDescriptor);
michael@0: 
michael@0:   if ((unsigned)new_size > storage_length_bytes_) {
michael@0:     return false;  // not enough space
michael@0:   }
michael@0: 
michael@0:   // unfortunately, we need to move the data to allow space for the
michael@0:   // new descriptor
michael@0:   u_int8_t *p = reinterpret_cast<u_int8_t*>(GetDataPacket());
michael@0:   bcopy(p, p+sizeof(MachMsgPortDescriptor), GetDataLength()+2*sizeof(int32_t));
michael@0: 
michael@0:   SetDescriptor(GetDescriptorCount(), desc);
michael@0:   SetDescriptorCount(GetDescriptorCount() + 1);
michael@0: 
michael@0:   CalculateSize();
michael@0: 
michael@0:   return true;
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: void MachMessage::SetDescriptorCount(int n) {
michael@0:   storage_->body.msgh_descriptor_count = n;
michael@0: 
michael@0:   if (n > 0) {
michael@0:     Head()->msgh_bits |= MACH_MSGH_BITS_COMPLEX;
michael@0:   } else {
michael@0:     Head()->msgh_bits &= ~MACH_MSGH_BITS_COMPLEX;
michael@0:   }
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: MachMsgPortDescriptor *MachMessage::GetDescriptor(int n) {
michael@0:   if (n < GetDescriptorCount()) {
michael@0:     MachMsgPortDescriptor *desc =
michael@0:         reinterpret_cast<MachMsgPortDescriptor*>(storage_->padding);
michael@0:     return desc + n;
michael@0:   }
michael@0: 
michael@0:   return nil;
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: mach_port_t MachMessage::GetTranslatedPort(int n) {
michael@0:   if (n < GetDescriptorCount()) {
michael@0:     return GetDescriptor(n)->GetMachPort();
michael@0:   }
michael@0:   return MACH_PORT_NULL;
michael@0: }
michael@0: 
michael@0: #pragma mark -
michael@0: 
michael@0: //==============================================================================
michael@0: // create a new mach port for receiving messages and register a name for it
michael@0: ReceivePort::ReceivePort(const char *receive_port_name) {
michael@0:   mach_port_t current_task = mach_task_self();
michael@0: 
michael@0:   init_result_ = mach_port_allocate(current_task,
michael@0:                                     MACH_PORT_RIGHT_RECEIVE,
michael@0:                                     &port_);
michael@0: 
michael@0:   if (init_result_ != KERN_SUCCESS)
michael@0:     return;
michael@0: 
michael@0:   init_result_ = mach_port_insert_right(current_task,
michael@0:                                         port_,
michael@0:                                         port_,
michael@0:                                         MACH_MSG_TYPE_MAKE_SEND);
michael@0: 
michael@0:   if (init_result_ != KERN_SUCCESS)
michael@0:     return;
michael@0: 
michael@0:   NSPort *ns_port = [NSMachPort portWithMachPort:port_];
michael@0:   NSString *port_name = [NSString stringWithUTF8String:receive_port_name];
michael@0:   [[NSMachBootstrapServer sharedInstance] registerPort:ns_port name:port_name];
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: // create a new mach port for receiving messages
michael@0: ReceivePort::ReceivePort() {
michael@0:   mach_port_t current_task = mach_task_self();
michael@0: 
michael@0:   init_result_ = mach_port_allocate(current_task,
michael@0:                                     MACH_PORT_RIGHT_RECEIVE,
michael@0:                                     &port_);
michael@0: 
michael@0:   if (init_result_ != KERN_SUCCESS)
michael@0:     return;
michael@0: 
michael@0:   init_result_ =   mach_port_insert_right(current_task,
michael@0:                                           port_,
michael@0:                                           port_,
michael@0:                                           MACH_MSG_TYPE_MAKE_SEND);
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: // Given an already existing mach port, use it.  We take ownership of the
michael@0: // port and deallocate it in our destructor.
michael@0: ReceivePort::ReceivePort(mach_port_t receive_port)
michael@0:   : port_(receive_port),
michael@0:     init_result_(KERN_SUCCESS) {
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: ReceivePort::~ReceivePort() {
michael@0:   if (init_result_ == KERN_SUCCESS)
michael@0:     mach_port_deallocate(mach_task_self(), port_);
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: kern_return_t ReceivePort::WaitForMessage(MachReceiveMessage *out_message,
michael@0:                                           mach_msg_timeout_t timeout) {
michael@0:   if (!out_message) {
michael@0:     return KERN_INVALID_ARGUMENT;
michael@0:   }
michael@0: 
michael@0:   // return any error condition encountered in constructor
michael@0:   if (init_result_ != KERN_SUCCESS)
michael@0:     return init_result_;
michael@0: 
michael@0:   out_message->Head()->msgh_bits = 0;
michael@0:   out_message->Head()->msgh_local_port = port_;
michael@0:   out_message->Head()->msgh_remote_port = MACH_PORT_NULL;
michael@0:   out_message->Head()->msgh_reserved = 0;
michael@0:   out_message->Head()->msgh_id = 0;
michael@0: 
michael@0:   kern_return_t result = mach_msg(out_message->Head(),
michael@0:                                   MACH_RCV_MSG | MACH_RCV_TIMEOUT,
michael@0:                                   0,
michael@0:                                   out_message->MaxSize(),
michael@0:                                   port_,
michael@0:                                   timeout,              // timeout in ms
michael@0:                                   MACH_PORT_NULL);
michael@0: 
michael@0:   return result;
michael@0: }
michael@0: 
michael@0: #pragma mark -
michael@0: 
michael@0: //==============================================================================
michael@0: // get a port with send rights corresponding to a named registered service
michael@0: MachPortSender::MachPortSender(const char *receive_port_name) {
michael@0:   mach_port_t bootstrap_port = 0;
michael@0:   init_result_ = task_get_bootstrap_port(mach_task_self(), &bootstrap_port);
michael@0: 
michael@0:   if (init_result_ != KERN_SUCCESS)
michael@0:     return;
michael@0: 
michael@0:   init_result_ = bootstrap_look_up(bootstrap_port,
michael@0:                     const_cast<char*>(receive_port_name),
michael@0:                     &send_port_);
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: MachPortSender::MachPortSender(mach_port_t send_port)
michael@0:   : send_port_(send_port),
michael@0:     init_result_(KERN_SUCCESS) {
michael@0: }
michael@0: 
michael@0: //==============================================================================
michael@0: kern_return_t MachPortSender::SendMessage(MachSendMessage &message,
michael@0:                                           mach_msg_timeout_t timeout) {
michael@0:   if (message.Head()->msgh_size == 0) {
michael@0:     NOTREACHED();
michael@0:     return KERN_INVALID_VALUE;    // just for safety -- never should occur
michael@0:   };
michael@0: 
michael@0:   if (init_result_ != KERN_SUCCESS)
michael@0:     return init_result_;
michael@0: 
michael@0:   message.Head()->msgh_remote_port = send_port_;
michael@0: 
michael@0:   kern_return_t result = mach_msg(message.Head(),
michael@0:                                   MACH_SEND_MSG | MACH_SEND_TIMEOUT,
michael@0:                                   message.Head()->msgh_size,
michael@0:                                   0,
michael@0:                                   MACH_PORT_NULL,
michael@0:                                   timeout,              // timeout in ms
michael@0:                                   MACH_PORT_NULL);
michael@0: 
michael@0:   return result;
michael@0: }