blob: c1de0fe3a675091f2cf5576c4340757666c658d6 [file] [log] [blame]
// Copyright 2020 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// DiskCleanup contains methods used to free up disk space.
// Used by DiskCleanup to perform the actual cleanup.
#include <cstdint>
#include <memory>
#include <vector>
#include <base/optional.h>
#include <base/time/time.h>
#include "cryptohome/disk_cleanup_routines.h"
#include "cryptohome/homedirs.h"
#include "cryptohome/platform.h"
#include "cryptohome/user_oldest_activity_timestamp_cache.h"
namespace cryptohome {
// Cleanup parameters in bytes.
const int64_t kFreeSpaceThresholdToTriggerCleanup = 1LL << 30;
const int64_t kFreeSpaceThresholdToTriggerAggressiveCleanup = 768 * 1024 * 1024;
const int64_t kTargetFreeSpaceAfterCleanup = 2LL << 30;
class DiskCleanupRoutines;
class DiskCleanup {
// Entries are sorted by the severity of the lack of free space. See
// FreeDiskSpaceState for thresholds.
enum class FreeSpaceState {
kError, // error while determining the amount of free disk
// space
kAboveTarget, // above target free disk space for cleanup result
kAboveThreshold, // above cleanup threshold but below cleanup target
kNeedNormalCleanup, // below threshold for normal cleanup
kNeedAggressiveCleanup, // below threshold for aggressive cleanup
DiskCleanup() = default;
DiskCleanup(Platform* platform,
HomeDirs* homedirs,
UserOldestActivityTimestampCache* timestamp_cache);
virtual ~DiskCleanup() = default;
// Return the available disk space in bytes for home directories, or nullopt
// on failure.
virtual base::Optional<int64_t> AmountOfFreeDiskSpace() const;
// Determines the state of the free disk space based on the following
// thresholds:
// kAboveTarget: free_disk_space >= cleanup_target_
// kAboveThreshold: cleanup_target_ > free_disk_space =>
// normal_cleanup_threshold_
// kNeedNormalCleanup: normal_cleanup_threshold_ >
// free_disk_space =>
// aggresive_cleanup_threshold_
// kNeedAggressiveCleanup: aggresive_cleanup_threshold_ >
// free_disk_space
virtual FreeSpaceState GetFreeDiskSpaceState(base::Optional<int64_t>) const;
// Uses AmountOfFreeDiskSpace to get the current amount of free disk space and
// to determine the state of the free disk space.
virtual FreeSpaceState GetFreeDiskSpaceState() const;
// Returns true if there is now at least cleanup_target_
// amount of free disk space or false otherwise.
virtual bool HasTargetFreeSpace() const;
// Checks if it is possible to free up disk space.
virtual bool IsFreeableDiskSpaceAvailable();
// Frees disk space for unused cryptohomes. If the available disk space is
// below normal_cleanup_threshold_, attempts to free space until
// it goes up to cleanup_target_.
virtual void FreeDiskSpace();
// Setters for cleanup thresholds.
virtual void set_cleanup_threshold(uint64_t cleanup_threshold) {
normal_cleanup_threshold_ = cleanup_threshold;
virtual void set_aggressive_cleanup_threshold(
uint64_t aggressive_cleanup_threshold) {
aggressive_cleanup_threshold_ = aggressive_cleanup_threshold;
virtual void set_target_free_space(uint64_t target_free_space) {
target_free_space_ = target_free_space;
// Testing methods.
void set_routines_for_testing(
DiskCleanupRoutines* routines /* takes ownership */);
// Actually performs disk cleanup. Called by FreeDiskSpace.
void FreeDiskSpaceInternal();
// Removes all mounted homedirs from the vector
void FilterMountedHomedirs(std::vector<HomeDirs::HomeDir>* homedirs);
// Removes all homedirs that have not been active since the cutoff
void FilterHomedirsProcessedBeforeCutoff(
base::Time cutoff, std::vector<HomeDirs::HomeDir>* homedirs);
// Not owned. Must outlive DiskCleanup. Passed with call to Init.
Platform* platform_ = nullptr;
HomeDirs* homedirs_ = nullptr;
UserOldestActivityTimestampCache* timestamp_cache_ = nullptr;
// Cleanup routines.
std::unique_ptr<DiskCleanupRoutines> routines_;
// Disk cleanup thresholds. Can be set using command line flags.
uint64_t normal_cleanup_threshold_ = kFreeSpaceThresholdToTriggerCleanup;
uint64_t aggressive_cleanup_threshold_ =
uint64_t target_free_space_ = kTargetFreeSpaceAfterCleanup;
// Cleanup times.
base::Optional<base::Time> last_free_disk_space_ = base::nullopt;
base::Optional<base::Time> last_normal_disk_cleanup_complete_ = base::nullopt;
base::Optional<base::Time> last_aggressive_disk_cleanup_complete_ =
} // namespace cryptohome