#include <XrdPosixPrepIO.hh>

Inheritance diagram for XrdPosixPrepIO:

Collaboration diagram for XrdPosixPrepIO:

Public Member Functions
	XrdPosixPrepIO (XrdPosixFile *fP, XrdCl::OpenFlags::Flags clflags, XrdCl::Access::Mode clmode)
virtual	~XrdPosixPrepIO ()
bool	Detach (XrdOucCacheIOCD &cdP)
void	Disable ()
int	Fcntl (XrdOucCacheOp::Code opc, const std::string &args, std::string &resp)
long long	FSize ()
int	Fstat (struct stat &buf)
int	Open ()
const char *	Path ()
int	Read (char *Buffer, long long Offset, int Length)
void	Read (XrdOucCacheIOCB &iocb, char *buff, long long offs, int rlen)
int	ReadV (const XrdOucIOVec *readV, int n)
void	ReadV (XrdOucCacheIOCB &iocb, const XrdOucIOVec *readV, int rnum)
int	Sync ()
void	Sync (XrdOucCacheIOCB &iocb)
int	Trunc (long long Offset)
int	Write (char *Buffer, long long Offset, int Length)
void	Write (XrdOucCacheIOCB &iocb, char *buff, long long offs, int wlen)
Public Member Functions inherited from XrdOucCacheIO
	XrdOucCacheIO ()
	Construct and Destructor.
virtual const char *	Location (bool refresh=false)
virtual int	pgRead (char buff, long long offs, int rdlen, std::vector< uint32_t > &csvec, uint64_t opts=0, int csfix=0)
virtual void	pgRead (XrdOucCacheIOCB &iocb, char buff, long long offs, int rdlen, std::vector< uint32_t > &csvec, uint64_t opts=0, int csfix=0)
virtual int	pgWrite (char buff, long long offs, int wrlen, std::vector< uint32_t > &csvec, uint64_t opts=0, int csfix=0)
virtual void	pgWrite (XrdOucCacheIOCB &iocb, char buff, long long offs, int wrlen, std::vector< uint32_t > &csvec, uint64_t opts=0, int csfix=0)
virtual void	Preread (aprParms &Parms)
virtual void	Preread (long long offs, int rlen, int opts=0)
virtual void	Preread (XrdOucRangeList &rlist)
virtual void	Trunc (XrdOucCacheIOCB &iocb, long long offs)
virtual void	Update (XrdOucCacheIO &iocp)
virtual int	WriteV (const XrdOucIOVec *writV, int wnum)
virtual void	WriteV (XrdOucCacheIOCB &iocb, const XrdOucIOVec *writV, int wnum)

Additional Inherited Members
Static Public Attributes inherited from XrdOucCacheIO
static const uint64_t	forceCS = 0x0000000000000001ULL
static const int	SingleUse = 0x0001
	Mark pages for single use.
Protected Member Functions inherited from XrdOucCacheIO
virtual	~XrdOucCacheIO ()

Detailed Description

Definition at line 38 of file XrdPosixPrepIO.hh.

Constructor & Destructor Documentation

◆ XrdPosixPrepIO()

XrdPosixPrepIO::XrdPosixPrepIO	(	XrdPosixFile *	fP,
		XrdCl::OpenFlags::Flags	clflags,
		XrdCl::Access::Mode	clmode )

inline

Definition at line 93 of file XrdPosixPrepIO.hh.

95 : fileP(fP), openRC(0), iCalls(0),

96 clFlags(clflags), clMode(clmode) {}

◆ ~XrdPosixPrepIO()

virtual XrdPosixPrepIO::~XrdPosixPrepIO ( )

inlinevirtual

Definition at line 97 of file XrdPosixPrepIO.hh.

97{}

Member Function Documentation

◆ Detach()

bool XrdPosixPrepIO::Detach ( XrdOucCacheIOCD & iocd )

inlinevirtual

Detach this CacheIO object from the cache.

Note: This method must be called instead of using the delete operator since CacheIO objects may have multiple outstanding references and actual deletion may need to be deferred.

Parameters

iocd	reference to the detach complete callback object.

Returns: true Deletion can occur immediately. There is no outstanding I/O.; false Deletion must be deferred until it is safe to so from the cache perspective. At which point, the cache will call the DetachDone() method in the passed callback object. No locks may be held with respect to the CacheIO object when this is done to avoid deadlocks.

Implements XrdOucCacheIO.

Definition at line 42 of file XrdPosixPrepIO.hh.

42{(void)cdP; return true;}

◆ Disable()

void XrdPosixPrepIO::Disable ( )

