forked from mirrors/0ad
Split ScriptRuntime and ScriptInterface code to separate files.
The runtime is becoming more and more important in the JSAPI. As a result, we also have more functionality on the runtime level and having the whole ScriptRuntime class hidden in ScriptInterface.cpp doesn't make sense anymore. ScriptInterface.cpp also has become quite a large file and pulling out the runtime part makes it a bit smaller. Refs #2462 This was SVN commit r15961.
This commit is contained in:
Yves
@@ -18,6 +18,7 @@
|
||||
#include "precompiled.h"
|
||||
|
||||
#include "ScriptInterface.h"
|
||||
#include "ScriptRuntime.h"
|
||||
// #include "DebuggingServer.h" // JS debugger temporarily disabled during the SpiderMonkey upgrade (check trac ticket #2348 for details)
|
||||
#include "ScriptStats.h"
|
||||
#include "AutoRooters.h"
|
||||
@@ -43,8 +44,6 @@
|
||||
|
||||
#include "valgrind.h"
|
||||
|
||||
#define STACK_CHUNK_SIZE 8192
|
||||
|
||||
#include "scriptinterface/ScriptExtraHeaders.h"
|
||||
|
||||
/**
|
||||
@@ -54,390 +53,6 @@
|
||||
* directly accessing the underlying JS api.
|
||||
*/
|
||||
|
||||
////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
* Abstraction around a SpiderMonkey JSRuntime.
|
||||
* Each ScriptRuntime can be used to initialize several ScriptInterface
|
||||
* contexts which can then share data, but a single ScriptRuntime should
|
||||
* only be used on a single thread.
|
||||
*
|
||||
* (One means to share data between threads and runtimes is to create
|
||||
* a ScriptInterface::StructuredClone.)
|
||||
*/
|
||||
|
||||
|
||||
void GCSliceCallbackHook(JSRuntime* UNUSED(rt), JS::GCProgress progress, const JS::GCDescription& UNUSED(desc))
|
||||
{
|
||||
/*
|
||||
* During non-incremental GC, the GC is bracketed by JSGC_CYCLE_BEGIN/END
|
||||
* callbacks. During an incremental GC, the sequence of callbacks is as
|
||||
* follows:
|
||||
* JSGC_CYCLE_BEGIN, JSGC_SLICE_END (first slice)
|
||||
* JSGC_SLICE_BEGIN, JSGC_SLICE_END (second slice)
|
||||
* ...
|
||||
* JSGC_SLICE_BEGIN, JSGC_CYCLE_END (last slice)
|
||||
*/
|
||||
|
||||
|
||||
if (progress == JS::GC_SLICE_BEGIN)
|
||||
{
|
||||
if (CProfileManager::IsInitialised() && ThreadUtil::IsMainThread())
|
||||
g_Profiler.Start("GCSlice");
|
||||
g_Profiler2.RecordRegionEnter("GCSlice");
|
||||
}
|
||||
else if (progress == JS::GC_SLICE_END)
|
||||
{
|
||||
if (CProfileManager::IsInitialised() && ThreadUtil::IsMainThread())
|
||||
g_Profiler.Stop();
|
||||
g_Profiler2.RecordRegionLeave("GCSlice");
|
||||
}
|
||||
else if (progress == JS::GC_CYCLE_BEGIN)
|
||||
{
|
||||
if (CProfileManager::IsInitialised() && ThreadUtil::IsMainThread())
|
||||
g_Profiler.Start("GCSlice");
|
||||
g_Profiler2.RecordRegionEnter("GCSlice");
|
||||
}
|
||||
else if (progress == JS::GC_CYCLE_END)
|
||||
{
|
||||
if (CProfileManager::IsInitialised() && ThreadUtil::IsMainThread())
|
||||
g_Profiler.Stop();
|
||||
g_Profiler2.RecordRegionLeave("GCSlice");
|
||||
}
|
||||
|
||||
// The following code can be used to print some information aobut garbage collection
|
||||
// Search for "Nonincremental reason" if there are problems running GC incrementally.
|
||||
#if 0
|
||||
if (progress == JS::GCProgress::GC_CYCLE_BEGIN)
|
||||
printf("starting cycle ===========================================\n");
|
||||
|
||||
const jschar* str = desc.formatMessage(rt);
|
||||
int len = 0;
|
||||
|
||||
for(int i = 0; i < 10000; i++)
|
||||
{
|
||||
len++;
|
||||
if(!str[i])
|
||||
break;
|
||||
}
|
||||
|
||||
wchar_t outstring[len];
|
||||
|
||||
for(int i = 0; i < len; i++)
|
||||
{
|
||||
outstring[i] = (wchar_t)str[i];
|
||||
}
|
||||
|
||||
printf("---------------------------------------\n: %ls \n---------------------------------------\n", outstring);
|
||||
#endif
|
||||
}
|
||||
|
||||
class ScriptRuntime
|
||||
{
|
||||
public:
|
||||
ScriptRuntime(int runtimeSize, int heapGrowthBytesGCTrigger):
|
||||
m_rooter(NULL),
|
||||
m_LastGCBytes(0),
|
||||
m_LastGCCheck(0.0f),
|
||||
m_HeapGrowthBytesGCTrigger(heapGrowthBytesGCTrigger),
|
||||
m_RuntimeSize(runtimeSize)
|
||||
{
|
||||
m_rt = JS_NewRuntime(runtimeSize, JS_USE_HELPER_THREADS);
|
||||
|
||||
ENSURE(m_rt); // TODO: error handling
|
||||
|
||||
JS_SetNativeStackQuota(m_rt, 128 * sizeof(size_t) * 1024);
|
||||
if (g_ScriptProfilingEnabled)
|
||||
{
|
||||
// Profiler isn't thread-safe, so only enable this on the main thread
|
||||
if (ThreadUtil::IsMainThread())
|
||||
{
|
||||
if (CProfileManager::IsInitialised())
|
||||
{
|
||||
JS_SetExecuteHook(m_rt, jshook_script, this);
|
||||
JS_SetCallHook(m_rt, jshook_function, this);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
JS::SetGCSliceCallback(m_rt, GCSliceCallbackHook);
|
||||
|
||||
JS_SetGCParameter(m_rt, JSGC_MAX_MALLOC_BYTES, m_RuntimeSize);
|
||||
JS_SetGCParameter(m_rt, JSGC_MAX_BYTES, m_RuntimeSize);
|
||||
JS_SetGCParameter(m_rt, JSGC_MODE, JSGC_MODE_INCREMENTAL);
|
||||
|
||||
// The whole heap-growth mechanism seems to work only for non-incremental GCs.
|
||||
// We disable it to make it more clear if full GCs happen triggered by this JSAPI internal mechanism.
|
||||
JS_SetGCParameter(m_rt, JSGC_DYNAMIC_HEAP_GROWTH, false);
|
||||
|
||||
JS_AddExtraGCRootsTracer(m_rt, jshook_trace, this);
|
||||
|
||||
m_dummyContext = JS_NewContext(m_rt, STACK_CHUNK_SIZE);
|
||||
ENSURE(m_dummyContext);
|
||||
}
|
||||
|
||||
#define GC_DEBUG_PRINT 0
|
||||
void MaybeIncrementalGC(double delay)
|
||||
{
|
||||
PROFILE2("MaybeIncrementalGC");
|
||||
|
||||
if (JS::IsIncrementalGCEnabled(m_rt))
|
||||
{
|
||||
// The idea is to get the heap size after a completed GC and trigger the next GC when the heap size has
|
||||
// reached m_LastGCBytes + X.
|
||||
// In practice it doesn't quite work like that. When the incremental marking is completed, the sweeping kicks in.
|
||||
// The sweeping actually frees memory and it does this in a background thread (if JS_USE_HELPER_THREADS is set).
|
||||
// While the sweeping is happening we already run scripts again and produce new garbage.
|
||||
|
||||
const int GCSliceTimeBudget = 30; // Milliseconds an incremental slice is allowed to run
|
||||
|
||||
// Have a minimum time in seconds to wait between GC slices and before starting a new GC to distribute the GC
|
||||
// load and to hopefully make it unnoticeable for the player. This value should be high enough to distribute
|
||||
// the load well enough and low enough to make sure we don't run out of memory before we can start with the
|
||||
// sweeping.
|
||||
if (timer_Time() - m_LastGCCheck < delay)
|
||||
return;
|
||||
|
||||
m_LastGCCheck = timer_Time();
|
||||
|
||||
int gcBytes = JS_GetGCParameter(m_rt, JSGC_BYTES);
|
||||
|
||||
#if GC_DEBUG_PRINT
|
||||
std::cout << "gcBytes: " << gcBytes / 1024 << " KB" << std::endl;
|
||||
#endif
|
||||
|
||||
if (m_LastGCBytes > gcBytes || m_LastGCBytes == 0)
|
||||
{
|
||||
#if GC_DEBUG_PRINT
|
||||
printf("Setting m_LastGCBytes: %d KB \n", gcBytes / 1024);
|
||||
#endif
|
||||
m_LastGCBytes = gcBytes;
|
||||
}
|
||||
|
||||
// Run an additional incremental GC slice if the currently running incremental GC isn't over yet
|
||||
// ... or
|
||||
// start a new incremental GC if the JS heap size has grown enough for a GC to make sense
|
||||
if (JS::IsIncrementalGCInProgress(m_rt) || (gcBytes - m_LastGCBytes > m_HeapGrowthBytesGCTrigger))
|
||||
{
|
||||
#if GC_DEBUG_PRINT
|
||||
if (JS::IsIncrementalGCInProgress(m_rt))
|
||||
printf("An incremental GC cycle is in progress. \n");
|
||||
else
|
||||
printf("GC needed because JSGC_BYTES - m_LastGCBytes > m_HeapGrowthBytesGCTrigger \n"
|
||||
" JSGC_BYTES: %d KB \n m_LastGCBytes: %d KB \n m_HeapGrowthBytesGCTrigger: %d KB \n",
|
||||
gcBytes / 1024,
|
||||
m_LastGCBytes / 1024,
|
||||
m_HeapGrowthBytesGCTrigger / 1024);
|
||||
#endif
|
||||
|
||||
// A hack to make sure we never exceed the runtime size because we can't collect the memory
|
||||
// fast enough.
|
||||
if(gcBytes > m_RuntimeSize / 2)
|
||||
{
|
||||
if (JS::IsIncrementalGCInProgress(m_rt))
|
||||
{
|
||||
#if GC_DEBUG_PRINT
|
||||
printf("Finishing incremental GC because gcBytes > m_RuntimeSize / 2. \n");
|
||||
#endif
|
||||
PrepareContextsForIncrementalGC();
|
||||
JS::FinishIncrementalGC(m_rt, JS::gcreason::REFRESH_FRAME);
|
||||
}
|
||||
else
|
||||
{
|
||||
#if GC_DEBUG_PRINT
|
||||
printf("Running full GC because gcBytes > m_RuntimeSize / 2. \n");
|
||||
#endif
|
||||
JS_GC(m_rt);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
#if GC_DEBUG_PRINT
|
||||
if (!JS::IsIncrementalGCInProgress(m_rt))
|
||||
printf("Starting incremental GC \n");
|
||||
else
|
||||
printf("Running incremental GC slice \n");
|
||||
#endif
|
||||
PrepareContextsForIncrementalGC();
|
||||
JS::IncrementalGC(m_rt, JS::gcreason::REFRESH_FRAME, GCSliceTimeBudget);
|
||||
}
|
||||
m_LastGCBytes = gcBytes;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void RegisterContext(JSContext* cx)
|
||||
{
|
||||
m_Contexts.push_back(cx);
|
||||
}
|
||||
|
||||
void UnRegisterContext(JSContext* cx)
|
||||
{
|
||||
m_Contexts.remove(cx);
|
||||
}
|
||||
|
||||
~ScriptRuntime()
|
||||
{
|
||||
JS_RemoveExtraGCRootsTracer(m_rt, jshook_trace, this);
|
||||
JS_DestroyContext(m_dummyContext);
|
||||
JS_DestroyRuntime(m_rt);
|
||||
}
|
||||
|
||||
JSRuntime* m_rt;
|
||||
AutoGCRooter* m_rooter;
|
||||
|
||||
private:
|
||||
|
||||
// Workaround for: https://bugzilla.mozilla.org/show_bug.cgi?id=890243
|
||||
JSContext* m_dummyContext;
|
||||
|
||||
int m_RuntimeSize;
|
||||
int m_HeapGrowthBytesGCTrigger;
|
||||
int m_LastGCBytes;
|
||||
double m_LastGCCheck;
|
||||
|
||||
void PrepareContextsForIncrementalGC()
|
||||
{
|
||||
for (std::list<JSContext*>::iterator itr = m_Contexts.begin(); itr != m_Contexts.end(); itr++)
|
||||
{
|
||||
JS::PrepareZoneForGC(js::GetCompartmentZone(js::GetContextCompartment(*itr)));
|
||||
}
|
||||
}
|
||||
|
||||
std::list<JSContext*> m_Contexts;
|
||||
|
||||
|
||||
static void* jshook_script(JSContext* UNUSED(cx), JSAbstractFramePtr UNUSED(fp), bool UNUSED(isConstructing), JSBool before, JSBool* UNUSED(ok), void* closure)
|
||||
{
|
||||
if (before)
|
||||
g_Profiler.StartScript("script invocation");
|
||||
else
|
||||
g_Profiler.Stop();
|
||||
|
||||
return closure;
|
||||
}
|
||||
|
||||
// To profile scripts usefully, we use a call hook that's called on every enter/exit,
|
||||
// and need to find the function name. But most functions are anonymous so we make do
|
||||
// with filename plus line number instead.
|
||||
// Computing the names is fairly expensive, and we need to return an interned char*
|
||||
// for the profiler to hold a copy of, so we use boost::flyweight to construct interned
|
||||
// strings per call location.
|
||||
|
||||
// Identifies a location in a script
|
||||
struct ScriptLocation
|
||||
{
|
||||
JSContext* cx;
|
||||
JSScript* script;
|
||||
jsbytecode* pc;
|
||||
|
||||
bool operator==(const ScriptLocation& b) const
|
||||
{
|
||||
return cx == b.cx && script == b.script && pc == b.pc;
|
||||
}
|
||||
|
||||
friend std::size_t hash_value(const ScriptLocation& loc)
|
||||
{
|
||||
std::size_t seed = 0;
|
||||
boost::hash_combine(seed, loc.cx);
|
||||
boost::hash_combine(seed, loc.script);
|
||||
boost::hash_combine(seed, loc.pc);
|
||||
return seed;
|
||||
}
|
||||
};
|
||||
|
||||
// Computes and stores the name of a location in a script
|
||||
struct ScriptLocationName
|
||||
{
|
||||
ScriptLocationName(const ScriptLocation& loc)
|
||||
{
|
||||
JSContext* cx = loc.cx;
|
||||
JSScript* script = loc.script;
|
||||
jsbytecode* pc = loc.pc;
|
||||
|
||||
std::string filename = JS_GetScriptFilename(cx, script);
|
||||
size_t slash = filename.rfind('/');
|
||||
if (slash != filename.npos)
|
||||
filename = filename.substr(slash+1);
|
||||
|
||||
uint line = JS_PCToLineNumber(cx, script, pc);
|
||||
|
||||
std::stringstream ss;
|
||||
ss << "(" << filename << ":" << line << ")";
|
||||
name = ss.str();
|
||||
}
|
||||
|
||||
std::string name;
|
||||
};
|
||||
|
||||
// Flyweight types (with no_locking because the call hooks are only used in the
|
||||
// main thread, and no_tracking because we mustn't delete values the profiler is
|
||||
// using and it's not going to waste much memory)
|
||||
typedef boost::flyweight<
|
||||
std::string,
|
||||
boost::flyweights::no_tracking,
|
||||
boost::flyweights::no_locking
|
||||
> StringFlyweight;
|
||||
typedef boost::flyweight<
|
||||
boost::flyweights::key_value<ScriptLocation, ScriptLocationName>,
|
||||
boost::flyweights::no_tracking,
|
||||
boost::flyweights::no_locking
|
||||
> LocFlyweight;
|
||||
|
||||
static void* jshook_function(JSContext* cx, JSAbstractFramePtr fp, bool UNUSED(isConstructing), JSBool before, JSBool* UNUSED(ok), void* closure)
|
||||
{
|
||||
if (!before)
|
||||
{
|
||||
g_Profiler.Stop();
|
||||
return closure;
|
||||
}
|
||||
|
||||
JSFunction* fn = fp.maybeFun();
|
||||
if (!fn)
|
||||
{
|
||||
g_Profiler.StartScript("(function)");
|
||||
return closure;
|
||||
}
|
||||
|
||||
// Try to get the name of non-anonymous functions
|
||||
JSString* name = JS_GetFunctionId(fn);
|
||||
if (name)
|
||||
{
|
||||
char* chars = JS_EncodeString(cx, name);
|
||||
if (chars)
|
||||
{
|
||||
g_Profiler.StartScript(StringFlyweight(chars).get().c_str());
|
||||
JS_free(cx, chars);
|
||||
return closure;
|
||||
}
|
||||
}
|
||||
|
||||
// No name - compute from the location instead
|
||||
JSScript* script;
|
||||
uint lineno;
|
||||
JS_DescribeScriptedCaller(cx, &script, &lineno);
|
||||
ENSURE(script == fp.script());
|
||||
ScriptLocation loc = { cx, fp.script(), JS_LineNumberToPC(cx, script, lineno) };
|
||||
g_Profiler.StartScript(LocFlyweight(loc).get().name.c_str());
|
||||
|
||||
return closure;
|
||||
}
|
||||
|
||||
static void jshook_trace(JSTracer* trc, void* data)
|
||||
{
|
||||
ScriptRuntime* m = static_cast<ScriptRuntime*>(data);
|
||||
|
||||
if (m->m_rooter)
|
||||
m->m_rooter->Trace(trc);
|
||||
}
|
||||
};
|
||||
|
||||
shared_ptr<ScriptRuntime> ScriptInterface::CreateRuntime(int runtimeSize, int heapGrowthBytesGCTrigger)
|
||||
{
|
||||
return shared_ptr<ScriptRuntime>(new ScriptRuntime(runtimeSize, heapGrowthBytesGCTrigger));
|
||||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////
|
||||
|
||||
struct ScriptInterface_impl
|
||||
{
|
||||
@@ -1227,6 +842,11 @@ bool ScriptInterface::LoadScript(const VfsPath& filename, const std::string& cod
|
||||
return ok;
|
||||
}
|
||||
|
||||
shared_ptr<ScriptRuntime> ScriptInterface::CreateRuntime(int runtimeSize, int heapGrowthBytesGCTrigger)
|
||||
{
|
||||
return shared_ptr<ScriptRuntime>(new ScriptRuntime(runtimeSize, heapGrowthBytesGCTrigger));
|
||||
}
|
||||
|
||||
bool ScriptInterface::LoadGlobalScript(const VfsPath& filename, const std::wstring& code)
|
||||
{
|
||||
JSAutoRequest rq(m->m_cx);
|
||||
@@ -1477,11 +1097,6 @@ void ScriptInterface::DumpHeap()
|
||||
fprintf(stderr, "# Bytes allocated after GC: %u\n", JS_GetGCParameter(GetJSRuntime(), JSGC_BYTES));
|
||||
}
|
||||
|
||||
void ScriptInterface::MaybeIncrementalRuntimeGC(double delay)
|
||||
{
|
||||
m->m_runtime->MaybeIncrementalGC(delay);
|
||||
}
|
||||
|
||||
void ScriptInterface::MaybeGC()
|
||||
{
|
||||
JS_MaybeGC(m->m_cx);
|
||||
|
||||
Reference in New Issue
Block a user