aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorRandy Dunlap <randy.dunlap@oracle.com>2010-04-08 18:57:18 -0400
committerSteven Rostedt <rostedt@goodmis.org>2010-04-09 10:18:12 -0400
commitda91094fad7ae5c93056d77300221ad913b4891f (patch)
tree5341940f2a0a522c1c36f43239e8f9801dce8fd7 /Documentation
parent94ea9b96207b73c4368882c459552b36ec91dfe6 (diff)
trace-cmd: trace.dat file format doc fixes
Typo/grammo corrections to trace-cmd.dat.5.txt: Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> LKML-Reference: <20100408155718.8673c823.randy.dunlap@oracle.com> Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/trace-cmd.dat.5.txt58
1 files changed, 29 insertions, 29 deletions
diff --git a/Documentation/trace-cmd.dat.5.txt b/Documentation/trace-cmd.dat.5.txt
index b393d3d..4d0cce5 100644
--- a/Documentation/trace-cmd.dat.5.txt
+++ b/Documentation/trace-cmd.dat.5.txt
@@ -29,7 +29,7 @@ INITIAL FORMAT
29 29
30 "tracing" 30 "tracing"
31 31
32 The next set of characters contain a null '\0' terminated string, 32 The next set of characters contain a null '\0' terminated string
33 that contains the version of the file (for example): 33 that contains the version of the file (for example):
34 34
35 "6\0" 35 "6\0"
@@ -41,15 +41,15 @@ INITIAL FORMAT
41 41
42 The next byte contains the number of bytes per "long" value: 42 The next byte contains the number of bytes per "long" value:
43 43
44 4 - 32 bit long values 44 4 - 32-bit long values
45 8 - 64 bit long values 45 8 - 64-bit long values
46 46
47 Note: This is the long size of the target's userspace. Not the 47 Note: This is the long size of the target's userspace. Not the
48 kernel space size. 48 kernel space size.
49 49
50 [ Now all numbers are written in file defined endianess ] 50 [ Now all numbers are written in file defined endianess. ]
51 51
52 The next 4 bytes is a 32 bit word that defines what the traced 52 The next 4 bytes are a 32-bit word that defines what the traced
53 host machine page size was. 53 host machine page size was.
54 54
55HEADER INFO FORMAT 55HEADER INFO FORMAT
@@ -62,28 +62,28 @@ HEADER INFO FORMAT
62 62
63 "header_page\0" 63 "header_page\0"
64 64
65 The next 8 bytes is a 64 bit word containing the size of the 65 The next 8 bytes are a 64-bit word containing the size of the
66 page header information stored next. 66 page header information stored next.
67 67
68 The next set of data is of the size read from the previous 8 bytes, 68 The next set of data is of the size read from the previous 8 bytes,
69 and contains the data retrieved from debugfs/tracing/events/header_page 69 and contains the data retrieved from debugfs/tracing/events/header_page.
70 70
71 Note: The size of the second field \fBcommit\fR contains the target 71 Note: The size of the second field \fBcommit\fR contains the target
72 kernel long size. For example: 72 kernel long size. For example:
73 73
74 field: local_t commit; offset:8; \fBsize:8;\fR signed:1; 74 field: local_t commit; offset:8; \fBsize:8;\fR signed:1;
75 75
76 Shows the kernel has a 64 bit long. 76 shows the kernel has a 64-bit long.
77 77
78 The next 13 bytes contain the string: 78 The next 13 bytes contain the string:
79 79
80 "header_event\0" 80 "header_event\0"
81 81
82 The next 8 bytes is a 64 bit word containing the size of the 82 The next 8 bytes are a 64-bit word containing the size of the
83 event header information stored next. 83 event header information stored next.
84 84
85 The next set of data is of the size read from the previous 8 bytes 85 The next set of data is of the size read from the previous 8 bytes
86 and contains the data retrieved from debugfs/tracing/events/header_event 86 and contains the data retrieved from debugfs/tracing/events/header_event.
87 87
88 This data allows the trace-cmd tool to know if the ring buffer format 88 This data allows the trace-cmd tool to know if the ring buffer format
89 of the kernel made any changes. 89 of the kernel made any changes.
@@ -95,7 +95,7 @@ FTRACE EVENT FORMATS
95 the Ftrace specific events. These are the events used by the Ftrace plugins 95 the Ftrace specific events. These are the events used by the Ftrace plugins
96 and are not enabled by the event tracing. 96 and are not enabled by the event tracing.
97 97
98 The next 4 bytes contains a 32 bit word of the number of Ftrace event 98 The next 4 bytes contain a 32-bit word of the number of Ftrace event
99 format files that are stored in the file. 99 format files that are stored in the file.
100 100
101 For the number of times defined by the previous 4 bytes is the 101 For the number of times defined by the previous 4 bytes is the
@@ -112,7 +112,7 @@ EVENT FORMATS
112 Directly after the Ftrace formats comes the information about 112 Directly after the Ftrace formats comes the information about
113 the event layout. 113 the event layout.
114 114
115 The next 4 bytes is a 32 bit word containing the number of 115 The next 4 bytes are a 32-bit word containing the number of
116 event systems that are stored in the file. These are the 116 event systems that are stored in the file. These are the
117 directories in debugfs/tracing/events excluding the \fBftrace\fR 117 directories in debugfs/tracing/events excluding the \fBftrace\fR
118 directory. 118 directory.
@@ -120,9 +120,9 @@ EVENT FORMATS
120 For the number of times defined by the previous 4 bytes is the 120 For the number of times defined by the previous 4 bytes is the
121 following: 121 following:
122 122
123 A null terminated string containing the system name. 123 A null-terminated string containing the system name.
124 124
125 4 bytes containing a 32 bit word containing the number 125 4 bytes containing a 32-bit word containing the number
126 of events within the system. 126 of events within the system.
127 127
128 For the number of times defined in the previous 4 bytes is the 128 For the number of times defined in the previous 4 bytes is the
@@ -139,7 +139,7 @@ KALLSYMS INFORMATION
139 Directly after the event formats comes the information of the mapping 139 Directly after the event formats comes the information of the mapping
140 of function addresses to the function names. 140 of function addresses to the function names.
141 141
142 The next 4 bytes is a 32 bit word containing the size of the 142 The next 4 bytes are a 32-bit word containing the size of the
143 data holding the function mappings. 143 data holding the function mappings.
144 144
145 The next set of data is of the size defined by the previous 4 bytes 145 The next set of data is of the size defined by the previous 4 bytes
@@ -155,8 +155,8 @@ TRACE_PRINTK INFORMATION
155 This information can be found in: 155 This information can be found in:
156 debugfs/tracing/printk_formats 156 debugfs/tracing/printk_formats
157 157
158 The next 4 bytes is a 32 bit word containing the size of the 158 The next 4 bytes are a 32-bit word containing the size of the
159 data holding the printk formats 159 data holding the printk formats.
160 160
161 The next set of data is of the size defined by the previous 4 bytes 161 The next set of data is of the size defined by the previous 4 bytes
162 and contains the information from debugfs/tracing/printk_formats. 162 and contains the information from debugfs/tracing/printk_formats.
@@ -168,11 +168,11 @@ PROCESS INFORMATION
168 Directly after the trace_printk formats comes the information mapping 168 Directly after the trace_printk formats comes the information mapping
169 a PID to a process name. 169 a PID to a process name.
170 170
171 The next 8 bytes contains a 64 bit word that holds the size of the 171 The next 8 bytes contain a 64-bit word that holds the size of the
172 data mapping the PID to a process name. 172 data mapping the PID to a process name.
173 173
174 The next set of data is of the size defined by the previous 8 bytes 174 The next set of data is of the size defined by the previous 8 bytes
175 and contains the information from debugfs/tracing/saved_cmdlines 175 and contains the information from debugfs/tracing/saved_cmdlines.
176 176
177 177
178REST OF TRACE-CMD HEADER 178REST OF TRACE-CMD HEADER
@@ -181,11 +181,11 @@ REST OF TRACE-CMD HEADER
181 Directly after the process information comes the last bit of the 181 Directly after the process information comes the last bit of the
182 trace.dat file header. 182 trace.dat file header.
183 183
184 The next 4 bytes is a 32 bit word defining the number of CPUs that 184 The next 4 bytes are a 32-bit word defining the number of CPUs that
185 was discovered on the target machine (and has matching trace data 185 were discovered on the target machine (and has matching trace data
186 for it). 186 for it).
187 187
188 The next 10 bytes is one of the following: 188 The next 10 bytes are one of the following:
189 189
190 "options \0" 190 "options \0"
191 191
@@ -195,10 +195,10 @@ REST OF TRACE-CMD HEADER
195 195
196 If it is "options \0" then: 196 If it is "options \0" then:
197 197
198 The next 2 bytes is a 16 bit word defining the current option. 198 The next 2 bytes are a 16-bit word defining the current option.
199 If the the value is zero then there are no more options. 199 If the the value is zero then there are no more options.
200 200
201 Otherwise, the next 4 bytes contains a 32 bit word containing the 201 Otherwise, the next 4 bytes contain a 32-bit word containing the
202 option size. If the reader does not know how to handle the option 202 option size. If the reader does not know how to handle the option
203 it can simply skip it. Currently there are no options defined, 203 it can simply skip it. Currently there are no options defined,
204 but this is here to extend the data. 204 but this is here to extend the data.
@@ -206,16 +206,16 @@ REST OF TRACE-CMD HEADER
206 The next option will be directly after the previous option, and 206 The next option will be directly after the previous option, and
207 the options ends with a zero in the option type field. 207 the options ends with a zero in the option type field.
208 208
209 The next 10 bytes after the options is one of the following: 209 The next 10 bytes after the options are one of the following:
210 210
211 "latency \0" 211 "latency \0"
212 212
213 "flyrecord\0" 213 "flyrecord\0"
214 214
215 Which would follow the same as if options were not present. 215 which would follow the same as if options were not present.
216 216
217 If the value is "latency \0", then the rest of the file is 217 If the value is "latency \0", then the rest of the file is
218 simply ASCII text that was taken from the targets: 218 simply ASCII text that was taken from the target's:
219 debugfs/tracing/trace 219 debugfs/tracing/trace
220 220
221 If the value is "flyrecord\0", the following is present: 221 If the value is "flyrecord\0", the following is present:
@@ -223,10 +223,10 @@ REST OF TRACE-CMD HEADER
223 For the number of CPUs that were read earlier, the 223 For the number of CPUs that were read earlier, the
224 following is present: 224 following is present:
225 225
226 8 bytes that is a 64 bit word containing the offset into the file 226 8 bytes that are a 64-bit word containing the offset into the file
227 that holds the data for the CPU. 227 that holds the data for the CPU.
228 228
229 8 bytes that is a 64 bit word containing the size of the CPU 229 8 bytes that are a 64-bit word containing the size of the CPU
230 data at that offset. 230 data at that offset.
231 231
232CPU DATA 232CPU DATA