XrdSsiSfs Class Reference

#include <XrdSsiSfs.hh>

Inheritance diagram for XrdSsiSfs:

Collaboration diagram for XrdSsiSfs:

Public Member Functions
	XrdSsiSfs ()
virtual	~XrdSsiSfs ()
int	chksum (csFunc Func, const char *csName, const char *path, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)
int	chmod (const char *Name, XrdSfsMode Mode, XrdOucErrInfo &eInfo, const XrdSecEntity *client, const char *opaque=0)
int	exists (const char *fileName, XrdSfsFileExistence &exists_flag, XrdOucErrInfo &eInfo, const XrdSecEntity *client, const char *opaque=0)
int	fsctl (const int cmd, const char *args, XrdOucErrInfo &eInfo, const XrdSecEntity *client)
int	getStats (char *buff, int blen)
const char *	getVersion ()
int	mkdir (const char *dirName, XrdSfsMode Mode, XrdOucErrInfo &eInfo, const XrdSecEntity *client, const char *opaque=0)
XrdSfsDirectory *	newDir (char *user=0, int MonID=0)
XrdSfsFile *	newFile (char *user=0, int MonID=0)
int	prepare (XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)
int	rem (const char *path, XrdOucErrInfo &eInfo, const XrdSecEntity *client, const char *info=0)
int	remdir (const char *dirName, XrdOucErrInfo &eInfo, const XrdSecEntity *client, const char *info=0)
int	rename (const char *oldFileName, const char *newFileName, XrdOucErrInfo &eInfo, const XrdSecEntity *client, const char *infoO=0, const char *infoN=0)
void	setFeatures (XrdSfsFileSystem *prevFS)
int	stat (const char *Name, mode_t &mode, XrdOucErrInfo &eInfo, const XrdSecEntity *client, const char *opaque=0)
int	stat (const char *Name, struct stat *buf, XrdOucErrInfo &eInfo, const XrdSecEntity *client, const char *opaque=0)
int	truncate (const char *Name, XrdSfsFileOffset fileOffset, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)
Public Member Functions inherited from XrdSfsFileSystem
	XrdSfsFileSystem ()
	Constructor and Destructor.
virtual	~XrdSfsFileSystem ()
virtual void	Connect (const XrdSecEntity *client=0)
virtual void	Disc (const XrdSecEntity *client=0)
virtual void	EnvInfo (XrdOucEnv *envP)
virtual int	FAttr (XrdSfsFACtl *faReq, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)
uint64_t	Features ()
virtual int	FSctl (const int cmd, XrdSfsFSctl &args, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)
virtual int	getChkPSize ()
virtual int	gpFile (gpfFunc &gpAct, XrdSfsGPFile &gpReq, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)
virtual XrdSfsDirectory *	newDir (XrdOucErrInfo &eInfo)
virtual XrdSfsFile *	newFile (XrdOucErrInfo &eInfo)

Static Public Member Functions
static void	setMax (int mVal)

Friends
class	XrdSsiFile

Additional Inherited Members
Public Types inherited from XrdSfsFileSystem
enum	csFunc {   csCalc = 0 ,   csGet ,   csSize }
enum	gpfFunc {   gpfCancel =0 ,   gpfGet ,   gpfPut }
Protected Attributes inherited from XrdSfsFileSystem
uint64_t	FeatureSet
	Adjust features at initialization.

Detailed Description

Definition at line 44 of file XrdSsiSfs.hh.

Constructor & Destructor Documentation

XrdSsiSfs()

XrdSsiSfs::XrdSsiSfs ( )

inline

Definition at line 139 of file XrdSsiSfs.hh.

{}

~XrdSsiSfs()

virtual XrdSsiSfs::~XrdSsiSfs ( )

inlinevirtual

Definition at line 140 of file XrdSsiSfs.hh.

{}  // Too complicate to delete :-)

Member Function Documentation

chksum()

int XrdSsiSfs::chksum ( csFunc Func, const char * csName, const char * path, XrdOucErrInfo & eInfo, const XrdSecEntity * client = 0, const char * opaque = 0 )

virtual

Reimplemented from XrdSfsFileSystem.

