1// Copyright 2014 the V8 project authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef V8_COMPILER_ACCESS_BUILDER_H_
6#define V8_COMPILER_ACCESS_BUILDER_H_
7
8#include "src/base/compiler-specific.h"
9#include "src/compiler/simplified-operator.h"
10#include "src/compiler/write-barrier-kind.h"
11#include "src/objects/elements-kind.h"
12#include "src/objects/js-objects.h"
13
14namespace v8 {
15namespace internal {
16namespace compiler {
17
18// This access builder provides a set of static methods constructing commonly
19// used FieldAccess and ElementAccess descriptors. These descriptors serve as
20// parameters to simplified load/store operators.
21class V8_EXPORT_PRIVATE AccessBuilder final
22    : public NON_EXPORTED_BASE(AllStatic) {
23 public:
24  // ===========================================================================
25  // Access to external values (based on external references).
26
27  // Provides access to an IntPtr field identified by an external reference.
28  static FieldAccess ForExternalIntPtr();
29
30  // ===========================================================================
31  // Access to heap object fields and elements (based on tagged pointer).
32
33  // Provides access to HeapObject::map() field.
34  static FieldAccess ForMap(WriteBarrierKind write_barrier = kMapWriteBarrier);
35
36  // Provides access to HeapNumber::value() field.
37  static FieldAccess ForHeapNumberValue();
38
39  // Provides access to BigInt's bit field.
40  static FieldAccess ForBigIntBitfield();
41
42  // Provides access to BigInt's 32 bit padding that is placed after the
43  // bitfield on 64 bit architectures without pointer compression. Do not use
44  // this on 32 bit architectures.
45  static FieldAccess ForBigIntOptionalPadding();
46
47  // Provides access to BigInt's least significant digit on 64 bit
48  // architectures. Do not use this on 32 bit architectures.
49  static FieldAccess ForBigIntLeastSignificantDigit64();
50
51  // Provides access to JSObject::properties() field.
52  static FieldAccess ForJSObjectPropertiesOrHash();
53
54  // Provides access to JSObject::properties() field for known pointers.
55  static FieldAccess ForJSObjectPropertiesOrHashKnownPointer();
56
57  // Provides access to JSObject::elements() field.
58  static FieldAccess ForJSObjectElements();
59
60  // Provides access to JSObject inobject property fields.
61  static FieldAccess ForJSObjectInObjectProperty(
62      const MapRef& map, int index,
63      MachineType machine_type = MachineType::AnyTagged());
64  static FieldAccess ForJSObjectOffset(
65      int offset, WriteBarrierKind write_barrier_kind = kFullWriteBarrier);
66
67  // Provides access to JSCollecton::table() field.
68  static FieldAccess ForJSCollectionTable();
69
70  // Provides access to JSCollectionIterator::table() field.
71  static FieldAccess ForJSCollectionIteratorTable();
72
73  // Provides access to JSCollectionIterator::index() field.
74  static FieldAccess ForJSCollectionIteratorIndex();
75
76  // Provides access to JSFunction::prototype_or_initial_map() field.
77  static FieldAccess ForJSFunctionPrototypeOrInitialMap();
78
79  // Provides access to JSFunction::context() field.
80  static FieldAccess ForJSFunctionContext();
81
82  // Provides access to JSFunction::shared() field.
83  static FieldAccess ForJSFunctionSharedFunctionInfo();
84
85  // Provides access to JSFunction::feedback_cell() field.
86  static FieldAccess ForJSFunctionFeedbackCell();
87
88  // Provides access to JSFunction::code() field.
89  static FieldAccess ForJSFunctionCode();
90
91  // Provides access to JSBoundFunction::bound_target_function() field.
92  static FieldAccess ForJSBoundFunctionBoundTargetFunction();
93
94  // Provides access to JSBoundFunction::bound_this() field.
95  static FieldAccess ForJSBoundFunctionBoundThis();
96
97  // Provides access to JSBoundFunction::bound_arguments() field.
98  static FieldAccess ForJSBoundFunctionBoundArguments();
99
100  // Provides access to JSGeneratorObject::context() field.
101  static FieldAccess ForJSGeneratorObjectContext();
102
103  // Provides access to JSGeneratorObject::continuation() field.
104  static FieldAccess ForJSGeneratorObjectContinuation();
105
106  // Provides access to JSGeneratorObject::input_or_debug_pos() field.
107  static FieldAccess ForJSGeneratorObjectInputOrDebugPos();
108
109  // Provides access to JSGeneratorObject::parameters_and_registers() field.
110  static FieldAccess ForJSGeneratorObjectParametersAndRegisters();
111
112  // Provides access to JSGeneratorObject::function() field.
113  static FieldAccess ForJSGeneratorObjectFunction();
114
115  // Provides access to JSGeneratorObject::receiver() field.
116  static FieldAccess ForJSGeneratorObjectReceiver();
117
118  // Provides access to JSGeneratorObject::resume_mode() field.
119  static FieldAccess ForJSGeneratorObjectResumeMode();
120
121  // Provides access to JSAsyncFunctionObject::promise() field.
122  static FieldAccess ForJSAsyncFunctionObjectPromise();
123
124  // Provides access to JSAsyncGeneratorObject::queue() field.
125  static FieldAccess ForJSAsyncGeneratorObjectQueue();
126
127  // Provides access to JSAsyncGeneratorObject::is_awaiting() field.
128  static FieldAccess ForJSAsyncGeneratorObjectIsAwaiting();
129
130  // Provides access to JSArray::length() field.
131  static FieldAccess ForJSArrayLength(ElementsKind elements_kind);
132
133  // Provides access to JSArrayBuffer::bit_field() field.
134  static FieldAccess ForJSArrayBufferBitField();
135
136  // Provides access to JSArrayBufferView::buffer() field.
137  static FieldAccess ForJSArrayBufferViewBuffer();
138
139  // Provides access to JSArrayBufferView::byteLength() field.
140  static FieldAccess ForJSArrayBufferViewByteLength();
141
142  // Provides access to JSArrayBufferView::byteOffset() field.
143  static FieldAccess ForJSArrayBufferViewByteOffset();
144
145  // Provides access to JSTypedArray::length() field.
146  static FieldAccess ForJSTypedArrayLength();
147
148  // Provides access to JSTypedArray::base_pointer() field.
149  static FieldAccess ForJSTypedArrayBasePointer();
150
151  // Provides access to JSTypedArray::external_pointer() field.
152  static FieldAccess ForJSTypedArrayExternalPointer();
153
154  // Provides access to JSDataView::data_pointer() field.
155  static FieldAccess ForJSDataViewDataPointer();
156
157  // Provides access to JSDate::value() field.
158  static FieldAccess ForJSDateValue();
159
160  // Provides access to JSDate fields.
161  static FieldAccess ForJSDateField(JSDate::FieldIndex index);
162
163  // Provides access to JSIteratorResult::done() field.
164  static FieldAccess ForJSIteratorResultDone();
165
166  // Provides access to JSIteratorResult::value() field.
167  static FieldAccess ForJSIteratorResultValue();
168
169  // Provides access to JSRegExp::data() field.
170  static FieldAccess ForJSRegExpData();
171
172  // Provides access to JSRegExp::flags() field.
173  static FieldAccess ForJSRegExpFlags();
174
175  // Provides access to JSRegExp::last_index() field.
176  static FieldAccess ForJSRegExpLastIndex();
177
178  // Provides access to JSRegExp::source() field.
179  static FieldAccess ForJSRegExpSource();
180
181  // Provides access to FixedArray::length() field.
182  static FieldAccess ForFixedArrayLength();
183
184  // Provides access to WeakFixedArray::length() field.
185  static FieldAccess ForWeakFixedArrayLength();
186
187  // Provides access to SloppyArgumentsElements::context() field.
188  static FieldAccess ForSloppyArgumentsElementsContext();
189
190  // Provides access to SloppyArgumentsElements::arguments() field.
191  static FieldAccess ForSloppyArgumentsElementsArguments();
192
193  // Provides access to PropertyArray::length() field.
194  static FieldAccess ForPropertyArrayLengthAndHash();
195
196  // Provides access to DescriptorArray::enum_cache() field.
197  static FieldAccess ForDescriptorArrayEnumCache();
198
199  // Provides access to Map::bit_field() byte.
200  static FieldAccess ForMapBitField();
201
202  // Provides access to Map::bit_field2() byte.
203  static FieldAccess ForMapBitField2();
204
205  // Provides access to Map::bit_field3() field.
206  static FieldAccess ForMapBitField3();
207
208  // Provides access to Map::descriptors() field.
209  static FieldAccess ForMapDescriptors();
210
211  // Provides access to Map::instance_type() field.
212  static FieldAccess ForMapInstanceType();
213
214  // Provides access to Map::prototype() field.
215  static FieldAccess ForMapPrototype();
216
217  // Provides access to Map::native_context() field.
218  static FieldAccess ForMapNativeContext();
219
220  // Provides access to Module::regular_exports() field.
221  static FieldAccess ForModuleRegularExports();
222
223  // Provides access to Module::regular_imports() field.
224  static FieldAccess ForModuleRegularImports();
225
226  // Provides access to Name::raw_hash_field() field.
227  static FieldAccess ForNameRawHashField();
228
229  // Provides access to String::length() field.
230  static FieldAccess ForStringLength();
231
232  // Provides access to ConsString::first() field.
233  static FieldAccess ForConsStringFirst();
234
235  // Provides access to ConsString::second() field.
236  static FieldAccess ForConsStringSecond();
237
238  // Provides access to ThinString::actual() field.
239  static FieldAccess ForThinStringActual();
240
241  // Provides access to SlicedString::offset() field.
242  static FieldAccess ForSlicedStringOffset();
243
244  // Provides access to SlicedString::parent() field.
245  static FieldAccess ForSlicedStringParent();
246
247  // Provides access to ExternalString::resource_data() field.
248  static FieldAccess ForExternalStringResourceData();
249
250  // Provides access to SeqOneByteString characters.
251  static ElementAccess ForSeqOneByteStringCharacter();
252
253  // Provides access to SeqTwoByteString characters.
254  static ElementAccess ForSeqTwoByteStringCharacter();
255
256  // Provides access to JSGlobalProxy::native_context() field.
257  static FieldAccess ForJSGlobalProxyNativeContext();
258
259  // Provides access to JSArrayIterator::iterated_object() field.
260  static FieldAccess ForJSArrayIteratorIteratedObject();
261
262  // Provides access to JSArrayIterator::next_index() field.
263  static FieldAccess ForJSArrayIteratorNextIndex();
264
265  // Provides access to JSArrayIterator::kind() field.
266  static FieldAccess ForJSArrayIteratorKind();
267
268  // Provides access to JSStringIterator::string() field.
269  static FieldAccess ForJSStringIteratorString();
270
271  // Provides access to JSStringIterator::index() field.
272  static FieldAccess ForJSStringIteratorIndex();
273
274  // Provides access to Cell::value() field.
275  static FieldAccess ForCellValue();
276
277  // Provides access to arguments object fields.
278  static FieldAccess ForArgumentsLength();
279  static FieldAccess ForArgumentsCallee();
280
281  // Provides access to FixedArray slots.
282  static FieldAccess ForFixedArraySlot(
283      size_t index, WriteBarrierKind write_barrier_kind = kFullWriteBarrier);
284
285  static FieldAccess ForFeedbackVectorSlot(int index);
286
287  // Provides access to ScopeInfo flags.
288  static FieldAccess ForScopeInfoFlags();
289
290  // Provides access to Context slots.
291  static FieldAccess ForContextSlot(size_t index);
292
293  // Provides access to Context slots that are known to be pointers.
294  static FieldAccess ForContextSlotKnownPointer(size_t index);
295
296  // Provides access to WeakFixedArray elements.
297  static ElementAccess ForWeakFixedArrayElement();
298  static FieldAccess ForWeakFixedArraySlot(int index);
299
300  // Provides access to FixedArray elements.
301  static ElementAccess ForFixedArrayElement();
302  static ElementAccess ForFixedArrayElement(ElementsKind kind);
303
304  // Provides access to SloppyArgumentsElements elements.
305  static ElementAccess ForSloppyArgumentsElementsMappedEntry();
306
307  // Provides access to stack arguments
308  static ElementAccess ForStackArgument();
309
310  // Provides access to FixedDoubleArray elements.
311  static ElementAccess ForFixedDoubleArrayElement();
312
313  // Provides access to EnumCache::keys() field.
314  static FieldAccess ForEnumCacheKeys();
315
316  // Provides access to EnumCache::indices() field.
317  static FieldAccess ForEnumCacheIndices();
318
319  // Provides access to Fixed{type}TypedArray and External{type}Array elements.
320  static ElementAccess ForTypedArrayElement(ExternalArrayType type,
321                                            bool is_external);
322
323  // Provides access to HashTable fields.
324  static FieldAccess ForHashTableBaseNumberOfElements();
325  static FieldAccess ForHashTableBaseNumberOfDeletedElement();
326  static FieldAccess ForHashTableBaseCapacity();
327
328  // Provides access to OrderedHashMapOrSet fields.
329  static FieldAccess ForOrderedHashMapOrSetNextTable();
330  static FieldAccess ForOrderedHashMapOrSetNumberOfBuckets();
331  static FieldAccess ForOrderedHashMapOrSetNumberOfElements();
332  static FieldAccess ForOrderedHashMapOrSetNumberOfDeletedElements();
333
334  // Provides access to OrderedHashMap elements.
335  static ElementAccess ForOrderedHashMapEntryValue();
336
337  // Provides access to Dictionary fields.
338  static FieldAccess ForDictionaryNextEnumerationIndex();
339  static FieldAccess ForDictionaryObjectHashIndex();
340
341  // Provides access to FeedbackCell fields.
342  static FieldAccess ForFeedbackCellInterruptBudget();
343
344  // Provides access to a FeedbackVector fields.
345  static FieldAccess ForFeedbackVectorInvocationCount();
346  static FieldAccess ForFeedbackVectorFlags();
347  static FieldAccess ForFeedbackVectorClosureFeedbackCellArray();
348
349 private:
350  DISALLOW_IMPLICIT_CONSTRUCTORS(AccessBuilder);
351};
352
353}  // namespace compiler
354}  // namespace internal
355}  // namespace v8
356
357#endif  // V8_COMPILER_ACCESS_BUILDER_H_
358