llGetFreeMemory

From Second Life Wiki
Revision as of 09:19, 12 July 2022 by Jenna Huntsman (talk | contribs) (Add caveat regarding the use of llSetMemoryLimit. Formatting cleanup.)
Jump to navigation Jump to search

Summary

Function: integer llGetFreeMemory( );

Returns the integer of the number of free bytes of memory the script can use.

Specification

This function's behavior is dependent upon the VM the script is using. Mono is the new VM, LSO is the old VM. The big difference between Mono and LSO is that Mono scripts run faster and can utilize four times more memory.

Mono

In Mono the value returned is the amount of free memory available to the script prior to garbage collection being run. This means that memory that is awaiting garbage collection counts against the scripts 64KiB allotment. In addition to this, Mono does not enforce the memory restrictions as strictly as the LSO VM did[1] (with LSO it was impossible to exceed the 16KiB memory cap), consequently it is possible to utilize more of the free memory.

LSO

In LSO, the value returned by this function is the amount of memory that the Stack can use of the Heap has yet to allocate for itself.

The LSL memory space is divided into four sections: Byte-code, Stack, Free Memory, Heap. Free Memory isn't an allocated block of memory, it's just the space between Stack and Heap. The size of all four sections combined is 16384 bytes (16KiB).

Strings, lists and keys are stored in the Heap. Heap pointers (for strings, lists & keys), integers, floats, vectors and rotations are all temporarily stored in the stack as the script executes.

As the script executes the Stack grows and shrinks in size depending upon the complexity of the expressions being executed. Likewise the Heap grows as the script executes but unlike the Stack, it never shrinks in size. When there is no free memory left for Stack or Heap to use they collide and a Stack-Heap Collision error is thrown causing the script to crash.

The Heap can become fragmented and blocks of memory in it can become unusable (due to their size). There is no defragment function[2] but there are scripting techniques that can be used to reduce fragmentation.

Caveats

  • The number of free bytes the Heap can use may be greater but not less.
  • "the number of free bytes of memory the script can use" means that if a memory limit is set (via llSetMemoryLimit), this function will report the free space between the script's current memory usage and the defined memory limit, not the uncapped memory limit.
All Issues ~ Search JIRA for related Bugs

Examples

Calling llGetFreeMemory can look like this:

llOwnerSay((string)llGetFreeMemory() + " bytes of free memory available for allocation.");

See Also

Functions

•  llGetUsedMemory
•  llScriptProfiler A more advanced function for analyzing script performance, and can also measure memory usage over time.
•  llSetMemoryLimit Define a memory limit (lower than the maximum for the appropriate VM).

Articles

•  Stack-Heap Collision LSL Error caused by the script running out of memory.

Deep Notes

LSO VM Notes

This function does not count free memory, and the name of this function makes this function difficult for people to learn. People say this function may be redefined or superseded by another more useful function when the LSL VM moves to Mono.

We can concisely specify llGetFreeMemory in the context of the classic Unix model for a parallel task/ thread/ process. Think of the task of the script always holding 16384 bytes (16 KiB). Let the byte code and then stack grow up from the bottom, let the heap grow down from the top. llGetFreeMemory then returns the "historic lowest heap pointer minus the stack end pointer".

llGetFreeMemory does not count the bytes freed, llGetFreeMemory instead counts all the bytes never yet used.

Search JIRA for related Issues

Footnotes

  1. ^ http://www.langnetsymposium.com/2009/talks/17-JimPurbrick-SecondLife.html
  2. ^ Due to the design of the LSO VM, a defragment function is impossible.

Signature

function integer llGetFreeMemory();