value-serializer.h 11.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
// Copyright 2016 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_VALUE_SERIALIZER_H_
#define V8_VALUE_SERIALIZER_H_

#include <cstdint>
#include <vector>

#include "include/v8.h"
#include "src/base/compiler-specific.h"
#include "src/base/macros.h"
14
#include "src/identity-map.h"
15
#include "src/maybe-handles.h"
16
#include "src/messages.h"
17
#include "src/vector.h"
18
#include "src/zone/zone.h"
19 20 21 22

namespace v8 {
namespace internal {

23
class BigInt;
24
class HeapNumber;
25
class Isolate;
26
class JSArrayBuffer;
27
class JSArrayBufferView;
28
class JSDate;
29
class JSMap;
30
class JSRegExp;
31
class JSSet;
32
class JSValue;
33
class MutableHeapNumber;
34 35
class Object;
class Oddball;
36
class Smi;
37
class WasmMemoryObject;
38
class WasmModuleObject;
39 40 41 42 43 44 45 46 47 48 49

enum class SerializationTag : uint8_t;

/**
 * Writes V8 objects in a binary format that allows the objects to be cloned
 * according to the HTML structured clone algorithm.
 *
 * Format is based on Blink's previous serialization logic.
 */
class ValueSerializer {
 public:
50
  ValueSerializer(Isolate* isolate, v8::ValueSerializer::Delegate* delegate);
51 52 53 54 55 56 57 58 59 60
  ~ValueSerializer();

  /*
   * Writes out a header, which includes the format version.
   */
  void WriteHeader();

  /*
   * Serializes a V8 object into the buffer.
   */
61
  Maybe<bool> WriteObject(Handle<Object> object) V8_WARN_UNUSED_RESULT;
62 63 64 65 66

  /*
   * Returns the stored data. This serializer should not be used once the buffer
   * is released. The contents are undefined if a previous write has failed.
   */
67 68 69 70 71 72 73
  std::vector<uint8_t> ReleaseBuffer();

  /*
   * Returns the buffer, allocated via the delegate, and its size.
   * Caller assumes ownership of the buffer.
   */
  std::pair<uint8_t*, size_t> Release();
74

75 76 77 78 79 80 81 82
  /*
   * Marks an ArrayBuffer as havings its contents transferred out of band.
   * Pass the corresponding JSArrayBuffer in the deserializing context to
   * ValueDeserializer::TransferArrayBuffer.
   */
  void TransferArrayBuffer(uint32_t transfer_id,
                           Handle<JSArrayBuffer> array_buffer);

83 84 85 86 87 88 89
  /*
   * Publicly exposed wire format writing methods.
   * These are intended for use within the delegate's WriteHostObject method.
   */
  void WriteUint32(uint32_t value);
  void WriteUint64(uint64_t value);
  void WriteRawBytes(const void* source, size_t length);
90
  void WriteDouble(double value);
91

92 93 94 95 96 97 98 99 100
  /*
   * Indicate whether to treat ArrayBufferView objects as host objects,
   * i.e. pass them to Delegate::WriteHostObject. This should not be
   * called when no Delegate was passed.
   *
   * The default is not to treat ArrayBufferViews as host objects.
   */
  void SetTreatArrayBufferViewsAsHostObjects(bool mode);

101
 private:
102
  // Managing allocations of the internal buffer.
103
  Maybe<bool> ExpandBuffer(size_t required_capacity);
104

105 106 107 108
  // Writing the wire format.
  void WriteTag(SerializationTag tag);
  template <typename T>
  void WriteVarint(T value);
109 110
  template <typename T>
  void WriteZigZag(T value);
111 112
  void WriteOneByteString(Vector<const uint8_t> chars);
  void WriteTwoByteString(Vector<const uc16> chars);
113
  void WriteBigIntContents(BigInt* bigint);
114
  Maybe<uint8_t*> ReserveRawBytes(size_t bytes);
115 116 117

