Document heap allocation functions in StgCmmMonad/StgCmmLayout
I'm having a hard time using the heap allocation functions in StgCmmMonad and StgCmmLayout, as they lack documentation. I'd be very grateful if someone could at least document:
getHpRelOffsetsetVirtHpgetVirtHp
To get an idea which questions I'm struggling with, I need to e.g. understand if the value returned by getHpRelOffset is affected by later calls to setVirtHp. This is probably obvious to some, but reading the code alone is not enough to get a good understanding how all the heap allocation code hangs together.
Trac metadata
| Trac field | Value |
|---|---|
| Version | 7.6.3 |
| Type | FeatureRequest |
| TypeOfFailure | OtherFailure |
| Priority | normal |
| Resolution | Unresolved |
| Component | Documentation |
| Test case | |
| Differential revisions | |
| BlockedBy | |
| Related | |
| Blocking | |
| CC | |
| Operating system | |
| Architecture |
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information