1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "remoting/base/crash/crashpad_database_manager.h"
#include <stdlib.h>
#include <vector>
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/i18n/time_formatting.h"
#include "base/path_service.h"
#include "base/strings/string_number_conversions.h"
#include "remoting/base/file_path_util_linux.h"
#include "third_party/crashpad/crashpad/client/crash_report_database.h"
#include "third_party/crashpad/crashpad/client/settings.h"
#if BUILDFLAG(IS_WIN)
#include "base/base_paths.h"
#include "base/strings/utf_string_conversions.h"
#endif // BUILDFLAG(IS_WIN)
namespace {
const base::FilePath::CharType kChromotingCrashpadDatabasePath[] =
FILE_PATH_LITERAL("crashpad");
// Maximum number of crash reports to log. Reports are sorted by timestamp so
// the most recent N reports will be logged.
const size_t kMaxReportsToLog = 2;
// Maximum number of crash reports to retain in the database. When the database
// contains more than this number, the oldest ones will be deleted, regardless
// of |kMaxReportDays|.
const size_t kMaxReportsToRetain = 20;
// Maximum number of days to keep reports around in the local database.
const size_t kMaxReportAgeDays = 7;
} // namespace
namespace remoting {
base::FilePath GetCrashpadDatabasePath() {
base::FilePath database_path;
#if BUILDFLAG(IS_WIN)
base::PathService::Get(base::BasePathKey::DIR_ASSETS, &database_path);
#else
database_path = GetConfigDirectoryPath();
#endif
return database_path.Append(kChromotingCrashpadDatabasePath);
}
CrashpadDatabaseManager::CrashpadDatabaseManager(Logger& logger)
: logger_(logger) {}
CrashpadDatabaseManager::~CrashpadDatabaseManager() = default;
bool CrashpadDatabaseManager::InitializeCrashpadDatabase() {
base::FilePath database_path = GetCrashpadDatabasePath();
base::File::Error error;
if (!base::CreateDirectoryAndGetError(database_path, &error)) {
#if BUILDFLAG(IS_WIN)
logger_->LogError("Unable to get directory for crash database: " +
base::WideToUTF8(database_path.value()));
#else
logger_->LogError("Unable to get directory for crash database: " +
database_path.value());
#endif
logger_->LogError("File Error: " + base::File::ErrorToString(error));
return false;
}
database_ = crashpad::CrashReportDatabase::Initialize(database_path);
if (!database_) {
logger_->LogError("Unable to initialize crash database");
return false;
}
// Load and sort the completed crash reports.
if (!LoadCompletedReports()) {
return false;
}
if (!LoadPendingReports()) {
return false;
}
return true;
}
bool CrashpadDatabaseManager::EnableReportUploads() {
if (!database_ || !database_->GetSettings()->SetUploadsEnabled(true)) {
logger_->LogError("Unable to enable Crashpad report uploads");
return false;
}
return true;
}
void CrashpadDatabaseManager::LogCompletedCrashpadReports() {
if (!database_) {
logger_->LogError("Crashpad database has not been initialized");
return;
}
LogCrashReports(completed_reports_, "Completed");
}
void CrashpadDatabaseManager::LogPendingCrashpadReports() {
if (!database_) {
logger_->LogError("Crashpad database has not been initialized");
return;
}
LogCrashReports(pending_reports_, "Pending");
}
bool CrashpadDatabaseManager::CleanupCompletedCrashpadReports() {
if (!database_) {
logger_->LogError("Crashpad database has not been initialized");
return false;
}
CleanupCrashReports(completed_reports_);
// Reload the completed reports since we may have deleted some entries.
return LoadCompletedReports();
}
// private
bool CrashpadDatabaseManager::LoadCompletedReports() {
crashpad::CrashReportDatabase::OperationStatus status =
database_->GetCompletedReports(&completed_reports_);
if (status != crashpad::CrashReportDatabase::OperationStatus::kNoError) {
logger_->LogError("Unable to read completed crash reports: " +
base::NumberToString(status));
return false;
}
SortCrashReports(completed_reports_);
return true;
}
bool CrashpadDatabaseManager::LoadPendingReports() {
crashpad::CrashReportDatabase::OperationStatus status =
database_->GetPendingReports(&pending_reports_);
if (status != crashpad::CrashReportDatabase::OperationStatus::kNoError) {
logger_->LogError("Unable to read pending crash reports: " +
base::NumberToString(status));
return false;
}
SortCrashReports(pending_reports_);
return true;
}
void CrashpadDatabaseManager::SortCrashReports(
std::vector<crashpad::CrashReportDatabase::Report>& reports) {
std::sort(reports.begin(), reports.end(),
[](crashpad::CrashReportDatabase::Report const& a,
crashpad::CrashReportDatabase::Report const& b) {
return a.creation_time > b.creation_time;
});
}
void CrashpadDatabaseManager::LogCrashReportInfo(
const crashpad::CrashReportDatabase::Report& report) {
const std::string& id = report.id;
// |id| will only be assigned if the report has been successfully uploaded.
if (id.empty()) {
logger_->Log(" Crash id: <unassigned>");
} else {
logger_->Log(" Crash id: " + id + " (http://go/crash/" + id + ")");
}
#if BUILDFLAG(IS_WIN)
logger_->Log(" path: " + base::WideToUTF8(report.file_path.value()));
#else
logger_->Log(" path: " + report.file_path.value());
#endif
logger_->Log(" uuid: " + report.uuid.ToString());
logger_->Log(" created: " +
TimeFormatHTTP(base::Time::FromTimeT(report.creation_time)));
std::string uploaded = report.uploaded ? "yes" : "no";
logger_->Log(" uploaded: " + uploaded + " (attempts: " +
base::NumberToString(report.upload_attempts) + ")");
}
void CrashpadDatabaseManager::LogCrashReports(
std::vector<crashpad::CrashReportDatabase::Report>& reports,
std::string_view report_type) {
size_t num_reports = reports.size();
if (num_reports > kMaxReportsToLog) {
logger_->Log("Recent " + std::string(report_type) + " crash reports: " +
base::NumberToString(num_reports) + " (most recent " +
base::NumberToString(kMaxReportsToLog) + " shown)");
} else {
logger_->Log("Recent " + std::string(report_type) +
" crash reports: " + base::NumberToString(num_reports));
}
for (size_t i = 0; i < num_reports && i < kMaxReportsToLog; ++i) {
LogCrashReportInfo(reports[i]);
}
}
bool CrashpadDatabaseManager::CleanupCrashReports(
std::vector<crashpad::CrashReportDatabase::Report>& reports) {
if (!database_) {
return false;
}
// Cleanup the oldest reports if we have too many in the database.
size_t num_reports = reports.size();
if (num_reports > kMaxReportsToRetain) {
logger_->Log("Too many crash reports in database. Retaining most recent " +
base::NumberToString(kMaxReportsToRetain));
for (size_t i = kMaxReportsToRetain; i < num_reports; ++i) {
const auto& report = reports[i];
std::string creation_time =
base::TimeFormatHTTP(base::Time::FromTimeT(report.creation_time));
logger_->Log(" Deleting crash report: " + report.id + " (" +
report.uuid.ToString() + ") " + creation_time);
auto status = database_->DeleteReport(report.uuid);
if (status != crashpad::CrashReportDatabase::OperationStatus::kNoError) {
logger_->LogError(
" Unable to delete crash report: " + base::NumberToString(status) +
" " + report.id + " (" + report.uuid.ToString() + ")");
return false;
}
}
reports.resize(kMaxReportsToRetain);
}
base::Time now = base::Time::Now();
base::Time threshold = now - base::Days(kMaxReportAgeDays);
// Cleanup old uploaded reports.
bool header_shown = false;
for (const auto& report : reports) {
base::Time created = base::Time::FromTimeT(report.creation_time);
if (report.uploaded && created < threshold) {
if (!header_shown) {
header_shown = true;
logger_->Log("Deleting uploaded crash reports older than " +
base::NumberToString(kMaxReportAgeDays) + " days:");
}
logger_->Log(" Deleting crash report: " + report.id + " (" +
base::TimeFormatHTTP(created) + ")");
auto status = database_->DeleteReport(report.uuid);
if (status != crashpad::CrashReportDatabase::OperationStatus::kNoError) {
logger_->LogError(" Unable to delete uploaded crash report: " +
base::NumberToString(status) + " " + report.id +
" (" + report.uuid.ToString() + ")");
return false;
}
}
}
// Cleanup old reports that haven't been uploaded.
header_shown = false;
for (const auto& report : reports) {
base::Time created = base::Time::FromTimeT(report.creation_time);
if (!report.uploaded && created < threshold) {
if (!header_shown) {
header_shown = true;
logger_->Log("Deleting crash reports older than " +
base::NumberToString(kMaxReportAgeDays) + " days:");
}
// We need to log |uuid| here because only uploaded reports have an |id|.
logger_->Log(" Deleting crash report: " + report.uuid.ToString() + " (" +
TimeFormatHTTP(created) + ")");
auto status = database_->DeleteReport(report.uuid);
if (status != crashpad::CrashReportDatabase::OperationStatus::kNoError) {
logger_->LogError(" Unable to delete old crash report: " +
base::NumberToString(status) + " (" +
report.uuid.ToString() + ")");
return false;
}
}
}
return true;
}
} // namespace remoting
|