blob: 13f2e5887ac5d0677115311bd5f01bbae23289ec [file] [log] [blame]
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/base_export.h"
#include "base/files/file.h"
#include "base/macros.h"
#include "build/build_config.h"
#if defined(OS_WIN)
#include <windows.h>
#include "starboard/types.h"
#if !defined(STARBOARD)
namespace base {
class FilePath;
class BASE_EXPORT MemoryMappedFile {
enum Access {
// Mapping a file into memory effectively allows for file I/O on any thread.
// The accessing thread could be paused while data from the file is paged
// into memory. Worse, a corrupted filesystem could cause a SEGV within the
// program instead of just an I/O error.
// This provides read/write access to a file and must be used with care of
// the additional subtleties involved in doing so. Though the OS will do
// the writing of data on its own time, too many dirty pages can cause
// the OS to pause the thread while it writes them out. The pause can
// be as much as 1s on some systems.
// This provides read/write access but with the ability to write beyond
// the end of the existing file up to a maximum size specified as the
// "region". Depending on the OS, the file may or may not be immediately
// extended to the maximum size though it won't be loaded in RAM until
// needed. Note, however, that the maximum size will still be reserved
// in the process address space.
// The default constructor sets all members to invalid/null values.
// Used to hold information about a region [offset + size] of a file.
struct BASE_EXPORT Region {
static const Region kWholeFile;
bool operator==(const Region& other) const;
bool operator!=(const Region& other) const;
// Start of the region (measured in bytes from the beginning of the file).
int64_t offset;
// Length of the region in bytes.
size_t size;
// Opens an existing file and maps it into memory. |access| can be read-only
// or read/write but not read/write+extend. If this object already points
// to a valid memory mapped file then this method will fail and return
// false. If it cannot open the file, the file does not exist, or the
// memory mapping fails, it will return false.
WARN_UNUSED_RESULT bool Initialize(const FilePath& file_name, Access access);
WARN_UNUSED_RESULT bool Initialize(const FilePath& file_name) {
return Initialize(file_name, READ_ONLY);
// As above, but works with an already-opened file. |access| can be read-only
// or read/write but not read/write+extend. MemoryMappedFile takes ownership
// of |file| and closes it when done. |file| must have been opened with
// permissions suitable for |access|. If the memory mapping fails, it will
// return false.
WARN_UNUSED_RESULT bool Initialize(File file, Access access);
WARN_UNUSED_RESULT bool Initialize(File file) {
return Initialize(std::move(file), READ_ONLY);
// As above, but works with a region of an already-opened file. All forms of
// |access| are allowed. If READ_WRITE_EXTEND is specified then |region|
// provides the maximum size of the file. If the memory mapping fails, it
// return false.
WARN_UNUSED_RESULT bool Initialize(File file,
const Region& region,
Access access);
WARN_UNUSED_RESULT bool Initialize(File file, const Region& region) {
return Initialize(std::move(file), region, READ_ONLY);
const uint8_t* data() const { return data_; }
uint8_t* data() { return data_; }
size_t length() const { return length_; }
// Is file_ a valid file handle that points to an open, memory mapped file?
bool IsValid() const;
// Given the arbitrarily aligned memory region [start, size], returns the
// boundaries of the region aligned to the granularity specified by the OS,
// (a page on Linux, ~32k on Windows) as follows:
// - |aligned_start| is page aligned and <= |start|.
// - |aligned_size| is a multiple of the VM granularity and >= |size|.
// - |offset| is the displacement of |start| w.r.t |aligned_start|.
static void CalculateVMAlignedBoundaries(int64_t start,
size_t size,
int64_t* aligned_start,
size_t* aligned_size,
int32_t* offset);
// Map the file to memory, set data_ to that memory address. Return true on
// success, false on any kind of failure. This is a helper for Initialize().
bool MapFileRegionToMemory(const Region& region, Access access);
// Closes all open handles.
void CloseHandles();
File file_;
uint8_t* data_;
size_t length_;
#if defined(OS_WIN)
win::ScopedHandle file_mapping_;
} // namespace base
#endif // !defined(STARBOARD)