XrdPfc.hh

Go to the documentation of this file.

#ifndef __XRDPFC_CACHE_HH__
#define __XRDPFC_CACHE_HH__
//----------------------------------------------------------------------------------
// Copyright (c) 2014 by Board of Trustees of the Leland Stanford, Jr., University
// Author: Alja Mrak-Tadel, Matevz Tadel, Brian Bockelman
//----------------------------------------------------------------------------------
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD is distributed in the hope that it will be useful,
// but WITHOUT ANY emacs WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//----------------------------------------------------------------------------------
#include <string>
#include <list>
#include <map>
#include <set>
 
#include "Xrd/XrdScheduler.hh"
#include "XrdVersion.hh"
#include "XrdSys/XrdSysPthread.hh"
#include "XrdOuc/XrdOucCache.hh"
#include "XrdOuc/XrdOucCallBack.hh"
#include "XrdCl/XrdClDefaultEnv.hh"
 
#include "XrdPfcFile.hh"
#include "XrdPfcDecision.hh"
 
class XrdOucStream;
class XrdSysError;
class XrdSysTrace;
class XrdXrootdGStream;
 
namespace XrdPfc
{
class File;
class IO;
 
class DataFsState;
}
 
 
namespace XrdPfc
{
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
struct Configuration
{
   Configuration();
 
   bool are_file_usage_limits_set()    const { return m_fileUsageMax > 0; }
   bool is_age_based_purge_in_effect() const { return m_purgeColdFilesAge > 0 ; }
   bool is_uvkeep_purge_in_effect()    const { return m_cs_UVKeep >= 0; }
   bool is_dir_stat_reporting_on()     const { return m_dirStatsMaxDepth >= 0 || ! m_dirStatsDirs.empty() || ! m_dirStatsDirGlobs.empty(); }
   bool is_purge_plugin_set_up()       const { return false; }
 
   void calculate_fractional_usages(long long du, long long fu, double &frac_du, double &frac_fu);
 
   CkSumCheck_e get_cs_Chk() const { return (CkSumCheck_e) m_cs_Chk; }
 
   bool is_cschk_cache() const { return m_cs_Chk & CSChk_Cache; }
   bool is_cschk_net()   const { return m_cs_Chk & CSChk_Net;   }
   bool is_cschk_any()   const { return m_cs_Chk & CSChk_Both;  }
   bool is_cschk_both()  const { return (m_cs_Chk & CSChk_Both) == CSChk_Both; }
 
   bool does_cschk_have_missing_bits(CkSumCheck_e cks_on_file) const { return m_cs_Chk & ~cks_on_file; }
 
   bool should_uvkeep_purge(time_t delta) const { return m_cs_UVKeep >= 0 && delta > m_cs_UVKeep; }
 
   bool m_hdfsmode;                     
   bool m_allow_xrdpfc_command;         
 
   std::string m_username;              
   std::string m_data_space;            
   std::string m_meta_space;            
 
   long long m_diskTotalSpace;          
   long long m_diskUsageLWM;            
   long long m_diskUsageHWM;            
   long long m_fileUsageBaseline;       
   long long m_fileUsageNominal;        
   long long m_fileUsageMax;            
   int       m_purgeInterval;           
   int       m_purgeColdFilesAge;       
   int       m_purgeAgeBasedPeriod;     
   int       m_accHistorySize;          
 
   std::set<std::string> m_dirStatsDirs;     
   std::set<std::string> m_dirStatsDirGlobs; 
   int       m_dirStatsMaxDepth;        
   int       m_dirStatsStoreDepth;      
 
   long long m_bufferSize;              
   long long m_RamAbsAvailable;         
   int       m_RamKeepStdBlocks;        
   int       m_wqueue_blocks;           
   int       m_wqueue_threads;          
   int       m_prefetch_max_blocks;     
 
   long long m_hdfsbsize;               
   long long m_flushCnt;                
 
   time_t    m_cs_UVKeep;               
   int       m_cs_Chk;                  
   bool      m_cs_ChkTLS;               
};
 
//------------------------------------------------------------------------------
 
struct TmpConfiguration
{
   std::string m_diskUsageLWM;
   std::string m_diskUsageHWM;
   std::string m_fileUsageBaseline;
   std::string m_fileUsageNominal;
   std::string m_fileUsageMax;
   std::string m_flushRaw;
 
   TmpConfiguration() :
      m_diskUsageLWM("0.90"), m_diskUsageHWM("0.95"),
      m_flushRaw("")
   {}
};
 
//==============================================================================
 
struct SplitParser
{
   char       *f_str;
   const char *f_delim;
   char       *f_state;
   bool        f_first;
 
