OOJSEngineTimeManagement.h File Reference

import "OOJavaScriptEngine.h"
import "OOProfilingStopwatch.h"

Include dependency graph for OOJSEngineTimeManagement.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	OOTimeProfile
class	OOTimeProfileEntry

Macros
#define	OOJSStartTimeLimiter()
#define	OOJSStartTimeLimiterWithTimeLimit(limit)
#define	OOJSStopTimeLimiter()
#define	kOOJSLongTimeLimit   (5.0)

Functions
void	OOJSStartTimeLimiterWithTimeLimit_ (OOTimeDelta limit, const char *file, unsigned line)
void	OOJSStopTimeLimiter_ (const char *file, unsigned line)
void	OOJSBeginProfiling (BOOL trace)
OOTimeProfile *	OOJSEndProfiling (void)
BOOL	OOJSIsProfiling (void)
OOHighResTimeValue	OOJSCopyTimeLimiterNominalStartTime (void)
void	OOJSResetTimeLimiter (void)
OOTimeDelta	OOJSGetTimeLimiterLimit (void)
void	OOJSSetTimeLimiterLimit (OOTimeDelta limit)
void	OOJSTimeManagementInit (OOJavaScriptEngine *engine, JSRuntime *runtime)

Macro Definition Documentation

kOOJSLongTimeLimit

#define kOOJSLongTimeLimit   (5.0)

Definition at line 63 of file OOJSEngineTimeManagement.h.

Referenced by PlayerEntity::docked, OOJSScript::initWithPath:properties:, and OODebugMonitor::performJSConsoleCommand:.

OOJSStartTimeLimiter

#define OOJSStartTimeLimiter

(

)

Value:

OOJSStartTimeLimiterWithTimeLimit(0.0)

Definition at line 50 of file OOJSEngineTimeManagement.h.

Referenced by OOJavaScriptEngine::callJSFunction:forObject:argc:argv:result:, OOJSScript::callMethod:inContext:withArguments:count:result:, OOJSFunction::evaluateWithContext:scope:argc:argv:result:, JSFunctionPredicate(), and OOStringFromDeciCredits().

OOJSStartTimeLimiterWithTimeLimit

#define OOJSStartTimeLimiterWithTimeLimit

(

limit

)

Value:

OOJSStartTimeLimiterWithTimeLimit_(limit, OOLOG_FILE_NAME, __LINE__)

Definition at line 53 of file OOJSEngineTimeManagement.h.

Referenced by PlayerEntity::docked, PlayerEntity::doWorldScriptEvent:inContext:withArguments:count:timeLimit:, OOJSScript::initWithPath:properties:, OOJSFrameCallbacksInvoke(), and OODebugMonitor::performJSConsoleCommand:.

OOJSStopTimeLimiter

#define OOJSStopTimeLimiter

(

)

Value:

OOJSStopTimeLimiter_(OOLOG_FILE_NAME, __LINE__)

Definition at line 54 of file OOJSEngineTimeManagement.h.

Referenced by OOJavaScriptEngine::callJSFunction:forObject:argc:argv:result:, OOJSScript::callMethod:inContext:withArguments:count:result:, PlayerEntity::docked, PlayerEntity::doWorldScriptEvent:inContext:withArguments:count:timeLimit:, OOJSFunction::evaluateWithContext:scope:argc:argv:result:, OOJSScript::initWithPath:properties:, JSFunctionPredicate(), OOJSFrameCallbacksInvoke(), OOStringFromDeciCredits(), and OODebugMonitor::performJSConsoleCommand:.

Function Documentation

OOJSBeginProfiling()

void OOJSBeginProfiling

(

BOOL

trace

)

Definition at line 311 of file OOJSEngineTimeManagement.m.

