XrdPfcFSctl Class Reference

#include <XrdPfcFSctl.hh>

Inheritance diagram for XrdPfcFSctl:

Collaboration diagram for XrdPfcFSctl:

Public Member Functions
	XrdPfcFSctl (XrdPfc::Cache &cInst, XrdSysLogger *logP)
	Constructor. More...
virtual	~XrdPfcFSctl ()
	Destructor. More...
virtual bool	Configure (const char *CfgFN, const char *Parms, XrdOucEnv *envP, const Plugins &plugs) override
virtual int	FSctl (const int cmd, int alen, const char *args, XrdSfsFile &file, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0) override
virtual int	FSctl (const int cmd, XrdSfsFSctl &args, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0) override
Public Member Functions inherited from XrdOfsFSctl_PI
	XrdOfsFSctl_PI ()
	Constructor. More...
virtual	~XrdOfsFSctl_PI ()
	Destructor. More...

Additional Inherited Members
Protected Attributes inherited from XrdOfsFSctl_PI
XrdSysError *	eDest
XrdOfsFSctl_PI *	prvPI

Detailed Description

Definition at line 46 of file XrdPfcFSctl.hh.

Constructor & Destructor Documentation

XrdPfcFSctl()

XrdPfcFSctl::XrdPfcFSctl	(	XrdPfc::Cache &	cInst,
		XrdSysLogger *	logP
	)

Constructor.

Definition at line 49 of file XrdPfcFSctl.cc.

                        : myCache(cInst), hProc(0), Log(logP, "PfcFsctl"),
                          sysTrace(cInst.GetTrace()), m_traceID("PfcFSctl") {}

~XrdPfcFSctl()

virtual XrdPfcFSctl::~XrdPfcFSctl ( )

inlinevirtual

Destructor.

Definition at line 76 of file XrdPfcFSctl.hh.

{}

Member Function Documentation

Configure()

bool XrdPfcFSctl::Configure ( const char *  CfgFN, const char *  Parms, XrdOucEnv *  envP, const Plugins &  plugs  )

overridevirtual

Configure plugin.

Parameters

CfgFN	- Path of the configuration file.
Parms	- Any parameters specified on the directive (may be null).
envP	- Pointer to environmental information
plugs	- Reference to the struct containing plugin pointers. Unloaded plugins have a nil pointer.

Returns

True upon success and false otherwise.

Reimplemented from XrdOfsFSctl_PI.

Definition at line 57 of file XrdPfcFSctl.cc.

{
// All we are interested in is getting the file handle handler pointer
//
   hProc = (XrdOfsHandle*)envP->GetPtr("XrdOfsHandle*");
   return hProc != 0;
}

References XrdProxy::envP, and XrdOucEnv::GetPtr().

Here is the call graph for this function:

FSctl() [1/2]

int XrdPfcFSctl::FSctl ( const int  cmd, int  alen, const char *  args, XrdSfsFile &  file, XrdOucErrInfo &  eInfo, const XrdSecEntity *  client = 0  )

overridevirtual

Perform a file control operation

Parameters

cmd	- The operation to be performed: SFS_FCTL_SPEC1 Return Implementation Dependent Data
alen	- The length of args.
args	- Arguments specific to cmd. SFS_FCTL_SPEC1 Unscreened args string.
file	- Reference to the target file object.
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. o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.

Implements XrdOfsFSctl_PI.

Definition at line 72 of file XrdPfcFSctl.cc.

{
   eInfo.setErrInfo(ENOTSUP, "File based fstcl not supported for a cache.");
   return SFS_ERROR;
}

References XrdOucErrInfo::setErrInfo(), and SFS_ERROR.

Here is the call graph for this function:

FSctl() [2/2]

int XrdPfcFSctl::FSctl ( const int  cmd, XrdSfsFSctl &  args, XrdOucErrInfo &  eInfo, const XrdSecEntity *  client = 0  )

overridevirtual

Perform a filesystem control operation (version 2)

Parameters

cmd	- The operation to be performed: SFS_FSCTL_PLUGIN Return Implementation Dependent Data v1 SFS_FSCTL_PLUGIO Return Implementation Dependent Data v2
args	- Arguments specific to cmd. SFS_FSCTL_PLUGIN path and opaque information, fileP == 0 SFS_FSCTL_PLUGIO Unscreened argument string, fileP == 0
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. o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.

Implements XrdOfsFSctl_PI.

Definition at line 87 of file XrdPfcFSctl.cc.

{
   const char *msg = "", *xeq = args.Arg1;
   int ec, rc;
 
// Verify command
//
   if (cmd != SFS_FSCTL_PLUGXC)
      {eInfo.setErrInfo(EIDRM, "None-cache command issued to a cache.");
       return SFS_ERROR;
      }
 
// Very that we have a command
//
   if (!xeq || args.Arg1Len < 1)
      {eInfo.setErrInfo(EINVAL, "Missing cache command or argument.");
       return SFS_ERROR;
      }
 
// Process command
//
   if ((!strcmp(xeq, "evict") || !strcmp(xeq, "fevict")) && args.Arg2Len == -2)
      {std::string path = args.ArgP[0];
       ec = myCache.UnlinkFile(path, *xeq != 'f');
       switch(ec)
             {case       0: if (hProc) hProc->Hide(path.c_str());
                            rc = SFS_OK;
                            break;
              case -ENOENT: ec = ENOENT;
                            rc = SFS_ERROR;
                            msg = "file does not exist";
                            break;
              case  -EBUSY: ec = ENOTTY;
                            rc = SFS_ERROR;
                            msg = "file is in use";
                            break;
              case -EAGAIN: rc = 5;
                            break;
              default:      rc = SFS_ERROR;
                            msg = "unlink failed";
                            break;
             }
       TRACE(Info,"Cache "<<xeq<<' '<<path<<" rc="<<ec<<" ec="<<ec<<" msg="<<msg);
      } else {
   ec = EINVAL;
   rc = SFS_ERROR;
  }
 
  if (!strcmp(xeq, "cached"))
  {
     const char* path = args.ArgP[0];
     int rval = myCache.ConsiderCached(path);
     if (rval == 0)
     {
        rc = SFS_OK;
        ec = 0;
     }
     else
     {
        ec = ETIME;
        rc = SFS_ERROR;
        TRACE(Info,"Cache "<<xeq<<' '<<path<<" rc="<<ec<<" ec="<<ec<<" msg=file not in cache");
     }
  }
 
// Return result
//
   eInfo.setErrInfo(ec, msg);
   return rc;
}

References XrdSfsFSctl::Arg1, XrdSfsFSctl::Arg1Len, XrdSfsFSctl::Arg2Len, XrdPfc::Cache::ConsiderCached(), ec, ETIME, XrdOfsHandle::Hide(), TPC::Info, XrdOucErrInfo::setErrInfo(), SFS_ERROR, SFS_FSCTL_PLUGXC, SFS_OK, TRACE, and XrdPfc::Cache::UnlinkFile().

Here is the call graph for this function:

---

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

• XrdPfcFSctl.hh
• XrdPfcFSctl.cc