Definition at line 51 of file XrdPosixPrepIO.cc.

{
   EPNAME("PrepIODisable");
   XrdPosixObjGuard objGuard(fileP);
 
   if(DEBUGON) {
     DEBUG("Disabling deferred open " << obfuscateAuth(fileP->Origin()));
   }
 
   openRC = -ESHUTDOWN;
}

References DEBUG, DEBUGON, EPNAME, and obfuscateAuth().

Here is the call graph for this function:

◆ Fcntl()

int XrdPosixPrepIO::Fcntl	(	XrdOucCacheOp::Code	opc,
		const std::string &	args,
		std::string &	resp )

inlinevirtual

Issue a special file control operation (synchronous).

Parameters

opc	The operation code (one of the enums).
args	The argument as required by opc.
resp	Where the response is to be placed.

Returns: 0 upon success or -errno upon failure.

Reimplemented from XrdOucCacheIO.

Definition at line 46 of file XrdPosixPrepIO.hh.

48 {return (Init() ? fileP->Fcntl(opc, args, resp) : openRC);}

◆ FSize()

long long XrdPosixPrepIO::FSize ( )

inlinevirtual

Obtain size of the file.

Returns: Size of the file in bytes.

Implements XrdOucCacheIO.

Definition at line 50 of file XrdPosixPrepIO.hh.

50{return (Init() ? fileP->FSize() : openRC);}

◆ Fstat()

int XrdPosixPrepIO::Fstat ( struct stat & sbuff )

inlinevirtual

Perform an fstat() operation (defaults to passthrough).

Parameters

sbuff reference to the stat buffer to be filled in. Only fields st_size, st_blocks, st_mtime (st_atime and st_ctime may be set to st_mtime), st_ino, and st_mode need to be set. All other fields are preset and should not be changed.

Returns: <0 - fstat failed, value is -errno. =0 - fstat succeeded, sbuff holds stat information. >0 - fstat could not be done, forward operation to next level.

Reimplemented from XrdOucCacheIO.

Definition at line 52 of file XrdPosixPrepIO.hh.

53 {return (Init() ? fileP->Fstat(buf) : openRC);}

References stat.

◆ Open()

int XrdPosixPrepIO::Open ( )

inline

Definition at line 55 of file XrdPosixPrepIO.hh.

55{Init(); return openRC;}

◆ Path()

const char * XrdPosixPrepIO::Path ( )

inlinevirtual

Get the path associated with this object.

Returns: Pointer to the path.

Implements XrdOucCacheIO.

Definition at line 57 of file XrdPosixPrepIO.hh.

57{return fileP->Path();}

◆ Read() [1/2]

int XrdPosixPrepIO::Read	(	char *	buff,
		long long	offs,
		int	rlen )

inlinevirtual

Perform an synchronous read.

Parameters

buff	pointer to the buffer to receive the results. The buffer must remain valid until the callback is invoked.
offs	the offset into the file.
rlen	the number of bytes to read.

Returns: < 0 - Read failed, value is -errno. >=0 - Read succeeded, value is number of bytes read.

Implements XrdOucCacheIO.

Definition at line 59 of file XrdPosixPrepIO.hh.

60 {return (Init() ? fileP->Read(Buffer, Offset, Length) : openRC);}

◆ Read() [2/2]

void XrdPosixPrepIO::Read	(	XrdOucCacheIOCB &	iocb,
		char *	buff,
		long long	offs,
		int	rlen )

inlinevirtual

Perform an asynchronous read (defaults to synchronous).

Parameters

iocb	reference to the callback object that receives the result. All results are returned via this object's Done() method. If the caller holds any locks they must be recursive locks as the callback may occur on the calling thread.
buff	pointer to the buffer to receive the results. The buffer must remain valid until the callback is invoked.
offs	the offset into the file.
rlen	the number of bytes to read.

Reimplemented from XrdOucCacheIO.

Definition at line 62 of file XrdPosixPrepIO.hh.

                 {if (Init(&iocb)) fileP->Read(iocb, buff, offs, rlen);
                     else iocb.Done(openRC);
                 }

References XrdOucCacheIOCB::Done().

Here is the call graph for this function:

◆ ReadV() [1/2]

int XrdPosixPrepIO::ReadV	(	const XrdOucIOVec *	readV,
		int	rnum )

inlinevirtual

Perform an synchronous vector read.

Parameters

readV	pointer to a vector of read requests.
rnum	the number of elements in the vector.

Returns: < 0 - ReadV failed, value is -errno. >=0 - ReadV succeeded, value is number of bytes read.

