1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
|
#include <config.h>
#include <glib.h>
#include <js/Class.h>
#include <js/GCAPI.h> // for JS_GC, JS_SetGCCallback, JSGCStatus
#include <js/RootingAPI.h>
#include <js/TypeDecls.h>
#include <js/Value.h>
#include <jsapi.h> // for JS_GetPrivate, JS_NewObject, JS_Set...
#include "cjs/jsapi-util-root.h"
#include "test/gjs-test-utils.h"
// COMPAT: https://gitlab.gnome.org/GNOME/glib/-/merge_requests/1553
#ifdef __clang_analyzer__
void g_assertion_message(const char*, const char*, int, const char*,
const char*) __attribute__((analyzer_noreturn));
#endif
static GMutex gc_lock;
static GCond gc_finished;
static volatile int gc_counter;
#define PARENT(fx) ((GjsUnitTestFixture *)fx)
struct GjsRootingFixture {
GjsUnitTestFixture parent;
bool finalized;
bool notify_called;
GjsMaybeOwned<JSObject *> *obj; /* only used in callback test cases */
};
static void test_obj_finalize(JSFreeOp*, JSObject* obj) {
bool *finalized_p = static_cast<bool *>(JS_GetPrivate(obj));
g_assert_false(*finalized_p);
*finalized_p = true;
}
static const JSClassOps test_obj_class_ops = {
nullptr, // addProperty
nullptr, // deleteProperty
nullptr, // enumerate
nullptr, // newEnumerate
nullptr, // resolve
nullptr, // mayResolve
test_obj_finalize};
static JSClass test_obj_class = {
"TestObj",
JSCLASS_HAS_PRIVATE | JSCLASS_FOREGROUND_FINALIZE,
&test_obj_class_ops
};
static JSObject *
test_obj_new(GjsRootingFixture *fx)
{
JSObject *retval = JS_NewObject(PARENT(fx)->cx, &test_obj_class);
JS_SetPrivate(retval, &fx->finalized);
return retval;
}
static void on_gc(JSContext*, JSGCStatus status, JS::GCReason, void*) {
if (status != JSGC_END)
return;
g_mutex_lock(&gc_lock);
g_atomic_int_inc(&gc_counter);
g_cond_broadcast(&gc_finished);
g_mutex_unlock(&gc_lock);
}
static void
setup(GjsRootingFixture *fx,
gconstpointer unused)
{
gjs_unit_test_fixture_setup(PARENT(fx), unused);
JS_SetGCCallback(PARENT(fx)->cx, on_gc, fx);
}
static void
teardown(GjsRootingFixture *fx,
gconstpointer unused)
{
gjs_unit_test_fixture_teardown(PARENT(fx), unused);
}
static void
wait_for_gc(GjsRootingFixture *fx)
{
int count = g_atomic_int_get(&gc_counter);
JS_GC(PARENT(fx)->cx);
g_mutex_lock(&gc_lock);
while (count == g_atomic_int_get(&gc_counter)) {
g_cond_wait(&gc_finished, &gc_lock);
}
g_mutex_unlock(&gc_lock);
}
static void test_maybe_owned_rooted_flag_set_when_rooted(GjsRootingFixture* fx,
const void*) {
auto obj = new GjsMaybeOwned<JS::Value>();
obj->root(PARENT(fx)->cx, JS::TrueValue());
g_assert_true(obj->rooted());
delete obj;
}
static void test_maybe_owned_rooted_flag_not_set_when_not_rooted(
GjsRootingFixture*, const void*) {
auto obj = new GjsMaybeOwned<JS::Value>();
*obj = JS::TrueValue();
g_assert_false(obj->rooted());
delete obj;
}
static void test_maybe_owned_rooted_keeps_alive_across_gc(GjsRootingFixture* fx,
const void*) {
auto obj = new GjsMaybeOwned<JSObject *>();
obj->root(PARENT(fx)->cx, test_obj_new(fx));
wait_for_gc(fx);
g_assert_false(fx->finalized);
delete obj;
wait_for_gc(fx);
g_assert_true(fx->finalized);
}
static void test_maybe_owned_rooted_is_collected_after_reset(
GjsRootingFixture* fx, const void*) {
auto obj = new GjsMaybeOwned<JSObject *>();
obj->root(PARENT(fx)->cx, test_obj_new(fx));
obj->reset();
wait_for_gc(fx);
g_assert_true(fx->finalized);
delete obj;
}
static void update_weak_pointer(JSContext*, JS::Compartment*, void* data) {
auto* obj = static_cast<GjsMaybeOwned<JSObject*>*>(data);
if (*obj)
obj->update_after_gc();
}
static void test_maybe_owned_weak_pointer_is_collected_by_gc(
GjsRootingFixture* fx, const void*) {
auto obj = new GjsMaybeOwned<JSObject *>();
*obj = test_obj_new(fx);
JS_AddWeakPointerCompartmentCallback(PARENT(fx)->cx, &update_weak_pointer,
obj);
wait_for_gc(fx);
g_assert_true(fx->finalized);
JS_RemoveWeakPointerCompartmentCallback(PARENT(fx)->cx,
&update_weak_pointer);
delete obj;
}
static void test_maybe_owned_heap_rooted_keeps_alive_across_gc(
GjsRootingFixture* fx, const void*) {
auto obj = new GjsMaybeOwned<JSObject *>();
obj->root(PARENT(fx)->cx, test_obj_new(fx));
wait_for_gc(fx);
g_assert_false(fx->finalized);
delete obj;
wait_for_gc(fx);
g_assert_true(fx->finalized);
}
static void test_maybe_owned_switching_mode_keeps_same_value(
GjsRootingFixture* fx, const void*) {
JSObject *test_obj = test_obj_new(fx);
auto obj = new GjsMaybeOwned<JSObject *>();
*obj = test_obj;
g_assert_true(*obj == test_obj);
obj->switch_to_rooted(PARENT(fx)->cx);
g_assert_true(obj->rooted());
g_assert_true(*obj == test_obj);
obj->switch_to_unrooted(PARENT(fx)->cx);
g_assert_false(obj->rooted());
g_assert_true(*obj == test_obj);
delete obj;
}
static void test_maybe_owned_switch_to_rooted_prevents_collection(
GjsRootingFixture* fx, const void*) {
auto obj = new GjsMaybeOwned<JSObject *>();
*obj = test_obj_new(fx);
obj->switch_to_rooted(PARENT(fx)->cx);
wait_for_gc(fx);
g_assert_false(fx->finalized);
delete obj;
}
static void test_maybe_owned_switch_to_unrooted_allows_collection(
GjsRootingFixture* fx, const void*) {
auto obj = new GjsMaybeOwned<JSObject *>();
obj->root(PARENT(fx)->cx, test_obj_new(fx));
obj->switch_to_unrooted(PARENT(fx)->cx);
JS_AddWeakPointerCompartmentCallback(PARENT(fx)->cx, &update_weak_pointer,
obj);
wait_for_gc(fx);
g_assert_true(fx->finalized);
JS_RemoveWeakPointerCompartmentCallback(PARENT(fx)->cx,
&update_weak_pointer);
delete obj;
}
static void context_destroyed(JS::HandleObject, void* data) {
auto fx = static_cast<GjsRootingFixture *>(data);
g_assert_false(fx->notify_called);
g_assert_false(fx->finalized);
fx->notify_called = true;
fx->obj->reset();
}
static void test_maybe_owned_notify_callback_called_on_context_destroy(
GjsRootingFixture* fx, const void*) {
fx->obj = new GjsMaybeOwned<JSObject *>();
fx->obj->root(PARENT(fx)->cx, test_obj_new(fx), context_destroyed, fx);
gjs_unit_test_destroy_context(PARENT(fx));
g_assert_true(fx->notify_called);
delete fx->obj;
}
static void test_maybe_owned_object_destroyed_after_notify(
GjsRootingFixture* fx, const void*) {
fx->obj = new GjsMaybeOwned<JSObject *>();
fx->obj->root(PARENT(fx)->cx, test_obj_new(fx), context_destroyed, fx);
gjs_unit_test_destroy_context(PARENT(fx));
g_assert_true(fx->finalized);
delete fx->obj;
}
void
gjs_test_add_tests_for_rooting(void)
{
#define ADD_ROOTING_TEST(path, f) \
g_test_add("/rooting/" path, GjsRootingFixture, nullptr, setup, f, \
teardown);
ADD_ROOTING_TEST("maybe-owned/rooted-flag-set-when-rooted",
test_maybe_owned_rooted_flag_set_when_rooted);
ADD_ROOTING_TEST("maybe-owned/rooted-flag-not-set-when-not-rooted",
test_maybe_owned_rooted_flag_not_set_when_not_rooted);
ADD_ROOTING_TEST("maybe-owned/rooted-keeps-alive-across-gc",
test_maybe_owned_rooted_keeps_alive_across_gc);
ADD_ROOTING_TEST("maybe-owned/rooted-is-collected-after-reset",
test_maybe_owned_rooted_is_collected_after_reset);
ADD_ROOTING_TEST("maybe-owned/weak-pointer-is-collected-by-gc",
test_maybe_owned_weak_pointer_is_collected_by_gc);
ADD_ROOTING_TEST("maybe-owned/heap-rooted-keeps-alive-across-gc",
test_maybe_owned_heap_rooted_keeps_alive_across_gc);
ADD_ROOTING_TEST("maybe-owned/switching-mode-keeps-same-value",
test_maybe_owned_switching_mode_keeps_same_value);
ADD_ROOTING_TEST("maybe-owned/switch-to-rooted-prevents-collection",
test_maybe_owned_switch_to_rooted_prevents_collection);
ADD_ROOTING_TEST("maybe-owned/switch-to-unrooted-allows-collection",
test_maybe_owned_switch_to_unrooted_allows_collection);
#undef ADD_ROOTING_TEST
#define ADD_CONTEXT_DESTROY_TEST(path, f) \
g_test_add("/rooting/" path, GjsRootingFixture, nullptr, setup, f, nullptr);
ADD_CONTEXT_DESTROY_TEST("maybe-owned/notify-callback-called-on-context-destroy",
test_maybe_owned_notify_callback_called_on_context_destroy);
ADD_CONTEXT_DESTROY_TEST("maybe-owned/object-destroyed-after-notify",
test_maybe_owned_object_destroyed_after_notify);
#undef ADD_CONTEXT_DESTROY_TEST
}
|