1 #ifndef __SFS_INTERFACE_H__
2 #define __SFS_INTERFACE_H__
35 #include <sys/types.h>
50 #define SFS_O_RDONLY 0
51 #define SFS_O_WRONLY 1
53 #define SFS_O_CREAT 0x00000100
54 #define SFS_O_TRUNC 0x00000200
55 #define SFS_O_MULTIW 0x00000400
56 #define SFS_O_NOTPC 0x00000800
57 #define SFS_O_DIRLIST 0x00010000
58 #define SFS_O_POSC 0x00100000
59 #define SFS_O_FORCE 0x00200000
60 #define SFS_O_HNAME 0x00400000
61 #define SFS_O_LOCAL 0x00800000
62 #define SFS_O_NOWAIT 0x01000000
63 #define SFS_O_RAWIO 0x02000000
64 #define SFS_O_RESET 0x04000000
65 #define SFS_O_REPLICA 0x08000000
70 #define SFS_O_MKPTH 0x00004000
75 #define SFS_O_LOCATE 0x10000000
76 #define SFS_O_STAT 0x20000000
77 #define SFS_O_META 0x40000000
85 #define SFS_FCTL_GETFD 1
86 #define SFS_FCTL_STATV 2
87 #define SFS_FCTL_SPEC1 3
89 #define SFS_SFIO_FDVAL 0x80000000
93 #define SFS_FSCTL_CMD 255
95 #define SFS_FSCTL_LOCATE 1
96 #define SFS_FSCTL_STATFS 2
97 #define SFS_FSCTL_STATLS 3
98 #define SFS_FSCTL_STATXA 4
99 #define SFS_FSCTL_STATCC 5
100 #define SFS_FSCTL_PLUGIN 8
101 #define SFS_FSCTL_PLUGIO 16
108 #define SFS_REDIRECT -256
109 #define SFS_STARTED -512
110 #define SFS_DATA -1024
111 #define SFS_DATAVEC -2048
115 #define SFS_LCLPRFX "/=/"
116 #define SFS_LCLPLEN 3
117 #define SFS_LCLPATH(x) !strncmp(x, SFS_LCLPRFX, SFS_LCLPLEN)
118 #define SFS_LCLPRFY "/="
119 #define SFS_LCLROOT(x) !strncmp(x, SFS_LCLPRFX, SFS_LCLPLEN-1) \
120 && (*(x+SFS_LCLPLEN-1) == '/' || *(x+SFS_LCLPLEN-1) == 0)
146 #define Prep_SENDAOK 4
147 #define Prep_SENDERR 8
148 #define Prep_SENDACK 12
149 #define Prep_WMODE 16
150 #define Prep_STAGE 32
151 #define Prep_COLOC 64
152 #define Prep_FRESH 128
153 #define Prep_CANCEL 256
154 #define Prep_QUERY 512
155 #define Prep_EVICT 1024
259 virtual int open(
const char *path,
261 const char *opaque = 0) = 0;
396 virtual int open(
const char *fileName,
400 const char *opaque = 0) = 0;
446 virtual int fctl(
const int cmd,
465 virtual int fctl(
const int cmd,
487 virtual int getMmap(
void **Addr, off_t &Size) = 0;
493 static const uint64_t
495 static const uint64_t
905 const char *opaque = 0);
923 const char *opaque = 0) = 0;
975 const char *opaque = 0) = 0;
1133 const char *opaque = 0) = 0;
1160 virtual int rem(
const char *path,
1163 const char *opaque = 0) = 0;
1179 const char *opaque = 0) = 0;
1198 const char *opaqueO = 0,
1199 const char *opaqueN = 0) = 0;
1218 const char *opaque = 0) = 0;
1238 const char *opaque = 0) = 0;
1256 const char *opaque = 0) = 0;
1299 const char *configFn,
1316 const char *configFn);
#define stat(a, b)
Definition: XrdPosix.hh:96
int XrdSfsMode
Definition: XrdSfsInterface.hh:128
XrdSfsFileExistence
Definition: XrdSfsInterface.hh:132
@ XrdSfsFileExistIsOther
Definition: XrdSfsInterface.hh:137
@ XrdSfsFileExistIsFile
Definition: XrdSfsInterface.hh:134
@ XrdSfsFileExistNo
Definition: XrdSfsInterface.hh:133
@ XrdSfsFileExistIsOffline
Definition: XrdSfsInterface.hh:136
@ XrdSfsFileExistIsDirectory
Definition: XrdSfsInterface.hh:135
int XrdSfsFileOpenMode
Definition: XrdSfsInterface.hh:127
long long XrdSfsFileOffset
Definition: XrdSfsInterface.hh:126
int XrdSfsXferSize
Definition: XrdSfsInterface.hh:129
Definition: XrdOucEnv.hh:42
Definition: XrdOucErrInfo.hh:99
Definition: XrdOucTList.hh:42
Definition: XrdSecEntity.hh:64
Definition: XrdSfsAio.hh:59
Definition: XrdSfsDio.hh:47
Definition: XrdSfsInterface.hh:239
virtual const char * nextEntry()=0
virtual int autoStat(struct stat *buf)
XrdSfsDirectory(XrdOucErrInfo &eInfo)
Definition: XrdSfsInterface.hh:334
XrdSfsDirectory(const char *user=0, int MonID=0)
Definition: XrdSfsInterface.hh:312
XrdSfsDirectory(XrdSfsDirectory &wrapD)
Definition: XrdSfsInterface.hh:324
virtual const char * FName()=0
XrdOucErrInfo * lclEI
Definition: XrdSfsInterface.hh:344
virtual ~XrdSfsDirectory()
Destructor.
Definition: XrdSfsInterface.hh:341
virtual int open(const char *path, const XrdSecEntity *client=0, const char *opaque=0)=0
XrdOucErrInfo & error
Definition: XrdSfsInterface.hh:247
Definition: XrdSfsInterface.hh:816
virtual XrdSfsDirectory * newDir(char *user=0, int MonID=0)=0
virtual void Connect(const XrdSecEntity *client=0)
Definition: XrdSfsInterface.hh:931
XrdSfsFileSystem()
Constructor and Destructor.
virtual int chmod(const char *path, XrdSfsMode mode, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual void EnvInfo(XrdOucEnv *envP)
Definition: XrdSfsInterface.hh:951
virtual int stat(const char *path, mode_t &mode, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual void Disc(const XrdSecEntity *client=0)
Definition: XrdSfsInterface.hh:942
virtual int getStats(char *buff, int blen)=0
virtual int FAttr(XrdSfsFACtl *faReq, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)
virtual XrdSfsDirectory * newDir(XrdOucErrInfo &eInfo)
Definition: XrdSfsInterface.hh:846
virtual int fsctl(const int cmd, const char *args, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
virtual int rename(const char *oPath, const char *nPath, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaqueO=0, const char *opaqueN=0)=0
virtual int mkdir(const char *path, XrdSfsMode mode, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual ~XrdSfsFileSystem()
Definition: XrdSfsInterface.hh:1263
virtual int truncate(const char *path, XrdSfsFileOffset fsize, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual int remdir(const char *path, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual int getChkPSize()
Definition: XrdSfsInterface.hh:1070
virtual int FSctl(const int cmd, XrdSfsFSctl &args, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)
csFunc
Definition: XrdSfsInterface.hh:898
@ csGet
Definition: XrdSfsInterface.hh:898
@ csCalc
Definition: XrdSfsInterface.hh:898
@ csSize
Definition: XrdSfsInterface.hh:898
uint64_t FeatureSet
Adjust features at initialization.
Definition: XrdSfsInterface.hh:1267
uint64_t Features()
Definition: XrdSfsInterface.hh:1004
virtual const char * getVersion()=0
virtual XrdSfsFile * newFile(XrdOucErrInfo &eInfo)
Definition: XrdSfsInterface.hh:875
virtual int exists(const char *path, XrdSfsFileExistence &eFlag, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual int prepare(XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
virtual int stat(const char *Name, struct stat *buf, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual XrdSfsFile * newFile(char *user=0, int MonID=0)=0
virtual int gpFile(gpfFunc &gpAct, XrdSfsGPFile &gpReq, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)
virtual int rem(const char *path, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
gpfFunc
Definition: XrdSfsInterface.hh:1107
@ gpfGet
Perform a file retrieval.
Definition: XrdSfsInterface.hh:1108
@ gpfCancel
Cancel this request.
Definition: XrdSfsInterface.hh:1107
@ gpfPut
Perform a file push.
Definition: XrdSfsInterface.hh:1109
virtual int chksum(csFunc Func, const char *csName, const char *path, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)
Definition: XrdSfsInterface.hh:362
static const uint64_t Verify
Options for pgRead() and pgWrite() as noted below.
Definition: XrdSfsInterface.hh:494
virtual int fctl(const int cmd, int alen, const char *args, const XrdSecEntity *client=0)
XrdOucErrInfo & error
Definition: XrdSfsInterface.hh:370
XrdSfsFileOffset pgwrEOF
Definition: XrdSfsInterface.hh:782
static const uint64_t NetOrder
all: bytes in/out in net byte order
Definition: XrdSfsInterface.hh:496
virtual int getMmap(void **Addr, off_t &Size)=0
virtual int open(const char *fileName, XrdSfsFileOpenMode openMode, mode_t createMode, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual int sync(XrdSfsAio *aiop)=0
virtual XrdSfsXferSize pgWrite(XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize wrlen, uint32_t *csvec, uint64_t opts=0)
virtual int SendData(XrdSfsDio *sfDio, XrdSfsFileOffset offset, XrdSfsXferSize size)
virtual XrdSfsXferSize writev(XrdOucIOVec *writeV, int wdvCnt)
virtual int write(XrdSfsAio *aioparm)=0
virtual XrdSfsXferSize read(XrdSfsFileOffset offset, XrdSfsXferSize size)=0
virtual int checkpoint(cpAct act, struct iov *range=0, int n=0)
virtual int truncate(XrdSfsFileOffset fsize)=0
virtual ~XrdSfsFile()
Destructor.
Definition: XrdSfsInterface.hh:778
virtual XrdSfsXferSize read(XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize size)=0
cpAct
Definition: XrdSfsInterface.hh:412
@ cpDelete
Delete an existing checkpoint.
Definition: XrdSfsInterface.hh:413
@ cpRestore
Restore an active checkpoint and delete it.
Definition: XrdSfsInterface.hh:414
@ cpCreate
Create a checkpoint, one must not be active.
Definition: XrdSfsInterface.hh:412
virtual const char * FName()=0
virtual int getCXinfo(char cxtype[4], int &cxrsz)=0
XrdSfsFile(XrdSfsFile &wrapF)
Definition: XrdSfsInterface.hh:761
XrdSfsFile(const char *user=0, int MonID=0)
Definition: XrdSfsInterface.hh:749
XrdOucErrInfo * lclEI
Definition: XrdSfsInterface.hh:781
virtual XrdSfsXferSize pgRead(XrdSfsFileOffset offset, char *buffer, XrdSfsXferSize rdlen, uint32_t *csvec, uint64_t opts=0)
XrdSfsFile(XrdOucErrInfo &eInfo)
Definition: XrdSfsInterface.hh:771
virtual XrdSfsXferSize readv(XrdOucIOVec *readV, int rdvCnt)
virtual int pgRead(XrdSfsAio *aioparm, uint64_t opts=0)
virtual int stat(struct stat *buf)=0
virtual void setXio(XrdSfsXio *xioP)
Definition: XrdSfsInterface.hh:736
virtual int fctl(const int cmd, const char *args, XrdOucErrInfo &eInfo)=0
virtual XrdSfsXferSize write(XrdSfsFileOffset offset, const char *buffer, XrdSfsXferSize size)=0
virtual int pgWrite(XrdSfsAio *aioparm, uint64_t opts=0)
virtual int read(XrdSfsAio *aioparm)=0
Definition: XrdSfsGPFile.hh:35
Definition: XrdSfsXio.hh:55
Definition: XrdSysLogger.hh:53
Definition: XrdOucIOVec.hh:41
Definition: XrdSfsFAttr.hh:73
< SFS_FSCTL_PLUGIN/PLUGIO parms
Definition: XrdSfsInterface.hh:160
const char * Arg1
PLUGIO, PLUGIN.
Definition: XrdSfsInterface.hh:161
int Arg2Len
Length.
Definition: XrdSfsInterface.hh:163
const char * Arg2
PLUGIN opaque string.
Definition: XrdSfsInterface.hh:164
int Arg1Len
Length.
Definition: XrdSfsInterface.hh:162
< Prepare parameters
Definition: XrdSfsInterface.hh:168
char * notify
Notification path or 0.
Definition: XrdSfsInterface.hh:170
XrdOucTList * paths
List of paths.
Definition: XrdSfsInterface.hh:172
XrdOucTList * oinfo
1-to-1 correspondence of opaque info
Definition: XrdSfsInterface.hh:173
char * reqid
Request ID.
Definition: XrdSfsInterface.hh:169
int opts
Prep_xxx.
Definition: XrdSfsInterface.hh:171