XrdPfc::File Class Reference

#include <XrdPfcFile.hh>

Collaboration diagram for XrdPfc::File:

Public Member Functions
	~File ()
	Destructor.
void	BlockRemovedFromWriteQ (Block *)
	Handle removal of a block from Cache's write queue.
void	BlocksRemovedFromWriteQ (std::list< Block * > &)
	Handle removal of a set of blocks from Cache's write queue.
int	Read (IO *io, char *buff, long long offset, int size, ReadReqRH *rh)
	Normal read.
int	ReadV (IO *io, const XrdOucIOVec *readV, int readVnum, ReadReqRH *rh)
	Vector read.
void	ioUpdated (IO *io)
	Notification from IO that it has been updated (remote open).
bool	ioActive (IO *io)
	Initiate close. Return true if still IO active. Used in XrdPosixXrootd::Close()
void	RequestSyncOfDetachStats ()
	Flags that detach stats should be written out in final sync. Called from CacheIO upon Detach.
bool	FinalizeSyncBeforeExit ()
	Returns true if any of blocks need sync. Called from Cache::dec_ref_cnt on zero ref cnt.
void	Sync ()
	Sync file cache inf o and output data with disk.
void	WriteBlockToDisk (Block *b)
void	Prefetch ()
float	GetPrefetchScore () const
const char *	lPath () const
	Log path.
std::string &	GetLocalPath ()
XrdSysError *	GetLog ()
XrdSysTrace *	GetTrace ()
long long	GetFileSize ()
void	AddIO (IO *io)
int	GetPrefetchCountOnIO (IO *io)
void	StopPrefetchingOnIO (IO *io)
void	RemoveIO (IO *io)
Stats	DeltaStatsFromLastCall ()
std::string	GetRemoteLocations () const
const Info::AStat *	GetLastAccessStats () const
size_t	GetAccessCnt () const
int	GetBlockSize () const
int	GetNBlocks () const
int	GetNDownloadedBlocks () const
const Stats &	RefStats () const
int	get_ref_cnt ()
int	inc_ref_cnt ()
int	dec_ref_cnt ()
void	initiate_emergency_shutdown ()
bool	is_in_emergency_shutdown ()

Static Public Member Functions
static File *	FileOpen (const std::string &path, long long offset, long long fileSize)
	Static constructor that also does Open. Returns null ptr if Open fails.

Private Types
enum	PrefetchState_e {   kOff =-1 , kOn , kHold , kStopped ,   kComplete }
typedef std::set< IO * >	IoSet_t
typedef IoSet_t::iterator	IoSet_i
typedef std::list< int >	IntList_t
typedef IntList_t::iterator	IntList_i
typedef std::map< int, Block * >	BlockMap_t
typedef BlockMap_t::iterator	BlockMap_i

Private Member Functions
	File (const std::string &path, long long offset, long long fileSize)
	Constructor.
bool	Open ()
	Open file handle for data file and info file on local disk.
void	insert_remote_location (const std::string &loc)
void	inc_prefetch_read_cnt (int prc)
void	inc_prefetch_hit_cnt (int phc)
void	calc_prefetch_score ()
bool	overlap (int blk, long long blk_size, long long req_off, int req_size, long long &off, long long &blk_off, int &size)
Block *	PrepareBlockRequest (int i, IO *io, void *req_id, bool prefetch)
void	ProcessBlockRequest (Block *b)
void	ProcessBlockRequests (BlockList_t &blks)
void	RequestBlocksDirect (IO *io, DirectResponseHandler *handler, std::vector< XrdOucIOVec > &ioVec, int expected_size)
int	ReadBlocksFromDisk (std::vector< XrdOucIOVec > &ioVec, int expected_size)
int	ReadOpusCoalescere (IO *io, const XrdOucIOVec *readV, int readVnum, ReadReqRH *rh, const char *tpfx)
void	ProcessDirectReadFinished (ReadRequest *rreq, int bytes_read, int error_cond)
void	ProcessBlockError (Block *b, ReadRequest *rreq)
void	ProcessBlockSuccess (Block *b, ChunkRequest &creq)
void	FinalizeReadRequest (ReadRequest *rreq)
void	ProcessBlockResponse (Block *b, int res)
void	inc_ref_count (Block *b)
void	dec_ref_count (Block *b, int count=1)
void	free_block (Block *)
bool	select_current_io_or_disable_prefetching (bool skip_current)
int	offsetIdx (int idx) const

Private Attributes
int	m_ref_cnt
	number of references from IO or sync
XrdOssDF *	m_data_file
	file handle for data file on disk
XrdOssDF *	m_info_file
	file handle for data-info file on disk
