1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/js/src/jsapi-tests/testGCFinalizeCallback.cpp Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,173 @@
1.4 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.5 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.6 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.7 +
1.8 +#include "jsapi-tests/tests.h"
1.9 +
1.10 +static const unsigned BufferSize = 20;
1.11 +static unsigned FinalizeCalls = 0;
1.12 +static JSFinalizeStatus StatusBuffer[BufferSize];
1.13 +static bool IsCompartmentGCBuffer[BufferSize];
1.14 +
1.15 +BEGIN_TEST(testGCFinalizeCallback)
1.16 +{
1.17 + JS_SetGCParameter(rt, JSGC_MODE, JSGC_MODE_INCREMENTAL);
1.18 + JS_SetFinalizeCallback(rt, FinalizeCallback);
1.19 +
1.20 + /* Full GC, non-incremental. */
1.21 + FinalizeCalls = 0;
1.22 + JS_GC(rt);
1.23 + CHECK(rt->gcIsFull);
1.24 + CHECK(checkSingleGroup());
1.25 + CHECK(checkFinalizeStatus());
1.26 + CHECK(checkFinalizeIsCompartmentGC(false));
1.27 +
1.28 + /* Full GC, incremental. */
1.29 + FinalizeCalls = 0;
1.30 + JS::PrepareForFullGC(rt);
1.31 + JS::IncrementalGC(rt, JS::gcreason::API, 1000000);
1.32 + CHECK(rt->gcIncrementalState == js::gc::NO_INCREMENTAL);
1.33 + CHECK(rt->gcIsFull);
1.34 + CHECK(checkMultipleGroups());
1.35 + CHECK(checkFinalizeStatus());
1.36 + CHECK(checkFinalizeIsCompartmentGC(false));
1.37 +
1.38 + JS::RootedObject global1(cx, createGlobal());
1.39 + JS::RootedObject global2(cx, createGlobal());
1.40 + JS::RootedObject global3(cx, createGlobal());
1.41 + CHECK(global1);
1.42 + CHECK(global2);
1.43 + CHECK(global3);
1.44 +
1.45 + /* Compartment GC, non-incremental, single compartment. */
1.46 + FinalizeCalls = 0;
1.47 + JS::PrepareZoneForGC(global1->zone());
1.48 + JS::GCForReason(rt, JS::gcreason::API);
1.49 + CHECK(!rt->gcIsFull);
1.50 + CHECK(checkSingleGroup());
1.51 + CHECK(checkFinalizeStatus());
1.52 + CHECK(checkFinalizeIsCompartmentGC(true));
1.53 +
1.54 + /* Compartment GC, non-incremental, multiple compartments. */
1.55 + FinalizeCalls = 0;
1.56 + JS::PrepareZoneForGC(global1->zone());
1.57 + JS::PrepareZoneForGC(global2->zone());
1.58 + JS::PrepareZoneForGC(global3->zone());
1.59 + JS::GCForReason(rt, JS::gcreason::API);
1.60 + CHECK(!rt->gcIsFull);
1.61 + CHECK(checkSingleGroup());
1.62 + CHECK(checkFinalizeStatus());
1.63 + CHECK(checkFinalizeIsCompartmentGC(true));
1.64 +
1.65 + /* Compartment GC, incremental, single compartment. */
1.66 + FinalizeCalls = 0;
1.67 + JS::PrepareZoneForGC(global1->zone());
1.68 + JS::IncrementalGC(rt, JS::gcreason::API, 1000000);
1.69 + CHECK(rt->gcIncrementalState == js::gc::NO_INCREMENTAL);
1.70 + CHECK(!rt->gcIsFull);
1.71 + CHECK(checkSingleGroup());
1.72 + CHECK(checkFinalizeStatus());
1.73 + CHECK(checkFinalizeIsCompartmentGC(true));
1.74 +
1.75 + /* Compartment GC, incremental, multiple compartments. */
1.76 + FinalizeCalls = 0;
1.77 + JS::PrepareZoneForGC(global1->zone());
1.78 + JS::PrepareZoneForGC(global2->zone());
1.79 + JS::PrepareZoneForGC(global3->zone());
1.80 + JS::IncrementalGC(rt, JS::gcreason::API, 1000000);
1.81 + CHECK(rt->gcIncrementalState == js::gc::NO_INCREMENTAL);
1.82 + CHECK(!rt->gcIsFull);
1.83 + CHECK(checkMultipleGroups());
1.84 + CHECK(checkFinalizeStatus());
1.85 + CHECK(checkFinalizeIsCompartmentGC(true));
1.86 +
1.87 +#ifdef JS_GC_ZEAL
1.88 +
1.89 + /* Full GC with reset due to new compartment, becoming compartment GC. */
1.90 +
1.91 + FinalizeCalls = 0;
1.92 + JS_SetGCZeal(cx, 9, 1000000);
1.93 + JS::PrepareForFullGC(rt);
1.94 + js::GCDebugSlice(rt, true, 1);
1.95 + CHECK(rt->gcIncrementalState == js::gc::MARK);
1.96 + CHECK(rt->gcIsFull);
1.97 +
1.98 + JS::RootedObject global4(cx, createGlobal());
1.99 + js::GCDebugSlice(rt, true, 1);
1.100 + CHECK(rt->gcIncrementalState == js::gc::NO_INCREMENTAL);
1.101 + CHECK(!rt->gcIsFull);
1.102 + CHECK(checkMultipleGroups());
1.103 + CHECK(checkFinalizeStatus());
1.104 +
1.105 + for (unsigned i = 0; i < FinalizeCalls - 1; ++i)
1.106 + CHECK(!IsCompartmentGCBuffer[i]);
1.107 + CHECK(IsCompartmentGCBuffer[FinalizeCalls - 1]);
1.108 +
1.109 + JS_SetGCZeal(cx, 0, 0);
1.110 +
1.111 +#endif
1.112 +
1.113 + /*
1.114 + * Make some use of the globals here to ensure the compiler doesn't optimize
1.115 + * them away in release builds, causing the compartments to be collected and
1.116 + * the test to fail.
1.117 + */
1.118 + CHECK(JS_IsGlobalObject(global1));
1.119 + CHECK(JS_IsGlobalObject(global2));
1.120 + CHECK(JS_IsGlobalObject(global3));
1.121 +
1.122 + JS_SetFinalizeCallback(rt, nullptr);
1.123 + return true;
1.124 +}
1.125 +
1.126 +bool checkSingleGroup()
1.127 +{
1.128 + CHECK(FinalizeCalls < BufferSize);
1.129 + CHECK(FinalizeCalls == 3);
1.130 + return true;
1.131 +}
1.132 +
1.133 +bool checkMultipleGroups()
1.134 +{
1.135 + CHECK(FinalizeCalls < BufferSize);
1.136 + CHECK(FinalizeCalls % 2 == 1);
1.137 + CHECK((FinalizeCalls - 1) / 2 > 1);
1.138 + return true;
1.139 +}
1.140 +
1.141 +bool checkFinalizeStatus()
1.142 +{
1.143 + /*
1.144 + * The finalize callback should be called twice for each compartment group
1.145 + * finalized, with status JSFINALIZE_GROUP_START and JSFINALIZE_GROUP_END,
1.146 + * and then once more with JSFINALIZE_COLLECTION_END.
1.147 + */
1.148 +
1.149 + for (unsigned i = 0; i < FinalizeCalls - 1; i += 2) {
1.150 + CHECK(StatusBuffer[i] == JSFINALIZE_GROUP_START);
1.151 + CHECK(StatusBuffer[i + 1] == JSFINALIZE_GROUP_END);
1.152 + }
1.153 +
1.154 + CHECK(StatusBuffer[FinalizeCalls - 1] == JSFINALIZE_COLLECTION_END);
1.155 +
1.156 + return true;
1.157 +}
1.158 +
1.159 +bool checkFinalizeIsCompartmentGC(bool isCompartmentGC)
1.160 +{
1.161 + for (unsigned i = 0; i < FinalizeCalls; ++i)
1.162 + CHECK(IsCompartmentGCBuffer[i] == isCompartmentGC);
1.163 +
1.164 + return true;
1.165 +}
1.166 +
1.167 +static void
1.168 +FinalizeCallback(JSFreeOp *fop, JSFinalizeStatus status, bool isCompartmentGC)
1.169 +{
1.170 + if (FinalizeCalls < BufferSize) {
1.171 + StatusBuffer[FinalizeCalls] = status;
1.172 + IsCompartmentGCBuffer[FinalizeCalls] = isCompartmentGC;
1.173 + }
1.174 + ++FinalizeCalls;
1.175 +}
1.176 +END_TEST(testGCFinalizeCallback)
