Alexander Shabalin
1f1b26f2a5
* A separate RegularWeakReferenceImpl for the new mm. Name is chosen for better consistency with other WeakReferenceImpl implementations. * KRefSharedHolder and BackRefFromAssociatedObject implementations are independent between the legacy and the new mm. * Better support for WeakReference in runtime unit tests.
86 lines
2.4 KiB
C++
86 lines
2.4 KiB
C++
/*
|
|
* Copyright 2010-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
|
|
* that can be found in the LICENSE file.
|
|
*/
|
|
|
|
#ifndef RUNTIME_MEMORYSHAREDREFS_HPP
|
|
#define RUNTIME_MEMORYSHAREDREFS_HPP
|
|
|
|
#include <type_traits>
|
|
|
|
#include "Memory.h"
|
|
|
|
// TODO: Generalize for uses outside this file.
|
|
enum class ErrorPolicy {
|
|
kIgnore, // Ignore any errors. (i.e. unsafe mode)
|
|
kDefaultValue, // Return the default value from the function when an error happens.
|
|
kThrow, // Throw a Kotlin exception when an error happens. The exact exception is chosen by the callee.
|
|
kTerminate, // Terminate immediately when an error happens.
|
|
};
|
|
|
|
class KRefSharedHolder {
|
|
public:
|
|
void initLocal(ObjHeader* obj);
|
|
|
|
void init(ObjHeader* obj);
|
|
|
|
// Error if called from the wrong worker with non-frozen obj_.
|
|
template <ErrorPolicy errorPolicy>
|
|
ObjHeader* ref() const;
|
|
|
|
void dispose();
|
|
|
|
void disposeFromNative() {
|
|
kotlin::CalledFromNativeGuard guard;
|
|
dispose();
|
|
}
|
|
|
|
OBJ_GETTER0(describe) const;
|
|
|
|
private:
|
|
ObjHeader* obj_;
|
|
ForeignRefContext context_;
|
|
};
|
|
|
|
static_assert(std::is_trivially_destructible_v<KRefSharedHolder>, "KRefSharedHolder destructor is not guaranteed to be called.");
|
|
|
|
class BackRefFromAssociatedObject {
|
|
public:
|
|
void initAndAddRef(ObjHeader* obj);
|
|
|
|
// Error if refCount is zero and it's called from the wrong worker with non-frozen obj_.
|
|
template <ErrorPolicy errorPolicy>
|
|
void addRef();
|
|
|
|
// Error if called from the wrong worker with non-frozen obj_.
|
|
template <ErrorPolicy errorPolicy>
|
|
bool tryAddRef();
|
|
|
|
void releaseRef();
|
|
|
|
void detach();
|
|
void assertDetached();
|
|
|
|
// Error if called from the wrong worker with non-frozen obj_.
|
|
template <ErrorPolicy errorPolicy>
|
|
ObjHeader* ref() const;
|
|
|
|
private:
|
|
ObjHeader* obj_; // May be null before [initAndAddRef] or after [detach].
|
|
ForeignRefContext context_;
|
|
volatile int refCount;
|
|
};
|
|
|
|
static_assert(
|
|
std::is_trivially_destructible_v<BackRefFromAssociatedObject>,
|
|
"BackRefFromAssociatedObject destructor is not guaranteed to be called.");
|
|
|
|
extern "C" {
|
|
RUNTIME_NOTHROW void KRefSharedHolder_initLocal(KRefSharedHolder* holder, ObjHeader* obj);
|
|
RUNTIME_NOTHROW void KRefSharedHolder_init(KRefSharedHolder* holder, ObjHeader* obj);
|
|
RUNTIME_NOTHROW void KRefSharedHolder_dispose(KRefSharedHolder* holder);
|
|
RUNTIME_NOTHROW ObjHeader* KRefSharedHolder_ref(const KRefSharedHolder* holder);
|
|
} // extern "C"
|
|
|
|
#endif // RUNTIME_MEMORYSHAREDREFS_HPP
|