Edit eventlog-formats.rst to match implementation
authorMitsutoshi Aoe <maoe@foldr.in>
Sun, 16 Apr 2017 21:08:25 +0000 (06:08 +0900)
committerBen Gamari <ben@smart-cactus.org>
Fri, 21 Apr 2017 23:34:56 +0000 (19:34 -0400)
* 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

docs/users_guide/eventlog-formats.rst

index 74a62f2..8d53f92 100644 (file)
@@ -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