spacepackets/src/cfdp/pdu/mod.rs

1091 lines
41 KiB
Rust
Raw Normal View History

2023-05-19 00:42:31 +02:00
//! CFDP Packet Data Unit (PDU) support.
2023-05-14 20:10:34 +02:00
use crate::cfdp::*;
2023-07-25 00:42:31 +02:00
use crate::util::{UnsignedByteField, UnsignedByteFieldU8, UnsignedEnum};
2023-08-18 10:09:32 +02:00
use crate::ByteConversionError;
2023-05-29 13:46:19 +02:00
use crate::CRC_CCITT_FALSE;
2023-11-24 16:15:46 +01:00
#[cfg(feature = "alloc")]
use alloc::vec::Vec;
2023-05-14 20:10:34 +02:00
use core::fmt::{Display, Formatter};
#[cfg(feature = "std")]
use std::error::Error;
2023-11-26 21:24:24 +01:00
pub mod ack;
2023-06-07 01:12:07 +02:00
pub mod eof;
2023-05-30 00:16:16 +02:00
pub mod file_data;
2023-06-08 16:51:22 +02:00
pub mod finished;
2023-05-18 14:05:51 +02:00
pub mod metadata;
2023-11-26 21:24:24 +01:00
pub mod nak;
2023-05-18 14:05:51 +02:00
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[repr(u8)]
pub enum FileDirectiveType {
EofPdu = 0x04,
FinishedPdu = 0x05,
AckPdu = 0x06,
MetadataPdu = 0x07,
NakPdu = 0x08,
PromptPdu = 0x09,
KeepAlivePdu = 0x0c,
}
2023-05-14 20:10:34 +02:00
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum PduError {
ByteConversionError(ByteConversionError),
/// Found version ID invalid, not equal to [CFDP_VERSION_2].
CfdpVersionMissmatch(u8),
/// Invalid length for the entity ID detected. Only the values 1, 2, 4 and 8 are supported.
InvalidEntityLen(u8),
/// Invalid length for the entity ID detected. Only the values 1, 2, 4 and 8 are supported.
InvalidTransactionSeqNumLen(u8),
2023-08-17 21:22:49 +02:00
SourceDestIdLenMissmatch {
src_id_len: usize,
dest_id_len: usize,
},
2023-11-26 21:24:24 +01:00
/// Wrong directive type, for example when parsing the directive field for a file directive
/// PDU.
2023-08-17 21:22:49 +02:00
WrongDirectiveType {
found: FileDirectiveType,
expected: FileDirectiveType,
},
2023-11-26 21:24:24 +01:00
/// The directive type field contained a value not in the range of permitted values. This can
/// also happen if an invalid value is passed to the ACK PDU constructor.
2023-08-17 21:22:49 +02:00
InvalidDirectiveType {
found: u8,
expected: Option<FileDirectiveType>,
},
2023-11-27 17:48:05 +01:00
InvalidSegmentRequestFormat,
InvalidStartOrEndOfScopeValue,
2023-06-08 20:50:18 +02:00
/// Invalid condition code. Contains the raw detected value.
InvalidConditionCode(u8),
2023-05-29 13:46:19 +02:00
/// Invalid checksum type which is not part of the checksums listed in the
/// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/).
InvalidChecksumType(u8),
2023-05-21 20:30:16 +02:00
FileSizeTooLarge(u64),
2023-05-29 13:46:19 +02:00
/// If the CRC flag for a PDU is enabled and the checksum check fails. Contains raw 16-bit CRC.
ChecksumError(u16),
2023-06-12 03:57:38 +02:00
/// Generic error for invalid PDU formats.
FormatError,
2023-06-08 20:50:18 +02:00
/// Error handling a TLV field.
TlvLvError(TlvLvError),
2023-05-14 20:10:34 +02:00
}
impl Display for PduError {
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
match self {
PduError::InvalidEntityLen(raw_id) => {
write!(
f,
2023-11-27 17:48:05 +01:00
"invalid PDU entity ID length {raw_id}, only [1, 2, 4, 8] are allowed"
2023-05-14 20:10:34 +02:00
)
}
2023-11-27 17:48:05 +01:00
PduError::InvalidSegmentRequestFormat => {
write!(f, "invalid segment request format for NAK PDU")
}
PduError::InvalidStartOrEndOfScopeValue => {
write!(f, "invalid start or end of scope for NAK PDU")
}
2023-05-14 20:10:34 +02:00
PduError::InvalidTransactionSeqNumLen(raw_id) => {
write!(
f,
2023-05-18 13:32:45 +02:00
"invalid PDUtransaction seq num length {raw_id}, only [1, 2, 4, 8] are allowed"
2023-05-14 20:10:34 +02:00
)
}
PduError::CfdpVersionMissmatch(raw) => {
write!(
f,
"cfdp version missmatch, found {raw}, expected {CFDP_VERSION_2}"
)
}
2023-08-17 22:13:00 +02:00
PduError::SourceDestIdLenMissmatch {
src_id_len,
dest_id_len,
} => {
2023-05-14 20:10:34 +02:00
write!(
f,
2023-08-17 21:22:49 +02:00
"missmatch of PDU source length {src_id_len} and destination length {dest_id_len}"
2023-05-14 20:10:34 +02:00
)
}
PduError::ByteConversionError(e) => {
2023-05-18 15:01:08 +02:00
write!(f, "{}", e)
2023-05-14 20:10:34 +02:00
}
2023-05-21 20:30:16 +02:00
PduError::FileSizeTooLarge(value) => {
2023-05-29 13:46:19 +02:00
write!(f, "file size value {value} exceeds allowed 32 bit width")
}
2023-08-17 22:13:00 +02:00
PduError::WrongDirectiveType { found, expected } => {
2023-05-29 13:46:19 +02:00
write!(f, "found directive type {found:?}, expected {expected:?}")
}
2023-06-08 20:50:18 +02:00
PduError::InvalidConditionCode(raw_code) => {
write!(f, "found invalid condition code with raw value {raw_code}")
}
2023-08-17 21:22:49 +02:00
PduError::InvalidDirectiveType { found, expected } => {
2023-05-29 13:46:19 +02:00
write!(
f,
2023-08-17 21:04:27 +02:00
"invalid directive type value {found}, expected {expected:?}"
2023-05-29 13:46:19 +02:00
)
}
PduError::InvalidChecksumType(checksum_type) => {
write!(f, "invalid checksum type {checksum_type}")
}
PduError::ChecksumError(checksum) => {
write!(f, "checksum error for CRC {checksum:#04x}")
2023-05-21 20:30:16 +02:00
}
2023-06-08 20:50:18 +02:00
PduError::TlvLvError(error) => {
write!(f, "pdu tlv error: {error}")
}
2023-06-12 03:57:38 +02:00
PduError::FormatError => {
write!(f, "generic PDU format error")
}
2023-05-14 20:10:34 +02:00
}
}
}
#[cfg(feature = "std")]
2023-05-18 15:01:08 +02:00
impl Error for PduError {
fn source(&self) -> Option<&(dyn Error + 'static)> {
match self {
PduError::ByteConversionError(e) => Some(e),
2023-06-08 20:50:18 +02:00
PduError::TlvLvError(e) => Some(e),
2023-05-18 15:01:08 +02:00
_ => None,
}
}
}
2023-05-14 20:10:34 +02:00
impl From<ByteConversionError> for PduError {
fn from(value: ByteConversionError) -> Self {
Self::ByteConversionError(value)
}
}
2023-06-08 20:50:18 +02:00
impl From<TlvLvError> for PduError {
fn from(e: TlvLvError) -> Self {
Self::TlvLvError(e)
}
}
2023-11-11 18:48:48 +01:00
pub trait WritablePduPacket {
2023-11-24 16:15:46 +01:00
fn len_written(&self) -> usize;
fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, PduError>;
2023-11-24 16:15:46 +01:00
#[cfg(feature = "alloc")]
fn to_vec(&self) -> Result<Vec<u8>, PduError> {
// This is the correct way to do this. See
// [this issue](https://github.com/rust-lang/rust-clippy/issues/4483) for caveats of more
// "efficient" implementations.
let mut vec = alloc::vec![0; self.len_written()];
self.write_to_bytes(&mut vec)?;
Ok(vec)
}
}
/// Abstraction trait for fields and properties common for all PDUs.
pub trait CfdpPdu {
fn pdu_header(&self) -> &PduHeader;
fn source_id(&self) -> UnsignedByteField {
self.pdu_header().common_pdu_conf().source_entity_id
}
fn dest_id(&self) -> UnsignedByteField {
self.pdu_header().common_pdu_conf().dest_entity_id
}
fn transaction_seq_num(&self) -> UnsignedByteField {
self.pdu_header().common_pdu_conf().transaction_seq_num
}
fn transmission_mode(&self) -> TransmissionMode {
self.pdu_header().common_pdu_conf().trans_mode
}
fn direction(&self) -> Direction {
self.pdu_header().common_pdu_conf().direction
}
fn crc_flag(&self) -> CrcFlag {
self.pdu_header().common_pdu_conf().crc_flag
}
fn file_flag(&self) -> LargeFileFlag {
self.pdu_header().common_pdu_conf().file_flag
}
fn pdu_type(&self) -> PduType {
self.pdu_header().pdu_type()
}
fn file_directive_type(&self) -> Option<FileDirectiveType>;
}
2023-05-14 20:10:34 +02:00
/// Common configuration fields for a PDU.
///
/// Please note that this structure has a custom implementation of [PartialEq] which only
/// compares the values for source entity ID, destination entity ID and transaction sequence
/// number. This permits that those fields can have different widths, as long as the value is the
/// same.
#[derive(Debug, Copy, Clone, Eq)]
2023-05-14 20:10:34 +02:00
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct CommonPduConfig {
source_entity_id: UnsignedByteField,
dest_entity_id: UnsignedByteField,
2023-05-15 01:01:46 +02:00
pub transaction_seq_num: UnsignedByteField,
pub trans_mode: TransmissionMode,
pub file_flag: LargeFileFlag,
pub crc_flag: CrcFlag,
pub direction: Direction,
2023-05-14 20:10:34 +02:00
}
2023-05-18 11:08:46 +02:00
// TODO: Builder pattern might be applicable here..
2023-05-14 20:10:34 +02:00
impl CommonPduConfig {
pub fn new(
2023-05-15 01:01:46 +02:00
source_id: impl Into<UnsignedByteField>,
dest_id: impl Into<UnsignedByteField>,
transaction_seq_num: impl Into<UnsignedByteField>,
2023-05-14 20:10:34 +02:00
trans_mode: TransmissionMode,
file_flag: LargeFileFlag,
crc_flag: CrcFlag,
direction: Direction,
) -> Result<Self, PduError> {
2023-08-10 19:55:42 +02:00
let (source_id, dest_id) = Self::source_dest_id_check(source_id, dest_id)?;
2023-05-15 01:01:46 +02:00
let transaction_seq_num = transaction_seq_num.into();
2023-07-02 20:57:50 +02:00
if transaction_seq_num.size() != 1
&& transaction_seq_num.size() != 2
&& transaction_seq_num.size() != 4
&& transaction_seq_num.size() != 8
2023-05-15 01:01:46 +02:00
{
return Err(PduError::InvalidTransactionSeqNumLen(
2023-07-02 20:57:50 +02:00
transaction_seq_num.size() as u8,
2023-05-15 01:01:46 +02:00
));
}
2023-05-14 20:10:34 +02:00
Ok(Self {
source_entity_id: source_id,
dest_entity_id: dest_id,
transaction_seq_num,
trans_mode,
file_flag,
crc_flag,
direction,
})
}
2023-05-15 01:01:46 +02:00
2023-07-25 00:42:31 +02:00
pub fn new_with_byte_fields(
2023-05-15 01:01:46 +02:00
source_id: impl Into<UnsignedByteField>,
dest_id: impl Into<UnsignedByteField>,
transaction_seq_num: impl Into<UnsignedByteField>,
) -> Result<Self, PduError> {
Self::new(
source_id,
dest_id,
transaction_seq_num,
TransmissionMode::Acknowledged,
LargeFileFlag::Normal,
CrcFlag::NoCrc,
Direction::TowardsReceiver,
)
}
2023-08-10 20:22:07 +02:00
pub fn source_id(&self) -> UnsignedByteField {
self.source_entity_id
}
2023-08-10 19:55:42 +02:00
fn source_dest_id_check(
source_id: impl Into<UnsignedByteField>,
dest_id: impl Into<UnsignedByteField>,
) -> Result<(UnsignedByteField, UnsignedByteField), PduError> {
let source_id = source_id.into();
let dest_id = dest_id.into();
if source_id.size() != dest_id.size() {
2023-08-17 21:22:49 +02:00
return Err(PduError::SourceDestIdLenMissmatch {
src_id_len: source_id.size(),
dest_id_len: dest_id.size(),
});
2023-08-10 19:55:42 +02:00
}
if source_id.size() != 1
&& source_id.size() != 2
&& source_id.size() != 4
&& source_id.size() != 8
{
return Err(PduError::InvalidEntityLen(source_id.size() as u8));
}
Ok((source_id, dest_id))
}
pub fn set_source_and_dest_id(
&mut self,
source_id: impl Into<UnsignedByteField>,
dest_id: impl Into<UnsignedByteField>,
) -> Result<(), PduError> {
let (source_id, dest_id) = Self::source_dest_id_check(source_id, dest_id)?;
self.source_entity_id = source_id;
self.dest_entity_id = dest_id;
Ok(())
}
2023-08-10 20:22:07 +02:00
pub fn dest_id(&self) -> UnsignedByteField {
self.dest_entity_id
}
}
impl Default for CommonPduConfig {
2023-07-25 00:42:31 +02:00
/// The defaults for the source ID, destination ID and the transaction sequence number is the
/// [UnsignedByteFieldU8] with an intitial value of 0
2023-08-10 20:22:07 +02:00
fn default() -> Self {
// The new function can not fail for these input parameters.
2023-07-25 00:42:31 +02:00
Self::new(
UnsignedByteFieldU8::new(0),
UnsignedByteFieldU8::new(0),
UnsignedByteFieldU8::new(0),
TransmissionMode::Acknowledged,
LargeFileFlag::Normal,
CrcFlag::NoCrc,
Direction::TowardsReceiver,
2023-07-26 23:27:40 +02:00
)
.unwrap()
2023-07-25 00:42:31 +02:00
}
2023-05-14 20:10:34 +02:00
}
2023-05-15 01:01:46 +02:00
impl PartialEq for CommonPduConfig {
fn eq(&self, other: &Self) -> bool {
self.source_entity_id.value() == other.source_entity_id.value()
&& self.dest_entity_id.value() == other.dest_entity_id.value()
&& self.transaction_seq_num.value() == other.transaction_seq_num.value()
&& self.trans_mode == other.trans_mode
&& self.file_flag == other.file_flag
&& self.crc_flag == other.crc_flag
&& self.direction == other.direction
}
}
2023-05-18 14:05:51 +02:00
pub const FIXED_HEADER_LEN: usize = 4;
2023-05-15 01:01:46 +02:00
2023-05-29 23:38:07 +02:00
/// Abstraction for the PDU header common to all CFDP PDUs.
///
/// For detailed information, refer to chapter 5.1 of the CFDP standard.
2023-05-14 20:10:34 +02:00
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct PduHeader {
pdu_type: PduType,
pdu_conf: CommonPduConfig,
seg_metadata_flag: SegmentMetadataFlag,
seg_ctrl: SegmentationControl,
pdu_datafield_len: u16,
}
impl PduHeader {
pub fn new_for_file_data(
pdu_conf: CommonPduConfig,
2023-05-18 00:46:58 +02:00
pdu_datafield_len: u16,
2023-05-14 20:10:34 +02:00
seg_metadata_flag: SegmentMetadataFlag,
seg_ctrl: SegmentationControl,
) -> Self {
2023-05-30 11:09:41 +02:00
Self::new_generic(
PduType::FileData,
2023-05-14 20:10:34 +02:00
pdu_conf,
2023-05-30 11:09:41 +02:00
pdu_datafield_len,
2023-05-14 20:10:34 +02:00
seg_metadata_flag,
seg_ctrl,
2023-05-30 11:09:41 +02:00
)
2023-05-14 20:10:34 +02:00
}
2023-05-30 11:09:41 +02:00
pub fn new_for_file_data_default(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
Self::new_generic(
PduType::FileData,
pdu_conf,
pdu_datafield_len,
SegmentMetadataFlag::NotPresent,
SegmentationControl::NoRecordBoundaryPreservation,
)
}
2023-05-14 20:10:34 +02:00
pub fn new_no_file_data(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
2023-05-30 11:09:41 +02:00
Self::new_generic(
PduType::FileDirective,
pdu_conf,
pdu_datafield_len,
SegmentMetadataFlag::NotPresent,
SegmentationControl::NoRecordBoundaryPreservation,
)
}
pub fn new_generic(
pdu_type: PduType,
pdu_conf: CommonPduConfig,
pdu_datafield_len: u16,
seg_metadata_flag: SegmentMetadataFlag,
seg_ctrl: SegmentationControl,
) -> Self {
Self {
pdu_type,
2023-05-14 20:10:34 +02:00
pdu_conf,
2023-05-30 11:09:41 +02:00
seg_metadata_flag,
seg_ctrl,
2023-05-14 20:10:34 +02:00
pdu_datafield_len,
}
}
2023-05-29 13:46:19 +02:00
/// Returns only the length of the PDU header when written to a raw buffer.
pub fn header_len(&self) -> usize {
2023-05-21 20:30:16 +02:00
FIXED_HEADER_LEN
2023-07-02 20:57:50 +02:00
+ self.pdu_conf.source_entity_id.size()
+ self.pdu_conf.transaction_seq_num.size()
+ self.pdu_conf.dest_entity_id.size()
2023-05-21 20:30:16 +02:00
}
2023-05-29 13:46:19 +02:00
2023-08-17 20:41:45 +02:00
pub fn pdu_datafield_len(&self) -> usize {
self.pdu_datafield_len.into()
}
2023-05-29 13:46:19 +02:00
/// Returns the full length of the PDU when written to a raw buffer, which is the header length
/// plus the PDU datafield length.
pub fn pdu_len(&self) -> usize {
self.header_len() + self.pdu_datafield_len as usize
}
pub fn write_to_bytes(&self, buf: &mut [u8]) -> Result<usize, PduError> {
2023-05-18 13:32:45 +02:00
// Internal note: There is currently no way to pass a PDU configuration like this, but
// this check is still kept for defensive programming.
2023-07-02 20:57:50 +02:00
if self.pdu_conf.source_entity_id.size() != self.pdu_conf.dest_entity_id.size() {
2023-08-17 21:22:49 +02:00
return Err(PduError::SourceDestIdLenMissmatch {
src_id_len: self.pdu_conf.source_entity_id.size(),
dest_id_len: self.pdu_conf.dest_entity_id.size(),
});
2023-05-14 20:10:34 +02:00
}
if buf.len()
2023-05-18 11:08:46 +02:00
< FIXED_HEADER_LEN
2023-07-02 20:57:50 +02:00
+ self.pdu_conf.source_entity_id.size()
+ self.pdu_conf.transaction_seq_num.size()
2023-05-14 20:10:34 +02:00
{
2023-08-18 10:09:32 +02:00
return Err(ByteConversionError::ToSliceTooSmall {
2023-05-14 20:10:34 +02:00
found: buf.len(),
2023-05-18 11:08:46 +02:00
expected: FIXED_HEADER_LEN,
2023-08-18 10:09:32 +02:00
}
2023-05-14 20:10:34 +02:00
.into());
}
let mut current_idx = 0;
buf[current_idx] = (CFDP_VERSION_2 << 5)
| ((self.pdu_type as u8) << 4)
| ((self.pdu_conf.direction as u8) << 3)
| ((self.pdu_conf.trans_mode as u8) << 2)
| ((self.pdu_conf.crc_flag as u8) << 1)
| (self.pdu_conf.file_flag as u8);
current_idx += 1;
buf[current_idx..current_idx + 2].copy_from_slice(&self.pdu_datafield_len.to_be_bytes());
current_idx += 2;
buf[current_idx] = ((self.seg_ctrl as u8) << 7)
2023-07-02 20:57:50 +02:00
| (((self.pdu_conf.source_entity_id.size() - 1) as u8) << 4)
2023-05-14 20:10:34 +02:00
| ((self.seg_metadata_flag as u8) << 3)
2023-07-02 20:57:50 +02:00
| ((self.pdu_conf.transaction_seq_num.size() - 1) as u8);
2023-05-15 01:01:46 +02:00
current_idx += 1;
2023-05-14 20:10:34 +02:00
self.pdu_conf.source_entity_id.write_to_be_bytes(
2023-07-02 20:57:50 +02:00
&mut buf[current_idx..current_idx + self.pdu_conf.source_entity_id.size()],
2023-05-14 20:10:34 +02:00
)?;
2023-07-02 20:57:50 +02:00
current_idx += self.pdu_conf.source_entity_id.size();
2023-05-14 20:10:34 +02:00
self.pdu_conf.transaction_seq_num.write_to_be_bytes(
2023-07-02 20:57:50 +02:00
&mut buf[current_idx..current_idx + self.pdu_conf.transaction_seq_num.size()],
2023-05-14 20:10:34 +02:00
)?;
2023-07-02 20:57:50 +02:00
current_idx += self.pdu_conf.transaction_seq_num.size();
2023-05-14 20:10:34 +02:00
self.pdu_conf.dest_entity_id.write_to_be_bytes(
2023-07-02 20:57:50 +02:00
&mut buf[current_idx..current_idx + self.pdu_conf.dest_entity_id.size()],
2023-05-14 20:10:34 +02:00
)?;
2023-07-02 20:57:50 +02:00
current_idx += self.pdu_conf.dest_entity_id.size();
2023-05-18 00:46:58 +02:00
Ok(current_idx)
2023-05-14 20:10:34 +02:00
}
2023-05-29 13:46:19 +02:00
/// This function first verifies that the buffer can hold the full length of the PDU parsed from
/// the header. Then, it verifies the checksum as specified in the standard if the CRC flag
/// of the PDU header is set.
///
/// This function will return the PDU length excluding the 2 CRC bytes on success. If the CRC
/// flag is not set, it will simply return the PDU length.
pub fn verify_length_and_checksum(&self, buf: &[u8]) -> Result<usize, PduError> {
if buf.len() < self.pdu_len() {
2023-08-18 10:09:32 +02:00
return Err(ByteConversionError::FromSliceTooSmall {
2023-05-29 13:46:19 +02:00
found: buf.len(),
expected: self.pdu_len(),
2023-08-18 10:09:32 +02:00
}
2023-05-29 13:46:19 +02:00
.into());
}
if self.pdu_conf.crc_flag == CrcFlag::WithCrc {
let mut digest = CRC_CCITT_FALSE.digest();
digest.update(&buf[..self.pdu_len()]);
if digest.finalize() != 0 {
return Err(PduError::ChecksumError(u16::from_be_bytes(
buf[self.pdu_len() - 2..self.pdu_len()].try_into().unwrap(),
)));
}
2023-05-29 23:38:07 +02:00
return Ok(self.pdu_len() - 2);
2023-05-29 13:46:19 +02:00
}
Ok(self.pdu_len())
}
/// Please note that this function will not verify that the passed buffer can hold the full
/// PDU length. This allows recovering the header portion even if the data field length is
/// invalid. This function will also not do the CRC procedure specified in chapter 4.1.1
/// and 4.1.2 because performing the CRC procedure requires the buffer to be large enough
/// to hold the full PDU.
///
2023-06-12 04:13:41 +02:00
/// Both functions can however be performed with the [Self::verify_length_and_checksum]
/// function.
pub fn from_bytes(buf: &[u8]) -> Result<(Self, usize), PduError> {
2023-05-18 11:08:46 +02:00
if buf.len() < FIXED_HEADER_LEN {
2023-05-14 20:10:34 +02:00
return Err(PduError::ByteConversionError(
2023-08-18 10:09:32 +02:00
ByteConversionError::FromSliceTooSmall {
2023-05-14 20:10:34 +02:00
found: buf.len(),
2023-05-18 11:08:46 +02:00
expected: FIXED_HEADER_LEN,
2023-08-18 10:09:32 +02:00
},
2023-05-14 20:10:34 +02:00
));
}
2023-05-15 01:01:46 +02:00
let cfdp_version_raw = (buf[0] >> 5) & 0b111;
2023-05-14 20:10:34 +02:00
if cfdp_version_raw != CFDP_VERSION_2 {
return Err(PduError::CfdpVersionMissmatch(cfdp_version_raw));
}
2023-05-15 01:01:46 +02:00
// unwrap for single bit fields: This operation will always succeed.
2023-05-14 20:10:34 +02:00
let pdu_type = PduType::try_from((buf[0] >> 4) & 0b1).unwrap();
let direction = Direction::try_from((buf[0] >> 3) & 0b1).unwrap();
let trans_mode = TransmissionMode::try_from((buf[0] >> 2) & 0b1).unwrap();
let crc_flag = CrcFlag::try_from((buf[0] >> 1) & 0b1).unwrap();
let file_flag = LargeFileFlag::try_from(buf[0] & 0b1).unwrap();
let pdu_datafield_len = u16::from_be_bytes(buf[1..3].try_into().unwrap());
let seg_ctrl = SegmentationControl::try_from((buf[3] >> 7) & 0b1).unwrap();
2023-05-15 01:03:15 +02:00
let expected_len_entity_ids = (((buf[3] >> 4) & 0b111) + 1) as usize;
2023-05-14 20:10:34 +02:00
if (expected_len_entity_ids != 1)
&& (expected_len_entity_ids != 2)
&& (expected_len_entity_ids != 4)
&& (expected_len_entity_ids != 8)
{
return Err(PduError::InvalidEntityLen(expected_len_entity_ids as u8));
}
let seg_metadata_flag = SegmentMetadataFlag::try_from((buf[3] >> 3) & 0b1).unwrap();
2023-05-15 01:03:15 +02:00
let expected_len_seq_num = ((buf[3] & 0b111) + 1) as usize;
2023-05-14 20:10:34 +02:00
if (expected_len_seq_num != 1)
&& (expected_len_seq_num != 2)
&& (expected_len_seq_num != 4)
&& (expected_len_seq_num != 8)
{
return Err(PduError::InvalidTransactionSeqNumLen(
expected_len_seq_num as u8,
));
}
if buf.len() < (4 + 2 * expected_len_entity_ids + expected_len_seq_num) {
2023-08-18 10:09:32 +02:00
return Err(ByteConversionError::FromSliceTooSmall {
2023-05-14 20:10:34 +02:00
found: buf.len(),
expected: 4 + 2 * expected_len_entity_ids + expected_len_seq_num,
2023-08-18 10:09:32 +02:00
}
2023-05-14 20:10:34 +02:00
.into());
}
let mut current_idx = 4;
2023-05-15 01:01:46 +02:00
// It is okay to unwrap here because we checked the validity of the expected length and of
// the remaining buffer length.
2023-05-14 20:10:34 +02:00
let source_id =
UnsignedByteField::new_from_be_bytes(expected_len_entity_ids, &buf[current_idx..])
.unwrap();
current_idx += expected_len_entity_ids;
let transaction_seq_num =
UnsignedByteField::new_from_be_bytes(expected_len_seq_num, &buf[current_idx..])
.unwrap();
current_idx += expected_len_seq_num;
let dest_id =
UnsignedByteField::new_from_be_bytes(expected_len_entity_ids, &buf[current_idx..])
.unwrap();
2023-05-18 11:08:46 +02:00
current_idx += expected_len_entity_ids;
2023-05-14 20:10:34 +02:00
let common_pdu_conf = CommonPduConfig::new(
source_id,
dest_id,
transaction_seq_num,
trans_mode,
file_flag,
crc_flag,
direction,
)
.unwrap();
2023-05-18 11:08:46 +02:00
Ok((
PduHeader {
pdu_type,
pdu_conf: common_pdu_conf,
seg_metadata_flag,
seg_ctrl,
pdu_datafield_len,
},
current_idx,
))
2023-05-14 20:10:34 +02:00
}
pub fn pdu_type(&self) -> PduType {
self.pdu_type
}
pub fn common_pdu_conf(&self) -> &CommonPduConfig {
&self.pdu_conf
}
2023-05-15 01:01:46 +02:00
pub fn seg_metadata_flag(&self) -> SegmentMetadataFlag {
self.seg_metadata_flag
}
pub fn seg_ctrl(&self) -> SegmentationControl {
self.seg_ctrl
}
}
2023-05-30 15:36:02 +02:00
pub(crate) fn write_fss_field(
file_flag: LargeFileFlag,
2023-05-30 00:16:16 +02:00
file_size: u64,
buf: &mut [u8],
2023-05-30 15:36:02 +02:00
) -> Result<usize, PduError> {
Ok(if file_flag == LargeFileFlag::Large {
buf[..core::mem::size_of::<u64>()].copy_from_slice(&file_size.to_be_bytes());
core::mem::size_of::<u64>()
2023-05-30 00:16:16 +02:00
} else {
if file_size > u32::MAX as u64 {
return Err(PduError::FileSizeTooLarge(file_size));
}
2023-05-30 15:36:02 +02:00
buf[..core::mem::size_of::<u32>()].copy_from_slice(&(file_size as u32).to_be_bytes());
core::mem::size_of::<u32>()
})
}
pub(crate) fn read_fss_field(file_flag: LargeFileFlag, buf: &[u8]) -> (usize, u64) {
if file_flag == LargeFileFlag::Large {
(
core::mem::size_of::<u64>(),
u64::from_be_bytes(buf[..core::mem::size_of::<u64>()].try_into().unwrap()),
)
} else {
(
core::mem::size_of::<u32>(),
u32::from_be_bytes(buf[..core::mem::size_of::<u32>()].try_into().unwrap()).into(),
)
2023-05-30 00:16:16 +02:00
}
}
2023-06-12 03:57:38 +02:00
// This is a generic length check applicable to most PDU deserializations. It first checks whether
// a given buffer can hold an expected minimum size, and then it checks whether the PDU datafield
// length is larger than that expected minimum size.
pub(crate) fn generic_length_checks_pdu_deserialization(
buf: &[u8],
min_expected_len: usize,
full_len_without_crc: usize,
) -> Result<(), ByteConversionError> {
// Buffer too short to hold additional expected minimum datasize.
if buf.len() < min_expected_len {
2023-08-18 10:09:32 +02:00
return Err(ByteConversionError::FromSliceTooSmall {
2023-06-12 03:57:38 +02:00
found: buf.len(),
expected: min_expected_len,
2023-08-18 10:09:32 +02:00
});
2023-06-12 03:57:38 +02:00
}
// This can happen if the PDU datafield length value is invalid.
if full_len_without_crc < min_expected_len {
2023-08-18 10:09:32 +02:00
return Err(ByteConversionError::FromSliceTooSmall {
2023-06-12 03:57:38 +02:00
found: full_len_without_crc,
expected: min_expected_len,
2023-08-18 10:09:32 +02:00
});
2023-06-12 03:57:38 +02:00
}
Ok(())
}
2023-06-12 13:00:58 +02:00
pub(crate) fn add_pdu_crc(buf: &mut [u8], mut current_idx: usize) -> usize {
let mut digest = CRC_CCITT_FALSE.digest();
digest.update(&buf[..current_idx]);
buf[current_idx..current_idx + 2].copy_from_slice(&digest.finalize().to_be_bytes());
current_idx += 2;
current_idx
}
2023-05-15 01:01:46 +02:00
#[cfg(test)]
mod tests {
2023-05-18 11:08:46 +02:00
use crate::cfdp::pdu::{CommonPduConfig, PduError, PduHeader, FIXED_HEADER_LEN};
2023-05-15 01:01:46 +02:00
use crate::cfdp::{
2023-05-18 00:46:58 +02:00
CrcFlag, Direction, LargeFileFlag, PduType, SegmentMetadataFlag, SegmentationControl,
TransmissionMode, CFDP_VERSION_2,
2023-05-15 01:01:46 +02:00
};
2023-05-29 01:29:04 +02:00
use crate::util::{
2023-11-25 18:16:21 +01:00
UbfU16, UbfU8, UnsignedByteField, UnsignedByteFieldU16, UnsignedByteFieldU8, UnsignedEnum,
2023-05-29 01:29:04 +02:00
};
2023-05-18 11:08:46 +02:00
use crate::ByteConversionError;
2023-05-18 00:46:58 +02:00
use std::format;
2023-05-15 01:01:46 +02:00
pub(crate) const TEST_SRC_ID: UbfU8 = UbfU8::new(5);
pub(crate) const TEST_DEST_ID: UbfU8 = UbfU8::new(10);
pub(crate) const TEST_SEQ_NUM: UbfU8 = UbfU8::new(20);
2023-06-08 20:50:18 +02:00
pub(crate) fn common_pdu_conf(crc_flag: CrcFlag, fss: LargeFileFlag) -> CommonPduConfig {
2023-07-25 00:42:31 +02:00
let mut pdu_conf =
CommonPduConfig::new_with_byte_fields(TEST_SRC_ID, TEST_DEST_ID, TEST_SEQ_NUM)
2023-07-25 00:42:31 +02:00
.expect("Generating common PDU config");
2023-06-08 20:50:18 +02:00
pdu_conf.crc_flag = crc_flag;
pdu_conf.file_flag = fss;
pdu_conf
}
2023-05-29 01:29:04 +02:00
pub(crate) fn verify_raw_header(pdu_conf: &PduHeader, buf: &[u8]) {
assert_eq!((buf[0] >> 5) & 0b111, CFDP_VERSION_2);
// File directive
assert_eq!((buf[0] >> 4) & 1, pdu_conf.pdu_type as u8);
assert_eq!((buf[0] >> 3) & 1, pdu_conf.pdu_conf.direction as u8);
// Acknowledged
assert_eq!((buf[0] >> 2) & 1, pdu_conf.pdu_conf.trans_mode as u8);
// No CRC
assert_eq!((buf[0] >> 1) & 1, pdu_conf.pdu_conf.crc_flag as u8);
// Regular file size
assert_eq!(buf[0] & 1, pdu_conf.pdu_conf.file_flag as u8);
let pdu_datafield_len = u16::from_be_bytes(buf[1..3].try_into().unwrap());
assert_eq!(pdu_datafield_len, pdu_conf.pdu_datafield_len);
// No record boundary preservation
assert_eq!((buf[3] >> 7) & 1, pdu_conf.seg_ctrl as u8);
// Entity ID length raw value is actual number of octets - 1 => 0
2023-07-05 19:07:31 +02:00
let entity_id_len = pdu_conf.pdu_conf.source_entity_id.size();
2023-05-29 01:29:04 +02:00
assert_eq!((buf[3] >> 4) & 0b111, entity_id_len as u8 - 1);
// No segment metadata
assert_eq!((buf[3] >> 3) & 0b1, pdu_conf.seg_metadata_flag as u8);
// Transaction Sequence ID length raw value is actual number of octets - 1 => 0
2023-07-05 19:07:31 +02:00
let seq_num_len = pdu_conf.pdu_conf.transaction_seq_num.size();
2023-05-29 01:29:04 +02:00
assert_eq!(buf[3] & 0b111, seq_num_len as u8 - 1);
let mut current_idx = 4;
let mut byte_field_check = |field_len: usize, ubf: &UnsignedByteField| {
match field_len {
1 => assert_eq!(buf[current_idx], ubf.value() as u8),
2 => assert_eq!(
u16::from_be_bytes(
buf[current_idx..current_idx + field_len]
.try_into()
.unwrap()
),
ubf.value() as u16
),
4 => assert_eq!(
u32::from_be_bytes(
buf[current_idx..current_idx + field_len]
.try_into()
.unwrap()
),
ubf.value() as u32
),
8 => assert_eq!(
u64::from_be_bytes(
buf[current_idx..current_idx + field_len]
.try_into()
.unwrap()
),
2023-10-06 14:54:11 +02:00
ubf.value()
2023-05-29 01:29:04 +02:00
),
_ => panic!("invalid entity ID length"),
}
current_idx += field_len
};
byte_field_check(entity_id_len, &pdu_conf.pdu_conf.source_entity_id);
byte_field_check(seq_num_len, &pdu_conf.pdu_conf.transaction_seq_num);
byte_field_check(entity_id_len, &pdu_conf.pdu_conf.dest_entity_id);
}
2023-05-15 01:01:46 +02:00
#[test]
fn test_basic_state() {
2023-05-18 13:32:45 +02:00
let src_id = UnsignedByteFieldU8::new(1);
let dest_id = UnsignedByteFieldU8::new(2);
let transaction_id = UnsignedByteFieldU8::new(3);
2023-07-25 00:42:31 +02:00
let common_pdu_cfg = CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-15 01:01:46 +02:00
.expect("common config creation failed");
let pdu_header = PduHeader::new_no_file_data(common_pdu_cfg, 5);
assert_eq!(pdu_header.pdu_type(), PduType::FileDirective);
let common_conf_ref = pdu_header.common_pdu_conf();
assert_eq!(*common_conf_ref, common_pdu_cfg);
// These should be 0 and ignored for non-filedata PDUs
assert_eq!(
pdu_header.seg_metadata_flag(),
SegmentMetadataFlag::NotPresent
);
assert_eq!(
pdu_header.seg_ctrl(),
SegmentationControl::NoRecordBoundaryPreservation
);
2023-05-18 00:46:58 +02:00
assert_eq!(pdu_header.pdu_datafield_len, 5);
2023-05-29 13:46:19 +02:00
assert_eq!(pdu_header.header_len(), 7);
2023-05-18 00:46:58 +02:00
}
#[test]
fn test_common_pdu_conf_partial_eq() {
2023-11-25 18:16:21 +01:00
let common_pdu_cfg_0 =
CommonPduConfig::new_with_byte_fields(UbfU8::new(1), UbfU8::new(2), UbfU8::new(3))
.expect("common config creation failed");
let common_pdu_cfg_1 =
CommonPduConfig::new_with_byte_fields(UbfU16::new(1), UbfU16::new(2), UbfU16::new(3))
.expect("common config creation failed");
assert_eq!(common_pdu_cfg_0, common_pdu_cfg_1);
}
2023-08-10 20:22:07 +02:00
#[test]
fn test_basic_state_default() {
let default_conf = CommonPduConfig::default();
assert_eq!(default_conf.source_id(), UnsignedByteFieldU8::new(0).into());
assert_eq!(default_conf.dest_id(), UnsignedByteFieldU8::new(0).into());
assert_eq!(
default_conf.transaction_seq_num,
UnsignedByteFieldU8::new(0).into()
);
2023-08-10 20:22:07 +02:00
assert_eq!(default_conf.trans_mode, TransmissionMode::Acknowledged);
assert_eq!(default_conf.direction, Direction::TowardsReceiver);
assert_eq!(default_conf.crc_flag, CrcFlag::NoCrc);
assert_eq!(default_conf.file_flag, LargeFileFlag::Normal);
}
2023-08-16 18:16:43 +02:00
#[test]
2023-08-10 19:55:42 +02:00
fn test_pdu_header_setter() {
let src_id = UnsignedByteFieldU8::new(1);
let dest_id = UnsignedByteFieldU8::new(2);
let transaction_id = UnsignedByteFieldU8::new(3);
2023-08-10 20:04:50 +02:00
let mut common_pdu_cfg =
2023-08-10 21:28:27 +02:00
CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-08-10 20:04:50 +02:00
.expect("common config creation failed");
2023-08-10 19:55:42 +02:00
let other_src_id = UnsignedByteFieldU16::new(5);
let other_dest_id = UnsignedByteFieldU16::new(6);
let set_result = common_pdu_cfg.set_source_and_dest_id(other_src_id, other_dest_id);
assert!(set_result.is_ok());
assert_eq!(common_pdu_cfg.source_id(), other_src_id.into());
assert_eq!(common_pdu_cfg.dest_id(), other_dest_id.into());
}
2023-08-10 20:22:07 +02:00
2023-05-18 00:46:58 +02:00
#[test]
fn test_serialization_1() {
2023-05-18 13:32:45 +02:00
let src_id = UnsignedByteFieldU8::new(1);
let dest_id = UnsignedByteFieldU8::new(2);
let transaction_id = UnsignedByteFieldU8::new(3);
2023-07-25 00:42:31 +02:00
let common_pdu_cfg = CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-15 01:01:46 +02:00
.expect("common config creation failed");
let pdu_header = PduHeader::new_no_file_data(common_pdu_cfg, 5);
let mut buf: [u8; 7] = [0; 7];
let res = pdu_header.write_to_bytes(&mut buf);
2023-05-15 01:01:46 +02:00
assert!(res.is_ok());
2023-05-18 00:46:58 +02:00
// 4 byte fixed header plus three bytes src, dest ID and transaction ID
assert_eq!(res.unwrap(), 7);
2023-05-29 01:29:04 +02:00
verify_raw_header(&pdu_header, &buf);
2023-05-18 00:46:58 +02:00
}
2023-05-18 11:08:46 +02:00
#[test]
fn test_deserialization_1() {
2023-05-18 13:32:45 +02:00
let src_id = UnsignedByteFieldU8::new(1);
let dest_id = UnsignedByteFieldU8::new(2);
let transaction_id = UnsignedByteFieldU8::new(3);
2023-07-25 00:42:31 +02:00
let common_pdu_cfg = CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-18 11:08:46 +02:00
.expect("common config creation failed");
let pdu_header = PduHeader::new_no_file_data(common_pdu_cfg, 5);
let mut buf: [u8; 7] = [0; 7];
let res = pdu_header.write_to_bytes(&mut buf);
2023-05-18 11:08:46 +02:00
assert!(res.is_ok());
let deser_res = PduHeader::from_bytes(&buf);
2023-05-18 11:08:46 +02:00
assert!(deser_res.is_ok());
let (header_read_back, read_size) = deser_res.unwrap();
assert_eq!(read_size, 7);
assert_eq!(header_read_back, pdu_header);
}
2023-05-18 00:46:58 +02:00
#[test]
fn test_serialization_2() {
2023-05-18 13:32:45 +02:00
let src_id = UnsignedByteFieldU16::new(0x0001);
let dest_id = UnsignedByteFieldU16::new(0x0203);
let transaction_id = UnsignedByteFieldU16::new(0x0405);
2023-05-18 00:46:58 +02:00
let mut common_pdu_cfg =
2023-07-25 00:42:31 +02:00
CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-18 00:46:58 +02:00
.expect("common config creation failed");
common_pdu_cfg.crc_flag = CrcFlag::WithCrc;
common_pdu_cfg.direction = Direction::TowardsSender;
common_pdu_cfg.trans_mode = TransmissionMode::Unacknowledged;
common_pdu_cfg.file_flag = LargeFileFlag::Large;
let pdu_header = PduHeader::new_for_file_data(
common_pdu_cfg,
5,
SegmentMetadataFlag::Present,
SegmentationControl::WithRecordBoundaryPreservation,
);
2023-05-29 13:46:19 +02:00
assert_eq!(pdu_header.header_len(), 10);
2023-05-18 00:46:58 +02:00
let mut buf: [u8; 16] = [0; 16];
let res = pdu_header.write_to_bytes(&mut buf);
2023-05-18 00:46:58 +02:00
assert!(res.is_ok(), "{}", format!("Result {res:?} not okay"));
// 4 byte fixed header, 6 bytes additional fields
assert_eq!(res.unwrap(), 10);
2023-05-29 01:29:04 +02:00
verify_raw_header(&pdu_header, &buf);
2023-05-15 01:01:46 +02:00
}
2023-05-18 00:46:58 +02:00
#[test]
2023-05-18 11:08:46 +02:00
fn test_deserialization_2() {
2023-05-18 13:32:45 +02:00
let src_id = UnsignedByteFieldU16::new(0x0001);
let dest_id = UnsignedByteFieldU16::new(0x0203);
let transaction_id = UnsignedByteFieldU16::new(0x0405);
2023-05-18 11:08:46 +02:00
let mut common_pdu_cfg =
2023-07-25 00:42:31 +02:00
CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-18 11:08:46 +02:00
.expect("common config creation failed");
common_pdu_cfg.crc_flag = CrcFlag::WithCrc;
common_pdu_cfg.direction = Direction::TowardsSender;
common_pdu_cfg.trans_mode = TransmissionMode::Unacknowledged;
common_pdu_cfg.file_flag = LargeFileFlag::Large;
let pdu_header = PduHeader::new_for_file_data(
common_pdu_cfg,
5,
SegmentMetadataFlag::Present,
SegmentationControl::WithRecordBoundaryPreservation,
);
let mut buf: [u8; 16] = [0; 16];
let res = pdu_header.write_to_bytes(&mut buf);
2023-05-18 11:08:46 +02:00
assert!(res.is_ok());
let deser_res = PduHeader::from_bytes(&buf);
2023-05-18 11:08:46 +02:00
assert!(deser_res.is_ok());
let (header_read_back, read_size) = deser_res.unwrap();
assert_eq!(read_size, 10);
assert_eq!(header_read_back, pdu_header);
}
#[test]
fn test_invalid_raw_version() {
2023-05-18 13:32:45 +02:00
let src_id = UnsignedByteFieldU8::new(1);
let dest_id = UnsignedByteFieldU8::new(2);
let transaction_id = UnsignedByteFieldU8::new(3);
2023-07-25 00:42:31 +02:00
let common_pdu_cfg = CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-18 11:08:46 +02:00
.expect("common config creation failed");
let pdu_header = PduHeader::new_no_file_data(common_pdu_cfg, 5);
let mut buf: [u8; 7] = [0; 7];
let res = pdu_header.write_to_bytes(&mut buf);
2023-05-18 11:08:46 +02:00
assert!(res.is_ok());
buf[0] &= !0b1110_0000;
buf[0] |= (CFDP_VERSION_2 + 1) << 5;
let res = PduHeader::from_bytes(&buf);
2023-05-18 11:08:46 +02:00
assert!(res.is_err());
let error = res.unwrap_err();
if let PduError::CfdpVersionMissmatch(raw_version) = error {
assert_eq!(raw_version, CFDP_VERSION_2 + 1);
} else {
panic!("invalid exception: {}", error);
}
}
#[test]
fn test_buf_too_small_1() {
let buf: [u8; 3] = [0; 3];
let res = PduHeader::from_bytes(&buf);
2023-05-18 11:08:46 +02:00
assert!(res.is_err());
let error = res.unwrap_err();
2023-08-18 10:09:32 +02:00
if let PduError::ByteConversionError(ByteConversionError::FromSliceTooSmall {
found,
expected,
}) = error
2023-05-18 11:08:46 +02:00
{
2023-08-18 10:09:32 +02:00
assert_eq!(found, 3);
assert_eq!(expected, FIXED_HEADER_LEN);
2023-05-18 11:08:46 +02:00
} else {
panic!("invalid exception: {}", error);
}
}
#[test]
fn test_buf_too_small_2() {
2023-05-18 13:32:45 +02:00
let src_id = UnsignedByteFieldU8::new(1);
let dest_id = UnsignedByteFieldU8::new(2);
let transaction_id = UnsignedByteFieldU8::new(3);
2023-07-25 00:42:31 +02:00
let common_pdu_cfg = CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-18 11:08:46 +02:00
.expect("common config creation failed");
let pdu_header = PduHeader::new_no_file_data(common_pdu_cfg, 5);
let mut buf: [u8; 7] = [0; 7];
let res = pdu_header.write_to_bytes(&mut buf);
2023-05-18 11:08:46 +02:00
assert!(res.is_ok());
let header = PduHeader::from_bytes(&buf[0..6]);
2023-05-18 11:08:46 +02:00
assert!(header.is_err());
let error = header.unwrap_err();
2023-08-18 10:09:32 +02:00
if let PduError::ByteConversionError(ByteConversionError::FromSliceTooSmall {
found,
expected,
}) = error
2023-05-18 11:08:46 +02:00
{
2023-08-18 10:09:32 +02:00
assert_eq!(found, 6);
assert_eq!(expected, 7);
2023-05-18 11:08:46 +02:00
}
}
2023-05-18 13:32:45 +02:00
#[test]
fn test_invalid_seq_len() {
let src_id = UbfU8::new(1);
let dest_id = UbfU8::new(2);
let transaction_seq_id = UbfU8::new(3);
let invalid_byte_field = UnsignedByteField::new(3, 5);
2023-07-25 00:42:31 +02:00
let pdu_conf_res =
CommonPduConfig::new_with_byte_fields(src_id, dest_id, invalid_byte_field);
2023-05-18 13:32:45 +02:00
assert!(pdu_conf_res.is_err());
let error = pdu_conf_res.unwrap_err();
if let PduError::InvalidTransactionSeqNumLen(len) = error {
assert_eq!(len, 3);
} else {
panic!("Invalid exception: {}", error)
}
2023-07-25 00:42:31 +02:00
let pdu_conf_res = CommonPduConfig::new_with_byte_fields(
2023-05-18 13:32:45 +02:00
invalid_byte_field,
invalid_byte_field,
transaction_seq_id,
);
assert!(pdu_conf_res.is_err());
let error = pdu_conf_res.unwrap_err();
if let PduError::InvalidEntityLen(len) = error {
assert_eq!(len, 3);
} else {
panic!("Invalid exception: {}", error)
}
}
#[test]
fn test_missmatch_src_dest_id() {
let src_id = UnsignedByteField::new(1, 5);
let dest_id = UnsignedByteField::new(2, 5);
let transaction_seq_id = UbfU8::new(3);
2023-07-25 00:42:31 +02:00
let pdu_conf_res =
CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_seq_id);
2023-05-18 13:32:45 +02:00
assert!(pdu_conf_res.is_err());
let error = pdu_conf_res.unwrap_err();
2023-08-17 22:13:00 +02:00
if let PduError::SourceDestIdLenMissmatch {
src_id_len,
dest_id_len,
} = error
{
2023-08-17 21:24:12 +02:00
assert_eq!(src_id_len, 1);
assert_eq!(dest_id_len, 2);
2023-05-18 13:32:45 +02:00
}
}
#[test]
fn test_invalid_raw_src_id_len() {
let src_id = UnsignedByteFieldU8::new(1);
let dest_id = UnsignedByteFieldU8::new(2);
let transaction_id = UnsignedByteFieldU8::new(3);
2023-07-25 00:42:31 +02:00
let common_pdu_cfg = CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-18 13:32:45 +02:00
.expect("common config creation failed");
let pdu_header = PduHeader::new_no_file_data(common_pdu_cfg, 5);
let mut buf: [u8; 7] = [0; 7];
let res = pdu_header.write_to_bytes(&mut buf);
2023-05-18 13:32:45 +02:00
assert!(res.is_ok());
buf[3] &= !0b0111_0000;
// Equivalent to the length of three
buf[3] |= 0b10 << 4;
let header_res = PduHeader::from_bytes(&buf);
2023-05-18 13:32:45 +02:00
assert!(header_res.is_err());
let error = header_res.unwrap_err();
if let PduError::InvalidEntityLen(len) = error {
assert_eq!(len, 3);
} else {
panic!("invalid exception {:?}", error)
}
}
#[test]
fn test_invalid_transaction_seq_id_len() {
let src_id = UnsignedByteFieldU8::new(1);
let dest_id = UnsignedByteFieldU8::new(2);
let transaction_id = UnsignedByteFieldU8::new(3);
2023-07-25 00:42:31 +02:00
let common_pdu_cfg = CommonPduConfig::new_with_byte_fields(src_id, dest_id, transaction_id)
2023-05-18 13:32:45 +02:00
.expect("common config creation failed");
let pdu_header = PduHeader::new_no_file_data(common_pdu_cfg, 5);
let mut buf: [u8; 7] = [0; 7];
let res = pdu_header.write_to_bytes(&mut buf);
2023-05-18 13:32:45 +02:00
assert!(res.is_ok());
buf[3] &= !0b0000_0111;
// Equivalent to the length of three
buf[3] |= 0b10;
let header_res = PduHeader::from_bytes(&buf);
2023-05-18 13:32:45 +02:00
assert!(header_res.is_err());
let error = header_res.unwrap_err();
if let PduError::InvalidTransactionSeqNumLen(len) = error {
assert_eq!(len, 3);
} else {
panic!("invalid exception {:?}", error)
}
}
2023-05-14 20:10:34 +02:00
}