#include <jsdbgapi.h>
import "OOJSEngineTimeManagement.h"
import "OOProfilingStopwatch.h"
import "OOJSScript.h"
import "OOCollectionExtractors.h"
import "OOLoggingExtended.h"
#include <unistd.h>

Include dependency graph for OOJSEngineTimeManagement.m:

Classes
category	OOTimeProfile(Private)
category	OOTimeProfileEntry(Private)

Macros
#define	OOJS_DEBUG_LIMITER 0
#define	OOJS_TIME_LIMIT (1)

Functions
void	OOJSStartTimeLimiterWithTimeLimit_ (OOTimeDelta limit, const char *file, unsigned line)
void	OOJSStopTimeLimiter_ (const char *file, unsigned line)
void	OOJSPauseTimeLimiter (void)
void	OOJSResumeTimeLimiter (void)
OOHighResTimeValue	OOJSCopyTimeLimiterNominalStartTime (void)
void	OOJSResetTimeLimiter (void)
OOTimeDelta	OOJSGetTimeLimiterLimit (void)
void	OOJSSetTimeLimiterLimit (OOTimeDelta limit)
static JSBool	OperationCallback (JSContext *context)
static JSBool	ContextCallback (JSContext *context, uintN contextOp)
void	OOJSTimeManagementInit (OOJavaScriptEngine engine, JSRuntime runtime)
void	OOJSBeginProfiling (BOOL trace)
OOTimeProfile *	OOJSEndProfiling (void)
BOOL	OOJSIsProfiling (void)
void	OOJSBeginTracing (void)
void	OOJSEndTracing (void)
BOOL	OOJSIsTracing (void)
static void	UpdateProfileForFrame (OOHighResTimeValue now, OOJSProfileStackFrame *frame)
void	OOJSProfileEnter (OOJSProfileStackFrame frame, const char function)
void	OOJSProfileExit (OOJSProfileStackFrame *frame)

Variables
static unsigned	sLimiterStartDepth
static int	sLimiterPauseDepth
static OOHighResTimeValue	sLimiterStart
static OOHighResTimeValue	sLimiterPauseStart
static double	sLimiterTimeLimit
static BOOL	sStop
static const char *	sLastStartedFile
static unsigned	sLastStartedLine
static const char *	sLastStoppedFile
static unsigned	sLastStoppedLine
static BOOL	sProfiling = NO
static BOOL	sTracing = NO
static OOJSProfileStackFrame *	sProfileStack = NULL
static NSMapTable *	sProfileInfo
static double	sProfilerOverhead
static double	sProfilerTotalNativeTime
static double	sProfilerTotalJavaScriptTime
static double	sProfilerEntryTimeLimit
static OOHighResTimeValue	sProfilerStartTime

Macro Definition Documentation

◆ OOJS_DEBUG_LIMITER

#define OOJS_DEBUG_LIMITER 0

Definition at line 49 of file OOJSEngineTimeManagement.m.

◆ OOJS_TIME_LIMIT

#define OOJS_TIME_LIMIT (1)

Definition at line 63 of file OOJSEngineTimeManagement.m.

Referenced by OOJSStartTimeLimiterWithTimeLimit_(), and OOJavaScriptEngine(WatchdogTimer)::watchdogTimerThread.

Function Documentation

◆ ContextCallback()

JSBool ContextCallback	(	JSContext *	context,
		uintN	contextOp )

static

Definition at line 240 of file OOJSEngineTimeManagement.m.

{
    if (contextOp == JSCONTEXT_NEW)
    {
        JS_SetOperationCallback(context, OperationCallback);
        
#if OOJS_PROFILE && defined(MOZ_TRACE_JSCALLS)
        JS_SetFunctionCallback(context, (JSFunctionCallback)FunctionCallback);  // Naughtily casts away consts, because const JSContexts and JSFunctions are useless.
#endif
    }
    return YES;
}

References OperationCallback().

Referenced by OOJSTimeManagementInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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:

◆ OOJSBeginTracing()