  // Writing V8 objects of various kinds.
  void WriteOddball(Oddball* oddball);
118 119
  void WriteSmi(Smi* smi);
  void WriteHeapNumber(HeapNumber* number);
120
  void WriteMutableHeapNumber(MutableHeapNumber* number);
121
  void WriteBigInt(BigInt* bigint);
122
  void WriteString(Handle<String> string);
123 124 125 126 127
  Maybe<bool> WriteJSReceiver(Handle<JSReceiver> receiver)
      V8_WARN_UNUSED_RESULT;
  Maybe<bool> WriteJSObject(Handle<JSObject> object) V8_WARN_UNUSED_RESULT;
  Maybe<bool> WriteJSObjectSlow(Handle<JSObject> object) V8_WARN_UNUSED_RESULT;
  Maybe<bool> WriteJSArray(Handle<JSArray> array) V8_WARN_UNUSED_RESULT;
128
  void WriteJSDate(JSDate* date);
129
  Maybe<bool> WriteJSValue(Handle<JSValue> value) V8_WARN_UNUSED_RESULT;
130
  void WriteJSRegExp(JSRegExp* regexp);
131 132
  Maybe<bool> WriteJSMap(Handle<JSMap> map) V8_WARN_UNUSED_RESULT;
  Maybe<bool> WriteJSSet(Handle<JSSet> map) V8_WARN_UNUSED_RESULT;
133
  Maybe<bool> WriteJSArrayBuffer(Handle<JSArrayBuffer> array_buffer)
134
      V8_WARN_UNUSED_RESULT;
135
  Maybe<bool> WriteJSArrayBufferView(JSArrayBufferView* array_buffer);
136
  Maybe<bool> WriteWasmModule(Handle<WasmModuleObject> object)
137
      V8_WARN_UNUSED_RESULT;
138
  Maybe<bool> WriteWasmMemory(Handle<WasmMemoryObject> object)
139 140
      V8_WARN_UNUSED_RESULT;
  Maybe<bool> WriteHostObject(Handle<JSObject> object) V8_WARN_UNUSED_RESULT;
141

142 143 144 145 146
  /*
   * Reads the specified keys from the object and writes key-value pairs to the
   * buffer. Returns the number of keys actually written, which may be smaller
   * if some keys are not own properties when accessed.
   */
147
  Maybe<uint32_t> WriteJSObjectPropertiesSlow(
148
      Handle<JSObject> object, Handle<FixedArray> keys) V8_WARN_UNUSED_RESULT;
149

150 151 152 153 154 155 156 157
  /*
   * Asks the delegate to handle an error that occurred during data cloning, by
   * throwing an exception appropriate for the host.
   */
  void ThrowDataCloneError(MessageTemplate::Template template_index);
  V8_NOINLINE void ThrowDataCloneError(MessageTemplate::Template template_index,
                                       Handle<Object> arg0);

158 159
  Maybe<bool> ThrowIfOutOfMemory();

160
  Isolate* const isolate_;
161
  v8::ValueSerializer::Delegate* const delegate_;
162
  bool treat_array_buffer_views_as_host_objects_ = false;
163 164 165
  uint8_t* buffer_ = nullptr;
  size_t buffer_size_ = 0;
  size_t buffer_capacity_ = 0;
166
  bool out_of_memory_ = false;
167 168 169 170 171
  Zone zone_;

  // To avoid extra lookups in the identity map, ID+1 is actually stored in the
  // map (checking if the used identity is zero is the fast way of checking if
  // the entry is new).
172
  IdentityMap<uint32_t, ZoneAllocationPolicy> id_map_;
173
  uint32_t next_id_ = 0;
174

175
  // A similar map, for transferred array buffers.
176
  IdentityMap<uint32_t, ZoneAllocationPolicy> array_buffer_transfer_map_;
177

178 179 180 181 182 183 184 185 186
  DISALLOW_COPY_AND_ASSIGN(ValueSerializer);
};

/*
 * Deserializes values from data written with ValueSerializer, or a compatible
 * implementation.
 */
class ValueDeserializer {
 public:
187 188
  ValueDeserializer(Isolate* isolate, Vector<const uint8_t> data,
                    v8::ValueDeserializer::Delegate* delegate);
189 190 191 192 193
  ~ValueDeserializer();

