Attaches/creates and detaches/deletes cache-io objects for disk based cache. More...

#include <XrdPfc.hh>

Inheritance diagram for XrdPfc::Cache:

Collaboration diagram for XrdPfc::Cache:

[legend]

Classes
struct	WriteQ

Public Member Functions
	Cache (XrdSysLogger logger, XrdOucEnv env)
	Constructor.

virtual XrdOucCacheIO *	Attach (XrdOucCacheIO *, int Options=0)

virtual int	LocalFilePath (const char url, char buff=0, int blen=0, LFP_Reason why=ForAccess, bool forall=false)

virtual int	Prepare (const char *url, int oflags, mode_t mode)

virtual int	Stat (const char *url, struct stat &sbuff)

virtual int	Unlink (const char *url)

bool	Decide (XrdOucCacheIO *)
	Makes decision if the original XrdOucCacheIO should be cached.

const Configuration &	RefConfiguration () const
	Reference XrdPfc configuration.

bool	Config (const char config_filename, const char parameters)
	Parse configuration file.

void	ResourceMonitorHeartBeat ()
	Thread function checking resource usage periodically.

void	Purge ()
	Thread function invoked to scan and purge files from disk when needed.

int	UnlinkFile (const std::string &f_name, bool fail_if_open)
	Remove cinfo and data files from cache.

void	AddWriteTask (Block *b, bool from_read)
	Add downloaded block in write queue.

void	RemoveWriteQEntriesFor (File *f)
	Remove blocks from write queue which belong to given prefetch. This method is used at the time of File destruction.

void	ProcessWriteTasks ()
	Separate task which writes blocks from ram to disk.

char *	RequestRAM (long long size)

void	ReleaseRAM (char *buf, long long size)

void	RegisterPrefetchFile (File *)

void	DeRegisterPrefetchFile (File *)

File *	GetNextFileToPrefetch ()

void	Prefetch ()

XrdOss *	GetOss () const

bool	IsFileActiveOrPurgeProtected (const std::string &)

File *	GetFile (const std::string &, IO *, long long off=0, long long filesize=0)

void	ReleaseFile (File , IO )

void	ScheduleFileSync (File *f)

void	FileSyncDone (File *, bool high_debug)

XrdSysError *	GetLog ()

XrdSysTrace *	GetTrace ()

XrdXrootdGStream *	GetGStream ()

void	ExecuteCommandUrl (const std::string &command_url)

virtual XrdOucCacheIO *	Attach (XrdOucCacheIO *ioP, int opts=0)=0
	Obtain a new IO object that fronts existing XrdOucCacheIO.

Public Member Functions inherited from XrdOucCache
virtual int	Rename (const char oldp, const char newp)

virtual int	Rmdir (const char *dirp)

virtual int	Truncate (const char *path, off_t size)

virtual int	Xeq (XeqCmd cmd, char *arg, int arglen)

	XrdOucCache (const char *ctype)

virtual	~XrdOucCache ()
	Destructor.

Static Public Member Functions
static Cache &	CreateInstance (XrdSysLogger logger, XrdOucEnv env)
	Singleton creation.

static Cache &	GetInstance ()
	Singleton access.

static const Cache &	TheOne ()

static const Configuration &	Conf ()

static bool	VCheck (XrdVersionInfo &urVersion)
	Version check.

Static Public Attributes
static XrdScheduler *	schedP

Static Public Attributes inherited from XrdOucCache
static const int	optFIS = 0x0001
	File is structured (e.g. root file)

static const int	optRW = 0x0004
	File is read/write (o/w read/only)

static const int	optNEW = 0x0014
	File is new -> optRW (o/w read or write)

static const int	optWIN = 0x0024
	File is new -> optRW use write-in cache.

Private Types
enum	ScanAndPurgeThreadState_e { SPTS_Idle , SPTS_Scan , SPTS_Purge , SPTS_Done }

typedef std::map< std::string, File * >	ActiveMap_t

typedef ActiveMap_t::iterator	ActiveMap_i

typedef std::multimap< std::string, XrdPfc::Stats >	StatsMMap_t

typedef StatsMMap_t::iterator	StatsMMap_i

typedef std::set< std::string >	FNameSet_t

typedef std::vector< File * >	PrefetchList

Private Member Functions
bool	ConfigParameters (std::string, XrdOucStream &, TmpConfiguration &tmpc)

bool	ConfigXeq (char *, XrdOucStream &)

