gecko-dev/ipc/glue/ProtocolMessageUtils.h
Nika Layzell bdb401316d Bug 1908725 - Part 2: Make the ChildID available in the same places as OtherPid, r=ipc-reviewers,media-playback-reviewers,win-reviewers,alwu,rkraesig,gfx-reviewers,mccr8,nical
This requires quite a bit of piping to get the ChildID passed everywhere where
we currently pass the pid in IPC. This is done by adding a new struct type
(EndpointProcInfo), which is passed around instead of OtherPid in these places,
and contains the full pid.

In most cases, it was a fairly painless change to move over, however in some
cases, more complex changes were required, as the pid was being stored
previously in something like an Atomic<...>, and needed to be switched to using
a mutex-protected value.

In the future, it may be possible to remove OtherPid from IPDL actors once
everything is migrated to ChildID, but we're still a long way off from that, so
for now we unfortunately need to pass both around.

Differential Revision: https://phabricator.services.mozilla.com/D217118
2024-08-07 20:39:39 +00:00

137 lines
3.9 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/. */
#ifndef IPC_GLUE_PROTOCOLMESSAGEUTILS_H
#define IPC_GLUE_PROTOCOLMESSAGEUTILS_H
#include <stdint.h>
#include <string>
#include "base/string_util.h"
#include "chrome/common/ipc_channel.h"
#include "chrome/common/ipc_message_utils.h"
#include "ipc/EnumSerializer.h"
#include "mozilla/Assertions.h"
#include "mozilla/ipc/Endpoint.h"
#include "mozilla/ipc/ProtocolUtils.h"
class PickleIterator;
namespace mozilla::ipc {
class FileDescriptor;
template <class PFooSide>
class Endpoint;
template <class PFooSide>
class ManagedEndpoint;
template <typename P>
struct IPDLParamTraits;
} // namespace mozilla::ipc
namespace IPC {
class Message;
class MessageReader;
class MessageWriter;
template <>
struct ParamTraits<Channel::Mode>
: ContiguousEnumSerializerInclusive<Channel::Mode, Channel::MODE_SERVER,
Channel::MODE_CLIENT> {};
template <>
struct ParamTraits<IPCMessageStart>
: ContiguousEnumSerializer<IPCMessageStart, IPCMessageStart(0),
LastMsgIndex> {};
template <>
struct ParamTraits<mozilla::ipc::ActorHandle> {
typedef mozilla::ipc::ActorHandle paramType;
static void Write(MessageWriter* aWriter, const paramType& aParam) {
IPC::WriteParam(aWriter, aParam.mId);
}
static bool Read(MessageReader* aReader, paramType* aResult) {
int id;
if (IPC::ReadParam(aReader, &id)) {
aResult->mId = id;
return true;
}
return false;
}
};
template <>
struct ParamTraits<mozilla::ipc::UntypedEndpoint> {
using paramType = mozilla::ipc::UntypedEndpoint;
static void Write(MessageWriter* aWriter, paramType&& aParam);
static bool Read(MessageReader* aReader, paramType* aResult);
};
template <class PFooSide>
struct ParamTraits<mozilla::ipc::Endpoint<PFooSide>>
: ParamTraits<mozilla::ipc::UntypedEndpoint> {};
template <>
struct ParamTraits<mozilla::ipc::EndpointProcInfo> {
using paramType = mozilla::ipc::EndpointProcInfo;
static void Write(MessageWriter* aWriter, const paramType& aParam) {
IPC::WriteParam(aWriter, aParam.mPid);
IPC::WriteParam(aWriter, aParam.mChildID);
}
static bool Read(MessageReader* aReader, paramType* aResult) {
return IPC::ReadParam(aReader, &aResult->mPid) &&
IPC::ReadParam(aReader, &aResult->mChildID);
}
};
} // namespace IPC
namespace mozilla::ipc {
template <>
struct IPDLParamTraits<UntypedManagedEndpoint> {
using paramType = UntypedManagedEndpoint;
static void Write(IPC::MessageWriter* aWriter, IProtocol* aActor,
paramType&& aParam);
static bool Read(IPC::MessageReader* aReader, IProtocol* aActor,
paramType* aResult);
};
template <class PFooSide>
struct IPDLParamTraits<ManagedEndpoint<PFooSide>> {
using paramType = ManagedEndpoint<PFooSide>;
static void Write(IPC::MessageWriter* aWriter, IProtocol* aActor,
paramType&& aParam) {
IPDLParamTraits<UntypedManagedEndpoint>::Write(aWriter, aActor,
std::move(aParam));
}
static bool Read(IPC::MessageReader* aReader, IProtocol* aActor,
paramType* aResult) {
return IPDLParamTraits<UntypedManagedEndpoint>::Read(aReader, aActor,
aResult);
}
};
template <>
struct IPDLParamTraits<FileDescriptor> {
typedef FileDescriptor paramType;
static void Write(IPC::MessageWriter* aWriter, IProtocol* aActor,
const paramType& aParam);
static bool Read(IPC::MessageReader* aReader, IProtocol* aActor,
paramType* aResult);
};
} // namespace mozilla::ipc
#endif // IPC_GLUE_PROTOCOLMESSAGEUTILS_H