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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

//
// Copyright 2023, Colias Group, LLC
// Copyright (c) 2020 Arm Limited
//
// SPDX-License-Identifier: MIT
//

use core::ffi::c_uint;

use crate::{
    const_helpers::u32_into_usize, sel4_cfg, sel4_cfg_enum, sel4_cfg_wrap_match, sys, CapType,
    ObjectBlueprintArch, ObjectTypeArch,
};

#[sel4_cfg(KERNEL_MCS)]
use crate::const_helpers::usize_max;

#[sel4_cfg(KERNEL_MCS)]
pub const MIN_SCHED_CONTEXT_BITS: usize = u32_into_usize(sys::seL4_MinSchedContextBits);

/// Corresponds to `seL4_ObjectType`.
#[sel4_cfg_enum]
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum ObjectType {
    Untyped,
    Endpoint,
    Notification,
    CNode,
    Tcb,
    #[sel4_cfg(KERNEL_MCS)]
    SchedContext,
    #[sel4_cfg(KERNEL_MCS)]
    Reply,
    Arch(ObjectTypeArch),
}

impl ObjectType {
    pub const fn into_sys(self) -> c_uint {
        sel4_cfg_wrap_match! {
            match self {
                Self::Untyped => sys::api_object::seL4_UntypedObject,
                Self::Endpoint => sys::api_object::seL4_EndpointObject,
                Self::Notification => sys::api_object::seL4_NotificationObject,
                Self::CNode => sys::api_object::seL4_CapTableObject,
                Self::Tcb => sys::api_object::seL4_TCBObject,
                #[sel4_cfg(KERNEL_MCS)]
                Self::SchedContext => sys::api_object::seL4_SchedContextObject,
                #[sel4_cfg(KERNEL_MCS)]
                Self::Reply => sys::api_object::seL4_ReplyObject,
                Self::Arch(arch) => arch.into_sys(),
            }
        }
    }
}

impl From<ObjectTypeArch> for ObjectType {
    fn from(ty: ObjectTypeArch) -> Self {
        Self::Arch(ty)
    }
}

/// An object description for [`Untyped::untyped_retype`](crate::cap::Untyped::untyped_retype).
#[sel4_cfg_enum]
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub enum ObjectBlueprint {
    Untyped {
        size_bits: usize,
    },
    Endpoint,
    Notification,
    CNode {
        size_bits: usize,
    },
    Tcb,
    #[sel4_cfg(KERNEL_MCS)]
    SchedContext {
        size_bits: usize,
    },
    #[sel4_cfg(KERNEL_MCS)]
    Reply,
    Arch(ObjectBlueprintArch),
}

impl ObjectBlueprint {
    pub const fn ty(self) -> ObjectType {
        sel4_cfg_wrap_match! {
            match self {
                Self::Untyped { .. } => ObjectType::Untyped,
                Self::Endpoint => ObjectType::Endpoint,
                Self::Notification => ObjectType::Notification,
                Self::CNode { .. } => ObjectType::CNode,
                Self::Tcb => ObjectType::Tcb,
                #[sel4_cfg(KERNEL_MCS)]
                Self::SchedContext { .. } => ObjectType::SchedContext,
                #[sel4_cfg(KERNEL_MCS)]
                Self::Reply => ObjectType::Reply,
                Self::Arch(arch) => ObjectType::Arch(arch.ty()),
            }
        }
    }

    pub const fn api_size_bits(self) -> Option<usize> {
        sel4_cfg_wrap_match! {
            match self {
                Self::Untyped { size_bits } => Some(size_bits),
                Self::CNode { size_bits } => Some(size_bits),
                #[sel4_cfg(KERNEL_MCS)]
                Self::SchedContext { size_bits } => Some(size_bits),
                _ => None,
            }
        }
    }

    pub const fn physical_size_bits(self) -> usize {
        sel4_cfg_wrap_match! {
            match self {
                Self::Untyped { size_bits } => size_bits,
                Self::Endpoint => u32_into_usize(sys::seL4_EndpointBits),
                Self::Notification => u32_into_usize(sys::seL4_NotificationBits),
                Self::CNode { size_bits } => u32_into_usize(sys::seL4_SlotBits) + size_bits,
                Self::Tcb => u32_into_usize(sys::seL4_TCBBits),
                #[sel4_cfg(KERNEL_MCS)]
                Self::SchedContext { size_bits } => usize_max(MIN_SCHED_CONTEXT_BITS, size_bits),
                #[sel4_cfg(KERNEL_MCS)]
                Self::Reply => u32_into_usize(sys::seL4_ReplyBits),
                Self::Arch(arch) => arch.physical_size_bits(),
            }
        }
    }

    pub const fn asid_pool() -> Self {
        Self::Untyped {
            size_bits: u32_into_usize(sys::seL4_ASIDPoolBits),
        }
    }
}

impl From<ObjectBlueprintArch> for ObjectBlueprint {
    fn from(blueprint: ObjectBlueprintArch) -> Self {
        Self::Arch(blueprint)
    }
}

pub trait CapTypeForObject: CapType {
    fn object_type() -> ObjectType;
}

pub trait CapTypeForObjectOfFixedSize: CapTypeForObject {
    fn object_blueprint() -> ObjectBlueprint;
}

pub trait CapTypeForObjectOfVariableSize: CapTypeForObject {
    fn object_blueprint(size_bits: usize) -> ObjectBlueprint;
}