Choosing the right memory allocator
There are a lot of different memory allocators in the Mozilla source tree. This article looks over some of them and tries to sort out which should be used under what circumstances.
These are general purpose memory-management routines that you should use unless your code falls into one of the other categories below. Use these if you link against XPCOM or XPCOM Glue; this includes extensions with binary components. See the XPCOM string guide for additional information.
nsMemory::Clone()(note: not part of nsIMemory)
See Infallible memory allocation for information about how to allocate memory infallibly; that is, how to use memory allocators that will only return valid memory buffers, and never return
See "Callee-allocated Parameters" in the XPCOM Strings guide; use
ToNewUnicode() to allocate strings that will be passed out. These methods convert
ns*String to nsIMemory allocated, unowned
Do not use
nsCRT::strdup for returning values from an XPCOM object, as that uses a different allocator.
You should only use the NSPR allocators within NSPR or the security code located in the /security/ subtree of the source code. Avoid using them elsewhere.
PR_Alloc()(do not use, no users and only exists in /security/; use
PR_NEW(pass in a struct to allocate its size)
PR_NEW, but zeros memory)
PR_Free()and also clears the pointer)
There are special memory allocation routines specifically intended for use from plugins, which must not be used from within Mozilla itself. See Gecko Plugin API Reference:Memory.
NSPR exposes arena allocators that can be used to efficiently allocate lots of small, uniformly sized objects.
nsPresContext::AllocateFromShell() can be used to allocate memory from an arena maintained by the PresShell. These should only be used to allocate objects that are guaranteed to have a shorter lifetime than the PresShell in question (typically layout data structures), because the PresShell destructor will wipe out the arena, leaving any pointers to memory allocated from it dangling.
The corresponding deallocators are
Memory that is allocated with the C standard library (
free()) should not be passed between shared libraries. These memory buffers may be used within a single shared library or program. For data structures being passed across XPCOM boundaries, use