1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
use async_lock::{RwLock, RwLockWriteGuard};
use async_trait::async_trait;
use futures_util::FutureExt;
use std::{
any::{Any, TypeId},
fmt,
future::Future,
hash::{BuildHasher, Hash},
pin::Pin,
sync::Arc,
};
use triomphe::Arc as TrioArc;
use crate::{
ops::compute::{CompResult, Op},
Entry,
};
use super::{ComputeNone, OptionallyNone};
const WAITER_MAP_NUM_SEGMENTS: usize = 64;
#[async_trait]
pub(crate) trait GetOrInsert<K, V> {
/// Gets a value for the given key without recording the access to the cache
/// policies.
async fn get_without_recording<I>(
&self,
key: &Arc<K>,
hash: u64,
replace_if: Option<&mut I>,
) -> Option<V>
where
V: 'static,
I: for<'i> FnMut(&'i V) -> bool + Send;
/// Gets an entry for the given key _with_ recording the access to the cache
/// policies.
async fn get_entry(&self, key: &Arc<K>, hash: u64) -> Option<Entry<K, V>>
where
V: 'static;
/// Inserts a value for the given key.
async fn insert(&self, key: Arc<K>, hash: u64, value: V);
/// Removes a value for the given key. Returns the removed value.
async fn remove(&self, key: &Arc<K>, hash: u64) -> Option<V>;
}
type ErrorObject = Arc<dyn Any + Send + Sync + 'static>;
pub(crate) enum InitResult<V, E> {
Initialized(V),
ReadExisting(V),
InitErr(Arc<E>),
}
enum WaiterValue<V> {
Computing,
Ready(Result<V, ErrorObject>),
ReadyNone,
// https://github.com/moka-rs/moka/issues/43
InitFuturePanicked,
// https://github.com/moka-rs/moka/issues/59
EnclosingFutureAborted,
}
impl<V> fmt::Debug for WaiterValue<V> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
WaiterValue::Computing => write!(f, "Computing"),
WaiterValue::Ready(_) => write!(f, "Ready"),
WaiterValue::ReadyNone => write!(f, "ReadyNone"),
WaiterValue::InitFuturePanicked => write!(f, "InitFuturePanicked"),
WaiterValue::EnclosingFutureAborted => write!(f, "EnclosingFutureAborted"),
}
}
}
type Waiter<V> = TrioArc<RwLock<WaiterValue<V>>>;
type WaiterMap<K, V, S> = crate::cht::SegmentedHashMap<(Arc<K>, TypeId), Waiter<V>, S>;
struct WaiterGuard<'a, K, V, S>
// NOTE: We usually do not attach trait bounds to here at the struct definition, but
// the Drop trait requires these bounds here.
where
K: Eq + Hash,
V: Clone,
S: BuildHasher,
{
w_key: Option<(Arc<K>, TypeId)>,
w_hash: u64,
waiters: &'a WaiterMap<K, V, S>,
write_lock: RwLockWriteGuard<'a, WaiterValue<V>>,
}
impl<'a, K, V, S> WaiterGuard<'a, K, V, S>
where
K: Eq + Hash,
V: Clone,
S: BuildHasher,
{
fn new(
w_key: (Arc<K>, TypeId),
w_hash: u64,
waiters: &'a WaiterMap<K, V, S>,
write_lock: RwLockWriteGuard<'a, WaiterValue<V>>,
) -> Self {
Self {
w_key: Some(w_key),
w_hash,
waiters,
write_lock,
}
}
fn set_waiter_value(mut self, v: WaiterValue<V>) {
*self.write_lock = v;
if let Some(w_key) = self.w_key.take() {
remove_waiter(self.waiters, w_key, self.w_hash);
}
}
}
impl<'a, K, V, S> Drop for WaiterGuard<'a, K, V, S>
where
K: Eq + Hash,
V: Clone,
S: BuildHasher,
{
fn drop(&mut self) {
if let Some(w_key) = self.w_key.take() {
// Value is not set. This means the future containing `*get_with` method
// has been aborted. Remove our waiter to prevent the issue described in
// https://github.com/moka-rs/moka/issues/59
*self.write_lock = WaiterValue::EnclosingFutureAborted;
remove_waiter(self.waiters, w_key, self.w_hash);
}
}
}
pub(crate) struct ValueInitializer<K, V, S> {
// TypeId is the type ID of the concrete error type of generic type E in the
// try_get_with method. We use the type ID as a part of the key to ensure that we
// can always downcast the trait object ErrorObject (in Waiter<V>) into its
// concrete type.
waiters: TrioArc<WaiterMap<K, V, S>>,
}
impl<K, V, S> ValueInitializer<K, V, S>
where
K: Eq + Hash + Send + Sync + 'static,
V: Clone + Send + Sync + 'static,
S: BuildHasher + Send + Sync + 'static,
{
pub(crate) fn with_hasher(hasher: S) -> Self {
Self {
waiters: TrioArc::new(crate::cht::SegmentedHashMap::with_num_segments_and_hasher(
WAITER_MAP_NUM_SEGMENTS,
hasher,
)),
}
}
//
// NOTES: We use `Pin<&mut impl Future>` instead of `impl Future` here for the
// `init` argument. This is because we want to avoid the future size inflation
// caused by calling nested async functions. See the following links for more
// details:
//
// - https://github.com/moka-rs/moka/issues/212
// - https://swatinem.de/blog/future-size/
//
/// # Panics
/// Panics if the `init` future has been panicked.
#[allow(clippy::too_many_arguments)]
pub(crate) async fn try_init_or_read<'a, C, I, O, E>(
&'a self,
c_key: &Arc<K>,
c_hash: u64,
type_id: TypeId,
cache: &C,
mut ignore_if: Option<I>,
// Future to initialize a new value.
init: Pin<&mut impl Future<Output = O>>,
// Function to convert a value O, returned from the init future, into
// Result<V, E>.
post_init: fn(O) -> Result<V, E>,
) -> InitResult<V, E>
where
C: GetOrInsert<K, V> + Send + 'a,
I: FnMut(&V) -> bool + Send,
E: Send + Sync + 'static,
{
use std::panic::{resume_unwind, AssertUnwindSafe};
use InitResult::{InitErr, Initialized, ReadExisting};
const MAX_RETRIES: usize = 200;
let mut retries = 0;
let (w_key, w_hash) = waiter_key_hash(&self.waiters, c_key, type_id);
let waiter = TrioArc::new(RwLock::new(WaiterValue::Computing));
// NOTE: We have to acquire a write lock before `try_insert_waiter`,
// so that any concurrent attempt will get our lock and wait on it.
let lock = waiter.write().await;
loop {
let Some(existing_waiter) =
try_insert_waiter(&self.waiters, w_key.clone(), w_hash, &waiter)
else {
// Inserted.
break;
};
// Somebody else's waiter already exists, so wait for its result to become available.
let waiter_result = existing_waiter.read().await;
match &*waiter_result {
WaiterValue::Ready(Ok(value)) => return ReadExisting(value.clone()),
WaiterValue::Ready(Err(e)) => return InitErr(Arc::clone(e).downcast().unwrap()),
// Somebody else's init future has been panicked.
WaiterValue::InitFuturePanicked => {
retries += 1;
panic_if_retry_exhausted_for_panicking(retries, MAX_RETRIES);
// Retry from the beginning.
continue;
}
// Somebody else (a future containing `get_with`/`try_get_with`)
// has been aborted.
WaiterValue::EnclosingFutureAborted => {
retries += 1;
panic_if_retry_exhausted_for_aborting(retries, MAX_RETRIES);
// Retry from the beginning.
continue;
}
// Unexpected state.
s @ (WaiterValue::Computing | WaiterValue::ReadyNone) => panic!(
"Got unexpected state `{s:?}` after resolving `init` future. \
This might be a bug in Moka"
),
}
}
// Our waiter was inserted.
// Create a guard. This will ensure to remove our waiter when the
// enclosing future has been aborted:
// https://github.com/moka-rs/moka/issues/59
let waiter_guard = WaiterGuard::new(w_key, w_hash, &self.waiters, lock);
// Check if the value has already been inserted by other thread.
if let Some(value) = cache
.get_without_recording(c_key, c_hash, ignore_if.as_mut())
.await
{
// Yes. Set the waiter value, remove our waiter, and return
// the existing value.
waiter_guard.set_waiter_value(WaiterValue::Ready(Ok(value.clone())));
return ReadExisting(value);
}
// The value still does note exist. Let's resolve the init
// future. Catching panic is safe here as we do not try to
// resolve the future again.
match AssertUnwindSafe(init).catch_unwind().await {
// Resolved.
Ok(value) => match post_init(value) {
Ok(value) => {
cache.insert(Arc::clone(c_key), c_hash, value.clone()).await;
waiter_guard.set_waiter_value(WaiterValue::Ready(Ok(value.clone())));
Initialized(value)
}
Err(e) => {
let err: ErrorObject = Arc::new(e);
waiter_guard.set_waiter_value(WaiterValue::Ready(Err(Arc::clone(&err))));
InitErr(err.downcast().unwrap())
}
},
// Panicked.
Err(payload) => {
waiter_guard.set_waiter_value(WaiterValue::InitFuturePanicked);
resume_unwind(payload);
}
}
// The lock will be unlocked here.
}
/// # Panics
/// Panics if the `init` future has been panicked.
pub(crate) async fn try_compute<'a, C, F, Fut, O, E>(
&'a self,
c_key: Arc<K>,
c_hash: u64,
cache: &C,
f: F,
post_init: fn(O) -> Result<Op<V>, E>,
allow_nop: bool,
) -> Result<CompResult<K, V>, E>
where
C: GetOrInsert<K, V> + Send + 'a,
F: FnOnce(Option<Entry<K, V>>) -> Fut,
Fut: Future<Output = O> + 'a,
E: Send + Sync + 'static,
{
use std::panic::{resume_unwind, AssertUnwindSafe};
let type_id = TypeId::of::<ComputeNone>();
let (w_key, w_hash) = waiter_key_hash(&self.waiters, &c_key, type_id);
let waiter = TrioArc::new(RwLock::new(WaiterValue::Computing));
// NOTE: We have to acquire a write lock before `try_insert_waiter`,
// so that any concurrent attempt will get our lock and wait on it.
let lock = waiter.write().await;
loop {
let Some(existing_waiter) =
try_insert_waiter(&self.waiters, w_key.clone(), w_hash, &waiter)
else {
// Inserted.
break;
};
// Somebody else's waiter already exists, so wait for it to finish
// (wait for it to release the write lock).
let waiter_result = existing_waiter.read().await;
match &*waiter_result {
// Unexpected state.
WaiterValue::Computing => panic!(
"Got unexpected state `Computing` after resolving `init` future. \
This might be a bug in Moka"
),
_ => {
// Try to insert our waiter again.
continue;
}
}
}
// Our waiter was inserted.
// Create a guard. This will ensure to remove our waiter when the
// enclosing future has been aborted:
// https://github.com/moka-rs/moka/issues/59
let waiter_guard = WaiterGuard::new(w_key, w_hash, &self.waiters, lock);
// Get the current value.
let maybe_entry = cache.get_entry(&c_key, c_hash).await;
let maybe_value = if allow_nop {
maybe_entry.as_ref().map(|ent| ent.value().clone())
} else {
None
};
let entry_existed = maybe_entry.is_some();
// Evaluate the `f` closure and get a future. Catching panic is safe here as
// we will not evaluate the closure again.
let fut = match std::panic::catch_unwind(AssertUnwindSafe(|| f(maybe_entry))) {
// Evaluated.
Ok(fut) => fut,
// Panicked.
Err(payload) => {
waiter_guard.set_waiter_value(WaiterValue::InitFuturePanicked);
resume_unwind(payload);
}
};
// Resolve the `fut` future. Catching panic is safe here as we will not
// resolve the future again.
let output = match AssertUnwindSafe(fut).catch_unwind().await {
// Resolved.
Ok(output) => {
waiter_guard.set_waiter_value(WaiterValue::ReadyNone);
output
}
// Panicked.
Err(payload) => {
waiter_guard.set_waiter_value(WaiterValue::InitFuturePanicked);
resume_unwind(payload);
}
};
match post_init(output)? {
Op::Nop => {
if let Some(value) = maybe_value {
Ok(CompResult::Unchanged(Entry::new(
Some(c_key),
value,
false,
false,
)))
} else {
Ok(CompResult::StillNone(c_key))
}
}
Op::Put(value) => {
cache
.insert(Arc::clone(&c_key), c_hash, value.clone())
.await;
if entry_existed {
crossbeam_epoch::pin().flush();
let entry = Entry::new(Some(c_key), value, true, true);
Ok(CompResult::ReplacedWith(entry))
} else {
let entry = Entry::new(Some(c_key), value, true, false);
Ok(CompResult::Inserted(entry))
}
}
Op::Remove => {
let maybe_prev_v = cache.remove(&c_key, c_hash).await;
if let Some(prev_v) = maybe_prev_v {
crossbeam_epoch::pin().flush();
let entry = Entry::new(Some(c_key), prev_v, false, false);
Ok(CompResult::Removed(entry))
} else {
Ok(CompResult::StillNone(c_key))
}
}
}
// The lock will be unlocked here.
}
/// The `post_init` function for the `get_with` method of cache.
pub(crate) fn post_init_for_get_with(value: V) -> Result<V, ()> {
Ok(value)
}
/// The `post_init` function for the `optionally_get_with` method of cache.
pub(crate) fn post_init_for_optionally_get_with(
value: Option<V>,
) -> Result<V, Arc<OptionallyNone>> {
// `value` can be either `Some` or `None`. For `None` case, without change
// the existing API too much, we will need to convert `None` to Arc<E> here.
// `Infallible` could not be instantiated. So it might be good to use an
// empty struct to indicate the error type.
value.ok_or(Arc::new(OptionallyNone))
}
/// The `post_init` function for `try_get_with` method of cache.
pub(crate) fn post_init_for_try_get_with<E>(result: Result<V, E>) -> Result<V, E> {
result
}
/// The `post_init` function for the `and_upsert_with` method of cache.
pub(crate) fn post_init_for_upsert_with(value: V) -> Result<Op<V>, ()> {
Ok(Op::Put(value))
}
/// The `post_init` function for the `and_compute_with` method of cache.
pub(crate) fn post_init_for_compute_with(op: Op<V>) -> Result<Op<V>, ()> {
Ok(op)
}
/// The `post_init` function for the `and_try_compute_with` method of cache.
pub(crate) fn post_init_for_try_compute_with<E>(op: Result<Op<V>, E>) -> Result<Op<V>, E>
where
E: Send + Sync + 'static,
{
op
}
/// Returns the `type_id` for `get_with` method of cache.
pub(crate) fn type_id_for_get_with() -> TypeId {
// NOTE: We use a regular function here instead of a const fn because TypeId
// is not stable as a const fn. (as of our MSRV)
TypeId::of::<()>()
}
/// Returns the `type_id` for `optionally_get_with` method of cache.
pub(crate) fn type_id_for_optionally_get_with() -> TypeId {
TypeId::of::<OptionallyNone>()
}
/// Returns the `type_id` for `try_get_with` method of cache.
pub(crate) fn type_id_for_try_get_with<E: 'static>() -> TypeId {
TypeId::of::<E>()
}
}
#[cfg(test)]
impl<K, V, S> ValueInitializer<K, V, S> {
pub(crate) fn waiter_count(&self) -> usize {
self.waiters.len()
}
}
#[inline]
fn remove_waiter<K, V, S>(waiter_map: &WaiterMap<K, V, S>, w_key: (Arc<K>, TypeId), w_hash: u64)
where
(Arc<K>, TypeId): Eq + Hash,
S: BuildHasher,
{
waiter_map.remove(w_hash, |k| k == &w_key);
}
#[inline]
fn try_insert_waiter<K, V, S>(
waiter_map: &WaiterMap<K, V, S>,
w_key: (Arc<K>, TypeId),
w_hash: u64,
waiter: &Waiter<V>,
) -> Option<Waiter<V>>
where
(Arc<K>, TypeId): Eq + Hash,
S: BuildHasher,
{
let waiter = TrioArc::clone(waiter);
waiter_map.insert_if_not_present(w_key, w_hash, waiter)
}
#[inline]
fn waiter_key_hash<K, V, S>(
waiter_map: &WaiterMap<K, V, S>,
c_key: &Arc<K>,
type_id: TypeId,
) -> ((Arc<K>, TypeId), u64)
where
(Arc<K>, TypeId): Eq + Hash,
S: BuildHasher,
{
let w_key = (Arc::clone(c_key), type_id);
let w_hash = waiter_map.hash(&w_key);
(w_key, w_hash)
}
fn panic_if_retry_exhausted_for_panicking(retries: usize, max: usize) {
assert!(
retries < max,
"Too many retries. Tried to read the return value from the `init` future \
but failed {retries} times. Maybe the `init` kept panicking?"
);
}
fn panic_if_retry_exhausted_for_aborting(retries: usize, max: usize) {
assert!(
retries < max,
"Too many retries. Tried to read the return value from the `init` future \
but failed {retries} times. Maybe the future containing `get_with`/`try_get_with` \
kept being aborted?"
);
}