diff options
author | Bjoern Brandenburg <bbb@Serenity.local> | 2008-12-09 17:41:30 -0500 |
---|---|---|
committer | Bjoern Brandenburg <bbb@Serenity.local> | 2008-12-09 17:41:30 -0500 |
commit | 7116c48f4387a13a847e09d5046d08187630ae7c (patch) | |
tree | f80b00d1e4ed5b611a94883dc1764236757945da | |
parent | a905aa78240da26c2b03c1781a975399398ab2b5 (diff) |
some more fixes
-rw-r--r-- | doc/tracing.html | 27 | ||||
-rw-r--r-- | doc/tracing.text | 25 | ||||
-rw-r--r-- | inc/format-doc.css | 2 |
3 files changed, 28 insertions, 26 deletions
diff --git a/doc/tracing.html b/doc/tracing.html index 5d40ab7..55d0085 100644 --- a/doc/tracing.html +++ b/doc/tracing.html | |||
@@ -42,9 +42,9 @@ This document is part of the documentation of the <a href="../index.html">LITMUS | |||
42 | <ol> | 42 | <ol> |
43 | <li><p><code>litmus_log</code>: This trace contains text messages (created with the <code>TRACE()</code> | 43 | <li><p><code>litmus_log</code>: This trace contains text messages (created with the <code>TRACE()</code> |
44 | macro, see <code>litmus.h</code>) that convey information useful for debugging. There is one global | 44 | macro, see <code>litmus.h</code>) that convey information useful for debugging. There is one global |
45 | <code>litmus_log</code> buffer for the whole system. Debug tracing must be enabled at compile time. Note that debug tracing creates significant overhead because string formatting takes place.</p></li> | 45 | <code>litmus_log</code> buffer for the whole system. The <code>litmus_log</code> facility is essentially a replacement for <code>printk()</code>, which cannot be invoked from scheduling code without risking deadlock. Debug tracing must be enabled at compile time. Note that debug tracing creates significant overhead because string formatting takes place. </p></li> |
46 | <li><p><code>ft_trace</code>: This trace contains binary-encoded time stamps. It is used for overhead tracing. There is one global <code>ft_trace</code> buffer for the whole system. The "ft" stands for <a href="http://www.cs.unc.edu/~bbb/feather-trace">Feather-Trace</a>. Feather-Trace is designed to create only negligible overhead when event sources are disabled, and to incur only low overhead when recording time stamps.</p></li> | 46 | <li><p><code>ft_trace</code>: This trace contains binary-encoded time stamps. It is used for overhead tracing. There is one global <code>ft_trace</code> buffer for the whole system. The "ft" stands for <a href="http://www.cs.unc.edu/~bbb/feather-trace">Feather-Trace</a>. Feather-Trace is designed to create only negligible overhead when event sources are disabled, and to incur only low overhead when recording time stamps.</p></li> |
47 | <li><p><code>sched_trace</code>: This trace contains binary-encoded scheduling event information, <em>e.g.</em>, an event can be recorded whenever a task got scheduled, a job was released, a job completed, etc. There is one <code>sched_trace</code> buffer per processor. <code>sched_trace</code> is also based on Feather-Trace and hence incurs only neglible overhead when event sources are disabled.</p></li> | 47 | <li><p><code>sched_trace</code>: This trace contains binary-encoded scheduling event information, <em>e.g.</em>, an event can be recorded whenever a task got scheduled, a job was released, a job completed, etc. There is one <code>sched_trace</code> buffer per processor. <code>sched_trace</code> is based on Feather-Trace and hence also incurs only negligible overhead when event sources are disabled.</p></li> |
48 | </ol> | 48 | </ol> |
49 | 49 | ||
50 | <h2>Accessing Trace Buffers</h2> | 50 | <h2>Accessing Trace Buffers</h2> |
@@ -81,8 +81,9 @@ done | |||
81 | 81 | ||
82 | <p>Kill the <code>cat</code> process to stop recording debug messages.</p> | 82 | <p>Kill the <code>cat</code> process to stop recording debug messages.</p> |
83 | 83 | ||
84 | <p>No post-processing is required since the debug messages are plain text. However, note that messages may appear in a different order than how they occured at runtime. If order is important (for example when debugging race conditions), then recorded messages can be sorted offline with the help of the <em>sequence number</em> at the start of each recorded message. <br /> | 84 | <p>No post-processing is required since the debug messages are plain text. However, note that messages may appear in an order that differs from the sequence of events at runtime. If order is important (for example when debugging race conditions), then recorded messages can be sorted offline with the help of the <em>sequence number</em> at the start of each recorded message.</p> |
85 | Example:</p> | 85 | |
86 | <p>Example:</p> | ||
86 | 87 | ||
87 | <pre><code>sort -n my_debug_log > my_sorted_debug_log | 88 | <pre><code>sort -n my_debug_log > my_sorted_debug_log |
88 | </code></pre> | 89 | </code></pre> |
@@ -93,7 +94,7 @@ Example:</p> | |||
93 | 94 | ||
94 | <p>Feather-Trace allows for much more fine-grained tracing than the simple debug stream realized by <code>litmus_log</code> and hence requires special-purpose tools to be used. These tools are available as part of the <code>ft_tools</code> package, which is available on the <a href="../index.html#download">LITMUS<sup>RT</sup> download page</a>.</p> | 95 | <p>Feather-Trace allows for much more fine-grained tracing than the simple debug stream realized by <code>litmus_log</code> and hence requires special-purpose tools to be used. These tools are available as part of the <code>ft_tools</code> package, which is available on the <a href="../index.html#download">LITMUS<sup>RT</sup> download page</a>.</p> |
95 | 96 | ||
96 | <p>Feather-Trace events can be enabled on a per-event basis. Each event is identified by a unique 32-bit ID. Intially, when the device buffer is not being accessed by any user space programs (<em>i.e.</em>, when the device driver is unused), all events are disabled. Events can be enabled (and subsequently disabled again) by writing binary commands to the buffer device file. Once events are enabled they can generate trace records, which are stored in the trace buffer. Userspace programs can obtain these records by reading from the device file. Reading a trace record removes it from the buffer, <em>i.e.</em>, each record can be read exactly once. Since buffer capacity is limited records should be consumed shortly after they were created.</p> | 97 | <p>Feather-Trace events can be enabled on a per-event basis. Each event is identified by a unique 32-bit ID. Initially, when the device buffer is not being accessed by any user space programs (<em>i.e.</em>, when the device driver is unused), all events are disabled. Events can be enabled (and subsequently disabled again) by writing binary commands to the buffer device file. Once events are enabled they can generate trace records, which are stored in the trace buffer. User space programs can obtain these records by reading from the device file. Reading a trace record removes it from the buffer, <em>i.e.</em>, each record can be read exactly once. Records should be consumed shortly after they were created since buffer capacity is limited.</p> |
97 | 98 | ||
98 | <p>The tool <code>ftcat</code>, which is part of the <code>ft_tools</code> package (see above), automates the process of enabling events and retrieving trace records. It takes the name of the <code>ft_trace</code> device file and the events of interest as arguments:</p> | 99 | <p>The tool <code>ftcat</code>, which is part of the <code>ft_tools</code> package (see above), automates the process of enabling events and retrieving trace records. It takes the name of the <code>ft_trace</code> device file and the events of interest as arguments:</p> |
99 | 100 | ||
@@ -102,7 +103,7 @@ Example:</p> | |||
102 | 103 | ||
103 | <p>The tool enables the specified events and copies all recorded events to <code>stdout</code>.</p> | 104 | <p>The tool enables the specified events and copies all recorded events to <code>stdout</code>.</p> |
104 | 105 | ||
105 | <p>Events can be specified either by their ID (see <code>include/litmus/trace.h</code> in the kernel directory for a list of timestamp-generating events) or by their symbolic name. The following symbolic names are recognized:</p> | 106 | <p>Events can be specified either by their ID (see <code>include/litmus/trace.h</code> in the kernel directory for a list of time stamp generating events) or by their symbolic name. The following symbolic names are recognized:</p> |
106 | 107 | ||
107 | <ul> | 108 | <ul> |
108 | <li><code>SCHED_START</code>, <code>SCHED_END</code>: <br /> | 109 | <li><code>SCHED_START</code>, <code>SCHED_END</code>: <br /> |
@@ -110,14 +111,14 @@ Used to measure the time spent to make a scheduling decision.</li> | |||
110 | <li><code>CXS_START</code>, <code>CXS_END</code>: <br /> | 111 | <li><code>CXS_START</code>, <code>CXS_END</code>: <br /> |
111 | Used to record the time spent to make a context switch.</li> | 112 | Used to record the time spent to make a context switch.</li> |
112 | <li><code>SCHED2_START</code>, <code>SCHED2_END</code>: <br /> | 113 | <li><code>SCHED2_START</code>, <code>SCHED2_END</code>: <br /> |
113 | Used to measure the time spent to perform post-context-switch cleanup and management activities. (This is part of the scheduling overhead but for technical reasons cannot be measured as part of the interval [<code>SCHED_START</code>, <code>SCHED_END</code>].</li> | 114 | Used to measure the time spent to perform post-context-switch cleanup and management activities. This is part of the scheduling overhead but for technical reasons cannot be measured as part of the interval [<code>SCHED_START</code>, <code>SCHED_END</code>].</li> |
114 | <li><code>TICK_START</code>, <code>TICK_END</code>: <br /> | 115 | <li><code>TICK_START</code>, <code>TICK_END</code>: <br /> |
115 | Used to measure the overhead incurred at the beginning of a scheduling quantum.</li> | 116 | Used to measure the overhead incurred at the beginning of a scheduling quantum.</li> |
116 | <li><code>PLUGIN_TICK_START</code>, <code>PLUGIN_TICK_END</code>: <br /> | 117 | <li><code>PLUGIN_TICK_START</code>, <code>PLUGIN_TICK_END</code>: <br /> |
117 | Like [<code>TICK_START</code>, <code>TICK_END</code>], but only measures the time spent by the active scheduling plugin.</li> | 118 | Like [<code>TICK_START</code>, <code>TICK_END</code>], but only measures the time spent by the active scheduling plugin.</li> |
118 | <li><code>PLUGIN_SCHED_START</code>, <code>PLUGIN_SCHED_END</code>: <br /> | 119 | <li><code>PLUGIN_SCHED_START</code>, <code>PLUGIN_SCHED_END</code>: <br /> |
119 | Like [<code>SCHED_START</code>, <code>SCHED_END</code>], but only measures the time spent by the active scheduling plugin. There is no equivalent <code>SCHED2</code> counterpart because the scheduling plugins do not directly compute to the <code>SCHED2</code> overhead.</li> | 120 | Like [<code>SCHED_START</code>, <code>SCHED_END</code>], but only measures the time spent by the active scheduling plugin. There is no equivalent <code>SCHED2</code> counterpart because the scheduling plugins do not directly compute to the <code>SCHED2</code> overhead.</li> |
120 | <li><code>RELEASE_START</code>, <code>RELEASE_END</code>: | 121 | <li><code>RELEASE_START</code>, <code>RELEASE_END</code>: <br /> |
121 | Used to measure the time spent to enqueue a newly-released job in a ready queue.</li> | 122 | Used to measure the time spent to enqueue a newly-released job in a ready queue.</li> |
122 | </ul> | 123 | </ul> |
123 | 124 | ||
@@ -134,7 +135,7 @@ Used to measure the time spent to enqueue a newly-released job in a ready queue. | |||
134 | 135 | ||
135 | <p>The binary event stream recorded by <code>ftcat</code> is of course of limited direct use—the data has yet to be exported for analysis. This can be achieved with the tool <code>ft2csv</code>, which is also part of the <code>ft_tools</code> package.</p> | 136 | <p>The binary event stream recorded by <code>ftcat</code> is of course of limited direct use—the data has yet to be exported for analysis. This can be achieved with the tool <code>ft2csv</code>, which is also part of the <code>ft_tools</code> package.</p> |
136 | 137 | ||
137 | <p>As the name suggests, <code>ft2csv</code> extracts intervals defined by pairs of timestamps in a recorded trace and displayse them as <em>comma-separated values</em> (CSV). It takes the name of an overhead trace and one start event as arguments:</p> | 138 | <p>As the name suggests, <code>ft2csv</code> extracts intervals defined by pairs of time stamps in a recorded trace and displays them as <em>comma-separated values</em> (CSV). It takes the name of an overhead trace and one start event as arguments:</p> |
138 | 139 | ||
139 | <pre><code>ft2csv <start event> <overhead trace> | 140 | <pre><code>ft2csv <start event> <overhead trace> |
140 | </code></pre> | 141 | </code></pre> |
@@ -151,9 +152,9 @@ Used to measure the time spent to enqueue a newly-released job in a ready queue. | |||
151 | 152 | ||
152 | <p>For each event, the start time (in clock cycles) is given in the first column, the end time is given in the second column, and the length is given in the third column (again, in cycles).</p> | 153 | <p>For each event, the start time (in clock cycles) is given in the first column, the end time is given in the second column, and the length is given in the third column (again, in cycles).</p> |
153 | 154 | ||
154 | <p><code>ft2csv</code> accepts a few options that affect how events are filtered. By default, events that do not involve real-time tasks are ignored. This can be changed by specifiying the <code>-b</code> option. If one happens to be processing output on a little-endian host that was produced on a big-endian host then the <code>-e</code> option can come in handy.</p> | 155 | <p><code>ft2csv</code> accepts a few options that affect how events are filtered. By default, events that do not involve real-time tasks are ignored. This can be changed by specifying the <code>-b</code> option. If one happens to be processing output on a little-endian host that was produced on a big-endian host then the <code>-e</code> option can come in handy.</p> |
155 | 156 | ||
156 | <p>Once the recorded overheads have been exported to CSV files they can be easily analyzed with tools such as Python, Octave, or Matlab.</p> | 157 | <p>Once the recorded overheads have been exported to CSV files they can be easily analyzed with tools such as Python's <code>csv</code> module, Octave, or Matlab.</p> |
157 | 158 | ||
158 | <h2>Recording and Post-Processing Scheduling Traces</h2> | 159 | <h2>Recording and Post-Processing Scheduling Traces</h2> |
159 | 160 | ||
@@ -182,7 +183,7 @@ Disabling 9 events. | |||
182 | 183 | ||
183 | <p>Note that <code>st_trace</code> may have to modified to change the default <code>sched_trace</code> device locations.</p> | 184 | <p>Note that <code>st_trace</code> may have to modified to change the default <code>sched_trace</code> device locations.</p> |
184 | 185 | ||
185 | <p><strong>Hint</strong>: To study/test the behavior of a scheduler plugin the dummy real-time task <code>rtspin</code> (distributed as part of the <code>liblitmus</code> package) may be useful.</p> | 186 | <p><strong>Hint</strong>: The dummy real-time task <code>rtspin</code> (distributed as part of the <code>liblitmus</code> package) may be useful when studying/testing the behavior of a scheduler plugin.</p> |
186 | 187 | ||
187 | <h2>Post-Processing Overhead Traces</h2> | 188 | <h2>Post-Processing Overhead Traces</h2> |
188 | 189 | ||
@@ -192,7 +193,7 @@ Disabling 9 events. | |||
192 | 193 | ||
193 | <h2>Concluding Remarks</h2> | 194 | <h2>Concluding Remarks</h2> |
194 | 195 | ||
195 | <p>At this point we only offer data <em>acquisition</em> tools since we have not yet had the time to develop release-quality <em>analysis</em> tools. <strong>Patches to improve the acquisition tools and contributions of analysis and visualization tools are very much welcome!</strong></p> | 196 | <p>At this point we only offer data <em>acquisition</em> tools since we have not yet had the time to develop release-quality <em>analysis</em> tools. <strong>Patches that improve the existing tools and contributions of new analysis and visualization tools are very much welcome!</strong></p> |
196 | 197 | ||
197 | <p>For any questions please contact the current LITMUS<sup>RT</sup> maintainer (as indicated on the <a href="../index.html#collaborators">LITMUS<sup>RT</sup> homepage</a>).</p> | 198 | <p>For any questions please contact the current LITMUS<sup>RT</sup> maintainer (as indicated on the <a href="../index.html#collaborators">LITMUS<sup>RT</sup> homepage</a>).</p> |
198 | 199 | ||
diff --git a/doc/tracing.text b/doc/tracing.text index 3421cd2..f31cb39 100644 --- a/doc/tracing.text +++ b/doc/tracing.text | |||
@@ -32,11 +32,11 @@ As of version 2008.2, there are three tracing mechanisms available in LITMUS<sup | |||
32 | 32 | ||
33 | 1. `litmus_log`: This trace contains text messages (created with the `TRACE()` | 33 | 1. `litmus_log`: This trace contains text messages (created with the `TRACE()` |
34 | macro, see `litmus.h`) that convey information useful for debugging. There is one global | 34 | macro, see `litmus.h`) that convey information useful for debugging. There is one global |
35 | `litmus_log` buffer for the whole system. Debug tracing must be enabled at compile time. Note that debug tracing creates significant overhead because string formatting takes place. | 35 | `litmus_log` buffer for the whole system. The `litmus_log` facility is essentially a replacement for `printk()`, which cannot be invoked from scheduling code without risking deadlock. Debug tracing must be enabled at compile time. Note that debug tracing creates significant overhead because string formatting takes place. |
36 | 36 | ||
37 | 2. `ft_trace`: This trace contains binary-encoded time stamps. It is used for overhead tracing. There is one global `ft_trace` buffer for the whole system. The "ft" stands for [Feather-Trace](http://www.cs.unc.edu/~bbb/feather-trace). Feather-Trace is designed to create only negligible overhead when event sources are disabled, and to incur only low overhead when recording time stamps. | 37 | 2. `ft_trace`: This trace contains binary-encoded time stamps. It is used for overhead tracing. There is one global `ft_trace` buffer for the whole system. The "ft" stands for [Feather-Trace](http://www.cs.unc.edu/~bbb/feather-trace). Feather-Trace is designed to create only negligible overhead when event sources are disabled, and to incur only low overhead when recording time stamps. |
38 | 38 | ||
39 | 3. `sched_trace`: This trace contains binary-encoded scheduling event information, *e.g.*, an event can be recorded whenever a task got scheduled, a job was released, a job completed, etc. There is one `sched_trace` buffer per processor. `sched_trace` is also based on Feather-Trace and hence incurs only neglible overhead when event sources are disabled. | 39 | 3. `sched_trace`: This trace contains binary-encoded scheduling event information, *e.g.*, an event can be recorded whenever a task got scheduled, a job was released, a job completed, etc. There is one `sched_trace` buffer per processor. `sched_trace` is based on Feather-Trace and hence also incurs only negligible overhead when event sources are disabled. |
40 | 40 | ||
41 | Accessing Trace Buffers | 41 | Accessing Trace Buffers |
42 | ----------------------- | 42 | ----------------------- |
@@ -72,7 +72,8 @@ The `litmus_log` buffer can be read by simply opening the file and reading its c | |||
72 | 72 | ||
73 | Kill the `cat` process to stop recording debug messages. | 73 | Kill the `cat` process to stop recording debug messages. |
74 | 74 | ||
75 | No post-processing is required since the debug messages are plain text. However, note that messages may appear in a different order than how they occured at runtime. If order is important (for example when debugging race conditions), then recorded messages can be sorted offline with the help of the *sequence number* at the start of each recorded message. | 75 | No post-processing is required since the debug messages are plain text. However, note that messages may appear in an order that differs from the sequence of events at runtime. If order is important (for example when debugging race conditions), then recorded messages can be sorted offline with the help of the *sequence number* at the start of each recorded message. |
76 | |||
76 | Example: | 77 | Example: |
77 | 78 | ||
78 | sort -n my_debug_log > my_sorted_debug_log | 79 | sort -n my_debug_log > my_sorted_debug_log |
@@ -84,7 +85,7 @@ Recording Overhead Traces | |||
84 | 85 | ||
85 | Feather-Trace allows for much more fine-grained tracing than the simple debug stream realized by `litmus_log` and hence requires special-purpose tools to be used. These tools are available as part of the `ft_tools` package, which is available on the [LITMUS<sup>RT</sup> download page](../index.html#download). | 86 | Feather-Trace allows for much more fine-grained tracing than the simple debug stream realized by `litmus_log` and hence requires special-purpose tools to be used. These tools are available as part of the `ft_tools` package, which is available on the [LITMUS<sup>RT</sup> download page](../index.html#download). |
86 | 87 | ||
87 | Feather-Trace events can be enabled on a per-event basis. Each event is identified by a unique 32-bit ID. Intially, when the device buffer is not being accessed by any user space programs (*i.e.*, when the device driver is unused), all events are disabled. Events can be enabled (and subsequently disabled again) by writing binary commands to the buffer device file. Once events are enabled they can generate trace records, which are stored in the trace buffer. Userspace programs can obtain these records by reading from the device file. Reading a trace record removes it from the buffer, *i.e.*, each record can be read exactly once. Since buffer capacity is limited records should be consumed shortly after they were created. | 88 | Feather-Trace events can be enabled on a per-event basis. Each event is identified by a unique 32-bit ID. Initially, when the device buffer is not being accessed by any user space programs (*i.e.*, when the device driver is unused), all events are disabled. Events can be enabled (and subsequently disabled again) by writing binary commands to the buffer device file. Once events are enabled they can generate trace records, which are stored in the trace buffer. User space programs can obtain these records by reading from the device file. Reading a trace record removes it from the buffer, *i.e.*, each record can be read exactly once. Records should be consumed shortly after they were created since buffer capacity is limited. |
88 | 89 | ||
89 | The tool `ftcat`, which is part of the `ft_tools` package (see above), automates the process of enabling events and retrieving trace records. It takes the name of the `ft_trace` device file and the events of interest as arguments: | 90 | The tool `ftcat`, which is part of the `ft_tools` package (see above), automates the process of enabling events and retrieving trace records. It takes the name of the `ft_trace` device file and the events of interest as arguments: |
90 | 91 | ||
@@ -92,21 +93,21 @@ The tool `ftcat`, which is part of the `ft_tools` package (see above), automates | |||
92 | 93 | ||
93 | The tool enables the specified events and copies all recorded events to `stdout`. | 94 | The tool enables the specified events and copies all recorded events to `stdout`. |
94 | 95 | ||
95 | Events can be specified either by their ID (see `include/litmus/trace.h` in the kernel directory for a list of timestamp-generating events) or by their symbolic name. The following symbolic names are recognized: | 96 | Events can be specified either by their ID (see `include/litmus/trace.h` in the kernel directory for a list of time stamp generating events) or by their symbolic name. The following symbolic names are recognized: |
96 | 97 | ||
97 | - `SCHED_START`, `SCHED_END`: | 98 | - `SCHED_START`, `SCHED_END`: |
98 | Used to measure the time spent to make a scheduling decision. | 99 | Used to measure the time spent to make a scheduling decision. |
99 | - `CXS_START`, `CXS_END`: | 100 | - `CXS_START`, `CXS_END`: |
100 | Used to record the time spent to make a context switch. | 101 | Used to record the time spent to make a context switch. |
101 | - `SCHED2_START`, `SCHED2_END`: | 102 | - `SCHED2_START`, `SCHED2_END`: |
102 | Used to measure the time spent to perform post-context-switch cleanup and management activities. (This is part of the scheduling overhead but for technical reasons cannot be measured as part of the interval [`SCHED_START`, `SCHED_END`]. | 103 | Used to measure the time spent to perform post-context-switch cleanup and management activities. This is part of the scheduling overhead but for technical reasons cannot be measured as part of the interval [`SCHED_START`, `SCHED_END`]. |
103 | - `TICK_START`, `TICK_END`: | 104 | - `TICK_START`, `TICK_END`: |
104 | Used to measure the overhead incurred at the beginning of a scheduling quantum. | 105 | Used to measure the overhead incurred at the beginning of a scheduling quantum. |
105 | - `PLUGIN_TICK_START`, `PLUGIN_TICK_END`: | 106 | - `PLUGIN_TICK_START`, `PLUGIN_TICK_END`: |
106 | Like [`TICK_START`, `TICK_END`], but only measures the time spent by the active scheduling plugin. | 107 | Like [`TICK_START`, `TICK_END`], but only measures the time spent by the active scheduling plugin. |
107 | - `PLUGIN_SCHED_START`, `PLUGIN_SCHED_END`: | 108 | - `PLUGIN_SCHED_START`, `PLUGIN_SCHED_END`: |
108 | Like [`SCHED_START`, `SCHED_END`], but only measures the time spent by the active scheduling plugin. There is no equivalent `SCHED2` counterpart because the scheduling plugins do not directly compute to the `SCHED2` overhead. | 109 | Like [`SCHED_START`, `SCHED_END`], but only measures the time spent by the active scheduling plugin. There is no equivalent `SCHED2` counterpart because the scheduling plugins do not directly compute to the `SCHED2` overhead. |
109 | - `RELEASE_START`, `RELEASE_END`: | 110 | - `RELEASE_START`, `RELEASE_END`: |
110 | Used to measure the time spent to enqueue a newly-released job in a ready queue. | 111 | Used to measure the time spent to enqueue a newly-released job in a ready queue. |
111 | 112 | ||
112 | For example, the following command can be used to store the length of context switches and scheduling decisions in the file `my_trace`. | 113 | For example, the following command can be used to store the length of context switches and scheduling decisions in the file `my_trace`. |
@@ -122,7 +123,7 @@ Post-Processing Overhead Traces | |||
122 | 123 | ||
123 | The binary event stream recorded by `ftcat` is of course of limited direct use—the data has yet to be exported for analysis. This can be achieved with the tool `ft2csv`, which is also part of the `ft_tools` package. | 124 | The binary event stream recorded by `ftcat` is of course of limited direct use—the data has yet to be exported for analysis. This can be achieved with the tool `ft2csv`, which is also part of the `ft_tools` package. |
124 | 125 | ||
125 | As the name suggests, `ft2csv` extracts intervals defined by pairs of timestamps in a recorded trace and displayse them as *comma-separated values* (CSV). It takes the name of an overhead trace and one start event as arguments: | 126 | As the name suggests, `ft2csv` extracts intervals defined by pairs of time stamps in a recorded trace and displays them as *comma-separated values* (CSV). It takes the name of an overhead trace and one start event as arguments: |
126 | 127 | ||
127 | ft2csv <start event> <overhead trace> | 128 | ft2csv <start event> <overhead trace> |
128 | 129 | ||
@@ -137,9 +138,9 @@ Events are specified in the same way as with `ftcat`. For example, the following | |||
137 | 138 | ||
138 | For each event, the start time (in clock cycles) is given in the first column, the end time is given in the second column, and the length is given in the third column (again, in cycles). | 139 | For each event, the start time (in clock cycles) is given in the first column, the end time is given in the second column, and the length is given in the third column (again, in cycles). |
139 | 140 | ||
140 | `ft2csv` accepts a few options that affect how events are filtered. By default, events that do not involve real-time tasks are ignored. This can be changed by specifiying the `-b` option. If one happens to be processing output on a little-endian host that was produced on a big-endian host then the `-e` option can come in handy. | 141 | `ft2csv` accepts a few options that affect how events are filtered. By default, events that do not involve real-time tasks are ignored. This can be changed by specifying the `-b` option. If one happens to be processing output on a little-endian host that was produced on a big-endian host then the `-e` option can come in handy. |
141 | 142 | ||
142 | Once the recorded overheads have been exported to CSV files they can be easily analyzed with tools such as Python, Octave, or Matlab. | 143 | Once the recorded overheads have been exported to CSV files they can be easily analyzed with tools such as Python's `csv` module, Octave, or Matlab. |
143 | 144 | ||
144 | Recording and Post-Processing Scheduling Traces | 145 | Recording and Post-Processing Scheduling Traces |
145 | ----------------------------------------------- | 146 | ----------------------------------------------- |
@@ -168,7 +169,7 @@ The following example illustrates how a `st_trace` is used with the tag `global- | |||
168 | 169 | ||
169 | Note that `st_trace` may have to modified to change the default `sched_trace` device locations. | 170 | Note that `st_trace` may have to modified to change the default `sched_trace` device locations. |
170 | 171 | ||
171 | **Hint**: To study/test the behavior of a scheduler plugin the dummy real-time task `rtspin` (distributed as part of the `liblitmus` package) may be useful. | 172 | **Hint**: The dummy real-time task `rtspin` (distributed as part of the `liblitmus` package) may be useful when studying/testing the behavior of a scheduler plugin. |
172 | 173 | ||
173 | Post-Processing Overhead Traces | 174 | Post-Processing Overhead Traces |
174 | ------------------------------- | 175 | ------------------------------- |
@@ -180,7 +181,7 @@ The tool `showst` (distributed as part of `liblitmus`) can be used to inspect th | |||
180 | Concluding Remarks | 181 | Concluding Remarks |
181 | ------------------ | 182 | ------------------ |
182 | 183 | ||
183 | At this point we only offer data *acquisition* tools since we have not yet had the time to develop release-quality *analysis* tools. **Patches to improve the acquisition tools and contributions of analysis and visualization tools are very much welcome!** | 184 | At this point we only offer data *acquisition* tools since we have not yet had the time to develop release-quality *analysis* tools. **Patches that improve the existing tools and contributions of new analysis and visualization tools are very much welcome!** |
184 | 185 | ||
185 | For any questions please contact the current LITMUS<sup>RT</sup> maintainer (as indicated on the [LITMUS<sup>RT</sup> homepage](../index.html#collaborators)). | 186 | For any questions please contact the current LITMUS<sup>RT</sup> maintainer (as indicated on the [LITMUS<sup>RT</sup> homepage](../index.html#collaborators)). |
186 | 187 | ||
diff --git a/inc/format-doc.css b/inc/format-doc.css index 78637f9..e70fe6c 100644 --- a/inc/format-doc.css +++ b/inc/format-doc.css | |||
@@ -89,7 +89,7 @@ h1 { | |||
89 | 89 | ||
90 | h2 { | 90 | h2 { |
91 | font: normal normal 18pt Georgia, "Times New Roman", Times, serif; | 91 | font: normal normal 18pt Georgia, "Times New Roman", Times, serif; |
92 | padding-top: 0.75cm; | 92 | padding-top: 0.50cm; |
93 | } | 93 | } |
94 | 94 | ||
95 | .relname { | 95 | .relname { |