llvm.org GIT mirror llvm / 651713e
[GC docs] Fill in description of the statepoint-example GC strategy git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@230572 91177308-0d34-0410-b5e6-96231b3b80d8 Philip Reames 4 years ago
2 changed file(s) with 16 addition(s) and 3 deletion(s). Raw diff Collapse all Expand all
385385
386386 .. _plugin:
387387
388 Built In Collectors
389 ====================
388 Built In GC Strategies
389 ======================
390390
391391 LLVM includes built in support for several varieties of garbage collectors.
392392
500500 F.setGC("statepoint-example");
501501
502502 This GC provides an example of how one might use the infrastructure provided
503 by ``gc.statepoint``.
503 by ``gc.statepoint``. This example GC is compatible with the
504 :ref:`PlaceSafepoints` and :ref:`RewriteStatepointsForGC` utility passes
505 which simplify ``gc.statepoint`` sequence insertion. If you need to build a
506 custom GC strategy around the ``gc.statepoints`` mechanisms, it is recommended
507 that you use this one as a starting point.
508
509 This GC strategy does not support read or write barriers. As a result, these
510 intrinsics are lowered to normal loads and stores.
511
512 The stack map format generated by this GC strategy can be found in the
513 :ref:`stackmap-section` using a format documented :ref:`here
514 `. This format is intended to be the standard
515 format supported by LLVM going forward.
504516
505517
506518 Custom GC Strategies
321321 side effects since it is just a way to extract information about work
322322 done during the actual call modeled by the ``gc.statepoint``.
323323
324 .. _statepoint-stackmap-format:
324325
325326 Stack Map Format
326327 ================