gc-store.hh

Go to the documentation of this file.

#pragma once
 
#include "lix/libstore/store-api.hh"
#include "lix/libutil/types.hh"
 
 
namespace nix {
 

typedef std::unordered_map<StorePath, std::unordered_set<std::string>> Roots;
typedef std::unordered_map<Path, std::unordered_set<std::string>> UncheckedRoots;
 
 
struct GCOptions
{
    typedef enum {
        gcReturnLive,
        gcReturnDead,
        gcDeleteDead,
        gcDeleteSpecific,
        gcTryDeleteSpecific,
    } GCAction;
 
    GCAction action{gcDeleteDead};

    bool ignoreLiveness{false};

    StorePathSet pathsToDelete;

    uint64_t maxFreed{std::numeric_limits<uint64_t>::max()};
};
 
 
struct GCResults
{
    PathSet paths;

    PathSet kept;

    uint64_t bytesFreed = 0;
};
 

struct GcStore : public virtual Store
{
    inline static std::string operationName = "Garbage collection";

    virtual kj::Promise<Result<Roots>> findRoots(bool censor) = 0;

    virtual kj::Promise<Result<void>>
    collectGarbage(const GCOptions & options, GCResults & results) = 0;
};
 
}