{
    assert(sProfiling == NO);
    sProfiling = YES;
    sTracing = trace;
    sProfileInfo = NSCreateMapTable(NSNonOwnedPointerMapKeyCallBacks, NSObjectMapValueCallBacks, 100);
    sProfilerOverhead = 0.0;
    sProfilerTotalNativeTime = 0.0;
    sProfilerTotalJavaScriptTime = 0.0;
    sProfilerEntryTimeLimit = OOJSGetTimeLimiterLimit();
    
    // This should be last for precision.
    sProfilerStartTime = OOGetHighResTime();
    
    if (trace)
    {
        OOLog(@"script.javaScript.trace", @"%@", @">>>> Beginning trace.");
        OOLogIndent();
    }
}

References OOGetHighResTime, OOJSGetTimeLimiterLimit(), OOLog, OOLogIndent(), sProfileInfo, sProfilerEntryTimeLimit, sProfilerOverhead, sProfilerStartTime, sProfilerTotalJavaScriptTime, sProfilerTotalNativeTime, sProfiling, and sTracing.

Referenced by PerformProfiling().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSCopyTimeLimiterNominalStartTime()

OOHighResTimeValue OOJSCopyTimeLimiterNominalStartTime

(

void

)

Definition at line 158 of file OOJSEngineTimeManagement.m.

{
    return sLimiterStart;
}

References sLimiterStart.

OOJSEndProfiling()

OOTimeProfile * OOJSEndProfiling

(

void

)

Definition at line 333 of file OOJSEngineTimeManagement.m.

{
    // This should be at the top for precision.
    OOHighResTimeValue now = OOGetHighResTime();
    // Time limiter should be as close to outermost as practical.
    OOJSPauseTimeLimiter();
    
    assert(sProfiling && sProfileStack == NULL);
    
    sProfiling = NO;
 
    OOTimeProfile *result = [[OOTimeProfile alloc] init];
    
    [result setTotalTime:OOHighResTimeDeltaInSeconds(sProfilerStartTime, now)];
    [result setNativeTime:sProfilerTotalNativeTime];
#ifdef MOZ_TRACE_JSCALLS
    [result setJavaScriptTime:sProfilerTotalJavaScriptTime];
#endif
    [result setProfilerOverhead:sProfilerOverhead];
    
    double currentTimeLimit = OOJSGetTimeLimiterLimit(); 
    [result setExtensionTime:currentTimeLimit - sProfilerEntryTimeLimit];
    
    [result setProfileEntries:[NSAllMapTableValues(sProfileInfo) sortedArrayUsingSelector:@selector(compareBySelfTimeReverse:)]];
    
    if (sTracing)
    {
        OOLogOutdent();
        OOLog(@"script.javaScript.trace", @"%@", @"<<<< End of trace.");
        sTracing = NO;
    }
    
    // Clean up.
    NSFreeMapTable(sProfileInfo);
    OODisposeHighResTime(sProfilerStartTime);
    
    OODisposeHighResTime(now);
    
    OOJSResumeTimeLimiter();
    return result;
}

References OODisposeHighResTime, OOGetHighResTime, OOJSGetTimeLimiterLimit(), OOJSPauseTimeLimiter(), OOJSResumeTimeLimiter(), OOLog, OOLogOutdent(), OOTimeProfile::setExtensionTime:, OOTimeProfile::setNativeTime:, OOTimeProfile::setProfileEntries:, OOTimeProfile::setProfilerOverhead:, OOTimeProfile::setTotalTime:, sProfileInfo, sProfilerStartTime, sProfileStack, sProfiling, and sTracing.

Referenced by PerformProfiling().

Here is the call graph for this function:

Here is the caller graph for this function:

OOJSGetTimeLimiterLimit()

OOTimeDelta OOJSGetTimeLimiterLimit

(

void

)

Definition at line 173 of file OOJSEngineTimeManagement.m.

{
    return sLimiterTimeLimit;
}

References sLimiterTimeLimit.

Referenced by OOJSBeginProfiling(), OOJSEndProfiling(), and PerformProfiling().

Here is the caller graph for this function:

OOJSIsProfiling()

BOOL OOJSIsProfiling

(

void

)

Definition at line 376 of file OOJSEngineTimeManagement.m.

{
    return sProfiling;
}

References sProfiling.

Referenced by ConsoleGetProfile(), ConsoleProfile(), and ConsoleTrace().

