visus
/
toolchain-gcc-arm-embedded
Seguir 1
Destacar 0
Fork 0
Código Incidencias 0 Pull Requests 0 Lanzamientos 0 Wiki Actividad
No puede seleccionar más de 25 temas Los temas deben comenzar con una letra o número, pueden incluir guiones ('-') y pueden tener hasta 35 caracteres de largo.
2 Commits
1 Rama
Árbol: 898a39b5ab
Ramas Etiquetas
${ item.name }
Crear rama ${ searchTerm }
desde '898a39b5ab'
${ noResults }
toolchain-gcc-arm-embedded/share/doc/gcc-arm-none-eabi/html/gdb/General-Query-Packets.html

1798 líneas
89KB
Original Blame Histórico 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

  2. <html>

  3. <!-- Copyright (C) 1988-2020 Free Software Foundation, Inc.

  4. 

  5. Permission is granted to copy, distribute and/or modify this document

  6. under the terms of the GNU Free Documentation License, Version 1.3 or

  7. any later version published by the Free Software Foundation; with the

  8. Invariant Sections being "Free Software" and "Free Software Needs

  9. Free Documentation", with the Front-Cover Texts being "A GNU Manual,"

  10. and with the Back-Cover Texts as in (a) below.

  11. 

  12. (a) The FSF's Back-Cover Text is: "You are free to copy and modify

  13. this GNU Manual.  Buying copies from GNU Press supports the FSF in

  14. developing GNU and promoting software freedom." -->

  15. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->

  16. <head>

  17. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">

  18. <title>General Query Packets (Debugging with GDB)</title>

  19. 

  20. <meta name="description" content="General Query Packets (Debugging with GDB)">

  21. <meta name="keywords" content="General Query Packets (Debugging with GDB)">

  22. <meta name="resource-type" content="document">

  23. <meta name="distribution" content="global">

  24. <meta name="Generator" content="makeinfo">

  25. <link href="index.html#Top" rel="start" title="Top">

  26. <link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">

  27. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">

  28. <link href="Remote-Protocol.html#Remote-Protocol" rel="up" title="Remote Protocol">

  29. <link href="Architecture_002dSpecific-Protocol-Details.html#Architecture_002dSpecific-Protocol-Details" rel="next" title="Architecture-Specific Protocol Details">

  30. <link href="Stop-Reply-Packets.html#Stop-Reply-Packets" rel="prev" title="Stop Reply Packets">

  31. <style type="text/css">

  32. <!--

  33. a.summary-letter {text-decoration: none}

  34. blockquote.indentedblock {margin-right: 0em}

  35. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}

  36. blockquote.smallquotation {font-size: smaller}

  37. div.display {margin-left: 3.2em}

  38. div.example {margin-left: 3.2em}

  39. div.lisp {margin-left: 3.2em}

  40. div.smalldisplay {margin-left: 3.2em}

  41. div.smallexample {margin-left: 3.2em}

  42. div.smalllisp {margin-left: 3.2em}

  43. kbd {font-style: oblique}

  44. pre.display {font-family: inherit}

  45. pre.format {font-family: inherit}

  46. pre.menu-comment {font-family: serif}

  47. pre.menu-preformatted {font-family: serif}

  48. pre.smalldisplay {font-family: inherit; font-size: smaller}

  49. pre.smallexample {font-size: smaller}

  50. pre.smallformat {font-family: inherit; font-size: smaller}

  51. pre.smalllisp {font-size: smaller}

  52. span.nolinebreak {white-space: nowrap}

  53. span.roman {font-family: initial; font-weight: normal}

  54. span.sansserif {font-family: sans-serif; font-weight: normal}

  55. ul.no-bullet {list-style: none}

  56. -->

  57. </style>

  58. 

  59. 

  60. </head>

  61. 

  62. <body lang="en">

  63. <a name="General-Query-Packets"></a>

  64. <div class="header">

  65. <p>

  66. Next: <a href="Architecture_002dSpecific-Protocol-Details.html#Architecture_002dSpecific-Protocol-Details" accesskey="n" rel="next">Architecture-Specific Protocol Details</a>, Previous: <a href="Stop-Reply-Packets.html#Stop-Reply-Packets" accesskey="p" rel="prev">Stop Reply Packets</a>, Up: <a href="Remote-Protocol.html#Remote-Protocol" accesskey="u" rel="up">Remote Protocol</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>

  67. </div>

  68. <hr>

  69. <a name="General-Query-Packets-1"></a>

  70. <h3 class="section">E.4 General Query Packets</h3>

  71. <a name="index-remote-query-requests"></a>

  72. 

  73. <p>Packets starting with &lsquo;<samp>q</samp>&rsquo; are <em>general query packets</em>;

  74. packets starting with &lsquo;<samp>Q</samp>&rsquo; are <em>general set packets</em>.  General

  75. query and set packets are a semi-unified form for retrieving and

  76. sending information to and from the stub.

  77. </p>

  78. <p>The initial letter of a query or set packet is followed by a name

  79. indicating what sort of thing the packet applies to.  For example,

  80. <small>GDB</small> may use a &lsquo;<samp>qSymbol</samp>&rsquo; packet to exchange symbol

  81. definitions with the stub.  These packet names follow some

  82. conventions:

  83. </p>

  84. <ul>

  85. <li> The name must not contain commas, colons or semicolons.

  86. </li><li> Most <small>GDB</small> query and set packets have a leading upper case

  87. letter.

  88. </li><li> The names of custom vendor packets should use a company prefix, in

  89. lower case, followed by a period.  For example, packets designed at

  90. the Acme Corporation might begin with &lsquo;<samp>qacme.foo</samp>&rsquo; (for querying

  91. foos) or &lsquo;<samp>Qacme.bar</samp>&rsquo; (for setting bars).

  92. </li></ul>

  93. 

  94. <p>The name of a query or set packet should be separated from any

  95. parameters by a &lsquo;<samp>:</samp>&rsquo;; the parameters themselves should be

  96. separated by &lsquo;<samp>,</samp>&rsquo; or &lsquo;<samp>;</samp>&rsquo;.  Stubs must be careful to match the

  97. full packet name, and check for a separator or the end of the packet,

  98. in case two packet names share a common prefix.  New packets should not begin

  99. with &lsquo;<samp>qC</samp>&rsquo;, &lsquo;<samp>qP</samp>&rsquo;, or &lsquo;<samp>qL</samp>&rsquo;<a name="DOCF20" href="#FOOT20"><sup>20</sup></a>.

  100. </p>

  101. <p>Like the descriptions of the other packets, each description here

  102. has a template showing the packet&rsquo;s overall syntax, followed by an

  103. explanation of the packet&rsquo;s meaning.  We include spaces in some of the

  104. templates for clarity; these are not part of the packet&rsquo;s syntax.  No

  105. <small>GDB</small> packet uses spaces to separate its components.

  106. </p>

  107. <p>Here are the currently defined query and set packets:

  108. </p>

  109. <dl compact="compact">

  110. <dt>&lsquo;<samp>QAgent:1</samp>&rsquo;</dt>

  111. <dt>&lsquo;<samp>QAgent:0</samp>&rsquo;</dt>

  112. <dd><p>Turn on or off the agent as a helper to perform some debugging operations

  113. delegated from <small>GDB</small> (see <a href="In_002dProcess-Agent.html#Control-Agent">Control Agent</a>).

  114. </p>

  115. </dd>

  116. <dt>&lsquo;<samp>QAllow:<var>op</var>:<var>val</var>&hellip;</samp>&rsquo;</dt>

  117. <dd><a name="index-QAllow-packet"></a>

  118. <p>Specify which operations <small>GDB</small> expects to request of the

  119. target, as a semicolon-separated list of operation name and value

  120. pairs.  Possible values for <var>op</var> include &lsquo;<samp>WriteReg</samp>&rsquo;,

  121. &lsquo;<samp>WriteMem</samp>&rsquo;, &lsquo;<samp>InsertBreak</samp>&rsquo;, &lsquo;<samp>InsertTrace</samp>&rsquo;,

  122. &lsquo;<samp>InsertFastTrace</samp>&rsquo;, and &lsquo;<samp>Stop</samp>&rsquo;. <var>val</var> is either 0,

  123. indicating that <small>GDB</small> will not request the operation, or 1,

  124. indicating that it may.  (The target can then use this to set up its

  125. own internals optimally, for instance if the debugger never expects to

  126. insert breakpoints, it may not need to install its own trap handler.)

  127. </p>

  128. </dd>

  129. <dt>&lsquo;<samp>qC</samp>&rsquo;</dt>

  130. <dd><a name="index-current-thread_002c-remote-request"></a>

  131. <a name="index-qC-packet"></a>

  132. <p>Return the current thread ID.

  133. </p>

  134. <p>Reply:

  135. </p><dl compact="compact">

  136. <dt>&lsquo;<samp>QC <var>thread-id</var></samp>&rsquo;</dt>

  137. <dd><p>Where <var>thread-id</var> is a thread ID as documented in 

  138. <a href="Packets.html#thread_002did-syntax">thread-id syntax</a>.

  139. </p></dd>

  140. <dt>&lsquo;<samp><span class="roman">(anything else)</span></samp>&rsquo;</dt>

  141. <dd><p>Any other reply implies the old thread ID.

  142. </p></dd>

  143. </dl>

  144. 

  145. </dd>

  146. <dt>&lsquo;<samp>qCRC:<var>addr</var>,<var>length</var></samp>&rsquo;</dt>

  147. <dd><a name="index-CRC-of-memory-block_002c-remote-request"></a>

  148. <a name="index-qCRC-packet"></a>

  149. <a name="qCRC-packet"></a><p>Compute the CRC checksum of a block of memory using CRC-32 defined in

  150. IEEE 802.3.  The CRC is computed byte at a time, taking the most

  151. significant bit of each byte first.  The initial pattern code

  152. <code>0xffffffff</code> is used to ensure leading zeros affect the CRC.

  153. </p>

  154. <p><em>Note:</em> This is the same CRC used in validating separate debug

  155. files (see <a href="Separate-Debug-Files.html#Separate-Debug-Files">Debugging Information in Separate

  156. Files</a>).  However the algorithm is slightly different.  When validating

  157. separate debug files, the CRC is computed taking the <em>least</em>

  158. significant bit of each byte first, and the final result is inverted to

  159. detect trailing zeros.

  160. </p>

  161. <p>Reply:

  162. </p><dl compact="compact">

  163. <dt>&lsquo;<samp>E <var>NN</var></samp>&rsquo;</dt>

  164. <dd><p>An error (such as memory fault)

  165. </p></dd>

  166. <dt>&lsquo;<samp>C <var>crc32</var></samp>&rsquo;</dt>

  167. <dd><p>The specified memory region&rsquo;s checksum is <var>crc32</var>.

  168. </p></dd>

  169. </dl>

  170. 

  171. </dd>

  172. <dt>&lsquo;<samp>QDisableRandomization:<var>value</var></samp>&rsquo;</dt>

  173. <dd><a name="index-disable-address-space-randomization_002c-remote-request"></a>

  174. <a name="index-QDisableRandomization-packet"></a>

  175. <p>Some target operating systems will randomize the virtual address space

  176. of the inferior process as a security feature, but provide a feature

  177. to disable such randomization, e.g. to allow for a more deterministic

  178. debugging experience.  On such systems, this packet with a <var>value</var>

  179. of 1 directs the target to disable address space randomization for

  180. processes subsequently started via &lsquo;<samp>vRun</samp>&rsquo; packets, while a packet

  181. with a <var>value</var> of 0 tells the target to enable address space

  182. randomization.

  183. </p>

  184. <p>This packet is only available in extended mode (see <a href="Packets.html#extended-mode">extended mode</a>).

  185. </p>

  186. <p>Reply:

  187. </p><dl compact="compact">

  188. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  189. <dd><p>The request succeeded.

  190. </p>

  191. </dd>

  192. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  193. <dd><p>An error occurred.  The error number <var>nn</var> is given as hex digits.

  194. </p>

  195. </dd>

  196. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  197. <dd><p>An empty reply indicates that &lsquo;<samp>QDisableRandomization</samp>&rsquo; is not supported

  198. by the stub.

  199. </p></dd>

  200. </dl>

  201. 

  202. <p>This packet is not probed by default; the remote stub must request it,

  203. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  204. This should only be done on targets that actually support disabling

  205. address space randomization.

  206. </p>

  207. </dd>

  208. <dt>&lsquo;<samp>QStartupWithShell:<var>value</var></samp>&rsquo;</dt>

  209. <dd><a name="index-startup-with-shell_002c-remote-request"></a>

  210. <a name="index-QStartupWithShell-packet"></a>

  211. <p>On UNIX-like targets, it is possible to start the inferior using a

  212. shell program.  This is the default behavior on both <small>GDB</small> and

  213. <code>gdbserver</code> (see <a href="Starting.html#set-startup_002dwith_002dshell">set startup-with-shell</a>).  This packet is

  214. used to inform <code>gdbserver</code> whether it should start the

  215. inferior using a shell or not.

  216. </p>

  217. <p>If <var>value</var> is &lsquo;<samp>0</samp>&rsquo;, <code>gdbserver</code> will not use a shell

  218. to start the inferior.  If <var>value</var> is &lsquo;<samp>1</samp>&rsquo;,

  219. <code>gdbserver</code> will use a shell to start the inferior.  All other

  220. values are considered an error.

  221. </p>

  222. <p>This packet is only available in extended mode (see <a href="Packets.html#extended-mode">extended mode</a>).

  223. </p>

  224. <p>Reply:

  225. </p><dl compact="compact">

  226. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  227. <dd><p>The request succeeded.

  228. </p>

  229. </dd>

  230. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  231. <dd><p>An error occurred.  The error number <var>nn</var> is given as hex digits.

  232. </p></dd>

  233. </dl>

  234. 

  235. <p>This packet is not probed by default; the remote stub must request it,

  236. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response

  237. (see <a href="#qSupported">qSupported</a>).  This should only be done on targets that

  238. actually support starting the inferior using a shell.

  239. </p>

  240. <p>Use of this packet is controlled by the <code>set startup-with-shell</code>

  241. command; see <a href="Starting.html#set-startup_002dwith_002dshell">set startup-with-shell</a>.

  242. </p>

  243. </dd>

  244. <dt>&lsquo;<samp>QEnvironmentHexEncoded:<var>hex-value</var></samp>&rsquo;</dt>

  245. <dd><a name="QEnvironmentHexEncoded"></a><a name="index-set-environment-variable_002c-remote-request"></a>

  246. <a name="index-QEnvironmentHexEncoded-packet"></a>

  247. <p>On UNIX-like targets, it is possible to set environment variables that

  248. will be passed to the inferior during the startup process.  This

  249. packet is used to inform <code>gdbserver</code> of an environment

  250. variable that has been defined by the user on <small>GDB</small> (see <a href="Environment.html#set-environment">set environment</a>).

  251. </p>

  252. <p>The packet is composed by <var>hex-value</var>, an hex encoded

  253. representation of the <var>name=value</var> format representing an

  254. environment variable.  The name of the environment variable is

  255. represented by <var>name</var>, and the value to be assigned to the

  256. environment variable is represented by <var>value</var>.  If the variable

  257. has no value (i.e., the value is <code>null</code>), then <var>value</var> will

  258. not be present.

  259. </p>

  260. <p>This packet is only available in extended mode (see <a href="Packets.html#extended-mode">extended mode</a>).

  261. </p>

  262. <p>Reply:

  263. </p><dl compact="compact">

  264. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  265. <dd><p>The request succeeded.

  266. </p></dd>

  267. </dl>

  268. 

  269. <p>This packet is not probed by default; the remote stub must request it,

  270. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response

  271. (see <a href="#qSupported">qSupported</a>).  This should only be done on targets that

  272. actually support passing environment variables to the starting

  273. inferior.

  274. </p>

  275. <p>This packet is related to the <code>set environment</code> command;

  276. see <a href="Environment.html#set-environment">set environment</a>.

  277. </p>

  278. </dd>

  279. <dt>&lsquo;<samp>QEnvironmentUnset:<var>hex-value</var></samp>&rsquo;</dt>

  280. <dd><a name="QEnvironmentUnset"></a><a name="index-unset-environment-variable_002c-remote-request"></a>

  281. <a name="index-QEnvironmentUnset-packet"></a>

  282. <p>On UNIX-like targets, it is possible to unset environment variables

  283. before starting the inferior in the remote target.  This packet is

  284. used to inform <code>gdbserver</code> of an environment variable that has

  285. been unset by the user on <small>GDB</small> (see <a href="Environment.html#unset-environment">unset environment</a>).

  286. </p>

  287. <p>The packet is composed by <var>hex-value</var>, an hex encoded

  288. representation of the name of the environment variable to be unset.

  289. </p>

  290. <p>This packet is only available in extended mode (see <a href="Packets.html#extended-mode">extended mode</a>).

  291. </p>

  292. <p>Reply:

  293. </p><dl compact="compact">

  294. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  295. <dd><p>The request succeeded.

  296. </p></dd>

  297. </dl>

  298. 

  299. <p>This packet is not probed by default; the remote stub must request it,

  300. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response

  301. (see <a href="#qSupported">qSupported</a>).  This should only be done on targets that

  302. actually support passing environment variables to the starting

  303. inferior.

  304. </p>

  305. <p>This packet is related to the <code>unset environment</code> command;

  306. see <a href="Environment.html#unset-environment">unset environment</a>.

  307. </p>

  308. </dd>

  309. <dt>&lsquo;<samp>QEnvironmentReset</samp>&rsquo;</dt>

  310. <dd><a name="QEnvironmentReset"></a><a name="index-reset-environment_002c-remote-request"></a>

  311. <a name="index-QEnvironmentReset-packet"></a>

  312. <p>On UNIX-like targets, this packet is used to reset the state of

  313. environment variables in the remote target before starting the

  314. inferior.  In this context, reset means unsetting all environment

  315. variables that were previously set by the user (i.e., were not

  316. initially present in the environment).  It is sent to

  317. <code>gdbserver</code> before the &lsquo;<samp>QEnvironmentHexEncoded</samp>&rsquo;

  318. (see <a href="#QEnvironmentHexEncoded">QEnvironmentHexEncoded</a>) and the &lsquo;<samp>QEnvironmentUnset</samp>&rsquo;

  319. (see <a href="#QEnvironmentUnset">QEnvironmentUnset</a>) packets.

  320. </p>

  321. <p>This packet is only available in extended mode (see <a href="Packets.html#extended-mode">extended mode</a>).

  322. </p>

  323. <p>Reply:

  324. </p><dl compact="compact">

  325. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  326. <dd><p>The request succeeded.

  327. </p></dd>

  328. </dl>

  329. 

  330. <p>This packet is not probed by default; the remote stub must request it,

  331. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response

  332. (see <a href="#qSupported">qSupported</a>).  This should only be done on targets that

  333. actually support passing environment variables to the starting

  334. inferior.

  335. </p>

  336. </dd>

  337. <dt>&lsquo;<samp>QSetWorkingDir:<span class="roman">[</span><var>directory</var><span class="roman">]</span></samp>&rsquo;</dt>

  338. <dd><a name="QSetWorkingDir-packet"></a><a name="index-set-working-directory_002c-remote-request"></a>

  339. <a name="index-QSetWorkingDir-packet"></a>

  340. <p>This packet is used to inform the remote server of the intended

  341. current working directory for programs that are going to be executed.

  342. </p>

  343. <p>The packet is composed by <var>directory</var>, an hex encoded

  344. representation of the directory that the remote inferior will use as

  345. its current working directory.  If <var>directory</var> is an empty string,

  346. the remote server should reset the inferior&rsquo;s current working

  347. directory to its original, empty value.

  348. </p>

  349. <p>This packet is only available in extended mode (see <a href="Packets.html#extended-mode">extended mode</a>).

  350. </p>

  351. <p>Reply:

  352. </p><dl compact="compact">

  353. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  354. <dd><p>The request succeeded.

  355. </p></dd>

  356. </dl>

  357. 

  358. </dd>

  359. <dt>&lsquo;<samp>qfThreadInfo</samp>&rsquo;</dt>

  360. <dt>&lsquo;<samp>qsThreadInfo</samp>&rsquo;</dt>

  361. <dd><a name="index-list-active-threads_002c-remote-request"></a>

  362. <a name="index-qfThreadInfo-packet"></a>

  363. <a name="index-qsThreadInfo-packet"></a>

  364. <p>Obtain a list of all active thread IDs from the target (OS).  Since there

  365. may be too many active threads to fit into one reply packet, this query

  366. works iteratively: it may require more than one query/reply sequence to

  367. obtain the entire list of threads.  The first query of the sequence will

  368. be the &lsquo;<samp>qfThreadInfo</samp>&rsquo; query; subsequent queries in the

  369. sequence will be the &lsquo;<samp>qsThreadInfo</samp>&rsquo; query.

  370. </p>

  371. <p>NOTE: This packet replaces the &lsquo;<samp>qL</samp>&rsquo; query (see below).

  372. </p>

  373. <p>Reply:

  374. </p><dl compact="compact">

  375. <dt>&lsquo;<samp>m <var>thread-id</var></samp>&rsquo;</dt>

  376. <dd><p>A single thread ID

  377. </p></dd>

  378. <dt>&lsquo;<samp>m <var>thread-id</var>,<var>thread-id</var>&hellip;</samp>&rsquo;</dt>

  379. <dd><p>a comma-separated list of thread IDs

  380. </p></dd>

  381. <dt>&lsquo;<samp>l</samp>&rsquo;</dt>

  382. <dd><p>(lower case letter &lsquo;<samp>L</samp>&rsquo;) denotes end of list.

  383. </p></dd>

  384. </dl>

  385. 

  386. <p>In response to each query, the target will reply with a list of one or

  387. more thread IDs, separated by commas.

  388. <small>GDB</small> will respond to each reply with a request for more thread

  389. ids (using the &lsquo;<samp>qs</samp>&rsquo; form of the query), until the target responds

  390. with &lsquo;<samp>l</samp>&rsquo; (lower-case ell, for <em>last</em>).

  391. Refer to <a href="Packets.html#thread_002did-syntax">thread-id syntax</a>, for the format of the <var>thread-id</var>

  392. fields.

  393. </p>

  394. <p><em>Note: <small>GDB</small> will send the <code>qfThreadInfo</code> query during the

  395. initial connection with the remote target, and the very first thread ID

  396. mentioned in the reply will be stopped by <small>GDB</small> in a subsequent

  397. message.  Therefore, the stub should ensure that the first thread ID in

  398. the <code>qfThreadInfo</code> reply is suitable for being stopped by <small>GDB</small>.</em>

  399. </p>

  400. </dd>

  401. <dt>&lsquo;<samp>qGetTLSAddr:<var>thread-id</var>,<var>offset</var>,<var>lm</var></samp>&rsquo;</dt>

  402. <dd><a name="index-get-thread_002dlocal-storage-address_002c-remote-request"></a>

  403. <a name="index-qGetTLSAddr-packet"></a>

  404. <p>Fetch the address associated with thread local storage specified

  405. by <var>thread-id</var>, <var>offset</var>, and <var>lm</var>.

  406. </p>

  407. <p><var>thread-id</var> is the thread ID associated with the

  408. thread for which to fetch the TLS address.  See <a href="Packets.html#thread_002did-syntax">thread-id syntax</a>.

  409. </p>

  410. <p><var>offset</var> is the (big endian, hex encoded) offset associated with the

  411. thread local variable.  (This offset is obtained from the debug

  412. information associated with the variable.)

  413. </p>

  414. <p><var>lm</var> is the (big endian, hex encoded) OS/ABI-specific encoding of the

  415. load module associated with the thread local storage.  For example,

  416. a <small>GNU</small>/Linux system will pass the link map address of the shared

  417. object associated with the thread local storage under consideration. 

  418. Other operating environments may choose to represent the load module

  419. differently, so the precise meaning of this parameter will vary.

  420. </p>

  421. <p>Reply:

  422. </p><dl compact="compact">

  423. <dt>&lsquo;<samp><var>XX</var>&hellip;</samp>&rsquo;</dt>

  424. <dd><p>Hex encoded (big endian) bytes representing the address of the thread

  425. local storage requested.

  426. </p>

  427. </dd>

  428. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  429. <dd><p>An error occurred.  The error number <var>nn</var> is given as hex digits.

  430. </p>

  431. </dd>

  432. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  433. <dd><p>An empty reply indicates that &lsquo;<samp>qGetTLSAddr</samp>&rsquo; is not supported by the stub.

  434. </p></dd>

  435. </dl>

  436. 

  437. </dd>

  438. <dt>&lsquo;<samp>qGetTIBAddr:<var>thread-id</var></samp>&rsquo;</dt>

  439. <dd><a name="index-get-thread-information-block-address"></a>

  440. <a name="index-qGetTIBAddr-packet"></a>

  441. <p>Fetch address of the Windows OS specific Thread Information Block.

  442. </p>

  443. <p><var>thread-id</var> is the thread ID associated with the thread.

  444. </p>

  445. <p>Reply:

  446. </p><dl compact="compact">

  447. <dt>&lsquo;<samp><var>XX</var>&hellip;</samp>&rsquo;</dt>

  448. <dd><p>Hex encoded (big endian) bytes representing the linear address of the

  449. thread information block.

  450. </p>

  451. </dd>

  452. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  453. <dd><p>An error occured.  This means that either the thread was not found, or the

  454. address could not be retrieved.

  455. </p>

  456. </dd>

  457. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  458. <dd><p>An empty reply indicates that &lsquo;<samp>qGetTIBAddr</samp>&rsquo; is not supported by the stub.

  459. </p></dd>

  460. </dl>

  461. 

  462. </dd>

  463. <dt>&lsquo;<samp>qL <var>startflag</var> <var>threadcount</var> <var>nextthread</var></samp>&rsquo;</dt>

  464. <dd><p>Obtain thread information from RTOS.  Where: <var>startflag</var> (one hex

  465. digit) is one to indicate the first query and zero to indicate a

  466. subsequent query; <var>threadcount</var> (two hex digits) is the maximum

  467. number of threads the response packet can contain; and <var>nextthread</var>

  468. (eight hex digits), for subsequent queries (<var>startflag</var> is zero), is

  469. returned in the response as <var>argthread</var>.

  470. </p>

  471. <p>Don&rsquo;t use this packet; use the &lsquo;<samp>qfThreadInfo</samp>&rsquo; query instead (see above).

  472. </p>

  473. <p>Reply:

  474. </p><dl compact="compact">

  475. <dt>&lsquo;<samp>qM <var>count</var> <var>done</var> <var>argthread</var> <var>thread</var>&hellip;</samp>&rsquo;</dt>

  476. <dd><p>Where: <var>count</var> (two hex digits) is the number of threads being

  477. returned; <var>done</var> (one hex digit) is zero to indicate more threads

  478. and one indicates no further threads; <var>argthreadid</var> (eight hex

  479. digits) is <var>nextthread</var> from the request packet; <var>thread</var>&hellip;

  480. is a sequence of thread IDs, <var>threadid</var> (eight hex

  481. digits), from the target.  See <code>remote.c:parse_threadlist_response()</code>.

  482. </p></dd>

  483. </dl>

  484. 

  485. </dd>

  486. <dt>&lsquo;<samp>qOffsets</samp>&rsquo;</dt>

  487. <dd><a name="index-section-offsets_002c-remote-request"></a>

  488. <a name="index-qOffsets-packet"></a>

  489. <p>Get section offsets that the target used when relocating the downloaded

  490. image.

  491. </p>

  492. <p>Reply:

  493. </p><dl compact="compact">

  494. <dt>&lsquo;<samp>Text=<var>xxx</var>;Data=<var>yyy</var><span class="roman">[</span>;Bss=<var>zzz</var><span class="roman">]</span></samp>&rsquo;</dt>

  495. <dd><p>Relocate the <code>Text</code> section by <var>xxx</var> from its original address.

  496. Relocate the <code>Data</code> section by <var>yyy</var> from its original address.

  497. If the object file format provides segment information (e.g. <small>ELF</small>

  498. &lsquo;<samp>PT_LOAD</samp>&rsquo; program headers), <small>GDB</small> will relocate entire

  499. segments by the supplied offsets.

  500. </p>

  501. <p><em>Note: while a <code>Bss</code> offset may be included in the response,

  502. <small>GDB</small> ignores this and instead applies the <code>Data</code> offset

  503. to the <code>Bss</code> section.</em>

  504. </p>

  505. </dd>

  506. <dt>&lsquo;<samp>TextSeg=<var>xxx</var><span class="roman">[</span>;DataSeg=<var>yyy</var><span class="roman">]</span></samp>&rsquo;</dt>

  507. <dd><p>Relocate the first segment of the object file, which conventionally

  508. contains program code, to a starting address of <var>xxx</var>.  If

  509. &lsquo;<samp>DataSeg</samp>&rsquo; is specified, relocate the second segment, which

  510. conventionally contains modifiable data, to a starting address of

  511. <var>yyy</var>.  <small>GDB</small> will report an error if the object file

  512. does not contain segment information, or does not contain at least

  513. as many segments as mentioned in the reply.  Extra segments are

  514. kept at fixed offsets relative to the last relocated segment.

  515. </p></dd>

  516. </dl>

  517. 

  518. </dd>

  519. <dt>&lsquo;<samp>qP <var>mode</var> <var>thread-id</var></samp>&rsquo;</dt>

  520. <dd><a name="index-thread-information_002c-remote-request"></a>

  521. <a name="index-qP-packet"></a>

  522. <p>Returns information on <var>thread-id</var>.  Where: <var>mode</var> is a hex

  523. encoded 32 bit mode; <var>thread-id</var> is a thread ID 

  524. (see <a href="Packets.html#thread_002did-syntax">thread-id syntax</a>).

  525. </p>

  526. <p>Don&rsquo;t use this packet; use the &lsquo;<samp>qThreadExtraInfo</samp>&rsquo; query instead

  527. (see below).

  528. </p>

  529. <p>Reply: see <code>remote.c:remote_unpack_thread_info_response()</code>.

  530. </p>

  531. </dd>

  532. <dt>&lsquo;<samp>QNonStop:1</samp>&rsquo;</dt>

  533. <dt>&lsquo;<samp>QNonStop:0</samp>&rsquo;</dt>

  534. <dd><a name="index-non_002dstop-mode_002c-remote-request"></a>

  535. <a name="index-QNonStop-packet"></a>

  536. <a name="QNonStop"></a><p>Enter non-stop (&lsquo;<samp>QNonStop:1</samp>&rsquo;) or all-stop (&lsquo;<samp>QNonStop:0</samp>&rsquo;) mode.

  537. See <a href="Remote-Non_002dStop.html#Remote-Non_002dStop">Remote Non-Stop</a>, for more information.

  538. </p>

  539. <p>Reply:

  540. </p><dl compact="compact">

  541. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  542. <dd><p>The request succeeded.

  543. </p>

  544. </dd>

  545. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  546. <dd><p>An error occurred.  The error number <var>nn</var> is given as hex digits.

  547. </p>

  548. </dd>

  549. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  550. <dd><p>An empty reply indicates that &lsquo;<samp>QNonStop</samp>&rsquo; is not supported by

  551. the stub.

  552. </p></dd>

  553. </dl>

  554. 

  555. <p>This packet is not probed by default; the remote stub must request it,

  556. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  557. Use of this packet is controlled by the <code>set non-stop</code> command; 

  558. see <a href="Non_002dStop-Mode.html#Non_002dStop-Mode">Non-Stop Mode</a>.

  559. </p>

  560. </dd>

  561. <dt>&lsquo;<samp>QCatchSyscalls:1 <span class="roman">[</span>;<var>sysno</var><span class="roman">]</span>&hellip;</samp>&rsquo;</dt>

  562. <dt>&lsquo;<samp>QCatchSyscalls:0</samp>&rsquo;</dt>

  563. <dd><a name="index-catch-syscalls-from-inferior_002c-remote-request"></a>

  564. <a name="index-QCatchSyscalls-packet"></a>

  565. <a name="QCatchSyscalls"></a><p>Enable (&lsquo;<samp>QCatchSyscalls:1</samp>&rsquo;) or disable (&lsquo;<samp>QCatchSyscalls:0</samp>&rsquo;)

  566. catching syscalls from the inferior process.

  567. </p>

  568. <p>For &lsquo;<samp>QCatchSyscalls:1</samp>&rsquo;, each listed syscall <var>sysno</var> (encoded

  569. in hex) should be reported to <small>GDB</small>.  If no syscall <var>sysno</var>

  570. is listed, every system call should be reported.

  571. </p>

  572. <p>Note that if a syscall not in the list is reported, <small>GDB</small> will

  573. still filter the event according to its own list from all corresponding

  574. <code>catch syscall</code> commands.  However, it is more efficient to only

  575. report the requested syscalls.

  576. </p>

  577. <p>Multiple &lsquo;<samp>QCatchSyscalls:1</samp>&rsquo; packets do not combine; any earlier

  578. &lsquo;<samp>QCatchSyscalls:1</samp>&rsquo; list is completely replaced by the new list.

  579. </p>

  580. <p>If the inferior process execs, the state of &lsquo;<samp>QCatchSyscalls</samp>&rsquo; is

  581. kept for the new process too.  On targets where exec may affect syscall

  582. numbers, for example with exec between 32 and 64-bit processes, the

  583. client should send a new packet with the new syscall list.

  584. </p>

  585. <p>Reply:

  586. </p><dl compact="compact">

  587. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  588. <dd><p>The request succeeded.

  589. </p>

  590. </dd>

  591. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  592. <dd><p>An error occurred.  <var>nn</var> are hex digits.

  593. </p>

  594. </dd>

  595. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  596. <dd><p>An empty reply indicates that &lsquo;<samp>QCatchSyscalls</samp>&rsquo; is not supported by

  597. the stub.

  598. </p></dd>

  599. </dl>

  600. 

  601. <p>Use of this packet is controlled by the <code>set remote catch-syscalls</code>

  602. command (see <a href="Remote-Configuration.html#Remote-Configuration">set remote catch-syscalls</a>).

  603. This packet is not probed by default; the remote stub must request it,

  604. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  605. </p>

  606. </dd>

  607. <dt>&lsquo;<samp>QPassSignals: <var>signal</var> <span class="roman">[</span>;<var>signal</var><span class="roman">]</span>&hellip;</samp>&rsquo;</dt>

  608. <dd><a name="index-pass-signals-to-inferior_002c-remote-request"></a>

  609. <a name="index-QPassSignals-packet"></a>

  610. <a name="QPassSignals"></a><p>Each listed <var>signal</var> should be passed directly to the inferior process. 

  611. Signals are numbered identically to continue packets and stop replies

  612. (see <a href="Stop-Reply-Packets.html#Stop-Reply-Packets">Stop Reply Packets</a>).  Each <var>signal</var> list item should be

  613. strictly greater than the previous item.  These signals do not need to stop

  614. the inferior, or be reported to <small>GDB</small>.  All other signals should be

  615. reported to <small>GDB</small>.  Multiple &lsquo;<samp>QPassSignals</samp>&rsquo; packets do not

  616. combine; any earlier &lsquo;<samp>QPassSignals</samp>&rsquo; list is completely replaced by the

  617. new list.  This packet improves performance when using &lsquo;<samp>handle

  618. <var>signal</var> nostop noprint pass</samp>&rsquo;.

  619. </p>

  620. <p>Reply:

  621. </p><dl compact="compact">

  622. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  623. <dd><p>The request succeeded.

  624. </p>

  625. </dd>

  626. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  627. <dd><p>An error occurred.  The error number <var>nn</var> is given as hex digits.

  628. </p>

  629. </dd>

  630. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  631. <dd><p>An empty reply indicates that &lsquo;<samp>QPassSignals</samp>&rsquo; is not supported by

  632. the stub.

  633. </p></dd>

  634. </dl>

  635. 

  636. <p>Use of this packet is controlled by the <code>set remote pass-signals</code>

  637. command (see <a href="Remote-Configuration.html#Remote-Configuration">set remote pass-signals</a>).

  638. This packet is not probed by default; the remote stub must request it,

  639. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  640. </p>

  641. </dd>

  642. <dt>&lsquo;<samp>QProgramSignals: <var>signal</var> <span class="roman">[</span>;<var>signal</var><span class="roman">]</span>&hellip;</samp>&rsquo;</dt>

  643. <dd><a name="index-signals-the-inferior-may-see_002c-remote-request"></a>

  644. <a name="index-QProgramSignals-packet"></a>

  645. <a name="QProgramSignals"></a><p>Each listed <var>signal</var> may be delivered to the inferior process.

  646. Others should be silently discarded.

  647. </p>

  648. <p>In some cases, the remote stub may need to decide whether to deliver a

  649. signal to the program or not without <small>GDB</small> involvement.  One

  650. example of that is while detaching &mdash; the program&rsquo;s threads may have

  651. stopped for signals that haven&rsquo;t yet had a chance of being reported to

  652. <small>GDB</small>, and so the remote stub can use the signal list specified

  653. by this packet to know whether to deliver or ignore those pending

  654. signals.

  655. </p>

  656. <p>This does not influence whether to deliver a signal as requested by a

  657. resumption packet (see <a href="Packets.html#vCont-packet">vCont packet</a>).

  658. </p>

  659. <p>Signals are numbered identically to continue packets and stop replies

  660. (see <a href="Stop-Reply-Packets.html#Stop-Reply-Packets">Stop Reply Packets</a>).  Each <var>signal</var> list item should be

  661. strictly greater than the previous item.  Multiple

  662. &lsquo;<samp>QProgramSignals</samp>&rsquo; packets do not combine; any earlier

  663. &lsquo;<samp>QProgramSignals</samp>&rsquo; list is completely replaced by the new list.

  664. </p>

  665. <p>Reply:

  666. </p><dl compact="compact">

  667. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  668. <dd><p>The request succeeded.

  669. </p>

  670. </dd>

  671. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  672. <dd><p>An error occurred.  The error number <var>nn</var> is given as hex digits.

  673. </p>

  674. </dd>

  675. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  676. <dd><p>An empty reply indicates that &lsquo;<samp>QProgramSignals</samp>&rsquo; is not supported

  677. by the stub.

  678. </p></dd>

  679. </dl>

  680. 

  681. <p>Use of this packet is controlled by the <code>set remote program-signals</code>

  682. command (see <a href="Remote-Configuration.html#Remote-Configuration">set remote program-signals</a>).

  683. This packet is not probed by default; the remote stub must request it,

  684. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  685. </p>

  686. <a name="QThreadEvents"></a></dd>

  687. <dt>&lsquo;<samp>QThreadEvents:1</samp>&rsquo;</dt>

  688. <dt>&lsquo;<samp>QThreadEvents:0</samp>&rsquo;</dt>

  689. <dd><a name="index-thread-create_002fexit-events_002c-remote-request"></a>

  690. <a name="index-QThreadEvents-packet"></a>

  691. 

  692. <p>Enable (&lsquo;<samp>QThreadEvents:1</samp>&rsquo;) or disable (&lsquo;<samp>QThreadEvents:0</samp>&rsquo;)

  693. reporting of thread create and exit events.  See <a href="Stop-Reply-Packets.html#thread-create-event">thread create event</a>, for the reply specifications.  For example, this is used in

  694. non-stop mode when <small>GDB</small> stops a set of threads and

  695. synchronously waits for the their corresponding stop replies.  Without

  696. exit events, if one of the threads exits, <small>GDB</small> would hang

  697. forever not knowing that it should no longer expect a stop for that

  698. same thread.  <small>GDB</small> does not enable this feature unless the

  699. stub reports that it supports it by including &lsquo;<samp>QThreadEvents+</samp>&rsquo; in

  700. its &lsquo;<samp>qSupported</samp>&rsquo; reply.

  701. </p>

  702. <p>Reply:

  703. </p><dl compact="compact">

  704. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  705. <dd><p>The request succeeded.

  706. </p>

  707. </dd>

  708. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  709. <dd><p>An error occurred.  The error number <var>nn</var> is given as hex digits.

  710. </p>

  711. </dd>

  712. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  713. <dd><p>An empty reply indicates that &lsquo;<samp>QThreadEvents</samp>&rsquo; is not supported by

  714. the stub.

  715. </p></dd>

  716. </dl>

  717. 

  718. <p>Use of this packet is controlled by the <code>set remote thread-events</code>

  719. command (see <a href="Remote-Configuration.html#Remote-Configuration">set remote thread-events</a>).

  720. </p>

  721. </dd>

  722. <dt>&lsquo;<samp>qRcmd,<var>command</var></samp>&rsquo;</dt>

  723. <dd><a name="index-execute-remote-command_002c-remote-request"></a>

  724. <a name="index-qRcmd-packet"></a>

  725. <p><var>command</var> (hex encoded) is passed to the local interpreter for

  726. execution.  Invalid commands should be reported using the output

  727. string.  Before the final result packet, the target may also respond

  728. with a number of intermediate &lsquo;<samp>O<var>output</var></samp>&rsquo; console output

  729. packets.  <em>Implementors should note that providing access to a

  730. stubs&rsquo;s interpreter may have security implications</em>.

  731. </p>

  732. <p>Reply:

  733. </p><dl compact="compact">

  734. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  735. <dd><p>A command response with no output.

  736. </p></dd>

  737. <dt>&lsquo;<samp><var>OUTPUT</var></samp>&rsquo;</dt>

  738. <dd><p>A command response with the hex encoded output string <var>OUTPUT</var>.

  739. </p></dd>

  740. <dt>&lsquo;<samp>E <var>NN</var></samp>&rsquo;</dt>

  741. <dd><p>Indicate a badly formed request.

  742. </p></dd>

  743. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  744. <dd><p>An empty reply indicates that &lsquo;<samp>qRcmd</samp>&rsquo; is not recognized.

  745. </p></dd>

  746. </dl>

  747. 

  748. <p>(Note that the <code>qRcmd</code> packet&rsquo;s name is separated from the

  749. command by a &lsquo;<samp>,</samp>&rsquo;, not a &lsquo;<samp>:</samp>&rsquo;, contrary to the naming

  750. conventions above.  Please don&rsquo;t use this packet as a model for new

  751. packets.)

  752. </p>

  753. </dd>

  754. <dt>&lsquo;<samp>qSearch:memory:<var>address</var>;<var>length</var>;<var>search-pattern</var></samp>&rsquo;</dt>

  755. <dd><a name="index-searching-memory_002c-in-remote-debugging"></a>

  756. <a name="index-qSearch_003amemory-packet"></a>

  757. <a name="index-qSearch-memory-packet"></a>

  758. <a name="qSearch-memory"></a><p>Search <var>length</var> bytes at <var>address</var> for <var>search-pattern</var>.

  759. Both <var>address</var> and <var>length</var> are encoded in hex;

  760. <var>search-pattern</var> is a sequence of bytes, also hex encoded.

  761. </p>

  762. <p>Reply:

  763. </p><dl compact="compact">

  764. <dt>&lsquo;<samp>0</samp>&rsquo;</dt>

  765. <dd><p>The pattern was not found.

  766. </p></dd>

  767. <dt>&lsquo;<samp>1,address</samp>&rsquo;</dt>

  768. <dd><p>The pattern was found at <var>address</var>.

  769. </p></dd>

  770. <dt>&lsquo;<samp>E <var>NN</var></samp>&rsquo;</dt>

  771. <dd><p>A badly formed request or an error was encountered while searching memory.

  772. </p></dd>

  773. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  774. <dd><p>An empty reply indicates that &lsquo;<samp>qSearch:memory</samp>&rsquo; is not recognized.

  775. </p></dd>

  776. </dl>

  777. 

  778. </dd>

  779. <dt>&lsquo;<samp>QStartNoAckMode</samp>&rsquo;</dt>

  780. <dd><a name="index-QStartNoAckMode-packet"></a>

  781. <a name="QStartNoAckMode"></a><p>Request that the remote stub disable the normal &lsquo;<samp>+</samp>&rsquo;/&lsquo;<samp>-</samp>&rsquo;

  782. protocol acknowledgments (see <a href="Packet-Acknowledgment.html#Packet-Acknowledgment">Packet Acknowledgment</a>).

  783. </p>

  784. <p>Reply:

  785. </p><dl compact="compact">

  786. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  787. <dd><p>The stub has switched to no-acknowledgment mode.

  788. <small>GDB</small> acknowledges this response,

  789. but neither the stub nor <small>GDB</small> shall send or expect further

  790. &lsquo;<samp>+</samp>&rsquo;/&lsquo;<samp>-</samp>&rsquo; acknowledgments in the current connection.

  791. </p></dd>

  792. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  793. <dd><p>An empty reply indicates that the stub does not support no-acknowledgment mode.

  794. </p></dd>

  795. </dl>

  796. 

  797. </dd>

  798. <dt>&lsquo;<samp>qSupported <span class="roman">[</span>:<var>gdbfeature</var> <span class="roman">[</span>;<var>gdbfeature</var><span class="roman">]</span>&hellip; <span class="roman">]</span></samp>&rsquo;</dt>

  799. <dd><a name="index-supported-packets_002c-remote-query"></a>

  800. <a name="index-features-of-the-remote-protocol"></a>

  801. <a name="index-qSupported-packet"></a>

  802. <a name="qSupported"></a><p>Tell the remote stub about features supported by <small>GDB</small>, and

  803. query the stub for features it supports.  This packet allows

  804. <small>GDB</small> and the remote stub to take advantage of each others&rsquo;

  805. features.  &lsquo;<samp>qSupported</samp>&rsquo; also consolidates multiple feature probes

  806. at startup, to improve <small>GDB</small> performance&mdash;a single larger

  807. packet performs better than multiple smaller probe packets on

  808. high-latency links.  Some features may enable behavior which must not

  809. be on by default, e.g. because it would confuse older clients or

  810. stubs.  Other features may describe packets which could be

  811. automatically probed for, but are not.  These features must be

  812. reported before <small>GDB</small> will use them.  This &ldquo;default

  813. unsupported&rdquo; behavior is not appropriate for all packets, but it

  814. helps to keep the initial connection time under control with new

  815. versions of <small>GDB</small> which support increasing numbers of packets.

  816. </p>

  817. <p>Reply:

  818. </p><dl compact="compact">

  819. <dt>&lsquo;<samp><var>stubfeature</var> <span class="roman">[</span>;<var>stubfeature</var><span class="roman">]</span>&hellip;</samp>&rsquo;</dt>

  820. <dd><p>The stub supports or does not support each returned <var>stubfeature</var>,

  821. depending on the form of each <var>stubfeature</var> (see below for the

  822. possible forms).

  823. </p></dd>

  824. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  825. <dd><p>An empty reply indicates that &lsquo;<samp>qSupported</samp>&rsquo; is not recognized,

  826. or that no features needed to be reported to <small>GDB</small>.

  827. </p></dd>

  828. </dl>

  829. 

  830. <p>The allowed forms for each feature (either a <var>gdbfeature</var> in the

  831. &lsquo;<samp>qSupported</samp>&rsquo; packet, or a <var>stubfeature</var> in the response)

  832. are:

  833. </p>

  834. <dl compact="compact">

  835. <dt>&lsquo;<samp><var>name</var>=<var>value</var></samp>&rsquo;</dt>

  836. <dd><p>The remote protocol feature <var>name</var> is supported, and associated

  837. with the specified <var>value</var>.  The format of <var>value</var> depends

  838. on the feature, but it must not include a semicolon.

  839. </p></dd>

  840. <dt>&lsquo;<samp><var>name</var>+</samp>&rsquo;</dt>

  841. <dd><p>The remote protocol feature <var>name</var> is supported, and does not

  842. need an associated value.

  843. </p></dd>

  844. <dt>&lsquo;<samp><var>name</var>-</samp>&rsquo;</dt>

  845. <dd><p>The remote protocol feature <var>name</var> is not supported.

  846. </p></dd>

  847. <dt>&lsquo;<samp><var>name</var>?</samp>&rsquo;</dt>

  848. <dd><p>The remote protocol feature <var>name</var> may be supported, and

  849. <small>GDB</small> should auto-detect support in some other way when it is

  850. needed.  This form will not be used for <var>gdbfeature</var> notifications,

  851. but may be used for <var>stubfeature</var> responses.

  852. </p></dd>

  853. </dl>

  854. 

  855. <p>Whenever the stub receives a &lsquo;<samp>qSupported</samp>&rsquo; request, the

  856. supplied set of <small>GDB</small> features should override any previous

  857. request.  This allows <small>GDB</small> to put the stub in a known

  858. state, even if the stub had previously been communicating with

  859. a different version of <small>GDB</small>.

  860. </p>

  861. <p>The following values of <var>gdbfeature</var> (for the packet sent by <small>GDB</small>)

  862. are defined:  

  863. </p>

  864. <dl compact="compact">

  865. <dt>&lsquo;<samp>multiprocess</samp>&rsquo;</dt>

  866. <dd><p>This feature indicates whether <small>GDB</small> supports multiprocess 

  867. extensions to the remote protocol.  <small>GDB</small> does not use such

  868. extensions unless the stub also reports that it supports them by

  869. including &lsquo;<samp>multiprocess+</samp>&rsquo; in its &lsquo;<samp>qSupported</samp>&rsquo; reply.

  870. See <a href="#multiprocess-extensions">multiprocess extensions</a>, for details.

  871. </p>

  872. </dd>

  873. <dt>&lsquo;<samp>xmlRegisters</samp>&rsquo;</dt>

  874. <dd><p>This feature indicates that <small>GDB</small> supports the XML target

  875. description.  If the stub sees &lsquo;<samp>xmlRegisters=</samp>&rsquo; with target

  876. specific strings separated by a comma, it will report register

  877. description.

  878. </p>

  879. </dd>

  880. <dt>&lsquo;<samp>qRelocInsn</samp>&rsquo;</dt>

  881. <dd><p>This feature indicates whether <small>GDB</small> supports the

  882. &lsquo;<samp>qRelocInsn</samp>&rsquo; packet (see <a href="Tracepoint-Packets.html#Tracepoint-Packets">Relocate

  883. instruction reply packet</a>).

  884. </p>

  885. </dd>

  886. <dt>&lsquo;<samp>swbreak</samp>&rsquo;</dt>

  887. <dd><p>This feature indicates whether <small>GDB</small> supports the swbreak stop

  888. reason in stop replies.  See <a href="Stop-Reply-Packets.html#swbreak-stop-reason">swbreak stop reason</a>, for details.

  889. </p>

  890. </dd>

  891. <dt>&lsquo;<samp>hwbreak</samp>&rsquo;</dt>

  892. <dd><p>This feature indicates whether <small>GDB</small> supports the hwbreak stop

  893. reason in stop replies.  See <a href="Stop-Reply-Packets.html#swbreak-stop-reason">swbreak stop reason</a>, for details.

  894. </p>

  895. </dd>

  896. <dt>&lsquo;<samp>fork-events</samp>&rsquo;</dt>

  897. <dd><p>This feature indicates whether <small>GDB</small> supports fork event

  898. extensions to the remote protocol.  <small>GDB</small> does not use such

  899. extensions unless the stub also reports that it supports them by

  900. including &lsquo;<samp>fork-events+</samp>&rsquo; in its &lsquo;<samp>qSupported</samp>&rsquo; reply.

  901. </p>

  902. </dd>

  903. <dt>&lsquo;<samp>vfork-events</samp>&rsquo;</dt>

  904. <dd><p>This feature indicates whether <small>GDB</small> supports vfork event

  905. extensions to the remote protocol.  <small>GDB</small> does not use such

  906. extensions unless the stub also reports that it supports them by

  907. including &lsquo;<samp>vfork-events+</samp>&rsquo; in its &lsquo;<samp>qSupported</samp>&rsquo; reply.

  908. </p>

  909. </dd>

  910. <dt>&lsquo;<samp>exec-events</samp>&rsquo;</dt>

  911. <dd><p>This feature indicates whether <small>GDB</small> supports exec event

  912. extensions to the remote protocol.  <small>GDB</small> does not use such

  913. extensions unless the stub also reports that it supports them by

  914. including &lsquo;<samp>exec-events+</samp>&rsquo; in its &lsquo;<samp>qSupported</samp>&rsquo; reply.

  915. </p>

  916. </dd>

  917. <dt>&lsquo;<samp>vContSupported</samp>&rsquo;</dt>

  918. <dd><p>This feature indicates whether <small>GDB</small> wants to know the

  919. supported actions in the reply to &lsquo;<samp>vCont?</samp>&rsquo; packet.

  920. </p></dd>

  921. </dl>

  922. 

  923. <p>Stubs should ignore any unknown values for

  924. <var>gdbfeature</var>.  Any <small>GDB</small> which sends a &lsquo;<samp>qSupported</samp>&rsquo;

  925. packet supports receiving packets of unlimited length (earlier

  926. versions of <small>GDB</small> may reject overly long responses).  Additional values

  927. for <var>gdbfeature</var> may be defined in the future to let the stub take

  928. advantage of new features in <small>GDB</small>, e.g. incompatible

  929. improvements in the remote protocol&mdash;the &lsquo;<samp>multiprocess</samp>&rsquo; feature is

  930. an example of such a feature.  The stub&rsquo;s reply should be independent

  931. of the <var>gdbfeature</var> entries sent by <small>GDB</small>; first <small>GDB</small>

  932. describes all the features it supports, and then the stub replies with

  933. all the features it supports.

  934. </p>

  935. <p>Similarly, <small>GDB</small> will silently ignore unrecognized stub feature

  936. responses, as long as each response uses one of the standard forms.

  937. </p>

  938. <p>Some features are flags.  A stub which supports a flag feature

  939. should respond with a &lsquo;<samp>+</samp>&rsquo; form response.  Other features

  940. require values, and the stub should respond with an &lsquo;<samp>=</samp>&rsquo;

  941. form response.

  942. </p>

  943. <p>Each feature has a default value, which <small>GDB</small> will use if

  944. &lsquo;<samp>qSupported</samp>&rsquo; is not available or if the feature is not mentioned

  945. in the &lsquo;<samp>qSupported</samp>&rsquo; response.  The default values are fixed; a

  946. stub is free to omit any feature responses that match the defaults.

  947. </p>

  948. <p>Not all features can be probed, but for those which can, the probing

  949. mechanism is useful: in some cases, a stub&rsquo;s internal

  950. architecture may not allow the protocol layer to know some information

  951. about the underlying target in advance.  This is especially common in

  952. stubs which may be configured for multiple targets.

  953. </p>

  954. <p>These are the currently defined stub features and their properties:

  955. </p>

  956. <table>

  957. <tr><td width="35%">Feature Name</td><td width="20%">Value Required</td><td width="12%">Default</td><td width="20%">Probe Allowed</td></tr>

  958. <tr><td width="35%">&lsquo;<samp>PacketSize</samp>&rsquo;</td><td width="20%">Yes</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  959. <tr><td width="35%">&lsquo;<samp>qXfer:auxv:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  960. <tr><td width="35%">&lsquo;<samp>qXfer:btrace:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  961. <tr><td width="35%">&lsquo;<samp>qXfer:btrace-conf:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  962. <tr><td width="35%">&lsquo;<samp>qXfer:exec-file:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  963. <tr><td width="35%">&lsquo;<samp>qXfer:features:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  964. <tr><td width="35%">&lsquo;<samp>qXfer:libraries:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  965. <tr><td width="35%">&lsquo;<samp>qXfer:libraries-svr4:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  966. <tr><td width="35%">&lsquo;<samp>augmented-libraries-svr4-read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  967. <tr><td width="35%">&lsquo;<samp>qXfer:memory-map:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  968. <tr><td width="35%">&lsquo;<samp>qXfer:sdata:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  969. <tr><td width="35%">&lsquo;<samp>qXfer:siginfo:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  970. <tr><td width="35%">&lsquo;<samp>qXfer:siginfo:write</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  971. <tr><td width="35%">&lsquo;<samp>qXfer:threads:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  972. <tr><td width="35%">&lsquo;<samp>qXfer:traceframe-info:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  973. <tr><td width="35%">&lsquo;<samp>qXfer:uib:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  974. <tr><td width="35%">&lsquo;<samp>qXfer:fdpic:read</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  975. <tr><td width="35%">&lsquo;<samp>Qbtrace:off</samp>&rsquo;</td><td width="20%">Yes</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  976. <tr><td width="35%">&lsquo;<samp>Qbtrace:bts</samp>&rsquo;</td><td width="20%">Yes</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  977. <tr><td width="35%">&lsquo;<samp>Qbtrace:pt</samp>&rsquo;</td><td width="20%">Yes</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  978. <tr><td width="35%">&lsquo;<samp>Qbtrace-conf:bts:size</samp>&rsquo;</td><td width="20%">Yes</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  979. <tr><td width="35%">&lsquo;<samp>Qbtrace-conf:pt:size</samp>&rsquo;</td><td width="20%">Yes</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  980. <tr><td width="35%">&lsquo;<samp>QNonStop</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  981. <tr><td width="35%">&lsquo;<samp>QCatchSyscalls</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  982. <tr><td width="35%">&lsquo;<samp>QPassSignals</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  983. <tr><td width="35%">&lsquo;<samp>QStartNoAckMode</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">Yes</td></tr>

  984. <tr><td width="35%">&lsquo;<samp>multiprocess</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  985. <tr><td width="35%">&lsquo;<samp>ConditionalBreakpoints</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  986. <tr><td width="35%">&lsquo;<samp>ConditionalTracepoints</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  987. <tr><td width="35%">&lsquo;<samp>ReverseContinue</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  988. <tr><td width="35%">&lsquo;<samp>ReverseStep</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  989. <tr><td width="35%">&lsquo;<samp>TracepointSource</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  990. <tr><td width="35%">&lsquo;<samp>QAgent</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  991. <tr><td width="35%">&lsquo;<samp>QAllow</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  992. <tr><td width="35%">&lsquo;<samp>QDisableRandomization</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  993. <tr><td width="35%">&lsquo;<samp>EnableDisableTracepoints</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  994. <tr><td width="35%">&lsquo;<samp>QTBuffer:size</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  995. <tr><td width="35%">&lsquo;<samp>tracenz</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  996. <tr><td width="35%">&lsquo;<samp>BreakpointCommands</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  997. <tr><td width="35%">&lsquo;<samp>swbreak</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  998. <tr><td width="35%">&lsquo;<samp>hwbreak</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  999. <tr><td width="35%">&lsquo;<samp>fork-events</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  1000. <tr><td width="35%">&lsquo;<samp>vfork-events</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  1001. <tr><td width="35%">&lsquo;<samp>exec-events</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  1002. <tr><td width="35%">&lsquo;<samp>QThreadEvents</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  1003. <tr><td width="35%">&lsquo;<samp>no-resumed</samp>&rsquo;</td><td width="20%">No</td><td width="12%">&lsquo;<samp>-</samp>&rsquo;</td><td width="20%">No</td></tr>

  1004. </table>

  1005. 

  1006. <p>These are the currently defined stub features, in more detail:

  1007. </p>

  1008. <dl compact="compact">

  1009. <dd><a name="index-packet-size_002c-remote-protocol"></a>

  1010. </dd>

  1011. <dt>&lsquo;<samp>PacketSize=<var>bytes</var></samp>&rsquo;</dt>

  1012. <dd><p>The remote stub can accept packets up to at least <var>bytes</var> in

  1013. length.  <small>GDB</small> will send packets up to this size for bulk

  1014. transfers, and will never send larger packets.  This is a limit on the

  1015. data characters in the packet, including the frame and checksum.

  1016. There is no trailing NUL byte in a remote protocol packet; if the stub

  1017. stores packets in a NUL-terminated format, it should allow an extra

  1018. byte in its buffer for the NUL.  If this stub feature is not supported,

  1019. <small>GDB</small> guesses based on the size of the &lsquo;<samp>g</samp>&rsquo; packet response.

  1020. </p>

  1021. </dd>

  1022. <dt>&lsquo;<samp>qXfer:auxv:read</samp>&rsquo;</dt>

  1023. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:auxv:read</samp>&rsquo; packet

  1024. (see <a href="#qXfer-auxiliary-vector-read">qXfer auxiliary vector read</a>).

  1025. </p>

  1026. </dd>

  1027. <dt>&lsquo;<samp>qXfer:btrace:read</samp>&rsquo;</dt>

  1028. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:btrace:read</samp>&rsquo;

  1029. packet (see <a href="#qXfer-btrace-read">qXfer btrace read</a>).

  1030. </p>

  1031. </dd>

  1032. <dt>&lsquo;<samp>qXfer:btrace-conf:read</samp>&rsquo;</dt>

  1033. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:btrace-conf:read</samp>&rsquo;

  1034. packet (see <a href="#qXfer-btrace_002dconf-read">qXfer btrace-conf read</a>).

  1035. </p>

  1036. </dd>

  1037. <dt>&lsquo;<samp>qXfer:exec-file:read</samp>&rsquo;</dt>

  1038. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:exec-file:read</samp>&rsquo; packet

  1039. (see <a href="#qXfer-executable-filename-read">qXfer executable filename read</a>).

  1040. </p>

  1041. </dd>

  1042. <dt>&lsquo;<samp>qXfer:features:read</samp>&rsquo;</dt>

  1043. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:features:read</samp>&rsquo; packet

  1044. (see <a href="#qXfer-target-description-read">qXfer target description read</a>).

  1045. </p>

  1046. </dd>

  1047. <dt>&lsquo;<samp>qXfer:libraries:read</samp>&rsquo;</dt>

  1048. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:libraries:read</samp>&rsquo; packet

  1049. (see <a href="#qXfer-library-list-read">qXfer library list read</a>).

  1050. </p>

  1051. </dd>

  1052. <dt>&lsquo;<samp>qXfer:libraries-svr4:read</samp>&rsquo;</dt>

  1053. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:libraries-svr4:read</samp>&rsquo; packet

  1054. (see <a href="#qXfer-svr4-library-list-read">qXfer svr4 library list read</a>).

  1055. </p>

  1056. </dd>

  1057. <dt>&lsquo;<samp>augmented-libraries-svr4-read</samp>&rsquo;</dt>

  1058. <dd><p>The remote stub understands the augmented form of the

  1059. &lsquo;<samp>qXfer:libraries-svr4:read</samp>&rsquo; packet

  1060. (see <a href="#qXfer-svr4-library-list-read">qXfer svr4 library list read</a>).

  1061. </p>

  1062. </dd>

  1063. <dt>&lsquo;<samp>qXfer:memory-map:read</samp>&rsquo;</dt>

  1064. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:memory-map:read</samp>&rsquo; packet

  1065. (see <a href="#qXfer-memory-map-read">qXfer memory map read</a>).

  1066. </p>

  1067. </dd>

  1068. <dt>&lsquo;<samp>qXfer:sdata:read</samp>&rsquo;</dt>

  1069. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:sdata:read</samp>&rsquo; packet

  1070. (see <a href="#qXfer-sdata-read">qXfer sdata read</a>).

  1071. </p>

  1072. </dd>

  1073. <dt>&lsquo;<samp>qXfer:siginfo:read</samp>&rsquo;</dt>

  1074. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:siginfo:read</samp>&rsquo; packet

  1075. (see <a href="#qXfer-siginfo-read">qXfer siginfo read</a>).

  1076. </p>

  1077. </dd>

  1078. <dt>&lsquo;<samp>qXfer:siginfo:write</samp>&rsquo;</dt>

  1079. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:siginfo:write</samp>&rsquo; packet

  1080. (see <a href="#qXfer-siginfo-write">qXfer siginfo write</a>).

  1081. </p>

  1082. </dd>

  1083. <dt>&lsquo;<samp>qXfer:threads:read</samp>&rsquo;</dt>

  1084. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:threads:read</samp>&rsquo; packet

  1085. (see <a href="#qXfer-threads-read">qXfer threads read</a>).

  1086. </p>

  1087. </dd>

  1088. <dt>&lsquo;<samp>qXfer:traceframe-info:read</samp>&rsquo;</dt>

  1089. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:traceframe-info:read</samp>&rsquo;

  1090. packet (see <a href="#qXfer-traceframe-info-read">qXfer traceframe info read</a>).

  1091. </p>

  1092. </dd>

  1093. <dt>&lsquo;<samp>qXfer:uib:read</samp>&rsquo;</dt>

  1094. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:uib:read</samp>&rsquo;

  1095. packet (see <a href="#qXfer-unwind-info-block">qXfer unwind info block</a>).

  1096. </p>

  1097. </dd>

  1098. <dt>&lsquo;<samp>qXfer:fdpic:read</samp>&rsquo;</dt>

  1099. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:fdpic:read</samp>&rsquo;

  1100. packet (see <a href="#qXfer-fdpic-loadmap-read">qXfer fdpic loadmap read</a>).

  1101. </p>

  1102. </dd>

  1103. <dt>&lsquo;<samp>QNonStop</samp>&rsquo;</dt>

  1104. <dd><p>The remote stub understands the &lsquo;<samp>QNonStop</samp>&rsquo; packet

  1105. (see <a href="#QNonStop">QNonStop</a>).

  1106. </p>

  1107. </dd>

  1108. <dt>&lsquo;<samp>QCatchSyscalls</samp>&rsquo;</dt>

  1109. <dd><p>The remote stub understands the &lsquo;<samp>QCatchSyscalls</samp>&rsquo; packet

  1110. (see <a href="#QCatchSyscalls">QCatchSyscalls</a>).

  1111. </p>

  1112. </dd>

  1113. <dt>&lsquo;<samp>QPassSignals</samp>&rsquo;</dt>

  1114. <dd><p>The remote stub understands the &lsquo;<samp>QPassSignals</samp>&rsquo; packet

  1115. (see <a href="#QPassSignals">QPassSignals</a>).

  1116. </p>

  1117. </dd>

  1118. <dt>&lsquo;<samp>QStartNoAckMode</samp>&rsquo;</dt>

  1119. <dd><p>The remote stub understands the &lsquo;<samp>QStartNoAckMode</samp>&rsquo; packet and

  1120. prefers to operate in no-acknowledgment mode.  See <a href="Packet-Acknowledgment.html#Packet-Acknowledgment">Packet Acknowledgment</a>.

  1121. </p>

  1122. </dd>

  1123. <dt>&lsquo;<samp>multiprocess</samp>&rsquo;</dt>

  1124. <dd><a name="multiprocess-extensions"></a><a name="index-multiprocess-extensions_002c-in-remote-protocol"></a>

  1125. <p>The remote stub understands the multiprocess extensions to the remote

  1126. protocol syntax.  The multiprocess extensions affect the syntax of

  1127. thread IDs in both packets and replies (see <a href="Packets.html#thread_002did-syntax">thread-id syntax</a>), and

  1128. add process IDs to the &lsquo;<samp>D</samp>&rsquo; packet and &lsquo;<samp>W</samp>&rsquo; and &lsquo;<samp>X</samp>&rsquo;

  1129. replies.  Note that reporting this feature indicates support for the

  1130. syntactic extensions only, not that the stub necessarily supports

  1131. debugging of more than one process at a time.  The stub must not use

  1132. multiprocess extensions in packet replies unless <small>GDB</small> has also

  1133. indicated it supports them in its &lsquo;<samp>qSupported</samp>&rsquo; request.

  1134. </p>

  1135. </dd>

  1136. <dt>&lsquo;<samp>qXfer:osdata:read</samp>&rsquo;</dt>

  1137. <dd><p>The remote stub understands the &lsquo;<samp>qXfer:osdata:read</samp>&rsquo; packet

  1138. ((see <a href="#qXfer-osdata-read">qXfer osdata read</a>).

  1139. </p>

  1140. </dd>

  1141. <dt>&lsquo;<samp>ConditionalBreakpoints</samp>&rsquo;</dt>

  1142. <dd><p>The target accepts and implements evaluation of conditional expressions

  1143. defined for breakpoints.  The target will only report breakpoint triggers

  1144. when such conditions are true (see <a href="Conditions.html#Conditions">Break Conditions</a>).

  1145. </p>

  1146. </dd>

  1147. <dt>&lsquo;<samp>ConditionalTracepoints</samp>&rsquo;</dt>

  1148. <dd><p>The remote stub accepts and implements conditional expressions defined

  1149. for tracepoints (see <a href="Tracepoint-Conditions.html#Tracepoint-Conditions">Tracepoint Conditions</a>).

  1150. </p>

  1151. </dd>

  1152. <dt>&lsquo;<samp>ReverseContinue</samp>&rsquo;</dt>

  1153. <dd><p>The remote stub accepts and implements the reverse continue packet

  1154. (see <a href="Packets.html#bc">bc</a>).

  1155. </p>

  1156. </dd>

  1157. <dt>&lsquo;<samp>ReverseStep</samp>&rsquo;</dt>

  1158. <dd><p>The remote stub accepts and implements the reverse step packet

  1159. (see <a href="Packets.html#bs">bs</a>).

  1160. </p>

  1161. </dd>

  1162. <dt>&lsquo;<samp>TracepointSource</samp>&rsquo;</dt>

  1163. <dd><p>The remote stub understands the &lsquo;<samp>QTDPsrc</samp>&rsquo; packet that supplies

  1164. the source form of tracepoint definitions.

  1165. </p>

  1166. </dd>

  1167. <dt>&lsquo;<samp>QAgent</samp>&rsquo;</dt>

  1168. <dd><p>The remote stub understands the &lsquo;<samp>QAgent</samp>&rsquo; packet.

  1169. </p>

  1170. </dd>

  1171. <dt>&lsquo;<samp>QAllow</samp>&rsquo;</dt>

  1172. <dd><p>The remote stub understands the &lsquo;<samp>QAllow</samp>&rsquo; packet.

  1173. </p>

  1174. </dd>

  1175. <dt>&lsquo;<samp>QDisableRandomization</samp>&rsquo;</dt>

  1176. <dd><p>The remote stub understands the &lsquo;<samp>QDisableRandomization</samp>&rsquo; packet.

  1177. </p>

  1178. </dd>

  1179. <dt>&lsquo;<samp>StaticTracepoint</samp>&rsquo;</dt>

  1180. <dd><a name="index-static-tracepoints_002c-in-remote-protocol"></a>

  1181. <p>The remote stub supports static tracepoints.

  1182. </p>

  1183. </dd>

  1184. <dt>&lsquo;<samp>InstallInTrace</samp>&rsquo;</dt>

  1185. <dd><a name="install-tracepoint-in-tracing"></a><p>The remote stub supports installing tracepoint in tracing.

  1186. </p>

  1187. </dd>

  1188. <dt>&lsquo;<samp>EnableDisableTracepoints</samp>&rsquo;</dt>

  1189. <dd><p>The remote stub supports the &lsquo;<samp>QTEnable</samp>&rsquo; (see <a href="Tracepoint-Packets.html#QTEnable">QTEnable</a>) and

  1190. &lsquo;<samp>QTDisable</samp>&rsquo; (see <a href="Tracepoint-Packets.html#QTDisable">QTDisable</a>) packets that allow tracepoints

  1191. to be enabled and disabled while a trace experiment is running.

  1192. </p>

  1193. </dd>

  1194. <dt>&lsquo;<samp>QTBuffer:size</samp>&rsquo;</dt>

  1195. <dd><p>The remote stub supports the &lsquo;<samp>QTBuffer:size</samp>&rsquo; (see <a href="Tracepoint-Packets.html#QTBuffer_002dsize">QTBuffer-size</a>)

  1196. packet that allows to change the size of the trace buffer.

  1197. </p>

  1198. </dd>

  1199. <dt>&lsquo;<samp>tracenz</samp>&rsquo;</dt>

  1200. <dd><a name="index-string-tracing_002c-in-remote-protocol"></a>

  1201. <p>The remote stub supports the &lsquo;<samp>tracenz</samp>&rsquo; bytecode for collecting strings.

  1202. See <a href="Bytecode-Descriptions.html#Bytecode-Descriptions">Bytecode Descriptions</a> for details about the bytecode.

  1203. </p>

  1204. </dd>

  1205. <dt>&lsquo;<samp>BreakpointCommands</samp>&rsquo;</dt>

  1206. <dd><a name="index-breakpoint-commands_002c-in-remote-protocol"></a>

  1207. <p>The remote stub supports running a breakpoint&rsquo;s command list itself,

  1208. rather than reporting the hit to <small>GDB</small>.

  1209. </p>

  1210. </dd>

  1211. <dt>&lsquo;<samp>Qbtrace:off</samp>&rsquo;</dt>

  1212. <dd><p>The remote stub understands the &lsquo;<samp>Qbtrace:off</samp>&rsquo; packet.

  1213. </p>

  1214. </dd>

  1215. <dt>&lsquo;<samp>Qbtrace:bts</samp>&rsquo;</dt>

  1216. <dd><p>The remote stub understands the &lsquo;<samp>Qbtrace:bts</samp>&rsquo; packet.

  1217. </p>

  1218. </dd>

  1219. <dt>&lsquo;<samp>Qbtrace:pt</samp>&rsquo;</dt>

  1220. <dd><p>The remote stub understands the &lsquo;<samp>Qbtrace:pt</samp>&rsquo; packet.

  1221. </p>

  1222. </dd>

  1223. <dt>&lsquo;<samp>Qbtrace-conf:bts:size</samp>&rsquo;</dt>

  1224. <dd><p>The remote stub understands the &lsquo;<samp>Qbtrace-conf:bts:size</samp>&rsquo; packet.

  1225. </p>

  1226. </dd>

  1227. <dt>&lsquo;<samp>Qbtrace-conf:pt:size</samp>&rsquo;</dt>

  1228. <dd><p>The remote stub understands the &lsquo;<samp>Qbtrace-conf:pt:size</samp>&rsquo; packet.

  1229. </p>

  1230. </dd>

  1231. <dt>&lsquo;<samp>swbreak</samp>&rsquo;</dt>

  1232. <dd><p>The remote stub reports the &lsquo;<samp>swbreak</samp>&rsquo; stop reason for memory

  1233. breakpoints.

  1234. </p>

  1235. </dd>

  1236. <dt>&lsquo;<samp>hwbreak</samp>&rsquo;</dt>

  1237. <dd><p>The remote stub reports the &lsquo;<samp>hwbreak</samp>&rsquo; stop reason for hardware

  1238. breakpoints.

  1239. </p>

  1240. </dd>

  1241. <dt>&lsquo;<samp>fork-events</samp>&rsquo;</dt>

  1242. <dd><p>The remote stub reports the &lsquo;<samp>fork</samp>&rsquo; stop reason for fork events.

  1243. </p>

  1244. </dd>

  1245. <dt>&lsquo;<samp>vfork-events</samp>&rsquo;</dt>

  1246. <dd><p>The remote stub reports the &lsquo;<samp>vfork</samp>&rsquo; stop reason for vfork events

  1247. and vforkdone events.

  1248. </p>

  1249. </dd>

  1250. <dt>&lsquo;<samp>exec-events</samp>&rsquo;</dt>

  1251. <dd><p>The remote stub reports the &lsquo;<samp>exec</samp>&rsquo; stop reason for exec events.

  1252. </p>

  1253. </dd>

  1254. <dt>&lsquo;<samp>vContSupported</samp>&rsquo;</dt>

  1255. <dd><p>The remote stub reports the supported actions in the reply to

  1256. &lsquo;<samp>vCont?</samp>&rsquo; packet.

  1257. </p>

  1258. </dd>

  1259. <dt>&lsquo;<samp>QThreadEvents</samp>&rsquo;</dt>

  1260. <dd><p>The remote stub understands the &lsquo;<samp>QThreadEvents</samp>&rsquo; packet.

  1261. </p>

  1262. </dd>

  1263. <dt>&lsquo;<samp>no-resumed</samp>&rsquo;</dt>

  1264. <dd><p>The remote stub reports the &lsquo;<samp>N</samp>&rsquo; stop reply.

  1265. </p>

  1266. </dd>

  1267. </dl>

  1268. 

  1269. </dd>

  1270. <dt>&lsquo;<samp>qSymbol::</samp>&rsquo;</dt>

  1271. <dd><a name="index-symbol-lookup_002c-remote-request"></a>

  1272. <a name="index-qSymbol-packet"></a>

  1273. <p>Notify the target that <small>GDB</small> is prepared to serve symbol lookup

  1274. requests.  Accept requests from the target for the values of symbols.

  1275. </p>

  1276. <p>Reply:

  1277. </p><dl compact="compact">

  1278. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  1279. <dd><p>The target does not need to look up any (more) symbols.

  1280. </p></dd>

  1281. <dt>&lsquo;<samp>qSymbol:<var>sym_name</var></samp>&rsquo;</dt>

  1282. <dd><p>The target requests the value of symbol <var>sym_name</var> (hex encoded).

  1283. <small>GDB</small> may provide the value by using the

  1284. &lsquo;<samp>qSymbol:<var>sym_value</var>:<var>sym_name</var></samp>&rsquo; message, described

  1285. below.

  1286. </p></dd>

  1287. </dl>

  1288. 

  1289. </dd>

  1290. <dt>&lsquo;<samp>qSymbol:<var>sym_value</var>:<var>sym_name</var></samp>&rsquo;</dt>

  1291. <dd><p>Set the value of <var>sym_name</var> to <var>sym_value</var>.

  1292. </p>

  1293. <p><var>sym_name</var> (hex encoded) is the name of a symbol whose value the

  1294. target has previously requested.

  1295. </p>

  1296. <p><var>sym_value</var> (hex) is the value for symbol <var>sym_name</var>.  If

  1297. <small>GDB</small> cannot supply a value for <var>sym_name</var>, then this field

  1298. will be empty.

  1299. </p>

  1300. <p>Reply:

  1301. </p><dl compact="compact">

  1302. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  1303. <dd><p>The target does not need to look up any (more) symbols.

  1304. </p></dd>

  1305. <dt>&lsquo;<samp>qSymbol:<var>sym_name</var></samp>&rsquo;</dt>

  1306. <dd><p>The target requests the value of a new symbol <var>sym_name</var> (hex

  1307. encoded).  <small>GDB</small> will continue to supply the values of symbols

  1308. (if available), until the target ceases to request them.

  1309. </p></dd>

  1310. </dl>

  1311. 

  1312. </dd>

  1313. <dt>&lsquo;<samp>qTBuffer</samp>&rsquo;</dt>

  1314. <dt>&lsquo;<samp>QTBuffer</samp>&rsquo;</dt>

  1315. <dt>&lsquo;<samp>QTDisconnected</samp>&rsquo;</dt>

  1316. <dt>&lsquo;<samp>QTDP</samp>&rsquo;</dt>

  1317. <dt>&lsquo;<samp>QTDPsrc</samp>&rsquo;</dt>

  1318. <dt>&lsquo;<samp>QTDV</samp>&rsquo;</dt>

  1319. <dt>&lsquo;<samp>qTfP</samp>&rsquo;</dt>

  1320. <dt>&lsquo;<samp>qTfV</samp>&rsquo;</dt>

  1321. <dt>&lsquo;<samp>QTFrame</samp>&rsquo;</dt>

  1322. <dt>&lsquo;<samp>qTMinFTPILen</samp>&rsquo;</dt>

  1323. <dd>

  1324. <p>See <a href="Tracepoint-Packets.html#Tracepoint-Packets">Tracepoint Packets</a>.

  1325. </p>

  1326. </dd>

  1327. <dt>&lsquo;<samp>qThreadExtraInfo,<var>thread-id</var></samp>&rsquo;</dt>

  1328. <dd><a name="index-thread-attributes-info_002c-remote-request"></a>

  1329. <a name="index-qThreadExtraInfo-packet"></a>

  1330. <p>Obtain from the target OS a printable string description of thread

  1331. attributes for the thread <var>thread-id</var>; see <a href="Packets.html#thread_002did-syntax">thread-id syntax</a>,

  1332. for the forms of <var>thread-id</var>.  This

  1333. string may contain anything that the target OS thinks is interesting

  1334. for <small>GDB</small> to tell the user about the thread.  The string is

  1335. displayed in <small>GDB</small>&rsquo;s <code>info threads</code> display.  Some

  1336. examples of possible thread extra info strings are &lsquo;<samp>Runnable</samp>&rsquo;, or

  1337. &lsquo;<samp>Blocked on Mutex</samp>&rsquo;.

  1338. </p>

  1339. <p>Reply:

  1340. </p><dl compact="compact">

  1341. <dt>&lsquo;<samp><var>XX</var>&hellip;</samp>&rsquo;</dt>

  1342. <dd><p>Where &lsquo;<samp><var>XX</var>&hellip;</samp>&rsquo; is a hex encoding of <small>ASCII</small> data,

  1343. comprising the printable string containing the extra information about

  1344. the thread&rsquo;s attributes.

  1345. </p></dd>

  1346. </dl>

  1347. 

  1348. <p>(Note that the <code>qThreadExtraInfo</code> packet&rsquo;s name is separated from

  1349. the command by a &lsquo;<samp>,</samp>&rsquo;, not a &lsquo;<samp>:</samp>&rsquo;, contrary to the naming

  1350. conventions above.  Please don&rsquo;t use this packet as a model for new

  1351. packets.)

  1352. </p>

  1353. </dd>

  1354. <dt>&lsquo;<samp>QTNotes</samp>&rsquo;</dt>

  1355. <dt>&lsquo;<samp>qTP</samp>&rsquo;</dt>

  1356. <dt>&lsquo;<samp>QTSave</samp>&rsquo;</dt>

  1357. <dt>&lsquo;<samp>qTsP</samp>&rsquo;</dt>

  1358. <dt>&lsquo;<samp>qTsV</samp>&rsquo;</dt>

  1359. <dt>&lsquo;<samp>QTStart</samp>&rsquo;</dt>

  1360. <dt>&lsquo;<samp>QTStop</samp>&rsquo;</dt>

  1361. <dt>&lsquo;<samp>QTEnable</samp>&rsquo;</dt>

  1362. <dt>&lsquo;<samp>QTDisable</samp>&rsquo;</dt>

  1363. <dt>&lsquo;<samp>QTinit</samp>&rsquo;</dt>

  1364. <dt>&lsquo;<samp>QTro</samp>&rsquo;</dt>

  1365. <dt>&lsquo;<samp>qTStatus</samp>&rsquo;</dt>

  1366. <dt>&lsquo;<samp>qTV</samp>&rsquo;</dt>

  1367. <dt>&lsquo;<samp>qTfSTM</samp>&rsquo;</dt>

  1368. <dt>&lsquo;<samp>qTsSTM</samp>&rsquo;</dt>

  1369. <dt>&lsquo;<samp>qTSTMat</samp>&rsquo;</dt>

  1370. <dd><p>See <a href="Tracepoint-Packets.html#Tracepoint-Packets">Tracepoint Packets</a>.

  1371. </p>

  1372. </dd>

  1373. <dt>&lsquo;<samp>qXfer:<var>object</var>:read:<var>annex</var>:<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1374. <dd><a name="index-read-special-object_002c-remote-request"></a>

  1375. <a name="index-qXfer-packet"></a>

  1376. <a name="qXfer-read"></a><p>Read uninterpreted bytes from the target&rsquo;s special data area

  1377. identified by the keyword <var>object</var>.  Request <var>length</var> bytes

  1378. starting at <var>offset</var> bytes into the data.  The content and

  1379. encoding of <var>annex</var> is specific to <var>object</var>; it can supply

  1380. additional details about what data to access.

  1381. </p>

  1382. <p>Reply:

  1383. </p><dl compact="compact">

  1384. <dt>&lsquo;<samp>m <var>data</var></samp>&rsquo;</dt>

  1385. <dd><p>Data <var>data</var> (see <a href="Overview.html#Binary-Data">Binary Data</a>) has been read from the

  1386. target.  There may be more data at a higher address (although

  1387. it is permitted to return &lsquo;<samp>m</samp>&rsquo; even for the last valid

  1388. block of data, as long as at least one byte of data was read).

  1389. It is possible for <var>data</var> to have fewer bytes than the <var>length</var> in the

  1390. request.

  1391. </p>

  1392. </dd>

  1393. <dt>&lsquo;<samp>l <var>data</var></samp>&rsquo;</dt>

  1394. <dd><p>Data <var>data</var> (see <a href="Overview.html#Binary-Data">Binary Data</a>) has been read from the target.

  1395. There is no more data to be read.  It is possible for <var>data</var> to

  1396. have fewer bytes than the <var>length</var> in the request.

  1397. </p>

  1398. </dd>

  1399. <dt>&lsquo;<samp>l</samp>&rsquo;</dt>

  1400. <dd><p>The <var>offset</var> in the request is at the end of the data.

  1401. There is no more data to be read.

  1402. </p>

  1403. </dd>

  1404. <dt>&lsquo;<samp>E00</samp>&rsquo;</dt>

  1405. <dd><p>The request was malformed, or <var>annex</var> was invalid.

  1406. </p>

  1407. </dd>

  1408. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  1409. <dd><p>The offset was invalid, or there was an error encountered reading the data.

  1410. The <var>nn</var> part is a hex-encoded <code>errno</code> value.

  1411. </p>

  1412. </dd>

  1413. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  1414. <dd><p>An empty reply indicates the <var>object</var> string was not recognized by

  1415. the stub, or that the object does not support reading.

  1416. </p></dd>

  1417. </dl>

  1418. 

  1419. <p>Here are the specific requests of this form defined so far.  All the

  1420. &lsquo;<samp>qXfer:<var>object</var>:read:&hellip;</samp>&rsquo; requests use the same reply

  1421. formats, listed above.

  1422. </p>

  1423. <dl compact="compact">

  1424. <dt>&lsquo;<samp>qXfer:auxv:read::<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1425. <dd><a name="qXfer-auxiliary-vector-read"></a><p>Access the target&rsquo;s <em>auxiliary vector</em>.  See <a href="OS-Information.html#OS-Information">auxiliary vector</a>.  Note <var>annex</var> must be empty.

  1426. </p>

  1427. <p>This packet is not probed by default; the remote stub must request it,

  1428. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1429. </p>

  1430. </dd>

  1431. <dt>&lsquo;<samp>qXfer:btrace:read:<var>annex</var>:<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1432. <dd><a name="qXfer-btrace-read"></a>

  1433. <p>Return a description of the current branch trace.

  1434. See <a href="Branch-Trace-Format.html#Branch-Trace-Format">Branch Trace Format</a>.  The annex part of the generic &lsquo;<samp>qXfer</samp>&rsquo;

  1435. packet may have one of the following values:

  1436. </p>

  1437. <dl compact="compact">

  1438. <dt><code>all</code></dt>

  1439. <dd><p>Returns all available branch trace.

  1440. </p>

  1441. </dd>

  1442. <dt><code>new</code></dt>

  1443. <dd><p>Returns all available branch trace if the branch trace changed since

  1444. the last read request.

  1445. </p>

  1446. </dd>

  1447. <dt><code>delta</code></dt>

  1448. <dd><p>Returns the new branch trace since the last read request.  Adds a new

  1449. block to the end of the trace that begins at zero and ends at the source

  1450. location of the first branch in the trace buffer.  This extra block is

  1451. used to stitch traces together.

  1452. </p>

  1453. <p>If the trace buffer overflowed, returns an error indicating the overflow.

  1454. </p></dd>

  1455. </dl>

  1456. 

  1457. <p>This packet is not probed by default; the remote stub must request it

  1458. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1459. </p>

  1460. </dd>

  1461. <dt>&lsquo;<samp>qXfer:btrace-conf:read::<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1462. <dd><a name="qXfer-btrace_002dconf-read"></a>

  1463. <p>Return a description of the current branch trace configuration.

  1464. See <a href="Branch-Trace-Configuration-Format.html#Branch-Trace-Configuration-Format">Branch Trace Configuration Format</a>.

  1465. </p>

  1466. <p>This packet is not probed by default; the remote stub must request it

  1467. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1468. </p>

  1469. </dd>

  1470. <dt>&lsquo;<samp>qXfer:exec-file:read:<var>annex</var>:<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1471. <dd><a name="qXfer-executable-filename-read"></a><p>Return the full absolute name of the file that was executed to create

  1472. a process running on the remote system.  The annex specifies the

  1473. numeric process ID of the process to query, encoded as a hexadecimal

  1474. number.  If the annex part is empty the remote stub should return the

  1475. filename corresponding to the currently executing process.

  1476. </p>

  1477. <p>This packet is not probed by default; the remote stub must request it,

  1478. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1479. </p>

  1480. </dd>

  1481. <dt>&lsquo;<samp>qXfer:features:read:<var>annex</var>:<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1482. <dd><a name="qXfer-target-description-read"></a><p>Access the <em>target description</em>.  See <a href="Target-Descriptions.html#Target-Descriptions">Target Descriptions</a>.  The

  1483. annex specifies which XML document to access.  The main description is

  1484. always loaded from the &lsquo;<samp>target.xml</samp>&rsquo; annex.

  1485. </p>

  1486. <p>This packet is not probed by default; the remote stub must request it,

  1487. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1488. </p>

  1489. </dd>

  1490. <dt>&lsquo;<samp>qXfer:libraries:read:<var>annex</var>:<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1491. <dd><a name="qXfer-library-list-read"></a><p>Access the target&rsquo;s list of loaded libraries.  See <a href="Library-List-Format.html#Library-List-Format">Library List Format</a>.

  1492. The annex part of the generic &lsquo;<samp>qXfer</samp>&rsquo; packet must be empty

  1493. (see <a href="#qXfer-read">qXfer read</a>).

  1494. </p>

  1495. <p>Targets which maintain a list of libraries in the program&rsquo;s memory do

  1496. not need to implement this packet; it is designed for platforms where

  1497. the operating system manages the list of loaded libraries.

  1498. </p>

  1499. <p>This packet is not probed by default; the remote stub must request it,

  1500. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1501. </p>

  1502. </dd>

  1503. <dt>&lsquo;<samp>qXfer:libraries-svr4:read:<var>annex</var>:<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1504. <dd><a name="qXfer-svr4-library-list-read"></a><p>Access the target&rsquo;s list of loaded libraries when the target is an SVR4

  1505. platform.  See <a href="Library-List-Format-for-SVR4-Targets.html#Library-List-Format-for-SVR4-Targets">Library List Format for SVR4 Targets</a>.  The annex part

  1506. of the generic &lsquo;<samp>qXfer</samp>&rsquo; packet must be empty unless the remote

  1507. stub indicated it supports the augmented form of this packet

  1508. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response

  1509. (see <a href="#qXfer-read">qXfer read</a>, <a href="#qSupported">qSupported</a>).

  1510. </p>

  1511. <p>This packet is optional for better performance on SVR4 targets.  

  1512. <small>GDB</small> uses memory read packets to read the SVR4 library list otherwise.

  1513. </p>

  1514. <p>This packet is not probed by default; the remote stub must request it,

  1515. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1516. </p>

  1517. <p>If the remote stub indicates it supports the augmented form of this

  1518. packet then the annex part of the generic &lsquo;<samp>qXfer</samp>&rsquo; packet may

  1519. contain a semicolon-separated list of &lsquo;<samp><var>name</var>=<var>value</var></samp>&rsquo;

  1520. arguments.  The currently supported arguments are:

  1521. </p>

  1522. <dl compact="compact">

  1523. <dt><code>start=<var>address</var></code></dt>

  1524. <dd><p>A hexadecimal number specifying the address of the &lsquo;<samp>struct

  1525. link_map</samp>&rsquo; to start reading the library list from.  If unset or zero

  1526. then the first &lsquo;<samp>struct link_map</samp>&rsquo; in the library list will be

  1527. chosen as the starting point.

  1528. </p>

  1529. </dd>

  1530. <dt><code>prev=<var>address</var></code></dt>

  1531. <dd><p>A hexadecimal number specifying the address of the &lsquo;<samp>struct

  1532. link_map</samp>&rsquo; immediately preceding the &lsquo;<samp>struct link_map</samp>&rsquo;

  1533. specified by the &lsquo;<samp>start</samp>&rsquo; argument.  If unset or zero then

  1534. the remote stub will expect that no &lsquo;<samp>struct link_map</samp>&rsquo;

  1535. exists prior to the starting point.

  1536. </p>

  1537. </dd>

  1538. </dl>

  1539. 

  1540. <p>Arguments that are not understood by the remote stub will be silently

  1541. ignored.

  1542. </p>

  1543. </dd>

  1544. <dt>&lsquo;<samp>qXfer:memory-map:read::<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1545. <dd><a name="qXfer-memory-map-read"></a><p>Access the target&rsquo;s <em>memory-map</em>.  See <a href="Memory-Map-Format.html#Memory-Map-Format">Memory Map Format</a>.  The

  1546. annex part of the generic &lsquo;<samp>qXfer</samp>&rsquo; packet must be empty

  1547. (see <a href="#qXfer-read">qXfer read</a>).

  1548. </p>

  1549. <p>This packet is not probed by default; the remote stub must request it,

  1550. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1551. </p>

  1552. </dd>

  1553. <dt>&lsquo;<samp>qXfer:sdata:read::<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1554. <dd><a name="qXfer-sdata-read"></a>

  1555. <p>Read contents of the extra collected static tracepoint marker

  1556. information.  The annex part of the generic &lsquo;<samp>qXfer</samp>&rsquo; packet must

  1557. be empty (see <a href="#qXfer-read">qXfer read</a>).  See <a href="Tracepoint-Actions.html#Tracepoint-Actions">Tracepoint

  1558. Action Lists</a>.

  1559. </p>

  1560. <p>This packet is not probed by default; the remote stub must request it,

  1561. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response

  1562. (see <a href="#qSupported">qSupported</a>).

  1563. </p>

  1564. </dd>

  1565. <dt>&lsquo;<samp>qXfer:siginfo:read::<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1566. <dd><a name="qXfer-siginfo-read"></a><p>Read contents of the extra signal information on the target

  1567. system.  The annex part of the generic &lsquo;<samp>qXfer</samp>&rsquo; packet must be

  1568. empty (see <a href="#qXfer-read">qXfer read</a>).

  1569. </p>

  1570. <p>This packet is not probed by default; the remote stub must request it,

  1571. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response

  1572. (see <a href="#qSupported">qSupported</a>).

  1573. </p>

  1574. </dd>

  1575. <dt>&lsquo;<samp>qXfer:threads:read::<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1576. <dd><a name="qXfer-threads-read"></a><p>Access the list of threads on target.  See <a href="Thread-List-Format.html#Thread-List-Format">Thread List Format</a>.  The

  1577. annex part of the generic &lsquo;<samp>qXfer</samp>&rsquo; packet must be empty

  1578. (see <a href="#qXfer-read">qXfer read</a>).

  1579. </p>

  1580. <p>This packet is not probed by default; the remote stub must request it,

  1581. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1582. </p>

  1583. </dd>

  1584. <dt>&lsquo;<samp>qXfer:traceframe-info:read::<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1585. <dd><a name="qXfer-traceframe-info-read"></a>

  1586. <p>Return a description of the current traceframe&rsquo;s contents.

  1587. See <a href="Traceframe-Info-Format.html#Traceframe-Info-Format">Traceframe Info Format</a>.  The annex part of the generic

  1588. &lsquo;<samp>qXfer</samp>&rsquo; packet must be empty (see <a href="#qXfer-read">qXfer read</a>).

  1589. </p>

  1590. <p>This packet is not probed by default; the remote stub must request it,

  1591. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1592. </p>

  1593. </dd>

  1594. <dt>&lsquo;<samp>qXfer:uib:read:<var>pc</var>:<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1595. <dd><a name="qXfer-unwind-info-block"></a>

  1596. <p>Return the unwind information block for <var>pc</var>.  This packet is used

  1597. on OpenVMS/ia64 to ask the kernel unwind information.

  1598. </p>

  1599. <p>This packet is not probed by default.

  1600. </p>

  1601. </dd>

  1602. <dt>&lsquo;<samp>qXfer:fdpic:read:<var>annex</var>:<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1603. <dd><a name="qXfer-fdpic-loadmap-read"></a><p>Read contents of <code>loadmap</code>s on the target system.  The

  1604. annex, either &lsquo;<samp>exec</samp>&rsquo; or &lsquo;<samp>interp</samp>&rsquo;, specifies which <code>loadmap</code>,

  1605. executable <code>loadmap</code> or interpreter <code>loadmap</code> to read.

  1606. </p>

  1607. <p>This packet is not probed by default; the remote stub must request it,

  1608. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response (see <a href="#qSupported">qSupported</a>).

  1609. </p>

  1610. </dd>

  1611. <dt>&lsquo;<samp>qXfer:osdata:read::<var>offset</var>,<var>length</var></samp>&rsquo;</dt>

  1612. <dd><a name="qXfer-osdata-read"></a><p>Access the target&rsquo;s <em>operating system information</em>.

  1613. See <a href="Operating-System-Information.html#Operating-System-Information">Operating System Information</a>.

  1614. </p>

  1615. </dd>

  1616. </dl>

  1617. 

  1618. </dd>

  1619. <dt>&lsquo;<samp>qXfer:<var>object</var>:write:<var>annex</var>:<var>offset</var>:<var>data</var>&hellip;</samp>&rsquo;</dt>

  1620. <dd><a name="index-write-data-into-object_002c-remote-request"></a>

  1621. <a name="qXfer-write"></a><p>Write uninterpreted bytes into the target&rsquo;s special data area

  1622. identified by the keyword <var>object</var>, starting at <var>offset</var> bytes

  1623. into the data.  The binary-encoded data (see <a href="Overview.html#Binary-Data">Binary Data</a>) to be

  1624. written is given by <var>data</var>&hellip;.  The content and encoding of <var>annex</var>

  1625. is specific to <var>object</var>; it can supply additional details about what data

  1626. to access.

  1627. </p>

  1628. <p>Reply:

  1629. </p><dl compact="compact">

  1630. <dt>&lsquo;<samp><var>nn</var></samp>&rsquo;</dt>

  1631. <dd><p><var>nn</var> (hex encoded) is the number of bytes written.

  1632. This may be fewer bytes than supplied in the request.

  1633. </p>

  1634. </dd>

  1635. <dt>&lsquo;<samp>E00</samp>&rsquo;</dt>

  1636. <dd><p>The request was malformed, or <var>annex</var> was invalid.

  1637. </p>

  1638. </dd>

  1639. <dt>&lsquo;<samp>E <var>nn</var></samp>&rsquo;</dt>

  1640. <dd><p>The offset was invalid, or there was an error encountered writing the data.

  1641. The <var>nn</var> part is a hex-encoded <code>errno</code> value.

  1642. </p>

  1643. </dd>

  1644. <dt>&lsquo;<samp><!-- /@w --></samp>&rsquo;</dt>

  1645. <dd><p>An empty reply indicates the <var>object</var> string was not

  1646. recognized by the stub, or that the object does not support writing.

  1647. </p></dd>

  1648. </dl>

  1649. 

  1650. <p>Here are the specific requests of this form defined so far.  All the

  1651. &lsquo;<samp>qXfer:<var>object</var>:write:&hellip;</samp>&rsquo; requests use the same reply

  1652. formats, listed above.

  1653. </p>

  1654. <dl compact="compact">

  1655. <dt>&lsquo;<samp>qXfer:siginfo:write::<var>offset</var>:<var>data</var>&hellip;</samp>&rsquo;</dt>

  1656. <dd><a name="qXfer-siginfo-write"></a><p>Write <var>data</var> to the extra signal information on the target system.

  1657. The annex part of the generic &lsquo;<samp>qXfer</samp>&rsquo; packet must be

  1658. empty (see <a href="#qXfer-write">qXfer write</a>).

  1659. </p>

  1660. <p>This packet is not probed by default; the remote stub must request it,

  1661. by supplying an appropriate &lsquo;<samp>qSupported</samp>&rsquo; response

  1662. (see <a href="#qSupported">qSupported</a>).

  1663. </p></dd>

  1664. </dl>

  1665. 

  1666. </dd>

  1667. <dt>&lsquo;<samp>qXfer:<var>object</var>:<var>operation</var>:&hellip;</samp>&rsquo;</dt>

  1668. <dd><p>Requests of this form may be added in the future.  When a stub does

  1669. not recognize the <var>object</var> keyword, or its support for

  1670. <var>object</var> does not recognize the <var>operation</var> keyword, the stub

  1671. must respond with an empty packet.

  1672. </p>

  1673. </dd>

  1674. <dt>&lsquo;<samp>qAttached:<var>pid</var></samp>&rsquo;</dt>

  1675. <dd><a name="index-query-attached_002c-remote-request"></a>

  1676. <a name="index-qAttached-packet"></a>

  1677. <p>Return an indication of whether the remote server attached to an

  1678. existing process or created a new process.  When the multiprocess

  1679. protocol extensions are supported (see <a href="#multiprocess-extensions">multiprocess extensions</a>),

  1680. <var>pid</var> is an integer in hexadecimal format identifying the target

  1681. process.  Otherwise, <small>GDB</small> will omit the <var>pid</var> field and

  1682. the query packet will be simplified as &lsquo;<samp>qAttached</samp>&rsquo;.

  1683. </p>

  1684. <p>This query is used, for example, to know whether the remote process

  1685. should be detached or killed when a <small>GDB</small> session is ended with

  1686. the <code>quit</code> command.

  1687. </p>

  1688. <p>Reply:

  1689. </p><dl compact="compact">

  1690. <dt>&lsquo;<samp>1</samp>&rsquo;</dt>

  1691. <dd><p>The remote server attached to an existing process.

  1692. </p></dd>

  1693. <dt>&lsquo;<samp>0</samp>&rsquo;</dt>

  1694. <dd><p>The remote server created a new process.

  1695. </p></dd>

  1696. <dt>&lsquo;<samp>E <var>NN</var></samp>&rsquo;</dt>

  1697. <dd><p>A badly formed request or an error was encountered.

  1698. </p></dd>

  1699. </dl>

  1700. 

  1701. </dd>

  1702. <dt>&lsquo;<samp>Qbtrace:bts</samp>&rsquo;</dt>

  1703. <dd><p>Enable branch tracing for the current thread using Branch Trace Store.

  1704. </p>

  1705. <p>Reply:

  1706. </p><dl compact="compact">

  1707. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  1708. <dd><p>Branch tracing has been enabled.

  1709. </p></dd>

  1710. <dt>&lsquo;<samp>E.errtext</samp>&rsquo;</dt>

  1711. <dd><p>A badly formed request or an error was encountered.

  1712. </p></dd>

  1713. </dl>

  1714. 

  1715. </dd>

  1716. <dt>&lsquo;<samp>Qbtrace:pt</samp>&rsquo;</dt>

  1717. <dd><p>Enable branch tracing for the current thread using Intel Processor Trace.

  1718. </p>

  1719. <p>Reply:

  1720. </p><dl compact="compact">

  1721. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  1722. <dd><p>Branch tracing has been enabled.

  1723. </p></dd>

  1724. <dt>&lsquo;<samp>E.errtext</samp>&rsquo;</dt>

  1725. <dd><p>A badly formed request or an error was encountered.

  1726. </p></dd>

  1727. </dl>

  1728. 

  1729. </dd>

  1730. <dt>&lsquo;<samp>Qbtrace:off</samp>&rsquo;</dt>

  1731. <dd><p>Disable branch tracing for the current thread.

  1732. </p>

  1733. <p>Reply:

  1734. </p><dl compact="compact">

  1735. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  1736. <dd><p>Branch tracing has been disabled.

  1737. </p></dd>

  1738. <dt>&lsquo;<samp>E.errtext</samp>&rsquo;</dt>

  1739. <dd><p>A badly formed request or an error was encountered.

  1740. </p></dd>

  1741. </dl>

  1742. 

  1743. </dd>

  1744. <dt>&lsquo;<samp>Qbtrace-conf:bts:size=<var>value</var></samp>&rsquo;</dt>

  1745. <dd><p>Set the requested ring buffer size for new threads that use the

  1746. btrace recording method in bts format.

  1747. </p>

  1748. <p>Reply:

  1749. </p><dl compact="compact">

  1750. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  1751. <dd><p>The ring buffer size has been set.

  1752. </p></dd>

  1753. <dt>&lsquo;<samp>E.errtext</samp>&rsquo;</dt>

  1754. <dd><p>A badly formed request or an error was encountered.

  1755. </p></dd>

  1756. </dl>

  1757. 

  1758. </dd>

  1759. <dt>&lsquo;<samp>Qbtrace-conf:pt:size=<var>value</var></samp>&rsquo;</dt>

  1760. <dd><p>Set the requested ring buffer size for new threads that use the

  1761. btrace recording method in pt format.

  1762. </p>

  1763. <p>Reply:

  1764. </p><dl compact="compact">

  1765. <dt>&lsquo;<samp>OK</samp>&rsquo;</dt>

  1766. <dd><p>The ring buffer size has been set.

  1767. </p></dd>

  1768. <dt>&lsquo;<samp>E.errtext</samp>&rsquo;</dt>

  1769. <dd><p>A badly formed request or an error was encountered.

  1770. </p></dd>

  1771. </dl>

  1772. 

  1773. </dd>

  1774. </dl>

  1775. 

  1776. <div class="footnote">

  1777. <hr>

  1778. <h4 class="footnotes-heading">Footnotes</h4>

  1779. 

  1780. <h3><a name="FOOT20" href="#DOCF20">(20)</a></h3>

  1781. <p>The &lsquo;<samp>qP</samp>&rsquo; and &lsquo;<samp>qL</samp>&rsquo;

  1782. packets predate these conventions, and have arguments without any terminator

  1783. for the packet name; we suspect they are in widespread use in places that

  1784. are difficult to upgrade.  The &lsquo;<samp>qC</samp>&rsquo; packet has no arguments, but some

  1785. existing stubs (e.g. RedBoot) are known to not check for the end of the

  1786. packet.</p>

  1787. </div>

  1788. <hr>

  1789. <div class="header">

  1790. <p>

  1791. Next: <a href="Architecture_002dSpecific-Protocol-Details.html#Architecture_002dSpecific-Protocol-Details" accesskey="n" rel="next">Architecture-Specific Protocol Details</a>, Previous: <a href="Stop-Reply-Packets.html#Stop-Reply-Packets" accesskey="p" rel="prev">Stop Reply Packets</a>, Up: <a href="Remote-Protocol.html#Remote-Protocol" accesskey="u" rel="up">Remote Protocol</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>

  1792. </div>

  1793. 

  1794. 

  1795. 

  1796. </body>

  1797. </html>