2014-11-13 12:19:28 +01:00
|
|
|
/* 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
|
|
|
|
|
2014-11-13 23:37:43 +01:00
|
|
|
#include <sstream>
|
2014-11-13 12:19:28 +01:00
|
|
|
|
|
|
|
#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:
|
2015-01-24 15:46:52 +01:00
|
|
|
ScriptRuntime(shared_ptr<ScriptRuntime> parentRuntime, int runtimeSize, int heapGrowthBytesGCTrigger);
|
2014-11-13 12:19:28 +01:00
|
|
|
~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.
|
2015-01-24 15:46:52 +01:00
|
|
|
*/
|
2014-11-13 12:19:28 +01:00
|
|
|
void MaybeIncrementalGC(double delay);
|
2015-01-24 15:46:52 +01:00
|
|
|
void ShrinkingGC();
|
2014-11-13 12:19:28 +01:00
|
|
|
|
|
|
|
void RegisterContext(JSContext* cx);
|
|
|
|
void UnRegisterContext(JSContext* cx);
|
|
|
|
|
2015-01-24 15:46:52 +01:00
|
|
|
/**
|
|
|
|
* 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);
|
|
|
|
|
2014-11-13 12:19:28 +01:00
|
|
|
JSRuntime* m_rt;
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
void PrepareContextsForIncrementalGC();
|
2015-01-24 15:46:52 +01:00
|
|
|
void GCCallbackMember();
|
2014-11-13 12:19:28 +01:00
|
|
|
|
|
|
|
// Workaround for: https://bugzilla.mozilla.org/show_bug.cgi?id=890243
|
|
|
|
JSContext* m_dummyContext;
|
|
|
|
|
|
|
|
std::list<JSContext*> m_Contexts;
|
2015-01-24 15:46:52 +01:00
|
|
|
std::vector<std::shared_ptr<void> > m_FinalizationListObjectIdCache;
|
|
|
|
static bool m_Initialized;
|
2014-11-13 12:19:28 +01:00
|
|
|
|
|
|
|
int m_RuntimeSize;
|
|
|
|
int m_HeapGrowthBytesGCTrigger;
|
|
|
|
int m_LastGCBytes;
|
|
|
|
double m_LastGCCheck;
|
|
|
|
|
2015-01-24 15:46:52 +01:00
|
|
|
static void GCCallback(JSRuntime *rt, JSGCStatus status, void *data);
|
2014-11-13 12:19:28 +01:00
|
|
|
|
2015-01-24 15:46:52 +01:00
|
|
|
static void* jshook_script(JSContext* UNUSED(cx), JSAbstractFramePtr UNUSED(fp),
|
|
|
|
bool UNUSED(isConstructing), bool before,
|
|
|
|
bool* UNUSED(ok), void* closure);
|
|
|
|
|
2014-11-13 12:19:28 +01:00
|
|
|
static void* jshook_function(JSContext* cx, JSAbstractFramePtr fp,
|
2015-01-24 15:46:52 +01:00
|
|
|
bool UNUSED(isConstructing), bool before,
|
|
|
|
bool* UNUSED(ok), void* closure);
|
2014-11-13 12:19:28 +01:00
|
|
|
|
|
|
|
};
|
|
|
|
|
2015-01-24 15:46:52 +01:00
|
|
|
#endif // INCLUDED_SCRIPTRUNTIME
|