blob: b02d8cfbdae09b89159675495313eae521a7576e [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/basictypes.h"
#include "base/files/file.h"
#include "build/build_config.h"
#if defined(OS_WIN)
#include <windows.h>
namespace base {
class FilePath;
class BASE_EXPORT MemoryMappedFile {
// The default constructor sets all members to invalid/null values.
// Opens an existing file and maps it into memory. Access is restricted to
// read only. 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.
// Later we may want to allow the user to specify access.
bool Initialize(const FilePath& file_name);
// As above, but works with an already-opened file. MemoryMappedFile takes
// ownership of |file| and closes it when done.
bool Initialize(File file);
#if defined(OS_WIN)
// Opens an existing file and maps it as an image section. Please refer to
// the Initialize function above for additional information.
bool InitializeAsImageSection(const FilePath& file_name);
#endif // OS_WIN
const uint8* data() const { 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;
// 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 MapFileToMemory();
// Closes all open handles.
void CloseHandles();
File file_;
uint8* data_;
size_t length_;
#if defined(OS_WIN)
win::ScopedHandle file_mapping_;
bool image_; // Map as an image.
} // namespace base