demikernel 1.5.13

Kernel-Bypass LibOS Architecture
Documentation 
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

//======================================================================================================================
// Imports
//======================================================================================================================

use crate::catnip::runtime::memory::consts::{
    DEFAULT_BODY_POOL_SIZE,
    DEFAULT_CACHE_SIZE,
    DEFAULT_MAX_BODY_SIZE,
};

//======================================================================================================================
// Structures
//======================================================================================================================

//// Memory Configuration Descriptor
#[derive(Debug)]
pub struct MemoryConfig {
    /// What is the maximum body size? This should effectively be the MSS + RTE_PKTMBUF_HEADROOM.
    max_body_size: usize,

    /// How many buffers are within the body pool?
    body_pool_size: usize,

    /// How many buffers should remain within `rte_mempool`'s per-thread cache?
    cache_size: usize,
}

//======================================================================================================================
// Associate Functions
//======================================================================================================================

/// Associate Functions for Memory Configuration Descriptors
impl MemoryConfig {
    pub fn new(max_body_size: Option<usize>, body_pool_size: Option<usize>, cache_size: Option<usize>) -> Self {
        let mut config: Self = Self::default();

        // Sets the max body pool size config option.
        if let Some(max_body_size) = max_body_size {
            config.max_body_size = max_body_size;
        }

        // Sets the body pool size config option.
        if let Some(body_pool_size) = body_pool_size {
            config.body_pool_size = body_pool_size;
        }

        // Sets the cache size config option.
        if let Some(cache_size) = cache_size {
            config.cache_size = cache_size;
        }

        config
    }

    /// Returns the max body size config stored in the target [MemoryConfig].
    pub fn get_max_body_size(&self) -> usize {
        self.max_body_size
    }

    /// Returns the body pool size config stored in the target [MemoryConfig].
    pub fn get_body_pool_size(&self) -> usize {
        self.body_pool_size
    }

    /// Returns the cache size config stored in the target [MemoryConfig].
    pub fn get_cache_size(&self) -> usize {
        self.cache_size
    }
}

//======================================================================================================================
// Trait Implementations
//======================================================================================================================

/// Default Trait Implementation for Memory Configuration Descriptors
impl Default for MemoryConfig {
    fn default() -> Self {
        Self {
            max_body_size: DEFAULT_MAX_BODY_SIZE,
            body_pool_size: DEFAULT_BODY_POOL_SIZE,
            cache_size: DEFAULT_CACHE_SIZE,
        }
    }
}