3party/crashpad
0
0
Fork 0
mirror of https://github.com/chromium/crashpad.git synced 2024-12-27 15:32:10 +08:00
Code Issues Projects Releases Wiki Activity

Don’t log an error when creating a new crash report database

Browse Source 
Previously, any attempt to create a new crash report database would
result in this message being logged:

[p:t:yyyymmdd,hhmmss.uuuuuu:ERROR file_io.cc:30] read: expected 40,
observed 0

This would be the first thing that a developer embedding Crashpad into
their application would see after getting everything right. It doesn’t
exactly seem like everything’s right with that being logged. It would
also be the first thing that a user would see on stderr or in logs upon
launching a Crashpad-enabled application, which also seems kind of
dodgy.

The crash report database settings creation logic is restructured to
avoid logging this error when definitely creating a new database, while
retaining all other error logging.

BUG=crashpad:63
TEST=crashpad_database_util --database $new_db --show-client-id
     (should not show any errors)

R=rsesek@chromium.org, scottmg@chromium.org

Review URL: https://codereview.chromium.org/1392953002 .
This commit is contained in:
Mark Mentovai 2015-10-07 16:20:29 -04:00
parent 9fdb70738b
commit 0884d4d3a8
2 changed files with 100 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
client/settings.cc
View File

@ -71,18 +71,18 @@ Settings::~Settings() {
}
bool Settings::Initialize() {
INITIALIZATION_STATE_SET_INITIALIZING(initialized_);
initialized_.set_invalid();
Data settings;
if (!OpenForWritingAndReadSettings(&settings).is_valid())
return false;
INITIALIZATION_STATE_SET_VALID(initialized_);
initialized_.set_valid();
return true;
}
bool Settings::GetClientID(UUID* client_id) {
INITIALIZATION_STATE_DCHECK_VALID(initialized_);
DCHECK(initialized_.is_valid());
Data settings;
if (!OpenAndReadSettings(&settings))
@ -93,7 +93,7 @@ bool Settings::GetClientID(UUID* client_id) {
}
bool Settings::GetUploadsEnabled(bool* enabled) {
INITIALIZATION_STATE_DCHECK_VALID(initialized_);
DCHECK(initialized_.is_valid());
Data settings;
if (!OpenAndReadSettings(&settings))
@ -104,7 +104,7 @@ bool Settings::GetUploadsEnabled(bool* enabled) {
}
bool Settings::SetUploadsEnabled(bool enabled) {
INITIALIZATION_STATE_DCHECK_VALID(initialized_);
DCHECK(initialized_.is_valid());
Data settings;
ScopedLockedFileHandle handle = OpenForWritingAndReadSettings(&settings);
@ -120,7 +120,7 @@ bool Settings::SetUploadsEnabled(bool enabled) {
}
bool Settings::GetLastUploadAttemptTime(time_t* time) {
INITIALIZATION_STATE_DCHECK_VALID(initialized_);
DCHECK(initialized_.is_valid());
Data settings;
if (!OpenAndReadSettings(&settings))
@ -132,7 +132,7 @@ bool Settings::GetLastUploadAttemptTime(time_t* time) {
}
bool Settings::SetLastUploadAttemptTime(time_t time) {
INITIALIZATION_STATE_DCHECK_VALID(initialized_);
DCHECK(initialized_.is_valid());
Data settings;
ScopedLockedFileHandle handle = OpenForWritingAndReadSettings(&settings);
@ -161,12 +161,20 @@ Settings::ScopedLockedFileHandle Settings::OpenForReading() {
FileLocking::kShared);
}
Settings::ScopedLockedFileHandle Settings::OpenForReadingAndWriting() {
return MakeScopedLockedFileHandle(
LoggingOpenFileForReadAndWrite(file_path(),
FileWriteMode::kReuseOrCreate,
FilePermissions::kWorldReadable),
FileLocking::kExclusive);
Settings::ScopedLockedFileHandle Settings::OpenForReadingAndWriting(
FileWriteMode mode, bool log_open_error) {
DCHECK(mode != FileWriteMode::kTruncateOrCreate);
FileHandle handle;
if (log_open_error) {
handle = LoggingOpenFileForReadAndWrite(
file_path(), mode, FilePermissions::kWorldReadable);
} else {
handle = OpenFileForReadAndWrite(
file_path(), mode, FilePermissions::kWorldReadable);
}
return MakeScopedLockedFileHandle(handle, FileLocking::kExclusive);
}
bool Settings::OpenAndReadSettings(Data* out_data) {
@ -174,7 +182,7 @@ bool Settings::OpenAndReadSettings(Data* out_data) {
if (!handle.is_valid())
return false;
if (ReadSettings(handle.get(), out_data))
if (ReadSettings(handle.get(), out_data, true))
return true;
// The settings file is corrupt, so reinitialize it.
@ -186,11 +194,48 @@ bool Settings::OpenAndReadSettings(Data* out_data) {
Settings::ScopedLockedFileHandle Settings::OpenForWritingAndReadSettings(
Data* out_data) {
ScopedLockedFileHandle handle = OpenForReadingAndWriting();
ScopedLockedFileHandle handle;
bool created = false;
if (!initialized_.is_valid()) {
// If this object is initializing, it hasn’t seen a settings file already,
// so go easy on errors. Creating a new settings file for the first time
// shouldn’t spew log messages.
//
// First, try to use an existing settings file.
handle = OpenForReadingAndWriting(FileWriteMode::kReuseOrFail, false);
if (!handle.is_valid()) {
// Create a new settings file if it didn’t already exist.
handle = OpenForReadingAndWriting(FileWriteMode::kCreateOrFail, false);
if (handle.is_valid()) {
created = true;
}
// There may have been a race to create the file, and something else may
// have won. There will be one more attempt to try to open or create the
// file below.
}
}
if (!handle.is_valid()) {
// Either the object is initialized, meaning it’s already seen a valid
// settings file, or the object is initializing and none of the above
// attempts to create the settings file succeeded. Either way, this is the
// last chance for success, so if this fails, log a message.
handle = OpenForReadingAndWriting(FileWriteMode::kReuseOrCreate, true);
}
if (!handle.is_valid())
return ScopedLockedFileHandle();
if (!ReadSettings(handle.get(), out_data)) {
// Attempt reading the settings even if the file is known to have just been
// created. The file-create and file-lock operations don’t occur atomically,
// and something else may have written the settings before this invocation
// took the lock. If the settings file was definitely just created, though,
// don’t log any read errors. The expected non-race behavior in this case is a
// zero-length read, with ReadSettings() failing.
if (!ReadSettings(handle.get(), out_data, !created)) {
if (!RecoverSettings(handle.get(), out_data))
return ScopedLockedFileHandle();
}
@ -198,11 +243,19 @@ Settings::ScopedLockedFileHandle Settings::OpenForWritingAndReadSettings(
return handle.Pass();
}
bool Settings::ReadSettings(FileHandle handle, Data* out_data) {
bool Settings::ReadSettings(FileHandle handle,
Data* out_data,
bool log_read_error) {
if (LoggingSeekFile(handle, 0, SEEK_SET) != 0)
return false;
if (!LoggingReadFile(handle, out_data, sizeof(*out_data)))
bool read_result;
if (log_read_error)
read_result = LoggingReadFile(handle, out_data, sizeof(*out_data));
else
read_result = ReadFile(handle, out_data, sizeof(*out_data));
if (!read_result)
return false;
if (out_data->magic != Data::kSettingsMagic) {
@ -231,12 +284,13 @@ bool Settings::WriteSettings(FileHandle handle, const Data& data) {
bool Settings::RecoverSettings(FileHandle handle, Data* out_data) {
ScopedLockedFileHandle scoped_handle;
if (handle == kInvalidFileHandle) {
scoped_handle = OpenForReadingAndWriting();
scoped_handle =
OpenForReadingAndWriting(FileWriteMode::kReuseOrCreate, true);
handle = scoped_handle.get();
// Test if the file has already been recovered now that the exclusive lock
// is held.
if (ReadSettings(handle, out_data))
if (ReadSettings(handle, out_data, true))
return true;
}
@ -248,7 +302,7 @@ bool Settings::RecoverSettings(FileHandle handle, Data* out_data) {
if (!InitializeSettings(handle))
return false;
return ReadSettings(handle, out_data);
return ReadSettings(handle, out_data, true);
}
bool Settings::InitializeSettings(FileHandle handle) {

32
client/settings.h
View File

@ -23,7 +23,7 @@
#include "base/files/file_path.h"
#include "base/scoped_generic.h"
#include "util/file/file_io.h"
#include "util/misc/initialization_state_dcheck.h"
#include "util/misc/initialization_state.h"
#include "util/misc/uuid.h"
namespace crashpad {
@ -108,8 +108,7 @@ class Settings {
// This must be constructed with MakeScopedLockedFileHandle(). It both unlocks
// and closes the file on destruction.
using ScopedLockedFileHandle =
base::ScopedGeneric<FileHandle,
internal::ScopedLockedFileHandleTraits>;
base::ScopedGeneric<FileHandle, internal::ScopedLockedFileHandleTraits>;
static ScopedLockedFileHandle MakeScopedLockedFileHandle(FileHandle file,
FileLocking locking);
@ -118,8 +117,15 @@ class Settings {
ScopedLockedFileHandle OpenForReading();
// Opens the settings file for reading and writing. On error, logs a message
// and returns the invalid handle.
ScopedLockedFileHandle OpenForReadingAndWriting();
// and returns the invalid handle. |mode| determines how the file will be
// opened. |mode| must not be FileWriteMode::kTruncateOrCreate.
//
// If |log_open_error| is false, nothing will be logged for an error
// encountered when attempting to open the file, but this method will still
// return false. This is intended to be used to suppress error messages when
// attempting to create a new settings file when multiple attempts are made.
ScopedLockedFileHandle OpenForReadingAndWriting(FileWriteMode mode,
bool log_open_error);
// Opens the settings file and reads the data. If that fails, an error will
// be logged and the settings will be recovered and re-initialized. If that
@ -133,10 +139,20 @@ class Settings {
// Reads the settings from |handle|. Logs an error and returns false on
// failure. This does not perform recovery.
bool ReadSettings(FileHandle handle, Data* out_data);
//
// |handle| must be the result of OpenForReading() or
// OpenForReadingAndWriting().
//
// If |log_read_error| is false, nothing will be logged for a read error, but
// this method will still return false. This is intended to be used to
// suppress error messages when attempting to read a newly created settings
// file.
bool ReadSettings(FileHandle handle, Data* out_data, bool log_read_error);
// Writes the settings to |handle|. Logs an error and returns false on
// failure. This does not perform recovery.
//
// |handle| must be the result of OpenForReadingAndWriting().
bool WriteSettings(FileHandle handle, const Data& data);
// Recovers the settings file by re-initializing the data. If |handle| is the
@ -149,13 +165,15 @@ class Settings {
// Initializes a settings file and writes the data to |handle|. Returns true
// on success and false on failure, with an error logged.
//
// |handle| must be the result of OpenForReadingAndWriting().
bool InitializeSettings(FileHandle handle);
const base::FilePath& file_path() const { return file_path_; }
base::FilePath file_path_;
InitializationStateDcheck initialized_;
InitializationState initialized_;
DISALLOW_COPY_AND_ASSIGN(Settings);
};