#include <cache_ram.h>

Inheritance diagram for RamCacheManager:

Collaboration diagram for RamCacheManager:

Classes
struct	Counters

struct	ReadOnlyHandle

struct	Transaction

Public Member Functions
virtual CacheManagerIds	id ()

virtual std::string	Describe ()

	RamCacheManager (uint64_t max_size, unsigned max_entries, MemoryKvStore::MemoryAllocator alloc, perf::StatisticsTemplate statistics)

virtual	~RamCacheManager ()

virtual bool	AcquireQuotaManager (QuotaManager *quota_mgr)

virtual int	Open (const BlessedObject &object)

virtual int64_t	GetSize (int fd)

virtual int	Close (int fd)

virtual int64_t	Pread (int fd, void *buf, uint64_t size, uint64_t offset)

virtual int	Dup (int fd)

virtual int	Readahead (int fd)

virtual uint32_t	SizeOfTxn ()

virtual int	StartTxn (const shash::Any &id, uint64_t size, void *txn)

virtual void	CtrlTxn (const ObjectInfo &object_info, const int flags, void *txn)

virtual int64_t	Write (const void buf, uint64_t size, void txn)

virtual int	Reset (void *txn)

virtual int	OpenFromTxn (void *txn)

virtual int	AbortTxn (void *txn)

virtual int	CommitTxn (void *txn)

virtual void	Spawn ()

Public Member Functions inherited from CacheManager
virtual	~CacheManager ()

int	OpenPinned (const shash::Any &id, const std::string &description, bool is_catalog)

int	ChecksumFd (int fd, shash::Any *id)

bool	Open2Mem (const shash::Any &id, const std::string &description, unsigned char *buffer, uint64_t size)

bool	CommitFromMem (const shash::Any &id, const unsigned char *buffer, const uint64_t size, const std::string &description)

QuotaManager *	quota_mgr ()

void *	SaveState (const int fd_progress)

int	RestoreState (const int fd_progress, void *state)

void	FreeState (const int fd_progress, void *state)

virtual manifest::Breadcrumb	LoadBreadcrumb (const std::string &)

virtual bool	StoreBreadcrumb (const manifest::Manifest &)

Private Member Functions
MemoryKvStore *	GetStore (const ReadOnlyHandle &fd)

MemoryKvStore *	GetTransactionStore (Transaction *txn)

int	AddFd (const ReadOnlyHandle &handle)

int64_t	CommitToKvStore (Transaction *transaction)

virtual int	DoOpen (const shash::Any &id)

Private Attributes
uint64_t	max_size_

FdTable< ReadOnlyHandle >	fd_table_

pthread_rwlock_t	rwlock_

MemoryKvStore	regular_entries_

MemoryKvStore	volatile_entries_

Counters	counters_

Static Private Attributes
static const shash::Any	kInvalidHandle

Additional Inherited Members
Public Types inherited from CacheManager
enum	ObjectType { kTypeRegular = 0, kTypeCatalog, kTypePinned, kTypeVolatile }

Static Public Member Functions inherited from CacheManager
static BlessedObject	Bless (const shash::Any &id)

static BlessedObject	Bless (const shash::Any &id, const ObjectInfo &info)

static BlessedObject	Bless (const shash::Any &id, ObjectType type)

static BlessedObject	Bless (const shash::Any &id, const std::string &description)

static BlessedObject	Bless (const shash::Any &id, ObjectType type, const std::string &description)

Static Public Attributes inherited from CacheManager
static const uint64_t	kSizeUnknown = uint64_t(-1)

Protected Member Functions inherited from CacheManager
	CacheManager ()

virtual void *	DoSaveState ()

virtual int	DoRestoreState (void *data)

virtual bool	DoFreeState (void *data)

Protected Attributes inherited from CacheManager
QuotaManager *	quota_mgr_

Detailed Description

This file is part of the CernVM File System. The RamCacheManager class provides a cache backend that operates entirely from the host's RAM. This backend does not require any additional privileges on the host such as filesystem access. This cache resides in a single process' memory, and does not support sharing or persistence. This cache backend is a good choice in highly restrictive environments, e.g. HPC resources, where it is not possible to make use of a shared/local filesystem.

To use this cache backend, set CVMFS_CACHE_PRIMARY=ram. There are not many knobs to configure; at present only the size to be used for cached objects. CVMFS_CACHE_RAM_SIZE sets the amount of memory to use (in MB) for caching objects. If the size ends with a percent sign, the cache size will be set to that percentage of the system memory. If no size is specified, the RAM cache size defaults to ~3% of the system memory. The minimum cache size is 200 MB.

RamCacheManager uses a custom heap allocator rather than the system's libc malloc(). To switch to libc malloc, set CVMFS_CACHE_RAM_MALLOC=libc

Definition at line 44 of file cache_ram.h.

Constructor & Destructor Documentation

RamCacheManager::RamCacheManager	(	uint64_t	max_size,
		unsigned	max_entries,
		MemoryKvStore::MemoryAllocator	alloc,
		perf::StatisticsTemplate	statistics
	)

Definition at line 29 of file cache_ram.cc.

Here is the call graph for this function:

RamCacheManager::~RamCacheManager ( )

virtual

Definition at line 55 of file cache_ram.cc.

Member Function Documentation

int RamCacheManager::AbortTxn ( void * txn )

virtual

Free the resources allocated for the pending transaction

Parameters

txn	A pointer to space allocated for storing the transaction details

-ENOSPC	The transaction would exceed the size of the cache
-ENFILE	No handles are available
-EEXIST	An entry with nonzero reference count already exists

description	Unused
type	The type of the entry, e.g. pinned
flags	Unused
txn	A pointer to space allocated for storing the transaction details

-ENOENT	The entry is not in the cache
-ENFILE	No handles are available

id	The hash key
size	The total size of the new cache entry
txn	A pointer to space allocated for storing the transaction details

buf	The source address
size	The number of bytes to copy
txn	A pointer to space allocated for storing the transaction details

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation