src/developer/forensics/crash_reports/store.h

// Copyright 2020 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_DEVELOPER_FORENSICS_CRASH_REPORTS_STORE_H_
#define SRC_DEVELOPER_FORENSICS_CRASH_REPORTS_STORE_H_

#include <optional>
#include <string>
#include <vector>

#include "src/developer/forensics/crash_reports/info/info_context.h"
#include "src/developer/forensics/crash_reports/info/store_info.h"
#include "src/developer/forensics/crash_reports/log_tags.h"
#include "src/developer/forensics/crash_reports/report.h"
#include "src/developer/forensics/crash_reports/report_id.h"
#include "src/developer/forensics/crash_reports/store_metadata.h"
#include "src/developer/forensics/utils/storage_size.h"

namespace forensics {
namespace crash_reports {

// Stores the contents of reports that have not yet been uploaded.
class Store {
 public:
  // |root_dir| is the location in the filesystem where reports will be stored. For example,
  // if |root_dir| is /tmp/store and a report for "foo" is filed, that report
  // will be stored in /tmp/store/foo/<report ReportId>.
  // |max_size| is the maximum size the store can take, garbage collecting the reports of lowest
  // ReportIds.
  Store(LogTags* tags, std::shared_ptr<InfoContext> info_context, const std::string& root_dir,
        StorageSize max_size);

  // Adds a report to the store and returns the ReportIds of any report garbage collected in the
  // process.
  bool Add(ReportId report_id, Report report, std::vector<ReportId>* garbage_collected_reports);

  // Gets a report from the store. If no report exists for |id| or there is an error reading the
  // report from the filesystem, return std::nullopt.
  std::optional<Report> Get(ReportId id);

  // Returns true if a report with ReportId |id| is removed from the store.
  bool Remove(ReportId id);

  void RemoveAll();

  std::vector<ReportId> GetReports() const;

  // Exposed for testing purposes.
  bool Contains(ReportId id) const;

 private:
  // Removes reports until |required_space| is free in the store and returns the ReportIds of the
  // reports removed.
  //
  // Return false if |required_space| cannot be freed.
  bool MakeFreeSpace(StorageSize required_space, std::vector<ReportId>* garbage_collected_reports);

  std::string root_dir_;

  StoreMetadata metadata_;
  LogTags* tags_;
  StoreInfo info_;
};

}  // namespace crash_reports
}  // namespace forensics

#endif  // SRC_DEVELOPER_FORENSICS_CRASH_REPORTS_STORE_H_