| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.14"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Crashpad: crashpad::PtraceBroker::Request Struct Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="crashpad_doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Crashpad |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.14 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacecrashpad.html">crashpad</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1PtraceBroker.html">PtraceBroker</a></li><li class="navelem"><a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html">Request</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="structcrashpad_1_1PtraceBroker_1_1Request-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::PtraceBroker::Request Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A request sent to a <a class="el" href="classcrashpad_1_1PtraceBroker.html" title="Implements a PtraceConnection over a socket. ">PtraceBroker</a> from a <a class="el" href="classcrashpad_1_1PtraceClient.html" title="Implements a PtraceConnection over a socket. ">PtraceClient</a>. |
| <a href="structcrashpad_1_1PtraceBroker_1_1Request.html#details">More...</a></p> |
| |
| <p><code>#include "util/linux/ptrace_broker.h"</code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a17f43bd6507f36e2fad108479d4ea999"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a17f43bd6507f36e2fad108479d4ea999">Type</a> : uint16_t </td></tr> |
| <tr class="memdesc:a17f43bd6507f36e2fad108479d4ea999"><td class="mdescLeft"> </td><td class="mdescRight">The type of request to serve. <a href="structcrashpad_1_1PtraceBroker_1_1Request.html#a17f43bd6507f36e2fad108479d4ea999">More...</a><br /></td></tr> |
| <tr class="separator:a17f43bd6507f36e2fad108479d4ea999"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a505a324ad681ab0fb627183df677d2f6"><td class="memItemLeft" align="right" valign="top"><a id="a505a324ad681ab0fb627183df677d2f6"></a> |
| uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a505a324ad681ab0fb627183df677d2f6">version</a> = kVersion</td></tr> |
| <tr class="memdesc:a505a324ad681ab0fb627183df677d2f6"><td class="mdescLeft"> </td><td class="mdescRight">The version number for this <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html" title="A request sent to a PtraceBroker from a PtraceClient. ">Request</a>. <br /></td></tr> |
| <tr class="separator:a505a324ad681ab0fb627183df677d2f6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0217871feb1dc3651d701026177727b0"><td class="memItemLeft" align="right" valign="top"><a id="a0217871feb1dc3651d701026177727b0"></a> |
| enum <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a17f43bd6507f36e2fad108479d4ea999">crashpad::PtraceBroker::Request::Type</a> </td><td class="memItemRight" valign="bottom"><b>type</b></td></tr> |
| <tr class="separator:a0217871feb1dc3651d701026177727b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeaf2944593020920cdd8e2315e3d5a69"><td class="memItemLeft" align="right" valign="top"><a id="aeaf2944593020920cdd8e2315e3d5a69"></a> |
| pid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#aeaf2944593020920cdd8e2315e3d5a69">tid</a></td></tr> |
| <tr class="memdesc:aeaf2944593020920cdd8e2315e3d5a69"><td class="mdescLeft"> </td><td class="mdescRight">The thread ID associated with this request. Valid for kTypeAttach, kTypeGetThreadInfo, and kTypeReadMemory. <br /></td></tr> |
| <tr class="separator:aeaf2944593020920cdd8e2315e3d5a69"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8cc06900c5ccd81f31837ac8e91d7e15"><td class="memItemLeft" ><a id="a8cc06900c5ccd81f31837ac8e91d7e15"></a> |
| union {</td></tr> |
| <tr class="memitem:a1fd112fd39f46ea2f7478d04043dbd7a"><td class="memItemLeft" > |
|    struct {</td></tr> |
| <tr class="memitem:a07a41636b3ebe89dd85618da4e26e45e"><td class="memItemLeft" > |
|       <a class="el" href="namespacecrashpad.html#af2d003bfc8632755c60ab27bd6d1c8ae">VMAddress</a>   <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a839198f6879d08e96bac2b85661ba664">base</a></td></tr> |
| <tr class="memdesc:a07a41636b3ebe89dd85618da4e26e45e"><td class="mdescLeft"> </td><td class="mdescRight">The base address of the memory region. <br /></td></tr> |
| <tr class="separator:a07a41636b3ebe89dd85618da4e26e45e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95d3d6edf916229392f03159ce37758f"><td class="memItemLeft" > |
|       <a class="el" href="namespacecrashpad.html#a103690edebf604dcd23d5c03b78fe0be">VMSize</a>   <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#ae8ce2719c6cb5df998146865c60b0738">size</a></td></tr> |
| <tr class="memdesc:a95d3d6edf916229392f03159ce37758f"><td class="mdescLeft"> </td><td class="mdescRight">The size of the memory region. <br /></td></tr> |
| <tr class="separator:a95d3d6edf916229392f03159ce37758f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1fd112fd39f46ea2f7478d04043dbd7a"><td class="memItemLeft" valign="top">   }   <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a44bbc283e428c052569044d5e7d888cd">iov</a></td></tr> |
| <tr class="memdesc:a1fd112fd39f46ea2f7478d04043dbd7a"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the memory region to read for a kTypeReadMemory request. <br /></td></tr> |
| <tr class="separator:a1fd112fd39f46ea2f7478d04043dbd7a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec981ea2ae94c4b97df170bcdd810831"><td class="memItemLeft" > |
|    struct {</td></tr> |
| <tr class="memitem:ae9340f627154fbef3045e0ddb5fe5ce7"><td class="memItemLeft" > |
|       <a class="el" href="namespacecrashpad.html#a103690edebf604dcd23d5c03b78fe0be">VMSize</a>   <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a92344ec9674a6c7517633154ca7f099e">path_length</a></td></tr> |
| <tr class="memdesc:ae9340f627154fbef3045e0ddb5fe5ce7"><td class="mdescLeft"> </td><td class="mdescRight">The number of bytes in <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a6797c04b619b63309f4c5d7ca464d295" title="The file path to read. ">path</a>. The path should not include a <code>NUL</code>-terminator. <br /></td></tr> |
| <tr class="separator:ae9340f627154fbef3045e0ddb5fe5ce7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a68bbe5bdd8ca4b7d794f326a8bb4fc1f"><td class="memItemLeft" > |
|       char   <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a6797c04b619b63309f4c5d7ca464d295">path</a> []</td></tr> |
| <tr class="memdesc:a68bbe5bdd8ca4b7d794f326a8bb4fc1f"><td class="mdescLeft"> </td><td class="mdescRight">The file path to read. <br /></td></tr> |
| <tr class="separator:a68bbe5bdd8ca4b7d794f326a8bb4fc1f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aec981ea2ae94c4b97df170bcdd810831"><td class="memItemLeft" valign="top">   }   <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a702c49fc54befe4ba0ac42c997f6d57a">path</a></td></tr> |
| <tr class="memdesc:aec981ea2ae94c4b97df170bcdd810831"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the file path to read for a kTypeReadFile request. <br /></td></tr> |
| <tr class="separator:aec981ea2ae94c4b97df170bcdd810831"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8cc06900c5ccd81f31837ac8e91d7e15"><td class="memItemLeft" valign="top">}; </td><td class="memItemRight" valign="bottom"></td></tr> |
| <tr class="separator:a8cc06900c5ccd81f31837ac8e91d7e15"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:acb39b7a385ca2af85356553b7fae9a5e"><td class="memItemLeft" align="right" valign="top"><a id="acb39b7a385ca2af85356553b7fae9a5e"></a> |
| static constexpr uint16_t </td><td class="memItemRight" valign="bottom"><b>kVersion</b> = 1</td></tr> |
| <tr class="separator:acb39b7a385ca2af85356553b7fae9a5e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A request sent to a <a class="el" href="classcrashpad_1_1PtraceBroker.html" title="Implements a PtraceConnection over a socket. ">PtraceBroker</a> from a <a class="el" href="classcrashpad_1_1PtraceClient.html" title="Implements a PtraceConnection over a socket. ">PtraceClient</a>. </p> |
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a id="a17f43bd6507f36e2fad108479d4ea999"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a17f43bd6507f36e2fad108479d4ea999">◆ </a></span>Type</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="structcrashpad_1_1PtraceBroker_1_1Request.html#a17f43bd6507f36e2fad108479d4ea999">crashpad::PtraceBroker::Request::Type</a> : uint16_t</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The type of request to serve. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a17f43bd6507f36e2fad108479d4ea999a6c4ad8fb8f81d2daf6bb1d26d1da937a"></a>kTypeAttach </td><td class="fielddoc"><p><code>ptrace</code>-attach the specified thread ID. Responds with kBoolTrue on success, otherwise kBoolFalse, followed by an Errno. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17f43bd6507f36e2fad108479d4ea999af03bf04c0abc1c3a09d49014e12c1407"></a>kTypeIs64Bit </td><td class="fielddoc"><p>Responds with kBoolTrue if the target process is 64-bit. Otherwise, kBoolFalse. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17f43bd6507f36e2fad108479d4ea999a61e1a5c74e7eb369add6386a7281904a"></a>kTypeGetThreadInfo </td><td class="fielddoc"><p>Responds with a <a class="el" href="structcrashpad_1_1PtraceBroker_1_1GetThreadInfoResponse.html" title="The response sent for a Request with type kTypeGetThreadInfo. ">GetThreadInfoResponse</a> containing a <a class="el" href="structcrashpad_1_1ThreadInfo.html" title="A collection of ptrace-able information about a thread. ">ThreadInfo</a> for the specified thread ID. If an error occurs, <a class="el" href="structcrashpad_1_1PtraceBroker_1_1GetThreadInfoResponse.html#a5bda26d861e6c0d6288618ec50db35b9" title="Specifies the success or failure of this call. ">GetThreadInfoResponse::success</a> is set to kBoolFalse and is followed by an Errno. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17f43bd6507f36e2fad108479d4ea999a009cbfd8cee582baa254a8a579678980"></a>kTypeReadMemory </td><td class="fielddoc"><p>Reads memory from the attached process. The data is returned in a series of messages. Each message begins with an int32_t indicating the number of bytes read, 0 for end-of-file, or -1 for errors, followed by a ReadError. On success the bytes read follow. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17f43bd6507f36e2fad108479d4ea999a5d94acaf928e6f21fc5f6711c8d5bfa7"></a>kTypeReadFile </td><td class="fielddoc"><p>Read a file's contents. The data is returned in a series of messages. The first message is an OpenResult, indicating the validity of the received file path. If the OpenResult is kOpenResultSuccess, each subsequent message begins with an int32_t indicating the number of bytes read, 0 for end-of-file, or -1 for errors, followed by an Errno. On success, the bytes read follow. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="a17f43bd6507f36e2fad108479d4ea999a0129b9368a0006420e4d48ea7cba3363"></a>kTypeExit </td><td class="fielddoc"><p>Causes the broker to return from <a class="el" href="classcrashpad_1_1PtraceBroker.html#a7710bcabc694ce327838c0b537f2fdc4" title="Begin serving requests on the configured socket. ">Run()</a>, detaching all attached threads. Does not respond. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li>util/linux/ptrace_broker.h</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.14 |
| </small></address> |
| </body> |
| </html> |
