How to determine if returned pointer is on the stack or heap
Distinguishing between malloc/free
and new/delete
is generally not possible, at least not in a reliable and/or portable way. Even more so as new
simply wrapps malloc
anyway in many implementations.
None of the following alternatives to distinguish heap/stack have been tested, but they should all work.
Linux:
- Solution proposed by Luca Tettananti, parse
/proc/self/maps
to get the address range of the stack. - As the first thing at startup,
clone
your process, this implies supplying a stack. Since you supply it, you automatically know where it is. - Call GCC's
__builtin_frame_address
function with increasing level parameter until it returns 0. You then know the depth. Now call__builtin_frame_address
again with the maximum level, and once with a level of 0. Anything that lives on the stack must necessarily be between these two addresses. sbrk(0)
as the first thing at startup, and remember the value. Whenever you want to know if something is on the heap,sbrk(0)
again -- something that's on the heap must be between the two values. Note that this will not work reliably with allocators that use memory mapping for large allocations.
Knowing the location and size of the stack (alternatives 1 and 2), it's trivial to find out if an address is within that range. If it's not, is necessarily "heap" (unless someone tries to be super smart-ass and gives you a pointer to a static global, or a function pointer, or such...).
Windows:
- Use CaptureStackBackTrace, anything living on the stack must be between the returned pointer array's first and last element.
- Use GCC-MinGW (and
__builtin_frame_address
, which should just work) as above. - Use
GetProcessHeaps
andHeapWalk
to check every allocated block for a match. If none match for none of the heaps, it's consequently allocated on the stack (... or a memory mapping, if someone tries to be super-smart with you). - Use
HeapReAlloc
withHEAP_REALLOC_IN_PLACE_ONLY
and with exactly the same size. If this fails, the memory block starting at the given address is not allocated on the heap. If it "succeeds", it is a no-op. - Use
GetCurrentThreadStackLimits
(Windows 8 / 2012 only) - Call
NtCurrentTeb()
(or readfs:[18h]
) and use the fieldsStackBase
andStackLimit
of the returned TEB.
I did the same question a couple of years ago on comp.lang.c, I liked the response of James Kuyper:
Yes. Keep track of it when you allocate it.
The way to do this is to use the concept of ownership of memory. At all times during the lifetime of a block of allocated memory, you should always have one and only one pointer that "owns" that block. Other pointers may point into that block, but only the owning pointer should ever be passed to free().
If at all possible, an owning pointer should be reserved for the purpose of owning pointers; it should not be used to store pointers to memory it does not own. I generally try to arrange that an owning pointer is initialized with a call to malloc(); if that's not feasible, it should be set to NULL sometime before first use. I also try to make sure that the lifetime of an owning pointer ends immediately after I free() the memory it owns. However, when that's not possible, set it to NULL immediately after free()ing that memory. With those precautions in place, you should not let the lifetime of a non-null owning pointer end without first passing it to free().
If you have trouble keeping track of which pointers are 'owning' pointers, put a comment about that fact next to their declaration. If you have lots of trouble, use a naming convention to keep track of this feature.
If, for any reason, it is not possible to reserve an owning pointer variable exclusively for ownership of the memory it points at, you should set aside a separate flag variable to keep track of whether or not that pointer currently owns the memory it points at. Creating a struct that contains both the pointer and the ownership flag is a very natural way to handle this - it ensures that they don't get separated.
If you have a rather complicated program, it may be necessary to transfer ownership of memory from one owning pointer variable to another. If so, make sure that any memory owned by target pointer is free()d before the transfer, and unless the lifetime of the source pointer ends immediately after the transfer, set the source pointer to NULL. If you're using ownership flags, reset them accordingly.
The plugin/library/whatever should not be returning an enum through a passed 'ALLOCATION_BEHAVIOR*' pointer. It's messy, at best. The 'deallocation' scheme belongs with the data and should be encapsulated with it.
I would prefer to return an object pointer of some base class that has a virtual 'release()' function member that the main app can call whenever it wants/needs to and handles the 'dealloaction' as required for that object. release() could do nothing, repool the object in a cache specified in a private data memebr of the object, of just delete() it, depending on whatever override is applied by the plugin subclasses.
If this is not possible because the plugin is written in a different language, or built with a different compiler, the plugin could return a function as well as the data so that the main app can call it back with the data pointer as a parameter for the purpose of deallocation. This at least allows you to put the char* and function* into the same object/struct on the C++ side, so maintaining at least some semblance of encapsulation and allowing the plugin to choose any deallocation scheme it wants to.
Edit - a scheme like this would also work safely if the plugin used a different heap than the main app - maybe it's in a DLL that has its own sub-allocator.