bool	xcschk (XrdOucStream &)

bool	xdlib (XrdOucStream &)

bool	xtrace (XrdOucStream &)

bool	cfg2bytes (const std::string &str, long long &store, long long totalSpace, const char *name)

void	inc_ref_cnt (File *, bool lock, bool high_debug)

void	dec_ref_cnt (File *, bool high_debug)

void	schedule_file_sync (File *, bool ref_cnt_already_set, bool high_debug)

void	copy_out_active_stats_and_update_data_fs_state ()

Private Attributes
XrdOucEnv *	m_env
	environment passed in at creation

XrdSysError	m_log
	XrdPfc namespace logger.

XrdSysTrace *	m_trace

const char *	m_traceID

XrdOss *	m_oss
	disk cache file system

XrdXrootdGStream *	m_gstream

std::vector< XrdPfc::Decision * >	m_decisionpoints
	decision plugins

Configuration	m_configuration
	configurable parameters

XrdSysCondVar	m_prefetch_condVar
	lock for vector of prefetching files

bool	m_prefetch_enabled
	set to true when prefetching is enabled

XrdSysMutex	m_RAM_mutex
	lock for allcoation of RAM blocks

long long	m_RAM_used

long long	m_RAM_write_queue

std::list< char * >	m_RAM_std_blocks
	A list of blocks of standard size, to be reused.

int	m_RAM_std_size

bool	m_isClient
	True if running as client.

WriteQ	m_writeQ

ActiveMap_t	m_active
	Map of currently active / open files.

StatsMMap_t	m_closed_files_stats

FNameSet_t	m_purge_delay_set

bool	m_in_purge

XrdSysCondVar	m_active_cond
	Cond-var protecting active file data structures.

PrefetchList	m_prefetchList

XrdSysCondVar	m_stats_n_purge_cond
	communication between heart-beat and scan-purge threads

DataFsState *	m_fs_state
	directory state for access / usage info and quotas

int	m_last_scan_duration

int	m_last_purge_duration

ScanAndPurgeThreadState_e	m_spt_state

Static Private Attributes
static Cache *	m_instance
	this object

Additional Inherited Members
Public Types inherited from XrdOucCache
enum	LFP_Reason { ForAccess =0 , ForInfo , ForPath }

enum	XeqCmd { xeqNoop = 0 }

Public Attributes inherited from XrdOucCache
XrdOucCacheStats	Statistics

const char	CacheType [8]
	A 1-to-7 character cache type identifier (usually pfc or rmc).

Detailed Description

Attaches/creates and detaches/deletes cache-io objects for disk based cache.

Member Typedef Documentation

◆ ActiveMap_i

typedef ActiveMap_t::iterator XrdPfc::Cache::ActiveMap_i

private

◆ ActiveMap_t

typedef std::map<std::string, File*> XrdPfc::Cache::ActiveMap_t

private

◆ FNameSet_t

typedef std::set<std::string> XrdPfc::Cache::FNameSet_t

private

◆ PrefetchList

typedef std::vector<File*> XrdPfc::Cache::PrefetchList

private

◆ StatsMMap_i

typedef StatsMMap_t::iterator XrdPfc::Cache::StatsMMap_i

private

◆ StatsMMap_t

typedef std::multimap<std::string, XrdPfc::Stats> XrdPfc::Cache::StatsMMap_t

private

Member Enumeration Documentation

◆ ScanAndPurgeThreadState_e

enum XrdPfc::Cache::ScanAndPurgeThreadState_e

private

Enumerator
SPTS_Idle
SPTS_Scan
SPTS_Purge
SPTS_Done

Constructor & Destructor Documentation

◆ Cache()

XrdPfc::Cache::Cache	(	XrdSysLogger *	logger,
		XrdOucEnv *	env
	)

Constructor.

Member Function Documentation

◆ AddWriteTask()

void XrdPfc::Cache::AddWriteTask	(	Block *	b,
		bool	from_read
	)

Add downloaded block in write queue.

◆ Attach() [1/2]

virtual XrdOucCacheIO * XrdPfc::Cache::Attach	(	XrdOucCacheIO *	,
		int	Options = `0`
	)

virtual

Implements XrdOucCache.

◆ Attach() [2/2]

virtual XrdOucCacheIO * XrdOucCache::Attach	(	XrdOucCacheIO *	ioP,
		int	opts = `0`
	)

virtual