Info	m_cfi
	download status of file blocks and access statistics
std::string	m_filename
	filename of data file on disk
long long	m_offset
	offset of cached file for block-based / hdfs operation
long long	m_file_size
	size of cached disk file for block-based operation
IoSet_t	m_io_set
IoSet_i	m_current_io
	IO object to be used for prefetching.
int	m_ios_in_detach
	Number of IO objects to which we replied false to ioActive() and will be removed soon.
std::vector< int >	m_writes_during_sync
int	m_non_flushed_cnt
bool	m_in_sync
bool	m_detach_time_logged
bool	m_in_shutdown
	file is in emergency shutdown due to irrecoverable error or unlink request
BlockMap_t	m_block_map
XrdSysCondVar	m_state_cond
long long	m_block_size
int	m_num_blocks
Stats	m_stats
	cache statistics for this instance
Stats	m_last_stats
	copy of cache stats during last purge cycle, used for per directory stat reporting
std::set< std::string >	m_remote_locations
	Gathered in AddIO / ioUpdate / ioActive.
PrefetchState_e	m_prefetch_state
int	m_prefetch_read_cnt
int	m_prefetch_hit_cnt
float	m_prefetch_score

Static Private Attributes
static const char *	m_traceID

Friends
class	BlockResponseHandler
class	DirectResponseHandler

Member Typedef Documentation

BlockMap_i

typedef BlockMap_t::iterator XrdPfc::File::BlockMap_i

private

BlockMap_t

typedef std::map<int, Block*> XrdPfc::File::BlockMap_t

private

IntList_i

typedef IntList_t::iterator XrdPfc::File::IntList_i

private

IntList_t

typedef std::list<int> XrdPfc::File::IntList_t

private

IoSet_i

typedef IoSet_t::iterator XrdPfc::File::IoSet_i

private

IoSet_t

typedef std::set<IO*> XrdPfc::File::IoSet_t

private

Member Enumeration Documentation

PrefetchState_e

enum XrdPfc::File::PrefetchState_e

private

Enumerator
kOff
kOn
kHold
kStopped
kComplete

Constructor & Destructor Documentation

~File()

XrdPfc::File::~File

(

)

Destructor.

File()

XrdPfc::File::File ( const std::string &  path, long long  offset, long long  fileSize  )

private

Constructor.

Member Function Documentation

AddIO()

void XrdPfc::File::AddIO

(

IO *

io

)

BlockRemovedFromWriteQ()

void XrdPfc::File::BlockRemovedFromWriteQ

(

Block *

)

Handle removal of a block from Cache's write queue.

BlocksRemovedFromWriteQ()

void XrdPfc::File::BlocksRemovedFromWriteQ

(

std::list< Block * > &

)

Handle removal of a set of blocks from Cache's write queue.

calc_prefetch_score()

void XrdPfc::File::calc_prefetch_score ( )

inlineprivate

References m_prefetch_hit_cnt, m_prefetch_read_cnt, and m_prefetch_score.

Referenced by inc_prefetch_hit_cnt(), and inc_prefetch_read_cnt().

dec_ref_cnt()

int XrdPfc::File::dec_ref_cnt ( )

inline

References m_ref_cnt.

dec_ref_count()

void XrdPfc::File::dec_ref_count ( Block *  b, int  count = 1  )

inlineprivate

References free_block(), XrdPfc::Block::is_finished(), and XrdPfc::Block::m_refcnt.

DeltaStatsFromLastCall()

Stats XrdPfc::File::DeltaStatsFromLastCall

(

)

FileOpen()

static File * XrdPfc::File::FileOpen ( const std::string &  path, long long  offset, long long  fileSize  )

static

Static constructor that also does Open. Returns null ptr if Open fails.

FinalizeReadRequest()

void XrdPfc::File::FinalizeReadRequest ( ReadRequest *  rreq )

private

FinalizeSyncBeforeExit()

bool XrdPfc::File::FinalizeSyncBeforeExit

(

)

Returns true if any of blocks need sync. Called from Cache::dec_ref_cnt on zero ref cnt.

free_block()

void XrdPfc::File::free_block ( Block *  )

private

Referenced by dec_ref_count().

get_ref_cnt()

int XrdPfc::File::get_ref_cnt ( )

inline

References m_ref_cnt.

GetAccessCnt()

size_t XrdPfc::File::GetAccessCnt ( ) const

inline

References XrdPfc::Info::GetAccessCnt(), and m_cfi.

GetBlockSize()

int XrdPfc::File::GetBlockSize ( ) const

inline

References XrdPfc::Info::GetBufferSize(), and m_cfi.

GetFileSize()

