File: SerializeToBytesUtil.h

package info (click to toggle)
firefox 147.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,324 kB
  • sloc: cpp: 7,607,156; javascript: 6,532,492; ansic: 3,775,158; python: 1,415,368; xml: 634,556; asm: 438,949; java: 186,241; sh: 62,751; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (65 lines) | stat: -rw-r--r-- 2,260 bytes parent folder | download | duplicates (2)
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
/* -*- 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 http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_ipc_SerializeToBytesUtil_h
#define mozilla_ipc_SerializeToBytesUtil_h

#include "chrome/common/ipc_message_utils.h"
#include "chrome/common/ipc_message.h"

namespace mozilla::ipc {

// This file contains a pair of functions which (ab-)use the IPC::ParamTraits
// serializers with a temporary on-stack IPC::Message to serialize &
// de-serialize a value from a byte span.
//
// NOTE: This is _not_ efficient, and is _not_ guaranteed to work for arbitrary
// types! Many IPC serializers depend on the IPC::Message supporting additional
// information, such as attached endpoints and file handles.

template <typename T>
void SerializeToBytesUtil(T&& aValue, nsTArray<char>& aBytes) {
  IPC::Message tmpMessage(MSG_ROUTING_NONE, -1);

  {
    IPC::MessageWriter writer(tmpMessage);
    IPC::WriteParam(&writer, std::forward<T>(aValue));
  }

  MOZ_RELEASE_ASSERT(!tmpMessage.has_any_attachments(),
                     "Value contains attachments (e.g. endpoints, file "
                     "handles) which cannot be serialized as bytes");

  aBytes.SetLength(tmpMessage.size() - IPC::Message::HeaderSize());

  IPC::MessageReader reader(tmpMessage);
  bool readOk = reader.ReadBytesInto(aBytes.Elements(), aBytes.Length());
  MOZ_RELEASE_ASSERT(readOk);
  // Double-check that the entire Message body was used.
  MOZ_RELEASE_ASSERT(!reader.HasBytesAvailable(1));
}

template <typename T>
IPC::ReadResult<T> DeserializeFromBytesUtil(const Span<char>& aBytes) {
  IPC::Message tmpMessage(MSG_ROUTING_NONE, -1);

  {
    IPC::MessageWriter writer(tmpMessage);
    writer.WriteBytes(aBytes.Elements(), aBytes.Length());
  }

  IPC::MessageReader reader(tmpMessage);
  auto rv = IPC::ReadParam<T>(&reader);
  if (rv.isOk() && reader.HasBytesAvailable(1)) {
    // Unexpected trailing data after deserialization.
    return {};
  }
  return rv;
}

}  // namespace mozilla::ipc

#endif  // mozilla_ipc_SerializeToBytesUtil_h