#include <XrdSfsInterface.hh>
Public Types | |
enum | cpAct { cpCreate = 0, cpDelete, cpRestore } |
Public Member Functions | |
virtual int | open (const char *fileName, XrdSfsFileOpenMode openMode, mode_t createMode, const XrdSecEntity *client=0, const char *opaque=0)=0 |
virtual int | checkpoint (cpAct act, struct iov *range=0, int n=0) |
virtual int | close ()=0 |
virtual int | fctl (const int cmd, const char *args, XrdOucErrInfo &eInfo)=0 |
virtual int | fctl (const int cmd, int alen, const char *args, const XrdSecEntity *client=0) |
virtual const char * | FName ()=0 |
virtual int | getMmap (void **Addr, off_t &Size)=0 |
virtual XrdSfsXferSize | pgRead (XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize rdlen, uint32_t *csvec, uint64_t opts=0) |
virtual int | pgRead (XrdSfsAio *aioparm, uint64_t opts=0) |
virtual XrdSfsXferSize | pgWrite (XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize wrlen, uint32_t *csvec, uint64_t opts=0) |
virtual int | pgWrite (XrdSfsAio *aioparm, uint64_t opts=0) |
virtual XrdSfsXferSize | read (XrdSfsFileOffset offset, XrdSfsXferSize size)=0 |
virtual XrdSfsXferSize | read (XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize size)=0 |
virtual int | read (XrdSfsAio *aioparm)=0 |
virtual XrdSfsXferSize | readv (XrdOucIOVec *readV, int rdvCnt) |
virtual int | SendData (XrdSfsDio *sfDio, XrdSfsFileOffset offset, XrdSfsXferSize size) |
virtual XrdSfsXferSize | write (XrdSfsFileOffset offset, const char *buffer, XrdSfsXferSize size)=0 |
virtual int | write (XrdSfsAio *aioparm)=0 |
virtual XrdSfsXferSize | writev (XrdOucIOVec *writeV, int wdvCnt) |
virtual int | stat (struct stat *buf)=0 |
virtual int | sync ()=0 |
virtual int | sync (XrdSfsAio *aiop)=0 |
virtual int | truncate (XrdSfsFileOffset fsize)=0 |
virtual int | getCXinfo (char cxtype[4], int &cxrsz)=0 |
virtual void | setXio (XrdSfsXio *xioP) |
XrdSfsFile (const char *user=0, int MonID=0) | |
XrdSfsFile (XrdSfsFile &wrapF) | |
XrdSfsFile (XrdOucErrInfo &eInfo) | |
virtual | ~XrdSfsFile () |
Destructor. | |
Public Attributes | |
XrdOucErrInfo & | error |
Static Public Attributes | |
static const uint64_t | Verify = 0x8000000000000000ULL |
Options for pgRead() and pgWrite() as noted below. | |
static const uint64_t | NetOrder = 0x4000000000000000ULL |
all: bytes in/out in net byte order | |
Private Attributes | |
XrdOucErrInfo * | lclEI |
XrdSfsFileOffset | pgwrEOF |
enum XrdSfsFile::cpAct |
Create, delete, query, or rollback a file checkpoint.
act | - The operation to be performed (see cpAct enum below). | |
range | - Portions of the file to be checkpointed. | |
n | - Number of elements in range. |
XrdSfsFile::XrdSfsFile | ( | const char * | user = 0 , |
|
int | MonID = 0 | |||
) | [inline] |
Constructor (user and MonID are the ones passed to newFile()!). This constructor should only be used by base plugins. Plugins that wrap an SfsFile should use the second version of the constructor shown below.
user | - Text identifying the client responsible for this call. The pointer may be null if identification is missing. | |
MonID | - The monitoring identifier assigned to this and all future requests using the returned object. |
XrdSfsFile::XrdSfsFile | ( | XrdSfsFile & | wrapF | ) | [inline] |
Constructor for plugins that wrap another SFS plugin. This constructor inherits the error object from a wrapped XrdSfsFile object so that only one identical error object exists for all file objects in the chain.
wrapF | - Reference to the file object being wrapped. |
XrdSfsFile::XrdSfsFile | ( | XrdOucErrInfo & | eInfo | ) | [inline] |
Constructor for base plugins that predefined an error object. This is a convenience constructor for base plugins only.
eInfo | - Reference to the error object to use. |
virtual XrdSfsFile::~XrdSfsFile | ( | ) | [inline, virtual] |
Destructor.
References lclEI.
virtual int XrdSfsFile::checkpoint | ( | cpAct | act, | |
struct iov * | range = 0 , |
|||
int | n = 0 | |||
) | [virtual] |
Reimplemented in XrdThrottle::File.
virtual int XrdSfsFile::close | ( | ) | [pure virtual] |
Close the file.
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::fctl | ( | const int | cmd, | |
int | alen, | |||
const char * | args, | |||
const XrdSecEntity * | client = 0 | |||
) | [virtual] |
Execute a special operation on the file (version 2)
cmd | - The operation to be performed: SFS_FCTL_SPEC1 Perform implementation defined action | |
alen | - Length of data pointed to by args. | |
args | - Data sent with request, zero if alen is zero. | |
client | - Client's identify (see common description). |
Reimplemented in XrdOfsFile, and XrdSsiFile.
virtual int XrdSfsFile::fctl | ( | const int | cmd, | |
const char * | args, | |||
XrdOucErrInfo & | eInfo | |||
) | [pure virtual] |
Execute a special operation on the file (version 1)
cmd | - The operation to be performed (see below). SFS_FCTL_GETFD Return file descriptor if possible SFS_FCTL_STATV Reserved for future use. | |
args | - specific arguments to cmd SFS_FCTL_GETFD Set to zero. | |
eInfo | - The object where error info or results are to be returned. This is legacy and the error onject may be used as well. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual const char* XrdSfsFile::FName | ( | ) | [pure virtual] |
Get the file path.
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::getCXinfo | ( | char | cxtype[4], | |
int & | cxrsz | |||
) | [pure virtual] |
Get compression information for the file.
cxtype | - Place where the compression algorithm name is to be placed | |
cxrsz | - Place where the compression page size is to be returned |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::getMmap | ( | void ** | Addr, | |
off_t & | Size | |||
) | [pure virtual] |
Get file's memory mapping if one exists (memory mapped files only).
addr | - Place where the starting memory address is returned. | |
size | - Place where the file's size is returned. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::open | ( | const char * | fileName, | |
XrdSfsFileOpenMode | openMode, | |||
mode_t | createMode, | |||
const XrdSecEntity * | client = 0 , |
|||
const char * | opaque = 0 | |||
) | [pure virtual] |
Open a file.
path | - Pointer to the path of the file to be opened. | |
oMode | - Flags indicating how the open is to be handled. SFS_O_CREAT create the file SFS_O_MKPTH Make directory path if missing SFS_O_NOWAIT do not impose operational delays SFS_O_NOTPC do not allow TPC operation SFS_O_POSC persist only on successful close SFS_O_RAWIO allow client-side decompression SFS_O_RDONLY open read/only SFS_O_RDWR open read/write SFS_O_REPLICA Open for replication SFS_O_RESET Reset any cached information SFS_O_TRUNC truncate existing file to zero length SFS_O_WRONLY open write/only | |
cMode | - The file's mode if it will be created. | |
client | - Client's identify (see common description). | |
opaque | - path's CGI information (see common description). |
Implemented in XrdBwmFile, XrdOfsFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::pgRead | ( | XrdSfsAio * | aioparm, | |
uint64_t | opts = 0 | |||
) | [virtual] |
Read file pages and checksums using asynchronous I/O.
aioparm | - Pointer to async I/O object controlling the I/O. | |
opts | - Processing options (see above). |
Reimplemented in XrdThrottle::File.
virtual XrdSfsXferSize XrdSfsFile::pgRead | ( | XrdSfsFileOffset | offset, | |
char * | buffer, | |||
XrdSfsXferSize | rdlen, | |||
uint32_t * | csvec, | |||
uint64_t | opts = 0 | |||
) | [virtual] |
Read file pages into a buffer and return corresponding checksums.
offset | - The offset where the read is to start. It must be page aligned. | |
buffer | - pointer to buffer where the bytes are to be placed. | |
rdlen | - The number of bytes to read. The amount must be an integral number of XrdSfsPage::Size bytes. | |
csvec | - A vector of entries to be filled with the cooresponding CRC32C checksum for each page. It must be size to rdlen/XrdSysPageSize + (rdlenXrdSysPageSize != 0) | |
opts | - Processing options (see above). |
Reimplemented in XrdThrottle::File.
virtual int XrdSfsFile::pgWrite | ( | XrdSfsAio * | aioparm, | |
uint64_t | opts = 0 | |||
) | [virtual] |
Write file pages and checksums using asynchronous I/O.
aioparm | - Pointer to async I/O object controlling the I/O. | |
opts | - Processing options (see above). |
Reimplemented in XrdThrottle::File.
virtual XrdSfsXferSize XrdSfsFile::pgWrite | ( | XrdSfsFileOffset | offset, | |
char * | buffer, | |||
XrdSfsXferSize | wrlen, | |||
uint32_t * | csvec, | |||
uint64_t | opts = 0 | |||
) | [virtual] |
Write file pages into a file with corresponding checksums.
offset | - The offset where the write is to start. It must be page aligned. | |
buffer | - pointer to buffer containing the bytes to write. | |
wrlen | - The number of bytes to write. If amount is not an integral number of XrdSys::PageSize bytes, then this must be the last write to the file at or above the offset. | |
csvec | - A vector which contains the corresponding CRC32 checksum for each page. It must be size to wrlen/XrdSysPageSize + (wrlenXrdSysPageSize != 0) | |
opts | - Processing options (see above). |
Reimplemented in XrdThrottle::File.
virtual int XrdSfsFile::read | ( | XrdSfsAio * | aioparm | ) | [pure virtual] |
Read file bytes using asynchronous I/O.
aioparm | - Pointer to async I/O object controlling the I/O. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual XrdSfsXferSize XrdSfsFile::read | ( | XrdSfsFileOffset | offset, | |
char * | buffer, | |||
XrdSfsXferSize | size | |||
) | [pure virtual] |
Read file bytes into a buffer.
offset | - The offset where the read is to start. | |
buffer | - pointer to buffer where the bytes are to be placed. | |
size | - The number of bytes to read. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual XrdSfsXferSize XrdSfsFile::read | ( | XrdSfsFileOffset | offset, | |
XrdSfsXferSize | size | |||
) | [pure virtual] |
Preread file blocks into the file system cache.
offset | - The offset where the read is to start. | |
size | - The number of bytes to pre-read. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual XrdSfsXferSize XrdSfsFile::readv | ( | XrdOucIOVec * | readV, | |
int | rdvCnt | |||
) | [virtual] |
Given an array of read requests (size rdvCnt), read them from the file and place the contents consecutively in the provided buffer. A dumb default implementation is supplied but should be replaced to increase performance.
readV | pointer to the array of read requests. | |
rdvcnt | the number of elements in readV. |
Reimplemented in XrdDigFile, XrdOfsFile, XrdSfsNativeFile, and XrdSsiFile.
virtual int XrdSfsFile::SendData | ( | XrdSfsDio * | sfDio, | |
XrdSfsFileOffset | offset, | |||
XrdSfsXferSize | size | |||
) | [virtual] |
Send file bytes via a XrdSfsDio sendfile object to a client (optional).
sfDio | - Pointer to the sendfile object for data transfer. | |
offset | - The offset where the read is to start. | |
size | - The number of bytes to read and send. |
Reimplemented in XrdSsiFile, and XrdThrottle::File.
virtual void XrdSfsFile::setXio | ( | XrdSfsXio * | xioP | ) | [inline, virtual] |
Enable exchange buffer I/O for write calls.
- | Pointer to the XrdSfsXio object to be used for buffer exchanges. |
Reimplemented in XrdSsiFile.
virtual int XrdSfsFile::stat | ( | struct stat * | buf | ) | [pure virtual] |
Return state information on the file.
buf | - Pointer to the structure where info it to be returned. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::sync | ( | XrdSfsAio * | aiop | ) | [pure virtual] |
Make sure all outstanding data is actually written to the file (async).
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::sync | ( | ) | [pure virtual] |
Make sure all outstanding data is actually written to the file (sync).
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::truncate | ( | XrdSfsFileOffset | fsize | ) | [pure virtual] |
Truncate the file.
fsize | - The size that the file is to have. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual int XrdSfsFile::write | ( | XrdSfsAio * | aioparm | ) | [pure virtual] |
Write file bytes using asynchronous I/O.
aioparm | - Pointer to async I/O object controlling the I/O. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual XrdSfsXferSize XrdSfsFile::write | ( | XrdSfsFileOffset | offset, | |
const char * | buffer, | |||
XrdSfsXferSize | size | |||
) | [pure virtual] |
Write file bytes from a buffer.
offset | - The offset where the write is to start. | |
buffer | - pointer to buffer where the bytes reside. | |
size | - The number of bytes to write. |
Implemented in XrdBwmFile, XrdDigFile, XrdOfsFile, XrdSfsNativeFile, XrdSsiFile, and XrdThrottle::File.
virtual XrdSfsXferSize XrdSfsFile::writev | ( | XrdOucIOVec * | writeV, | |
int | wdvCnt | |||
) | [virtual] |
Given an array of write requests (size wdvcnt), write them to the file from the provided associated buffer. A dumb default implementation is supplied but should be replaced to increase performance.
writeV | pointer to the array of write requests. | |
wdvcnt | the number of elements in writeV. |
The error object is used to return details whenever something other than SFS_OK is returned from the methods in this class, when noted.
Referenced by XrdSfsFile().
XrdOucErrInfo* XrdSfsFile::lclEI [private] |
Referenced by XrdSfsFile(), and ~XrdSfsFile().
const uint64_t XrdSfsFile::NetOrder = 0x4000000000000000ULL [static] |
all: bytes in/out in net byte order
XrdSfsFileOffset XrdSfsFile::pgwrEOF [private] |
Referenced by XrdSfsFile().
const uint64_t XrdSfsFile::Verify = 0x8000000000000000ULL [static] |