1 #ifndef __XRDPFC_FILE_HH__
2 #define __XRDPFC_FILE_HH__
45 class BlockResponseHandler;
46 class DirectResponseHandler;
49 struct ReadVBlockListRAM;
50 struct ReadVChunkListRAM;
51 struct ReadVBlockListDisk;
52 struct ReadVChunkListDisk;
137 Block(
File *f,
IO *io,
void *rid,
char *buf,
long long off,
int size,
int rsize,
188 void Done(
int result)
override;
207 void Done(
int result)
override;
220 static File*
FileOpen(
const std::string &path,
long long offset,
long long fileSize);
306 File(
const std::string &path,
long long offset,
long long fileSize);
Definition: XrdOucCache.hh:53
Definition: XrdPfcFile.hh:182
Block * m_block
Definition: XrdPfcFile.hh:184
void Done(int result) override
BlockResponseHandler(Block *b)
Definition: XrdPfcFile.hh:186
Definition: XrdPfcFile.hh:117
int * ptr_n_cksum_errors()
Definition: XrdPfcFile.hh:173
int get_size() const
Definition: XrdPfcFile.hh:146
int get_error() const
Definition: XrdPfcFile.hh:160
int get_n_cksum_errors()
Definition: XrdPfcFile.hh:172
IO * m_io
Definition: XrdPfcFile.hh:120
File * m_file
Definition: XrdPfcFile.hh:119
Block(File *f, IO *io, void *rid, char *buf, long long off, int size, int rsize, bool m_prefetch, bool cks_net)
Definition: XrdPfcFile.hh:137
int m_size
Definition: XrdPfcFile.hh:125
void * get_req_id() const
Definition: XrdPfcFile.hh:152
int m_req_size
Definition: XrdPfcFile.hh:126
long long get_offset() const
Definition: XrdPfcFile.hh:148
vChunkRequest_t m_chunk_reqs
Definition: XrdPfcFile.hh:135
bool is_finished() const
Definition: XrdPfcFile.hh:154
bool is_ok() const
Definition: XrdPfcFile.hh:155
void set_error(int err)
Definition: XrdPfcFile.hh:159
vCkSum_t & ref_cksum_vec()
Definition: XrdPfcFile.hh:171
bool m_prefetch
Definition: XrdPfcFile.hh:130
int m_n_cksum_errors
Definition: XrdPfcFile.hh:133
char * get_buff() const
Definition: XrdPfcFile.hh:145
IO * get_io() const
Definition: XrdPfcFile.hh:151
void set_downloaded()
Definition: XrdPfcFile.hh:158
int m_errno
Definition: XrdPfcFile.hh:128
bool req_cksum_net() const
Definition: XrdPfcFile.hh:169
int m_refcnt
Definition: XrdPfcFile.hh:127
char * m_buff
Definition: XrdPfcFile.hh:123
void * m_req_id
Definition: XrdPfcFile.hh:121
bool has_cksums() const
Definition: XrdPfcFile.hh:170
File * get_file() const
Definition: XrdPfcFile.hh:150
bool is_failed() const
Definition: XrdPfcFile.hh:156
long long m_offset
Definition: XrdPfcFile.hh:124
bool m_downloaded
Definition: XrdPfcFile.hh:129
vCkSum_t m_cksum_vec
Definition: XrdPfcFile.hh:132
void reset_error_and_set_io(IO *io, void *rid)
Definition: XrdPfcFile.hh:162
bool m_req_cksum_net
Definition: XrdPfcFile.hh:131
int get_req_size() const
Definition: XrdPfcFile.hh:147
Definition: XrdPfcFile.hh:194
int m_to_wait
Definition: XrdPfcFile.hh:199
void Done(int result) override
XrdSysMutex m_mutex
Definition: XrdPfcFile.hh:196
ReadRequest * m_read_req
Definition: XrdPfcFile.hh:198
DirectResponseHandler(File *file, ReadRequest *rreq, int to_wait)
Definition: XrdPfcFile.hh:203
int m_errno
Definition: XrdPfcFile.hh:201
int m_bytes_read
Definition: XrdPfcFile.hh:200
File * m_file
Definition: XrdPfcFile.hh:197
Definition: XrdPfcFile.hh:213
void inc_prefetch_read_cnt(int prc)
Definition: XrdPfcFile.hh:371
XrdOssDF * m_info_file
file handle for data-info file on disk
Definition: XrdPfcFile.hh:316
void ProcessBlockRequests(BlockList_t &blks)
const char * lPath() const
Log path.
IoSet_t m_io_set
Definition: XrdPfcFile.hh:328
long long m_offset
offset of cached file for block-based / hdfs operation
Definition: XrdPfcFile.hh:320
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)
int Read(IO *io, char *buff, long long offset, int size, ReadReqRH *rh)
Normal read.
int m_num_blocks
Definition: XrdPfcFile.hh:351
int m_non_flushed_cnt
Definition: XrdPfcFile.hh:335
IntList_t::iterator IntList_i
Definition: XrdPfcFile.hh:343
int GetNBlocks() const
Definition: XrdPfcFile.hh:292
void ioUpdated(IO *io)
Notification from IO that it has been updated (remote open).
BlockMap_t::iterator BlockMap_i
Definition: XrdPfcFile.hh:346
void inc_ref_count(Block *b)
Definition: XrdPfcFile.hh:420
bool m_in_sync
Definition: XrdPfcFile.hh:336
File(const std::string &path, long long offset, long long fileSize)
Constructor.
int ReadV(IO *io, const XrdOucIOVec *readV, int readVnum, ReadReqRH *rh)
Vector read.
void StopPrefetchingOnIO(IO *io)
void RequestSyncOfDetachStats()
Flags that detach stats should be written out in final sync. Called from CacheIO upon Detach.
const Info::AStat * GetLastAccessStats() const
Definition: XrdPfcFile.hh:289
Stats m_last_stats
copy of cache stats during last purge cycle, used for per directory stat reporting
Definition: XrdPfcFile.hh:356
size_t GetAccessCnt() const
Definition: XrdPfcFile.hh:290
int m_prefetch_read_cnt
Definition: XrdPfcFile.hh:367
void BlocksRemovedFromWriteQ(std::list< Block * > &)
Handle removal of a set of blocks from Cache's write queue.
bool ioActive(IO *io)
Initiate close. Return true if still IO active. Used in XrdPosixXrootd::Close()
void Sync()
Sync file cache inf o and output data with disk.
Stats m_stats
cache statistics for this instance
Definition: XrdPfcFile.hh:355
static const char * m_traceID
Definition: XrdPfcFile.hh:311
XrdSysCondVar m_state_cond
Definition: XrdPfcFile.hh:349
float GetPrefetchScore() const
int GetBlockSize() const
Definition: XrdPfcFile.hh:291
int GetNDownloadedBlocks() const
Definition: XrdPfcFile.hh:293
long long GetFileSize()
Definition: XrdPfcFile.hh:279
int offsetIdx(int idx) const
int m_prefetch_hit_cnt
Definition: XrdPfcFile.hh:368
bool m_detach_time_logged
Definition: XrdPfcFile.hh:337
int m_ios_in_detach
Number of IO objects to which we replied false to ioActive() and will be removed soon.
Definition: XrdPfcFile.hh:330
IoSet_t::iterator IoSet_i
Definition: XrdPfcFile.hh:326
std::list< int > IntList_t
Definition: XrdPfcFile.hh:342
void dec_ref_count(Block *b, int count=1)
Definition: XrdPfcFile.hh:428
Block * PrepareBlockRequest(int i, IO *io, void *req_id, bool prefetch)
void ProcessBlockResponse(Block *b, int res)
bool Open()
Open file handle for data file and info file on local disk.
PrefetchState_e
Definition: XrdPfcFile.hh:363
@ kStopped
Definition: XrdPfcFile.hh:363
@ kOff
Definition: XrdPfcFile.hh:363
@ kHold
Definition: XrdPfcFile.hh:363
@ kComplete
Definition: XrdPfcFile.hh:363
@ kOn
Definition: XrdPfcFile.hh:363
std::set< IO * > IoSet_t
Definition: XrdPfcFile.hh:325
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.
int inc_ref_cnt()
Definition: XrdPfcFile.hh:298
void RequestBlocksDirect(IO *io, DirectResponseHandler *handler, std::vector< XrdOucIOVec > &ioVec, int expected_size)
int GetPrefetchCountOnIO(IO *io)
void ProcessBlockRequest(Block *b)
void FinalizeReadRequest(ReadRequest *rreq)
int dec_ref_cnt()
Definition: XrdPfcFile.hh:299
int get_ref_cnt()
Definition: XrdPfcFile.hh:297
bool select_current_io_or_disable_prefetching(bool skip_current)
void WriteBlockToDisk(Block *b)
IoSet_i m_current_io
IO object to be used for prefetching.
Definition: XrdPfcFile.hh:329
Info m_cfi
download status of file blocks and access statistics
Definition: XrdPfcFile.hh:317
bool overlap(int blk, long long blk_size, long long req_off, int req_size, long long &off, long long &blk_off, int &size)
std::string m_filename
filename of data file on disk
Definition: XrdPfcFile.hh:319
std::string GetRemoteLocations() const
const Stats & RefStats() const
Definition: XrdPfcFile.hh:294
void insert_remote_location(const std::string &loc)
bool m_in_shutdown
file is in emergency shutdown due to irrecoverable error or unlink request
Definition: XrdPfcFile.hh:338
std::set< std::string > m_remote_locations
Gathered in AddIO / ioUpdate / ioActive.
Definition: XrdPfcFile.hh:358
int m_ref_cnt
number of references from IO or sync
Definition: XrdPfcFile.hh:313
std::string & GetLocalPath()
Definition: XrdPfcFile.hh:274
void ProcessBlockSuccess(Block *b, ChunkRequest &creq)
bool FinalizeSyncBeforeExit()
Returns true if any of blocks need sync. Called from Cache::dec_ref_cnt on zero ref cnt.
Stats DeltaStatsFromLastCall()
void inc_prefetch_hit_cnt(int phc)
Definition: XrdPfcFile.hh:372
void BlockRemovedFromWriteQ(Block *)
Handle removal of a block from Cache's write queue.
long long m_file_size
size of cached disk file for block-based operation
Definition: XrdPfcFile.hh:321
float m_prefetch_score
Definition: XrdPfcFile.hh:369
PrefetchState_e m_prefetch_state
Definition: XrdPfcFile.hh:365
XrdOssDF * m_data_file
file handle for data file on disk
Definition: XrdPfcFile.hh:315
bool is_in_emergency_shutdown()
Definition: XrdPfcFile.hh:302
int ReadBlocksFromDisk(std::vector< XrdOucIOVec > &ioVec, int expected_size)
void initiate_emergency_shutdown()
std::vector< int > m_writes_during_sync
Definition: XrdPfcFile.hh:334
void calc_prefetch_score()
Definition: XrdPfcFile.hh:373
BlockMap_t m_block_map
Definition: XrdPfcFile.hh:348
std::map< int, Block * > BlockMap_t
Definition: XrdPfcFile.hh:345
long long m_block_size
Definition: XrdPfcFile.hh:350
Base cache-io class that implements some XrdOucCacheIO abstract methods.
Definition: XrdPfcIO.hh:18
Status of cached file. Can be read from and written into a binary file.
Definition: XrdPfcInfo.hh:45
long long GetBufferSize() const
Get prefetch buffer size.
Definition: XrdPfcInfo.hh:473
const AStat * GetLastAccessStats() const
Get latest access stats.
int GetNDownloadedBlocks() const
Get number of downloaded blocks.
Definition: XrdPfcInfo.hh:402
size_t GetAccessCnt() const
Get number of accesses.
Definition: XrdPfcInfo.hh:265
int GetNBlocks() const
Get number of blocks represented in download-state bit-vector.
Definition: XrdPfcInfo.hh:441
Statistics of cache utilisation by a File object.
Definition: XrdPfcStats.hh:31
Definition: XrdSysPthread.hh:79
Definition: XrdSysError.hh:90
Definition: XrdSysPthread.hh:165
Definition: XrdSysTrace.hh:49
Definition: XrdClAction.hh:34
std::vector< ChunkRequest > vChunkRequest_t
Definition: XrdPfcFile.hh:111
std::vector< ChunkRequest >::iterator vChunkRequest_i
Definition: XrdPfcFile.hh:112
std::list< Block * > BlockList_t
Definition: XrdPfcFile.hh:176
std::vector< uint32_t > vCkSum_t
Definition: XrdPfcTypes.hh:27
std::list< Block * >::iterator BlockList_i
Definition: XrdPfcFile.hh:177
Definition: XrdOucIOVec.hh:41
Definition: XrdPfcFile.hh:100
int m_size
Definition: XrdPfcFile.hh:104
ChunkRequest(ReadRequest *rreq, char *buf, long long off, int size)
Definition: XrdPfcFile.hh:106
char * m_buf
Definition: XrdPfcFile.hh:102
ReadRequest * m_read_req
Definition: XrdPfcFile.hh:101
long long m_off
Definition: XrdPfcFile.hh:103
Access statistics.
Definition: XrdPfcInfo.hh:61
Definition: XrdPfcFile.hh:61
XrdOucCacheIOCB * m_iocb
Definition: XrdPfcFile.hh:65
unsigned short m_seq_id
Definition: XrdPfcFile.hh:64
ReadReqRH(unsigned short sid, XrdOucCacheIOCB *iocb)
Definition: XrdPfcFile.hh:67
int m_expected_size
Definition: XrdPfcFile.hh:62
int m_n_chunks
Definition: XrdPfcFile.hh:63
Definition: XrdPfcFile.hh:75
void update_error_cond(int ec)
Definition: XrdPfcFile.hh:91
ReadRequest(IO *io, ReadReqRH *rh)
Definition: XrdPfcFile.hh:87
int m_n_chunk_reqs
Definition: XrdPfcFile.hh:83
ReadReqRH * m_rh
Definition: XrdPfcFile.hh:77
IO * m_io
Definition: XrdPfcFile.hh:76
bool m_sync_done
Definition: XrdPfcFile.hh:84
int m_error_cond
Definition: XrdPfcFile.hh:80
Stats m_stats
Definition: XrdPfcFile.hh:81
bool is_complete() const
Definition: XrdPfcFile.hh:93
bool m_direct_done
Definition: XrdPfcFile.hh:85
int return_value() const
Definition: XrdPfcFile.hh:94
long long m_bytes_read
Definition: XrdPfcFile.hh:79