Reimplemented from XrdOucCacheIO.

Definition at line 67 of file XrdPosixPrepIO.hh.

68 {return (Init() ? fileP->ReadV(readV, n) : openRC);}

◆ ReadV() [2/2]

void XrdPosixPrepIO::ReadV	(	XrdOucCacheIOCB &	iocb,
		const XrdOucIOVec *	readV,
		int	rnum )

inlinevirtual

Perform an asynchronous vector read (defaults to synchronous).

Parameters

iocb	reference to the callback object that receives the result. All results are returned via this object's Done() method. If the caller holds any locks they must be recursive locks as the callback may occur on the calling thread.
readV	pointer to a vector of read requests.
rnum	the number of elements in the vector.

Reimplemented from XrdOucCacheIO.

Definition at line 70 of file XrdPosixPrepIO.hh.

                 {if (Init(&iocb)) fileP->ReadV(iocb, readV, rnum);
                     else iocb.Done(openRC);
                 }

References XrdOucCacheIOCB::Done().

Here is the call graph for this function:

◆ Sync() [1/2]

int XrdPosixPrepIO::Sync ( )

inlinevirtual

Perform an synchronous sync() operation.

Returns: <0 - Sync failed, value is -errno. =0 - Sync succeeded.

Implements XrdOucCacheIO.

Definition at line 75 of file XrdPosixPrepIO.hh.

75{return (Init() ? fileP->Sync() : openRC);}

◆ Sync() [2/2]

void XrdPosixPrepIO::Sync ( XrdOucCacheIOCB & iocb )

inlinevirtual

Perform an asynchronous sync() operation (defaults to synchronous).

Parameters

iocb	reference to the callback object that receives the result. All results are returned via this object's Done() method. If the caller holds any locks they must be recursive locks as the callback may occur on the calling thread.

Reimplemented from XrdOucCacheIO.

Definition at line 77 of file XrdPosixPrepIO.hh.

                 {if (Init(&iocb)) fileP->Sync(iocb);
                     else iocb.Done(openRC);
                 }

References XrdOucCacheIOCB::Done().

Here is the call graph for this function:

◆ Trunc()

int XrdPosixPrepIO::Trunc ( long long offs )

inlinevirtual

Perform an synchronous trunc() operation.

Parameters

offs	the size the file is have.

Returns: <0 - Trunc failed, value is -errno. =0 - Trunc succeeded.

Implements XrdOucCacheIO.

Definition at line 82 of file XrdPosixPrepIO.hh.

83 {return (Init() ? fileP->Trunc(Offset) : openRC);}

◆ Write() [1/2]

int XrdPosixPrepIO::Write	(	char *	buff,
		long long	offs,
		int	wlen )

inlinevirtual

Perform an synchronous write.

Parameters

buff	pointer to the buffer holding the contents. The buffer must remain valid until the callback is invoked.
offs	the offset into the file.
wlen	the number of bytes to write

Returns: < 0 - Write failed, value is -errno. >=0 - Write succeeded, value is number of bytes written.

Implements XrdOucCacheIO.

Definition at line 85 of file XrdPosixPrepIO.hh.

86 {return (Init() ? fileP->Write(Buffer,Offset,Length) : openRC);}

◆ Write() [2/2]

void XrdPosixPrepIO::Write	(	XrdOucCacheIOCB &	iocb,
		char *	buff,
		long long	offs,
		int	wlen )

inlinevirtual

Perform an asynchronous write (defaults to synchronous).

Parameters

iocb	reference to the callback object that receives the result. All results are returned via this object's Done() method. If the caller holds any locks they must be recursive locks as the callback may occur on the calling thread.
buff	pointer to the buffer holding the contents. The buffer must remain valid until the callback is invoked.
offs	the offset into the file.
wlen	the number of bytes to write

Reimplemented from XrdOucCacheIO.

Definition at line 88 of file XrdPosixPrepIO.hh.

                 {if (Init(&iocb)) fileP->Write(iocb, buff, offs, wlen);
                     else iocb.Done(openRC);
                 }

References XrdOucCacheIOCB::Done().

Here is the call graph for this function:

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

	XRootD

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XrdPosixPrepIO()

◆ ~XrdPosixPrepIO()

Member Function Documentation

◆ Detach()

◆ Disable()

◆ Fcntl()

◆ FSize()

◆ Fstat()

◆ Open()

◆ Path()

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadV() [1/2]

◆ ReadV() [2/2]

◆ Sync() [1/2]

◆ Sync() [2/2]

◆ Trunc()

◆ Write() [1/2]

◆ Write() [2/2]