Skip to content

Commit 05768aa

Browse files
PaulDancetgross35
authored andcommitted
Docs(linux): Add docs for PF_* constants
Taken from <https://github.com/torvalds/linux/blob/2ba9f676d0a2e408aef14d679984c26373bf37b7/include/linux/sched.h#L1661\>. Signed-off-by: Paul Mabileau <paul.mabileau@harfanglab.fr> (backport <#4174>) (cherry picked from commit 9a38ea3)
1 parent 0e89233 commit 05768aa

File tree

1 file changed

+36
-0
lines changed
  • src/unix/linux_like/linux

1 file changed

+36
-0
lines changed

src/unix/linux_like/linux/mod.rs

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5631,32 +5631,68 @@ pub const NET_DCCP: c_int = 20;
56315631
pub const NET_IRDA: c_int = 412;
56325632

56335633
// include/linux/sched.h
5634+
/// I'm a virtual CPU.
56345635
pub const PF_VCPU: c_int = 0x00000001;
5636+
/// I am an IDLE thread.
56355637
pub const PF_IDLE: c_int = 0x00000002;
5638+
/// Getting shut down.
56365639
pub const PF_EXITING: c_int = 0x00000004;
5640+
/// Coredumps should ignore this task.
56375641
pub const PF_POSTCOREDUMP: c_int = 0x00000008;
5642+
/// Task is an IO worker.
56385643
pub const PF_IO_WORKER: c_int = 0x00000010;
5644+
/// I'm a workqueue worker.
56395645
pub const PF_WQ_WORKER: c_int = 0x00000020;
5646+
/// Forked but didn't exec.
56405647
pub const PF_FORKNOEXEC: c_int = 0x00000040;
5648+
/// Process policy on mce errors.
56415649
pub const PF_MCE_PROCESS: c_int = 0x00000080;
5650+
/// Used super-user privileges.
56425651
pub const PF_SUPERPRIV: c_int = 0x00000100;
5652+
/// Dumped core.
56435653
pub const PF_DUMPCORE: c_int = 0x00000200;
5654+
/// Killed by a signal.
56445655
pub const PF_SIGNALED: c_int = 0x00000400;
5656+
/// Allocating memory to free memory.
5657+
///
5658+
/// See `memalloc_noreclaim_save()`.
56455659
pub const PF_MEMALLOC: c_int = 0x00000800;
5660+
/// `set_user()` noticed that `RLIMIT_NPROC` was exceeded.
56465661
pub const PF_NPROC_EXCEEDED: c_int = 0x00001000;
5662+
/// If unset the fpu must be initialized before use.
56475663
pub const PF_USED_MATH: c_int = 0x00002000;
5664+
/// Kernel thread cloned from userspace thread.
56485665
pub const PF_USER_WORKER: c_int = 0x00004000;
5666+
/// This thread should not be frozen.
56495667
pub const PF_NOFREEZE: c_int = 0x00008000;
5668+
/// I am `kswapd`.
56505669
pub const PF_KSWAPD: c_int = 0x00020000;
5670+
/// All allocations inherit `GFP_NOFS`.
5671+
///
5672+
/// See `memalloc_nfs_save()`.
56515673
pub const PF_MEMALLOC_NOFS: c_int = 0x00040000;
5674+
/// All allocations inherit `GFP_NOIO`.
5675+
///
5676+
/// See `memalloc_noio_save()`.
56525677
pub const PF_MEMALLOC_NOIO: c_int = 0x00080000;
5678+
/// Throttle writes only against the bdi I write to, I am cleaning
5679+
/// dirty pages from some other bdi.
56535680
pub const PF_LOCAL_THROTTLE: c_int = 0x00100000;
5681+
/// I am a kernel thread.
56545682
pub const PF_KTHREAD: c_int = 0x00200000;
5683+
/// Randomize virtual address space.
56555684
pub const PF_RANDOMIZE: c_int = 0x00400000;
5685+
/// Userland is not allowed to meddle with `cpus_mask`.
56565686
pub const PF_NO_SETAFFINITY: c_int = 0x04000000;
5687+
/// Early kill for mce process policy.
56575688
pub const PF_MCE_EARLY: c_int = 0x08000000;
5689+
/// Allocations constrained to zones which allow long term pinning.
5690+
///
5691+
/// See `memalloc_pin_save()`.
56585692
pub const PF_MEMALLOC_PIN: c_int = 0x10000000;
5693+
/// Plug has ts that needs updating.
56595694
pub const PF_BLOCK_TS: c_int = 0x20000000;
5695+
/// This thread called `freeze_processes()` and should not be frozen.
56605696
pub const PF_SUSPEND_TASK: c_int = PF_SUSPEND_TASK_UINT as _;
56615697
// The used value is the highest possible bit fitting on 32 bits, so directly
56625698
// defining it as a signed integer causes the compiler to report an overflow.

0 commit comments

Comments
 (0)