void OOJSBeginTracing ( void )

◆ 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:

◆ OOJSEndTracing()

void OOJSEndTracing ( void )

◆ 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:

◆ OOJSIsTracing()

BOOL OOJSIsTracing ( void )

◆ OOJSPauseTimeLimiter()

void OOJSPauseTimeLimiter ( void )

Definition at line 133 of file OOJSEngineTimeManagement.m.

{
    if (sLimiterPauseDepth++ == 0)
    {
        OODisposeHighResTime(sLimiterPauseStart);
        sLimiterPauseStart = OOGetHighResTime();
    }
}

References OODisposeHighResTime, OOGetHighResTime, sLimiterPauseDepth, and sLimiterPauseStart.

Referenced by OODebugMonitor::appendJSConsoleLine:colorKey:emphasisRange:, OODebugMonitor::clearJSConsole, ConsoleConsoleMessage(), ConsoleIsExecutableJavaScript(), ConsoleSettingsSetProperty(), OOJavaScriptEngine::DebuggerHook, Universe::findEntitiesMatchingPredicate:parameter:inRange:ofEntity:, Universe::findOneEntityMatchingPredicate:parameter:, JSFunctionPredicate(), MissionRunScreen(), OOJSEndProfiling(), PlanetSetProperty(), ReportJSError(), OODebugMonitor::showJSConsole, SoundFromJSValue(), SystemFilteredEntities(), and SystemInfoStaticFilteredSystems().

Here is the caller graph for this function:

◆ OOJSProfileEnter()

void OOJSProfileEnter	(	OOJSProfileStackFrame *	frame,
		const char *	function )

Definition at line 527 of file OOJSEngineTimeManagement.m.

{
    if (EXPECT(!sProfiling))  return;
    if (EXPECT_NOT(sTracing))
    {
        // We use EXPECT_NOT here because profiles are time-critical and traces are not.
        OOLog(@"script.javaScript.trace.ON", @">> %s [ON]", function);
        OOLogIndent();
    }
    
    *frame = (OOJSProfileStackFrame)
    {
        .back = sProfileStack,
        .key = function,
        .function = function,
        .startTime = OOGetHighResTime(),
        .total = &sProfilerTotalNativeTime
    };
    sProfileStack = frame;
}

References EXPECT, EXPECT_NOT, OOGetHighResTime, OOLog, OOLogIndent(), sProfilerTotalNativeTime, sProfileStack, sProfiling, and sTracing.

Here is the call graph for this function:

◆ OOJSProfileExit()

void OOJSProfileExit ( OOJSProfileStackFrame * frame )

Definition at line 549 of file OOJSEngineTimeManagement.m.

{
    if (EXPECT(!sProfiling))  return;
    
    OOHighResTimeValue  now = OOGetHighResTime();
    NSAutoreleasePool   *pool = [NSAutoreleasePool new];
    BOOL                done = NO;
    
    /*
        It's possible there could be JavaScript frames on top of this frame if
        a JS native returned false. Or possibly not. The semantics of
        JS_SetFunctionCallback() aren't specified in detail.
        -- Ahruman 2011-01-16
    */
    for (;;)
    {
        assert(sProfileStack != NULL);
        
        done = (sProfileStack == frame);
        UpdateProfileForFrame(now, sProfileStack);
        if (EXPECT(done))  break;
    }
    
    [pool release];
    
    OODisposeHighResTime(frame->startTime);
    
    OOHighResTimeValue end = OOGetHighResTime();
    double currentOverhead = OOHighResTimeDeltaInSeconds(now, end);
    sProfilerOverhead += currentOverhead;
    
    /*  Equivalent of pausing/resuming time limiter, except that it guarantees
        excluded time will match profiler overhead if there are no other
        pauses happening.
    */
    if (sLimiterPauseDepth == 0)  sLimiterTimeLimit += currentOverhead;
    
    OODisposeHighResTime(now);
    OODisposeHighResTime(end);
}

