| Index: base/memory/discardable_shared_memory.h
|
| diff --git a/base/memory/discardable_shared_memory.h b/base/memory/discardable_shared_memory.h
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..ca2accf1a2ebb51e6f027ab13882c0f1e30b0747
|
| --- /dev/null
|
| +++ b/base/memory/discardable_shared_memory.h
|
| @@ -0,0 +1,109 @@
|
| +// Copyright 2014 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.
|
| +
|
| +#ifndef BASE_MEMORY_DISCARDABLE_SHARED_MEMORY_H_
|
| +#define BASE_MEMORY_DISCARDABLE_SHARED_MEMORY_H_
|
| +
|
| +#include "base/base_export.h"
|
| +#include "base/memory/shared_memory.h"
|
| +#include "base/time/time.h"
|
| +
|
| +namespace base {
|
| +
|
| +// Platform abstraction for discardable shared memory.
|
| +class BASE_EXPORT DiscardableSharedMemory {
|
| + public:
|
| + DiscardableSharedMemory();
|
| +
|
| + // Create a new DiscardableSharedMemory object from an existing, open shared
|
| + // memory file.
|
| + explicit DiscardableSharedMemory(SharedMemoryHandle handle);
|
| +
|
| + // Closes any open files.
|
| + virtual ~DiscardableSharedMemory();
|
| +
|
| + // Creates and maps a locked DiscardableSharedMemory object with |size|.
|
| + // Returns true on success and false on failure.
|
| + bool CreateAndMap(size_t size);
|
| +
|
| + // Maps the discardable memory into the caller's address space.
|
| + // Returns true on success, false otherwise.
|
| + bool Map(size_t size);
|
| +
|
| + // The actual size of the mapped memory (may be larger than requested).
|
| + size_t mapped_size() const { return shared_memory_.mapped_size(); }
|
| +
|
| + // Returns a shared memory handle for this DiscardableSharedMemory object.
|
| + SharedMemoryHandle handle() const { return shared_memory_.handle(); }
|
| +
|
| + // Locks the memory so that it will not be purged by the system. Returns
|
| + // true if successful and the memory is still resident. Locking can fail
|
| + // for three reasons; object might have been purged, our last known usage
|
| + // timestamp might be out of date or memory might already be locked. Last
|
| + // know usage time is updated to the actual last usage timestamp if memory
|
| + // is still resident or 0 if not.
|
| + bool Lock();
|
| +
|
| + // Unlock previously successfully locked memory.
|
| + void Unlock();
|
| +
|
| + // Gets a pointer to the opened discardable memory space. Discardable memory
|
| + // must have been mapped via Map().
|
| + void* memory() const;
|
| +
|
| + // Returns the last know usage time for DiscardableSharedMemory object. This
|
| + // may be earlier than the "true" usage time when memory has been used by a
|
| + // different process. Returns NULL time if purged.
|
| + Time last_known_usage() const { return last_known_usage_; }
|
| +
|
| + // This returns true and sets |last_known_usage_| to 0 if
|
| + // DiscardableSharedMemory object was successfully purged. Purging can fail
|
| + // for two reasons; object might be locked or our last known usage timestamp
|
| + // might be out of date. Last known usage time is updated to |current_time|
|
| + // if locked or the actual last usage timestamp if unlocked. It is often
|
| + // neccesary to call this function twice for the object to successfully be
|
| + // purged. First call, updates |last_known_usage_|. Second call, successfully
|
| + // purges the object using the updated |last_known_usage_|.
|
| + // Note: there is no guarantee that multiple calls to this function will
|
| + // successfully purge object. DiscardableSharedMemory object might be locked
|
| + // or another thread/process might be able to lock and unlock it in between
|
| + // each call.
|
| + bool Purge(Time current_time);
|
| +
|
| + // Purge and release as much memory as possible to the OS.
|
| + // Note: The amount of memory that can be released to the OS is platform
|
| + // specific. Best case, all but one page is released. Worst case, nothing
|
| + // is released.
|
| + bool PurgeAndTruncate(Time current_time);
|
| +
|
| + // Returns true if memory is still resident.
|
| + bool IsMemoryResident() const;
|
| +
|
| + // Closes the open discardable memory segment.
|
| + // It is safe to call Close repeatedly.
|
| + void Close();
|
| +
|
| + // Shares the discardable memory segment to another process. Attempts to
|
| + // create a platform-specific |new_handle| which can be used in a remote
|
| + // process to access the discardable memory segment. |new_handle| is an
|
| + // output parameter to receive the handle for use in the remote process.
|
| + // Returns true on success, false otherwise.
|
| + bool ShareToProcess(ProcessHandle process_handle,
|
| + SharedMemoryHandle* new_handle) {
|
| + return shared_memory_.ShareToProcess(process_handle, new_handle);
|
| + }
|
| +
|
| + private:
|
| + // Virtual for tests.
|
| + virtual Time Now() const;
|
| +
|
| + SharedMemory shared_memory_;
|
| + Time last_known_usage_;
|
| +
|
| + DISALLOW_COPY_AND_ASSIGN(DiscardableSharedMemory);
|
| +};
|
| +
|
| +} // namespace base
|
| +
|
| +#endif // BASE_MEMORY_DISCARDABLE_SHARED_MEMORY_H_
|
|
|