bronze_gc 0.2.0

The Bronze garbage collector for Rust. This version only includes the API for creating and using GC references; it does not actually collect anything. For experimental purposes only.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

#include <stdint.h>

/// The map for a single function's stack frame.  One of these is
///        compiled as constant data into the executable for each function.
///
/// Storage of metadata values is elided if the %metadata parameter to
/// @llvm.gcroot is null.
struct LLVMFrameMap {
  int32_t NumRoots;    //< Number of roots in stack frame.
  int32_t NumMeta;     //< Number of metadata entries.  May be < NumRoots.
  const void *Meta[0]; //< Metadata for each root.
};

/// A link in the dynamic shadow stack.  One of these is embedded in
///        the stack frame of each function on the call stack.
struct LLVMStackEntry {
  struct LLVMStackEntry *Next;    //< Link to next stack entry (the caller's).
  const struct LLVMFrameMap *Map; //< Pointer to constant FrameMap.
  void *Roots[0];      //< Stack roots (in-place array).
};


/// Calls Visitor(root, meta) for each GC root on the stack.
///        root and meta are exactly the values passed to
///        @llvm.gcroot.
///
/// Visitor could be a function to recursively mark live objects.  Or it
/// might copy them to another heap or generation.
///
/// @param Visitor A function to invoke for every GC root on the stack.
// void visitGCRoots(void (*Visitor)(void **Root, const void *Meta)) {
//   for (StackEntry *R = llvm_gc_root_chain; R; R = R->Next) {
//     unsigned i = 0;

//     // For roots [0, NumMeta), the metadata pointer is in the FrameMap.
//     for (unsigned e = R->Map->NumMeta; i != e; ++i)
//       Visitor(&R->Roots[i], R->Map->Meta[i]);

//     // For roots [NumMeta, NumRoots), the metadata pointer is null.
//     for (unsigned e = R->Map->NumRoots; i != e; ++i)
//       Visitor(&R->Roots[i], NULL);
//   }
// }

// Get the head of the global GC root chain.
struct LLVMStackEntry *get_llvm_gc_root_chain();