[Git][ghc/ghc][wip/adamse/eventlog-docs] 4 commits: docs: explain the BLOCK_MARKER event

[ase (@adamse)]

ase pushed to branch wip/adamse/eventlog-docs at Glasgow Haskell Compiler / GHC


Commits:
5e40c42d by Adam Sandberg Ericsson at 2023-03-20T16:25:11+00:00
docs: explain the BLOCK_MARKER event

- - - - -
46bd3219 by Adam Sandberg Ericsson at 2023-03-20T16:25:11+00:00
docs: add BlockedOnMVarRead thread status in eventlog encodings

- - - - -
a8ad190f by Adam Sandberg Ericsson at 2023-03-20T16:25:11+00:00
docs: add TASK_DELETE event in eventlog encodings

- - - - -
a7f675ff by Adam Sandberg Ericsson at 2023-03-20T16:25:11+00:00
docs: add WALL_CLOCK_TIME event in eventlog encodings

- - - - -


1 changed file:

- docs/users_guide/eventlog-formats.rst


Changes:

=====================================
docs/users_guide/eventlog-formats.rst
=====================================
@@ -122,6 +122,18 @@ environment which the program is being run in.
 
    Describes the environment variables present in the program's environment.
 
+.. event-type:: WALL_CLOCK_TIME
+
+   :tag: 43
+   :length: fixed
+   :field CapSetId: Capability set
+   :field Word64: Unix epoch seconds
+   :field Word32: Nanoseconds
+
+   Records the wall clock time to make it possible to correlate events from
+   elsewhere with the eventlog.
+
+
 Thread and scheduling events
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -164,6 +176,7 @@ Thread and scheduling events
       * 12: BlockedOnSTM
       * 13: BlockedOnDoProc
       * 16: BlockedOnMsgThrowTo
+      * 20: BlockedOnMVarRead
 
    :field ThreadId: thread id of thread being blocked on (only for some status
                     values)
@@ -538,6 +551,15 @@ Task events
 
    Marks the migration of a task to a new capability.
 
+.. event-type:: TASK_DELETE
+
+   :tag: 57
+   :length: fixed
+   :field TaskId: task id
+
+   Marks the deletion of a task.
+
+
 Tracing events
 ~~~~~~~~~~~~~~
 
@@ -553,11 +575,12 @@ Tracing events
 
    :tag: 18
    :length: fixed
-   :field Word32: size
+   :field Word32: block size
    :field Word64: end time in nanoseconds
-   :field Word16: capability number
+   :field Word16: capability number, invalid if ``0xffff``.
 
-   TODO
+   Marks a chunk of events. The events that fit in the next ``block size``
+   bytes all belong to the block marker capability.
 
 .. event-type:: USER_MSG
 



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/50226c6d0ca087c182c072247895cf75ceea2a92...a7f675ff71bd38cf6cd325db7c82671107da6420

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/50226c6d0ca087c182c072247895cf75ceea2a92...a7f675ff71bd38cf6cd325db7c82671107da6420
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20230320/3ec26efc/attachment-0001.html>