JS_SetNativeStackQuota

This article needs a technical review. How you can help.

This article covers features introduced in SpiderMonkey 17

Enable or disable checks to avoid overflowing the C stack.

Syntax

void
JS_SetNativeStackQuota(JSRuntime *cx, size_t systemCodeStackSize,
                       size_t trustedScriptStackSize = 0,
                       size_t untrustedScriptStackSize = 0);

 

Name Type Description
rt JSRuntime * The runtime.
systemCodeStackSize size_t The desired stack quota setting, in bytes.
trustedScriptStackSize size_t The desired stack quota setting, in bytes for trusted script. If omitted, it uses the value of systemCodeStackSize. Added in SpiderMonkey 31
untrustedScriptStackSize size_t The desired stack quota setting, in bytes for untrusted script. If omitted, it uses the value of trustedScriptStackSize. Added in SpiderMonkey 31

Description

JS_SetNativeStackQuota sets the size of the native stack that should not be exceeded. To disable stack size checking, pass 0.

SpiderMonkey allows for a distinction between system code (such as GCs, which may incidentally be triggered by script but are not strictly performed on behalf of such script), trusted script (as determined by JS_SetTrustedPrincipals), and untrusted script. Each kind of code may have a different stack quota, allowing embedders to keep higher-priority machinery running in the face of scripted stack exhaustion by something else.

The stack quotas for each kind of code should be monotonically descending, and may be specified with this function. If 0 is passed for a given kind of code, it defaults to the value of the next-highest-priority kind.

This function may only be called immediately after the runtime is initialized and before any code is executed and/or interrupts requested.

See Also

Document Tags and Contributors

 Contributors to this page: kscarfone, arai
 Last updated by: kscarfone,