Blame - www/formats.html - fp2-dev/platform/external/lldb

<tr valign=top><td><b>frame.reg.NAME</b></td><td>Access to any platform specific register by name (replace <b>NAME</b> with the name of the desired register).</td></tr>

82

<tr valign=top><td><b>function.name</b></td><td>The name of the current function or symbol</td></tr>

83

<tr valign=top><td><b>function.pc-offset</b></td><td>The program counter offset within the current function or symbol</td></tr>

84

<tr valign=top><td><b>line.file.basename</b></td><td>The line table entry basename to the file for the current line entry in the current frame.</td></tr>

85

<tr valign=top><td><b>line.file.fullpath</b></td><td>The line table entry fullpath to the file for the current line entry in the current frame.</td></tr>

86

<tr valign=top><td><b>line.number</b></td><td>The line table entry line number for the current line entry in the current frame.</td></tr>

87

<tr valign=top><td><b>line.start-addr</b></td><td>The line table entry start address for the current line entry in the current frame.</td></tr>

88

<tr valign=top><td><b>line.end-addr</b></td><td>The line table entry end address for the current line entry in the current frame.</td></tr>

89

<tr valign=top><td><b>module.file.basename</b></td><td>The basename of the current module (shared library or executable)</td></tr>

90

<tr valign=top><td><b>module.file.fullpath</b></td><td>The basename of the current module (shared library or executable)</td></tr>

91

<tr valign=top><td><b>process.file.basename</b></td><td>The basename of the file for the process</td></tr>

92

<tr valign=top><td><b>process.file.fullpath</b></td><td>The fullname of the file for the process</td></tr>

93

<tr valign=top><td><b>process.id</b></td><td>The process ID native the the system on which the inferior runs.</td></tr>

94

<tr valign=top><td><b>process.name</b></td><td>The name of the process at runtime</td></tr>

95

<tr valign=top><td><b>thread.id</b></td><td>The thread identifier for the current thread</td></tr>

96

<tr valign=top><td><b>thread.index</b></td><td>The unique one based thread index ID which is guaranteed to be unique as threads come and go.</td></tr>

97

<tr valign=top><td><b>thread.name</b></td><td>The name of the thread if the target OS supports naming threads</td></tr>

98

<tr valign=top><td><b>thread.queue</b></td><td>The queue name of the thread if the target OS supports dispatch queues</td></tr>

99

<tr valign=top><td><b>thread.stop-reason</b></td><td>A textual reason each thread stopped</td></tr>

Jim Ingham

1586d97

2011-12-17 01:35:57 +0000

[diff] [blame]

100

<tr valign=top><td><b>thread.return-value</b></td><td>The return value of the latest step operation (currently only for step-out.)</td></tr>

Greg Clayton

198e8fe

2010-10-04 02:33:45 +0000

[diff] [blame]

101

<tr valign=top><td><b>target.arch</b></td><td>The architecture of the current target</td></tr>

</table>

</div>

</div>

<h1 class ="postheader">Control Characters</h1>

110

111

112

<p>Control characters include <b><code>'{'</code></b>,

113

114

115

<p>The '{' and '}' are used for scoping blocks, and the '\' character

116

allows you to desensitize control characters and also emit non-printable

characters.

</div>

</div>

<h1 class ="postheader">Desensitizing Characters in the format string</h1>

125

126

<p>The backslash control character allows your to enter the typical

127

<b><code>"\a"</code></b>, <b><code>"\b"</code></b>, <b><code>"\f"</code></b>, <b><code>"\n"</code></b>,

128

<b><code>"\r"</code></b>, <b><code>"\t"</code></b>, <b><code>"\v"</code></b>, <b><code>"\\"</code></b>, characters

129

and along with the standard octal representation <b><code>"\0123"</code></b>

130

and hex <b><code>"\xAB"</code></b> characters. This allows you to enter

131

escape characters into your format strings and will

132

allow colorized output for terminals that support color.

</div>

</div>

<h1 class ="postheader">Scoping</h1>

140

141

<p>Many times the information that you might have in your prompt might not be

142

available and you won't want it to print out if it isn't valid. To take care

143

of this you can enclose everything that <b>must</b> resolve into a scope. A scope

144

is starts with <code><b>'{'</code></b> and ends with

145

<code><b>'}'</code></b>. For example in order to only display

146

the current frame line table entry basename and line number when the information

147

