xrootd
XrdFileCache.hh
Go to the documentation of this file.
1 #ifndef __XRDFILECACHE_CACHE_HH__
2 #define __XRDFILECACHE_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 <set>
23 
24 #include "Xrd/XrdScheduler.hh"
25 #include "XrdVersion.hh"
26 #include "XrdSys/XrdSysPthread.hh"
27 #include "XrdOuc/XrdOucCache2.hh"
28 #include "XrdOuc/XrdOucCallBack.hh"
29 #include "XrdCl/XrdClDefaultEnv.hh"
30 #include "XrdFileCacheFile.hh"
31 #include "XrdFileCacheDecision.hh"
32 
33 class XrdOucStream;
34 class XrdSysError;
35 class XrdSysTrace;
36 
37 namespace XrdCl {
38 class Log;
39 }
40 namespace XrdFileCache {
41 class File;
42 class IO;
43 }
44 
45 
46 namespace XrdFileCache
47 {
48 //----------------------------------------------------------------------------
50 //----------------------------------------------------------------------------
52 {
54  m_hdfsmode(false),
56  m_data_space("public"),
57  m_meta_space("public"),
58  m_diskTotalSpace(-1),
59  m_diskUsageLWM(-1),
60  m_diskUsageHWM(-1),
63  m_fileUsageMax(-1),
64  m_purgeInterval(300),
67  m_bufferSize(1024*1024),
69  m_NRamBuffers(-1),
71  m_hdfsbsize(128*1024*1024),
72  m_flushCnt(100)
73  {}
74 
75  bool are_file_usage_limits_set() const { return m_fileUsageMax > 0; }
77  bool is_purge_plugin_set_up() const { return false; }
78 
79  void calculate_fractional_usages(long long du, long long fu, double &frac_du, double &frac_fu);
80 
81  bool m_hdfsmode;
83 
84  std::string m_username;
85  std::string m_data_space;
86  std::string m_meta_space;
87 
88  long long m_diskTotalSpace;
89  long long m_diskUsageLWM;
90  long long m_diskUsageHWM;
91  long long m_fileUsageBaseline;
92  long long m_fileUsageNominal;
93  long long m_fileUsageMax;
97 
98  long long m_bufferSize;
99  long long m_RamAbsAvailable;
102 
103  long long m_hdfsbsize;
104  long long m_flushCnt;
105 };
106 
108 {
109  std::string m_diskUsageLWM;
110  std::string m_diskUsageHWM;
111  std::string m_fileUsageBaseline;
112  std::string m_fileUsageNominal;
113  std::string m_fileUsageMax;
114  std::string m_flushRaw;
115 
117  m_diskUsageLWM("0.90"), m_diskUsageHWM("0.95"),
118  m_flushRaw("100")
119  {}
120 };
121 
122 //----------------------------------------------------------------------------
124 //----------------------------------------------------------------------------
125 class Cache : public XrdOucCache2
126 {
127 public:
128  //---------------------------------------------------------------------
130  //---------------------------------------------------------------------
131  Cache(XrdSysLogger *logger);
132 
133  //---------------------------------------------------------------------
135  //---------------------------------------------------------------------
136  using XrdOucCache2::Attach;
137 
138  virtual XrdOucCacheIO2 *Attach(XrdOucCacheIO2 *, int Options = 0);
139 
140  //---------------------------------------------------------------------
142  //---------------------------------------------------------------------
143  virtual int isAttached();
144 
145  //---------------------------------------------------------------------
146  // Virtual function of XrdOucCache2. Used to pass environmental info.
147  virtual void EnvInfo(XrdOucEnv &theEnv);
148 
149  //---------------------------------------------------------------------
150  // Virtual function of XrdOucCache2. Used for redirection to a local
151  // file on a distributed FS.
152  virtual int LocalFilePath(const char *url, char *buff=0, int blen=0,
153  LFP_Reason why=ForAccess);
154 
155  //---------------------------------------------------------------------
156  // Virtual function of XrdOucCache2. Used for deferred open.
157  virtual int Prepare(const char *url, int oflags, mode_t mode);
158 
159  // virtual function of XrdOucCache2::Stat()
160  virtual int Stat(const char *url, struct stat &sbuff);
161 
162  //--------------------------------------------------------------------
168  //--------------------------------------------------------------------
169  bool Decide(XrdOucCacheIO*);
170 
171  //------------------------------------------------------------------------
173  //------------------------------------------------------------------------
174  const Configuration& RefConfiguration() const { return m_configuration; }
175 
176  //---------------------------------------------------------------------
183  //---------------------------------------------------------------------
184  bool Config(const char *config_filename, const char *parameters);
185 
186  //---------------------------------------------------------------------
188  //---------------------------------------------------------------------
189  static Cache &CreateInstance(XrdSysLogger *logger);
190 
191  //---------------------------------------------------------------------
193  //---------------------------------------------------------------------
194  static Cache &GetInstance();
195 
196  //---------------------------------------------------------------------
198  //---------------------------------------------------------------------
199  static bool VCheck(XrdVersionInfo &urVersion) { return true; }
200 
201  //---------------------------------------------------------------------
203  //---------------------------------------------------------------------
204  void Purge();
205 
206  //---------------------------------------------------------------------
208  //---------------------------------------------------------------------
209  void AddWriteTask(Block* b, bool from_read);
210 
211  //---------------------------------------------------------------------
214  //---------------------------------------------------------------------
215  void RemoveWriteQEntriesFor(File *f);
216 
217  //---------------------------------------------------------------------
219  //---------------------------------------------------------------------
220  void ProcessWriteTasks();
221 
222  bool RequestRAMBlock();
223 
224  void RAMBlockReleased();
225 
226  void RegisterPrefetchFile(File*);
228 
230 
231  void Prefetch();
232 
233  XrdOss* GetOss() const { return m_output_fs; }
234 
235  bool IsFileActiveOrPurgeProtected(const std::string&);
236 
237  File* GetFile(const std::string&, IO*, long long off = 0, long long filesize = 0);
238 
239  void ReleaseFile(File*, IO*);
240 
241  void ScheduleFileSync(File* f) { schedule_file_sync(f, false, false); }
242 
243  void FileSyncDone(File*, bool high_debug);
244 
245  XrdSysError* GetLog() { return &m_log; }
246  XrdSysTrace* GetTrace() { return m_trace; }
247 
248  void ExecuteCommandUrl(const std::string& command_url);
249 
250 private:
251  bool ConfigParameters(std::string, XrdOucStream&, TmpConfiguration &tmpc);
252  bool ConfigXeq(char *, XrdOucStream &);
253  bool xdlib(XrdOucStream &);
254  bool xtrace(XrdOucStream &);
255 
256  bool cfg2bytes(const std::string &str, long long &store, long long totalSpace, const char *name);
257 
258  static Cache *m_factory;
260 
263  const char *m_traceID;
264 
267 
268  std::vector<XrdFileCache::Decision*> m_decisionpoints;
269 
270  std::map<std::string, long long> m_filesInQueue;
271 
273 
276 
279  bool m_isClient;
280 
281  struct WriteQ
282  {
284 
286  size_t size;
287  std::list<Block*> queue;
289  };
290 
292 
293  // active map, purge delay set
294  typedef std::map<std::string, File*> ActiveMap_t;
295  typedef ActiveMap_t::iterator ActiveMap_i;
296  typedef std::set<std::string> FNameSet_t;
297 
302 
303  void inc_ref_cnt(File*, bool lock, bool high_debug);
304  void dec_ref_cnt(File*, bool high_debug);
305 
306  void schedule_file_sync(File*, bool ref_cnt_already_set, bool high_debug);
307 
308  // prefetching
309  typedef std::vector<File*> PrefetchList;
311 };
312 
313 }
314 
315 #endif
Definition: XrdFileCache.hh:281
bool Config(const char *config_filename, const char *parameters)
Parse configuration file.
virtual XrdOucCacheIO2 * Attach(XrdOucCacheIO2 *, int Options=0)
WriteQ()
Definition: XrdFileCache.hh:283
File * GetNextFileToPrefetch()
void calculate_fractional_usages(long long du, long long fu, double &frac_du, double &frac_fu)
virtual int isAttached()
Number of cache-io objects atteched through this cache.
void FileSyncDone(File *, bool high_debug)
std::string m_diskUsageHWM
Definition: XrdFileCache.hh:110
Definition: XrdOucCache2.hh:196
XrdSysTrace * GetTrace()
Definition: XrdFileCache.hh:246
virtual int Prepare(const char *url, int oflags, mode_t mode)
long long m_diskTotalSpace
total disk space on configured partition or oss space
Definition: XrdFileCache.hh:88
std::string m_diskUsageLWM
Definition: XrdFileCache.hh:109
XrdSysError m_log
XrdFileCache namespace logger.
Definition: XrdFileCache.hh:261
int m_prefetch_max_blocks
maximum number of blocks to prefetch per file
Definition: XrdFileCache.hh:101
Definition: XrdFileCache.hh:40
Configuration m_configuration
configurable parameters
Definition: XrdFileCache.hh:272
int m_purgeColdFilesAge
purge files older than this age
Definition: XrdFileCache.hh:95
bool Decide(XrdOucCacheIO *)
Makes decision if the original XrdOucCacheIO should be cached.
long long m_fileUsageNominal
cache purge - files usage nominal
Definition: XrdFileCache.hh:92
ActiveMap_t::iterator ActiveMap_i
Definition: XrdFileCache.hh:295
int m_purgeInterval
sleep interval between cache purges
Definition: XrdFileCache.hh:94
void ProcessWriteTasks()
Separate task which writes blocks from ram to disk.
Definition: XrdOucCache2.hh:290
const Configuration & RefConfiguration() const
Reference XrdFileCache configuration.
Definition: XrdFileCache.hh:174
long long m_diskUsageHWM
cache purge - disk usage high water mark
Definition: XrdFileCache.hh:90
Definition: XrdOucCache.hh:127
long long m_diskUsageLWM
cache purge - disk usage low water mark
Definition: XrdFileCache.hh:89
Definition: XrdFileCacheFile.hh:59
Definition: XrdOucStream.hh:45
TmpConfiguration()
Definition: XrdFileCache.hh:116
long long m_fileUsageMax
cache purge - files usage maximum
Definition: XrdFileCache.hh:93
bool ConfigXeq(char *, XrdOucStream &)
bool xtrace(XrdOucStream &)
bool cfg2bytes(const std::string &str, long long &store, long long totalSpace, const char *name)
bool m_hdfsmode
flag for enabling block-level operation
Definition: XrdFileCache.hh:81
virtual int Stat(const char *url, struct stat &sbuff)
std::string m_username
username passed to oss plugin
Definition: XrdFileCache.hh:84
XrdSysTrace * m_trace
Definition: XrdFileCache.hh:262
bool ConfigParameters(std::string, XrdOucStream &, TmpConfiguration &tmpc)
PrefetchList m_prefetchList
Definition: XrdFileCache.hh:310
std::vector< File * > PrefetchList
Definition: XrdFileCache.hh:309
WriteQ m_writeQ
Definition: XrdFileCache.hh:291
std::map< std::string, File * > ActiveMap_t
Definition: XrdFileCache.hh:294
Definition: XrdSysError.hh:89
const char * m_traceID
Definition: XrdFileCache.hh:263
long long writes_between_purges
upper bound on amount of bytes written between two purge passes
Definition: XrdFileCache.hh:288
Definition: XrdSysTrace.hh:48
std::string m_fileUsageNominal
Definition: XrdFileCache.hh:112
Definition: XrdScheduler.hh:44
Definition: XrdSysPthread.hh:165
size_t size
cache size of a container
Definition: XrdFileCache.hh:286
Base cache-io class that implements XrdOucCacheIO abstract methods.
Definition: XrdFileCacheIO.hh:16
virtual void EnvInfo(XrdOucEnv &theEnv)
virtual XrdOucCacheIO2 * Attach(XrdOucCacheIO2 *ioP, int opts=0)=0
bool IsFileActiveOrPurgeProtected(const std::string &)
void inc_ref_cnt(File *, bool lock, bool high_debug)
static bool VCheck(XrdVersionInfo &urVersion)
Version check.
Definition: XrdFileCache.hh:199
bool is_age_based_purge_in_effect() const
Definition: XrdFileCache.hh:76
void ExecuteCommandUrl(const std::string &command_url)
std::string m_meta_space
oss space for metadata files (cinfo)
Definition: XrdFileCache.hh:86
static Cache & CreateInstance(XrdSysLogger *logger)
Singleton creation.
int m_RAMblocks_used
Definition: XrdFileCache.hh:278
void Purge()
Thread function running disk cache purge periodically.
Definition: XrdSysPthread.hh:78
XrdOucCacheStats m_stats
Definition: XrdFileCache.hh:265
Definition: XrdOucCache2.hh:62
long long m_RamAbsAvailable
available from configuration
Definition: XrdFileCache.hh:99
ActiveMap_t m_active
Definition: XrdFileCache.hh:298
Definition: XrdOucEnv.hh:41
Definition: XrdClAnyObject.hh:25
bool xdlib(XrdOucStream &)
void RemoveWriteQEntriesFor(File *f)
Remove blocks from write queue which belong to given prefetch. This method is used at the time of Fil...
XrdOss * m_output_fs
disk cache file system
Definition: XrdFileCache.hh:266
bool m_in_purge
Definition: XrdFileCache.hh:300
Contains parameters configurable from the xrootd config file.
Definition: XrdFileCache.hh:51
static Cache & GetInstance()
Singleton access.
void RegisterPrefetchFile(File *)
std::string m_fileUsageMax
Definition: XrdFileCache.hh:113
FNameSet_t m_purge_delay_set
Definition: XrdFileCache.hh:299
std::vector< XrdFileCache::Decision * > m_decisionpoints
decision plugins
Definition: XrdFileCache.hh:268
File * GetFile(const std::string &, IO *, long long off=0, long long filesize=0)
bool m_allow_xrdpfc_command
flag for enabling access to /xrdpfc-command/ functionality.
Definition: XrdFileCache.hh:82
bool m_prefetch_enabled
set to true when prefetching is enabled
Definition: XrdFileCache.hh:275
Definition: XrdSysLogger.hh:52
Definition: XrdFileCacheFile.hh:133
std::string m_flushRaw
Definition: XrdFileCache.hh:114
XrdSysError * GetLog()
Definition: XrdFileCache.hh:245
long long m_flushCnt
nuber of unsynced blcoks on disk before flush is called
Definition: XrdFileCache.hh:104
std::string m_data_space
oss space for data files
Definition: XrdFileCache.hh:85
XrdSysCondVar m_prefetch_condVar
lock for vector of prefetching files
Definition: XrdFileCache.hh:274
#define stat(a, b)
Definition: XrdPosix.hh:96
Configuration()
Definition: XrdFileCache.hh:53
Cache(XrdSysLogger *logger)
Constructor.
XrdSysCondVar condVar
write list condVar
Definition: XrdFileCache.hh:285
void AddWriteTask(Block *b, bool from_read)
Add downloaded block in write queue.
bool are_file_usage_limits_set() const
Definition: XrdFileCache.hh:75
Definition: XrdOss.hh:173
int m_NRamBuffers
number of total in-memory cache blocks, cached
Definition: XrdFileCache.hh:100
Definition: XrdOucCacheStats.hh:40
LFP_Reason
Definition: XrdOucCache2.hh:290
int m_purgeColdFilesPeriod
peform cold file purge every this many purge cycles
Definition: XrdFileCache.hh:96
virtual int LocalFilePath(const char *url, char *buff=0, int blen=0, LFP_Reason why=ForAccess)
XrdSysCondVar m_active_cond
Definition: XrdFileCache.hh:301
std::map< std::string, long long > m_filesInQueue
Definition: XrdFileCache.hh:270
std::list< Block * > queue
container
Definition: XrdFileCache.hh:287
XrdSysMutex m_RAMblock_mutex
lock for allcoation of RAM blocks
Definition: XrdFileCache.hh:277
static Cache * m_factory
this object
Definition: XrdFileCache.hh:258
bool m_isClient
True if running as client.
Definition: XrdFileCache.hh:279
Definition: XrdFileCache.hh:107
void DeRegisterPrefetchFile(File *)
void ReleaseFile(File *, IO *)
std::string m_fileUsageBaseline
Definition: XrdFileCache.hh:111
XrdOss * GetOss() const
Definition: XrdFileCache.hh:233
std::set< std::string > FNameSet_t
Definition: XrdFileCache.hh:296
Attaches/creates and detaches/deletes cache-io objects for disk based cache.
Definition: XrdFileCache.hh:125
bool is_purge_plugin_set_up() const
Definition: XrdFileCache.hh:77
static XrdScheduler * schedP
Definition: XrdFileCache.hh:259
void ScheduleFileSync(File *f)
Definition: XrdFileCache.hh:241
void schedule_file_sync(File *, bool ref_cnt_already_set, bool high_debug)
long long m_fileUsageBaseline
cache purge - files usage baseline
Definition: XrdFileCache.hh:91
long long m_bufferSize
prefetch buffer size, default 1MB
Definition: XrdFileCache.hh:98
void dec_ref_cnt(File *, bool high_debug)
long long m_hdfsbsize
used with m_hdfsmode, default 128MB
Definition: XrdFileCache.hh:103