22 #include <sys/statvfs.h>
51 Cache *Cache::m_instance =
nullptr;
78 const char *config_filename,
79 const char *parameters,
83 err.
Say(
"++++++ Proxy file cache initialization started.");
94 if (! instance.
Config(config_filename, parameters))
96 err.
Say(
"Config Proxy file cache initialization failed.");
99 err.
Say(
"++++++ Proxy file cache initialization completed.");
106 for (
int wti = 0; wti < instance.
RefConfiguration().m_wqueue_threads; ++wti)
118 env->
PutPtr(
"XrdFSCtl_PC*", pfcFSctl);
128 assert (m_instance == 0);
129 m_instance =
new Cache(logger, env);
140 if (! m_decisionpoints.empty())
143 std::string filename = url.
GetPath();
144 std::vector<Decision*>::const_iterator it;
145 for (it = m_decisionpoints.begin(); it != m_decisionpoints.end(); ++it)
149 if (! d->
Decide(filename, *m_oss))
162 m_log(logger,
"XrdPfc_"),
168 m_prefetch_condVar(0),
169 m_prefetch_enabled(false),
171 m_RAM_write_queue(0),
182 const char* tpfx =
"Attach() ";
203 TRACE(
Error, tpfx <<
"Failed opening local file, falling back to remote access " << io->
Path());
211 ((loc && loc[0] != 0) ? loc :
"<deferred open>"));
231 m_writeQ.condVar.Lock();
233 m_writeQ.queue.push_back(b);
235 m_writeQ.queue.push_front(b);
237 m_writeQ.condVar.Signal();
238 m_writeQ.condVar.UnLock();
243 std::list<Block*> removed_blocks;
244 long long sum_size = 0;
246 m_writeQ.condVar.Lock();
247 std::list<Block*>::iterator i = m_writeQ.queue.begin();
248 while (i != m_writeQ.queue.end())
250 if ((*i)->m_file == file)
252 TRACE(Dump,
"Remove entries for " << (
void*)(*i) <<
" path " << file->
lPath());
253 std::list<Block*>::iterator j = i++;
254 removed_blocks.push_back(*j);
255 sum_size += (*j)->get_size();
256 m_writeQ.queue.erase(j);
264 m_writeQ.condVar.UnLock();
268 m_RAM_write_queue -= sum_size;
280 m_writeQ.condVar.Lock();
281 while (m_writeQ.size == 0)
283 m_writeQ.condVar.Wait();
289 int n_pushed = std::min(m_writeQ.size, m_configuration.
m_wqueue_blocks);
290 long long sum_size = 0;
292 for (
int bi = 0; bi < n_pushed; ++bi)
294 Block* block = m_writeQ.queue.front();
295 m_writeQ.queue.pop_front();
296 m_writeQ.writes_between_purges += block->
get_size();
299 blks_to_write[bi] = block;
301 TRACE(Dump,
"ProcessWriteTasks for block " << (
void*)(block) <<
" path " << block->
m_file->
lPath());
303 m_writeQ.size -= n_pushed;
305 m_writeQ.condVar.UnLock();
309 m_RAM_write_queue -= sum_size;
312 for (
int bi = 0; bi < n_pushed; ++bi)
314 Block* block = blks_to_write[bi];
325 long long ret = m_writeQ.writes_between_purges;
326 m_writeQ.writes_between_purges = 0;
334 static const size_t s_block_align = sysconf(_SC_PAGESIZE);
340 long long total = m_RAM_used + size;
345 if (std_size && m_RAM_std_size > 0)
347 char *buf = m_RAM_std_blocks.back();
348 m_RAM_std_blocks.pop_back();
359 if (posix_memalign((
void**) &buf, s_block_align, (
size_t) size))
382 m_RAM_std_blocks.push_back(buf);
394 TRACE(
Debug,
"GetFile " << path <<
", io " << io);
403 it = m_active.find(path);
407 if (it == m_active.end())
409 it = m_active.insert(std::make_pair(path, (
File*) 0)).first;
415 it->second->AddIO(io);
416 inc_ref_cnt(it->second,
false,
true);
423 m_active_cond.
Wait();
432 int res = io->
Fstat(st);
435 TRACE(
Error,
"GetFile, could not get valid stat");
436 }
else if (res > 0) {
438 TRACE(
Error,
"GetFile, stat returned positive value, this should NOT happen here");
440 filesize = st.st_size;
456 inc_ref_cnt(file,
false,
true);
483 dec_ref_cnt(f,
true);
490 class DiskSyncer :
public XrdJob
497 DiskSyncer(
File *f,
bool high_debug,
const char *desc =
"") :
500 m_high_debug(high_debug)
512 class CommandExecutor :
public XrdJob
515 std::string m_command_url;
518 CommandExecutor(
const std::string& command,
const char *desc =
"") :
520 m_command_url(command)
534 void Cache::schedule_file_sync(
File* f,
bool ref_cnt_already_set,
bool high_debug)
536 DiskSyncer* ds =
new DiskSyncer(f, high_debug);
538 if ( ! ref_cnt_already_set) inc_ref_cnt(f,
true, high_debug);
545 dec_ref_cnt(f, high_debug);
548 void Cache::inc_ref_cnt(
File* f,
bool lock,
bool high_debug)
554 if (lock) m_active_cond.
Lock();
556 if (lock) m_active_cond.
UnLock();
561 void Cache::dec_ref_cnt(
File* f,
bool high_debug)
583 <<
" -- deleting File object without further ado");
608 schedule_file_sync(f,
true,
true);
613 bool finished_p =
false;
618 TRACE_INT(tlvl,
"dec_ref_cnt " << f->
GetLocalPath() <<
", cnt after sync_check and dec_ref_cnt = " << cnt);
635 int len = snprintf(buf, 4096,
"{\"event\":\"file_close\","
636 "\"lfn\":\"%s\",\"size\":%lld,\"blk_size\":%d,\"n_blks\":%d,\"n_blks_done\":%d,"
637 "\"access_cnt\":%lu,\"attach_t\":%lld,\"detach_t\":%lld,\"remotes\":%s,"
638 "\"b_hit\":%lld,\"b_miss\":%lld,\"b_bypass\":%lld,"
639 "\"b_todisk\":%lld,\"b_prefetch\":%lld,\"n_cks_errs\":%d}",
650 suc = m_gstream->
Insert(buf, len + 1);
654 TRACE(
Error,
"Failed g-stream insertion of file_close record, len=" << len);
666 return m_active.find(path) != m_active.end() ||
667 m_purge_delay_set.find(path) != m_purge_delay_set.end();
673 m_purge_delay_set.clear();
684 if ( ! m_prefetch_enabled)
689 m_prefetch_condVar.
Lock();
690 m_prefetchList.push_back(file);
691 m_prefetch_condVar.
Signal();
692 m_prefetch_condVar.
UnLock();
700 if ( ! m_prefetch_enabled)
705 m_prefetch_condVar.
Lock();
706 for (PrefetchList::iterator it = m_prefetchList.begin(); it != m_prefetchList.end(); ++it)
710 m_prefetchList.erase(it);
714 m_prefetch_condVar.
UnLock();
720 m_prefetch_condVar.
Lock();
721 while (m_prefetchList.empty())
723 m_prefetch_condVar.
Wait();
728 size_t l = m_prefetchList.size();
729 int idx = rand() % l;
730 File* f = m_prefetchList[idx];
732 m_prefetch_condVar.
UnLock();
744 bool doPrefetch = (m_RAM_used < limit_RAM);
782 static const mode_t groupReadable = S_IRUSR | S_IWUSR | S_IRGRP;
783 static const mode_t worldReadable = S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH;
784 static const char *lfpReason[] = {
"ForAccess",
"ForInfo",
"ForPath" };
786 TRACE(
Debug,
"LocalFilePath '" << curl <<
"', why=" << lfpReason[why]);
788 if (buff && blen > 0) buff[0] = 0;
791 std::string f_name = url.
GetPath();
796 int ret = m_oss->
Lfn2Pfn(f_name.c_str(), buff, blen);
797 TRACE(
Info,
"LocalFilePath '" << curl <<
"', why=" << lfpReason[why] <<
" -> " << ret);
803 m_purge_delay_set.insert(f_name);
806 struct stat sbuff, sbuff2;
810 if (S_ISDIR(sbuff.st_mode))
812 TRACE(
Info,
"LocalFilePath '" << curl <<
"', why=" << lfpReason[why] <<
" -> EISDIR");
817 bool read_ok =
false;
818 bool is_complete =
false;
830 m_active_cond.
Lock();
832 bool is_active = m_active.find(f_name) != m_active.end();
834 if (is_active) m_active_cond.
UnLock();
838 int res = infoFile->
Open(i_name.c_str(), O_RDWR, 0600, myEnv);
841 Info info(m_trace, 0);
842 if (info.
Read(infoFile, i_name.c_str()))
849 if ( ! is_active && is_complete && why ==
ForAccess)
852 info.
Write(infoFile, i_name.c_str());
859 if ( ! is_active) m_active_cond.
UnLock();
863 if ((is_complete || why ==
ForInfo) && buff != 0)
865 int res2 = m_oss->
Lfn2Pfn(f_name.c_str(), buff, blen);
872 {mode_t mode = (forall ? worldReadable : groupReadable);
873 if (((sbuff.st_mode & worldReadable) != mode)
875 {is_complete =
false;
881 TRACE(
Info,
"LocalFilePath '" << curl <<
"', why=" << lfpReason[why] <<
882 (is_complete ?
" -> FILE_COMPLETE_IN_CACHE" :
" -> EREMOTE"));
884 return is_complete ? 0 : -EREMOTE;
889 TRACE(
Info,
"LocalFilePath '" << curl <<
"', why=" << lfpReason[why] <<
" -> ENOENT");
901 TRACE(
Debug,
"WriteFileSizeXAttr error setting xattr " << res);
915 m_oss->
Lfn2Pfn(cinfo_fname.c_str(), pfn, 4096);
916 long long fsize = -1ll;
918 if (res ==
sizeof(
long long))
924 TRACE(
Debug,
"DetermineFullFileSize error getting xattr " << res);
931 int res = infoFile->
Open(cinfo_fname.c_str(), O_RDONLY, 0600, env);
935 Info info(m_trace, 0);
936 if ( ! info.
Read(infoFile, cinfo_fname.c_str())) {
954 if (file_size == 0 || bytes_on_disk >= file_size)
957 double frac_on_disk = (double) bytes_on_disk / file_size;
987 static const char* tpfx =
"ConsiderCached ";
992 std::string f_name = url.
GetPath();
994 File *file =
nullptr;
997 auto it = m_active.find(f_name);
998 if (it != m_active.end()) {
1000 inc_ref_cnt(file,
false,
false);
1005 int res = file->
Fstat(sbuff);
1006 dec_ref_cnt(file,
false);
1010 return sbuff.st_atime > 0 ? 0 : -EREMOTE;
1014 int res = m_oss->
Stat(f_name.c_str(), &sbuff);
1019 if (S_ISDIR(sbuff.st_mode))
1026 if (file_size < 0) {
1027 TRACE(
Debug, tpfx << curl <<
" -> " << file_size);
1028 return (
int) file_size;
1032 return is_cached ? 0 : -EREMOTE;
1048 std::string f_name = url.
GetPath();
1052 if (oflags & (O_WRONLY | O_RDWR | O_APPEND | O_CREAT))
1054 TRACE(
Warning,
"Prepare write access requested on file " << f_name <<
". Denying access.");
1063 CommandExecutor *ce =
new CommandExecutor(f_name,
"CommandExecutor");
1073 m_purge_delay_set.insert(f_name);
1079 TRACE(Dump,
"Prepare defer open " << f_name);
1098 const char *tpfx =
"Stat ";
1101 std::string f_name = url.
GetPath();
1103 File *file =
nullptr;
1106 auto it = m_active.find(f_name);
1107 if (it != m_active.end()) {
1109 inc_ref_cnt(file,
false,
false);
1113 int res = file->
Fstat(sbuff);
1114 dec_ref_cnt(file,
false);
1115 TRACE(
Debug, tpfx <<
"from active file " << curl <<
" -> " << res);
1119 int res = m_oss->
Stat(f_name.c_str(), &sbuff);
1124 if (S_ISDIR(sbuff.st_mode))
1131 if (file_size < 0) {
1132 TRACE(
Debug, tpfx << curl <<
" -> " << file_size);
1135 sbuff.st_size = file_size;
1138 sbuff.st_ctime = sbuff.st_mtime = sbuff.st_atime = 0;
1141 TRACE(
Debug, tpfx <<
"from disk " << curl <<
" -> " << res);
1156 std::string f_name = url.
GetPath();
1165 static const char* trc_pfx =
"UnlinkFile ";
1171 it = m_active.find(f_name);
1173 if (it != m_active.end())
1177 TRACE(
Info, trc_pfx << f_name <<
", file currently open and force not requested - denying request");
1183 if (it->second == 0)
1185 TRACE(
Info, trc_pfx << f_name <<
", an operation on this file is ongoing - denying request");
1195 it = m_active.insert(std::make_pair(f_name, (
File*) 0)).first;
1208 bool stat_ok = (m_oss->
Stat(f_name.c_str(), &f_stat) ==
XrdOssOK);
1209 int f_ret = m_oss->
Unlink(f_name.c_str());
1210 int i_ret = m_oss->
Unlink(i_name.c_str());
1215 TRACE(
Debug, trc_pfx << f_name <<
", f_ret=" << f_ret <<
", i_ret=" << i_ret);
1223 return std::min(f_ret, i_ret);
int DoIt(int argpnt, int argc, char **argv, bool singleshot)
std::string obfuscateAuth(const std::string &input)
#define TRACE_PC(act, pre_code, x)
#define TRACE_INT(act, x)
void * ResourceMonitorThread(void *)
XrdOucCache * XrdOucGetCache(XrdSysLogger *logger, const char *config_filename, const char *parameters, XrdOucEnv *env)
void * PrefetchThread(void *)
XrdSysXAttr * XrdSysXAttrActive
void * ProcessWriteTaskThread(void *)
int stat(const char *path, struct stat *buf)
const std::string & GetPath() const
Get the path.
virtual int Close(long long *retsz=0)=0
virtual int Open(const char *path, int Oflag, mode_t Mode, XrdOucEnv &env)
virtual int Chmod(const char *path, mode_t mode, XrdOucEnv *envP=0)=0
virtual int Lfn2Pfn(const char *Path, char *buff, int blen)
virtual XrdOssDF * newFile(const char *tident)=0
virtual int Stat(const char *path, struct stat *buff, int opts=0, XrdOucEnv *envP=0)=0
virtual int Unlink(const char *path, int Opts=0, XrdOucEnv *envP=0)=0
virtual const char * Path()=0
virtual int Fstat(struct stat &sbuff)
virtual const char * Location(bool refresh=false)
void * GetPtr(const char *varname)
void PutPtr(const char *varname, void *value)
Attaches/creates and detaches/deletes cache-io objects for disk based cache.
long long DetermineFullFileSize(const std::string &cinfo_fname)
void FileSyncDone(File *, bool high_debug)
File * GetFile(const std::string &, IO *, long long off=0, long long filesize=0)
static const Configuration & Conf()
bool Config(const char *config_filename, const char *parameters)
Parse configuration file.
virtual int LocalFilePath(const char *url, char *buff=0, int blen=0, LFP_Reason why=ForAccess, bool forall=false)
virtual int Stat(const char *url, struct stat &sbuff)
const Configuration & RefConfiguration() const
Reference XrdPfc configuration.
static ResourceMonitor & ResMon()
bool IsFileActiveOrPurgeProtected(const std::string &) const
void ClearPurgeProtectedSet()
void ReleaseRAM(char *buf, long long size)
virtual int ConsiderCached(const char *url)
static Cache & GetInstance()
Singleton access.
void DeRegisterPrefetchFile(File *)
void ExecuteCommandUrl(const std::string &command_url)
void RegisterPrefetchFile(File *)
void WriteFileSizeXAttr(int cinfo_fd, long long file_size)
void ReleaseFile(File *, IO *)
void AddWriteTask(Block *b, bool from_read)
Add downloaded block in write queue.
Cache(XrdSysLogger *logger, XrdOucEnv *env)
Constructor.
bool Decide(XrdOucCacheIO *)
Makes decision if the original XrdOucCacheIO should be cached.
int UnlinkFile(const std::string &f_name, bool fail_if_open)
Remove cinfo and data files from cache.
virtual XrdOucCacheIO * Attach(XrdOucCacheIO *ioP, int opts=0)=0
Obtain a new IO object that fronts existing XrdOucCacheIO.
static XrdScheduler * schedP
File * GetNextFileToPrefetch()
ResourceMonitor & RefResMon()
long long WritesSinceLastCall()
void ProcessWriteTasks()
Separate task which writes blocks from ram to disk.
virtual int Unlink(const char *url)
void RemoveWriteQEntriesFor(File *f)
Remove blocks from write queue which belong to given prefetch. This method is used at the time of Fil...
static const Cache & TheOne()
char * RequestRAM(long long size)
virtual int Prepare(const char *url, int oflags, mode_t mode)
bool DecideIfConsideredCached(long long file_size, long long bytes_on_disk)
static Cache & CreateInstance(XrdSysLogger *logger, XrdOucEnv *env)
Singleton creation.
Base class for selecting which files should be cached.
virtual bool Decide(const std::string &, XrdOss &) const =0
bool FinalizeSyncBeforeExit()
Returns true if any of blocks need sync. Called from Cache::dec_ref_cnt on zero ref cnt.
const char * lPath() const
Log path.
void WriteBlockToDisk(Block *b)
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::string GetRemoteLocations() const
const Info::AStat * GetLastAccessStats() const
size_t GetAccessCnt() const
int Fstat(struct stat &sbuff)
long long GetPrefetchedBytes() const
int GetNDownloadedBlocks() const
void BlocksRemovedFromWriteQ(std::list< Block * > &)
Handle removal of a set of blocks from Cache's write queue.
void initiate_emergency_shutdown()
void Sync()
Sync file cache inf o and output data with disk.
long long GetFileSize() const
const Stats & RefStats() const
const std::string & GetLocalPath() const
bool is_in_emergency_shutdown()
Downloads original file into multiple files, chunked into blocks. Only blocks that are asked for are ...
Downloads original file into a single file on local disk. Handles read requests as they come along.
bool HasFile() const
Check if File was opened successfully.
Base cache-io class that implements some XrdOucCacheIO abstract methods.
Status of cached file. Can be read from and written into a binary file.
static const char * s_infoExtension
void WriteIOStatSingle(long long bytes_disk)
Write single open/close time for given bytes read from disk.
bool Write(XrdOssDF *fp, const char *dname, const char *fname=0)
bool IsComplete() const
Get complete status.
long long GetFileSize() const
Get file size.
bool Read(XrdOssDF *fp, const char *dname, const char *fname=0)
Read content of cinfo file into this object.
void register_file_purge(DirState *target, long long size_in_st_blocks)
void main_thread_function()
Statistics of cache utilisation by a File object.
int m_NCksumErrors
number of checksum errors while getting data from remote
long long m_BytesWritten
number of bytes written to disk
void Schedule(XrdJob *jp)
void Say(const char *text1, const char *text2=0, const char *txt3=0, const char *text4=0, const char *text5=0, const char *txt6=0)
static int Run(pthread_t *, void *(*proc)(void *), void *arg, int opts=0, const char *desc=0)
static void Wait(int milliseconds)
virtual int Get(const char *Aname, void *Aval, int Avsz, const char *Path, int fd=-1)=0
virtual int Set(const char *Aname, const void *Aval, int Avsz, const char *Path, int fd=-1, int isNew=0)=0
bool Insert(const char *data, int dlen)
Contains parameters configurable from the xrootd config file.
long long m_RamAbsAvailable
available from configuration
bool m_allow_xrdpfc_command
flag for enabling access to /xrdpfc-command/ functionality.
int m_prefetch_max_blocks
maximum number of blocks to prefetch per file
int m_RamKeepStdBlocks
number of standard-sized blocks kept after release
long long m_bufferSize
prefetch buffer size, default 1MB
int m_wqueue_blocks
maximum number of blocks written per write-queue loop
std::string m_username
username passed to oss plugin
double m_onlyIfCachedMinFrac
minimum fraction of downloaded file, used by only-if-cached CGI option
long long m_onlyIfCachedMinSize
minumum size of downloaded file, used by only-if-cached CGI option
long long BytesHit
read from cache
long long BytesBypassed
read from remote and dropped
time_t DetachTime
close time
long long BytesMissed
read from remote and cached
time_t AttachTime
open time