Obtain a new IO object that fronts existing XrdOucCacheIO.

Implements XrdOucCache.

◆ cfg2bytes()

bool XrdPfc::Cache::cfg2bytes	(	const std::string &	str,
		long long &	store,
		long long	totalSpace,
		const char *	name
	)

private

◆ Conf()

static const Configuration & XrdPfc::Cache::Conf ( )

static

◆ Config()

bool XrdPfc::Cache::Config	(	const char *	config_filename,
		const char *	parameters
	)

Parse configuration file.

Parameters

config_filename	path to configuration file
parameters	optional parameters to be passed

Returns: parse status

◆ ConfigParameters()

bool XrdPfc::Cache::ConfigParameters	(	std::string	,
		XrdOucStream &	,
		TmpConfiguration &	tmpc
	)

private

◆ ConfigXeq()

bool XrdPfc::Cache::ConfigXeq	(	char *	,
		XrdOucStream &
	)

private

◆ copy_out_active_stats_and_update_data_fs_state()

void XrdPfc::Cache::copy_out_active_stats_and_update_data_fs_state ( )

private

◆ CreateInstance()

static Cache & XrdPfc::Cache::CreateInstance	(	XrdSysLogger *	logger,
		XrdOucEnv *	env
	)

static

Singleton creation.

◆ dec_ref_cnt()

void XrdPfc::Cache::dec_ref_cnt	(	File *	,
		bool	high_debug
	)

private

◆ Decide()

bool XrdPfc::Cache::Decide ( XrdOucCacheIO * )

Makes decision if the original XrdOucCacheIO should be cached.

Parameters

&	URL of file

Returns: decision if IO object will be cached.

◆ DeRegisterPrefetchFile()

void XrdPfc::Cache::DeRegisterPrefetchFile ( File * )

◆ ExecuteCommandUrl()

void XrdPfc::Cache::ExecuteCommandUrl ( const std::string & command_url )

◆ FileSyncDone()

void XrdPfc::Cache::FileSyncDone	(	File *	,
		bool	high_debug
	)

◆ GetFile()

File * XrdPfc::Cache::GetFile	(	const std::string &	,
		IO *	,
		long long	off = `0`,
		long long	filesize = `0`
	)

◆ GetGStream()

XrdXrootdGStream * XrdPfc::Cache::GetGStream ( )

inline

References m_gstream.

◆ GetInstance()

static Cache & XrdPfc::Cache::GetInstance ( )

static

Singleton access.

◆ GetLog()

XrdSysError * XrdPfc::Cache::GetLog ( )

inline

References m_log.

◆ GetNextFileToPrefetch()

File * XrdPfc::Cache::GetNextFileToPrefetch ( )

◆ GetOss()

XrdOss * XrdPfc::Cache::GetOss ( ) const

inline

References m_oss.

◆ GetTrace()

XrdSysTrace * XrdPfc::Cache::GetTrace ( )

inline

References m_trace.

Referenced by XrdPfc::IO::GetTrace().

◆ inc_ref_cnt()

void XrdPfc::Cache::inc_ref_cnt	(	File *	,
		bool	lock,
		bool	high_debug
	)

private

◆ IsFileActiveOrPurgeProtected()

bool XrdPfc::Cache::IsFileActiveOrPurgeProtected ( const std::string & )

◆ LocalFilePath()

virtual int XrdPfc::Cache::LocalFilePath	(	const char *	url,
		char *	buff = `0`,
		int	blen = `0`,
		LFP_Reason	why = `ForAccess`,
		bool	forall = `false`
	)

virtual

Reimplemented from XrdOucCache.

◆ Prefetch()

void XrdPfc::Cache::Prefetch ( )

◆ Prepare()

virtual int XrdPfc::Cache::Prepare	(	const char *	url,
		int	oflags,
		mode_t	mode
	)

virtual

Prepare the cache for a file open request. This method is called prior to actually opening a file. This method is meant to allow defering an open request or implementing the full I/O stack in the cache layer.

Parameters

url	- Pointer to the url about to be opened.
oflags	- Standard Unix open flags (see open(2)).
mode	- Standard mode flags if file is being created.

Returns: <0 Error has occurred, return value is -errno; fail open request. The error code -EUSERS may be returned to trigger overload recovery as specified by the xrootd.fsoverload directive. No other method should return this error code. =0 Continue with open() request. >0 Defer open but treat the file as actually being open.

Reimplemented from XrdOucCache.

