XrdOfsCksFile.hh

Go to the documentation of this file.

#ifndef _XRDOFSCKSFILE_H
#define _XRDOFSCKSFILE_H
/******************************************************************************/
/*                                                                            */
/*                      X r d O f s C k s F i l e . h h                       */
/*                                                                            */
/* (c) 2026 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* 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 Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
#include <cstdint>
#include <map>
 
#include "XrdOss/XrdOssWrapper.hh"
#include "XrdSys/XrdSysPthread.hh"
 
class  XrdCks;
class  XrdCksCalc;
class  XrdOucEnv;
class  XrdSfsAio;
class  XrdSysLogger;
 
class XrdOfsCksFile : public XrdOssWrapDF
{
public:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
int     Close(long long* retsz=0) override;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
int     Ftruncate(unsigned long long flen) override;
 
//-----------------------------------------------------------------------------
// Perform one time initialization
//
// @param cp - Pointer to checksum manager.
// @param ep - Pointer to the environment.
//-----------------------------------------------------------------------------
 
static
void    Init(XrdCks* cp, XrdOucEnv* ep);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
int     Open(const char* path, int Oflag, mode_t Mode, XrdOucEnv& env)
             override;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
ssize_t pgWrite(void* buffer, off_t offset, size_t wrlen,
                        uint32_t* csvec, uint64_t opts) override;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
int     pgWrite(XrdSfsAio* aioparm, uint64_t opts) override;
 
//-----------------------------------------------------------------------------
// Set the reread buffer size
//
// @param sz - The desired size of the buffer.
//-----------------------------------------------------------------------------
 
static
void    setRDSZ(int sz) {sz = ((sz/65536) + (sz%65536 != 0)) * 65536;
                         if (sz > 2*1024*1024) ioBlen = 2*1024*1024;
                            else ioBlen = sz;
                        }
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
ssize_t Write(const void* buffer, off_t offset, size_t size) override;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
int     Write(XrdSfsAio* aiop) override;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
ssize_t WriteV(XrdOucIOVec *writeV, int wrvcnt) override;
 
         XrdOfsCksFile(const char* tid, const char* path, XrdOssDF* df,
                       XrdCksCalc*  cP, bool& delFlag);
 
virtual ~XrdOfsCksFile();
 
private:
 
const char* RTC_CB32(const void* inBuff, off_t inoff, int inLen);
const char* RTC_NCXX(const void* inBuff, off_t inoff, int inLen);
const char* RTC_Updt(off_t inoff, int inLen);
 
const char* (XrdOfsCksFile::*ProcessRTC)(const void*, off_t, int);
 
XrdSysMutex cksMtx;
const char* tident;
      char* fPath;          // Valid throughout object lifetime
XrdOssDF*   ossDF;          // Underlying dir/file object
XrdCksCalc* calcP;
const char* cksName;
XrdCksCalc* altcP;
bool&       viaDel;
off_t       nextOff;
void*       ioBuff;
static
inline int  ioBlen = 1024*1024; // 1 MB default buffer size when needed
 
struct      inSeg
           {off_t       segBeg;
            int         segLen;
            uint32_t    segCks; // adler32 or crc...
 
            inSeg(off_t newOff, int newLen, uint32_t newCks)
                    : segBeg(newOff), segLen(newLen), segCks(newCks) {}
           ~inSeg() {}
           };
 
std::map<off_t, inSeg> segMap;
 
bool        Dirty;
};
#endif