Perform some action for each object in a
JSRuntime's GC root set.
#define JS_MAP_GCROOT_NEXT 0 /* continue mapping entries */ #define JS_MAP_GCROOT_STOP 1 /* stop mapping entries */ #define JS_MAP_GCROOT_REMOVE 2 /* remove and free the current entry */ typedef intN (*JSGCRootMapFun)(void *rp, const char *name, void *data);
JS_MapGCRoots to map the GC's roots table using
map(rp, name, data). The root is pointed at by
rp; if the root is unnamed,
name is null;
data is supplied from the third parameter to
map function should return
JS_MAP_GCROOT_REMOVE to cause the currently enumerated root to be removed. To stop enumeration, return
JS_MAP_GCROOT_STOP. To continue mapping, return
JS_MAP_GCROOT_NEXT. These constants are flags; you can OR them together.
This function acquires and releases
rt's GC lock around the mapping of the roots table, so the
map function should run to completion in as few cycles as possible. The
map function cannot call
JS_BeginRequest, or any JS API entry point that acquires locks, without double-tripping or deadlocking on the GC lock.
JS_MapGCRoots returns the count of roots that were successfully mapped.