◆ ProcessWriteTasks()

void XrdPfc::Cache::ProcessWriteTasks ( )

Separate task which writes blocks from ram to disk.

◆ Purge()

void XrdPfc::Cache::Purge ( )

Thread function invoked to scan and purge files from disk when needed.

◆ RefConfiguration()

const Configuration & XrdPfc::Cache::RefConfiguration ( ) const

inline

Reference XrdPfc configuration.

References m_configuration.

◆ RegisterPrefetchFile()

void XrdPfc::Cache::RegisterPrefetchFile ( File * )

◆ ReleaseFile()

void XrdPfc::Cache::ReleaseFile	(	File *	,
		IO *
	)

◆ ReleaseRAM()

void XrdPfc::Cache::ReleaseRAM	(	char *	buf,
		long long	size
	)

◆ RemoveWriteQEntriesFor()

void XrdPfc::Cache::RemoveWriteQEntriesFor ( File * f )

Remove blocks from write queue which belong to given prefetch. This method is used at the time of File destruction.

◆ RequestRAM()

char * XrdPfc::Cache::RequestRAM ( long long size )

◆ ResourceMonitorHeartBeat()

void XrdPfc::Cache::ResourceMonitorHeartBeat ( )

Thread function checking resource usage periodically.

◆ schedule_file_sync()

void XrdPfc::Cache::schedule_file_sync	(	File *	,
		bool	ref_cnt_already_set,
		bool	high_debug
	)

private

Referenced by ScheduleFileSync().

◆ ScheduleFileSync()

void XrdPfc::Cache::ScheduleFileSync ( File * f )

inline

References schedule_file_sync().

◆ Stat()

virtual int XrdPfc::Cache::Stat	(	const char *	url,
		struct stat &	sbuff
	)

virtual

Perform a stat() operation (defaults to passthrough).

Parameters

url	pointer to the url whose stat information is wanted.
sbuff	reference to the stat buffer to be filled in. Only fields st_size, st_blocks, st_mtime (st_atime and st_ctime may be set to st_mtime), st_ino, and st_mode need to be set. All other fields are preset and should not be changed.

Returns: <0 - Stat failed, value is -errno. =0 - Stat succeeded, sbuff holds stat information. >0 - Stat could not be done, forward operation to next level.

Reimplemented from XrdOucCache.

◆ TheOne()

static const Cache & XrdPfc::Cache::TheOne ( )

static

◆ Unlink()

virtual int XrdPfc::Cache::Unlink ( const char * path )

virtual

Remove a file from the cache.

Parameters

path	- the path of the file to be removed.

Returns: Success: 0; Failure: -errno

Reimplemented from XrdOucCache.

◆ UnlinkFile()

int XrdPfc::Cache::UnlinkFile	(	const std::string &	f_name,
		bool	fail_if_open
	)

Remove cinfo and data files from cache.

◆ VCheck()

static bool XrdPfc::Cache::VCheck ( XrdVersionInfo & urVersion )

inlinestatic

Version check.

◆ xcschk()

bool XrdPfc::Cache::xcschk ( XrdOucStream & )

private

◆ xdlib()

bool XrdPfc::Cache::xdlib ( XrdOucStream & )

private

◆ xtrace()

bool XrdPfc::Cache::xtrace ( XrdOucStream & )

private

Member Data Documentation

◆ m_active

ActiveMap_t XrdPfc::Cache::m_active

private

Map of currently active / open files.

◆ m_active_cond

XrdSysCondVar XrdPfc::Cache::m_active_cond

private

Cond-var protecting active file data structures.

◆ m_closed_files_stats

StatsMMap_t XrdPfc::Cache::m_closed_files_stats

private

◆ m_configuration

Configuration XrdPfc::Cache::m_configuration

private

configurable parameters

Referenced by RefConfiguration().

◆ m_decisionpoints

std::vector<XrdPfc::Decision*> XrdPfc::Cache::m_decisionpoints

private

decision plugins

◆ m_env

XrdOucEnv* XrdPfc::Cache::m_env

private

environment passed in at creation

◆ m_fs_state

DataFsState* XrdPfc::Cache::m_fs_state

private

directory state for access / usage info and quotas

◆ m_gstream

XrdXrootdGStream* XrdPfc::Cache::m_gstream

private

Referenced by GetGStream().

◆ m_in_purge

bool XrdPfc::Cache::m_in_purge

private

◆ m_instance

