XrdPfcFile.hh

Go to the documentation of this file.

#ifndef __XRDPFC_FILE_HH__
#define __XRDPFC_FILE_HH__
//----------------------------------------------------------------------------------
// Copyright (c) 2014 by Board of Trustees of the Leland Stanford, Jr., University
// Author: Alja Mrak-Tadel, Matevz Tadel
//----------------------------------------------------------------------------------
// 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 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 "XrdPfcTypes.hh"
#include "XrdPfcInfo.hh"
#include "XrdPfcStats.hh"
 
#include "XrdOuc/XrdOucCache.hh"
#include "XrdOuc/XrdOucIOVec.hh"
 
#include <climits>
#include <functional>
#include <list>
#include <map>
#include <set>
#include <string>
 
class XrdJob;
struct XrdOucIOVec;
 
namespace XrdPfc
{
class File;
class BlockResponseHandler;
class DirectResponseHandler;
class IO;
 
struct ReadVBlockListRAM;
struct ReadVChunkListRAM;
struct ReadVBlockListDisk;
struct ReadVChunkListDisk;
 
// Returned by File::Read()/ReadV() when the request is queued and its ReadReqRH will
// be called later.  Must not be a -errno: the former -EWOULDBLOCK equals -EAGAIN on
// Linux, so a read that failed with EAGAIN was mistaken for a pending one.  Not
// INT_MIN itself, so that negating it, as error paths do, stays well defined.
constexpr int kReadPending = INT_MIN + 1;
 
struct ReadReqRH : public XrdOucCacheIOCB
{
   int               m_expected_size = 0;
   int               m_n_chunks = 0; // Only set for ReadV().
   unsigned short    m_seq_id;
   XrdOucCacheIOCB  *m_iocb; // External callback passed into IO::Read().
 
   ReadReqRH(unsigned short sid, XrdOucCacheIOCB *iocb) :
      m_seq_id(sid), m_iocb(iocb)
   {}
};
 
// -------------------------------------------------------------
 
struct ReadRequest
{
   IO         *m_io;
   ReadReqRH  *m_rh; // Internal callback created in IO::Read().
 
   long long   m_bytes_read = 0;
   int         m_error_cond = 0; // to be set to -errno
   int         m_error_count = 0;
   Stats       m_stats;
 
   int         m_n_chunk_reqs = 0;
   bool        m_sync_done    = false;
   bool        m_direct_done  = true;
 
   ReadRequest(IO *io, ReadReqRH *rh) :
      m_io(io), m_rh(rh)
   {}
 
   void update_error_cond(int ec) { ++m_error_count; if (m_error_cond == 0 ) m_error_cond = ec; }
 
   bool is_complete()  const { return m_n_chunk_reqs == 0 && m_sync_done && m_direct_done; }
   int  return_value() const { return m_error_cond ? m_error_cond : m_bytes_read; }
};
 
// -------------------------------------------------------------
 
struct ChunkRequest
{
   ReadRequest *m_read_req;
   char        *m_buf;      // Where to place the data chunk.
   long long    m_off;      // Offset *within* the corresponding block.
   int          m_size;     // Size of the data chunk.
 
   ChunkRequest(ReadRequest *rreq, char *buf, long long off, int size) :
      m_read_req(rreq), m_buf(buf), m_off(off), m_size(size)
   {}
};
 
using vChunkRequest_t = std::vector<ChunkRequest>;
using vChunkRequest_i = std::vector<ChunkRequest>::iterator;
 
// ================================================================
 
class Block
{
public:
   File               *m_file;
   IO                 *m_io;            // IO that handled current request, used for == / != comparisons only
   void               *m_req_id;        // Identity of requestor -- used for stats.
 
   char               *m_buff;
   long long           m_offset;
   int                 m_size;
   int                 m_req_size;
   int                 m_refcnt;
   int                 m_errno;         // stores negative errno
   bool                m_downloaded;
   bool                m_prefetch;
   bool                m_req_cksum_net;
   vCkSum_t            m_cksum_vec;
   int                 m_n_cksum_errors;
 
   vChunkRequest_t     m_chunk_reqs;
 
   Block(File *f, IO *io, void *rid, char *buf, long long off, int size, int rsize,
         bool m_prefetch, bool cks_net) :
      m_file(f), m_io(io), m_req_id(rid),
      m_buff(buf), m_offset(off), m_size(size), m_req_size(rsize),
      m_refcnt(0), m_errno(0), m_downloaded(false), m_prefetch(m_prefetch),
      m_req_cksum_net(cks_net), m_n_cksum_errors(0)
   {}
 
   char*     get_buff()     const { return m_buff;     }
   int       get_size()     const { return m_size;     }
   int       get_req_size() const { return m_req_size; }
   long long get_offset()   const { return m_offset;   }
 
