XRootD
XrdThrottle::File Class Referencefinal

#include <XrdThrottle.hh>

+ Inheritance diagram for XrdThrottle::File:
+ Collaboration diagram for XrdThrottle::File:

Public Member Functions

virtual int checkpoint (cpAct act, struct iov *range=0, int n=0) override
 
virtual int close () override
 
virtual int fctl (const int cmd, const char *args, XrdOucErrInfo &eInfo)=0
 
virtual int fctl (const int cmd, const char *args, XrdOucErrInfo &out_error) override
 
virtual int fctl (const int cmd, int alen, const char *args, const XrdSecEntity *client=0)
 
virtual const char * FName () override
 
virtual int getCXinfo (char cxtype[4], int &cxrsz) override
 
virtual int getMmap (void **Addr, off_t &Size) override
 
virtual int open (const char *fileName, XrdSfsFileOpenMode openMode, mode_t createMode, const XrdSecEntity *client, const char *opaque=0) override
 
virtual XrdSfsXferSize pgRead (XrdSfsAio *aioparm, uint64_t opts=0) override
 
virtual XrdSfsXferSize pgRead (XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize rdlen, uint32_t *csvec, uint64_t opts=0) override
 
virtual XrdSfsXferSize pgWrite (XrdSfsAio *aioparm, uint64_t opts=0) override
 
virtual XrdSfsXferSize pgWrite (XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize rdlen, uint32_t *csvec, uint64_t opts=0) override
 
virtual int read (XrdSfsAio *aioparm) override
 
virtual XrdSfsXferSize read (XrdSfsFileOffset fileOffset, char *buffer, XrdSfsXferSize buffer_size) override
 
virtual int read (XrdSfsFileOffset fileOffset, XrdSfsXferSize amount) override
 
virtual int SendData (XrdSfsDio *sfDio, XrdSfsFileOffset offset, XrdSfsXferSize size) override
 
virtual int stat (struct stat *buf) override
 
virtual int sync () override
 
virtual int sync (XrdSfsAio *aiop) override
 
virtual int truncate (XrdSfsFileOffset fileOffset) override
 
virtual int write (XrdSfsAio *aioparm) override
 
virtual XrdSfsXferSize write (XrdSfsFileOffset fileOffset, const char *buffer, XrdSfsXferSize buffer_size) override
 
- Public Member Functions inherited from XrdSfsFile
 XrdSfsFile (const char *user=0, int MonID=0)
 
 XrdSfsFile (XrdOucErrInfo &eInfo)
 
 XrdSfsFile (XrdSfsFile &wrapF)
 
virtual ~XrdSfsFile ()
 Destructor. More...
 
virtual int fctl (const int cmd, int alen, const char *args, const XrdSecEntity *client=0)
 
virtual XrdSfsXferSize readv (XrdOucIOVec *readV, int rdvCnt)
 
virtual void setXio (XrdSfsXio *xioP)
 
virtual XrdSfsXferSize writev (XrdOucIOVec *writeV, int wdvCnt)
 

Friends

class FileSystem
 

Additional Inherited Members

- Public Types inherited from XrdSfsFile
enum  cpAct {
  cpCreate =0 ,
  cpDelete ,
  cpRestore ,
  cpQuery ,
  cpTrunc ,
  cpWrite
}
 
- Public Attributes inherited from XrdSfsFile
XrdOucErrInfoerror
 
- Static Public Attributes inherited from XrdSfsFile
static const uint64_t Verify = 0x8000000000000000ULL
 Options for pgRead() and pgWrite() as noted below. More...
 

Detailed Description

Definition at line 28 of file XrdThrottle.hh.

Member Function Documentation

◆ checkpoint()

int File::checkpoint ( cpAct  act,
struct iov range = 0,
int  n = 0 
)
overridevirtual

Reimplemented from XrdSfsFile.

Definition at line 85 of file XrdThrottleFile.cc.

86 { return m_sfs->checkpoint(act, range, n);}

◆ close()

int File::close ( )
overridevirtual

Close the file.

Returns
One of SFS_OK or SFS_ERROR.

Implements XrdSfsFile.

Definition at line 78 of file XrdThrottleFile.cc.

79 {
80  m_is_open = false;
81  m_throttle.CloseFile(m_user);
82  return m_sfs->close();
83 }
bool CloseFile(const std::string &entity)

References XrdThrottleManager::CloseFile().

+ Here is the call graph for this function:

◆ fctl() [1/3]

virtual int XrdSfsFile::fctl

Execute a special operation on the file (version 1)

Parameters
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.
Returns
If an error occurs or the operation is not support, SFS_ERROR should be returned with error.code set to errno. Otherwise, SFS_FCTL_GETFD error.code holds the real file descriptor number If the value is negative, sendfile() is not used. If the value is SFS_SFIO_FDVAL then the SendData() method is used for future read requests.

◆ fctl() [2/3]

int File::fctl ( const int  cmd,
const char *  args,
XrdOucErrInfo eInfo 
)
overridevirtual

Execute a special operation on the file (version 1)

Parameters
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.
Returns
If an error occurs or the operation is not support, SFS_ERROR should be returned with error.code set to errno. Otherwise, SFS_FCTL_GETFD error.code holds the real file descriptor number If the value is negative, sendfile() is not used. If the value is SFS_SFIO_FDVAL then the SendData() method is used for future read requests.

Implements XrdSfsFile.

Definition at line 89 of file XrdThrottleFile.cc.

92 {
93  // Disable sendfile
94  if (cmd == SFS_FCTL_GETFD)
95  {
96  error.setErrInfo(ENOTSUP, "Sendfile not supported by throttle plugin.");
97  return SFS_ERROR;
98  }
99  else return m_sfs->fctl(cmd, args, out_error);
100 }
#define SFS_ERROR
#define SFS_FCTL_GETFD
int setErrInfo(int code, const char *emsg)
XrdOucErrInfo & error

References XrdSfsFile::error, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and SFS_FCTL_GETFD.

+ Here is the call graph for this function:

◆ fctl() [3/3]

int XrdSfsFile::fctl

Execute a special operation on the file (version 2)

Parameters
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).
Returns
SFS_OK a null response is sent.
SFS_DATA error.code length of the data to be sent. error.message contains the data to be sent. o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.

Definition at line 489 of file XrdSfsInterface.cc.

84 {
85  (void)cmd; (void)alen; (void)args; (void)client;
86  return SFS_OK;
87 }
#define SFS_OK

◆ FName()

const char * File::FName ( )
overridevirtual

Get the file path.

Returns
Null terminated string of the path used in open().

Implements XrdSfsFile.

Definition at line 103 of file XrdThrottleFile.cc.

104 {
105  return m_sfs->FName();
106 }

◆ getCXinfo()

int File::getCXinfo ( char  cxtype[4],
int &  cxrsz 
)
overridevirtual

Get compression information for the file.

Parameters
cxtype- Place where the compression algorithm name is to be placed
cxrsz- Place where the compression page size is to be returned
Returns
One of the valid SFS return codes described above. If the file is not compressed or an error is returned, cxrsz must be set to 0.

Implements XrdSfsFile.

Definition at line 230 of file XrdThrottleFile.cc.

231 {
232  return m_sfs->getCXinfo(cxtype, cxrsz);
233 }

◆ getMmap()

int File::getMmap ( void **  Addr,
off_t &  Size 
)
overridevirtual

Get file's memory mapping if one exists (memory mapped files only).

Parameters
Addr- Place where the starting memory address is returned.
Size- Place where the file's size is returned.
Returns
SFS_OK when the file is memory mapped or any other code otherwise.

Implements XrdSfsFile.

Definition at line 109 of file XrdThrottleFile.cc.

110 { // We cannot monitor mmap-based reads, so we disable them.
111  error.setErrInfo(ENOTSUP, "Mmap not supported by throttle plugin.");
112  return SFS_ERROR;
113 }

References XrdSfsFile::error, XrdOucErrInfo::setErrInfo(), and SFS_ERROR.

+ Here is the call graph for this function:

◆ open()

int File::open ( const char *  fileName,
XrdSfsFileOpenMode  openMode,
mode_t  createMode,
const XrdSecEntity client,
const char *  opaque = 0 
)
overridevirtual

Open a file.

Parameters
fileName- Pointer to the path of the file to be opened.
openMode- 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
createMode- The file's mode if it will be created.
client- Client's identify (see common description).
opaque- path's CGI information (see common description).
Returns
One of SFS_OK, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED

Implements XrdSfsFile.

Definition at line 55 of file XrdThrottleFile.cc.

60 {
61  std::tie(m_user, m_uid) = m_throttle.GetUserInfo(client);
62  m_throttle.PrepLoadShed(opaque, m_loadshed);
63  std::string open_error_message;
64  if (!m_throttle.OpenFile(m_user, open_error_message)) {
65  error.setErrInfo(EMFILE, open_error_message.c_str());
66  return SFS_ERROR;
67  }
68  auto retval = m_sfs->open(fileName, openMode, createMode, client, opaque);
69  if (retval != SFS_ERROR) {
70  m_is_open = true;
71  } else {
72  m_throttle.CloseFile(m_user);
73  }
74  return retval;
75 }
std::tuple< std::string, uint16_t > GetUserInfo(const XrdSecEntity *client)
void PrepLoadShed(const char *opaque, std::string &lsOpaque)
bool OpenFile(const std::string &entity, std::string &open_error_message)

References XrdThrottleManager::CloseFile(), XrdSfsFile::error, XrdThrottleManager::GetUserInfo(), XrdThrottleManager::OpenFile(), XrdThrottleManager::PrepLoadShed(), XrdOucErrInfo::setErrInfo(), and SFS_ERROR.

+ Here is the call graph for this function:

◆ pgRead() [1/2]

XrdSfsXferSize File::pgRead ( XrdSfsAio aioparm,
uint64_t  opts = 0 
)
overridevirtual

Read file pages and checksums using asynchronous I/O.

Parameters
aioparm- Pointer to async I/O object controlling the I/O.
opts- Processing options (see above).
Returns
SFS_OK Request accepted and will be scheduled.
SFS_ERROR File could not be read, error holds the reason.

Reimplemented from XrdSfsFile.

Definition at line 127 of file XrdThrottleFile.cc.

128 { // We disable all AIO-based reads.
129  aioparm->Result = this->pgRead((XrdSfsFileOffset)aioparm->sfsAio.aio_offset,
130  (char *)aioparm->sfsAio.aio_buf,
131  (XrdSfsXferSize)aioparm->sfsAio.aio_nbytes,
132  aioparm->cksVec, opts);
133  aioparm->doneRead();
134  return SFS_OK;
135 }
struct myOpts opts
off_t aio_offset
Definition: XrdSfsAio.hh:49
size_t aio_nbytes
Definition: XrdSfsAio.hh:48
void * aio_buf
Definition: XrdSfsAio.hh:47
long long XrdSfsFileOffset
int XrdSfsXferSize
uint32_t * cksVec
Definition: XrdSfsAio.hh:63
ssize_t Result
Definition: XrdSfsAio.hh:65
virtual void doneRead()=0
struct aiocb sfsAio
Definition: XrdSfsAio.hh:62
virtual XrdSfsXferSize pgRead(XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize rdlen, uint32_t *csvec, uint64_t opts=0) override

References aiocb::aio_buf, aiocb::aio_nbytes, aiocb::aio_offset, XrdSfsAio::cksVec, XrdSfsAio::doneRead(), opts, pgRead(), XrdSfsAio::Result, SFS_OK, and XrdSfsAio::sfsAio.

+ Here is the call graph for this function:

◆ pgRead() [2/2]

XrdSfsXferSize File::pgRead ( XrdSfsFileOffset  offset,
char *  buffer,
XrdSfsXferSize  rdlen,
uint32_t *  csvec,
uint64_t  opts = 0 
)
overridevirtual

Read file pages into a buffer and return corresponding checksums.

Parameters
offset- The offset where the read is to start. It may be unaligned with certain caveats relative to csvec.
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. However, if the offset is unaligned, then csvec[0] contains the crc for the page fragment that brings it to alignment for csvec[1]. It must be sized to hold all aligned XrdSys::Pagesize crc's plus additional ones for leading and ending page fragments, if any.
opts- Processing options (see above).
Returns
>= 0 The number of bytes that placed in buffer.
SFS_ERROR File could not be read, error holds the reason.

Reimplemented from XrdSfsFile.

Definition at line 116 of file XrdThrottleFile.cc.

121 {
122  DO_THROTTLE(rdlen)
123  return m_sfs->pgRead(offset, buffer, rdlen, csvec, opts);
124 }
#define DO_THROTTLE(amount)

References DO_THROTTLE, and opts.

Referenced by pgRead().

+ Here is the caller graph for this function:

◆ pgWrite() [1/2]

XrdSfsXferSize File::pgWrite ( XrdSfsAio aioparm,
uint64_t  opts = 0 
)
overridevirtual

Write file pages and checksums using asynchronous I/O.