long long XrdPfc::File::GetFileSize ( )

inline

References m_file_size.

GetLastAccessStats()

const Info::AStat * XrdPfc::File::GetLastAccessStats ( ) const

inline

References XrdPfc::Info::GetLastAccessStats(), and m_cfi.

GetLocalPath()

std::string & XrdPfc::File::GetLocalPath ( )

inline

References m_filename.

GetLog()

XrdSysError * XrdPfc::File::GetLog

(

)

GetNBlocks()

int XrdPfc::File::GetNBlocks ( ) const

inline

References XrdPfc::Info::GetNBlocks(), and m_cfi.

GetNDownloadedBlocks()

int XrdPfc::File::GetNDownloadedBlocks ( ) const

inline

References XrdPfc::Info::GetNDownloadedBlocks(), and m_cfi.

GetPrefetchCountOnIO()

int XrdPfc::File::GetPrefetchCountOnIO

(

IO *

io

)

GetPrefetchScore()

float XrdPfc::File::GetPrefetchScore

(

)

const

GetRemoteLocations()

std::string XrdPfc::File::GetRemoteLocations

(

)

const

GetTrace()

XrdSysTrace * XrdPfc::File::GetTrace

(

)

inc_prefetch_hit_cnt()

void XrdPfc::File::inc_prefetch_hit_cnt ( int  phc )

inlineprivate

References calc_prefetch_score(), and m_prefetch_hit_cnt.

inc_prefetch_read_cnt()

void XrdPfc::File::inc_prefetch_read_cnt ( int  prc )

inlineprivate

References calc_prefetch_score(), and m_prefetch_read_cnt.

inc_ref_cnt()

int XrdPfc::File::inc_ref_cnt ( )

inline

References m_ref_cnt.

inc_ref_count()

void XrdPfc::File::inc_ref_count ( Block *  b )

inlineprivate

References XrdPfc::Block::m_refcnt.

initiate_emergency_shutdown()

void XrdPfc::File::initiate_emergency_shutdown

(

)

insert_remote_location()

void XrdPfc::File::insert_remote_location ( const std::string &  loc )

private

ioActive()

bool XrdPfc::File::ioActive

(

IO *

io

)

Initiate close. Return true if still IO active. Used in XrdPosixXrootd::Close()

ioUpdated()

void XrdPfc::File::ioUpdated

(

IO *

io

)

Notification from IO that it has been updated (remote open).

is_in_emergency_shutdown()

bool XrdPfc::File::is_in_emergency_shutdown ( )

inline

References m_in_shutdown.

lPath()

const char * XrdPfc::File::lPath

(

)

const

Log path.

offsetIdx()

int XrdPfc::File::offsetIdx ( int  idx ) const

private

Open()

bool XrdPfc::File::Open ( )

private

Open file handle for data file and info file on local disk.

overlap()

bool XrdPfc::File::overlap ( int  blk, long long  blk_size, long long  req_off, int  req_size, long long &  off, long long &  blk_off, int &  size  )

private

Prefetch()

void XrdPfc::File::Prefetch

(

)

PrepareBlockRequest()

Block * XrdPfc::File::PrepareBlockRequest ( int  i, IO *  io, void *  req_id, bool  prefetch  )

private

ProcessBlockError()

void XrdPfc::File::ProcessBlockError ( Block *  b, ReadRequest *  rreq  )

private

ProcessBlockRequest()

void XrdPfc::File::ProcessBlockRequest ( Block *  b )

private

ProcessBlockRequests()

void XrdPfc::File::ProcessBlockRequests ( BlockList_t &  blks )

private

ProcessBlockResponse()

void XrdPfc::File::ProcessBlockResponse ( Block *  b, int  res  )

private

ProcessBlockSuccess()

void XrdPfc::File::ProcessBlockSuccess ( Block *  b, ChunkRequest &  creq  )

private

ProcessDirectReadFinished()

void XrdPfc::File::ProcessDirectReadFinished ( ReadRequest *  rreq, int  bytes_read, int  error_cond  )

private

Read()

int XrdPfc::File::Read	(	IO *	io,
		char *	buff,
		long long	offset,
		int	size,
		ReadReqRH *	rh
	)

Normal read.

ReadBlocksFromDisk()

int XrdPfc::File::ReadBlocksFromDisk ( std::vector< XrdOucIOVec > &  ioVec, int  expected_size  )

private

ReadOpusCoalescere()

int XrdPfc::File::ReadOpusCoalescere ( IO *  io, const XrdOucIOVec *  readV, int  readVnum, ReadReqRH *  rh, const char *  tpfx  )

private

ReadV()

