gecko-dev/modules/ipc/common/ipcm.cpp

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla IPC.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Darin Fisher <darin@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include <string.h>
#include "ipcm.h"
#include "prlog.h"

const nsID IPCM_TARGET =
{ /* 753ca8ff-c8c2-4601-b115-8c2944da1150 */
    0x753ca8ff,
    0xc8c2,
    0x4601,
    {0xb1, 0x15, 0x8c, 0x29, 0x44, 0xda, 0x11, 0x50}
};

//
// MSG_TYPE values
//
const PRUint32 ipcmMessagePing::MSG_TYPE = IPCM_MSG_TYPE_PING;
const PRUint32 ipcmMessageError::MSG_TYPE = IPCM_MSG_TYPE_ERROR;
const PRUint32 ipcmMessageClientHello::MSG_TYPE = IPCM_MSG_TYPE_CLIENT_HELLO;
const PRUint32 ipcmMessageClientID::MSG_TYPE = IPCM_MSG_TYPE_CLIENT_ID;
const PRUint32 ipcmMessageClientInfo::MSG_TYPE = IPCM_MSG_TYPE_CLIENT_INFO;
const PRUint32 ipcmMessageClientAddName::MSG_TYPE = IPCM_MSG_TYPE_CLIENT_ADD_NAME;
const PRUint32 ipcmMessageClientDelName::MSG_TYPE = IPCM_MSG_TYPE_CLIENT_DEL_NAME;
const PRUint32 ipcmMessageClientAddTarget::MSG_TYPE = IPCM_MSG_TYPE_CLIENT_ADD_TARGET;
const PRUint32 ipcmMessageClientDelTarget::MSG_TYPE = IPCM_MSG_TYPE_CLIENT_DEL_TARGET;
const PRUint32 ipcmMessageQueryClientByName::MSG_TYPE = IPCM_MSG_TYPE_QUERY_CLIENT_BY_NAME;
const PRUint32 ipcmMessageQueryClientInfo::MSG_TYPE = IPCM_MSG_TYPE_QUERY_CLIENT_INFO;
const PRUint32 ipcmMessageForward::MSG_TYPE = IPCM_MSG_TYPE_FORWARD;

//
// CLIENT_INFO message
//
//  +-----------------------------------------+
//  | DWORD : MSG_TYPE                        |
//  +--------------------+--------------------+
//  | DWORD : clientID                        |
//  +--------------------+--------------------+
//  | WORD : nameStart   | WORD : nameCount   |
//  +--------------------+--------------------+
//  | WORD : targetStart | WORD : targetCount |
//  +--------------------+--------------------+
//  | name[0]            | (null byte)        |
//  +--------------------+--------------------+
//  .                    .                    .
//  .                    .                    .
//  +--------------------+--------------------+
//  | name[count - 1]    | (null byte)        |
//  +--------------------+--------------------+
//  | target[0]                               |
//  +-----------------------------------------+
//  .                    .                    .
//  .                    .                    .
//  +-----------------------------------------+
//  | target[count - 1]                       |
//  +-----------------------------------------+
//

struct ipcmClientInfoHeader
{
    PRUint32 mType;
    PRUint32 mID;
    PRUint16 mNameStart;
    PRUint16 mNameCount;
    PRUint16 mTargetStart;
    PRUint16 mTargetCount;
};

ipcmMessageClientInfo::ipcmMessageClientInfo(PRUint32 cID, const char *names[], const nsID *targets[])
{
    ipcmClientInfoHeader hdr = {0};

    hdr.mType = MSG_TYPE;
    hdr.mID = cID;
    hdr.mNameStart = sizeof(hdr);

    PRUint32 i, namesLen = 0;

    i = 0;
    while (names[i]) {
        namesLen += (strlen(names[i]) + 1);
        ++hdr.mNameCount;
        ++i;
    }

    i = 0;
    while (targets[i]) {
        ++hdr.mTargetCount;
        ++i;
    }

    //
    // compute target array starting offset
    //
    hdr.mTargetStart = hdr.mNameStart + namesLen;

    //
    // compute message length
    //
    PRUint32 dataLen = sizeof(hdr) + namesLen + hdr.mTargetCount * sizeof(nsID);

    Init(IPCM_TARGET, NULL, dataLen);
    
    //
    // write message data
    //
    SetData(0, (const char *) &hdr, sizeof(hdr));

    PRUint32 offset = sizeof(hdr);

    for (i = 0; names[i]; ++i) {
        PRUint32 len = strlen(names[i]) + 1;
        SetData(offset, names[i], len);
        offset += len;
    }

    for (i = 0; targets[i]; ++i) {
        PRUint32 len = sizeof(nsID);
        SetData(offset, (const char *) targets[i], len);
        offset += len;
    }
}

PRUint32
ipcmMessageClientInfo::ClientID() const
{
    ipcmClientInfoHeader *hdr = (ipcmClientInfoHeader *) Data();
    return hdr->mID;
}

PRUint32
ipcmMessageClientInfo::NameCount() const
{
    ipcmClientInfoHeader *hdr = (ipcmClientInfoHeader *) Data();
    return hdr->mNameCount;
}

PRUint32
ipcmMessageClientInfo::TargetCount() const
{
    ipcmClientInfoHeader *hdr = (ipcmClientInfoHeader *) Data();
    return hdr->mTargetCount;
}

const char *
ipcmMessageClientInfo::NextName(const char *name) const
{
    ipcmClientInfoHeader *hdr = (ipcmClientInfoHeader *) Data();

    if (!name)
        return (const char *) hdr + hdr->mNameStart;

    name += strlen(name) + 1;
    if (name == (const char *) hdr + hdr->mTargetStart)
        name = NULL;
    return name;
}

const nsID *
ipcmMessageClientInfo::NextTarget(const nsID *target) const
{
    ipcmClientInfoHeader *hdr = (ipcmClientInfoHeader *) Data();

    if (!target)
        return (const nsID *) (Data() + hdr->mTargetStart);

    if (++target == (const nsID *) (MsgBuf() + MsgLen()))
        target = NULL;
    return target;
}

//
// FORWARD message
//
//  +-------------------------+
//  | DWORD : MSG_TYPE        |
//  +-------------------------+
//  | clientID                |
//  +-------------------------+
//  | innerMsgHeader          |
//  +-------------------------+
//  | innerMsgData            |
//  +-------------------------+
//

ipcmMessageForward::ipcmMessageForward(PRUint32 cID,
                                       const nsID &target,
                                       const char *data,
                                       PRUint32 dataLen)
{
    int len = sizeof(MSG_TYPE) +     // MSG_TYPE
              sizeof(cID) +          // cID
              IPC_MSG_HEADER_SIZE +  // innerMsgHeader
              dataLen;               // innerMsgData

    Init(IPCM_TARGET, NULL, len);

    SetData(0, (char *) &MSG_TYPE, sizeof(MSG_TYPE));
    SetData(4, (char *) &cID, sizeof(cID));

    ipcMessageHeader hdr;
    hdr.mLen = IPC_MSG_HEADER_SIZE + dataLen;
    hdr.mVersion = IPC_MSG_VERSION;
    hdr.mFlags = 0;
    hdr.mTarget = target;

    SetData(8, (char *) &hdr, IPC_MSG_HEADER_SIZE);
    if (data)
        SetInnerData(0, data, dataLen);
}

void
ipcmMessageForward::SetInnerData(PRUint32 offset, const char *data, PRUint32 dataLen)
{
    SetData(8 + IPC_MSG_HEADER_SIZE + offset, data, dataLen);
}

PRUint32
ipcmMessageForward::DestClientID() const
{
    return ((PRUint32 *) Data())[1];
}

const nsID &
ipcmMessageForward::InnerTarget() const
{
    ipcMessageHeader *hdr = (ipcMessageHeader *) (Data() + 8);
    return hdr->mTarget;
}

const char *
ipcmMessageForward::InnerData() const
{
    return Data() + 8 + IPC_MSG_HEADER_SIZE;
}

PRUint32
ipcmMessageForward::InnerDataLen() const
{
    ipcMessageHeader *hdr = (ipcMessageHeader *) (Data() + 8);
    return hdr->mLen - IPC_MSG_HEADER_SIZE;
}