|
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ptrace` mod in crate `nix`."><meta name="keywords" content="rust, rustlang, rust-lang, ptrace"><title>nix::sys::ptrace - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../nix/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module ptrace</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a></p><script>window.sidebarCurrent = {name: 'ptrace', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/nix/sys/ptrace/mod.rs.html#1-22' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>nix</a>::<wbr><a href='../index.html'>sys</a>::<wbr><a class="mod" href=''>ptrace</a></span></h1><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Options.html" title='nix::sys::ptrace::Options struct'>Options</a></td><td class='docblock-short'><p>Ptrace options used in conjunction with the PTRACE_SETOPTIONS request.
|
|
|
See <code>man ptrace</code> for more details.</p>
|
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.Event.html" title='nix::sys::ptrace::Event enum'>Event</a></td><td class='docblock-short'><p>Using the ptrace options the tracer can configure the tracee to stop
|
|
|
at certain events. This enum is used to define those events as defined
|
|
|
in <code>man ptrace</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Request.html" title='nix::sys::ptrace::Request enum'>Request</a></td><td class='docblock-short'><p>Ptrace Request enum defining the action to be taken.</p>
|
|
|
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.attach.html" title='nix::sys::ptrace::attach fn'>attach</a></td><td class='docblock-short'><p>Attach to a running process, as with <code>ptrace(PTRACE_ATTACH, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.cont.html" title='nix::sys::ptrace::cont fn'>cont</a></td><td class='docblock-short'><p>Restart the stopped tracee process, as with <code>ptrace(PTRACE_CONT, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.detach.html" title='nix::sys::ptrace::detach fn'>detach</a></td><td class='docblock-short'><p>Detaches the current running process, as with <code>ptrace(PTRACE_DETACH, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.getevent.html" title='nix::sys::ptrace::getevent fn'>getevent</a></td><td class='docblock-short'><p>Gets a ptrace event as described by <code>ptrace(PTRACE_GETEVENTMSG,...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.getregs.html" title='nix::sys::ptrace::getregs fn'>getregs</a></td><td class='docblock-short'><p>Get user registers, as with <code>ptrace(PTRACE_GETREGS, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.getsiginfo.html" title='nix::sys::ptrace::getsiginfo fn'>getsiginfo</a></td><td class='docblock-short'><p>Get siginfo as with <code>ptrace(PTRACE_GETSIGINFO,...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.kill.html" title='nix::sys::ptrace::kill fn'>kill</a></td><td class='docblock-short'><p>Issues a kill request as with <code>ptrace(PTRACE_KILL, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.ptrace.html" title='nix::sys::ptrace::ptrace fn'>ptrace</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'><span class="stab deprecated">Deprecated</span><p>Performs a ptrace request. If the request in question is provided by a specialised function
|
|
|
this function will return an unsupported operation error.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.read.html" title='nix::sys::ptrace::read fn'>read</a></td><td class='docblock-short'><p>Reads a word from a processes memory at the given address</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.setoptions.html" title='nix::sys::ptrace::setoptions fn'>setoptions</a></td><td class='docblock-short'><p>Set options, as with <code>ptrace(PTRACE_SETOPTIONS,...)</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.setregs.html" title='nix::sys::ptrace::setregs fn'>setregs</a></td><td class='docblock-short'><p>Set user registers, as with <code>ptrace(PTRACE_SETREGS, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.setsiginfo.html" title='nix::sys::ptrace::setsiginfo fn'>setsiginfo</a></td><td class='docblock-short'><p>Set siginfo as with <code>ptrace(PTRACE_SETSIGINFO,...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.step.html" title='nix::sys::ptrace::step fn'>step</a></td><td class='docblock-short'><p>Move the stopped tracee process forward by a single step as with
|
|
|
<code>ptrace(PTRACE_SINGLESTEP, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.syscall.html" title='nix::sys::ptrace::syscall fn'>syscall</a></td><td class='docblock-short'><p>Ask for next syscall, as with <code>ptrace(PTRACE_SYSCALL, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.traceme.html" title='nix::sys::ptrace::traceme fn'>traceme</a></td><td class='docblock-short'><p>Sets the process as traceable, as with <code>ptrace(PTRACE_TRACEME, ...)</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.write.html" title='nix::sys::ptrace::write fn'>write</a></td><td class='docblock-short'><p>Writes a word into the processes memory at the given address</p>
|
|
|
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="type" href="type.AddressType.html" title='nix::sys::ptrace::AddressType type'>AddressType</a></td><td class='docblock-short'></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "nix";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |
