diff options
| author | Mitsutoshi Aoe <maoe@foldr.in> | 2017-04-17 06:08:25 +0900 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2017-04-21 19:34:56 -0400 |
| commit | 9dd20a3fa523a9986a29f538dee7a570be72a677 (patch) | |
| tree | a32037ffbb9c0034671203e58e0fe0a285ff9455 | |
| parent | 58a59d035102c01472cec8ebace21c7ced6f2a06 (diff) | |
| download | haskell-9dd20a3fa523a9986a29f538dee7a570be72a677.tar.gz | |
Edit eventlog-formats.rst to match implementation
* Add missing filters in EVENT_HEAP_PROF_BEGIN and reorder them
* EVENT_HEAP_PROF_SAMPLE_COST_CENTRE isn't used in retainer profiling
* Modify EVENT_HEAP_PROF_SAMPLE_STRING's format
* Biography break-down isn't implemented
| -rw-r--r-- | docs/users_guide/eventlog-formats.rst | 32 |
1 files changed, 9 insertions, 23 deletions
diff --git a/docs/users_guide/eventlog-formats.rst b/docs/users_guide/eventlog-formats.rst index 74a62f2bd3..8d53f92323 100644 --- a/docs/users_guide/eventlog-formats.rst +++ b/docs/users_guide/eventlog-formats.rst @@ -38,11 +38,13 @@ A single fixed-width event emitted during program start-up describing the sample * ``SAMPLE_TYPE_MODULE`` (output from ``-hm``) * ``SAMPLE_TYPE_TYPE_DESCR`` (output from ``-hy``) * ``SAMPLE_TYPE_BIOGRAPHY`` (output from ``-hb``) - * ``String``: Cost centre filter - * ``String``: Closure description filter - * ``String``: Retainer filter * ``String``: Module filter + * ``String``: Closure description filter * ``String``: Type description filter + * ``String``: Cost centre filter + * ``String``: Cost centre stack filter + * ``String``: Retainer filter + * ``String``: Biography filter Cost center definitions ^^^^^^^^^^^^^^^^^^^^^^^ @@ -81,9 +83,8 @@ Cost-center break-down A variable-length packet encoding a heap profile sample broken down by, * cost-center (``-hc``) - * retainer (``-hr``) - * ``EVENT_HEAP_PROF_SAMPLE`` + * ``EVENT_HEAP_PROF_SAMPLE_COST_CENTRE`` * ``Word8``: Profile ID * ``Word64``: heap residency in bytes * ``Word8``: stack depth @@ -98,22 +99,7 @@ A variable-length event encoding a heap sample broken down by, * closure description (``-hd``) * module (``-hm``) - * ``EVENT_HEAP_PROF_SAMPLE`` + * ``EVENT_HEAP_PROF_SAMPLE_STRING`` * ``Word8``: Profile ID - * The event shall contain packed pairs of, - * ``String``: type description - * ``Word64``: heap residency in bytes - - -Biography break-down -^^^^^^^^^^^^^^^^^^^^ - -A fixed-length event encoding a biography heap sample. - - * ``EVENT_HEAP_PROF_SAMPLE`` - * ``Word8``: Profile ID - * ``Word64``: Void - * ``Word64``: Lag - * ``Word64``: Use - * ``Word64``: Inherent use - * ``Word64``: Drag + * ``Word64``: heap residency in bytes + * ``String``: type or closure description, or module name |