diff --git a/services/pddb/src/api.rs b/services/pddb/src/api.rs index db7510027..3e5d94bb0 100644 --- a/services/pddb/src/api.rs +++ b/services/pddb/src/api.rs @@ -95,6 +95,8 @@ pub(crate) enum Opcode { /// drops any connection state associated with a given key KeyDrop, + /// Suspend/resume callback + SuspendResume, /// quit the server Quit, } @@ -121,10 +123,27 @@ pub enum PddbRequestCode { AccessDenied, Uninit, } +#[derive(Copy, Clone, Eq, PartialEq, Debug)] +#[derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)] +pub enum BasisRetentionPolicy { + Persist, + ClearAfterSleeps(u32), + //TimeOutSecs(u32), +} +impl BasisRetentionPolicy { + pub fn derive_init_state(&self) -> u32 { + match self { + BasisRetentionPolicy::Persist => 0, + BasisRetentionPolicy::ClearAfterSleeps(sleeps) => *sleeps, + //BasisRetentionPolicy::TimeOutSecs(secs) => *secs, + } + } +} #[derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)] pub struct PddbBasisRequest { pub name: xous_ipc::String::, pub code: PddbRequestCode, + pub policy: Option, } #[derive(rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)] pub struct PddbDictRequest { diff --git a/services/pddb/src/backend/basis.rs b/services/pddb/src/backend/basis.rs index df9474080..4f1ec2cc3 100644 --- a/services/pddb/src/backend/basis.rs +++ b/services/pddb/src/backend/basis.rs @@ -237,21 +237,6 @@ impl DerefMut for BasisRoot { } } -#[derive(Copy, Clone, Eq, PartialEq, Debug)] -pub(crate) enum BasisRetentionPolicy { - Persist, - ClearAfterSleeps(u32), - TimeOutSecs(u32), -} -impl BasisRetentionPolicy { - pub(crate) fn derive_init_state(&self) -> u32 { - match self { - BasisRetentionPolicy::Persist => 0, - BasisRetentionPolicy::ClearAfterSleeps(sleeps) => *sleeps, - BasisRetentionPolicy::TimeOutSecs(secs) => *secs, - } - } -} /// A list of open Basis that we can use to search and operate upon. Sort of the "root" data structure of the PDDB. /// /// Note to self: it's tempting to integrate the "hw" parameter (the pointer to the PddbOs structure). However, this @@ -949,6 +934,31 @@ impl BasisCache { } Ok(()) } + + pub(crate) fn suspend(&mut self, hw: &mut PddbOs) { + self.sync(hw, None).expect("couldn't sync on suspend"); + let mut lock_list = Vec::::new(); + for basis in self.cache.iter_mut() { + match basis.policy { + BasisRetentionPolicy::Persist => (), + BasisRetentionPolicy::ClearAfterSleeps(sleeps) => { + basis.policy_state += 1; + if basis.policy_state >= sleeps { + lock_list.push(basis.name.clone()); + } + } + /* + BasisRetentionPolicy::TimeOutSecs(secs) => { + if secs < basis.policy_state { + lock_list.push(basis.name.clone()); + } + }*/ + } + } + for basis in lock_list { + self.basis_unmount(hw, &basis).ok(); + } + } } /// This is the RAM cached copy of a basis as maintained in the PDDB. @@ -983,7 +993,7 @@ pub(crate) struct BasisCacheEntry { pub large_alloc_ptr: Option, /// retiention policy pub policy: BasisRetentionPolicy, - /// rention state + // rention state pub policy_state: u32, } impl BasisCacheEntry { diff --git a/services/pddb/src/lib.rs b/services/pddb/src/lib.rs index 65e354fea..c3df21dda 100644 --- a/services/pddb/src/lib.rs +++ b/services/pddb/src/lib.rs @@ -115,6 +115,7 @@ impl Pddb { let mgmt = PddbBasisRequest { name: xous_ipc::String::::new(), code: PddbRequestCode::Uninit, + policy: None, }; let mut buf = Buffer::into_buf(mgmt).expect("Couldn't convert to memory structure"); buf.lend_mut(self.conn, Opcode::LatestBasis.to_u32().unwrap()).expect("Couldn't execute ListBasis opcode"); @@ -139,6 +140,7 @@ impl Pddb { let mgmt = PddbBasisRequest { name: xous_ipc::String::::from_str(basis_name), code: PddbRequestCode::Create, + policy: None, }; let mut buf = Buffer::into_buf(mgmt).expect("Couldn't convert to memory structure"); buf.lend_mut(self.conn, Opcode::CreateBasis.to_u32().unwrap()).expect("Couldn't execute CreateBasis opcode"); @@ -153,13 +155,14 @@ impl Pddb { } } } - pub fn unlock_basis(&self, basis_name: &str) -> Result<()> { + pub fn unlock_basis(&self, basis_name: &str, policy: Option) -> Result<()> { if basis_name.len() > BASIS_NAME_LEN - 1 { return Err(Error::new(ErrorKind::InvalidInput, "basis name too long")); } let mgmt = PddbBasisRequest { name: xous_ipc::String::::from_str(basis_name), code: PddbRequestCode::Open, + policy, }; let mut buf = Buffer::into_buf(mgmt).expect("Couldn't convert to memory structure"); buf.lend_mut(self.conn, Opcode::OpenBasis.to_u32().unwrap()).expect("Couldn't execute OpenBasis opcode"); @@ -181,6 +184,7 @@ impl Pddb { let mgmt = PddbBasisRequest { name: xous_ipc::String::::from_str(basis_name), code: PddbRequestCode::Close, + policy: None, }; let mut buf = Buffer::into_buf(mgmt).expect("Couldn't convert to memory structure"); buf.lend_mut(self.conn, Opcode::CloseBasis.to_u32().unwrap()).expect("Couldn't execute CloseBasis opcode"); @@ -202,6 +206,7 @@ impl Pddb { let mgmt = PddbBasisRequest { name: xous_ipc::String::::from_str(basis_name), code: PddbRequestCode::Delete, + policy: None, }; let mut buf = Buffer::into_buf(mgmt).expect("Couldn't convert to memory structure"); buf.lend_mut(self.conn, Opcode::DeleteBasis.to_u32().unwrap()).expect("Couldn't execute DeleteBasis opcode"); diff --git a/services/pddb/src/main.rs b/services/pddb/src/main.rs index 6c7572c14..beb16faf8 100644 --- a/services/pddb/src/main.rs +++ b/services/pddb/src/main.rs @@ -542,9 +542,17 @@ fn xmain() -> ! { let mut key_token: Option<[u32; 4]> = None; let mut dict_list = Vec::::new(); // storage for dict lists let mut dict_token: Option<[u32; 4]> = None; + + // register a suspend/resume listener + let sr_cid = xous::connect(pddb_sid).expect("couldn't create suspend callback connection"); + let mut susres = susres::Susres::new(&xns, api::Opcode::SuspendResume as u32, sr_cid).expect("couldn't create suspend/resume object"); loop { let mut msg = xous::receive_message(pddb_sid).unwrap(); match FromPrimitive::from_usize(msg.body.id()) { + Some(Opcode::SuspendResume) => xous::msg_scalar_unpack!(msg, token, _, _, _, { + basis_cache.suspend(&mut pddb_os); + susres.suspend_until_resume(token).expect("couldn't execute suspend/resume"); + }), Some(Opcode::ListBasis) => { let mut buffer = unsafe { Buffer::from_memory_message_mut(msg.body.memory_message_mut().unwrap()) }; let mut list_ipc = buffer.to_original::().unwrap(); @@ -612,7 +620,7 @@ fn xmain() -> ! { if let Some(pw) = ret.plaintext_pw { if let Some(basis) = basis_cache.basis_unlock( &mut pddb_os, mgmt.name.as_str().expect("name is not valid utf-8"), pw.as_str().expect("password was not valid utf-8"), - BasisRetentionPolicy::Persist + mgmt.policy.unwrap_or(BasisRetentionPolicy::Persist) ) { basis_cache.basis_add(basis); finished = true;