Definition at line 161 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk) return theFS->chksum(Func, csName, Path, einfo, client, opaque);
   einfo.setErrInfo(ENOTSUP, "Checksums are not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, Path, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

chmod()

int XrdSsiSfs::chmod ( const char * path, XrdSfsMode mode, XrdOucErrInfo & eInfo, const XrdSecEntity * client, const char * opaque = 0 )

virtual

Change file mode settings.

Parameters

path	- Pointer to the path of the file in question.
mode	- The new file mode setting.
eInfo	- The object where error info or results are to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns

One of SFS_OK, SFS_ERROR, SFS_REDIRECT or SFS_STALL

Implements XrdSfsFileSystem.

Definition at line 179 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(path))
          return theFS->chmod(path, Mode, einfo, client, info);
       einfo.setErrInfo(ENOTSUP, "chmod is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "chmod is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, Mode, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

exists()

int XrdSsiSfs::exists ( const char * path, XrdSfsFileExistence & eFlag, XrdOucErrInfo & eInfo, const XrdSecEntity * client, const char * opaque = 0 )

virtual

Return directory/file existence information (short stat).

Parameters

path	- Pointer to the path of the file/directory in question.
eFlag	- Where the results are to be returned.
eInfo	- The object where error info is to be returned.
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 When SFS_OK is returned, eFlag must be properly set, as follows: XrdSfsFileExistNo - path does not exist XrdSfsFileExistIsFile - path refers to an online file XrdSfsFileExistIsDirectory - path refers to an online directory XrdSfsFileExistIsOffline - path refers to an offline file XrdSfsFileExistIsOther - path is neither a file nor directory

Implements XrdSfsFileSystem.

Definition at line 227 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(path))
          return theFS->exists(path, file_exists, einfo, client, info);
       einfo.setErrInfo(ENOTSUP, "exists is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "exists is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

fsctl()

int XrdSsiSfs::fsctl ( const int cmd, const char * args, XrdOucErrInfo & eInfo, const XrdSecEntity * client )

virtual

Perform a filesystem control operation (version 1)

Parameters

cmd	- The operation to be performed: SFS_FSCTL_LOCATE Locate a file or file servers SFS_FSCTL_STATCC Return cluster config status SFS_FSCTL_STATFS Return physical filesystem information SFS_FSCTL_STATLS Return logical filesystem information SFS_FSCTL_STATXA Return extended attributes
args	- Arguments specific to cmd. SFS_FSCTL_LOCATE args points to the path to be located "" path is the first exported path "*" return all current servers "*‍/" return servers exporting path o/w return servers having the path SFS_FSCTL_STATFS Path in the filesystem in question. SFS_FSCTL_STATLS Path in the filesystem in question. SFS_FSCTL_STATXA Path of the file whose xattr is wanted.
eInfo	- The object where error info or results are to be returned.
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.

SFS_STARTED Operation started result will be returned via callback. Valid only for for SFS_FSCTL_LOCATE, SFS_FSCTL_STATFS, and SFS_FSCTL_STATXA o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.

Implements XrdSfsFileSystem.

Definition at line 247 of file XrdSsiSfs.cc.

{
   EPNAME("fsctl");
   const char *tident = einfo.getErrUser();
 
   char pbuff[1024], rType[3] = {'S', 'w', 0};
   const char *Resp[2] = {rType, pbuff};
   const char *opq, *Path = Split(args,&opq,pbuff,sizeof(pbuff));
   XrdNetIF::ifType ifType;
   int Resp1Len;
 
// Do some debugging
//
   DEBUG(args);
 
// We only process the locate request here. Reroute it if we can otherwise.
//
   if ((cmd & SFS_FSCTL_CMD) != SFS_FSCTL_LOCATE)
      {if (fsChk) return theFS->fsctl(cmd, args, einfo, client);
       einfo.setErrInfo(ENOTSUP, "Requested fsctl operation not supported.");
       return SFS_ERROR;
      }
 
// Preprocess the argument
//
            if (*Path == '*')      Path++;
       else if (cmd & SFS_O_TRUNC) Path = 0;
 
// Check if we should reoute this request
//
   if (fsChk && Path && FSPath.Find(Path))
      return theFS->fsctl(cmd, args, einfo, client);
 
// If we have a path then see if we really have it
//
   if (Path)
      {if (!Provider) return Emsg(epname, einfo, EHOSTUNREACH, "locate", Path);
          else {XrdSsiProvider::rStat rStat = Provider->QueryResource(Path);
                     if (rStat == XrdSsiProvider::isPresent) rType[0] = 'S';
                else if (rStat == XrdSsiProvider::isPending) rType[0] = 's';
                else return Emsg(epname, einfo, ENOENT, "locate", Path);
               }
      }
 
// Compute interface return options
//
   ifType = XrdNetIF::GetIFType((einfo.getUCap() & XrdOucEI::uIPv4)  != 0,
                                (einfo.getUCap() & XrdOucEI::uIPv64) != 0,
                                (einfo.getUCap() & XrdOucEI::uPrip)  != 0);
   bool retHN = (cmd & SFS_O_HNAME) != 0;
 
// Get our destination
//
   if ((Resp1Len = myIF->GetDest(pbuff, sizeof(pbuff), ifType, retHN)))
      {einfo.setErrInfo(Resp1Len+3, (const char **)Resp, 2);
       return SFS_DATA;
      }
 
// We failed for some unknown reason
//
   return Emsg(epname, einfo, ENETUNREACH, "locate", Path);
}

References DEBUG, EPNAME, XrdSsi::fsChk, XrdSsi::FSPath, XrdOucErrInfo::getErrUser(), XrdNetIF::GetIFType(), XrdOucErrInfo::getUCap(), XrdSsiProvider::isPending, XrdSsiProvider::isPresent, XrdSsi::myIF, Path, XrdSsi::Provider, XrdOucErrInfo::setErrInfo(), SFS_DATA, SFS_ERROR, SFS_FSCTL_CMD, SFS_FSCTL_LOCATE, SFS_O_HNAME, SFS_O_TRUNC, XrdSsi::theFS, tident, XrdOucEI::uIPv4, XrdOucEI::uIPv64, and XrdOucEI::uPrip.

Here is the call graph for this function:

getStats()

int XrdSsiSfs::getStats ( char * buff, int blen )

virtual

Return statistical information.

Parameters

buff	- Pointer to the buffer where results are to be returned. Statistics should be in standard XML format. If buff is nil then only maximum size information is wanted.
blen	- The length available in buff.

Returns

Number of bytes placed in buff. When buff is nil, the maximum number of bytes that could have been placed in buff.

Implements XrdSfsFileSystem.

Definition at line 330 of file XrdSsiSfs.cc.

{
// Return statustics
//
   return Stats.Stats(buff, blen);
}

References XrdSsi::Stats.

getVersion()

const char * XrdSsiSfs::getVersion ( )

virtual

Get version string.

Returns

The version string. Normally this is the XrdVERSION value.

Implements XrdSfsFileSystem.

Definition at line 341 of file XrdSsiSfs.cc.

{return XrdVERSION;}

mkdir()

int XrdSsiSfs::mkdir ( const char * path, XrdSfsMode mode, XrdOucErrInfo & eInfo, const XrdSecEntity * client, const char * opaque = 0 )

virtual

Create a directory.

Parameters

path	- Pointer to the path of the directory to be created.
mode	- The directory mode setting.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns

One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

Definition at line 347 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(path))
          return theFS->mkdir(path, Mode, einfo, client, info);
       einfo.setErrInfo(ENOTSUP, "mkdir is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "mkdir is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, Mode, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

newDir()

XrdSfsDirectory * XrdSsiSfs::newDir ( char * user = 0, int MonID = 0 )

inlinevirtual

Obtain a new director object to be used for future directory requests.

Parameters

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.

Returns

pointer- Pointer to an XrdSfsDirectory object.

nil - Insufficient memory to allocate an object.

Implements XrdSfsFileSystem.

Definition at line 52 of file XrdSsiSfs.hh.

                                {return new XrdSsiDir(user, MonID);}

newFile()

XrdSfsFile * XrdSsiSfs::newFile ( char * user = 0, int MonID = 0 )

inlinevirtual

Obtain a new file object to be used for a future file requests.

Parameters

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.

Returns

pointer- Pointer to an XrdSfsFile object.

nil - Insufficient memory to allocate an object.

Implements XrdSfsFileSystem.

Definition at line 55 of file XrdSsiSfs.hh.

                                {return new XrdSsiFile(user, MonID);}

References XrdSsiFile.

Here is the call graph for this function:

prepare()

int XrdSsiSfs::prepare ( XrdSfsPrep & pargs, XrdOucErrInfo & eInfo, const XrdSecEntity * client = 0 )

virtual

Prepare a file for future processing.

Parameters

pargs	- The preapre arguments.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).

