Struct dpdk_unix::android_linux::mounts::HugePageMountSettings

pub struct HugePageMountSettings {
    pub mount_point: PathBuf,
    pub user_id: uid_t,
    pub group_id: gid_t,
    pub mode: mode_t,
    pub maximum_value_of_memory_in_bytes: Option<u64>,
    pub minimum_value_of_memory_in_bytes: Option<u64>,
    pub maximum_number_of_inodes: Option<u64>,
    pub mount_flags: MountFlags,
}

Settings for mounting a hugetlbfs file system.

Fields

mount_point: PathBuf

Mount point for huge pages file system.

There is no real standard; we default to /dev/hugepages, this being the default used by the Ubuntu official deb package and similar in spirit to /dev/shm. Other options include:-

• DPDK dpdk-setup.sh uses /mnt/huge
• DPDK docs variously also use /mnt/hugepages and /mnt/hugetlbfs.
• RHEL, Debian tutorials and examples use /hugetlbfs.
• Ubuntu official deb package uses /dev/hugepages (https://gerrit.fd.io/r/gitweb?p=deb_dpdk.git;a=blob;f=debian/dpdk-init;h=86eda2cb9c4e802aa07603761a82b312f4bb7fa2;hb=HEAD).
• At least one admin on a forum uses /mnt/huge_1gb.

user_id: uid_t

User id (uid), eg 0.

group_id: gid_t

Group id (gid), eg 0.

mode: mode_t

Permissions mode.

Debian uses 1770 for mode.

maximum_value_of_memory_in_bytes: Option<u64>

eg None.

minimum_value_of_memory_in_bytes: Option<u64>

eg None.

maximum_number_of_inodes: Option<u64>

eg None.

mount_flags: MountFlags

eg MountFlags::DoNotUpdateAccessTimes | MountFlags::DoNotAllowProgramsToBeExecuted | MountFlags::DoNotHonourSetUidAndSetGidPermissions.

Methods

impl HugePageMountSettings

pub fn mount(&self, sys_path: &SysPath) -> bool

Creates the required mount point then mounts hugetlbfs.

Panics if mount already exists and is not a directory.

Returns true if the mount point was created or false if it already existed.

Trait Implementations

impl Eq for HugePageMountSettings

impl Clone for HugePageMountSettings

fn clone(&self) -> HugePageMountSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialOrd<HugePageMountSettings> for HugePageMountSettings

fn partial_cmp(&self, other: &HugePageMountSettings) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &HugePageMountSettings) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &HugePageMountSettings) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &HugePageMountSettings) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &HugePageMountSettings) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<HugePageMountSettings> for HugePageMountSettings

fn eq(&self, other: &HugePageMountSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HugePageMountSettings) -> bool

This method tests for !=.

impl Default for HugePageMountSettings

fn default() -> Self

Returns the "default value" for a type.

impl Ord for HugePageMountSettings

fn cmp(&self, other: &HugePageMountSettings) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for HugePageMountSettings

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for HugePageMountSettings

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for HugePageMountSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for HugePageMountSettings where
    HugePageMountSettings: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.