XrdOssArc Class Reference

#include <XrdOssArc.hh>

Inheritance diagram for XrdOssArc:

Collaboration diagram for XrdOssArc:

Public Member Functions
	XrdOssArc (XrdOss &ossref)
virtual	~XrdOssArc ()
virtual int	Chmod (const char *path, mode_t mode, XrdOucEnv *envP=0) override
virtual int	Create (const char *tid, const char *path, mode_t mode, XrdOucEnv &env, int opts=0) override
virtual uint64_t	Features () override
virtual int	FSctl (int cmd, int alen, const char *args, char **resp=0) override
virtual bool	getErrMsg (std::string &eText) override
int	InitArc (const char *, const char *parms, XrdOucEnv *envP)
virtual int	Lfn2Pfn (const char *Path, char *buff, int blen) override
virtual const char *	Lfn2Pfn (const char *Path, char *buff, int blen, int &rc) override
virtual int	Mkdir (const char *path, mode_t mode, int mkpath=0, XrdOucEnv *envP=0) override
virtual XrdOssDF *	newDir (const char *tident) override
virtual XrdOssDF *	newFile (const char *tident) override
virtual int	Remdir (const char *path, int Opts=0, XrdOucEnv *envP=0) override
virtual int	Rename (const char *oPath, const char *nPath, XrdOucEnv *oEnvP=0, XrdOucEnv *nEnvP=0) override
virtual int	Stat (const char *path, struct stat *buff, int opts=0, XrdOucEnv *envP=0) override
virtual int	Truncate (const char *path, unsigned long long fsize, XrdOucEnv *envP=0) override
virtual int	Unlink (const char *path, int Opts=0, XrdOucEnv *envP=0) override
Public Member Functions inherited from XrdOssWrapper
	XrdOssWrapper (XrdOss &ossRef)
virtual	~XrdOssWrapper ()
virtual void	Connect (XrdOucEnv &env)
virtual void	Disc (XrdOucEnv &env)
virtual void	EnvInfo (XrdOucEnv *envP)
virtual int	Init (XrdSysLogger *lp, const char *cfn)
virtual int	Init (XrdSysLogger *lp, const char *cfn, XrdOucEnv *envP)
virtual int	Reloc (const char *tident, const char *path, const char *cgName, const char *anchor=0)
virtual int	StatFS (const char *path, char *buff, int &blen, XrdOucEnv *envP=0)
virtual int	StatLS (XrdOucEnv &env, const char *path, char *buff, int &blen)
virtual int	StatPF (const char *path, struct stat *buff)
virtual int	StatPF (const char *path, struct stat *buff, int opts)
virtual int	Stats (char *buff, int blen)
virtual int	StatVS (XrdOssVSInfo *vsP, const char *sname=0, int updt=0)
virtual int	StatXA (const char *path, char *buff, int &blen, XrdOucEnv *envP=0)
virtual int	StatXP (const char *path, unsigned long long &attr, XrdOucEnv *envP=0)
Public Member Functions inherited from XrdOss
	XrdOss ()
	Constructor and Destructor. More...
virtual	~XrdOss ()

Additional Inherited Members
Static Public Attributes inherited from XrdOss
static const int	PF_csVer = 0x00000001
	verified file checksums present More...
static const int	PF_csVun = 0x00000002
	unverified file checksums present More...
static const int	PF_dInfo = 0x00000001
static const int	PF_dNums = 0x00000002
static const int	PF_dStat = 0x00000008
static const int	PF_isLFN = 0x00000004
Protected Attributes inherited from XrdOssWrapper
XrdOss &	wrapPI

Detailed Description

Definition at line 39 of file XrdOssArc.hh.

Constructor & Destructor Documentation

XrdOssArc()

XrdOssArc::XrdOssArc ( XrdOss &  ossref )

inline

Definition at line 253 of file XrdOssArc.hh.

:XrdOssWrapper(ossref) {}

~XrdOssArc()

virtual XrdOssArc::~XrdOssArc ( )

inlinevirtual

Definition at line 255 of file XrdOssArc.hh.

{}

Member Function Documentation

Chmod()

int XrdOssArc::Chmod ( const char *  path, mode_t  mode, XrdOucEnv *  envP = 0  )

overridevirtual

Change file mode settings.

Parameters

path	- Pointer to the path of the file in question.
mode	- The new file mode setting.
envP	- Pointer to environmental information.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 124 of file XrdOssArc.cc.

{
 
// chmod is only valid for non-archive paths
//
   if (XrdOssArcCompose::isMine(path))
      {Elog.Emsg("Chmod", EROFS, "chmod using", path);
       return -EROFS;
      }
 
// Pass this through
//
   return wrapPI.Chmod(path, mode, envP);
}

References XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdProxy::envP, and XrdOssArcCompose::isMine().

Here is the call graph for this function:

Create()

int XrdOssArc::Create ( const char *  tid, const char *  path, mode_t  mode, XrdOucEnv &  env, int  opts = 0  )

overridevirtual

Create file.

Parameters

tid	- Pointer to the trace identifier.
path	- Pointer to the path of the file to create.
mode	- The new file mode setting.
env	- Reference to environmental information.
opts	- Create options: XRDOSS_mkpath - create dir path if it does not exist. XRDOSS_new - the file must not already exist. oflags<<8 - open flags shifted 8 bits to the left/

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 143 of file XrdOssArc.cc.

{
 
// Create is only valid for non-archive paths
//
   if (XrdOssArcCompose::isMine(path))
      {Elog.Emsg("create", EROFS, "create file using", path);
           return -EROFS;
      }
 
// Pass this through
//
   return wrapPI.Create(tid, path, mode, env, opts);
}

References XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdOssArcCompose::isMine(), and opts.

Here is the call graph for this function:

Features()

uint64_t XrdOssArc::Features ( )

overridevirtual

Return storage system features.

Returns

Storage system features (see XRDOSS_HASxxx flags).

Reimplemented from XrdOssWrapper.

Definition at line 163 of file XrdOssArc.cc.

{
   return XRDOSS_HASXERT | wrapPI.Features();
}

References XRDOSS_HASXERT.

FSctl()

int XrdOssArc::FSctl ( int  cmd, int  alen, const char *  args, char **  resp = 0  )

overridevirtual

Execute a special storage system operation.

Parameters

cmd	- The operation to be performed: XRDOSS_FSCTLFA - Perform proxy file attribute operation
alen	- Length of data pointed to by args.
args	- Data sent with request, zero if alen is zero.
resp	- Where the response is to be set, if any.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 172 of file XrdOssArc.cc.

{
// Pass this through
//
   return wrapPI.FSctl(cmd, alen, args, resp);
}

getErrMsg()

bool XrdOssArc::getErrMsg ( std::string &  eText )

overridevirtual

Obtain detailed error message text for the immediately preceeding error returned by any method in this class.

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 XrdOssWrapper.

Definition at line 183 of file XrdOssArc.cc.

{
// Return any extened error mesage associated with this thread
//
   if (ecMsg.hasMsg())
      {ecMsg.Get(eText);
       return true;
      }
   return false;
}

References XrdOssArcGlobals::ecMsg, XrdOucECMsg::Get(), and XrdOucECMsg::hasMsg().

Here is the call graph for this function:

InitArc()

int XrdOssArc::InitArc	(	const char *	configfn,
		const char *	parms,
		XrdOucEnv *	envP
	)

Definition at line 205 of file XrdOssArc.cc.

{
   const char *ending = "completed.";
   int retc = EINVAL;
 
// Obtain pointer to the scheduler. If missing allocate one.
//
   if (!envP || !(schedP = (XrdScheduler*)envP->GetPtr("XrdScheduler*")))
      {schedP = new XrdScheduler;
       schedP->Start();
      }
 
// Print herald
//
   Elog.Say("++++++ Archive Storage System initialization started.");
 
// Configure the subsystems
//
   if ( (!Config.Configure(configfn, parms, envP)) ) ending = "failed!";
      else retc = XrdOssOK;
 
// Print closing herald
//
   Elog.Say("------ Archive Storage System initialization ", ending);
 
// All done.
//
   return retc;
}

References XrdOssArcGlobals::Config, XrdOssArcConfig::Configure(), XrdOssArcGlobals::Elog, XrdProxy::envP, XrdOucEnv::GetPtr(), XrdSysError::Say(), XrdOssArcGlobals::schedP, XrdScheduler::Start(), and XrdOssOK.

Referenced by XrdVERSIONINFO().

Here is the call graph for this function:

Here is the caller graph for this function:

Lfn2Pfn() [1/2]

int XrdOssArc::Lfn2Pfn ( const char *  Path, char *  buff, int  blen  )

overridevirtual

Translate logical name to physical name V1 (deprecated).

Parameters

Path	- Path in whose information is wanted.
buff	- Pointer to the buffer to hold the new path.
blen	- Length of the buffer.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 239 of file XrdOssArc.cc.

{
   int rc = 0;
 
// Use v2 version to generate the Pfn
//
   if (Lfn2Pfn(Path, buff, blen, rc) == Path && !rc)
      {if ((int)strlen(Path) >= blen) rc = -ENAMETOOLONG;
          else strcpy(buff, Path);
      }
   return rc;
}

References Path.

Lfn2Pfn() [2/2]

const char * XrdOssArc::Lfn2Pfn ( const char *  Path, char *  buff, int  blen, int &  rc  )

overridevirtual

Translate logical name to physical name V2.

Parameters

Path	- Path in whose information is wanted.
buff	- Pointer to the buffer to hold the new path.
blen	- Length of the buffer.
rc	- Place where failure return code is to be returned: -errno or -osserr (see XrdOssError.hh).

Returns

Pointer to the translated path upon success or nil on failure.

Reimplemented from XrdOssWrapper.

Definition at line 256 of file XrdOssArc.cc.

{
 
// The caller typically needs the LFN2PFN mapping to handle file attributes,
// checksums, and prepare requests. All of these are disallowed for our
// internal paths so we simply fail the mapping here.
//
  if (XrdOssArcCompose::isMine(Path))
     {rc = -EPERM;
      return 0;
     }
 
// Use the underlying mapping.
//
   return wrapPI.Lfn2Pfn(Path, buff, blen, rc);
}

References XrdOssArcCompose::isMine(), and Path.

Here is the call graph for this function:

Mkdir()

int XrdOssArc::Mkdir ( const char *  path, mode_t  mode, int  mkpath = 0, XrdOucEnv *  envP = 0  )

overridevirtual

Create a directory.

Parameters

path	- Pointer to the path of the directory to be created.
mode	- The directory mode setting.
mkpath	- When true the path is created if it does not exist.
envP	- Pointer to environmental information.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 277 of file XrdOssArc.cc.

{
 
// mkdir is only valid for non-archive paths
//
   if (XrdOssArcCompose::isMine(path))
      {Elog.Emsg("Mkdir", EROFS, "create directory using", path);
       return -EROFS;
      }
 
// Pass this through
//
   return wrapPI.Mkdir(path, mode, mkpath, envP);
}

References XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdProxy::envP, and XrdOssArcCompose::isMine().

Here is the call graph for this function:

newDir()

virtual XrdOssDF* XrdOssArc::newDir ( const char *  tident )

inlineoverridevirtual

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

Parameters

tident

- The trace identifier.

Returns

pointer- Pointer to a possibly wrapped XrdOssDF object.

nil - Insufficient memory to allocate an object.

Reimplemented from XrdOssWrapper.

Definition at line 52 of file XrdOssArc.hh.

                        {return new XrdOssArcDir(tident,wrapPI.newDir(tident));}

References XrdOss::newDir(), tident, and XrdOssWrapper::wrapPI.

Here is the call graph for this function:

newFile()

virtual XrdOssDF* XrdOssArc::newFile ( const char *  tident )

inlineoverridevirtual

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

Parameters

tident

- The trace identifier.

Returns

pointer- Pointer to a possibly wrapped XrdOssDF object.

nil - Insufficient memory to allocate an object.

Reimplemented from XrdOssWrapper.

Definition at line 64 of file XrdOssArc.hh.

                         {return new XrdOssArcFile(tident,wrapPI.newFile(tident));}

References XrdOss::newFile(), tident, and XrdOssWrapper::wrapPI.

Here is the call graph for this function:

Remdir()

int XrdOssArc::Remdir ( const char *  path, int  Opts = 0, XrdOucEnv *  envP = 0  )

overridevirtual

Remove a directory.

Parameters

path	- Pointer to the path of the directory to be removed.
Opts	- The processing options: XRDOSS_Online - only remove online copy XRDOSS_isPFN - path is already translated.
envP	- Pointer to environmental information.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 296 of file XrdOssArc.cc.

{
 
// Remdir is only valid for non-archive paths
//
   if (XrdOssArcCompose::isMine(path))
      {Elog.Emsg("Remdir", EROFS, "remove", path);
       return -EROFS;
      }
 
// Pass this through
//
   return wrapPI.Remdir(path, Opts, envP);
}

References XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdProxy::envP, XrdOssArcCompose::isMine(), and XrdMpx::Opts.

Here is the call graph for this function:

Rename()

int XrdOssArc::Rename ( const char *  oPath, const char *  nPath, XrdOucEnv *  oEnvP = 0, XrdOucEnv *  nEnvP = 0  )

overridevirtual

Rename a file or directory.

Parameters

oPath	- Pointer to the path to be renamed.
nPath	- Pointer to the path oPath is to have.
oEnvP	- Environmental information for oPath.
nEnvP	- Environmental information for nPath.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 315 of file XrdOssArc.cc.

