orion/phy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
doc
phy/rustix/process/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

43 lines
41 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Process-associated operations."><title>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 mod"><!--[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="#">Module process</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate rustix</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></span><h1>Module <span>process</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/mod.rs.html#1-84">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Process-associated operations.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.CpuSet.html" title="struct rustix::process::CpuSet">CpuSet</a></div><div class="desc docblock-short"><code>CpuSet</code> represents a bit-mask of CPUs.</div></li><li><div class="item-name"><a class="struct" href="struct.Cpuid.html" title="struct rustix::process::Cpuid">Cpuid</a></div><div class="desc docblock-short">A Linux CPU ID.</div></li><li><div class="item-name"><a class="struct" href="struct.FloatingPointEmulationControl.html" title="struct rustix::process::FloatingPointEmulationControl">Floating<wbr>Point<wbr>Emulation<wbr>Control</a></div><div class="desc docblock-short"><code>PR_FPEMU_*</code> flags for use with <a href="fn.floating_point_emulation_control.html" title="fn rustix::process::floating_point_emulation_control"><code>floating_point_emulation_control</code></a>
and <a href="fn.set_floating_point_emulation_control.html" title="fn rustix::process::set_floating_point_emulation_control"><code>set_floating_point_emulation_control</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.FloatingPointExceptionMode.html" title="struct rustix::process::FloatingPointExceptionMode">Floating<wbr>Point<wbr>Exception<wbr>Mode</a></div><div class="desc docblock-short">Zero means floating point exceptions are disabled.</div></li><li><div class="item-name"><a class="struct" href="struct.Gid.html" title="struct rustix::process::Gid">Gid</a></div><div class="desc docblock-short"><code>gid_t</code>—A Unix group ID.</div></li><li><div class="item-name"><a class="struct" href="struct.MembarrierQuery.html" title="struct rustix::process::MembarrierQuery">Membarrier<wbr>Query</a></div><div class="desc docblock-short">A result from <a href="fn.membarrier_query.html" title="fn rustix::process::membarrier_query"><code>membarrier_query</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Pid.html" title="struct rustix::process::Pid">Pid</a></div><div class="desc docblock-short"><code>pid_t</code>—A non-zero Unix process ID.</div></li><li><div class="item-name"><a class="struct" href="struct.PidfdFlags.html" title="struct rustix::process::PidfdFlags">Pidfd<wbr>Flags</a></div><div class="desc docblock-short"><code>PIDFD_*</code> flags for use with <a href="fn.pidfd_open.html" title="fn rustix::process::pidfd_open"><code>pidfd_open</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PidfdGetfdFlags.html" title="struct rustix::process::PidfdGetfdFlags">Pidfd<wbr>Getfd<wbr>Flags</a></div><div class="desc docblock-short">All flags are reserved for future use.</div></li><li><div class="item-name"><a class="struct" href="struct.PrctlMmMap.html" title="struct rustix::process::PrctlMmMap">Prctl<wbr>MmMap</a></div><div class="desc docblock-short">This structure provides new memory descriptor map which mostly modifies
<code>/proc/pid/stat[m]</code> output for a task.
This mostly done in a sake of checkpoint/restore functionality.</div></li><li><div class="item-name"><a class="struct" href="struct.Rlimit.html" title="struct rustix::process::Rlimit">Rlimit</a></div><div class="desc docblock-short"><code>struct rlimit</code>—Current and maximum values used in <a href="fn.getrlimit.html" title="fn rustix::process::getrlimit"><code>getrlimit</code></a>,
<a href="fn.setrlimit.html" title="fn rustix::process::setrlimit"><code>setrlimit</code></a>, and <a href="fn.prlimit.html" title="fn rustix::process::prlimit"><code>prlimit</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.SpeculationFeatureControl.html" title="struct rustix::process::SpeculationFeatureControl">Speculation<wbr>Feature<wbr>Control</a></div><div class="desc docblock-short"><code>PR_SPEC_*</code> flags for use with <a href="fn.control_speculative_feature.html" title="fn rustix::process::control_speculative_feature"><code>control_speculative_feature</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.SpeculationFeatureState.html" title="struct rustix::process::SpeculationFeatureState">Speculation<wbr>Feature<wbr>State</a></div><div class="desc docblock-short">Zero means the processors are not vulnerable.</div></li><li><div class="item-name"><a class="struct" href="struct.Uid.html" title="struct rustix::process::Uid">Uid</a></div><div class="desc docblock-short"><code>uid_t</code>—A Unix user ID.</div></li><li><div class="item-name"><a class="struct" href="struct.UnalignedAccessControl.html" title="struct rustix::process::UnalignedAccessControl">Unaligned<wbr>Access<wbr>Control</a></div><div class="desc docblock-short"><code>PR_UNALIGN_*</code> flags for use with <a href="fn.unaligned_access_control.html" title="fn rustix::process::unaligned_access_control"><code>unaligned_access_control</code></a> and
<a href="fn.set_unaligned_access_control.html" title="fn rustix::process::set_unaligned_access_control"><code>set_unaligned_access_control</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.WaitOptions.html" title="struct rustix::process::WaitOptions">Wait<wbr>Options</a></div><div class="desc docblock-short">Options for modifying the behavior of <a href="fn.wait.html" title="fn rustix::process::wait"><code>wait</code></a>/<a href="fn.waitpid.html" title="fn rustix::process::waitpid"><code>waitpid</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.WaitStatus.html" title="struct rustix::process::WaitStatus">Wait<wbr>Status</a></div><div class="desc docblock-short">The status of a child process after calling <a href="fn.wait.html" title="fn rustix::process::wait"><code>wait</code></a>/<a href="fn.waitpid.html" title="fn rustix::process::waitpid"><code>waitpid</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.WaitidOptions.html" title="struct rustix::process::WaitidOptions">Waitid<wbr>Options</a></div><div class="desc docblock-short">Options for modifying the behavior of <a href="fn.waitid.html" title="fn rustix::process::waitid"><code>waitid</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.WaitidStatus.html" title="struct rustix::process::WaitidStatus">Waitid<wbr>Status</a></div><div class="desc docblock-short">The status of a process after calling <a href="fn.waitid.html" title="fn rustix::process::waitid"><code>waitid</code></a>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.DumpableBehavior.html" title="enum rustix::process::DumpableBehavior">Dumpable<wbr>Behavior</a></div><div class="desc docblock-short"><code>SUID_DUMP_*</code> values for use with <a href="fn.dumpable_behavior.html" title="fn rustix::process::dumpable_behavior"><code>dumpable_behavior</code></a> and
<a href="fn.set_dumpable_behavior.html" title="fn rustix::process::set_dumpable_behavior"><code>set_dumpable_behavior</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.EndianMode.html" title="enum rustix::process::EndianMode">Endian<wbr>Mode</a></div><div class="desc docblock-short"><code>PR_ENDIAN_*</code> values for use with <a href="fn.endian_mode.html" title="fn rustix::process::endian_mode"><code>endian_mode</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.FloatingPointMode.html" title="enum rustix::process::FloatingPointMode">Floating<wbr>Point<wbr>Mode</a></div><div class="desc docblock-short"><code>PR_FP_MODE_*</code> values for use with <a href="fn.floating_point_mode.html" title="fn rustix::process::floating_point_mode"><code>floating_point_mode</code></a> and
<a href="fn.set_floating_point_mode.html" title="fn rustix::process::set_floating_point_mode"><code>set_floating_point_mode</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.MachineCheckMemoryCorruptionKillPolicy.html" title="enum rustix::process::MachineCheckMemoryCorruptionKillPolicy">Machine<wbr>Check<wbr>Memory<wbr>Corruption<wbr>Kill<wbr>Policy</a></div><div class="desc docblock-short"><code>PR_MCE_KILL_*</code> values for use with
<a href="fn.machine_check_memory_corruption_kill_policy.html" title="fn rustix::process::machine_check_memory_corruption_kill_policy"><code>machine_check_memory_corruption_kill_policy</code></a> and
<a href="fn.set_machine_check_memory_corruption_kill_policy.html" title="fn rustix::process::set_machine_check_memory_corruption_kill_policy"><code>set_machine_check_memory_corruption_kill_policy</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.MembarrierCommand.html" title="enum rustix::process::MembarrierCommand">Membarrier<wbr>Command</a></div><div class="desc docblock-short">A command for use with <a href="fn.membarrier.html" title="fn rustix::process::membarrier"><code>membarrier</code></a> and <a href="fn.membarrier_cpu.html" title="fn rustix::process::membarrier_cpu"><code>membarrier_cpu</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.PTracer.html" title="enum rustix::process::PTracer">PTracer</a></div><div class="desc docblock-short">Process ptracer.</div></li><li><div class="item-name"><a class="enum" href="enum.Resource.html" title="enum rustix::process::Resource">Resource</a></div><div class="desc docblock-short">A resource value for use with <a href="fn.getrlimit.html" title="fn rustix::process::getrlimit"><code>getrlimit</code></a>, <a href="fn.setrlimit.html" title="fn rustix::process::setrlimit"><code>setrlimit</code></a>, and
<a href="fn.prlimit.html" title="fn rustix::process::prlimit"><code>prlimit</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.Signal.html" title="enum rustix::process::Signal">Signal</a></div><div class="desc docblock-short">A signal number for use with <a href="fn.kill_process.html" title="fn rustix::process::kill_process"><code>kill_process</code></a>, <a href="fn.kill_process_group.html" title="fn rustix::process::kill_process_group"><code>kill_process_group</code></a>, and
<a href="fn.kill_current_process_group.html" title="fn rustix::process::kill_current_process_group"><code>kill_current_process_group</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.SpeculationFeature.html" title="enum rustix::process::SpeculationFeature">Speculation<wbr>Feature</a></div><div class="desc docblock-short"><code>PR_SPEC_*</code> values for use with <a href="fn.speculative_feature_state.html" title="fn rustix::process::speculative_feature_state"><code>speculative_feature_state</code></a> and
<a href="fn.control_speculative_feature.html" title="fn rustix::process::control_speculative_feature"><code>control_speculative_feature</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.TimeStampCounterReadability.html" title="enum rustix::process::TimeStampCounterReadability">Time<wbr>Stamp<wbr>Counter<wbr>Readability</a></div><div class="desc docblock-short"><code>PR_TSC_*</code> values for use with <a href="fn.time_stamp_counter_readability.html" title="fn rustix::process::time_stamp_counter_readability"><code>time_stamp_counter_readability</code></a> and
<a href="fn.set_time_stamp_counter_readability.html" title="fn rustix::process::set_time_stamp_counter_readability"><code>set_time_stamp_counter_readability</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.TimingMethod.html" title="enum rustix::process::TimingMethod">Timing<wbr>Method</a></div><div class="desc docblock-short"><code>PR_TIMING_*</code> values for use with <a href="fn.timing_method.html" title="fn rustix::process::timing_method"><code>timing_method</code></a> and
<a href="fn.set_timing_method.html" title="fn rustix::process::set_timing_method"><code>set_timing_method</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.VirtualMemoryMapAddress.html" title="enum rustix::process::VirtualMemoryMapAddress">Virtual<wbr>Memory<wbr>MapAddress</a></div><div class="desc docblock-short"><code>PR_SET_MM_*</code> values for use with <a href="fn.set_virtual_memory_map_address.html" title="fn rustix::process::set_virtual_memory_map_address"><code>set_virtual_memory_map_address</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.WaitId.html" title="enum rustix::process::WaitId">WaitId</a></div><div class="desc docblock-short">The identifier to wait on in a call to <a href="fn.waitid.html" title="fn rustix::process::waitid"><code>waitid</code></a>.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.EXIT_FAILURE.html" title="constant rustix::process::EXIT_FAILURE">EXIT_<wbr>FAILURE</a></div><div class="desc docblock-short"><code>EXIT_FAILURE</code> for use with <a href="https://doc.rust-lang.org/1.84.0/std/process/fn.exit.html" title="fn std::process::exit"><code>exit</code></a>.</div></li><li><div class="item-name"><a class="constant" href="constant.EXIT_SIGNALED_SIGABRT.html" title="constant rustix::process::EXIT_SIGNALED_SIGABRT">EXIT_<wbr>SIGNALED_<wbr>SIGABRT</a></div><div class="desc docblock-short">The exit status used by a process terminated with a <a href="enum.Signal.html#variant.Abort" title="variant rustix::process::Signal::Abort"><code>Signal::Abort</code></a>
signal.</div></li><li><div class="item-name"><a class="constant" href="constant.EXIT_SUCCESS.html" title="constant rustix::process::EXIT_SUCCESS">EXIT_<wbr>SUCCESS</a></div><div class="desc docblock-short"><code>EXIT_SUCCESS</code> for use with <a href="https://doc.rust-lang.org/1.84.0/std/process/fn.exit.html" title="fn std::process::exit"><code>exit</code></a>.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.chdir.html" title="fn rustix::process::chdir">chdir</a></div><div class="desc docblock-short"><code>chdir(path)</code>—Change the current working directory.</div></li><li><div class="item-name"><a class="fn" href="fn.child_subreaper.html" title="fn rustix::process::child_subreaper">child_<wbr>subreaper</a></div><div class="desc docblock-short">Get the <code>child subreaper</code> setting of the calling process.</div></li><li><div class="item-name"><a class="fn" href="fn.chroot.html" title="fn rustix::process::chroot">chroot</a></div><div class="desc docblock-short"><code>chroot(path)</code>—Change the process root directory.</div></li><li><div class="item-name"><a class="fn" href="fn.configure_io_flusher_behavior.html" title="fn rustix::process::configure_io_flusher_behavior">configure_<wbr>io_<wbr>flusher_<wbr>behavior</a></div><div class="desc docblock-short">Put the process in the <code>IO_FLUSHER</code> state, allowing it to make progress
when allocating memory.</div></li><li><div class="item-name"><a class="fn" href="fn.configure_performance_counters.html" title="fn rustix::process::configure_performance_counters">configure_<wbr>performance_<wbr>counters</a></div><div class="desc docblock-short">Enable or disable all performance counters attached to the calling process.</div></li><li><div class="item-name"><a class="fn" href="fn.configure_pointer_authentication_keys.html" title="fn rustix::process::configure_pointer_authentication_keys">configure_<wbr>pointer_<wbr>authentication_<wbr>keys</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set enabled pointer authentication keys.</div></li><li><div class="item-name"><a class="fn" href="fn.configure_virtual_memory_map.html" title="fn rustix::process::configure_virtual_memory_map">configure_<wbr>virtual_<wbr>memory_<wbr>map</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Provides one-shot access to all the addresses by passing in a
<a href="struct.PrctlMmMap.html" title="struct rustix::process::PrctlMmMap"><code>PrctlMmMap</code></a>.</div></li><li><div class="item-name"><a class="fn" href="fn.control_speculative_feature.html" title="fn rustix::process::control_speculative_feature">control_<wbr>speculative_<wbr>feature</a></div><div class="desc docblock-short">Sets the state of the speculation misfeature.</div></li><li><div class="item-name"><a class="fn" href="fn.dumpable_behavior.html" title="fn rustix::process::dumpable_behavior">dumpable_<wbr>behavior</a></div><div class="desc docblock-short">Get the current state of the calling process’ <code>dumpable</code> attribute.</div></li><li><div class="item-name"><a class="fn" href="fn.enabled_pointer_authentication_keys.html" title="fn rustix::process::enabled_pointer_authentication_keys">enabled_<wbr>pointer_<wbr>authentication_<wbr>keys</a></div><div class="desc docblock-short">Get enabled pointer authentication keys.</div></li><li><div class="item-name"><a class="fn" href="fn.endian_mode.html" title="fn rustix::process::endian_mode">endian_<wbr>mode</a></div><div class="desc docblock-short">Get the endianness of the calling process.</div></li><li><div class="item-name"><a class="fn" href="fn.fchdir.html" title="fn rustix::process::fchdir">fchdir</a></div><div class="desc docblock-short"><code>fchdir(fd)</code>—Change the current working directory.</div></li><li><div class="item-name"><a class="fn" href="fn.floating_point_emulation_control.html" title="fn rustix::process::floating_point_emulation_control">floating_<wbr>point_<wbr>emulation_<wbr>control</a></div><div class="desc docblock-short">Get floating point emulation control bits.</div></li><li><div class="item-name"><a class="fn" href="fn.floating_point_exception_mode.html" title="fn rustix::process::floating_point_exception_mode">floating_<wbr>point_<wbr>exception_<wbr>mode</a></div><div class="desc docblock-short">Get floating point exception mode.</div></li><li><div class="item-name"><a class="fn" href="fn.floating_point_mode.html" title="fn rustix::process::floating_point_mode">floating_<wbr>point_<wbr>mode</a></div><div class="desc docblock-short">Get the current floating point mode.</div></li><li><div class="item-name"><a class="fn" href="fn.getcwd.html" title="fn rustix::process::getcwd">getcwd</a></div><div class="desc docblock-short"><code>getCWD</code>—Return the current working directory.</div></li><li><div class="item-name"><a class="fn" href="fn.getegid.html" title="fn rustix::process::getegid">getegid</a></div><div class="desc docblock-short"><code>getegid()</code>—Returns the process’ effective group ID.</div></li><li><div class="item-name"><a class="fn" href="fn.geteuid.html" title="fn rustix::process::geteuid">geteuid</a></div><div class="desc docblock-short"><code>geteuid()</code>—Returns the process’ effective user ID.</div></li><li><div class="item-name"><a class="fn" href="fn.getgid.html" title="fn rustix::process::getgid">getgid</a></div><div class="desc docblock-short"><code>getgid()</code>—Returns the process’ real group ID.</div></li><li><div class="item-name"><a class="fn" href="fn.getgroups.html" title="fn rustix::process::getgroups">getgroups</a></div><div class="desc docblock-short"><code>getgroups()</code>—Return a list of the current user’s groups.</div></li><li><div class="item-name"><a class="fn" href="fn.getpgid.html" title="fn rustix::process::getpgid">getpgid</a></div><div class="desc docblock-short"><code>getpgid(pid)</code>—Returns the process group ID of the given process.</div></li><li><div class="item-name"><a class="fn" href="fn.getpgrp.html" title="fn rustix::process::getpgrp">getpgrp</a></div><div class="desc docblock-short"><code>getpgrp()</code>—Returns the process’ group ID.</div></li><li><div class="item-name"><a class="fn" href="fn.getpid.html" title="fn rustix::process::getpid">getpid</a></div><div class="desc docblock-short"><code>getpid()</code>—Returns the process’ ID.</div></li><li><div class="item-name"><a class="fn" href="fn.getppid.html" title="fn rustix::process::getppid">getppid</a></div><div class="desc docblock-short"><code>getppid()</code>—Returns the parent process’ ID.</div></li><li><div class="item-name"><a class="fn" href="fn.getpriority_pgrp.html" title="fn rustix::process::getpriority_pgrp">getpriority_<wbr>pgrp</a></div><div class="desc docblock-short"><code>getpriority(PRIO_PGRP, gid)</code>—Get the scheduling priority of the given
process group.</div></li><li><div class="item-name"><a class="fn" href="fn.getpriority_process.html" title="fn rustix::process::getpriority_process">getpriority_<wbr>process</a></div><div class="desc docblock-short"><code>getpriority(PRIO_PROCESS, pid)</code>—Get the scheduling priority of the given
process.</div></li><li><div class="item-name"><a class="fn" href="fn.getpriority_user.html" title="fn rustix::process::getpriority_user">getpriority_<wbr>user</a></div><div class="desc docblock-short"><code>getpriority(PRIO_USER, uid)</code>—Get the scheduling priority of the given
user.</div></li><li><div class="item-name"><a class="fn" href="fn.getrlimit.html" title="fn rustix::process::getrlimit">getrlimit</a></div><div class="desc docblock-short"><code>getrlimit(resource)</code>—Get a process resource limit value.</div></li><li><div class="item-name"><a class="fn" href="fn.getsid.html" title="fn rustix::process::getsid">getsid</a></div><div class="desc docblock-short"><code>getsid(pid)</code>—Get the session ID of the given process.</div></li><li><div class="item-name"><a class="fn" href="fn.getuid.html" title="fn rustix::process::getuid">getuid</a></div><div class="desc docblock-short"><code>getuid()</code>—Returns the process’ real user ID.</div></li><li><div class="item-name"><a class="fn" href="fn.ioctl_tiocsctty.html" title="fn rustix::process::ioctl_tiocsctty">ioctl_<wbr>tiocsctty</a></div><div class="desc docblock-short"><code>ioctl(fd, TIOCSCTTY, 0)</code>—Sets the controlling terminal for the process.</div></li><li><div class="item-name"><a class="fn" href="fn.is_io_flusher.html" title="fn rustix::process::is_io_flusher">is_<wbr>io_<wbr>flusher</a></div><div class="desc docblock-short">Get the <code>IO_FLUSHER</code> state of the caller.</div></li><li><div class="item-name"><a class="fn" href="fn.kill_current_process_group.html" title="fn rustix::process::kill_current_process_group">kill_<wbr>current_<wbr>process_<wbr>group</a></div><div class="desc docblock-short"><code>kill(0, sig)</code>—Sends a signal to all processes in the current process
group.</div></li><li><div class="item-name"><a class="fn" href="fn.kill_process.html" title="fn rustix::process::kill_process">kill_<wbr>process</a></div><div class="desc docblock-short"><code>kill(pid, sig)</code>—Sends a signal to a process.</div></li><li><div class="item-name"><a class="fn" href="fn.kill_process_group.html" title="fn rustix::process::kill_process_group">kill_<wbr>process_<wbr>group</a></div><div class="desc docblock-short"><code>kill(-pid, sig)</code>—Sends a signal to all processes in a process group.</div></li><li><div class="item-name"><a class="fn" href="fn.machine_check_memory_corruption_kill_policy.html" title="fn rustix::process::machine_check_memory_corruption_kill_policy">machine_<wbr>check_<wbr>memory_<wbr>corruption_<wbr>kill_<wbr>policy</a></div><div class="desc docblock-short">Get the current per-process machine check kill policy.</div></li><li><div class="item-name"><a class="fn" href="fn.membarrier.html" title="fn rustix::process::membarrier">membarrier</a></div><div class="desc docblock-short"><code>membarrier(cmd, 0, 0)</code>—Perform a memory barrier.</div></li><li><div class="item-name"><a class="fn" href="fn.membarrier_cpu.html" title="fn rustix::process::membarrier_cpu">membarrier_<wbr>cpu</a></div><div class="desc docblock-short"><code>membarrier(cmd, MEMBARRIER_CMD_FLAG_CPU, cpu)</code>—Perform a memory barrier
with a specific CPU.</div></li><li><div class="item-name"><a class="fn" href="fn.membarrier_query.html" title="fn rustix::process::membarrier_query">membarrier_<wbr>query</a></div><div class="desc docblock-short"><code>membarrier(MEMBARRIER_CMD_QUERY, 0, 0)</code>—Query the supported <code>membarrier</code>
commands.</div></li><li><div class="item-name"><a class="fn" href="fn.nice.html" title="fn rustix::process::nice">nice</a></div><div class="desc docblock-short"><code>nice(inc)</code>—Adjust the scheduling priority of the current process.</div></li><li><div class="item-name"><a class="fn" href="fn.parent_process_death_signal.html" title="fn rustix::process::parent_process_death_signal">parent_<wbr>process_<wbr>death_<wbr>signal</a></div><div class="desc docblock-short">Get the current value of the parent process death signal.</div></li><li><div class="item-name"><a class="fn" href="fn.pidfd_getfd.html" title="fn rustix::process::pidfd_getfd">pidfd_<wbr>getfd</a></div><div class="desc docblock-short"><code>syscall(SYS_pidfd_getfd, pidfd, flags)</code>—Obtain a duplicate of another
process’ file descriptor.</div></li><li><div class="item-name"><a class="fn" href="fn.pidfd_open.html" title="fn rustix::process::pidfd_open">pidfd_<wbr>open</a></div><div class="desc docblock-short"><code>syscall(SYS_pidfd_open, pid, flags)</code>—Creates a file descriptor for a
process.</div></li><li><div class="item-name"><a class="fn" href="fn.pidfd_send_signal.html" title="fn rustix::process::pidfd_send_signal">pidfd_<wbr>send_<wbr>signal</a></div><div class="desc docblock-short"><code>syscall(SYS_pidfd_send_signal, pidfd, sig, NULL, 0)</code>—Send a signal to a
process specified by a file descriptor.</div></li><li><div class="item-name"><a class="fn" href="fn.pivot_root.html" title="fn rustix::process::pivot_root">pivot_<wbr>root</a></div><div class="desc docblock-short"><code>pivot_root(new_root, put_old)</code>—Change the root mount.</div></li><li><div class="item-name"><a class="fn" href="fn.prlimit.html" title="fn rustix::process::prlimit">prlimit</a></div><div class="desc docblock-short"><code>prlimit(pid, resource, new)</code>—Get and set a process resource limit value.</div></li><li><div class="item-name"><a class="fn" href="fn.sched_getaffinity.html" title="fn rustix::process::sched_getaffinity">sched_<wbr>getaffinity</a></div><div class="desc docblock-short"><code>sched_getaffinity(pid)</code>—Get a thread’s CPU affinity mask.</div></li><li><div class="item-name"><a class="fn" href="fn.sched_getcpu.html" title="fn rustix::process::sched_getcpu">sched_<wbr>getcpu</a></div><div class="desc docblock-short"><code>sched_getcpu()</code>—Get the CPU that the current thread is currently on.</div></li><li><div class="item-name"><a class="fn" href="fn.sched_setaffinity.html" title="fn rustix::process::sched_setaffinity">sched_<wbr>setaffinity</a></div><div class="desc docblock-short"><code>sched_setaffinity(pid, cpuset)</code>—Set a thread’s CPU affinity mask.</div></li><li><div class="item-name"><a class="fn" href="fn.sched_yield.html" title="fn rustix::process::sched_yield">sched_<wbr>yield</a></div><div class="desc docblock-short"><code>sched_yield()</code>—Hints to the OS that other processes should run.</div></li><li><div class="item-name"><a class="fn" href="fn.set_auxiliary_vector.html" title="fn rustix::process::set_auxiliary_vector">set_<wbr>auxiliary_<wbr>vector</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set a new auxiliary vector.</div></li><li><div class="item-name"><a class="fn" href="fn.set_child_subreaper.html" title="fn rustix::process::set_child_subreaper">set_<wbr>child_<wbr>subreaper</a></div><div class="desc docblock-short">Set the <code>child subreaper</code> attribute of the calling process.</div></li><li><div class="item-name"><a class="fn" href="fn.set_dumpable_behavior.html" title="fn rustix::process::set_dumpable_behavior">set_<wbr>dumpable_<wbr>behavior</a></div><div class="desc docblock-short">Set the state of the <code>dumpable</code> attribute.</div></li><li><div class="item-name"><a class="fn" href="fn.set_endian_mode.html" title="fn rustix::process::set_endian_mode">set_<wbr>endian_<wbr>mode</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Set the endianness of the calling process.</div></li><li><div class="item-name"><a class="fn" href="fn.set_executable_file.html" title="fn rustix::process::set_executable_file">set_<wbr>executable_<wbr>file</a></div><div class="desc docblock-short">Supersede the <code>/proc/pid/exe</code> symbolic link with a new one pointing to a
new executable file.</div></li><li><div class="item-name"><a class="fn" href="fn.set_floating_point_emulation_control.html" title="fn rustix::process::set_floating_point_emulation_control">set_<wbr>floating_<wbr>point_<wbr>emulation_<wbr>control</a></div><div class="desc docblock-short">Set floating point emulation control bits.</div></li><li><div class="item-name"><a class="fn" href="fn.set_floating_point_exception_mode.html" title="fn rustix::process::set_floating_point_exception_mode">set_<wbr>floating_<wbr>point_<wbr>exception_<wbr>mode</a></div><div class="desc docblock-short">Set floating point exception mode.</div></li><li><div class="item-name"><a class="fn" href="fn.set_floating_point_mode.html" title="fn rustix::process::set_floating_point_mode">set_<wbr>floating_<wbr>point_<wbr>mode</a></div><div class="desc docblock-short">Allow control of the floating point mode from user space.</div></li><li><div class="item-name"><a class="fn" href="fn.set_machine_check_memory_corruption_kill_policy.html" title="fn rustix::process::set_machine_check_memory_corruption_kill_policy">set_<wbr>machine_<wbr>check_<wbr>memory_<wbr>corruption_<wbr>kill_<wbr>policy</a></div><div class="desc docblock-short">Set the machine check memory corruption kill policy for the calling thread.</div></li><li><div class="item-name"><a class="fn" href="fn.set_parent_process_death_signal.html" title="fn rustix::process::set_parent_process_death_signal">set_<wbr>parent_<wbr>process_<wbr>death_<wbr>signal</a></div><div class="desc docblock-short">Set the parent-death signal of the calling process.</div></li><li><div class="item-name"><a class="fn" href="fn.set_ptracer.html" title="fn rustix::process::set_ptracer">set_<wbr>ptracer</a></div><div class="desc docblock-short">Declare that the ptracer process can <code>ptrace</code> the calling process as if it
were a direct process ancestor.</div></li><li><div class="item-name"><a class="fn" href="fn.set_time_stamp_counter_readability.html" title="fn rustix::process::set_time_stamp_counter_readability">set_<wbr>time_<wbr>stamp_<wbr>counter_<wbr>readability</a></div><div class="desc docblock-short">Set the state of the flag determining if the timestamp counter can be read
by the process.</div></li><li><div class="item-name"><a class="fn" href="fn.set_timing_method.html" title="fn rustix::process::set_timing_method">set_<wbr>timing_<wbr>method</a></div><div class="desc docblock-short">Set whether to use (normal, traditional) statistical process timing or
accurate timestamp-based process timing.</div></li><li><div class="item-name"><a class="fn" href="fn.set_unaligned_access_control.html" title="fn rustix::process::set_unaligned_access_control">set_<wbr>unaligned_<wbr>access_<wbr>control</a></div><div class="desc docblock-short">Set unaligned access control bits.</div></li><li><div class="item-name"><a class="fn" href="fn.set_virtual_memory_map_address.html" title="fn rustix::process::set_virtual_memory_map_address">set_<wbr>virtual_<wbr>memory_<wbr>map_<wbr>address</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Modify certain kernel memory map descriptor addresses of the calling
process.</div></li><li><div class="item-name"><a class="fn" href="fn.set_virtual_memory_region_name.html" title="fn rustix::process::set_virtual_memory_region_name">set_<wbr>virtual_<wbr>memory_<wbr>region_<wbr>name</a></div><div class="desc docblock-short">Set the name for a virtual memory region.</div></li><li><div class="item-name"><a class="fn" href="fn.setpgid.html" title="fn rustix::process::setpgid">setpgid</a></div><div class="desc docblock-short"><code>setpgid(pid, pgid)</code>—Sets the process group ID of the given process.</div></li><li><div class="item-name"><a class="fn" href="fn.setpriority_pgrp.html" title="fn rustix::process::setpriority_pgrp">setpriority_<wbr>pgrp</a></div><div class="desc docblock-short"><code>setpriority(PRIO_PGRP, pgid)</code>—Get the scheduling priority of the given
process group.</div></li><li><div class="item-name"><a class="fn" href="fn.setpriority_process.html" title="fn rustix::process::setpriority_process">setpriority_<wbr>process</a></div><div class="desc docblock-short"><code>setpriority(PRIO_PROCESS, pid)</code>—Get the scheduling priority of the given
process.</div></li><li><div class="item-name"><a class="fn" href="fn.setpriority_user.html" title="fn rustix::process::setpriority_user">setpriority_<wbr>user</a></div><div class="desc docblock-short"><code>setpriority(PRIO_USER, uid)</code>—Get the scheduling priority of the given
user.</div></li><li><div class="item-name"><a class="fn" href="fn.setrlimit.html" title="fn rustix::process::setrlimit">setrlimit</a></div><div class="desc docblock-short"><code>setrlimit(resource, new)</code>—Set a process resource limit value.</div></li><li><div class="item-name"><a class="fn" href="fn.setsid.html" title="fn rustix::process::setsid">setsid</a></div><div class="desc docblock-short"><code>setsid()</code>—Create a new session.</div></li><li><div class="item-name"><a class="fn" href="fn.speculative_feature_state.html" title="fn rustix::process::speculative_feature_state">speculative_<wbr>feature_<wbr>state</a></div><div class="desc docblock-short">Get the state of the speculation misfeature.</div></li><li><div class="item-name"><a class="fn" href="fn.test_kill_current_process_group.html" title="fn rustix::process::test_kill_current_process_group">test_<wbr>kill_<wbr>current_<wbr>process_<wbr>group</a></div><div class="desc docblock-short"><code>kill(0, 0)</code>—Check validity of pid and permissions to send signals to the
all processes in the current process group, without actually sending any
signals.</div></li><li><div class="item-name"><a class="fn" href="fn.test_kill_process.html" title="fn rustix::process::test_kill_process">test_<wbr>kill_<wbr>process</a></div><div class="desc docblock-short"><code>kill(pid, 0)</code>—Check validity of pid and permissions to send signals to
the process, without actually sending any signals.</div></li><li><div class="item-name"><a class="fn" href="fn.test_kill_process_group.html" title="fn rustix::process::test_kill_process_group">test_<wbr>kill_<wbr>process_<wbr>group</a></div><div class="desc docblock-short"><code>kill(-pid, 0)</code>—Check validity of pid and permissions to send signals to
all processes in the process group, without actually sending any signals.</div></li><li><div class="item-name"><a class="fn" href="fn.time_stamp_counter_readability.html" title="fn rustix::process::time_stamp_counter_readability">time_<wbr>stamp_<wbr>counter_<wbr>readability</a></div><div class="desc docblock-short">Get the state of the flag determining if the timestamp counter can be read.</div></li><li><div class="item-name"><a class="fn" href="fn.timing_method.html" title="fn rustix::process::timing_method">timing_<wbr>method</a></div><div class="desc docblock-short">Get which process timing method is currently in use.</div></li><li><div class="item-name"><a class="fn" href="fn.umask.html" title="fn rustix::process::umask">umask</a></div><div class="desc docblock-short"><code>umask(mask)</code>—Set the process file creation mask.</div></li><li><div class="item-name"><a class="fn" href="fn.unaligned_access_control.html" title="fn rustix::process::unaligned_access_control">unaligned_<wbr>access_<wbr>control</a></div><div class="desc docblock-short">Get unaligned access control bits.</div></li><li><div class="item-name"><a class="fn" href="fn.virtual_memory_map_config_struct_size.html" title="fn rustix::process::virtual_memory_map_config_struct_size">virtual_<wbr>memory_<wbr>map_<wbr>config_<wbr>struct_<wbr>size</a></div><div class="desc docblock-short">Get the size of the <a href="struct.PrctlMmMap.html" title="struct rustix::process::PrctlMmMap"><code>PrctlMmMap</code></a> the kernel expects.</div></li><li><div class="item-name"><a class="fn" href="fn.wait.html" title="fn rustix::process::wait">wait</a></div><div class="desc docblock-short"><code>wait(waitopts)</code>—Wait for any of the children of calling process to
change state.</div></li><li><div class="item-name"><a class="fn" href="fn.waitid.html" title="fn rustix::process::waitid">waitid</a></div><div class="desc docblock-short"><code>waitid(_, _, _, opts)</code>—Wait for the specified child process to change
state.</div></li><li><div class="item-name"><a class="fn" href="fn.waitpgid.html" title="fn rustix::process::waitpgid">waitpgid</a></div><div class="desc docblock-short"><code>waitpid(-pgid, waitopts)</code>—Wait for a process in a specific process group
to change state.</div></li><li><div class="item-name"><a class="fn" href="fn.waitpid.html" title="fn rustix::process::waitpid">waitpid</a></div><div class="desc docblock-short"><code>waitpid(pid, waitopts)</code>—Wait for a specific process to change state.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.ForeignRawFd.html" title="type rustix::process::ForeignRawFd">Foreign<wbr>RawFd</a></div><div class="desc docblock-short">Raw file descriptor in another process.</div></li><li><div class="item-name"><a class="type" href="type.RawGid.html" title="type rustix::process::RawGid">RawGid</a></div><div class="desc docblock-short">A group identifier as a raw integer.</div></li><li><div class="item-name"><a class="type" href="type.RawPid.html" title="type rustix::process::RawPid">RawPid</a></div><div class="desc docblock-short">A process identifier as a raw integer.</div></li><li><div class="item-name"><a class="type" href="type.RawUid.html" title="type rustix::process::RawUid">RawUid</a></div><div class="desc docblock-short">A user identifier as a raw integer.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink