Go to the documentation of this file. 1 #ifndef __XRDFILECACHE_FILE_HH__
2 #define __XRDFILECACHE_FILE_HH__
43 class BlockResponseHandler;
44 class DirectResponseHandler;
47 struct ReadVBlockListRAM;
48 struct ReadVChunkListRAM;
49 struct ReadVBlockListDisk;
50 struct ReadVChunkListDisk;
110 virtual void Done(
int result);
128 virtual void Done(
int result);
139 File(
const std::string &path,
long long offset,
long long fileSize);
144 static File*
FileOpen(
const std::string &path,
long long offset,
long long fileSize);
164 int Read (
IO *io,
char* buff,
long long offset,
int size);
207 const char*
lPath()
const;
312 char* buff,
long long req_off,
long long req_size);
315 char* req_buf,
long long req_off,
long long req_size);
321 ReadVBlockListRAM& blks_to_process,
322 ReadVBlockListDisk& blks_on_disk,
323 std::vector<XrdOucIOVec>& chunkVec);
325 ReadVBlockListDisk& blks_on_disk);
327 std::vector<ReadVChunkListRAM>& blks_to_process,
328 std::vector<ReadVChunkListRAM>& blks_rocessed);
std::map< IO *, IODetails > IoMap_t
Definition: XrdFileCacheFile.hh:259
std::string m_filename
filename of data file on disk
Definition: XrdFileCacheFile.hh:244
void set_error(int err)
Definition: XrdFileCacheFile.hh:90
IntList_t::iterator IntList_i
Definition: XrdFileCacheFile.hh:272
BlockResponseHandler(Block *b, bool prefetch)
Definition: XrdFileCacheFile.hh:107
bool m_allow_prefetching
Definition: XrdFileCacheFile.hh:253
Status of cached file. Can be read from and written into a binary file.
Definition: XrdFileCacheInfo.hh:48
XrdSysCondVar m_downloadCond
Definition: XrdFileCacheFile.hh:283
int ReadV(IO *io, const XrdOucIOVec *readV, int n)
Vector read from disk if block is already downloaded, else ReadV from client.
Block(File *f, IO *io, long long off, int size, bool m_prefetch)
Definition: XrdFileCacheFile.hh:72
@ kHold
Definition: XrdFileCacheFile.hh:233
Definition: XrdSysPthread.hh:129
int get_size()
Definition: XrdFileCacheFile.hh:80
float GetPrefetchScore() const
Definition: XrdFileCacheFile.hh:59
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)
void inc_ref_count(Block *)
bool select_current_io_or_disable_prefetching(bool skip_current)
IoMap_t::iterator IoMap_i
Definition: XrdFileCacheFile.hh:260
long long m_offset
offset of cached file for block-based / hdfs operation
Definition: XrdFileCacheFile.hh:245
bool is_ok()
Definition: XrdFileCacheFile.hh:125
IoMap_i m_current_io
IO object to be used for prefetching.
Definition: XrdFileCacheFile.hh:263
virtual void Done(int result)
IO * m_io
Definition: XrdFileCacheFile.hh:65
int RequestBlocksDirect(IO *io, DirectResponseHandler *handler, IntList_t &blocks, char *buff, long long req_off, long long req_size)
long long m_fileSize
size of cached disk file for block-based operation
Definition: XrdFileCacheFile.hh:246
void ProcessBlockResponse(BlockResponseHandler *brh, int res)
Definition: XrdFileCacheFile.hh:133
bool m_for_prefetch
Definition: XrdFileCacheFile.hh:105
Statistics of disk cache utilisation.
Definition: XrdFileCacheStats.hh:30
bool ioActive(IO *io)
Initiate close. Return true if still IO active. Used in XrdPosixXrootd::Close()
int m_errno
Definition: XrdFileCacheFile.hh:120
int VReadFromDisk(const XrdOucIOVec *readV, int n, ReadVBlockListDisk &blks_on_disk)
PrefetchState_e
Definition: XrdFileCacheFile.hh:233
bool m_ioactive_false_reported
Definition: XrdFileCacheFile.hh:254
Base cache-io class that implements XrdOucCacheIO abstract methods.
Definition: XrdFileCacheIO.hh:16
File(const std::string &path, long long offset, long long fileSize)
Constructor.
bool is_failed()
Definition: XrdFileCacheFile.hh:87
bool is_failed()
Definition: XrdFileCacheFile.hh:126
Definition: XrdOucIOVec.hh:40
bool Open()
Open file handle for data file and info file on local disk.
void ProcessBlockRequests(BlockList_t &blks, bool prefetch)
int m_errno
Definition: XrdFileCacheFile.hh:68
XrdOssDF * m_output
file handle for data file on disk
Definition: XrdFileCacheFile.hh:240
void dec_ref_count(Block *)
bool VReadValidate(const XrdOucIOVec *readV, int n)
void initiate_emergency_shutdown()
int m_non_flushed_cnt
Definition: XrdFileCacheFile.hh:268
bool m_is_open
open state (presumably not needed anymore)
Definition: XrdFileCacheFile.hh:237
int GetPrefetchCountOnIO(IO *io)
PrefetchState_e m_prefetchState
Definition: XrdFileCacheFile.hh:287
BlockMap_t::iterator BlockMap_i
Definition: XrdFileCacheFile.hh:278
std::list< int > IntList_t
Definition: XrdFileCacheFile.hh:271
@ kStopped
Definition: XrdFileCacheFile.hh:233
int inc_ref_cnt()
Definition: XrdFileCacheFile.hh:226
Block * PrepareBlockRequest(int i, IO *io, bool prefetch)
Definition: XrdSysPthread.hh:78
bool isOpen() const
Data and cinfo files are open.
Definition: XrdFileCacheFile.hh:169
int get_ref_cnt()
Definition: XrdFileCacheFile.hh:225
BlockMap_t m_block_map
Definition: XrdFileCacheFile.hh:281
long long GetFileSize()
Definition: XrdFileCacheFile.hh:214
int m_active_prefetches
Definition: XrdFileCacheFile.hh:252
std::string & GetLocalPath()
Definition: XrdFileCacheFile.hh:209
std::vector< char > m_buff
Definition: XrdFileCacheFile.hh:62
long long get_offset()
Definition: XrdFileCacheFile.hh:81
int m_ref_cnt
number of references from IO or sync
Definition: XrdFileCacheFile.hh:235
Definition: XrdFileCache.hh:40
void RequestSyncOfDetachStats()
Flags that detach stats should be written out in final sync. Called from CacheIO upon Detach.
@ kOn
Definition: XrdFileCacheFile.hh:233
bool m_in_shutdown
file is in emergency shutdown due to irrecoverable error or unlink request
Definition: XrdFileCacheFile.hh:238
Definition: XrdFileCacheFile.hh:115
long long m_offset
Definition: XrdFileCacheFile.hh:63
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)
IODetails()
Definition: XrdFileCacheFile.hh:256
Definition: XrdFileCacheFile.hh:101
int m_ios_in_detach
Number of IO objects to which we replied false to ioActive() and will be removed soon.
Definition: XrdFileCacheFile.hh:264
bool m_downloaded
Definition: XrdFileCacheFile.hh:69
void BlocksRemovedFromWriteQ(std::list< Block * > &)
Handle removal of a set of blocks from Cache's write queue.
@ kComplete
Definition: XrdFileCacheFile.hh:233
virtual void Done(int result)
void WriteBlockToDisk(Block *b)
bool m_in_sync
Definition: XrdFileCacheFile.hh:269
void StopPrefetchingOnIO(IO *io)
int Read(IO *io, char *buff, long long offset, int size)
Normal read.
int ReadBlocksFromDisk(IntList_t &blocks, char *req_buf, long long req_off, long long req_size)
bool is_in_emergency_shutdown()
Definition: XrdFileCacheFile.hh:230
Stats & GetStats()
Reference to prefetch statistics.
Definition: XrdFileCacheFile.hh:197
bool m_prefetch
Definition: XrdFileCacheFile.hh:70
int VReadProcessBlocks(IO *io, const XrdOucIOVec *readV, int n, std::vector< ReadVChunkListRAM > &blks_to_process, std::vector< ReadVChunkListRAM > &blks_rocessed)
void set_downloaded()
Definition: XrdFileCacheFile.hh:89
Definition: XrdClAnyObject.hh:25
bool FinalizeSyncBeforeExit()
Returns true if any of blocks need sync. Called from Cache::dec_ref_cnt on zero ref cnt.
void reset_error_and_set_io(IO *io)
Definition: XrdFileCacheFile.hh:92
BlockList_t::iterator BlockList_i
Definition: XrdFileCacheFile.hh:275
const char * lPath() const
Log path.
void Sync()
Sync file cache inf o and output data with disk.
File * m_file
Definition: XrdFileCacheFile.hh:64
Info m_cfi
download status of file blocks and access statistics
Definition: XrdFileCacheFile.hh:242
std::vector< int > m_writes_during_sync
Definition: XrdFileCacheFile.hh:267
XrdOssDF * m_infoFile
file handle for data-info file on disk
Definition: XrdFileCacheFile.hh:241
bool m_detachTimeIsLogged
Definition: XrdFileCacheFile.hh:293
XrdSysCondVar m_cond
Definition: XrdFileCacheFile.hh:118
void ProcessBlockRequest(Block *b, bool prefetch)
void BlockRemovedFromWriteQ(Block *)
Handle removal of a block from Cache's write queue.
bool is_ok()
Definition: XrdFileCacheFile.hh:86
bool is_finished()
Definition: XrdFileCacheFile.hh:85
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.
std::list< Block * > BlockList_t
Definition: XrdFileCacheFile.hh:274
int m_refcnt
Definition: XrdFileCacheFile.hh:67
bool is_finished()
Definition: XrdFileCacheFile.hh:124
IoMap_t m_io_map
Definition: XrdFileCacheFile.hh:262
Definition: XrdOucCache.hh:93
int m_prefetchHitCnt
Definition: XrdFileCacheFile.hh:290
static const char * m_traceID
Definition: XrdFileCacheFile.hh:295
@ kOff
Definition: XrdFileCacheFile.hh:233
int dec_ref_cnt()
Definition: XrdFileCacheFile.hh:227
Definition: XrdSysError.hh:89
Definition: XrdSysTrace.hh:48
float m_prefetchScore
Definition: XrdFileCacheFile.hh:291
IO * get_io() const
Definition: XrdFileCacheFile.hh:83
Block * m_block
Definition: XrdFileCacheFile.hh:104
int m_prefetchReadCnt
Definition: XrdFileCacheFile.hh:289
std::map< int, Block * > BlockMap_t
Definition: XrdFileCacheFile.hh:277
Stats m_stats
cache statistics, used in IO detach
Definition: XrdFileCacheFile.hh:285
DirectResponseHandler(int to_wait)
Definition: XrdFileCacheFile.hh:122
char * get_buff(long long pos=0)
Definition: XrdFileCacheFile.hh:79
Definition: XrdFileCacheFile.hh:250
int m_to_wait
Definition: XrdFileCacheFile.hh:119