Parameters
aioparm- Pointer to async I/O object controlling the I/O.
opts- Processing options (see above).
Returns
SFS_OK Request accepted and will be scheduled.
SFS_ERROR File could not be read, error holds the reason.

Reimplemented from XrdSfsFile.

Definition at line 149 of file XrdThrottleFile.cc.

150 { // We disable all AIO-based writes.
151  aioparm->Result = this->pgWrite((XrdSfsFileOffset)aioparm->sfsAio.aio_offset,
152  (char *)aioparm->sfsAio.aio_buf,
153  (XrdSfsXferSize)aioparm->sfsAio.aio_nbytes,
154  aioparm->cksVec, opts);
155  aioparm->doneWrite();
156  return SFS_OK;
157 }
virtual void doneWrite()=0
virtual XrdSfsXferSize pgWrite(XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize rdlen, uint32_t *csvec, uint64_t opts=0) override

References aiocb::aio_buf, aiocb::aio_nbytes, aiocb::aio_offset, XrdSfsAio::cksVec, XrdSfsAio::doneWrite(), opts, pgWrite(), XrdSfsAio::Result, SFS_OK, and XrdSfsAio::sfsAio.

+ Here is the call graph for this function:

◆ pgWrite() [2/2]

XrdSfsXferSize File::pgWrite ( XrdSfsFileOffset  offset,
char *  buffer,
XrdSfsXferSize  wrlen,
uint32_t *  csvec,
uint64_t  opts = 0 
)
overridevirtual

Write file pages into a file with corresponding checksums.

Parameters
offset- The offset where the write is to start. It may be unaligned with certain caveats relative to csvec.
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 or page fragment. If offset is unaligned then csvec[0] is the crc of the leading fragment to align the subsequent full page who's crc is in csvec[1]. It must be sized to hold all aligned XrdSys::Pagesize crc's plus additional ones for leading and ending page fragments, if any.
opts- Processing options (see above).
Returns
>= 0 The number of bytes written.
SFS_ERROR File could not be read, error holds the reason.

Reimplemented from XrdSfsFile.

Definition at line 138 of file XrdThrottleFile.cc.

143 {
144  DO_THROTTLE(rdlen)
145  return m_sfs->pgWrite(offset, buffer, rdlen, csvec, opts);
146 }

References DO_THROTTLE, and opts.

Referenced by pgWrite().

+ Here is the caller graph for this function:

◆ read() [1/3]

int File::read ( XrdSfsAio aioparm)
overridevirtual

Read file bytes using asynchronous I/O.

Parameters
aioparm- Pointer to async I/O object controlling the I/O.
Returns
SFS_OK Request accepted and will be scheduled.
SFS_ERROR File could not be read, error holds the reason.

Implements XrdSfsFile.

Definition at line 177 of file XrdThrottleFile.cc.

178 { // We disable all AIO-based reads.
179  aioparm->Result = this->read((XrdSfsFileOffset)aioparm->sfsAio.aio_offset,
180  (char *)aioparm->sfsAio.aio_buf,
181  (XrdSfsXferSize)aioparm->sfsAio.aio_nbytes);
182  aioparm->doneRead();
183  return SFS_OK;
184 }
virtual int read(XrdSfsFileOffset fileOffset, XrdSfsXferSize amount) override

References aiocb::aio_buf, aiocb::aio_nbytes, aiocb::aio_offset, XrdSfsAio::doneRead(), read(), XrdSfsAio::Result, SFS_OK, and XrdSfsAio::sfsAio.

+ Here is the call graph for this function:

◆ read() [2/3]

XrdSfsXferSize File::read ( XrdSfsFileOffset  offset,
char *  buffer,
XrdSfsXferSize  size 
)
overridevirtual

Read file bytes into a buffer.

Parameters
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.
Returns
>= 0 The number of bytes that placed in buffer.
SFS_ERROR File could not be read, error holds the reason.

Implements XrdSfsFile.

Definition at line 168 of file XrdThrottleFile.cc.

171 {
172  DO_THROTTLE(buffer_size);
173  return m_sfs->read(fileOffset, buffer, buffer_size);
174 }

References DO_THROTTLE.

◆ read() [3/3]

int File::read ( XrdSfsFileOffset  offset,
XrdSfsXferSize  size 
)
overridevirtual

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 The number of bytes that will be pre-read.
SFS_ERROR File could not be preread, error holds the reason.

