blob: 4ac1be15d665468ba04a1c169a994e2aa1f02b8b [file] [log] [blame]
* Copyright 2004 The WebRTC Project Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
#include <map>
#include <string>
#if defined(WEBRTC_WIN)
#undef UnlockResource
#endif // WEBRTC_WIN
namespace rtc {
class StreamInterface;
// DiskCache - An LRU cache of streams, stored on disk.
// Streams are identified by a unique resource id. Multiple streams can be
// associated with each resource id, distinguished by an index. When old
// resources are flushed from the cache, all streams associated with those
// resources are removed together.
// DiskCache is designed to persist across executions of the program. It is
// safe for use from an arbitrary number of users on a single thread, but not
// from multiple threads or other processes.
class DiskCache {
virtual ~DiskCache();
bool Initialize(const std::string& folder, size_t size);
bool Purge();
bool LockResource(const std::string& id);
StreamInterface* WriteResource(const std::string& id, size_t index);
bool UnlockResource(const std::string& id);
StreamInterface* ReadResource(const std::string& id, size_t index) const;
bool HasResource(const std::string& id) const;
bool HasResourceStream(const std::string& id, size_t index) const;
bool DeleteResource(const std::string& id);
virtual bool InitializeEntries() = 0;
virtual bool PurgeFiles() = 0;
virtual bool FileExists(const std::string& filename) const = 0;
virtual bool DeleteFile(const std::string& filename) const = 0;
struct Entry {
LockState lock_state;
mutable size_t accessors;
size_t size;
size_t streams;
time_t last_modified;
typedef std::map<std::string, Entry> EntryMap;
friend class DiskCacheAdapter;
bool CheckLimit();
std::string IdToFilename(const std::string& id, size_t index) const;
bool FilenameToId(const std::string& filename, std::string* id,
size_t* index) const;
const Entry* GetEntry(const std::string& id) const {
return const_cast<DiskCache*>(this)->GetOrCreateEntry(id, false);
Entry* GetOrCreateEntry(const std::string& id, bool create);
void ReleaseResource(const std::string& id, size_t index) const;
std::string folder_;
size_t max_cache_, total_size_;
EntryMap map_;
mutable size_t total_accessors_;
// CacheLock - Automatically manage locking and unlocking, with optional
// rollback semantics
class CacheLock {
CacheLock(DiskCache* cache, const std::string& id, bool rollback = false)
: cache_(cache), id_(id), rollback_(rollback)
locked_ = cache_->LockResource(id_);
~CacheLock() {
if (locked_) {
if (rollback_) {
bool IsLocked() const { return locked_; }
void Commit() { rollback_ = false; }
DiskCache* cache_;
std::string id_;
bool rollback_, locked_;
} // namespace rtc