Skip to content

Commit

Permalink
Update migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
qinsoon committed Jun 5, 2024
1 parent b257517 commit 7c872dd
Showing 1 changed file with 23 additions and 18 deletions.
41 changes: 23 additions & 18 deletions docs/userguide/src/migration/prefix.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,29 @@ Notes for the mmtk-core developers:

## 0.26.0

### Remove GC in `harness_begin`

```admonish tldr
`harness_begin` no longer triggers a GC before collecting statistics. The user application
is responsible to trigger a GC before calling `harness_begin`.
```

API changes:
* module `memory_manager`
* `handle_user_collection_request`
* It now takes an argument `exhaustive` to indicate if the user triggered GC is
exhaustive (full heap) or not.
* type `Options`
* The runtime option `full_heap_sytem_gc` is removed.

Not API change, but worth noting:

* module `mmtk::memory_manager`
* `harness_begin`
* The function used to trigger a forced full heap GC before starting collecting statistics.
Now it no longer triggers the GC.
* The user applications and benchmarks are responsible to trigger a GC before calling `harness_begin`.

### Rename "edge" to "slot"

```admonish tldr
Expand Down Expand Up @@ -75,24 +98,6 @@ See also:
- PR: <https://github.com/mmtk/mmtk-core/pull/1134>
- Example: <https://github.com/mmtk/mmtk-openjdk/pull/274>

### Remove GC in `harness_begin`

```admonish tldr
`harness_begin` no longer triggers a GC before collecting statistics. The user application
is responsible to trigger a GC before calling `harness_begin`.
```

Not API change, but worth noting:

* module `mmtk::memory_manager`
* `harness_begin`
* The function used to trigger a forced full heap GC before starting collecting statistics.
Now it no longer triggers the GC.
* The user applications and benchmarks are responsible to trigger a GC before calling `harness_begin`.
* `handle_user_collection_request`
* The runtime option `full_heap_sytem_gc` defaults to `true` now (it used to be `false` by default).
The GC triggered by this function will be a full heap GC by default.

## 0.25.0

### `ObjectReference` is no longer nullable
Expand Down

0 comments on commit 7c872dd

Please sign in to comment.