Skip to content

Commit 9a38ea3

Browse files
committed
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>
1 parent 6934e52 commit 9a38ea3

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
@@ -5668,32 +5668,68 @@ pub const NET_DCCP: c_int = 20;
56685668
pub const NET_IRDA: c_int = 412;
56695669

56705670
// include/linux/sched.h
5671+
/// I'm a virtual CPU.
56715672
pub const PF_VCPU: c_int = 0x00000001;
5673+
/// I am an IDLE thread.
56725674
pub const PF_IDLE: c_int = 0x00000002;
5675+
/// Getting shut down.
56735676
pub const PF_EXITING: c_int = 0x00000004;
5677+
/// Coredumps should ignore this task.
56745678
pub const PF_POSTCOREDUMP: c_int = 0x00000008;
5679+
/// Task is an IO worker.
56755680
pub const PF_IO_WORKER: c_int = 0x00000010;
5681+
/// I'm a workqueue worker.
56765682
pub const PF_WQ_WORKER: c_int = 0x00000020;
5683+
/// Forked but didn't exec.
56775684
pub const PF_FORKNOEXEC: c_int = 0x00000040;
5685+
/// Process policy on mce errors.
56785686
pub const PF_MCE_PROCESS: c_int = 0x00000080;
5687+
/// Used super-user privileges.
56795688
pub const PF_SUPERPRIV: c_int = 0x00000100;
5689+
/// Dumped core.
56805690
pub const PF_DUMPCORE: c_int = 0x00000200;
5691+
/// Killed by a signal.
56815692
pub const PF_SIGNALED: c_int = 0x00000400;
5693+
/// Allocating memory to free memory.
5694+
///
5695+
/// See `memalloc_noreclaim_save()`.
56825696
pub const PF_MEMALLOC: c_int = 0x00000800;
5697+
/// `set_user()` noticed that `RLIMIT_NPROC` was exceeded.
56835698
pub const PF_NPROC_EXCEEDED: c_int = 0x00001000;
5699+
/// If unset the fpu must be initialized before use.
56845700
pub const PF_USED_MATH: c_int = 0x00002000;
5701+
/// Kernel thread cloned from userspace thread.
56855702
pub const PF_USER_WORKER: c_int = 0x00004000;
5703+
/// This thread should not be frozen.
56865704
pub const PF_NOFREEZE: c_int = 0x00008000;
5705+
/// I am `kswapd`.
56875706
pub const PF_KSWAPD: c_int = 0x00020000;
5707+
/// All allocations inherit `GFP_NOFS`.
5708+
///
5709+
/// See `memalloc_nfs_save()`.
56885710
pub const PF_MEMALLOC_NOFS: c_int = 0x00040000;
5711+
/// All allocations inherit `GFP_NOIO`.
5712+
///
5713+
/// See `memalloc_noio_save()`.
56895714
pub const PF_MEMALLOC_NOIO: c_int = 0x00080000;
5715+
/// Throttle writes only against the bdi I write to, I am cleaning
5716+
/// dirty pages from some other bdi.
56905717
pub const PF_LOCAL_THROTTLE: c_int = 0x00100000;
5718+
/// I am a kernel thread.
56915719
pub const PF_KTHREAD: c_int = 0x00200000;
5720+
/// Randomize virtual address space.
56925721
pub const PF_RANDOMIZE: c_int = 0x00400000;
5722+
/// Userland is not allowed to meddle with `cpus_mask`.
56935723
pub const PF_NO_SETAFFINITY: c_int = 0x04000000;
5724+
/// Early kill for mce process policy.
56945725
pub const PF_MCE_EARLY: c_int = 0x08000000;
5726+
/// Allocations constrained to zones which allow long term pinning.
5727+
///
5728+
/// See `memalloc_pin_save()`.
56955729
pub const PF_MEMALLOC_PIN: c_int = 0x10000000;
5730+
/// Plug has ts that needs updating.
56965731
pub const PF_BLOCK_TS: c_int = 0x20000000;
5732+
/// This thread called `freeze_processes()` and should not be frozen.
56975733
pub const PF_SUSPEND_TASK: c_int = PF_SUSPEND_TASK_UINT as _;
56985734
// The used value is the highest possible bit fitting on 32 bits, so directly
56995735
// defining it as a signed integer causes the compiler to report an overflow.

0 commit comments

Comments
 (0)