is available for the current frame:

148

149

<p><b><code>"{ at {$line.file.basename}:${line.number}}"</code></b></p>

150

151

<p>Broken down this is:

152

<ul>

153

<li>The start the scope <p><b><code>"{"</code></b></p></li>

154

<li> format whose content will only be displayed if all information is available:

155

<p><b><code>"at {$line.file.basename}:${line.number}"</code></b></p></li>

156

<li>end the scope: <p><b><code>"}"</code></b></p></li>

</ul>

</div>

</div>

<h1 class ="postheader">Making the Frame Format</h1>

165

166

<p>The information that we see when stopped in a frame:

167

168

<p><b><code>frame #0: 0x0000000100000e85 a.out`main + 4 at test.c:19</code></b></p>

169

170

<p>can be displayed with the following format:</p>

171

172

<p><b><code>"frame #${frame.index}: ${frame.pc}{ ${module.file.basename}`${function.name}{${function.pc-offset}}}{ at ${line.file.basename}:${line.number}}\n"</code></b></p>

173

174

<p>This breaks down to:

175

176

<ul>

177

<li>Always print the frame index and frame PC:

178

179

<p><b><code>"frame #${frame.index}: ${frame.pc}"</code></b></p>

180

181

<li>only print the module followed by a tick if there is a valid

182

module for the current frame:

183

184

<p><b><code>"{ ${module.file.basename}`}"</code></b></p>

185

186

<li>print the function name with optional offset:</p>

187

<p><b><code>"{${function.name}{${function.pc-offset}}}"</code></b></p>

188

189

<li>print the line info if it is available:</p>

190

191

<p><b><code>"{ at ${line.file.basename}:${line.number}}"</code></b></p>

192

193

<li>then finish off with a newline:</p>

</ul>

</div>

</div>

<h1 class ="postheader">Making Your Own Formats</h1>

204

205

206

<p>When modifying your own format strings, it is useful

207

to start with the default values for the frame and

208

thread format strings. These can be accessed with the

209

<b><code>"settings show"</code></b> command:

210

211

<p><b><code>(lldb)</b> settings show thread-format

212

<br>thread-format (string) = 'thread #${thread.index}: tid = ${thread.id}{, ${frame.pc}}{ ${module.file.basename}`${function.name}{${function.pc-offset}}}{, stop reason = ${thread.stop-reason}}{, name = ${thread.name}}{, queue = ${thread.queue}}\n'

213

<br><b>(lldb)</b> settings show frame-format

214

<br>frame-format (string) = 'frame #${frame.index}: ${frame.pc}{ ${module.file.basename}`${function.name}{${function.pc-offset}}}{ at ${line.file.basename}:${line.number}}\n'

</code></p>

Greg Clayton

2010-10-04 03:06:05 +0000

[diff] [blame]

218

<p>When making thread formats, you will need surround any

219

of the information that comes from a stack frame with scopes (<b>{</b> <i>frame-content</i> <b>}</b>)

220

as the thread format doesn't always want to show frame information.

221

When displaying the backtrace for a thread, we don't need to duplicate

222

the information for frame zero in the thread information:

223

224

<p><code><b>(lldb)</b> thread backtrace

225

<br>thread #1: tid = 0x2e03, stop reason = breakpoint 1.1 2.1

226

<br>  frame #0: 0x0000000100000e85 a.out`main + 4 at test.c:19

227

<br>  frame #1: 0x0000000100000e40 a.out`start + 52

</code>

</p>

<p>The frame related variables are:

232

<ul>

233

234

<li><code><b>${frame.*}</b></code></li>

235

<li><code><b>${function.*}</b></code></li>

236

237

<li><code><b>${module.*}</b></code></li>

</ul>

</p>

<p>Looking at the default format for the thread, and underlining

242

the frame information:

243

<p><code>'thread #${thread.index}: tid = ${thread.id}<u><b>{</b>, ${frame.pc}<b>}{</b> ${module.file.basename}`${function.name}{${function.pc-offset}}<b>}</b></u>{, stop reason = ${thread.stop-reason}}{, name = ${thread.name}}{, queue = ${thread.queue}}\n'

244

</code></p>

245

<p>We can see that all frame information is contained in scopes so

246

that when the thread information is displayed in a context where

247

we only want to show thread information, we can do so.

248

Greg Clayton

198e8fe

2010-10-04 02:33:45 +0000