   SplitParser(const std::string &s, const char *d) :
      f_str(strdup(s.c_str())), f_delim(d), f_state(0), f_first(true)
   {}
   ~SplitParser() { free(f_str); }
 
   char* get_token()
   {
      if (f_first) { f_first = false; return strtok_r(f_str, f_delim, &f_state); }
      else         { return strtok_r(0, f_delim, &f_state); }
   }
 
   char* get_reminder_with_delim()
   {
      if (f_first) { return f_str; }
      else         { *(f_state - 1) = f_delim[0]; return f_state - 1; }
   }
 
   char *get_reminder()
   {
      return f_first ? f_str : f_state;
   }
 
   int fill_argv(std::vector<char*> &argv)
   {
      if (!f_first) return 0;
      int dcnt = 0; { char *p = f_str; while (*p) { if (*(p++) == f_delim[0]) ++dcnt; } }
      argv.reserve(dcnt + 1);
      int argc = 0;
      char *i = strtok_r(f_str, f_delim, &f_state);
      while (i)
      {
         ++argc;
         argv.push_back(i);
         // printf("  arg %d : '%s'\n", argc, i);
         i = strtok_r(0, f_delim, &f_state);
      }
      return argc;
   }
};
 
struct PathTokenizer : private SplitParser
{
   std::vector<const char*>  m_dirs;
   const char               *m_reminder;
   int                       m_n_dirs;
 
   PathTokenizer(const std::string &path, int max_depth, bool parse_as_lfn) :
      SplitParser(path, "/"),
      m_reminder (0),
      m_n_dirs   (0)
   {
      // If parse_as_lfn is true store final token into m_reminder, regardless of maxdepth.
      // This assumes the last token is a file name (and full path is lfn, including the file name).
 
      m_dirs.reserve(max_depth);
 
      char *t = 0;
      for (int i = 0; i < max_depth; ++i)
      {
         t = get_token();
         if (t == 0) break;
         m_dirs.emplace_back(t);
      }
      if (parse_as_lfn && *get_reminder() == 0 && ! m_dirs.empty())
      {
         m_reminder = m_dirs.back();
         m_dirs.pop_back();
      }
      else
      {
         m_reminder = get_reminder();
      }
      m_n_dirs = (int) m_dirs.size();
   }
 
   int get_n_dirs()
   {
      return m_n_dirs;
   }
 
   const char *get_dir(int pos)
   {
      if (pos >= m_n_dirs) return 0;
      return m_dirs[pos];
   }
 
   std::string make_path()
   {
      std::string res;
      for (std::vector<const char*>::iterator i = m_dirs.begin(); i != m_dirs.end(); ++i)
      {
         res += "/";
         res += *i;
      }
      if (m_reminder != 0)
      {
         res += "/";
         res += m_reminder;
      }
      return res;
   }
 
   void deboog()
   {
      printf("PathTokenizer::deboog size=%d\n", m_n_dirs);
      for (int i = 0; i < m_n_dirs; ++i)
      {
         printf("   %2d: %s\n", i, m_dirs[i]);
      }
      printf("  rem: %s\n", m_reminder);
   }
};
 
 
//==============================================================================
// Cache
//==============================================================================
 
//----------------------------------------------------------------------------
//----------------------------------------------------------------------------
class Cache : public XrdOucCache
{
public:
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   Cache(XrdSysLogger *logger, XrdOucEnv *env);
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   using XrdOucCache::Attach;
 
   virtual XrdOucCacheIO *Attach(XrdOucCacheIO *, int Options = 0);
 
   //---------------------------------------------------------------------
   // Virtual function of XrdOucCache. Used for redirection to a local
   // file on a distributed FS.
   virtual int LocalFilePath(const char *url, char *buff=0, int blen=0,
                             LFP_Reason why=ForAccess, bool forall=false);
 
   //---------------------------------------------------------------------
   // Virtual function of XrdOucCache. Used for deferred open.
   virtual int  Prepare(const char *url, int oflags, mode_t mode);
 
   // virtual function of XrdOucCache.
   virtual int  Stat(const char *url, struct stat &sbuff);
 
   // virtual function of XrdOucCache.
   virtual int  Unlink(const char *url);
 
   //--------------------------------------------------------------------
   //--------------------------------------------------------------------
   bool Decide(XrdOucCacheIO*);
 
   //------------------------------------------------------------------------
   //------------------------------------------------------------------------
   const Configuration& RefConfiguration() const { return m_configuration; }
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   bool Config(const char *config_filename, const char *parameters);
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   static Cache &CreateInstance(XrdSysLogger *logger, XrdOucEnv *env);
 