References EXPECT, OODisposeHighResTime, OOGetHighResTime, OOHighResTimeDeltaInSeconds(), sLimiterPauseDepth, sLimiterTimeLimit, sProfilerOverhead, sProfileStack, sProfiling, and UpdateProfileForFrame().

Here is the call 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:

◆ OOJSResumeTimeLimiter()

void OOJSResumeTimeLimiter ( void )

Definition at line 143 of file OOJSEngineTimeManagement.m.

{
    if (--sLimiterPauseDepth == 0)
        
    {
        OOHighResTimeValue now = OOGetHighResTime();
        OOTimeDelta elapsed = OOHighResTimeDeltaInSeconds(sLimiterPauseStart, now);
        OODisposeHighResTime(now);
        
        sLimiterTimeLimit += elapsed;
    }
}

References OODisposeHighResTime, OOGetHighResTime, OOHighResTimeDeltaInSeconds(), sLimiterPauseDepth, sLimiterPauseStart, and sLimiterTimeLimit.

Referenced by OODebugMonitor::appendJSConsoleLine:colorKey:emphasisRange:, OODebugMonitor::clearJSConsole, ConsoleConsoleMessage(), ConsoleIsExecutableJavaScript(), ConsoleSettingsSetProperty(), OOJavaScriptEngine::DebuggerHook, Universe::findEntitiesMatchingPredicate:parameter:inRange:ofEntity:, Universe::findOneEntityMatchingPredicate:parameter:, JSFunctionPredicate(), MissionRunScreen(), OOJSEndProfiling(), PlanetSetProperty(), ReportJSError(), OODebugMonitor::showJSConsole, SoundFromJSValue(), SystemFilteredEntities(), and SystemInfoStaticFilteredSystems().

Here is the call graph for this function:

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:

◆ OperationCallback()

JSBool OperationCallback ( JSContext * context )

static

Definition at line 217 of file OOJSEngineTimeManagement.m.

{
    if (!sStop)  return YES;
    
    JS_ClearPendingException(context);
    
    OOHighResTimeValue now = OOGetHighResTime();
    OOTimeDelta elapsed = OOHighResTimeDeltaInSeconds(sLimiterStart, now);
    OODisposeHighResTime(now);
    
    if (elapsed <= sLimiterTimeLimit)  return YES;
    
    OOLogERR(@"script.javaScript.timeLimit", @"Script \"%@\" ran for %g seconds and has been terminated.", [[OOJSScript currentlyRunningScript] name], elapsed);
#ifndef NDEBUG
    OOJSDumpStack(context);
#endif
    
    // FIXME: we really should put something in the JS log here, but since that's implemented in JS there are complications.
    
    return NO;
}

References OODisposeHighResTime, OOGetHighResTime, OOHighResTimeDeltaInSeconds(), OOJSDumpStack(), OOLogERR, sLimiterStart, sLimiterTimeLimit, and sStop.

Referenced by ContextCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateProfileForFrame()

void UpdateProfileForFrame	(	OOHighResTimeValue	now,
		OOJSProfileStackFrame *	frame )

static

Definition at line 591 of file OOJSEngineTimeManagement.m.

{
    sProfileStack = frame->back;
    
    OOTimeProfileEntry *entry = NSMapGet(sProfileInfo, frame->key);
    if (entry == nil)
    {
        entry = [[OOTimeProfileEntry alloc] initWithCName:frame->function];
        NSMapInsertKnownAbsent(sProfileInfo, frame->key, entry);
        [entry release];
    }
    
    OOTimeDelta time = OOHighResTimeDeltaInSeconds(frame->startTime, now);
    OOTimeDelta selfTime = time - frame->subTime;
    [entry addSampleWithTotalTime:time selfTime:selfTime];
    
    *(frame->total) += selfTime;
    if (sProfileStack != NULL)  sProfileStack->subTime += time;
    
    if (frame->cleanup != NULL)  frame->cleanup(frame);
    
    if (EXPECT_NOT(sTracing))  OOLogOutdent();
}