Line data Source code
1 : //! This module implements the pageserver-global disk-usage-based layer eviction task.
2 : //!
3 : //! # Mechanics
4 : //!
5 : //! Function `launch_disk_usage_global_eviction_task` starts a pageserver-global background
6 : //! loop that evicts layers in response to a shortage of available bytes
7 : //! in the $repo/tenants directory's filesystem.
8 : //!
9 : //! The loop runs periodically at a configurable `period`.
10 : //!
11 : //! Each loop iteration uses `statvfs` to determine filesystem-level space usage.
12 : //! It compares the returned usage data against two different types of thresholds.
13 : //! The iteration tries to evict layers until app-internal accounting says we should be below the thresholds.
14 : //! We cross-check this internal accounting with the real world by making another `statvfs` at the end of the iteration.
15 : //! We're good if that second statvfs shows that we're _actually_ below the configured thresholds.
16 : //! If we're still above one or more thresholds, we emit a warning log message, leaving it to the operator to investigate further.
17 : //!
18 : //! # Eviction Policy
19 : //!
20 : //! There are two thresholds:
21 : //! `max_usage_pct` is the relative available space, expressed in percent of the total filesystem space.
22 : //! If the actual usage is higher, the threshold is exceeded.
23 : //! `min_avail_bytes` is the absolute available space in bytes.
24 : //! If the actual usage is lower, the threshold is exceeded.
25 : //! If either of these thresholds is exceeded, the system is considered to have "disk pressure", and eviction
26 : //! is performed on the next iteration, to release disk space and bring the usage below the thresholds again.
27 : //! The iteration evicts layers in LRU fashion, but, with a weak reservation per tenant.
28 : //! The reservation is to keep the most recently accessed X bytes per tenant resident.
29 : //! If we cannot relieve pressure by evicting layers outside of the reservation, we
30 : //! start evicting layers that are part of the reservation, LRU first.
31 : //!
32 : //! The value for the per-tenant reservation is referred to as `tenant_min_resident_size`
33 : //! throughout the code, but, no actual variable carries that name.
34 : //! The per-tenant default value is the `max(tenant's layer file sizes, regardless of local or remote)`.
35 : //! The idea is to allow at least one layer to be resident per tenant, to ensure it can make forward progress
36 : //! during page reconstruction.
37 : //! An alternative default for all tenants can be specified in the `tenant_config` section of the config.
38 : //! Lastly, each tenant can have an override in their respective tenant config (`min_resident_size_override`).
39 :
40 : // Implementation notes:
41 : // - The `#[allow(dead_code)]` above various structs are to suppress warnings about only the Debug impl
42 : // reading these fields. We use the Debug impl for semi-structured logging, though.
43 :
44 : use std::{
45 : sync::Arc,
46 : time::{Duration, SystemTime},
47 : };
48 :
49 : use anyhow::Context;
50 : use pageserver_api::shard::TenantShardId;
51 : use remote_storage::GenericRemoteStorage;
52 : use serde::{Deserialize, Serialize};
53 : use tokio::time::Instant;
54 : use tokio_util::sync::CancellationToken;
55 : use tracing::{debug, error, info, instrument, warn, Instrument};
56 : use utils::serde_percent::Percent;
57 : use utils::{completion, id::TimelineId};
58 :
59 : use crate::{
60 : config::PageServerConf,
61 : metrics::disk_usage_based_eviction::METRICS,
62 : task_mgr::{self, TaskKind, BACKGROUND_RUNTIME},
63 : tenant::{
64 : mgr::TenantManager,
65 : remote_timeline_client::LayerFileMetadata,
66 : secondary::SecondaryTenant,
67 : storage_layer::{AsLayerDesc, EvictionError, Layer, LayerName},
68 : },
69 : };
70 :
71 10 : #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
72 : pub struct DiskUsageEvictionTaskConfig {
73 : pub max_usage_pct: Percent,
74 : pub min_avail_bytes: u64,
75 : #[serde(with = "humantime_serde")]
76 : pub period: Duration,
77 : #[cfg(feature = "testing")]
78 : pub mock_statvfs: Option<crate::statvfs::mock::Behavior>,
79 : /// Select sorting for evicted layers
80 : #[serde(default)]
81 : pub eviction_order: EvictionOrder,
82 : }
83 :
84 : /// Selects the sort order for eviction candidates *after* per tenant `min_resident_size`
85 : /// partitioning.
86 0 : #[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
87 : #[serde(tag = "type", content = "args")]
88 : pub enum EvictionOrder {
89 : /// Order the layers to be evicted by how recently they have been accessed in absolute
90 : /// time.
91 : ///
92 : /// This strategy is unfair when some tenants grow faster than others towards the slower
93 : /// growing.
94 : #[default]
95 : AbsoluteAccessed,
96 :
97 : /// Order the layers to be evicted by how recently they have been accessed relatively within
98 : /// the set of resident layers of a tenant.
99 : RelativeAccessed {
100 : /// Determines if the tenant with most layers should lose first.
101 : ///
102 : /// Having this enabled is currently the only reasonable option, because the order in which
103 : /// we read tenants is deterministic. If we find the need to use this as `false`, we need
104 : /// to ensure nondeterminism by adding in a random number to break the
105 : /// `relative_last_activity==0.0` ties.
106 : #[serde(default = "default_highest_layer_count_loses_first")]
107 : highest_layer_count_loses_first: bool,
108 : },
109 : }
110 :
111 0 : fn default_highest_layer_count_loses_first() -> bool {
112 0 : true
113 0 : }
114 :
115 : impl EvictionOrder {
116 0 : fn sort(&self, candidates: &mut [(MinResidentSizePartition, EvictionCandidate)]) {
117 0 : use EvictionOrder::*;
118 0 :
119 0 : match self {
120 0 : AbsoluteAccessed => {
121 0 : candidates.sort_unstable_by_key(|(partition, candidate)| {
122 0 : (*partition, candidate.last_activity_ts)
123 0 : });
124 0 : }
125 0 : RelativeAccessed { .. } => candidates.sort_unstable_by_key(|(partition, candidate)| {
126 0 : (*partition, candidate.relative_last_activity)
127 0 : }),
128 : }
129 0 : }
130 :
131 : /// Called to fill in the [`EvictionCandidate::relative_last_activity`] while iterating tenants
132 : /// layers in **most** recently used order.
133 40 : fn relative_last_activity(&self, total: usize, index: usize) -> finite_f32::FiniteF32 {
134 40 : use EvictionOrder::*;
135 40 :
136 40 : match self {
137 0 : AbsoluteAccessed => finite_f32::FiniteF32::ZERO,
138 : RelativeAccessed {
139 40 : highest_layer_count_loses_first,
140 : } => {
141 : // keeping the -1 or not decides if every tenant should lose their least recently accessed
142 : // layer OR if this should happen in the order of having highest layer count:
143 40 : let fudge = if *highest_layer_count_loses_first {
144 : // relative_last_activity vs. tenant layer count:
145 : // - 0.1..=1.0 (10 layers)
146 : // - 0.01..=1.0 (100 layers)
147 : // - 0.001..=1.0 (1000 layers)
148 : //
149 : // leading to evicting less of the smallest tenants.
150 20 : 0
151 : } else {
152 : // use full 0.0..=1.0 range, which means even the smallest tenants could always lose a
153 : // layer. the actual ordering is unspecified: for 10k tenants on a pageserver it could
154 : // be that less than 10k layer evictions is enough, so we would not need to evict from
155 : // all tenants.
156 : //
157 : // as the tenant ordering is now deterministic this could hit the same tenants
158 : // disproportionetly on multiple invocations. alternative could be to remember how many
159 : // layers did we evict last time from this tenant, and inject that as an additional
160 : // fudge here.
161 20 : 1
162 : };
163 :
164 40 : let total = total.checked_sub(fudge).filter(|&x| x > 1).unwrap_or(1);
165 40 : let divider = total as f32;
166 40 :
167 40 : // most recently used is always (total - 0) / divider == 1.0
168 40 : // least recently used depends on the fudge:
169 40 : // - (total - 1) - (total - 1) / total => 0 / total
170 40 : // - total - (total - 1) / total => 1 / total
171 40 : let distance = (total - index) as f32;
172 40 :
173 40 : finite_f32::FiniteF32::try_from_normalized(distance / divider)
174 40 : .unwrap_or_else(|val| {
175 0 : tracing::warn!(%fudge, "calculated invalid relative_last_activity for i={index}, total={total}: {val}");
176 0 : finite_f32::FiniteF32::ZERO
177 40 : })
178 : }
179 : }
180 40 : }
181 : }
182 :
183 : #[derive(Default)]
184 : pub struct State {
185 : /// Exclude http requests and background task from running at the same time.
186 : mutex: tokio::sync::Mutex<()>,
187 : }
188 :
189 0 : pub fn launch_disk_usage_global_eviction_task(
190 0 : conf: &'static PageServerConf,
191 0 : storage: GenericRemoteStorage,
192 0 : state: Arc<State>,
193 0 : tenant_manager: Arc<TenantManager>,
194 0 : background_jobs_barrier: completion::Barrier,
195 0 : ) -> anyhow::Result<()> {
196 0 : let Some(task_config) = &conf.disk_usage_based_eviction else {
197 0 : info!("disk usage based eviction task not configured");
198 0 : return Ok(());
199 : };
200 :
201 0 : info!("launching disk usage based eviction task");
202 :
203 0 : task_mgr::spawn(
204 0 : BACKGROUND_RUNTIME.handle(),
205 0 : TaskKind::DiskUsageEviction,
206 0 : None,
207 0 : None,
208 0 : "disk usage based eviction",
209 0 : false,
210 0 : async move {
211 0 : let cancel = task_mgr::shutdown_token();
212 :
213 : // wait until initial load is complete, because we cannot evict from loading tenants.
214 : tokio::select! {
215 : _ = cancel.cancelled() => { return Ok(()); },
216 : _ = background_jobs_barrier.wait() => { }
217 : };
218 :
219 0 : disk_usage_eviction_task(&state, task_config, &storage, tenant_manager, cancel).await;
220 0 : Ok(())
221 0 : },
222 0 : );
223 0 :
224 0 : Ok(())
225 0 : }
226 :
227 0 : #[instrument(skip_all)]
228 : async fn disk_usage_eviction_task(
229 : state: &State,
230 : task_config: &DiskUsageEvictionTaskConfig,
231 : storage: &GenericRemoteStorage,
232 : tenant_manager: Arc<TenantManager>,
233 : cancel: CancellationToken,
234 : ) {
235 : scopeguard::defer! {
236 : info!("disk usage based eviction task finishing");
237 : };
238 :
239 : use crate::tenant::tasks::random_init_delay;
240 : {
241 : if random_init_delay(task_config.period, &cancel)
242 : .await
243 : .is_err()
244 : {
245 : return;
246 : }
247 : }
248 :
249 : let mut iteration_no = 0;
250 : loop {
251 : iteration_no += 1;
252 : let start = Instant::now();
253 :
254 0 : async {
255 0 : let res = disk_usage_eviction_task_iteration(
256 0 : state,
257 0 : task_config,
258 0 : storage,
259 0 : &tenant_manager,
260 0 : &cancel,
261 0 : )
262 0 : .await;
263 :
264 0 : match res {
265 0 : Ok(()) => {}
266 0 : Err(e) => {
267 0 : // these stat failures are expected to be very rare
268 0 : warn!("iteration failed, unexpected error: {e:#}");
269 : }
270 : }
271 0 : }
272 : .instrument(tracing::info_span!("iteration", iteration_no))
273 : .await;
274 :
275 : let sleep_until = start + task_config.period;
276 : if tokio::time::timeout_at(sleep_until, cancel.cancelled())
277 : .await
278 : .is_ok()
279 : {
280 : break;
281 : }
282 : }
283 : }
284 :
285 : pub trait Usage: Clone + Copy + std::fmt::Debug {
286 : fn has_pressure(&self) -> bool;
287 : fn add_available_bytes(&mut self, bytes: u64);
288 : }
289 :
290 0 : async fn disk_usage_eviction_task_iteration(
291 0 : state: &State,
292 0 : task_config: &DiskUsageEvictionTaskConfig,
293 0 : storage: &GenericRemoteStorage,
294 0 : tenant_manager: &Arc<TenantManager>,
295 0 : cancel: &CancellationToken,
296 0 : ) -> anyhow::Result<()> {
297 0 : let tenants_dir = tenant_manager.get_conf().tenants_path();
298 0 : let usage_pre = filesystem_level_usage::get(&tenants_dir, task_config)
299 0 : .context("get filesystem-level disk usage before evictions")?;
300 0 : let res = disk_usage_eviction_task_iteration_impl(
301 0 : state,
302 0 : storage,
303 0 : usage_pre,
304 0 : tenant_manager,
305 0 : task_config.eviction_order,
306 0 : cancel,
307 0 : )
308 0 : .await;
309 0 : match res {
310 0 : Ok(outcome) => {
311 0 : debug!(?outcome, "disk_usage_eviction_iteration finished");
312 0 : match outcome {
313 0 : IterationOutcome::NoPressure | IterationOutcome::Cancelled => {
314 0 : // nothing to do, select statement below will handle things
315 0 : }
316 0 : IterationOutcome::Finished(outcome) => {
317 : // Verify with statvfs whether we made any real progress
318 0 : let after = filesystem_level_usage::get(&tenants_dir, task_config)
319 0 : // It's quite unlikely to hit the error here. Keep the code simple and bail out.
320 0 : .context("get filesystem-level disk usage after evictions")?;
321 :
322 0 : debug!(?after, "disk usage");
323 :
324 0 : if after.has_pressure() {
325 : // Don't bother doing an out-of-order iteration here now.
326 : // In practice, the task period is set to a value in the tens-of-seconds range,
327 : // which will cause another iteration to happen soon enough.
328 : // TODO: deltas between the three different usages would be helpful,
329 : // consider MiB, GiB, TiB
330 0 : warn!(?outcome, ?after, "disk usage still high");
331 : } else {
332 0 : info!(?outcome, ?after, "disk usage pressure relieved");
333 : }
334 : }
335 : }
336 : }
337 0 : Err(e) => {
338 0 : error!("disk_usage_eviction_iteration failed: {:#}", e);
339 : }
340 : }
341 :
342 0 : Ok(())
343 0 : }
344 :
345 : #[derive(Debug, Serialize)]
346 : #[allow(clippy::large_enum_variant)]
347 : pub enum IterationOutcome<U> {
348 : NoPressure,
349 : Cancelled,
350 : Finished(IterationOutcomeFinished<U>),
351 : }
352 :
353 : #[derive(Debug, Serialize)]
354 : pub struct IterationOutcomeFinished<U> {
355 : /// The actual usage observed before we started the iteration.
356 : before: U,
357 : /// The expected value for `after`, according to internal accounting, after phase 1.
358 : planned: PlannedUsage<U>,
359 : /// The outcome of phase 2, where we actually do the evictions.
360 : ///
361 : /// If all layers that phase 1 planned to evict _can_ actually get evicted, this will
362 : /// be the same as `planned`.
363 : assumed: AssumedUsage<U>,
364 : }
365 :
366 : #[derive(Debug, Serialize)]
367 : struct AssumedUsage<U> {
368 : /// The expected value for `after`, after phase 2.
369 : projected_after: U,
370 : /// The layers we failed to evict during phase 2.
371 : failed: LayerCount,
372 : }
373 :
374 : #[derive(Debug, Serialize)]
375 : struct PlannedUsage<U> {
376 : respecting_tenant_min_resident_size: U,
377 : fallback_to_global_lru: Option<U>,
378 : }
379 :
380 : #[derive(Debug, Default, Serialize)]
381 : struct LayerCount {
382 : file_sizes: u64,
383 : count: usize,
384 : }
385 :
386 0 : pub(crate) async fn disk_usage_eviction_task_iteration_impl<U: Usage>(
387 0 : state: &State,
388 0 : _storage: &GenericRemoteStorage,
389 0 : usage_pre: U,
390 0 : tenant_manager: &Arc<TenantManager>,
391 0 : eviction_order: EvictionOrder,
392 0 : cancel: &CancellationToken,
393 0 : ) -> anyhow::Result<IterationOutcome<U>> {
394 : // use tokio's mutex to get a Sync guard (instead of std::sync::Mutex)
395 0 : let _g = state
396 0 : .mutex
397 0 : .try_lock()
398 0 : .map_err(|_| anyhow::anyhow!("iteration is already executing"))?;
399 :
400 0 : debug!(?usage_pre, "disk usage");
401 :
402 0 : if !usage_pre.has_pressure() {
403 0 : return Ok(IterationOutcome::NoPressure);
404 0 : }
405 0 :
406 0 : warn!(
407 : ?usage_pre,
408 0 : "running disk usage based eviction due to pressure"
409 : );
410 :
411 0 : let (candidates, collection_time) = {
412 0 : let started_at = std::time::Instant::now();
413 0 : match collect_eviction_candidates(tenant_manager, eviction_order, cancel).await? {
414 : EvictionCandidates::Cancelled => {
415 0 : return Ok(IterationOutcome::Cancelled);
416 : }
417 0 : EvictionCandidates::Finished(partitioned) => (partitioned, started_at.elapsed()),
418 0 : }
419 0 : };
420 0 :
421 0 : METRICS.layers_collected.inc_by(candidates.len() as u64);
422 0 :
423 0 : tracing::info!(
424 0 : elapsed_ms = collection_time.as_millis(),
425 0 : total_layers = candidates.len(),
426 0 : "collection completed"
427 : );
428 :
429 : // Debug-log the list of candidates
430 0 : let now = SystemTime::now();
431 0 : for (i, (partition, candidate)) in candidates.iter().enumerate() {
432 0 : let nth = i + 1;
433 0 : let total_candidates = candidates.len();
434 0 : let size = candidate.layer.get_file_size();
435 0 : let rel = candidate.relative_last_activity;
436 0 : debug!(
437 0 : "cand {nth}/{total_candidates}: size={size}, rel_last_activity={rel}, no_access_for={}us, partition={partition:?}, {}/{}/{}",
438 0 : now.duration_since(candidate.last_activity_ts)
439 0 : .unwrap()
440 0 : .as_micros(),
441 0 : candidate.layer.get_tenant_shard_id(),
442 0 : candidate.layer.get_timeline_id(),
443 0 : candidate.layer.get_name(),
444 : );
445 : }
446 :
447 : // phase1: select victims to relieve pressure
448 : //
449 : // Walk through the list of candidates, until we have accumulated enough layers to get
450 : // us back under the pressure threshold. 'usage_planned' is updated so that it tracks
451 : // how much disk space would be used after evicting all the layers up to the current
452 : // point in the list.
453 : //
454 : // If we get far enough in the list that we start to evict layers that are below
455 : // the tenant's min-resident-size threshold, print a warning, and memorize the disk
456 : // usage at that point, in 'usage_planned_min_resident_size_respecting'.
457 :
458 0 : let (evicted_amount, usage_planned) =
459 0 : select_victims(&candidates, usage_pre).into_amount_and_planned();
460 0 :
461 0 : METRICS.layers_selected.inc_by(evicted_amount as u64);
462 0 :
463 0 : // phase2: evict layers
464 0 :
465 0 : let mut js = tokio::task::JoinSet::new();
466 0 : let limit = 1000;
467 0 :
468 0 : let mut evicted = candidates.into_iter().take(evicted_amount).fuse();
469 0 : let mut consumed_all = false;
470 0 :
471 0 : // After the evictions, `usage_assumed` is the post-eviction usage,
472 0 : // according to internal accounting.
473 0 : let mut usage_assumed = usage_pre;
474 0 : let mut evictions_failed = LayerCount::default();
475 0 :
476 0 : let evict_layers = async move {
477 : loop {
478 0 : let next = if js.len() >= limit || consumed_all {
479 0 : js.join_next().await
480 0 : } else if !js.is_empty() {
481 : // opportunistically consume ready result, one per each new evicted
482 0 : futures::future::FutureExt::now_or_never(js.join_next()).and_then(|x| x)
483 : } else {
484 0 : None
485 : };
486 :
487 0 : if let Some(next) = next {
488 0 : match next {
489 0 : Ok(Ok(file_size)) => {
490 0 : METRICS.layers_evicted.inc();
491 0 : usage_assumed.add_available_bytes(file_size);
492 0 : }
493 : Ok(Err((
494 0 : file_size,
495 0 : EvictionError::NotFound
496 0 : | EvictionError::Downloaded
497 0 : | EvictionError::Timeout,
498 0 : ))) => {
499 0 : evictions_failed.file_sizes += file_size;
500 0 : evictions_failed.count += 1;
501 0 : }
502 0 : Err(je) if je.is_cancelled() => unreachable!("not used"),
503 0 : Err(je) if je.is_panic() => { /* already logged */ }
504 0 : Err(je) => tracing::error!("unknown JoinError: {je:?}"),
505 : }
506 0 : }
507 :
508 0 : if consumed_all && js.is_empty() {
509 0 : break;
510 0 : }
511 :
512 : // calling again when consumed_all is fine as evicted is fused.
513 0 : let Some((_partition, candidate)) = evicted.next() else {
514 0 : if !consumed_all {
515 0 : tracing::info!("all evictions started, waiting");
516 0 : consumed_all = true;
517 0 : }
518 0 : continue;
519 : };
520 :
521 0 : match candidate.layer {
522 0 : EvictionLayer::Attached(layer) => {
523 0 : let file_size = layer.layer_desc().file_size;
524 0 : js.spawn(async move {
525 0 : // have a low eviction waiting timeout because our LRU calculations go stale fast;
526 0 : // also individual layer evictions could hang because of bugs and we do not want to
527 0 : // pause disk_usage_based_eviction for such.
528 0 : let timeout = std::time::Duration::from_secs(5);
529 0 :
530 0 : match layer.evict_and_wait(timeout).await {
531 0 : Ok(()) => Ok(file_size),
532 0 : Err(e) => Err((file_size, e)),
533 : }
534 0 : });
535 0 : }
536 0 : EvictionLayer::Secondary(layer) => {
537 0 : let file_size = layer.metadata.file_size;
538 0 :
539 0 : js.spawn(async move {
540 0 : layer
541 0 : .secondary_tenant
542 0 : .evict_layer(layer.timeline_id, layer.name)
543 0 : .await;
544 0 : Ok(file_size)
545 0 : });
546 0 : }
547 : }
548 0 : tokio::task::yield_now().await;
549 : }
550 :
551 0 : (usage_assumed, evictions_failed)
552 0 : };
553 :
554 0 : let started_at = std::time::Instant::now();
555 0 :
556 0 : let evict_layers = async move {
557 0 : let mut evict_layers = std::pin::pin!(evict_layers);
558 0 :
559 0 : let maximum_expected = std::time::Duration::from_secs(10);
560 :
561 0 : let res = tokio::time::timeout(maximum_expected, &mut evict_layers).await;
562 0 : let tuple = if let Ok(tuple) = res {
563 0 : tuple
564 : } else {
565 0 : let elapsed = started_at.elapsed();
566 0 : tracing::info!(elapsed_ms = elapsed.as_millis(), "still ongoing");
567 0 : evict_layers.await
568 : };
569 :
570 0 : let elapsed = started_at.elapsed();
571 0 : tracing::info!(elapsed_ms = elapsed.as_millis(), "completed");
572 0 : tuple
573 0 : };
574 :
575 0 : let evict_layers =
576 0 : evict_layers.instrument(tracing::info_span!("evict_layers", layers=%evicted_amount));
577 :
578 0 : let (usage_assumed, evictions_failed) = tokio::select! {
579 : tuple = evict_layers => { tuple },
580 : _ = cancel.cancelled() => {
581 : // dropping joinset will abort all pending evict_and_waits and that is fine, our
582 : // requests will still stand
583 : return Ok(IterationOutcome::Cancelled);
584 : }
585 : };
586 :
587 0 : Ok(IterationOutcome::Finished(IterationOutcomeFinished {
588 0 : before: usage_pre,
589 0 : planned: usage_planned,
590 0 : assumed: AssumedUsage {
591 0 : projected_after: usage_assumed,
592 0 : failed: evictions_failed,
593 0 : },
594 0 : }))
595 0 : }
596 :
597 : #[derive(Clone)]
598 : pub(crate) struct EvictionSecondaryLayer {
599 : pub(crate) secondary_tenant: Arc<SecondaryTenant>,
600 : pub(crate) timeline_id: TimelineId,
601 : pub(crate) name: LayerName,
602 : pub(crate) metadata: LayerFileMetadata,
603 : }
604 :
605 : /// Full [`Layer`] objects are specific to tenants in attached mode. This type is a layer
606 : /// of indirection to store either a `Layer`, or a reference to a secondary tenant and a layer name.
607 : #[derive(Clone)]
608 : pub(crate) enum EvictionLayer {
609 : Attached(Layer),
610 : Secondary(EvictionSecondaryLayer),
611 : }
612 :
613 : impl From<Layer> for EvictionLayer {
614 0 : fn from(value: Layer) -> Self {
615 0 : Self::Attached(value)
616 0 : }
617 : }
618 :
619 : impl EvictionLayer {
620 0 : pub(crate) fn get_tenant_shard_id(&self) -> &TenantShardId {
621 0 : match self {
622 0 : Self::Attached(l) => &l.layer_desc().tenant_shard_id,
623 0 : Self::Secondary(sl) => sl.secondary_tenant.get_tenant_shard_id(),
624 : }
625 0 : }
626 :
627 0 : pub(crate) fn get_timeline_id(&self) -> &TimelineId {
628 0 : match self {
629 0 : Self::Attached(l) => &l.layer_desc().timeline_id,
630 0 : Self::Secondary(sl) => &sl.timeline_id,
631 : }
632 0 : }
633 :
634 0 : pub(crate) fn get_name(&self) -> LayerName {
635 0 : match self {
636 0 : Self::Attached(l) => l.layer_desc().layer_name(),
637 0 : Self::Secondary(sl) => sl.name.clone(),
638 : }
639 0 : }
640 :
641 0 : pub(crate) fn get_file_size(&self) -> u64 {
642 0 : match self {
643 0 : Self::Attached(l) => l.layer_desc().file_size,
644 0 : Self::Secondary(sl) => sl.metadata.file_size,
645 : }
646 0 : }
647 : }
648 :
649 : #[derive(Clone)]
650 : pub(crate) struct EvictionCandidate {
651 : pub(crate) layer: EvictionLayer,
652 : pub(crate) last_activity_ts: SystemTime,
653 : pub(crate) relative_last_activity: finite_f32::FiniteF32,
654 : }
655 :
656 : impl std::fmt::Display for EvictionLayer {
657 0 : fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
658 0 : match self {
659 0 : Self::Attached(l) => l.fmt(f),
660 0 : Self::Secondary(sl) => {
661 0 : write!(f, "{}/{}", sl.timeline_id, sl.name)
662 : }
663 : }
664 0 : }
665 : }
666 :
667 : #[derive(Default)]
668 : pub(crate) struct DiskUsageEvictionInfo {
669 : /// Timeline's largest layer (remote or resident)
670 : pub max_layer_size: Option<u64>,
671 : /// Timeline's resident layers
672 : pub resident_layers: Vec<EvictionCandidate>,
673 : }
674 :
675 : impl std::fmt::Debug for EvictionCandidate {
676 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
677 0 : // format the tv_sec, tv_nsec into rfc3339 in case someone is looking at it
678 0 : // having to allocate a string to this is bad, but it will rarely be formatted
679 0 : let ts = chrono::DateTime::<chrono::Utc>::from(self.last_activity_ts);
680 0 : let ts = ts.to_rfc3339_opts(chrono::SecondsFormat::Nanos, true);
681 0 : struct DisplayIsDebug<'a, T>(&'a T);
682 0 : impl<'a, T: std::fmt::Display> std::fmt::Debug for DisplayIsDebug<'a, T> {
683 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
684 0 : write!(f, "{}", self.0)
685 0 : }
686 0 : }
687 0 : f.debug_struct("LocalLayerInfoForDiskUsageEviction")
688 0 : .field("layer", &DisplayIsDebug(&self.layer))
689 0 : .field("last_activity", &ts)
690 0 : .finish()
691 0 : }
692 : }
693 :
694 : #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
695 : enum MinResidentSizePartition {
696 : Above,
697 : Below,
698 : }
699 :
700 : enum EvictionCandidates {
701 : Cancelled,
702 : Finished(Vec<(MinResidentSizePartition, EvictionCandidate)>),
703 : }
704 :
705 : /// Gather the eviction candidates.
706 : ///
707 : /// The returned `Ok(EvictionCandidates::Finished(candidates))` is sorted in eviction
708 : /// order. A caller that evicts in that order, until pressure is relieved, implements
709 : /// the eviction policy outlined in the module comment.
710 : ///
711 : /// # Example with EvictionOrder::AbsoluteAccessed
712 : ///
713 : /// Imagine that there are two tenants, A and B, with five layers each, a-e.
714 : /// Each layer has size 100, and both tenant's min_resident_size is 150.
715 : /// The eviction order would be
716 : ///
717 : /// ```text
718 : /// partition last_activity_ts tenant/layer
719 : /// Above 18:30 A/c
720 : /// Above 19:00 A/b
721 : /// Above 18:29 B/c
722 : /// Above 19:05 B/b
723 : /// Above 20:00 B/a
724 : /// Above 20:03 A/a
725 : /// Below 20:30 A/d
726 : /// Below 20:40 B/d
727 : /// Below 20:45 B/e
728 : /// Below 20:58 A/e
729 : /// ```
730 : ///
731 : /// Now, if we need to evict 300 bytes to relieve pressure, we'd evict `A/c, A/b, B/c`.
732 : /// They are all in the `Above` partition, so, we respected each tenant's min_resident_size.
733 : ///
734 : /// But, if we need to evict 900 bytes to relieve pressure, we'd evict
735 : /// `A/c, A/b, B/c, B/b, B/a, A/a, A/d, B/d, B/e`, reaching into the `Below` partition
736 : /// after exhauting the `Above` partition.
737 : /// So, we did not respect each tenant's min_resident_size.
738 : ///
739 : /// # Example with EvictionOrder::RelativeAccessed
740 : ///
741 : /// ```text
742 : /// partition relative_age last_activity_ts tenant/layer
743 : /// Above 0/4 18:30 A/c
744 : /// Above 0/4 18:29 B/c
745 : /// Above 1/4 19:00 A/b
746 : /// Above 1/4 19:05 B/b
747 : /// Above 2/4 20:00 B/a
748 : /// Above 2/4 20:03 A/a
749 : /// Below 3/4 20:30 A/d
750 : /// Below 3/4 20:40 B/d
751 : /// Below 4/4 20:45 B/e
752 : /// Below 4/4 20:58 A/e
753 : /// ```
754 : ///
755 : /// With tenants having the same number of layers the picture does not change much. The same with
756 : /// A having many more layers **resident** (not all of them listed):
757 : ///
758 : /// ```text
759 : /// Above 0/100 18:30 A/c
760 : /// Above 0/4 18:29 B/c
761 : /// Above 1/100 19:00 A/b
762 : /// Above 2/100 20:03 A/a
763 : /// Above 3/100 20:03 A/nth_3
764 : /// Above 4/100 20:03 A/nth_4
765 : /// ...
766 : /// Above 1/4 19:05 B/b
767 : /// Above 25/100 20:04 A/nth_25
768 : /// ...
769 : /// Above 2/4 20:00 B/a
770 : /// Above 50/100 20:10 A/nth_50
771 : /// ...
772 : /// Below 3/4 20:40 B/d
773 : /// Below 99/100 20:30 A/nth_99
774 : /// Below 4/4 20:45 B/e
775 : /// Below 100/100 20:58 A/nth_100
776 : /// ```
777 : ///
778 : /// Now it's easier to see that because A has grown fast it has more layers to get evicted. What is
779 : /// difficult to see is what happens on the next round assuming the evicting 23 from the above list
780 : /// relieves the pressure (22 A layers gone, 1 B layers gone) but a new fast growing tenant C has
781 : /// appeared:
782 : ///
783 : /// ```text
784 : /// Above 0/87 20:04 A/nth_23
785 : /// Above 0/3 19:05 B/b
786 : /// Above 0/50 20:59 C/nth_0
787 : /// Above 1/87 20:04 A/nth_24
788 : /// Above 1/50 21:00 C/nth_1
789 : /// Above 2/87 20:04 A/nth_25
790 : /// ...
791 : /// Above 16/50 21:02 C/nth_16
792 : /// Above 1/3 20:00 B/a
793 : /// Above 27/87 20:10 A/nth_50
794 : /// ...
795 : /// Below 2/3 20:40 B/d
796 : /// Below 49/50 21:05 C/nth_49
797 : /// Below 86/87 20:30 A/nth_99
798 : /// Below 3/3 20:45 B/e
799 : /// Below 50/50 21:05 C/nth_50
800 : /// Below 87/87 20:58 A/nth_100
801 : /// ```
802 : ///
803 : /// Now relieving pressure with 23 layers would cost:
804 : /// - tenant A 14 layers
805 : /// - tenant B 1 layer
806 : /// - tenant C 8 layers
807 0 : async fn collect_eviction_candidates(
808 0 : tenant_manager: &Arc<TenantManager>,
809 0 : eviction_order: EvictionOrder,
810 0 : cancel: &CancellationToken,
811 0 : ) -> anyhow::Result<EvictionCandidates> {
812 : const LOG_DURATION_THRESHOLD: std::time::Duration = std::time::Duration::from_secs(10);
813 :
814 : // get a snapshot of the list of tenants
815 0 : let tenants = tenant_manager
816 0 : .list_tenants()
817 0 : .context("get list of tenants")?;
818 :
819 : // TODO: avoid listing every layer in every tenant: this loop can block the executor,
820 : // and the resulting data structure can be huge.
821 : // (https://github.com/neondatabase/neon/issues/6224)
822 0 : let mut candidates = Vec::new();
823 :
824 0 : for (tenant_id, _state, _gen) in tenants {
825 0 : if cancel.is_cancelled() {
826 0 : return Ok(EvictionCandidates::Cancelled);
827 0 : }
828 0 : let tenant = match tenant_manager.get_attached_tenant_shard(tenant_id) {
829 0 : Ok(tenant) if tenant.is_active() => tenant,
830 : Ok(_) => {
831 0 : debug!(tenant_id=%tenant_id.tenant_id, shard_id=%tenant_id.shard_slug(), "Tenant shard is not active");
832 0 : continue;
833 : }
834 0 : Err(e) => {
835 0 : // this can happen if tenant has lifecycle transition after we fetched it
836 0 : debug!("failed to get tenant: {e:#}");
837 0 : continue;
838 : }
839 : };
840 :
841 0 : if tenant.cancel.is_cancelled() {
842 0 : info!(%tenant_id, "Skipping tenant for eviction, it is shutting down");
843 0 : continue;
844 0 : }
845 0 :
846 0 : let started_at = std::time::Instant::now();
847 0 :
848 0 : // collect layers from all timelines in this tenant
849 0 : //
850 0 : // If one of the timelines becomes `!is_active()` during the iteration,
851 0 : // for example because we're shutting down, then `max_layer_size` can be too small.
852 0 : // That's OK. This code only runs under a disk pressure situation, and being
853 0 : // a little unfair to tenants during shutdown in such a situation is tolerable.
854 0 : let mut tenant_candidates = Vec::new();
855 0 : let mut max_layer_size = 0;
856 0 : for tl in tenant.list_timelines() {
857 0 : if !tl.is_active() {
858 0 : continue;
859 0 : }
860 0 : let info = tl.get_local_layers_for_disk_usage_eviction().await;
861 0 : debug!(tenant_id=%tl.tenant_shard_id.tenant_id, shard_id=%tl.tenant_shard_id.shard_slug(), timeline_id=%tl.timeline_id, "timeline resident layers count: {}", info.resident_layers.len());
862 :
863 0 : tenant_candidates.extend(info.resident_layers.into_iter());
864 0 : max_layer_size = max_layer_size.max(info.max_layer_size.unwrap_or(0));
865 0 :
866 0 : if cancel.is_cancelled() {
867 0 : return Ok(EvictionCandidates::Cancelled);
868 0 : }
869 : }
870 :
871 : // `min_resident_size` defaults to maximum layer file size of the tenant.
872 : // This ensures that each tenant can have at least one layer resident at a given time,
873 : // ensuring forward progress for a single Timeline::get in that tenant.
874 : // It's a questionable heuristic since, usually, there are many Timeline::get
875 : // requests going on for a tenant, and, at least in Neon prod, the median
876 : // layer file size is much smaller than the compaction target size.
877 : // We could be better here, e.g., sum of all L0 layers + most recent L1 layer.
878 : // That's what's typically used by the various background loops.
879 : //
880 : // The default can be overridden with a fixed value in the tenant conf.
881 : // A default override can be put in the default tenant conf in the pageserver.toml.
882 0 : let min_resident_size = if let Some(s) = tenant.get_min_resident_size_override() {
883 0 : debug!(
884 0 : tenant_id=%tenant.tenant_shard_id().tenant_id,
885 0 : shard_id=%tenant.tenant_shard_id().shard_slug(),
886 0 : overridden_size=s,
887 0 : "using overridden min resident size for tenant"
888 : );
889 0 : s
890 : } else {
891 0 : debug!(
892 0 : tenant_id=%tenant.tenant_shard_id().tenant_id,
893 0 : shard_id=%tenant.tenant_shard_id().shard_slug(),
894 0 : max_layer_size,
895 0 : "using max layer size as min_resident_size for tenant",
896 : );
897 0 : max_layer_size
898 : };
899 :
900 : // Sort layers most-recently-used first, then partition by
901 : // cumsum above/below min_resident_size.
902 0 : tenant_candidates
903 0 : .sort_unstable_by_key(|layer_info| std::cmp::Reverse(layer_info.last_activity_ts));
904 0 : let mut cumsum: i128 = 0;
905 0 :
906 0 : let total = tenant_candidates.len();
907 0 :
908 0 : let tenant_candidates =
909 0 : tenant_candidates
910 0 : .into_iter()
911 0 : .enumerate()
912 0 : .map(|(i, mut candidate)| {
913 0 : // as we iterate this reverse sorted list, the most recently accessed layer will always
914 0 : // be 1.0; this is for us to evict it last.
915 0 : candidate.relative_last_activity =
916 0 : eviction_order.relative_last_activity(total, i);
917 :
918 0 : let partition = if cumsum > min_resident_size as i128 {
919 0 : MinResidentSizePartition::Above
920 : } else {
921 0 : MinResidentSizePartition::Below
922 : };
923 0 : cumsum += i128::from(candidate.layer.get_file_size());
924 0 :
925 0 : (partition, candidate)
926 0 : });
927 0 :
928 0 : METRICS
929 0 : .tenant_layer_count
930 0 : .observe(tenant_candidates.len() as f64);
931 0 :
932 0 : candidates.extend(tenant_candidates);
933 0 :
934 0 : let elapsed = started_at.elapsed();
935 0 : METRICS
936 0 : .tenant_collection_time
937 0 : .observe(elapsed.as_secs_f64());
938 0 :
939 0 : if elapsed > LOG_DURATION_THRESHOLD {
940 0 : tracing::info!(
941 0 : tenant_id=%tenant.tenant_shard_id().tenant_id,
942 0 : shard_id=%tenant.tenant_shard_id().shard_slug(),
943 0 : elapsed_ms = elapsed.as_millis(),
944 0 : "collection took longer than threshold"
945 : );
946 0 : }
947 : }
948 :
949 : // Note: the same tenant ID might be hit twice, if it transitions from attached to
950 : // secondary while we run. That is okay: when we eventually try and run the eviction,
951 : // the `Gate` on the object will ensure that whichever one has already been shut down
952 : // will not delete anything.
953 :
954 0 : let mut secondary_tenants = Vec::new();
955 0 : tenant_manager.foreach_secondary_tenants(
956 0 : |_tenant_shard_id: &TenantShardId, state: &Arc<SecondaryTenant>| {
957 0 : secondary_tenants.push(state.clone());
958 0 : },
959 0 : );
960 :
961 0 : for tenant in secondary_tenants {
962 : // for secondary tenants we use a sum of on_disk layers and already evicted layers. this is
963 : // to prevent repeated disk usage based evictions from completely draining less often
964 : // updating secondaries.
965 0 : let (mut layer_info, total_layers) = tenant.get_layers_for_eviction();
966 0 :
967 0 : debug_assert!(
968 0 : total_layers >= layer_info.resident_layers.len(),
969 0 : "total_layers ({total_layers}) must be at least the resident_layers.len() ({})",
970 0 : layer_info.resident_layers.len()
971 : );
972 :
973 0 : let started_at = std::time::Instant::now();
974 0 :
975 0 : layer_info
976 0 : .resident_layers
977 0 : .sort_unstable_by_key(|layer_info| std::cmp::Reverse(layer_info.last_activity_ts));
978 0 :
979 0 : let tenant_candidates =
980 0 : layer_info
981 0 : .resident_layers
982 0 : .into_iter()
983 0 : .enumerate()
984 0 : .map(|(i, mut candidate)| {
985 0 : candidate.relative_last_activity =
986 0 : eviction_order.relative_last_activity(total_layers, i);
987 0 : (
988 0 : // Secondary locations' layers are always considered above the min resident size,
989 0 : // i.e. secondary locations are permitted to be trimmed to zero layers if all
990 0 : // the layers have sufficiently old access times.
991 0 : MinResidentSizePartition::Above,
992 0 : candidate,
993 0 : )
994 0 : });
995 0 :
996 0 : METRICS
997 0 : .tenant_layer_count
998 0 : .observe(tenant_candidates.len() as f64);
999 0 : candidates.extend(tenant_candidates);
1000 0 :
1001 0 : tokio::task::yield_now().await;
1002 :
1003 0 : let elapsed = started_at.elapsed();
1004 0 :
1005 0 : METRICS
1006 0 : .tenant_collection_time
1007 0 : .observe(elapsed.as_secs_f64());
1008 0 :
1009 0 : if elapsed > LOG_DURATION_THRESHOLD {
1010 0 : tracing::info!(
1011 0 : tenant_id=%tenant.tenant_shard_id().tenant_id,
1012 0 : shard_id=%tenant.tenant_shard_id().shard_slug(),
1013 0 : elapsed_ms = elapsed.as_millis(),
1014 0 : "collection took longer than threshold"
1015 : );
1016 0 : }
1017 : }
1018 :
1019 0 : debug_assert!(MinResidentSizePartition::Above < MinResidentSizePartition::Below,
1020 0 : "as explained in the function's doc comment, layers that aren't in the tenant's min_resident_size are evicted first");
1021 :
1022 0 : eviction_order.sort(&mut candidates);
1023 0 :
1024 0 : Ok(EvictionCandidates::Finished(candidates))
1025 0 : }
1026 :
1027 : /// Given a pre-sorted vec of all layers in the system, select the first N which are enough to
1028 : /// relieve pressure.
1029 : ///
1030 : /// Returns the amount of candidates selected, with the planned usage.
1031 0 : fn select_victims<U: Usage>(
1032 0 : candidates: &[(MinResidentSizePartition, EvictionCandidate)],
1033 0 : usage_pre: U,
1034 0 : ) -> VictimSelection<U> {
1035 0 : let mut usage_when_switched = None;
1036 0 : let mut usage_planned = usage_pre;
1037 0 : let mut evicted_amount = 0;
1038 :
1039 0 : for (i, (partition, candidate)) in candidates.iter().enumerate() {
1040 0 : if !usage_planned.has_pressure() {
1041 0 : break;
1042 0 : }
1043 0 :
1044 0 : if partition == &MinResidentSizePartition::Below && usage_when_switched.is_none() {
1045 0 : usage_when_switched = Some((usage_planned, i));
1046 0 : }
1047 :
1048 0 : usage_planned.add_available_bytes(candidate.layer.get_file_size());
1049 0 : evicted_amount += 1;
1050 : }
1051 :
1052 0 : VictimSelection {
1053 0 : amount: evicted_amount,
1054 0 : usage_pre,
1055 0 : usage_when_switched,
1056 0 : usage_planned,
1057 0 : }
1058 0 : }
1059 :
1060 : struct VictimSelection<U> {
1061 : amount: usize,
1062 : usage_pre: U,
1063 : usage_when_switched: Option<(U, usize)>,
1064 : usage_planned: U,
1065 : }
1066 :
1067 : impl<U: Usage> VictimSelection<U> {
1068 0 : fn into_amount_and_planned(self) -> (usize, PlannedUsage<U>) {
1069 0 : debug!(
1070 : evicted_amount=%self.amount,
1071 0 : "took enough candidates for pressure to be relieved"
1072 : );
1073 :
1074 0 : if let Some((usage_planned, candidate_no)) = self.usage_when_switched.as_ref() {
1075 0 : warn!(usage_pre=?self.usage_pre, ?usage_planned, candidate_no, "tenant_min_resident_size-respecting LRU would not relieve pressure, evicting more following global LRU policy");
1076 0 : }
1077 :
1078 0 : let planned = match self.usage_when_switched {
1079 0 : Some((respecting_tenant_min_resident_size, _)) => PlannedUsage {
1080 0 : respecting_tenant_min_resident_size,
1081 0 : fallback_to_global_lru: Some(self.usage_planned),
1082 0 : },
1083 0 : None => PlannedUsage {
1084 0 : respecting_tenant_min_resident_size: self.usage_planned,
1085 0 : fallback_to_global_lru: None,
1086 0 : },
1087 : };
1088 :
1089 0 : (self.amount, planned)
1090 0 : }
1091 : }
1092 :
1093 : /// A totally ordered f32 subset we can use with sorting functions.
1094 : pub(crate) mod finite_f32 {
1095 :
1096 : /// A totally ordered f32 subset we can use with sorting functions.
1097 : #[derive(Clone, Copy, PartialEq)]
1098 : pub struct FiniteF32(f32);
1099 :
1100 : impl std::fmt::Debug for FiniteF32 {
1101 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1102 0 : std::fmt::Debug::fmt(&self.0, f)
1103 0 : }
1104 : }
1105 :
1106 : impl std::fmt::Display for FiniteF32 {
1107 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1108 0 : std::fmt::Display::fmt(&self.0, f)
1109 0 : }
1110 : }
1111 :
1112 : impl std::cmp::Eq for FiniteF32 {}
1113 :
1114 : impl std::cmp::PartialOrd for FiniteF32 {
1115 0 : fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
1116 0 : Some(self.cmp(other))
1117 0 : }
1118 : }
1119 :
1120 : impl std::cmp::Ord for FiniteF32 {
1121 0 : fn cmp(&self, other: &Self) -> std::cmp::Ordering {
1122 0 : self.0.total_cmp(&other.0)
1123 0 : }
1124 : }
1125 :
1126 : impl TryFrom<f32> for FiniteF32 {
1127 : type Error = f32;
1128 :
1129 0 : fn try_from(value: f32) -> Result<Self, Self::Error> {
1130 0 : if value.is_finite() {
1131 0 : Ok(FiniteF32(value))
1132 : } else {
1133 0 : Err(value)
1134 : }
1135 0 : }
1136 : }
1137 :
1138 : impl From<FiniteF32> for f32 {
1139 40 : fn from(value: FiniteF32) -> f32 {
1140 40 : value.0
1141 40 : }
1142 : }
1143 :
1144 : impl FiniteF32 {
1145 : pub const ZERO: FiniteF32 = FiniteF32(0.0);
1146 :
1147 40 : pub fn try_from_normalized(value: f32) -> Result<Self, f32> {
1148 40 : if (0.0..=1.0).contains(&value) {
1149 : // -0.0 is within the range, make sure it is assumed 0.0..=1.0
1150 40 : let value = value.abs();
1151 40 : Ok(FiniteF32(value))
1152 : } else {
1153 0 : Err(value)
1154 : }
1155 40 : }
1156 :
1157 40 : pub fn into_inner(self) -> f32 {
1158 40 : self.into()
1159 40 : }
1160 : }
1161 : }
1162 :
1163 : mod filesystem_level_usage {
1164 : use anyhow::Context;
1165 : use camino::Utf8Path;
1166 :
1167 : use crate::statvfs::Statvfs;
1168 :
1169 : use super::DiskUsageEvictionTaskConfig;
1170 :
1171 : #[derive(Debug, Clone, Copy)]
1172 : pub struct Usage<'a> {
1173 : config: &'a DiskUsageEvictionTaskConfig,
1174 :
1175 : /// Filesystem capacity
1176 : total_bytes: u64,
1177 : /// Free filesystem space
1178 : avail_bytes: u64,
1179 : }
1180 :
1181 : impl super::Usage for Usage<'_> {
1182 14 : fn has_pressure(&self) -> bool {
1183 14 : let usage_pct =
1184 14 : (100.0 * (1.0 - ((self.avail_bytes as f64) / (self.total_bytes as f64)))) as u64;
1185 14 :
1186 14 : let pressures = [
1187 14 : (
1188 14 : "min_avail_bytes",
1189 14 : self.avail_bytes < self.config.min_avail_bytes,
1190 14 : ),
1191 14 : (
1192 14 : "max_usage_pct",
1193 14 : usage_pct >= self.config.max_usage_pct.get() as u64,
1194 14 : ),
1195 14 : ];
1196 14 :
1197 28 : pressures.into_iter().any(|(_, has_pressure)| has_pressure)
1198 14 : }
1199 :
1200 12 : fn add_available_bytes(&mut self, bytes: u64) {
1201 12 : self.avail_bytes += bytes;
1202 12 : }
1203 : }
1204 :
1205 0 : pub fn get<'a>(
1206 0 : tenants_dir: &Utf8Path,
1207 0 : config: &'a DiskUsageEvictionTaskConfig,
1208 0 : ) -> anyhow::Result<Usage<'a>> {
1209 0 : let mock_config = {
1210 0 : #[cfg(feature = "testing")]
1211 0 : {
1212 0 : config.mock_statvfs.as_ref()
1213 : }
1214 : #[cfg(not(feature = "testing"))]
1215 : {
1216 : None
1217 : }
1218 : };
1219 :
1220 0 : let stat = Statvfs::get(tenants_dir, mock_config)
1221 0 : .context("statvfs failed, presumably directory got unlinked")?;
1222 :
1223 : // https://unix.stackexchange.com/a/703650
1224 0 : let blocksize = if stat.fragment_size() > 0 {
1225 0 : stat.fragment_size()
1226 : } else {
1227 0 : stat.block_size()
1228 : };
1229 :
1230 : // use blocks_available (b_avail) since, pageserver runs as unprivileged user
1231 0 : let avail_bytes = stat.blocks_available() * blocksize;
1232 0 : let total_bytes = stat.blocks() * blocksize;
1233 0 :
1234 0 : Ok(Usage {
1235 0 : config,
1236 0 : total_bytes,
1237 0 : avail_bytes,
1238 0 : })
1239 0 : }
1240 :
1241 : #[test]
1242 2 : fn max_usage_pct_pressure() {
1243 2 : use super::EvictionOrder;
1244 2 : use super::Usage as _;
1245 2 : use std::time::Duration;
1246 2 : use utils::serde_percent::Percent;
1247 2 :
1248 2 : let mut usage = Usage {
1249 2 : config: &DiskUsageEvictionTaskConfig {
1250 2 : max_usage_pct: Percent::new(85).unwrap(),
1251 2 : min_avail_bytes: 0,
1252 2 : period: Duration::MAX,
1253 2 : #[cfg(feature = "testing")]
1254 2 : mock_statvfs: None,
1255 2 : eviction_order: EvictionOrder::default(),
1256 2 : },
1257 2 : total_bytes: 100_000,
1258 2 : avail_bytes: 0,
1259 2 : };
1260 2 :
1261 2 : assert!(usage.has_pressure(), "expected pressure at 100%");
1262 :
1263 2 : usage.add_available_bytes(14_000);
1264 2 : assert!(usage.has_pressure(), "expected pressure at 86%");
1265 :
1266 2 : usage.add_available_bytes(999);
1267 2 : assert!(usage.has_pressure(), "expected pressure at 85.001%");
1268 :
1269 2 : usage.add_available_bytes(1);
1270 2 : assert!(usage.has_pressure(), "expected pressure at precisely 85%");
1271 :
1272 2 : usage.add_available_bytes(1);
1273 2 : assert!(!usage.has_pressure(), "no pressure at 84.999%");
1274 :
1275 2 : usage.add_available_bytes(999);
1276 2 : assert!(!usage.has_pressure(), "no pressure at 84%");
1277 :
1278 2 : usage.add_available_bytes(16_000);
1279 2 : assert!(!usage.has_pressure());
1280 2 : }
1281 : }
1282 :
1283 : #[cfg(test)]
1284 : mod tests {
1285 : use super::*;
1286 :
1287 : #[test]
1288 2 : fn relative_equal_bounds() {
1289 2 : let order = EvictionOrder::RelativeAccessed {
1290 2 : highest_layer_count_loses_first: false,
1291 2 : };
1292 2 :
1293 2 : let len = 10;
1294 2 : let v = (0..len)
1295 20 : .map(|i| order.relative_last_activity(len, i).into_inner())
1296 2 : .collect::<Vec<_>>();
1297 2 :
1298 2 : assert_eq!(v.first(), Some(&1.0));
1299 2 : assert_eq!(v.last(), Some(&0.0));
1300 18 : assert!(v.windows(2).all(|slice| slice[0] > slice[1]));
1301 2 : }
1302 :
1303 : #[test]
1304 2 : fn relative_spare_bounds() {
1305 2 : let order = EvictionOrder::RelativeAccessed {
1306 2 : highest_layer_count_loses_first: true,
1307 2 : };
1308 2 :
1309 2 : let len = 10;
1310 2 : let v = (0..len)
1311 20 : .map(|i| order.relative_last_activity(len, i).into_inner())
1312 2 : .collect::<Vec<_>>();
1313 2 :
1314 2 : assert_eq!(v.first(), Some(&1.0));
1315 2 : assert_eq!(v.last(), Some(&0.1));
1316 18 : assert!(v.windows(2).all(|slice| slice[0] > slice[1]));
1317 2 : }
1318 : }
|
