XrdOssArcDir Class Reference

#include <XrdOssArcDir.hh>

Inheritance diagram for XrdOssArcDir:

Collaboration diagram for XrdOssArcDir:

Public Member Functions
	XrdOssArcDir (const char *tident, XrdOssDF *df)
virtual	~XrdOssArcDir ()
int	Close (long long *retsz=0) override
bool	getErrMsg (std::string &eText) override
int	Opendir (const char *path, XrdOucEnv &env) 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	Fstat (struct stat *buf)
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	Open (const char *path, int Oflag, mode_t Mode, 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 (off_t offset, size_t size)
virtual ssize_t	Read (void *buffer, off_t offset, size_t size)
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 ssize_t	Write (const void *buffer, off_t offset, size_t size)
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 XrdOssArcDir.hh.

Constructor & Destructor Documentation

XrdOssArcDir()

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

inline

Definition at line 84 of file XrdOssArcDir.hh.

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

~XrdOssArcDir()

XrdOssArcDir::~XrdOssArcDir ( )

virtual

Definition at line 68 of file XrdOssArcDir.cc.

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

Member Function Documentation

Close()

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

overridevirtual

Close a directory or 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 77 of file XrdOssArcDir.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;
}

getErrMsg()

bool XrdOssArcDir::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 100 of file XrdOssArcDir.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:

Opendir()

int XrdOssArcDir::Opendir ( const char *  path, XrdOucEnv &  env  )

overridevirtual

Open a directory.

Parameters

path	- Pointer to the path of the directory to be opened.
env	- Reference to environmental information.

Returns

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

Reimplemented from XrdOssWrapDF.

Definition at line 120 of file XrdOssArcDir.cc.

{
   TraceInfo("Opendir", ossDF->getTID());
   int rc, arcFD;
 
// Construct a minimal information object
//
   XrdOssArcCompose dsInfo(path, 0, rc, false);
 
// If this is not out path, forward it along
//
   if (rc == EDOM) return ossDF->Opendir(path, env);
 
// We don't support directory listings for backup paths
//
   if (dsInfo.didType == XrdOssArcCompose::isBKP) return EPERM;
 
// 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)))
      {Elog.Emsg("opendir", rc, "instantiate path", arcPath);
       return -rc;
      }
 
// Open the directory
//
   DEBUG("Dir="<<arcPath);
   if ((arcFD = XrdSysFD_Open(arcPath, O_RDONLY)) < 0)
      {rc = errno;
       Elog.Emsg("opendir", rc, "open directory", arcPath);
       return -rc;
      }
 
// We now promote the newly opened directory to the wrapped directory
// object as it will handle all of the directory methods. We just do the open
// to bypass all of the name2name mapping.
//
    rc = ossDF->Fctl(XrdOssDF::Fctl_setFD,sizeof(int),(const char*)&arcFD);
    if (rc)
       {Elog.Emsg("opendir", rc, "promote open of", arcPath);
        close(arcFD);
        return Neg(rc);
       }
 
// All done
//
   return XrdOssOK;
}

References XrdOssArcCompose::ArcPath(), close, DEBUG, XrdOssArcCompose::didType, XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdOssDF::Fctl_setFD, XrdOssArcCompose::isBKP, Neg, TraceInfo, and XrdOssOK.

Here is the call graph for this function:

---

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

• XrdOssArcDir.hh
• XrdOssArcDir.cc