XrdOssArcFile Class Reference

#include <XrdOssArcFile.hh>

Inheritance diagram for XrdOssArcFile:

Collaboration diagram for XrdOssArcFile:

Public Member Functions
	XrdOssArcFile (const char *tident, XrdOssDF *df)
virtual	~XrdOssArcFile ()
int	Close (long long *retsz=0) override
int	Fstat (struct stat *buf) override
bool	getErrMsg (std::string &eText) override
int	Open (const char *path, int Oflag, mode_t Mode, XrdOucEnv &env) override
ssize_t	Read (off_t offset, size_t size) override
ssize_t	Read (void *buffer, off_t offset, size_t size) override
ssize_t	Write (const void *buffer, off_t offset, size_t size) override
Public Member Functions inherited from XrdOssWrapDF
	XrdOssWrapDF (XrdOssDF &df2Wrap)
virtual	~XrdOssWrapDF ()
virtual int	Clone (const std::vector< XrdOucCloneSeg > &cVec)
virtual int	Clone (XrdOssDF &srcFile)
uint16_t	DFType ()
virtual int	Fchmod (mode_t mode)
virtual int	Fctl (int cmd, int alen, const char *args, char **resp=0)
virtual void	Flush ()
	Flush filesystem cached pages for this file (used for checksums). More...
virtual int	Fsync ()
virtual int	Fsync (XrdSfsAio *aiop)
virtual int	Ftruncate (unsigned long long flen)
virtual int	getFD ()
virtual off_t	getMmap (void **addr)
virtual const char *	getTID ()
virtual int	isCompressed (char *cxidp=0)
virtual int	Opendir (const char *path, XrdOucEnv &env)
virtual ssize_t	pgRead (void *buffer, off_t offset, size_t rdlen, uint32_t *csvec, uint64_t opts)
virtual int	pgRead (XrdSfsAio *aioparm, uint64_t opts)
virtual ssize_t	pgWrite (void *buffer, off_t offset, size_t wrlen, uint32_t *csvec, uint64_t opts)
virtual int	pgWrite (XrdSfsAio *aioparm, uint64_t opts)
virtual ssize_t	Read (XrdOucRangeList &rlist)
virtual int	Read (XrdSfsAio *aiop)
virtual int	Readdir (char *buff, int blen)
virtual ssize_t	ReadRaw (void *buffer, off_t offset, size_t size)
virtual ssize_t	ReadV (XrdOucIOVec *readV, int rdvcnt)
virtual int	StatRet (struct stat *Stat)
virtual int	Write (XrdSfsAio *aiop)
virtual ssize_t	WriteV (XrdOucIOVec *writeV, int wrvcnt)
Public Member Functions inherited from XrdOssDF
	XrdOssDF (const char *tid="", uint16_t dftype=0, int fdnum=-1)
virtual	~XrdOssDF ()
uint16_t	DFType ()

Additional Inherited Members
Static Public Attributes inherited from XrdOssDF
static const uint16_t	DF_isDir = 0x0001
	Object is for a directory. More...
static const uint16_t	DF_isFile = 0x0002
	Object is for a file. More...
static const uint16_t	DF_isProxy = 0x0010
	Object is a proxy object. More...
static const uint64_t	doCalc = 0x4000000000000000ULL
	pgw: Calculate checksums More...
static const int	Fctl_ckpObj = 0
static const int	Fctl_QFinfo = 3
static const int	Fctl_setFD = 2
static const int	Fctl_utimes = 1
static const uint64_t	Verify = 0x8000000000000000ULL
	all: Verify checksums More...
Protected Attributes inherited from XrdOssWrapDF
XrdOssDF &	wrapDF
Protected Attributes inherited from XrdOssDF
uint16_t	dfType
int	fd
off_t	pgwEOF
short	rsvd
const char *	tident

Detailed Description

Definition at line 39 of file XrdOssArcFile.hh.

Constructor & Destructor Documentation

XrdOssArcFile()

XrdOssArcFile::XrdOssArcFile ( const char *  tident, XrdOssDF *  df  )

inline

Definition at line 130 of file XrdOssArcFile.hh.

                             : XrdOssWrapDF(*df), ossDF(df) {}

