blob: 6045d7b092811f545a3668c7c9993a7aa98c3721 [file] [log] [blame]
/*
* Copyright (C) 2018-2021 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. ``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
* 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 "Butterfly.h"
#include "IndexingHeader.h"
#include "JSCJSValueInlines.h"
#include "JSCell.h"
#include "Structure.h"
#include "VirtualRegister.h"
namespace JSC {
class JSImmutableButterfly : public JSCell {
using Base = JSCell;
public:
static constexpr unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
DECLARE_INFO;
static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype, IndexingType indexingType)
{
return Structure::create(vm, globalObject, prototype, TypeInfo(JSImmutableButterflyType, StructureFlags), info(), indexingType);
}
ALWAYS_INLINE static JSImmutableButterfly* tryCreate(VM& vm, Structure* structure, unsigned length)
{
if (UNLIKELY(length > IndexingHeader::maximumLength))
return nullptr;
// Because of the above maximumLength requirement, allocationSize can never overflow.
void* buffer = tryAllocateCell<JSImmutableButterfly>(vm, allocationSize(length));
if (UNLIKELY(!buffer))
return nullptr;
JSImmutableButterfly* result = new (NotNull, buffer) JSImmutableButterfly(vm, structure, length);
result->finishCreation(vm);
return result;
}
static JSImmutableButterfly* create(VM& vm, IndexingType indexingType, unsigned length)
{
auto* array = tryCreate(vm, vm.immutableButterflyStructures[arrayIndexFromIndexingType(indexingType) - NumberOfIndexingShapes].get(), length);
RELEASE_ASSERT(array);
return array;
}
ALWAYS_INLINE static JSImmutableButterfly* createFromArray(JSGlobalObject* globalObject, VM& vm, JSArray* array)
{
auto throwScope = DECLARE_THROW_SCOPE(vm);
IndexingType indexingType = array->indexingType() & IndexingShapeMask;
unsigned length = array->length();
// FIXME: JSImmutableButterfly::createFromArray should support re-using non contiguous indexing types as well.
if (isCopyOnWrite(indexingType)) {
if (hasContiguous(indexingType))
return JSImmutableButterfly::fromButterfly(array->butterfly());
}
JSImmutableButterfly* result = JSImmutableButterfly::tryCreate(vm, vm.immutableButterflyStructures[arrayIndexFromIndexingType(CopyOnWriteArrayWithContiguous) - NumberOfIndexingShapes].get(), length);
if (UNLIKELY(!result)) {
throwOutOfMemoryError(globalObject, throwScope);
return nullptr;
}
if (!length)
return result;
if (indexingType == ContiguousShape || indexingType == Int32Shape) {
for (unsigned i = 0; i < length; i++) {
JSValue value = array->butterfly()->contiguous().at(array, i).get();
value = !!value ? value : jsUndefined();
result->setIndex(vm, i, value);
}
return result;
}
if (indexingType == DoubleShape) {
for (unsigned i = 0; i < length; i++) {
double d = array->butterfly()->contiguousDouble().at(array, i);
JSValue value = std::isnan(d) ? jsUndefined() : JSValue(JSValue::EncodeAsDouble, d);
result->setIndex(vm, i, value);
}
return result;
}
for (unsigned i = 0; i < length; i++) {
JSValue value = array->getDirectIndex(globalObject, i);
if (!value) {
// When we see a hole, we assume that it's safe to assume the get would have returned undefined.
// We may still call into this function when !globalObject->isArrayIteratorProtocolFastAndNonObservable(),
// however, if we do that, we ensure we're calling in with an array with all self properties between
// [0, length).
//
// We may also call into this during OSR exit to materialize a phantom fixed array.
// We may be creating a fixed array during OSR exit even after the iterator protocol changed.
// But, when the phantom would have logically been created, the protocol hadn't been
// changed. Therefore, it is sound to assume empty indices are jsUndefined().
value = jsUndefined();
}
RETURN_IF_EXCEPTION(throwScope, nullptr);
result->setIndex(vm, i, value);
}
return result;
}
unsigned publicLength() const { return m_header.publicLength(); }
unsigned vectorLength() const { return m_header.vectorLength(); }
unsigned length() const { return m_header.publicLength(); }
Butterfly* toButterfly() const { return bitwise_cast<Butterfly*>(bitwise_cast<char*>(this) + offsetOfData()); }
static JSImmutableButterfly* fromButterfly(Butterfly* butterfly) { return bitwise_cast<JSImmutableButterfly*>(bitwise_cast<char*>(butterfly) - offsetOfData()); }
JSValue get(unsigned index) const
{
if (!hasDouble(indexingMode()))
return toButterfly()->contiguous().at(this, index).get();
double value = toButterfly()->contiguousDouble().at(this, index);
// Holes are not supported yet.
ASSERT(!std::isnan(value));
return jsDoubleNumber(value);
}
DECLARE_VISIT_CHILDREN;
void copyToArguments(JSGlobalObject*, JSValue* firstElementDest, unsigned offset, unsigned length);
template<typename, SubspaceAccess>
static CompleteSubspace* subspaceFor(VM& vm)
{
// We allocate out of the JSValue gigacage as other code expects all butterflies to live there.
return &vm.immutableButterflyJSValueGigacageAuxiliarySpace();
}
// Only call this if you just allocated this butterfly.
void setIndex(VM& vm, unsigned index, JSValue value)
{
if (hasDouble(indexingType()))
toButterfly()->contiguousDouble().atUnsafe(index) = value.asNumber();
else
toButterfly()->contiguous().atUnsafe(index).set(vm, this, value);
}
static constexpr size_t offsetOfData()
{
return WTF::roundUpToMultipleOf<sizeof(WriteBarrier<Unknown>)>(sizeof(JSImmutableButterfly));
}
static ptrdiff_t offsetOfPublicLength()
{
return OBJECT_OFFSETOF(JSImmutableButterfly, m_header) + IndexingHeader::offsetOfPublicLength();
}
static ptrdiff_t offsetOfVectorLength()
{
return OBJECT_OFFSETOF(JSImmutableButterfly, m_header) + IndexingHeader::offsetOfVectorLength();
}
static Checked<size_t> allocationSize(Checked<size_t> numItems)
{
return offsetOfData() + numItems * sizeof(WriteBarrier<Unknown>);
}
private:
JSImmutableButterfly(VM& vm, Structure* structure, unsigned length)
: Base(vm, structure)
{
m_header.setVectorLength(length);
m_header.setPublicLength(length);
if (hasContiguous(indexingType())) {
for (unsigned index = 0; index < length; ++index)
toButterfly()->contiguous().at(this, index).setStartingValue(JSValue());
}
}
IndexingHeader m_header;
};
} // namespace JSC