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

// 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.


/// Global Linux command line configuration.
#[derive(Debug, Clone, Eq, PartialEq)]
#[derive(Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct GlobalLinuxKernelCommandLineConfiguration
{
	/// Check for incompatible settings.
	#[serde(default = "GlobalLinuxKernelCommandLineConfiguration::check_for_incompatible_settings_default")] pub check_for_incompatible_settings: bool,

	/// Check for incorrect huge page settings.
	#[serde(default = "GlobalLinuxKernelCommandLineConfiguration::check_for_huge_page_size_settings_default")] pub check_for_huge_page_size_settings: bool,

	/// Optional checks to suppress.
	#[serde(default = "GlobalLinuxKernelCommandLineConfiguration::optional_kernel_command_line_setting_check_to_suppress_default")] pub optional_kernel_command_line_setting_check_to_suppress: HashSet<OptionalKernelCommandLineSettingCheck>,
}

impl Default for GlobalLinuxKernelCommandLineConfiguration
{
	fn default() -> Self
	{
		Self
		{
			check_for_incompatible_settings: Self::check_for_incompatible_settings_default(),
			check_for_huge_page_size_settings: Self::check_for_huge_page_size_settings_default(),
			optional_kernel_command_line_setting_check_to_suppress: Self::optional_kernel_command_line_setting_check_to_suppress_default(),
		}
	}
}

impl GlobalLinuxKernelCommandLineConfiguration
{
	/// Configures.
	#[inline(always)]
	pub fn configure(&self, proc_path: &ProcPath) -> Result<(), GlobalLinuxKernelCommandLineConfigurationError>
	{
		use self::GlobalLinuxKernelCommandLineConfigurationError::*;

		let linux_kernel_command_line_parameters = LinuxKernelCommandLineParameters::parse(proc_path).map_err(|cause| CouldNotParseLinuxKernelCommandLineParameters(cause))?;

		if self.check_for_incompatible_settings
		{
			incompatible_settings(&linux_kernel_command_line_parameters).map_err(|reason| IncompatibleSettings(reason))?;
		}
		if self.check_for_huge_page_size_settings
		{
			validate_huge_page_sizes(&linux_kernel_command_line_parameters, cpu_supports_1gb_pages()).map_err(|reason| InvalidHugePageSizes(reason))?;
		}

		OptionalKernelCommandLineSettingCheck::run_all_checks(&self.optional_kernel_command_line_setting_check_to_suppress, &linux_kernel_command_line_parameters).map_err(|cause| OptionalLinuxKernelCommandLineSettingChecksFailed(cause))?;

		Ok(())
	}

	#[inline(always)]
	fn optional_kernel_command_line_setting_check_to_suppress_default() -> HashSet<OptionalKernelCommandLineSettingCheck>
	{
		use self::OptionalKernelCommandLineSettingCheck::*;
		fast_secure_hash_set!
		{
			hashdist,
			noaliencache,
			skew_tick,
			numa_zonelist_order,
			#[cfg(target_arch = "x86_64")] noxsaveopt,
			#[cfg(target_arch = "x86_64")] idle_poll,
		}
	}

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

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