~XrdOssArcFile()

XrdOssArcFile::~XrdOssArcFile ( )

virtual

Definition at line 75 of file XrdOssArcFile.cc.

{   delete ossDF;
    if (zFile) delete zFile;
}

Member Function Documentation

Close()

int XrdOssArcFile::Close ( long long *  retsz = 0 )

overridevirtual

Close file.

Parameters

retsz

If not nil, where the size of the file is to be returned.

Returns

0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssWrapDF.

Definition at line 84 of file XrdOssArcFile.cc.

{
   int rc;
 
// Issue close to possible zipfile appendage and delete it. The underlying
// oss did not open the file, so we do not issue a close to that. 
//
   if (zFile) 
      {rc = zFile->Close();
       if (retsz) *retsz = 0;
       delete zFile;
       zFile = 0;
      } else rc = ossDF->Close(retsz);
 
// All done
//
   return rc;
}

Fstat()

int XrdOssArcFile::Fstat ( struct stat *  buf )

overridevirtual

Return state information for this file.

Parameters

buf	- Pointer to the structure where info it to be returned.

Returns

0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssWrapDF.

Definition at line 107 of file XrdOssArcFile.cc.

{
// Check if we should forward this call  
//
   if (zFile == 0) return ossDF->Fstat(buf);
 
// Obtain stat for the archive file member
//
   return zFile->Stat(*buf);
}

getErrMsg()

bool XrdOssArcFile::getErrMsg ( std::string &  eText )

overridevirtual

Obtain detailed error message text for the immediately preceeding directory or file error (see also XrdOss::getErrMsg()).

Parameters

eText

- Where the message text is to be returned.

Returns

True if message text is available, false otherwise.

Note

This method should be called using the same thread that encountered the error; otherwise, missleading error text may be returned.

Upon return, the internal error message text is cleared.

Reimplemented from XrdOssWrapDF.

Definition at line 122 of file XrdOssArcFile.cc.

{
// Return any extened error mesage associated with this thread
//
   if (ecMsg.hasMsg())
      {std::string xMsg;
       if (ossDF->getErrMsg(xMsg))
          {ecMsg.Append();
           ecMsg.Msg("oss", xMsg.c_str());
          }
       ecMsg.Get(eText);
       return true;
      }
   return ossDF->getErrMsg(eText);
}

References XrdOucECMsg::Append(), XrdOssArcGlobals::ecMsg, XrdOucECMsg::Get(), XrdOucECMsg::hasMsg(), and XrdOucECMsg::Msg().

Here is the call graph for this function:

Open()

int XrdOssArcFile::Open ( const char *  path, int  Oflag, mode_t  Mode, XrdOucEnv &  env  )

overridevirtual

Open a file.

Parameters

path	- Pointer to the path of the file to be opened.
Oflag	- Standard open flags.
Mode	- File open mode (ignored unless creating a file).
env	- Reference to environmental information.

Returns

0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssWrapDF.

Definition at line 142 of file XrdOssArcFile.cc.

