XRootD
Loading...
Searching...
No Matches
XrdPfc.hh
Go to the documentation of this file.
1#ifndef __XRDPFC_CACHE_HH__
2#define __XRDPFC_CACHE_HH__
3//----------------------------------------------------------------------------------
4// Copyright (c) 2014 by Board of Trustees of the Leland Stanford, Jr., University
5// Author: Alja Mrak-Tadel, Matevz Tadel, Brian Bockelman
6//----------------------------------------------------------------------------------
7// XRootD is free software: you can redistribute it and/or modify
8// it under the terms of the GNU Lesser General Public License as published by
9// the Free Software Foundation, either version 3 of the License, or
10// (at your option) any later version.
11//
12// XRootD is distributed in the hope that it will be useful,
13// but WITHOUT ANY emacs WARRANTY; without even the implied warranty of
14// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15// GNU General Public License for more details.
16//
17// You should have received a copy of the GNU Lesser General Public License
18// along with XRootD. If not, see <http://www.gnu.org/licenses/>.
19//----------------------------------------------------------------------------------
20#include <string>
21#include <list>
22#include <map>
23#include <set>
24
25#include "Xrd/XrdScheduler.hh"
26#include "XrdVersion.hh"
28#include "XrdOuc/XrdOucCache.hh"
30
31#include "XrdPfcFile.hh"
32#include "XrdPfcDecision.hh"
33
34class XrdOss;
35class XrdOucStream;
36class XrdSysError;
37class XrdSysTrace;
39
40namespace XrdPfc
41{
42class File;
43class IO;
44class PurgePin;
45class ResourceMonitor;
46
47
48template<class MOO>
50 MOO &mutex;
51 MutexHolder(MOO &m) : mutex(m) { mutex.Lock(); }
52 ~MutexHolder() { mutex.UnLock(); }
53};
54}
55
56
57namespace XrdPfc
58{
59
60//----------------------------------------------------------------------------
62//----------------------------------------------------------------------------
64{
66
67 bool are_file_usage_limits_set() const { return m_fileUsageMax > 0; }
69 bool is_uvkeep_purge_in_effect() const { return m_cs_UVKeep >= 0; }
70 bool is_dir_stat_reporting_on() const { return m_dirStatsMaxDepth >= 0 || ! m_dirStatsDirs.empty() || ! m_dirStatsDirGlobs.empty(); }
71 bool is_purge_plugin_set_up() const { return false; }
72
74
75 bool is_cschk_cache() const { return m_cs_Chk & CSChk_Cache; }
76 bool is_cschk_net() const { return m_cs_Chk & CSChk_Net; }
77 bool is_cschk_any() const { return m_cs_Chk & CSChk_Both; }
78 bool is_cschk_both() const { return (m_cs_Chk & CSChk_Both) == CSChk_Both; }
79
80 bool does_cschk_have_missing_bits(CkSumCheck_e cks_on_file) const { return m_cs_Chk & ~cks_on_file; }
81
82 bool should_uvkeep_purge(time_t delta) const { return m_cs_UVKeep >= 0 && delta > m_cs_UVKeep; }
83
86
87 std::string m_username;
88 std::string m_data_space;
89 std::string m_meta_space;
90
91 long long m_diskTotalSpace;
92 long long m_diskUsageLWM;
93 long long m_diskUsageHWM;
96 long long m_fileUsageMax;
101
102 std::set<std::string> m_dirStatsDirs;
103 std::set<std::string> m_dirStatsDirGlobs;
107
108 long long m_bufferSize;
114
115 long long m_hdfsbsize;
116 long long m_flushCnt;
117
118 time_t m_cs_UVKeep;
121
124};
125
126//------------------------------------------------------------------------------
127
129{
130 std::string m_diskUsageLWM;
131 std::string m_diskUsageHWM;
134 std::string m_fileUsageMax;
135 std::string m_flushRaw;
136
138 m_diskUsageLWM("0.90"), m_diskUsageHWM("0.95"),
139 m_flushRaw("")
140 {}
141};
142
143
144//==============================================================================
145// Cache
146//==============================================================================
147
148//----------------------------------------------------------------------------
150//----------------------------------------------------------------------------
151class Cache : public XrdOucCache
152{
153public:
154 //---------------------------------------------------------------------
156 //---------------------------------------------------------------------
157 Cache(XrdSysLogger *logger, XrdOucEnv *env);
158
159 //---------------------------------------------------------------------
161 //---------------------------------------------------------------------
163
164 virtual XrdOucCacheIO *Attach(XrdOucCacheIO *, int Options = 0);
165
166 //---------------------------------------------------------------------
167 // Virtual function of XrdOucCache. Used for redirection to a local
168 // file on a distributed FS.
169 virtual int LocalFilePath(const char *url, char *buff=0, int blen=0,
170 LFP_Reason why=ForAccess, bool forall=false);
171
172 //---------------------------------------------------------------------
173 // Virtual function of XrdOucCache. Used for deferred open.
174 virtual int Prepare(const char *url, int oflags, mode_t mode);
175
176 // virtual function of XrdOucCache.
177 virtual int Stat(const char *url, struct stat &sbuff);
178
179 // virtual function of XrdOucCache.
180 virtual int Unlink(const char *url);
181
182 //---------------------------------------------------------------------
183 // Used by PfcFstcl::Fsctl function.
184 // Test if file is cached taking in onlyifcached configuration parameters.
185 //---------------------------------------------------------------------
186 virtual int ConsiderCached(const char *url);
187
188 bool DecideIfConsideredCached(long long file_size, long long bytes_on_disk);
189 void WriteFileSizeXAttr(int cinfo_fd, long long file_size);
190 long long DetermineFullFileSize(const std::string &cinfo_fname);
191
192 //--------------------------------------------------------------------
198 //--------------------------------------------------------------------
199 bool Decide(XrdOucCacheIO*);
200
201 //------------------------------------------------------------------------
203 //------------------------------------------------------------------------
204 const Configuration& RefConfiguration() const { return m_configuration; }
205
206 //---------------------------------------------------------------------
213 //---------------------------------------------------------------------
214 bool Config(const char *config_filename, const char *parameters);
215
216 //---------------------------------------------------------------------
218 //---------------------------------------------------------------------
219 static Cache &CreateInstance(XrdSysLogger *logger, XrdOucEnv *env);
220
221 //---------------------------------------------------------------------
223 //---------------------------------------------------------------------
224 static Cache &GetInstance();
225 static const Cache &TheOne();
226 static const Configuration &Conf();
227
228 static ResourceMonitor &ResMon();
229
230 //---------------------------------------------------------------------
232 //---------------------------------------------------------------------
233 static bool VCheck(XrdVersionInfo &urVersion) { return true; }
234
235 //---------------------------------------------------------------------
237 //---------------------------------------------------------------------
238 int UnlinkFile(const std::string& f_name, bool fail_if_open);
239
240 //---------------------------------------------------------------------
242 //---------------------------------------------------------------------
243 void AddWriteTask(Block* b, bool from_read);
244
245 //---------------------------------------------------------------------
248 //---------------------------------------------------------------------
250
251 //---------------------------------------------------------------------
253 //---------------------------------------------------------------------
254 void ProcessWriteTasks();
255
256 long long WritesSinceLastCall();
257
258 char* RequestRAM(long long size);
259 void ReleaseRAM(char* buf, long long size);
260
263
265
266 void Prefetch();
267
268 XrdOss* GetOss() const { return m_oss; }
269
270 bool IsFileActiveOrPurgeProtected(const std::string&) const;
272 PurgePin* GetPurgePin() const { return m_purge_pin; }
273
274 File* GetFile(const std::string&, IO*, long long off = 0, long long filesize = 0);
275
276 void ReleaseFile(File*, IO*);
277
278 void ScheduleFileSync(File* f) { schedule_file_sync(f, false, false); }
279
280 void FileSyncDone(File*, bool high_debug);
281
282 XrdSysError* GetLog() { return &m_log; }
283 XrdSysTrace* GetTrace() { return m_trace; }
284
285 ResourceMonitor& RefResMon() { return *m_res_mon; }
286 XrdXrootdGStream* GetGStream() { return m_gstream; }
287
288 void ExecuteCommandUrl(const std::string& command_url);
289
291
292private:
293 bool ConfigParameters(std::string, XrdOucStream&, TmpConfiguration &tmpc);
294 bool ConfigXeq(char *, XrdOucStream &);
295 bool xcschk(XrdOucStream &);
296 bool xdlib(XrdOucStream &);
297 bool xplib(XrdOucStream &);
298 bool xtrace(XrdOucStream &);
299 bool test_oss_basics_and_features();
300
301 bool cfg2bytes(const std::string &str, long long &store, long long totalSpace, const char *name);
302
303 static Cache *m_instance;
304
305 XrdOucEnv *m_env;
306 XrdSysError m_log;
307 XrdSysTrace *m_trace;
308 const char *m_traceID;
309
310 XrdOss *m_oss;
311
312 XrdXrootdGStream *m_gstream;
313
314 ResourceMonitor *m_res_mon;
315
316 std::vector<Decision*> m_decisionpoints;
317 PurgePin* m_purge_pin;
318
319 Configuration m_configuration;
320
321 XrdSysCondVar m_prefetch_condVar;
322 bool m_prefetch_enabled;
323
324 XrdSysMutex m_RAM_mutex;
325 long long m_RAM_used;
326 long long m_RAM_write_queue;
327 std::list<char*> m_RAM_std_blocks;
328 int m_RAM_std_size;
329
330 bool m_isClient;
331 bool m_dataXattr = false;
332 bool m_metaXattr = false;
333
334 struct WriteQ
335 {
336 WriteQ() : condVar(0), writes_between_purges(0), size(0) {}
337
338 XrdSysCondVar condVar;
339 std::list<Block*> queue;
340 long long writes_between_purges;
341 int size;
342 };
343
344 WriteQ m_writeQ;
345
346 // active map, purge delay set
347 typedef std::map<std::string, File*> ActiveMap_t;
348 typedef ActiveMap_t::iterator ActiveMap_i;
349 typedef std::set<std::string> FNameSet_t;
350
351 ActiveMap_t m_active;
352 FNameSet_t m_purge_delay_set;
353 mutable XrdSysCondVar m_active_cond;
354
355 void inc_ref_cnt(File*, bool lock, bool high_debug);
356 void dec_ref_cnt(File*, bool high_debug);
357
358 void schedule_file_sync(File*, bool ref_cnt_already_set, bool high_debug);
359
360 // prefetching
361 typedef std::vector<File*> PrefetchList;
362 PrefetchList m_prefetchList;
363};
364
365}
366
367#endif
struct stat Stat
Definition XrdCks.cc:49
#define stat(a, b)
Definition XrdPosix.hh:101
XrdOucString File
virtual XrdOucCacheIO * Attach(XrdOucCacheIO *ioP, int opts=0)=0
Attaches/creates and detaches/deletes cache-io objects for disk based cache.
Definition XrdPfc.hh:152
long long DetermineFullFileSize(const std::string &cinfo_fname)
Definition XrdPfc.cc:925
void FileSyncDone(File *, bool high_debug)
Definition XrdPfc.cc:542
File * GetFile(const std::string &, IO *, long long off=0, long long filesize=0)
Definition XrdPfc.cc:389
static const Configuration & Conf()
Definition XrdPfc.cc:134
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)
Definition XrdPfc.cc:793
const Configuration & RefConfiguration() const
Reference XrdPfc configuration.
Definition XrdPfc.hh:204
XrdSysTrace * GetTrace()
Definition XrdPfc.hh:283
static ResourceMonitor & ResMon()
Definition XrdPfc.cc:135
bool IsFileActiveOrPurgeProtected(const std::string &) const
Definition XrdPfc.cc:676
void ClearPurgeProtectedSet()
Definition XrdPfc.cc:684
void ReleaseRAM(char *buf, long long size)
Definition XrdPfc.cc:371
virtual int ConsiderCached(const char *url)
Definition XrdPfc.cc:999
static Cache & GetInstance()
Singleton access.
Definition XrdPfc.cc:132
void DeRegisterPrefetchFile(File *)
Definition XrdPfc.cc:710
void ExecuteCommandUrl(const std::string &command_url)
void RegisterPrefetchFile(File *)
Definition XrdPfc.cc:694
void WriteFileSizeXAttr(int cinfo_fd, long long file_size)
Definition XrdPfc.cc:910
void Prefetch()
Definition XrdPfc.cc:751
void ReleaseFile(File *, IO *)
Definition XrdPfc.cc:471
void AddWriteTask(Block *b, bool from_read)
Add downloaded block in write queue.
Definition XrdPfc.cc:221
Cache(XrdSysLogger *logger, XrdOucEnv *env)
Constructor.
Definition XrdPfc.cc:158
XrdXrootdGStream * GetGStream()
Definition XrdPfc.hh:286
bool Decide(XrdOucCacheIO *)
Makes decision if the original XrdOucCacheIO should be cached.
Definition XrdPfc.cc:137
int UnlinkFile(const std::string &f_name, bool fail_if_open)
Remove cinfo and data files from cache.
Definition XrdPfc.cc:1187
static XrdScheduler * schedP
Definition XrdPfc.hh:290
ResourceMonitor & RefResMon()
Definition XrdPfc.hh:285
File * GetNextFileToPrefetch()
Definition XrdPfc.cc:732
long long WritesSinceLastCall()
Definition XrdPfc.cc:320
void ProcessWriteTasks()
Separate task which writes blocks from ram to disk.
Definition XrdPfc.cc:273
virtual int Unlink(const char *url)
Definition XrdPfc.cc:1177
void RemoveWriteQEntriesFor(File *f)
Remove blocks from write queue which belong to given prefetch. This method is used at the time of Fil...
Definition XrdPfc.cc:240
virtual XrdOucCacheIO * Attach(XrdOucCacheIO *, int Options=0)
Definition XrdPfc.cc:179
static const Cache & TheOne()
Definition XrdPfc.cc:133
PurgePin * GetPurgePin() const
Definition XrdPfc.hh:272
XrdOss * GetOss() const
Definition XrdPfc.hh:268
static bool VCheck(XrdVersionInfo &urVersion)
Version check.
Definition XrdPfc.hh:233
char * RequestRAM(long long size)
Definition XrdPfc.cc:331
virtual int Prepare(const char *url, int oflags, mode_t mode)
Definition XrdPfc.cc:1065
bool DecideIfConsideredCached(long long file_size, long long bytes_on_disk)
Definition XrdPfc.cc:966
static Cache & CreateInstance(XrdSysLogger *logger, XrdOucEnv *env)
Singleton creation.
Definition XrdPfc.cc:125
XrdSysError * GetLog()
Definition XrdPfc.hh:282
void ScheduleFileSync(File *f)
Definition XrdPfc.hh:278
Base cache-io class that implements some XrdOucCacheIO abstract methods.
Definition XrdPfcIO.hh:16
Base class for reguesting directory space to obtain.
@ CSChk_Cache
Contains parameters configurable from the xrootd config file.
Definition XrdPfc.hh:64
long long m_hdfsbsize
used with m_hdfsmode, default 128MB
Definition XrdPfc.hh:115
long long m_RamAbsAvailable
available from configuration
Definition XrdPfc.hh:109
long long m_flushCnt
nuber of unsynced blcoks on disk before flush is called
Definition XrdPfc.hh:116
int m_accHistorySize
max number of entries in access history part of cinfo file
Definition XrdPfc.hh:100
bool does_cschk_have_missing_bits(CkSumCheck_e cks_on_file) const
Definition XrdPfc.hh:80
int m_wqueue_threads
number of threads writing blocks to disk
Definition XrdPfc.hh:112
long long m_diskTotalSpace
total disk space on configured partition or oss space
Definition XrdPfc.hh:91
long long m_fileUsageMax
cache purge - files usage maximum
Definition XrdPfc.hh:96
long long m_fileUsageBaseline
cache purge - files usage baseline
Definition XrdPfc.hh:94
int m_dirStatsStoreDepth
depth to which statistics should be collected
Definition XrdPfc.hh:106
bool m_allow_xrdpfc_command
flag for enabling access to /xrdpfc-command/ functionality.
Definition XrdPfc.hh:85
bool is_purge_plugin_set_up() const
Definition XrdPfc.hh:71
long long m_diskUsageHWM
cache purge - disk usage high water mark
Definition XrdPfc.hh:93
bool is_cschk_cache() const
Definition XrdPfc.hh:75
std::set< std::string > m_dirStatsDirGlobs
directory globs for which stat reporting was requested
Definition XrdPfc.hh:103
CkSumCheck_e get_cs_Chk() const
Definition XrdPfc.hh:73
bool is_uvkeep_purge_in_effect() const
Definition XrdPfc.hh:69
int m_prefetch_max_blocks
maximum number of blocks to prefetch per file
Definition XrdPfc.hh:113
bool are_file_usage_limits_set() const
Definition XrdPfc.hh:67
bool is_cschk_any() const
Definition XrdPfc.hh:77
bool m_cs_ChkTLS
Allow TLS.
Definition XrdPfc.hh:120
long long m_fileUsageNominal
cache purge - files usage nominal
Definition XrdPfc.hh:95
int m_cs_Chk
Checksum check.
Definition XrdPfc.hh:119
bool should_uvkeep_purge(time_t delta) const
Definition XrdPfc.hh:82
int m_purgeAgeBasedPeriod
peform cold file / uvkeep purge every this many purge cycles
Definition XrdPfc.hh:99
bool m_hdfsmode
flag for enabling block-level operation
Definition XrdPfc.hh:84
int m_purgeColdFilesAge
purge files older than this age
Definition XrdPfc.hh:98
std::string m_data_space
oss space for data files
Definition XrdPfc.hh:88
bool is_cschk_both() const
Definition XrdPfc.hh:78
std::set< std::string > m_dirStatsDirs
directories for which stat reporting was requested
Definition XrdPfc.hh:102
long long m_diskUsageLWM
cache purge - disk usage low water mark
Definition XrdPfc.hh:92
int m_RamKeepStdBlocks
number of standard-sized blocks kept after release
Definition XrdPfc.hh:110
long long m_bufferSize
prefetch buffer size, default 1MB
Definition XrdPfc.hh:108
int m_dirStatsInterval
time between resource monitor statistics dump in seconds
Definition XrdPfc.hh:104
std::string m_meta_space
oss space for metadata files (cinfo)
Definition XrdPfc.hh:89
int m_wqueue_blocks
maximum number of blocks written per write-queue loop
Definition XrdPfc.hh:111
bool is_age_based_purge_in_effect() const
Definition XrdPfc.hh:68
std::string m_username
username passed to oss plugin
Definition XrdPfc.hh:87
bool is_cschk_net() const
Definition XrdPfc.hh:76
double m_onlyIfCachedMinFrac
minimum fraction of downloaded file, used by only-if-cached CGI option
Definition XrdPfc.hh:123
time_t m_cs_UVKeep
unverified checksum cache keep
Definition XrdPfc.hh:118
int m_dirStatsMaxDepth
maximum depth for statistics write out
Definition XrdPfc.hh:105
int m_purgeInterval
sleep interval between cache purges
Definition XrdPfc.hh:97
long long m_onlyIfCachedMinSize
minumum size of downloaded file, used by only-if-cached CGI option
Definition XrdPfc.hh:122
bool is_dir_stat_reporting_on() const
Definition XrdPfc.hh:70
MutexHolder(MOO &m)
Definition XrdPfc.hh:51
std::string m_diskUsageLWM
Definition XrdPfc.hh:130
std::string m_diskUsageHWM
Definition XrdPfc.hh:131
std::string m_fileUsageBaseline
Definition XrdPfc.hh:132
std::string m_fileUsageNominal
Definition XrdPfc.hh:133
std::string m_flushRaw
Definition XrdPfc.hh:135
std::string m_fileUsageMax
Definition XrdPfc.hh:134