Cache* XrdPfc::Cache::m_instance

staticprivate

this object

◆ m_isClient

bool XrdPfc::Cache::m_isClient

private

True if running as client.

◆ m_last_purge_duration

int XrdPfc::Cache::m_last_purge_duration

private

◆ m_last_scan_duration

int XrdPfc::Cache::m_last_scan_duration

private

◆ m_log

XrdSysError XrdPfc::Cache::m_log

private

XrdPfc namespace logger.

Referenced by GetLog().

◆ m_oss

XrdOss* XrdPfc::Cache::m_oss

private

disk cache file system

Referenced by GetOss().

◆ m_prefetch_condVar

XrdSysCondVar XrdPfc::Cache::m_prefetch_condVar

private

lock for vector of prefetching files

◆ m_prefetch_enabled

bool XrdPfc::Cache::m_prefetch_enabled

private

set to true when prefetching is enabled

◆ m_prefetchList

PrefetchList XrdPfc::Cache::m_prefetchList

private

◆ m_purge_delay_set

FNameSet_t XrdPfc::Cache::m_purge_delay_set

private

◆ m_RAM_mutex

XrdSysMutex XrdPfc::Cache::m_RAM_mutex

private

lock for allcoation of RAM blocks

◆ m_RAM_std_blocks

std::list<char*> XrdPfc::Cache::m_RAM_std_blocks

private

A list of blocks of standard size, to be reused.

◆ m_RAM_std_size

int XrdPfc::Cache::m_RAM_std_size

private

◆ m_RAM_used

long long XrdPfc::Cache::m_RAM_used

private

◆ m_RAM_write_queue

long long XrdPfc::Cache::m_RAM_write_queue

private

◆ m_spt_state

ScanAndPurgeThreadState_e XrdPfc::Cache::m_spt_state

private

◆ m_stats_n_purge_cond

XrdSysCondVar XrdPfc::Cache::m_stats_n_purge_cond

private

communication between heart-beat and scan-purge threads

◆ m_trace

XrdSysTrace* XrdPfc::Cache::m_trace

private

Referenced by GetTrace().

◆ m_traceID

const char* XrdPfc::Cache::m_traceID

private

◆ m_writeQ

WriteQ XrdPfc::Cache::m_writeQ

private

◆ schedP

XrdScheduler* XrdPfc::Cache::schedP

static

The documentation for this class was generated from the following file:

XrdPfc.hh

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ActiveMap_i

◆ ActiveMap_t

◆ FNameSet_t

◆ PrefetchList

◆ StatsMMap_i

◆ StatsMMap_t

Member Enumeration Documentation

◆ ScanAndPurgeThreadState_e

Constructor & Destructor Documentation

◆ Cache()

Member Function Documentation

◆ AddWriteTask()

◆ Attach() [1/2]

◆ Attach() [2/2]

◆ cfg2bytes()

◆ Conf()

◆ Config()

◆ ConfigParameters()

◆ ConfigXeq()

◆ copy_out_active_stats_and_update_data_fs_state()

◆ CreateInstance()

◆ dec_ref_cnt()

◆ Decide()

◆ DeRegisterPrefetchFile()

◆ ExecuteCommandUrl()

◆ FileSyncDone()

◆ GetFile()

◆ GetGStream()

◆ GetInstance()

◆ GetLog()

◆ GetNextFileToPrefetch()

◆ GetOss()

◆ GetTrace()

◆ inc_ref_cnt()

◆ IsFileActiveOrPurgeProtected()

◆ LocalFilePath()

◆ Prefetch()

◆ Prepare()

◆ ProcessWriteTasks()

◆ Purge()

◆ RefConfiguration()

◆ RegisterPrefetchFile()

◆ ReleaseFile()

◆ ReleaseRAM()

◆ RemoveWriteQEntriesFor()

◆ RequestRAM()

◆ ResourceMonitorHeartBeat()

◆ schedule_file_sync()

◆ ScheduleFileSync()

◆ Stat()

◆ TheOne()

◆ Unlink()

◆ UnlinkFile()

◆ VCheck()

◆ xcschk()

◆ xdlib()

◆ xtrace()

Member Data Documentation

◆ m_active

◆ m_active_cond

◆ m_closed_files_stats

◆ m_configuration

◆ m_decisionpoints

◆ m_env

◆ m_fs_state

◆ m_gstream

◆ m_in_purge

◆ m_instance

◆ m_isClient