rust/cfdp
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Add acknowledged destination handler

Browse Source
This commit is contained in:
Robin Mueller
2025-09-12 15:56:17 +02:00
parent 8e755fd7b2
commit c0a7dfd9f8
9 changed files with 2802 additions and 739 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View File

@@ -29,7 +29,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@1.85.0
- uses: dtolnay/rust-toolchain@1.86.0
- run: cargo check --release
cross-check:

5
Cargo.toml
View File

@@ -2,7 +2,7 @@
name = "cfdp-rs"
version = "0.2.0"
edition = "2024"
rust-version = "1.85.0"
rust-version = "1.86.0"
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
description = "High level CCSDS File Delivery Protocol components"
homepage = "https://egit.irs.uni-stuttgart.de/rust/cfdp"
@@ -22,6 +22,7 @@ derive-new = ">=0.6, <=0.7"
hashbrown = { version = ">=0.14, <=0.15", optional = true }
spacepackets = { git = "https://egit.irs.uni-stuttgart.de/rust/spacepackets.git", version = "0.16", default-features = false }
thiserror = { version = "2", default-features = false }
heapless = "0.9"
serde = { version = "1", optional = true }
defmt = { version = "1", optional = true }
@@ -36,7 +37,7 @@ alloc = [
"hashbrown",
"spacepackets/alloc"
]
serde = ["dep:serde", "spacepackets/serde", "hashbrown/serde"]
serde = ["dep:serde", "spacepackets/serde", "hashbrown/serde", "heapless/serde"]
defmt = ["dep:defmt", "spacepackets/defmt"]
[dev-dependencies]

13
examples/python-interop/main.rs
View File

@@ -13,9 +13,10 @@ use std::{
use cfdp::{
EntityType, IndicationConfig, LocalEntityConfig, PduOwnedWithInfo, PduProvider,
RemoteEntityConfig, StdTimerCreator, TransactionId, UserFaultHookProvider,
RemoteEntityConfig, StdTimerCreator, TransactionId, UserFaultHook,
dest::DestinationHandler,
filestore::NativeFilestore,
lost_segments::LostSegmentsList,
request::{PutRequestOwned, StaticPutRequestCacher},
source::SourceHandler,
user::{CfdpUser, FileSegmentRecvdParams, MetadataReceivedParams, TransactionFinishedParams},
@@ -62,7 +63,7 @@ pub struct Cli {
#[derive(Default)]
pub struct ExampleFaultHandler {}
impl UserFaultHookProvider for ExampleFaultHandler {
impl UserFaultHook for ExampleFaultHandler {
fn notice_of_suspension_cb(
&mut self,
transaction_id: TransactionId,
@@ -261,7 +262,7 @@ impl UdpServer {
while let Ok(tm) = receiver.try_recv() {
debug!("Sending PDU: {:?}", tm);
pdu_printout(&tm);
let result = self.socket.send_to(tm.pdu(), self.remote_addr());
let result = self.socket.send_to(tm.raw_pdu(), self.remote_addr());
if let Err(e) = result {
warn!("Sending TM with UDP socket failed: {e}")
}
@@ -284,7 +285,7 @@ fn pdu_printout(pdu: &PduOwnedWithInfo) {
spacepackets::cfdp::pdu::FileDirectiveType::AckPdu => (),
spacepackets::cfdp::pdu::FileDirectiveType::MetadataPdu => {
let meta_pdu =
MetadataPduReader::new(pdu.pdu()).expect("creating metadata pdu failed");
MetadataPduReader::new(pdu.raw_pdu()).expect("creating metadata pdu failed");
debug!("Metadata PDU: {:?}", meta_pdu)
}
spacepackets::cfdp::pdu::FileDirectiveType::NakPdu => (),
@@ -292,7 +293,8 @@ fn pdu_printout(pdu: &PduOwnedWithInfo) {
spacepackets::cfdp::pdu::FileDirectiveType::KeepAlivePdu => (),
},
spacepackets::cfdp::PduType::FileData => {
let fd_pdu = FileDataPdu::from_bytes(pdu.pdu()).expect("creating file data pdu failed");
let fd_pdu =
FileDataPdu::from_bytes(pdu.raw_pdu()).expect("creating file data pdu failed");
debug!("File data PDU: {:?}", fd_pdu);
}
}
@@ -367,6 +369,7 @@ fn main() {
NativeFilestore::default(),
remote_cfg_python,
StdTimerCreator::default(),
LostSegmentsList::default(),
);
let mut cfdp_user_dest = ExampleCfdpUser::new(EntityType::Receiving);

1531
src/dest.rs
View File

File diff suppressed because it is too large Load Diff

263
src/lib.rs
View File

@@ -93,13 +93,14 @@ extern crate std;
#[cfg(feature = "alloc")]
pub mod dest;
pub mod filestore;
pub mod lost_segments;
pub mod request;
#[cfg(feature = "alloc")]
pub mod source;
pub mod time;
pub mod user;
use crate::time::CountdownProvider;
use crate::time::Countdown;
use core::{cell::RefCell, fmt::Debug, hash::Hash};
use crc::{CRC_32_ISCSI, CRC_32_ISO_HDLC, Crc};
@@ -180,8 +181,8 @@ pub enum TimerContext {
/// The timer will be used to perform the Positive Acknowledgement Procedures as specified in
/// 4.7. 1of the CFDP standard. The expiration period will be provided by the Positive ACK timer
/// interval of the remote entity configuration.
pub trait TimerCreatorProvider {
type Countdown: CountdownProvider;
pub trait TimerCreator {
type Countdown: Countdown;
fn create_countdown(&self, timer_context: TimerContext) -> Self::Countdown;
}
@@ -256,12 +257,12 @@ pub struct RemoteEntityConfig {
pub crc_on_transmission_by_default: bool,
pub default_transmission_mode: TransmissionMode,
pub default_crc_type: ChecksumType,
pub positive_ack_timer_interval_seconds: f32,
pub positive_ack_timer_interval: Duration,
pub positive_ack_timer_expiration_limit: u32,
pub check_limit: u32,
pub disposition_on_cancellation: bool,
pub immediate_nak_mode: bool,
pub nak_timer_interval_seconds: f32,
pub nak_timer_interval: Duration,
pub nak_timer_expiration_limit: u32,
}
@@ -283,26 +284,33 @@ impl RemoteEntityConfig {
default_transmission_mode,
default_crc_type,
check_limit: 2,
positive_ack_timer_interval_seconds: 10.0,
positive_ack_timer_interval: Duration::from_secs(10),
positive_ack_timer_expiration_limit: 2,
disposition_on_cancellation: false,
immediate_nak_mode: true,
nak_timer_interval_seconds: 10.0,
nak_timer_interval: Duration::from_secs(10),
nak_timer_expiration_limit: 2,
}
}
}
pub trait RemoteEntityConfigProvider {
#[derive(Debug, PartialEq, Eq, thiserror::Error)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum RemoteConfigStoreError {
#[error("store is full")]
Full,
}
pub trait RemoteConfigStore {
/// Retrieve the remote entity configuration for the given remote ID.
fn get(&self, remote_id: u64) -> Option<&RemoteEntityConfig>;
fn get_mut(&mut self, remote_id: u64) -> Option<&mut RemoteEntityConfig>;
/// Add a new remote configuration. Return [true] if the configuration was
/// inserted successfully, and [false] if a configuration already exists.
fn add_config(&mut self, cfg: &RemoteEntityConfig) -> bool;
/// Remote a configuration. Returns [true] if the configuration was removed successfully,
/// and [false] if no configuration exists for the given remote ID.
fn remove_config(&mut self, remote_id: u64) -> bool;
fn add_config(&mut self, cfg: &RemoteEntityConfig) -> Result<bool, RemoteConfigStoreError>;
}
/// This is a thin wrapper around a [hashbrown::HashMap] to store remote entity configurations.
@@ -310,20 +318,26 @@ pub trait RemoteEntityConfigProvider {
#[cfg(feature = "alloc")]
#[derive(Default, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct StdRemoteEntityConfigProvider(pub hashbrown::HashMap<u64, RemoteEntityConfig>);
pub struct RemoteConfigStoreStd(pub hashbrown::HashMap<u64, RemoteEntityConfig>);
#[cfg(feature = "std")]
impl RemoteEntityConfigProvider for StdRemoteEntityConfigProvider {
impl RemoteConfigStore for RemoteConfigStoreStd {
fn get(&self, remote_id: u64) -> Option<&RemoteEntityConfig> {
self.0.get(&remote_id)
}
fn get_mut(&mut self, remote_id: u64) -> Option<&mut RemoteEntityConfig> {
self.0.get_mut(&remote_id)
}
fn add_config(&mut self, cfg: &RemoteEntityConfig) -> bool {
self.0.insert(cfg.entity_id.value(), *cfg).is_some()
fn add_config(&mut self, cfg: &RemoteEntityConfig) -> Result<bool, RemoteConfigStoreError> {
Ok(self.0.insert(cfg.entity_id.value(), *cfg).is_some())
}
fn remove_config(&mut self, remote_id: u64) -> bool {
}
#[cfg(feature = "std")]
impl RemoteConfigStoreStd {
pub fn remove_config(&mut self, remote_id: u64) -> bool {
self.0.remove(&remote_id).is_some()
}
}
@@ -334,10 +348,10 @@ impl RemoteEntityConfigProvider for StdRemoteEntityConfigProvider {
#[derive(Default, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct VecRemoteEntityConfigProvider(pub alloc::vec::Vec<RemoteEntityConfig>);
pub struct RemoteConfigList(pub alloc::vec::Vec<RemoteEntityConfig>);
#[cfg(feature = "alloc")]
impl RemoteEntityConfigProvider for VecRemoteEntityConfigProvider {
impl RemoteConfigStore for RemoteConfigList {
fn get(&self, remote_id: u64) -> Option<&RemoteEntityConfig> {
self.0
.iter()
@@ -350,12 +364,19 @@ impl RemoteEntityConfigProvider for VecRemoteEntityConfigProvider {
.find(|cfg| cfg.entity_id.value() == remote_id)
}
fn add_config(&mut self, cfg: &RemoteEntityConfig) -> bool {
fn add_config(&mut self, cfg: &RemoteEntityConfig) -> Result<bool, RemoteConfigStoreError> {
for other_cfg in self.0.iter() {
if cfg.entity_id.value() == other_cfg.entity_id.value() {
return Ok(false);
}
}
self.0.push(*cfg);
true
Ok(true)
}
}
fn remove_config(&mut self, remote_id: u64) -> bool {
impl RemoteConfigList {
pub fn remove_config(&mut self, remote_id: u64) -> bool {
for (idx, cfg) in self.0.iter().enumerate() {
if cfg.entity_id.value() == remote_id {
self.0.remove(idx);
@@ -366,10 +387,55 @@ impl RemoteEntityConfigProvider for VecRemoteEntityConfigProvider {
}
}
/// A remote entity configurations also implements the [RemoteEntityConfigProvider], but the
/// [RemoteEntityConfigProvider::add_config] and [RemoteEntityConfigProvider::remove_config]
/// are no-ops and always returns [false].
impl RemoteEntityConfigProvider for RemoteEntityConfig {
/// This is a thin wrapper around a [alloc::vec::Vec] to store remote entity configurations.
/// It implements the full [RemoteEntityConfigProvider] trait.
#[derive(Default, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct RemoteConfigListHeapless<const N: usize>(pub heapless::vec::Vec<RemoteEntityConfig, N>);
impl<const N: usize> RemoteConfigStore for RemoteConfigListHeapless<N> {
fn get(&self, remote_id: u64) -> Option<&RemoteEntityConfig> {
self.0
.iter()
.find(|&cfg| cfg.entity_id.value() == remote_id)
}
fn get_mut(&mut self, remote_id: u64) -> Option<&mut RemoteEntityConfig> {
self.0
.iter_mut()
.find(|cfg| cfg.entity_id.value() == remote_id)
}
fn add_config(&mut self, cfg: &RemoteEntityConfig) -> Result<bool, RemoteConfigStoreError> {
if self.0.is_full() {
return Err(RemoteConfigStoreError::Full);
}
for other_cfg in self.0.iter() {
if cfg.entity_id.value() == other_cfg.entity_id.value() {
return Ok(false);
}
}
self.0.push(*cfg).unwrap();
Ok(true)
}
}
impl<const N: usize> RemoteConfigListHeapless<N> {
pub fn remove_config(&mut self, remote_id: u64) -> bool {
for (idx, cfg) in self.0.iter().enumerate() {
if cfg.entity_id.value() == remote_id {
self.0.remove(idx);
return true;
}
}
false
}
}
/// A remote entity configurations also implements the [RemoteConfigStore], but the
/// [RemoteConfigStore::add_config] always returns [RemoteConfigStoreError::Full].
impl RemoteConfigStore for RemoteEntityConfig {
fn get(&self, remote_id: u64) -> Option<&RemoteEntityConfig> {
if remote_id == self.entity_id.value() {
return Some(self);
@@ -384,12 +450,8 @@ impl RemoteEntityConfigProvider for RemoteEntityConfig {
None
}
fn add_config(&mut self, _cfg: &RemoteEntityConfig) -> bool {
false
}
fn remove_config(&mut self, _remote_id: u64) -> bool {
false
fn add_config(&mut self, _cfg: &RemoteEntityConfig) -> Result<bool, RemoteConfigStoreError> {
Err(RemoteConfigStoreError::Full)
}
}
@@ -403,7 +465,7 @@ impl RemoteEntityConfigProvider for RemoteEntityConfig {
///
/// For each error reported by the [FaultHandler], the appropriate fault handler callback
/// will be called depending on the [FaultHandlerCode].
pub trait UserFaultHookProvider {
pub trait UserFaultHook {
fn notice_of_suspension_cb(
&mut self,
transaction_id: TransactionId,
@@ -428,7 +490,7 @@ pub trait UserFaultHookProvider {
#[derive(Default, Debug, PartialEq, Eq, Copy, Clone)]
pub struct DummyFaultHook {}
impl UserFaultHookProvider for DummyFaultHook {
impl UserFaultHook for DummyFaultHook {
fn notice_of_suspension_cb(
&mut self,
_transaction_id: TransactionId,
@@ -476,14 +538,14 @@ impl UserFaultHookProvider for DummyFaultHook {
/// These defaults can be overriden by using the [Self::set_fault_handler] method.
/// Please note that in any case, fault handler overrides can be specified by the sending CFDP
/// entity.
pub struct FaultHandler<UserHandler: UserFaultHookProvider> {
pub struct FaultHandler<UserHandler: UserFaultHook> {
handler_array: [FaultHandlerCode; 10],
// Could also change the user fault handler trait to have non mutable methods, but that limits
// flexbility on the user side..
pub user_hook: RefCell<UserHandler>,
}
impl<UserHandler: UserFaultHookProvider> FaultHandler<UserHandler> {
impl<UserHandler: UserFaultHook> FaultHandler<UserHandler> {
fn condition_code_to_array_index(conditon_code: ConditionCode) -> Option<usize> {
Some(match conditon_code {
ConditionCode::PositiveAckLimitReached => 0,
@@ -589,17 +651,17 @@ impl Default for IndicationConfig {
}
/// Each CFDP entity handler has a [LocalEntityConfig]uration.
pub struct LocalEntityConfig<UserFaultHook: UserFaultHookProvider> {
pub struct LocalEntityConfig<UserFaultHookInstance: UserFaultHook> {
pub id: UnsignedByteField,
pub indication_cfg: IndicationConfig,
pub fault_handler: FaultHandler<UserFaultHook>,
pub fault_handler: FaultHandler<UserFaultHookInstance>,
}
impl<UserFaultHook: UserFaultHookProvider> LocalEntityConfig<UserFaultHook> {
impl<UserFaultHookInstance: UserFaultHook> LocalEntityConfig<UserFaultHookInstance> {
pub fn new(
id: UnsignedByteField,
indication_cfg: IndicationConfig,
hook: UserFaultHook,
hook: UserFaultHookInstance,
) -> Self {
Self {
id,
@@ -609,12 +671,12 @@ impl<UserFaultHook: UserFaultHookProvider> LocalEntityConfig<UserFaultHook> {
}
}
impl<UserFaultHook: UserFaultHookProvider> LocalEntityConfig<UserFaultHook> {
pub fn user_fault_hook_mut(&mut self) -> &mut RefCell<UserFaultHook> {
impl<UserFaultHookInstance: UserFaultHook> LocalEntityConfig<UserFaultHookInstance> {
pub fn user_fault_hook_mut(&mut self) -> &mut RefCell<UserFaultHookInstance> {
&mut self.fault_handler.user_hook
}
pub fn user_fault_hook(&self) -> &RefCell<UserFaultHook> {
pub fn user_fault_hook(&self) -> &RefCell<UserFaultHookInstance> {
&self.fault_handler.user_hook
}
}
@@ -638,6 +700,14 @@ pub trait PduSendProvider {
file_directive_type: Option<FileDirectiveType>,
raw_pdu: &[u8],
) -> Result<(), GenericSendError>;
fn send_file_directive_pdu(
&self,
file_directive_type: FileDirectiveType,
raw_pdu: &[u8],
) -> Result<(), GenericSendError> {
self.send_pdu(PduType::FileDirective, Some(file_directive_type), raw_pdu)
}
}
#[cfg(feature = "std")]
@@ -683,7 +753,7 @@ pub mod std_mod {
}
}
impl CountdownProvider for StdCountdown {
impl Countdown for StdCountdown {
fn has_expired(&self) -> bool {
if self.start_time.elapsed() > self.expiry_time {
return true;
@@ -714,7 +784,7 @@ pub mod std_mod {
}
}
impl TimerCreatorProvider for StdTimerCreator {
impl TimerCreator for StdTimerCreator {
type Countdown = StdCountdown;
fn create_countdown(&self, timer_context: TimerContext) -> Self::Countdown {
@@ -800,7 +870,7 @@ pub enum PacketTarget {
pub trait PduProvider {
fn pdu_type(&self) -> PduType;
fn file_directive_type(&self) -> Option<FileDirectiveType>;
fn pdu(&self) -> &[u8];
fn raw_pdu(&self) -> &[u8];
fn packet_target(&self) -> Result<PacketTarget, PduError>;
}
@@ -815,7 +885,7 @@ impl PduProvider for DummyPduProvider {
None
}
fn pdu(&self) -> &[u8] {
fn raw_pdu(&self) -> &[u8] {
&[]
}
@@ -927,7 +997,7 @@ impl PduProvider for PduRawWithInfo<'_> {
self.file_directive_type
}
fn pdu(&self) -> &[u8] {
fn raw_pdu(&self) -> &[u8] {
self.raw_packet
}
@@ -989,7 +1059,7 @@ pub mod alloc_mod {
self.file_directive_type
}
fn pdu(&self) -> &[u8] {
fn raw_pdu(&self) -> &[u8] {
&self.pdu
}
@@ -999,6 +1069,12 @@ pub mod alloc_mod {
}
}
#[derive(Debug)]
struct PositiveAckParams<CountdownInstance: Countdown> {
ack_timer: CountdownInstance,
ack_counter: u32,
}
#[cfg(test)]
pub(crate) mod tests {
use core::{
@@ -1016,6 +1092,7 @@ pub(crate) mod tests {
CommonPduConfig, FileDirectiveType, PduHeader,
eof::EofPdu,
file_data::FileDataPdu,
finished::{DeliveryCode, FileStatus},
metadata::{MetadataGenericParams, MetadataPduCreator},
},
},
@@ -1057,7 +1134,7 @@ pub(crate) mod tests {
expiry_control: TimerExpiryControl,
}
impl CountdownProvider for TestCheckTimer {
impl Countdown for TestCheckTimer {
fn has_expired(&self) -> bool {
match self.context {
TimerContext::CheckLimit {
@@ -1117,7 +1194,7 @@ pub(crate) mod tests {
}
}
impl TimerCreatorProvider for TestCheckTimerCreator {
impl TimerCreator for TestCheckTimerCreator {
type Countdown = TestCheckTimer;
fn create_countdown(&self, timer_context: TimerContext) -> Self::Countdown {
@@ -1135,6 +1212,7 @@ pub(crate) mod tests {
}
}
#[derive(Debug)]
pub struct FileSegmentRecvdParamsNoSegMetadata {
#[allow(dead_code)]
pub id: TransactionId,
@@ -1142,8 +1220,9 @@ pub(crate) mod tests {
pub length: usize,
}
#[derive(Default)]
#[derive(Default, Debug)]
pub struct TestCfdpUser {
pub check_queues_empty_on_drop: bool,
pub next_expected_seq_num: u64,
pub expected_full_src_name: String,
pub expected_full_dest_name: String,
@@ -1164,6 +1243,7 @@ pub(crate) mod tests {
expected_file_size: u64,
) -> Self {
Self {
check_queues_empty_on_drop: true,
next_expected_seq_num,
expected_full_src_name,
expected_full_dest_name,
@@ -1181,6 +1261,36 @@ pub(crate) mod tests {
assert_eq!(id.source_id, LOCAL_ID.into());
assert_eq!(id.seq_num().value(), self.next_expected_seq_num);
}
pub fn indication_queues_empty(&self) -> bool {
self.finished_indic_queue.is_empty()
&& self.metadata_recv_queue.is_empty()
&& self.file_seg_recvd_queue.is_empty()
}
pub fn verify_finished_indication_retained(
&mut self,
delivery_code: DeliveryCode,
cond_code: ConditionCode,
id: TransactionId,
) {
self.verify_finished_indication(delivery_code, cond_code, id, FileStatus::Retained);
}
pub fn verify_finished_indication(
&mut self,
delivery_code: DeliveryCode,
cond_code: ConditionCode,
id: TransactionId,
file_status: FileStatus,
) {
assert_eq!(self.finished_indic_queue.len(), 1);
let finished_indication = self.finished_indic_queue.pop_front().unwrap();
assert_eq!(finished_indication.id, id);
assert_eq!(finished_indication.condition_code, cond_code);
assert_eq!(finished_indication.delivery_code, delivery_code);
assert_eq!(finished_indication.file_status, file_status);
}
}
impl CfdpUser for TestCfdpUser {
@@ -1270,6 +1380,20 @@ pub(crate) mod tests {
}
}
impl Drop for TestCfdpUser {
fn drop(&mut self) {
if self.check_queues_empty_on_drop {
assert!(
self.indication_queues_empty(),
"indication queues not empty on drop: finished: {}, metadata: {}, file seg: {}",
self.finished_indic_queue.len(),
self.metadata_recv_queue.len(),
self.file_seg_recvd_queue.len()
);
}
}
}
#[derive(Default, Debug)]
pub(crate) struct TestFaultHandler {
pub notice_of_suspension_queue: VecDeque<(TransactionId, ConditionCode, u64)>,
@@ -1278,7 +1402,7 @@ pub(crate) mod tests {
pub ignored_queue: VecDeque<(TransactionId, ConditionCode, u64)>,
}
impl UserFaultHookProvider for TestFaultHandler {
impl UserFaultHook for TestFaultHandler {
fn notice_of_suspension_cb(
&mut self,
transaction_id: TransactionId,
@@ -1383,8 +1507,8 @@ pub(crate) mod tests {
dest_id: impl Into<UnsignedByteField>,
max_packet_len: usize,
crc_on_transmission_by_default: bool,
) -> StdRemoteEntityConfigProvider {
let mut table = StdRemoteEntityConfigProvider::default();
) -> RemoteConfigStoreStd {
let mut table = RemoteConfigStoreStd::default();
let remote_entity_cfg = RemoteEntityConfig::new_with_default_values(
dest_id.into(),
max_packet_len,
@@ -1393,7 +1517,7 @@ pub(crate) mod tests {
TransmissionMode::Unacknowledged,
ChecksumType::Crc32,
);
table.add_config(&remote_entity_cfg);
table.add_config(&remote_entity_cfg).unwrap();
table
}
@@ -1534,9 +1658,10 @@ pub(crate) mod tests {
TransmissionMode::Unacknowledged,
ChecksumType::Crc32,
);
assert!(!remote_entity_cfg.add_config(&dummy));
// Removal is no-op.
assert!(!remote_entity_cfg.remove_config(REMOTE_ID.value()));
assert_eq!(
remote_entity_cfg.add_config(&dummy).unwrap_err(),
RemoteConfigStoreError::Full
);
let remote_entity_retrieved = remote_entity_cfg.get(REMOTE_ID.value()).unwrap();
assert_eq!(remote_entity_retrieved.entity_id, REMOTE_ID.into());
// Does not exist.
@@ -1554,9 +1679,9 @@ pub(crate) mod tests {
TransmissionMode::Unacknowledged,
ChecksumType::Crc32,
);
let mut remote_cfg_provider = StdRemoteEntityConfigProvider::default();
let mut remote_cfg_provider = RemoteConfigStoreStd::default();
assert!(remote_cfg_provider.0.is_empty());
remote_cfg_provider.add_config(&remote_entity_cfg);
remote_cfg_provider.add_config(&remote_entity_cfg).unwrap();
assert_eq!(remote_cfg_provider.0.len(), 1);
let remote_entity_cfg_2 = RemoteEntityConfig::new_with_default_values(
LOCAL_ID.into(),
@@ -1568,7 +1693,9 @@ pub(crate) mod tests {
);
let cfg_0 = remote_cfg_provider.get(REMOTE_ID.value()).unwrap();
assert_eq!(cfg_0.entity_id, REMOTE_ID.into());
remote_cfg_provider.add_config(&remote_entity_cfg_2);
remote_cfg_provider
.add_config(&remote_entity_cfg_2)
.unwrap();
assert_eq!(remote_cfg_provider.0.len(), 2);
let cfg_1 = remote_cfg_provider.get(LOCAL_ID.value()).unwrap();
assert_eq!(cfg_1.entity_id, LOCAL_ID.into());
@@ -1582,7 +1709,7 @@ pub(crate) mod tests {
#[test]
fn test_remote_cfg_provider_vector() {
let mut remote_cfg_provider = VecRemoteEntityConfigProvider::default();
let mut remote_cfg_provider = RemoteConfigList::default();
let remote_entity_cfg = RemoteEntityConfig::new_with_default_values(
REMOTE_ID.into(),
1024,
@@ -1592,7 +1719,7 @@ pub(crate) mod tests {
ChecksumType::Crc32,
);
assert!(remote_cfg_provider.0.is_empty());
remote_cfg_provider.add_config(&remote_entity_cfg);
remote_cfg_provider.add_config(&remote_entity_cfg).unwrap();
assert_eq!(remote_cfg_provider.0.len(), 1);
let remote_entity_cfg_2 = RemoteEntityConfig::new_with_default_values(
LOCAL_ID.into(),
@@ -1604,7 +1731,11 @@ pub(crate) mod tests {
);
let cfg_0 = remote_cfg_provider.get(REMOTE_ID.value()).unwrap();
assert_eq!(cfg_0.entity_id, REMOTE_ID.into());
remote_cfg_provider.add_config(&remote_entity_cfg_2);
assert!(
remote_cfg_provider
.add_config(&remote_entity_cfg_2)
.unwrap()
);
assert_eq!(remote_cfg_provider.0.len(), 2);
let cfg_1 = remote_cfg_provider.get(LOCAL_ID.value()).unwrap();
assert_eq!(cfg_1.entity_id, LOCAL_ID.into());
@@ -1634,7 +1765,7 @@ pub(crate) mod tests {
let dummy_pdu_provider = DummyPduProvider(());
assert_eq!(dummy_pdu_provider.pdu_type(), PduType::FileData);
assert!(dummy_pdu_provider.file_directive_type().is_none());
assert_eq!(dummy_pdu_provider.pdu(), &[]);
assert_eq!(dummy_pdu_provider.raw_pdu(), &[]);
assert_eq!(
dummy_pdu_provider.packet_target(),
Ok(PacketTarget::SourceEntity)

1339
src/lost_segments.rs Normal file
View File

File diff suppressed because it is too large Load Diff

380
src/source.rs
View File

@@ -40,7 +40,6 @@ use core::{
cell::{Cell, RefCell},
ops::ControlFlow,
str::Utf8Error,
time::Duration,
};
use spacepackets::{
@@ -68,13 +67,13 @@ use spacepackets::{
use spacepackets::seq_count::SequenceCounter;
use crate::{
DummyPduProvider, EntityType, GenericSendError, PduProvider, TimerCreatorProvider,
time::CountdownProvider,
DummyPduProvider, EntityType, GenericSendError, PduProvider, PositiveAckParams, TimerCreator,
time::Countdown,
};
use super::{
LocalEntityConfig, PacketTarget, PduSendProvider, RemoteEntityConfig,
RemoteEntityConfigProvider, State, TransactionId, UserFaultHookProvider,
LocalEntityConfig, PacketTarget, PduSendProvider, RemoteConfigStore, RemoteEntityConfig, State,
TransactionId, UserFaultHook,
filestore::{FilestoreError, VirtualFilestore},
request::{ReadablePutRequest, StaticPutRequestCacher},
user::{CfdpUser, TransactionFinishedParams},
@@ -94,7 +93,6 @@ pub enum TransactionStep {
SendingEof = 6,
WaitingForEofAck = 7,
WaitingForFinished = 8,
//SendingAckOfFinished = 9,
NoticeOfCompletion = 10,
}
@@ -204,12 +202,6 @@ pub enum PutRequestError {
FilestoreError(#[from] FilestoreError),
}
#[derive(Debug)]
struct PositiveAckParams<Countdown: CountdownProvider> {
ack_timer: Countdown,
ack_counter: u32,
}
#[derive(Debug, Default, Clone, Copy)]
pub struct AnomalyTracker {
invalid_ack_directive_code: u8,
@@ -251,18 +243,18 @@ pub enum FsmContext {
/// thread pool, or move the newly created handler to a new thread.
pub struct SourceHandler<
PduSender: PduSendProvider,
UserFaultHook: UserFaultHookProvider,
UserFaultHookInstance: UserFaultHook,
Vfs: VirtualFilestore,
RemoteCfgTable: RemoteEntityConfigProvider,
TimerCreator: TimerCreatorProvider<Countdown = Countdown>,
Countdown: CountdownProvider,
RemoteConfigStoreInstance: RemoteConfigStore,
TimerCreatorInstance: TimerCreator<Countdown = CountdownInstance>,
CountdownInstance: Countdown,
SequenceCounterInstance: SequenceCounter,
> {
local_cfg: LocalEntityConfig<UserFaultHook>,
local_cfg: LocalEntityConfig<UserFaultHookInstance>,
pdu_sender: PduSender,
pdu_and_cksum_buffer: RefCell<alloc::vec::Vec<u8>>,
put_request_cacher: StaticPutRequestCacher,
remote_cfg_table: RemoteCfgTable,
remote_cfg_table: RemoteConfigStoreInstance,
vfs: Vfs,
state_helper: StateHelper,
// Transfer related state information
@@ -271,29 +263,29 @@ pub struct SourceHandler<
file_params: FileParams,
// PDU configuration is cached so it can be re-used for all PDUs generated for file transfers.
pdu_conf: CommonPduConfig,
check_timer: RefCell<Option<Countdown>>,
positive_ack_params: RefCell<Option<PositiveAckParams<Countdown>>>,
timer_creator: TimerCreator,
check_timer: RefCell<Option<CountdownInstance>>,
positive_ack_params: RefCell<Option<PositiveAckParams<CountdownInstance>>>,
timer_creator: TimerCreatorInstance,
seq_count_provider: SequenceCounterInstance,
anomalies: AnomalyTracker,
}
impl<
PduSender: PduSendProvider,
UserFaultHook: UserFaultHookProvider,
UserFaultHookInstance: UserFaultHook,
Vfs: VirtualFilestore,
RemoteCfgTable: RemoteEntityConfigProvider,
TimerCreator: TimerCreatorProvider<Countdown = Countdown>,
Countdown: CountdownProvider,
RemoteConfigStoreInstance: RemoteConfigStore,
TimerCreatorInstance: TimerCreator<Countdown = CountdownInstance>,
CountdownInstance: Countdown,
SequenceCounterInstance: SequenceCounter,
>
SourceHandler<
PduSender,
UserFaultHook,
UserFaultHookInstance,
Vfs,
RemoteCfgTable,
TimerCreator,
Countdown,
RemoteConfigStoreInstance,
TimerCreatorInstance,
CountdownInstance,
SequenceCounterInstance,
>
{
@@ -321,13 +313,13 @@ impl<
/// which contains an incrementing counter.
#[allow(clippy::too_many_arguments)]
pub fn new(
cfg: LocalEntityConfig<UserFaultHook>,
cfg: LocalEntityConfig<UserFaultHookInstance>,
pdu_sender: PduSender,
vfs: Vfs,
put_request_cacher: StaticPutRequestCacher,
pdu_and_cksum_buf_size: usize,
remote_cfg_table: RemoteCfgTable,
timer_creator: TimerCreator,
remote_cfg_table: RemoteConfigStoreInstance,
timer_creator: TimerCreatorInstance,
seq_count_provider: SequenceCounterInstance,
) -> Self {
Self {
@@ -416,7 +408,7 @@ impl<
}
#[inline]
pub fn local_cfg(&self) -> &LocalEntityConfig<UserFaultHook> {
pub fn local_cfg(&self) -> &LocalEntityConfig<UserFaultHookInstance> {
&self.local_cfg
}
@@ -551,16 +543,16 @@ impl<
.expect("PDU directive type unexpectedly not set")
{
FileDirectiveType::FinishedPdu => {
let finished_pdu = FinishedPduReader::new(packet_to_insert.pdu())?;
let finished_pdu = FinishedPduReader::new(packet_to_insert.raw_pdu())?;
self.handle_finished_pdu(&finished_pdu)?
}
FileDirectiveType::NakPdu => {
let nak_pdu = NakPduReader::new(packet_to_insert.pdu())?;
let nak_pdu = NakPduReader::new(packet_to_insert.raw_pdu())?;
sent_packets += self.handle_nak_pdu(&nak_pdu)?;
}
FileDirectiveType::KeepAlivePdu => self.handle_keep_alive_pdu(),
FileDirectiveType::AckPdu => {
let ack_pdu = AckPdu::from_bytes(packet_to_insert.pdu())?;
let ack_pdu = AckPdu::from_bytes(packet_to_insert.raw_pdu())?;
self.handle_ack_pdu(&ack_pdu)?
}
FileDirectiveType::EofPdu
@@ -789,12 +781,11 @@ impl<
ack_timer: self
.timer_creator
.create_countdown(crate::TimerContext::PositiveAck {
expiry_time: Duration::from_secs(
self.tstate_ref()
.remote_cfg
.borrow()
.positive_ack_timer_interval_seconds as u64,
),
expiry_time: self
.tstate_ref()
.remote_cfg
.borrow()
.positive_ack_timer_interval,
}),
ack_counter: 0,
})
@@ -844,7 +835,8 @@ impl<
FileDirectiveType::FinishedPdu,
condition_code,
transaction_status,
)?;
)
.map_err(PduError::from)?;
self.pdu_send_helper(&ack_pdu)?;
Ok(())
}
@@ -1203,7 +1195,7 @@ mod tests {
use super::*;
use crate::{
CRC_32, FaultHandler, IndicationConfig, PduRawWithInfo, StdRemoteEntityConfigProvider,
CRC_32, FaultHandler, IndicationConfig, PduRawWithInfo, RemoteConfigStoreStd,
filestore::NativeFilestore,
request::PutRequestOwned,
source::TransactionStep,
@@ -1229,7 +1221,7 @@ mod tests {
TestCfdpSender,
TestFaultHandler,
NativeFilestore,
StdRemoteEntityConfigProvider,
RemoteConfigStoreStd,
TestCheckTimerCreator,
TestCheckTimer,
SequenceCounterSimple<u16>,
@@ -1387,7 +1379,7 @@ mod tests {
transfer_info: &TransferInfo,
seg_reqs: &[(u32, u32)],
) {
let nak_pdu = NakPduCreator::new(
let nak_pdu = NakPduCreator::new_normal_file_size(
transfer_info.pdu_header,
0,
transfer_info.file_size as u32,
@@ -1693,18 +1685,21 @@ mod tests {
Some(false),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, file_size);
let transaction_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
let mut user = tb.create_user(0, file_size);
let transfer_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
tb.common_eof_pdu_check(
&mut cfdp_user,
transaction_info.closure_requested,
&mut user,
transfer_info.closure_requested,
EofParams::new_success(file_size, CRC_32.digest().finalize()),
1,
)
);
user.verify_finished_indication(
DeliveryCode::Complete,
ConditionCode::NoError,
transfer_info.id,
FileStatus::Unreported,
);
}
#[test]
@@ -1719,53 +1714,55 @@ mod tests {
Some(false),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, file_size);
let transaction_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
let mut user = tb.create_user(0, file_size);
let transaction_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
tb.common_eof_pdu_check(
&mut cfdp_user,
&mut user,
transaction_info.closure_requested,
EofParams::new_success(file_size, CRC_32.digest().finalize()),
1,
);
tb.acknowledge_eof_pdu(&mut cfdp_user, &transaction_info);
tb.finish_handling(&mut cfdp_user, &transaction_info);
tb.acknowledge_eof_pdu(&mut user, &transaction_info);
tb.finish_handling(&mut user, &transaction_info);
tb.common_finished_pdu_ack_check();
user.verify_finished_indication_retained(
DeliveryCode::Complete,
ConditionCode::NoError,
transaction_info.id,
);
}
#[test]
fn test_tiny_file_transfer_not_acked_no_closure() {
let mut cfdp_user = TestCfdpUser::default();
let mut user = TestCfdpUser::default();
let mut tb = SourceHandlerTestbench::new(TransmissionMode::Unacknowledged, false, 512);
tb.common_tiny_file_transfer(&mut cfdp_user, false);
tb.common_tiny_file_transfer(&mut user, false);
}
#[test]
fn test_tiny_file_transfer_acked() {
let mut cfdp_user = TestCfdpUser::default();
let mut user = TestCfdpUser::default();
let mut tb = SourceHandlerTestbench::new(TransmissionMode::Acknowledged, false, 512);
let (_data, transfer_info) = tb.common_tiny_file_transfer(&mut cfdp_user, false);
tb.acknowledge_eof_pdu(&mut cfdp_user, &transfer_info);
tb.finish_handling(&mut cfdp_user, &transfer_info);
let (_data, transfer_info) = tb.common_tiny_file_transfer(&mut user, false);
tb.acknowledge_eof_pdu(&mut user, &transfer_info);
tb.finish_handling(&mut user, &transfer_info);
tb.common_finished_pdu_ack_check();
}
#[test]
fn test_tiny_file_transfer_not_acked_with_closure() {
let mut tb = SourceHandlerTestbench::new(TransmissionMode::Unacknowledged, false, 512);
let mut cfdp_user = TestCfdpUser::default();
let (_data, transfer_info) = tb.common_tiny_file_transfer(&mut cfdp_user, true);
tb.finish_handling(&mut cfdp_user, &transfer_info)
let mut user = TestCfdpUser::default();
let (_data, transfer_info) = tb.common_tiny_file_transfer(&mut user, true);
tb.finish_handling(&mut user, &transfer_info)
}
#[test]
fn test_two_segment_file_transfer_not_acked_no_closure() {
let mut tb = SourceHandlerTestbench::new(TransmissionMode::Unacknowledged, false, 128);
let mut cfdp_user = TestCfdpUser::default();
let mut user = TestCfdpUser::default();
let mut file = OpenOptions::new()
.write(true)
.open(&tb.srcfile)
@@ -1775,14 +1772,14 @@ mod tests {
file.write_all(&rand_data)
.expect("writing file content failed");
drop(file);
let (_, fd_pdus) = tb.generic_file_transfer(&mut cfdp_user, false, rand_data.to_vec());
let (_, fd_pdus) = tb.generic_file_transfer(&mut user, false, rand_data.to_vec());
assert_eq!(fd_pdus, 2);
}
#[test]
fn test_two_segment_file_transfer_not_acked_with_closure() {
let mut tb = SourceHandlerTestbench::new(TransmissionMode::Unacknowledged, false, 128);
let mut cfdp_user = TestCfdpUser::default();
let mut user = TestCfdpUser::default();
let mut file = OpenOptions::new()
.write(true)
.open(&tb.srcfile)
@@ -1793,14 +1790,14 @@ mod tests {
.expect("writing file content failed");
drop(file);
let (transfer_info, fd_pdus) =
tb.generic_file_transfer(&mut cfdp_user, true, rand_data.to_vec());
tb.generic_file_transfer(&mut user, true, rand_data.to_vec());
assert_eq!(fd_pdus, 2);
tb.finish_handling(&mut cfdp_user, &transfer_info)
tb.finish_handling(&mut user, &transfer_info)
}
#[test]
fn test_two_segment_file_transfer_acked() {
let mut cfdp_user = TestCfdpUser::default();
let mut user = TestCfdpUser::default();
let mut tb = SourceHandlerTestbench::new(TransmissionMode::Acknowledged, false, 128);
let mut file = OpenOptions::new()
.write(true)
@@ -1812,10 +1809,10 @@ mod tests {
.expect("writing file content failed");
drop(file);
let (transfer_info, fd_pdus) =
tb.generic_file_transfer(&mut cfdp_user, true, rand_data.to_vec());
tb.generic_file_transfer(&mut user, true, rand_data.to_vec());
assert_eq!(fd_pdus, 2);
tb.acknowledge_eof_pdu(&mut cfdp_user, &transfer_info);
tb.finish_handling(&mut cfdp_user, &transfer_info);
tb.acknowledge_eof_pdu(&mut user, &transfer_info);
tb.finish_handling(&mut user, &transfer_info);
tb.common_finished_pdu_ack_check();
}
@@ -1831,19 +1828,21 @@ mod tests {
Some(true),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, file_size);
let transaction_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
let mut user = tb.create_user(0, file_size);
let transaction_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
tb.common_eof_pdu_check(
&mut cfdp_user,
&mut user,
transaction_info.closure_requested,
EofParams::new_success(file_size, CRC_32.digest().finalize()),
1,
);
tb.finish_handling(&mut cfdp_user, &transaction_info)
tb.finish_handling(&mut user, &transaction_info);
user.verify_finished_indication_retained(
DeliveryCode::Complete,
ConditionCode::NoError,
transaction_info.id,
);
}
#[test]
@@ -1905,15 +1904,12 @@ mod tests {
Some(true),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, file_size);
let transaction_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
let mut user = tb.create_user(0, file_size);
let transaction_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
let expected_id = tb.handler.transaction_id().unwrap();
tb.common_eof_pdu_check(
&mut cfdp_user,
&mut user,
transaction_info.closure_requested,
EofParams::new_success(file_size, CRC_32.digest().finalize()),
1,
@@ -1924,10 +1920,7 @@ mod tests {
// cancellation -> leads to an EOF PDU with the appropriate error code.
tb.expiry_control.set_check_limit_expired();
assert_eq!(
tb.handler.state_machine_no_packet(&mut cfdp_user).unwrap(),
1
);
assert_eq!(tb.handler.state_machine_no_packet(&mut user).unwrap(), 1);
assert!(!tb.pdu_queue_empty());
let next_pdu = tb.get_next_sent_pdu().unwrap();
let eof_pdu = EofPdu::from_bytes(&next_pdu.raw_pdu).expect("invalid EOF PDU format");
@@ -1960,9 +1953,9 @@ mod tests {
Some(false),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, filesize);
assert_eq!(cfdp_user.transaction_indication_call_count, 0);
assert_eq!(cfdp_user.eof_sent_call_count, 0);
let mut user = tb.create_user(0, filesize);
assert_eq!(user.transaction_indication_call_count, 0);
assert_eq!(user.eof_sent_call_count, 0);
tb.put_request(&put_request)
.expect("put_request call failed");
@@ -1971,7 +1964,7 @@ mod tests {
assert!(tb.get_next_sent_pdu().is_none());
let id = tb.handler.transaction_id().unwrap();
tb.handler
.cancel_request(&mut cfdp_user, &id)
.cancel_request(&mut user, &id)
.expect("transaction cancellation failed");
assert_eq!(tb.handler.state(), State::Idle);
assert_eq!(tb.handler.step(), TransactionStep::Idle);
@@ -2014,12 +2007,9 @@ mod tests {
)
.expect("creating put request failed");
let file_size = rand_data.len() as u64;
let mut cfdp_user = tb.create_user(0, file_size);
let transaction_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
let mut user = tb.create_user(0, file_size);
let transaction_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
let mut chunks = rand_data.chunks(
calculate_max_file_seg_len_for_max_packet_len_and_pdu_header(
&transaction_info.pdu_header,
@@ -2038,7 +2028,7 @@ mod tests {
let expected_id = tb.handler.transaction_id().unwrap();
assert!(
tb.handler
.cancel_request(&mut cfdp_user, &expected_id)
.cancel_request(&mut user, &expected_id)
.expect("cancellation failed")
);
assert_eq!(tb.handler.state(), State::Idle);
@@ -2077,18 +2067,10 @@ mod tests {
Some(false),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, file_size);
let transfer_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
1,
);
let mut user = tb.create_user(0, file_size);
let transfer_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 1);
assert!(tb.pdu_queue_empty());
@@ -2096,19 +2078,19 @@ mod tests {
tb.expiry_control.set_positive_ack_expired();
let sent_packets = tb
.handler
.state_machine_no_packet(&mut cfdp_user)
.state_machine_no_packet(&mut user)
.expect("source handler FSM failure");
assert_eq!(sent_packets, 1);
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
2,
);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 2);
tb.acknowledge_eof_pdu(&mut cfdp_user, &transfer_info);
tb.finish_handling(&mut cfdp_user, &transfer_info);
tb.acknowledge_eof_pdu(&mut user, &transfer_info);
tb.finish_handling(&mut user, &transfer_info);
tb.common_finished_pdu_ack_check();
user.verify_finished_indication_retained(
DeliveryCode::Complete,
ConditionCode::NoError,
transfer_info.id,
);
}
#[test]
@@ -2124,18 +2106,10 @@ mod tests {
Some(false),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, file_size);
let transfer_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
1,
);
let mut user = tb.create_user(0, file_size);
let transfer_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 1);
assert!(tb.pdu_queue_empty());
@@ -2143,34 +2117,29 @@ mod tests {
tb.expiry_control.set_positive_ack_expired();
let sent_packets = tb
.handler
.state_machine_no_packet(&mut cfdp_user)
.state_machine_no_packet(&mut user)
.expect("source handler FSM failure");
assert_eq!(sent_packets, 1);
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
2,
);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 2);
// Enforce a postive ack timer expiry -> leads to a re-send of the EOF PDU.
tb.expiry_control.set_positive_ack_expired();
let sent_packets = tb
.handler
.state_machine_no_packet(&mut cfdp_user)
.state_machine_no_packet(&mut user)
.expect("source handler FSM failure");
assert_eq!(sent_packets, 1);
eof_params.condition_code = ConditionCode::PositiveAckLimitReached;
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
3,
);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 3);
// This boilerplate handling is still expected. In a real-life use-case I would expect
// this to fail as well, leading to a transaction abandonment. This is tested separately.
tb.acknowledge_eof_pdu(&mut cfdp_user, &transfer_info);
tb.finish_handling(&mut cfdp_user, &transfer_info);
tb.acknowledge_eof_pdu(&mut user, &transfer_info);
tb.finish_handling(&mut user, &transfer_info);
tb.common_finished_pdu_ack_check();
user.verify_finished_indication_retained(
DeliveryCode::Complete,
ConditionCode::NoError,
transfer_info.id,
);
}
#[test]
@@ -2186,18 +2155,10 @@ mod tests {
Some(false),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, file_size);
let transfer_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
1,
);
let mut user = tb.create_user(0, file_size);
let transfer_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 1);
assert!(tb.pdu_queue_empty());
@@ -2205,29 +2166,19 @@ mod tests {
tb.expiry_control.set_positive_ack_expired();
let sent_packets = tb
.handler
.state_machine_no_packet(&mut cfdp_user)
.state_machine_no_packet(&mut user)
.expect("source handler FSM failure");
assert_eq!(sent_packets, 1);
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
2,
);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 2);
// Enforce a postive ack timer expiry -> positive ACK limit reached -> Cancel EOF sent.
tb.expiry_control.set_positive_ack_expired();
let sent_packets = tb
.handler
.state_machine_no_packet(&mut cfdp_user)
.state_machine_no_packet(&mut user)
.expect("source handler FSM failure");
assert_eq!(sent_packets, 1);
eof_params.condition_code = ConditionCode::PositiveAckLimitReached;
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
3,
);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 3);
// Cancellation fault should have been triggered.
let fault_handler = tb.test_fault_handler_mut();
let fh_ref_mut = fault_handler.get_mut();
@@ -2243,22 +2194,17 @@ mod tests {
tb.expiry_control.set_positive_ack_expired();
let sent_packets = tb
.handler
.state_machine_no_packet(&mut cfdp_user)
.state_machine_no_packet(&mut user)
.expect("source handler FSM failure");
assert_eq!(sent_packets, 1);
tb.common_eof_pdu_check(
&mut cfdp_user,
transfer_info.closure_requested,
eof_params,
4,
);
tb.common_eof_pdu_check(&mut user, transfer_info.closure_requested, eof_params, 4);
// Enforce a postive ack timer expiry -> positive ACK limit reached -> Transaction
// abandoned
tb.expiry_control.set_positive_ack_expired();
let sent_packets = tb
.handler
.state_machine_no_packet(&mut cfdp_user)
.state_machine_no_packet(&mut user)
.expect("source handler FSM failure");
assert_eq!(sent_packets, 0);
// Abandonment fault should have been triggered.
@@ -2276,21 +2222,21 @@ mod tests {
#[test]
fn test_nak_for_whole_file() {
let mut tb = SourceHandlerTestbench::new(TransmissionMode::Acknowledged, false, 512);
let mut cfdp_user = TestCfdpUser::default();
let (data, transfer_info) = tb.common_tiny_file_transfer(&mut cfdp_user, true);
let mut user = TestCfdpUser::default();
let (data, transfer_info) = tb.common_tiny_file_transfer(&mut user, true);
let seg_reqs = &[(0, transfer_info.file_size as u32)];
tb.nak_for_file_segments(&mut cfdp_user, &transfer_info, seg_reqs);
tb.nak_for_file_segments(&mut user, &transfer_info, seg_reqs);
tb.check_next_file_pdu(0, data.as_bytes());
tb.all_fault_queues_empty();
tb.acknowledge_eof_pdu(&mut cfdp_user, &transfer_info);
tb.finish_handling(&mut cfdp_user, &transfer_info);
tb.acknowledge_eof_pdu(&mut user, &transfer_info);
tb.finish_handling(&mut user, &transfer_info);
tb.common_finished_pdu_ack_check();
}
#[test]
fn test_nak_for_file_segment() {
let mut cfdp_user = TestCfdpUser::default();
let mut user = TestCfdpUser::default();
let mut tb = SourceHandlerTestbench::new(TransmissionMode::Acknowledged, false, 128);
let mut file = OpenOptions::new()
.write(true)
@@ -2302,14 +2248,14 @@ mod tests {
.expect("writing file content failed");
drop(file);
let (transfer_info, fd_pdus) =
tb.generic_file_transfer(&mut cfdp_user, false, rand_data.to_vec());
tb.generic_file_transfer(&mut user, false, rand_data.to_vec());
assert_eq!(fd_pdus, 2);
tb.nak_for_file_segments(&mut cfdp_user, &transfer_info, &[(0, 90)]);
tb.nak_for_file_segments(&mut user, &transfer_info, &[(0, 90)]);
tb.check_next_file_pdu(0, &rand_data[0..90]);
tb.all_fault_queues_empty();
tb.acknowledge_eof_pdu(&mut cfdp_user, &transfer_info);
tb.finish_handling(&mut cfdp_user, &transfer_info);
tb.acknowledge_eof_pdu(&mut user, &transfer_info);
tb.finish_handling(&mut user, &transfer_info);
tb.common_finished_pdu_ack_check();
}
@@ -2325,21 +2271,18 @@ mod tests {
Some(false),
)
.expect("creating put request failed");
let mut cfdp_user = tb.create_user(0, file_size);
let transfer_info = tb.common_file_transfer_init_with_metadata_check(
&mut cfdp_user,
put_request,
file_size,
);
let mut user = tb.create_user(0, file_size);
let transfer_info =
tb.common_file_transfer_init_with_metadata_check(&mut user, put_request, file_size);
tb.common_eof_pdu_check(
&mut cfdp_user,
&mut user,
transfer_info.closure_requested,
EofParams::new_success(file_size, CRC_32.digest().finalize()),
1,
);
// NAK to cause re-transmission of metadata PDU.
let nak_pdu = NakPduCreator::new(
let nak_pdu = NakPduCreator::new_normal_file_size(
transfer_info.pdu_header,
0,
transfer_info.file_size as u32,
@@ -2350,7 +2293,7 @@ mod tests {
let packet_info = PduRawWithInfo::new(&nak_pdu_vec).unwrap();
let sent_packets = tb
.handler
.state_machine(&mut cfdp_user, Some(&packet_info))
.state_machine(&mut user, Some(&packet_info))
.unwrap();
assert_eq!(sent_packets, 1);
let next_pdu = tb.get_next_sent_pdu().unwrap();
@@ -2358,8 +2301,13 @@ mod tests {
tb.metadata_check(&next_pdu, file_size);
tb.all_fault_queues_empty();
tb.acknowledge_eof_pdu(&mut cfdp_user, &transfer_info);
tb.finish_handling(&mut cfdp_user, &transfer_info);
tb.acknowledge_eof_pdu(&mut user, &transfer_info);
tb.finish_handling(&mut user, &transfer_info);
tb.common_finished_pdu_ack_check();
user.verify_finished_indication_retained(
DeliveryCode::Complete,
ConditionCode::NoError,
transfer_info.id,
);
}
}

2
src/time.rs
View File

@@ -1,7 +1,7 @@
use core::fmt::Debug;
/// Generic abstraction for a check/countdown timer. Should also be cheap to copy and clone.
pub trait CountdownProvider: Debug {
pub trait Countdown: Debug {
fn has_expired(&self) -> bool;
fn reset(&mut self);
}

6
tests/end-to-end.rs
View File

@@ -13,9 +13,10 @@ use std::{
use cfdp::{
EntityType, IndicationConfig, LocalEntityConfig, PduOwnedWithInfo, RemoteEntityConfig,
StdTimerCreator, TransactionId, UserFaultHookProvider,
StdTimerCreator, TransactionId, UserFaultHook,
dest::DestinationHandler,
filestore::NativeFilestore,
lost_segments::LostSegmentsList,
request::{PutRequestOwned, StaticPutRequestCacher},
source::SourceHandler,
user::{CfdpUser, FileSegmentRecvdParams, MetadataReceivedParams, TransactionFinishedParams},
@@ -33,7 +34,7 @@ const FILE_DATA: &str = "Hello World!";
#[derive(Default)]
pub struct ExampleFaultHandler {}
impl UserFaultHookProvider for ExampleFaultHandler {
impl UserFaultHook for ExampleFaultHandler {
fn notice_of_suspension_cb(
&mut self,
transaction_id: TransactionId,
@@ -230,6 +231,7 @@ fn end_to_end_test(with_closure: bool) {
NativeFilestore::default(),
remote_cfg_of_source,
StdTimerCreator::default(),
LostSegmentsList::default(),
);
let mut cfdp_user_dest = ExampleCfdpUser::new(EntityType::Receiving, completion_signal_dest);