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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
#[cfg(feature = "std")]
use std::fmt;
use std::fmt::Display;
#[cfg(not(feature = "std"))]
use alloc::fmt;
use deku::{
bitvec::{BitSlice, BitVec, BitView, Msb0},
prelude::*,
};
use crate::utils::pad_rest;
use super::action::Action;
use super::operand::{RequestTag, ResponseTag};
#[derive(DekuRead, DekuWrite, Clone, Debug, PartialEq, Default)]
#[deku(ctx = "command_length: u32")]
pub struct Command {
// we cannot process an indirect forward without knowing the interface type, which is stored in the interface file
// as identified by the indirectforward itself
// As such, we HAVE to bail here
#[deku(
until = "|action: &Action| { action.deku_id().unwrap() == OpCode::IndirectForward }",
bytes_read = "command_length"
)]
pub actions: Vec<Action>,
}
/// Stub implementation so we can implement DekuContainerRead
impl<'a> DekuRead<'a, ()> for Command {
fn read(_: &'a BitSlice<u8, Msb0>, _: ()) -> Result<(&'a BitSlice<u8, Msb0>, Self), DekuError>
where
Self: Sized,
{
unreachable!("This should not have been called")
}
}
impl DekuWrite<()> for Command {
fn write(&self, _: &mut BitVec<u8, Msb0>, _: ()) -> Result<(), DekuError> {
unreachable!("This should not have been called")
}
}
impl Command {
pub fn new(actions: Vec<Action>) -> Self {
// TODO: validate actions
Self { actions }
}
pub fn request_tag(&self) -> Option<&RequestTag> {
for action in self.actions.iter() {
if let Action::RequestTag(operand) = action {
return Some(operand);
}
}
None
}
pub fn request_id(&self) -> Option<u8> {
self.request_tag().map(|t| t.id)
}
pub fn response_tag(&self) -> Option<&ResponseTag> {
for action in self.actions.iter() {
if let Action::ResponseTag(operand) = action {
return Some(operand);
}
}
None
}
pub fn response_id(&self) -> Option<u8> {
self.response_tag().map(|t| t.id)
}
pub fn tag_id(&self) -> Option<u8> {
self.request_id().or(self.response_id())
}
pub fn is_last_response(&self) -> bool {
for action in self.actions.iter() {
if let Action::ResponseTag(ResponseTag { eop, .. }) = action {
return *eop;
}
}
false
}
}
impl<'a> DekuContainerRead<'a> for Command {
fn from_bytes(input: (&'a [u8], usize)) -> Result<((&'a [u8], usize), Self), DekuError> {
let input_bits = input.0.view_bits::<Msb0>();
let size = (input_bits.len() - input.1) as u32 / u8::BITS;
let (rest, value) = Self::read(&input_bits[input.1..], size)?;
Ok((pad_rest(input_bits, rest), value))
}
}
/// Stub implementation so we can implement DekuContainerWrite
impl DekuContainerWrite for Command {
fn to_bytes(&self) -> Result<Vec<u8>, DekuError> {
let output = self.to_bits()?;
Ok(output.into_vec())
}
fn to_bits(&self) -> Result<BitVec<u8, Msb0>, DekuError> {
let mut output: BitVec<u8, Msb0> = BitVec::new();
self.write(&mut output, u32::MAX)?;
Ok(output)
}
}
impl TryFrom<&'_ [u8]> for Command {
type Error = DekuError;
fn try_from(input: &'_ [u8]) -> Result<Self, Self::Error> {
let (rest, res) = <Self as DekuContainerRead>::from_bytes((input, 0))?;
if !rest.0.is_empty() {
return Err(DekuError::Parse({
let res = fmt::format(format_args!("Too much data"));
res
}));
}
Ok(res)
}
}
impl TryFrom<Command> for Vec<u8> {
type Error = DekuError;
fn try_from(input: Command) -> Result<Self, Self::Error> {
DekuContainerWrite::to_bytes(&input)
}
}
impl Display for Command {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let tag_str = self
.tag_id()
.map_or("".to_string(), |t| format!("with tag {} ", t));
f.write_str(&format!("Command {} ", &tag_str))?;
let status = if let Some(operand) = self.response_tag() {
if operand.eop {
if operand.error {
"completed, with error"
} else {
"completed, without error"
}
} else {
"executing"
}
} else {
"executing"
};
f.write_str(&format!("({})", status))?;
if self.actions.len() > 0 {
f.write_str("\n\tactions:\n")?;
for action in self.actions.iter() {
f.write_str(&format!("\t\t{:?}\n", action))?;
}
}
// if self.interface_status is not None:
// output += "\tinterface status: {}\n".format(self.interface_status)
// return output
Ok(())
}
}
#[cfg(test)]
mod test {
use hex_literal::hex;
use crate::{
app::operand::{ActionHeader, FileOffset, Nop, ReadFileData},
test_tools::test_item,
};
use super::*;
#[test]
fn test_command() {
let cmd = Command {
actions: vec![
Action::RequestTag(RequestTag { id: 66, eop: true }),
Action::ReadFileData(ReadFileData {
header: ActionHeader {
response: true,
group: false,
},
offset: FileOffset {
file_id: 0,
offset: 0u32.into(),
},
length: 8u32.into(),
}),
Action::ReadFileData(ReadFileData {
header: ActionHeader {
response: false,
group: true,
},
offset: FileOffset {
file_id: 4,
offset: 2u32.into(),
},
length: 3u32.into(),
}),
Action::Nop(Nop {
header: ActionHeader {
response: true,
group: true,
},
}),
],
};
let data = &hex!("B4 42 41 00 00 08 81 04 02 03 C0");
test_item(cmd, data);
}
#[test]
fn test_command_request_id() {
assert_eq!(
Command {
actions: vec![
Action::RequestTag(RequestTag { eop: true, id: 66 }),
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: true
}
})
]
}
.request_id(),
Some(66)
);
assert_eq!(
Command {
actions: vec![
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: false
}
}),
Action::RequestTag(RequestTag { eop: true, id: 44 }),
]
}
.request_id(),
Some(44)
);
assert_eq!(
Command {
actions: vec![
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: false
}
}),
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: false
}
})
]
}
.request_id(),
None
);
}
#[test]
fn test_command_response_id() {
assert_eq!(
Command {
actions: vec![
Action::ResponseTag(ResponseTag {
eop: true,
error: true,
id: 66
}),
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: true
}
})
]
}
.response_id(),
Some(66)
);
assert_eq!(
Command {
actions: vec![
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: false
}
}),
Action::ResponseTag(ResponseTag {
eop: true,
error: true,
id: 44
}),
]
}
.response_id(),
Some(44)
);
assert_eq!(
Command {
actions: vec![
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: false
}
}),
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: false
}
})
]
}
.response_id(),
None
);
}
#[test]
fn test_command_is_last_response() {
assert!(Command {
actions: vec![
Action::ResponseTag(ResponseTag {
eop: true,
error: true,
id: 66
}),
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: true
}
})
]
}
.is_last_response());
assert!(!Command {
actions: vec![
Action::ResponseTag(ResponseTag {
eop: false,
error: false,
id: 66
}),
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: true
}
})
]
}
.is_last_response());
assert!(!Command {
actions: vec![
Action::ResponseTag(ResponseTag {
eop: false,
error: true,
id: 44
}),
Action::ResponseTag(ResponseTag {
eop: true,
error: true,
id: 44
}),
]
}
.is_last_response());
assert!(!Command {
actions: vec![
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: false
}
}),
Action::Nop(Nop {
header: ActionHeader {
group: true,
response: false
}
})
]
}
.is_last_response());
}
}