Yves
c02a7e1a7b
This upgrade also introduces exact stack rooting (see to the wiki: JSRootingGuide) and fixes problems with moving GC. This allows us to enable generational garbage collection (GGC). Measurements a few months ago have shown a performance improvement of a non-visual replay of around 13.5%. This probably varies quite a bit, but it should be somewhere between 5-20%. Memory usage has also been improved. Check the forum thread for details. Thanks to everyone from the team who helped with this directly or indirectly (review, finding and fixing issues, the required C++11 upgrade, the new autobuilder etc.)! Also thanks to the SpiderMonkey developers who helped on the #jsapi channel or elsewhere! Fixes #2462, #2415, #2428, #2684, #1374 Refs #2973, #2669 This was SVN commit r16214.
102 lines
3.7 KiB
C++
102 lines
3.7 KiB
C++
/* Copyright (C) 2014 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef INCLUDED_SCRIPTRUNTIME
|
|
#define INCLUDED_SCRIPTRUNTIME
|
|
|
|
#include <sstream>
|
|
|
|
#include "ScriptTypes.h"
|
|
#include "ScriptExtraHeaders.h"
|
|
|
|
#define STACK_CHUNK_SIZE 8192
|
|
|
|
/**
|
|
* 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.)
|
|
*/
|
|
|
|
class ScriptRuntime
|
|
{
|
|
public:
|
|
ScriptRuntime(shared_ptr<ScriptRuntime> parentRuntime, int runtimeSize, int heapGrowthBytesGCTrigger);
|
|
~ScriptRuntime();
|
|
|
|
/**
|
|
* MaybeIncrementalRuntimeGC tries to determine whether a runtime-wide garbage collection would free up enough memory to
|
|
* be worth the amount of time it would take. It does this with our own logic and NOT some predefined JSAPI logic because
|
|
* such functionality currently isn't available out of the box.
|
|
* It does incremental GC which means it will collect one slice each time it's called until the garbage collection is done.
|
|
* This can and should be called quite regularly. The delay parameter allows you to specify a minimum time since the last GC
|
|
* in seconds (the delay should be a fraction of a second in most cases though).
|
|
* It will only start a new incremental GC or another GC slice if this time is exceeded. The user of this function is
|
|
* responsible for ensuring that GC can run with a small enough delay to get done with the work.
|
|
*/
|
|
void MaybeIncrementalGC(double delay);
|
|
void ShrinkingGC();
|
|
|
|
void RegisterContext(JSContext* cx);
|
|
void UnRegisterContext(JSContext* cx);
|
|
|
|
/**
|
|
* Registers an object to be freed/finalized by the ScriptRuntime. Freeing is
|
|
* guaranteed to happen after the next minor GC has completed, but might also
|
|
* happen a bit later. This is only needed in very special situations
|
|
* and you should only use it if you know exactly why you need it!
|
|
* Specify a deleter for the shared_ptr to free the void pointer correctly
|
|
* (by casting to the right type before calling delete for example).
|
|
*/
|
|
void AddDeferredFinalizationObject(const std::shared_ptr<void>& obj);
|
|
|
|
JSRuntime* m_rt;
|
|
|
|
private:
|
|
|
|
void PrepareContextsForIncrementalGC();
|
|
void GCCallbackMember();
|
|
|
|
// Workaround for: https://bugzilla.mozilla.org/show_bug.cgi?id=890243
|
|
JSContext* m_dummyContext;
|
|
|
|
std::list<JSContext*> m_Contexts;
|
|
std::vector<std::shared_ptr<void> > m_FinalizationListObjectIdCache;
|
|
static bool m_Initialized;
|
|
|
|
int m_RuntimeSize;
|
|
int m_HeapGrowthBytesGCTrigger;
|
|
int m_LastGCBytes;
|
|
double m_LastGCCheck;
|
|
|
|
static void GCCallback(JSRuntime *rt, JSGCStatus status, void *data);
|
|
|
|
static void* jshook_script(JSContext* UNUSED(cx), JSAbstractFramePtr UNUSED(fp),
|
|
bool UNUSED(isConstructing), bool before,
|
|
bool* UNUSED(ok), void* closure);
|
|
|
|
static void* jshook_function(JSContext* cx, JSAbstractFramePtr fp,
|
|
bool UNUSED(isConstructing), bool before,
|
|
bool* UNUSED(ok), void* closure);
|
|
|
|
};
|
|
|
|
#endif // INCLUDED_SCRIPTRUNTIME
|