23 lines
4.9 KiB
HTML
23 lines
4.9 KiB
HTML
<!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="`syscall(SYS_pidfd_getfd, pidfd, flags)`—Obtain a duplicate of another process’ file descriptor."><title>pidfd_getfd in rustix::process - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustix" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustix/index.html">rustix</a><span class="version">0.38.37</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">pidfd_<wbr>getfd</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#references" title="References">References</a></li><li><a href="#warning" title="Warning">Warning</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In rustix::<wbr>process</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">rustix</a>::<wbr><a href="index.html">process</a></span><h1>Function <span class="fn">pidfd_getfd</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rustix/process/pidfd_getfd.rs.html#50-56">Source</a> </span></div><pre class="rust item-decl"><code>pub fn pidfd_getfd<Fd: <a class="trait" href="../fd/trait.AsFd.html" title="trait rustix::fd::AsFd">AsFd</a>>(
|
||
pidfd: Fd,
|
||
targetfd: <a class="type" href="type.ForeignRawFd.html" title="type rustix::process::ForeignRawFd">ForeignRawFd</a>,
|
||
flags: <a class="struct" href="struct.PidfdGetfdFlags.html" title="struct rustix::process::PidfdGetfdFlags">PidfdGetfdFlags</a>,
|
||
) -> <a class="type" href="../io/type.Result.html" title="type rustix::io::Result">Result</a><<a class="struct" href="../fd/struct.OwnedFd.html" title="struct rustix::fd::OwnedFd">OwnedFd</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>syscall(SYS_pidfd_getfd, pidfd, flags)</code>—Obtain a duplicate of another
|
||
process’ file descriptor.</p>
|
||
<h2 id="references"><a class="doc-anchor" href="#references">§</a>References</h2>
|
||
<ul>
|
||
<li><a href="https://man7.org/linux/man-pages/man2/pidfd_getfd.2.html">Linux</a></li>
|
||
</ul>
|
||
<h2 id="warning"><a class="doc-anchor" href="#warning">§</a>Warning</h2>
|
||
<p>This function is generally safe for the calling process, but it can impact
|
||
the target process in unexpected ways. If you want to ensure that Rust I/O
|
||
safety assumptions continue to hold in the target process, then the target
|
||
process must have communicated the file description number to the calling
|
||
process from a value of a type that implements <code>AsRawFd</code>, and the target
|
||
process must not drop that value until after the calling process has
|
||
returned from <code>pidfd_getfd</code>.</p>
|
||
<p>When <code>pidfd_getfd</code> is used to debug the target, or the target is not a Rust
|
||
application, or <code>pidfd_getfd</code> is used in any other way, then extra care
|
||
should be taken to avoid unexpected behaviour or crashes.</p>
|
||
<p>For further details, see the references above.</p>
|
||
</div></details></section></div></main></body></html> |