{
 
// Rename is only valid for non-archive paths
//
   if (XrdOssArcCompose::isMine(oldname) || (XrdOssArcCompose::isMine(newname)))
      {Elog.Emsg("Rename", EROFS, "rename", newname);
       return -EROFS;
      }
 
// Pass this through
//
   return wrapPI.Rename(oldname, newname, old_env, new_env);
}

References XrdOssArcGlobals::Elog, XrdSysError::Emsg(), and XrdOssArcCompose::isMine().

Here is the call graph for this function:

Stat()

int XrdOssArc::Stat ( const char *  path, struct stat *  buff, int  opts = 0, XrdOucEnv *  envP = 0  )

overridevirtual

Return state information on a file or directory.

Parameters

path	- Pointer to the path in question.
buff	- Pointer to the structure where info it to be returned.
opts	- Options: XRDOSS_preop - this is a stat prior to open. XRDOSS_resonly - only look for resident files. XRDOSS_updtatm - update file access time.
envP	- Pointer to environmental information.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 335 of file XrdOssArc.cc.

{
   TraceInfo("Stat", 0);
   char buff[MAXPATHLEN];
   int rc;
 
// Prepare to process the archive/backup request
//
   XrdOssArcCompose dsInfo(path, envP, rc, false, true);
 
// Make sure all went well
//
   if (rc)
      {if (rc != EDOM)
          {Elog.Emsg("Stat", rc, "locate", path);
           return -rc;
          }
       return wrapPI.Stat(path, Stat, opts, envP);
      }
 
// If this is a stat for an archive, we can do this here
//
   if (dsInfo.didType == dsInfo.isARC)
      {if ((rc = dsInfo.ArcPath(buff, sizeof(buff), true))) return -rc;
       if (stat(buff, Stat))
          {rc = errno;
           DEBUG("Stat archive "<<buff<<" failed; "<<XrdSysE2T(rc));
           return -rc;
          }
       return XrdOssOK;
      }
 
// The person want to stat a particular file in an archive. The most sensible
// way to do this is to ask the DM system for than information.
//
   if ((rc = dsInfo.Stat(dsInfo.flScope.c_str(), dsInfo.flName.c_str(), Stat)))
      {DEBUG("Stat file "<<dsInfo.flScope.c_str()<<':'<<dsInfo.flName.c_str()
             <<" failed; "<<XrdSysE2T(rc));
       return -rc;
      }
   return XrdOssOK;
}

References XrdOssArcCompose::ArcPath(), DEBUG, XrdOssArcCompose::didType, XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdProxy::envP, XrdOssArcCompose::flName, XrdOssArcCompose::flScope, XrdOssArcCompose::isARC, opts, Stat, stat, XrdOssArcCompose::Stat(), TraceInfo, XrdOssOK, and XrdSysE2T().

Here is the call graph for this function:

Truncate()

int XrdOssArc::Truncate ( const char *  path, unsigned long long  fsize, XrdOucEnv *  envP = 0  )

overridevirtual

Truncate a file.

Parameters

path	- Pointer to the path of the file to be truncated.
fsize	- The size that the file is to have.
envP	- Pointer to environmental information.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 383 of file XrdOssArc.cc.

{
 
// Truncate is only valid for non-archive paths
//
   if (XrdOssArcCompose::isMine(path))
      {Elog.Emsg("Truncate", EROFS, "truncate", path);
       return -EROFS;
      }
 
// Pass this through
//
   return wrapPI.Truncate(path, size, envP);
}

References XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdProxy::envP, and XrdOssArcCompose::isMine().

Here is the call graph for this function:

Unlink()

int XrdOssArc::Unlink ( const char *  path, int  Opts = 0, XrdOucEnv *  envP = 0  )

overridevirtual

Remove a file.

Parameters

path	- Pointer to the path of the file to be removed.
Opts	- Options: XRDOSS_isMIG - this is a migratable path. XRDOSS_isPFN - do not apply name2name to path. XRDOSS_Online - remove only the online copy.
envP	- Pointer to environmental information.

Returns

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

Reimplemented from XrdOssWrapper.

Definition at line 403 of file XrdOssArc.cc.

{
 
// Unlink is only valid for non-archive paths
//
   if (XrdOssArcCompose::isMine(path))
      {Elog.Emsg("Rename", EROFS, "remove", path);
       return -EROFS;
      }
 
// Pass this through
//
   return wrapPI.Unlink(path, Opts, envP);
}

References XrdOssArcGlobals::Elog, XrdSysError::Emsg(), XrdProxy::envP, XrdOssArcCompose::isMine(), and XrdMpx::Opts.

Here is the call graph for this function:

---

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

• XrdOssArc.hh
• XrdOssArc.cc