   File* get_file()   const { return m_file;   }
   IO*   get_io()     const { return m_io;     }
   void* get_req_id() const { return m_req_id; }
 
   bool is_finished() const { return m_downloaded || m_errno != 0; }
   bool is_ok()       const { return m_downloaded; }
   bool is_failed()   const { return m_errno != 0; }
 
   void set_downloaded()    { m_downloaded = true; }
   void set_error(int err)  { m_errno      = err;  }
   int  get_error() const   { return m_errno;      }
 
   void reset_error_and_set_io(IO *io, void *rid)
   {
      m_errno  = 0;
      m_io     = io;
      m_req_id = rid;
   }
 
   bool      req_cksum_net() const { return m_req_cksum_net; }
   bool      has_cksums()    const { return ! m_cksum_vec.empty(); }
   vCkSum_t& ref_cksum_vec()       { return m_cksum_vec; }
   int       get_n_cksum_errors()  { return m_n_cksum_errors; }
   int*      ptr_n_cksum_errors()  { return &m_n_cksum_errors; }
};
 
using BlockList_t = std::list<Block*>;
using BlockList_i = std::list<Block*>::iterator;
 
// ================================================================
 
class BlockResponseHandler : public XrdOucCacheIOCB
{
public:
   Block *m_block;
 
   BlockResponseHandler(Block *b) : m_block(b) {}
 
   void Done(int result) override;
};
 
// ----------------------------------------------------------------
 
class DirectResponseHandler : public XrdOucCacheIOCB
{
public:
   XrdSysMutex   m_mutex;
   File         *m_file;
   ReadRequest  *m_read_req;
   int           m_to_wait;
   int           m_bytes_read = 0;
   int           m_errno = 0;
 
   DirectResponseHandler(File *file, ReadRequest *rreq, int to_wait) :
      m_file(file), m_read_req(rreq), m_to_wait(to_wait)
   {}
 
   void Done(int result) override;
};
 
// ================================================================
 
class File
{
   friend class Cache;
   friend class BlockResponseHandler;
   friend class DirectResponseHandler;
public:
   // Constructor, destructor, Open() and Close() are private.
 
   static File* FileOpen(const std::string &path, long long offset, long long fileSize, XrdOucCacheIO *inputIO);
 
   void BlockRemovedFromWriteQ(Block*);
 
   void BlocksRemovedFromWriteQ(std::list<Block*>&);
 
   int Read(IO *io, char* buff, long long offset, int size, ReadReqRH *rh);
 
   int ReadV(IO *io, const XrdOucIOVec *readV, int readVnum, ReadReqRH *rh);
 
   //----------------------------------------------------------------------
   //----------------------------------------------------------------------
   void ioUpdated(IO *io);
 
   //----------------------------------------------------------------------
   //----------------------------------------------------------------------
   bool ioActive(IO *io);
 
   //----------------------------------------------------------------------
   //----------------------------------------------------------------------
   void RequestSyncOfDetachStats();
 
   //----------------------------------------------------------------------
   //----------------------------------------------------------------------
   bool FinalizeSyncBeforeExit();
 
   //----------------------------------------------------------------------
   //----------------------------------------------------------------------
   void Sync();
 
   void WriteBlockToDisk(Block *b);
 
   void Prefetch();
 
   float GetPrefetchScore() const;
 
   const char* lPath() const;
 
   const std::string& GetLocalPath() const { return m_filename; }
 
   XrdSysError* GetLog() const;
   XrdSysTrace* GetTrace() const;
 
   long long GetFileSize() const { return m_file_size; }
 
   void AddIO(IO *io);
   int  GetPrefetchCountOnIO(IO *io);
   void StopPrefetchingOnIO(IO *io);
   void RemoveIO(IO *io);
 
   std::string        GetRemoteLocations()   const;
   const Info::AStat* GetLastAccessStats()   const { return m_cfi.GetLastAccessStats(); }
   size_t             GetAccessCnt()         const { return m_cfi.GetAccessCnt(); }
   int                GetBlockSize()         const { return m_cfi.GetBufferSize(); }
   int                GetNBlocks()           const { return m_cfi.GetNBlocks(); }
   int                GetNDownloadedBlocks() const { return m_cfi.GetNDownloadedBlocks(); }
   long long          GetPrefetchedBytes()   const { return m_prefetch_bytes; }
   const Stats&       RefStats()             const { return m_stats; }
 
   int Fstat(struct stat &sbuff);
 
   // These three methods are called under Cache's m_active lock
   int get_ref_cnt() { return   m_ref_cnt; }
   int inc_ref_cnt() { return ++m_ref_cnt; }
   int dec_ref_cnt() { return --m_ref_cnt; }
 
