xrootd
Classes | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
XrdPfc::File Class Reference

#include <XrdPfcFile.hh>

Collaboration diagram for XrdPfc::File:
Collaboration graph
[legend]

Classes

struct  IODetails
 

Public Member Functions

 File (const std::string &path, long long offset, long long fileSize)
 Constructor. More...
 
 ~File ()
 Destructor. More...
 
void BlockRemovedFromWriteQ (Block *)
 Handle removal of a block from Cache's write queue. More...
 
void BlocksRemovedFromWriteQ (std::list< Block *> &)
 Handle removal of a set of blocks from Cache's write queue. More...
 
bool Open ()
 Open file handle for data file and info file on local disk. More...
 
int ReadV (IO *io, const XrdOucIOVec *readV, int n)
 Vector read from disk if block is already downloaded, else ReadV from client. More...
 
int Read (IO *io, char *buff, long long offset, int size)
 Normal read. More...
 
bool isOpen () const
 Data and cinfo files are open. More...
 
void ioUpdated (IO *io)
 Notification from IO that it has been updated (remote open). More...
 
bool ioActive (IO *io)
 Initiate close. Return true if still IO active. Used in XrdPosixXrootd::Close() More...
 
void RequestSyncOfDetachStats ()
 Flags that detach stats should be written out in final sync. Called from CacheIO upon Detach. More...
 
bool FinalizeSyncBeforeExit ()
 Returns true if any of blocks need sync. Called from Cache::dec_ref_cnt on zero ref cnt. More...
 
void Sync ()
 Sync file cache inf o and output data with disk. More...
 
void ProcessBlockResponse (BlockResponseHandler *brh, int res)
 
void WriteBlockToDisk (Block *b)
 
void Prefetch ()
 
float GetPrefetchScore () const
 
const char * lPath () const
 Log path. More...
 
std::string & GetLocalPath ()
 
XrdSysErrorGetLog ()
 
XrdSysTraceGetTrace ()
 
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::AStatGetLastAccessStats () const
 
size_t GetAccessCnt () const
 
int GetBlockSize () const
 
int GetNBlocks () const
 
int GetNDownloadedBlocks () 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 FileFileOpen (const std::string &path, long long offset, long long fileSize)
 Static constructor that also does Open. Returns null ptr if Open fails. More...
 

Private Types

enum  PrefetchState_e {
  kOff =-1, kOn, kHold, kStopped,
  kComplete
}
 
typedef std::map< IO *, IODetailsIoMap_t
 
typedef IoMap_t::iterator IoMap_i
 
typedef std::list< int > IntList_t
 
typedef IntList_t::iterator IntList_i
 
typedef std::list< Block * > BlockList_t
 
typedef BlockList_t::iterator BlockList_i
 
typedef std::map< int, Block * > BlockMap_t
 
typedef BlockMap_t::iterator BlockMap_i
 
typedef std::set< Block * > BlockSet_t
 
typedef BlockSet_t::iterator BlockSet_i
 

Private Member Functions

void insert_remote_location (const std::string &loc)
 
bool overlap (int blk, long long blk_size, long long req_off, int req_size, long long &off, long long &blk_off, long long &size)
 
BlockPrepareBlockRequest (int i, IO *io, bool prefetch)
 
void ProcessBlockRequest (Block *b)
 
void ProcessBlockRequests (BlockList_t &blks)
 
int RequestBlocksDirect (IO *io, DirectResponseHandler *handler, IntList_t &blocks, char *buff, long long req_off, long long req_size)
 
int ReadBlocksFromDisk (IntList_t &blocks, char *req_buf, long long req_off, long long req_size)
 
bool VReadValidate (const XrdOucIOVec *readV, int n)
 
void VReadPreProcess (IO *io, const XrdOucIOVec *readV, int n, BlockList_t &blks_to_request, ReadVBlockListRAM &blks_to_process, ReadVBlockListDisk &blks_on_disk, std::vector< XrdOucIOVec > &chunkVec)
 
int VReadFromDisk (const XrdOucIOVec *readV, int n, ReadVBlockListDisk &blks_on_disk)
 
int VReadProcessBlocks (IO *io, const XrdOucIOVec *readV, int n, std::vector< ReadVChunkListRAM > &blks_to_process, std::vector< ReadVChunkListRAM > &blks_processed, long long &bytes_hit, long long &bytes_missed)
 
long long BufferSize ()
 
void inc_ref_count (Block *)
 
void dec_ref_count (Block *)
 
void free_block (Block *)
 
bool select_current_io_or_disable_prefetching (bool skip_current)
 
int offsetIdx (int idx)
 

Private Attributes

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

Static Private Attributes

static const char * m_traceID
 

Member Typedef Documentation

◆ BlockList_i

typedef BlockList_t::iterator XrdPfc::File::BlockList_i
private

◆ BlockList_t

typedef std::list<Block*> XrdPfc::File::BlockList_t
private

◆ BlockMap_i

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

◆ BlockMap_t

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

◆ BlockSet_i

typedef BlockSet_t::iterator XrdPfc::File::BlockSet_i
private

◆ BlockSet_t