  //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   static       Cache         &GetInstance();
   static const Cache         &TheOne();
   static const Configuration &Conf();
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   static bool VCheck(XrdVersionInfo &urVersion) { return true; }
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   void ResourceMonitorHeartBeat();
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   void Purge();
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   int  UnlinkFile(const std::string& f_name, bool fail_if_open);
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   void AddWriteTask(Block* b, bool from_read);
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   void RemoveWriteQEntriesFor(File *f);
 
   //---------------------------------------------------------------------
   //---------------------------------------------------------------------
   void ProcessWriteTasks();
 
   char* RequestRAM(long long size);
   void  ReleaseRAM(char* buf, long long size);
 
   void RegisterPrefetchFile(File*);
   void DeRegisterPrefetchFile(File*);
 
   File* GetNextFileToPrefetch();
 
   void Prefetch();
 
   XrdOss* GetOss() const { return m_oss; }
 
   bool IsFileActiveOrPurgeProtected(const std::string&);
   
   File* GetFile(const std::string&, IO*, long long off = 0, long long filesize = 0);
 
   void  ReleaseFile(File*, IO*);
 
   void ScheduleFileSync(File* f) { schedule_file_sync(f, false, false); }
 
   void FileSyncDone(File*, bool high_debug);
   
   XrdSysError* GetLog()   { return &m_log;  }
   XrdSysTrace* GetTrace() { return m_trace; }
 
   XrdXrootdGStream* GetGStream() { return m_gstream; }
 
   void ExecuteCommandUrl(const std::string& command_url);
 
   static XrdScheduler *schedP;
 
private:
   bool ConfigParameters(std::string, XrdOucStream&, TmpConfiguration &tmpc);
   bool ConfigXeq(char *, XrdOucStream &);
   bool xcschk(XrdOucStream &);
   bool xdlib(XrdOucStream &);
   bool xtrace(XrdOucStream &);
 
   bool cfg2bytes(const std::string &str, long long &store, long long totalSpace, const char *name);
 
   static Cache     *m_instance;        
 
   XrdOucEnv        *m_env;             
   XrdSysError       m_log;             
   XrdSysTrace      *m_trace;
   const char       *m_traceID;
 
   XrdOss           *m_oss;             
 
   XrdXrootdGStream *m_gstream;
 
   std::vector<XrdPfc::Decision*> m_decisionpoints;       
 
   Configuration m_configuration;           
 
   XrdSysCondVar m_prefetch_condVar;        
   bool          m_prefetch_enabled;        
 
   XrdSysMutex m_RAM_mutex;                 
   long long   m_RAM_used;
   long long   m_RAM_write_queue;
   std::list<char*> m_RAM_std_blocks;       
   int              m_RAM_std_size;
 
   bool        m_isClient;                  
 
   struct WriteQ
   {
      WriteQ() : condVar(0), writes_between_purges(0), size(0) {}
 
      XrdSysCondVar     condVar;      
      std::list<Block*> queue;        
      long long         writes_between_purges; 
      int               size;         
   };
 
   WriteQ m_writeQ;
 
   // active map, purge delay set
   typedef std::map<std::string, File*>               ActiveMap_t;
   typedef ActiveMap_t::iterator                      ActiveMap_i;
   typedef std::multimap<std::string, XrdPfc::Stats>  StatsMMap_t;
   typedef StatsMMap_t::iterator                      StatsMMap_i;
   typedef std::set<std::string>                      FNameSet_t;
 
   ActiveMap_t      m_active;             
   StatsMMap_t      m_closed_files_stats;
   FNameSet_t       m_purge_delay_set;
   bool             m_in_purge;
   XrdSysCondVar    m_active_cond;        
 
   void inc_ref_cnt(File*, bool lock, bool high_debug);
   void dec_ref_cnt(File*, bool high_debug);
 
   void schedule_file_sync(File*, bool ref_cnt_already_set, bool high_debug);
 
   // prefetching
   typedef std::vector<File*>  PrefetchList;
   PrefetchList m_prefetchList;
 
   //---------------------------------------------------------------------------
   // Statistics, heart-beat, scan-and-purge
 
   enum ScanAndPurgeThreadState_e { SPTS_Idle, SPTS_Scan, SPTS_Purge, SPTS_Done };
 
   XrdSysCondVar    m_stats_n_purge_cond; 
 
   DataFsState     *m_fs_state;           
 
   int                       m_last_scan_duration;
   int                       m_last_purge_duration;
   ScanAndPurgeThreadState_e m_spt_state;
 
   void copy_out_active_stats_and_update_data_fs_state();
};
 
}
 
#endif