   long long initiate_emergency_shutdown();
   bool      is_in_emergency_shutdown() { return m_in_shutdown; }
 
private:
   File(const std::string &path, long long offset, long long fileSize);
 
   ~File();
 
   void Close();
 
   bool Open(XrdOucCacheIO *inputIO);
   void parse_pfc_url_args(XrdOucCacheIO *inputIO, long long &pfc_blocksize, int &pfc_prefetch) const;
 
   static const char *m_traceID;
 
   int            m_ref_cnt;            
 
   XrdOssDF      *m_data_file;          
   XrdOssDF      *m_info_file;          
   Info           m_cfi;                
 
   const std::string    m_filename;     
   const long long      m_offset;       
   const long long      m_file_size;    
 
   // IO objects attached to this file.
 
   typedef std::set<IO*>     IoSet_t;
   typedef IoSet_t::iterator IoSet_i;
 
   IoSet_t    m_io_set;
   IoSet_i    m_current_io;     
   int        m_ios_in_detach;  
 
   // FSync
 
   std::vector<int>  m_writes_during_sync;
   int  m_non_flushed_cnt;
   bool m_in_sync;
   bool m_detach_time_logged;
   bool m_in_shutdown;        
 
   // Block state and management
 
   typedef std::list<int>        IntList_t;
   typedef IntList_t::iterator   IntList_i;
 
   typedef std::map<int, Block*> BlockMap_t;
   typedef BlockMap_t::iterator  BlockMap_i;
 
   BlockMap_t    m_block_map;
   XrdSysCondVar m_state_cond;
   long long     m_block_size;
   int           m_num_blocks;
 
   // Stats and ResourceMonitor interface
 
   Stats         m_stats;              
   Stats         m_delta_stats;        
   long long     m_st_blocks;          
   long long     m_resmon_report_threshold;
   int           m_resmon_token;       
 
   void check_delta_stats();
   void report_and_merge_delta_stats();
 
   std::set<std::string> m_remote_locations; 
   void insert_remote_location(const std::string &loc);
 
   // Prefetch
 
   enum PrefetchState_e { kOff=-1, kOn, kHold, kStopped, kComplete };
 
   PrefetchState_e m_prefetch_state;
   int             m_prefetch_max_blocks_in_flight;
 
   long long m_prefetch_bytes;
   int   m_prefetch_read_cnt;
   int   m_prefetch_hit_cnt;
   float m_prefetch_score;              // cached
 
   void inc_prefetch_read_cnt(int prc) { if (prc) { m_prefetch_read_cnt += prc; calc_prefetch_score(); } }
   void inc_prefetch_hit_cnt (int phc) { if (phc) { m_prefetch_hit_cnt  += phc; calc_prefetch_score(); } }
   void calc_prefetch_score() { m_prefetch_score = float(m_prefetch_hit_cnt) / m_prefetch_read_cnt; }
 
   // Helpers
 
   bool overlap(int blk,               // block to query
                long long blk_size,    //
                long long req_off,     // offset of user request
                int req_size,          // size of user request
                // output:
                long long &off,        // offset in user buffer
                long long &blk_off,    // offset in block
                int       &size);
 
   // Read & ReadV
 
   Block* PrepareBlockRequest(int i, IO *io, void *req_id, bool prefetch);
 
   void   ProcessBlockRequest (Block       *b);
   void   ProcessBlockRequests(BlockList_t& blks);
 
   void   RequestBlocksDirect(IO *io, ReadRequest *read_req, std::vector<XrdOucIOVec>& ioVec, int expected_size);
 
   int    ReadBlocksFromDisk(std::vector<XrdOucIOVec>& ioVec, int expected_size);
 
   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);
   void ProcessBlockSuccess(Block *b, ChunkRequest &creq);
   void FinalizeReadRequest(ReadRequest *rreq);
 
   void ProcessBlockResponse(Block *b, int res);
 
   // Block management
 
   void inc_ref_count(Block* b);
   void dec_ref_count(Block* b, int count = 1);
   void free_block(Block*);
 
   bool select_current_io_or_disable_prefetching(bool skip_current);
 
   int  offsetIdx(int idx) const;
};
 
//------------------------------------------------------------------------------
 
inline void File::inc_ref_count(Block* b)
{
   // Method always called under lock.
   b->m_refcnt++;
}
 
//------------------------------------------------------------------------------
 
inline void File::dec_ref_count(Block* b, int count)
{
   // Method always called under lock.
   assert(b->is_finished());
   b->m_refcnt -= count;
   assert(b->m_refcnt >= 0);
 
   if (b->m_refcnt == 0)
   {
      free_block(b);
   }
}
 
}
 
#endif