  /*
   * Runs version detection logic, which may fail if the format is invalid.
   */
194
  Maybe<bool> ReadHeader() V8_WARN_UNUSED_RESULT;
195

196 197 198 199 200 201 202
  /*
   * Reads the underlying wire format version. Likely mostly to be useful to
   * legacy code reading old wire format versions. Must be called after
   * ReadHeader.
   */
  uint32_t GetWireFormatVersion() const { return version_; }

203 204 205
  /*
   * Deserializes a V8 object from the buffer.
   */
206
  MaybeHandle<Object> ReadObject() V8_WARN_UNUSED_RESULT;
207

208 209 210 211 212 213 214 215
  /*
   * Reads an object, consuming the entire buffer.
   *
   * This is required for the legacy "version 0" format, which did not allow
   * reference deduplication, and instead relied on a "stack" model for
   * deserializing, with the contents of objects and arrays provided first.
   */
  MaybeHandle<Object> ReadObjectUsingEntireBufferForLegacyFormat()
216
      V8_WARN_UNUSED_RESULT;
217

218 219 220 221 222 223 224
  /*
   * Accepts the array buffer corresponding to the one passed previously to
   * ValueSerializer::TransferArrayBuffer.
   */
  void TransferArrayBuffer(uint32_t transfer_id,
                           Handle<JSArrayBuffer> array_buffer);

225 226 227 228
  /*
   * Publicly exposed wire format writing methods.
   * These are intended for use within the delegate's WriteHostObject method.
   */
229 230 231 232
  bool ReadUint32(uint32_t* value) V8_WARN_UNUSED_RESULT;
  bool ReadUint64(uint64_t* value) V8_WARN_UNUSED_RESULT;
  bool ReadDouble(double* value) V8_WARN_UNUSED_RESULT;
  bool ReadRawBytes(size_t length, const void** data) V8_WARN_UNUSED_RESULT;
233 234 235
  void set_expect_inline_wasm(bool expect_inline_wasm) {
    expect_inline_wasm_ = expect_inline_wasm;
  }
236

237
 private:
238
  // Reading the wire format.
239
  Maybe<SerializationTag> PeekTag() const V8_WARN_UNUSED_RESULT;
240
  void ConsumeTag(SerializationTag peeked_tag);
241
  Maybe<SerializationTag> ReadTag() V8_WARN_UNUSED_RESULT;
242
  template <typename T>
243
  Maybe<T> ReadVarint() V8_WARN_UNUSED_RESULT;
244
  template <typename T>
245 246 247
  Maybe<T> ReadZigZag() V8_WARN_UNUSED_RESULT;
  Maybe<double> ReadDouble() V8_WARN_UNUSED_RESULT;
  Maybe<Vector<const uint8_t>> ReadRawBytes(int size) V8_WARN_UNUSED_RESULT;
248
  bool expect_inline_wasm() const { return expect_inline_wasm_; }
249

250 251
  // Reads a string if it matches the one provided.
  // Returns true if this was the case. Otherwise, nothing is consumed.
252
  bool ReadExpectedString(Handle<String> expected) V8_WARN_UNUSED_RESULT;
253

254 255
  // Like ReadObject, but skips logic for special cases in simulating the
  // "stack machine".
256
  MaybeHandle<Object> ReadObjectInternal() V8_WARN_UNUSED_RESULT;
257

258 259 260
  // Reads a string intended to be part of a more complicated object.
  // Before v12, these are UTF-8 strings. After, they can be any encoding
  // permissible for a string (with the relevant tag).
261
  MaybeHandle<String> ReadString() V8_WARN_UNUSED_RESULT;
262

263 264
  // Reading V8 objects of specific kinds.
  // The tag is assumed to have already been read.
265 266 267 268 269 270 271 272 273 274 275 276
  MaybeHandle<BigInt> ReadBigInt() V8_WARN_UNUSED_RESULT;
  MaybeHandle<String> ReadUtf8String() V8_WARN_UNUSED_RESULT;
  MaybeHandle<String> ReadOneByteString() V8_WARN_UNUSED_RESULT;
  MaybeHandle<String> ReadTwoByteString() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSObject> ReadJSObject() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSArray> ReadSparseJSArray() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSArray> ReadDenseJSArray() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSDate> ReadJSDate() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSValue> ReadJSValue(SerializationTag tag) V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSRegExp> ReadJSRegExp() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSMap> ReadJSMap() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSSet> ReadJSSet() V8_WARN_UNUSED_RESULT;
277
  MaybeHandle<JSArrayBuffer> ReadJSArrayBuffer(bool is_shared)
278
      V8_WARN_UNUSED_RESULT;
279
  MaybeHandle<JSArrayBuffer> ReadTransferredJSArrayBuffer()
280
      V8_WARN_UNUSED_RESULT;
281
  MaybeHandle<JSArrayBufferView> ReadJSArrayBufferView(
282 283 284 285 286
      Handle<JSArrayBuffer> buffer) V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSObject> ReadWasmModule() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSObject> ReadWasmModuleTransfer() V8_WARN_UNUSED_RESULT;
  MaybeHandle<WasmMemoryObject> ReadWasmMemory() V8_WARN_UNUSED_RESULT;
  MaybeHandle<JSObject> ReadHostObject() V8_WARN_UNUSED_RESULT;
287 288 289 290 291 292

  /*
   * Reads key-value pairs into the object until the specified end tag is
   * encountered. If successful, returns the number of properties read.
   */
  Maybe<uint32_t> ReadJSObjectProperties(Handle<JSObject> object,
293 294
                                         SerializationTag end_tag,
                                         bool can_use_transitions);
295 296 297 298 299

  // Manipulating the map from IDs to reified objects.
  bool HasObjectWithID(uint32_t id);
  MaybeHandle<JSReceiver> GetObjectWithID(uint32_t id);
  void AddObjectWithID(uint32_t id, Handle<JSReceiver> object);
300 301

  Isolate* const isolate_;
302
  v8::ValueDeserializer::Delegate* const delegate_;
303 304
  const uint8_t* position_;
  const uint8_t* const end_;
305
  PretenureFlag pretenure_;
306
  uint32_t version_ = 0;
307
  uint32_t next_id_ = 0;
308
  bool expect_inline_wasm_ = false;
309

310
  // Always global handles.
311
  Handle<FixedArray> id_map_;
312
  MaybeHandle<SimpleNumberDictionary> array_buffer_transfer_map_;
313

314 315 316 317 318 319 320
  DISALLOW_COPY_AND_ASSIGN(ValueDeserializer);
};

}  // namespace internal
}  // namespace v8

#endif  // V8_VALUE_SERIALIZER_H_