{
   int rc, arcFD;
   bool isRW = (Oflag & (O_APPEND|O_CREAT|O_TRUNC|O_WRONLY|O_RDWR)) != 0; 
 
// Check what we should be doing here. Options are:
// a) Forward open to underlying storage system (not our path),
// b) Handle and error,
// c) Open an actual arvhive, or
// d) Open a file inside an archive.
//
   XrdOssArcCompose dsInfo(path, &env, rc, isRW);
 
   if (rc == EDOM) return ossDF->Open(path, Oflag, Mode, env);
   if (rc != 0)    return -rc;
 
// We will be doing a MSS orinted restore. This is subject to pausing.
// So, we must run under the control of the stop monitor.
//
   XrdOssArcStopMon stopMon(Config.stopMon);
 
// Whether this is a request for an archve or a file in the archive, we
// need to bring the archive file online. We do this first.
//
   char arcPath[MAXPATHLEN];
   if ((rc = dsInfo.ArcPath(arcPath, sizeof(arcPath), true))) return -rc;
   if ((rc = XrdOssArcStage::Stage(arcPath, arcPath+Config.tapePathLEN)))
      {if (rc == EINPROGRESS) return Config.wtpStage;
       return -rc;
      }
 
// If this was a request for the actual archive file, then open it and promote
// the open to the underlying file system as it will handle all I/O.
//
   if (dsInfo.didType == XrdOssArcCompose::isARC)
      {if ((arcFD = XrdSysFD_Open(arcPath, O_RDONLY, Mode)) < 0)
          {rc = errno;
           Elog.Emsg("open", rc, "open", arcPath);
           return -rc;
          }
       rc = ossDF->Fctl(XrdOssDF::Fctl_setFD,sizeof(int),(const char*)&arcFD);
       if (rc)
          {Elog.Emsg("open", rc, "promote open", arcPath);
           close(arcFD);
           return Neg(rc);
          }
       return XrdOssOK;
      }
 
// Create the name of the archive member in the archive file
//
   char arcMember[MAXPATHLEN];
   if ((rc = dsInfo.ArcMember(arcMember, sizeof(arcMember)))) return -rc;
 
// This is a request for a particular file. Get a zip file object and open it.
//
   zFile = new XrdOssArcZipFile(arcPath, rc);
 
// Open the member in the archive if possibe
//
   if (!rc) rc = zFile->Open(arcMember);
 
// Diagnose any errors
//
   if (rc)
      {Elog.Emsg("open", rc, "open archive", path);
       ecMsg.Msg("open", "Unable to access member", arcMember, "in archive",
                         arcPath);
       delete zFile; zFile = 0;
       return Neg(rc);
      }
   return 0;
}

References XrdOssArcCompose::ArcMember(), XrdOssArcCompose::ArcPath(), close, XrdOssArcGlobals::Config, XrdOssArcCompose::didType, XrdOssArcGlobals::ecMsg, XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdOssDF::Fctl_setFD, XrdOssArcCompose::isARC, Mode, XrdOucECMsg::Msg(), Neg, XrdOssArcStage::Stage(), XrdOssArcConfig::stopMon, XrdOssArcConfig::tapePathLEN, XrdOssArcConfig::wtpStage, and XrdOssOK.

Here is the call graph for this function:

Read() [1/2]

ssize_t XrdOssArcFile::Read ( off_t  offset, size_t  size  )

inlineoverridevirtual

Preread file blocks into the file system cache.

Parameters

offset	- The offset where the read is to start.
size	- The number of bytes to pre-read.

Returns

0 upon success or -errno or -osserr (see XrdOssError.hh).

Reimplemented from XrdOssWrapDF.

Definition at line 102 of file XrdOssArcFile.hh.

{return 0;}

Read() [2/2]

ssize_t XrdOssArcFile::Read ( void *  buffer, off_t  offset, size_t  size  )

overridevirtual

Read file bytes into a buffer.

Parameters

buffer	- pointer to buffer where the bytes are to be placed.
offset	- The offset where the read is to start.
size	- The number of bytes to read.

Returns

>= 0 The number of bytes that placed in buffer.

< 0 -errno or -osserr upon failure (see XrdOssError.hh).

Reimplemented from XrdOssWrapDF.

Definition at line 220 of file XrdOssArcFile.cc.

{
// Execute read based on what kind of file we currently have
//
   if (zFile) return zFile->Read(buffer, offset, size);
   return ossDF->Read(buffer, offset, size);
}

Write()

ssize_t XrdOssArcFile::Write ( const void *  buffer, off_t  offset, size_t  size  )

overridevirtual

Write file bytes from a buffer.

Parameters

buffer	- pointer to buffer where the bytes reside.
offset	- The offset where the write is to start.
size	- The number of bytes to write.

Returns

>= 0 The number of bytes that were written.

< 0 -errno or -osserr upon failure (see XrdOssError.hh).

Reimplemented from XrdOssWrapDF.

Definition at line 234 of file XrdOssArcFile.cc.

{
// Execute read based on what kind of file we currently have
//
   if (zFile) return -EBADF;
   return ossDF->Write(buffer, offset, size);
}

---

The documentation for this class was generated from the following files:

• XrdOssArcFile.hh
• XrdOssArcFile.cc