[Git][ghc/ghc][master] 5 commits: docs: fix some wrongs in the eventlog format documentation
Marge Bot (@marge-bot)
gitlab at gitlab.haskell.org
Tue Mar 21 15:18:13 UTC 2023
Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC
Commits:
23642bf6 by Adam Sandberg Ericsson at 2023-03-21T11:17:53-04:00
docs: fix some wrongs in the eventlog format documentation
- - - - -
90159773 by Adam Sandberg Ericsson at 2023-03-21T11:17:53-04:00
docs: explain the BLOCK_MARKER event
- - - - -
ab1c25e8 by Adam Sandberg Ericsson at 2023-03-21T11:17:53-04:00
docs: add BlockedOnMVarRead thread status in eventlog encodings
- - - - -
898afaef by Adam Sandberg Ericsson at 2023-03-21T11:17:53-04:00
docs: add TASK_DELETE event in eventlog encodings
- - - - -
bb05b4cc by Adam Sandberg Ericsson at 2023-03-21T11:17:53-04: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
=====================================
@@ -44,7 +44,9 @@ start with the event type id and a 64-bit timestamp:
EventLog :
EVENT_HEADER_BEGIN
+ EVENT_HET_BEGIN -- header event types begin
EventType*
+ EVENT_HET_END -- header event types end
EVENT_HEADER_END
EVENT_DATA_BEGIN
Event*
@@ -120,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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -162,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)
@@ -200,7 +215,7 @@ Thread and scheduling events
.. event-type:: THREAD_LABEL
:tag: 44
- :length: fixed
+ :length: variable
:field ThreadId: thread id
:field String: label
@@ -332,9 +347,10 @@ in :ref:`nonmoving-gc-events`.
:field Word64: bytes of fragmentation, the difference between total mblock size
and total block size. When all mblocks are full of full blocks,
this number is 0.
- :field Word64: number of parallel garbage collection threads
+ :field Word32: number of parallel garbage collection threads
:field Word64: maximum number of bytes copied by any single collector thread
:field Word64: total bytes copied by all collector threads
+ :field Word64: the amount of balanced data copied by all threads
Report various information about a major collection.
@@ -535,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
~~~~~~~~~~~~~~
@@ -549,12 +574,13 @@ Tracing events
.. event-type:: BLOCK_MARKER
:tag: 18
- :length: variable
- :field Word32: size
+ :length: fixed
+ :field Word32: block size
:field Word64: end time in nanoseconds
- :field String: marker name
+ :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/a13affce1a6196ccff6c126112ab26823c85e727...bb05b4ccdfe81e9fc60065337eafa9c94499ad61
--
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/a13affce1a6196ccff6c126112ab26823c85e727...bb05b4ccdfe81e9fc60065337eafa9c94499ad61
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/20230321/ae02076c/attachment-0001.html>
More information about the ghc-commits
mailing list