Returns

One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

Definition at line 367 of file XrdSsiSfs.cc.

{
// Reroute this if we can
//
   if (theFS) return theFS->prepare(pargs, out_error, client);
   return SFS_OK;
}

References SFS_OK, and XrdSsi::theFS.

rem()

int XrdSsiSfs::rem ( const char * path, XrdOucErrInfo & eInfo, const XrdSecEntity * client, const char * opaque = 0 )

virtual

Remove a file.

Parameters

path	- Pointer to the path of the file to be removed.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns

One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

Definition at line 381 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(path))
          return theFS->rem(path, einfo, client, info);
       einfo.setErrInfo(ENOTSUP, "rem is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "rem is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

remdir()

int XrdSsiSfs::remdir ( const char * path, XrdOucErrInfo & eInfo, const XrdSecEntity * client, const char * opaque = 0 )

virtual

Remove a directory.

Parameters

path	- Pointer to the path of the directory to be removed.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns

One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

Definition at line 400 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(path))
          return theFS->rem(path, einfo, client, info);
       einfo.setErrInfo(ENOTSUP, "remdir is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "remdir is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

rename()

int XrdSsiSfs::rename ( const char * oPath, const char * nPath, XrdOucErrInfo & eInfo, const XrdSecEntity * client, const char * opaqueO = 0, const char * opaqueN = 0 )

virtual

Rename a file or directory.

Parameters

oPath	- Pointer to the path to be renamed.
nPath	- Pointer to the path oPath is to have.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaqueO	- oPath's CGI information (see common description).
opaqueN	- nPath's CGI information (see common description).

Returns

One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

Definition at line 419 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(old_name))
          return theFS->rename(old_name,new_name,einfo,client,infoO,infoN);
       einfo.setErrInfo(ENOTSUP, "rename is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "rename is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

setFeatures()

void XrdSsiSfs::setFeatures

(

XrdSfsFileSystem *

prevFS

)

Definition at line 440 of file XrdSsiSfs.cc.

{
   uint64_t fSet = (prevFS ? prevFS->Features() : 0);
 
   FeatureSet = fSet | XrdSfs::hasSXIO;
}

References XrdSfsFileSystem::XrdSfsFileSystem(), XrdSfsFileSystem::Features(), XrdSfsFileSystem::FeatureSet, and XrdSfs::hasSXIO.

Referenced by XrdSfsGetFileSystem2().

Here is the call graph for this function:

Here is the caller graph for this function:

setMax()

void XrdSsiSfs::setMax ( int mVal )

inlinestatic

Definition at line 137 of file XrdSsiSfs.hh.

{freeMax = mVal;}

stat() [1/2]

int XrdSsiSfs::stat ( const char * path, mode_t & mode, XrdOucErrInfo & eInfo, const XrdSecEntity * client, const char * opaque = 0 )

virtual

Return mode information on a file or directory.

Parameters

path	- Pointer to the path in question.
mode	- Where full mode information is to be returned.
eInfo	- The object where error info is to be returned.
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 When SFS_OK is returned, mode must contain mode information. If the mode is -1 then it is taken as an offline file.

Implements XrdSfsFileSystem.

Definition at line 485 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(path))
          return theFS->stat(path, mode, einfo, client, info);
       einfo.setErrInfo(ENOTSUP, "stat is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "stat is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

stat() [2/2]

int XrdSsiSfs::stat ( const char * Name, struct stat * buf, XrdOucErrInfo & eInfo, const XrdSecEntity * client, const char * opaque = 0 )

virtual

Return state information on a file or directory.

Parameters

Name	- Pointer to the path in question.
buf	- Pointer to the structure where info it to be returned.
eInfo	- The object where error info is to be returned.
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 When SFS_OK is returned, buf must contain stat information.

Implements XrdSfsFileSystem.

Definition at line 467 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(path))
          return theFS->stat(path, buf, einfo, client, info);
       einfo.setErrInfo(ENOTSUP, "stat is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "stat is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, XrdOucErrInfo::setErrInfo(), SFS_ERROR, stat(), and XrdSsi::theFS.

Referenced by stat().

Here is the call graph for this function:

Here is the caller graph for this function:

truncate()

int XrdSsiSfs::truncate ( const char * path, XrdSfsFileOffset fsize, XrdOucErrInfo & eInfo, const XrdSecEntity * client = 0, const char * opaque = 0 )

virtual

Truncate a file.

Parameters

path	- Pointer to the path of the file to be truncated.
fsize	- The size that the file is to have.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- path's CGI information (see common description).

Returns

One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

Definition at line 505 of file XrdSsiSfs.cc.

{
// Reroute this request if we can
//
   if (fsChk)
      {if (FSPath.Find(path))
          return theFS->truncate(path, Size, einfo, client, info);
       einfo.setErrInfo(ENOTSUP, "truncate is not supported for given path.");
      } else einfo.setErrInfo(ENOTSUP, "truncate is not supported.");
   return SFS_ERROR;
}

References XrdSsi::fsChk, XrdSsi::FSPath, XrdOucErrInfo::setErrInfo(), SFS_ERROR, and XrdSsi::theFS.

Here is the call graph for this function:

Friends And Related Symbol Documentation

XrdSsiFile

friend class XrdSsiFile

friend

Definition at line 46 of file XrdSsiSfs.hh.

References XrdSsiFile.

Referenced by newFile(), and XrdSsiFile.

---

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

• XrdSsiSfs.hh
• XrdSsiSfs.cc