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
155
156
|
// Copyright 2023, The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Error types used in libgbl.
use crate::GblOpsError;
use avb::{DescriptorError, SlotVerifyError};
use core::ffi::{FromBytesUntilNulError, FromBytesWithNulError};
use core::fmt::{Debug, Display, Formatter};
use gbl_storage::StorageError;
/// Helper type GBL functions will return.
pub type Result<T> = core::result::Result<T, IntegrationError>;
#[derive(Debug, PartialEq)]
/// Errors originating from GBL native logic.
pub enum Error {
ArithmeticOverflow,
/// Fail to hand off to kernel.
BootFailed,
/// Generic error
Error,
/// Missing all images required to boot system
MissingImage,
/// Functionality is not implemented
NotImplemented,
/// Some combination of parameters and global state prohibits the operation
OperationProhibited,
/// Internal error
Internal,
/// AvbOps were already borrowed. This would happen on second `load_and_verify_image()` call
/// unless `reuse()` is called before.
AvbOpsBusy,
}
impl Display for Error {
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
match self {
Error::ArithmeticOverflow => write!(f, "Arithmetic Overflow"),
Error::BootFailed => write!(f, "Failed to boot"),
Error::Error => write!(f, "Generic error"),
Error::MissingImage => write!(f, "Missing image required to boot system"),
Error::NotImplemented => write!(f, "Functionality is not implemented"),
Error::OperationProhibited => write!(f, "Operation is prohibited"),
Error::Internal => write!(f, "Internal error"),
Error::AvbOpsBusy => write!(f, "AvbOps were already borrowed"),
}
}
}
/// A helper macro for declaring a composite enum type that simply wraps other types as entries.
/// It auto-generate `From<...>` implementation for each entry type. The type for each entry must
/// be different from each other. i.e.:
///
/// ```rust
/// composite_enum! {
/// pub enum MyEnum {
/// Usize(usize),
/// I64(i64),
/// }
/// }
/// ```
///
/// expands to
///
/// ```rust
/// pub enum MyEnum {
/// Usize(usize),
/// I64(i64),
/// }
///
/// impl From<usize> for MyEnum {
/// fn from(ent: usize) -> MyEnum {
/// MyEnum::Usize(ent)
/// }
/// }
///
/// impl From<i64> for MyEnum {
/// fn from(ent: i64) -> MyEnum {
/// MyEnum::I64(ent)
/// }
/// }
/// ```
#[macro_export]
macro_rules! composite_enum {
(
$(#[$outer:meta])*
$vis:vis enum $name:ident {
$(
$(#[$inner:ident $($args:tt)*])*
$ent:ident($ent_t:ty)
),*
$(,)*
}
) => {
// Copy over enum declaration as it is.
$(#[$outer])*
$vis enum $name {
$(
$(#[$inner $($args)*])*
$ent($ent_t)
),*
}
// Generate `From<...>` implementation.
composite_enum!{$name, $($ent($ent_t)),*}
};
// `From<>` implementation generation. Base case.
($name:ident, $ent:ident($ent_t:ty)) => {
impl From<$ent_t> for $name {
fn from(ent: $ent_t) -> $name {
$name::$ent(ent)
}
}
};
// `From<>` implementation generation. Recursive case.
($name:ident, $ent:ident($ent_t:ty), $($next:ident($next_t:ty)),+) => {
composite_enum!{$name, $ent($ent_t)}
composite_enum!{$name, $($next($next_t)),*}
};
}
composite_enum! {
/// Top level error type that integrates errors from various dependency libraries.
#[derive(Debug)]
pub enum IntegrationError {
/// Failed to get descriptor from AvbMeta
AvbDescriptorError(DescriptorError),
/// Avb slot verification failed.
/// SlotVerifyError is used without verify data.
AvbSlotVerifyError(SlotVerifyError<'static>),
GblNativeError(Error),
GblOpsError(GblOpsError),
FromBytesUntilNulError(FromBytesUntilNulError),
FromBytesWithNulError(FromBytesWithNulError),
StorageError(StorageError),
SafeMathError(safemath::Error),
}
}
impl Display for IntegrationError {
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
write!(f, "{:?}", self)
}
}
|