Implements XrdSfsFile.

Definition at line 160 of file XrdThrottleFile.cc.

162 {
163  DO_THROTTLE(amount)
164  return m_sfs->read(fileOffset, amount);
165 }

References DO_THROTTLE.

Referenced by read().

+ Here is the caller graph for this function:

◆ SendData()

int File::SendData ( XrdSfsDio sfDio,
XrdSfsFileOffset  offset,
XrdSfsXferSize  size 
)
overridevirtual

Send file bytes via a XrdSfsDio sendfile object to a client (optional).

Parameters
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.
Returns
SFS_ERROR File not read, error object has reason.
SFS_OK Either data has been successfully sent via sfDio or no data has been sent and a normal read() should be issued.

Reimplemented from XrdSfsFile.

Definition at line 236 of file XrdThrottleFile.cc.

239 {
240  DO_THROTTLE(size);
241  return m_sfs->SendData(sfDio, offset, size);
242 }

References DO_THROTTLE.

◆ stat()

int File::stat ( struct stat *  buf)
overridevirtual

Return state information on the file.

Parameters
buf- Pointer to the structure where info it to be returned.
Returns
One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL. When SFS_OK is returned, buf must hold stat information.

Implements XrdSfsFile.

Definition at line 218 of file XrdThrottleFile.cc.

219 {
220  return m_sfs->stat(buf);
221 }

◆ sync() [1/2]

int File::sync ( )
overridevirtual

Make sure all outstanding data is actually written to the file (sync).

Returns
One of SFS_OK, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED

Implements XrdSfsFile.

Definition at line 206 of file XrdThrottleFile.cc.

207 {
208  return m_sfs->sync();
209 }

◆ sync() [2/2]

int File::sync ( XrdSfsAio aiop)
overridevirtual

Make sure all outstanding data is actually written to the file (async).

Returns
SFS_OK Request accepted and will be scheduled.
SFS_ERROR Request could not be accepted, return error has reason.

Implements XrdSfsFile.

Definition at line 212 of file XrdThrottleFile.cc.

213 {
214  return m_sfs->sync(aiop);
215 }

◆ truncate()

int File::truncate ( XrdSfsFileOffset  fsize)
overridevirtual

Truncate the file.

Parameters
fsize- The size that the file is to have.
Returns
One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFile.

Definition at line 224 of file XrdThrottleFile.cc.

225 {
226  return m_sfs->truncate(fileOffset);
227 }

◆ write() [1/2]

int File::write ( XrdSfsAio aioparm)
overridevirtual

Write file bytes using asynchronous I/O.

Parameters
aioparm- Pointer to async I/O object controlling the I/O.
Returns
0 Request accepted and will be scheduled.
!0 Request not accepted, returned value is errno.

Implements XrdSfsFile.

Definition at line 196 of file XrdThrottleFile.cc.

197 {
198  aioparm->Result = this->write((XrdSfsFileOffset)aioparm->sfsAio.aio_offset,
199  (char *)aioparm->sfsAio.aio_buf,
200  (XrdSfsXferSize)aioparm->sfsAio.aio_nbytes);
201  aioparm->doneWrite();
202  return SFS_OK;
203 }
virtual XrdSfsXferSize write(XrdSfsFileOffset fileOffset, const char *buffer, XrdSfsXferSize buffer_size) override

References aiocb::aio_buf, aiocb::aio_nbytes, aiocb::aio_offset, XrdSfsAio::doneWrite(), XrdSfsAio::Result, SFS_OK, XrdSfsAio::sfsAio, and write().

+ Here is the call graph for this function:

◆ write() [2/2]

XrdSfsXferSize File::write ( XrdSfsFileOffset  offset,
const char *  buffer,
XrdSfsXferSize  size 
)
overridevirtual

Write file bytes from a buffer.

Parameters
offset- The offset where the write is to start.
buffer- pointer to buffer where the bytes reside.
size- The number of bytes to write.
Returns
>= 0 The number of bytes that were written.
SFS_ERROR File could not be written, error holds the reason.

Implements XrdSfsFile.

Definition at line 187 of file XrdThrottleFile.cc.

190 {
191  DO_THROTTLE(buffer_size);
192  return m_sfs->write(fileOffset, buffer, buffer_size);
193 }

References DO_THROTTLE.

Referenced by write().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ FileSystem

friend class FileSystem
friend

Definition at line 30 of file XrdThrottle.hh.


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