int XrdPfc::File::ReadV	(	IO *	io,
		const XrdOucIOVec *	readV,
		int	readVnum,
		ReadReqRH *	rh
	)

Vector read.

RefStats()

const Stats & XrdPfc::File::RefStats ( ) const

inline

References m_stats.

RemoveIO()

void XrdPfc::File::RemoveIO

(

IO *

io

)

RequestBlocksDirect()

void XrdPfc::File::RequestBlocksDirect ( IO *  io, DirectResponseHandler *  handler, std::vector< XrdOucIOVec > &  ioVec, int  expected_size  )

private

RequestSyncOfDetachStats()

void XrdPfc::File::RequestSyncOfDetachStats

(

)

Flags that detach stats should be written out in final sync. Called from CacheIO upon Detach.

select_current_io_or_disable_prefetching()

bool XrdPfc::File::select_current_io_or_disable_prefetching ( bool  skip_current )

private

StopPrefetchingOnIO()

void XrdPfc::File::StopPrefetchingOnIO

(

IO *

io

)

Sync()

void XrdPfc::File::Sync

(

)

Sync file cache inf o and output data with disk.

WriteBlockToDisk()

void XrdPfc::File::WriteBlockToDisk

(

Block *

b

)

Friends And Related Symbol Documentation

BlockResponseHandler

friend class BlockResponseHandler

friend

DirectResponseHandler

friend class DirectResponseHandler

friend

Member Data Documentation

m_block_map

BlockMap_t XrdPfc::File::m_block_map

private

m_block_size

long long XrdPfc::File::m_block_size

private

m_cfi

Info XrdPfc::File::m_cfi

private

download status of file blocks and access statistics

Referenced by GetAccessCnt(), GetBlockSize(), GetLastAccessStats(), GetNBlocks(), and GetNDownloadedBlocks().

m_current_io

IoSet_i XrdPfc::File::m_current_io

private

IO object to be used for prefetching.

m_data_file

XrdOssDF* XrdPfc::File::m_data_file

private

file handle for data file on disk

m_detach_time_logged

bool XrdPfc::File::m_detach_time_logged

private

m_file_size

long long XrdPfc::File::m_file_size

private

size of cached disk file for block-based operation

Referenced by GetFileSize().

m_filename

std::string XrdPfc::File::m_filename

private

filename of data file on disk

Referenced by GetLocalPath().

m_in_shutdown

bool XrdPfc::File::m_in_shutdown

private

file is in emergency shutdown due to irrecoverable error or unlink request

Referenced by is_in_emergency_shutdown().

m_in_sync

bool XrdPfc::File::m_in_sync

private

m_info_file

XrdOssDF* XrdPfc::File::m_info_file

private

file handle for data-info file on disk

m_io_set

IoSet_t XrdPfc::File::m_io_set

private

m_ios_in_detach

int XrdPfc::File::m_ios_in_detach

private

Number of IO objects to which we replied false to ioActive() and will be removed soon.

m_last_stats

Stats XrdPfc::File::m_last_stats

private

copy of cache stats during last purge cycle, used for per directory stat reporting

m_non_flushed_cnt

int XrdPfc::File::m_non_flushed_cnt

private

m_num_blocks

int XrdPfc::File::m_num_blocks

private

m_offset

long long XrdPfc::File::m_offset

private

offset of cached file for block-based / hdfs operation

m_prefetch_hit_cnt

int XrdPfc::File::m_prefetch_hit_cnt

private

Referenced by calc_prefetch_score(), and inc_prefetch_hit_cnt().

m_prefetch_read_cnt

int XrdPfc::File::m_prefetch_read_cnt

private

Referenced by calc_prefetch_score(), and inc_prefetch_read_cnt().

m_prefetch_score

float XrdPfc::File::m_prefetch_score

private

Referenced by calc_prefetch_score().

m_prefetch_state

PrefetchState_e XrdPfc::File::m_prefetch_state

private

m_ref_cnt

int XrdPfc::File::m_ref_cnt

private

number of references from IO or sync

Referenced by dec_ref_cnt(), get_ref_cnt(), and inc_ref_cnt().

m_remote_locations

std::set<std::string> XrdPfc::File::m_remote_locations

private

Gathered in AddIO / ioUpdate / ioActive.

m_state_cond

XrdSysCondVar XrdPfc::File::m_state_cond

private

m_stats

Stats XrdPfc::File::m_stats

private

cache statistics for this instance

Referenced by RefStats().

m_traceID

const char* XrdPfc::File::m_traceID

staticprivate

m_writes_during_sync

std::vector<int> XrdPfc::File::m_writes_during_sync

private

---

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

• XrdPfcFile.hh