blob: c4f26c52aeb91477337b36bb548cfef2a172084d [file] [log] [blame]
/*
* Copyright (C) 2017 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. AND ITS CONTRIBUTORS ``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 ITS 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 "AuxiliaryBarrier.h"
#include <wtf/CagedPtr.h>
namespace JSC {
class JSCell;
class VM;
// This is a convenient combo of AuxiliaryBarrier and CagedPtr.
template<Gigacage::Kind passedKind, typename T, bool shouldTag = false>
class CagedBarrierPtr {
public:
static constexpr Gigacage::Kind kind = passedKind;
using Type = T;
using CagedType = CagedPtr<kind, Type, shouldTag>;
CagedBarrierPtr() = default;
template<typename U>
CagedBarrierPtr(VM& vm, JSCell* cell, U&& value, unsigned size)
{
m_barrier.set(vm, cell, CagedType(std::forward<U>(value), size));
}
void clear() { m_barrier.clear(); }
template<typename U>
void set(VM& vm, JSCell* cell, U&& value, unsigned size)
{
m_barrier.set(vm, cell, CagedType(std::forward<U>(value), size));
}
T* get(unsigned size) const { return m_barrier.get().get(size); }
T* getMayBeNull(unsigned size) const { return m_barrier.get().getMayBeNull(size); }
T* getUnsafe() const { return m_barrier.get().getUnsafe(); }
// We need the template here so that the type of U is deduced at usage time rather than class time. U should always be T.
template<typename U = T>
typename std::enable_if<!std::is_same<void, U>::value, T>::type&
/* T& */ at(unsigned index, unsigned size) const { return get(size)[index]; }
bool operator==(const CagedBarrierPtr& other) const
{
return m_barrier.get() == other.m_barrier.get();
}
bool operator!=(const CagedBarrierPtr& other) const
{
return !(*this == other);
}
explicit operator bool() const
{
return !!m_barrier.get();
}
template<typename U>
void setWithoutBarrier(U&& value, unsigned size) { m_barrier.setWithoutBarrier(CagedType(std::forward<U>(value), size)); }
T* rawBits() const
{
return m_barrier.get().rawBits();
}
private:
AuxiliaryBarrier<CagedType> m_barrier;
};
} // namespace JSC