2022-09-06 19:14:07 -04:00
|
|
|
// Copyright 2015 The Crashpad Authors
|
2015-02-18 14:15:38 -05:00
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
#include "util/file/file_reader.h"
|
|
|
|
|
2023-10-18 12:08:10 -07:00
|
|
|
#include "base/check_op.h"
|
2015-02-18 14:15:38 -05:00
|
|
|
#include "base/logging.h"
|
|
|
|
#include "base/numerics/safe_conversions.h"
|
2015-08-07 13:57:05 -04:00
|
|
|
#include "build/build_config.h"
|
2015-02-18 14:15:38 -05:00
|
|
|
|
|
|
|
namespace crashpad {
|
|
|
|
|
util/file: Handle oversized reads and writes gracefully
file_io and the FileReader family had a few loose ends regarding big
reads and writes. It’s not likely that we’ve experienced these
conditions yet, but they’d be likely to appear in a potential future
involving full memory dumps. This specifies the behavior with large
reads and writes, consolidates some logic, and improves some interfaces.
ReadFile() should always return without retrying after a short read, and
in fact does return after short reads since 00b64427523b. It is
straightforward to limit the maximum read size based on a parameter
limitation of the underlying operation, or a limitation of the type used
for FileOperationResult.
In contrast, WriteFile() should always retry after a short write,
including a write shortened because of a parameter limitation of the
underlying operation, or a limitation of the type used for
FileOperationResult. This allows its return value to be simplified to a
“bool”.
The platform-specific WriteFile() code has been moved to
internal::NativeWriteFile(), and the platform-independent loop that
retries following a short write has been refactored into
internal::WriteAllInternal so that it can be used by a new test.
The platform-agnostic ReadFileExactlyInternal() implementation has been
refactored into internal::ReadExactlyInternal so that it can be used by
a new test and by FileReaderInterface::ReadExactly(), which had a nearly
identical implementation.
Test: crashpad_util_test FileIO.ReadExactly_*:FileIO.WriteAll_*:FileReader.ReadExactly_*
Change-Id: I487450322ab049c6f2acd4061ea814037cc9a864
Reviewed-on: https://chromium-review.googlesource.com/456824
Reviewed-by: Scott Graham <scottmg@chromium.org>
2017-03-21 15:08:05 -04:00
|
|
|
bool FileReaderInterface::ReadExactly(void* data, size_t size) {
|
2024-10-21 14:52:29 +11:00
|
|
|
return internal::ReadExactly(
|
|
|
|
[this](bool can_log, void* buffer, size_t size) {
|
|
|
|
DCHECK(can_log);
|
|
|
|
return Read(buffer, size);
|
|
|
|
},
|
|
|
|
true,
|
|
|
|
data,
|
|
|
|
size);
|
2015-02-18 18:22:39 -05:00
|
|
|
}
|
|
|
|
|
2015-02-18 14:15:38 -05:00
|
|
|
WeakFileHandleFileReader::WeakFileHandleFileReader(FileHandle file_handle)
|
|
|
|
: file_handle_(file_handle) {
|
|
|
|
}
|
|
|
|
|
|
|
|
WeakFileHandleFileReader::~WeakFileHandleFileReader() {
|
|
|
|
}
|
|
|
|
|
2015-10-22 16:14:18 -07:00
|
|
|
FileOperationResult WeakFileHandleFileReader::Read(void* data, size_t size) {
|
2015-02-18 14:15:38 -05:00
|
|
|
DCHECK_NE(file_handle_, kInvalidFileHandle);
|
|
|
|
|
2015-10-22 16:14:18 -07:00
|
|
|
base::checked_cast<FileOperationResult>(size);
|
|
|
|
FileOperationResult rv = ReadFile(file_handle_, data, size);
|
2015-02-18 14:15:38 -05:00
|
|
|
if (rv < 0) {
|
util/file: Handle oversized reads and writes gracefully
file_io and the FileReader family had a few loose ends regarding big
reads and writes. It’s not likely that we’ve experienced these
conditions yet, but they’d be likely to appear in a potential future
involving full memory dumps. This specifies the behavior with large
reads and writes, consolidates some logic, and improves some interfaces.
ReadFile() should always return without retrying after a short read, and
in fact does return after short reads since 00b64427523b. It is
straightforward to limit the maximum read size based on a parameter
limitation of the underlying operation, or a limitation of the type used
for FileOperationResult.
In contrast, WriteFile() should always retry after a short write,
including a write shortened because of a parameter limitation of the
underlying operation, or a limitation of the type used for
FileOperationResult. This allows its return value to be simplified to a
“bool”.
The platform-specific WriteFile() code has been moved to
internal::NativeWriteFile(), and the platform-independent loop that
retries following a short write has been refactored into
internal::WriteAllInternal so that it can be used by a new test.
The platform-agnostic ReadFileExactlyInternal() implementation has been
refactored into internal::ReadExactlyInternal so that it can be used by
a new test and by FileReaderInterface::ReadExactly(), which had a nearly
identical implementation.
Test: crashpad_util_test FileIO.ReadExactly_*:FileIO.WriteAll_*:FileReader.ReadExactly_*
Change-Id: I487450322ab049c6f2acd4061ea814037cc9a864
Reviewed-on: https://chromium-review.googlesource.com/456824
Reviewed-by: Scott Graham <scottmg@chromium.org>
2017-03-21 15:08:05 -04:00
|
|
|
PLOG(ERROR) << internal::kNativeReadFunctionName;
|
2015-02-18 14:15:38 -05:00
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
return rv;
|
|
|
|
}
|
|
|
|
|
|
|
|
FileOffset WeakFileHandleFileReader::Seek(FileOffset offset, int whence) {
|
|
|
|
DCHECK_NE(file_handle_, kInvalidFileHandle);
|
|
|
|
return LoggingSeekFile(file_handle_, offset, whence);
|
|
|
|
}
|
|
|
|
|
|
|
|
FileReader::FileReader()
|
|
|
|
: file_(),
|
|
|
|
weak_file_handle_file_reader_(kInvalidFileHandle) {
|
|
|
|
}
|
|
|
|
|
|
|
|
FileReader::~FileReader() {
|
|
|
|
}
|
|
|
|
|
2015-03-05 15:40:47 -05:00
|
|
|
bool FileReader::Open(const base::FilePath& path) {
|
2015-02-18 14:15:38 -05:00
|
|
|
CHECK(!file_.is_valid());
|
|
|
|
file_.reset(LoggingOpenFileForRead(path));
|
|
|
|
if (!file_.is_valid()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
weak_file_handle_file_reader_.set_file_handle(file_.get());
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
void FileReader::Close() {
|
|
|
|
CHECK(file_.is_valid());
|
|
|
|
|
|
|
|
weak_file_handle_file_reader_.set_file_handle(kInvalidFileHandle);
|
|
|
|
file_.reset();
|
|
|
|
}
|
|
|
|
|
2015-10-22 16:14:18 -07:00
|
|
|
FileOperationResult FileReader::Read(void* data, size_t size) {
|
2015-02-18 14:15:38 -05:00
|
|
|
DCHECK(file_.is_valid());
|
|
|
|
return weak_file_handle_file_reader_.Read(data, size);
|
|
|
|
}
|
|
|
|
|
|
|
|
FileOffset FileReader::Seek(FileOffset offset, int whence) {
|
|
|
|
DCHECK(file_.is_valid());
|
|
|
|
return weak_file_handle_file_reader_.Seek(offset, whence);
|
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace crashpad
|