search

haskell / ghc-events

Library and tool for parsing .eventlog files from GHC
http://www.haskell.org/haskellwiki/ThreadScope
Other
33 stars 34 forks source link

WIP: Improve haddocks #98

Open BinderDavid opened 1 year ago

Mikolaj commented 1 year ago

I'm not the current maintainer, but thanks a lot, buddy, great job this and the other PRs!

BTW, I think there may be some old docs somewhere. If not in this repo, perhaps in the ThreadScope repo or in some writeup about the RTS? I may be misremembering, though.

BinderDavid commented 1 year ago

Yep, I am sitting here at the GHC Contributor workshop and plan on working a bit on this on the weekend. I found it very difficult to figure out what all the events mean, apparently even some GHC devs are a bit confused on the details: https://gitlab.haskell.org/ghc/ghc/-/issues/23105 :) I plan to simultaneously also work on improving the documentation in the GHC User guide, since the documentation there is also incomplete and contains various TODOs.

Mikolaj commented 1 year ago

Oh cool. Yeah, the semantics is complex. ThreadScope contains some finite automata where the states are the events, but unfortunately most are jail-broken (illegal state transitions are accepted), because the RTS semantics is full of exceptions (or events sometimes get serialized out of order, I never managed to figure out which it is).

Mikolaj commented 2 months ago

@BinderDavid: how is it going with the GHC User guide? Anything to port to ghc-events already?

BinderDavid commented 2 months ago

Sorry, I somehow got a bit distracted. I can see if I find time this weekend to at least bring this PR in a mergeable state.