summaryrefslogtreecommitdiffstats
path: root/js/src/wasm/WasmSerialize.h
blob: 5c86f617a0be917b601d48e65c9f2d8add4e2991 (plain)
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: set ts=8 sts=2 et sw=2 tw=80:
 *
 * Copyright 2015 Mozilla Foundation
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef wasm_serialize_h
#define wasm_serialize_h

#include <type_traits>

#include "js/Vector.h"

namespace js {
namespace wasm {

// Factor out common serialization, cloning and about:memory size-computation
// functions for reuse when serializing wasm and asm.js modules.

static inline uint8_t* WriteBytes(uint8_t* dst, const void* src,
                                  size_t nbytes) {
  if (nbytes) {
    memcpy(dst, src, nbytes);
  }
  return dst + nbytes;
}

static inline const uint8_t* ReadBytes(const uint8_t* src, void* dst,
                                       size_t nbytes) {
  if (nbytes) {
    memcpy(dst, src, nbytes);
  }
  return src + nbytes;
}

static inline const uint8_t* ReadBytesChecked(const uint8_t* src,
                                              size_t* remain, void* dst,
                                              size_t nbytes) {
  if (*remain < nbytes) {
    return nullptr;
  }
  memcpy(dst, src, nbytes);
  *remain -= nbytes;
  return src + nbytes;
}

template <class T>
static inline uint8_t* WriteScalar(uint8_t* dst, T t) {
  memcpy(dst, &t, sizeof(t));
  return dst + sizeof(t);
}

template <class T>
static inline const uint8_t* ReadScalar(const uint8_t* src, T* dst) {
  memcpy(dst, src, sizeof(*dst));
  return src + sizeof(*dst);
}

template <class T>
static inline const uint8_t* ReadScalarChecked(const uint8_t* src,
                                               size_t* remain, T* dst) {
  if (*remain < sizeof(*dst)) {
    return nullptr;
  }
  memcpy(dst, src, sizeof(*dst));
  *remain -= sizeof(*dst);
  return src + sizeof(*dst);
}

template <class T, size_t N>
static inline size_t SerializedVectorSize(
    const mozilla::Vector<T, N, SystemAllocPolicy>& vec) {
  size_t size = sizeof(uint32_t);
  for (size_t i = 0; i < vec.length(); i++) {
    size += vec[i].serializedSize();
  }
  return size;
}

template <class T, size_t N>
static inline uint8_t* SerializeVector(
    uint8_t* cursor, const mozilla::Vector<T, N, SystemAllocPolicy>& vec) {
  cursor = WriteScalar<uint32_t>(cursor, vec.length());
  for (size_t i = 0; i < vec.length(); i++) {
    cursor = vec[i].serialize(cursor);
  }
  return cursor;
}

template <class T, size_t N>
static inline const uint8_t* DeserializeVector(
    const uint8_t* cursor, mozilla::Vector<T, N, SystemAllocPolicy>* vec) {
  uint32_t length;
  cursor = ReadScalar<uint32_t>(cursor, &length);
  if (!vec->resize(length)) {
    return nullptr;
  }
  for (size_t i = 0; i < vec->length(); i++) {
    if (!(cursor = (*vec)[i].deserialize(cursor))) {
      return nullptr;
    }
  }
  return cursor;
}

template <class T, size_t N>
static inline size_t SizeOfVectorExcludingThis(
    const mozilla::Vector<T, N, SystemAllocPolicy>& vec,
    MallocSizeOf mallocSizeOf) {
  size_t size = vec.sizeOfExcludingThis(mallocSizeOf);
  for (const T& t : vec) {
    size += t.sizeOfExcludingThis(mallocSizeOf);
  }
  return size;
}

template <class T, size_t N>
static inline size_t SerializedPodVectorSize(
    const mozilla::Vector<T, N, SystemAllocPolicy>& vec) {
  return sizeof(uint32_t) + vec.length() * sizeof(T);
}

template <class T, size_t N>
static inline uint8_t* SerializePodVector(
    uint8_t* cursor, const mozilla::Vector<T, N, SystemAllocPolicy>& vec) {
  // This binary format must not change without taking into consideration the
  // constraints in Assumptions::serialize.

  cursor = WriteScalar<uint32_t>(cursor, vec.length());
  cursor = WriteBytes(cursor, vec.begin(), vec.length() * sizeof(T));
  return cursor;
}

template <class T, size_t N>
static inline const uint8_t* DeserializePodVector(
    const uint8_t* cursor, mozilla::Vector<T, N, SystemAllocPolicy>* vec) {
  uint32_t length;
  cursor = ReadScalar<uint32_t>(cursor, &length);
  if (!vec->initLengthUninitialized(length)) {
    return nullptr;
  }
  cursor = ReadBytes(cursor, vec->begin(), length * sizeof(T));
  return cursor;
}

template <class T, size_t N>
static inline const uint8_t* DeserializePodVectorChecked(
    const uint8_t* cursor, size_t* remain,
    mozilla::Vector<T, N, SystemAllocPolicy>* vec) {
  uint32_t length;
  cursor = ReadScalarChecked<uint32_t>(cursor, remain, &length);
  if (!cursor || !vec->initLengthUninitialized(length)) {
    return nullptr;
  }
  cursor = ReadBytesChecked(cursor, remain, vec->begin(), length * sizeof(T));
  return cursor;
}

template <class T>
inline size_t SerializableRefPtr<T>::serializedSize() const {
  return (*this)->serializedSize();
}

template <class T>
inline uint8_t* SerializableRefPtr<T>::serialize(uint8_t* cursor) const {
  return (*this)->serialize(cursor);
}

template <class T>
inline const uint8_t* SerializableRefPtr<T>::deserialize(
    const uint8_t* cursor) {
  auto* t = js_new<std::remove_const_t<T>>();
  *this = t;
  return t->deserialize(cursor);
}

template <class T>
inline size_t SerializableRefPtr<T>::sizeOfExcludingThis(
    mozilla::MallocSizeOf mallocSizeOf) const {
  return (*this)->sizeOfExcludingThis(mallocSizeOf);
}

}  // namespace wasm
}  // namespace js

#endif  // wasm_serialize_h