linux-support 0.0.25

Comprehensive Linux support for namespaces, cgroups, processes, scheduling, parsing /proc, parsing /sys, signals, hyper threads, CPUS, NUMA nodes, unusual file descriptors, PCI devices and much, much more
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

// This file is part of linux-support. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/linux-support/master/COPYRIGHT. No part of linux-support, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2020 The developers of linux-support. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/linux-support/master/COPYRIGHT.


/// Transparent Huge Pages Configuration.
///
/// Default implementation disables transparent huge pages entirely.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[derive(Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct GlobalTransparentHugePagesConfiguration
{
	#[allow(missing_docs)]
	#[serde(default)] pub defragmentation_choice: TransparentHugePageDefragmentationChoice,

	#[allow(missing_docs)]
	#[serde(default = "GlobalTransparentHugePagesConfiguration::defragmentation_pages_to_scan_default")] pub defragmentation_pages_to_scan: u16,

	#[allow(missing_docs)]
	#[serde(default = "GlobalTransparentHugePagesConfiguration::defragmentation_scan_sleep_in_milliseconds_default")] pub defragmentation_scan_sleep_in_milliseconds: usize,

	#[allow(missing_docs)]
	#[serde(default = "GlobalTransparentHugePagesConfiguration::defragmentation_allocation_sleep_in_milliseconds_default")] pub defragmentation_allocation_sleep_in_milliseconds: usize,

	#[allow(missing_docs)]
	#[serde(default = "GlobalTransparentHugePagesConfiguration::defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_allocated_when_collapsing_small_pages_default")] pub defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_allocated_when_collapsing_small_pages: u16,

	#[allow(missing_docs)]
	#[serde(default = "GlobalTransparentHugePagesConfiguration::defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_swapped_when_collapsing_small_pages_default")] pub defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_swapped_when_collapsing_small_pages: u16,

	#[allow(missing_docs)]
	#[serde(default)] pub regular_memory_choice: TransparentHugePageRegularMemoryChoice,

	#[allow(missing_docs)]
	#[serde(default)] pub shared_memory_choice: TransparentHugePageSharedMemoryChoice,

	#[allow(missing_docs)]
	#[serde(default = "GlobalTransparentHugePagesConfiguration::use_zero_page_default")] pub use_zero_page: bool,
}

impl Default for GlobalTransparentHugePagesConfiguration
{
	#[inline(always)]
	fn default() -> Self
	{
		Self
		{
			defragmentation_choice: TransparentHugePageDefragmentationChoice::Never,
			defragmentation_pages_to_scan: Self::defragmentation_pages_to_scan_default(),
			defragmentation_scan_sleep_in_milliseconds: Self::defragmentation_scan_sleep_in_milliseconds_default(),
			defragmentation_allocation_sleep_in_milliseconds: Self::defragmentation_allocation_sleep_in_milliseconds_default(),
			defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_allocated_when_collapsing_small_pages: Self::defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_allocated_when_collapsing_small_pages_default(),
			defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_swapped_when_collapsing_small_pages: Self::defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_swapped_when_collapsing_small_pages_default(),
			regular_memory_choice: TransparentHugePageRegularMemoryChoice::Never,
			shared_memory_choice: TransparentHugePageSharedMemoryChoice::Never,
			use_zero_page: Self::use_zero_page_default(),
		}
	}
}

impl GlobalTransparentHugePagesConfiguration
{
	/// Configure.
	#[inline(always)]
	pub fn configure(&self, sys_path: &SysPath) -> Result<(), GlobalTransparentHugePagesConfigurationError>
	{
		use self::GlobalTransparentHugePagesConfigurationError::*;

		TransparentHugePageDefragmentationChoice::Never.change_transparent_huge_pages_defragmentation(sys_path, self.defragmentation_pages_to_scan, self.defragmentation_scan_sleep_in_milliseconds, self.defragmentation_allocation_sleep_in_milliseconds, self.defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_allocated_when_collapsing_small_pages, self.defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_swapped_when_collapsing_small_pages).map_err(|io_error| Defragmentation(io_error))?;

		self.regular_memory_choice.change_transparent_huge_pages_usage(sys_path, self.shared_memory_choice, self.use_zero_page).map_err(|io_error| Usage(io_error))?;

		Ok(())
	}

	#[inline(always)]
	fn defragmentation_pages_to_scan_default() -> u16
	{
		4096
	}

	#[inline(always)]
	fn defragmentation_scan_sleep_in_milliseconds_default() -> usize
	{
		60_000
	}

	#[inline(always)]
	fn defragmentation_allocation_sleep_in_milliseconds_default() -> usize
	{
		10_000
	}

	#[inline(always)]
	fn defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_allocated_when_collapsing_small_pages_default() -> u16
	{
		511
	}

	#[inline(always)]
	fn defragmentation_how_many_extra_small_pages_not_already_mapped_can_be_swapped_when_collapsing_small_pages_default() -> u16
	{
		64
	}

	#[inline(always)]
	fn use_zero_page_default() -> bool
	{
		true
	}
}