XrdPssDir Class Reference

#include <XrdPss.hh>

Inheritance diagram for XrdPssDir:

Collaboration diagram for XrdPssDir:

Public Member Functions
	XrdPssDir (const char *tid)
	~XrdPssDir ()
int	Close (long long *retsz=0) override
bool	getErrMsg (std::string &eText) override
int	Opendir (const char *, XrdOucEnv &) override
int	Readdir (char *buff, int blen) override
int	StatRet (struct stat *buf) override
Public Member Functions inherited from XrdOssDF
	XrdOssDF (const char *tid="", uint16_t dftype=0, int fdnum=-1)
virtual	~XrdOssDF ()
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 ssize_t	ReadRaw (void *buffer, off_t offset, size_t size)
virtual ssize_t	ReadV (XrdOucIOVec *readV, int rdvcnt)
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)

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 XrdOssDF
uint16_t	dfType
int	fd
off_t	pgwEOF
short	rsvd
const char *	tident

Detailed Description

Definition at line 51 of file XrdPss.hh.

Constructor & Destructor Documentation

XrdPssDir()

XrdPssDir::XrdPssDir ( const char *  tid )

inline

Definition at line 67 of file XrdPss.hh.

                 : XrdOssDF(tid, XrdOssDF::DF_isDir|XrdOssDF::DF_isProxy),
                   myDir(0), lastEtrc(0) {}

~XrdPssDir()

XrdPssDir::~XrdPssDir ( )

inline

Definition at line 71 of file XrdPss.hh.

{if (myDir) Close();}

References Close().

Here is the call graph for this function:

Member Function Documentation

Close()

int XrdPssDir::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).

Implements XrdOssDF.

Definition at line 824 of file XrdPss.cc.

{
   DIR *theDir;
 
// Close the directory proper if it exists. POSIX specified that directory
// stream is no longer available after closedir() regardless if return value.
//
   if ((theDir = myDir))
      {myDir = 0;
       if (XrdPosixXrootd::Closedir(theDir))
          {int rc = errno;
           lastEtrc = XrdPosixXrootd::QueryError(lastEtext);
           return -rc;
          }
       return XrdOssOK;
      }
 
// Directory is not open
//
   return -XRDOSS_E8002;
}

References XrdPosixXrootd::Closedir(), XrdPosixXrootd::QueryError(), XRDOSS_E8002, and XrdOssOK.

Referenced by ~XrdPssDir().

Here is the call graph for this function:

Here is the caller graph for this function:

getErrMsg()

bool XrdPssDir::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 XrdOssDF.

Definition at line 850 of file XrdPss.cc.

{
// Return what we have but make sure to reset whatever we have
//
   if (lastEtrc <= 0 || lastEtext.empty()) return false;
   eText = lastEtext;
   lastEtext.clear();
   lastEtrc = 0;
   return true;
}

Opendir()

int XrdPssDir::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 XrdOssDF.

Definition at line 719 of file XrdPss.cc.

{
   EPNAME("Opendir");
   int rc;
   char pbuff[PBsz];
 
// Return an error if this object is already open
//
   if (myDir) return -XRDOSS_E8001;
 
// Open directories are not supported for object id's
//
   if (*dir_path != '/') return -ENOTSUP;
 
// Setup url info
//
   XrdPssUrlInfo uInfo(&Env, dir_path);
   uInfo.setID();
 
// Convert path to URL
//
   if ((rc = XrdPssSys::P2URL(pbuff, PBsz, uInfo, XrdPssSys::xLfn2Pfn)))
      return rc;
 
// Do some tracing
//
  if(DEBUGON) {
    auto urlObf = obfuscateAuth(pbuff);
    DEBUG(uInfo.Tident(),"url="<<urlObf);
  }
 
// Open the directory
//
   myDir = XrdPosixXrootd::Opendir(pbuff);
   if (!myDir)
      {rc = -errno;
       lastEtrc = XrdPosixXrootd::QueryError(lastEtext);
       return rc;
      }
   return XrdOssOK;
}

References DEBUG, DEBUGON, EPNAME, obfuscateAuth(), XrdPosixXrootd::Opendir(), XrdPssSys::P2URL(), XrdProxy::PBsz, XrdPosixXrootd::QueryError(), XrdPssUrlInfo::setID(), XrdPssUrlInfo::Tident(), XrdPssSys::xLfn2Pfn, XRDOSS_E8001, and XrdOssOK.

Here is the call graph for this function:

Readdir()

int XrdPssDir::Readdir ( char *  buff, int  blen  )

overridevirtual

Get the next directory entry.

Parameters

buff	- Pointer to buffer where a null terminated string of the entry name is to be returned. If no more entries exist, a null string is returned.
blen	- Length of the buffer.

Returns

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

Reimplemented from XrdOssDF.

Definition at line 780 of file XrdPss.cc.

{
// Check if we are directly reading the directory
//
   if (myDir)
      {dirent *entP, myEnt;
       int    rc = XrdPosixXrootd::Readdir_r(myDir, &myEnt, &entP);
       if (rc)
          {lastEtrc = XrdPosixXrootd::QueryError(lastEtext, myDir);
           return -rc;
          }
       if (!entP) *buff = 0;
          else strlcpy(buff, myEnt.d_name, blen);
       return XrdOssOK;
      }
 
// The directory is not open
//
   return -XRDOSS_E8002;
}

References XrdPosixXrootd::QueryError(), XrdPosixXrootd::Readdir_r(), strlcpy(), XRDOSS_E8002, and XrdOssOK.

Here is the call graph for this function:

StatRet()

int XrdPssDir::StatRet ( struct stat *  buff )

overridevirtual

Set the stat() buffer where stat information is to be placed corresponding to the directory entry returned by Readdir().

Parameters

buff	- Pointer to stat structure to be used.

Returns

0 upon success or -ENOTSUP if not supported.

Note

This is a one-time call as stat structure is reused for each Readdir.

When StatRet() is in effect, directory entries that have been deleted from the target directory are quietly skipped.

Reimplemented from XrdOssDF.

Definition at line 804 of file XrdPss.cc.

{
   if (!myDir) return -XRDOSS_E8002;
 
   auto rc = XrdPosixXrootd::StatRet(myDir, buff);
   if (rc) return -rc;
   return XrdOssOK;
}

References XrdPosixXrootd::StatRet(), XRDOSS_E8002, and XrdOssOK.

Here is the call graph for this function:

---

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

• XrdPss.hh
• XrdPss.cc