tvl-depot/third_party/nix/src/libstore/nar-info-disk-cache.cc

#include "libstore/nar-info-disk-cache.hh"

#include <absl/strings/str_cat.h>
#include <absl/strings/str_split.h>
#include <glog/logging.h>
#include <sqlite3.h>

#include "libstore/globals.hh"
#include "libstore/sqlite.hh"
#include "libutil/sync.hh"

namespace nix {

static const char* schema = R"sql(

create table if not exists BinaryCaches (
    id        integer primary key autoincrement not null,
    url       text unique not null,
    timestamp integer not null,
    storeDir  text not null,
    wantMassQuery integer not null,
    priority  integer not null
);

create table if not exists NARs (
    cache            integer not null,
    hashPart         text not null,
    namePart         text,
    url              text,
    compression      text,
    fileHash         text,
    fileSize         integer,
    narHash          text,
    narSize          integer,
    refs             text,
    deriver          text,
    sigs             text,
    ca               text,
    timestamp        integer not null,
    present          integer not null,
    primary key (cache, hashPart),
    foreign key (cache) references BinaryCaches(id) on delete cascade
);

create table if not exists LastPurge (
    dummy            text primary key,
    value            integer
);

)sql";

class NarInfoDiskCacheImpl final : public NarInfoDiskCache {
 public:
  /* How often to purge expired entries from the cache. */
  const int purgeInterval = 24 * 3600;

  struct Cache {
    int id;
    Path storeDir;
    bool wantMassQuery;
    int priority;
  };

  struct State {
    SQLite db;
    SQLiteStmt insertCache, queryCache, insertNAR, insertMissingNAR, queryNAR,
        purgeCache;
    std::map<std::string, Cache> caches;
  };

  Sync<State> _state;

  NarInfoDiskCacheImpl() {
    auto state(_state.lock());

    Path dbPath = getCacheDir() + "/nix/binary-cache-v6.sqlite";
    createDirs(dirOf(dbPath));

    state->db = SQLite(dbPath);

    if (sqlite3_busy_timeout(state->db, 60 * 60 * 1000) != SQLITE_OK) {
      throwSQLiteError(state->db, "setting timeout");
    }

    // We can always reproduce the cache.
    state->db.exec("pragma synchronous = off");
    state->db.exec("pragma main.journal_mode = truncate");

    state->db.exec(schema);

    state->insertCache.create(
        state->db,
        "insert or replace into BinaryCaches(url, timestamp, storeDir, "
        "wantMassQuery, priority) values (?, ?, ?, ?, ?)");

    state->queryCache.create(state->db,
                             "select id, storeDir, wantMassQuery, priority "
                             "from BinaryCaches where url = ?");

    state->insertNAR.create(
        state->db,
        "insert or replace into NARs(cache, hashPart, namePart, url, "
        "compression, fileHash, fileSize, narHash, "
        "narSize, refs, deriver, sigs, ca, timestamp, present) values (?, ?, "
        "?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, 1)");

    state->insertMissingNAR.create(
        state->db,
        "insert or replace into NARs(cache, hashPart, timestamp, present) "
        "values (?, ?, ?, 0)");

    state->queryNAR.create(
        state->db,
        "select present, namePart, url, compression, fileHash, fileSize, "
        "narHash, narSize, refs, deriver, sigs, ca from NARs where cache = ? "
        "and hashPart = ? and ((present = 0 and timestamp > ?) or (present = 1 "
        "and timestamp > ?))");

    /* Periodically purge expired entries from the database. */
    retrySQLite<void>([&]() {
      auto now = time(nullptr);

      SQLiteStmt queryLastPurge(state->db, "select value from LastPurge");
      auto queryLastPurge_(queryLastPurge.use());

      if (!queryLastPurge_.next() ||
          queryLastPurge_.getInt(0) < now - purgeInterval) {
        SQLiteStmt(state->db,
                   "delete from NARs where ((present = 0 and timestamp < ?) or "
                   "(present = 1 and timestamp < ?))")
            .use()(now - settings.ttlNegativeNarInfoCache)(
                now - settings.ttlPositiveNarInfoCache)
            .exec();

        DLOG(INFO) << "deleted " << sqlite3_changes(state->db)
                   << " entries from the NAR info disk cache";

        SQLiteStmt(
            state->db,
            "insert or replace into LastPurge(dummy, value) values ('', ?)")
            .use()(now)
            .exec();
      }
    });
  }

  static Cache& getCache(State& state, const std::string& uri) {
    auto i = state.caches.find(uri);
    if (i == state.caches.end()) {
      abort();
    }
    return i->second;
  }

  void createCache(const std::string& uri, const Path& storeDir,
                   bool wantMassQuery, int priority) override {
    retrySQLite<void>([&]() {
      auto state(_state.lock());

      // FIXME: race

      state->insertCache
          .use()(uri)(time(nullptr))(storeDir)(
              static_cast<int64_t>(wantMassQuery))(priority)
          .exec();
      assert(sqlite3_changes(state->db) == 1);
      state->caches[uri] =
          Cache{static_cast<int>(sqlite3_last_insert_rowid(state->db)),
                storeDir, wantMassQuery, priority};
    });
  }

  bool cacheExists(const std::string& uri, bool& wantMassQuery,
                   int& priority) override {
    return retrySQLite<bool>([&]() {
      auto state(_state.lock());

      auto i = state->caches.find(uri);
      if (i == state->caches.end()) {
        auto queryCache(state->queryCache.use()(uri));
        if (!queryCache.next()) {
          return false;
        }
        state->caches.emplace(
            uri, Cache{static_cast<int>(queryCache.getInt(0)),
                       queryCache.getStr(1), queryCache.getInt(2) != 0,
                       static_cast<int>(queryCache.getInt(3))});
      }

      auto& cache(getCache(*state, uri));

      wantMassQuery = cache.wantMassQuery;
      priority = cache.priority;

      return true;
    });
  }

  std::pair<Outcome, std::shared_ptr<NarInfo>> lookupNarInfo(
      const std::string& uri, const std::string& hashPart) override {
    return retrySQLite<std::pair<Outcome, std::shared_ptr<NarInfo>>>(
        [&]() -> std::pair<Outcome, std::shared_ptr<NarInfo>> {
          auto state(_state.lock());

          auto& cache(getCache(*state, uri));

          auto now = time(nullptr);

          auto queryNAR(state->queryNAR.use()(cache.id)(hashPart)(
              now - settings.ttlNegativeNarInfoCache)(
              now - settings.ttlPositiveNarInfoCache));

          if (!queryNAR.next()) {
            return {oUnknown, nullptr};
          }

          if (queryNAR.getInt(0) == 0) {
            return {oInvalid, nullptr};
          }

          auto narInfo = make_ref<NarInfo>();

          auto namePart = queryNAR.getStr(1);
          narInfo->path = cache.storeDir + "/" + hashPart +
                          (namePart.empty() ? "" : "-" + namePart);
          narInfo->url = queryNAR.getStr(2);
          narInfo->compression = queryNAR.getStr(3);
          if (!queryNAR.isNull(4)) {
            auto hash_ = Hash::deserialize(queryNAR.getStr(4));
            // TODO(#statusor): does this throw mess with retrySQLite?
            narInfo->fileHash = Hash::unwrap_throw(hash_);
          }
          narInfo->fileSize = queryNAR.getInt(5);
          auto hash_ = Hash::deserialize(queryNAR.getStr(6));
          narInfo->narHash = Hash::unwrap_throw(hash_);
          narInfo->narSize = queryNAR.getInt(7);
          for (auto r : absl::StrSplit(queryNAR.getStr(8), absl::ByChar(' '),
                                       absl::SkipEmpty())) {
            narInfo->references.insert(absl::StrCat(cache.storeDir, "/", r));
          }
          if (!queryNAR.isNull(9)) {
            narInfo->deriver = cache.storeDir + "/" + queryNAR.getStr(9);
          }
          for (auto& sig : absl::StrSplit(
                   queryNAR.getStr(10), absl::ByChar(' '), absl::SkipEmpty())) {
            narInfo->sigs.insert(std::string(sig));
          }
          narInfo->ca = queryNAR.getStr(11);

          return {oValid, narInfo};
        });
  }

  void upsertNarInfo(const std::string& uri, const std::string& hashPart,
                     std::shared_ptr<ValidPathInfo> info) override {
    retrySQLite<void>([&]() {
      auto state(_state.lock());

      auto& cache(getCache(*state, uri));

      if (info) {
        auto narInfo = std::dynamic_pointer_cast<NarInfo>(info);

        assert(hashPart == storePathToHash(info->path));

        state->insertNAR
            .use()(cache.id)(hashPart)(storePathToName(info->path))(
                narInfo ? narInfo->url : "", narInfo != nullptr)(
                narInfo ? narInfo->compression : "", narInfo != nullptr)(
                narInfo && narInfo->fileHash ? narInfo->fileHash.to_string()
                                             : "",
                narInfo && narInfo->fileHash)(
                narInfo ? narInfo->fileSize : 0,
                narInfo != nullptr &&
                    (narInfo->fileSize != 0u))(info->narHash.to_string())(
                info->narSize)(concatStringsSep(" ", info->shortRefs()))(
                !info->deriver.empty() ? baseNameOf(info->deriver) : "",
                !info->deriver.empty())(concatStringsSep(" ", info->sigs))(
                info->ca)(time(nullptr))
            .exec();

      } else {
        state->insertMissingNAR.use()(cache.id)(hashPart)(time(nullptr)).exec();
      }
    });
  }
};

std::shared_ptr<NarInfoDiskCache> getNarInfoDiskCache() {
  static std::shared_ptr<NarInfoDiskCache> cache =
      std::make_shared<NarInfoDiskCacheImpl>();
  return cache;
}

}  // namespace nix