Here is the caller graph for this function:

OOJSResetTimeLimiter()

void OOJSResetTimeLimiter

(

void

)

Definition at line 164 of file OOJSEngineTimeManagement.m.

{
    OODisposeHighResTime(sLimiterStart);
    sLimiterStart = OOGetHighResTime();
    
    sStop = NO;
}

References OODisposeHighResTime, OOGetHighResTime, sLimiterStart, and sStop.

Referenced by PerformProfiling().

Here is the caller graph for this function:

OOJSSetTimeLimiterLimit()

void OOJSSetTimeLimiterLimit

(

OOTimeDelta

limit

)

Definition at line 179 of file OOJSEngineTimeManagement.m.

{
    sLimiterTimeLimit = limit;
}

References sLimiterTimeLimit.

Referenced by PerformProfiling().

Here is the caller graph for this function:

OOJSStartTimeLimiterWithTimeLimit_()

void OOJSStartTimeLimiterWithTimeLimit_	(	OOTimeDelta	limit,
		const char *	file,
		unsigned	line )

Definition at line 82 of file OOJSEngineTimeManagement.m.

{
#if OOJS_DEBUG_LIMITER
    OOLog(@"script.javaScript.timeLimit.debug",@"Limiter starting: %u => %u",sLimiterStartDepth,sLimiterStartDepth+1);
#endif
    if (sLimiterStartDepth++ == 0)
    {
        if (limit <= 0.0)  limit = OOJS_TIME_LIMIT;
        sLimiterTimeLimit = limit;
        sLimiterPauseDepth = 0;
        
        OODisposeHighResTime(sLimiterStart);
        sLimiterStart = OOGetHighResTime();
    }
    
#ifndef NDEBUG
    sLastStartedFile = file;
    sLastStartedLine = line;
#endif
}

References OODisposeHighResTime, OOGetHighResTime, OOJS_TIME_LIMIT, OOLog, sLastStartedFile, sLastStartedLine, sLimiterPauseDepth, sLimiterStart, sLimiterStartDepth, and sLimiterTimeLimit.

OOJSStopTimeLimiter_()

void OOJSStopTimeLimiter_	(	const char *	file,
		unsigned	line )

Definition at line 108 of file OOJSEngineTimeManagement.m.

{
#ifndef NDEBUG
    if (sLimiterStartDepth == 0)
    {
        OOLog(@"bug.javaScript.limiterDepth", @"Attempt to stop JavaScript time limiter while it is already fully stopped. This is an internal bug, please report it. (Last start: %@:%u, last valid stop: %@:%u, this stop attempt: %@:%u.)", OOLogAbbreviatedFileName(sLastStartedFile), sLastStartedLine, OOLogAbbreviatedFileName(sLastStoppedFile), sLastStoppedLine, OOLogAbbreviatedFileName(file), line);
        return;
    }
    
    sLastStoppedFile = file;
    sLastStoppedLine = line;
 
#if OOJS_DEBUG_LIMITER
    OOLog(@"script.javaScript.timeLimit.debug",@"Limiter ending: %u <= %u",sLimiterStartDepth-1,sLimiterStartDepth);
#endif
 
#endif
    
    if (--sLimiterStartDepth == 0)  sLimiterTimeLimit = 0.0;
}

References OOLog, OOLogAbbreviatedFileName(), sLastStartedFile, sLastStartedLine, sLastStoppedFile, sLastStoppedLine, sLimiterStartDepth, and sLimiterTimeLimit.

Here is the call graph for this function:

OOJSTimeManagementInit()

void OOJSTimeManagementInit	(	OOJavaScriptEngine *	engine,
		JSRuntime *	runtime )

Definition at line 254 of file OOJSEngineTimeManagement.m.

{
    [NSThread detachNewThreadSelector:@selector(watchdogTimerThread)
                             toTarget:engine
                           withObject:nil];
    
    JS_SetContextCallback(runtime, ContextCallback);
}

References ContextCallback().

Referenced by OOJavaScriptEngine::init.

Here is the call graph for this function:

Here is the caller graph for this function: