| // 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 <map> |
| #include <optional> |
| #include <string> |
| |
| #include "src/developer/forensics/crash_reports/report.h" |
| |
| namespace forensics { |
| namespace crash_reports { |
| |
| // Stores the contents of reports that have not yet been uploaded. |
| class Store { |
| public: |
| // A unique report identifier. |
| using Uid = uint64_t; |
| |
| // |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 Uid>. |
| explicit Store(const std::string& root_dir); |
| |
| // Adds a report to the store. If the operation fails, std::nullopt is returned, else a unique |
| // identifier referring to the report is returned. |
| std::optional<Uid> Add(Report report); |
| |
| // 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(const Uid& id); |
| |
| void Remove(const Uid& id); |
| void RemoveAll(); |
| |
| // Exposed for testing purposes. |
| bool Contains(const Uid& id) const; |
| |
| private: |
| struct ReportMetadata { |
| // The directory containing the report's files, e.g., /tmp/crashes/foo/<report Uid> |
| std::string dir; |
| |
| // "foo" in the above example, it shouldn't contain forward slashes. |
| std::string program_shortname; |
| }; |
| |
| std::string root_dir_; |
| std::map<Uid, ReportMetadata> id_to_metadata_; |
| |
| // TODO(47137): Uids may collide across component instances, however this will no longer happen |
| // once we rebuild the store's metadata when the component starts up. |
| Uid next_id_{0}; |
| }; |
| |
| } // namespace crash_reports |
| } // namespace forensics |
| |
| #endif // SRC_DEVELOPER_FORENSICS_CRASH_REPORTS_STORE_H_ |