1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
|
/*
* Copyright (C) 2010-2020 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "Attachment.h"
#include "MessageNames.h"
#include "StringReference.h"
#include <WebCore/SharedBuffer.h>
#include <wtf/Forward.h>
#include <wtf/OptionSet.h>
#include <wtf/Vector.h>
namespace IPC {
enum class MessageFlags : uint8_t;
enum class ShouldDispatchWhenWaitingForSyncReply : uint8_t;
template<typename, typename> struct ArgumentCoder;
class Encoder final {
WTF_MAKE_FAST_ALLOCATED;
public:
Encoder(MessageName, uint64_t destinationID);
~Encoder();
Encoder(const Encoder&) = delete;
Encoder(Encoder&&) = delete;
Encoder& operator=(const Encoder&) = delete;
Encoder& operator=(Encoder&&) = delete;
ReceiverName messageReceiverName() const { return receiverName(m_messageName); }
MessageName messageName() const { return m_messageName; }
uint64_t destinationID() const { return m_destinationID; }
bool isSyncMessage() const { return messageIsSync(messageName()); }
void setShouldDispatchMessageWhenWaitingForSyncReply(ShouldDispatchWhenWaitingForSyncReply);
ShouldDispatchWhenWaitingForSyncReply shouldDispatchMessageWhenWaitingForSyncReply() const;
void setFullySynchronousModeForTesting();
void setShouldMaintainOrderingWithAsyncMessages();
void wrapForTesting(UniqueRef<Encoder>&&);
void encodeFixedLengthData(const uint8_t* data, size_t, size_t alignment);
template<typename T>
Encoder& operator<<(T&& t)
{
ArgumentCoder<std::remove_const_t<std::remove_reference_t<T>>, void>::encode(*this, std::forward<T>(t));
return *this;
}
uint8_t* buffer() const { return m_buffer; }
size_t bufferSize() const { return m_bufferSize; }
void addAttachment(Attachment&&);
Vector<Attachment> releaseAttachments();
void reserve(size_t);
static constexpr bool isIPCEncoder = true;
private:
uint8_t* grow(size_t alignment, size_t);
bool hasAttachments() const;
void encodeHeader();
const OptionSet<MessageFlags>& messageFlags() const;
OptionSet<MessageFlags>& messageFlags();
MessageName m_messageName;
uint64_t m_destinationID;
uint8_t m_inlineBuffer[512];
uint8_t* m_buffer { m_inlineBuffer };
uint8_t* m_bufferPointer { m_inlineBuffer };
size_t m_bufferSize { 0 };
size_t m_bufferCapacity { sizeof(m_inlineBuffer) };
Vector<Attachment> m_attachments;
};
} // namespace IPC
|