typedef std::set<Block*> XrdPfc::File::BlockSet_t
private

◆ IntList_i

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

◆ IntList_t

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

◆ IoMap_i

typedef IoMap_t::iterator XrdPfc::File::IoMap_i
private

◆ IoMap_t

typedef std::map<IO*, IODetails> XrdPfc::File::IoMap_t
private

Member Enumeration Documentation

◆ PrefetchState_e

Enumerator
kOff 
kOn 
kHold 
kStopped 
kComplete 

Constructor & Destructor Documentation

◆ File()

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

Constructor.

◆ ~File()

XrdPfc::File::~File ( )

Destructor.

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.

◆ BufferSize()

long long XrdPfc::File::BufferSize ( )
private

◆ dec_ref_cnt()

int XrdPfc::File::dec_ref_cnt ( )
inline

References m_ref_cnt.

◆ dec_ref_count()

void XrdPfc::File::dec_ref_count ( Block )
private

◆ 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.

◆ 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

◆ get_ref_cnt()

int XrdPfc::File::get_ref_cnt ( )
inline

References m_ref_cnt.

◆ GetAccessCnt()

size_t XrdPfc::File::GetAccessCnt ( ) const
inline

◆ GetBlockSize()

int XrdPfc::File::GetBlockSize ( ) const
inline

◆ GetFileSize()

long long XrdPfc::File::GetFileSize ( )
inline

References m_file_size.

◆ GetLastAccessStats()

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

◆ GetLocalPath()

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

References m_filename.

◆ GetLog()

XrdSysError* XrdPfc::File::GetLog ( )

◆ GetNBlocks()

int XrdPfc::File::GetNBlocks ( ) const
inline

◆ GetNDownloadedBlocks()

int XrdPfc::File::GetNDownloadedBlocks ( ) const
inline

◆ 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_ref_cnt()

int XrdPfc::File::inc_ref_cnt ( )
inline

References m_ref_cnt.

◆ inc_ref_count()

void XrdPfc::File::inc_ref_count ( Block )
private

◆ 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.

◆ isOpen()

bool XrdPfc::File::isOpen ( ) const
inline

Data and cinfo files are open.

References m_is_open.

◆ lPath()

const char* XrdPfc::File::lPath ( ) const

Log path.

◆ offsetIdx()

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

◆ Open()

bool XrdPfc::File::Open ( )

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,
long long &  size 
)
private

◆ Prefetch()

void XrdPfc::File::Prefetch ( )

◆ PrepareBlockRequest()

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

◆ ProcessBlockRequest()

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

◆ ProcessBlockRequests()

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

◆ ProcessBlockResponse()

void XrdPfc::File::ProcessBlockResponse ( BlockResponseHandler brh,
int  res 
)

◆ Read()

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

Normal read.

◆ ReadBlocksFromDisk()

int XrdPfc::File::ReadBlocksFromDisk ( IntList_t blocks,
char *  req_buf,
long long  req_off,
long long  req_size 
)
private

◆ ReadV()

int XrdPfc::File::ReadV ( IO io,
const XrdOucIOVec readV,
int  n 
)

Vector read from disk if block is already downloaded, else ReadV from client.

◆ RemoveIO()

void XrdPfc::File::RemoveIO ( IO io)

◆ RequestBlocksDirect()

int XrdPfc::File::RequestBlocksDirect ( IO io,
DirectResponseHandler handler,
IntList_t blocks,
char *  buff,
long long  req_off,
long long  req_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.

◆ VReadFromDisk()

int XrdPfc::File::VReadFromDisk ( const XrdOucIOVec readV,
int  n,
ReadVBlockListDisk &  blks_on_disk 
)
private

◆ VReadPreProcess()

void XrdPfc::File::VReadPreProcess ( IO io,
const XrdOucIOVec readV,
int  n,
BlockList_t blks_to_request,
ReadVBlockListRAM &  blks_to_process,
ReadVBlockListDisk &  blks_on_disk,
std::vector< XrdOucIOVec > &  chunkVec 
)
private

◆ VReadProcessBlocks()

int XrdPfc::File::VReadProcessBlocks ( IO io,
const XrdOucIOVec readV,
int  n,
std::vector< ReadVChunkListRAM > &  blks_to_process,
std::vector< ReadVChunkListRAM > &  blks_processed,
long long &  bytes_hit,
long long &  bytes_missed 
)
private

◆ VReadValidate()

bool XrdPfc::File::VReadValidate ( const XrdOucIOVec readV,
int  n 
)
private

◆ WriteBlockToDisk()

void XrdPfc::File::WriteBlockToDisk ( Block b)

Member Data Documentation

◆ m_block_map

BlockMap_t XrdPfc::File::m_block_map
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

IoMap_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_map

IoMap_t XrdPfc::File::m_io_map
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_is_open

bool XrdPfc::File::m_is_open
private

open state (presumably not needed anymore)

Referenced by isOpen().

◆ 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_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

◆ m_prefetch_read_cnt

int XrdPfc::File::m_prefetch_read_cnt
private

◆ m_prefetch_score

float XrdPfc::File::m_prefetch_score
private

◆ 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

◆ 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: