pub struct MemorySurbStore {
pseudonym_openers: Cache<SimplePseudonym, Cache<[u8; 8], ReplyOpener>>,
admitted_surbs_per_pseudonym: Cache<SimplePseudonym, AdmittedRing>,
quarantine_surbs: Cache<SimplePseudonym, SurbRingBuffer<SURB<Ed25519Suite, HoprSphinxHeaderSpec>>>,
quarantine_budget: Arc<Atomic<usize>>,
invalidated_relayers: Arc<RwLock<RawRwLock, HashSet<KeyIdent>>>,
generations: Cache<SimplePseudonym, Arc<Atomic<u8>>>,
stats: Arc<EvictionStats>,
cfg: Arc<SurbStoreConfig>,
}Expand description
Basic SurbStore implementation based on an in-memory cache.
This SURB store offers no persistence, and all SURBs and Reply Openers are lost once dropped.
The instance can be cheaply cloned.
Fields§
§pseudonym_openers: Cache<SimplePseudonym, Cache<[u8; 8], ReplyOpener>>§admitted_surbs_per_pseudonym: Cache<SimplePseudonym, AdmittedRing>§quarantine_surbs: Cache<SimplePseudonym, SurbRingBuffer<SURB<Ed25519Suite, HoprSphinxHeaderSpec>>>§quarantine_budget: Arc<Atomic<usize>>§invalidated_relayers: Arc<RwLock<RawRwLock, HashSet<KeyIdent>>>§generations: Cache<SimplePseudonym, Arc<Atomic<u8>>>§stats: Arc<EvictionStats>§cfg: Arc<SurbStoreConfig>Implementations§
Source§impl MemorySurbStore
impl MemorySurbStore
Sourcepub fn new(cfg: SurbStoreConfig) -> MemorySurbStore
pub fn new(cfg: SurbStoreConfig) -> MemorySurbStore
Creates a new instance with the given configuration.
Sourcepub fn is_relayer_invalidated(&self, relayer: &KeyIdent) -> bool
pub fn is_relayer_invalidated(&self, relayer: &KeyIdent) -> bool
Whether relayer is currently unusable as a return path’s first hop.
Sourcepub fn admitted_ring_ceiling(
&self,
pseudonym: &SimplePseudonym,
) -> Option<usize>
pub fn admitted_ring_ceiling( &self, pseudonym: &SimplePseudonym, ) -> Option<usize>
Ceiling on how many SURBs the admitted ring for pseudonym can hold, or None when it holds
no admitted ring.
Observability seam: the ceiling is what an announced target has to raise, since a Session whose ring is too narrow loses SURBs — and, under PIX, the shares they carried — the moment the Entry mints past it.
Note this is a cache get, so it records recency on the admitted cache’s LRU. Every live
Session holds a ring and the cache is sized for that census, so a read here cannot evict one;
it is only a diagnostic, not a hot path.
Sourcepub fn raise_admitted_capacity(
&self,
pseudonym: &SimplePseudonym,
token: u64,
expected_surbs: usize,
)
pub fn raise_admitted_capacity( &self, pseudonym: &SimplePseudonym, token: u64, expected_surbs: usize, )
Widens pseudonym’s admitted ring for an announced SURB target that changed mid-Session.
admit sizes the ring once, from the target in force at establishment,
and a peer may raise that target afterwards: the gnosis_vpn client ramps its balancer from a
ping tier to a main tier seconds into the Session and announces each step (see
gnosis/gnosis_vpn#739). Left alone, the ring keeps the first tier’s ceiling while the Entry
mints toward the new one — every SURB past the ceiling is evicted on arrival, and under PIX so
is the share it carried, which is unrecoverable.
The re-admission path already grows a ring in place (SurbRingBuffer::raise_capacity is a
fetch_max, so it only ever widens). This is that path, for a peer rather than a successor
Session: it mints no new admission number, so the token the Session already holds still
names this admission and its teardown retires it as before. A token that no longer names the
pseudonym’s current admission is a no-op, for the same reason a stale retire is.
expected_surbs is the announced target, not a ring size: the headroom, floor and ceiling
arithmetic is this store’s, exactly as in admit.
Trait Implementations§
Source§impl Clone for MemorySurbStore
impl Clone for MemorySurbStore
Source§fn clone(&self) -> MemorySurbStore
fn clone(&self) -> MemorySurbStore
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for MemorySurbStore
impl Default for MemorySurbStore
Source§fn default() -> MemorySurbStore
fn default() -> MemorySurbStore
Source§impl SurbStore for MemorySurbStore
impl SurbStore for MemorySurbStore
Source§fn admit(&self, pseudonym: &SimplePseudonym, expected_surbs: usize) -> u64
fn admit(&self, pseudonym: &SimplePseudonym, expected_surbs: usize) -> u64
Admits pseudonym into the store’s admitted class, behind an established Session.
Called once the Session over the pseudonym is established, and never on a mere packet’s say-so,
so the admitted class stays out of any unauthenticated peer’s reach. expected_surbs is the
Session’s announced SURB target; the store adds its own headroom and floors at
quarantine_rb_capacity — an unknown target (0) is treated as “no announcement” and gets the
floor, not a one-SURB ring.
Returns the number naming this admission, which the caller threads to
SurbStore::retire. Every call mints a fresh one and invalidates the previous, so a
retire issued on behalf of a superseded admission matches nothing — that is the guard that
makes the deferred retire safe to schedule.
Any quarantine ring for the pseudonym is promoted rather than left behind to expire: the SURBs
arrived for this very Session. A ring arrives here only while the pseudonym is unadmitted
(insert_surbs routes on admission), so an admitted entry this finds already in place is one a
previous admission left behind — insert_surbs never creates one — and the promotion fills it
rather than discarding what it holds.
The admitted entry is installed before the quarantine ring is promoted, not after. That order
is what lets an insert racing this admission re-check after its quarantine push: a push that
lands after the promotion can only do so once the entry is already in place, so the insert’s
re-check finds it and folds the batch in. Promoting first would leave a window — promotion done,
entry not yet installed — in which a push and its re-check could both slip through, stranding
the batch in a quarantine ring find_surb no longer consults.
Source§fn retire(&self, pseudonym: &SimplePseudonym, token: u64)
fn retire(&self, pseudonym: &SimplePseudonym, token: u64)
Retires pseudonym from the admitted class: its Session is over.
Only the admitted class is touched — a rolled-back or unestablished Session’s preload SURBs belong to the quarantine, where their short TTI expires them without any teardown bookkeeping. Idempotent: retiring a pseudonym that holds no admitted ring is a no-op.
token names the admission the teardown is retiring, and the retire is honoured only while it
still matches the pseudonym’s current one. The retire runs deferred, past the packet pipeline’s
SURB-resolution window, because the closing Session’s own return-routed notification still
needs its ring — long enough for a successor Session to have been admitted on the same
client-chosen pseudonym. Dropping the successor’s ring there would silently degrade its return
path with nothing logged anywhere, which is exactly what the token exists to prevent: a stale
retire leaves the successor’s ring, and its epoch, exactly as they are.
Source§fn surbs_held(&self) -> usize
fn surbs_held(&self) -> usize
Total SURBs held across both classes. Test and observability seam, not a hot path: it walks the admitted cache and reads the quarantine budget.
Source§fn insert_surbs(
&self,
pseudonym: SimplePseudonym,
surbs: Vec<([u8; 8], SURB<Ed25519Suite, HoprSphinxHeaderSpec>)>,
) -> SurbInsertOutcome
fn insert_surbs( &self, pseudonym: SimplePseudonym, surbs: Vec<([u8; 8], SURB<Ed25519Suite, HoprSphinxHeaderSpec>)>, ) -> SurbInsertOutcome
Source§fn tier_lens(&self, pseudonym: &SimplePseudonym) -> Option<(usize, usize)>
fn tier_lens(&self, pseudonym: &SimplePseudonym) -> Option<(usize, usize)>
pseudonym in each of the store’s tiers, as (share-bearing, share-less), or None if the store holds no SURBs for it or does not tell its SURBs apart that
way. Read moreSource§fn insert_reply_opener(&self, sender_id: HoprSenderId, opener: ReplyOpener)
fn insert_reply_opener(&self, sender_id: HoprSenderId, opener: ReplyOpener)
Source§fn invalidate_relayer(&self, relayer: &KeyIdent)
fn invalidate_relayer(&self, relayer: &KeyIdent)
relayer as unusable, so stored SURBs whose return path
starts there are no longer handed out. Read moreSource§fn revalidate_relayer(&self, relayer: &KeyIdent)
fn revalidate_relayer(&self, relayer: &KeyIdent)
Source§fn find_reply_opener(&self, sender_id: &HoprSenderId) -> Option<ReplyOpener>
fn find_reply_opener(&self, sender_id: &HoprSenderId) -> Option<ReplyOpener>
Source§fn remove_reply_opener(&self, sender_id: &HoprSenderId)
fn remove_reply_opener(&self, sender_id: &HoprSenderId)
ReplyOpener that has been used to deliver a reply. Read moreSource§fn current_generation(&self, pseudonym: &SimplePseudonym) -> u8
fn current_generation(&self, pseudonym: &SimplePseudonym) -> u8
pseudonym. Read moreSource§fn bump_generation(&self, pseudonym: &SimplePseudonym) -> u8
fn bump_generation(&self, pseudonym: &SimplePseudonym) -> u8
pseudonym and returns the new value. Read moreAuto Trait Implementations§
impl !RefUnwindSafe for MemorySurbStore
impl !UnwindSafe for MemorySurbStore
impl Freeze for MemorySurbStore
impl Send for MemorySurbStore
impl Sync for MemorySurbStore
impl Unpin for MemorySurbStore
impl UnsafeUnpin for MemorySurbStore
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.